Diffstat (limited to 'libopie2/opiepim/ui/todayplugininterface.h') (more/less context) (ignore whitespace changes)
-rw-r--r-- | libopie2/opiepim/ui/todayplugininterface.h | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/libopie2/opiepim/ui/todayplugininterface.h b/libopie2/opiepim/ui/todayplugininterface.h index 5dfeaa8..2b7f1e5 100644 --- a/libopie2/opiepim/ui/todayplugininterface.h +++ b/libopie2/opiepim/ui/todayplugininterface.h | |||
@@ -59,62 +59,71 @@ public: | |||
59 | virtual ~TodayPluginObject() {}; | 59 | virtual ~TodayPluginObject() {}; |
60 | 60 | ||
61 | /** | 61 | /** |
62 | * The name if the plugin | 62 | * The name if the plugin |
63 | * @return The plugin should return its name here | 63 | * @return The plugin should return its name here |
64 | */ | 64 | */ |
65 | virtual QString pluginName() const = 0; | 65 | virtual QString pluginName() const = 0; |
66 | 66 | ||
67 | /** | 67 | /** |
68 | * Version numbering | 68 | * Version numbering |
69 | * @return The plugin should return the version number | 69 | * @return The plugin should return the version number |
70 | */ | 70 | */ |
71 | virtual double versionNumber() const = 0; | 71 | virtual double versionNumber() const = 0; |
72 | 72 | ||
73 | 73 | ||
74 | /** | 74 | /** |
75 | * @return the pixmap name widget?! -- FIXME | 75 | * @return the pixmap name widget?! -- FIXME |
76 | */ | 76 | */ |
77 | virtual QString pixmapNameWidget() const = 0; | 77 | virtual QString pixmapNameWidget() const = 0; |
78 | 78 | ||
79 | /** | 79 | /** |
80 | * widget for the today view | 80 | * widget for the today view |
81 | * It _needs_ a parent here. | 81 | * It _needs_ a parent here. |
82 | * Plugin authors need to take parent as parent! | 82 | * Plugin authors need to take parent as parent! |
83 | * | ||
84 | * Note that you always need to create a new QWidget | ||
85 | * on this call and the ownership is transfered to the | ||
86 | * caller. | ||
87 | * | ||
88 | * @param The parent of your to be created widget | ||
83 | */ | 89 | */ |
84 | virtual QWidget* widget( QWidget *parent ) = 0; | 90 | virtual QWidget* widget( QWidget *parent ) = 0; |
85 | 91 | ||
86 | /** | 92 | /** |
87 | * Pixmap used in the config widget | 93 | * Pixmap used in the config widget |
88 | */ | 94 | */ |
89 | virtual QString pixmapNameConfig() const = 0; | 95 | virtual QString pixmapNameConfig() const = 0; |
90 | 96 | ||
91 | /** | 97 | /** |
92 | * Config plugin widget - optional | 98 | * Config plugin widget - optional |
93 | * If the plugin has a config widget, it _needs_ a parent here. | 99 | * If the plugin has a config widget, it _needs_ a parent here. |
94 | * may return 0 if no config widget is needed | 100 | * may return 0 if no config widget is needed |
101 | * | ||
102 | * Note: Always create a new Widget on this call and ownership | ||
103 | * is transfered | ||
95 | */ | 104 | */ |
96 | virtual TodayConfigWidget* configWidget( QWidget * ) = 0; | 105 | virtual TodayConfigWidget* configWidget( QWidget *parent ) = 0; |
97 | 106 | ||
98 | /** | 107 | /** |
99 | * The application that should be assigned to the button (pixmap) | 108 | * The application that should be assigned to the button (pixmap) |
100 | * Today will show the plugin icon. On click it tries to execute the | 109 | * Today will show the plugin icon. On click it tries to execute the |
101 | * plugin related application. | 110 | * plugin related application. |
102 | */ | 111 | */ |
103 | virtual QString appName() const = 0; | 112 | virtual QString appName() const = 0; |
104 | 113 | ||
105 | 114 | ||
106 | /** | 115 | /** |
107 | * If the plugin should take part in the periodic refresh | 116 | * If the plugin should take part in the periodic refresh |
108 | */ | 117 | */ |
109 | virtual bool excludeFromRefresh() const = 0; | 118 | virtual bool excludeFromRefresh() const = 0; |
110 | 119 | ||
111 | /** | 120 | /** |
112 | * Refresh that plugins view. For updating the plugins | 121 | * Refresh that plugins view. For updating the plugins |
113 | */ | 122 | */ |
114 | virtual void refresh() {}; | 123 | virtual void refresh() {}; |
115 | 124 | ||
116 | /** | 125 | /** |
117 | * reread the plugins config and act apropiate | 126 | * reread the plugins config and act apropiate |
118 | * This is for example used when returning from the config dialog | 127 | * This is for example used when returning from the config dialog |
119 | */ | 128 | */ |
120 | virtual void reinitialize() {}; | 129 | virtual void reinitialize() {}; |