TodayPluginObject Class Reference

base class for today plugins More...

Inheritance diagram for TodayPluginObject:


Public Member Functions
virtual	~TodayPluginObject ()
virtual QString	pluginName () const =0
virtual double	versionNumber () const =0
virtual QString	pixmapNameWidget () const =0
virtual QWidget *	widget (QWidget *parent)=0
virtual QString	pixmapNameConfig () const =0
virtual TodayConfigWidget *	configWidget (QWidget *parent)=0
virtual QString	appName () const =0
virtual bool	excludeFromRefresh () const =0
virtual void	refresh ()
virtual void	reinitialize ()
virtual	~TodayPluginObject ()
virtual QString	pluginName () const =0
virtual double	versionNumber () const =0
virtual QString	pixmapNameWidget () const =0
virtual QWidget *	widget (QWidget *parent)=0
virtual QString	pixmapNameConfig () const =0
virtual TodayConfigWidget *	configWidget (QWidget *)=0
virtual QString	appName () const =0
virtual bool	excludeFromRefresh () const =0
virtual void	refresh ()
virtual void	reinitialize ()

Detailed Description

base class for today plugins

A TodayPluginObject is the base for all Today Plugins. A plugin author needs to inherit this class and implement the pure virtual methods

Definition at line 55 of file todayplugininterface.h.

virtual TodayPluginObject::~TodayPluginObject ( ) [inline, virtual]

Definition at line 59 of file todayplugininterface.h.

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.
Implemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, ExamplePlugin, FortunePlugin, StockTickerPlugin, and WeatherPlugin.

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
Implemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, ExamplePlugin, FortunePlugin, StockTickerPlugin, and WeatherPlugin.

virtual TodayConfigWidget* TodayPluginObject::configWidget ( QWidget * parent ) [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
Note: Always create a new Widget on this call and ownership is transfered
Implemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, ExamplePlugin, FortunePlugin, StockTickerPlugin, and WeatherPlugin.

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

If the plugin should take part in the periodic refresh
Implemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, ExamplePlugin, FortunePlugin, StockTickerPlugin, and WeatherPlugin.

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

Pixmap used in the config widget
Implemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, ExamplePlugin, FortunePlugin, StockTickerPlugin, and WeatherPlugin.

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

Returns:
the pixmap name widget?! -- FIXME

Implemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, ExamplePlugin, FortunePlugin, StockTickerPlugin, and WeatherPlugin.

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

The name if the plugin
Returns:
The plugin should return its name here

Implemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, ExamplePlugin, FortunePlugin, StockTickerPlugin, and WeatherPlugin.

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

Refresh that plugins view. For updating the plugins
Reimplemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, and ExamplePlugin.
Definition at line 114 of file todayplugininterface.h.

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

Refresh that plugins view. For updating the plugins
Reimplemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, and ExamplePlugin.
Definition at line 123 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
Reimplemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, and ExamplePlugin.
Definition at line 120 of file todayplugininterface.h.

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

Version numbering
Returns:
The plugin should return the version number

Implemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, ExamplePlugin, FortunePlugin, StockTickerPlugin, and WeatherPlugin.

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!
Implemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, ExamplePlugin, FortunePlugin, StockTickerPlugin, and WeatherPlugin.

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!
Note that you always need to create a new QWidget on this call and the ownership is transfered to the caller.

Parameters:

The parent of your to be created widget

Implemented in AddressBookPlugin, DatebookPlugin, MailPlugin, TodolistPlugin, ExamplePlugin, FortunePlugin, StockTickerPlugin, and WeatherPlugin.
Referenced by Today::loadPluginWidgets().

The documentation for this class was generated from the following files:

Generated on Sat Nov 5 17:54:07 2005 for OPIE by

1.4.2