EventViews::CalendarDecoration::Element Class
Class for calendar decoration elements. More...
| Header: | #include <Element> |
| CMake: | find_package(KPim6 REQUIRED COMPONENTS EventViews)target_link_libraries(mytarget PRIVATE KPim6::EventViews) |
| Inherited By: |
Public Functions
| Element(const QString &id) | |
| virtual | ~Element() override |
| 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 |
Signals
| void | gotNewExtensiveText(const QString &) |
| void | gotNewLongText(const QString &) |
| void | gotNewPixmap(const QPixmap &) |
| void | gotNewShortText(const QString &) |
| void | gotNewUrl(const QUrl &) |
Detailed Description
It provides entities like texts and pictures for a given date. Implementations can implement all functions or only a subset.
Member Function Documentation
[explicit] Element::Element(const QString &id)
[override virtual noexcept] Element::~Element()
[virtual] QString Element::elementInfo() const
Description of element.
[virtual] QString Element::extensiveText() const
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.
[signal] void Element::gotNewExtensiveText(const QString &)
[signal] void Element::gotNewLongText(const QString &)
[signal] void Element::gotNewPixmap(const QPixmap &)
[signal] void Element::gotNewShortText(const QString &)
[signal] void Element::gotNewUrl(const QUrl &)
[virtual] QString Element::id() const
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.
[virtual] QString Element::longText() const
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.
[virtual] QPixmap Element::newPixmap(const QSize &)
Return a pixmap for a given date and a given size.
[virtual] QString Element::shortText() const
Return a short text for a given date, usually only a few words.
[virtual] QUrl Element::url() const
Return a URL pointing to more information about the content of the element.