author | Michael Krelin <hacker@klever.net> | 2007-07-04 11:23:42 (UTC) |
---|---|---|
committer | Michael Krelin <hacker@klever.net> | 2007-07-04 11:23:42 (UTC) |
commit | a08aff328d4393031d5ba7d622c2b05705a89d73 (patch) (unidiff) | |
tree | 8ee90d686081c52e7c69b5ce946e9b1a7d690001 /libkcal/customproperties.h | |
parent | 11edc920afe4f274c0964436633aa632c8288a40 (diff) | |
download | kdepimpi-p1.zip kdepimpi-p1.tar.gz kdepimpi-p1.tar.bz2 |
initial public commit of qt4 portp1
-rw-r--r-- | libkcal/customproperties.h | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/libkcal/customproperties.h b/libkcal/customproperties.h index 0cbfdcd..75eb3ad 100644 --- a/libkcal/customproperties.h +++ b/libkcal/customproperties.h | |||
@@ -2,96 +2,98 @@ | |||
2 | This file is part of libkcal. | 2 | This file is part of libkcal. |
3 | Copyright (c) 2002 David Jarvie <software@astrojar.org.uk> | 3 | Copyright (c) 2002 David Jarvie <software@astrojar.org.uk> |
4 | 4 | ||
5 | This library is free software; you can redistribute it and/or | 5 | This library is free software; you can redistribute it and/or |
6 | modify it under the terms of the GNU Library General Public | 6 | modify it under the terms of the GNU Library General Public |
7 | License as published by the Free Software Foundation; either | 7 | License as published by the Free Software Foundation; either |
8 | version 2 of the License, or (at your option) any later version. | 8 | version 2 of the License, or (at your option) any later version. |
9 | 9 | ||
10 | This library is distributed in the hope that it will be useful, | 10 | This library is distributed in the hope that it will be useful, |
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of | 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
13 | Library General Public License for more details. | 13 | Library General Public License for more details. |
14 | 14 | ||
15 | You should have received a copy of the GNU Library General Public License | 15 | You should have received a copy of the GNU Library General Public License |
16 | along with this library; see the file COPYING.LIB. If not, write to | 16 | along with this library; see the file COPYING.LIB. If not, write to |
17 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | 17 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
18 | Boston, MA 02111-1307, USA. | 18 | Boston, MA 02111-1307, USA. |
19 | */ | 19 | */ |
20 | 20 | ||
21 | #ifndef KCAL_CUSTOM_PROPERTIES_H | 21 | #ifndef KCAL_CUSTOM_PROPERTIES_H |
22 | #define KCAL_CUSTOM_PROPERTIES_H | 22 | #define KCAL_CUSTOM_PROPERTIES_H |
23 | 23 | ||
24 | #include <qstring.h> | 24 | #include <qstring.h> |
25 | #include <qmap.h> | 25 | #include <qmap.h> |
26 | //Added by qt3to4: | ||
27 | #include <Q3CString> | ||
26 | 28 | ||
27 | namespace KCal { | 29 | namespace KCal { |
28 | 30 | ||
29 | /** | 31 | /** |
30 | This class represents custom calendar properties. | 32 | This class represents custom calendar properties. |
31 | It is used as a base class for classes which represent calendar components. | 33 | It is used as a base class for classes which represent calendar components. |
32 | A custom property name written by libkcal has the form X-KDE-APP-KEY where | 34 | A custom property name written by libkcal has the form X-KDE-APP-KEY where |
33 | APP represents the application name, and KEY distinguishes individual | 35 | APP represents the application name, and KEY distinguishes individual |
34 | properties for the application. | 36 | properties for the application. |
35 | In keeping with RFC2445, property names must be composed only of the | 37 | In keeping with RFC2445, property names must be composed only of the |
36 | characters A-Z, a-z, 0-9 and '-'. | 38 | characters A-Z, a-z, 0-9 and '-'. |
37 | */ | 39 | */ |
38 | class CustomProperties | 40 | class CustomProperties |
39 | { | 41 | { |
40 | public: | 42 | public: |
41 | /** Construct a new empty custom properties instance */ | 43 | /** Construct a new empty custom properties instance */ |
42 | CustomProperties(); | 44 | CustomProperties(); |
43 | CustomProperties(const CustomProperties &); | 45 | CustomProperties(const CustomProperties &); |
44 | ~CustomProperties(); | 46 | ~CustomProperties(); |
45 | 47 | ||
46 | /** Create or modify a custom calendar property. | 48 | /** Create or modify a custom calendar property. |
47 | @param app Application name as it appears in the custom property name. | 49 | @param app Application name as it appears in the custom property name. |
48 | @param key Property identifier specific to the application. | 50 | @param key Property identifier specific to the application. |
49 | @param value The property's value. A call with a value of QString::null | 51 | @param value The property's value. A call with a value of QString::null |
50 | will be ignored. | 52 | will be ignored. |
51 | */ | 53 | */ |
52 | void setCustomProperty(const QCString &app, const QCString &key, | 54 | void setCustomProperty(const Q3CString &app, const Q3CString &key, |
53 | const QString &value); | 55 | const QString &value); |
54 | /** Delete a custom calendar property. | 56 | /** Delete a custom calendar property. |
55 | @param app Application name as it appears in the custom property name. | 57 | @param app Application name as it appears in the custom property name. |
56 | @param key Property identifier specific to the application. | 58 | @param key Property identifier specific to the application. |
57 | */ | 59 | */ |
58 | void removeCustomProperty(const QCString &app, const QCString &key); | 60 | void removeCustomProperty(const Q3CString &app, const Q3CString &key); |
59 | /** Return the value of a custom calendar property. | 61 | /** Return the value of a custom calendar property. |
60 | @param app Application name as it appears in the custom property name. | 62 | @param app Application name as it appears in the custom property name. |
61 | @param key Property identifier specific to the application. | 63 | @param key Property identifier specific to the application. |
62 | @return Property value, or QString::null if (and only if) the property does not exist. | 64 | @return Property value, or QString::null if (and only if) the property does not exist. |
63 | */ | 65 | */ |
64 | QString customProperty(const QCString &app, const QCString &key) const; | 66 | QString customProperty(const Q3CString &app, const Q3CString &key) const; |
65 | 67 | ||
66 | /** Create or modify a non-KDE or non-standard custom calendar property. | 68 | /** Create or modify a non-KDE or non-standard custom calendar property. |
67 | @param name Full property name | 69 | @param name Full property name |
68 | @param value The property's value. A call with a value of QString::null | 70 | @param value The property's value. A call with a value of QString::null |
69 | will be ignored. | 71 | will be ignored. |
70 | */ | 72 | */ |
71 | void setNonKDECustomProperty(const QCString &name, const QString &value); | 73 | void setNonKDECustomProperty(const Q3CString &name, const QString &value); |
72 | /** Delete a non-KDE or non-standard custom calendar property. | 74 | /** Delete a non-KDE or non-standard custom calendar property. |
73 | @param name Full property name | 75 | @param name Full property name |
74 | */ | 76 | */ |
75 | void removeNonKDECustomProperty(const QCString &name); | 77 | void removeNonKDECustomProperty(const Q3CString &name); |
76 | /** Return the value of a non-KDE or non-standard custom calendar property. | 78 | /** Return the value of a non-KDE or non-standard custom calendar property. |
77 | @param name Full property name | 79 | @param name Full property name |
78 | @return Property value, or QString::null if (and only if) the property does not exist. | 80 | @return Property value, or QString::null if (and only if) the property does not exist. |
79 | */ | 81 | */ |
80 | QString nonKDECustomProperty(const QCString& name) const; | 82 | QString nonKDECustomProperty(const Q3CString& name) const; |
81 | 83 | ||
82 | /** Initialise the alarm's custom calendar properties to the specified | 84 | /** Initialise the alarm's custom calendar properties to the specified |
83 | key/value pairs. | 85 | key/value pairs. |
84 | */ | 86 | */ |
85 | void setCustomProperties(const QMap<QCString, QString> &properties); | 87 | void setCustomProperties(const QMap<Q3CString, QString> &properties); |
86 | /** Return all custom calendar property key/value pairs. */ | 88 | /** Return all custom calendar property key/value pairs. */ |
87 | QMap<QCString, QString> customProperties() const; | 89 | QMap<Q3CString, QString> customProperties() const; |
88 | 90 | ||
89 | private: | 91 | private: |
90 | static bool checkName(const QCString& name); | 92 | static bool checkName(const Q3CString& name); |
91 | 93 | ||
92 | QMap<QCString, QString> mProperties; // custom calendar properties | 94 | QMap<Q3CString, QString> mProperties; // custom calendar properties |
93 | }; | 95 | }; |
94 | 96 | ||
95 | } | 97 | } |
96 | 98 | ||
97 | #endif | 99 | #endif |