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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/* This file is part of the KDE libraries
Copyright (C) 1999 Sirtaj Singh Kanq <taj@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 version 2 as published by the Free Software Foundation.
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 _KGLOBAL_H
#define _KGLOBAL_H
#include "tdelibs_export.h"
#include <kinstance.h> // KDE4: class KInstance is enough here
class KCharsets;
class KConfig;
class KSharedConfig;
class KIconLoader;
class KLocale;
class KStandardDirs;
class KStaticDeleterBase;
class KStaticDeleterList;
class KStringDict;
class TQString;
/**
* Access to the KDE global objects.
* KGlobal provides you with pointers of many central
* objects that exist only once in the process. It is also
* responsible for managing instances of KStaticDeleterBase.
*
* @see KStaticDeleterBase
* @author Sirtaj Singh Kang (taj@kde.org)
*/
class TDECORE_EXPORT KGlobal
{
public:
/**
* Returns the global instance. There is always at least
* one instance of a component in one application (in most
* cases the application itself).
* @return the global instance
*/
static KInstance *instance();
/**
* Returns the application standard dirs object.
* @return the global standard dir object
*/
static KStandardDirs *dirs();
/**
* Returns the general config object.
* @return the global configuration object.
*/
static KConfig *config();
/**
* Returns the general config object.
* @return the global configuration object.
*/
static KSharedConfig *sharedConfig();
/**
* Returns an iconloader object.
* @return the global iconloader object
*/
static KIconLoader *iconLoader();
/**
* Returns the global locale object.
* @return the global locale object
*/
static KLocale *locale();
/**
* The global charset manager.
* @return the global charset manager
*/
static KCharsets *charsets();
/**
* Creates a static TQString.
*
* To be used inside functions(!) like:
* \code
* static const TQString &myString = KGlobal::staticQString("myText");
* \endcode
*
* !!! Do _NOT_ use: !!!
* \code
* static TQString myString = KGlobal::staticQString("myText");
* \endcode
* This creates a static object (instead of a static reference)
* and as you know static objects are EVIL.
* @param str the string to create
* @return the static string
*/
static const TQString &staticQString(const char *str);
/**
* Creates a static TQString.
*
* To be used inside functions(!) like:
* \code
* static const TQString &myString = KGlobal::staticQString(i18n("My Text"));
* \endcode
*
* !!! Do _NOT_ use: !!!
* \code
* static TQString myString = KGlobal::staticQString(i18n("myText"));
* \endcode
* This creates a static object (instead of a static reference)
* and as you know static objects are EVIL.
* @param str the string to create
* @return the static string
*/
static const TQString &staticQString(const TQString &str);
/**
* Registers a static deleter.
* @param d the static deleter to register
* @see KStaticDeleterBase
* @see KStaticDeleter
*/
static void registerStaticDeleter(KStaticDeleterBase *d);
/**
* Unregisters a static deleter.
* @param d the static deleter to unregister
* @see KStaticDeleterBase
* @see KStaticDeleter
*/
static void unregisterStaticDeleter(KStaticDeleterBase *d);
/**
* Calls KStaticDeleterBase::destructObject() on all
* registered static deleters and unregisters them all.
* @see KStaticDeleterBase
* @see KStaticDeleter
*/
static void deleteStaticDeleters();
//private:
static KStringDict *_stringDict;
static KInstance *_instance;
static KLocale *_locale;
static KCharsets *_charsets;
static KStaticDeleterList *_staticDeleters;
/**
* The instance currently active (useful in a multi-instance
* application, such as a KParts application).
* Don't use this - it's mainly for KAboutDialog and KBugReport.
* @internal
*/
static void setActiveInstance(KInstance *d);
static KInstance *activeInstance() { return _activeInstance; }
static KInstance *_activeInstance;
};
/**
* \relates KGlobal
* A typesafe function to find the minimum of the two arguments.
*/
#define KMIN(a,b) kMin(a,b)
/**
* \relates KGlobal
* A typesafe function to find the maximum of the two arguments.
*/
#define KMAX(a,b) kMax(a,b)
/**
* \relates KGlobal
* A typesafe function to determine the absolute value of the argument.
*/
#define KABS(a) kAbs(a)
/**
* \relates KGlobal
* A typesafe function that returns x if it's between low and high values.
* low if x is smaller than then low and high if x is bigger than high.
*/
#define KCLAMP(x,low,high) kClamp(x,low,high)
// XXX KDE4: Make kMin, kMax and kClamp return "T" instead of "const T &"!
template<class T>
inline const T& kMin (const T& a, const T& b) { return a < b ? a : b; }
template<class T>
inline const T& kMax (const T& a, const T& b) { return b < a ? a : b; }
template<class T>
inline T kAbs (const T& a) { return a < 0 ? -a : a; }
template<class T>
inline const T& kClamp( const T& x, const T& low, const T& high )
{
if ( x < low ) return low;
else if ( high < x ) return high;
else return x;
}
/**
* Locale-independent qstricmp. Use this for comparing ascii keywords
* in a case-insensitive way.
* qstricmp fails with e.g. the Turkish locale where 'I'.lower() != 'i'
* @since 3.4
*/
int TDECORE_EXPORT kasciistricmp( const char *str1, const char *str2 );
/**
* \mainpage The KDE Core Functionality Library
*
* All KDE programs use this library to provide basic functionality such
* as the configuration system, IPC, internationalization and locale
* support, site-independent access to the filesystem and a large number
* of other (but no less important) things.
*
* All KDE applications should link to the tdecore library. Also, using a
* KApplication derived class instead of TQApplication is almost
* mandatory if you expect your application to behave nicely within the
* KDE environment.
*/
#endif // _KGLOBAL_H
|
