Akonadi::CalendarBase
#include <calendarbase.h>
Public Types | |
using | Ptr = QSharedPointer<CalendarBase> |
Public Types inherited from KCalendarCore::MemoryCalendar | |
typedef QSharedPointer< MemoryCalendar > | Ptr |
Public Types inherited from KCalendarCore::Calendar | |
typedef QSharedPointer< Calendar > | Ptr |
Public Types inherited from QObject | |
typedef | QObjectList |
Signals | |
void | createFinished (bool success, const QString &errorMessage) |
void | deleteFinished (bool success, const QString &errorMessage) |
void | modifyFinished (bool success, const QString &errorMessage) |
Signals inherited from KCalendarCore::Calendar | |
void | accessModeChanged () |
void | filterChanged () |
void | iconChanged () |
void | idChanged () |
void | isLoadingChanged () |
void | nameChanged () |
void | ownerChanged () |
Protected Attributes | |
std::unique_ptr< CalendarBasePrivate > const | d_ptr |
Additional Inherited Members | |
Properties inherited from QObject | |
objectName | |
Static Public Member Functions inherited from KCalendarCore::Calendar | |
static Incidence::Ptr | createException (const Incidence::Ptr &incidence, const QDateTime &recurrenceId, bool thisAndFuture=false) |
static Incidence::List | mergeIncidenceList (const Event::List &events, const Todo::List &todos, const Journal::List &journals) |
static Event::List | sortEvents (Event::List &&eventList, EventSortField sortField, SortDirection sortDirection) |
static Journal::List | sortJournals (Journal::List &&journalList, JournalSortField sortField, SortDirection sortDirection) |
static Todo::List | sortTodos (Todo::List &&todoList, TodoSortField sortField, SortDirection sortDirection) |
Static Public Member Functions inherited from QObject | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Static Public Member Functions inherited from KCalendarCore::CustomProperties | |
static QByteArray | customPropertyName (const QByteArray &app, const QByteArray &key) |
Detailed Description
The base class for all akonadi aware calendars.
Because it inherits KCalendarCore::Calendar, it provides seamless integration with KCalendarCore and KCalUtils libraries eliminating any need for adapter ( akonadi<->KCalendarCore ) classes.
- See also
- ETMCalendar
- FetchJobCalendar
- Since
- 4.11
Definition at line 37 of file calendarbase.h.
Member Typedef Documentation
◆ Ptr
Definition at line 41 of file calendarbase.h.
Constructor & Destructor Documentation
◆ CalendarBase() [1/2]
|
explicit |
Constructs a CalendarBase object.
Definition at line 378 of file calendarbase.cpp.
◆ ~CalendarBase()
|
overridedefault |
Destroys the calendar.
◆ CalendarBase() [2/2]
|
protected |
Definition at line 385 of file calendarbase.cpp.
Member Function Documentation
◆ addEvent()
|
overridevirtual |
Adds an Event to the calendar.
It's added to akonadi in the background
- See also
- createFinished().
- Parameters
-
event the event to be added
Implements KCalendarCore::Calendar.
Reimplemented in Akonadi::CollectionCalendar.
Definition at line 543 of file calendarbase.cpp.
◆ addIncidence()
|
overridevirtual |
Adds an incidence to the calendar.
It's added to akonadi in the background
- See also
- createFinished().
- Parameters
-
incidence the incidence to add
Reimplemented from KCalendarCore::Calendar.
Definition at line 573 of file calendarbase.cpp.
◆ addJournal()
|
overridevirtual |
Adds a Journal to the calendar.
It's added to akonadi in the background
- See also
- createFinished().
- Parameters
-
journal the journal to add
Implements KCalendarCore::Calendar.
Reimplemented in Akonadi::CollectionCalendar.
Definition at line 563 of file calendarbase.cpp.
◆ addTodo()
|
overridevirtual |
Adds a Todo to the calendar.
It's added to akonadi in the background
- See also
- createFinished().
- Parameters
-
todo the todo to add
Implements KCalendarCore::Calendar.
Reimplemented in Akonadi::CollectionCalendar.
Definition at line 553 of file calendarbase.cpp.
◆ childIncidences() [1/2]
|
nodiscard |
Returns the child incidences of the parent identified by parentUid
.
Only the direct children are returned
- Parameters
-
parentUid identifier of the parent incidence
Definition at line 491 of file calendarbase.cpp.
◆ childIncidences() [2/2]
|
nodiscard |
Returns the child incidences of the parent identified by parentId
.
Only the direct children are returned
- Parameters
-
parentId identifier of the parent item
Definition at line 471 of file calendarbase.cpp.
◆ childItems() [1/2]
|
nodiscard |
Returns the child items of the parent identified by parentUid
.
Only the direct children are returned
- Parameters
-
parentUid identifier of the parent incidence
Definition at line 527 of file calendarbase.cpp.
◆ childItems() [2/2]
|
nodiscard |
Returns the child items of the parent identified by parentId
.
Only the direct children are returned
- Parameters
-
parentId identifier of the parent item
Definition at line 507 of file calendarbase.cpp.
◆ createFinished
|
signal |
This signal is emitted when an incidence is created in akonadi through add{Incidence,Event,Todo,Journal}.
- Parameters
-
success the success of the operation errorMessage if success
is false, contains the error message
◆ deleteEvent()
|
overridevirtual |
Deletes an Event from the calendar.
It's removed from akonadi in the background
- See also
- deleteFinished().
- Parameters
-
event the event to be deleted
Implements KCalendarCore::Calendar.
Definition at line 548 of file calendarbase.cpp.
◆ deleteFinished
|
signal |
This signal is emitted when an incidence is deleted in akonadi through delete{Incidence,Event,Todo,Journal}.
- Parameters
-
success the success of the operation errorMessage if success
is false, contains the error message
◆ deleteIncidence()
|
overridevirtual |
Deletes an incidence from the calendar.
It's removed from akonadi in the background
- See also
- deleteFinished().
- Parameters
-
incidence the incidence to delete
Reimplemented from KCalendarCore::Calendar.
Definition at line 613 of file calendarbase.cpp.
◆ deleteJournal()
|
overridevirtual |
Deletes a Journal from the calendar.
It's removed from akonadi in the background
- See also
- deleteFinished().
- Parameters
-
journal the journal to delete
Implements KCalendarCore::Calendar.
Definition at line 568 of file calendarbase.cpp.
◆ deleteTodo()
|
overridevirtual |
Deletes a Todo from the calendar.
It's removed from akonadi in the background
- See also
- deleteFinished().
- Parameters
-
todo the todo to delete
Implements KCalendarCore::Calendar.
Definition at line 558 of file calendarbase.cpp.
◆ endBatchAdding()
|
overridevirtual |
Tells the Calendar that you stopped adding a batch of incidences.
- See also
- startBatchAdding()
Reimplemented from KCalendarCore::Calendar.
Definition at line 644 of file calendarbase.cpp.
◆ incidenceChanger()
|
nodiscard |
Returns the IncidenceChanger used by this calendar to make changes in akonadi.
Use this if you need the defaults used by CalendarBase.
Definition at line 633 of file calendarbase.cpp.
◆ item() [1/3]
|
nodiscard |
Returns the Item with id
or an invalid Item if not found.
Definition at line 394 of file calendarbase.cpp.
◆ item() [2/3]
|
nodiscard |
Returns the Item containing incidence
or an invalid Item if the incidence isn't found.
Definition at line 432 of file calendarbase.cpp.
◆ item() [3/3]
|
nodiscard |
Returns the Item containing the incidence with uid uid
or an invalid Item if the incidence isn't found.
- See also
- Use item(Incidence::Ptr) instead where possible. This function doesn't take exceptions (recurrenceId) into account (and thus always returns the main event).
Definition at line 407 of file calendarbase.cpp.
◆ itemList()
|
nodiscard |
Returns the item list that corresponds to the incidenceList
.
Definition at line 455 of file calendarbase.cpp.
◆ items()
|
nodiscard |
Returns the list of items contained in this calendar that belong to the specified collection.
- See also
- incidences()
- Since
- 4.12
Definition at line 437 of file calendarbase.cpp.
◆ modifyFinished
|
signal |
This signal is emitted when an incidence is modified in akonadi through modifyIncidence().
- Parameters
-
success the success of the operation errorMessage if success
is false, contains the error message
◆ modifyIncidence()
bool CalendarBase::modifyIncidence | ( | const KCalendarCore::Incidence::Ptr & | newIncidence | ) |
Modifies an incidence.
The incidence with the same uid as newIncidence
will be updated with the contents of
- Parameters
-
newIncidence the incidence to modify
Definition at line 624 of file calendarbase.cpp.
◆ startBatchAdding()
|
overridevirtual |
Call this to tell the calendar that you're adding a batch of incidences.
So it doesn't, for example, ask the destination for each incidence.
- See also
- endBatchAdding()
Reimplemented from KCalendarCore::Calendar.
Definition at line 639 of file calendarbase.cpp.
Member Data Documentation
◆ d_ptr
|
protected |
Definition at line 221 of file calendarbase.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:14:27 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.