wx.aui.AuiBookSerializer¶

wx.aui.AuiBookSerializer is used for serializing wx.aui.AuiNotebook layout.

This includes the tab controls layout and the order of pages in them.

It can be used standalone with wx.aui.AuiNotebook.SaveLayout or as base class of wx.aui.AuiSerializer for saving and restoring the entire layout.

Added in version 4.3/wxWidgets-3.3.0.

Class Hierarchy¶

Inheritance diagram for class AuiBookSerializer:

Known Subclasses¶

wx.aui.AuiSerializer

Methods Summary¶

`__init__`	Trivial default constructor.
`AfterSaveNotebook`	Called after saving information about all the pages of the notebook in the `AUI` pane with the given name.
`BeforeSaveNotebook`	Called before starting to save information about the tabs in the notebook in the `AUI` pane with the given name.
`SaveNotebookTabControl`	Called to save information about a single tab control in the given notebook.

Class API¶

class wx.aui.AuiBookSerializer(object)¶

Possible constructors:

AuiBookSerializer() -> None

AuiBookSerializer is used for serializing AuiNotebook layout.

Methods¶

__init__(self)¶

Trivial default constructor.

Return type:: None

AfterSaveNotebook(self)¶

Called after saving information about all the pages of the notebook in the AUI pane with the given name.

Does nothing by default.

Return type:: None

BeforeSaveNotebook(self, name)¶

Called before starting to save information about the tabs in the notebook in the AUI pane with the given name.

This function needs to be overridden to keep record of the notebook for which SaveNotebookTabControl will be called next.

If this class is used as a base class of wx.aui.AuiSerializer, saving notebook layout may be unnecessary, e.g. because the program doesn’t use wx.aui.AuiNotebook at all, and the implementation can be trivial and just do nothing because it is not going to be called at all if there are no notebooks in the full layout.

When using wx.aui.AuiNotebook.SaveLayout directly, this function is always called and is the first function of this class to be called.

Parameters:: name (string)
Return type:: None

SaveNotebookTabControl(self, tab)¶

Called to save information about a single tab control in the given notebook.

This function will be called for all tab controls in the notebook after BeforeSaveNotebook .

As with that function, it has to be implemented, but can simply do nothing if saving notebook layout is not necessary.

Parameters:: tab (wx.aui.AuiTabLayoutInfo)
Return type:: None

Navigation