]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/wizard.tex
Fixed to work with the new wxMacControl system.
[wxWidgets.git] / docs / latex / wx / wizard.tex
... / ...
CommitLineData
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: wizard.tex
3%% Purpose: wxWizard class documentation
4%% Author: Vadim Zeitlin
5%% Modified by: Robert Vazan (sizers)
6%% Created: 02.04.00
7%% RCS-ID: $Id$
8%% Copyright: (c) Vadim Zeitlin
9%% License: wxWidgets license
10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12\section{\class{wxWizard}}\label{wxwizard}
13
14wxWizard is the central class for implementing `wizard-like' dialogs. These
15dialogs are mostly familiar to Windows users and are nothing else but a
16sequence of `pages' each of them displayed inside a dialog which has the
17buttons to pass to the next (and previous) pages.
18
19The wizards are typically used to decompose a complex dialog into several
20simple steps and are mainly useful to the novice users, hence it is important
21to keep them as simple as possible.
22
23To show a wizard dialog, you must first create an object of wxWizard class
24using either the non default constructor or a default one followed by call to
25\helpref{Create}{wxwizardcreate} function. Then you should add all pages you
26want the wizard to show and call \helpref{RunWizard}{wxwizardrunwizard}.
27Finally, don't forget to call {\tt wizard->Destroy()}.
28
29\wxheading{Derived from}
30
31\helpref{wxDialog}{wxdialog}\\
32\helpref{wxPanel}{wxpanel}\\
33\helpref{wxWindow}{wxwindow}\\
34\helpref{wxEvtHandler}{wxevthandler}\\
35\helpref{wxObject}{wxobject}
36
37\wxheading{Include files}
38
39<wx/wizard.h>
40
41\wxheading{Event table macros}
42
43To process input from a wizard dialog, use these event handler macros to
44direct input to member functions that take a
45\helpref{wxWizardEvent}{wxwizardevent} argument. For some events,
46\helpref{Veto()}{wxnotifyeventveto} can be called to prevent the event from
47happening.
48
49\twocolwidtha{7cm}
50\begin{twocollist}\itemsep=2pt
51\twocolitem{{\bf EVT\_WIZARD\_PAGE\_CHANGED(id, func)}}{The page has been just
52changed (this event can not be vetoed).}
53\twocolitem{{\bf EVT\_WIZARD\_PAGE\_CHANGING(id, func)}}{The page is being
54changed (this event can be vetoed).}
55\twocolitem{{\bf EVT\_WIZARD\_CANCEL(id, func)}}{The user attempted to cancel
56the wizard (this event may also be vetoed).}
57\twocolitem{{\bf EVT\_WIZARD\_HELP(id, func)}}{The wizard help button was pressed.}
58\twocolitem{{\bf EVT\_WIZARD\_FINISHED(id, func)}}{The wizard finished button was pressed.}
59\end{twocollist}
60
61\wxheading{Extended styles}
62
63Use the \helpref{wxWindow::SetExtraStyle}{wxwindowsetextrastyle} function to set the following
64style. You will need to use two-step construction (use the default constructor, call {\bf SetExtraStyle}, then call {\bf Create}).
65
66\twocolwidtha{5cm}%
67\begin{twocollist}\itemsep=0pt
68\twocolitem{\windowstyle{wxWIZARD\_EX\_HELPBUTTON}}{Shows a Help button using wxID\_HELP.}
69\end{twocollist}
70
71See also \helpref{wxDialog}{wxdialog} for other extended styles.
72
73\wxheading{See also}
74
75\helpref{wxWizardEvent}{wxwizardevent}, \helpref{wxWizardPage}{wxwizardpage}, \helpref{wxWizard sample}{samplewizard}
76
77\latexignore{\rtfignore{\wxheading{Members}}}
78
79\membersection{wxWizard::wxWizard}\label{wxwizardctor}
80
81\func{}{wxWizard}{\void}
82
83Default constructor. Use this if you wish to derive from wxWizard and then call
84\helpref{Create}{wxwizardcreate}, for example if you wish to set an extra style
85with \helpref{wxWindow::SetExtraStyle}{wxwindowsetextrastyle} between the two
86calls.
87
88\func{}{wxWizard}{\param{wxWindow* }{parent}, \param{int }{id = -1}, \param{const wxString\& }{title = wxEmptyString}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{long }{style = wxDEFAULT\_DIALOG\_STYLE}}
89
90Constructor which really creates the wizard -- if you use this constructor, you
91shouldn't call \helpref{Create}{wxwizardcreate}.
92
93Notice that unlike almost all other wxWidgets classes, there is no {\it size}
94parameter in wxWizard constructor because the wizard will have a predefined
95default size by default. If you want to change this, you should use the
96\helpref{GetPageAreaSizer}{wxwizardgetpageareasizer} function.
97
98\wxheading{Parameters}
99
100\docparam{parent}{The parent window, may be NULL.}
101
102\docparam{id}{The id of the dialog, will usually be just $-1$.}
103
104\docparam{title}{The title of the dialog.}
105
106\docparam{bitmap}{The default bitmap used in the left side of the wizard. See
107also \helpref{GetBitmap}{wxwizardpagegetbitmap}.}
108
109\docparam{pos}{The position of the dialog, it will be centered on the screen
110by default.}
111
112\docparam{style}{Window style is passed to wxDialog.}
113
114
115\membersection{wxWizard::Create}\label{wxwizardcreate}
116
117\func{bool}{Create}{\param{wxWindow* }{parent}, \param{int }{id = -1}, \param{const wxString\& }{title = wxEmptyString}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{long }{style = wxDEFAULT\_DIALOG\_STYLE}}
118
119Creates the wizard dialog. Must be called if the default constructor had been
120used to create the object.
121
122Notice that unlike almost all other wxWidgets classes, there is no {\it size}
123parameter in wxWizard constructor because the wizard will have a predefined
124default size by default. If you want to change this, you should use the
125\helpref{GetPageAreaSizer}{wxwizardgetpageareasizer} function.
126
127\wxheading{Parameters}
128
129\docparam{parent}{The parent window, may be NULL.}
130
131\docparam{id}{The id of the dialog, will usually be just $-1$.}
132
133\docparam{title}{The title of the dialog.}
134
135\docparam{bitmap}{The default bitmap used in the left side of the wizard. See
136also \helpref{GetBitmap}{wxwizardpagegetbitmap}.}
137
138\docparam{pos}{The position of the dialog, it will be centered on the screen
139by default.}
140
141\docparam{style}{Window style is passed to wxDialog.}
142
143
144\membersection{wxWizard::FitToPage}\label{wxwizardfittopage}
145
146\func{void}{FitToPage}{\param{const wxWizardPage* }{firstPage}}
147
148This method is obsolete, use
149\helpref{GetPageAreaSizer}{wxwizardgetpageareasizer} instead.
150
151Sets the page size to be big enough for all the pages accessible via the
152given {\it firstPage}, i.e. this page, its next page and so on.
153
154This method may be called more than once and it will only change the page size
155if the size required by the new page is bigger than the previously set one.
156This is useful if the decision about which pages to show is taken during the
157run-time as in this case, the wizard won't be able to get to all pages starting
158from a single one and you should call {\it Fit} separately for the others.
159
160
161\membersection{wxWizard::GetCurrentPage}\label{wxwizardgetcurrentpage}
162
163\constfunc{wxWizardPage*}{GetCurrentPage}{\void}
164
165Get the current page while the wizard is running. {\tt NULL} is returned if
166\helpref{RunWizard()}{wxwizardrunwizard} is not being executed now.
167
168
169\membersection{wxWizard::GetPageAreaSizer}\label{wxwizardgetpageareasizer}
170
171\constfunc{virtual wxSizer*}{GetPageAreaSizer}{\void}
172
173Returns pointer to page area sizer. Wizard is laid out using sizers and
174page area sizer is the place holder for the pages. All pages are resized before
175being shown to match the wizard page area.
176
177Page area sizer has minimal size that is maximum of several values. First,
178all pages (or other objects) added to the sizer. Second, all pages reachable
179by repeatedly applying
180\helpref{wxWizardPage::GetNext}{wxwizardpagegetnext} to
181any page inserted into the sizer. Third,
182minimal size specified using \helpref{SetPageSize}{wxwizardsetpagesize} and
183\helpref{FitToPage}{wxwizardfittopage}. Fourth, the total wizard height may
184be increased to accomodate the bitmap height. Fifth and finally, wizards are
185never smaller some built-in minimal size to avoid too small wizards.
186
187Caller can use \helpref{wxSizer::SetMinSize}{wxsizersetminsize} to enlarge it
188beyond minimal size. If {\tt wxRESIZE\_BORDER} was passed to constructor, user
189can resize wizard and consequently page area (but not make it smaller than the
190minimal size).
191
192It is recommended to add first page to page area sizer. For simple wizards,
193this will enlarge the wizard to fit biggest page. For non-linear wizards,
194first page of every separate chain should be added. Caller-specified size
195can be accomplished using \helpref{wxSizer::SetMinSize}{wxsizersetminsize}.
196
197Adding pages to page area sizer affects default border width around page
198area that can be altered with \helpref{SetBorder}{wxwizardsetborder}.
199
200
201\membersection{wxWizard::GetPageSize}\label{wxwizardgetpagesize}
202
203\constfunc{wxSize}{GetPageSize}{\void}
204
205Returns the size available for the pages.
206
207
208\membersection{wxWizard::HasNextPage}\label{wxwizardhasnextpage}
209
210\func{virtual bool}{HasNextPage}{\param{wxWizardPage *}{page}}
211
212Return {\tt true} if this page is not the last one in the wizard. The base
213class version implements this by calling
214\helpref{page->GetNext}{wxwizardpagegetnext} but this could be undesirable if,
215for example, the pages are created on demand only.
216
217\wxheading{See also}
218
219\helpref{HasPrevPage}{wxwizardhasprevpage}
220
221
222\membersection{wxWizard::HasPrevPage}\label{wxwizardhasprevpage}
223
224\func{virtual bool}{HasPrevPage}{\param{wxWizardPage *}{page}}
225
226Return {\tt true} if this page is not the last one in the wizard. The base
227class version implements this by calling
228\helpref{page->GetPrev}{wxwizardpagegetprev} but this could be undesirable if,
229for example, the pages are created on demand only.
230
231\wxheading{See also}
232
233\helpref{HasNextPage}{wxwizardhasnextpage}
234
235
236\membersection{wxWizard::RunWizard}\label{wxwizardrunwizard}
237
238\func{bool}{RunWizard}{\param{wxWizardPage* }{firstPage}}
239
240Executes the wizard starting from the given page, returns {\tt true} if it was
241successfully finished or {\tt false} if user cancelled it. The {\it firstPage}
242can not be {\tt NULL}.
243
244
245\membersection{wxWizard::SetPageSize}\label{wxwizardsetpagesize}
246
247\func{void}{SetPageSize}{\param{const wxSize\& }{sizePage}}
248
249This method is obsolete, use
250\helpref{GetPageAreaSizer}{wxwizardgetpageareasizer} instead.
251
252Sets the minimal size to be made available for the wizard pages. The wizard
253will take into account the size of the bitmap (if any) itself. Also, the
254wizard will never be smaller than the default size.
255
256The recommended way to use this function is to layout all wizard pages using
257the sizers (even though the wizard is not resizeable) and then use
258\helpref{wxSizer::CalcMin}{wxsizercalcmin} in a loop to calculate the maximum
259of minimal sizes of the pages and pass it to SetPageSize().
260
261
262\membersection{wxWizard::SetBorder}\label{wxwizardsetborder}
263
264\func{void}{SetBorder}{\param{int }{border}}
265
266Sets width of border around page area. Default is zero. For backward
267compatibility, if there are no pages in
268\helpref{GetPageAreaSizer}{wxwizardgetpageareasizer}, default is $5$ pixels.
269
270If there is five point border around all controls in a page and border around
271page area is left zero, five point white space along all dialog borders
272will be added to control border to space page controls ten points from dialog
273border and non-page controls.
274