Akonadi::TagAttribute
#include <tagattribute.h>
Public Member Functions | |
QColor | backgroundColor () const |
TagAttribute * | clone () const override |
void | deserialize (const QByteArray &data) override |
QString | displayName () const |
QString | font () const |
QString | iconName () const |
bool | inToolbar () const |
int | priority () const |
QByteArray | serialized () const override |
void | setBackgroundColor (const QColor &color) |
void | setDisplayName (const QString &name) |
void | setFont (const QString &fontKey) |
void | setIconName (const QString &name) |
void | setInToolbar (bool inToolbar) |
void | setPriority (int priority) |
void | setShortcut (const QString &shortcut) |
void | setTextColor (const QColor &color) |
QString | shortcut () const |
QColor | textColor () const |
QByteArray | type () const override |
Public Member Functions inherited from Akonadi::Attribute | |
virtual | ~Attribute () |
Additional Inherited Members | |
Public Types inherited from Akonadi::Attribute | |
using | List = QList<Attribute *> |
Protected Member Functions inherited from Akonadi::Attribute | |
Attribute (const Attribute &)=default | |
Detailed Description
Attribute that stores the properties that are used to display a tag.
- Since
- 4.13
Definition at line 26 of file tagattribute.h.
Constructor & Destructor Documentation
◆ TagAttribute()
|
explicit |
Definition at line 26 of file tagattribute.cpp.
Member Function Documentation
◆ backgroundColor()
|
nodiscard |
Definition at line 143 of file tagattribute.cpp.
◆ clone()
|
overridevirtual |
Creates a copy of this attribute.
Implements Akonadi::Attribute.
Definition at line 59 of file tagattribute.cpp.
◆ deserialize()
|
overridevirtual |
Sets the data of this attribute, using the same encoding as returned by toByteArray().
- Parameters
-
data The encoded attribute data.
Implements Akonadi::Attribute.
Definition at line 121 of file tagattribute.cpp.
◆ displayName()
|
nodiscard |
Returns the name that should be used for display.
Users of this should fall back to Collection::name() if this is empty.
Definition at line 33 of file tagattribute.cpp.
◆ font()
|
nodiscard |
Definition at line 168 of file tagattribute.cpp.
◆ iconName()
|
nodiscard |
Returns the icon name of the icon returned by icon().
Definition at line 43 of file tagattribute.cpp.
◆ inToolbar()
|
nodiscard |
Definition at line 178 of file tagattribute.cpp.
◆ priority()
|
nodiscard |
Returns the priority of the tag.
The default value is -1
Definition at line 198 of file tagattribute.cpp.
◆ serialized()
|
nodiscardoverridevirtual |
Returns a QByteArray representation of the attribute which will be storaged.
This can be raw binary data, no encoding needs to be applied.
Implements Akonadi::Attribute.
Definition at line 73 of file tagattribute.cpp.
◆ setBackgroundColor()
void TagAttribute::setBackgroundColor | ( | const QColor & | color | ) |
Definition at line 148 of file tagattribute.cpp.
◆ setDisplayName()
void TagAttribute::setDisplayName | ( | const QString & | name | ) |
Sets the name
that should be used for display.
Definition at line 38 of file tagattribute.cpp.
◆ setFont()
void TagAttribute::setFont | ( | const QString & | fontKey | ) |
Definition at line 163 of file tagattribute.cpp.
◆ setIconName()
void TagAttribute::setIconName | ( | const QString & | name | ) |
Sets the icon name
for the default icon.
Definition at line 48 of file tagattribute.cpp.
◆ setInToolbar()
void TagAttribute::setInToolbar | ( | bool | inToolbar | ) |
Definition at line 173 of file tagattribute.cpp.
◆ setPriority()
void TagAttribute::setPriority | ( | int | priority | ) |
Sets the priority of the tag.
The priority is primarily used for presentation, e.g. for sorting. If only one tag can be displayed for a given item, the one with the highest priority should be shown.
Definition at line 193 of file tagattribute.cpp.
◆ setShortcut()
void TagAttribute::setShortcut | ( | const QString & | shortcut | ) |
Definition at line 183 of file tagattribute.cpp.
◆ setTextColor()
void TagAttribute::setTextColor | ( | const QColor & | color | ) |
Definition at line 153 of file tagattribute.cpp.
◆ shortcut()
|
nodiscard |
Definition at line 188 of file tagattribute.cpp.
◆ textColor()
|
nodiscard |
Definition at line 158 of file tagattribute.cpp.
◆ type()
|
nodiscardoverridevirtual |
Returns the type of the attribute.
Implements Akonadi::Attribute.
Definition at line 53 of file tagattribute.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:01:01 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.