• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KCalUtils Library

  • KCalUtils
  • Stringify
Functions
KCalUtils::Stringify Namespace Reference

Functions

KCALUTILS_EXPORT QString attendeeRole (KCalCore::Attendee::Role role)
 
KCALUTILS_EXPORT QStringList attendeeRoleList ()
 
KCALUTILS_EXPORT QString attendeeStatus (KCalCore::Attendee::PartStat status)
 
KCALUTILS_EXPORT QStringList attendeeStatusList ()
 
KCALUTILS_EXPORT QString errorMessage (const KCalCore::Exception &exception)
 
KCALUTILS_EXPORT QString formatDate (const KDateTime &dt, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec())
 
KCALUTILS_EXPORT QString formatDateTime (const KDateTime &dt, bool dateOnly=false, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec())
 
KCALUTILS_EXPORT QString formatTime (const KDateTime &dt, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec())
 
KCALUTILS_EXPORT QString incidenceSecrecy (KCalCore::Incidence::Secrecy secrecy)
 
KCALUTILS_EXPORT QStringList incidenceSecrecyList ()
 
KCALUTILS_EXPORT QString incidenceStatus (const KCalCore::Incidence::Ptr &incidence)
 
KCALUTILS_EXPORT QString incidenceStatus (KCalCore::Incidence::Status status)
 
KCALUTILS_EXPORT QString incidenceType (KCalCore::Incidence::IncidenceType type)
 
KCALUTILS_EXPORT QString scheduleMessageStatus (KCalCore::ScheduleMessage::Status status)
 
KCALUTILS_EXPORT QStringList secrecyList ()
 
KCALUTILS_EXPORT QString secrecyName (KCalCore::Incidence::Secrecy secrecy)
 
KCALUTILS_EXPORT QString todoCompletedDateTime (const KCalCore::Todo::Ptr &todo, bool shortfmt=false)
 

Detailed Description

Provides methods to format Incidence properties in various ways for display purposes.

Function Documentation

◆ attendeeRole()

QString KCalUtils::Stringify::attendeeRole ( KCalCore::Attendee::Role  role)

Definition at line 132 of file stringify.cpp.

◆ attendeeRoleList()

QStringList KCalUtils::Stringify::attendeeRoleList ( )

Definition at line 151 of file stringify.cpp.

◆ attendeeStatus()

QString KCalUtils::Stringify::attendeeStatus ( KCalCore::Attendee::PartStat  status)

Definition at line 162 of file stringify.cpp.

◆ attendeeStatusList()

QStringList KCalUtils::Stringify::attendeeStatusList ( )

Definition at line 193 of file stringify.cpp.

◆ errorMessage()

QString KCalUtils::Stringify::errorMessage ( const KCalCore::Exception &  exception)

Build a translated message representing an exception.

Definition at line 265 of file stringify.cpp.

◆ formatDate()

QString KCalUtils::Stringify::formatDate ( const KDateTime &  dt,
bool  shortfmt = true,
const KDateTime::Spec &  spec = KDateTime::Spec() 
)

Build a QString date representation of a KDateTime object.

Parameters
dateThe date to be formatted.
shortfmtIf true, display info in short format.
specTime spec to use.
See also
formatDate(), formatDateTime().

Definition at line 222 of file stringify.cpp.

◆ formatDateTime()

QString KCalUtils::Stringify::formatDateTime ( const KDateTime &  dt,
bool  dateOnly = false,
bool  shortfmt = true,
const KDateTime::Spec &  spec = KDateTime::Spec() 
)

Build a QString date/time representation of a KDateTime object.

Parameters
dateThe date to be formatted.
dateOnlyIf true, don't print the time fields; print the date fields only.
shortfmtIf true, display info in short format.
specTime spec to use.
See also
formatDate(), formatTime().

Definition at line 242 of file stringify.cpp.

◆ formatTime()

QString KCalUtils::Stringify::formatTime ( const KDateTime &  dt,
bool  shortfmt = true,
const KDateTime::Spec &  spec = KDateTime::Spec() 
)

Build a QString time representation of a KDateTime object.

Parameters
dateThe date to be formatted.
shortfmtIf true, display info in short format.
specTime spec to use.
See also
formatDate(), formatDateTime().

Definition at line 207 of file stringify.cpp.

◆ incidenceSecrecy()

QString KCalUtils::Stringify::incidenceSecrecy ( KCalCore::Incidence::Secrecy  secrecy)

Returns the incidence Secrecy as translated string.

See also
incidenceSecrecyList().

Definition at line 73 of file stringify.cpp.

◆ incidenceSecrecyList()

QStringList KCalUtils::Stringify::incidenceSecrecyList ( )

Returns a list of all available Secrecy types as a list of translated strings.

See also
incidenceSecrecy().

Definition at line 87 of file stringify.cpp.

◆ incidenceStatus() [1/2]

QString KCalUtils::Stringify::incidenceStatus ( const KCalCore::Incidence::Ptr &  incidence)

Definition at line 123 of file stringify.cpp.

◆ incidenceStatus() [2/2]

QString KCalUtils::Stringify::incidenceStatus ( KCalCore::Incidence::Status  status)

Definition at line 97 of file stringify.cpp.

◆ scheduleMessageStatus()

QString KCalUtils::Stringify::scheduleMessageStatus ( KCalCore::ScheduleMessage::Status  status)

Definition at line 341 of file stringify.cpp.

◆ secrecyList()

QStringList KCalUtils::Stringify::secrecyList ( )

Definition at line 377 of file stringify.cpp.

◆ secrecyName()

QString KCalUtils::Stringify::secrecyName ( KCalCore::Incidence::Secrecy  secrecy)

Definition at line 363 of file stringify.cpp.

◆ todoCompletedDateTime()

QString KCalUtils::Stringify::todoCompletedDateTime ( const KCalCore::Todo::Ptr &  todo,
bool  shortfmt = false 
)

Returns string containing the date/time when the to-do was completed, formatted according to the user's locale settings.

Parameters
shortfmtIf true, use a short date format; else use a long format.

Definition at line 65 of file stringify.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCalUtils Library

Skip menu "KCalUtils Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal