#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
Constructor & Destructor Documentation
Akonadi::EntityDisplayAttribute::EntityDisplayAttribute | ( | ) |
Creates a new entity display attribute.
Akonadi::EntityDisplayAttribute::~EntityDisplayAttribute | ( | ) |
Destroys the entity display attribute.
Member Function Documentation
KIcon Akonadi::EntityDisplayAttribute::activeIcon | ( | ) | const |
Returns the icon that should be used for this collection or item when active.
- Since:
- 4.4
QString Akonadi::EntityDisplayAttribute::activeIconName | ( | ) | const |
Returns the icon name of an active item.
- Since:
- 4.4
QColor Akonadi::EntityDisplayAttribute::backgroundColor | ( | ) | const |
Returns the backgroundColor or an invalid color if none is set.
- Since:
- 4.4
EntityDisplayAttribute* Akonadi::EntityDisplayAttribute::clone | ( | ) | const [virtual] |
Creates a copy of this attribute.
Implements Akonadi::Attribute.
void Akonadi::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.
QString Akonadi::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.
KIcon Akonadi::EntityDisplayAttribute::icon | ( | ) | const |
Returns the icon that should be used for this collection or item.
QString Akonadi::EntityDisplayAttribute::iconName | ( | ) | const |
Returns the icon name of the icon returned by icon().
QByteArray Akonadi::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.
void Akonadi::EntityDisplayAttribute::setActiveIconName | ( | const QString & | name | ) |
Sets the icon name
for the active icon.
- Since:
- 4.4
void Akonadi::EntityDisplayAttribute::setBackgroundColor | ( | const QColor & | color | ) |
Sets the backgroundColor to color
.
- Since:
- 4.4
void Akonadi::EntityDisplayAttribute::setDisplayName | ( | const QString & | name | ) |
Sets the name
that should be used for display.
void Akonadi::EntityDisplayAttribute::setIconName | ( | const QString & | name | ) |
Sets the icon name
for the default icon.
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: