Window Styles¶

This class supports the following styles:

• wx.TBK_BUTTONBAR: Use ButtonToolBar-based implementation under macOS (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 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 ).

Class Hierarchy¶

Inheritance diagram for class Toolbook:

Methods Summary¶

Properties Summary¶

Class API¶

class wx.Toolbook(BookCtrlBase)¶

Possible constructors:

Toolbook() -> None

Toolbook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
         style=0, name='') -> None

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.

Overloaded Implementations:

---

__init__ (self)

Return type:

None

---

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

Parameters:

• parent (wx.Window)

• id (wx.WindowID)

• pos (wx.Point)

• size (wx.Size)

• style (long)

• name (string)

Return type:

None

---

---

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:

• parent (wx.Window)

• id (wx.WindowID)

• pos (wx.Point)

• size (wx.Size)

• style (long)

• name (string)

Return type:

bool

---

EnablePage(self, *args, **kw)¶

Overloaded Implementations:

---

EnablePage (self, page, enable)

Enables or disables the specified page.

Using this function, a page can be disabled when it can’t be used, while still remaining present to let the users know that more functionality is available, even if currently inaccessible.

Icons for disabled pages are created by wx.Bitmap.ConvertToDisabled .

Parameters:

• page (int) – The index of the page.

• enable (bool) – True to enable the page and False to disable it.

Return type:

bool

Returns:

True if successful, False otherwise (currently only if the index is invalid).

Added in version 4.1/wxWidgets-3.1.2.

---

EnablePage (self, page, enable)

Enables or disables the specified page.

This is similar to the overload above, but finds the index of the specified page.

Parameters:

• page (wx.Window) – Pointer of a page windows inside the book control.

• enable (bool) – True to enable the page and False to disable it.

Return type:

bool

Returns:

True if successful, False otherwise, e.g. if page is not one of the pages of this control.

Added in version 4.1/wxWidgets-3.1.2.

---

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶

Parameters:

variant (WindowVariant)

Return type:

wx.VisualAttributes

---

GetToolBar(self)¶

Return the toolbar used for page selection.

Return type:

wx.ToolBar

Properties¶

ToolBar¶

See GetToolBar