KCalendarCore

KCalendarCore Namespace Reference

Classes

class  Alarm
 
class  Attachment
 
class  Attendee
 
class  Calendar
 
class  CalendarPlugin
 
class  CalFilter
 
class  CalFormat
 
class  CalStorage
 
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
 
class  OccurrenceIterator
 
class  Period
 
class  Person
 
class  Recurrence
 
class  RecurrenceRule
 
class  ScheduleMessage
 
class  Todo
 
class  VCalFormat
 
class  Visitor
 

Typedefs

typedef QList< QDateDateList
 
typedef QList< QDateTimeDateTimeList
 
typedef QList< QTimeTimeList
 

Enumerations

enum  AccessMode { ReadOnly, ReadWrite }
 
enum  EventSortField { EventSortUnsorted, EventSortStartDate, EventSortEndDate, EventSortSummary }
 
enum  iTIPMethod {
  iTIPPublish, iTIPRequest, iTIPReply, iTIPAdd,
  iTIPCancel, iTIPRefresh, iTIPCounter, iTIPDeclineCounter,
  iTIPNoMethod
}
 
enum  JournalSortField { JournalSortUnsorted, JournalSortDate, JournalSortSummary }
 
enum  SortDirection { SortDirectionAscending, SortDirectionDescending }
 
enum  TodoSortField {
  TodoSortUnsorted, TodoSortStartDate, TodoSortDueDate, TodoSortPriority,
  TodoSortPercentComplete, TodoSortSummary, TodoSortCreated, TodoSortCategories
}
 

Functions

KCALENDARCORE_EXPORT bool identical (QDateTime, QDateTime)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &out, const KCalendarCore::Alarm::Ptr &)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &out, const KCalendarCore::Attachment &)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &out, const KCalendarCore::Duration &)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &out, const KCalendarCore::IncidenceBase::Ptr &)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &out, const KCalendarCore::RecurrenceRule *)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &out, const KCalendarCore::RecurrenceRule::WDayPos &)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &out, KCalendarCore::Recurrence *)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &stream, const KCalendarCore::Attendee &attendee)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &stream, const KCalendarCore::Conference &conference)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &stream, const KCalendarCore::CustomProperties &properties)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &stream, const KCalendarCore::FreeBusy::Ptr &freebusy)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &stream, const KCalendarCore::FreeBusyPeriod &period)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &stream, const KCalendarCore::Period &period)
 
KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &stream, const KCalendarCore::Person &person)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &in, const KCalendarCore::Alarm::Ptr &)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &in, const KCalendarCore::RecurrenceRule *)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &in, KCalendarCore::Attachment &)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &in, KCalendarCore::Duration &)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &in, KCalendarCore::IncidenceBase::Ptr &)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &in, KCalendarCore::Recurrence *)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &in, KCalendarCore::RecurrenceRule::WDayPos &)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &stream, KCalendarCore::Attendee &attendee)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &stream, KCalendarCore::Conference &conference)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &stream, KCalendarCore::CustomProperties &properties)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &stream, KCalendarCore::FreeBusy::Ptr &freebusy)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &stream, KCalendarCore::FreeBusyPeriod &period)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &stream, KCalendarCore::Period &period)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &stream, KCalendarCore::Person &person)
 
uint qHash (const Duration &duration, uint seed=0)
 
KCALENDARCORE_EXPORT uint qHash (const KCalendarCore::Period &key)
 
KCALENDARCORE_EXPORT uint qHash (const KCalendarCore::Person &key)
 

Detailed Description

Namespace for all KCalendarCore types.

Typedef Documentation

◆ DateList

List of dates.

Definition at line 64 of file incidencebase.h.

◆ DateTimeList

List of times.

Definition at line 67 of file incidencebase.h.

Enumeration Type Documentation

◆ AccessMode

The calendar's access mode, i.e.

whether it can be written to or is read only.

Since
5.85

Definition at line 102 of file calendar.h.

◆ EventSortField

Calendar Event sort keys.

Enumerator
EventSortUnsorted 

Do not sort Events.

EventSortStartDate 

Sort Events chronologically, by start date.

EventSortEndDate 

Sort Events chronologically, by end date.

EventSortSummary 

Sort Events alphabetically, by summary.

Definition at line 68 of file calendar.h.

◆ iTIPMethod

iTIP methods.

Enumerator
iTIPPublish 

Event, to-do, journal or freebusy posting.

iTIPRequest 

Event, to-do or freebusy scheduling request.

iTIPReply 

Event, to-do or freebusy reply to request.

