Phoenix Logo

phoenix_title wx.Listbook

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

The underlying 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 Notebook Sample to see wx.Listbook in action.

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.

events Events Emitted by this Class

Handlers bound for the following event types will receive a 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.

See also

wx.BookCtrl , wx.Notebook, Notebook Sample


class_hierarchy Class Hierarchy

Inheritance diagram for class Listbook:


appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


method_summary Methods Summary

__init__ Default constructor.
Create Create the list book control that has already been constructed with the default constructor.
GetListView Returns the wx.ListView associated with the control.

property_summary Properties Summary

ListView See 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.


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor.



__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=””)

Constructs a listbook control.

Parameters:





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.

Parameters:
Return type:

bool



GetListView(self)

Returns the wx.ListView associated with the control.

Return type: wx.ListView

Properties



ListView

See GetListView