KCal Library
KCal::IncidenceFormatter Namespace Reference
Provides methods to format Incidences in various ways for display purposes. More...
Functions | |
QString | extensiveDisplayStr (IncidenceBase *incidence, KDateTime::Spec spec=KDateTime::Spec()) |
QString | extensiveDisplayString (IncidenceBase *incidence) |
QString | formatICalInvitation (QString invitation, Calendar *mCalendar, InvitationFormatterHelper *helper) |
QString | formatICalInvitationNoHtml (QString invitation, Calendar *mCalendar, InvitationFormatterHelper *helper) |
QString | formatTNEFInvitation (const QByteArray &tnef, Calendar *mCalendar, InvitationFormatterHelper *helper) |
QString | mailBodyStr (IncidenceBase *incidence, KDateTime::Spec spec=KDateTime::Spec()) |
QString | mailBodyString (IncidenceBase *incidence) |
QString | msTNEFToVPart (const QByteArray &tnef) |
QString | recurrenceString (Incidence *incidence) |
QString | toolTipStr (IncidenceBase *incidence, bool richText=true, KDateTime::Spec spec=KDateTime::Spec()) |
QString | toolTipString (IncidenceBase *incidence, bool richText=true) |
Detailed Description
Provides methods to format Incidences in various ways for display purposes.Helpers that provides several static methods to format an Incidence in different ways: like an HTML representation for KMail, a representation for tool tips, or a representation for a viewer widget.
Function Documentation
QString KCal::IncidenceFormatter::extensiveDisplayStr | ( | IncidenceBase * | incidence, | |
KDateTime::Spec | spec = KDateTime::Spec() | |||
) |
Create a RichText QString representation of an Incidence in a nice format suitable for using in a viewer widget.
- Parameters:
-
incidence is a pointer to the Incidence to be formatted. spec is an optional time specification which, when specified, will shift the Incidence times to different timezones.
- Since:
- 4.2
Definition at line 588 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::extensiveDisplayString | ( | IncidenceBase * | incidence | ) |
Create a RichText QString representation of an Incidence in a nice format suitable for using in a viewer widget.
- Parameters:
-
incidence is a pointer to the Incidence to be formatted.
Definition at line 583 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::formatICalInvitation | ( | QString | invitation, | |
Calendar * | mCalendar, | |||
InvitationFormatterHelper * | helper | |||
) |
Deliver an HTML formatted string displaying an invitation.
Use the time zone from mCalendar.
Definition at line 1544 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::formatICalInvitationNoHtml | ( | QString | invitation, | |
Calendar * | mCalendar, | |||
InvitationFormatterHelper * | helper | |||
) |
QString KCal::IncidenceFormatter::formatTNEFInvitation | ( | const QByteArray & | tnef, | |
Calendar * | mCalendar, | |||
InvitationFormatterHelper * | helper | |||
) |
Format a TNEF attachment to an HTML mail.
- Since:
- 4.1
QString KCal::IncidenceFormatter::mailBodyStr | ( | IncidenceBase * | incidence, | |
KDateTime::Spec | spec = KDateTime::Spec() | |||
) |
Create a QString representation of an Incidence in format suitable for including inside a mail message.
- Parameters:
-
incidence is a pointer to the Incidence to be formatted. spec is an optional time specification which, when specified, will shift the Incidence times to different timezones.
- Since:
- 4.2
Definition at line 1914 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::mailBodyString | ( | IncidenceBase * | incidence | ) |
Create a QString representation of an Incidence in format suitable for including inside a mail message.
- Parameters:
-
incidence is a pointer to the Incidence to be formatted.
Definition at line 1909 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::msTNEFToVPart | ( | const QByteArray & | tnef | ) |
Transform a TNEF attachment to an iCal or vCard.
- Since:
- 4.1
QString KCal::IncidenceFormatter::recurrenceString | ( | Incidence * | incidence | ) |
Build a pretty QString representation of an Incidence's recurrence info.
- Parameters:
-
incidence is a pointer to the Incidence whose recurrence info is to be formatted.
- Since:
- 4.1
Definition at line 1941 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::toolTipStr | ( | IncidenceBase * | incidence, | |
bool | richText = true , |
|||
KDateTime::Spec | spec = KDateTime::Spec() | |||
) |
Create a QString representation of an Incidence in a nice format suitable for using in a tooltip.
- Parameters:
-
incidence is a pointer to the Incidence to be formatted. richText if yes, the QString will be created as RichText. spec is an optional time specification which, when specified, will shift the Incidence times to different timezones.
- Since:
- 4.2
Definition at line 1749 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::toolTipString | ( | IncidenceBase * | incidence, | |
bool | richText = true | |||
) |
Create a QString representation of an Incidence in a nice format suitable for using in a tooltip.
- Parameters:
-
incidence is a pointer to the Incidence to be formatted. richText if yes, the QString will be created as RichText.
Definition at line 1743 of file incidenceformatter.cpp.