wx.adv.Wizard

wx.adv.Wizard 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 wx.adv.Wizard class using either the non-default constructor or a default one followed by call to the wx.adv.Wizard.Create function. Then you should add all pages you want the wizard to show and call wx.adv.Wizard.RunWizard . Finally, don’t forget to call "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 wx.adv.Wizard.SetBitmapPlacement and if necessary, wx.adv.Wizard.SetBitmapBackgroundColour and wx.adv.Wizard.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 wx.Dialog.EnableLayoutAdaptation or per dialog with wx.Dialog.SetLayoutAdaptationMode . For more about layout adaptation, see Automatic Scrolled Dialogs.

Events Emitted by this Class

Handlers bound for the following event types will receive a wx.adv.WizardEvent parameter.

• EVT_WIZARD_PAGE_CHANGED: The page has just been changed (this event cannot be vetoed).
• EVT_WIZARD_PAGE_CHANGING: The page is being changed (this event can be vetoed).
• EVT_WIZARD_BEFORE_PAGE_CHANGED: Called after Next is clicked but before GetNext is called. Unlike EVT_WIZARD_CHANGING, the handler for this function can change state that might affect the return value of GetNext. This event can be vetoed.
• EVT_WIZARD_PAGE_SHOWN: The page was shown and laid out (this event cannot be vetoed).
• EVT_WIZARD_CANCEL: The user attempted to cancel the wizard (this event may also be vetoed).
• EVT_WIZARD_HELP: The wizard help button was pressed.
• EVT_WIZARD_FINISHED: The wizard finished button was pressed.

Extended styles

Window Extra Styles

Use the wx.Window.SetExtraStyle function to set the following style. You will need to use two-step construction (use the default constructor, call SetExtraStyle, then call Create). This class supports the following extra styles:

• wx.adv.WIZARD_EX_HELPBUTTON: Shows a Help button using wx.ID_HELP.

See also

wx.Dialog for other extended styles.

See also

wx.adv.WizardEvent, wx.adv.WizardPage, Wizard Sample

Class Hierarchy

Inheritance diagram for class Wizard:

Methods Summary

__init__	Default constructor.
Create	Creates the wizard dialog.
FitToPage	This method is obsolete, use GetPageAreaSizer instead.
GetBitmap	Returns the bitmap used for the wizard.
GetBitmapBackgroundColour	Returns the colour that should be used to fill the area not taken up by the wizard or page bitmap, if a non-zero bitmap placement flag has been set.
GetBitmapPlacement	Returns the flags indicating how the wizard or page bitmap should be expanded and positioned to fit the page height.
GetCurrentPage	Get the current page while the wizard is running.
GetMinimumBitmapWidth	Returns the minimum width for the bitmap that will be constructed to contain the actual wizard or page bitmap if a non-zero bitmap placement flag has been set.
GetPageAreaSizer	Returns pointer to page area sizer.
GetPageSize	Returns the size available for the pages.
HasNextPage	Return True if this page is not the last one in the wizard.
HasPrevPage	Returns True if this page is not the last one in the wizard.
IsRunning
RunWizard	Executes the wizard starting from the given page, returning True if it was successfully finished or False if user cancelled it.
SetBitmap	Sets the bitmap used for the wizard.
SetBitmapBackgroundColour	Sets the colour that should be used to fill the area not taken up by the wizard or page bitmap, if a non-zero bitmap placement flag has been set.
SetBitmapPlacement	Sets the flags indicating how the wizard or page bitmap should be expanded and positioned to fit the page height.
SetBorder	Sets width of border around page area.
SetMinimumBitmapWidth	Sets the minimum width for the bitmap that will be constructed to contain the actual wizard or page bitmap if a non-zero bitmap placement flag has been set.
SetPageSize	Sets the minimal size to be made available for the wizard pages.
ShowPage	Show the given wizard page.

Properties Summary

