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
|
/***************************************************************************
begin : 2004/03/12
copyright : (C) Mark Kretschmann
email : [email protected]
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef AKREGATOR_PLUGINMANAGER_H
#define AKREGATOR_PLUGINMANAGER_H
#include <vector>
#include <kservice.h>
#include <ktrader.h>
class KLibrary;
namespace Akregator {
class Plugin;
class PluginManager
{
public:
/** Bump this number whenever the plugin framework gets incompatible with older versions */
static const int FrameworkVersion = 1;
/**
* It will return a list of services that match your
* specifications. The only required parameter is the service
* type. This is something like 'text/plain' or 'text/html'. The
* constraint parameter is used to limit the possible choices
* returned based on the constraints you give it.
*
* The @p constraint language is rather full. The most common
* keywords are AND, OR, NOT, IN, and EXIST, all used in an
* almost spoken-word form. An example is:
* \code
* (Type == 'Service') and (('KParts/ReadOnlyPart' in ServiceTypes) or (exist Exec))
* \endcode
*
* The keys used in the query (Type, ServiceType, Exec) are all
* fields found in the .desktop files.
*
* @param constraint A constraint to limit the choices returned, TQString() to
* get all services of the given @p servicetype
*
* @return A list of services that satisfy the query
* @see http://developer.kde.org/documentation/library/kdeqt/tradersyntax.html
*/
static TDETrader::OfferList query( const TQString& constraint = TQString() );
/**
* Load and instantiate plugin from query
* @param constraint A constraint to limit the choices returned, TQString() to
* get all services of the given @p servicetype
* @return Pointer to Plugin, or NULL if error
* @see http://developer.kde.org/documentation/library/kdeqt/tradersyntax.html
*/
static Akregator::Plugin* createFromQuery( const TQString& constraint = TQString() );
/**
* Load and instantiate plugin from service
* @param service Pointer to KService
* @return Pointer to Plugin, or NULL if error
*/
static Akregator::Plugin* createFromService( const KService::Ptr service );
/**
* Remove library and delete plugin
* @param plugin Pointer to plugin
*/
static void unload( Akregator::Plugin* plugin );
/**
* Look up service for loaded plugin from store
* @param plugin Pointer to plugin
* @return KService, or 0 if not found
*/
static KService::Ptr getService( const Akregator::Plugin* plugin );
/**
* Dump properties from a service to stdout for debugging
* @param service Pointer to KService
*/
static void dump( const KService::Ptr service );
/**
* Show modal info dialog about plugin
* @param constraint A constraint to limit the choices returned
*/
static void showAbout( const TQString& constraint );
private:
struct StoreItem {
Akregator::Plugin* plugin;
KLibrary* library;
KService::Ptr service;
};
static std::vector<StoreItem>::iterator lookupPlugin( const Akregator::Plugin* plugin );
//attributes:
static std::vector<StoreItem> m_store;
};
}
#endif /* AKREGATOR_PLUGINMANAGER_H */
|
