%% Name: wizard.tex
%% Purpose: wxWizard class documentation
%% Author: Vadim Zeitlin
-%% Modified by:
+%% Modified by: Robert Vazan (sizers)
%% Created: 02.04.00
%% RCS-ID: $Id$
%% Copyright: (c) Vadim Zeitlin
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}}
+\func{}{wxWizard}{\param{wxWindow* }{parent}, \param{int }{id = -1}, \param{const wxString\& }{title = wxEmptyString}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{long }{style = wxDEFAULT_DIALOG_STYLE}}
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
default size by default. If you want to change this, you should use the
-\helpref{SetPageSize}{wxwizardsetpagesize} function.
+\helpref{GetPageAreaSizer}{wxwizardgetpageareasizer} function.
\wxheading{Parameters}
\docparam{pos}{The position of the dialog, it will be centered on the screen
by default.}
+\docparam{style}{Window style is passed to wxDialog.}
+
+
\membersection{wxWizard::Create}\label{wxwizardcreate}
-\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}}
+\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}, \param{long }{style = wxDEFAULT_DIALOG_STYLE}}
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.
+\helpref{GetPageAreaSizer}{wxwizardgetpageareasizer} function.
\wxheading{Parameters}
\docparam{pos}{The position of the dialog, it will be centered on the screen
by default.}
+\docparam{style}{Window style is passed to wxDialog.}
+
+
\membersection{wxWizard::FitToPage}\label{wxwizardfittopage}
-\func{void}{FittoPage}{\param{const wxWizardPage* }{firstPage}}
+\func{void}{FitToPage}{\param{const wxWizardPage* }{firstPage}}
+
+This method is obsolete, use
+\helpref{GetPageAreaSizer}{wxwizardgetpageareasizer} instead.
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.
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}
\constfunc{wxWizardPage*}{GetCurrentPage}{\void}
Get the current page while the wizard is running. {\tt NULL} is returned if
\helpref{RunWizard()}{wxwizardrunwizard} is not being executed now.
+
+\membersection{wxWizard::GetPageAreaSizer}\label{wxwizardgetpageareasizer}
+
+\constfunc{virtual wxSizer*}{GetPageAreaSizer}{\void}
+
+Returns pointer to page area sizer. Wizard is laid out using sizers and
+page area sizer is the place holder for the pages. All pages are resized before
+being shown to match the wizard page area.
+
+Page area sizer has minimal size that is maximum of several values. First,
+all pages (or other objects) added to the sizer. Second, all pages reachable
+by repeatedly applying
+\helpref{wxWizardPage::GetNext}{wxwizardpagegetnext} to
+any page inserted into the sizer. Third,
+minimal size specified using \helpref{SetPageSize}{wxwizardsetpagesize} and
+\helpref{FitToPage}{wxwizardfittopage}. Fourth, the total wizard height may
+be increased to accomodate the bitmap height. Fifth and finally, wizards are
+never smaller some built-in minimal size to avoid too small wizards.
+
+Caller can use \helpref{wxSizer::SetMinSize}{wxsizersetminsize} to enlarge it
+beyond minimal size. If {\tt wxRESIZE\_BORDER} was passed to constructor, user
+can resize wizard and consequently page area (but not make it smaller than the
+minimal size).
+
+It is recommended to add first page to page area sizer. For simple wizards,
+this will enlarge the wizard to fit biggest page. For non-linear wizards,
+first page of every separate chain should be added. Caller-specified size
+can be accomplished using \helpref{wxSizer::SetMinSize}{wxsizersetminsize}.
+
+Adding pages to page area sizer affects default border width around page
+area that can be altered with \helpref{SetBorder}{wxwizardsetborder}.
+
+
\membersection{wxWizard::GetPageSize}\label{wxwizardgetpagesize}
\constfunc{wxSize}{GetPageSize}{\void}
Returns the size available for the pages.
+
\membersection{wxWizard::HasNextPage}\label{wxwizardhasnextpage}
\func{virtual bool}{HasNextPage}{\param{wxWizardPage *}{page}}
\helpref{HasPrevPage}{wxwizardhasprevpage}
+
\membersection{wxWizard::HasPrevPage}\label{wxwizardhasprevpage}
\func{virtual bool}{HasPrevPage}{\param{wxWizardPage *}{page}}
\helpref{HasNextPage}{wxwizardhasnextpage}
+
\membersection{wxWizard::RunWizard}\label{wxwizardrunwizard}
\func{bool}{RunWizard}{\param{wxWizardPage* }{firstPage}}
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}}
+This method is obsolete, use
+\helpref{GetPageAreaSizer}{wxwizardgetpageareasizer} instead.
+
Sets the minimal size to be made available for the wizard pages. The wizard
will take into account the size of the bitmap (if any) itself. Also, the
wizard will never be smaller than the default size.
\helpref{wxSizer::CalcMin}{wxsizercalcmin} in a loop to calculate the maximum
of minimal sizes of the pages and pass it to SetPageSize().
+
+\membersection{wxWizard::SetBorder}\label{wxwizardsetborder}
+
+\func{void}{SetBorder}{\param{int }{border}}
+
+Sets width of border around page area. Default is zero. For backward
+compatibility, if there are no pages in
+\helpref{GetPageAreaSizer}{wxwizardgetpageareasizer}, default is $5$ pixels.
+
+If there is five point border around all controls in a page and border around
+page area is left zero, five point white space along all dialog borders
+will be added to control border to space page controls ten points from dialog
+border and non-page controls.
+
projects / wxWidgets.git / blobdiff