/**
@class wxWizardPage
@wxheader{wizard.h}
-
+
wxWizardPage is one of the screens in wxWizard: it must
know what are the following and preceding pages (which may be @NULL for the
first/last page). Except for this extra knowledge, wxWizardPage is just a
panel, so the controls may be placed directly on it in the usual way.
-
+
This class allows the programmer to decide the order of pages in the wizard
dynamically (during run-time) and so provides maximal flexibility. Usually,
- however, the order of pages is known in advance in which case
+ however, the order of pages is known in advance in which case
wxWizardPageSimple class is enough and it is simpler
to use.
-
+
@library{wxadv}
@category{miscwnd}
-
+
@seealso
wxWizard, @ref overview_samplewizard "wxWizard sample"
*/
be of the same size). Notice that no other parameters are needed because the
wizard will resize and reposition the page anyhow.
- @param parent
+ @param parent
The parent wizard
- @param bitmap
+ @param bitmap
The page-specific bitmap if different from the global one
*/
wxWizardPage(wxWizard* parent,
/**
This method is called by wxWizard to get the bitmap to display alongside the
- page. By default, @c m_bitmap member variable which was set in the
+ page. By default, @c m_bitmap member variable which was set in the
@ref wxwizardpage() constructor.
If the bitmap was not explicitly set (i.e. if @c wxNullBitmap is returned),
/**
@class wxWizardEvent
@wxheader{wizard.h}
-
+
wxWizardEvent class represents an event generated by the
wizard: this event is first sent to the page itself and,
if not processed there, goes up the window hierarchy as usual.
-
+
@library{wxadv}
@category{events}
-
+
@seealso
wxWizard, @ref overview_samplewizard "wxWizard sample"
*/
/**
@class wxWizardPageSimple
@wxheader{wizard.h}
-
- wxWizardPageSimple is the simplest possible
+
+ wxWizardPageSimple is the simplest possible
wxWizardPage implementation: it just returns the
pointers given to its constructor from GetNext() and GetPrev() functions.
-
+
This makes it very easy to use the objects of this class in the wizards where
the pages order is known statically - on the other hand, if this is not the
- case you must derive your own class from wxWizardPage
+ case you must derive your own class from wxWizardPage
instead.
-
+
@library{wxadv}
@category{miscwnd}
-
+
@seealso
wxWizard, @ref overview_samplewizard "wxWizard sample"
*/
public:
/**
Constructor takes the previous and next pages. They may be modified later by
- SetPrev() or
+ SetPrev() or
SetNext().
*/
wxWizardPageSimple(wxWizard* parent = @NULL,
/**
@class wxWizard
@wxheader{wizard.h}
-
+
wxWizard is the central class for implementing 'wizard-like' dialogs. These
dialogs are mostly familiar to Windows users and are nothing other than a
sequence of 'pages', each displayed inside a dialog which has the
buttons to navigate 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
to keep them as simple as possible.
-
+
To show a wizard dialog, you must first create an instance of the wxWizard class
using either the non-default constructor or a default one followed by call to
- the
+ the
wxWizard::Create function. Then you should add all pages you
want the wizard to show and call wxWizard::RunWizard.
Finally, don't forget to call @c wizard-Destroy(), otherwise your application
will hang on exit due to an undestroyed window.
-
+
You can supply a bitmap to display on the left of the wizard, either for all
pages
or for individual pages. If you need to have the bitmap resize to the height of
the wizard,
call wxWizard::SetBitmapPlacement and if necessary,
wxWizard::SetBitmapBackgroundColour and wxWizard::SetMinimumBitmapWidth.
-
+
To make wizard pages scroll when the display is too small to fit the whole
dialog, you can switch
layout adaptation on globally with wxDialog::EnableLayoutAdaptation or
per dialog with wxDialog::SetLayoutAdaptationMode. For more
about layout adaptation, see @ref overview_autoscrollingdialogs "Automatic
scrolling dialogs".
-
+
@library{wxadv}
@category{cmndlg}
-
+
@seealso
wxWizardEvent, wxWizardPage, @ref overview_samplewizard "wxWizard sample"
*/
Constructor which really creates the wizard -- if you use this constructor, you
shouldn't call Create().
- Notice that unlike almost all other wxWidgets classes, there is no @e size
+ Notice that unlike almost all other wxWidgets classes, there is no @e size
parameter in the 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
GetPageAreaSizer() function.
- @param parent
+ @param parent
The parent window, may be @NULL.
- @param id
+ @param id
The id of the dialog, will usually be just -1.
- @param title
+ @param title
The title of the dialog.
- @param bitmap
+ @param bitmap
The default bitmap used in the left side of the wizard. See
also GetBitmap.
- @param pos
+ @param pos
The position of the dialog, it will be centered on the screen
by default.
- @param style
+ @param style
Window style is passed to wxDialog.
*/
wxWizard();
- wxWizard(wxWindow* parent, int id = -1,
- const wxString& title = wxEmptyString,
- const wxBitmap& bitmap = wxNullBitmap,
- const wxPoint& pos = wxDefaultPosition,
- long style = wxDEFAULT_DIALOG_STYLE);
+ wxWizard(wxWindow* parent, int id = -1,
+ const wxString& title = wxEmptyString,
+ const wxBitmap& bitmap = wxNullBitmap,
+ const wxPoint& pos = wxDefaultPosition,
+ 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 wxWidgets classes, there is no @e size
+ Notice that unlike almost all other wxWidgets classes, there is no @e size
parameter in the 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
GetPageAreaSizer() function.
- @param parent
+ @param parent
The parent window, may be @NULL.
- @param id
+ @param id
The id of the dialog, will usually be just -1.
- @param title
+ @param title
The title of the dialog.
- @param bitmap
+ @param bitmap
The default bitmap used in the left side of the wizard. See
also GetBitmap.
- @param pos
+ @param pos
The position of the dialog, it will be centered on the screen
by default.
- @param style
+ @param style
Window style is passed to wxDialog.
*/
bool Create(wxWindow* parent, int id = -1,
int GetBitmapPlacement();
/**
- Get the current page while the wizard is running. @NULL is returned if
+ Get the current page while the wizard is running. @NULL is returned if
RunWizard() is not being executed now.
*/
wxWizardPage* GetCurrentPage();
Page area sizer has a minimal size that is the maximum of several values. First,
all pages (or other objects) added to the sizer. Second, all pages reachable
- by repeatedly applying
+ by repeatedly applying
wxWizardPage::GetNext to
any page inserted into the sizer. Third,
- the minimal size specified using SetPageSize() and
+ the minimal size specified using SetPageSize() and
FitToPage(). Fourth, the total wizard height may
be increased to accommodate the bitmap height. Fifth and finally, wizards are
never smaller than some built-in minimal size to avoid wizards that are too
/**
Return @true if this page is not the last one in the wizard. The base
- class version implements this by calling
+ class version implements this by calling
@ref wxWizardPage::getnext page-GetNext but this could be undesirable if,
for example, the pages are created on demand only.
/**
Returns @true if this page is not the last one in the wizard. The base
- class version implements this by calling
+ class version implements this by calling
@ref wxWizardPage::getprev page-GetPrev but this could be undesirable if,
for example, the pages are created on demand only.
/**
Executes the wizard starting from the given page, returning @true if it was
- successfully finished or @false if user cancelled it. The @e firstPage
+ successfully finished or @false if user cancelled it. The @e firstPage
can not be @NULL.
*/
bool RunWizard(wxWizardPage* firstPage);
wizard will never be smaller than the default size.
The recommended way to use this function is to lay out all wizard pages using
- the sizers (even though the wizard is not resizeable) and then use
+ the sizers (even though the wizard is not resizeable) and then use
wxSizer::CalcMin in a loop to calculate the maximum
of minimal sizes of the pages and pass it to SetPageSize().
*/
projects / wxWidgets.git / blobdiff