iTIPAdd 

Event, to-do or journal additional property request.

iTIPCancel 

Event, to-do or journal cancellation notice.

iTIPRefresh 

Event or to-do description update request.

iTIPCounter 

Event or to-do submit counter proposal.

iTIPDeclineCounter 

Event or to-do decline a counter proposal.

iTIPNoMethod 

No method.

Definition at line 22 of file schedulemessage.h.

◆ JournalSortField

Calendar Journal sort keys.

Enumerator
JournalSortUnsorted 

Do not sort Journals.

JournalSortDate 

Sort Journals chronologically by date.

JournalSortSummary 

Sort Journals alphabetically, by summary.

Definition at line 92 of file calendar.h.

◆ SortDirection

Calendar Incidence sort directions.

Enumerator
SortDirectionAscending 

Sort in ascending order (first to last)

SortDirectionDescending 

Sort in descending order (last to first)

Definition at line 60 of file calendar.h.

◆ TodoSortField

Calendar Todo sort keys.

Enumerator
TodoSortUnsorted 

Do not sort Todos.

TodoSortStartDate 

Sort Todos chronologically, by start date.

TodoSortDueDate 

Sort Todos chronologically, by due date.

TodoSortPriority 

Sort Todos by priority.

TodoSortPercentComplete 

Sort Todos by percentage completed.

TodoSortSummary 

Sort Todos alphabetically, by summary.

TodoSortCreated 

Sort Todos chronologically, by creation date.

TodoSortCategories 

Sort Todos by categories (tags)

Since
5.83

Definition at line 78 of file calendar.h.

Function Documentation

◆ identical()

bool KCalendarCore::identical ( QDateTime  dt1,
QDateTime  dt2 
)

Compare two QDateTimes 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().

Since
5.93

Definition at line 617 of file incidencebase.cpp.

◆ operator<<() [1/14]

QDataStream & KCalendarCore::operator<< ( QDataStream out,
const KCalendarCore::Alarm::Ptr a 
)

Alarm serializer.

Since
4.12

Definition at line 820 of file alarm.cpp.

◆ operator<<() [2/14]

QDataStream & KCalendarCore::operator<< ( QDataStream out,
const KCalendarCore::Attachment a 
)

Attachment serializer.

Since
4.12

Definition at line 210 of file attachment.cpp.

◆ operator<<() [3/14]

QDataStream & KCalendarCore::operator<< ( QDataStream out,
const KCalendarCore::Duration duration 
)

Duration serializer.

Since
4.12

Definition at line 206 of file duration.cpp.

◆ operator<<() [4/14]

QDataStream & KCalendarCore::operator<< ( QDataStream out,
const KCalendarCore::IncidenceBase::Ptr i 
)

Incidence serializer.

Since
4.12

Definition at line 622 of file incidencebase.cpp.

◆ operator<<() [5/14]

KCALENDARCORE_EXPORT QDataStream & KCalendarCore::operator<< ( QDataStream out,
const KCalendarCore::RecurrenceRule r 
)

RecurrenceRule serializer and deserializer.

Since
4.12

Definition at line 2241 of file recurrencerule.cpp.

◆ operator<<() [6/14]

KCALENDARCORE_EXPORT QDataStream & KCalendarCore::operator<< ( QDataStream out,
const KCalendarCore::RecurrenceRule::WDayPos w 
)

RecurrenceRule::WDayPos serializer and deserializer.

Since
4.12

Definition at line 2229 of file recurrencerule.cpp.

◆ operator<<() [7/14]

KCALENDARCORE_EXPORT QDataStream & KCalendarCore::operator<< ( QDataStream out,
KCalendarCore::Recurrence r 
)

Recurrence serializer and deserializer.

Since
4.12

Definition at line 1513 of file recurrence.cpp.

◆ operator<<() [8/14]

QDataStream & KCalendarCore::operator<< ( QDataStream stream,
const KCalendarCore::Attendee attendee 
)

Serializes an Attendee object into a data stream.

Parameters
streamis a QDataStream.
attendeeis a pointer to a Attendee object to be serialized.

Definition at line 302 of file attendee.cpp.

◆ operator<<() [9/14]

QDataStream & KCalendarCore::operator<< ( QDataStream stream,
const KCalendarCore::Conference conference 
)

Serializes a Conference object into a data stream.

Parameters
streamis a QDataStream.
conferenceis a reference to a Conference object to be serialized.

Definition at line 132 of file conference.cpp.

◆ operator<<() [10/14]

