File: qwizard.html

package info (click to toggle)
qt-embedded 2.3.2-3
  • links: PTS
  • area: main
  • in suites: woody
  • size: 68,608 kB
  • ctags: 45,998
  • sloc: cpp: 276,654; ansic: 71,987; makefile: 29,074; sh: 12,305; yacc: 2,465; python: 1,863; perl: 481; lex: 480; xml: 68; lisp: 15
file content (203 lines) | stat: -rw-r--r-- 14,024 bytes parent folder | download 
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
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Qt Toolkit - QWizard Class</title><style type="text/css"><!--
h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }body { background: white; color: black; }
--></style>
</head><body bgcolor="#ffffff">

<table width="100%">
<tr><td><a href="index.html">
<img width="100" height="100" src="qtlogo.png"
alt="Home" border="0"><img width="100"
height="100" src="face.png" alt="Home" border="0">
</a><td valign=top><div align=right><img src="dochead.png" width="472" height="27"><br>
<a href="classes.html"><b>Classes</b></a>
-<a href="annotated.html">Annotated</a>
- <a href="hierarchy.html">Tree</a>
-<a href="functions.html">Functions</a>
-<a href="index.html">Home</a>
-<a href="topicals.html"><b>Structure</b></a>
</div>
</table>

<h1 align=center>QWizard Class Reference</h1><br clear="all">
<p>
The QWizard class provides a framework for easily writing wizards.
<a href="#details">More...</a>
<p>
<code>#include &lt;<a href="qwizard-h.html">qwizard.h</a>&gt;</code>
<p>
Inherits <a href="qdialog.html">QDialog</a>.
<p><a href="qwizard-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li><div class="fn"><a href="#483585"><b>QWizard</b></a>(QWidget*parent=0, constchar*name=0, boolmodal=FALSE, WFlagsf=0)</div>
<li><div class="fn"><a href="#f65a2c"><b>~QWizard</b></a>()</div>
<li><div class="fn">virtualvoid<a href="#f29492"><b>addPage</b></a>(QWidget*, constQString&amp;)</div>
<li><div class="fn">virtualvoid<a href="#35797b"><b>removePage</b></a>(QWidget*)</div>
<li><div class="fn">QString<a href="#59a5b6"><b>title</b></a>(QWidget*)const</div>
<li><div class="fn">void<a href="#973315"><b>setTitle</b></a>(QWidget*, constQString&amp;)</div>
<li><div class="fn">virtualvoid<a href="#9f7d8a"><b>showPage</b></a>(QWidget*)</div>
<li><div class="fn">QWidget*<a href="#c5e4cc"><b>currentPage</b></a>()const</div>
<li><div class="fn">QWidget*<a href="#219da0"><b>page</b></a>(intpos)const</div>
<li><div class="fn">int<a href="#4766dd"><b>pageCount</b></a>()const</div>
<li><div class="fn">virtualbool<a href="#6e81e1"><b>appropriate</b></a>(QWidget*)const</div>
<li><div class="fn">virtualvoid<a href="#70d94e"><b>setAppropriate</b></a>(QWidget*, bool)</div>
<li><div class="fn">QPushButton*<a href="#7bb9e6"><b>backButton</b></a>()const</div>
<li><div class="fn">QPushButton*<a href="#1e5507"><b>nextButton</b></a>()const</div>
<li><div class="fn">QPushButton*<a href="#605909"><b>finishButton</b></a>()const</div>
<li><div class="fn">QPushButton*<a href="#e0adc4"><b>cancelButton</b></a>()const</div>
<li><div class="fn">QPushButton*<a href="#da0e50"><b>helpButton</b></a>()const</div>
</ul>
<h2>Public Slots</h2>
<ul>
<li><div class="fn">virtualvoid<a href="#8e84eb"><b>setBackEnabled</b></a>(QWidget*, bool)</div>
<li><div class="fn">virtualvoid<a href="#03bd73"><b>setNextEnabled</b></a>(QWidget*, bool)</div>
<li><div class="fn">virtualvoid<a href="#64601b"><b>setFinishEnabled</b></a>(QWidget*, bool)</div>
<li><div class="fn">virtualvoid<a href="#058879"><b>setHelpEnabled</b></a>(QWidget*, bool)</div>
<li><div class="fn">virtualvoidsetFinish(QWidget*, bool)<em>(obsolete)</em></div>
</ul>
<h2>Signals</h2>
<ul>
<li><div class="fn">void<a href="#c2698f"><b>helpClicked</b></a>()</div>
<li><div class="fn">void<a href="#cac5eb"><b>selected</b></a>(constQString&amp;)</div>
</ul>
<h2>Protected Members</h2>
<ul>
<li><div class="fn">virtualvoid<a href="#f66867"><b>layOutButtonRow</b></a>(QHBoxLayout*)</div>
<li><div class="fn">virtualvoid<a href="#89fc16"><b>layOutTitleRow</b></a>(QHBoxLayout*, constQString&amp;)</div>
</ul>
<h2>Protected Slots</h2>
<ul>
<li><div class="fn">virtualvoid<a href="#73a193"><b>back</b></a>()</div>
<li><div class="fn">virtualvoid<a href="#e11923"><b>next</b></a>()</div>
<li><div class="fn">virtualvoid<a href="#279917"><b>help</b></a>()</div>
</ul>
<hr><h2><a name="details"></a>Detailed Description</h2>
The QWizard class provides a framework for easily writing wizards.
<p>
A wizard is a dialog that consists of a sequential number of steps,
each consisting of a single page.  QWizard provides a title for each
page, and "Next", "Back", "Finish", "Cancel" and "Help" buttons, as
appropriate.

