This class represents a notebook control, which manages multiple windows with associated tabs.
To use the class, create a Notebook object and call Notebook.AddPage or Notebook.InsertPage , passing a window to be used as the page. Do not explicitly delete the window for a page that is currently managed by Notebook.
NotebookPage is a typedef for Window.
This class supports the following styles:
The styles NB_LEFT, RIGHT and BOTTOM are not supported under Microsoft Windows XP when using visual themes.
Handlers bound for the following event types will receive a BookCtrlEvent parameter.
On Windows XP, the default theme paints a gradient 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 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.
See also
BookCtrl , BookCtrlEvent, ImageList,
__init__ | Constructs a notebook control. |
ChangeSelection | Changes the selection for the given page, returning the previous selection. |
Create | Creates a notebook control. |
GetPageImage | Returns the image index for the given page. |
GetPageText | Returns the string for the given page. |
GetRowCount | Returns the number of rows in the notebook control. |
GetSelection | Returns the currently selected page, or NOT_FOUND if none was selected. |
GetThemeBackgroundColour | 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 . |
InsertPage | Inserts a new page at the specified position. |
SetPadding | Sets the amount of space around each page’s icon and label, in pixels. |
SetPageImage | Sets the image index for the given page. |
SetPageText | Sets the text for the given page. |
SetSelection | Sets the selection for the given page, returning the previous selection. |
RowCount | See GetRowCount |
Selection | See GetSelection and SetSelection |
ThemeBackgroundColour | See GetThemeBackgroundColour |
This class represents a notebook control, which manages multiple windows with associated tabs.
Possible constructors:
Notebook()
Notebook(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
style=0, name=NotebookNameStr)
Overloaded Implementations:
__init__ (self)
Constructs a notebook control.
__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 CLIP_CHILDREN window style.
Parameters: |
---|
Changes the selection for 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 |
Creates a notebook control.
See Notebook for a description of the parameters.
Parameters: | |
---|---|
Return type: | bool |
Returns the image index for the given page.
Parameters: | nPage (int) – |
---|---|
Return type: | int |
Returns the string for the given page.
Parameters: | nPage (int) – |
---|---|
Return type: | string |
Returns the number of rows in the notebook control.
Return type: | int |
---|
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 BookCtrlEvent.GetSelection should be used instead in this case.
Return type: | int |
---|
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: | Colour |
---|
Inserts a new page at the specified position.
Parameters: |
|
---|---|
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
Sets the amount of space around each page’s icon and label, in pixels.
Parameters: | padding (Size) – |
---|
Note
The vertical padding cannot be changed in wxGTK.
Sets the image index for the given page.
image is an index into the image list which was set with SetImageList .
Parameters: |
|
---|---|
Return type: | bool |
Sets the text for the given page.
Parameters: |
|
---|---|
Return type: | bool |
Sets the selection for 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
See GetRowCount
See GetSelection and SetSelection