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
|
/* ksim - a system monitor for kde
*
* Copyright (C) 2001 Robbie Ward <linuxphreak@gmx.co.uk>
*
* 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.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef PLUGINMODULE_H
#define PLUGINMODULE_H
#include <qwidget.h>
#include <kdemacros.h>
class QPopupMenu;
class KConfig;
#define KSIM_INIT_PLUGIN(className) \
extern "C" { \
KDE_EXPORT KSim::PluginObject *init_plugin(const char *name) { \
return new className(name); \
} \
}
namespace KSim
{
class PluginView;
class PluginPage;
/**
* The base class for ksim modules.
*
* To init a plugin so KSim can load your plugin just do:
* <pre>
* // MyPluginModule is the class that inherits KSim::PluginObject
* KSIM_INIT_PLUGIN(MyPluginModule);
* </pre>
* @see KSim::PluginView KSim::PluginPage
* @author Robbie Ward <linuxphreak@gmx.co.uk>
*/
class KDE_EXPORT PluginObject
{
public:
/**
* constructor for PluginObject
*/
PluginObject(const QCString &name);
/**
* destructor for PluginObject
*/
virtual ~PluginObject();
/**
* creates a new View page, re-implement this
* to return your main view class
*/
virtual KSim::PluginView *createView(const char *) = 0;
/**
* creates a new Config page, re-implement this
* to return you config class
*/
virtual KSim::PluginPage *createConfigPage(const char *) = 0;
/**
* re-implement this to show your about dialog
*/
virtual void showAbout() = 0;
/**
* @return the instance name of the app
*/
const char *instanceName() const;
/**
* @return the name of the plugin
*/
const QCString &name() const;
/**
* sets the configuration file name to @p name
*/
void setConfigFileName(const QString &name);
/**
* @return the config filename the plugin should use
* or name() if the filename hasn't been set
*/
const QString &configFileName() const;
private:
PluginObject();
PluginObject(const PluginObject &);
PluginObject &operator=(const PluginObject &);
class Private;
Private *d;
};
/**
* Provides you with a config page
*
* re-implement readConfig() and saveConfig() for your
* classes reading and saving functions and use
* the config() to gain access to your config file
* @author Robbie Ward <linuxphreak@gmx.co.uk>
*/
class KDE_EXPORT PluginPage : public QWidget
{
Q_OBJECT
public:
/**
* constructor for PluginPage
*/
PluginPage(KSim::PluginObject *parent, const char *name);
/**
* destructor for PluginPage
*/
virtual ~PluginPage();
/**
* called when apply or ok button is clicked in KSimPref
* use this to save your plugin options
*/
virtual void saveConfig() = 0;
/**
* called when apply or ok button is clicked in KSimPref
* use this to read your plugin options
*/
virtual void readConfig() = 0;
/*
* use this to get a config object unique to the plugin name,
* eg: the plugin foo would have the config file foorc
*/
KConfig *config() const;
signals:
void pageChanged();
protected:
PluginObject *parentPlugin() const;
private:
class Private;
Private *d;
};
/**
* inherit from this class to get your base view
*
* use config() to get an instance of your config file,
* reimplement reparseConfig() to recreate your view
* when apply or ok gets clicked in the config dialog
* @author Robbie Ward <linuxphreak@gmx.co.uk>
*/
class KDE_EXPORT PluginView : public QWidget
{
Q_OBJECT
public:
/**
* constructor for PluginView
*/
PluginView(KSim::PluginObject *parent, const char *name);
/**
* destructor for PluginView
*/
virtual ~PluginView();
/*
* use this to get a config object unique to the plugin name,
* eg: the plugin foo would have the config file foorc
*/
KConfig *config() const;
/**
* the plugins popup menu
*/
QPopupMenu *menu() const;
/**
* reimplement to recreate your view when KSim requests this
*/
virtual void reparseConfig() = 0;
void doCommand();
signals:
void runCommand(const QCString &);
protected:
virtual void mousePressEvent(QMouseEvent *);
PluginObject *parentPlugin() const;
private slots:
void showAbout();
private:
class Private;
Private *d;
};
}
#endif
|
