CalendarEvents::CalendarEventsPlugin

Search for usage in LXR

CalendarEvents::CalendarEventsPlugin Class Referenceabstract

#include <CalendarEvents/CalendarEventsPlugin>

Inheritance diagram for CalendarEvents::CalendarEventsPlugin:

Public Types

enum class  SubLabelPriority { Low , Default , High , Urgent }
 

Signals

void alternateCalendarDateReady (const QHash< QDate, QCalendar::YearMonthDay > &data)
 
void dataReady (const QMultiHash< QDate, CalendarEvents::EventData > &data)
 
void eventModified (const CalendarEvents::EventData &modifiedEvent)
 
void eventRemoved (const QString &uid)
 
void subLabelReady (const QHash< QDate, SubLabel > &data)
 

Public Member Functions

 CalendarEventsPlugin (QObject *parent=nullptr)
 
virtual void loadEventsForDateRange (const QDate &startDate, const QDate &endDate)=0
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
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 () const const
 
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 QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
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_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 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
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- 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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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)
 

Detailed Description

Plugin for feeding events to a calendar instance.

Definition at line 182 of file calendareventsplugin.h.

Member Enumeration Documentation

◆ SubLabelPriority

Enumerator
Low 

Usually used in alternate calendars.

Default 

For holidays or normal events.

High 

For flagged or marked events.

Definition at line 187 of file calendareventsplugin.h.

Constructor & Destructor Documentation

◆ CalendarEventsPlugin()

CalendarEvents::CalendarEventsPlugin::CalendarEventsPlugin ( QObject * parent = nullptr)
explicit

Definition at line 11 of file calendareventsplugin.cpp.

◆ ~CalendarEventsPlugin()

CalendarEvents::CalendarEventsPlugin::~CalendarEventsPlugin ( )
override

Definition at line 16 of file calendareventsplugin.cpp.

Member Function Documentation

◆ alternateCalendarDateReady

void CalendarEvents::CalendarEventsPlugin::alternateCalendarDateReady ( const QHash< QDate, QCalendar::YearMonthDay > & data)
signal

Emitted when the plugin has loaded the alternate dates.

Parameters
dataA hash containing a QDate key from Gregorian calendar for the alternate date in the value, QDate.
Since
6.0

◆ dataReady

void CalendarEvents::CalendarEventsPlugin::dataReady ( const QMultiHash< QDate, CalendarEvents::EventData > & data)
signal

Emitted when the plugin has loaded the events data.

Parameters
dataA hash containing a QDate key for the event in the value, CalendarEvents::EventData, which holds all the details for the given event It's a multihash as there can be multiple events in the same day For multi-day events, insert just one with the key being the startdate of the event

◆ eventModified

void CalendarEvents::CalendarEventsPlugin::eventModified ( const CalendarEvents::EventData & modifiedEvent)
signal

Should be emitted when there is a modification of an event that was previously returned via the dataReady() signal.

Parameters
eventThe modified event data

◆ eventRemoved

void CalendarEvents::CalendarEventsPlugin::eventRemoved ( const QString & uid)
signal

Should be emitted when the plugin removes some event from its collection.

Parameters
uidThe uid of the event that was removed

◆ loadEventsForDateRange()

virtual void CalendarEvents::CalendarEventsPlugin::loadEventsForDateRange ( const QDate & startDate,
const QDate & endDate )
pure virtual

When this is called, the plugin should load all events data between those two date ranges.

Once the data are ready, it should just emit the dataReady() signal. The range is usually one month

Parameters
startDatethe start of the range
endDatethe end of the range

◆ subLabelReady

void CalendarEvents::CalendarEventsPlugin::subLabelReady ( const QHash< QDate, SubLabel > & data)
signal

Emitted when the plugin has loaded the sublabels.

Parameters
dataA hash containing a QDate key for the sublabels in the value, SubLabel.
Since
5.95

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:51:26 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.