1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
Copyright (c) 2008 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_ENTITYDISPLAYATTRIBUTE_H
#define AKONADI_ENTITYDISPLAYATTRIBUTE_H
#include <QtGui/QColor>
#include <akonadi/attribute.h>
class KIcon;
namespace Akonadi {
/**
* @short 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.
*
* @author Volker Krause <vkrause@kde.org>
* @since 4.2
*/
class AKONADI_EXPORT EntityDisplayAttribute : public Attribute
{
public:
/**
* Creates a new entity display attribute.
*/
EntityDisplayAttribute();
/**
* Destroys the entity display attribute.
*/
~EntityDisplayAttribute();
/**
* Sets the @p name that should be used for display.
*/
void setDisplayName( const QString &name );
/**
* Returns the name that should be used for display.
* Users of this should fall back to Collection::name() if this is empty.
*/
QString displayName() const;
/**
* Sets the icon @p name for the default icon.
*/
void setIconName( const QString &name );
/**
* Returns the icon that should be used for this collection or item.
*/
KIcon icon() const;
/**
* Returns the icon name of the icon returned by icon().
*/
QString iconName() const;
/**
* Sets the icon @p name for the active icon.
* @since 4.4
*/
void setActiveIconName( const QString &name );
/**
* Returns the icon that should be used for this collection or item when active.
* @since 4.4
*/
KIcon activeIcon() const;
/**
* Returns the icon name of an active item.
* @since 4.4
*/
QString activeIconName() const;
/**
* Returns the backgroundColor or an invalid color if none is set.
* @since 4.4
*/
QColor backgroundColor() const;
/**
* Sets the backgroundColor to @p color.
* @since 4.4
*/
void setBackgroundColor( const QColor &color );
/* reimpl */
QByteArray type() const;
EntityDisplayAttribute* clone() const;
QByteArray serialized() const;
void deserialize( const QByteArray &data );
private:
//@cond PRIVATE
class Private;
Private* const d;
//@endcond
};
}
#endif
|