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
|
/*
Copyright (c) 1999 Matthias Hoelzer-Kluepfel <hoelzer@kde.org>
Copyright (c) 2002-2003 Daniel Molkentin <molkentin@kde.org>
This file is part of the KDE project
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 MODLOADER_H
#define MODLOADER_H
#include <kcmodule.h>
#include <kcmoduleinfo.h>
class TQWidget;
class KLibLoader;
/**
* @ingroup kcmodule
* @brief Loads a KControl Module.
*
* KCModuleLoader tries in several ways
* to locate and load a KCModule. If loading fails a
* zero pointer is returned. \n
* It is very unlikely KCModuleLoader is what you want
* and @ref KCModuleProxy suits your needs.
*
* @author Matthias Hoelzer-Kluepfel <mhk@kde.org>
* @author Frans Englich <frans.englich@telia.com>
* @since 3.2
* @internal
**/
class KUTILS_EXPORT KCModuleLoader
{
public:
/**
* Loads a @ref KCModule. If loading fails a zero pointer is returned.
* @param module what module to load
* @param withFallback if true and loading failed a separate window
* with the module may appear and a zero pointer is a returned
* @param parent The parent widget
* @param name The widget's name
* @param args A list of arguments for the module to load
*
* @return a pointer to the loaded @ref KCModule
*
* @deprecated use the function which explicitly states the error reporting
* method
*/
static KCModule *loadModule(const KCModuleInfo &module, bool withFallback=true,
TQWidget * parent = 0, const char * name = 0,
const TQStringList & args = TQStringList() ) KDE_DEPRECATED;
/**
* Loads a @ref KCModule. If loading fails a zero pointer is returned.
* @param module what module to load
* with the module may appear and a zero pointer is a returned
* @param parent The parent widget
* @param name The widget's name
* @param args A list of arguments for the module to load
*
* @deprecated use the function which explicitly states the error reporting
* method
*/
static KCModule *loadModule(const TQString &module, TQWidget *parent = 0,
const char *name = 0, const TQStringList & args = TQStringList()) KDE_DEPRECATED;
/**
* Determines the way errors are reported
*/
enum ErrorReporting {
/**
* no error reporting is done
* */
None = 0,
/**
* the error report is shown instead of the
* KCModule that should have * been loaded
*/
Inline = 1,
/**
* shows a dialog with the error report
*/
Dialog = 2,
/**
* does both Inline and Dialog
*/
Both = 3
};
/**
* Loads a @ref KCModule. If loading fails a zero pointer is returned.
* @param module what module to load
* @param report see ErrorReporting
* @param withFallback if true and loading failed a separate window
* with the module may appear and a zero pointer is a returned
* @param parent The parent widget
* @param name The widget's name
* @param args A list of arguments for the module to load
*
* @return a pointer to the loaded @ref KCModule
* @since 3.4
*/
static KCModule *loadModule(const KCModuleInfo &module, ErrorReporting
report, bool withFallback=true, TQWidget * parent = 0,
const char * name = 0, const TQStringList & args = TQStringList() );
/**
* Loads a @ref KCModule. If loading fails a zero pointer is returned.
* @param module what module to load
* @param report see ErrorReporting
* with the module may appear and a zero pointer is a returned
* @param parent The parent widget
* @param name The widget's name
* @param args A list of arguments for the module to load
*
* @return a pointer to the loaded @ref KCModule
* @since 3.4
*/
static KCModule *loadModule(const TQString &module, ErrorReporting
report, TQWidget *parent = 0, const char *name = 0,
const TQStringList & args = TQStringList());
/**
* Unloads the module's library
* @param mod What module to unload for
*/
static void unloadModule(const KCModuleInfo &mod);
/**
* Display a message box explaining an error occured and possible
* reasons to why.
*
* @deprecated Use a constructor with ErrorReporting set to Dialog to show a
* message box like this function did.
*/
static void showLastLoaderError(TQWidget *parent) KDE_DEPRECATED;
/**
* Checks whether an KCModule should be shown by running its
* test function. If it is unsure whether a module should be shown, it should
* be made available, leaving the decision to the user.
* If false is returned, the module should not be loaded in any interface.
*
* A module declares it needs to be tested by having "X-KDE-Test-Module=true" in
* its desktop file. When that line exists, the following code must be available
* in the module's library:
*
* \code
* extern "C"
* {
* bool test_moduleName()
* {
* // Code testing for hardware/software presence.
* return true; // and the modue will be loaded.
* }
*
* }
* \endcode
*
* where moduleName is the library name for the module.
*
* @param module the module to check
* @returns true if the module should be loaded
* @since 3.4
*/
static bool testModule( const TQString& module );
/**
* Convenience function, essentially the same as above.
*
* @param module the module to check
* @returns true if the module should be loaded
* @since 3.4
*/
static bool testModule( const KCModuleInfo& module );
/**
* Returns a KCModule containing the messages @p report and @p text.
*
* @param report the type of error reporting, see ErrorReporting
* @param text the main message
* @param details any additional details
* @param parent The parent widget
*
* @since 3.4
* @internal
*/
static KCModule* reportError( ErrorReporting report, const TQString & text,
TQString details, TQWidget * parent );
private:
/**
* Internal loader called by the public loaders.
* @internal
*/
static KCModule* load(const KCModuleInfo &mod, const TQString &libname,
KLibLoader *loader, ErrorReporting report, TQWidget * parent = 0,
const char * name = 0, const TQStringList & args = TQStringList() );
};
// vim: ts=2 sw=2 et
#endif // MODLOADER_H
|
