Akonadi::FetchJobCalendar

Akonadi::FetchJobCalendar Class Reference

#include <fetchjobcalendar.h>

Inheritance diagram for Akonadi::FetchJobCalendar:

Public Types

typedef QSharedPointer< FetchJobCalendarPtr
 
- Public Types inherited from Akonadi::CalendarBase
typedef QSharedPointer< CalendarBasePtr
 
- Public Types inherited from KCalendarCore::MemoryCalendar
typedef QSharedPointer< MemoryCalendarPtr
 
- Public Types inherited from KCalendarCore::Calendar
typedef QSharedPointer< CalendarPtr
 

Signals

void loadFinished (bool success, const QString &errorMessage)
 
- 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 filterChanged ()
 

Public Member Functions

 FetchJobCalendar (QObject *parent=nullptr)
 
 ~FetchJobCalendar () override
 
bool isLoaded () const override
 
- Public Member Functions inherited from Akonadi::CalendarBase
 CalendarBase (QObject *parent=nullptr)
 
 ~CalendarBase () override
 
bool addEvent (const KCalendarCore::Event::Ptr &event) override
 
bool addIncidence (const KCalendarCore::Incidence::Ptr &incidence) override
 
bool addJournal (const KCalendarCore::Journal::Ptr &journal) override
 
bool addTodo (const KCalendarCore::Todo::Ptr &todo) override
 
KCalendarCore::Incidence::List childIncidences (const QString &parentUid) const
 
KCalendarCore::Incidence::List childIncidences (Item::Id parentId) const
 
Akonadi::Item::List childItems (const QString &parentUid) const
 
Akonadi::Item::List childItems (Item::Id parentId) const
 
bool deleteEvent (const KCalendarCore::Event::Ptr &event) override
 
bool deleteIncidence (const KCalendarCore::Incidence::Ptr &incidence) override
 
bool deleteJournal (const KCalendarCore::Journal::Ptr &journal) override
 
bool deleteTodo (const KCalendarCore::Todo::Ptr &todo) override
 
void endBatchAdding () override
 
Akonadi::IncidenceChanger * incidenceChanger () const
 
Akonadi::Item item (const QString &uid) const
 
Akonadi::Item item (const KCalendarCore::Incidence::Ptr &incidence) const
 
Akonadi::Item item (Akonadi::Item::Id) const
 
Akonadi::Item::List itemList (const KCalendarCore::Incidence::List &incidenceList) const
 
Akonadi::Item::List items (Akonadi::Collection::Id=-1) const
 
bool modifyIncidence (const KCalendarCore::Incidence::Ptr &newIncidence)
 
void startBatchAdding () override
 
- Public Member Functions inherited from KCalendarCore::MemoryCalendar
 MemoryCalendar (const QTimeZone &timeZone)
 
 MemoryCalendar (const QByteArray &timeZoneId)
 
Alarm::List alarms (const QDateTime &from, const QDateTime &to, bool excludeBlockedAlarms=false) const override
 
Alarm::List alarmsTo (const QDateTime &to) const
 
void close () override
 
Event::Ptr deletedEvent (const QString &uid, const QDateTime &recurrenceId={}) const override
 
Event::List deletedEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const override
 
Journal::Ptr deletedJournal (const QString &uid, const QDateTime &recurrenceId={}) const override
 
Journal::List deletedJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const override
 
Todo::Ptr deletedTodo (const QString &uid, const QDateTime &recurrenceId={}) const override
 
Todo::List deletedTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const override
 
bool deleteEventInstances (const Event::Ptr &event) override
 
bool deleteIncidenceInstances (const Incidence::Ptr &incidence) override
 
bool deleteJournalInstances (const Journal::Ptr &journal) override
 
bool deleteTodoInstances (const Todo::Ptr &todo) override
 
void doSetTimeZone (const QTimeZone &timeZone) override
 
Event::Ptr event (const QString &uid, const QDateTime &recurrenceId={}) const override
 
