Akonadi::ETMCalendar
#include <etmcalendar.h>
Public Types | |
enum | CollectionColumn { CollectionTitle = 0 , CollectionColumnCount } |
using | Ptr = QSharedPointer<ETMCalendar> |
Public Types inherited from Akonadi::CalendarBase | |
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 | calendarChanged () |
void | calendarSelectionEdited () |
void | collectionChanged (const Akonadi::Collection &collection, const QSet< QByteArray > &attributeNames) |
void | collectionsAdded (const Akonadi::Collection::List &collection) |
void | collectionsRemoved (const Akonadi::Collection::List &collection) |
Signals inherited from Akonadi::CalendarBase | |
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 () |
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) |
Protected Member Functions inherited from Akonadi::CalendarBase | |
CalendarBase (CalendarBasePrivate *const d, QObject *parent) | |
Protected Member Functions inherited from KCalendarCore::MemoryCalendar | |
void | virtual_hook (int id, void *data) override |
Protected Member Functions inherited from KCalendarCore::Calendar | |
void | appendAlarms (Alarm::List &alarms, const Incidence::Ptr &incidence, const QDateTime &from, const QDateTime &to) const |
void | appendRecurringAlarms (Alarm::List &alarms, const Incidence::Ptr &incidence, const QDateTime &from, const QDateTime &to) const |
void | customPropertyUpdated () override |
void | notifyIncidenceAboutToBeDeleted (const Incidence::Ptr &incidence) |
void | notifyIncidenceAdded (const Incidence::Ptr &incidence) |
void | notifyIncidenceAdditionCanceled (const Incidence::Ptr &incidence) |
void | notifyIncidenceChanged (const Incidence::Ptr &incidence) |
void | notifyIncidenceDeleted (const Incidence::Ptr &incidence) |
void | setIsLoading (bool isLoading) |
void | setObserversEnabled (bool enabled) |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Protected Member Functions inherited from KCalendarCore::CustomProperties | |
virtual void | customPropertyUpdate () |
Protected Attributes inherited from Akonadi::CalendarBase | |
std::unique_ptr< CalendarBasePrivate > const | d_ptr |
Detailed Description
A KCalendarCore::Calendar that uses an EntityTreeModel to populate itself.
All non-idempotent KCalendarCore::Calendar methods interact with Akonadi. If you need a need a non-persistent calendar use FetchJobCalendar.
ETMCalendar allows to be populated with only a subset of your calendar items, by using a KCheckableProxyModel to specify which collections to be used and/or by setting a KCalendarCore::CalFilter.
- See also
- FetchJobCalendar
- CalendarBase
- Since
- 4.11
Definition at line 40 of file etmcalendar.h.
Member Typedef Documentation
◆ Ptr
Definition at line 49 of file etmcalendar.h.
Member Enumeration Documentation
◆ CollectionColumn
enum Akonadi::ETMCalendar::CollectionColumn |
Definition at line 44 of file etmcalendar.h.
Constructor & Destructor Documentation
◆ ETMCalendar() [1/4]
|
explicit |
Constructs a new ETMCalendar.
Loading begins immediately, asynchronously.
Definition at line 420 of file etmcalendar.cpp.
◆ ETMCalendar() [2/4]
|
explicit |
Constructs a new ETMCalendar that will only load the specified mime types.
Use this ctor to ignore journals or to-dos for example. If no mime types are specified, all mime types will be used.
Definition at line 427 of file etmcalendar.cpp.
◆ ETMCalendar() [3/4]
|
explicit |
Constructs a new ETMCalendar.
This overload exists for optimization reasons, it allows to share an EntityTreeModel across several ETMCalendars to save memory.
Usually when having many ETMCalendars, the only bit that's different is the collection selection. The memory hungry EntityTreeModel is the same, so should be shared.
- Parameters
-
calendar an existing ETMCalendar who's EntityTreeModel is to be used.
- Since
- 4.13
Definition at line 435 of file etmcalendar.cpp.
◆ ETMCalendar() [4/4]
Definition at line 448 of file etmcalendar.cpp.
◆ ~ETMCalendar()
|
overridedefault |
Destroys this ETMCalendar.
Member Function Documentation
◆ alarms()
|
nodiscardoverridevirtual |
Returns all alarms occurring in a specified time interval.
- Parameters
-
from start date of interval to end data of interval excludeBlockedAlarms if true, alarms belonging to blocked collections aren't returned.
Implements KCalendarCore::Calendar.
Definition at line 501 of file etmcalendar.cpp.
◆ calendarChanged
|
signal |
Emitted whenever an Item is inserted, removed or modified.
◆ calendarSelectionEdited
|
signal |
Emitted whenever the set selected (checked) calendars was modified by the user.
Typically used to save that new selection to a config file.
- Since
- 6.1.40
◆ checkableProxyModel()
|
nodiscard |
Returns the KCheckableProxyModel used to select from which collections should the calendar be populated from.
Definition at line 495 of file etmcalendar.cpp.
◆ collection()
|
nodiscard |
Returns the collection having id
.
Use this instead of creating a new collection, the returned collection will have the correct right, name, display name, etc all set.
Definition at line 469 of file etmcalendar.cpp.
◆ collectionChanged
|
signal |
This signal is emitted if a collection has been changed (properties or attributes).
- Parameters
-
collection The changed collection. attributeNames The names of the collection attributes that have been changed.
◆ collectionFilteringEnabled()
|
nodiscard |
Returns whether collection filtering is enabled.
Default is true.
- See also
- setCollectionFilteringEnabled()
Definition at line 576 of file etmcalendar.cpp.
◆ collectionsAdded
|
signal |
This signal is emitted when one or more collections are added to the ETM.
- Parameters
-
collection non empty list of collections
◆ collectionsRemoved
|
signal |
This signal is emitted when one or more collections are deleted from the ETM.
- Parameters
-
collection non empty list of collections
◆ entityTreeModel()
|
nodiscard |
Returns the underlying EntityTreeModel.
For most uses, you'll want model() or the KCalendarCore::Calendar interface instead.
It contains every item and collection with calendar mime type, doesn't have KCalendarCore filtering and doesn't honour any collection selection.
This method is exposed for performance reasons only, so you can reuse it, since it's resource savvy.
- See also
- model()
Definition at line 552 of file etmcalendar.cpp.
◆ hasRight() [1/2]
|
nodiscard |
Returns true if the collection owning incidence has
righ right
.
Definition at line 480 of file etmcalendar.cpp.
◆ hasRight() [2/2]
|
nodiscard |
This is an overloaded function.
- Parameters
-
uid the identifier for the incidence to check for rights right the access right to check for
- See also
- hasRight()
Definition at line 475 of file etmcalendar.cpp.
◆ model()
|
nodiscard |
Convenience method to access the contents of this KCalendarCore::Calendar through a QAIM interface.
Like through calendar interface, the model only items of selected collections. To select or unselect collections, see checkableProxyModel().
Definition at line 489 of file etmcalendar.cpp.
◆ setCollectionFilteringEnabled()
void ETMCalendar::setCollectionFilteringEnabled | ( | bool | enable | ) |
Enable or disable collection filtering.
If true, the calendar will only contain items of selected collections.
- Parameters
-
enable enables collection filtering if set as true
Definition at line 558 of file etmcalendar.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 16:57:41 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.