Phoenix Logo

phoenix_title wx.adv.WizardPage

wx.adv.WizardPage is one of the screens in wx.adv.Wizard: it must know what are the following and preceding pages (which may be None for the first/last page).

Except for this extra knowledge, wx.adv.WizardPage 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 wx.adv.WizardPageSimple class is enough and it is simpler to use.

phoenix_title Virtual functions to override

To use this class, you must override wx.adv.WizardPage.GetPrev and wx.adv.WizardPage.GetNext pure virtual functions (or you may use wx.adv.WizardPageSimple instead). wx.adv.WizardPage.GetBitmap can also be overridden, but this should be very rarely needed.

See also

wx.adv.Wizard, Wizard Sample


class_hierarchy Class Hierarchy

Inheritance diagram for class WizardPage:

sub_classes Known Subclasses

wx.adv.WizardPageSimple


method_summary Methods Summary

__init__ Default constructor.
Create Creates the wizard page.
GetBitmap This method is called by wx.adv.Wizard to get the bitmap to display alongside the page.
GetNext Get the page which should be shown when the user chooses the "Next" button: if None is returned, this button will be disabled.
GetPrev Get the page which should be shown when the user chooses the "Back" button: if None is returned, this button will be disabled.

property_summary Properties Summary

Bitmap See GetBitmap
Next See GetNext
Prev See GetPrev

api Class API



class wx.adv.WizardPage(Panel)

Possible constructors:

WizardPage()

WizardPage(parent, bitmap=NullBitmap)

WizardPage is one of the screens in Wizard: it must know what are the following and preceding pages (which may be None for the first/last page).


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor.



__init__ (self, parent, bitmap=NullBitmap)

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 (wx.adv.Wizard) – The parent wizard
  • bitmap (wx.Bitmap) – The page-specific bitmap if different from the global one





Create(self, parent, bitmap=NullBitmap)

Creates the wizard page.

Must be called if the default constructor had been used to create the object.

Parameters:
  • parent (wx.adv.Wizard) – The parent wizard
  • bitmap (wx.Bitmap) – The page-specific bitmap if different from the global one
Return type:

bool



GetBitmap(self)

This method is called by wx.adv.Wizard to get the bitmap to display alongside the page.

By default, m_bitmap member variable which was set in the wx.adv.WizardPage constructor.

If the bitmap was not explicitly set (i.e. if wx.NullBitmap 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.

Return type:Bitmap


GetNext(self)

Get the page which should be shown when the user chooses the "Next" button: if None is returned, this button will be disabled.

The last page of the wizard will usually return None from here, but the others will not.

Return type: wx.adv.WizardPage

See also

GetPrev



GetPrev(self)

Get the page which should be shown when the user chooses the "Back" button: if None is returned, this button will be disabled.

The first page of the wizard will usually return None from here, but the others will not.

Return type: wx.adv.WizardPage

See also

GetNext


Properties



Bitmap

See GetBitmap



Next

See GetNext



Prev

See GetPrev