1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- q3wizard.cpp -->
<title>Qt 4.8: Q3Wizard Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="content">
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
</div>
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li>Qt3SupportLight</li>
<li>Q3Wizard</li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#protected-slots">Protected Slots</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Q3Wizard Class Reference</h1>
<!-- $$$Q3Wizard-brief -->
<p>The Q3Wizard class provides a framework for wizard dialogs. <a href="#details">More...</a></p>
<!-- @@@Q3Wizard -->
<pre class="cpp"> <span class="preprocessor">#include <Q3Wizard></span></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See <a href="porting4.html#qwizard">Porting to Qt 4</a> for more information.</p>
<p><b>Inherits: </b><a href="qdialog.html">QDialog</a>.</p>
<ul>
<li><a href="q3wizard-members.html">List of all members, including inherited members</a></li>
<li><a href="q3wizard-obsolete.html">Obsolete members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><a href="q3wizard.html#titleFont-prop">titleFont</a></b> : QFont</li>
</ul>
<ul>
<li class="fn">2 properties inherited from <a href="qdialog.html#properties">QDialog</a></li>
<li class="fn">58 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#Q3Wizard">Q3Wizard</a></b> ( QWidget * <i>parent</i> = 0, const char * <i>name</i> = 0, bool <i>modal</i> = false, Qt::WindowFlags <i>f</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#dtor.Q3Wizard">~Q3Wizard</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#addPage">addPage</a></b> ( QWidget * <i>page</i>, const QString & <i>title</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#appropriate">appropriate</a></b> ( QWidget * <i>page</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPushButton * </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#backButton">backButton</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPushButton * </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#cancelButton">cancelButton</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWidget * </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#currentPage">currentPage</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPushButton * </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#finishButton">finishButton</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPushButton * </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#helpButton">helpButton</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#indexOf">indexOf</a></b> ( QWidget * <i>page</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#insertPage">insertPage</a></b> ( QWidget * <i>page</i>, const QString & <i>title</i>, int <i>index</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPushButton * </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#nextButton">nextButton</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWidget * </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#page">page</a></b> ( int <i>index</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#pageCount">pageCount</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#removePage">removePage</a></b> ( QWidget * <i>page</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#setAppropriate">setAppropriate</a></b> ( QWidget * <i>page</i>, bool <i>appropriate</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#setTitle">setTitle</a></b> ( QWidget * <i>page</i>, const QString & <i>title</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#titleFont-prop">setTitleFont</a></b> ( const QFont & )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#showPage">showPage</a></b> ( QWidget * <i>page</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#title">title</a></b> ( QWidget * <i>page</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QFont </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#titleFont-prop">titleFont</a></b> () const</td></tr>
</table>
<a name="reimplemented-public-functions"></a>
<h2>Reimplemented Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#eventFilter">eventFilter</a></b> ( QObject * <i>o</i>, QEvent * <i>e</i> )</td></tr>
</table>
<ul>
<li class="fn">8 public functions inherited from <a href="qdialog.html#public-functions">QDialog</a></li>
<li class="fn">221 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
<li class="fn">13 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>
</ul>
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#setBackEnabled">setBackEnabled</a></b> ( QWidget * <i>page</i>, bool <i>enable</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#setFinishEnabled">setFinishEnabled</a></b> ( QWidget * <i>page</i>, bool <i>enable</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#setHelpEnabled">setHelpEnabled</a></b> ( QWidget * <i>page</i>, bool <i>enable</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#setNextEnabled">setNextEnabled</a></b> ( QWidget * <i>page</i>, bool <i>enable</i> )</td></tr>
</table>
<ul>
<li class="fn">5 public slots inherited from <a href="qdialog.html#public-slots">QDialog</a></li>
<li class="fn">19 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#helpClicked">helpClicked</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#selected">selected</a></b> ( const QString & <i>title</i> )</td></tr>
</table>
<ul>
<li class="fn">3 signals inherited from <a href="qdialog.html#signals">QDialog</a></li>
<li class="fn">1 signal inherited from <a href="qwidget.html#signals">QWidget</a></li>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#layOutButtonRow">layOutButtonRow</a></b> ( QHBoxLayout * <i>layout</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#layOutTitleRow">layOutTitleRow</a></b> ( QHBoxLayout * <i>layout</i>, const QString & <i>title</i> )</td></tr>
</table>
<ul>
<li class="fn">7 protected functions inherited from <a href="qdialog.html#protected-functions">QDialog</a></li>
<li class="fn">37 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
<li class="fn">1 protected function inherited from <a href="qpaintdevice.html#protected-functions">QPaintDevice</a></li>
</ul>
<a name="protected-slots"></a>
<h2>Protected Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#back">back</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#help">help</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3wizard.html#next">next</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">1 protected slot inherited from <a href="qwidget.html#protected-slots">QWidget</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">4 static public members inherited from <a href="qwidget.html#static-public-members">QWidget</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$Q3Wizard-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3Wizard class provides a framework for wizard dialogs.</p>
<p>A wizard is a special type of input dialog that consists of a sequence of dialog pages. A wizard's purpose is to walk the user through a process step by step. Wizards are useful for complex or infrequently occurring tasks that people may find difficult to learn or do.</p>
<p>Q3Wizard provides page titles and displays Next, Back, Finish, Cancel, and Help push buttons, as appropriate to the current position in the page sequence. These buttons can be enabled/disabled using <a href="q3wizard.html#setBackEnabled">setBackEnabled</a>(), <a href="q3wizard.html#setNextEnabled">setNextEnabled</a>(), <a href="q3wizard.html#setFinishEnabled">setFinishEnabled</a>() and <a href="q3wizard.html#setHelpEnabled">setHelpEnabled</a>().</p>
<p>Create and populate dialog pages that inherit from <a href="qwidget.html">QWidget</a> and add them to the wizard using <a href="q3wizard.html#addPage">addPage</a>(). Use <a href="q3wizard.html#insertPage">insertPage</a>() to add a dialog page at a certain position in the page sequence. Use <a href="q3wizard.html#removePage">removePage</a>() to remove a page from the page sequence.</p>
<p>Use <a href="q3wizard.html#currentPage">currentPage</a>() to retrieve a pointer to the currently displayed page. <a href="q3wizard.html#page">page</a>() returns a pointer to the page at a certain position in the page sequence.</p>
<p>Use <a href="q3wizard.html#pageCount">pageCount</a>() to retrieve the total number of pages in the page sequence. <a href="q3wizard.html#indexOf">indexOf</a>() will return the index of a page in the page sequence.</p>
<p>Q3Wizard provides functionality to mark pages as appropriate (or not) in the current context with <a href="q3wizard.html#setAppropriate">setAppropriate</a>(). The idea is that a page may be irrelevant and should be skipped depending on the data entered by the user on a preceding page.</p>
<p>It is generally considered good design to provide a greater number of simple pages with fewer choices rather than a smaller number of complex pages.</p>
</div>
<!-- @@@Q3Wizard -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$titleFont-prop$$$titleFont$$$setTitleFontconstQFont& -->
<h3 class="fn"><a name="titleFont-prop"></a><span class="name">titleFont</span> : <span class="type"><a href="qfont.html">QFont</a></span></h3>
<p>This property holds the font used for page titles.</p>
<p>The default is <a href="qapplication.html#font">QApplication::font</a>().</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QFont </td><td class="memItemRight bottomAlign"><span class="name"><b>titleFont</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setTitleFont</b></span> ( const QFont & )</td></tr>
</table>
<!-- @@@titleFont -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3Wizard[overload1]$$$Q3WizardQWidget*constchar*boolQt::WindowFlags -->
<h3 class="fn"><a name="Q3Wizard"></a>Q3Wizard::<span class="name">Q3Wizard</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>parent</i> = 0, const <span class="type">char</span> * <i>name</i> = 0, <span class="type">bool</span> <i>modal</i> = false, <span class="type"><a href="qt.html#WindowType-enum">Qt::WindowFlags</a></span> <i>f</i> = 0 )</h3>
<p>Constructs an empty wizard dialog. The <i>parent</i>, <i>name</i>, <i>modal</i> and <i>f</i> arguments are passed to the <a href="qdialog.html">QDialog</a> constructor.</p>
<!-- @@@Q3Wizard -->
<!-- $$$~Q3Wizard[overload1]$$$~Q3Wizard -->
<h3 class="fn"><a name="dtor.Q3Wizard"></a>Q3Wizard::<span class="name">~Q3Wizard</span> ()</h3>
<p>Destroys the object and frees any allocated resources, including all pages and controllers.</p>
<!-- @@@~Q3Wizard -->
<!-- $$$addPage[overload1]$$$addPageQWidget*constQString& -->
<h3 class="fn"><a name="addPage"></a><span class="type">void</span> Q3Wizard::<span class="name">addPage</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>title</i> )<tt> [virtual]</tt></h3>
<p>Adds <i>page</i> to the end of the page sequence, with the title, <i>title</i>.</p>
<!-- @@@addPage -->
<!-- $$$appropriate[overload1]$$$appropriateQWidget* -->
<h3 class="fn"><a name="appropriate"></a><span class="type">bool</span> Q3Wizard::<span class="name">appropriate</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i> ) const<tt> [virtual]</tt></h3>
<p>Called when the Next button is clicked; this virtual function returns true if <i>page</i> is relevant for display in the current context; otherwise it is ignored by <a href="q3wizard.html" class="compat">Q3Wizard</a> and returns false. The default implementation returns the value set using <a href="q3wizard.html#setAppropriate">setAppropriate</a>(). The ultimate default is true.</p>
<p><b>Warning:</b> The last page of the wizard will be displayed if no page is relevant in the current context.</p>
<p><b>See also </b><a href="q3wizard.html#setAppropriate">setAppropriate</a>().</p>
<!-- @@@appropriate -->
<!-- $$$back[overload1]$$$back -->
<h3 class="fn"><a name="back"></a><span class="type">void</span> Q3Wizard::<span class="name">back</span> ()<tt> [virtual protected slot]</tt></h3>
<p>Called when the user clicks the Back button; this function shows the preceding relevant page in the sequence.</p>
<p><b>See also </b><a href="q3wizard.html#appropriate">appropriate</a>().</p>
<!-- @@@back -->
<!-- $$$backButton[overload1]$$$backButton -->
<h3 class="fn"><a name="backButton"></a><span class="type"><a href="qpushbutton.html">QPushButton</a></span> * Q3Wizard::<span class="name">backButton</span> () const</h3>
<p>Returns a pointer to the dialog's Back button</p>
<p>By default, this button is connected to the <a href="q3wizard.html#back">back</a>() slot, which is virtual so you can reimplement it in a <a href="q3wizard.html" class="compat">Q3Wizard</a> subclass. Use <a href="q3wizard.html#setBackEnabled">setBackEnabled</a>() to enable/disable this button.</p>
<!-- @@@backButton -->
<!-- $$$cancelButton[overload1]$$$cancelButton -->
<h3 class="fn"><a name="cancelButton"></a><span class="type"><a href="qpushbutton.html">QPushButton</a></span> * Q3Wizard::<span class="name">cancelButton</span> () const</h3>
<p>Returns a pointer to the dialog's Cancel button</p>
<p>By default, this button is connected to the <a href="qdialog.html#reject">QDialog::reject</a>() slot, which is virtual so you can reimplement it in a <a href="q3wizard.html" class="compat">Q3Wizard</a> subclass.</p>
<!-- @@@cancelButton -->
<!-- $$$currentPage[overload1]$$$currentPage -->
<h3 class="fn"><a name="currentPage"></a><span class="type"><a href="qwidget.html">QWidget</a></span> * Q3Wizard::<span class="name">currentPage</span> () const</h3>
<p>Returns a pointer to the current page in the sequence. Although the wizard does its best to make sure that this value is never 0, it can be if you try hard enough.</p>
<!-- @@@currentPage -->
<!-- $$$eventFilter[overload1]$$$eventFilterQObject*QEvent* -->
<h3 class="fn"><a name="eventFilter"></a><span class="type">bool</span> Q3Wizard::<span class="name">eventFilter</span> ( <span class="type"><a href="qobject.html">QObject</a></span> * <i>o</i>, <span class="type"><a href="qevent.html">QEvent</a></span> * <i>e</i> )<tt> [virtual]</tt></h3>
<p>Reimplemented from <a href="qobject.html#eventFilter">QObject::eventFilter</a>().</p>
<!-- @@@eventFilter -->
<!-- $$$finishButton[overload1]$$$finishButton -->
<h3 class="fn"><a name="finishButton"></a><span class="type"><a href="qpushbutton.html">QPushButton</a></span> * Q3Wizard::<span class="name">finishButton</span> () const</h3>
<p>Returns a pointer to the dialog's Finish button</p>
<p>By default, this button is connected to the <a href="qdialog.html#accept">QDialog::accept</a>() slot, which is virtual so you can reimplement it in a <a href="q3wizard.html" class="compat">Q3Wizard</a> subclass. Use <a href="q3wizard.html#setFinishEnabled">setFinishEnabled</a>() to enable/disable this button.</p>
<!-- @@@finishButton -->
<!-- $$$help[overload1]$$$help -->
<h3 class="fn"><a name="help"></a><span class="type">void</span> Q3Wizard::<span class="name">help</span> ()<tt> [virtual protected slot]</tt></h3>
<p>Called when the user clicks the Help button, this function emits the <a href="q3wizard.html#helpClicked">helpClicked</a>() signal.</p>
<!-- @@@help -->
<!-- $$$helpButton[overload1]$$$helpButton -->
<h3 class="fn"><a name="helpButton"></a><span class="type"><a href="qpushbutton.html">QPushButton</a></span> * Q3Wizard::<span class="name">helpButton</span> () const</h3>
<p>Returns a pointer to the dialog's Help button</p>
<p>By default, this button is connected to the <a href="q3wizard.html#help">help</a>() slot, which is virtual so you can reimplement it in a <a href="q3wizard.html" class="compat">Q3Wizard</a> subclass. Use <a href="q3wizard.html#setHelpEnabled">setHelpEnabled</a>() to enable/disable this button.</p>
<!-- @@@helpButton -->
<!-- $$$helpClicked[overload1]$$$helpClicked -->
<h3 class="fn"><a name="helpClicked"></a><span class="type">void</span> Q3Wizard::<span class="name">helpClicked</span> ()<tt> [signal]</tt></h3>
<p>This signal is emitted when the user clicks on the Help button.</p>
<!-- @@@helpClicked -->
<!-- $$$indexOf[overload1]$$$indexOfQWidget* -->
<h3 class="fn"><a name="indexOf"></a><span class="type">int</span> Q3Wizard::<span class="name">indexOf</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i> ) const</h3>
<p>Returns the position of page <i>page</i>. If the page is not part of the wizard -1 is returned.</p>
<!-- @@@indexOf -->
<!-- $$$insertPage[overload1]$$$insertPageQWidget*constQString&int -->
<h3 class="fn"><a name="insertPage"></a><span class="type">void</span> Q3Wizard::<span class="name">insertPage</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>title</i>, <span class="type">int</span> <i>index</i> )<tt> [virtual]</tt></h3>
<p>Inserts <i>page</i> at position <i>index</i> into the page sequence, with title <i>title</i>. If <i>index</i> is -1, the page will be appended to the end of the wizard's page sequence.</p>
<!-- @@@insertPage -->
<!-- $$$layOutButtonRow[overload1]$$$layOutButtonRowQHBoxLayout* -->
<h3 class="fn"><a name="layOutButtonRow"></a><span class="type">void</span> Q3Wizard::<span class="name">layOutButtonRow</span> ( <span class="type"><a href="qhboxlayout.html">QHBoxLayout</a></span> * <i>layout</i> )<tt> [virtual protected]</tt></h3>
<p>This virtual function is responsible for adding the buttons below the bottom divider.</p>
<p><i>layout</i> is the horizontal layout of the entire wizard.</p>
<!-- @@@layOutButtonRow -->
<!-- $$$layOutTitleRow[overload1]$$$layOutTitleRowQHBoxLayout*constQString& -->
<h3 class="fn"><a name="layOutTitleRow"></a><span class="type">void</span> Q3Wizard::<span class="name">layOutTitleRow</span> ( <span class="type"><a href="qhboxlayout.html">QHBoxLayout</a></span> * <i>layout</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>title</i> )<tt> [virtual protected]</tt></h3>
<p>This virtual function is responsible for laying out the title row.</p>
<p><i>layout</i> is the horizontal layout for the wizard, and <i>title</i> is the title for this page. This function is called every time <i>title</i> changes.</p>
<!-- @@@layOutTitleRow -->
<!-- $$$next[overload1]$$$next -->
<h3 class="fn"><a name="next"></a><span class="type">void</span> Q3Wizard::<span class="name">next</span> ()<tt> [virtual protected slot]</tt></h3>
<p>Called when the user clicks the Next button, this function shows the next relevant page in the sequence.</p>
<p><b>See also </b><a href="q3wizard.html#appropriate">appropriate</a>().</p>
<!-- @@@next -->
<!-- $$$nextButton[overload1]$$$nextButton -->
<h3 class="fn"><a name="nextButton"></a><span class="type"><a href="qpushbutton.html">QPushButton</a></span> * Q3Wizard::<span class="name">nextButton</span> () const</h3>
<p>Returns a pointer to the dialog's Next button</p>
<p>By default, this button is connected to the <a href="q3wizard.html#next">next</a>() slot, which is virtual so you can reimplement it in a <a href="q3wizard.html" class="compat">Q3Wizard</a> subclass. Use <a href="q3wizard.html#setNextEnabled">setNextEnabled</a>() to enable/disable this button.</p>
<!-- @@@nextButton -->
<!-- $$$page[overload1]$$$pageint -->
<h3 class="fn"><a name="page"></a><span class="type"><a href="qwidget.html">QWidget</a></span> * Q3Wizard::<span class="name">page</span> ( <span class="type">int</span> <i>index</i> ) const</h3>
<p>Returns a pointer to the page at position <i>index</i> in the sequence, or 0 if <i>index</i> is out of range. The first page has index 0.</p>
<!-- @@@page -->
<!-- $$$pageCount[overload1]$$$pageCount -->
<h3 class="fn"><a name="pageCount"></a><span class="type">int</span> Q3Wizard::<span class="name">pageCount</span> () const</h3>
<p>Returns the number of pages in the wizard.</p>
<!-- @@@pageCount -->
<!-- $$$removePage[overload1]$$$removePageQWidget* -->
<h3 class="fn"><a name="removePage"></a><span class="type">void</span> Q3Wizard::<span class="name">removePage</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i> )<tt> [virtual]</tt></h3>
<p>Removes <i>page</i> from the page sequence but does not delete the page. If <i>page</i> is currently being displayed, <a href="q3wizard.html" class="compat">Q3Wizard</a> will display the page that precedes it, or the first page if this was the first page.</p>
<!-- @@@removePage -->
<!-- $$$selected[overload1]$$$selectedconstQString& -->
<h3 class="fn"><a name="selected"></a><span class="type">void</span> Q3Wizard::<span class="name">selected</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>title</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the current page changes. The <i>title</i> parameter contains the title of the selected page.</p>
<!-- @@@selected -->
<!-- $$$setAppropriate[overload1]$$$setAppropriateQWidget*bool -->
<h3 class="fn"><a name="setAppropriate"></a><span class="type">void</span> Q3Wizard::<span class="name">setAppropriate</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i>, <span class="type">bool</span> <i>appropriate</i> )<tt> [virtual]</tt></h3>
<p>If <i>appropriate</i> is true then page <i>page</i> is considered relevant in the current context and should be displayed in the page sequence; otherwise <i>page</i> should not be displayed in the page sequence.</p>
<p><b>See also </b><a href="q3wizard.html#appropriate">appropriate</a>().</p>
<!-- @@@setAppropriate -->
<!-- $$$setBackEnabled[overload1]$$$setBackEnabledQWidget*bool -->
<h3 class="fn"><a name="setBackEnabled"></a><span class="type">void</span> Q3Wizard::<span class="name">setBackEnabled</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i>, <span class="type">bool</span> <i>enable</i> )<tt> [virtual slot]</tt></h3>
<p>If <i>enable</i> is true, page <i>page</i> has a Back button; otherwise <i>page</i> has no Back button. By default all pages have this button.</p>
<!-- @@@setBackEnabled -->
<!-- $$$setFinishEnabled[overload1]$$$setFinishEnabledQWidget*bool -->
<h3 class="fn"><a name="setFinishEnabled"></a><span class="type">void</span> Q3Wizard::<span class="name">setFinishEnabled</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i>, <span class="type">bool</span> <i>enable</i> )<tt> [virtual slot]</tt></h3>
<p>If <i>enable</i> is true, page <i>page</i> has a Finish button; otherwise <i>page</i> has no Finish button. By default <i>no</i> page has this button.</p>
<!-- @@@setFinishEnabled -->
<!-- $$$setHelpEnabled[overload1]$$$setHelpEnabledQWidget*bool -->
<h3 class="fn"><a name="setHelpEnabled"></a><span class="type">void</span> Q3Wizard::<span class="name">setHelpEnabled</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i>, <span class="type">bool</span> <i>enable</i> )<tt> [virtual slot]</tt></h3>
<p>If <i>enable</i> is true, page <i>page</i> has a Help button; otherwise <i>page</i> has no Help button. By default all pages have this button.</p>
<!-- @@@setHelpEnabled -->
<!-- $$$setNextEnabled[overload1]$$$setNextEnabledQWidget*bool -->
<h3 class="fn"><a name="setNextEnabled"></a><span class="type">void</span> Q3Wizard::<span class="name">setNextEnabled</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i>, <span class="type">bool</span> <i>enable</i> )<tt> [virtual slot]</tt></h3>
<p>If <i>enable</i> is true, page <i>page</i> has a Next button; otherwise the Next button on <i>page</i> is disabled. By default all pages have this button.</p>
<!-- @@@setNextEnabled -->
<!-- $$$setTitle[overload1]$$$setTitleQWidget*constQString& -->
<h3 class="fn"><a name="setTitle"></a><span class="type">void</span> Q3Wizard::<span class="name">setTitle</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>title</i> )</h3>
<p>Sets the title for page <i>page</i> to <i>title</i>.</p>
<p><b>See also </b><a href="q3wizard.html#title">title</a>().</p>
<!-- @@@setTitle -->
<!-- $$$showPage[overload1]$$$showPageQWidget* -->
<h3 class="fn"><a name="showPage"></a><span class="type">void</span> Q3Wizard::<span class="name">showPage</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i> )<tt> [virtual]</tt></h3>
<p>Makes <i>page</i> the current page and emits the <a href="q3wizard.html#selected">selected</a>() signal.</p>
<p>This virtual function is called whenever a different page is to be shown, including the first time the <a href="q3wizard.html" class="compat">Q3Wizard</a> is shown. By reimplementing it (and calling Q3Wizard::showPage()), you can prepare each page prior to it being shown.</p>
<!-- @@@showPage -->
<!-- $$$title[overload1]$$$titleQWidget* -->
<h3 class="fn"><a name="title"></a><span class="type"><a href="qstring.html">QString</a></span> Q3Wizard::<span class="name">title</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>page</i> ) const</h3>
<p>Returns the title of page <i>page</i>.</p>
<p><b>See also </b><a href="q3wizard.html#setTitle">setTitle</a>().</p>
<!-- @@@title -->
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2012 Nokia Corporation and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Nokia, Qt and their respective logos are trademarks of Nokia Corporation
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>
|
