ExamplePlugin Class Reference

#include </home/clem/local/src/opie/examples/todayplugin/exampleplugin.h>

Inheritance diagram for ExamplePlugin:

[legend]Collaboration diagram for ExamplePlugin:

[legend]List of all members.

Public Member Functions
	ExamplePlugin ()
	~ExamplePlugin ()
QString	pluginName () const
double	versionNumber () const
QString	pixmapNameWidget () const
QWidget *	widget (QWidget *)
QString	pixmapNameConfig () const
TodayConfigWidget *	configWidget (QWidget *)
QString	appName () const
bool	excludeFromRefresh () const
void	refresh ()
void	reinitialize ()
Private Attributes
ExamplePluginWidget *	m_widget

---

Constructor & Destructor Documentation

ExamplePlugin::ExamplePlugin (   )

Definition at line 9 of file exampleplugin.cpp.

ExamplePlugin::~ExamplePlugin (   )

Definition at line 14 of file exampleplugin.cpp.

---

Member Function Documentation

QString ExamplePlugin::appName (   )  const [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. Implements TodayPluginObject. Definition at line 47 of file exampleplugin.cpp. References QString::null.

TodayConfigWidget * ExamplePlugin::configWidget (  QWidget *   )  [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 Implements TodayPluginObject. Definition at line 42 of file exampleplugin.cpp. References l.

bool ExamplePlugin::excludeFromRefresh (   )  const [virtual]

If the plugin should take part in the periodic refresh Implements TodayPluginObject. Definition at line 52 of file exampleplugin.cpp.

QString ExamplePlugin::pixmapNameConfig (   )  const [virtual]

Pixmap used in the config widget Implements TodayPluginObject. Definition at line 37 of file exampleplugin.cpp. References l.

QString ExamplePlugin::pixmapNameWidget (   )  const [virtual]

Returns: the pixmap name widget?! -- FIXME Implements TodayPluginObject. Definition at line 26 of file exampleplugin.cpp. References QString::fromLatin1().

QString ExamplePlugin::pluginName (   )  const [virtual]

The name if the plugin Returns: The plugin should return its name here Implements TodayPluginObject. Definition at line 17 of file exampleplugin.cpp. References tr.

void ExamplePlugin::refresh (   )  [virtual]

Refresh that plugins view. For updating the plugins Reimplemented from TodayPluginObject. Definition at line 56 of file exampleplugin.cpp. References m_widget, and ExamplePluginWidget::refresh().

void ExamplePlugin::reinitialize (   )  [virtual]

reread the plugins config and act apropiate This is for example used when returning from the config dialog Reimplemented from TodayPluginObject. Definition at line 62 of file exampleplugin.cpp.

double ExamplePlugin::versionNumber (   )  const [virtual]

Version numbering Returns: The plugin should return the version number Implements TodayPluginObject. Definition at line 21 of file exampleplugin.cpp.

QWidget * ExamplePlugin::widget (  QWidget *   )  [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 Implements TodayPluginObject. Definition at line 30 of file exampleplugin.cpp. References m_widget.

---

Member Data Documentation

ExamplePluginWidget* ExamplePlugin::m_widget [private]

Definition at line 35 of file exampleplugin.h. Referenced by refresh(), and widget().

---

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

• examples/todayplugin/exampleplugin.h
• examples/todayplugin/exampleplugin.cpp

---