Window Styles¶

This class supports the following styles:

• wx.NB_TOP: Place tabs on the top side.

• wx.NB_LEFT: Place tabs on the left side.

• wx.NB_RIGHT: Place tabs on the right side.

• wx.NB_BOTTOM: Place tabs under instead of above the notebook pages.

• wx.NB_FIXEDWIDTH: (Windows only) All tabs will have same width.

• wx.NB_MULTILINE: (Windows only) There can be several rows of tabs.

• wx.NB_NOPAGETHEME: (Windows only) Display a solid colour on notebook pages, and not a gradient, which can reduce performance.

The styles wx.NB_LEFT, wx.RIGHT and wx.BOTTOM are not supported under Microsoft Windows when using visual themes.

Events Emitted by this Class¶

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

• EVT_NOTEBOOK_PAGE_CHANGED: The page selection was changed. Processes a wxEVT_NOTEBOOK_PAGE_CHANGED event.

• EVT_NOTEBOOK_PAGE_CHANGING: The page selection is about to be changed. Processes a wxEVT_NOTEBOOK_PAGE_CHANGING event. This event can be vetoed.

Page backgrounds¶

On Windows, the default theme paints a background on the notebook’s pages. If you wish to suppress this theme, for aesthetic or performance reasons, there are three ways of doing it. You can use NB_NOPAGETHEME to disable themed drawing for a particular notebook, you can call wx.SystemOptions.SetOption to disable it for the whole application, or you can disable it for individual pages by using SetBackgroundColour. To disable themed pages globally:

wx.SystemOptions.SetOption("msw.notebook.themed-background", 0)

Set the value to 1 to enable it again. To give a single page a solid background that more or less fits in with the overall theme, use:

col = notebook.GetThemeBackgroundColour()

if col.IsOk():
    page.SetBackgroundColour(col)

On platforms other than Windows, or if the application is not using Windows themes, GetThemeBackgroundColour will return an uninitialised colour object, and the above code will therefore work on all platforms.

Class Hierarchy¶

Inheritance diagram for class Notebook:

Control Appearance¶

Methods Summary¶

Properties Summary¶

Class API¶

class wx.Notebook(BookCtrlBase)¶

Possible constructors:

Notebook() -> None

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

This class represents a notebook control, which manages multiple windows with associated tabs.

Methods¶

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

Overloaded Implementations:

---

__init__ (self)

Constructs a notebook control.

Return type:

None

---

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

Constructs a notebook control.

Note that sometimes you can reduce flicker by passing the wx.CLIP_CHILDREN window style.

Parameters:

• parent (wx.Window) – The parent window. Must be non-null.

• id (wx.WindowID) – The window identifier.

• pos (wx.Point) – The window position.

• size (wx.Size) – The window size.

• style (long) – The window style. See wx.Notebook.

• name (string) – The name of the control.

Return type:

None

---

---

ChangeSelection(self, page)¶

Changes the selection to the given page, returning the previous selection.

This function behaves as SetSelection but does not generate the page changing events.

See User Generated Events vs Programmatically Generated Events for more information.

Parameters:

page (int)

Return type:

int

---

Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=NotebookNameStr)¶

Creates a notebook control.

See wx.Notebook for a description of the parameters.

Parameters:

• parent (wx.Window)

• id (wx.WindowID)

• pos (wx.Point)

• size (wx.Size)

• style (long)

• name (string)

Return type:

bool

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶

Parameters:

variant (WindowVariant)

Return type:

wx.VisualAttributes

---

GetPageImage(self, nPage)¶

Returns the image index for the given page.

Parameters:

nPage (int)

Return type:

int

---

GetPageText(self, nPage)¶

Returns the string for the given page.

Parameters:

nPage (int)

Return type:

str

---

GetRowCount(self)¶

Returns the number of rows in the notebook control.

Return type:

int

---

GetSelection(self)¶

Returns the currently selected page, or NOT_FOUND if none was selected.

Note that this method may return either the previously or newly selected page when called from the EVT_BOOKCTRL_PAGE_CHANGED handler depending on the platform and so wx.BookCtrlEvent.GetSelection should be used instead in this case.

Return type:

int

---

GetTabOrientation(self)¶

This is a convenience function mapping wx.BK_TOP etc styles to one of the Direction enum elements.

Return type:

wx.DataObject.Direction

Added in version 4.3/wxWidgets-3.3.0.

---

GetTabRect(self, page)¶

Return the rectangle of the given page tab in window coordinates.

This function always returns the rectangle for the specified tab, even if the tab is currently not visible.

If page is invalid, an assert failure is triggered and an empty rectangle is returned.

Parameters:

page (int)

Return type:

wx.Rect

Added in version 4.3/wxWidgets-3.3.0.

Note

Currently only available in Univ and MSW and always asserts in the other ports.

---

GetThemeBackgroundColour(self)¶

If running under Windows and themes are enabled for the application, this function returns a suitable colour for painting the background of a notebook page, and can be passed to SetBackgroundColour .

Otherwise, an uninitialised colour will be returned.

Return type:

wx.Colour

---

InsertPage(self, index, page, text, select=False, imageId=NO_IMAGE)¶

Inserts a new page at the specified position.

Parameters:

• index (int) – Specifies the position for the new page.

• page (wx.Window) – Specifies the new page.

• text (string) – Specifies the text of the new page. Note that it may contain mnemonic characters, see SetPageText for more information.

• select (bool) – Specifies whether the page should be selected.

• imageId (int) – Specifies the optional image index for the new page.

Return type:

bool

Returns:

True if successful, False otherwise.

Note

Do not delete the page, it will be deleted by the book control.

See also

AddPage

---

SetPadding(self, padding)¶

Sets the amount of space around each page’s icon and label, in pixels.

Parameters:

padding (wx.Size)

Return type:

None

Note

The vertical padding cannot be changed in wxGTK.

---

SetPageImage(self, page, image)¶

Sets the image index for the given page.

image is an index into the image list which was set with SetImageList .

Parameters:

• page (int)

• image (int)

Return type:

bool

---

SetPageText(self, page, text)¶

Sets the text for the given page.

The text may contain mnemonics, i.e. accelerator characters preceded by the ampersand ( & ) character. If you need to include a literal ampersand in the text, you need to float it, i.e. use && .

Parameters:

• page (int)

• text (string)

Return type:

bool

---

SetSelection(self, page)¶

Sets the selection to the given page, returning the previous selection.

Notice that the call to this function generates the page changing events, use the ChangeSelection function if you don’t want these events to be generated.

Parameters:

page (int)

Return type:

int

See also

GetSelection

Properties¶

RowCount¶

See GetRowCount

---

Selection¶

See GetSelection and SetSelection

---

TabOrientation¶

See GetTabOrientation

---

ThemeBackgroundColour¶

See GetThemeBackgroundColour