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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
/*
kopetecontactproperty.h
Kopete::Contact Property class
Copyright (c) 2004 by Stefan Gehn <metz AT gehn.net>
Kopete (c) 2004 by the Kopete developers <kopete-devel@kde.org>
*************************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
*************************************************************************
*/
#ifndef _KOPETECONTACTPROPERTY_H_
#define _KOPETECONTACTPROPERTY_H_
#include <qvariant.h>
#include "kopete_export.h"
namespace Kopete
{
struct ContactPropertyTmplPrivate;
/**
* @author Stefan Gehn <metz AT gehn.net>
*
* The template class for registering properties in Kopete
* You need to use this if you want to set properties for a
* Kopete::Contact
**/
class KOPETE_EXPORT ContactPropertyTmpl
{
public:
/**
* Constructor only used for empty ContactPropertyTmpl objects
*
* Note: Only useful for the null object
**/
ContactPropertyTmpl();
/**
* Constructor
* @param key internal unique key for this template
* @param label a label to show for properties based on this template
* @param icon name of the icon to show for properties based on this template
* @param persistent if true, properties based on this template will be
* saved to the contactlist.
* @param richText Indicate that this property should be able to handle rich text
* @param privateProp if true, properties based on this template won't be
* visible to the user
**/
ContactPropertyTmpl( const QString &key,
const QString &label,
const QString &icon = QString::null,
bool persistent = false,
bool richText = false,
bool privateProp = false );
/**
* Copy constructor
**/
ContactPropertyTmpl(const ContactPropertyTmpl &other);
/** Destructor */
~ContactPropertyTmpl();
ContactPropertyTmpl &operator=(const ContactPropertyTmpl &other);
bool operator==(const ContactPropertyTmpl &other) const;
bool operator!=(const ContactPropertyTmpl &other) const;
/**
* Getter for the unique key. Properties based on this template will be
* stored with this key
**/
const QString &key() const;
/**
* Getter for i18ned label
**/
const QString &label() const;
/**
* Getter for icon to show aside or instead of @p label()
**/
const QString &icon() const;
/**
* Returns true if properties based on this template should
* be saved across Kopete sessions, false otherwise.
**/
bool persistent() const;
/**
* Returns true if properties based on this template are HTML formatted
**/
bool isRichText() const;
/**
* Returns true if properties based on this template are invisible to the user
**/
bool isPrivate() const;
/**
* An empty template, check for it using isNull()
*/
static ContactPropertyTmpl null;
/**
* Returns true if this object is an empty template
**/
bool isNull() const;
/**
* A Map of QString and ContactPropertyTmpl objects, based on QMap
**/
typedef QMap<QString, ContactPropertyTmpl> Map;
private:
ContactPropertyTmplPrivate *d;
};
/**
* @author Stefan Gehn <metz AT gehn.net>
*
* A data container for whatever information Kopete or any of its
* plugins want to store for a Kopete::Contact
**/
class KOPETE_EXPORT ContactProperty
{
// TODO: Add d-pointer !
public:
/**
* Constructor only used for empty ContactProperty objects
*
* Note: you cannot set a label or value later on!
**/
ContactProperty();
/**
* @param tmpl The contact property template this property is based on
* @param value The value this Property holds
**/
ContactProperty(const ContactPropertyTmpl &tmpl, const QVariant &value);
/** Destructor **/
~ContactProperty();
/**
* Getter for this properties template
**/
const ContactPropertyTmpl &tmpl() const;
/**
* Getter for this properties value
**/
const QVariant &value() const;
/**
* The null, i.e. empty, ContactProperty
*/
static ContactProperty null;
/**
* Returns true if this object is an empty Property (i.e. it holds no
* value), false otherwise.
**/
bool isNull() const;
/**
* Returns true if this property is HTML formatted
**/
bool isRichText() const;
/**
* A map of key,ContactProperty items
**/
typedef QMap<QString, ContactProperty> Map;
private:
QVariant mValue;
ContactPropertyTmpl mTemplate;
};
} // END namespace Kopete
#endif //_KOPETECONTACTPROPERTY_H_
|
