akonadi
Akonadi::EntityDisplayAttribute Class Reference
Attribute that stores the properties that are used to display an entity. More...
#include <entitydisplayattribute.h>

Public Member Functions | |
EntityDisplayAttribute * | clone () const |
void | deserialize (const QByteArray &data) |
QString | displayName () const |
EntityDisplayAttribute () | |
KIcon | icon () const |
QString | iconName () const |
QByteArray | serialized () const |
void | setDisplayName (const QString &name) |
void | setIconName (const QString &name) |
QByteArray | type () const |
~EntityDisplayAttribute () |
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.
- Todo:
- add active icon, eg. when folder contains unread mail, or a mail is unread
- Since:
- 4.2
Definition at line 38 of file entitydisplayattribute.h.
Constructor & Destructor Documentation
EntityDisplayAttribute::EntityDisplayAttribute | ( | ) |
EntityDisplayAttribute::~EntityDisplayAttribute | ( | ) |
Member Function Documentation
EntityDisplayAttribute * EntityDisplayAttribute::clone | ( | ) | const [virtual] |
Creates a copy of this attribute.
Implements Akonadi::Attribute.
Definition at line 75 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 91 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 45 of file entitydisplayattribute.cpp.
KIcon EntityDisplayAttribute::icon | ( | ) | const |
Returns the icon that should be used for this collection or item.
Definition at line 55 of file entitydisplayattribute.cpp.
QString EntityDisplayAttribute::iconName | ( | ) | const |
Returns the icon name of the icon returned by icon().
Definition at line 60 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 83 of file entitydisplayattribute.cpp.
void EntityDisplayAttribute::setDisplayName | ( | const QString & | name | ) |
Sets the name
that should be used for display.
Definition at line 50 of file entitydisplayattribute.cpp.
void EntityDisplayAttribute::setIconName | ( | const QString & | name | ) |
QByteArray Akonadi::EntityDisplayAttribute::type | ( | ) | const [virtual] |
Returns the type of the attribute.
Implements Akonadi::Attribute.
Definition at line 70 of file entitydisplayattribute.cpp.
The documentation for this class was generated from the following files: