summaryrefslogtreecommitdiff
path: root/libopie
authorzecke <zecke>2003-05-07 14:45:49 (UTC)
committer zecke <zecke>2003-05-07 14:45:49 (UTC)
commit9602e59e3baf01465f4b4139715f2196bb01e012 (patch) (unidiff)
tree2d7f0dbf91e88de3981fcc82d49ba8ddc05cfbd5 /libopie
parentda949558a957ec4817bf610d7c9186585c0d2d92 (diff)
downloadopie-9602e59e3baf01465f4b4139715f2196bb01e012.zip
opie-9602e59e3baf01465f4b4139715f2196bb01e012.tar.gz
opie-9602e59e3baf01465f4b4139715f2196bb01e012.tar.bz2
Add d ptr
add comments and FIXMEs three new signals for otodoaccess
Diffstat (limited to 'libopie') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie/colordialog.h1
-rw-r--r--libopie/colorpopupmenu.h1
-rw-r--r--libopie/oclickablelabel.h6
-rw-r--r--libopie/ocolorbutton.h1
-rw-r--r--libopie/odevicebutton.h4
-rw-r--r--libopie/oprocess.h6
-rw-r--r--libopie/orecurrancewidget.h3
-rw-r--r--libopie/otabbar.h4
-rw-r--r--libopie/otabinfo.h2
-rw-r--r--libopie/otabwidget.h2
-rw-r--r--libopie/oticker.h1
-rw-r--r--libopie/otimepicker.h2
-rw-r--r--libopie/owait.h3
-rw-r--r--libopie/pim/otodoaccess.h5
-rw-r--r--libopie/xmltree.h2
15 files changed, 35 insertions, 8 deletions
diff --git a/libopie/colordialog.h b/libopie/colordialog.h
index 1a6a3fd..c825a83 100644
--- a/libopie/colordialog.h
+++ b/libopie/colordialog.h
@@ -1,89 +1,90 @@
1/**************************************************************************** 1/****************************************************************************
2** $Id$ 2** $Id$
3** 3**
4** Definition of OColorDialog class 4** Definition of OColorDialog class
5** 5**
6** Created : 990222 6** Created : 990222
7** 7**
8** Copyright (C) 1992-2000 Trolltech AS. All rights reserved. 8** Copyright (C) 1992-2000 Trolltech AS. All rights reserved.
9** 9**
10** This file is part of the dialogs module of the Qt GUI Toolkit. 10** This file is part of the dialogs module of the Qt GUI Toolkit.
11** 11**
12** This file may be distributed under the terms of the Q Public License 12** This file may be distributed under the terms of the Q Public License
13** as defined by Trolltech AS of Norway and appearing in the file 13** as defined by Trolltech AS of Norway and appearing in the file
14** LICENSE.QPL included in the packaging of this file. 14** LICENSE.QPL included in the packaging of this file.
15** 15**
16** This file may be distributed and/or modified under the terms of the 16** This file may be distributed and/or modified under the terms of the
17** GNU General Public License version 2 as published by the Free Software 17** GNU General Public License version 2 as published by the Free Software
18** Foundation and appearing in the file LICENSE.GPL included in the 18** Foundation and appearing in the file LICENSE.GPL included in the
19** packaging of this file. 19** packaging of this file.
20** 20**
21** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition 21** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
22** licenses may use this file in accordance with the Qt Commercial License 22** licenses may use this file in accordance with the Qt Commercial License
23** Agreement provided with the Software. 23** Agreement provided with the Software.
24** 24**
25** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE 25** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
26** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. 26** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
27** 27**
28** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for 28** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
29** information about Qt Commercial License Agreements. 29** information about Qt Commercial License Agreements.
30** See http://www.trolltech.com/qpl/ for QPL licensing information. 30** See http://www.trolltech.com/qpl/ for QPL licensing information.
31** See http://www.trolltech.com/gpl/ for GPL licensing information. 31** See http://www.trolltech.com/gpl/ for GPL licensing information.
32** 32**
33** Contact info@trolltech.com if any conditions of this licensing are 33** Contact info@trolltech.com if any conditions of this licensing are
34** not clear to you. 34** not clear to you.
35** 35**
36**********************************************************************/ 36**********************************************************************/
37 37
38#ifndef OColorDialog_H 38#ifndef OColorDialog_H
39#define OColorDialog_H 39#define OColorDialog_H
40 40
41#ifndef QT_H 41#ifndef QT_H
42#include <qdialog.h> 42#include <qdialog.h>
43#endif // QT_H 43#endif // QT_H
44 44
45class OColorDialogPrivate; 45class OColorDialogPrivate;
46 46
47/* 47/*
48 * @class OColorDialog 48 * @class OColorDialog
49 * @brief The OColorDialog class is a copy of QColorDialog for use in Opie. 49 * @brief The OColorDialog class is a copy of QColorDialog for use in Opie.
50 * 50 *
51 * OColorDialog is a copy of TrollTech's QColorDialog for use in Opie. The default 51 * OColorDialog is a copy of TrollTech's QColorDialog for use in Opie. The default
52 * build of QT/Embedded used by Opie does not include QColorDialog, so it is provided 52 * build of QT/Embedded used by Opie does not include QColorDialog, so it is provided
53 * here. It is renamed to prevent conflicts in the event the QColorDialog is included 53 * here. It is renamed to prevent conflicts in the event the QColorDialog is included
54 * at a later date in QP/E. 54 * at a later date in QP/E.
55 * 55 *
56 * See http://doc.trolltech.com/2.3/qcolordialog.html for complete documentation of 56 * See http://doc.trolltech.com/2.3/qcolordialog.html for complete documentation of
57 * QColorDialog. 57 * QColorDialog.
58 */ 58 */
59class Q_EXPORT OColorDialog : public QDialog 59class Q_EXPORT OColorDialog : public QDialog
60{ 60{
61 Q_OBJECT 61 Q_OBJECT
62 62
63public: 63public:
64 static QColor getColor( const QColor&, QWidget *parent=0, const char* name=0 ); 64 static QColor getColor( const QColor&, QWidget *parent=0, const char* name=0 );
65 static QRgb getRgba( const QRgb&, bool* ok = 0, 65 static QRgb getRgba( const QRgb&, bool* ok = 0,
66 QWidget *parent=0, const char* name=0 ); 66 QWidget *parent=0, const char* name=0 );
67 67
68private: 68private:
69 ~OColorDialog(); 69 ~OColorDialog();
70 70
71 // FIXME add WFlags? -zecke
71 OColorDialog( QWidget* parent=0, const char* name=0, bool modal=FALSE ); 72 OColorDialog( QWidget* parent=0, const char* name=0, bool modal=FALSE );
72 void setColor( const QColor& ); 73 void setColor( const QColor& );
73 QColor color() const; 74 QColor color() const;
74 75
75private: 76private:
76 void setSelectedAlpha( int ); 77 void setSelectedAlpha( int );
77 int selectedAlpha() const; 78 int selectedAlpha() const;
78private: 79private:
79 OColorDialogPrivate *d; 80 OColorDialogPrivate *d;
80 friend class OColorDialogPrivate; 81 friend class OColorDialogPrivate;
81 82
82 private:// Disabled copy constructor and operator= 83 private:// Disabled copy constructor and operator=
83#if defined(Q_DISABLE_COPY) 84#if defined(Q_DISABLE_COPY)
84 OColorDialog( const OColorDialog & ); 85 OColorDialog( const OColorDialog & );
85 OColorDialog& operator=( const OColorDialog & ); 86 OColorDialog& operator=( const OColorDialog & );
86#endif 87#endif
87}; 88};
88 89
89#endif 90#endif
diff --git a/libopie/colorpopupmenu.h b/libopie/colorpopupmenu.h
index 3e90c5e..98d67cc 100644
--- a/libopie/colorpopupmenu.h
+++ b/libopie/colorpopupmenu.h
@@ -1,254 +1,255 @@
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 S. Prud'homme <prudhomme@laposte.net> 4              Copyright (c) 2002 S. Prud'homme <prudhomme@laposte.net>
5              Dan Williams <williamsdr@acm.org> 5              Dan Williams <williamsdr@acm.org>
6 =. 6 =.
7 .=l. 7 .=l.
8           .>+-= 8           .>+-=
9 _;:,     .>    :=|. This program is free software; you can 9 _;:,     .>    :=|. This program is free software; you can
10.> <`_,   >  .   <= redistribute it and/or modify it under 10.> <`_,   >  .   <= redistribute it and/or modify it under
11:`=1 )Y*s>-.--   : the terms of the GNU Library General Public 11:`=1 )Y*s>-.--   : the terms of the GNU Library General Public
12.="- .-=="i,     .._ License as published by the Free Software 12.="- .-=="i,     .._ License as published by the Free Software
13 - .   .-<_>     .<> Foundation; either version 2 of the License, 13 - .   .-<_>     .<> Foundation; either version 2 of the License,
14     ._= =}       : or (at your option) any later version. 14     ._= =}       : or (at your option) any later version.
15    .%`+i>       _;_. 15    .%`+i>       _;_.
16    .i_,=:_.      -<s. This program is distributed in the hope that 16    .i_,=:_.      -<s. This program is distributed in the hope that
17     +  .  -:.       = it will be useful, but WITHOUT ANY WARRANTY; 17     +  .  -:.       = it will be useful, but WITHOUT ANY WARRANTY;
18    : ..    .:,     . . . without even the implied warranty of 18    : ..    .:,     . . . without even the implied warranty of
19    =_        +     =;=|` MERCHANTABILITY or FITNESS FOR A 19    =_        +     =;=|` MERCHANTABILITY or FITNESS FOR A
20  _.=:.       :    :=>`: PARTICULAR PURPOSE. See the GNU 20  _.=:.       :    :=>`: PARTICULAR PURPOSE. See the GNU
21..}^=.=       =       ; Library General Public License for more 21..}^=.=       =       ; Library General Public License for more
22++=   -.     .`     .: details. 22++=   -.     .`     .: details.
23 :     =  ...= . :.=- 23 :     =  ...= . :.=-
24 -.   .:....=;==+<; You should have received a copy of the GNU 24 -.   .:....=;==+<; You should have received a copy of the GNU
25  -_. . .   )=.  = Library General Public License along with 25  -_. . .   )=.  = Library General Public License along with
26    --        :-=` this library; see the file COPYING.LIB. 26    --        :-=` this library; see the file COPYING.LIB.
27 If not, write to the Free Software Foundation, 27 If not, write to the Free Software Foundation,
28 Inc., 59 Temple Place - Suite 330, 28 Inc., 59 Temple Place - Suite 330,
29 Boston, MA 02111-1307, USA. 29 Boston, MA 02111-1307, USA.
30 30
31*/ 31*/
32 32
33#ifndef COLORPOPUPMENU_H 33#ifndef COLORPOPUPMENU_H
34#define COLORPOPUPMENU_H 34#define COLORPOPUPMENU_H
35 35
36#include <qframe.h> 36#include <qframe.h>
37#include <qpopupmenu.h> 37#include <qpopupmenu.h>
38 38
39class QWidget; 39class QWidget;
40class QGridLayout; 40class QGridLayout;
41 41
42/** 42/**
43 * @class OColorPanelButton 43 * @class OColorPanelButton
44 * @brief The OColorPanelButton class provides a button for color selection. 44 * @brief The OColorPanelButton class provides a button for color selection.
45 * 45 *
46 * @see OColorPopupMenu 46 * @see OColorPopupMenu
47 * 47 *
48 * The OColorPanelButton class provides a button for color selection. The button 48 * The OColorPanelButton class provides a button for color selection. The button
49 * is drawn with the desired color and no border. This class is used internally 49 * is drawn with the desired color and no border. This class is used internally
50 * by the OColorPopupMenu class to displaying colors in its menu. 50 * by the OColorPopupMenu class to displaying colors in its menu.
51 */ 51 */
52class OColorPanelButton : public QFrame 52class OColorPanelButton : public QFrame
53{ 53{
54 Q_OBJECT 54 Q_OBJECT
55 55
56public: 56public:
57 57
58/** 58/**
59 * @fn OColorPanelButton( const QColor& color, QWidget* parent = 0, const char* name = 0 ) 59 * @fn OColorPanelButton( const QColor& color, QWidget* parent = 0, const char* name = 0 )
60 * @brief Object constructor. 60 * @brief Object constructor.
61 * 61 *
62 * @param color Desired color. 62 * @param color Desired color.
63 * @param parent Pointer to parent of this control. 63 * @param parent Pointer to parent of this control.
64 * @param name Name of control. 64 * @param name Name of control.
65 * 65 *
66 * Constructs a new ColorPanelButton control with parent, name and desired color. 66 * Constructs a new ColorPanelButton control with parent, name and desired color.
67 */ 67 */
68 OColorPanelButton(const QColor& color, QWidget* parent = 0, const char* name = 0); 68 OColorPanelButton(const QColor& color, QWidget* parent = 0, const char* name = 0);
69 69
70/** 70/**
71 * @fn ~OColorPanelButton() 71 * @fn ~OColorPanelButton()
72 * @brief Object destructor. 72 * @brief Object destructor.
73 */ 73 */
74 ~OColorPanelButton(); 74 ~OColorPanelButton();
75 75
76/** 76/**
77 * @fn setActive( bool active ) 77 * @fn setActive( bool active )
78 * @brief Sets button selection state. 78 * @brief Sets button selection state.
79 * 79 *
80 * @param active Boolean indicator of new button state. 80 * @param active Boolean indicator of new button state.
81 * 81 *
82 * Changes button selection state. If button is selected, a highlighted border 82 * Changes button selection state. If button is selected, a highlighted border
83 * is drawn. 83 * is drawn.
84 */ 84 */
85 void setActive(bool active); 85 void setActive(bool active);
86 86
87/** 87/**
88 * @fn enterEvent( QEvent* e ) 88 * @fn enterEvent( QEvent* e )
89 * @brief Reimplemented for internal reasons. 89 * @brief Reimplemented for internal reasons.
90 * 90 *
91 * @param e Event currently being processed. 91 * @param e Event currently being processed.
92 * 92 *
93 * Reimplemented to ensure correct display of button based on whether it is 93 * Reimplemented to ensure correct display of button based on whether it is
94 * active or not. 94 * active or not.
95 */ 95 */
96 void enterEvent(QEvent* e); 96 void enterEvent(QEvent* e);
97 97
98/** 98/**
99 * @fn leaveEvent( QEvent* e ) 99 * @fn leaveEvent( QEvent* e )
100 * @brief Reimplemented for internal reasons. 100 * @brief Reimplemented for internal reasons.
101 * 101 *
102 * @param e Event currently being processed. 102 * @param e Event currently being processed.
103 * 103 *
104 * Reimplemented to ensure correct display of button based on whether it is 104 * Reimplemented to ensure correct display of button based on whether it is
105 * active or not. 105 * active or not.
106 */ 106 */
107 void leaveEvent(QEvent* e); 107 void leaveEvent(QEvent* e);
108 108
109/** 109/**
110 * @fn paintEvent( QPaintEvent* e ) 110 * @fn paintEvent( QPaintEvent* e )
111 * @brief Reimplemented for internal reasons. 111 * @brief Reimplemented for internal reasons.
112 * 112 *
113 * @param e Event currently being processed. 113 * @param e Event currently being processed.
114 * @reimp 114 * @reimp
115 * Reimplemented to ensure correct display of button. 115 * Reimplemented to ensure correct display of button.
116 */ 116 */
117 void paintEvent(QPaintEvent* e); 117 void paintEvent(QPaintEvent* e);
118 118
119/** 119/**
120 * @fn mouseReleaseEvent( QMouseEvent* e ) 120 * @fn mouseReleaseEvent( QMouseEvent* e )
121 * @brief Slot executed when button is pressed. 121 * @brief Slot executed when button is pressed.
122 * 122 *
123 * @param e Mouse event currently being processed. 123 * @param e Mouse event currently being processed.
124 * 124 *
125 * @see selected() 125 * @see selected()
126 * 126 *
127 * This slot executes when the button has been pressed. It emits the selected 127 * This slot executes when the button has been pressed. It emits the selected
128 * signal as notification that it has been pressed. 128 * signal as notification that it has been pressed.
129 */ 129 */
130 void mouseReleaseEvent(QMouseEvent* e); 130 void mouseReleaseEvent(QMouseEvent* e);
131 131
132signals: 132signals:
133 133
134/** 134/**
135 * @fn selected( const QColor& color ) 135 * @fn selected( const QColor& color )
136 * @brief Signal to indicate button has been pressed. 136 * @brief Signal to indicate button has been pressed.
137 * 137 *
138 * @param color Button color. 138 * @param color Button color.
139 * 139 *
140 * This signal is emitted when the button is pressed. It provides the color 140 * This signal is emitted when the button is pressed. It provides the color
141 * associated to this button. 141 * associated to this button.
142 */ 142 */
143 void selected(const QColor&); 143 void selected(const QColor&);
144 144
145private: 145private:
146 QColor m_color; 146 QColor m_color;
147 bool m_active : 1; 147 bool m_active : 1;
148 class ColorPanelButtonPrivate; 148 class ColorPanelButtonPrivate;
149 ColorPanelButtonPrivate *d; 149 ColorPanelButtonPrivate *d;
150}; 150};
151 151
152/** 152/**
153 * @class OColorPopupMenu 153 * @class OColorPopupMenu
154 * @brief The OColorPopupMenu class provides a small color selection 154 * @brief The OColorPopupMenu class provides a small color selection
155 * popup menu. 155 * popup menu.
156 * 156 *
157 * OColorPopupMenu is a derivation of TrollTech's QPopupMenu and provides 157 * OColorPopupMenu is a derivation of TrollTech's QPopupMenu and provides
158 * a small color selection popup menu which can be attached to another control 158 * a small color selection popup menu which can be attached to another control
159 * such as a toolbar button of menu item. 159 * such as a toolbar button of menu item.
160 * 160 *
161 * The popup menu displays 30 default colors available in a grid, and also 161 * The popup menu displays 30 default colors available in a grid, and also
162 * includes an option at the bottom to display a color selection dialog box for 162 * includes an option at the bottom to display a color selection dialog box for
163 * finer color control. 163 * finer color control.
164 */ 164 */
165class OColorPopupMenu : public QPopupMenu 165class OColorPopupMenu : public QPopupMenu
166{ 166{
167 Q_OBJECT 167 Q_OBJECT
168 168
169public: 169public:
170 170
171/** 171/**
172 * @fn OColorPopupMenu( const QColor& color, QWidget* parent = 0, const char* name = 0 ) 172 * @fn OColorPopupMenu( const QColor& color, QWidget* parent = 0, const char* name = 0 )
173 * @brief Object constructor. 173 * @brief Object constructor.
174 * 174 *
175 * @param color Initial color selected in menu. 175 * @param color Initial color selected in menu.
176 * @param parent Pointer to parent of this control. 176 * @param parent Pointer to parent of this control.
177 * @param name Name of control. 177 * @param name Name of control.
178 * 178 *
179 * Constructs a new OColorPopupMenu control with parent, name and initial color selected. 179 * Constructs a new OColorPopupMenu control with parent, name and initial color selected.
180 */ 180 */
181 // FIXME add Wflags? -zecke
181 OColorPopupMenu( const QColor& color, QWidget* parent = 0, const char* name = 0 ); 182 OColorPopupMenu( const QColor& color, QWidget* parent = 0, const char* name = 0 );
182 183
183/** 184/**
184 * @fn ~OColorPopupMenu() 185 * @fn ~OColorPopupMenu()
185 * @brief Object destructor. 186 * @brief Object destructor.
186 */ 187 */
187 ~OColorPopupMenu(); 188 ~OColorPopupMenu();
188 189
189private: 190private:
190 class ColorPopupMenuPrivate; 191 class ColorPopupMenuPrivate;
191 ColorPopupMenuPrivate *d; 192 ColorPopupMenuPrivate *d;
192 QColor m_color; 193 QColor m_color;
193 QWidget* colorPanel; 194 QWidget* colorPanel;
194 QGridLayout* colorLayout; 195 QGridLayout* colorLayout;
195 196
196/** 197/**
197 * @fn addColor( const QColor& color, int row, int col ) 198 * @fn addColor( const QColor& color, int row, int col )
198 * @brief Adds color selection option to popup menu. 199 * @brief Adds color selection option to popup menu.
199 * 200 *
200 * @param color Color to be displayed in menu. 201 * @param color Color to be displayed in menu.
201 * @param row Row where color is to appear in menu. 202 * @param row Row where color is to appear in menu.
202 * @param col Column where color is to appear in menu. 203 * @param col Column where color is to appear in menu.
203 * 204 *
204 * Adds a color selection option to popup menu. Used internally when 205 * Adds a color selection option to popup menu. Used internally when
205 * initially constructing the menu control. 206 * initially constructing the menu control.
206 */ 207 */
207 void addColor( const QColor& color, int row, int col ); 208 void addColor( const QColor& color, int row, int col );
208 209
209signals: 210signals:
210 211
211/** 212/**
212 * @fn colorSelected( const QColor& color ) 213 * @fn colorSelected( const QColor& color )
213 * @brief Signal to indicate color chosen from the menu. 214 * @brief Signal to indicate color chosen from the menu.
214 * 215 *
215 * @param color Color selected from the menu. 216 * @param color Color selected from the menu.
216 * 217 *
217 * This signal is emitted when a color has been selected either directly from 218 * This signal is emitted when a color has been selected either directly from
218 * the menu, or chosen from the color selection dialog. 219 * the menu, or chosen from the color selection dialog.
219 */ 220 */
220 void colorSelected( const QColor& color ); 221 void colorSelected( const QColor& color );
221 222
222protected slots: 223protected slots:
223 224
224/** 225/**
225 * @fn buttonSelected( const QColor& color ) 226 * @fn buttonSelected( const QColor& color )
226 * @brief Slot to process selected color. 227 * @brief Slot to process selected color.
227 * 228 *
228 * @param color Color selected from the menu. 229 * @param color Color selected from the menu.
229 * 230 *
230 * @see colorSelected() 231 * @see colorSelected()
231 * 232 *
232 * This slot executes when a color has been selected from the menu. It performs 233 * This slot executes when a color has been selected from the menu. It performs
233 * two functions: 234 * two functions:
234 * - Emit the colorSelected signal with the color selected. 235 * - Emit the colorSelected signal with the color selected.
235 * - Hide the menu. 236 * - Hide the menu.
236 */ 237 */
237 void buttonSelected( const QColor& color ); 238 void buttonSelected( const QColor& color );
238 239
239/** 240/**
240 * @fn moreColorClicked() 241 * @fn moreColorClicked()
241 * @brief Slot to process display color selection dialog. 242 * @brief Slot to process display color selection dialog.
242 * 243 *
243 * @see colorSelected() 244 * @see colorSelected()
244 * 245 *
245 * This slot executes when the 'More...' option is selected at the bottom of the menu. 246 * This slot executes when the 'More...' option is selected at the bottom of the menu.
246 * It performs the following functions: 247 * It performs the following functions:
247 * - Constructs and executes a OColorDialog to allow finer color selection. 248 * - Constructs and executes a OColorDialog to allow finer color selection.
248 * - Emit the colorSelected signal with the color selected. 249 * - Emit the colorSelected signal with the color selected.
249 * - Hide the menu. 250 * - Hide the menu.
250 */ 251 */
251 void moreColorClicked(); 252 void moreColorClicked();
252}; 253};
253 254
254#endif // COLORPOPUPMENUANEL_H 255#endif // COLORPOPUPMENUANEL_H
diff --git a/libopie/oclickablelabel.h b/libopie/oclickablelabel.h
index 6e7a123..f93ade0 100644
--- a/libopie/oclickablelabel.h
+++ b/libopie/oclickablelabel.h
@@ -1,64 +1,68 @@
1#ifndef CLICKABLELABEL 1#ifndef CLICKABLELABEL
2#define CLICKABLELABEL 2#define CLICKABLELABEL
3 3
4#include <qlabel.h> 4#include <qlabel.h>
5 5
6/** 6/**
7 * This class is a special QLabel which can behave 7 * This class is a special QLabel which can behave
8 * as a QPushButton or QToggleButton. 8 * as a QPushButton or QToggleButton.
9 * The reason to use a clickable is if you want to save space 9 * The reason to use a clickable is if you want to save space
10 * or you want to skip the border of a normal button 10 * or you want to skip the border of a normal button
11 * 11 *
12 * <pre> 12 * <pre>
13 * QLabel* lbl = new OClickableLabel( parent, "PushLabel" ); 13 * QLabel* lbl = new OClickableLabel( parent, "PushLabel" );
14 * lbl->setPixmap( "config" ); 14 * lbl->setPixmap( "config" );
15 * QWhatsThis::add( lbl, tr("Click here to do something") ); 15 * QWhatsThis::add( lbl, tr("Click here to do something") );
16 * </pre> 16 * </pre>
17 * 17 *
18 * @short A Label behaving as button 18 * @short A Label behaving as button
19 * @author Hakan Ardo, Maximillian Reiß ( harlekin@handhelds.org ) 19 * @author Hakan Ardo, Maximillian Reiß ( harlekin@handhelds.org )
20 * @see QLabel 20 * @see QLabel
21 * @see QPushButton 21 * @see QPushButton
22 * @see QToggleButton 22 * @see QToggleButton
23 * @version 1.0 23 * @version 1.0
24 */ 24 */
25 25
26class OClickableLabel: public QLabel 26class OClickableLabel: public QLabel
27{ 27{
28 Q_OBJECT 28 Q_OBJECT
29public: 29public:
30 OClickableLabel(QWidget* parent = 0, const char* name = 0, 30 OClickableLabel(QWidget* parent = 0, const char* name = 0,
31 WFlags fl = 0); 31 WFlags fl = 0);
32 void setToggleButton(bool t); 32 void setToggleButton(bool t);
33 33
34 protected: 34 protected:
35 /** @internal */ 35 /** @internal */
36 void mousePressEvent( QMouseEvent *e ); 36 void mousePressEvent( QMouseEvent *e );
37 /** @internal */ 37 /** @internal */
38 void mouseReleaseEvent( QMouseEvent *e ); 38 void mouseReleaseEvent( QMouseEvent *e );
39 /** @internal */ 39 /** @internal */
40 void mouseMoveEvent( QMouseEvent *e ); 40 void mouseMoveEvent( QMouseEvent *e );
41 41
42 public slots: 42 public slots:
43 void setOn(bool on); 43 void setOn(bool on);
44 signals: 44 signals:
45 /** 45 /**
46 * emitted when the labels gets clicked 46 * emitted when the labels gets clicked
47 */ 47 */
48 void clicked(); 48 void clicked();
49 49
50 /** 50 /**
51 * emitted when the labels gets toggled 51 * emitted when the labels gets toggled
52 * @param the new new state of the label 52 * @param on the new new state of the label
53 */ 53 */
54 void toggled(bool on); 54 void toggled(bool on);
55 private: 55 private:
56 bool isToggle : 1; 56 bool isToggle : 1;
57 bool isDown : 1; 57 bool isDown : 1;
58 bool textInverted : 1; 58 bool textInverted : 1;
59 59
60 void showState(bool on); 60 void showState(bool on);
61 void setInverted(bool on); 61 void setInverted(bool on);
62
63 private:
64 class Private;
65 Private *d; // private d pointer
62}; 66};
63 67
64#endif 68#endif
diff --git a/libopie/ocolorbutton.h b/libopie/ocolorbutton.h
index 7ff9cd2..6196c83 100644
--- a/libopie/ocolorbutton.h
+++ b/libopie/ocolorbutton.h
@@ -1,72 +1,73 @@
1/* 1/*
2               =. This file is part of the OPIE Project 2               =. This file is part of the OPIE Project
3             .=l. Copyright (c) 2002 Robert Griebl <sandman@handhelds.org> 3             .=l. Copyright (c) 2002 Robert Griebl <sandman@handhelds.org>
4           .>+-= 4           .>+-=
5 _;:,     .>    :=|. This library is free software; you can 5 _;:,     .>    :=|. This library is free software; you can
6.> <`_,   >  .   <= redistribute it and/or modify it under 6.> <`_,   >  .   <= redistribute it and/or modify it under
7:`=1 )Y*s>-.--   : the terms of the GNU Library General Public 7:`=1 )Y*s>-.--   : the terms of the GNU Library General Public
8.="- .-=="i,     .._ License as published by the Free Software 8.="- .-=="i,     .._ License as published by the Free Software
9 - .   .-<_>     .<> Foundation; either version 2 of the License, 9 - .   .-<_>     .<> Foundation; either version 2 of the License,
10     ._= =}       : or (at your option) any later version. 10     ._= =}       : or (at your option) any later version.
11    .%`+i>       _;_. 11    .%`+i>       _;_.
12    .i_,=:_.      -<s. This library is distributed in the hope that 12    .i_,=:_.      -<s. This library is distributed in the hope that
13     +  .  -:.       = it will be useful, but WITHOUT ANY WARRANTY; 13     +  .  -:.       = it will be useful, but WITHOUT ANY WARRANTY;
14    : ..    .:,     . . . without even the implied warranty of 14    : ..    .:,     . . . without even the implied warranty of
15    =_        +     =;=|` MERCHANTABILITY or FITNESS FOR A 15    =_        +     =;=|` MERCHANTABILITY or FITNESS FOR A
16  _.=:.       :    :=>`: PARTICULAR PURPOSE. See the GNU 16  _.=:.       :    :=>`: PARTICULAR PURPOSE. See the GNU
17..}^=.=       =       ; Library General Public License for more 17..}^=.=       =       ; Library General Public License for more
18++=   -.     .`     .: details. 18++=   -.     .`     .: details.
19 :     =  ...= . :.=- 19 :     =  ...= . :.=-
20 -.   .:....=;==+<; You should have received a copy of the GNU 20 -.   .:....=;==+<; You should have received a copy of the GNU
21  -_. . .   )=.  = Library General Public License along with 21  -_. . .   )=.  = Library General Public License along with
22    --        :-=` this library; see the file COPYING.LIB. 22    --        :-=` this library; see the file COPYING.LIB.
23 If not, write to the Free Software Foundation, 23 If not, write to the Free Software Foundation,
24 Inc., 59 Temple Place - Suite 330, 24 Inc., 59 Temple Place - Suite 330,
25 Boston, MA 02111-1307, USA. 25 Boston, MA 02111-1307, USA.
26 26
27*/ 27*/
28 28
29#ifndef __OPIE_OCOLORBUTTON_H__ 29#ifndef __OPIE_OCOLORBUTTON_H__
30#define __OPIE_OCOLORBUTTON_H__ 30#define __OPIE_OCOLORBUTTON_H__
31 31
32#include <qpushbutton.h> 32#include <qpushbutton.h>
33 33
34class OColorButtonPrivate; 34class OColorButtonPrivate;
35class QColor; 35class QColor;
36 36
37/** 37/**
38 * 38 *
39 * @short A Button which will show a OColorPopupMenu 39 * @short A Button which will show a OColorPopupMenu
40 * @author Robert Griebl ( sandman@handhelds.org ) 40 * @author Robert Griebl ( sandman@handhelds.org )
41 * @version 1.0 41 * @version 1.0
42 * @see QPushButton 42 * @see QPushButton
43 */ 43 */
44class OColorButton : public QPushButton { 44class OColorButton : public QPushButton {
45 Q_OBJECT 45 Q_OBJECT
46public: 46public:
47 // FIXME Wflags? -zecke
47 OColorButton ( QWidget *parent = 0, const QColor & = black, const char *name = 0 ); 48 OColorButton ( QWidget *parent = 0, const QColor & = black, const char *name = 0 );
48 virtual ~OColorButton ( ); 49 virtual ~OColorButton ( );
49 50
50 QColor color ( ) const; 51 QColor color ( ) const;
51 52
52signals: 53signals:
53 /** 54 /**
54 * emitted when a color gets selected 55 * emitted when a color gets selected
55 */ 56 */
56 void colorSelected ( const QColor & ); 57 void colorSelected ( const QColor & );
57 58
58public slots: 59public slots:
59 virtual void setColor ( const QColor & ); 60 virtual void setColor ( const QColor & );
60 61
61protected slots: 62protected slots:
62 /** 63 /**
63 * @internal 64 * @internal
64 */ 65 */
65 virtual void updateColor ( const QColor & ); 66 virtual void updateColor ( const QColor & );
66 67
67private: 68private:
68 OColorButtonPrivate *d; 69 OColorButtonPrivate *d;
69}; 70};
70 71
71#endif 72#endif
72 73
diff --git a/libopie/odevicebutton.h b/libopie/odevicebutton.h
index cf91bbd..abe27d6 100644
--- a/libopie/odevicebutton.h
+++ b/libopie/odevicebutton.h
@@ -1,101 +1,105 @@
1/********************************************************************** 1/**********************************************************************
2** Copyright (C) 2000-2002 Trolltech AS. All rights reserved. 2** Copyright (C) 2000-2002 Trolltech AS. All rights reserved.
3** 3**
4** This file is part of the Qtopia Environment. 4** This file is part of the Qtopia Environment.
5** 5**
6** This file may be distributed and/or modified under the terms of the 6** This file may be distributed and/or modified under the terms of the
7** GNU General Public License version 2 as published by the Free Software 7** GNU General Public License version 2 as published by the Free Software
8** Foundation and appearing in the file LICENSE.GPL included in the 8** Foundation and appearing in the file LICENSE.GPL included in the
9** packaging of this file. 9** packaging of this file.
10** 10**
11** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE 11** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
12** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. 12** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
13** 13**
14** See http://www.trolltech.com/gpl/ for GPL licensing information. 14** See http://www.trolltech.com/gpl/ for GPL licensing information.
15** 15**
16** Contact info@trolltech.com if any conditions of this licensing are 16** Contact info@trolltech.com if any conditions of this licensing are
17** not clear to you. 17** not clear to you.
18** 18**
19**********************************************************************/ 19**********************************************************************/
20#ifndef DEVICE_BUTTON_H 20#ifndef DEVICE_BUTTON_H
21#define DEVICE_BUTTON_H 21#define DEVICE_BUTTON_H
22 22
23#include <qpixmap.h> 23#include <qpixmap.h>
24#include <qstring.h> 24#include <qstring.h>
25 25
26class OQCopMessageData; 26class OQCopMessageData;
27 27
28namespace Opie 28namespace Opie
29{ 29{
30 30
31class OQCopMessage { 31class OQCopMessage {
32public: 32public:
33 OQCopMessage ( ); 33 OQCopMessage ( );
34 OQCopMessage ( const OQCopMessage &copy ); 34 OQCopMessage ( const OQCopMessage &copy );
35 OQCopMessage ( const QCString &m_channel, const QCString &message, const QByteArray &args = QByteArray ( )); 35 OQCopMessage ( const QCString &m_channel, const QCString &message, const QByteArray &args = QByteArray ( ));
36 36
37 OQCopMessage &operator = ( const OQCopMessage &assign ); 37 OQCopMessage &operator = ( const OQCopMessage &assign );
38 38
39 void setChannel ( const QCString &channel ); 39 void setChannel ( const QCString &channel );
40 void setMessage ( const QCString &message ); 40 void setMessage ( const QCString &message );
41 void setData ( const QByteArray &ba ); 41 void setData ( const QByteArray &ba );
42 42
43 QCString channel ( ) const; 43 QCString channel ( ) const;
44 QCString message ( ) const; 44 QCString message ( ) const;
45 QByteArray data ( ) const; 45 QByteArray data ( ) const;
46 46
47 bool send ( ); 47 bool send ( );
48 48
49private: 49private:
50 void init ( const QCString &m_channel, const QCString &message, const QByteArray &args ); 50 void init ( const QCString &m_channel, const QCString &message, const QByteArray &args );
51 51
52 OQCopMessageData *d; 52 OQCopMessageData *d;
53 class Private;
54 Private* data;
53}; 55};
54 56
55 57
56/** 58/**
57 * This class represents a physical button on a Qtopia device. A device may 59 * This class represents a physical button on a Qtopia device. A device may
58 * have n "user programmable" buttons, which are number 1..n. The location 60 * have n "user programmable" buttons, which are number 1..n. The location
59 * and number of buttons will vary from device to device. userText() and pixmap() 61 * and number of buttons will vary from device to device. userText() and pixmap()
60 * may be used to describe this button to the user in help documentation. 62 * may be used to describe this button to the user in help documentation.
61 * 63 *
62 * @version 1.0 64 * @version 1.0
63 * @author Trolltech 65 * @author Trolltech
64 * @short A representation of buttons 66 * @short A representation of buttons
65 */ 67 */
66 68
67class ODeviceButton 69class ODeviceButton
68{ 70{
69public: 71public:
70 ODeviceButton(); 72 ODeviceButton();
71 virtual ~ODeviceButton(); 73 virtual ~ODeviceButton();
72 74
73 ushort keycode ( ) const; 75 ushort keycode ( ) const;
74 QString userText ( ) const; 76 QString userText ( ) const;
75 QPixmap pixmap ( ) const; 77 QPixmap pixmap ( ) const;
76 OQCopMessage factoryPresetPressedAction ( ) const; 78 OQCopMessage factoryPresetPressedAction ( ) const;
77 OQCopMessage pressedAction ( ) const; 79 OQCopMessage pressedAction ( ) const;
78 OQCopMessage factoryPresetHeldAction ( ) const; 80 OQCopMessage factoryPresetHeldAction ( ) const;
79 OQCopMessage heldAction ( ) const; 81 OQCopMessage heldAction ( ) const;
80 82
81 void setKeycode ( ushort keycode ); 83 void setKeycode ( ushort keycode );
82 void setUserText ( const QString& text ); 84 void setUserText ( const QString& text );
83 void setPixmap ( const QPixmap& picture ); 85 void setPixmap ( const QPixmap& picture );
84 void setFactoryPresetPressedAction ( const OQCopMessage& qcopMessage ); 86 void setFactoryPresetPressedAction ( const OQCopMessage& qcopMessage );
85 void setPressedAction ( const OQCopMessage& qcopMessage ); 87 void setPressedAction ( const OQCopMessage& qcopMessage );
86 void setFactoryPresetHeldAction ( const OQCopMessage& qcopMessage ); 88 void setFactoryPresetHeldAction ( const OQCopMessage& qcopMessage );
87 void setHeldAction ( const OQCopMessage& qcopMessage ); 89 void setHeldAction ( const OQCopMessage& qcopMessage );
88 90
89private: 91private:
90 ushort m_Keycode; 92 ushort m_Keycode;
91 QString m_UserText; 93 QString m_UserText;
92 QPixmap m_Pixmap; 94 QPixmap m_Pixmap;
93 OQCopMessage m_FactoryPresetPressedAction; 95 OQCopMessage m_FactoryPresetPressedAction;
94 OQCopMessage m_PressedAction; 96 OQCopMessage m_PressedAction;
95 OQCopMessage m_FactoryPresetHeldAction; 97 OQCopMessage m_FactoryPresetHeldAction;
96 OQCopMessage m_HeldAction; 98 OQCopMessage m_HeldAction;
99 class Private;
100 Private *d;
97}; 101};
98 102
99} 103}
100 104
101#endif 105#endif
diff --git a/libopie/oprocess.h b/libopie/oprocess.h
index f2853b0..af7cddb 100644
--- a/libopie/oprocess.h
+++ b/libopie/oprocess.h
@@ -1,753 +1,747 @@
1/* This file is part of the KDE libraries 1/* This file is part of the KDE libraries
2 Copyright (C) 1997 Christian Czezakte (e9025461@student.tuwien.ac.at) 2 Copyright (C) 1997 Christian Czezakte (e9025461@student.tuwien.ac.at)
3 3
4 This library is free software; you can redistribute it and/or 4 This library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public 5 modify it under the terms of the GNU Library General Public
6 License as published by the Free Software Foundation; either 6 License as published by the Free Software Foundation; either
7 version 2 of the License, or (at your option) any later version. 7 version 2 of the License, or (at your option) any later version.
8 8
9 This library is distributed in the hope that it will be useful, 9 This library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of 10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Library General Public License for more details. 12 Library General Public License for more details.
13 13
14 You should have received a copy of the GNU Library General Public License 14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to 15 along with this library; see the file COPYING.LIB. If not, write to
16 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 16 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 Boston, MA 02111-1307, USA. 17 Boston, MA 02111-1307, USA.
18*/ 18*/
19// 19//
20// KPROCESS -- A class for handling child processes in KDE without 20// KPROCESS -- A class for handling child processes in KDE without
21// having to take care of Un*x specific implementation details 21// having to take care of Un*x specific implementation details
22// 22//
23// version 0.3.1, Jan 8th 1998 23// version 0.3.1, Jan 8th 1998
24// 24//
25// (C) Christian Czezatke 25// (C) Christian Czezatke
26// e9025461@student.tuwien.ac.at 26// e9025461@student.tuwien.ac.at
27// Ported by Holger Freyther to the Open Palmtop Integrated Environment 27// Ported by Holger Freyther to the Open Palmtop Integrated Environment
28// 28//
29 29
30#ifndef __kprocess_h__ 30#ifndef __kprocess_h__
31#define __kprocess_h__ 31#define __kprocess_h__
32 32
33#include <sys/types.h> // for pid_t 33#include <sys/types.h> // for pid_t
34#include <sys/wait.h> 34#include <sys/wait.h>
35#include <signal.h> 35#include <signal.h>
36#include <unistd.h> 36#include <unistd.h>
37#include <qvaluelist.h> 37#include <qvaluelist.h>
38#include <qcstring.h> 38#include <qcstring.h>
39#include <qobject.h> 39#include <qobject.h>
40 40
41class QSocketNotifier; 41class QSocketNotifier;
42class OProcessPrivate; 42class OProcessPrivate;
43 43
44/** 44/**
45 * Child process invocation, monitoring and control. 45 * Child process invocation, monitoring and control.
46 * 46 *
47 * @sect General usage and features 47 * @sect General usage and features
48 * 48 *
49 *This class allows a KDE and OPIE application to start child processes without having 49 *This class allows a KDE and OPIE application to start child processes without having
50 *to worry about UN*X signal handling issues and zombie process reaping. 50 *to worry about UN*X signal handling issues and zombie process reaping.
51 * 51 *
52 *@see KProcIO 52 *@see KProcIO
53 * 53 *
54 *Basically, this class distinguishes three different ways of running 54 *Basically, this class distinguishes three different ways of running
55 *child processes: 55 *child processes:
56 * 56 *
57 *@li OProcess::DontCare -- The child process is invoked and both the child 57 *@li OProcess::DontCare -- The child process is invoked and both the child
58 *process and the parent process continue concurrently. 58 *process and the parent process continue concurrently.
59 * 59 *
60 *Starting a DontCare child process means that the application is 60 *Starting a DontCare child process means that the application is
61 *not interested in any notification to determine whether the 61 *not interested in any notification to determine whether the
62 *child process has already exited or not. 62 *child process has already exited or not.
63 * 63 *
64 *@li OProcess::NotifyOnExit -- The child process is invoked and both the 64 *@li OProcess::NotifyOnExit -- The child process is invoked and both the
65 *child and the parent process run concurrently. 65 *child and the parent process run concurrently.
66 * 66 *
67 *When the child process exits, the OProcess instance 67 *When the child process exits, the OProcess instance
68 *corresponding to it emits the Qt signal @ref processExited(). 68 *corresponding to it emits the Qt signal @ref processExited().
69 * 69 *
70 *Since this signal is @em not emitted from within a UN*X 70 *Since this signal is @em not emitted from within a UN*X
71 *signal handler, arbitrary function calls can be made. 71 *signal handler, arbitrary function calls can be made.
72 * 72 *
73 *Be aware: When the OProcess objects gets destructed, the child 73 *Be aware: When the OProcess objects gets destructed, the child
74 *process will be killed if it is still running! 74 *process will be killed if it is still running!
75 *This means in particular, that you cannot use a OProcess on the stack 75 *This means in particular, that you cannot use a OProcess on the stack
76 *with OProcess::NotifyOnExit. 76 *with OProcess::NotifyOnExit.
77 * 77 *
78 *@li OProcess::Block -- The child process starts and the parent process 78 *@li OProcess::Block -- The child process starts and the parent process
79 *is suspended until the child process exits. (@em Really not recommended 79 *is suspended until the child process exits. (@em Really not recommended
80 *for programs with a GUI.) 80 *for programs with a GUI.)
81 * 81 *
82 *OProcess also provides several functions for determining the exit status 82 *OProcess also provides several functions for determining the exit status
83 *and the pid of the child process it represents. 83 *and the pid of the child process it represents.
84 * 84 *
85 *Furthermore it is possible to supply command-line arguments to the process 85 *Furthermore it is possible to supply command-line arguments to the process
86 *in a clean fashion (no null -- terminated stringlists and such...) 86 *in a clean fashion (no null -- terminated stringlists and such...)
87 * 87 *
88 *A small usage example: 88 *A small usage example:
89 *<pre> 89 *<pre>
90 *OProcess *proc = new OProcess; 90 *OProcess *proc = new OProcess;
91 * 91 *
92 **proc << "my_executable"; 92 **proc << "my_executable";
93 **proc << "These" << "are" << "the" << "command" << "line" << "args"; 93 **proc << "These" << "are" << "the" << "command" << "line" << "args";
94 *QApplication::connect(proc, SIGNAL(processExited(OProcess *)), 94 *QApplication::connect(proc, SIGNAL(processExited(OProcess *)),
95 * pointer_to_my_object, SLOT(my_objects_slot(OProcess *))); 95 * pointer_to_my_object, SLOT(my_objects_slot(OProcess *)));
96 *proc->start(); 96 *proc->start();
97 *</pre> 97 *</pre>
98 * 98 *
99 *This will start "my_executable" with the commandline arguments "These"... 99 *This will start "my_executable" with the commandline arguments "These"...
100 * 100 *
101 *When the child process exits, the respective Qt signal will be emitted. 101 *When the child process exits, the respective Qt signal will be emitted.
102 * 102 *
103 *@sect Communication with the child process 103 *@sect Communication with the child process
104 * 104 *
105 *OProcess supports communication with the child process through 105 *OProcess supports communication with the child process through
106 *stdin/stdout/stderr. 106 *stdin/stdout/stderr.
107 * 107 *
108 *The following functions are provided for getting data from the child 108 *The following functions are provided for getting data from the child
109 *process or sending data to the child's stdin (For more information, 109 *process or sending data to the child's stdin (For more information,
110 *have a look at the documentation of each function): 110 *have a look at the documentation of each function):
111 * 111 *
112 *@li bool @ref writeStdin(char *buffer, int buflen); 112 *@li bool @ref writeStdin(char *buffer, int buflen);
113 *@li -- Transmit data to the child process's stdin. 113 *@li -- Transmit data to the child process's stdin.
114 * 114 *
115 *@li bool @ref closeStdin(); 115 *@li bool @ref closeStdin();
116 *@li -- Closes the child process's stdin (which causes it to see an feof(stdin)). 116 *@li -- Closes the child process's stdin (which causes it to see an feof(stdin)).
117 *Returns false if you try to close stdin for a process that has been started 117 *Returns false if you try to close stdin for a process that has been started
118 *without a communication channel to stdin. 118 *without a communication channel to stdin.
119 * 119 *
120 *@li bool @ref closeStdout(); 120 *@li bool @ref closeStdout();
121 *@li -- Closes the child process's stdout. 121 *@li -- Closes the child process's stdout.
122 *Returns false if you try to close stdout for a process that has been started 122 *Returns false if you try to close stdout for a process that has been started
123 *without a communication channel to stdout. 123 *without a communication channel to stdout.
124 * 124 *
125 *@li bool @ref closeStderr(); 125 *@li bool @ref closeStderr();
126 *@li -- Closes the child process's stderr. 126 *@li -- Closes the child process's stderr.
127 *Returns false if you try to close stderr for a process that has been started 127 *Returns false if you try to close stderr for a process that has been started
128 *without a communication channel to stderr. 128 *without a communication channel to stderr.
129 * 129 *
130 * 130 *
131 *@sect QT signals: 131 *@sect QT signals:
132 * 132 *
133 *@li void @ref receivedStdout(OProcess *proc, char *buffer, int buflen); 133 *@li void @ref receivedStdout(OProcess *proc, char *buffer, int buflen);
134 *@li void @ref receivedStderr(OProcess *proc, char *buffer, int buflen); 134 *@li void @ref receivedStderr(OProcess *proc, char *buffer, int buflen);
135 *@li -- Indicates that new data has arrived from either the 135 *@li -- Indicates that new data has arrived from either the
136 *child process's stdout or stderr. 136 *child process's stdout or stderr.
137 * 137 *
138 *@li void @ref wroteStdin(OProcess *proc); 138 *@li void @ref wroteStdin(OProcess *proc);
139 *@li -- Indicates that all data that has been sent to the child process 139 *@li -- Indicates that all data that has been sent to the child process
140 *by a prior call to @ref writeStdin() has actually been transmitted to the 140 *by a prior call to @ref writeStdin() has actually been transmitted to the
141 *client . 141 *client .
142 * 142 *
143 *@author Christian Czezakte e9025461@student.tuwien.ac.at 143 *@author Christian Czezakte e9025461@student.tuwien.ac.at
144 * 144 *
145 * 145 *
146 **/ 146 **/
147class OProcess : public QObject 147class OProcess : public QObject
148{ 148{
149 Q_OBJECT 149 Q_OBJECT
150 150
151public: 151public:
152 152
153 /** 153 /**
154 * Modes in which the communication channel can be opened. 154 * Modes in which the communication channel can be opened.
155 * 155 *
156 * If communication for more than one channel is required, 156 * If communication for more than one channel is required,
157 * the values have to be or'ed together, for example to get 157 * the values have to be or'ed together, for example to get
158 * communication with stdout as well as with stdin, you would 158 * communication with stdout as well as with stdin, you would
159 * specify @p Stdin @p | @p Stdout 159 * specify @p Stdin @p | @p Stdout
160 * 160 *
161 * If @p NoRead is specified in conjunction with @p Stdout, 161 * If @p NoRead is specified in conjunction with @p Stdout,
162 * no data is actually read from @p Stdout but only 162 * no data is actually read from @p Stdout but only
163 * the signal @ref childOutput(int fd) is emitted. 163 * the signal @ref childOutput(int fd) is emitted.
164 */ 164 */
165 enum Communication { NoCommunication = 0, Stdin = 1, Stdout = 2, Stderr = 4, 165 enum Communication { NoCommunication = 0, Stdin = 1, Stdout = 2, Stderr = 4,
166 AllOutput = 6, All = 7, 166 AllOutput = 6, All = 7,
167 NoRead }; 167 NoRead };
168 168
169 /** 169 /**
170 * Run-modes for a child process. 170 * Run-modes for a child process.
171 */ 171 */
172 enum RunMode { 172 enum RunMode {
173 /** 173 /**
174 * The application does not receive notifications from the subprocess when 174 * The application does not receive notifications from the subprocess when
175 * it is finished or aborted. 175 * it is finished or aborted.
176 */ 176 */
177 DontCare, 177 DontCare,
178 /** 178 /**
179 * The application is notified when the subprocess dies. 179 * The application is notified when the subprocess dies.
180 */ 180 */
181 NotifyOnExit, 181 NotifyOnExit,
182 /** 182 /**
183 * The application is suspended until the started process is finished. 183 * The application is suspended until the started process is finished.
184 */ 184 */
185 Block }; 185 Block };
186 186
187 /** 187 /**
188 * Constructor 188 * Constructor
189 */ 189 */
190 OProcess(QObject *parent = 0, const char *name = 0); 190 OProcess(QObject *parent = 0, const char *name = 0);
191 /** 191 /**
192 * Constructor 192 * Constructor
193 */ 193 */
194 OProcess(const QString &arg0, QObject *parent = 0, const char *name = 0); 194 OProcess(const QString &arg0, QObject *parent = 0, const char *name = 0);
195 /** 195 /**
196 * Constructor 196 * Constructor
197 */ 197 */
198 OProcess(const QStringList &args, QObject *parent = 0, const char *name = 0); 198 OProcess(const QStringList &args, QObject *parent = 0, const char *name = 0);
199 199
200 /** 200 /**
201 *Destructor: 201 *Destructor:
202 * 202 *
203 * If the process is running when the destructor for this class 203 * If the process is running when the destructor for this class
204 * is called, the child process is killed with a SIGKILL, but 204 * is called, the child process is killed with a SIGKILL, but
205 * only if the run mode is not of type @p DontCare. 205 * only if the run mode is not of type @p DontCare.
206 * Processes started as @p DontCare keep running anyway. 206 * Processes started as @p DontCare keep running anyway.
207 */ 207 */
208 virtual ~OProcess(); 208 virtual ~OProcess();
209 209
210 /** 210 /**
211 @deprecated 211 @deprecated
212 212
213 The use of this function is now deprecated. -- Please use the 213 The use of this function is now deprecated. -- Please use the
214 "operator<<" instead of "setExecutable". 214 "operator<<" instead of "setExecutable".
215 215
216 Sets the executable to be started with this OProcess object. 216 Sets the executable to be started with this OProcess object.
217 Returns false if the process is currently running (in that 217 Returns false if the process is currently running (in that
218 case the executable remains unchanged.) 218 case the executable remains unchanged.)
219 219
220 @see operator<< 220 @see operator<<
221 221
222 */ 222 */
223 bool setExecutable(const QString& proc); 223 bool setExecutable(const QString& proc);
224 224
225 225
226 /** 226 /**
227 * Sets the executable and the command line argument list for this process. 227 * Sets the executable and the command line argument list for this process.
228 * 228 *
229 * For example, doing an "ls -l /usr/local/bin" can be achieved by: 229 * For example, doing an "ls -l /usr/local/bin" can be achieved by:
230 * <pre> 230 * <pre>
231 * OProcess p; 231 * OProcess p;
232 * ... 232 * ...
233 * p << "ls" << "-l" << "/usr/local/bin" 233 * p << "ls" << "-l" << "/usr/local/bin"
234 * </pre> 234 * </pre>
235 * 235 *
236 **/ 236 **/
237 OProcess &operator<<(const QString& arg); 237 OProcess &operator<<(const QString& arg);
238 /** 238 /**
239 * Similar to previous method, takes a char *, supposed to be in locale 8 bit already. 239 * Similar to previous method, takes a char *, supposed to be in locale 8 bit already.
240 */ 240 */
241 OProcess &operator<<(const char * arg); 241 OProcess &operator<<(const char * arg);
242 /** 242 /**
243 * Similar to previous method, takes a QCString, supposed to be in locale 8 bit already. 243 * Similar to previous method, takes a QCString, supposed to be in locale 8 bit already.
244 */ 244 */
245 OProcess &operator<<(const QCString & arg); 245 OProcess &operator<<(const QCString & arg);
246 246
247 /** 247 /**
248 * Sets the executable and the command line argument list for this process, 248 * Sets the executable and the command line argument list for this process,
249 * in a single method call, or add a list of arguments. 249 * in a single method call, or add a list of arguments.
250 **/ 250 **/
251 OProcess &operator<<(const QStringList& args); 251 OProcess &operator<<(const QStringList& args);
252 252
253 /** 253 /**
254 * Clear a command line argument list that has been set by using 254 * Clear a command line argument list that has been set by using
255 * the "operator<<". 255 * the "operator<<".
256 */ 256 */
257 void clearArguments(); 257 void clearArguments();
258 258
259 /** 259 /**
260 * Starts the process. 260 * Starts the process.
261 * For a detailed description of the 261 * For a detailed description of the
262 * various run modes and communication semantics, have a look at the 262 * various run modes and communication semantics, have a look at the
263 * general description of the OProcess class. 263 * general description of the OProcess class.
264 * 264 *
265 * The following problems could cause this function to 265 * The following problems could cause this function to
266 * return false: 266 * return false:
267 * 267 *
268 * @li The process is already running. 268 * @li The process is already running.
269 * @li The command line argument list is empty. 269 * @li The command line argument list is empty.
270 * @li The starting of the process failed (could not fork). 270 * @li The starting of the process failed (could not fork).
271 * @li The executable was not found. 271 * @li The executable was not found.
272 * 272 *
273 * @param comm Specifies which communication links should be 273 * @param comm Specifies which communication links should be
274 * established to the child process (stdin/stdout/stderr). By default, 274 * established to the child process (stdin/stdout/stderr). By default,
275 * no communication takes place and the respective communication 275 * no communication takes place and the respective communication
276 * signals will never get emitted. 276 * signals will never get emitted.
277 * 277 *
278 * @return true on success, false on error 278 * @return true on success, false on error
279 * (see above for error conditions) 279 * (see above for error conditions)
280 **/ 280 **/
281 virtual bool start(RunMode runmode = NotifyOnExit, 281 virtual bool start(RunMode runmode = NotifyOnExit,
282 Communication comm = NoCommunication); 282 Communication comm = NoCommunication);
283 283
284 /** 284 /**
285 * Stop the process (by sending it a signal). 285 * Stop the process (by sending it a signal).
286 * 286 *
287 * @param signoThe signal to send. The default is SIGTERM. 287 * @param signoThe signal to send. The default is SIGTERM.
288 * @return @p true if the signal was delivered successfully. 288 * @return @p true if the signal was delivered successfully.
289 */ 289 */
290 virtual bool kill(int signo = SIGTERM); 290 virtual bool kill(int signo = SIGTERM);
291 291
292 /** 292 /**
293 @return @p true if the process is (still) considered to be running 293 @return @p true if the process is (still) considered to be running
294 */ 294 */
295 bool isRunning() const; 295 bool isRunning() const;
296 296
297 /** Returns the process id of the process. 297 /** Returns the process id of the process.
298 * 298 *
299 * If it is called after 299 * If it is called after
300 * the process has exited, it returns the process id of the last 300 * the process has exited, it returns the process id of the last
301 * child process that was created by this instance of OProcess. 301 * child process that was created by this instance of OProcess.
302 * 302 *
303 * Calling it before any child process has been started by this 303 * Calling it before any child process has been started by this
304 * OProcess instance causes pid() to return 0. 304 * OProcess instance causes pid() to return 0.
305 **/ 305 **/
306 pid_t pid() const; 306 pid_t pid() const;
307 307
308 /** 308 /**
309 * Use pid().
310 * @deprecated
311 */
312 pid_t getPid() const { return pid(); }
313
314 /**
315 * Suspend processing of data from stdout of the child process. 309 * Suspend processing of data from stdout of the child process.
316 */ 310 */
317 void suspend(); 311 void suspend();
318 312
319 /** 313 /**
320 * Resume processing of data from stdout of the child process. 314 * Resume processing of data from stdout of the child process.
321 */ 315 */
322 void resume(); 316 void resume();
323 317
324 /** 318 /**
325 * @return @p true if the process has already finished and has exited 319 * @return @p true if the process has already finished and has exited
326 * "voluntarily", ie: it has not been killed by a signal. 320 * "voluntarily", ie: it has not been killed by a signal.
327 * 321 *
328 * Note that you should check @ref OProcess::exitStatus() to determine 322 * Note that you should check @ref OProcess::exitStatus() to determine
329 * whether the process completed its task successful or not. 323 * whether the process completed its task successful or not.
330 */ 324 */
331 bool normalExit() const; 325 bool normalExit() const;
332 326
333 /** 327 /**
334 * Returns the exit status of the process. 328 * Returns the exit status of the process.
335 * 329 *
336 * Please use 330 * Please use
337 * @ref OProcess::normalExit() to check whether the process has exited 331 * @ref OProcess::normalExit() to check whether the process has exited
338 * cleanly (i.e., @ref OProcess::normalExit() returns @p true) before calling 332 * cleanly (i.e., @ref OProcess::normalExit() returns @p true) before calling
339 * this function because if the process did not exit normally, 333 * this function because if the process did not exit normally,
340 * it does not have a valid exit status. 334 * it does not have a valid exit status.
341 */ 335 */
342 int exitStatus() const; 336 int exitStatus() const;
343 337
344 338
345 /** 339 /**
346 * Transmit data to the child process's stdin. 340 * Transmit data to the child process's stdin.
347 * 341 *
348 * OProcess::writeStdin may return false in the following cases: 342 * OProcess::writeStdin may return false in the following cases:
349 * 343 *
350 * @li The process is not currently running. 344 * @li The process is not currently running.
351 * 345 *
352 * @li Communication to stdin has not been requested in the @ref start() call. 346 * @li Communication to stdin has not been requested in the @ref start() call.
353 * 347 *
354 * @li Transmission of data to the child process by a previous call to 348 * @li Transmission of data to the child process by a previous call to
355 * @ref writeStdin() is still in progress. 349 * @ref writeStdin() is still in progress.
356 * 350 *
357 * Please note that the data is sent to the client asynchronously, 351 * Please note that the data is sent to the client asynchronously,
358 * so when this function returns, the data might not have been 352 * so when this function returns, the data might not have been
359 * processed by the child process. 353 * processed by the child process.
360 * 354 *
361 * If all the data has been sent to the client, the signal 355 * If all the data has been sent to the client, the signal
362 * @ref wroteStdin() will be emitted. 356 * @ref wroteStdin() will be emitted.
363 * 357 *
364 * Please note that you must not free "buffer" or call @ref writeStdin() 358 * Please note that you must not free "buffer" or call @ref writeStdin()
365 * again until either a @ref wroteStdin() signal indicates that the 359 * again until either a @ref wroteStdin() signal indicates that the
366 * data has been sent or a @ref processHasExited() signal shows that 360 * data has been sent or a @ref processHasExited() signal shows that
367 * the child process is no longer alive... 361 * the child process is no longer alive...
368 **/ 362 **/
369 bool writeStdin(const char *buffer, int buflen); 363 bool writeStdin(const char *buffer, int buflen);
370 364
371 void flushStdin(); 365 void flushStdin();
372 366
373 /** 367 /**
374 * This causes the stdin file descriptor of the child process to be 368 * This causes the stdin file descriptor of the child process to be
375 * closed indicating an "EOF" to the child. 369 * closed indicating an "EOF" to the child.
376 * 370 *
377 * @return @p false if no communication to the process's stdin 371 * @return @p false if no communication to the process's stdin
378 * had been specified in the call to @ref start(). 372 * had been specified in the call to @ref start().
379 */ 373 */
380 bool closeStdin(); 374 bool closeStdin();
381 375
382 /** 376 /**
383 * This causes the stdout file descriptor of the child process to be 377 * This causes the stdout file descriptor of the child process to be
384 * closed. 378 * closed.
385 * 379 *
386 * @return @p false if no communication to the process's stdout 380 * @return @p false if no communication to the process's stdout
387 * had been specified in the call to @ref start(). 381 * had been specified in the call to @ref start().
388 */ 382 */
389 bool closeStdout(); 383 bool closeStdout();
390 384
391 /** 385 /**
392 * This causes the stderr file descriptor of the child process to be 386 * This causes the stderr file descriptor of the child process to be
393 * closed. 387 * closed.
394 * 388 *
395 * @return @p false if no communication to the process's stderr 389 * @return @p false if no communication to the process's stderr
396 * had been specified in the call to @ref start(). 390 * had been specified in the call to @ref start().
397 */ 391 */
398 bool closeStderr(); 392 bool closeStderr();
399 393
400 /** 394 /**
401 * Lets you see what your arguments are for debugging. 395 * Lets you see what your arguments are for debugging.
402 */ 396 */
403 397
404 const QValueList<QCString> &args() { return arguments; } 398 const QValueList<QCString> &args() { return arguments; }
405 399
406 /** 400 /**
407 * Controls whether the started process should drop any 401 * Controls whether the started process should drop any
408 * setuid/segid privileges or whether it should keep them 402 * setuid/segid privileges or whether it should keep them
409 * 403 *
410 * The default is @p false : drop privileges 404 * The default is @p false : drop privileges
411 */ 405 */
412 void setRunPrivileged(bool keepPrivileges); 406 void setRunPrivileged(bool keepPrivileges);
413 407
414 /** 408 /**
415 * Returns whether the started process will drop any 409 * Returns whether the started process will drop any
416 * setuid/segid privileges or whether it will keep them 410 * setuid/segid privileges or whether it will keep them
417 */ 411 */
418 bool runPrivileged() const; 412 bool runPrivileged() const;
419 413
420 /** 414 /**
421 * Modifies the environment of the process to be started. 415 * Modifies the environment of the process to be started.
422 * This function must be called before starting the process. 416 * This function must be called before starting the process.
423 */ 417 */
424 void setEnvironment(const QString &name, const QString &value); 418 void setEnvironment(const QString &name, const QString &value);
425 419
426 /** 420 /**
427 * Changes the current working directory (CWD) of the process 421 * Changes the current working directory (CWD) of the process
428 * to be started. 422 * to be started.
429 * This function must be called before starting the process. 423 * This function must be called before starting the process.
430 */ 424 */
431 void setWorkingDirectory(const QString &dir); 425 void setWorkingDirectory(const QString &dir);
432 426
433 /** 427 /**
434 * Specify whether to start the command via a shell or directly. 428 * Specify whether to start the command via a shell or directly.
435 * The default is to start the command directly. 429 * The default is to start the command directly.
436 * If @p useShell is true @p shell will be used as shell, or 430 * If @p useShell is true @p shell will be used as shell, or
437 * if shell is empty, the standard shell is used. 431 * if shell is empty, the standard shell is used.
438 * @p quote A flag indicating whether to quote the arguments. 432 * @p quote A flag indicating whether to quote the arguments.
439 * 433 *
440 * When using a shell, the caller should make sure that all filenames etc. 434 * When using a shell, the caller should make sure that all filenames etc.
441 * are properly quoted when passed as argument. 435 * are properly quoted when passed as argument.
442 * @see quote() 436 * @see quote()
443 */ 437 */
444 void setUseShell(bool useShell, const char *shell = 0); 438 void setUseShell(bool useShell, const char *shell = 0);
445 439
446 /** 440 /**
447 * This function can be used to quote an argument string such that 441 * This function can be used to quote an argument string such that
448 * the shell processes it properly. This is e. g. necessary for 442 * the shell processes it properly. This is e. g. necessary for
449 * user-provided file names which may contain spaces or quotes. 443 * user-provided file names which may contain spaces or quotes.
450 * It also prevents expansion of wild cards and environment variables. 444 * It also prevents expansion of wild cards and environment variables.
451 */ 445 */
452 static QString quote(const QString &arg); 446 static QString quote(const QString &arg);
453 447
454 /** 448 /**
455 * Detaches OProcess from child process. All communication is closed. 449 * Detaches OProcess from child process. All communication is closed.
456 * No exit notification is emitted any more for the child process. 450 * No exit notification is emitted any more for the child process.
457 * Deleting the OProcess will no longer kill the child process. 451 * Deleting the OProcess will no longer kill the child process.
458 * Note that the current process remains the parent process of the 452 * Note that the current process remains the parent process of the
459 * child process. 453 * child process.
460 */ 454 */
461 void detach(); 455 void detach();
462 456
463 457
464 458
465signals: 459signals:
466 460
467 /** 461 /**
468 * Emitted after the process has terminated when 462 * Emitted after the process has terminated when
469 * the process was run in the @p NotifyOnExit (==default option to 463 * the process was run in the @p NotifyOnExit (==default option to
470 * @ref start()) or the @ref Block mode. 464 * @ref start()) or the @ref Block mode.
471 **/ 465 **/
472 void processExited(OProcess *proc); 466 void processExited(OProcess *proc);
473 467
474 468
475 /** 469 /**
476 * Emitted, when output from the child process has 470 * Emitted, when output from the child process has
477 * been received on stdout. 471 * been received on stdout.
478 * 472 *
479 * To actually get 473 * To actually get
480 * these signals, the respective communication link (stdout/stderr) 474 * these signals, the respective communication link (stdout/stderr)
481 * has to be turned on in @ref start(). 475 * has to be turned on in @ref start().
482 * 476 *
483 * @param buffer The data received. 477 * @param buffer The data received.
484 * @param buflen The number of bytes that are available. 478 * @param buflen The number of bytes that are available.
485 * 479 *
486 * You should copy the information contained in @p buffer to your private 480 * You should copy the information contained in @p buffer to your private
487 * data structures before returning from this slot. 481 * data structures before returning from this slot.
488 **/ 482 **/
489 void receivedStdout(OProcess *proc, char *buffer, int buflen); 483 void receivedStdout(OProcess *proc, char *buffer, int buflen);
490 484
491 /** 485 /**
492 * Emitted when output from the child process has 486 * Emitted when output from the child process has
493 * been received on stdout. 487 * been received on stdout.
494 * 488 *
495 * To actually get these signals, the respective communications link 489 * To actually get these signals, the respective communications link
496 * (stdout/stderr) has to be turned on in @ref start() and the 490 * (stdout/stderr) has to be turned on in @ref start() and the
497 * @p NoRead flag should have been passed. 491 * @p NoRead flag should have been passed.
498 * 492 *
499 * You will need to explicitly call resume() after your call to start() 493 * You will need to explicitly call resume() after your call to start()
500 * to begin processing data from the child process's stdout. This is 494 * to begin processing data from the child process's stdout. This is
501 * to ensure that this signal is not emitted when no one is connected 495 * to ensure that this signal is not emitted when no one is connected
502 * to it, otherwise this signal will not be emitted. 496 * to it, otherwise this signal will not be emitted.
503 * 497 *
504 * The data still has to be read from file descriptor @p fd. 498 * The data still has to be read from file descriptor @p fd.
505 **/ 499 **/
506 void receivedStdout(int fd, int &len); 500 void receivedStdout(int fd, int &len);
507 501
508 502
509 /** 503 /**
510 * Emitted, when output from the child process has 504 * Emitted, when output from the child process has
511 * been received on stderr. 505 * been received on stderr.
512 * To actually get 506 * To actually get
513 * these signals, the respective communication link (stdout/stderr) 507 * these signals, the respective communication link (stdout/stderr)
514 * has to be turned on in @ref start(). 508 * has to be turned on in @ref start().
515 * 509 *
516 * @param buffer The data received. 510 * @param buffer The data received.
517 * @param buflen The number of bytes that are available. 511 * @param buflen The number of bytes that are available.
518 * 512 *
519 * You should copy the information contained in @p buffer to your private 513 * You should copy the information contained in @p buffer to your private
520 * data structures before returning from this slot. 514 * data structures before returning from this slot.
521 */ 515 */
522 void receivedStderr(OProcess *proc, char *buffer, int buflen); 516 void receivedStderr(OProcess *proc, char *buffer, int buflen);
523 517
524 /** 518 /**
525 * Emitted after all the data that has been 519 * Emitted after all the data that has been
526 * specified by a prior call to @ref writeStdin() has actually been 520 * specified by a prior call to @ref writeStdin() has actually been
527 * written to the child process. 521 * written to the child process.
528 **/ 522 **/
529 void wroteStdin(OProcess *proc); 523 void wroteStdin(OProcess *proc);
530 524
531 525
532protected slots: 526protected slots:
533 527
534 /** 528 /**
535 * This slot gets activated when data from the child's stdout arrives. 529 * This slot gets activated when data from the child's stdout arrives.
536 * It usually calls "childOutput" 530 * It usually calls "childOutput"
537 */ 531 */
538 void slotChildOutput(int fdno); 532 void slotChildOutput(int fdno);
539 533
540 /** 534 /**
541 * This slot gets activated when data from the child's stderr arrives. 535 * This slot gets activated when data from the child's stderr arrives.
542 * It usually calls "childError" 536 * It usually calls "childError"
543 */ 537 */
544 void slotChildError(int fdno); 538 void slotChildError(int fdno);
545 /* 539 /*
546 Slot functions for capturing stdout and stderr of the child 540 Slot functions for capturing stdout and stderr of the child
547 */ 541 */
548 542
549 /** 543 /**
550 * Called when another bulk of data can be sent to the child's 544 * Called when another bulk of data can be sent to the child's
551 * stdin. If there is no more data to be sent to stdin currently 545 * stdin. If there is no more data to be sent to stdin currently
552 * available, this function must disable the QSocketNotifier "innot". 546 * available, this function must disable the QSocketNotifier "innot".
553 */ 547 */
554 void slotSendData(int dummy); 548 void slotSendData(int dummy);
555 549
556protected: 550protected:
557 551
558 /** 552 /**
559 * Sets up the environment according to the data passed via 553 * Sets up the environment according to the data passed via
560 * setEnvironment(...) 554 * setEnvironment(...)
561 */ 555 */
562 void setupEnvironment(); 556 void setupEnvironment();
563 557
564 /** 558 /**
565 * The list of the process' command line arguments. The first entry 559 * The list of the process' command line arguments. The first entry
566 * in this list is the executable itself. 560 * in this list is the executable itself.
567 */ 561 */
568 QValueList<QCString> arguments; 562 QValueList<QCString> arguments;
569 /** 563 /**
570 * How to run the process (Block, NotifyOnExit, DontCare). You should 564 * How to run the process (Block, NotifyOnExit, DontCare). You should
571 * not modify this data member directly from derived classes. 565 * not modify this data member directly from derived classes.
572 */ 566 */
573 RunMode run_mode; 567 RunMode run_mode;
574 /** 568 /**
575 * true if the process is currently running. You should not 569 * true if the process is currently running. You should not
576 * modify this data member directly from derived classes. For 570 * modify this data member directly from derived classes. For
577 * reading the value of this data member, please use "isRunning()" 571 * reading the value of this data member, please use "isRunning()"
578 * since "runs" will probably be made private in later versions 572 * since "runs" will probably be made private in later versions
579 * of OProcess. 573 * of OProcess.
580 */ 574 */
581 bool runs; 575 bool runs;
582 576
583 /** 577 /**
584 * The PID of the currently running process (see "getPid()"). 578 * The PID of the currently running process (see "getPid()").
585 * You should not modify this data member in derived classes. 579 * You should not modify this data member in derived classes.
586 * Please use "getPid()" instead of directly accessing this 580 * Please use "getPid()" instead of directly accessing this
587 * member function since it will probably be made private in 581 * member function since it will probably be made private in
588 * later versions of OProcess. 582 * later versions of OProcess.
589 */ 583 */
590 pid_t pid_; 584 pid_t pid_;
591 585
592 /** 586 /**
593 * The process' exit status as returned by "waitpid". You should not 587 * The process' exit status as returned by "waitpid". You should not
594 * modify the value of this data member from derived classes. You should 588 * modify the value of this data member from derived classes. You should
595 * rather use @ref exitStatus than accessing this data member directly 589 * rather use @ref exitStatus than accessing this data member directly
596 * since it will probably be made private in further versions of 590 * since it will probably be made private in further versions of
597 * OProcess. 591 * OProcess.
598 */ 592 */
599 int status; 593 int status;
600 594
601 595
602 /** 596 /**
603 * See setRunPrivileged() 597 * See setRunPrivileged()
604 */ 598 */
605 bool keepPrivs; 599 bool keepPrivs;
606 600
607 /* 601 /*
608 Functions for setting up the sockets for communication. 602 Functions for setting up the sockets for communication.
609 setupCommunication 603 setupCommunication
610 -- is called from "start" before "fork"ing. 604 -- is called from "start" before "fork"ing.
611 commSetupDoneP 605 commSetupDoneP
612 -- completes communication socket setup in the parent 606 -- completes communication socket setup in the parent
613 commSetupDoneC 607 commSetupDoneC
614 -- completes communication setup in the child process 608 -- completes communication setup in the child process
615 commClose 609 commClose
616 -- frees all allocated communication resources in the parent 610 -- frees all allocated communication resources in the parent
617 after the process has exited 611 after the process has exited
618 */ 612 */
619 613
620 /** 614 /**
621 * This function is called from "OProcess::start" right before a "fork" takes 615 * This function is called from "OProcess::start" right before a "fork" takes
622 * place. According to 616 * place. According to
623 * the "comm" parameter this function has to initialize the "in", "out" and 617 * the "comm" parameter this function has to initialize the "in", "out" and
624 * "err" data member of OProcess. 618 * "err" data member of OProcess.
625 * 619 *
626 * This function should return 0 if setting the needed communication channels 620 * This function should return 0 if setting the needed communication channels
627 * was successful. 621 * was successful.
628 * 622 *
629 * The default implementation is to create UNIX STREAM sockets for the communication, 623 * The default implementation is to create UNIX STREAM sockets for the communication,
630 * but you could overload this function and establish a TCP/IP communication for 624 * but you could overload this function and establish a TCP/IP communication for
631 * network communication, for example. 625 * network communication, for example.
632 */ 626 */
633 virtual int setupCommunication(Communication comm); 627 virtual int setupCommunication(Communication comm);
634 628
635 /** 629 /**
636 * Called right after a (successful) fork on the parent side. This function 630 * Called right after a (successful) fork on the parent side. This function
637 * will usually do some communications cleanup, like closing the reading end 631 * will usually do some communications cleanup, like closing the reading end
638 * of the "stdin" communication channel. 632 * of the "stdin" communication channel.
639 * 633 *
640 * Furthermore, it must also create the QSocketNotifiers "innot", "outnot" and 634 * Furthermore, it must also create the QSocketNotifiers "innot", "outnot" and
641 * "errnot" and connect their Qt slots to the respective OProcess member functions. 635 * "errnot" and connect their Qt slots to the respective OProcess member functions.
642 * 636 *
643 * For a more detailed explanation, it is best to have a look at the default 637 * For a more detailed explanation, it is best to have a look at the default
644 * implementation of "setupCommunication" in kprocess.cpp. 638 * implementation of "setupCommunication" in kprocess.cpp.
645 */ 639 */
646 virtual int commSetupDoneP(); 640 virtual int commSetupDoneP();
647 641
648 /** 642 /**
649 * Called right after a (successful) fork, but before an "exec" on the child 643 * Called right after a (successful) fork, but before an "exec" on the child
650 * process' side. It usually just closes the unused communication ends of 644 * process' side. It usually just closes the unused communication ends of
651 * "in", "out" and "err" (like the writing end of the "in" communication 645 * "in", "out" and "err" (like the writing end of the "in" communication
652 * channel. 646 * channel.
653 */ 647 */
654 virtual int commSetupDoneC(); 648 virtual int commSetupDoneC();
655 649
656 650
657 /** 651 /**
658 * Immediately called after a process has exited. This function normally 652 * Immediately called after a process has exited. This function normally
659 * calls commClose to close all open communication channels to this 653 * calls commClose to close all open communication channels to this
660 * process and emits the "processExited" signal (if the process was 654 * process and emits the "processExited" signal (if the process was
661 * not running in the "DontCare" mode). 655 * not running in the "DontCare" mode).
662 */ 656 */
663 virtual void processHasExited(int state); 657 virtual void processHasExited(int state);
664 658
665 /** 659 /**
666 * Should clean up the communication links to the child after it has 660 * Should clean up the communication links to the child after it has
667 * exited. Should be called from "processHasExited". 661 * exited. Should be called from "processHasExited".
668 */ 662 */
669 virtual void commClose(); 663 virtual void commClose();
670 664
671 665
672 /** 666 /**
673 * the socket descriptors for stdin/stdout/stderr. 667 * the socket descriptors for stdin/stdout/stderr.
674 */ 668 */
675 int out[2]; 669 int out[2];
676 int in[2]; 670 int in[2];
677 int err[2]; 671 int err[2];
678 672
679 /** 673 /**
680 * The socket notifiers for the above socket descriptors. 674 * The socket notifiers for the above socket descriptors.
681 */ 675 */
682 QSocketNotifier *innot; 676 QSocketNotifier *innot;
683 QSocketNotifier *outnot; 677 QSocketNotifier *outnot;
684 QSocketNotifier *errnot; 678 QSocketNotifier *errnot;
685 679
686 /** 680 /**
687 * Lists the communication links that are activated for the child 681 * Lists the communication links that are activated for the child
688 * process. Should not be modified from derived classes. 682 * process. Should not be modified from derived classes.
689 */ 683 */
690 Communication communication; 684 Communication communication;
691 685
692 /** 686 /**
693 * Called by "slotChildOutput" this function copies data arriving from the 687 * Called by "slotChildOutput" this function copies data arriving from the
694 * child process's stdout to the respective buffer and emits the signal 688 * child process's stdout to the respective buffer and emits the signal
695 * "@ref receivedStderr". 689 * "@ref receivedStderr".
696 */ 690 */
697 int childOutput(int fdno); 691 int childOutput(int fdno);
698 692
699 /** 693 /**
700 * Called by "slotChildOutput" this function copies data arriving from the 694 * Called by "slotChildOutput" this function copies data arriving from the
701 * child process's stdout to the respective buffer and emits the signal 695 * child process's stdout to the respective buffer and emits the signal
702 * "@ref receivedStderr" 696 * "@ref receivedStderr"
703 */ 697 */
704 int childError(int fdno); 698 int childError(int fdno);
705 699
706 // information about the data that has to be sent to the child: 700 // information about the data that has to be sent to the child:
707 701
708 const char *input_data; // the buffer holding the data 702 const char *input_data; // the buffer holding the data
709 int input_sent; // # of bytes already transmitted 703 int input_sent; // # of bytes already transmitted
710 int input_total; // total length of input_data 704 int input_total; // total length of input_data
711 705
712 /** 706 /**
713 * @ref OProcessController is a friend of OProcess because it has to have 707 * @ref OProcessController is a friend of OProcess because it has to have
714 * access to various data members. 708 * access to various data members.
715 */ 709 */
716 friend class OProcessController; 710 friend class OProcessController;
717 711
718 712
719private: 713private:
720 /** 714 /**
721 * Searches for a valid shell. 715 * Searches for a valid shell.
722 * Here is the algorithm used for finding an executable shell: 716 * Here is the algorithm used for finding an executable shell:
723 * 717 *
724 * @li Try the executable pointed to by the "SHELL" environment 718 * @li Try the executable pointed to by the "SHELL" environment
725 * variable with white spaces stripped off 719 * variable with white spaces stripped off
726 * 720 *
727 * @li If your process runs with uid != euid or gid != egid, a shell 721 * @li If your process runs with uid != euid or gid != egid, a shell
728 * not listed in /etc/shells will not used. 722 * not listed in /etc/shells will not used.
729 * 723 *
730 * @li If no valid shell could be found, "/bin/sh" is used as a last resort. 724 * @li If no valid shell could be found, "/bin/sh" is used as a last resort.
731 */ 725 */
732 QCString searchShell(); 726 QCString searchShell();
733 727
734 /** 728 /**
735 * Used by @ref searchShell in order to find out whether the shell found 729 * Used by @ref searchShell in order to find out whether the shell found
736 * is actually executable at all. 730 * is actually executable at all.
737 */ 731 */
738 bool isExecutable(const QCString &filename); 732 bool isExecutable(const QCString &filename);
739 733
740 // Disallow assignment and copy-construction 734 // Disallow assignment and copy-construction
741 OProcess( const OProcess& ); 735 OProcess( const OProcess& );
742 OProcess& operator= ( const OProcess& ); 736 OProcess& operator= ( const OProcess& );
743 737
744private: 738private:
745 void init ( ); 739 void init ( );
746 740
747 OProcessPrivate *d; 741 OProcessPrivate *d;
748}; 742};
749 743
750 744
751 745
752#endif 746#endif
753 747
diff --git a/libopie/orecurrancewidget.h b/libopie/orecurrancewidget.h
index a5d6489..37a57f0 100644
--- a/libopie/orecurrancewidget.h
+++ b/libopie/orecurrancewidget.h
@@ -1,90 +1,93 @@
1/* 1/*
2 * GPL and based on the widget from TT 2 * GPL and based on the widget from TT
3 */ 3 */
4 4
5#ifndef OPIE_RECURRANCE_WIDGET_H 5#ifndef OPIE_RECURRANCE_WIDGET_H
6#define OPIE_RECURRANCE_WIDGET_H 6#define OPIE_RECURRANCE_WIDGET_H
7 7
8#include <qlist.h> 8#include <qlist.h>
9#include <qtoolbutton.h> 9#include <qtoolbutton.h>
10#include <qcheckbox.h> 10#include <qcheckbox.h>
11#include <qdatetime.h> 11#include <qdatetime.h>
12#include <qbuttongroup.h> 12#include <qbuttongroup.h>
13 13
14#include <qpe/datebookmonth.h> 14#include <qpe/datebookmonth.h>
15 15
16#include "orecurrancebase.h" 16#include "orecurrancebase.h"
17#include <opie/orecur.h> 17#include <opie/orecur.h>
18 18
19// FIXME spelling!!!! -zecke 19// FIXME spelling!!!! -zecke
20// FIXME spelling filenames 20// FIXME spelling filenames
21 21
22/** 22/**
23 * A widget to let the user select rules for recurrences. 23 * A widget to let the user select rules for recurrences.
24 * This widget can take care of weekly, monthly, daily and yearly recurrence 24 * This widget can take care of weekly, monthly, daily and yearly recurrence
25 * It is used inside todolist and datebook. 25 * It is used inside todolist and datebook.
26 * 26 *
27 * 27 *
28 * @short Widget of selecting Recurrance 28 * @short Widget of selecting Recurrance
29 * @author Trolltech, Holger Freyther 29 * @author Trolltech, Holger Freyther
30 * @version 0.9 30 * @version 0.9
31 */ 31 */
32class ORecurranceWidget : public ORecurranceBase { 32class ORecurranceWidget : public ORecurranceBase {
33 Q_OBJECT 33 Q_OBJECT
34public: 34public:
35 ORecurranceWidget( bool startOnMonday, 35 ORecurranceWidget( bool startOnMonday,
36 const QDate& start, QWidget* parent = 0, 36 const QDate& start, QWidget* parent = 0,
37 const char* name = 0, bool modal = TRUE, 37 const char* name = 0, bool modal = TRUE,
38 WFlags fl = 0 ); 38 WFlags fl = 0 );
39 ORecurranceWidget( bool startOnMonday, 39 ORecurranceWidget( bool startOnMonday,
40 const ORecur& rp, const QDate& start, 40 const ORecur& rp, const QDate& start,
41 QWidget* parent = 0, const char* name =0, 41 QWidget* parent = 0, const char* name =0,
42 bool modal = TRUE, WFlags = 0 ); 42 bool modal = TRUE, WFlags = 0 );
43 ~ORecurranceWidget(); 43 ~ORecurranceWidget();
44 ORecur recurrence()const; 44 ORecur recurrence()const;
45 QDate endDate()const; 45 QDate endDate()const;
46 46
47public slots: 47public slots:
48 void slotSetRType( int ); 48 void slotSetRType( int );
49 /** 49 /**
50 * set the new end date 50 * set the new end date
51 */ 51 */
52 void endDateChanged( int, int, int ); 52 void endDateChanged( int, int, int );
53 /** 53 /**
54 * enable/disable end date 54 * enable/disable end date
55 */ 55 */
56 void slotNoEnd( bool unused ); 56 void slotNoEnd( bool unused );
57 void setStartDate( const QDate& ); 57 void setStartDate( const QDate& );
58 void setRecurrence( const ORecur& recur, const QDate& start ); 58 void setRecurrence( const ORecur& recur, const QDate& start );
59 void setRecurrence( const ORecur& recur ); 59 void setRecurrence( const ORecur& recur );
60 60
61private slots: 61private slots:
62 void setupRepeatLabel( const QString& ); 62 void setupRepeatLabel( const QString& );
63 void setupRepeatLabel( int ); 63 void setupRepeatLabel( int );
64 void slotWeekLabel(); 64 void slotWeekLabel();
65 void slotMonthLabel( int ); 65 void slotMonthLabel( int );
66 void slotChangeStartOfWeek( bool onMonday ); 66 void slotChangeStartOfWeek( bool onMonday );
67 67
68private: 68private:
69 void setupNone(); 69 void setupNone();
70 void setupDaily(); 70 void setupDaily();
71 void setupWeekly(); 71 void setupWeekly();
72 void setupMonthly(); 72 void setupMonthly();
73 void setupYearly(); 73 void setupYearly();
74 74
75 enum repeatButtons { None, Day, Week, Month, Year }; 75 enum repeatButtons { None, Day, Week, Month, Year };
76 void init(); 76 void init();
77 void hideExtras(); 77 void hideExtras();
78 void showRepeatStuff(); 78 void showRepeatStuff();
79 79
80 QList<QToolButton> listRTypeButtons; 80 QList<QToolButton> listRTypeButtons;
81 QList<QToolButton> listExtra; 81 QList<QToolButton> listExtra;
82 QDate start; // only used in one spot... 82 QDate start; // only used in one spot...
83 QDate end; 83 QDate end;
84 repeatButtons currInterval; 84 repeatButtons currInterval;
85 bool startWeekOnMonday : 1; 85 bool startWeekOnMonday : 1;
86 DateBookMonth *repeatPicker; 86 DateBookMonth *repeatPicker;
87
88 class Private;
89 Private *d;
87 90
88}; 91};
89 92
90#endif 93#endif
diff --git a/libopie/otabbar.h b/libopie/otabbar.h
index 0b353e2..668187b 100644
--- a/libopie/otabbar.h
+++ b/libopie/otabbar.h
@@ -1,76 +1,80 @@
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 OTABBAR_H 32#ifndef OTABBAR_H
33#define OTABBAR_H 33#define OTABBAR_H
34 34
35#include <qtabbar.h> 35#include <qtabbar.h>
36 36
37/** 37/**
38 * @class OTabBar 38 * @class OTabBar
39 * @brief The OTabBar class is a derivative of QTabBar. 39 * @brief The OTabBar class is a derivative of QTabBar.
40 * 40 *
41 * OTabBar is a derivation of TrollTech's QTabBar which provides 41 * OTabBar is a derivation of TrollTech's QTabBar which provides
42 * a row of tabs for selection. The only difference between this 42 * a row of tabs for selection. The only difference between this
43 * class and QTabBar is that there is no dotted line box around 43 * class and QTabBar is that there is no dotted line box around
44 * the label of the tab with the current focus. 44 * the label of the tab with the current focus.
45 */ 45 */
46class OTabBar : public QTabBar 46class OTabBar : public QTabBar
47{ 47{
48 Q_OBJECT 48 Q_OBJECT
49 49
50public: 50public:
51/** 51/**
52 * @fn OTabBar( QWidget *parent = 0, const char *name = 0 ) 52 * @fn OTabBar( QWidget *parent = 0, const char *name = 0 )
53 * @brief Object constructor. 53 * @brief Object constructor.
54 * 54 *
55 * @param parent Pointer to parent of this control. 55 * @param parent Pointer to parent of this control.
56 * @param name Name of control. 56 * @param name Name of control.
57 * 57 *
58 * Constructs a new OTabBar control with parent and name. 58 * Constructs a new OTabBar control with parent and name.
59 */ 59 */
60 // FIXME Allow WFlags? -zecke 60 // FIXME Allow WFlags? -zecke
61 OTabBar( QWidget * = 0, const char * = 0 ); 61 OTabBar( QWidget * = 0, const char * = 0 );
62 62
63protected: 63protected:
64/** 64/**
65 * @fn paintLabel( QPainter* p, const QRect& br , QTab* t, bool has_focus)const 65 * @fn paintLabel( QPainter* p, const QRect& br , QTab* t, bool has_focus)const
66 * @brief Internal function to draw a tab's label. 66 * @brief Internal function to draw a tab's label.
67 * 67 *
68 * @param p Pointer to QPainter used for drawing. 68 * @param p Pointer to QPainter used for drawing.
69 * @param br QRect providing region to draw label in. 69 * @param br QRect providing region to draw label in.
70 * @param t Tab to draw label for. 70 * @param t Tab to draw label for.
71 * @param has_focus Boolean value not used, retained for compatibility reasons. 71 * @param has_focus Boolean value not used, retained for compatibility reasons.
72 */ 72 */
73 void paintLabel( QPainter *, const QRect &, QTab *, bool ) const; 73 void paintLabel( QPainter *, const QRect &, QTab *, bool ) const;
74
75private:
76 class Private;
77 Private *d;
74}; 78};
75 79
76#endif 80#endif
diff --git a/libopie/otabinfo.h b/libopie/otabinfo.h
index eebaf8e..00bb06d 100644
--- a/libopie/otabinfo.h
+++ b/libopie/otabinfo.h
@@ -1,132 +1,134 @@
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 OTABINFO_H 32#ifndef OTABINFO_H
33#define OTABINFO_H 33#define OTABINFO_H
34 34
35#include <qlist.h> 35#include <qlist.h>
36#include <qstring.h> 36#include <qstring.h>
37 37
38class QWidget; 38class QWidget;
39 39
40/** 40/**
41 * @class OTabInfo 41 * @class OTabInfo
42 * @brief The OTabInfo class is used internally by OTabWidget to keep track 42 * @brief The OTabInfo class is used internally by OTabWidget to keep track
43 * of widgets added to the control. 43 * of widgets added to the control.
44 * 44 *
45 * OTabInfo provides the following information about a widget added to an 45 * OTabInfo provides the following information about a widget added to an
46 * OTabWidget control: 46 * OTabWidget control:
47 * 47 *
48 * ID - integer tab bar ID 48 * ID - integer tab bar ID
49 * Control - QWidget pointer to child widget 49 * Control - QWidget pointer to child widget
50 * Label - QString text label for OTabWidget selection control 50 * Label - QString text label for OTabWidget selection control
51 * Icon - QString name of icon file 51 * Icon - QString name of icon file
52 */ 52 */
53class OTabInfo 53class OTabInfo
54{ 54{
55public: 55public:
56/** 56/**
57 * @fn OTabInfo() 57 * @fn OTabInfo()
58 * @brief Object constructor. 58 * @brief Object constructor.
59 * 59 *
60 * @param parent Pointer to parent of this control. 60 * @param parent Pointer to parent of this control.
61 * @param name Name of control. 61 * @param name Name of control.
62 * @param s Style of widget selection control. 62 * @param s Style of widget selection control.
63 * @param p Position of the widget selection control. 63 * @param p Position of the widget selection control.
64 */ 64 */
65 OTabInfo() : i( -1 ), c( 0 ), p( 0 ), l( QString::null ) {} 65 OTabInfo() : i( -1 ), c( 0 ), p( 0 ), l( QString::null ) {}
66 66
67/** 67/**
68 * @fn OTabInfo( int id, QWidget *control, const QString &icon, const QString &label ) 68 * @fn OTabInfo( int id, QWidget *control, const QString &icon, const QString &label )
69 * @brief Object constructor. 69 * @brief Object constructor.
70 * 70 *
71 * @param id TabBar identifier for widget. 71 * @param id TabBar identifier for widget.
72 * @param control QWidget pointer to widget. 72 * @param control QWidget pointer to widget.
73 * @param icon QString name of icon file. 73 * @param icon QString name of icon file.
74 * @param label QString text label for OTabWidget selection control. 74 * @param label QString text label for OTabWidget selection control.
75 */ 75 */
76 OTabInfo( int id, QWidget *control, const QString &icon, const QString &label ) 76 OTabInfo( int id, QWidget *control, const QString &icon, const QString &label )
77 : i( id ), c( control ), p( icon ), l( label ) {} 77 : i( id ), c( control ), p( icon ), l( label ) {}
78 78
79/** 79/**
80 * @fn id()const 80 * @fn id()const
81 * @brief Returns TabBar ID. 81 * @brief Returns TabBar ID.
82 */ 82 */
83 int id() const { return i; } 83 int id() const { return i; }
84 84
85/** 85/**
86 * @fn label()const 86 * @fn label()const
87 * @brief Returns text label for widget. 87 * @brief Returns text label for widget.
88 */ 88 */
89 const QString &label() const { return l; } 89 const QString &label() const { return l; }
90 90
91/** 91/**
92 * @fn setLabel( const QString &label ) 92 * @fn setLabel( const QString &label )
93 * @brief Set label for tab. 93 * @brief Set label for tab.
94 * 94 *
95 * @param label QString text label for OTabWidget selection control. 95 * @param label QString text label for OTabWidget selection control.
96 */ 96 */
97 void setLabel( const QString &label ) { l = label; } 97 void setLabel( const QString &label ) { l = label; }
98 98
99/** 99/**
100 * @fn control()const 100 * @fn control()const
101 * @brief Returns pointer to widget. 101 * @brief Returns pointer to widget.
102 */ 102 */
103 QWidget *control() const { return c; } 103 QWidget *control() const { return c; }
104 104
105/** 105/**
106 * @fn icon()const 106 * @fn icon()const
107 * @brief Returns name of icon file. 107 * @brief Returns name of icon file.
108 */ 108 */
109 const QString &icon() const { return p; } 109 const QString &icon() const { return p; }
110 110
111/** 111/**
112 * @fn setIcon( const QString &icon ) 112 * @fn setIcon( const QString &icon )
113 * @brief Set icon for tab. 113 * @brief Set icon for tab.
114 * 114 *
115 * @param icon QString name of icon file. 115 * @param icon QString name of icon file.
116 */ 116 */
117 void setIcon( const QString &icon ) { p = icon; } 117 void setIcon( const QString &icon ) { p = icon; }
118 118
119private: 119private:
120 int i; 120 int i;
121 QWidget *c; 121 QWidget *c;
122 QString p; 122 QString p;
123 QString l; 123 QString l;
124 class Private;
125 Private *d;
124}; 126};
125 127
126/** 128/**
127 * @class OTabInfoList 129 * @class OTabInfoList
128 * @brief A list of OTabInfo objects used by OTabWidget. 130 * @brief A list of OTabInfo objects used by OTabWidget.
129 */ 131 */
130typedef QList<OTabInfo> OTabInfoList; 132typedef QList<OTabInfo> OTabInfoList;
131 133
132#endif 134#endif
diff --git a/libopie/otabwidget.h b/libopie/otabwidget.h
index a67fe06..c140c0b 100644
--- a/libopie/otabwidget.h
+++ b/libopie/otabwidget.h
@@ -1,276 +1,278 @@
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
40class OTabBar; 40class OTabBar;
41class QComboBox; 41class QComboBox;
42class QPixmap; 42class QPixmap;
43class QTabBar; 43class QTabBar;
44class QWidgetStack; 44class 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 */
61class OTabWidget : public QWidget 61class OTabWidget : public QWidget
62{ 62{
63 Q_OBJECT 63 Q_OBJECT
64public: 64public:
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 // FIXME WFlags? -zecke
103 OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top ); 103 OTabWidget( QWidget * = 0, const char * = 0, TabStyle = Global, TabPosition = Top );
104 104
105/** 105/**
106 * @fn ~OTabWidget() 106 * @fn ~OTabWidget()
107 * @brief Object destructor. 107 * @brief Object destructor.
108 */ 108 */
109 ~OTabWidget(); 109 ~OTabWidget();
110 110
111/** 111/**
112 * @fn addTab( QWidget *child, const QString &icon, const QString &label ) 112 * @fn addTab( QWidget *child, const QString &icon, const QString &label )
113 * @brief Add new widget to control. 113 * @brief Add new widget to control.
114 * 114 *
115 * @param child Widget control. 115 * @param child Widget control.
116 * @param icon Path to icon. 116 * @param icon Path to icon.
117 * @param label Text label. 117 * @param label Text label.
118 */ 118 */
119 void addTab( QWidget *, const QString &, const QString & ); 119 void addTab( QWidget *, const QString &, const QString & );
120 120
121/** 121/**
122 * @fn removePage( QWidget *widget ) 122 * @fn removePage( QWidget *widget )
123 * @brief Remove widget from control. Does not delete widget. 123 * @brief Remove widget from control. Does not delete widget.
124 * 124 *
125 * @param widget Widget control to be removed. 125 * @param widget Widget control to be removed.
126 */ 126 */
127 void removePage( QWidget * ); 127 void removePage( QWidget * );
128 128
129/** 129/**
130 * @fn changeTab( QWidget *widget, const QString &icon, const QString &label ) 130 * @fn changeTab( QWidget *widget, const QString &icon, const QString &label )
131 * @brief Change text and/or icon for existing tab 131 * @brief Change text and/or icon for existing tab
132 * 132 *
133 * @param child Widget control. 133 * @param child Widget control.
134 * @param icon Path to icon. 134 * @param icon Path to icon.
135 * @param label Text label. 135 * @param label Text label.
136 */ 136 */
137 void changeTab( QWidget *, const QString &, const QString & ); 137 void changeTab( QWidget *, const QString &, const QString & );
138 138
139/** 139/**
140 * @fn tabStyle()const 140 * @fn tabStyle()const
141 * @brief Returns current widget selection control style. 141 * @brief Returns current widget selection control style.
142 */ 142 */
143 TabStyle tabStyle() const; 143 TabStyle tabStyle() const;
144 144
145/** 145/**
146 * @fn setTabStyle( TabStyle s ) 146 * @fn setTabStyle( TabStyle s )
147 * @brief Set the current widget selection control style. 147 * @brief Set the current widget selection control style.
148 * 148 *
149 * @param s New style to be used. 149 * @param s New style to be used.
150 */ 150 */
151 void setTabStyle( TabStyle ); 151 void setTabStyle( TabStyle );
152 152
153/** 153/**
154 * @fn tabPosition()const 154 * @fn tabPosition()const
155 * @brief Returns current widget selection control position. 155 * @brief Returns current widget selection control position.
156 */ 156 */
157 TabPosition tabPosition() const; 157 TabPosition tabPosition() const;
158 158
159/** 159/**
160 * @fn setTabPosition( TabPosition p ) 160 * @fn setTabPosition( TabPosition p )
161 * @brief Set the current widget selection control position. 161 * @brief Set the current widget selection control position.
162 * 162 *
163 * @param p New position of widget selection control. 163 * @param p New position of widget selection control.
164 */ 164 */
165 void setTabPosition( TabPosition ); 165 void setTabPosition( TabPosition );
166 166
167/** 167/**
168 * @fn setCurrentTab( QWidget *childwidget ) 168 * @fn setCurrentTab( QWidget *childwidget )
169 * @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.
170 * 170 *
171 * @param childwidget Widget to select. 171 * @param childwidget Widget to select.
172 */ 172 */
173 void setCurrentTab( QWidget * ); 173 void setCurrentTab( QWidget * );
174 174
175/** 175/**
176 * @fn setCurrentTab( const QString &tabname ) 176 * @fn setCurrentTab( const QString &tabname )
177 * @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.
178 * 178 *
179 * @param tabname Text label for widget to select. 179 * @param tabname Text label for widget to select.
180 */ 180 */
181 void setCurrentTab( const QString & ); 181 void setCurrentTab( const QString & );
182 182
183/** 183/**
184 * @fn setCurrentTab( int ) 184 * @fn setCurrentTab( int )
185 * @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.
186 * 186 *
187 * @param tab id for widget to select. 187 * @param tab id for widget to select.
188 */ 188 */
189 void setCurrentTab(int); 189 void setCurrentTab(int);
190 190
191/** 191/**
192 * @fn sizeHint()const 192 * @fn sizeHint()const
193 * @brief Reimplemented for internal purposes. 193 * @brief Reimplemented for internal purposes.
194 */ 194 */
195 QSize sizeHint() const; 195 QSize sizeHint() const;
196 196
197/** 197/**
198 * @fn currentTab( ) 198 * @fn currentTab( )
199 * @brief returns current tab id. 199 * @brief returns current tab id.
200 */ 200 */
201 int currentTab(); 201 int currentTab();
202 202
203 203
204protected: 204protected:
205 205
206/** 206/**
207 * @fn resizeEvent( QResizeEvent * ) 207 * @fn resizeEvent( QResizeEvent * )
208 * @brief Reimplemented for internal purposes. 208 * @brief Reimplemented for internal purposes.
209 */ 209 */
210 void resizeEvent( QResizeEvent * ); 210 void resizeEvent( QResizeEvent * );
211 211
212private: 212private:
213 OTabInfoList tabs; 213 OTabInfoList tabs;
214 OTabInfo *currTab; 214 OTabInfo *currTab;
215 215
216 TabStyle tabBarStyle; 216 TabStyle tabBarStyle;
217 TabPosition tabBarPosition; 217 TabPosition tabBarPosition;
218 218
219 QWidgetStack *tabBarStack; 219 QWidgetStack *tabBarStack;
220 OTabBar *tabBar; 220 OTabBar *tabBar;
221 QComboBox *tabList; 221 QComboBox *tabList;
222 222
223 QWidgetStack *widgetStack; 223 QWidgetStack *widgetStack;
224 class Private;
225 Private* d;
224 226
225/** 227/**
226 * @fn loadSmooth( const QString &name ) 228 * @fn loadSmooth( const QString &name )
227 * @brief Loads icon for widget. 229 * @brief Loads icon for widget.
228 * 230 *
229 * @param name Name of icon image file. 231 * @param name Name of icon image file.
230 */ 232 */
231 QPixmap loadSmooth( const QString & ); 233 QPixmap loadSmooth( const QString & );
232 234
233/** 235/**
234 * @fn selectTab( OTabInfo *tab ) 236 * @fn selectTab( OTabInfo *tab )
235 * @brief Internal function to select desired widget. 237 * @brief Internal function to select desired widget.
236 * 238 *
237 * @param tab Pointer to data for widget. 239 * @param tab Pointer to data for widget.
238 */ 240 */
239 void selectTab( OTabInfo * ); 241 void selectTab( OTabInfo * );
240 242
241/** 243/**
242 * @fn setUpLayout() 244 * @fn setUpLayout()
243 * @brief Internal function to adjust layout. 245 * @brief Internal function to adjust layout.
244 */ 246 */
245 void setUpLayout(); 247 void setUpLayout();
246 248
247 249
248signals: 250signals:
249/** 251/**
250 * @fn currentChanegd( QWidget *widget ) 252 * @fn currentChanegd( QWidget *widget )
251 * @brief This signal is emitted whenever the widget has changed. 253 * @brief This signal is emitted whenever the widget has changed.
252 * 254 *
253 * @param widget Pointer to new current widget. 255 * @param widget Pointer to new current widget.
254 */ 256 */
255 void currentChanged( QWidget * ); 257 void currentChanged( QWidget * );
256 258
257private slots: 259private slots:
258 260
259/** 261/**
260 * @fn slotTabBarSelected( int id ) 262 * @fn slotTabBarSelected( int id )
261 * @brief Slot which is called when a tab is selected. 263 * @brief Slot which is called when a tab is selected.
262 * 264 *
263 * @param id ID of widget selected. 265 * @param id ID of widget selected.
264 */ 266 */
265 void slotTabBarSelected( int ); 267 void slotTabBarSelected( int );
266 268
267/** 269/**
268 * @fn slotTabListSelected( int index ) 270 * @fn slotTabListSelected( int index )
269 * @brief Slot which is called when a drop down selection is made. 271 * @brief Slot which is called when a drop down selection is made.
270 * 272 *
271 * @param id Index of widget selected. 273 * @param id Index of widget selected.
272 */ 274 */
273 void slotTabListSelected( int ); 275 void slotTabListSelected( int );
274}; 276};
275 277
276#endif 278#endif
diff --git a/libopie/oticker.h b/libopie/oticker.h
index c848654..c52e317 100644
--- a/libopie/oticker.h
+++ b/libopie/oticker.h
@@ -1,147 +1,148 @@
1/* 1/*
2                This file is part of the Opie Project 2                This file is part of the Opie Project
3 Copyright (c) 2002 L. Potter <ljp@llornkcor.com> 3 Copyright (c) 2002 L. Potter <ljp@llornkcor.com>
4 =. 4 =.
5 .=l. 5 .=l.
6           .>+-= 6           .>+-=
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 General Public 9:`=1 )Y*s>-.--   : the terms of the GNU 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 OTICKER_H 31#ifndef OTICKER_H
32#define OTICKER_H 32#define OTICKER_H
33 33
34#include <qwidget.h> 34#include <qwidget.h>
35#include <qpainter.h> 35#include <qpainter.h>
36#include <qdrawutil.h> 36#include <qdrawutil.h>
37#include <qpixmap.h> 37#include <qpixmap.h>
38#include <qstring.h> 38#include <qstring.h>
39#include <qslider.h> 39#include <qslider.h>
40#include <qlabel.h> 40#include <qlabel.h>
41#include <qframe.h> 41#include <qframe.h>
42#include <qcolor.h> 42#include <qcolor.h>
43 43
44/** 44/**
45 * @class OTicker 45 * @class OTicker
46 * @brief The OTicker class provides a QLabel widget that scroll its contents 46 * @brief The OTicker class provides a QLabel widget that scroll its contents
47 * 47 *
48 */ 48 */
49class OTicker : public QLabel { 49class OTicker : public QLabel {
50 Q_OBJECT 50 Q_OBJECT
51 51
52public: 52public:
53 53
54/*! 54/*!
55 * @fn OTicker( QWidget* parent = 0 ) 55 * @fn OTicker( QWidget* parent = 0 )
56 * @brief Object constructor. 56 * @brief Object constructor.
57 * 57 *
58 * @param parent Pointer to parent of this control. 58 * @param parent Pointer to parent of this control.
59 59
60 * Constructs a new OTicker control with parent 60 * Constructs a new OTicker control with parent
61 */ 61 */
62 OTicker( QWidget* parent=0 ); 62 OTicker( QWidget* parent=0 );
63/*! 63/*!
64 * @fn ~OTicker() 64 * @fn ~OTicker()
65 * @brief Object destructor. 65 * @brief Object destructor.
66 */ 66 */
67 ~OTicker(); 67 ~OTicker();
68/*! 68/*!
69 * @fn setText(const QString& ) 69 * @fn setText(const QString& )
70 * @brief sets text to be displayed 70 * @brief sets text to be displayed
71 * @param text QString text to be displayed. 71 * @param text QString text to be displayed.
72 * 72 *
73 */ 73 */
74 void setText( const QString& text ) ; 74 void setText( const QString& text ) ;
75/*! 75/*!
76 * @fn setBackgroundColor(QColor color) 76 * @fn setBackgroundColor(QColor color)
77 * @brief sets color of the ticker's background 77 * @brief sets color of the ticker's background
78 * @param color QColor color to be set. 78 * @param color QColor color to be set.
79 * 79 *
80 */ 80 */
81 //FIXME const QColor& please -zecke 81 //FIXME const QColor& please -zecke
82 void setBackgroundColor(QColor color); 82 void setBackgroundColor(QColor color);
83/*! 83/*!
84 * @fn setForegroundColor(QColor color) 84 * @fn setForegroundColor(QColor color)
85 * @brief sets color of text 85 * @brief sets color of text
86 * @param color QColor color of text 86 * @param color QColor color of text
87 * 87 *
88 */ 88 */
89 // FIXME const QColor& please -zecke
89 void setForegroundColor(QColor color); 90 void setForegroundColor(QColor color);
90/*! 91/*!
91 * @fn setFrame(int style) 92 * @fn setFrame(int style)
92 * @brief sets frame style 93 * @brief sets frame style
93 * @param style int Frame style to be see. See Qt::WidgetFlags. 94 * @param style int Frame style to be see. See Qt::WidgetFlags.
94 * 95 *
95 */ 96 */
96 void setFrame(int style); 97 void setFrame(int style);
97/*! 98/*!
98 * @fn setUpdateTime(int timeout) 99 * @fn setUpdateTime(int timeout)
99 * @brief sets time of update 100 * @brief sets time of update
100 * @param timeout int time in milliseconds between updates. 101 * @param timeout int time in milliseconds between updates.
101 * 102 *
102 */ 103 */
103 void setUpdateTime(int timeout); 104 void setUpdateTime(int timeout);
104/*! 105/*!
105 * @fn setScrollLength(int length) 106 * @fn setScrollLength(int length)
106 * @brief sets amount of scrolling default is 1 107 * @brief sets amount of scrolling default is 1
107 * @param length int scroll length. 108 * @param length int scroll length.
108 * 109 *
109 */ 110 */
110 void setScrollLength(int length); 111 void setScrollLength(int length);
111signals: 112signals:
112/*! 113/*!
113 * @fn mousePressed() 114 * @fn mousePressed()
114 * @brief signal mouse press event 115 * @brief signal mouse press event
115 * 116 *
116 */ 117 */
117 void mousePressed(); 118 void mousePressed();
118protected: 119protected:
119/*! 120/*!
120 * @fn timerEvent( QTimerEvent * e) 121 * @fn timerEvent( QTimerEvent * e)
121 * @brief timer timeout event 122 * @brief timer timeout event
122 * @param e QEvent see QEvent. 123 * @param e QEvent see QEvent.
123 * 124 *
124 */ 125 */
125 void timerEvent( QTimerEvent * e); 126 void timerEvent( QTimerEvent * e);
126/*! 127/*!
127 * @fn drawContents( QPainter *p ) 128 * @fn drawContents( QPainter *p )
128 * @brief draws widget contents 129 * @brief draws widget contents
129 * @param p QPainter. see QPainter 130 * @param p QPainter. see QPainter
130 * 131 *
131 */ 132 */
132 void drawContents( QPainter *p ); 133 void drawContents( QPainter *p );
133/*! 134/*!
134 * @fn mouseReleaseEvent( QMouseEvent *e) 135 * @fn mouseReleaseEvent( QMouseEvent *e)
135 * @brief mouse release event 136 * @brief mouse release event
136 * @param e QMouseEvent. see QMouseEvent. 137 * @param e QMouseEvent. see QMouseEvent.
137 * 138 *
138 */ 139 */
139 void mouseReleaseEvent( QMouseEvent *e); 140 void mouseReleaseEvent( QMouseEvent *e);
140private: 141private:
141 QColor backgroundcolor, foregroundcolor; 142 QColor backgroundcolor, foregroundcolor;
142 QString scrollText; 143 QString scrollText;
143 QPixmap scrollTextPixmap; 144 QPixmap scrollTextPixmap;
144 int pos, updateTimerTime, scrollLength; 145 int pos, updateTimerTime, scrollLength;
145}; 146};
146 147
147#endif 148#endif
diff --git a/libopie/otimepicker.h b/libopie/otimepicker.h
index d501a95..6a9e040 100644
--- a/libopie/otimepicker.h
+++ b/libopie/otimepicker.h
@@ -1,81 +1,83 @@
1#ifndef OTIMEPICKER_H 1#ifndef OTIMEPICKER_H
2#define OTIMEPICKER_H 2#define OTIMEPICKER_H
3 3
4#include <qwidget.h> 4#include <qwidget.h>
5#include <qvaluelist.h> 5#include <qvaluelist.h>
6#include <qdatetime.h> 6#include <qdatetime.h>
7#include <qdialog.h> 7#include <qdialog.h>
8 8
9#include <opie/oclickablelabel.h> 9#include <opie/oclickablelabel.h>
10#include "otimepickerbase.h" 10#include "otimepickerbase.h"
11 11
12/** 12/**
13 * A class to pick time. It uses clickable labels 13 * A class to pick time. It uses clickable labels
14 * internally to allow a quick selection of a time. 14 * internally to allow a quick selection of a time.
15 * A time can be selected by two clicks of a user 15 * A time can be selected by two clicks of a user
16 * 16 *
17 * @short A widget to quickly pick a QTime 17 * @short A widget to quickly pick a QTime
18 * @version 1.0 18 * @version 1.0
19 * @see QWidget 19 * @see QWidget
20 * @see QTime 20 * @see QTime
21 * @author Hakan Ardo, Stefan Eilers 21 * @author Hakan Ardo, Stefan Eilers
22 */ 22 */
23class OTimePicker: public QWidget { 23class OTimePicker: public QWidget {
24 Q_OBJECT 24 Q_OBJECT
25 25
26 public: 26 public:
27 OTimePicker(QWidget* parent = 0, const char* name = 0, 27 OTimePicker(QWidget* parent = 0, const char* name = 0,
28 WFlags fl = 0); 28 WFlags fl = 0);
29 29
30 public slots: 30 public slots:
31 void setHour(int h); 31 void setHour(int h);
32 void setMinute(int m); 32 void setMinute(int m);
33 void setTime( const QTime& ); 33 void setTime( const QTime& );
34 void setTime( int h, int m ); 34 void setTime( int h, int m );
35 35
36 public: 36 public:
37 QTime time()const; 37 QTime time()const;
38 38
39 private: 39 private:
40 QValueList<OClickableLabel *> hourLst; 40 QValueList<OClickableLabel *> hourLst;
41 QValueList<OClickableLabel *> minuteLst; 41 QValueList<OClickableLabel *> minuteLst;
42 QTime tm; 42 QTime tm;
43 struct Private; 43 struct Private;
44 Private *d; 44 Private *d;
45 45
46 private slots: 46 private slots:
47 void slotHour(bool b); 47 void slotHour(bool b);
48 void slotMinute(bool b); 48 void slotMinute(bool b);
49 49
50 signals: 50 signals:
51 /** 51 /**
52 * gets emitted when the time got changed by the user 52 * gets emitted when the time got changed by the user
53 */ 53 */
54 void timeChanged(const QTime &); 54 void timeChanged(const QTime &);
55}; 55};
56 56
57/** 57/**
58 * 58 *
59 * @short A small dialog to pick a time 59 * @short A small dialog to pick a time
60 * @version 1.0 60 * @version 1.0
61 * @author Stefan Eilers 61 * @author Stefan Eilers
62 */ 62 */
63 63
64class OTimePickerDialog: public OTimePickerDialogBase { 64class OTimePickerDialog: public OTimePickerDialogBase {
65 Q_OBJECT 65 Q_OBJECT
66 66
67 public: 67 public:
68 OTimePickerDialog ( QWidget* parent = 0, const char* name = NULL, WFlags fl = 0 ); 68 OTimePickerDialog ( QWidget* parent = 0, const char* name = NULL, WFlags fl = 0 );
69 ~OTimePickerDialog() { }; 69 ~OTimePickerDialog() { };
70 70
71 QTime time()const; 71 QTime time()const;
72 72
73 public slots: 73 public slots:
74 void setTime( const QTime& time ); 74 void setTime( const QTime& time );
75 void setHour( const QString& hour ); 75 void setHour( const QString& hour );
76 void setMinute( const QString& minute ); 76 void setMinute( const QString& minute );
77 77
78 private: 78 private:
79 QTime m_time; 79 QTime m_time;
80 class Private;
81 Private* d;
80}; 82};
81#endif 83#endif
diff --git a/libopie/owait.h b/libopie/owait.h
index 6217e31..cbfc8d6 100644
--- a/libopie/owait.h
+++ b/libopie/owait.h
@@ -1,74 +1,77 @@
1/* This file is part of the OPIE libraries 1/* This file is part of the OPIE libraries
2 Copyright (C) 2003 Maximilian Reiss (harlekin@handhelds.org) 2 Copyright (C) 2003 Maximilian Reiss (harlekin@handhelds.org)
3 3
4 This library is free software; you can redistribute it and/or 4 This library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public 5 modify it under the terms of the GNU Library General Public
6 License as published by the Free Software Foundation; either 6 License as published by the Free Software Foundation; either
7 version 2 of the License, or (at your option) any later version. 7 version 2 of the License, or (at your option) any later version.
8 8
9 This library is distributed in the hope that it will be useful, 9 This library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of 10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Library General Public License for more details. 12 Library General Public License for more details.
13 13
14 You should have received a copy of the GNU Library General Public License 14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to 15 along with this library; see the file COPYING.LIB. If not, write to
16 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 16 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 Boston, MA 02111-1307, USA. 17 Boston, MA 02111-1307, USA.
18*/ 18*/
19 19
20 20
21 21
22#ifndef WAITPOPUP_H 22#ifndef WAITPOPUP_H
23#define WAITPOPUP_H 23#define WAITPOPUP_H
24 24
25#include <qdialog.h> 25#include <qdialog.h>
26#include <qpixmap.h> 26#include <qpixmap.h>
27#include <qlabel.h> 27#include <qlabel.h>
28#include <qtimer.h> 28#include <qtimer.h>
29 29
30/** 30/**
31 * This class displays a animated waiting icon in the middle of the screen. 31 * This class displays a animated waiting icon in the middle of the screen.
32 * 32 *
33 * @short modal hour glass dialog 33 * @short modal hour glass dialog
34 * @see QDialog 34 * @see QDialog
35 * @author Maximilian Reiß 35 * @author Maximilian Reiß
36 */ 36 */
37class OWait : public QDialog { 37class OWait : public QDialog {
38 38
39 Q_OBJECT 39 Q_OBJECT
40 40
41public: 41public:
42 // FIXME Wflags -zecke?
42 OWait(QWidget *parent=0,const char* name=0, bool dispIcon=TRUE); 43 OWait(QWidget *parent=0,const char* name=0, bool dispIcon=TRUE);
43 ~OWait(); 44 ~OWait();
44 45
45 /** 46 /**
46 * reimplemented for control reasons 47 * reimplemented for control reasons
47 */ 48 */
48 void show(); 49 void show();
49 50
50 /** 51 /**
51 * Set the time before the icon will be automaticly hidden 52 * Set the time before the icon will be automaticly hidden
52 * The timer will be started once the widget will be shown. 53 * The timer will be started once the widget will be shown.
53 * @param length - time in seconds 54 * @param length - time in seconds
54 */ 55 */
55 void setTimerLength( int length ); 56 void setTimerLength( int length );
56 57
57 public slots: 58 public slots:
58 /** 59 /**
59 * reimplemented for control reasons 60 * reimplemented for control reasons
60 */ 61 */
61 void hide(); 62 void hide();
62 63
63 private: 64 private:
64 void timerEvent( QTimerEvent * ) ; 65 void timerEvent( QTimerEvent * ) ;
65 void paintEvent( QPaintEvent * ); 66 void paintEvent( QPaintEvent * );
66 67
67 QPixmap m_pix; 68 QPixmap m_pix;
68 QLabel *m_lb; 69 QLabel *m_lb;
69 QTimer *m_waitTimer; 70 QTimer *m_waitTimer;
70 int m_timerLength; 71 int m_timerLength;
71 int m_aniSize; 72 int m_aniSize;
73 class Private;
74 Private *d;
72}; 75};
73 76
74#endif 77#endif
diff --git a/libopie/pim/otodoaccess.h b/libopie/pim/otodoaccess.h
index 2bb87dc..a626731 100644
--- a/libopie/pim/otodoaccess.h
+++ b/libopie/pim/otodoaccess.h
@@ -1,87 +1,90 @@
1#ifndef OPIE_TODO_ACCESS_H 1#ifndef OPIE_TODO_ACCESS_H
2#define OPIE_TODO_ACCESS_H 2#define OPIE_TODO_ACCESS_H
3 3
4#include <qobject.h> 4#include <qobject.h>
5#include <qvaluelist.h> 5#include <qvaluelist.h>
6 6
7#include "otodo.h" 7#include "otodo.h"
8#include "otodoaccessbackend.h" 8#include "otodoaccessbackend.h"
9#include "opimaccesstemplate.h" 9#include "opimaccesstemplate.h"
10 10
11 11
12/** 12/**
13 * OTodoAccess 13 * OTodoAccess
14 * the class to get access to 14 * the class to get access to
15 * the todolist 15 * the todolist
16 */ 16 */
17class OTodoAccess : public QObject, public OPimAccessTemplate<OTodo> { 17class OTodoAccess : public QObject, public OPimAccessTemplate<OTodo> {
18 Q_OBJECT 18 Q_OBJECT
19public: 19public:
20 enum SortOrder { Completed = 0, 20 enum SortOrder { Completed = 0,
21 Priority, 21 Priority,
22 Description, 22 Description,
23 Deadline }; 23 Deadline };
24 enum SortFilter{ Category =1, 24 enum SortFilter{ Category =1,
25 OnlyOverDue= 2, 25 OnlyOverDue= 2,
26 DoNotShowCompleted =4 }; 26 DoNotShowCompleted =4 };
27 /** 27 /**
28 * if you use 0l 28 * if you use 0l
29 * the default resource will be 29 * the default resource will be
30 * picked up 30 * picked up
31 */ 31 */
32 OTodoAccess( OTodoAccessBackend* = 0l, enum Access acc = Random ); 32 OTodoAccess( OTodoAccessBackend* = 0l, enum Access acc = Random );
33 ~OTodoAccess(); 33 ~OTodoAccess();
34 34
35 35
36 /* our functions here */ 36 /* our functions here */
37 /** 37 /**
38 * include todos from start to end 38 * include todos from start to end
39 * includeNoDates whether or not to include 39 * includeNoDates whether or not to include
40 * events with no dates 40 * events with no dates
41 */ 41 */
42 List effectiveToDos( const QDate& start, 42 List effectiveToDos( const QDate& start,
43 const QDate& end, 43 const QDate& end,
44 bool includeNoDates = true ); 44 bool includeNoDates = true );
45 45
46 /** 46 /**
47 * start 47 * start
48 * end date taken from the currentDate() 48 * end date taken from the currentDate()
49 */ 49 */
50 List effectiveToDos( const QDate& start, 50 List effectiveToDos( const QDate& start,
51 bool includeNoDates = true ); 51 bool includeNoDates = true );
52 52
53 53
54 /** 54 /**
55 * return overdue OTodos 55 * return overdue OTodos
56 */ 56 */
57 List overDue(); 57 List overDue();
58 58
59 /** 59 /**
60 * 60 *
61 */ 61 */
62 List sorted( bool ascending, int sortOrder, int sortFilter, int cat ); 62 List sorted( bool ascending, int sortOrder, int sortFilter, int cat );
63 63
64 /** 64 /**
65 * merge a list of OTodos into 65 * merge a list of OTodos into
66 * the resource 66 * the resource
67 */ 67 */
68 void mergeWith( const QValueList<OTodo>& ); 68 void mergeWith( const QValueList<OTodo>& );
69 69
70 /** 70 /**
71 * delete all already completed items 71 * delete all already completed items
72 */ 72 */
73 void removeAllCompleted(); 73 void removeAllCompleted();
74 74
75signals: 75signals:
76 /** 76 /**
77 * if the OTodoAccess was changed 77 * if the OTodoAccess was changed
78 */ 78 */
79 void signalChanged( const OTodoAccess* ); 79 void changed( const OTodoAccess* );
80 void changed( const OTodoAccess*, int uid );
81 void added( const OTodoAccess*, int uid );
82 void removed( const OTodoAccess*, int uid );
80private: 83private:
81 int m_cat; 84 int m_cat;
82 OTodoAccessBackend* m_todoBackEnd; 85 OTodoAccessBackend* m_todoBackEnd;
83 class OTodoAccessPrivate; 86 class OTodoAccessPrivate;
84 OTodoAccessPrivate* d; 87 OTodoAccessPrivate* d;
85}; 88};
86 89
87#endif 90#endif
diff --git a/libopie/xmltree.h b/libopie/xmltree.h
index 4a6b6d9..4b6bdfa 100644
--- a/libopie/xmltree.h
+++ b/libopie/xmltree.h
@@ -1,117 +1,119 @@
1/* This file is part of the KDE project 1/* This file is part of the KDE project
2 Copyright (C) 2000,2001 Simon Hausmann <hausmann@kde.org> 2 Copyright (C) 2000,2001 Simon Hausmann <hausmann@kde.org>
3 3
4 This library is free software; you can redistribute it and/or 4 This library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Library General Public 5 modify it under the terms of the GNU Library General Public
6 License as published by the Free Software Foundation; either 6 License as published by the Free Software Foundation; either
7 version 2 of the License, or (at your option) any later version. 7 version 2 of the License, or (at your option) any later version.
8 8
9 This library is distributed in the hope that it will be useful, 9 This library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of 10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Library General Public License for more details. 12 Library General Public License for more details.
13 13
14 You should have received a copy of the GNU Library General Public License 14 You should have received a copy of the GNU Library General Public License
15 along with this library; see the file COPYING.LIB. If not, write to 15 along with this library; see the file COPYING.LIB. If not, write to
16 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 16 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 Boston, MA 02111-1307, USA. 17 Boston, MA 02111-1307, USA.
18*/ 18*/
19 19
20 20
21#ifndef __bookmarks_h__ 21#ifndef __bookmarks_h__
22#define __bookmarks_h__ 22#define __bookmarks_h__
23 23
24#include <qstring.h> 24#include <qstring.h>
25#include <qmap.h> 25#include <qmap.h>
26#include <qtextstream.h> 26#include <qtextstream.h>
27 27
28namespace Opie 28namespace Opie
29{ 29{
30 30
31/** 31/**
32 * A small xml lib written by Simon Hausmann. 32 * A small xml lib written by Simon Hausmann.
33 */ 33 */
34class XMLElement 34class XMLElement
35{ 35{
36public: 36public:
37 typedef QMap<QString, QString> AttributeMap; 37 typedef QMap<QString, QString> AttributeMap;
38 38
39 /** 39 /**
40 * The constructor of XMLElement 40 * The constructor of XMLElement
41 */ 41 */
42 XMLElement(); 42 XMLElement();
43 ~XMLElement(); 43 ~XMLElement();
44 44
45 /** appendChild appends a child to the XMLElement behind the last element. 45 /** appendChild appends a child to the XMLElement behind the last element.
46 * The ownership of the child get's transfered to the 46 * The ownership of the child get's transfered to the
47 * this XMLElement. 47 * this XMLElement.
48 * If child is already the child of another parent 48 * If child is already the child of another parent
49 * it's get removed from the other parent first. 49 * it's get removed from the other parent first.
50 */ 50 */
51 void appendChild( XMLElement *child ); 51 void appendChild( XMLElement *child );
52 52
53 /** inserts newChild after refChild. If newChild is the child 53 /** inserts newChild after refChild. If newChild is the child
54 * of another parent the child will get removed. 54 * of another parent the child will get removed.
55 * The ownership of child gets transfered. 55 * The ownership of child gets transfered.
56 * 56 *
57 */ 57 */
58 void insertAfter( XMLElement *newChild, XMLElement *refChild ); 58 void insertAfter( XMLElement *newChild, XMLElement *refChild );
59 59
60 /** same as insertAfter but the element get's inserted before refChild. 60 /** same as insertAfter but the element get's inserted before refChild.
61 * 61 *
62 */ 62 */
63 void insertBefore( XMLElement *newChild, XMLElement *refChild ); 63 void insertBefore( XMLElement *newChild, XMLElement *refChild );
64 64
65 /** removeChild removes the child from the XMLElement. 65 /** removeChild removes the child from the XMLElement.
66 * The ownership gets dropped. You need to delete the 66 * The ownership gets dropped. You need to delete the
67 * child yourself. 67 * child yourself.
68 */ 68 */
69 void removeChild( XMLElement *child ); 69 void removeChild( XMLElement *child );
70 70
71 /** parent() returns the parent of this XMLElement 71 /** parent() returns the parent of this XMLElement
72 * If there is no parent 0l gets returned 72 * If there is no parent 0l gets returned
73 */ 73 */
74 XMLElement *parent() const { return m_parent; } 74 XMLElement *parent() const { return m_parent; }
75 XMLElement *firstChild() const { return m_first; } 75 XMLElement *firstChild() const { return m_first; }
76 XMLElement *nextChild() const { return m_next; } 76 XMLElement *nextChild() const { return m_next; }
77 XMLElement *prevChild() const { return m_prev; } 77 XMLElement *prevChild() const { return m_prev; }
78 XMLElement *lastChild() const { return m_last; } 78 XMLElement *lastChild() const { return m_last; }
79 79
80 void setTagName( const QString &tag ) { m_tag = tag; } 80 void setTagName( const QString &tag ) { m_tag = tag; }
81 QString tagName() const { return m_tag; } 81 QString tagName() const { return m_tag; }
82 82
83 void setValue( const QString &val ) { m_value = val; } 83 void setValue( const QString &val ) { m_value = val; }
84 QString value() const { return m_value; } 84 QString value() const { return m_value; }
85 85
86 void setAttributes( const AttributeMap &attrs ) { m_attributes = attrs; } 86 void setAttributes( const AttributeMap &attrs ) { m_attributes = attrs; }
87 AttributeMap attributes() const { return m_attributes; } 87 AttributeMap attributes() const { return m_attributes; }
88 AttributeMap &attributes() { return m_attributes; } 88 AttributeMap &attributes() { return m_attributes; }
89 89
90 QString attribute( const QString & ) const; 90 QString attribute( const QString & ) const;
91 void setAttribute( const QString &attr, const QString &value ); 91 void setAttribute( const QString &attr, const QString &value );
92 void save( QTextStream &stream, uint indent = 0 ); 92 void save( QTextStream &stream, uint indent = 0 );
93 93
94 XMLElement *namedItem( const QString &name ); 94 XMLElement *namedItem( const QString &name );
95 95
96 XMLElement *clone() const; 96 XMLElement *clone() const;
97 97
98 static XMLElement *load( const QString &fileName ); 98 static XMLElement *load( const QString &fileName );
99 99
100private: 100private:
101 QString m_tag; 101 QString m_tag;
102 QString m_value; 102 QString m_value;
103 AttributeMap m_attributes; 103 AttributeMap m_attributes;
104 104
105 XMLElement *m_parent; 105 XMLElement *m_parent;
106 XMLElement *m_next; 106 XMLElement *m_next;
107 XMLElement *m_prev; 107 XMLElement *m_prev;
108 XMLElement *m_first; 108 XMLElement *m_first;
109 XMLElement *m_last; 109 XMLElement *m_last;
110 110
111 XMLElement( const XMLElement &rhs ); 111 XMLElement( const XMLElement &rhs );
112 XMLElement &operator=( const XMLElement &rhs ); 112 XMLElement &operator=( const XMLElement &rhs );
113 class Private;
114 Private* d;
113}; 115};
114 116
115} // namespace Opie 117} // namespace Opie
116 118
117#endif 119#endif