summaryrefslogtreecommitdiff
authorzecke <zecke>2004-02-06 15:49:41 (UTC)
committer zecke <zecke>2004-02-06 15:49:41 (UTC)
commitd1323683320700b9e7d78f8d25b208c89503c097 (patch) (unidiff)
treec99a3c527cb4396e1c84a02e48033398d6021dfc
parentd1c1ce295b6522e52244c970010a9e42c0b614ae (diff)
downloadopie-d1323683320700b9e7d78f8d25b208c89503c097.zip
opie-d1323683320700b9e7d78f8d25b208c89503c097.tar.gz
opie-d1323683320700b9e7d78f8d25b208c89503c097.tar.bz2
various interface documentation
Diffstat (more/less context) (show whitespace changes)
-rw-r--r--library/dummy_api_docu.cpp311
1 files changed, 311 insertions, 0 deletions
diff --git a/library/dummy_api_docu.cpp b/library/dummy_api_docu.cpp
new file mode 100644
index 0000000..6b76401
--- a/dev/null
+++ b/library/dummy_api_docu.cpp
@@ -0,0 +1,311 @@
1/*
2 * A place to explain various headers
3 */
4
5/*
6 * applicationinterface.h
7 */
8
9/**
10 * \class ApplicationInterface
11 * \brief Application interface currently used by the quicklaunch framework
12 *
13 * This is the interface to be exposed by applications available as DSO
14 * Normally one would use the OApplicationFactory which does the magic of
15 * exposing the interface.
16 *
17 * Resulting dynamic shared objects (dso) need to go into the
18 * OPIEDIR/plugins/application.
19 *
20 *
21 * You can use this interface to load applications into your application.
22 * @todo Implement Services + Trader
23 * @since Opie 1.0.2
24 */
25/**
26 * \fn QWidget* ApplicationInterface::createMainWindow(const QString& appName, QWidget* parent, const char* name, Qt::WFlags f)
27 * \brief create the mainwindow for the giving application name
28 * Create a main window for the giving application name
29 *
30 * @param appName The application widget to be created
31 * @param parent The parent of the newly created widget
32 * @param name The name of the QObject
33 * @param f Possible Window Flags
34 *
35 * @return the widget or 0l
36 */
37/**
38 * \fn QStringList ApplicationInterface::applications()const
39 * The list of application windows supported
40 */
41
42/*
43 * Font Factory
44 */
45
46/**
47 * \class FontFactoryInterface
48 * \brief Interface for additional Font Factories
49 *
50 * To add special types of fonts TrueTypes or your very own
51 * format. If you implement this Interface you can add
52 * custom font loading.
53 *
54 * The dynamic shared object goes to
55 * OPIEDIR/plugins/fontfactories.
56 *
57 * As of version Opie 1.0.2 loading of the plugins is not
58 * yet implemented
59 *
60 */
61
62/**
63 * \fn QFontFactory* FontFactoryInterface::fontFactory()
64 *
65 * Create a new QFontFactory and return it
66 */
67
68
69/*
70 * ImageCodec
71 */
72
73/**
74 * \class ImageCodecInterface
75 * \brief add Image Codecs
76 *
77 * This interface will be queried to add new Image loading
78 * and saving routines.
79 *
80 * The ImageCodec needs to be placed in OPIEDIR/plugins/imagecodecs.
81 *
82 * @see QImage
83 * @see QImageIO
84 **/
85
86/**
87 * \fn QStringList ImageCodecInterface::keys()const
88 * \brief Query for the list of supported formats
89 *
90 * Return a QStringList of the supported formats
91 *
92 */
93
94/**
95 * \fn bool ImageCodecInterface::installIOHandler(const QString& format )
96 * \brief install codec to QIageIO for the specefic format
97 *
98 * Install a QImage codec for the requested format
99 */
100
101/*
102 * Input Methods
103 */
104
105/**
106 * \class InputMethodInterface
107 * \brief Interface class for inputting keyboard events
108 *
109 * InputMethods are loaded by the Launcher/Server/Taskbar
110 * and are located inside OPIEDIR/plugins/inputmethods
111 *
112 * Depending on the device these InputMethods are the only way
113 * to input charachters
114 *
115 */
116
117
118/**
119 * \fn QWidget InputMethodInterface::inputMethod(QWidget*parent, Qt::WFlags f)
120 * \brief create a new widget which should be used as input
121 *
122 * This method will be called if the inputmethod is to be shown.
123 * Make sure that your widget is not too large. As of Opie1.1 InputMethods
124 * can be floating as well.
125 *
126 * Delete the Widget yourself.
127 *
128 *
129 * @param parent The parent of the to be created Input widget.
130 * @param f The Qt::WFlags for the widget
131 */
132
133/**
134 * \fn void InputMethodInterface::resetState()
135 * \brief Reset the state of the inputmethod
136 *
137 * If you're shown reset the state of the keyboard to the
138 * the default.
139 */
140
141/**
142 * \fn QPixmap* InputMethodInterface::icon()
143 * \brief The icon of your Input method
144 *
145 * Return a pointer to a QPixmap symboling your inputmethod
146 * You need to delete the pixmap later yourself.
147 */
148
149/**
150 * \fn void InputMethodInterface::onKeyPress(QObject* receiver, const char* slot)
151 * \brief pass your key event through
152 *
153 * In your actual Input Implementation you'll need a SIGNAL with this
154 * void key(ushort,ushort,ushort,bool,bool) signal. The host of your input method
155 * requests you to connect your signal with the signal out of receiver and slot.
156 *
157 * ushort == unicode value
158 * ushort == keycode
159 * ushort == modifiers from Qt::ButtonState
160 * bool == true if the key is pressed and false if released
161 * bool == autorepeat on or off.
162 *
163 * See the QWSServer for more information about emitting keys
164 *
165 *
166 * @param receiver the receiver to QObject::connect to
167 * @param slot the slot to QObject::connect to
168 *
169 */
170
171/*
172 * MediaPlayer Plugins
173 */
174
175/**
176 * \class MediaPlayerPluginInterface
177 * \brief Plugins for the Opie Player I
178 *
179 * You can extend the Opie Player I by plugins placed in
180 * OPIEDIR/plugins/codecs
181 *
182 *
183 */
184
185/**
186 * \fn MediaPlayerDecoder MediaPlayerPluginInterface::decoder()
187 *
188 * Create a new MediaPlayerDecoder
189 *
190 */
191
192
193/*
194 * MenuApplet Interface
195 */
196
197/**
198 * \class MenuAppletInterface
199 * \brief Plugins for the Menu Applet/StartMenu
200 *
201 * You can extend the startmenu by plugins implementing this
202 * interface. You need to place the plugin in plugins/applets
203 * from where they will be loaded.
204 *
205 *
206 */
207
208/**
209 * \fn QString MenuAppletInterface::name()const
210 * \brief Translated name of the Menu Applet
211 *
212 * Return a translated name using QObject::tr of your plugin
213 */
214
215/**
216 * \fn int MenuAppletInterface::position()const
217 * \brief the wished position of this applet
218 *
219 * The position where you want to be placed. 0 for the down most
220 *
221 */
222
223/**
224 * \fn QIconSet MenuAppletInterface::icon()const
225 * \brief return a QIconSet.
226 *
227 * The returned icon set will be shown next
228 * to text().
229 * Make use of AppLnk::smallIconSize()
230 */
231
232/**
233 * \fn QString MenuAppletInterface::text()const
234 * \brief return a Text shown to the user in the menu
235 */
236
237/**
238 * \fn QPopupMenu* MenuAppletInterface::popup( QWidget* parent)const
239 * \brief Provide a SubMenu popup if you want
240 *
241 * You can provide a Submenu popup for your item as well. If you return
242 * 0 no popup will be shown.
243 *
244 * You can use the QPopupMenu::aboutToShow() signal to be informed before
245 * showing the popup
246 *
247 * @param parent The parent of the to be created popup.
248 * @see QPopupMenu
249 */
250
251
252/**
253 * \fn void MenuAppletInterface::activated()
254 * \brief This method gets called once the user clicked on the item
255 *
256 * This is the way you get informed about user input. Your plugin
257 * has just been clicked
258 */
259
260/*
261 * StyleInterface
262 */
263
264/**
265 * \class StyleInterface
266 * \brief StyleInterface base class
267 *
268 * Opie styles should implement StyleExtendedInterface.
269 * StyleInterface is only for compability reasons present and should
270 * not be used for new styles.
271 *
272 * Styles need to be put into OPIEDIR/plugins/styles
273 */
274
275
276/**
277 * \class StyleExtendedInterface
278 * \brief The Plugin Interface for all Opie styles
279 *
280 * If you want to create a new QStyle for Opie use this class.
281 *
282 * key(ushort,ushort,ushort,bool,bool)
283 */
284
285/*
286 * Taskbar Applets
287 */
288
289
290/**
291 * \class TaskbarAppletInterface
292 *
293 * This is the base class of all Applets shown in the taskbar
294 * An applets need to provide a position and a widget.
295 *
296 * Applets need to be put into OPIEDIR/plugins/applets
297 *
298 */
299/**
300 * \fn QWidget* TaskbarAppletInterface::applet( QWidget* parent )
301 * \brief return the new Applet Widget
302 *
303 * @param parent The parent of the Applet normally the taskbar
304 */
305
306/**
307 * \fn int TaskbarAppletInterface::position()const;
308 * \brief the wished position
309 *
310 * From left to right. 0 is left. The clock uses 10
311 */