summaryrefslogtreecommitdiff
authordrw <drw>2004-03-08 16:30:22 (UTC)
committer drw <drw>2004-03-08 16:30:22 (UTC)
commit15a9a86fbec54292a82663e1b01c93450f3fbbf8 (patch) (unidiff)
treee12b30aaa2e0c209e16c17ad85789a035a36c9cf
parent6248d9ec10561273cf8a864f1fe6c20b366d2639 (diff)
downloadopie-15a9a86fbec54292a82663e1b01c93450f3fbbf8.zip
opie-15a9a86fbec54292a82663e1b01c93450f3fbbf8.tar.gz
opie-15a9a86fbec54292a82663e1b01c93450f3fbbf8.tar.bz2
Removed unneeded comment
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opieui/otabwidget.h3
1 files changed, 1 insertions, 2 deletions
diff --git a/libopie2/opieui/otabwidget.h b/libopie2/opieui/otabwidget.h
index c7d32c2..092f22c 100644
--- a/libopie2/opieui/otabwidget.h
+++ b/libopie2/opieui/otabwidget.h
@@ -7,191 +7,190 @@
7 _;:,     .>    :=|. This program is free software; you can 7 _;:,     .>    :=|. This program is free software; you can
8.> <`_,   >  .   <= redistribute it and/or modify it under 8.> <`_,   >  .   <= redistribute it and/or modify it under
9:`=1 )Y*s>-.--   : the terms of the GNU Library General Public 9:`=1 )Y*s>-.--   : the terms of the GNU Library General Public
10.="- .-=="i,     .._ License as published by the Free Software 10.="- .-=="i,     .._ License as published by the Free Software
11 - .   .-<_>     .<> Foundation; either version 2 of the License, 11 - .   .-<_>     .<> Foundation; either version 2 of the License,
12     ._= =}       : or (at your option) any later version. 12     ._= =}       : or (at your option) any later version.
13    .%`+i>       _;_. 13    .%`+i>       _;_.
14    .i_,=:_.      -<s. This program is distributed in the hope that 14    .i_,=:_.      -<s. This program is distributed in the hope that
15     +  .  -:.       = it will be useful, but WITHOUT ANY WARRANTY; 15     +  .  -:.       = it will be useful, but WITHOUT ANY WARRANTY;
16    : ..    .:,     . . . without even the implied warranty of 16    : ..    .:,     . . . without even the implied warranty of
17    =_        +     =;=|` MERCHANTABILITY or FITNESS FOR A 17    =_        +     =;=|` MERCHANTABILITY or FITNESS FOR A
18  _.=:.       :    :=>`: PARTICULAR PURPOSE. See the GNU 18  _.=:.       :    :=>`: PARTICULAR PURPOSE. See the GNU
19..}^=.=       =       ; Library General Public License for more 19..}^=.=       =       ; Library General Public License for more
20++=   -.     .`     .: details. 20++=   -.     .`     .: details.
21 :     =  ...= . :.=- 21 :     =  ...= . :.=-
22 -.   .:....=;==+<; You should have received a copy of the GNU 22 -.   .:....=;==+<; You should have received a copy of the GNU
23  -_. . .   )=.  = Library General Public License along with 23  -_. . .   )=.  = Library General Public License along with
24    --        :-=` this library; see the file COPYING.LIB. 24    --        :-=` this library; see the file COPYING.LIB.
25 If not, write to the Free Software Foundation, 25 If not, write to the Free Software Foundation,
26 Inc., 59 Temple Place - Suite 330, 26 Inc., 59 Temple Place - Suite 330,
27 Boston, MA 02111-1307, USA. 27 Boston, MA 02111-1307, USA.
28 28
29*/ 29*/
30 30
31#ifndef OTABWIDGET_H 31#ifndef OTABWIDGET_H
32#define OTABWIDGET_H 32#define OTABWIDGET_H
33 33
34/* OPIE */ 34/* OPIE */
35#include <opie2/otabinfo.h> 35#include <opie2/otabinfo.h>
36 36
37/* QT */ 37/* QT */
38#include <qwidget.h> 38#include <qwidget.h>
39#include <qlist.h> 39#include <qlist.h>
40 40
41using namespace Opie; 41using namespace Opie;
42 42
43class QComboBox; 43class QComboBox;
44class QPixmap; 44class QPixmap;
45class QTabBar; 45class QTabBar;
46class QWidgetStack; 46class QWidgetStack;
47 47
48namespace Opie 48namespace Opie
49{ 49{
50 50
51class OTabBar; 51class OTabBar;
52 52
53/** 53/**
54 * @class OTabWidget 54 * @class OTabWidget
55 * @brief The OTabWidget class provides a stack of widgets. 55 * @brief The OTabWidget class provides a stack of widgets.
56 * 56 *
57 * OTabWidget is a derivation of TrollTech's QTabWidget which provides 57 * OTabWidget is a derivation of TrollTech's QTabWidget which provides
58 * 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
59 * drop down list box. 59 * drop down list box.
60 * 60 *
61 * 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
62 * constructor: 62 * constructor:
63 * - Create a OTabWidget. 63 * - Create a OTabWidget.
64 * - 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
65 * 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()
66 * to add the widget. 66 * to add the widget.
67 */ 67 */
68class OTabWidget : public QWidget 68class OTabWidget : public QWidget
69{ 69{
70 Q_OBJECT 70 Q_OBJECT
71 71
72 public: 72 public:
73/** 73/**
74 * @enum TabStyle 74 * @enum TabStyle
75 * @brief Defines how the widget selection control is displayed. 75 * @brief Defines how the widget selection control is displayed.
76 * 76 *
77 * Valid values: 77 * Valid values:
78 * - Global: use globally selected options (qpe.conf - TabStyle & TabPosition) 78 * - Global: use globally selected options (qpe.conf - TabStyle & TabPosition)
79 * - TextTab: Tabbed widget selection with text labels 79 * - TextTab: Tabbed widget selection with text labels
80 * - 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
81 * (similar to Opie launcher) 81 * (similar to Opie launcher)
82 * - TextList: Drop down list widget selection with text labels 82 * - TextList: Drop down list widget selection with text labels
83 * - IconList: Drop down list widget selection with icon & text labels 83 * - IconList: Drop down list widget selection with icon & text labels
84 */ 84 */
85 enum TabStyle { Global, TextTab, IconTab, TextList, IconList }; 85 enum TabStyle { Global, TextTab, IconTab, TextList, IconList };
86 86
87/** 87/**
88 * @enum TabPosition 88 * @enum TabPosition
89 * @brief Defines where the widget selection control is drawn. 89 * @brief Defines where the widget selection control is drawn.
90 * 90 *
91 * Valid values: 91 * Valid values:
92 * - Top: Widget selection control is drawn above widgets 92 * - Top: Widget selection control is drawn above widgets
93 * - Bottom: Widget selection control is drawn below widgets 93 * - Bottom: Widget selection control is drawn below widgets
94 */ 94 */
95 enum TabPosition { Top, Bottom }; 95 enum TabPosition { Top, Bottom };
96 96
97/** 97/**
98 * @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 )
99 * @brief Object constructor. 99 * @brief Object constructor.
100 * 100 *
101 * @param parent Pointer to parent of this control. 101 * @param parent Pointer to parent of this control.
102 * @param name Name of control. 102 * @param name Name of control.
103 * @param s Style of widget selection control. 103 * @param s Style of widget selection control.
104 * @param p Position of the widget selection control. 104 * @param p Position of the widget selection control.
105 * 105 *
106 * 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
107 * determine how the widget selection control will be displayed. 107 * determine how the widget selection control will be displayed.
108 */ 108 */
109 OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top ); 109 OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top );
110 110
111/** 111/**
112 * @fn ~OTabWidget() 112 * @fn ~OTabWidget()
113 * @brief Object destructor. 113 * @brief Object destructor.
114 */ 114 */
115 ~OTabWidget(); 115 ~OTabWidget();
116 116
117/** 117/**
118 * @fn addTab( QWidget *child, const QString &icon, const QString &label ) 118 * @fn addTab( QWidget *child, const QString &icon, const QString &label )
119 * @brief Add new widget to control. 119 * @brief Add new widget to control.
120 * 120 *
121 * @param child Widget control. 121 * @param child Widget control.
122 * @param icon Path to icon. 122 * @param icon Path to icon.
123 * @param label Text label. 123 * @param label Text label.
124 */ 124 */
125 void addTab( QWidget *, const QString &, const QString & ); 125 void addTab( QWidget *, const QString &, const QString & );
126 126
127/** 127/**
128 * @fn removePage( QWidget *widget ) 128 * @fn removePage( QWidget *widget )
129 * @brief Remove widget from control. Does not delete widget. 129 * @brief Remove widget from control. Does not delete widget.
130 * 130 *
131 * @param widget Widget control to be removed. 131 * @param widget Widget control to be removed.
132 */ 132 */
133 /* ### Page vs. Tab.. yes the widget is a Page but then is addTab wrong -zecke */
134 void removePage( QWidget * ); 133 void removePage( QWidget * );
135 134
136/** 135/**
137 * @fn changeTab( QWidget *widget, const QString &icon, const QString &label ) 136 * @fn changeTab( QWidget *widget, const QString &icon, const QString &label )
138 * @brief Change text and/or icon for existing tab 137 * @brief Change text and/or icon for existing tab
139 * 138 *
140 * @param child Widget control. 139 * @param child Widget control.
141 * @param icon Path to icon. 140 * @param icon Path to icon.
142 * @param label Text label. 141 * @param label Text label.
143 */ 142 */
144 void changeTab( QWidget *, const QString &, const QString & ); 143 void changeTab( QWidget *, const QString &, const QString & );
145 144
146/** 145/**
147 * @fn tabStyle()const 146 * @fn tabStyle()const
148 * @brief Returns current widget selection control style. 147 * @brief Returns current widget selection control style.
149 */ 148 */
150 TabStyle tabStyle() const; 149 TabStyle tabStyle() const;
151 150
152/** 151/**
153 * @fn setTabStyle( TabStyle s ) 152 * @fn setTabStyle( TabStyle s )
154 * @brief Set the current widget selection control style. 153 * @brief Set the current widget selection control style.
155 * 154 *
156 * @param s New style to be used. 155 * @param s New style to be used.
157 */ 156 */
158 void setTabStyle( TabStyle ); 157 void setTabStyle( TabStyle );
159 158
160/** 159/**
161 * @fn tabPosition()const 160 * @fn tabPosition()const
162 * @brief Returns current widget selection control position. 161 * @brief Returns current widget selection control position.
163 */ 162 */
164 TabPosition tabPosition() const; 163 TabPosition tabPosition() const;
165 164
166/** 165/**
167 * @fn setTabPosition( TabPosition p ) 166 * @fn setTabPosition( TabPosition p )
168 * @brief Set the current widget selection control position. 167 * @brief Set the current widget selection control position.
169 * 168 *
170 * @param p New position of widget selection control. 169 * @param p New position of widget selection control.
171 */ 170 */
172 void setTabPosition( TabPosition ); 171 void setTabPosition( TabPosition );
173 172
174/** 173/**
175 * @fn setCurrentTab( QWidget *childwidget ) 174 * @fn setCurrentTab( QWidget *childwidget )
176 * @brief Selects and brings to top the desired widget by using widget pointer. 175 * @brief Selects and brings to top the desired widget by using widget pointer.
177 * 176 *
178 * @param childwidget Widget to select. 177 * @param childwidget Widget to select.
179 */ 178 */
180 void setCurrentTab( QWidget * ); 179 void setCurrentTab( QWidget * );
181 180
182/** 181/**
183 * @fn setCurrentTab( const QString &tabname ) 182 * @fn setCurrentTab( const QString &tabname )
184 * @brief Selects and brings to top the desired widget, by using label. 183 * @brief Selects and brings to top the desired widget, by using label.
185 * 184 *
186 * @param tabname Text label for widget to select. 185 * @param tabname Text label for widget to select.
187 */ 186 */
188 void setCurrentTab( const QString & ); 187 void setCurrentTab( const QString & );
189 188
190/** 189/**
191 * @fn setCurrentTab( int ) 190 * @fn setCurrentTab( int )
192 * @brief Selects and brings to top the desired widget, by using id. 191 * @brief Selects and brings to top the desired widget, by using id.
193 * 192 *
194 * @param tab id for widget to select. 193 * @param tab id for widget to select.
195 */ 194 */
196 void setCurrentTab(int); 195 void setCurrentTab(int);
197 196