*********************
wx.wizard.WizardEvent
*********************

Inheritance diagram for `wx.wizard.WizardEvent`:

|

.. inheritance-diagram:: wx.wizard.WizardEvent

|

Description
===========

`wx.wizard.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.


.. seealso:: `wx.wizard.Wizard <../wizard/wx.wizard.Wizard.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.NotifyEvent <wx.NotifyEvent.html>`_ 
* `wx.CommandEvent <wx.CommandEvent.html>`_ 
* `wx.Event <wx.Event.html>`_ 
* `wx.Object <../Widgets/wx.Object.html>`_ 


Event Handling
^^^^^^^^^^^^^^

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

==================================================  ==================================================  
Event Name                                          Description
==================================================  ==================================================  
wx.wizard.EVT_WIZARD_PAGE_CHANGED(id, func)         The page has just been changed (this event cannot be vetoed).  
wx.wizard.EVT_WIZARD_PAGE_CHANGING(id, func)        The page is being changed (this event can be vetoed).  
wx.wizard.EVT_WIZARD_CANCEL(id, func)               The user attempted to cancel the wizard (this event may also be vetoed).  
wx.wizard.EVT_WIZARD_HELP(id, func)                 The wizard help button was pressed.  
wx.wizard.EVT_WIZARD_FINISHED(id, func)             The wizard finished button was pressed.  
==================================================  ==================================================  


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetDirection <#GetDirection>`_ 
* `GetPage <#GetPage>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `Direction <#Direction>`_ 
* `Page <#Page>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(type=wx.EVT_NULL, id=-1, direction=True, page=None)

   Constructor. It is not normally used by the user code as the objects of this type are constructed by 
   `wx.wizard.Wizard <../wizard/wx.wizard.Wizard.html>`_.
   
   **Parameters:**

   * `type` (eventtype)
   * `id` (int)
   * `direction` (bool)
   * `page` (`wx.wizard.WizardPage <../wizard/wx.wizard.WizardPage.html>`_)

   |

   **Returns:**

   `wx.wizard.WizardEvent <wx.wizard.WizardEvent.html>`_

--------

.. method:: GetDirection()

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

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetPage()

   Returns the `wx.wizard.WizardPage <../wizard/wx.wizard.WizardPage.html>`_ which was active when this event was generated.

   |  

   **Returns:**

   `wx.wizard.WizardPage <../wizard/wx.wizard.WizardPage.html>`_
 

--------

Properties
^^^^^^^^^^


.. attribute:: Direction

   See `GetDirection <#GetDirection>`_

.. attribute:: Page

   See `GetPage <#GetPage>`_