Phoenix Logo

phoenix_title wx.adv.WizardEvent

wx.adv.WizardEvent class represents an event generated by the wx.adv.Wizard: this event is first sent to the page itself and, if not processed there, goes up the window hierarchy as usual.

events 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 been just 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.

See also

wx.adv.Wizard, Wizard Sample


class_hierarchy Class Hierarchy

Inheritance diagram for class WizardEvent:


method_summary Methods Summary

__init__ Constructor.
GetDirection Return the direction in which the page is changing: for EVT_WIZARD_PAGE_CHANGING , return True if we’re going forward or False otherwise and for EVT_WIZARD_PAGE_CHANGED return True if we came from the previous page and False if we returned from the next one.
GetPage Returns the wx.adv.WizardPage which was active when this event was generated.

property_summary Properties Summary

Direction See GetDirection
Page See GetPage

api Class API



class wx.adv.WizardEvent(NotifyEvent)

Possible constructors:

WizardEvent(type=wxEVT_NULL, id=ID_ANY, direction=True, page=0)

WizardEvent 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.


Methods



__init__(self, type=wxEVT_NULL, id=ID_ANY, direction=True, page=0)

Constructor.

It is not normally used by the user code as the objects of this type are constructed by wx.adv.Wizard.

Parameters:
  • type (wx.EventType) –
  • id (int) –
  • direction (bool) –
  • page (wx.adv.WizardPage) –


GetDirection(self)

Return the direction in which the page is changing: for EVT_WIZARD_PAGE_CHANGING , return True if we’re going forward or False otherwise and for EVT_WIZARD_PAGE_CHANGED return True if we came from the previous page and False if we returned from the next one.

Return type:bool


GetPage(self)

Returns the wx.adv.WizardPage which was active when this event was generated.

Return type: wx.adv.WizardPage

Properties



Direction

See GetDirection



Page

See GetPage