KCalendarCore Namespace
Namespace for all KCalendarCore types. More...
| Header: | #include <KCalendarCore> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS CalendarCore)target_link_libraries(mytarget PRIVATE KF6::CalendarCore) |
Classes
| class | Alarm |
| class | Attachment |
| class | Attendee |
| class | CalFilter |
| class | CalFormat |
| class | CalStorage |
| class | Calendar |
(since 6.4) class | CalendarListModel |
(since 5.85) class | CalendarPlugin |
(since 5.97) class | CalendarPluginLoader |
(since 5.77) class | Conference |
| class | CustomProperties |
| class | Duration |
| class | Event |
| class | Exception |
| class | FileStorage |
| class | FreeBusy |
| class | FreeBusyCache |
| class | FreeBusyPeriod |
| class | ICalFormat |
| class | Incidence |
| class | IncidenceBase |
| class | Journal |
| class | MemoryCalendar |
(since 4.11) class | OccurrenceIterator |
| class | Period |
| class | Person |
| class | Recurrence |
| class | RecurrenceRule |
| class | ScheduleMessage |
| class | Todo |
| class | VCalFormat |
| class | Visitor |
Types
(since 5.85) enum | AccessMode { ReadOnly, ReadWrite } |
| DateList | |
| DateTimeList | |
| enum | EventSortField { EventSortUnsorted, EventSortStartDate, EventSortEndDate, EventSortSummary } |
| enum | JournalSortField { JournalSortUnsorted, JournalSortDate, JournalSortSummary } |
| enum | SortDirection { SortDirectionAscending, SortDirectionDescending } |
(since 5.83.) enum | TodoSortField { TodoSortUnsorted, TodoSortStartDate, TodoSortDueDate, TodoSortPriority, TodoSortPercentComplete, …, TodoSortCategories } |
| enum | iTIPMethod { iTIPPublish, iTIPRequest, iTIPReply, iTIPAdd, iTIPCancel, …, iTIPNoMethod } |
Functions
(since 5.93) bool | identical(const QDateTime &dt1, const QDateTime &dt2) |
| size_t | qHash(const KCalendarCore::Period &key, size_t seed = 0) |
| size_t | qHash(const KCalendarCore::Person &key, size_t seed = 0) |
(since 4.12) QDataStream & | operator<<(QDataStream &out, KCalendarCore::Recurrence *) |
(since 4.12) QDataStream & | operator<<(QDataStream &out, const KCalendarCore::Alarm::Ptr &) |
(since 4.12) QDataStream & | operator<<(QDataStream &out, const KCalendarCore::Attachment &) |
| QDataStream & | operator<<(QDataStream &stream, const KCalendarCore::Attendee &attendee) |
| QDataStream & | operator<<(QDataStream &stream, const KCalendarCore::Conference &conference) |
| QDataStream & | operator<<(QDataStream &stream, const KCalendarCore::CustomProperties &properties) |
(since 4.12) QDataStream & | operator<<(QDataStream &out, const KCalendarCore::Duration &) |
| QDataStream & | operator<<(QDataStream &stream, const KCalendarCore::FreeBusy::Ptr &freebusy) |
| QDataStream & | operator<<(QDataStream &stream, const KCalendarCore::FreeBusyPeriod &period) |
(since 4.12) QDataStream & | operator<<(QDataStream &out, const KCalendarCore::IncidenceBase::Ptr &) |
| QDataStream & | operator<<(QDataStream &stream, const KCalendarCore::Period &period) |
| QDataStream & | operator<<(QDataStream &stream, const KCalendarCore::Person &person) |
(since 4.12) QDataStream & | operator<<(QDataStream &out, const KCalendarCore::RecurrenceRule *) |
(since 4.12) QDataStream & | operator<<(QDataStream &out, const KCalendarCore::RecurrenceRule::WDayPos &) |
(since 4.12) QDataStream & | operator>>(QDataStream &in, KCalendarCore::Attachment &) |
| QDataStream & | operator>>(QDataStream &stream, KCalendarCore::Attendee &attendee) |
| QDataStream & | operator>>(QDataStream &stream, KCalendarCore::Conference &conference) |
| QDataStream & | operator>>(QDataStream &stream, KCalendarCore::CustomProperties &properties) |
(since 4.12) QDataStream & | operator>>(QDataStream &in, KCalendarCore::Duration &) |
| QDataStream & | operator>>(QDataStream &stream, KCalendarCore::FreeBusy::Ptr &freebusy) |
| QDataStream & | operator>>(QDataStream &stream, KCalendarCore::FreeBusyPeriod &period) |
(since 4.12) QDataStream & | operator>>(QDataStream &in, KCalendarCore::IncidenceBase::Ptr &) |
| QDataStream & | operator>>(QDataStream &stream, KCalendarCore::Period &period) |
| QDataStream & | operator>>(QDataStream &stream, KCalendarCore::Person &person) |
(since 4.12) QDataStream & | operator>>(QDataStream &in, KCalendarCore::Recurrence *) |
(since 4.12) QDataStream & | operator>>(QDataStream &in, const KCalendarCore::Alarm::Ptr &) |
Detailed Description
Classes
class Alarm
Represents an alarm notification. More...
class Attachment
Represents information related to an attachment for a Calendar Incidence. More...
class Attendee
Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (to-do). More...
class CalFilter
Provides a filter for calendars. More...
class CalFormat
An abstract base class that provides an interface to various calendar formats. More...
class CalStorage
An abstract base class that provides a calendar storage interface. More...
class Calendar
Represents the main calendar class. More...
class CalendarListModel
Model adaptor for KCalendarCore::CalendarPlugin::calendars(). More...
class CalendarPlugin
A plugin that provides calendar data. More...
class CalendarPluginLoader
Provides access to a KCalendarCore::CalendarPlugin instance, if available. More...
class Conference
Represents information related to a conference information of an Calendar Incidence, typically a meeting or task (to-do). More...
class CustomProperties
A class to manage custom calendar properties. More...
class Duration
Represents a span of time measured in seconds or days. More...
class Event
This class provides an Event in the sense of RFC2445. More...
class Exception
Exception base class, currently used as a fancy kind of error code and not as an C++ exception. More...
class FileStorage
This class provides a calendar storage as a local file. More...
class FreeBusy
Provides information about the free/busy time of a calendar. More...
class FreeBusyCache
An abstract base class to allow different implementations of storing free busy information, e.g. local storage or storage on a Kolab server. More...
class FreeBusyPeriod
Represents a period of time. More...
class ICalFormat
iCalendar format implementation. More...
class Incidence
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar components known as incidences. More...
class IncidenceBase
An abstract class that provides a common base for all calendar incidence classes. More...
class Journal
Provides a Journal in the sense of RFC2445. More...
class MemoryCalendar
This class provides a calendar stored in memory. More...
class OccurrenceIterator
Iterate over calendar items in a calendar. More...
class Period
The period can be defined by either a start time and an end time or by a start time and a duration. More...
class Person
Represents a person, by name and email address. More...
class Recurrence
This class represents a recurrence rule for a calendar incidence. More...
class RecurrenceRule
This class represents a recurrence rule for a calendar incidence. More...
class ScheduleMessage
A Scheduling message class. More...
class Todo
Provides a To-do in the sense of RFC2445. More...
class VCalFormat
vCalendar format implementation. More...
class Visitor
This class provides the interface for a visitor of calendar components. More...
Type Documentation
[since 5.85] enum KCalendarCore::AccessMode
The calendar's access mode, i.e. whether it can be written to or is read only.
| Constant | Value |
|---|---|
KCalendarCore::ReadOnly | 0 |
KCalendarCore::ReadWrite | 1 |
This enum was introduced in 5.85.
KCalendarCore::DateList
List of dates
KCalendarCore::DateTimeList
List of times
enum KCalendarCore::EventSortField
Calendar Event sort keys.
| Constant | Value | Description |
|---|---|---|
KCalendarCore::EventSortUnsorted | 0 | Do not sort Events. |
KCalendarCore::EventSortStartDate | 1 | Sort Events chronologically, by start date. |
KCalendarCore::EventSortEndDate | 2 | Sort Events chronologically, by end date. |
KCalendarCore::EventSortSummary | 3 | Sort Events alphabetically, by summary. |
enum KCalendarCore::JournalSortField
Calendar Journal sort keys.
| Constant | Value | Description |
|---|---|---|
KCalendarCore::JournalSortUnsorted | 0 | Do not sort Journals. |
KCalendarCore::JournalSortDate | 1 | Sort Journals chronologically by date. |
KCalendarCore::JournalSortSummary | 2 | Sort Journals alphabetically, by summary. |
enum KCalendarCore::SortDirection
Calendar Incidence sort directions.
| Constant | Value | Description |
|---|---|---|
KCalendarCore::SortDirectionAscending | 0 | Sort in ascending order (first to last). |
KCalendarCore::SortDirectionDescending | 1 | Sort in descending order (last to first). |
[since 5.83.] enum KCalendarCore::TodoSortField
Calendar Todo sort keys.
| Constant | Value | Description |
|---|---|---|
KCalendarCore::TodoSortUnsorted | 0 | Do not sort Todos. |
KCalendarCore::TodoSortStartDate | 1 | Sort Todos chronologically, by start date. |
KCalendarCore::TodoSortDueDate | 2 | Sort Todos chronologically, by due date. |
KCalendarCore::TodoSortPriority | 3 | Sort Todos by priority. |
KCalendarCore::TodoSortPercentComplete | 4 | Sort Todos by percentage completed. |
KCalendarCore::TodoSortSummary | 5 | Sort Todos alphabetically, by summary. |
KCalendarCore::TodoSortCreated | 6 | Sort Todos chronologically, by creation date. |
KCalendarCore::TodoSortCategories | 7 | Sort Todos by categories (tags) |
This enum was introduced in 5.83..
enum KCalendarCore::iTIPMethod
iTIP methods.
| Constant | Value | Description |
|---|---|---|
KCalendarCore::iTIPPublish | 0 | Event, to-do, journal or freebusy posting. |
KCalendarCore::iTIPRequest | 1 | Event, to-do or freebusy scheduling request. |
KCalendarCore::iTIPReply | 2 | Event, to-do or freebusy reply to request. |
KCalendarCore::iTIPAdd | 3 | Event, to-do or journal additional property request. |
KCalendarCore::iTIPCancel | 4 | Event, to-do or journal cancellation notice. |
KCalendarCore::iTIPRefresh | 5 | Event or to-do description update request. |
KCalendarCore::iTIPCounter | 6 | Event or to-do submit counter proposal. |
KCalendarCore::iTIPDeclineCounter | 7 | Event or to-do decline a counter proposal. |
KCalendarCore::iTIPNoMethod | 8 | No method. |
Function Documentation
[since 5.93] bool KCalendarCore::identical(const QDateTime &dt1, const QDateTime &dt2)
Compare two QDateTimes dt1 and dt2 for extended equality.
QDateTime::operator==() in Qt 5.12 returns true if its operands represent the same instant in time, regardless of their time zones or TimeSpecs (and contrary to the documentation). This function returns true if and only if their times, time zones, and TimeSpecs are equal, or both are invalid().
This function was introduced in 5.93.
size_t KCalendarCore::qHash(const KCalendarCore::Period &key, size_t seed = 0)
Return a hash value for a Period argument.
key is a Period.
size_t KCalendarCore::qHash(const KCalendarCore::Person &key, size_t seed = 0)
Return a hash value for a Person argument. key is a Person.
[since 4.12] QDataStream &KCalendarCore::operator<<(QDataStream &out, KCalendarCore::Recurrence *)
Recurrence serializer.
out is the output data stream
This function was introduced in 4.12.
[since 4.12] QDataStream &KCalendarCore::operator<<(QDataStream &out, const KCalendarCore::Alarm::Ptr &)
Alarm serializer.
This function was introduced in 4.12.
[since 4.12] QDataStream &KCalendarCore::operator<<(QDataStream &out, const KCalendarCore::Attachment &)
Attachment serializer.
out is the output data stream
This function was introduced in 4.12.
QDataStream &KCalendarCore::operator<<(QDataStream &stream, const KCalendarCore::Attendee &attendee)
Serializes an Attendee object into a data stream.
stream is a QDataStream.
attendee is a pointer to a Attendee object to be serialized.
QDataStream &KCalendarCore::operator<<(QDataStream &stream, const KCalendarCore::Conference &conference)
Serializes a Conference object into a data stream.
stream is a QDataStream.
conference is a reference to a Conference object to be serialized.
QDataStream &KCalendarCore::operator<<(QDataStream &stream, const KCalendarCore::CustomProperties &properties)
Serializes the properties object into the stream.
[since 4.12] QDataStream &KCalendarCore::operator<<(QDataStream &out, const KCalendarCore::Duration &)
Duration serializer.
This function was introduced in 4.12.
QDataStream &KCalendarCore::operator<<(QDataStream &stream, const KCalendarCore::FreeBusy::Ptr &freebusy)
Serializes the freebusy object into the stream.
QDataStream &KCalendarCore::operator<<(QDataStream &stream, const KCalendarCore::FreeBusyPeriod &period)
Write period to the datastream stream, in binary format.
[since 4.12] QDataStream &KCalendarCore::operator<<(QDataStream &out, const KCalendarCore::IncidenceBase::Ptr &)
Incidence serializer.
This function was introduced in 4.12.
QDataStream &KCalendarCore::operator<<(QDataStream &stream, const KCalendarCore::Period &period)
Write period to the datastream stream, in binary format.
QDataStream &KCalendarCore::operator<<(QDataStream &stream, const KCalendarCore::Person &person)
Serializes the person object into the stream.
[since 4.12] QDataStream &KCalendarCore::operator<<(QDataStream &out, const KCalendarCore::RecurrenceRule *)
RecurrenceRule serializer and deserializer.
This function was introduced in 4.12.
[since 4.12] QDataStream &KCalendarCore::operator<<(QDataStream &out, const KCalendarCore::RecurrenceRule::WDayPos &)
RecurrenceRule::WDayPos serializer and deserializer.
This function was introduced in 4.12.
[since 4.12] QDataStream &KCalendarCore::operator>>(QDataStream &in, KCalendarCore::Attachment &)
Attachment deserializer.
in is the input data stream
This function was introduced in 4.12.
QDataStream &KCalendarCore::operator>>(QDataStream &stream, KCalendarCore::Attendee &attendee)
Initializes an Attendee object from a data stream.
stream is a QDataStream.
attendee is a pointer to a Attendee object to be initialized.
QDataStream &KCalendarCore::operator>>(QDataStream &stream, KCalendarCore::Conference &conference)
Initializes a Conference object from a data stream.
stream is a QDataStream.
conference is a reference to a Conference object to be initialized.
QDataStream &KCalendarCore::operator>>(QDataStream &stream, KCalendarCore::CustomProperties &properties)
Initializes the properties object from the stream.
[since 4.12] QDataStream &KCalendarCore::operator>>(QDataStream &in, KCalendarCore::Duration &)
Duration deserializer.
This function was introduced in 4.12.
QDataStream &KCalendarCore::operator>>(QDataStream &stream, KCalendarCore::FreeBusy::Ptr &freebusy)
Initializes the freebusy object from the stream.
QDataStream &KCalendarCore::operator>>(QDataStream &stream, KCalendarCore::FreeBusyPeriod &period)
Read a Period object into period from stream, in binary format.
[since 4.12] QDataStream &KCalendarCore::operator>>(QDataStream &in, KCalendarCore::IncidenceBase::Ptr &)
Incidence deserializer.
This function was introduced in 4.12.
QDataStream &KCalendarCore::operator>>(QDataStream &stream, KCalendarCore::Period &period)
Read a Period object into period from stream, in binary format.
QDataStream &KCalendarCore::operator>>(QDataStream &stream, KCalendarCore::Person &person)
Initializes the person object from the stream.
[since 4.12] QDataStream &KCalendarCore::operator>>(QDataStream &in, KCalendarCore::Recurrence *)
Recurrence deserializer.
in is the input data stream
This function was introduced in 4.12.
[since 4.12] QDataStream &KCalendarCore::operator>>(QDataStream &in, const KCalendarCore::Alarm::Ptr &)
Alarm deserializer.
This function was introduced in 4.12.