KCal Library
KCal::IncidenceFormatter Namespace Reference
Provides methods to format Incidences in various ways for display purposes. More...
Functions | |
QString | dateTimeToString (const KDateTime &date, bool dateOnly=false, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) |
QString | dateToString (const KDateTime &date, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) |
QString | extensiveDisplayStr (IncidenceBase *incidence, KDateTime::Spec spec=KDateTime::Spec()) |
QString | extensiveDisplayStr (Calendar *calendar, IncidenceBase *incidence, const QDate &date=QDate(), 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 | resourceString (Calendar *calendar, Incidence *incidence) |
QString | timeToString (const KDateTime &date, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) |
QString | toolTipStr (IncidenceBase *incidence, bool richText=true, KDateTime::Spec spec=KDateTime::Spec()) |
QString | toolTipStr (Calendar *calendar, IncidenceBase *incidence, const QDate &date=QDate(), 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::dateTimeToString | ( | const KDateTime & | date, | |
bool | dateOnly = false , |
|||
bool | shortfmt = true , |
|||
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) |
Build a QString date/time representation of a KDateTime object.
- Parameters:
-
date The date to be formatted. dateOnly If true, don't print the time fields; print the date fields only. shortfmt If true, display info in short format. spec Time spec to use.
- See also:
- dateToString(), timeToString().
- Since:
- 4.3
Definition at line 3065 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::dateToString | ( | const KDateTime & | date, | |
bool | shortfmt = true , |
|||
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) |
Build a QString date representation of a KDateTime object.
- Parameters:
-
date The date to be formatted. shortfmt If true, display info in short format. spec Time spec to use.
- See also:
- dateToString(), dateTimeToString().
- Since:
- 4.3
Definition at line 3043 of file incidenceformatter.cpp.
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
- Deprecated:
- use extensiveDisplayStr( Calendar *, IncidenceBase *, KDateTime::Spec )
Definition at line 838 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::extensiveDisplayStr | ( | Calendar * | calendar, | |
IncidenceBase * | incidence, | |||
const QDate & | date = QDate() , |
|||
KDateTime::Spec | spec = KDateTime::Spec() | |||
) |
Create a RichText QString representation of an Incidence in a nice format suitable for using in a viewer widget.
calendar is a pointer to the Calendar that owns the specified Incidence.
- Parameters:
-
incidence is a pointer to the Incidence to be formatted. date is the QDate for which the string representation should be computed; used mainly for recurring incidences. spec is an optional time specification which, when specified, will shift the Incidence times to different timezones.
- Since:
- 4.4
Definition at line 853 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.
- Deprecated:
- use extensiveDisplayStr( Calendar *, IncidenceBase *, KDateTime::Spec )
Definition at line 833 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 2255 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::formatICalInvitationNoHtml | ( | QString | invitation, | |
Calendar * | mCalendar, | |||
InvitationFormatterHelper * | helper | |||
) |
- Since:
- 4.2
Definition at line 2263 of file incidenceformatter.cpp.
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 2684 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 2679 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 2715 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::timeToString | ( | const KDateTime & | date, | |
bool | shortfmt = true , |
|||
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) |
Build a QString time representation of a KDateTime object.
- Parameters:
-
date The date to be formatted. shortfmt If true, display info in short format. spec Time spec to use.
- See also:
- dateToString(), dateTimeToString().
- Since:
- 4.3
Definition at line 3026 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
- Deprecated:
- use toolTipStr( Calendar *, IncidenceBase *, bool, KDateTime::Spec)
Definition at line 2506 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::toolTipStr | ( | Calendar * | calendar, | |
IncidenceBase * | incidence, | |||
const QDate & | date = QDate() , |
|||
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. date is the QDate for which the toolTip should be computed; used mainly for recurring incidences. 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.4
Definition at line 2517 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.
- Deprecated:
- use toolTipStr( Calendar *, IncidenceBase *, bool, KDateTime::Spec)
Definition at line 2500 of file incidenceformatter.cpp.