Akonadi::EntityDisplayAttribute Class

class Akonadi::EntityDisplayAttribute

Attribute that stores the properties that are used to display an entity. More...

Header:	`#include <Akonadi/EntityDisplayAttribute>`
CMake:	`find_package(KPim6 REQUIRED COMPONENTS AkonadiCore)` `target_link_libraries(mytarget PRIVATE KPim6::AkonadiCore)`
Inherits:	Akonadi::Attribute

List of all members, including inherited members

Public Functions

	EntityDisplayAttribute()
virtual	~EntityDisplayAttribute() override
QIcon	activeIcon() const
QString	activeIconName() const
QColor	backgroundColor() const
QString	displayName() const
QIcon	icon() const
QString	iconName() const
void	setActiveIconName(const QString &name)
void	setBackgroundColor(const QColor &color)
void	setDisplayName(const QString &name)
void	setIconName(const QString &name)

Detailed Description

Display properties of a collection or item, such as translated names and icons.

Author: Volker Krause <vkrause@kde.org>

Member Function Documentation

`[explicit]` EntityDisplayAttribute::EntityDisplayAttribute()

Creates a new entity display attribute.

`[override virtual noexcept]` EntityDisplayAttribute::~EntityDisplayAttribute()

Destroys the entity display attribute.

QIcon EntityDisplayAttribute::activeIcon() const

Returns the icon that should be used for this collection or item when active.

QString EntityDisplayAttribute::activeIconName() const

Returns the icon name of an active item.

See also setActiveIconName().

QColor EntityDisplayAttribute::backgroundColor() const

Returns the backgroundColor or an invalid color if none is set.

See also setBackgroundColor().

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.

See also setDisplayName().

QIcon EntityDisplayAttribute::icon() const

Returns the icon that should be used for this collection or item.

QString EntityDisplayAttribute::iconName() const

Returns the icon name of the icon returned by icon().

See also setIconName().

void EntityDisplayAttribute::setActiveIconName(const QString &name)

Sets the icon name for the active icon. name the icon name to use

See also activeIconName().

void EntityDisplayAttribute::setBackgroundColor(const QColor &color)

Sets the backgroundColor to color. color the background color to use

See also backgroundColor().

void EntityDisplayAttribute::setDisplayName(const QString &name)

Sets the name that should be used for display.

See also displayName().

void EntityDisplayAttribute::setIconName(const QString &name)

Sets the icon name for the default icon.

See also iconName().

Contents