EventViews::CalendarDecoration::Element

Search for usage in LXR

EventViews::CalendarDecoration::Element Class Reference

#include <calendardecoration.h>

Inheritance diagram for EventViews::CalendarDecoration::Element:

Public Types

using List = QList<Element *>
 
- Public Types inherited from QObject
typedef  QObjectList
 

Signals

void gotNewExtensiveText (const QString &)
 
void gotNewLongText (const QString &)
 
void gotNewPixmap (const QPixmap &)
 
void gotNewShortText (const QString &)
 
void gotNewUrl (const QUrl &)
 

Public Member Functions

 Element (const QString &id)
 
virtual QString elementInfo () const
 
virtual QString extensiveText () const
 
virtual QString id () const
 
virtual QString longText () const
 
virtual QPixmap newPixmap (const QSize &)
 
virtual QString shortText () const
 
virtual QUrl url () const
 
- 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
 

Protected Attributes

QString mId
 

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)
 
- 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

Class for calendar decoration elements.

It provides entities like texts and pictures for a given date. Implementations can implement all functions or only a subset.

Definition at line 29 of file calendardecoration.h.

Member Typedef Documentation

◆ List

Constructor & Destructor Documentation

◆ Element()

Element::Element ( const QString & id)
explicit

Definition at line 10 of file calendardecoration.cpp.

Member Function Documentation

◆ elementInfo()

QString Element::elementInfo ( ) const
nodiscardvirtual

Description of element.

Definition at line 22 of file calendardecoration.cpp.

◆ extensiveText()

QString Element::extensiveText ( ) const
nodiscardvirtual

Return an extensive text for a given date.

This text can be of any length, but usually it will have one or a few paragraphs.

Reimplemented in EventViews::CalendarDecoration::StoredElement.

Definition at line 37 of file calendardecoration.cpp.

◆ id()

QString Element::id ( ) const
nodiscardvirtual

Return a name for easy identification.

This will be used for example for internal configuration (position, etc.), so don't i18n it and make it unique for your decoration.

Definition at line 17 of file calendardecoration.cpp.

◆ longText()

QString Element::longText ( ) const
nodiscardvirtual

Return a long text for a given date.

This text can be of any length, but usually it will have one or a few lines.

Can for example be used as a tool tip.

Reimplemented in EventViews::CalendarDecoration::StoredElement.

Definition at line 32 of file calendardecoration.cpp.

◆ newPixmap()

QPixmap Element::newPixmap ( const QSize & )
nodiscardvirtual

Return a pixmap for a given date and a given size.

Definition at line 42 of file calendardecoration.cpp.

◆ shortText()

QString Element::shortText ( ) const
nodiscardvirtual

Return a short text for a given date, usually only a few words.

Reimplemented in EventViews::CalendarDecoration::StoredElement.

Definition at line 27 of file calendardecoration.cpp.

◆ url()

QUrl Element::url ( ) const
nodiscardvirtual

Return a URL pointing to more information about the content of the element.

Reimplemented in EventViews::CalendarDecoration::StoredElement.

Definition at line 47 of file calendardecoration.cpp.

Member Data Documentation

◆ mId

QString EventViews::CalendarDecoration::Element::mId
protected

Definition at line 92 of file calendardecoration.h.


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 Sat Dec 21 2024 16:57:56 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.