~ubuntu-branches/ubuntu/oneiric/kde4libs/oneiric-proposed

« back to all changes in this revision

Viewing changes to plasma/pluginloader.h

  • Committer: Package Import Robot
  • Author(s): Philip Muškovac
  • Date: 2011-07-08 00:08:34 UTC
  • mto: This revision was merged to the branch mainline in revision 247.
  • Revision ID: package-import@ubuntu.com-20110708000834-dr9a8my4iml90qe5
Tags: upstream-4.6.90
Import upstream version 4.6.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
40
40
 * This is an abstract base class which defines an interface to which Plasma's 
41
41
 * Applet Loading logic can communicate with a parent application. The plugin loader
42
42
 * must be set before any plugins are loaded, otherwise (for safety reasons), the
43
 
 * default PluginLoader implementation will be used.
44
 
 * 
 
43
 * default PluginLoader implementation will be used. The reimplemented version should
 
44
 * not do more than simply returning a loaded plugin. It should not init() it, and it should not
 
45
 * hang on to it. The associated methods will be called only when a component of Plasma
 
46
 * needs to load a _new_ plugin. (e.g. DataEngine does it's own caching).
 
47
 *
45
48
 * @author Ryan Rix <ry@n.rix.si>
46
49
 * @since 4.6
47
50
 **/
135
138
 
136
139
    /**
137
140
     * Set the plugin loader which will be queried for all loads.
138
 
     * 
 
141
     *
139
142
     * @param loader A subclass of PluginLoader which will be supplied
140
143
     * by the application
141
144
     **/
210
213
     * This method is called by listAppletInfo prior to generating the list of applets installed
211
214
     * on the system using the standard Plasma plugin mechanisms, and will try to find .desktop
212
215
     * files for your applets.
213
 
     * 
 
216
     *
214
217
     * @param category Only applets matching this category will be returned.
215
218
     *                 Useful in conjunction with knownCategories.
216
219
     *                 If "Misc" is passed in, then applets without a
246
249
    /**
247
250
     * Standardized mechanism for providing internal Applets by install .desktop files
248
251
     * in $APPPDATA/plasma/internal/applets/
249
 
     * 
 
252
     *
250
253
     * For applications that do this, internalAppletInfo can be implemented as a one-liner
251
254
     * call to this method.
252
 
     * 
 
255
     *
253
256
     * @param category Only applets matching this category will be returned.
254
257
     *                 Useful in conjunction with knownCategories.
255
258
     *                 If "Misc" is passed in, then applets without a
263
266
    /**
264
267
     * Standardized mechanism for providing internal Applets by install .desktop files
265
268
     * in $APPPDATA/plasma/internal/dataengines/
266
 
     * 
 
269
     *
267
270
     * For applications that do this, internalDataEngineInfo can be implemented as a one-liner
268
271
     * call to this method.
269
 
     * 
 
272
     *
270
273
     * @return list of applets
271
274
     */
272
275
    KPluginInfo::List standardInternalDataEngineInfo() const;
274
277
    /**
275
278
     * Standardized mechanism for providing internal Applets by install .desktop files
276
279
     * in $APPPDATA/plasma/internal/runners/
277
 
     * 
 
280
     *
278
281
     * For applications that do this, internalRunnerInfo can be implemented as a one-liner
279
282
     * call to this method.
280
 
     * 
 
283
     *
281
284
     * @return list of applets
282
285
     */
283
286
    KPluginInfo::List standardInternalRunnerInfo() const;
285
288
    /**
286
289
     * Standardized mechanism for providing internal Applets by install .desktop files
287
290
     * in $APPPDATA/plasma/internal/services/
288
 
     * 
 
291
     *
289
292
     * For applications that do this, internalRunnerInfo can be implemented as a one-liner
290
293
     * call to this method.
291
 
     * 
 
294
     *
292
295
     * @return list of applets
293
296
     */
294
297
    KPluginInfo::List standardInternalServiceInfo() const;
301
304
 
302
305
Q_DECLARE_METATYPE(Plasma::PluginLoader*)
303
306
 
304
 
#endif 
 
307
#endif