Diffstat (limited to 'noncore/unsupported/libopie/todayplugininterface.h') (more/less context) (ignore whitespace changes)
| -rw-r--r-- | noncore/unsupported/libopie/todayplugininterface.h | 133 |
1 files changed, 133 insertions, 0 deletions
diff --git a/noncore/unsupported/libopie/todayplugininterface.h b/noncore/unsupported/libopie/todayplugininterface.h new file mode 100644 index 0000000..5dfeaa8 --- a/dev/null +++ b/noncore/unsupported/libopie/todayplugininterface.h @@ -0,0 +1,133 @@ +/* + This file is part of the Opie Project + Copyright (c) 2002 Maximilian Reiss <max.reiss@gmx.de> + =. + .=l. + .>+-= + _;:, .> :=|. This program is free software; you can +.> <`_, > . <= redistribute it and/or modify it under +:`=1 )Y*s>-.-- : the terms of the GNU General Public +.="- .-=="i, .._ License as published by the Free Software + - . .-<_> .<> Foundation; either version 2 of the License, + ._= =} : or (at your option) any later version. + .%`+i> _;_. + .i_,=:_. -<s. This program is distributed in the hope that + + . -:. = it will be useful, but WITHOUT ANY WARRANTY; + : .. .:, . . . without even the implied warranty of + =_ + =;=|` MERCHANTABILITY or FITNESS FOR A + _.=:. : :=>`: PARTICULAR PURPOSE. See the GNU +..}^=.= = ; Library General Public License for more +++= -. .` .: details. + : = ...= . :.=- + -. .:....=;==+<; You should have received a copy of the GNU + -_. . . )=. = Library General Public License along with + -- :-=` this library; see the file COPYING.LIB. + If not, write to the Free Software Foundation, + Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + +*/ + + +#ifndef TODAY_PLUGIN_INTERFACE +#define TODAY_PLUGIN_INTERFACE + +#include <qpe/qcom.h> +#include "todayconfigwidget.h" + +class QString; +class QWidget; + +#ifndef IID_TodayPluginInterface +#define IID_TodayPluginInterface QUuid( 0x70481804, 0x2b50, 0x4fba, 0x80, 0xbb, 0x0b, 0xf8, 0xdc, 0x72, 0x04, 0x14) +#endif + +/** + * + * A TodayPluginObject is the base for all Today Plugins. + * A plugin author needs to inherit this class and implement + * the pure virtual methods + * + * @short base class for today plugins + * @author Maximilian Reiss + * + */ +class TodayPluginObject { + +public: + + virtual ~TodayPluginObject() {}; + + /** + * The name if the plugin + * @return The plugin should return its name here + */ + virtual QString pluginName() const = 0; + + /** + * Version numbering + * @return The plugin should return the version number + */ + virtual double versionNumber() const = 0; + + + /** + * @return the pixmap name widget?! -- FIXME + */ + virtual QString pixmapNameWidget() const = 0; + + /** + * widget for the today view + * It _needs_ a parent here. + * Plugin authors need to take parent as parent! + */ + virtual QWidget* widget( QWidget *parent ) = 0; + + /** + * Pixmap used in the config widget + */ + virtual QString pixmapNameConfig() const = 0; + + /** + * 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 TodayConfigWidget* configWidget( QWidget * ) = 0; + + /** + * 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 QString appName() const = 0; + + + /** + * If the plugin should take part in the periodic refresh + */ + virtual bool excludeFromRefresh() const = 0; + + /** + * Refresh that plugins view. For updating the plugins + */ + virtual void refresh() {}; + + /** + * reread the plugins config and act apropiate + * This is for example used when returning from the config dialog + */ + virtual void reinitialize() {}; +}; + +/** + * This is part of the QCOM works. See example plugins how to do it right + */ +struct TodayPluginInterface : public QUnknownInterface { + /** + * return the TodayPluginObject implementation + */ + virtual TodayPluginObject *guiPart() = 0; +}; + +#endif |