Bitmap	See GetBitmap and SetBitmap
BitmapBackgroundColour	See GetBitmapBackgroundColour and SetBitmapBackgroundColour
BitmapPlacement	See GetBitmapPlacement and SetBitmapPlacement
CurrentPage	See GetCurrentPage
MinimumBitmapWidth	See GetMinimumBitmapWidth and SetMinimumBitmapWidth
PageAreaSizer	See GetPageAreaSizer
PageSize	See GetPageSize and SetPageSize

Class API

---

class wx.adv.Wizard(Dialog)

Possible constructors:

Wizard()

Wizard(parent, id=ID_ANY, title="", bitmap=NullBitmap,
       pos=DefaultPosition, style=DEFAULT_DIALOG_STYLE)

Wizard is the central class for implementing ‘wizard-like’ dialogs.

Methods

---

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

Use this if you wish to derive from wx.adv.Wizard and then call Create , for example if you wish to set an extra style with wx.Window.SetExtraStyle between the two calls.

---

__init__ (self, parent, id=ID_ANY, title=””, bitmap=NullBitmap, pos=DefaultPosition, style=DEFAULT_DIALOG_STYLE)

Constructor which really creates the wizard Create .

Notice that unlike almost all other wxWidgets classes, there is no size parameter in the wx.adv.Wizard 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 (wx.Window) – The parent window, may be None.
• id (int) – The id of the dialog, will usually be just wx.ID_ANY.
• title (string) – The title of the dialog.
• bitmap (wx.Bitmap) – The default bitmap used in the left side of the wizard. See also GetBitmap .
• pos (wx.Point) – The position of the dialog, it will be centered on the screen by default.
• style (long) – Window style is passed to wx.Dialog.

---

---

