wx.aui.AuiDeserializer

wx.aui.AuiDeserializer is used by wx.aui.AuiManager.LoadLayout to restore layout information saved by wx.aui.AuiManager.SaveLayout .

As wx.aui.AuiSerializer, this is an abstract base class, you need to inherit from it and override its pure virtual functions in your derived class.

Derived class function also may throw and, if any of them other than AfterLoad does, the existing layout is not changed, i.e. wx.aui.AuiManager.LoadLayout is exception-safe.

Added in version 4.3/wxWidgets-3.3.0.

Class Hierarchy

Inheritance diagram for class AuiDeserializer:

Methods Summary

__init__	Constructor taking the manager for which we’re restoring the layout.
AfterLoad	Called after restoring everything.
BeforeLoad	Called before doing anything else.
CreatePaneWindow	Create the window to be managed by the given pane if necessary.

Class API

class wx.aui.AuiDeserializer(AuiBookDeserializer)

Possible constructors:

AuiDeserializer(manager) -> None

AuiDeserializer is used by AuiManager.LoadLayout() to restore layout information saved by AuiManager.SaveLayout().

Methods

__init__(self, manager)

Constructor taking the manager for which we’re restoring the layout.

The manager remains valid for the lifetime of this object.

Parameters:

manager (wx.aui.AuiManager)

Return type:

None

---

AfterLoad(self)

Called after restoring everything.

Default implementation calls wx.aui.AuiManager.Update . Override this function and do not call the base class version if you want to prevent this from happening, e.g. if you need to make further changes to the restored layout before updating it.

Return type:

None

---

BeforeLoad(self)

Called before doing anything else.

Does nothing by default.

Return type:

None

---

CreatePaneWindow(self, pane)

Create the window to be managed by the given pane if necessary.

This function is called if any of the panes returned by LoadPanes doesn’t exist in the existing layout and allows to create windows on the fly.

If this function returns nullptr, as it does by default, the pane is not added to the manager.

If the function does create a new window, it should typically modify pane parameter to fill in the fields such as caption or icon that wouldn’t normally be serialized and so wouldn’t be restored by LoadPanes .

Parameters:

pane (wx.aui.AuiPaneInfo)

Return type:

Window