summaryrefslogtreecommitdiff
path: root/library/dummy_api_docu.cpp
Unidiff
Diffstat (limited to 'library/dummy_api_docu.cpp') (more/less context) (ignore whitespace changes)
-rw-r--r--library/dummy_api_docu.cpp58
1 files changed, 58 insertions, 0 deletions
diff --git a/library/dummy_api_docu.cpp b/library/dummy_api_docu.cpp
index 6b76401..f2153df 100644
--- a/library/dummy_api_docu.cpp
+++ b/library/dummy_api_docu.cpp
@@ -300,12 +300,70 @@
300 * \fn QWidget* TaskbarAppletInterface::applet( QWidget* parent ) 300 * \fn QWidget* TaskbarAppletInterface::applet( QWidget* parent )
301 * \brief return the new Applet Widget 301 * \brief return the new Applet Widget
302 * 302 *
303 * @param parent The parent of the Applet normally the taskbar 303 * @param parent The parent of the Applet normally the taskbar
304 */ 304 */
305 305
306/** 306/**
307 * \fn int TaskbarAppletInterface::position()const; 307 * \fn int TaskbarAppletInterface::position()const;
308 * \brief the wished position 308 * \brief the wished position
309 * 309 *
310 * From left to right. 0 is left. The clock uses 10 310 * From left to right. 0 is left. The clock uses 10
311 */ 311 */
312
313
314/**
315 * \class WindowDecorationInterface
316 *
317 * Interface class for Window Decorations. Yu need to implement
318 * metric and drawing functions.
319 */
320
321/**
322 * \class WindowDecorationInterface::WindowData
323 *
324 * Window informations like the QRect, Palette, Caption
325 * and flag
326 */
327
328/**
329 * \fn int WindowDecorationInterface::metric(Metric m,const WindowData* )
330 *
331 * Return the width for the item out of Metric.
332 * Normally you will case Metric and default: should call the interface
333 * method. Also return 0
334 */
335
336/**
337 * \fn void WindowDecorationInterface::drawArea( Area a, QPainter* , const WindowData* )const
338 *
339 * draw the Area specefic in a to the QPainter
340 */
341
342/**
343 * \fn void WindowDecorationInterface::drawButton(Button b,QPainter*p ,const WindowData* d, int x, int y, int w,int h, QWSButton::State s)const
344 *
345 * @param b The Button to be drawn
346 * @param p The painter to draw at
347 * @param d The Window Data
348 * @param x The X position of the button
349 * @param y The Y position of the button
350 * @param w The width of the button
351 * @param h The height of the button
352 * @param s The state of the button
353 */
354
355/**
356 * \fn QRegion WindowDecorationInterface::mask( const WindowData* )const
357 *
358 * The mask of the Decoration.
359 *
360 * \code
361 * int th = metric(TitleHeight,wd);
362 * QRect rect( wd->rect );
363 * QRect r(rect.left() - metric(LeftBorder,wd),
364 * rect.top() - th - metric(TopBorder,wd),
365 * rect.width() + metric(LeftBorder,wd) + metric(RightBorder,wd),
366 * rect.height() + th + metric(TopBorder,wd) + metric(BottomBorder,wd));
367 * return QRegion(r) - rect;
368 * \endcode
369 */