Event::List eventInstances (const Incidence::Ptr &event, EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const override
 
void incidenceUpdate (const QString &uid, const QDateTime &recurrenceId) override
 
void incidenceUpdated (const QString &uid, const QDateTime &recurrenceId) override
 
Incidence::Ptr instance (const QString &identifier) const
 
Journal::Ptr journal (const QString &uid, const QDateTime &recurrenceId={}) const override
 
Journal::List journalInstances (const Incidence::Ptr &journal, JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const override
 
Event::List rawEvents (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const override
 
Event::List rawEvents (const QDate &start, const QDate &end, const QTimeZone &timeZone={}, bool inclusive=false) const override
 
Event::List rawEventsForDate (const QDateTime &dt) const override
 
Event::List rawEventsForDate (const QDate &date, const QTimeZone &timeZone={}, EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const override
 
Journal::List rawJournals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const override
 
Journal::List rawJournalsForDate (const QDate &date) const override
 
Todo::List rawTodos (const QDate &start, const QDate &end, const QTimeZone &timeZone={}, bool inclusive=false) const override
 
Todo::List rawTodos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const override
 
Todo::List rawTodosForDate (const QDate &date) const override
 
Todo::Ptr todo (const QString &uid, const QDateTime &recurrenceId={}) const override
 
Todo::List todoInstances (const Incidence::Ptr &todo, TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const override
 
- Public Member Functions inherited from KCalendarCore::Calendar
 Calendar (const QTimeZone &timeZone)
 
 Calendar (const QByteArray &timeZoneId)
 
bool addNotebook (const QString &notebook, bool isVisible)
 
bool batchAdding () const
 
virtual bool beginChange (const Incidence::Ptr &incidence)
 
QStringList categories () const
 
virtual void clearNotebookAssociations ()
 
QString defaultNotebook () const
 
Incidence::Ptr deleted (const QString &uid, const QDateTime &recurrenceId={}) const
 
bool deleteNotebook (const QString &notebook)
 
virtual Incidence::List duplicates (const Incidence::Ptr &incidence)
 
virtual bool endChange (const Incidence::Ptr &incidence)
 
virtual Event::List events (EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
 
Event::List events (const QDateTime &dt) const
 
Event::List events (const QDate &start, const QDate &end, const QTimeZone &timeZone={}, bool inclusive=false) const
 
Event::List events (const QDate &date, const QTimeZone &timeZone={}, EventSortField sortField=EventSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
 
CalFilterfilter () const
 
bool hasValidNotebook (const QString &notebook) const
 
Incidence::Ptr incidence (const QString &uid, const QDateTime &recurrenceId={}) const
 
virtual Incidence::Ptr incidenceFromSchedulingID (const QString &sid) const
 
virtual Incidence::List incidences () const
 
virtual Incidence::List incidences (const QDate &date) const
 
virtual Incidence::List incidences (const QString &notebook) const
 
virtual Incidence::List incidencesFromSchedulingID (const QString &sid) const
 
virtual Incidence::List instances (const Incidence::Ptr &incidence) const
 
bool isAncestorOf (const Incidence::Ptr &ancestor, const Incidence::Ptr &incidence) const
 
bool isModified () const
 
virtual bool isSaving () const
 
bool isVisible (const Incidence::Ptr &incidence) const
 
bool isVisible (const QString &notebook) const
 
virtual Journal::List journals (JournalSortField sortField=JournalSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
 
virtual Journal::List journals (const QDate &date) const
 
virtual QString notebook (const Incidence::Ptr &incidence) const
 
virtual QString notebook (const QString &uid) const
 
virtual QStringList notebooks () const
 
Person owner () const
 
QString productId () const
 
virtual Incidence::List rawIncidences () const
 
void registerObserver (CalendarObserver *observer)
 
Incidence::List relations (const QString &uid) const
 
virtual bool reload ()
 
virtual void removeRelations (const Incidence::Ptr &incidence)
 
virtual bool save ()
 
bool setDefaultNotebook (const QString &notebook)
 
void setFilter (CalFilter *filter)
 
void setModified (bool modified)
 
virtual bool setNotebook (const Incidence::Ptr &incidence, const QString &notebook)
 
void setOwner (const Person &owner)
 
void setProductId (const QString &id)
 
void setTimeZone (const QTimeZone &timeZone)
 
void setTimeZoneId (const QByteArray &timeZoneId)
 
virtual void setupRelations (const Incidence::Ptr &incidence)
 
void shiftTimes (const QTimeZone &oldZone, const QTimeZone &newZone)
 
QTimeZone timeZone () const
 
QByteArray timeZoneId () const
 
virtual Todo::List todos (const QDate &date) const
 
virtual Todo::List todos (TodoSortField sortField=TodoSortUnsorted, SortDirection sortDirection=SortDirectionAscending) const
 
virtual Todo::List todos (const QDate &start, const QDate &end, const QTimeZone &timeZone={}, bool inclusive=false) const
 
void unregisterObserver (CalendarObserver *observer)
 
bool updateNotebook (const QString &notebook, bool isVisible)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 
- Public Member Functions inherited from KCalendarCore::CustomProperties
 CustomProperties (const CustomProperties &other)
 
QMap< QByteArray, QStringcustomProperties () const
 
QString customProperty (const QByteArray &app, const QByteArray &key) const
 
QString nonKDECustomProperty (const QByteArray &name) const
 
QString nonKDECustomPropertyParameters (const QByteArray &name) const
 
CustomPropertiesoperator= (const CustomProperties &other)
 
bool operator== (const CustomProperties &properties) const
 
void removeCustomProperty (const QByteArray &app, const QByteArray &key)
 
void removeNonKDECustomProperty (const QByteArray &name)
 
void setCustomProperties (const QMap< QByteArray, QString > &properties)
 
void setCustomProperty (const QByteArray &app, const QByteArray &key, const QString &value)
 
void setNonKDECustomProperty (const QByteArray &name, const QString &value, const QString &parameters=QString())
 

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 (const Event::List &eventList, EventSortField sortField, SortDirection sortDirection)
 
static Journal::List sortJournals (const Journal::List &journalList, JournalSortField sortField, SortDirection sortDirection)
 
static Todo::List sortTodos (const 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
bool deletionTracking () const
 
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 setDeletionTracking (bool enable)
 
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
 
QObjectsender () 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
QScopedPointer< CalendarBasePrivate > d_ptr
 

Detailed Description

A KCalendarCore::Calendar that uses a one time IncidenceFetchJob to populate itself.

If you want a persistent calendar ( which monitors Akonadi for changes ) use an ETMCalendar.

See also
ETMCalendar
CalendarBase
Author
Sérgio Martins sergi[email protected]o.ma[email protected]rtins[email protected]@kda[email protected]b.com
Since
4.11

Definition at line 30 of file fetchjobcalendar.h.

Constructor & Destructor Documentation

FetchJobCalendar::FetchJobCalendar ( QObject parent = nullptr)
explicit

Creates a new FetchJobCalendar.

Loading begins asynchronously.

See also
loadFinished()

Definition at line 69 of file fetchjobcalendar.cpp.

FetchJobCalendar::~FetchJobCalendar ( )
override

Destroys this FetchJobCalendar.

Definition at line 74 of file fetchjobcalendar.cpp.

Member Function Documentation

bool FetchJobCalendar::isLoaded ( ) const
overridevirtual

Returns if the calendar already finished loading.

This is an alternative to listening for the loadFinished() signal.

Reimplemented from Akonadi::CalendarBase.

Definition at line 78 of file fetchjobcalendar.cpp.

void Akonadi::FetchJobCalendar::loadFinished ( bool  success,
const QString errorMessage 
)
signal

This signal is emitted when the IncidenceFetchJob finishes.

Parameters
successthe success of the operation
errorMessageif success is false, contains the error message

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Aug 14 2020 23:10:37 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.