-rw-r--r-- | libopie/otabwidget.h | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/libopie/otabwidget.h b/libopie/otabwidget.h index bacda07..d61fe9e 100644 --- a/libopie/otabwidget.h +++ b/libopie/otabwidget.h | |||
@@ -25,209 +25,226 @@ | |||
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 | OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top ); | 102 | OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top ); |
103 | 103 | ||
104 | /** | 104 | /** |
105 | * @fn ~OTabWidget() | 105 | * @fn ~OTabWidget() |
106 | * @brief Object destructor. | 106 | * @brief Object destructor. |
107 | */ | 107 | */ |
108 | ~OTabWidget(); | 108 | ~OTabWidget(); |
109 | 109 | ||
110 | /** | 110 | /** |
111 | * @fn addTab( QWidget *child, const QString &icon, const QString &label ) | 111 | * @fn addTab( QWidget *child, const QString &icon, const QString &label ) |
112 | * @brief Add new widget to control. | 112 | * @brief Add new widget to control. |
113 | * | 113 | * |
114 | * @param child Widget control. | 114 | * @param child Widget control. |
115 | * @param icon Path to icon. | 115 | * @param icon Path to icon. |
116 | * @param label Text label. | 116 | * @param label Text label. |
117 | */ | 117 | */ |
118 | void addTab( QWidget *, const QString &, const QString & ); | 118 | void addTab( QWidget *, const QString &, const QString & ); |
119 | 119 | ||
120 | /** | 120 | /** |
121 | * @fn removePage( QWidget *widget ) | ||
122 | * @brief Remove widget from control. Does not delete widget. | ||
123 | * | ||
124 | * @param widget Widget control to be removed. | ||
125 | */ | ||
126 | void removePage( QWidget * ); | ||
127 | |||
128 | /** | ||
121 | * @fn tabStyle() | 129 | * @fn tabStyle() |
122 | * @brief Returns current widget selection control style. | 130 | * @brief Returns current widget selection control style. |
123 | */ | 131 | */ |
124 | TabStyle tabStyle() const; | 132 | TabStyle tabStyle() const; |
125 | 133 | ||
126 | /** | 134 | /** |
127 | * @fn setTabStyle( TabStyle s ) | 135 | * @fn setTabStyle( TabStyle s ) |
128 | * @brief Set the current widget selection control style. | 136 | * @brief Set the current widget selection control style. |
129 | * | 137 | * |
130 | * @param s New style to be used. | 138 | * @param s New style to be used. |
131 | */ | 139 | */ |
132 | void setTabStyle( TabStyle ); | 140 | void setTabStyle( TabStyle ); |
133 | 141 | ||
134 | /** | 142 | /** |
135 | * @fn tabPosition() | 143 | * @fn tabPosition() |
136 | * @brief Returns current widget selection control position. | 144 | * @brief Returns current widget selection control position. |
137 | */ | 145 | */ |
138 | TabPosition tabPosition() const; | 146 | TabPosition tabPosition() const; |
139 | 147 | ||
140 | /** | 148 | /** |
141 | * @fn setTabPosition( TabPosition p ) | 149 | * @fn setTabPosition( TabPosition p ) |
142 | * @brief Set the current widget selection control position. | 150 | * @brief Set the current widget selection control position. |
143 | * | 151 | * |
144 | * @param p New position of widget selection control. | 152 | * @param p New position of widget selection control. |
145 | */ | 153 | */ |
146 | void setTabPosition( TabPosition ); | 154 | void setTabPosition( TabPosition ); |
147 | 155 | ||
148 | /** | 156 | /** |
149 | * @fn setCurrentTab( QWidget *childwidget ) | 157 | * @fn setCurrentTab( QWidget *childwidget ) |
150 | * @brief Selects and brings to top the desired widget by using widget pointer. | 158 | * @brief Selects and brings to top the desired widget by using widget pointer. |
151 | * | 159 | * |
152 | * @param childwidget Widget to select. | 160 | * @param childwidget Widget to select. |
153 | */ | 161 | */ |
154 | void setCurrentTab( QWidget * ); | 162 | void setCurrentTab( QWidget * ); |
155 | 163 | ||
156 | /** | 164 | /** |
157 | * @fn setCurrentTab( const QString &tabname ) | 165 | * @fn setCurrentTab( const QString &tabname ) |
158 | * @brief Selects and brings to top the desired widget, by using label. | 166 | * @brief Selects and brings to top the desired widget, by using label. |
159 | * | 167 | * |
160 | * @param tabname Text label for widget to select. | 168 | * @param tabname Text label for widget to select. |
161 | */ | 169 | */ |
162 | void setCurrentTab( const QString & ); | 170 | void setCurrentTab( const QString & ); |
163 | 171 | ||
164 | /** | 172 | /** |
165 | * @fn sizeHint() | 173 | * @fn sizeHint() |
166 | * @brief Reimplemented for internal purposes. | 174 | * @brief Reimplemented for internal purposes. |
167 | */ | 175 | */ |
168 | QSize sizeHint() const; | 176 | QSize sizeHint() const; |
169 | 177 | ||
170 | 178 | ||
171 | protected: | 179 | protected: |
172 | 180 | ||
173 | /** | 181 | /** |
174 | * @fn resizeEvent( QResizeEvent * ) | 182 | * @fn resizeEvent( QResizeEvent * ) |
175 | * @brief Reimplemented for internal purposes. | 183 | * @brief Reimplemented for internal purposes. |
176 | */ | 184 | */ |
177 | void resizeEvent( QResizeEvent * ); | 185 | void resizeEvent( QResizeEvent * ); |
178 | 186 | ||
179 | private: | 187 | private: |
180 | OTabInfoList tabs; | 188 | OTabInfoList tabs; |
181 | OTabInfo *currentTab; | 189 | OTabInfo *currentTab; |
182 | 190 | ||
183 | TabStyle tabBarStyle; | 191 | TabStyle tabBarStyle; |
184 | TabPosition tabBarPosition; | 192 | TabPosition tabBarPosition; |
185 | 193 | ||
186 | QWidgetStack *tabBarStack; | 194 | QWidgetStack *tabBarStack; |
187 | OTabBar *tabBar; | 195 | OTabBar *tabBar; |
188 | QComboBox *tabList; | 196 | QComboBox *tabList; |
189 | 197 | ||
190 | QWidgetStack *widgetStack; | 198 | QWidgetStack *widgetStack; |
191 | 199 | ||
192 | /** | 200 | /** |
193 | * @fn loadSmooth( const QString &name ) | 201 | * @fn loadSmooth( const QString &name ) |
194 | * @brief Loads icon for widget. | 202 | * @brief Loads icon for widget. |
195 | * | 203 | * |
196 | * @param name Name of icon image file. | 204 | * @param name Name of icon image file. |
197 | */ | 205 | */ |
198 | QPixmap loadSmooth( const QString & ); | 206 | QPixmap loadSmooth( const QString & ); |
199 | 207 | ||
200 | /** | 208 | /** |
201 | * @fn selectTab( OTabInfo *tab ) | 209 | * @fn selectTab( OTabInfo *tab ) |
202 | * @brief Internal function to select desired widget. | 210 | * @brief Internal function to select desired widget. |
203 | * | 211 | * |
204 | * @param tab Pointer to data for widget. | 212 | * @param tab Pointer to data for widget. |
205 | */ | 213 | */ |
206 | void selectTab( OTabInfo * ); | 214 | void selectTab( OTabInfo * ); |
207 | 215 | ||
208 | /** | 216 | /** |
209 | * @fn setUpLayout() | 217 | * @fn setUpLayout() |
210 | * @brief Internal function to adjust layout. | 218 | * @brief Internal function to adjust layout. |
211 | */ | 219 | */ |
212 | void setUpLayout(); | 220 | void setUpLayout(); |
213 | 221 | ||
222 | signals: | ||
223 | /** | ||
224 | * @fn currentChanegd( QWidget *widget ) | ||
225 | * @brief This signal is emitted whenever the widget has changed. | ||
226 | * | ||
227 | * @param widget Pointer to new current widget. | ||
228 | */ | ||
229 | void currentChanged( QWidget * ); | ||
230 | |||
214 | private slots: | 231 | private slots: |
215 | 232 | ||
216 | /** | 233 | /** |
217 | * @fn slotTabBarSelected( int id ) | 234 | * @fn slotTabBarSelected( int id ) |
218 | * @brief Slot which is called when a tab is selected. | 235 | * @brief Slot which is called when a tab is selected. |
219 | * | 236 | * |
220 | * @param id ID of widget selected. | 237 | * @param id ID of widget selected. |
221 | */ | 238 | */ |
222 | void slotTabBarSelected( int ); | 239 | void slotTabBarSelected( int ); |
223 | 240 | ||
224 | /** | 241 | /** |
225 | * @fn slotTabListSelected( int index ) | 242 | * @fn slotTabListSelected( int index ) |
226 | * @brief Slot which is called when a drop down selection is made. | 243 | * @brief Slot which is called when a drop down selection is made. |
227 | * | 244 | * |
228 | * @param id Index of widget selected. | 245 | * @param id Index of widget selected. |
229 | */ | 246 | */ |
230 | void slotTabListSelected( int ); | 247 | void slotTabListSelected( int ); |
231 | }; | 248 | }; |
232 | 249 | ||
233 | #endif | 250 | #endif |