summaryrefslogtreecommitdiff
path: root/libopie/todayplugininterface.h
authorzecke <zecke>2003-04-16 10:59:24 (UTC)
committer zecke <zecke>2003-04-16 10:59:24 (UTC)
commit5b9d1ddde859ff783f95babf1887fa40e6bfe0be (patch) (unidiff)
tree0a8596c4de5145e5f469a6c0d8dbd2f946ef0817 /libopie/todayplugininterface.h
parenteeb29547890a2d162de66d7d5b98d3840a7e2d79 (diff)
downloadopie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.zip
opie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.tar.gz
opie-5b9d1ddde859ff783f95babf1887fa40e6bfe0be.tar.bz2
API docu fixes...
if using \fn infront of a function make sure to name the right function ljp please see my comment in oticker about constness
Diffstat (limited to 'libopie/todayplugininterface.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie/todayplugininterface.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/libopie/todayplugininterface.h b/libopie/todayplugininterface.h
index 29a12bc..532f492 100644
--- a/libopie/todayplugininterface.h
+++ b/libopie/todayplugininterface.h
@@ -55,52 +55,55 @@ public:
55 55
56 /** 56 /**
57 * Pixmap used in the config widget 57 * Pixmap used in the config widget
58 */ 58 */
59 virtual QString pixmapNameConfig() const = 0; 59 virtual QString pixmapNameConfig() const = 0;
60 60
61 /** 61 /**
62 * Config plugin widget - optional 62 * Config plugin widget - optional
63 * If the plugin has a config widget, it _needs_ a parent here. 63 * If the plugin has a config widget, it _needs_ a parent here.
64 * may return 0 if no config widget is needed 64 * may return 0 if no config widget is needed
65 */ 65 */
66 virtual TodayConfigWidget* configWidget( QWidget * ) = 0; 66 virtual TodayConfigWidget* configWidget( QWidget * ) = 0;
67 67
68 /** 68 /**
69 * The application that should be assigned to the button (pixmap) 69 * The application that should be assigned to the button (pixmap)
70 * Today will show the plugin icon. On click it tries to execute the 70 * Today will show the plugin icon. On click it tries to execute the
71 * plugin related application. 71 * plugin related application.
72 */ 72 */
73 virtual QString appName() const = 0; 73 virtual QString appName() const = 0;
74 74
75 75
76 /** 76 /**
77 * If the plugin should take part in the periodic refresh 77 * If the plugin should take part in the periodic refresh
78 */ 78 */
79 virtual bool excludeFromRefresh() const = 0; 79 virtual bool excludeFromRefresh() const = 0;
80 80
81 /** 81 /**
82 * Refresh that plugins view. For updating the plugins 82 * Refresh that plugins view. For updating the plugins
83 * 83 *
84 */ 84 */
85 virtual void refresh() {}; 85 virtual void refresh() {};
86 86
87 /** 87 /**
88 * minimum height the plugin at least should have 88 * minimum height the plugin at least should have
89 */ 89 */
90 // virtual int minHeight() const = 0; 90 // virtual int minHeight() const = 0;
91 91
92 /** 92 /**
93 * maximum height that should be used before starting scrolling 93 * maximum height that should be used before starting scrolling
94 */ 94 */
95 // virtual int maxHeight() const = 0; 95 // virtual int maxHeight() const = 0;
96 96
97}; 97};
98 98
99/** 99/**
100 * This is part of the QCOM works. See example plugins how to do it right 100 * This is part of the QCOM works. See example plugins how to do it right
101 */ 101 */
102struct TodayPluginInterface : public QUnknownInterface { 102struct TodayPluginInterface : public QUnknownInterface {
103 /**
104 * return the TodayPluginObject implementation
105 */
103 virtual TodayPluginObject *guiPart() = 0; 106 virtual TodayPluginObject *guiPart() = 0;
104}; 107};
105 108
106#endif 109#endif