summaryrefslogtreecommitdiff
path: root/libopie2/opiepim/ui/todayplugininterface.h
Unidiff
Diffstat (limited to 'libopie2/opiepim/ui/todayplugininterface.h') (more/less context) (show whitespace changes)
-rw-r--r--libopie2/opiepim/ui/todayplugininterface.h11
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
@@ -77,26 +77,35 @@ public:
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 */