KCal Library
Functions | |
KCAL_DEPRECATED_EXPORT QString | dateTimeToString (const KDateTime &date, bool dateOnly=false, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) |
KCAL_DEPRECATED_EXPORT QString | dateToString (const KDateTime &date, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) |
KCAL_DEPRECATED_EXPORT QString | durationString (Incidence *incidence) |
KCAL_DEPRECATED_EXPORT QString | extensiveDisplayStr (Calendar *calendar, IncidenceBase *incidence, const QDate &date=QDate(), KDateTime::Spec spec=KDateTime::Spec()) |
KCAL_DEPRECATED_EXPORT QString | extensiveDisplayStr (const QString &sourceName, IncidenceBase *incidence, const QDate &date=QDate(), KDateTime::Spec spec=KDateTime::Spec()) |
KCAL_DEPRECATED_EXPORT QString | extensiveDisplayStr (IncidenceBase *incidence, KDateTime::Spec spec=KDateTime::Spec()) |
KCAL_DEPRECATED_EXPORT QString | extensiveDisplayString (IncidenceBase *incidence) |
KCAL_DEPRECATED_EXPORT QString | formatICalInvitation (QString invitation, Calendar *calendar, InvitationFormatterHelper *helper) |
KCAL_DEPRECATED_EXPORT QString | formatICalInvitationNoHtml (QString invitation, Calendar *calendar, InvitationFormatterHelper *helper) |
KCAL_DEPRECATED_EXPORT QString | formatICalInvitationNoHtml (const QString &invitation, Calendar *calendar, InvitationFormatterHelper *helper, const QString &sender) |
KCAL_DEPRECATED_EXPORT QString | formatTNEFInvitation (const QByteArray &tnef, Calendar *mCalendar, InvitationFormatterHelper *helper) |
KCAL_DEPRECATED_EXPORT QString | mailBodyStr (IncidenceBase *incidence, KDateTime::Spec spec=KDateTime::Spec()) |
KCAL_DEPRECATED_EXPORT QString | mailBodyString (IncidenceBase *incidence) |
KCAL_DEPRECATED_EXPORT QString | msTNEFToVPart (const QByteArray &tnef) |
KCAL_DEPRECATED_EXPORT QString | recurrenceString (Incidence *incidence) |
KCAL_DEPRECATED_EXPORT QStringList | reminderStringList (Incidence *incidence, bool shortfmt=true) |
KCAL_DEPRECATED_EXPORT QString | resourceString (Calendar *calendar, Incidence *incidence) |
KCAL_DEPRECATED_EXPORT QString | timeToString (const KDateTime &date, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) |
KCAL_DEPRECATED_EXPORT QString | toolTipStr (Calendar *calendar, IncidenceBase *incidence, const QDate &date=QDate(), bool richText=true, KDateTime::Spec spec=KDateTime::Spec()) |
KCAL_DEPRECATED_EXPORT QString | toolTipStr (const QString &sourceName, IncidenceBase *incidence, const QDate &date=QDate(), bool richText=true, KDateTime::Spec spec=KDateTime::Spec()) |
KCAL_DEPRECATED_EXPORT QString | toolTipStr (IncidenceBase *incidence, bool richText=true, KDateTime::Spec spec=KDateTime::Spec()) |
KCAL_DEPRECATED_EXPORT 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
KCAL_DEPRECATED_EXPORT 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
KCAL_DEPRECATED_EXPORT 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
KCAL_DEPRECATED_EXPORT QString KCal::IncidenceFormatter::durationString | ( | Incidence * | incidence | ) |
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.
- Parameters
-
calendar is a pointer to the Calendar that owns the specified Incidence. 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 991 of file incidenceformatter.cpp.
QString KCal::IncidenceFormatter::extensiveDisplayStr | ( | const QString & | sourceName, |
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.
- Parameters
-
sourceName where the incidence is from (e.g. resource name) 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.5
Definition at line 1008 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 976 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 971 of file incidenceformatter.cpp.
KCAL_DEPRECATED_EXPORT QString KCal::IncidenceFormatter::formatICalInvitation | ( | QString | invitation, |
Calendar * | calendar, | ||
InvitationFormatterHelper * | helper | ||
) |
Deliver an HTML formatted string displaying an invitation.
Use the time zone from mCalendar.
KCAL_DEPRECATED_EXPORT QString KCal::IncidenceFormatter::formatICalInvitationNoHtml | ( | QString | invitation, |
Calendar * | calendar, | ||
InvitationFormatterHelper * | helper | ||
) |
Deliver an HTML formatted string displaying an invitation.
Differs from formatICalInvitation() in that invitation details (summary, location, etc) have HTML formatting cleaned. Use the time zone from calendar.
- Parameters
-
invitation a QString containing a string representation of a calendar Event which will be intrepreted as an invitation. calendar is a pointer to the Calendar that owns the invitation. helper is a pointer to an InvitationFormatterHelper.
- Deprecated:
- use formatICalInvitationNoHtml(const QString &,Calendar *, InvitationFormatterHelper *,const QString &) instead.
KCAL_DEPRECATED_EXPORT QString KCal::IncidenceFormatter::formatICalInvitationNoHtml | ( | const QString & | invitation, |
Calendar * | calendar, | ||
InvitationFormatterHelper * | helper, | ||
const QString & | sender | ||
) |
Deliver an HTML formatted string displaying an invitation.
Differs from formatICalInvitation() in that invitation details (summary, location, etc) have HTML formatting cleaned. Use the time zone from calendar.
- Parameters
-
invitation a QString containing a string representation of a calendar Event which will be intrepreted as an invitation. calendar is a pointer to the Calendar that owns the invitation. helper is a pointer to an InvitationFormatterHelper. sender is a QString containing the email address of the person sending the invitation.
- Since
- 4.5
KCAL_DEPRECATED_EXPORT QString KCal::IncidenceFormatter::formatTNEFInvitation | ( | const QByteArray & | tnef, |
Calendar * | mCalendar, | ||
InvitationFormatterHelper * | helper | ||
) |
Format a TNEF attachment to an HTML mail.
- Since
- 4.1
KCAL_DEPRECATED_EXPORT QString KCal::IncidenceFormatter::mailBodyStr | ( | IncidenceBase * | incidence, |
KDateTime::Spec | spec = KDateTime::Spec() |
||
) |
KCAL_DEPRECATED_EXPORT QString KCal::IncidenceFormatter::mailBodyString | ( | IncidenceBase * | incidence | ) |
KCAL_DEPRECATED_EXPORT QString KCal::IncidenceFormatter::msTNEFToVPart | ( | const QByteArray & | tnef | ) |
Transform a TNEF attachment to an iCal or vCard.
- Since
- 4.1
KCAL_DEPRECATED_EXPORT QString KCal::IncidenceFormatter::recurrenceString | ( | Incidence * | incidence | ) |
KCAL_DEPRECATED_EXPORT QStringList KCal::IncidenceFormatter::reminderStringList | ( | Incidence * | incidence, |
bool | shortfmt = true |
||
) |
Returns a reminder string computed for the specified Incidence.
Each item of the returning QStringList corresponds to a string representation of an reminder belonging to this incidence.
- Parameters
-
incidence is a pointer to the Incidence. shortfmt if false, a short version of each reminder is printed; else a longer version of each reminder is printed.
- Since
- 4.5
KCAL_DEPRECATED_EXPORT QString KCal::IncidenceFormatter::resourceString | ( | Calendar * | calendar, |
Incidence * | incidence | ||
) |
KCAL_DEPRECATED_EXPORT 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
KCAL_DEPRECATED_EXPORT 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
KCAL_DEPRECATED_EXPORT QString KCal::IncidenceFormatter::toolTipStr | ( | const QString & | sourceName, |
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
-
sourceName where the incidence is from (e.g. resource name) 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.5
KCAL_DEPRECATED_EXPORT 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)
KCAL_DEPRECATED_EXPORT 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)
Documentation copyright © 1996-2015 The KDE developers.
Generated on Fri Apr 10 2015 18:58:20 by doxygen 1.8.6 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.