wxWizardPage

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 wxWizardPageSimple class is enough and it is simpler to use.

Virtual functions to override

To use this class, you must override GetPrev and GetNext pure virtual functions (or you may use wxWizardPageSimple instead).

GetBitmap can also be overridden, but this should be very rarely needed.

Derived from

wxPanel
wxWindow
wxEvtHandler
wxObject

Include files

<wx/wizard.h>

See also

wxWizard, wxWizard sample

Members

wxWizardPage::wxWizardPage
wxWizardPage::GetPrev
wxWizardPage::GetNext
wxWizardPage::GetBitmap

wxWizardPage::wxWizardPage

wxWizardPage(wxWizard* parent, const wxBitmap& bitmap = wxNullBitmap, const wxChar *resource = NULL)

Constructor accepts an optional bitmap which will be used for this page instead of the default one for this wizard (note that all bitmaps used should be of the same size). Notice that no other parameters are needed because the wizard will resize and reposition the page anyhow.

Parameters

parent

The parent wizard

bitmap

The page-specific bitmap if different from the global one

resource

Load the page from the specified resource if non-NULL

wxWizardPage::GetPrev

wxWizardPage* GetPrev() const

Get the page which should be shown when the user chooses the "Back" button: if NULL is returned, this button will be disabled. The first page of the wizard will usually return NULL from here, but the others will not.

See also

GetNext

wxWizardPage::GetNext

wxWizardPage* GetNext() const

Get the page which should be shown when the user chooses the "Next" button: if NULL is returned, this button will be disabled. The last page of the wizard will usually return NULL from here, but the others will not.

See also

GetPrev

wxWizardPage::GetBitmap

wxBitmap GetBitmap() const

This method is called by wxWizard to get the bitmap to display alongside the page. By default, m_bitmap member variable which was set in the constructor.

If the bitmap was not explicitly set (i.e. if wxNullBitmap is returned), the default bitmap for the wizard should be used.

The only cases when you would want to override this function is if the page bitmap depends dynamically on the user choices, i.e. almost never.