Akonadi::TagAttribute Class

class Akonadi::TagAttribute

Attribute that stores the properties that are used to display a tag. More...

Header:	`#include <Akonadi/TagAttribute>`
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

QColor	backgroundColor() const
QString	displayName() const
QString	font() const
QString	iconName() const
bool	inToolbar() const
int	priority() const
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

Detailed Description

Member Function Documentation

QColor TagAttribute::backgroundColor() const

See also setBackgroundColor().

QString TagAttribute::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().

QString TagAttribute::font() const

See also setFont().

QString TagAttribute::iconName() const

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

See also setIconName().

bool TagAttribute::inToolbar() const

See also setInToolbar().

int TagAttribute::priority() const

Returns the priority of the tag. The default value is -1

See also setPriority().

void TagAttribute::setBackgroundColor(const QColor &color)

See also backgroundColor().

void TagAttribute::setDisplayName(const QString &name)

Sets the name that should be used for display.

See also displayName().

void TagAttribute::setFont(const QString &fontKey)

See also font().

void TagAttribute::setIconName(const QString &name)

Sets the icon name for the default icon.

See also iconName().

void TagAttribute::setInToolbar(bool inToolbar)

See also inToolbar().

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.

See also priority().

void TagAttribute::setShortcut(const QString &shortcut)

See also shortcut().

void TagAttribute::setTextColor(const QColor &color)

See also textColor().

QString TagAttribute::shortcut() const

See also setShortcut().

QColor TagAttribute::textColor() const

See also setTextColor().

Contents