added a more convenient version of wxFileType::GetOpenCommand()

[wxWidgets.git] / docs / latex / wx / wizard.tex

diff --git a/docs/latex/wx/wizard.tex b/docs/latex/wx/wizard.tex
index 10de3469b785c72b86bfcb39746a2f329acae3ef..6d0866a49b51a78d2a92cd32247142b03fcc46b0 100644 (file)
--- a/docs/latex/wx/wizard.tex
+++ b/docs/latex/wx/wizard.tex
@@ -14,7 +14,7 @@
 wxWizard is the central class for implementing `wizard-like' dialogs. These
 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
 wxWizard is the central class for implementing `wizard-like' dialogs. These
 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

-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
 simple steps and are mainly useful to the novice users, hence it is important
 
 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


@@ -53,14 +53,59 @@ 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).}
 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}%
 
 \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}
 
 \helpref{wxWizardEvent}{wxwizardevent}, \helpref{wxWizardPage}{wxwizardpage}, \helpref{wxWizard sample}{samplewizard}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \wxheading{See also}
 
 \helpref{wxWizardEvent}{wxwizardevent}, \helpref{wxWizardPage}{wxwizardpage}, \helpref{wxWizard sample}{samplewizard}
 
 \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}
 
 \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}}
 \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}}


@@ -74,6 +119,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 
 \helpref{SetPageSize}{wxwizardsetpagesize} function.
 
 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.}
 \wxheading{Parameters}
 
 \docparam{parent}{The parent window, may be NULL.}


@@ -88,13 +137,18 @@ also \helpref{GetBitmap}{wxwizardpagegetbitmap}.}
 \docparam{pos}{The position of the dialog, it will be centered on the screen
 by default.}
 
 \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}
 
 
 \membersection{wxWizard::GetCurrentPage}\label{wxwizardgetcurrentpage}
 


@@ -109,6 +163,14 @@ Get the current page while the wizard is running. {\tt NULL} is returned if
 
 Returns the size available for the pages.
 
 
 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}}
 \membersection{wxWizard::SetPageSize}\label{wxwizardsetpagesize}
 
 \func{void}{SetPageSize}{\param{const wxSize\& }{sizePage}}