docs/latex/wx/wizpage.tex

   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
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxWizardPage}}\label{wxwizardpage}
  13
  14 wxWizardPage is one of the screens in \helpref{wxWizard}{wxwizard}: it must
  15 know what are the following and preceding pages (which may be {\tt NULL} for the
  16 first/last page). Except for this extra knowledge, wxWizardPage is just a
  17 panel, so the controls may be placed directly on it in the usual way.
  18
  19 This class allows the programmer to decide the order of pages in the wizard
  20 dynamically (during run-time) and so provides maximal flexibility. Usually,
  21 however, the order of pages is known in advance in which case
  22 \helpref{wxWizardPageSimple}{wxwizardpagesimple} class is enough and it is simpler
  23 to use.
  24
  25 \wxheading{Virtual functions to override}
  26
  27 To use this class, you must override \helpref{GetPrev}{wxwizardpagegetprev}
  28 and \helpref{GetNext}{wxwizardpagegetnext} pure virtual functions (or you
  29 may use \helpref{wxWizardPageSimple}{wxwizardpagesimple} instead).
  30
  31 \helpref{GetBitmap}{wxwizardpagegetbitmap} can also be overridden, but this
  32 should 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
  53 \func{}{wxWizardPage}{\param{wxWizard* }{parent}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
  54
  55 Constructor accepts an optional bitmap which will be used for this page
  56 instead of the default one for this wizard (note that all bitmaps used should
  57 be of the same size). Notice that no other parameters are needed because the
  58 wizard will resize and reposition the page anyhow.
  59
  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
  66
  67 \membersection{wxWizardPage::GetPrev}\label{wxwizardpagegetprev}
  68
  69 \constfunc{wxWizardPage*}{GetPrev}{\void}
  70
  71 Get the page which should be shown when the user chooses the {\tt "Back"}
  72 button: if {\tt NULL} is returned, this button will be disabled. The first
  73 page of the wizard will usually return {\tt NULL} from here, but the others
  74 will 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
  84 Get the page which should be shown when the user chooses the {\tt "Next"}
  85 button: if {\tt NULL} is returned, this button will be disabled. The last
  86 page of the wizard will usually return {\tt NULL} from here, but the others
  87 will 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
  97 This method is called by wxWizard to get the bitmap to display alongside the
  98 page. By default, {\tt m\_bitmap} member variable which was set in the
  99 \helpref{constructor}{wxwizardpagewxwizardpage}.
 100
 101 If the bitmap was not explicitly set (i.e. if {\tt wxNullBitmap} is returned),
 102 the default bitmap for the wizard should be used.
 103
 104 The only cases when you would want to override this function is if the page
 105 bitmap depends dynamically on the user choices, i.e. almost never.
 106
 107 %%%%%%%%%%%%%%%%%%%%%%%%%%%%% wxWizardPageSimple %%%%%%%%%%%%%%%%%%%%%%%%%%%%
 108
 109 \section{\class{wxWizardPageSimple}}\label{wxwizardpagesimple}
 110
 111 wxWizardPageSimple is the simplest possible
 112 \helpref{wxWizardPage}{wxwizardpage} implementation: it just returns the
 113 pointers given to its constructor from GetNext() and GetPrev() functions.
 114
 115 This makes it very easy to use the objects of this class in the wizards where
 116 the pages order is known statically - on the other hand, if this is not the
 117 case you must derive your own class from \helpref{wxWizardPage}{wxwizardpage}
 118 instead.
 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
 140 \func{}{wxWizardPageSimple}{\param{wxWizard* }{parent = NULL}, \param{wxWizardPage* }{prev = NULL}, \param{wxWizardPage* }{next = NULL},
 141 \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
 142
 143 Constructor 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
 151 Sets the previous page.
 152
 153 \membersection{wxWizardPageSimple::SetNext}\label{wxwizardpagesimplesetnext}
 154
 155 \func{void}{SetNext}{\param{wxWizardPage* }{next}}
 156
 157 Sets the next page.
 158
 159 \membersection{wxWizardPageSimple::Chain}\label{wxwizardpagesimplechain}
 160
 161 \func{static void}{Chain}{\param{wxWizardPageSimple* }{first}, \param{wxWizardPageSimple* }{second}}
 162
 163 A convenience function to make the pages follow each other.
 164
 165 Example:
 166
 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