Akonadi::EntityDisplayAttribute Class Reference
Attribute that stores the properties that are used to display an entity. More...
#include <entitydisplayattribute.h>
Public Member Functions | |
| EntityDisplayAttribute () | |
| ~EntityDisplayAttribute () | |
| KIcon | activeIcon () const |
| QString | activeIconName () const |
| QColor | backgroundColor () const |
| EntityDisplayAttribute * | clone () const |
| void | deserialize (const QByteArray &data) |
| QString | displayName () const |
| KIcon | icon () const |
| QString | iconName () const |
| QByteArray | serialized () const |
| void | setActiveIconName (const QString &name) |
| void | setBackgroundColor (const QColor &color) |
| void | setDisplayName (const QString &name) |
| void | setIconName (const QString &name) |
| QByteArray | type () const |
Detailed Description
Attribute that stores the properties that are used to display an entity.
Display properties of a collection or item, such as translated names and icons.
- Since:
- 4.2
Definition at line 39 of file entitydisplayattribute.h.
Constructor & Destructor Documentation
| EntityDisplayAttribute::EntityDisplayAttribute | ( | ) |
Creates a new entity display attribute.
Definition at line 39 of file entitydisplayattribute.cpp.
| EntityDisplayAttribute::~EntityDisplayAttribute | ( | ) |
Destroys the entity display attribute.
Definition at line 44 of file entitydisplayattribute.cpp.
Member Function Documentation
| KIcon EntityDisplayAttribute::activeIcon | ( | ) | const |
Returns the icon that should be used for this collection or item when active.
- Since:
- 4.4
Definition at line 145 of file entitydisplayattribute.cpp.
| QString EntityDisplayAttribute::activeIconName | ( | ) | const |
Returns the icon name of an active item.
- Since:
- 4.4
Definition at line 150 of file entitydisplayattribute.cpp.
| QColor EntityDisplayAttribute::backgroundColor | ( | ) | const |
Returns the backgroundColor or an invalid color if none is set.
- Since:
- 4.4
Definition at line 155 of file entitydisplayattribute.cpp.
| EntityDisplayAttribute * EntityDisplayAttribute::clone | ( | ) | const [virtual] |
Creates a copy of this attribute.
Implements Akonadi::Attribute.
Definition at line 79 of file entitydisplayattribute.cpp.
| void EntityDisplayAttribute::deserialize | ( | const QByteArray & | data | ) | [virtual] |
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 108 of file entitydisplayattribute.cpp.
| QString EntityDisplayAttribute::displayName | ( | ) | const |
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 49 of file entitydisplayattribute.cpp.
| KIcon EntityDisplayAttribute::icon | ( | ) | const |
Returns the icon that should be used for this collection or item.
Definition at line 59 of file entitydisplayattribute.cpp.
| QString EntityDisplayAttribute::iconName | ( | ) | const |
Returns the icon name of the icon returned by icon().
Definition at line 64 of file entitydisplayattribute.cpp.
| QByteArray EntityDisplayAttribute::serialized | ( | ) | const [virtual] |
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 89 of file entitydisplayattribute.cpp.
| void EntityDisplayAttribute::setActiveIconName | ( | const QString & | name | ) |
Sets the icon name for the active icon.
- Since:
- 4.4
Definition at line 140 of file entitydisplayattribute.cpp.
| void EntityDisplayAttribute::setBackgroundColor | ( | const QColor & | color | ) |
Sets the backgroundColor to color.
- Since:
- 4.4
Definition at line 160 of file entitydisplayattribute.cpp.
| void EntityDisplayAttribute::setDisplayName | ( | const QString & | name | ) |
Sets the name that should be used for display.
Definition at line 54 of file entitydisplayattribute.cpp.
| void EntityDisplayAttribute::setIconName | ( | const QString & | name | ) |
Sets the icon name for the default icon.
Definition at line 69 of file entitydisplayattribute.cpp.
| QByteArray Akonadi::EntityDisplayAttribute::type | ( | ) | const [virtual] |
Returns the type of the attribute.
Implements Akonadi::Attribute.
Definition at line 74 of file entitydisplayattribute.cpp.
The documentation for this class was generated from the following files:
