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
|
/*
This file is part of libkcal.
Copyright (c) 2002,2006 David Jarvie <software@astrojar.org.uk>
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 KCAL_CUSTOMPROPERTIES_H
#define KCAL_CUSTOMPROPERTIES_H
#include <qstring.h>
#include <qmap.h>
#include <kdepimmacros.h>
#include "libkcal_export.h"
namespace KCal {
/**
This class represents custom calendar properties.
It is used as a base class for classes which represent calendar components.
A custom property name written by libkcal has the form X-KDE-APP-KEY where
APP represents the application name, and KEY distinguishes individual
properties for the application.
In keeping with RFC2445, property names must be composed only of the
characters A-Z, a-z, 0-9 and '-'.
*/
class LIBKCAL_EXPORT CustomProperties
{
public:
/**
Construct a new empty custom properties instance.
*/
CustomProperties();
CustomProperties( const CustomProperties & );
~CustomProperties();
bool operator==( const CustomProperties & ) const;
/**
Create or modify a custom calendar property.
@param app Application name as it appears in the custom property name.
@param key Property identifier specific to the application.
@param value The property's value. A call with a value of QString::null
will be ignored.
*/
void setCustomProperty( const QCString &app, const QCString &key,
const QString &value );
/**
Delete a custom calendar property.
@param app Application name as it appears in the custom property name.
@param key Property identifier specific to the application.
*/
void removeCustomProperty( const QCString &app, const QCString &key );
/**
Return the value of a custom calendar property.
@param app Application name as it appears in the custom property name.
@param key Property identifier specific to the application.
@return Property value, or QString::null if (and only if) the property
does not exist.
*/
QString customProperty( const QCString &app, const QCString &key ) const;
/**
Create or modify a non-KDE or non-standard custom calendar property.
@param name Full property name
@param value The property's value. A call with a value of QString::null
will be ignored.
*/
void setNonKDECustomProperty( const QCString &name, const QString &value );
/**
Delete a non-KDE or non-standard custom calendar property.
@param name Full property name
*/
void removeNonKDECustomProperty( const QCString &name );
/**
Return the value of a non-KDE or non-standard custom calendar property.
@param name Full property name
@return Property value, or QString::null if (and only if) the property
does not exist.
*/
QString nonKDECustomProperty( const QCString& name ) const;
/**
Initialise the alarm's custom calendar properties to the specified
key/value pairs.
*/
void setCustomProperties( const QMap<QCString, QString> &properties );
/**
Return all custom calendar property key/value pairs.
*/
QMap<QCString, QString> customProperties() const;
protected:
/**
Called when a custom property has been changed.
The default implementation does nothing: override in derived classes
to perform change processing.
*/
virtual void customPropertyUpdated() {}
private:
static bool checkName(const QCString& name);
QMap<QCString, QString> mProperties; // custom calendar properties
class Private;
Private *d;
};
}
#endif
|