QDataStream & KCalendarCore::operator<< ( QDataStream stream,
const KCalendarCore::CustomProperties properties 
)

Serializes the properties object into the stream.

Definition at line 237 of file customproperties.cpp.

◆ operator<<() [11/14]

QDataStream & KCalendarCore::operator<< ( QDataStream stream,
const KCalendarCore::FreeBusy::Ptr freebusy 
)

Serializes the freebusy object into the stream.

Definition at line 399 of file freebusy.cpp.

◆ operator<<() [12/14]

QDataStream & KCalendarCore::operator<< ( QDataStream stream,
const KCalendarCore::FreeBusyPeriod period 
)

Write period to the datastream stream, in binary format.

Definition at line 116 of file freebusyperiod.cpp.

◆ operator<<() [13/14]

QDataStream & KCalendarCore::operator<< ( QDataStream stream,
const KCalendarCore::Period period 
)

Write period to the datastream stream, in binary format.

Definition at line 144 of file period.cpp.

◆ operator<<() [14/14]

QDataStream & KCalendarCore::operator<< ( QDataStream stream,
const KCalendarCore::Person person 
)

Serializes the person object into the stream.

Definition at line 152 of file person.cpp.

◆ operator>>() [1/11]

QDataStream & KCalendarCore::operator>> ( QDataStream in,
const KCalendarCore::Alarm::Ptr a 
)

Alarm deserializer.

Since
4.12

Definition at line 833 of file alarm.cpp.

◆ operator>>() [2/11]

QDataStream & KCalendarCore::operator>> ( QDataStream in,
KCalendarCore::Attachment a 
)

Attachment deserializer.

Since
4.12

Definition at line 216 of file attachment.cpp.

◆ operator>>() [3/11]

QDataStream & KCalendarCore::operator>> ( QDataStream in,
KCalendarCore::Duration duration 
)

Duration deserializer.

Since
4.12

Definition at line 212 of file duration.cpp.

◆ operator>>() [4/11]

QDataStream & KCalendarCore::operator>> ( QDataStream in,
KCalendarCore::IncidenceBase::Ptr i 
)

Incidence deserializer.

Since
4.12

Definition at line 648 of file incidencebase.cpp.

◆ operator>>() [5/11]

QDataStream & KCalendarCore::operator>> ( QDataStream stream,
KCalendarCore::Attendee attendee 
)

Initializes an Attendee object from a data stream.

Parameters
streamis a QDataStream.
attendeeis a pointer to a Attendee object to be initialized.

Definition at line 310 of file attendee.cpp.

◆ operator>>() [6/11]

QDataStream & KCalendarCore::operator>> ( QDataStream stream,
KCalendarCore::Conference conference 
)

Initializes a Conference object from a data stream.

Parameters
streamis a QDataStream.
conferenceis a reference to a Conference object to be initialized.

Definition at line 137 of file conference.cpp.

◆ operator>>() [7/11]

QDataStream & KCalendarCore::operator>> ( QDataStream stream,
KCalendarCore::CustomProperties properties 
)

Initializes the properties object from the stream.

Definition at line 242 of file customproperties.cpp.

◆ operator>>() [8/11]

QDataStream & KCalendarCore::operator>> ( QDataStream stream,
KCalendarCore::FreeBusy::Ptr freebusy 
)

Initializes the freebusy object from the stream.

Definition at line 406 of file freebusy.cpp.

◆ operator>>() [9/11]

QDataStream & KCalendarCore::operator>> ( QDataStream stream,
KCalendarCore::FreeBusyPeriod period 
)

Read a Period object into period from stream, in binary format.

Definition at line 124 of file freebusyperiod.cpp.

◆ operator>>() [10/11]

QDataStream & KCalendarCore::operator>> ( QDataStream stream,
KCalendarCore::Period period 
)

Read a Period object into period from stream, in binary format.

Definition at line 151 of file period.cpp.

◆ operator>>() [11/11]

QDataStream & KCalendarCore::operator>> ( QDataStream stream,
KCalendarCore::Person person 
)

Initializes the person object from the stream.

Definition at line 157 of file person.cpp.

◆ qHash() [1/2]

uint KCalendarCore::qHash ( const KCalendarCore::Period key)

Return a hash value for a Period argument.

Parameters
keyis a Period.

Definition at line 159 of file period.cpp.

◆ qHash() [2/2]

uint KCalendarCore::qHash ( const KCalendarCore::Person key)

Return a hash value for a Person argument.

Parameters
keyis a Person.

Definition at line 147 of file person.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri May 20 2022 04:16:17 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.