<hr><h2>Member Function Documentation</h2>
<h3 class="fn"><a name="483585"></a>QWizard::QWizard(<a href="qwidget.html">QWidget</a>*parent=0, constchar*name=0, boolmodal=FALSE, WFlagsf=0)</h3>
<p>Constructs an empty wizard dialog.
<h3 class="fn"><a name="f65a2c"></a>QWizard::~QWizard()</h3>
<p>Destructs the object and frees any allocated resources, including,
of course, all pages and controllers.
<h3 class="fn">void<a name="f29492"></a>QWizard::addPage(<a href="qwidget.html">QWidget</a>*page, const<a href="qstring.html">QString</a>&amp;title) <code>[virtual]</code></h3>
<p>Adds <em>page</em> to the end of the wizard, titled <em>title.</em>
<h3 class="fn">bool<a name="6e81e1"></a>QWizard::appropriate(<a href="qwidget.html">QWidget</a>*w)const <code>[virtual]</code></h3>
<p>This virtual function returns TRUE if <em>w</em> is appropriate for
display in the current context of the wizard, and FALSE if QWizard
should go on.
<p>It is called when the Next button is clicked.<p><b>Warning:</b> The last page of a wizard will be displayed if nothing else wants
to, and the Next button was enabled when the user clicked.
<p>The default implementation returns whatever was set using
<a href="#70d94e">setAppropriate</a>().  The ultimate default is TRUE.
<h3 class="fn">void<a name="73a193"></a>QWizard::back() <code>[virtualprotected slot]</code></h3>
<p>Called when the user clicks the Back button, this function shows
the page which the user saw prior to the current one.
<h3 class="fn"><a href="qpushbutton.html">QPushButton</a>*<a name="7bb9e6"></a>QWizard::backButton()const</h3>
<p>Returns the Back button of the dialog.
<p>By default, this button is connected to the <a href="#73a193">back</a>()
slot, which is virtual.
<h3 class="fn"><a href="qpushbutton.html">QPushButton</a>*<a name="e0adc4"></a>QWizard::cancelButton()const</h3>
<p>Returns the Cancel button of the dialog.
<p>By default, this button is connected to the <a href="qdialog.html#604679">QDialog::reject</a>() slot,
which is virtual so you may reimplement it in a QWizard subclass.
<h3 class="fn"><a href="qwidget.html">QWidget</a>*<a name="c5e4cc"></a>QWizard::currentPage()const</h3>
<p>Returns a pointer to the page currently being displayed by the
wizard.  The wizard does its best to make sure that this value is
never 0, but if you try hard enough it can be.
<h3 class="fn">bool<a name="3693e3"></a>QWizard::eventFilter(<a href="qobject.html">QObject</a>*o, <a href="qevent.html">QEvent</a>*e) <code>[virtual]</code></h3>
<p>Reimplemented for internal reasons; the API is not affected.
<p>Reimplemented from <a href="qobject.html#bd20fe">QObject.</a>
<h3 class="fn"><a href="qpushbutton.html">QPushButton</a>*<a name="605909"></a>QWizard::finishButton()const</h3>
<p>Returns the Finish button of the dialog.
<p>By default, this button is connected to the <a href="qdialog.html#82d406">QDialog::accept</a>() slot,
which is virtual so you may reimplement it in a QWizard subclass.
<h3 class="fn">void<a name="279917"></a>QWizard::help() <code>[virtualprotected slot]</code></h3>
<p>This slot either makes the wizard help you, if it can.  The only
way it knows is to emit the <a href="#c2698f">helpClicked</a>() signal.
<h3 class="fn"><a href="qpushbutton.html">QPushButton</a>*<a name="da0e50"></a>QWizard::helpButton()const</h3>
<p>Returns the Help button of the dialog.
<p>By default, this button is connected to the <a href="#279917">help</a>() slot.
<h3 class="fn">void<a name="c2698f"></a>QWizard::helpClicked() <code>[signal]</code></h3>
<p>This signal is emitted when the user clicks on the help button.
<h3 class="fn">void<a name="f66867"></a>QWizard::layOutButtonRow(<a href="qhboxlayout.html">QHBoxLayout</a>*layout) <code>[virtualprotected]</code></h3>
<p>This virtual function is responsible for adding the bottom
divider and buttons below it.
<p><em>layout</em> is the vertical layout of the entire wizard.
<h3 class="fn">void<a name="89fc16"></a>QWizard::layOutTitleRow(<a href="qhboxlayout.html">QHBoxLayout</a>*layout, const<a href="qstring.html">QString</a>&amp;title) <code>[virtualprotected]</code></h3>
<p>This virtual function is responsible for laying out the title row
and adding the vertical divider between the title and the wizard page.
<em>layout</em> is the vertical layout for the wizard, <em>title</em> is the title
for this page, and this function is called every time <em>title</em>
changes.
<h3 class="fn">void<a name="e11923"></a>QWizard::next() <code>[virtualprotected slot]</code></h3>
<p>Called when the user clicks the Next button, this function shows
the next appropriate page.
<h3 class="fn"><a href="qpushbutton.html">QPushButton</a>*<a name="1e5507"></a>QWizard::nextButton()const</h3>
<p>Returns the Next button of the dialog.
<p>By default, this button is connected to the <a href="#e11923">next</a>()
slot, which is virtual.
<h3 class="fn"><a href="qwidget.html">QWidget</a>*<a name="219da0"></a>QWizard::page(intpos)const</h3>
<p>Returns a pointer to page a position <em>pos,</em> or 0 if <em>pos</em> is out of range.
The first page has position 0.
<h3 class="fn">int<a name="4766dd"></a>QWizard::pageCount()const</h3>
<p>Returns the number of pages in the wizard.
<h3 class="fn">void<a name="35797b"></a>QWizard::removePage(<a href="qwidget.html">QWidget</a>*page) <code>[virtual]</code></h3>
<p>Removes <em>page</em> from this wizard.  Does not delete
<em>page.</em> If <em>page</em> is currently being displayed, QWizard will
display something else.
<h3 class="fn">void<a name="cac5eb"></a>QWizard::selected(const<a href="qstring.html">QString</a>&amp;) <code>[signal]</code></h3>
<p>This signal is emitted when the page changes, signalling
the title of the page.
<h3 class="fn">void<a name="70d94e"></a>QWizard::setAppropriate(<a href="qwidget.html">QWidget</a>*w, boolenable) <code>[virtual]</code></h3>
<p>Sets whether it is appropriate for <em>w</em> to be displayed in the
current context of the wizard.
<p>See also  <a href="#6e81e1">appropriate</a>().
<h3 class="fn">void<a name="8e84eb"></a>QWizard::setBackEnabled(<a href="qwidget.html">QWidget</a>*w, boolenable) <code>[virtualslot]</code></h3>
<p>Enables or disables the "Back" button for pages <em>w</em> in the wizard.
By default, all pages have this button.
<h3 class="fn">void<a name="ea4d4e"></a>QWizard::setFinish(<a href="qwidget.html">QWidget</a>*, bool) <code>[virtualslot]</code></h3>
<p><b>This function is obsolete.</b> It is provided to keep old source working, and will probably be removed in a future version of Qt.  We strongly advise against using it in new code.<p>
<h3 class="fn">void<a name="64601b"></a>QWizard::setFinishEnabled(<a href="qwidget.html">QWidget</a>*w, boolenable) <code>[virtualslot]</code></h3>
<p>Enables or disables the "Finish" button for pages <em>w</em> in the wizard.
By default, <em>no</em> pages have this button.
<h3 class="fn">void<a name="98ce4e"></a>QWizard::setFont(const<a href="qfont.html">QFont</a>&amp;font) <code>[virtual]</code></h3>
<p>Reimplemented for internal reasons; the API is not affected.
<p>Reimplemented from <a href="qwidget.html#c52788">QWidget.</a>
<h3 class="fn">void<a name="058879"></a>QWizard::setHelpEnabled(<a href="qwidget.html">QWidget</a>*w, boolenable) <code>[virtualslot]</code></h3>
<p>Enables or disables the "Help" button for pages <em>w</em> in the wizard.
By default, all pages have this button.
<h3 class="fn">void<a name="03bd73"></a>QWizard::setNextEnabled(<a href="qwidget.html">QWidget</a>*w, boolenable) <code>[virtualslot]</code></h3>
<p>Enables or disables the "Next" button for pages <em>w</em> in the wizard.
By default, all pages have this button.
<h3 class="fn">void<a name="973315"></a>QWizard::setTitle(<a href="qwidget.html">QWidget</a>*page, const<a href="qstring.html">QString</a>&amp;t)</h3>
<p>Sets the title for the <em>page</em> to <em>title.</em>
<h3 class="fn">void<a name="5a4c78"></a>QWizard::show() <code>[virtual]</code></h3>
<p>Reimplemented for internal reasons; the API is not affected.
<p>Reimplemented from <a href="qwidget.html#200ee5">QWidget.</a>
<h3 class="fn">void<a name="9f7d8a"></a>QWizard::showPage(<a href="qwidget.html">QWidget</a>*page) <code>[virtual]</code></h3>
<p>Makes <em>page</em> be the displayed page and emits the <a href="#cac5eb">selected</a>() signal.
<h3 class="fn"><a href="qstring.html">QString</a><a name="59a5b6"></a>QWizard::title(<a href="qwidget.html">QWidget</a>*page)const</h3>
<p>Returns the title of <em>page.</em>
<hr><p>
Search the documentation, FAQ, qt-interest archive and more (uses
<a href="http://www.trolltech.com">www.trolltech.com</a>):<br>
<form method=post action="http://www.trolltech.com/search.cgi">
<input type=hidden name="version" value="2.3.2"><nobr>
<input size="50" name="search"><input type=submit value="Search">
</nobr></form><hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>,
copyright &copy; 1995-2001
<a href="http://www.trolltech.com">Trolltech</a>, all rights reserved.<p><address><hr><div align="center">
<table width="100%" cellspacing="0" border="0"><tr>
<td>Copyright  2001 Trolltech<td><a href="http://www.trolltech.com/trademarks.html">Trademarks</a>
<td align="right"><div align="right">Qt version 2.3.2</div>
</table></div></address></body></html>