libopie API Documentation
Overview Class Hierarchy Classes Classes (annotated) Members Source Files Todo

TodayPluginObject Class Reference

A TodayPluginObject is the base for all Today Plugins. base class for today plugins. More...

#include <todayplugininterface.h>

List of all members.

Public Member Functions

virtual QString pluginName () const=0
 The name if the plugin.

virtual double versionNumber () const=0
 Version numbering.

virtual QString pixmapNameWidget () const=0
virtual QWidget * widget (QWidget *parent)=0
 widget for the today view It _needs_ a parent here.

virtual QString pixmapNameConfig () const=0
 Pixmap used in the config widget.

virtual TodayConfigWidget * configWidget (QWidget *)=0
 Config plugin widget - optional If the plugin has a config widget, it _needs_ a parent here.

virtual QString appName () const=0
 The application that should be assigned to the button (pixmap) Today will show the plugin icon.

virtual bool excludeFromRefresh () const=0
 If the plugin should take part in the periodic refresh.

virtual void refresh ()
 Refresh that plugins view.

virtual void reinitialize ()
 reread the plugins config and act apropiate This is for example used when returning from the config dialog

Detailed Description

A TodayPluginObject is the base for all Today Plugins. base class for today plugins.

A plugin author needs to inherit this class and implement the pure virtual methods

Author:
Maximilian Reiss

Definition at line 55 of file todayplugininterface.h.

Member Function Documentation

virtual QString TodayPluginObject::pluginName (   )  const [pure virtual]
 

The name if the plugin.

Returns:
The plugin should return its name here

virtual double TodayPluginObject::versionNumber (   )  const [pure virtual]
 

Version numbering.

Returns:
The plugin should return the version number

virtual QString TodayPluginObject::pixmapNameWidget (   )  const [pure virtual]
 

Returns:
the pixmap name widget?! -- FIXME

virtual QWidget* TodayPluginObject::widget (  QWidget *  parent  )  [pure virtual]
 

widget for the today view It _needs_ a parent here.

Plugin authors need to take parent as parent!

virtual QString TodayPluginObject::pixmapNameConfig (   )  const [pure virtual]
 

Pixmap used in the config widget.

virtual TodayConfigWidget* TodayPluginObject::configWidget (  QWidget *   )  [pure virtual]
 

Config plugin widget - optional If the plugin has a config widget, it _needs_ a parent here.

may return 0 if no config widget is needed

virtual QString TodayPluginObject::appName (   )  const [pure virtual]
 

The application that should be assigned to the button (pixmap) Today will show the plugin icon.

On click it tries to execute the plugin related application.

virtual bool TodayPluginObject::excludeFromRefresh (   )  const [pure virtual]
 

If the plugin should take part in the periodic refresh.

virtual void TodayPluginObject::refresh (   )  [inline, virtual]
 

Refresh that plugins view.

For updating the plugins

Definition at line 114 of file todayplugininterface.h.

virtual void TodayPluginObject::reinitialize (   )  [inline, virtual]
 

reread the plugins config and act apropiate This is for example used when returning from the config dialog

Definition at line 120 of file todayplugininterface.h.

The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for OPIE Version 1.1.
Documentation copyright © 1997-2003 the KDE developers. 2003 OPIE developers
Generated on Tue Feb 10 20:25:06 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001