Create(self, parent, id=ID_ANY, title="", bitmap=NullBitmap, pos=DefaultPosition, style=DEFAULT_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 wx.adv.Wizard 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 (wx.Window) – The parent window, may be None.
• id (int) – The id of the dialog, will usually be just -1.
• title (string) – The title of the dialog.
• bitmap (wx.Bitmap) – The default bitmap used in the left side of the wizard. See also GetBitmap .
• pos (wx.Point) – The position of the dialog, it will be centered on the screen by default.
• style (long) – Window style is passed to wx.Dialog.

Return type:

bool

---

FitToPage(self, 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.

Parameters:firstPage (wx.adv.WizardPage) –

---

GetBitmap(self)

Returns the bitmap used for the wizard.

Return type:Bitmap

---

GetBitmapBackgroundColour(self)

Returns the colour that should be used to fill the area not taken up by the wizard or page bitmap, if a non-zero bitmap placement flag has been set.

See also SetBitmapPlacement .

Return type:Colour

---

GetBitmapPlacement(self)

Returns the flags indicating how the wizard or page bitmap should be expanded and positioned to fit the page height.

By default, placement is 0 (no expansion is done).

See also SetBitmapPlacement for the possible values.

Return type:int

---

GetCurrentPage(self)

Get the current page while the wizard is running.

None is returned if RunWizard is not being executed now.

Return type: wx.adv.WizardPage

---

GetMinimumBitmapWidth(self)

Returns the minimum width for the bitmap that will be constructed to contain the actual wizard or page bitmap if a non-zero bitmap placement flag has been set.

See also SetBitmapPlacement .

Return type:int

---

GetPageAreaSizer(self)

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 wx.adv.WizardPage.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 wx.Sizer.SetMinSize to enlarge it beyond the minimal size. If RESIZE_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 wx.Sizer.SetMinSize . Adding pages to the page area sizer affects the default border width around page area that can be altered with SetBorder .

Return type:Sizer

---

GetPageSize(self)

Returns the size available for the pages.

Return type:Size

---

HasNextPage(self, 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.

Parameters:page (wx.adv.WizardPage) – Return type:bool

See also

HasPrevPage

---

HasPrevPage(self, 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.

Parameters:page (wx.adv.WizardPage) – Return type:bool

See also

HasNextPage

---

IsRunning(self)

Return type:bool

---

RunWizard(self, firstPage)

Executes the wizard starting from the given page, returning True if it was successfully finished or False if user cancelled it.

The firstPage cannot be None.

Parameters:firstPage (wx.adv.WizardPage) – Return type:bool

---

SetBitmap(self, bitmap)

Sets the bitmap used for the wizard.

Parameters:bitmap (wx.Bitmap) –

---

SetBitmapBackgroundColour(self, colour)

Sets the colour that should be used to fill the area not taken up by the wizard or page bitmap, if a non-zero bitmap placement flag has been set.

See also SetBitmapPlacement .

Parameters:colour (wx.Colour) –

---

SetBitmapPlacement(self, placement)

Sets the flags indicating how the wizard or page bitmap should be expanded and positioned to fit the page height.

By default, placement is 0 (no expansion is done). placement is a bitlist with the following possible values:

• wx.adv.WIZARD_VALIGN_TOP: Aligns the bitmap at the top.
• wx.adv.WIZARD_VALIGN_CENTRE: Centres the bitmap vertically.
• wx.adv.WIZARD_VALIGN_BOTTOM: Aligns the bitmap at the bottom.
• wx.adv.WIZARD_HALIGN_LEFT: Left-aligns the bitmap.
• wx.adv.WIZARD_HALIGN_CENTRE: Centres the bitmap horizontally.
• wx.adv.WIZARD_HALIGN_RIGHT: Right-aligns the bitmap.
• wx.adv.WIZARD_TILE: todo 52.

See also SetMinimumBitmapWidth .

Parameters:placement (int) –

---

SetBorder(self, 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.

Parameters:border (int) –

---

SetMinimumBitmapWidth(self, width)

Sets the minimum width for the bitmap that will be constructed to contain the actual wizard or page bitmap if a non-zero bitmap placement flag has been set.

If this is not set when using bitmap placement, the initial layout may be incorrect.

See also SetBitmapPlacement .

Parameters:width (int) –

---

SetPageSize(self, sizePage)

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 resizable) and then use wx.Sizer.CalcMin in a loop to calculate the maximum of minimal sizes of the pages and pass it to SetPageSize .

Parameters:sizePage (wx.Size) –

---

ShowPage(self, page, goingForward=True)

Show the given wizard page.

C

a

l

l

s

T

r

a

n

s

f

e

r

D

a

t

a

F

r

o

m

W

i

n

d

o

w

o

n

t

h

e

c

u

r

r

e

n

t

p

a

g

e

f

i

r

s

t

,

a

n

d

r

e

t

u

r

n

s

f

a

l

s

e

w

i

t

h

o

u

t

c

h

a

n

g

i

n

g

t

h

e

p

a

g

e

i

f

i

t

r

e

t

u

r

n

e

d

f

a

l

s

e

.

R

e

t

u

r

n

s

T

r

u

e

/

F

a

l

s

e

t

o

i

n

d

i

c

a

t

e

i

f

t

h

e

p

a

g

e

w

a

s

a

c

t

u

a

l

l

y

c

h

a

n

g

e

d

.

Parameters:

• page (wx.adv.WizardPage) –
• goingForward (bool) –

Return type:

bool

Properties

---

Bitmap

See GetBitmap and SetBitmap

---

BitmapBackgroundColour

See GetBitmapBackgroundColour and SetBitmapBackgroundColour

---

BitmapPlacement

See GetBitmapPlacement and SetBitmapPlacement

---

CurrentPage

See GetCurrentPage

---

MinimumBitmapWidth

See GetMinimumBitmapWidth and SetMinimumBitmapWidth

---

PageAreaSizer

See GetPageAreaSizer

---

PageSize

See GetPageSize and SetPageSize