Diffstat (limited to 'libopie/todayplugininterface.h') (more/less context) (ignore whitespace changes)
| -rw-r--r-- | libopie/todayplugininterface.h | 133 |
1 files changed, 0 insertions, 133 deletions
diff --git a/libopie/todayplugininterface.h b/libopie/todayplugininterface.h deleted file mode 100644 index 5dfeaa8..0000000 --- a/libopie/todayplugininterface.h +++ b/dev/null | |||
| @@ -1,133 +0,0 @@ | |||
| 1 | /* | ||
| 2 | This file is part of the Opie Project | ||
| 3 | Copyright (c) 2002 Maximilian Reiss <max.reiss@gmx.de> | ||
| 4 | =. | ||
| 5 | .=l. | ||
| 6 | .>+-= | ||
| 7 | _;:, .> :=|. This program is free software; you can | ||
| 8 | .> <`_, > . <= redistribute it and/or modify it under | ||
| 9 | :`=1 )Y*s>-.-- : the terms of the GNU General Public | ||
| 10 | .="- .-=="i, .._ License as published by the Free Software | ||
| 11 | - . .-<_> .<> Foundation; either version 2 of the License, | ||
| 12 | ._= =} : or (at your option) any later version. | ||
| 13 | .%`+i> _;_. | ||
| 14 | .i_,=:_. -<s. This program is distributed in the hope that | ||
| 15 | + . -:. = it will be useful, but WITHOUT ANY WARRANTY; | ||
| 16 | : .. .:, . . . without even the implied warranty of | ||
| 17 | =_ + =;=|` MERCHANTABILITY or FITNESS FOR A | ||
| 18 | _.=:. : :=>`: PARTICULAR PURPOSE. See the GNU | ||
| 19 | ..}^=.= = ; Library General Public License for more | ||
| 20 | ++= -. .` .: details. | ||
| 21 | : = ...= . :.=- | ||
| 22 | -. .:....=;==+<; You should have received a copy of the GNU | ||
| 23 | -_. . . )=. = Library General Public License along with | ||
| 24 | -- :-=` this library; see the file COPYING.LIB. | ||
| 25 | If not, write to the Free Software Foundation, | ||
| 26 | Inc., 59 Temple Place - Suite 330, | ||
| 27 | Boston, MA 02111-1307, USA. | ||
| 28 | |||
| 29 | */ | ||
| 30 | |||
| 31 | |||
| 32 | #ifndef TODAY_PLUGIN_INTERFACE | ||
| 33 | #define TODAY_PLUGIN_INTERFACE | ||
| 34 | |||
| 35 | #include <qpe/qcom.h> | ||
| 36 | #include "todayconfigwidget.h" | ||
| 37 | |||
| 38 | class QString; | ||
| 39 | class QWidget; | ||
| 40 | |||
| 41 | #ifndef IID_TodayPluginInterface | ||
| 42 | #define IID_TodayPluginInterface QUuid( 0x70481804, 0x2b50, 0x4fba, 0x80, 0xbb, 0x0b, 0xf8, 0xdc, 0x72, 0x04, 0x14) | ||
| 43 | #endif | ||
| 44 | |||
| 45 | /** | ||
| 46 | * | ||
| 47 | * A TodayPluginObject is the base for all Today Plugins. | ||
| 48 | * A plugin author needs to inherit this class and implement | ||
| 49 | * the pure virtual methods | ||
| 50 | * | ||
| 51 | * @short base class for today plugins | ||
| 52 | * @author Maximilian Reiss | ||
| 53 | * | ||
| 54 | */ | ||
| 55 | class TodayPluginObject { | ||
| 56 | |||
| 57 | public: | ||
| 58 | |||
| 59 | virtual ~TodayPluginObject() {}; | ||
| 60 | |||
| 61 | /** | ||
| 62 | * The name if the plugin | ||
| 63 | * @return The plugin should return its name here | ||
| 64 | */ | ||
| 65 | virtual QString pluginName() const = 0; | ||
| 66 | |||
| 67 | /** | ||
| 68 | * Version numbering | ||
| 69 | * @return The plugin should return the version number | ||
| 70 | */ | ||
| 71 | virtual double versionNumber() const = 0; | ||
| 72 | |||
| 73 | |||
| 74 | /** | ||
| 75 | * @return the pixmap name widget?! -- FIXME | ||
| 76 | */ | ||
| 77 | virtual QString pixmapNameWidget() const = 0; | ||
| 78 | |||
| 79 | /** | ||
| 80 | * widget for the today view | ||
| 81 | * It _needs_ a parent here. | ||
| 82 | * Plugin authors need to take parent as parent! | ||
| 83 | */ | ||
| 84 | virtual QWidget* widget( QWidget *parent ) = 0; | ||
| 85 | |||
| 86 | /** | ||
| 87 | * Pixmap used in the config widget | ||
| 88 | */ | ||
| 89 | virtual QString pixmapNameConfig() const = 0; | ||
| 90 | |||
| 91 | /** | ||
| 92 | * Config plugin widget - optional | ||
| 93 | * If the plugin has a config widget, it _needs_ a parent here. | ||
| 94 | * may return 0 if no config widget is needed | ||
| 95 | */ | ||
| 96 | virtual TodayConfigWidget* configWidget( QWidget * ) = 0; | ||
| 97 | |||
| 98 | /** | ||
| 99 | * The application that should be assigned to the button (pixmap) | ||
| 100 | * Today will show the plugin icon. On click it tries to execute the | ||
| 101 | * plugin related application. | ||
| 102 | */ | ||
| 103 | virtual QString appName() const = 0; | ||
| 104 | |||
| 105 | |||
| 106 | /** | ||
| 107 | * If the plugin should take part in the periodic refresh | ||
| 108 | */ | ||
| 109 | virtual bool excludeFromRefresh() const = 0; | ||
| 110 | |||
| 111 | /** | ||
| 112 | * Refresh that plugins view. For updating the plugins | ||
| 113 | */ | ||
| 114 | virtual void refresh() {}; | ||
| 115 | |||
| 116 | /** | ||
| 117 | * reread the plugins config and act apropiate | ||
| 118 | * This is for example used when returning from the config dialog | ||
| 119 | */ | ||
| 120 | virtual void reinitialize() {}; | ||
| 121 | }; | ||
| 122 | |||
| 123 | /** | ||
| 124 | * This is part of the QCOM works. See example plugins how to do it right | ||
| 125 | */ | ||
| 126 | struct TodayPluginInterface : public QUnknownInterface { | ||
| 127 | /** | ||
| 128 | * return the TodayPluginObject implementation | ||
| 129 | */ | ||
| 130 | virtual TodayPluginObject *guiPart() = 0; | ||
| 131 | }; | ||
| 132 | |||
| 133 | #endif | ||