## wxWizard

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 Create function. Then you should add all pages you want the wizard to show and call RunWizard. Finally, don't forget to call `wizard->Destroy()`, otherwise your application will hang on exit due to an undestroyed window.

Derived from

wxDialog
wxPanel
wxWindow
wxEvtHandler
wxObject

Include files

<wx/wizard.h>

Event table macros

To process input from a wizard dialog, use these event handler macros to direct input to member functions that take a wxWizardEvent argument. For some events, Veto() can be called to prevent the event from happening.

EVT_WIZARD_PAGE_CHANGED(id, func) | The page has just been changed (this event cannot be vetoed).
EVT_WIZARD_PAGE_CHANGING(id, func) | The page is being changed (this event can be vetoed).
EVT_WIZARD_PAGE_SHOWN(id, func) | The page was shown and laid out.
EVT_WIZARD_CANCEL(id, func) | The user attempted to cancel the wizard (this event may also be vetoed).
EVT_WIZARD_HELP(id, func) | The wizard help button was pressed.
EVT_WIZARD_FINISHED(id, func) | The wizard finished button was pressed.

Extended styles

Use the wxWindow::SetExtraStyle function to set the following style. You will need to use two-step construction (use the default constructor, call SetExtraStyle, then call Create).

wxWIZARD_EX_HELPBUTTON | Shows a Help button using wxID_HELP.

See also wxDialog for other extended styles.

See also

wxWizardEvent, wxWizardPage, wxWizard sample

Members

wxWizard::wxWizard
wxWizard::Create
wxWizard::FitToPage
wxWizard::GetBitmap
wxWizard::GetCurrentPage
wxWizard::GetPageAreaSizer
wxWizard::GetPageSize
wxWizard::HasNextPage
wxWizard::HasPrevPage
wxWizard::RunWizard
wxWizard::SetBitmap
wxWizard::SetPageSize
wxWizard::SetBorder

### wxWizard::wxWizard

wxWizard()

Default constructor. Use this if you wish to derive from wxWizard and then call Create, for example if you wish to set an extra style with wxWindow::SetExtraStyle between the two calls.

wxWizard(wxWindow* parent, int id = -1, const wxString& title = wxEmptyString, const wxBitmap& bitmap = wxNullBitmap, const wxPoint& pos = wxDefaultPosition, long style = wxDEFAULT_DIALOG_STYLE)

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 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 GetPageAreaSizer function.

Parameters

parent

The parent window, may be NULL.

id

The id of the dialog, will usually be just -1.

title

The title of the dialog.

bitmap

The default bitmap used in the left side of the wizard. See also GetBitmap.

pos

The position of the dialog, it will be centered on the screen by default.

style

Window style is passed to wxDialog.

### wxWizard::Create

bool Create(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 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 GetPageAreaSizer function.

Parameters

parent

The parent window, may be NULL.

id

The id of the dialog, will usually be just -1.

title

The title of the dialog.

bitmap

The default bitmap used in the left side of the wizard. See also GetBitmap.

pos

The position of the dialog, it will be centered on the screen by default.

style

Window style is passed to wxDialog.

### wxWizard::FitToPage

void FitToPage(const wxWizardPage* firstPage)

This method is obsolete, use GetPageAreaSizer instead.

Sets the page size to be big enough for all the pages accessible via the given 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 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 Fit separately for the others.

### wxWizard::GetBitmap

const wxBitmap& GetBitmap() const

Returns the bitmap used for the wizard.

### wxWizard::GetCurrentPage

wxWizardPage* GetCurrentPage() const

Get the current page while the wizard is running. `NULL` is returned if RunWizard() is not being executed now.

### wxWizard::GetPageAreaSizer

virtual wxSizer* GetPageAreaSizer() const

Returns pointer to page area sizer. The wizard is laid out using sizers and the 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 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 wxWizardPage::GetNext to any page inserted into the sizer. Third, 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 small.

The caller can use wxSizer::SetMinSize to enlarge it beyond the minimal size. If `wxRESIZE_BORDER` was passed to constructor, user can resize wizard and consequently the page area (but not make it smaller than the minimal size).

It is recommended to add the first page to the page area sizer. For simple wizards, this will enlarge the wizard to fit the biggest page. For non-linear wizards, the first page of every separate chain should be added. Caller-specified size can be accomplished using wxSizer::SetMinSize.

Adding pages to the page area sizer affects the default border width around page area that can be altered with SetBorder.

### wxWizard::GetPageSize

wxSize GetPageSize() const

Returns the size available for the pages.

### wxWizard::HasNextPage

virtual bool HasNextPage(wxWizardPage *page)

Return `true` if this page is not the last one in the wizard. The base class version implements this by calling page->GetNext but this could be undesirable if, for example, the pages are created on demand only.

See also

HasPrevPage

### wxWizard::HasPrevPage

virtual bool HasPrevPage(wxWizardPage *page)

Returns `true` if this page is not the last one in the wizard. The base class version implements this by calling page->GetPrev but this could be undesirable if, for example, the pages are created on demand only.

See also

HasNextPage

### wxWizard::RunWizard

bool RunWizard(wxWizardPage* firstPage)

Executes the wizard starting from the given page, returning `true` if it was successfully finished or `false` if user cancelled it. The firstPage can not be `NULL`.

### wxWizard::SetBitmap

void SetBitmap(const wxBitmap& bitmap)

Sets the bitmap used for the wizard.

### wxWizard::SetPageSize

void SetPageSize(const wxSize& sizePage)

This method is obsolete, use GetPageAreaSizer 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.

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 wxSizer::CalcMin in a loop to calculate the maximum of minimal sizes of the pages and pass it to SetPageSize().

### wxWizard::SetBorder

void SetBorder(int border)

Sets width of border around page area. Default is zero. For backward compatibility, if there are no pages in GetPageAreaSizer, the default is 5 pixels.

If there is a five point border around all controls in a page and the border around page area is left as zero, a five point white space along all dialog borders will be added to the control border in order to space page controls ten points from the dialog border and non-page controls.