Added doc for 2-step initialisation and wxWIZARD_EX_HELPBUTTON style.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@11400 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart 2001-08-17 09:38:53 +00:00
parent 77436c4cba
commit 213ba43b70

View File

@ -14,7 +14,7 @@
wxWizard is the central class for implementing `wizard-like' dialogs. These wxWizard is the central class for implementing `wizard-like' dialogs. These
dialogs are mostly familiar to Windows users and are nothing else but a dialogs are mostly familiar to Windows users and are nothing else but a
sequence of `pages' each of them displayed inside a dialog which has the sequence of `pages' each of them displayed inside a dialog which has the
buttons to pas to the next (and previous) pages. buttons to pass to the next (and previous) pages.
The wizards are typically used to decompose a complex dialog into several The wizards are typically used to decompose a complex dialog into several
simple steps and are mainly useful to the novice users, hence it is important simple steps and are mainly useful to the novice users, hence it is important
@ -55,12 +55,56 @@ changed (this event can be vetoed).}
the wizard (this event may also be vetoed).} the wizard (this event may also be vetoed).}
\end{twocollist}% \end{twocollist}%
\wxheading{Extended styles}
Use the \helpref{wxWindow::SetExtraStyle}{wxwindowsetextrastyle} function to set the following
style. You will need to use two-step construction (use the default constructor, call {\bf SetExtraStyle}, then call {\bf Create}).
\twocolwidtha{5cm}%
\begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxWIZARD\_EX\_HELPBUTTON}}{Shows a Help button using wxID\_HELP.}
\end{twocollist}
See also \helpref{wxDialog}{wxdialog} for other extended styles.
\wxheading{See also} \wxheading{See also}
\helpref{wxWizardEvent}{wxwizardevent}, \helpref{wxWizardPage}{wxwizardpage}, \helpref{wxWizard sample}{samplewizard} \helpref{wxWizardEvent}{wxwizardevent}, \helpref{wxWizardPage}{wxwizardpage}, \helpref{wxWizard sample}{samplewizard}
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxWizard::wxWizard}\label{wxwizardctor}
\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}.
\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.
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.
\wxheading{Parameters}
\docparam{parent}{The parent window, may be NULL.}
\docparam{id}{The id of the dialog, will usually be just $-1$.}
\docparam{title}{The title of the dialog.}
\docparam{bitmap}{The default bitmap used in the left side of the wizard. See
also \helpref{GetBitmap}{wxwizardpagegetbitmap}.}
\docparam{pos}{The position of the dialog, it will be centered on the screen
by default.}
\membersection{wxWizard::Create}\label{wxwizardcreate} \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{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}}
@ -74,6 +118,10 @@ 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 default size by default. If you want to change this, you should use the
\helpref{SetPageSize}{wxwizardsetpagesize} function. \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} \wxheading{Parameters}
\docparam{parent}{The parent window, may be NULL.} \docparam{parent}{The parent window, may be NULL.}