]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/wizpage.tex
Removed wxDataViewViewColumn since it is redundant.
[wxWidgets.git] / docs / latex / wx / wizpage.tex
CommitLineData
f6bcfd97
BP
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: wizpage.tex
3%% Purpose: wxWizardPage and wxWizardPageSimple classes documentation
4%% Author: Vadim Zeitlin
5%% Modified by:
6%% Created: 02.04.00
7%% RCS-ID: $Id$
8%% Copyright: (c) Vadim Zeitlin
8795498c 9%% License: wxWindows license
f6bcfd97
BP
10%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11
12\section{\class{wxWizardPage}}\label{wxwizardpage}
13
14wxWizardPage is one of the screens in \helpref{wxWizard}{wxwizard}: it must
15know what are the following and preceding pages (which may be {\tt NULL} for the
16first/last page). Except for this extra knowledge, wxWizardPage is just a
17panel, so the controls may be placed directly on it in the usual way.
18
decb3a6a
JS
19This class allows the programmer to decide the order of pages in the wizard
20dynamically (during run-time) and so provides maximal flexibility. Usually,
f6bcfd97
BP
21however, the order of pages is known in advance in which case
22\helpref{wxWizardPageSimple}{wxwizardpagesimple} class is enough and it is simpler
23to use.
24
25\wxheading{Virtual functions to override}
26
27To use this class, you must override \helpref{GetPrev}{wxwizardpagegetprev}
28and \helpref{GetNext}{wxwizardpagegetnext} pure virtual functions (or you
29may use \helpref{wxWizardPageSimple}{wxwizardpagesimple} instead).
30
31\helpref{GetBitmap}{wxwizardpagegetbitmap} can also be overridden, but this
32should be very rarely needed.
33
34\wxheading{Derived from}
35
36\helpref{wxPanel}{wxpanel}\\
37\helpref{wxWindow}{wxwindow}\\
38\helpref{wxEvtHandler}{wxevthandler}\\
39\helpref{wxObject}{wxobject}
40
41\wxheading{Include files}
42
43<wx/wizard.h>
44
45\wxheading{See also}
46
47\helpref{wxWizard}{wxwizard}, \helpref{wxWizard sample}{samplewizard}
48
49\latexignore{\rtfignore{\wxheading{Members}}}
50
51\membersection{wxWizardPage::wxWizardPage}\label{wxwizardpagewxwizardpage}
52
cf63f3d3 53\func{}{wxWizardPage}{\param{wxWizard* }{parent}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
f6bcfd97
BP
54
55Constructor accepts an optional bitmap which will be used for this page
56instead of the default one for this wizard (note that all bitmaps used should
57be of the same size). Notice that no other parameters are needed because the
58wizard will resize and reposition the page anyhow.
59
a0a48a3f
VZ
60\wxheading{Parameters}
61
62\docparam{parent}{The parent wizard}
63
64\docparam{bitmap}{The page-specific bitmap if different from the global one}
65
a0a48a3f 66
f6bcfd97
BP
67\membersection{wxWizardPage::GetPrev}\label{wxwizardpagegetprev}
68
69\constfunc{wxWizardPage*}{GetPrev}{\void}
70
71Get the page which should be shown when the user chooses the {\tt "Back"}
72button: if {\tt NULL} is returned, this button will be disabled. The first
73page of the wizard will usually return {\tt NULL} from here, but the others
74will not.
75
76\wxheading{See also}
77
78\helpref{GetNext}{wxwizardpagegetnext}
79
80\membersection{wxWizardPage::GetNext}\label{wxwizardpagegetnext}
81
82\constfunc{wxWizardPage*}{GetNext}{\void}
83
84Get the page which should be shown when the user chooses the {\tt "Next"}
85button: if {\tt NULL} is returned, this button will be disabled. The last
86page of the wizard will usually return {\tt NULL} from here, but the others
87will not.
88
89\wxheading{See also}
90
91\helpref{GetPrev}{wxwizardpagegetprev}
92
93\membersection{wxWizardPage::GetBitmap}\label{wxwizardpagegetbitmap}
94
95\constfunc{wxBitmap}{GetBitmap}{\void}
96
97This method is called by wxWizard to get the bitmap to display alongside the
98page. By default, {\tt m\_bitmap} member variable which was set in the
99\helpref{constructor}{wxwizardpagewxwizardpage}.
100
101If the bitmap was not explicitly set (i.e. if {\tt wxNullBitmap} is returned),
102the default bitmap for the wizard should be used.
103
104The only cases when you would want to override this function is if the page
105bitmap depends dynamically on the user choices, i.e. almost never.
106
107%%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxWizardPageSimple %%%%%%%%%%%%%%%%%%%%%%%%%%%%
108
109\section{\class{wxWizardPageSimple}}\label{wxwizardpagesimple}
110
111wxWizardPageSimple is the simplest possible
112\helpref{wxWizardPage}{wxwizardpage} implementation: it just returns the
113pointers given to its constructor from GetNext() and GetPrev() functions.
114
2edb0bde 115This makes it very easy to use the objects of this class in the wizards where
f6bcfd97
BP
116the pages order is known statically - on the other hand, if this is not the
117case you must derive your own class from \helpref{wxWizardPage}{wxwizardpage}
118instead.
119
120\wxheading{Derived from}
121
122\helpref{wxWizardPage}{wxwizardpage}\\
123\helpref{wxPanel}{wxpanel}\\
124\helpref{wxWindow}{wxwindow}\\
125\helpref{wxEvtHandler}{wxevthandler}\\
126\helpref{wxObject}{wxobject}
127
128\wxheading{Include files}
129
130<wx/wizard.h>
131
132\wxheading{See also}
133
134\helpref{wxWizard}{wxwizard}, \helpref{wxWizard sample}{samplewizard}
135
136\latexignore{\rtfignore{\wxheading{Members}}}
137
138\membersection{wxWizardPageSimple::wxWizardPageSimple}\label{wxwizardpagesimplewxwizardpagesimple}
139
ae500232 140\func{}{wxWizardPageSimple}{\param{wxWizard* }{parent = NULL}, \param{wxWizardPage* }{prev = NULL}, \param{wxWizardPage* }{next = NULL},
e119d049 141\param{const wxBitmap\& }{bitmap = wxNullBitmap}}
f6bcfd97
BP
142
143Constructor takes the previous and next pages. They may be modified later by
144\helpref{SetPrev()}{wxwizardpagesimplesetprev} or
145\helpref{SetNext()}{wxwizardpagesimplesetnext}.
146
147\membersection{wxWizardPageSimple::SetPrev}\label{wxwizardpagesimplesetprev}
148
149\func{void}{SetPrev}{\param{wxWizardPage* }{prev}}
150
151Sets the previous page.
152
153\membersection{wxWizardPageSimple::SetNext}\label{wxwizardpagesimplesetnext}
154
155\func{void}{SetNext}{\param{wxWizardPage* }{next}}
156
157Sets the next page.
158
159\membersection{wxWizardPageSimple::Chain}\label{wxwizardpagesimplechain}
160
161\func{static void}{Chain}{\param{wxWizardPageSimple* }{first}, \param{wxWizardPageSimple* }{second}}
162
163A convenience function to make the pages follow each other.
164
165Example:
d2c2afc9 166
f6bcfd97
BP
167\begin{verbatim}
168 wxRadioboxPage *page3 = new wxRadioboxPage(wizard);
169 wxValidationPage *page4 = new wxValidationPage(wizard);
170
171 wxWizardPageSimple::Chain(page3, page4);
172\end{verbatim}
173