X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..1e8dba5e29eba7ac5e53fa4035e65ceeaeed3884:/docs/latex/wx/wizpage.tex diff --git a/docs/latex/wx/wizpage.tex b/docs/latex/wx/wizpage.tex index 2418fe5dd5..1b6812c26b 100644 --- a/docs/latex/wx/wizpage.tex +++ b/docs/latex/wx/wizpage.tex @@ -16,8 +16,8 @@ know what are the following and preceding pages (which may be {\tt NULL} for the first/last page). Except for this extra knowledge, wxWizardPage is just a panel, so the controls may be placed directly on it in the usual way. -This class allows to decide what is the orde fo pages in the wizard -dynamically (during run-time) and so providex maximal flexibility. Usually, +This class allows the programmer to decide the order of pages in the wizard +dynamically (during run-time) and so provides maximal flexibility. Usually, however, the order of pages is known in advance in which case \helpref{wxWizardPageSimple}{wxwizardpagesimple} class is enough and it is simpler to use. @@ -50,13 +50,21 @@ should be very rarely needed. \membersection{wxWizardPage::wxWizardPage}\label{wxwizardpagewxwizardpage} -\func{}{wxWizardPage}{\param{wxWizard* }{parent}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}} +\func{}{wxWizardPage}{\param{wxWizard* }{parent}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}, \param{const wxChar }{*resource = NULL}} Constructor accepts an optional bitmap which will be used for this page instead of the default one for this wizard (note that all bitmaps used should be of the same size). Notice that no other parameters are needed because the wizard will resize and reposition the page anyhow. +\wxheading{Parameters} + +\docparam{parent}{The parent wizard} + +\docparam{bitmap}{The page-specific bitmap if different from the global one} + +\docparam{resource}{Load the page from the specified resource if non-NULL} + \membersection{wxWizardPage::GetPrev}\label{wxwizardpagegetprev} \constfunc{wxWizardPage*}{GetPrev}{\void} @@ -105,7 +113,7 @@ wxWizardPageSimple is the simplest possible \helpref{wxWizardPage}{wxwizardpage} implementation: it just returns the pointers given to its constructor from GetNext() and GetPrev() functions. -This makes it very easy to use the obejcts of this class in the wizards where +This makes it very easy to use the objects of this class in the wizards where the pages order is known statically - on the other hand, if this is not the case you must derive your own class from \helpref{wxWizardPage}{wxwizardpage} instead. @@ -130,7 +138,8 @@ instead. \membersection{wxWizardPageSimple::wxWizardPageSimple}\label{wxwizardpagesimplewxwizardpagesimple} -\func{}{wxWizardPageSimple}{\param{wxWizard* }{parent = NULL}, \param{wxWizardPage* }{prev = NULL}, \param{wxWizardPage* }{next = NULL}} +\func{}{wxWizardPageSimple}{\param{wxWizard* }{parent = NULL}, \param{wxWizardPage* }{prev = NULL}, \param{wxWizardPage* }{next = NULL}, +\param{const wxBitmap\& }{bitmap = wxNullBitmap}} Constructor takes the previous and next pages. They may be modified later by \helpref{SetPrev()}{wxwizardpagesimplesetprev} or @@ -155,6 +164,7 @@ Sets the next page. A convenience function to make the pages follow each other. Example: + \begin{verbatim} wxRadioboxPage *page3 = new wxRadioboxPage(wizard); wxValidationPage *page4 = new wxValidationPage(wizard);