.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc



.. _wx.Toolbook:

==========================================================================================================================================
|phoenix_title|  **wx.Toolbook**
==========================================================================================================================================

:ref:`wx.Toolbook`  is a class similar to :ref:`wx.Notebook`  but which uses a :ref:`wx.ToolBar`  to show the labels instead of the tabs.          

There is no documentation for this class yet but its usage is identical to :ref:`wx.Notebook`  (except for the features clearly related to tabs only), so please refer to that class documentation for now. You can also use the :ref:`Notebook Sample <notebook sample>`  to see :ref:`wx.Toolbook`  in action. 





.. _Toolbook-styles:

|styles| Window Styles
================================

This class supports the following styles: 

  

- ``wx.TBK_BUTTONBAR``: Use ButtonToolBar-based implementation under Mac OS (ignored under other platforms).  
- ``wx.TBK_HORZ_LAYOUT``: Shows the text and the icons alongside, not vertically stacked (only implement under Windows and GTK 2 platforms as it relies on  ``TB_HORZ_LAYOUT``   flag support).   

The common BookCtrl styles described in the
:ref:`BookCtrl Overview <bookctrl overview>`  are also supported. 







.. _Toolbook-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`wx.BookCtrlEvent` parameter.


- EVT_TOOLBOOK_PAGE_CHANGED: The page selection was changed. Processes a  ``wxEVT_TOOLBOOK_PAGE_CHANGED``   event.   
- EVT_TOOLBOOK_PAGE_CHANGING: The page selection is about to be changed. Processes a  ``wxEVT_TOOLBOOK_PAGE_CHANGING``   event. This event can be vetoed (using  :meth:`wx.NotifyEvent.Veto` ).  








         



.. seealso:: :ref:`BookCtrl Overview <bookctrl overview>`, :ref:`wx.BookCtrlBase`, :ref:`wx.Notebook`, :ref:`Notebook Sample <notebook sample>`    







|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>Toolbook</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.Toolbook_inheritance.png" alt="Inheritance diagram of Toolbook" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="146,237,234,267"/> <area shape="rect" id="node6" href="wx.BookCtrlBase.html" title="A book control is a convenient way of displaying multiple pages of information, displayed one page at a time." alt="" coords="62,315,190,344"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="145,160,235,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="90,5,173,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="134,83,246,112"/> <area shape="rect" id="node5" href="wx.Toolbook.html" title="wx.Toolbook  is a class similar to wx.Notebook  but which uses a wx.ToolBar  to show the labels instead of the tabs." alt="" coords="77,392,175,421"/> <area shape="rect" id="node7" href="wx.WithImages.html" title="A mixin class to be used with other classes that use a wx.ImageList." alt="" coords="5,237,121,267"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="197,5,300,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.Toolbook.__init__`                                                    Constructs a choicebook control.
:meth:`~wx.Toolbook.Create`                                                      Create the tool book control that has already been constructed with the default constructor.
:meth:`~wx.Toolbook.GetToolBar`                                                  Return the toolbar used for page selection.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.Toolbook.ToolBar`                                                     See :meth:`~wx.Toolbook.GetToolBar`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.Toolbook(BookCtrlBase)

   **Possible constructors**::

       Toolbook()
       
       Toolbook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
                style=0, name="")
       
   
   Toolbook is a class similar to Notebook but which uses a ToolBar
   to show the labels instead of the tabs.



   .. method:: __init__(self, *args, **kw)

      Constructs a choicebook control.                   


      |overload| Overloaded Implementations:

      **~~~**

      
      **__init__** `(self)`
      
      
      
      
      
      **~~~**

      
      **__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name="")`
      
      
      
      
      :param `parent`: 
      :type `parent`: wx.Window
      :param `id`: 
      :type `id`: wx.WindowID
      :param `pos`: 
      :type `pos`: wx.Point
      :param `size`: 
      :type `size`: wx.Size
      :param `style`: 
      :type `style`: long
      :param `name`: 
      :type `name`: string
      
      
      
      
      
      
      **~~~**






   .. method:: Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name="")

      Create the tool book control that has already been constructed with the default constructor.                  


      :param `parent`: 
      :type `parent`: wx.Window
      :param `id`: 
      :type `id`: wx.WindowID
      :param `pos`: 
      :type `pos`: wx.Point
      :param `size`: 
      :type `size`: wx.Size
      :param `style`: 
      :type `style`: long
      :param `name`: 
      :type `name`: string




      :rtype: `bool`








   .. method:: GetToolBar(self)

      Return the toolbar used for page selection. 

      :rtype: :ref:`wx.ToolBar`








   .. attribute:: ToolBar

      See :meth:`~wx.Toolbook.GetToolBar`