*************
wx.Choicebook
*************

Inheritance diagram for `wx.Choicebook`:

|

.. inheritance-diagram:: wx.Choicebook

|

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

`wx.Choicebook` is a class similar to `wx.Notebook <wx.Notebook.html>`_ but which uses a `wx.Choice <wx.Choice.html>`_ 
to show the labels instead of the tabs.

There is very little documentation for this class but its usage is identical to `wx.Notebook` (except for the features 
clearly related to tabs only), so please refer to that class documentation for now. 

This is particularly useful when screen space is restricted, as it often is when `wx.Choicebook` is being employed.

.. seealso:: `wx.Notebook <wx.Notebook.html>`_ 


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

* `wx.Control <wx.Control.html>`_ 
* `wx.Window <wx.Window.html>`_ 
* `wx.EvtHandler <wx.EvtHandler.html>`_ 
* `wx.Object <wx.Object.html>`_ 


Window Styles
^^^^^^^^^^^^^

==================================================  ==================================================  
Window Style                                        Description
==================================================  ==================================================  
``wx.CHB_DEFAULT``                                  Choose the default location for the labels depending on the current platform (left everywhere except Mac where it is top).
``wx.CHB_TOP``                                      Place labels above the page area.
``wx.CHB_LEFT``                                     Place labels on the left side.
``wx.CHB_RIGHT``                                    Place labels on the right side.
``wx.CHB_BOTTOM``                                   Place labels below the page area.
==================================================  ==================================================  

|

Control Appearance
^^^^^^^^^^^^^^^^^^

|

.. figure:: ../images/wxWidgets/wxmsw/choicebook.png 
   :alt: wxMSW
   :figclass: floatleft
   
   **wxMSW**


.. figure:: ../images/wxWidgets/wxmac/choicebook.png 
   :alt: wxMAC
   :figclass: floatright

   **wxMAC**


.. figure:: ../images/wxWidgets/wxgtk/choicebook.png
   :alt: wxGTK
   :figclass: floatcenter

   **wxGTK**


|

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

* `__init__ <#__init__>`_ 
* `GetChoiceCtrl <#GetChoiceCtrl>`_ 

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

* `ChoiceCtrl <#ChoiceCtrl>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(parent, id, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, name="")

   Constructor.

   **Parameters:**

   * `parent` (`wx.Window <wx.Window.html>`_)
   * `id` (int)
   * `pos` (`wx.Point <wx.Point.html>`_)
   * `size` (`wx.Size <wx.Size.html>`_)
   * `style` (long)
   * `name` (string)

   |

   **Returns:**

   `wx.Choicebook <wx.Choicebook.html>`_
 

--------

.. method:: GetChoiceCtrl()

   Returns the `wx.Choice <wx.Choice.html>`_ control associated with `wx.Choicebook`.

   |

   **Returns:**

   `wx.Choice <wx.Choice.html>`_ 


--------


Properties
^^^^^^^^^^


.. attribute:: ChoiceCtrl

   See `GetChoiceCtrl <#GetChoiceCtrl>`_