-rw-r--r-- | libopie/otabwidget.h | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/libopie/otabwidget.h b/libopie/otabwidget.h index 0aa9bb8..23fe774 100644 --- a/libopie/otabwidget.h +++ b/libopie/otabwidget.h | |||
@@ -1,275 +1,277 @@ | |||
1 | /* | 1 | /* |
2 | This file is part of the Opie Project | 2 | This file is part of the Opie Project |
3 | 3 | ||
4 | Copyright (c) 2002 Dan Williams <williamsdr@acm.org> | 4 | Copyright (c) 2002 Dan Williams <williamsdr@acm.org> |
5 | =. | 5 | =. |
6 | .=l. | 6 | .=l. |
7 | .>+-= | 7 | .>+-= |
8 | _;:, .> :=|. This program is free software; you can | 8 | _;:, .> :=|. This program is free software; you can |
9 | .> <`_, > . <= redistribute it and/or modify it under | 9 | .> <`_, > . <= redistribute it and/or modify it under |
10 | :`=1 )Y*s>-.-- : the terms of the GNU Library General Public | 10 | :`=1 )Y*s>-.-- : the terms of the GNU Library General Public |
11 | .="- .-=="i, .._ License as published by the Free Software | 11 | .="- .-=="i, .._ License as published by the Free Software |
12 | - . .-<_> .<> Foundation; either version 2 of the License, | 12 | - . .-<_> .<> Foundation; either version 2 of the License, |
13 | ._= =} : or (at your option) any later version. | 13 | ._= =} : or (at your option) any later version. |
14 | .%`+i> _;_. | 14 | .%`+i> _;_. |
15 | .i_,=:_. -<s. This program is distributed in the hope that | 15 | .i_,=:_. -<s. This program is distributed in the hope that |
16 | + . -:. = it will be useful, but WITHOUT ANY WARRANTY; | 16 | + . -:. = it will be useful, but WITHOUT ANY WARRANTY; |
17 | : .. .:, . . . without even the implied warranty of | 17 | : .. .:, . . . without even the implied warranty of |
18 | =_ + =;=|` MERCHANTABILITY or FITNESS FOR A | 18 | =_ + =;=|` MERCHANTABILITY or FITNESS FOR A |
19 | _.=:. : :=>`: PARTICULAR PURPOSE. See the GNU | 19 | _.=:. : :=>`: PARTICULAR PURPOSE. See the GNU |
20 | ..}^=.= = ; Library General Public License for more | 20 | ..}^=.= = ; Library General Public License for more |
21 | ++= -. .` .: details. | 21 | ++= -. .` .: details. |
22 | : = ...= . :.=- | 22 | : = ...= . :.=- |
23 | -. .:....=;==+<; You should have received a copy of the GNU | 23 | -. .:....=;==+<; You should have received a copy of the GNU |
24 | -_. . . )=. = Library General Public License along with | 24 | -_. . . )=. = Library General Public License along with |
25 | -- :-=` this library; see the file COPYING.LIB. | 25 | -- :-=` this library; see the file COPYING.LIB. |
26 | If not, write to the Free Software Foundation, | 26 | If not, write to the Free Software Foundation, |
27 | Inc., 59 Temple Place - Suite 330, | 27 | Inc., 59 Temple Place - Suite 330, |
28 | Boston, MA 02111-1307, USA. | 28 | Boston, MA 02111-1307, USA. |
29 | 29 | ||
30 | */ | 30 | */ |
31 | 31 | ||
32 | #ifndef OTABWIDGET_H | 32 | #ifndef OTABWIDGET_H |
33 | #define OTABWIDGET_H | 33 | #define OTABWIDGET_H |
34 | 34 | ||
35 | #include "otabinfo.h" | 35 | #include "otabinfo.h" |
36 | 36 | ||
37 | #include <qwidget.h> | 37 | #include <qwidget.h> |
38 | #include <qlist.h> | 38 | #include <qlist.h> |
39 | 39 | ||
40 | class OTabBar; | 40 | class OTabBar; |
41 | class QComboBox; | 41 | class QComboBox; |
42 | class QPixmap; | 42 | class QPixmap; |
43 | class QTabBar; | 43 | class QTabBar; |
44 | class QWidgetStack; | 44 | class QWidgetStack; |
45 | 45 | ||
46 | /** | 46 | /** |
47 | * @class OTabWidget | 47 | * @class OTabWidget |
48 | * @brief The OTabWidget class provides a stack of widgets. | 48 | * @brief The OTabWidget class provides a stack of widgets. |
49 | * | 49 | * |
50 | * OTabWidget is a derivation of TrollTech's QTabWidget which provides | 50 | * OTabWidget is a derivation of TrollTech's QTabWidget which provides |
51 | * a stack of widgets. Widgets can be selected using either a tab bar or | 51 | * a stack of widgets. Widgets can be selected using either a tab bar or |
52 | * drop down list box. | 52 | * drop down list box. |
53 | * | 53 | * |
54 | * The normal way to use OTabWidget is to do the following in the | 54 | * The normal way to use OTabWidget is to do the following in the |
55 | * constructor: | 55 | * constructor: |
56 | * - Create a OTabWidget. | 56 | * - Create a OTabWidget. |
57 | * - Create a QWidget for each of the pages in the control, insert | 57 | * - Create a QWidget for each of the pages in the control, insert |
58 | * children into it, set up geometry management for it, and use addTab() | 58 | * children into it, set up geometry management for it, and use addTab() |
59 | * to add the widget. | 59 | * to add the widget. |
60 | */ | 60 | */ |
61 | class OTabWidget : public QWidget | 61 | class OTabWidget : public QWidget |
62 | { | 62 | { |
63 | Q_OBJECT | 63 | Q_OBJECT |
64 | public: | 64 | public: |
65 | 65 | ||
66 | /** | 66 | /** |
67 | * @enum TabStyle | 67 | * @enum TabStyle |
68 | * @brief Defines how the widget selection control is displayed. | 68 | * @brief Defines how the widget selection control is displayed. |
69 | * | 69 | * |
70 | * Valid values: | 70 | * Valid values: |
71 | * - Global: use globally selected options (qpe.conf - TabStyle & TabPosition) | 71 | * - Global: use globally selected options (qpe.conf - TabStyle & TabPosition) |
72 | * - TextTab: Tabbed widget selection with text labels | 72 | * - TextTab: Tabbed widget selection with text labels |
73 | * - IconTab: Tabbed widget selection with icon labels, text label for active widget | 73 | * - IconTab: Tabbed widget selection with icon labels, text label for active widget |
74 | * (similar to Opie launcher) | 74 | * (similar to Opie launcher) |
75 | * - TextList: Drop down list widget selection with text labels | 75 | * - TextList: Drop down list widget selection with text labels |
76 | * - IconList: Drop down list widget selection with icon & text labels | 76 | * - IconList: Drop down list widget selection with icon & text labels |
77 | */ | 77 | */ |
78 | enum TabStyle { Global, TextTab, IconTab, TextList, IconList }; | 78 | enum TabStyle { Global, TextTab, IconTab, TextList, IconList }; |
79 | 79 | ||
80 | /** | 80 | /** |
81 | * @enum TabPosition | 81 | * @enum TabPosition |
82 | * @brief Defines where the widget selection control is drawn. | 82 | * @brief Defines where the widget selection control is drawn. |
83 | * | 83 | * |
84 | * Valid values: | 84 | * Valid values: |
85 | * - Top: Widget selection control is drawn above widgets | 85 | * - Top: Widget selection control is drawn above widgets |
86 | * - Bottom: Widget selection control is drawn below widgets | 86 | * - Bottom: Widget selection control is drawn below widgets |
87 | */ | 87 | */ |
88 | enum TabPosition { Top, Bottom }; | 88 | enum TabPosition { Top, Bottom }; |
89 | 89 | ||
90 | /** | 90 | /** |
91 | * @fn OTabWidget( QWidget *parent = 0, const char *name = 0, TabStyle s = Global, TabPosition p = Top ) | 91 | * @fn OTabWidget( QWidget *parent = 0, const char *name = 0, TabStyle s = Global, TabPosition p = Top ) |
92 | * @brief Object constructor. | 92 | * @brief Object constructor. |
93 | * | 93 | * |
94 | * @param parent Pointer to parent of this control. | 94 | * @param parent Pointer to parent of this control. |
95 | * @param name Name of control. | 95 | * @param name Name of control. |
96 | * @param s Style of widget selection control. | 96 | * @param s Style of widget selection control. |
97 | * @param p Position of the widget selection control. | 97 | * @param p Position of the widget selection control. |
98 | * | 98 | * |
99 | * Constructs a new OTabWidget control with parent and name. The style and position parameters | 99 | * Constructs a new OTabWidget control with parent and name. The style and position parameters |
100 | * determine how the widget selection control will be displayed. | 100 | * determine how the widget selection control will be displayed. |
101 | */ | 101 | */ |
102 | // FIXME WFlags? -zecke | ||
102 | OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top ); | 103 | OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top ); |
103 | 104 | ||
104 | /** | 105 | /** |
105 | * @fn ~OTabWidget() | 106 | * @fn ~OTabWidget() |
106 | * @brief Object destructor. | 107 | * @brief Object destructor. |
107 | */ | 108 | */ |
108 | ~OTabWidget(); | 109 | ~OTabWidget(); |
109 | 110 | ||
110 | /** | 111 | /** |
111 | * @fn addTab( QWidget *child, const QString &icon, const QString &label ) | 112 | * @fn addTab( QWidget *child, const QString &icon, const QString &label ) |
112 | * @brief Add new widget to control. | 113 | * @brief Add new widget to control. |
113 | * | 114 | * |
114 | * @param child Widget control. | 115 | * @param child Widget control. |
115 | * @param icon Path to icon. | 116 | * @param icon Path to icon. |
116 | * @param label Text label. | 117 | * @param label Text label. |
117 | */ | 118 | */ |
118 | void addTab( QWidget *, const QString &, const QString & ); | 119 | void addTab( QWidget *, const QString &, const QString & ); |
119 | 120 | ||
120 | /** | 121 | /** |
121 | * @fn removePage( QWidget *widget ) | 122 | * @fn removePage( QWidget *widget ) |
122 | * @brief Remove widget from control. Does not delete widget. | 123 | * @brief Remove widget from control. Does not delete widget. |
123 | * | 124 | * |
124 | * @param widget Widget control to be removed. | 125 | * @param widget Widget control to be removed. |
125 | */ | 126 | */ |
126 | void removePage( QWidget * ); | 127 | void removePage( QWidget * ); |
127 | 128 | ||
128 | /** | 129 | /** |
129 | * @fn changeTab( QWidget *widget, const QIconSet &icon, const QString &label ) | 130 | * @fn changeTab( QWidget *widget, const QIconSet &icon, const QString &label ) |
130 | * @brief Change text and/or icon for existing tab | 131 | * @brief Change text and/or icon for existing tab |
131 | * | 132 | * |
132 | * @param child Widget control. | 133 | * @param child Widget control. |
133 | * @param icon Path to icon. | 134 | * @param icon Path to icon. |
134 | * @param label Text label. | 135 | * @param label Text label. |
135 | */ | 136 | */ |
136 | void changeTab( QWidget *, const QString &, const QString & ); | 137 | void changeTab( QWidget *, const QString &, const QString & ); |
137 | 138 | ||
138 | /** | 139 | /** |
139 | * @fn tabStyle() | 140 | * @fn tabStyle() |
140 | * @brief Returns current widget selection control style. | 141 | * @brief Returns current widget selection control style. |
141 | */ | 142 | */ |
142 | TabStyle tabStyle() const; | 143 | TabStyle tabStyle() const; |
143 | 144 | ||
144 | /** | 145 | /** |
145 | * @fn setTabStyle( TabStyle s ) | 146 | * @fn setTabStyle( TabStyle s ) |
146 | * @brief Set the current widget selection control style. | 147 | * @brief Set the current widget selection control style. |
147 | * | 148 | * |
148 | * @param s New style to be used. | 149 | * @param s New style to be used. |
149 | */ | 150 | */ |
150 | void setTabStyle( TabStyle ); | 151 | void setTabStyle( TabStyle ); |
151 | 152 | ||
152 | /** | 153 | /** |
153 | * @fn tabPosition() | 154 | * @fn tabPosition() |
154 | * @brief Returns current widget selection control position. | 155 | * @brief Returns current widget selection control position. |
155 | */ | 156 | */ |
156 | TabPosition tabPosition() const; | 157 | TabPosition tabPosition() const; |
157 | 158 | ||
158 | /** | 159 | /** |
159 | * @fn setTabPosition( TabPosition p ) | 160 | * @fn setTabPosition( TabPosition p ) |
160 | * @brief Set the current widget selection control position. | 161 | * @brief Set the current widget selection control position. |
161 | * | 162 | * |
162 | * @param p New position of widget selection control. | 163 | * @param p New position of widget selection control. |
163 | */ | 164 | */ |
164 | void setTabPosition( TabPosition ); | 165 | void setTabPosition( TabPosition ); |
165 | 166 | ||
166 | /** | 167 | /** |
167 | * @fn setCurrentTab( QWidget *childwidget ) | 168 | * @fn setCurrentTab( QWidget *childwidget ) |
168 | * @brief Selects and brings to top the desired widget by using widget pointer. | 169 | * @brief Selects and brings to top the desired widget by using widget pointer. |
169 | * | 170 | * |
170 | * @param childwidget Widget to select. | 171 | * @param childwidget Widget to select. |
171 | */ | 172 | */ |
172 | void setCurrentTab( QWidget * ); | 173 | void setCurrentTab( QWidget * ); |
173 | 174 | ||
174 | /** | 175 | /** |
175 | * @fn setCurrentTab( const QString &tabname ) | 176 | * @fn setCurrentTab( const QString &tabname ) |
176 | * @brief Selects and brings to top the desired widget, by using label. | 177 | * @brief Selects and brings to top the desired widget, by using label. |
177 | * | 178 | * |
178 | * @param tabname Text label for widget to select. | 179 | * @param tabname Text label for widget to select. |
179 | */ | 180 | */ |
180 | void setCurrentTab( const QString & ); | 181 | void setCurrentTab( const QString & ); |
181 | 182 | ||
182 | /** | 183 | /** |
183 | * @fn setCurrentTab( int ) | 184 | * @fn setCurrentTab( int ) |
184 | * @brief Selects and brings to top the desired widget, by using id. | 185 | * @brief Selects and brings to top the desired widget, by using id. |
185 | * | 186 | * |
186 | * @param tab id for widget to select. | 187 | * @param tab id for widget to select. |
187 | */ | 188 | */ |
188 | void setCurrentTab(int); | 189 | void setCurrentTab(int); |
189 | 190 | ||
190 | /** | 191 | /** |
191 | * @fn sizeHint() | 192 | * @fn sizeHint() |
192 | * @brief Reimplemented for internal purposes. | 193 | * @brief Reimplemented for internal purposes. |
193 | */ | 194 | */ |
194 | QSize sizeHint() const; | 195 | QSize sizeHint() const; |
195 | 196 | ||
196 | /** | 197 | /** |
197 | * @fn getCurrentTab( ) | 198 | * @fn getCurrentTab( ) |
198 | * @brief returns current tab id. | 199 | * @brief returns current tab id. |
199 | */ | 200 | */ |
201 | //FIXME TT coding style currentTab() -zecke | ||
200 | int getCurrentTab(); | 202 | int getCurrentTab(); |
201 | 203 | ||
202 | 204 | ||
203 | protected: | 205 | protected: |
204 | 206 | ||
205 | /** | 207 | /** |
206 | * @fn resizeEvent( QResizeEvent * ) | 208 | * @fn resizeEvent( QResizeEvent * ) |
207 | * @brief Reimplemented for internal purposes. | 209 | * @brief Reimplemented for internal purposes. |
208 | */ | 210 | */ |
209 | void resizeEvent( QResizeEvent * ); | 211 | void resizeEvent( QResizeEvent * ); |
210 | 212 | ||
211 | private: | 213 | private: |
212 | OTabInfoList tabs; | 214 | OTabInfoList tabs; |
213 | OTabInfo *currentTab; | 215 | OTabInfo *currentTab; |
214 | 216 | ||
215 | TabStyle tabBarStyle; | 217 | TabStyle tabBarStyle; |
216 | TabPosition tabBarPosition; | 218 | TabPosition tabBarPosition; |
217 | 219 | ||
218 | QWidgetStack *tabBarStack; | 220 | QWidgetStack *tabBarStack; |
219 | OTabBar *tabBar; | 221 | OTabBar *tabBar; |
220 | QComboBox *tabList; | 222 | QComboBox *tabList; |
221 | 223 | ||
222 | QWidgetStack *widgetStack; | 224 | QWidgetStack *widgetStack; |
223 | 225 | ||
224 | /** | 226 | /** |
225 | * @fn loadSmooth( const QString &name ) | 227 | * @fn loadSmooth( const QString &name ) |
226 | * @brief Loads icon for widget. | 228 | * @brief Loads icon for widget. |
227 | * | 229 | * |
228 | * @param name Name of icon image file. | 230 | * @param name Name of icon image file. |
229 | */ | 231 | */ |
230 | QPixmap loadSmooth( const QString & ); | 232 | QPixmap loadSmooth( const QString & ); |
231 | 233 | ||
232 | /** | 234 | /** |
233 | * @fn selectTab( OTabInfo *tab ) | 235 | * @fn selectTab( OTabInfo *tab ) |
234 | * @brief Internal function to select desired widget. | 236 | * @brief Internal function to select desired widget. |
235 | * | 237 | * |
236 | * @param tab Pointer to data for widget. | 238 | * @param tab Pointer to data for widget. |
237 | */ | 239 | */ |
238 | void selectTab( OTabInfo * ); | 240 | void selectTab( OTabInfo * ); |
239 | 241 | ||
240 | /** | 242 | /** |
241 | * @fn setUpLayout() | 243 | * @fn setUpLayout() |
242 | * @brief Internal function to adjust layout. | 244 | * @brief Internal function to adjust layout. |
243 | */ | 245 | */ |
244 | void setUpLayout(); | 246 | void setUpLayout(); |
245 | 247 | ||
246 | 248 | ||
247 | signals: | 249 | signals: |
248 | /** | 250 | /** |
249 | * @fn currentChanegd( QWidget *widget ) | 251 | * @fn currentChanegd( QWidget *widget ) |
250 | * @brief This signal is emitted whenever the widget has changed. | 252 | * @brief This signal is emitted whenever the widget has changed. |
251 | * | 253 | * |
252 | * @param widget Pointer to new current widget. | 254 | * @param widget Pointer to new current widget. |
253 | */ | 255 | */ |
254 | void currentChanged( QWidget * ); | 256 | void currentChanged( QWidget * ); |
255 | 257 | ||
256 | private slots: | 258 | private slots: |
257 | 259 | ||
258 | /** | 260 | /** |
259 | * @fn slotTabBarSelected( int id ) | 261 | * @fn slotTabBarSelected( int id ) |
260 | * @brief Slot which is called when a tab is selected. | 262 | * @brief Slot which is called when a tab is selected. |
261 | * | 263 | * |
262 | * @param id ID of widget selected. | 264 | * @param id ID of widget selected. |
263 | */ | 265 | */ |
264 | void slotTabBarSelected( int ); | 266 | void slotTabBarSelected( int ); |
265 | 267 | ||
266 | /** | 268 | /** |
267 | * @fn slotTabListSelected( int index ) | 269 | * @fn slotTabListSelected( int index ) |
268 | * @brief Slot which is called when a drop down selection is made. | 270 | * @brief Slot which is called when a drop down selection is made. |
269 | * | 271 | * |
270 | * @param id Index of widget selected. | 272 | * @param id Index of widget selected. |
271 | */ | 273 | */ |
272 | void slotTabListSelected( int ); | 274 | void slotTabListSelected( int ); |
273 | }; | 275 | }; |
274 | 276 | ||
275 | #endif | 277 | #endif |