********************
wx.wizard.WizardPage
********************

Inheritance diagram for `wx.wizard.WizardPage`:

|

.. inheritance-diagram:: wx.wizard.WizardPage

|

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

`wx.wizard.WizardPage` is one of the screens in `wx.wizard.Wizard <wx.wizard.Wizard.html>`_: 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.wizard.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.wizard.WizardPageSimple <wx.wizard.WizardPageSimple.html>`_ class is enough and it is simpler to use.


.. note:: To use this class, you must override `GetPrev <#GetPrev>`_ and `GetNext <#GetNext>`_ method (or you may use 
   `wx.wizard.WizardPageSimple <wx.wizard.WizardPageSimple.html>`_ instead).

   `GetBitmap <#GetBitmap>`_ can also be overridden, but this should be very rarely needed.


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


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

* `wx.Panel <../Widgets/wx.Panel.html>`_ 
* `wx.Window <../Widgets/wx.Window.html>`_ 
* `wx.EvtHandler <../Widgets/wx.EvtHandler.html>`_ 
* `wx.Object <../Widgets/wx.Object.html>`_ 


Known Subclasses
^^^^^^^^^^^^^^^^

`wx.wizard.PyWizardPage <wx.wizard.PyWizardPage.html>`_, `wx.wizard.WizardPageSimple <wx.wizard.WizardPageSimple.html>`_


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

* `__init__ <#__init__>`_ 
* `GetBitmap <#GetBitmap>`_ 
* `GetNext <#GetNext>`_ 
* `GetPrev <#GetPrev>`_ 

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

* `Bitmap <#Bitmap>`_ 
* `Next <#Next>`_ 
* `Prev <#Prev>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   `No docstrings available for this method.` 

--------


.. method:: GetBitmap()

   This method is called by `wx.wizard.Wizard <wx.wizard.Wizard.html>`_ to get the bitmap to display alongside the page. 

   If the bitmap was not explicitly set in the constructor (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.

   |  

   **Returns:**

   `wx.Bitmap <../Widgets/wx.Bitmap.html>`_
 

--------

.. method:: GetNext()

   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.

   |  

   **Returns:**

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

.. seealso:: `GetPrev <#GetPrev>`_
  

--------

.. method:: GetPrev()

   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.

   |  

   **Returns:**

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

.. seealso:: `GetNext <#GetNext>`_
  

--------

Properties
^^^^^^^^^^


.. attribute:: Bitmap

   See `GetBitmap <#GetBitmap>`_

.. attribute:: Next

   See `GetNext <#GetNext>`_

.. attribute:: Prev

   See `GetPrev <#GetPrev>`_