X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c73b439f80d84ce1a58d862835b3b8cc3fb96f5d..8da8907446d4b07378b8564e93c05b9e7257de15:/docs/latex/wx/wizard.tex diff --git a/docs/latex/wx/wizard.tex b/docs/latex/wx/wizard.tex index 6d0866a49b..ebe73802ee 100644 --- a/docs/latex/wx/wizard.tex +++ b/docs/latex/wx/wizard.tex @@ -21,8 +21,9 @@ simple steps and are mainly useful to the novice users, hence it is important to keep them as simple as possible. To show a wizard dialog, you must first create an object of wxWizard class -using \helpref{Create}{wxwizardcreate} function. Then you should add all pages -you want the wizard to show and call \helpref{RunWizard}{wxwizardrunwizard}. +using either the non default constructor or a default one followed by call to +\helpref{Create}{wxwizardcreate} function. Then you should add all pages you +want the wizard to show and call \helpref{RunWizard}{wxwizardrunwizard}. Finally, don't forget to call {\tt wizard->Destroy()}. \wxheading{Derived from} @@ -54,6 +55,7 @@ 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.} +\twocolitem{{\bf EVT\_WIZARD\_FINISHED(id, func)}}{The wizard finished button was pressed.} \end{twocollist}% \wxheading{Extended styles} @@ -78,14 +80,15 @@ See also \helpref{wxDialog}{wxdialog} for other extended styles. \func{}{wxWizard}{\void} -Default constructor. Use this if you wish to derive from wxWizard and then call {\bf Create}, for example -if you wish to set an extra style with \helpref{wxWindow::SetExtraStyle}{wxwindowsetextrastyle}. +Default constructor. Use this if you wish to derive from wxWizard and then call +\helpref{Create}{wxwizardcreate}, for example if you wish to set an extra style +with \helpref{wxWindow::SetExtraStyle}{wxwindowsetextrastyle} between the two +calls. \func{}{wxWizard}{\param{wxWindow* }{parent}, \param{int }{id = -1}, \param{const wxString\& }{title = wxEmptyString}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}, \param{const wxPoint\& }{pos = wxDefaultPosition}} -Creates the wizard dialog. The wizard should not be deleted -directly, you should rather call {\tt Destroy()} on it and wxWindows will -delete it itself. +Constructor which really creates the wizard -- if you use this constructor, you +shouldn't call \helpref{Create}{wxwizardcreate}. Notice that unlike almost all other wxWindows classes, there is no {\it size} parameter in wxWizard constructor because the wizard will have a predefined @@ -108,21 +111,16 @@ by default.} \membersection{wxWizard::Create}\label{wxwizardcreate} -\func{static wxWizard*}{Create}{\param{wxWindow* }{parent}, \param{int }{id = -1}, \param{const wxString\& }{title = wxEmptyString}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}, \param{const wxPoint\& }{pos = wxDefaultPosition}} +\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}} -Creates the wizard dialog. The returned pointer should not be deleted -directly, you should rather call {\tt Destroy()} on it and wxWindows will -delete it itself. +Creates the wizard dialog. Must be called if the default constructor had been +used to create the object. Notice that unlike almost all other wxWindows classes, there is no {\it size} parameter in wxWizard constructor because the wizard will have a predefined default size by default. If you want to change this, you should use the \helpref{SetPageSize}{wxwizardsetpagesize} function. -\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}} - -Alternative, non-static constructor for two-step construction of a class derived from wxWizard. - \wxheading{Parameters} \docparam{parent}{The parent window, may be NULL.} @@ -137,9 +135,9 @@ also \helpref{GetBitmap}{wxwizardpagegetbitmap}.} \docparam{pos}{The position of the dialog, it will be centered on the screen by default.} -\membersection{wxWizard::Fit}\label{wxwizardfit} +\membersection{wxWizard::FitToPage}\label{wxwizardfittopage} -\func{void}{Fit}{\param{const wxWizardPage* }{firstPage}} +\func{void}{FittoPage}{\param{const wxWizardPage* }{firstPage}} 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. @@ -163,6 +161,32 @@ Get the current page while the wizard is running. {\tt NULL} is returned if Returns the size available for the pages. +\membersection{wxWizard::HasNextPage}\label{wxwizardhasnextpage} + +\func{virtual bool}{HasNextPage}{\param{wxWizardPage *}{page}} + +Return {\tt TRUE} if this page is not the last one in the wizard. The base +class version implements this by calling +\helpref{page->GetNext}{wxwizardpagegetnext} but this could be undesirable if, +for example, the pages are created on demand only. + +\wxheading{See also} + +\helpref{HasPrevPage}{wxwizardhasprevpage} + +\membersection{wxWizard::HasPrevPage}\label{wxwizardhasprevpage} + +\func{virtual bool}{HasPrevPage}{\param{wxWizardPage *}{page}} + +Return {\tt TRUE} if this page is not the last one in the wizard. The base +class version implements this by calling +\helpref{page->GetPrev}{wxwizardpagegetprev} but this could be undesirable if, +for example, the pages are created on demand only. + +\wxheading{See also} + +\helpref{HasNextPage}{wxwizardhasnextpage} + \membersection{wxWizard::RunWizard}\label{wxwizardrunwizard} \func{bool}{RunWizard}{\param{wxWizardPage* }{firstPage}}