Phoenix Logo

phoenix_title wx.Toolbook

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

There is no documentation for this class yet 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. You can also use the Notebook Sample to see wx.Toolbook in action.

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 BookCtrl Overview are also supported.

events Events Emitted by this Class

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

See also

BookCtrl Overview, wx.BookCtrlBase, wx.Notebook, Notebook Sample


class_hierarchy Class Hierarchy

Inheritance diagram for class Toolbook:

method_summary Methods Summary

__init__ Constructs a choicebook control.
Create Create the tool book control that has already been constructed with the default constructor.
GetToolBar Return the toolbar used for page selection.

property_summary Properties Summary

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


Methods



__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=””)

Parameters:





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.

Parameters:
Return type:

bool



GetToolBar(self)

Return the toolbar used for page selection.

Return type: wx.ToolBar

Properties



ToolBar

See GetToolBar