.. wxPython Phoenix documentation

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

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

.. include:: headings.inc



.. _wx.Listbook:

==========================================================================================================================================
|phoenix_title|  **wx.Listbook**
==========================================================================================================================================

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

The underlying :ref:`wx.ListCtrl`  displays page labels in a one-column report view by default. Calling `BookCtrl.SetImageList` will implicitly switch the control to use an icon view. 

For usage documentation of this class, please refer to the base abstract class BookCtrl. You can also use the :ref:`Notebook Sample <notebook sample>`  to see :ref:`wx.Listbook`  in action. 

^^ 



.. _Listbook-styles:

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

This class supports the following styles: 

  

- ``wx.LB_DEFAULT``: Choose the default location for the labels depending on the current platform (left everywhere except Mac where it is top).  
- ``wx.LB_TOP``: Place labels above the page area.  
- ``wx.LB_LEFT``: Place labels on the left side.  
- ``wx.LB_RIGHT``: Place labels on the right side.  
- ``wx.LB_BOTTOM``: Place labels below the page area. ^^ 

^^






.. _Listbook-events:

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

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


- EVT_LISTBOOK_PAGE_CHANGED: The page selection was changed. Processes a  ``wxEVT_LISTBOOK_PAGE_CHANGED``   event.   
- EVT_LISTBOOK_PAGE_CHANGING: The page selection is about to be changed. Processes a  ``wxEVT_LISTBOOK_PAGE_CHANGING``   event. This event can be vetoed. ^^ 






         



.. seealso:: `wx.BookCtrl`     , :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>Listbook</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.Listbook_inheritance.png" alt="Inheritance diagram of Listbook" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Listbook.html" title="wx.Listbook  is a class similar to wx.Notebook  but which uses a wx.ListCtrl  to show the labels instead of the tabs." alt="" coords="121,392,215,421"/> <area shape="rect" id="node2" 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="104,315,232,344"/> <area shape="rect" id="node3" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="61,237,149,267"/> <area shape="rect" id="node4" href="wx.WithImages.html" title="A mixin class to be used with other classes that use a wx.ImageList." alt="" coords="174,237,290,267"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="61,160,150,189"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="49,83,161,112"/> <area shape="rect" id="node7" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,88,35"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="113,5,215,35"/> </map> 
   </p>
   </div>

|


|appearance| Control Appearance
===============================

|

.. figure:: _static/images/widgets/fullsize/wxmsw/wx.listbook.png
   :alt: wxMSW
   :figclass: floatleft

   **wxMSW**


.. figure:: _static/images/widgets/fullsize/wxmac/wx.listbook.png
   :alt: wxMAC
   :figclass: floatright

   **wxMAC**


.. figure:: _static/images/widgets/fullsize/wxgtk/wx.listbook.png
   :alt: wxGTK
   :figclass: floatcenter

   **wxGTK**


|


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

================================================================================ ================================================================================
:meth:`~wx.Listbook.__init__`                                                    Default constructor.
:meth:`~wx.Listbook.Create`                                                      Create the list book control that has already been constructed with the default constructor.
:meth:`~wx.Listbook.GetClassDefaultAttributes`                                   
:meth:`~wx.Listbook.GetListView`                                                 Returns the :ref:`wx.ListView`  associated with the control.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.Listbook.ListView`                                                    See :meth:`~wx.Listbook.GetListView`
================================================================================ ================================================================================


|


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


.. class:: wx.Listbook(BookCtrlBase)

   **Possible constructors**::

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



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



      |overload| Overloaded Implementations:

      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self)`
      
      Default constructor.                   
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name="")`
      
      Constructs a listbook control.                  
      
      
      :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
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






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

      Create the list 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`








   .. staticmethod:: GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)




      :param `variant`: 
      :type `variant`: wx.WindowVariant




      :rtype: :ref:`wx.VisualAttributes`








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



      |overload| Overloaded Implementations:

      :html:`<hr class="overloadsep" /><br />`

      
      **GetListView** `(self)`
      
      Returns the :ref:`wx.ListView`  associated with the control.                  
      
      :rtype: :ref:`wx.ListView`
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **GetListView** `(self)`
      
      Returns the list control used for selecting pages. 
      
      :rtype: :ref:`wx.ListView`
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






   .. attribute:: ListView

      See :meth:`~wx.Listbook.GetListView`