Diffstat (limited to 'libopie2/opieui/otabwidget.h') (more/less context) (ignore whitespace changes)
-rw-r--r-- | libopie2/opieui/otabwidget.h | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/libopie2/opieui/otabwidget.h b/libopie2/opieui/otabwidget.h index 51d1c6d..c7d32c2 100644 --- a/libopie2/opieui/otabwidget.h +++ b/libopie2/opieui/otabwidget.h | |||
@@ -1,28 +1,27 @@ | |||
1 | /* | 1 | /* |
2 | This file is part of the Opie Project | 2 | This file is part of the Opie Project |
3 | 3 | Copyright (C) 2002 Dan Williams <williamsdr@acm.org> | |
4 | Copyright (c) 2002 Dan Williams <williamsdr@acm.org> | ||
5 | =. | 4 | =. |
6 | .=l. | 5 | .=l. |
7 | .>+-= | 6 | .>+-= |
8 | _;:, .> :=|. This program is free software; you can | 7 | _;:, .> :=|. This program is free software; you can |
9 | .> <`_, > . <= redistribute it and/or modify it under | 8 | .> <`_, > . <= redistribute it and/or modify it under |
10 | :`=1 )Y*s>-.-- : the terms of the GNU Library General Public | 9 | :`=1 )Y*s>-.-- : the terms of the GNU Library General Public |
11 | .="- .-=="i, .._ License as published by the Free Software | 10 | .="- .-=="i, .._ License as published by the Free Software |
12 | - . .-<_> .<> Foundation; either version 2 of the License, | 11 | - . .-<_> .<> Foundation; either version 2 of the License, |
13 | ._= =} : or (at your option) any later version. | 12 | ._= =} : or (at your option) any later version. |
14 | .%`+i> _;_. | 13 | .%`+i> _;_. |
15 | .i_,=:_. -<s. This program is distributed in the hope that | 14 | .i_,=:_. -<s. This program is distributed in the hope that |
16 | + . -:. = it will be useful, but WITHOUT ANY WARRANTY; | 15 | + . -:. = it will be useful, but WITHOUT ANY WARRANTY; |
17 | : .. .:, . . . without even the implied warranty of | 16 | : .. .:, . . . without even the implied warranty of |
18 | =_ + =;=|` MERCHANTABILITY or FITNESS FOR A | 17 | =_ + =;=|` MERCHANTABILITY or FITNESS FOR A |
19 | _.=:. : :=>`: PARTICULAR PURPOSE. See the GNU | 18 | _.=:. : :=>`: PARTICULAR PURPOSE. See the GNU |
20 | ..}^=.= = ; Library General Public License for more | 19 | ..}^=.= = ; Library General Public License for more |
21 | ++= -. .` .: details. | 20 | ++= -. .` .: details. |
22 | : = ...= . :.=- | 21 | : = ...= . :.=- |
23 | -. .:....=;==+<; You should have received a copy of the GNU | 22 | -. .:....=;==+<; You should have received a copy of the GNU |
24 | -_. . . )=. = Library General Public License along with | 23 | -_. . . )=. = Library General Public License along with |
25 | -- :-=` this library; see the file COPYING.LIB. | 24 | -- :-=` this library; see the file COPYING.LIB. |
26 | If not, write to the Free Software Foundation, | 25 | If not, write to the Free Software Foundation, |
27 | Inc., 59 Temple Place - Suite 330, | 26 | Inc., 59 Temple Place - Suite 330, |
28 | Boston, MA 02111-1307, USA. | 27 | Boston, MA 02111-1307, USA. |
@@ -48,87 +47,86 @@ class QWidgetStack; | |||
48 | 47 | ||
49 | namespace Opie | 48 | namespace Opie |
50 | { | 49 | { |
51 | 50 | ||
52 | class OTabBar; | 51 | class OTabBar; |
53 | 52 | ||
54 | /** | 53 | /** |
55 | * @class OTabWidget | 54 | * @class OTabWidget |
56 | * @brief The OTabWidget class provides a stack of widgets. | 55 | * @brief The OTabWidget class provides a stack of widgets. |
57 | * | 56 | * |
58 | * OTabWidget is a derivation of TrollTech's QTabWidget which provides | 57 | * OTabWidget is a derivation of TrollTech's QTabWidget which provides |
59 | * a stack of widgets. Widgets can be selected using either a tab bar or | 58 | * a stack of widgets. Widgets can be selected using either a tab bar or |
60 | * drop down list box. | 59 | * drop down list box. |
61 | * | 60 | * |
62 | * The normal way to use OTabWidget is to do the following in the | 61 | * The normal way to use OTabWidget is to do the following in the |
63 | * constructor: | 62 | * constructor: |
64 | * - Create a OTabWidget. | 63 | * - Create a OTabWidget. |
65 | * - Create a QWidget for each of the pages in the control, insert | 64 | * - Create a QWidget for each of the pages in the control, insert |
66 | * children into it, set up geometry management for it, and use addTab() | 65 | * children into it, set up geometry management for it, and use addTab() |
67 | * to add the widget. | 66 | * to add the widget. |
68 | */ | 67 | */ |
69 | class OTabWidget : public QWidget | 68 | class OTabWidget : public QWidget |
70 | { | 69 | { |
71 | Q_OBJECT | 70 | Q_OBJECT |
72 | public: | 71 | |
73 | 72 | public: | |
74 | /** | 73 | /** |
75 | * @enum TabStyle | 74 | * @enum TabStyle |
76 | * @brief Defines how the widget selection control is displayed. | 75 | * @brief Defines how the widget selection control is displayed. |
77 | * | 76 | * |
78 | * Valid values: | 77 | * Valid values: |
79 | * - Global: use globally selected options (qpe.conf - TabStyle & TabPosition) | 78 | * - Global: use globally selected options (qpe.conf - TabStyle & TabPosition) |
80 | * - TextTab: Tabbed widget selection with text labels | 79 | * - TextTab: Tabbed widget selection with text labels |
81 | * - IconTab: Tabbed widget selection with icon labels, text label for active widget | 80 | * - IconTab: Tabbed widget selection with icon labels, text label for active widget |
82 | * (similar to Opie launcher) | 81 | * (similar to Opie launcher) |
83 | * - TextList: Drop down list widget selection with text labels | 82 | * - TextList: Drop down list widget selection with text labels |
84 | * - IconList: Drop down list widget selection with icon & text labels | 83 | * - IconList: Drop down list widget selection with icon & text labels |
85 | */ | 84 | */ |
86 | enum TabStyle { Global, TextTab, IconTab, TextList, IconList }; | 85 | enum TabStyle { Global, TextTab, IconTab, TextList, IconList }; |
87 | 86 | ||
88 | /** | 87 | /** |
89 | * @enum TabPosition | 88 | * @enum TabPosition |
90 | * @brief Defines where the widget selection control is drawn. | 89 | * @brief Defines where the widget selection control is drawn. |
91 | * | 90 | * |
92 | * Valid values: | 91 | * Valid values: |
93 | * - Top: Widget selection control is drawn above widgets | 92 | * - Top: Widget selection control is drawn above widgets |
94 | * - Bottom: Widget selection control is drawn below widgets | 93 | * - Bottom: Widget selection control is drawn below widgets |
95 | */ | 94 | */ |
96 | enum TabPosition { Top, Bottom }; | 95 | enum TabPosition { Top, Bottom }; |
97 | 96 | ||
98 | /** | 97 | /** |
99 | * @fn OTabWidget( QWidget *parent = 0, const char *name = 0, TabStyle s = Global, TabPosition p = Top ) | 98 | * @fn OTabWidget( QWidget *parent = 0, const char *name = 0, TabStyle s = Global, TabPosition p = Top ) |
100 | * @brief Object constructor. | 99 | * @brief Object constructor. |
101 | * | 100 | * |
102 | * @param parent Pointer to parent of this control. | 101 | * @param parent Pointer to parent of this control. |
103 | * @param name Name of control. | 102 | * @param name Name of control. |
104 | * @param s Style of widget selection control. | 103 | * @param s Style of widget selection control. |
105 | * @param p Position of the widget selection control. | 104 | * @param p Position of the widget selection control. |
106 | * | 105 | * |
107 | * Constructs a new OTabWidget control with parent and name. The style and position parameters | 106 | * Constructs a new OTabWidget control with parent and name. The style and position parameters |
108 | * determine how the widget selection control will be displayed. | 107 | * determine how the widget selection control will be displayed. |
109 | */ | 108 | */ |
110 | // FIXME WFlags? -zecke | ||
111 | OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top ); | 109 | OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top ); |
112 | 110 | ||
113 | /** | 111 | /** |
114 | * @fn ~OTabWidget() | 112 | * @fn ~OTabWidget() |
115 | * @brief Object destructor. | 113 | * @brief Object destructor. |
116 | */ | 114 | */ |
117 | ~OTabWidget(); | 115 | ~OTabWidget(); |
118 | 116 | ||
119 | /** | 117 | /** |
120 | * @fn addTab( QWidget *child, const QString &icon, const QString &label ) | 118 | * @fn addTab( QWidget *child, const QString &icon, const QString &label ) |
121 | * @brief Add new widget to control. | 119 | * @brief Add new widget to control. |
122 | * | 120 | * |
123 | * @param child Widget control. | 121 | * @param child Widget control. |
124 | * @param icon Path to icon. | 122 | * @param icon Path to icon. |
125 | * @param label Text label. | 123 | * @param label Text label. |
126 | */ | 124 | */ |
127 | void addTab( QWidget *, const QString &, const QString & ); | 125 | void addTab( QWidget *, const QString &, const QString & ); |
128 | 126 | ||
129 | /** | 127 | /** |
130 | * @fn removePage( QWidget *widget ) | 128 | * @fn removePage( QWidget *widget ) |
131 | * @brief Remove widget from control. Does not delete widget. | 129 | * @brief Remove widget from control. Does not delete widget. |
132 | * | 130 | * |
133 | * @param widget Widget control to be removed. | 131 | * @param widget Widget control to be removed. |
134 | */ | 132 | */ |
@@ -241,55 +239,55 @@ private: | |||
241 | 239 | ||
242 | /** | 240 | /** |
243 | * @fn loadSmooth( const QString &name ) | 241 | * @fn loadSmooth( const QString &name ) |
244 | * @brief Loads icon for widget. | 242 | * @brief Loads icon for widget. |
245 | * | 243 | * |
246 | * @param name Name of icon image file. | 244 | * @param name Name of icon image file. |
247 | */ | 245 | */ |
248 | QPixmap loadSmooth( const QString & ); | 246 | QPixmap loadSmooth( const QString & ); |
249 | 247 | ||
250 | /** | 248 | /** |
251 | * @fn selectTab( OTabInfo *tab ) | 249 | * @fn selectTab( OTabInfo *tab ) |
252 | * @brief Internal function to select desired widget. | 250 | * @brief Internal function to select desired widget. |
253 | * | 251 | * |
254 | * @param tab Pointer to data for widget. | 252 | * @param tab Pointer to data for widget. |
255 | */ | 253 | */ |
256 | void selectTab( OTabInfo * ); | 254 | void selectTab( OTabInfo * ); |
257 | 255 | ||
258 | /** | 256 | /** |
259 | * @fn setUpLayout() | 257 | * @fn setUpLayout() |
260 | * @brief Internal function to adjust layout. | 258 | * @brief Internal function to adjust layout. |
261 | */ | 259 | */ |
262 | void setUpLayout(); | 260 | void setUpLayout(); |
263 | 261 | ||
264 | 262 | ||
265 | signals: | 263 | signals: |
266 | /** | 264 | /** |
267 | * @fn currentChanegd( QWidget *widget ) | 265 | * @fn currentChanegd( QWidget *widget ) |
268 | * @brief This signal is emitted whenever the widget has changed. | 266 | * @brief This signal is emitted whenever the widget has changed. |
269 | * | 267 | * |
270 | * @param widget Pointer to new current widget. | 268 | * @param widget Pointer to new current widget. |
271 | */ | 269 | */ |
272 | void currentChanged( QWidget * ); | 270 | void currentChanged( QWidget * ); |
273 | 271 | ||
274 | private slots: | 272 | private slots: |
275 | 273 | ||
276 | /** | 274 | /** |
277 | * @fn slotTabBarSelected( int id ) | 275 | * @fn slotTabBarSelected( int id ) |
278 | * @brief Slot which is called when a tab is selected. | 276 | * @brief Slot which is called when a tab is selected. |
279 | * | 277 | * |
280 | * @param id ID of widget selected. | 278 | * @param id ID of widget selected. |
281 | */ | 279 | */ |
282 | void slotTabBarSelected( int ); | 280 | void slotTabBarSelected( int ); |
283 | 281 | ||
284 | /** | 282 | /** |
285 | * @fn slotTabListSelected( int index ) | 283 | * @fn slotTabListSelected( int index ) |
286 | * @brief Slot which is called when a drop down selection is made. | 284 | * @brief Slot which is called when a drop down selection is made. |
287 | * | 285 | * |
288 | * @param id Index of widget selected. | 286 | * @param id Index of widget selected. |
289 | */ | 287 | */ |
290 | void slotTabListSelected( int ); | 288 | void slotTabListSelected( int ); |
291 | }; | 289 | }; |
292 | 290 | ||
293 | }; | 291 | }; |
294 | 292 | ||
295 | #endif | 293 | #endif |