X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/213ba43b706f97c0920b70473796871de8a1f6f5..0532a2588121690115f4629cdcbc41d2049e50c0:/docs/latex/wx/wizard.tex diff --git a/docs/latex/wx/wizard.tex b/docs/latex/wx/wizard.tex index d564956088..6d0866a49b 100644 --- a/docs/latex/wx/wizard.tex +++ b/docs/latex/wx/wizard.tex @@ -53,6 +53,7 @@ changed (this event can not be vetoed).} changed (this event can be vetoed).} \twocolitem{{\bf EVT\_WIZARD\_CANCEL(id, func)}}{The user attempted to cancel the wizard (this event may also be vetoed).} +\twocolitem{{\bf EVT\_WIZARD\_HELP(id, func)}}{The wizard help button was pressed.} \end{twocollist}% \wxheading{Extended styles} @@ -136,13 +137,18 @@ also \helpref{GetBitmap}{wxwizardpagegetbitmap}.} \docparam{pos}{The position of the dialog, it will be centered on the screen by default.} -\membersection{wxWizard::RunWizard}\label{wxwizardrunwizard} +\membersection{wxWizard::Fit}\label{wxwizardfit} -\func{bool}{RunWizard}{\param{wxWizardPage* }{firstPage}} +\func{void}{Fit}{\param{const wxWizardPage* }{firstPage}} -Executes the wizard starting from the given page, returns {\tt TRUE} if it was -successfully finished or {\tt FALSE} if user cancelled it. The {\it firstPage} -can not be {\tt NULL}. +Sets the page size to be big enough for all the pages accessible via the +given {\it firstPage}, i.e. this page, its next page and so on. + +This method may be called more than once and it will only change the page size +if the size required by the new page is bigger than the previously set one. +This is useful if the decision about which pages to show is taken during the +run-time as in this case, the wizard won't be able to get to all pages starting +from a single one and you should call {\it Fit} separately for the others. \membersection{wxWizard::GetCurrentPage}\label{wxwizardgetcurrentpage} @@ -157,6 +163,14 @@ Get the current page while the wizard is running. {\tt NULL} is returned if Returns the size available for the pages. +\membersection{wxWizard::RunWizard}\label{wxwizardrunwizard} + +\func{bool}{RunWizard}{\param{wxWizardPage* }{firstPage}} + +Executes the wizard starting from the given page, returns {\tt TRUE} if it was +successfully finished or {\tt FALSE} if user cancelled it. The {\it firstPage} +can not be {\tt NULL}. + \membersection{wxWizard::SetPageSize}\label{wxwizardsetpagesize} \func{void}{SetPageSize}{\param{const wxSize\& }{sizePage}}