wx.aui.AuiSerializer

wx.aui.AuiSerializer is used by wx.aui.AuiManager.SaveLayout to store layout information.

This is an abstract base class, you need to inherit from it and override its pure virtual functions, including those inherited from its base wx.aui.AuiBookSerializer class, in your derived class.

In particular, SavePane must be overridden and will be called by wx.aui.AuiManager for each pane and dock present in the layout. Most of the other functions don’t need to be overridden, but it is often convenient to perform some actions before or after starting to save the objects of the given type or at the beginning or end of the whole saving process, so this class provides hooks for doing it.

If any of the functions of the derived class throw an exception, it is propagated out of wx.aui.AuiManager.SaveLayout and it’s callers responsibility to handle it.

Added in version 4.3/wxWidgets-3.3.0.

Class Hierarchy

Inheritance diagram for class AuiSerializer:

Methods Summary

__init__	Trivial default constructor.
AfterSave	Called after saving everything.
AfterSaveNotebooks	Called after the last call to SaveNotebook().
AfterSavePanes	Called after the last call to SavePane .
BeforeSave	Called before doing anything else.
BeforeSaveNotebooks	Called before starting to save information about the notebooks.
BeforeSavePanes	Called before starting to save information about the panes.
SavePane	Save information about the given pane.

Class API

class wx.aui.AuiSerializer(AuiBookSerializer)

Possible constructors:

AuiSerializer() -> None

AuiSerializer is used by AuiManager.SaveLayout() to store layout information.

Methods

__init__(self)

Trivial default constructor.

Return type:

None

---

AfterSave(self)

Called after saving everything.

Does nothing by default.

Return type:

None

---

AfterSaveNotebooks(self)

Called after the last call to SaveNotebook().

Does nothing by default.

This function is called after all wx.aui.AuiBookSerializer member functions

Return type:

None

---

AfterSavePanes(self)

Called after the last call to SavePane .

Does nothing by default.

Return type:

None

---

BeforeSave(self)

Called before doing anything else.

Does nothing by default.

Return type:

None

---

BeforeSaveNotebooks(self)

Called before starting to save information about the notebooks.

Does nothing by default.

Note that this function is called after AfterSavePanes but may not be called at all if there are no panes containing wx.aui.AuiNotebook.

wx.aui.AuiBookSerializer member functions will be called after this function if it is called at all.

Return type:

None

---

BeforeSavePanes(self)

Called before starting to save information about the panes.

Does nothing by default.

Return type:

None

---

SavePane(self, pane)

Save information about the given pane.

This function will be called for all panes and must be implemented to save their data in a format from which it can be restored later using a matching wx.aui.AuiDeserializer implementation.

Note that all sizes and positions in pane are using DIPs, i.e. resolution-independent pixels, when it is passed to this function, so it does not need to perform any scaling itself to ensure that the stored values are restored correctly if the resolution changes.

Parameters:

pane (wx.aui.AuiPaneLayoutInfo)

Return type:

None