wx.aui.AuiManager¶

wx.aui.AuiManager is the central class of the AUI class framework.

wx.aui.AuiManager manages the panes associated with it for a particular wx.Frame, using a pane’s wx.aui.AuiPaneInfo information to determine each pane’s docking and floating behaviour.

wx.aui.AuiManager uses wxWidgets’ sizer mechanism to plan the layout of each frame. It uses a replaceable dock art class to do all drawing, so all drawing is localized in one area, and may be customized depending on an application’s specific needs.

wx.aui.AuiManager works as follows: the programmer adds panes to the class, or makes changes to existing pane properties (dock position, floating state, show state, etc.). To apply these changes, wx.aui.AuiManager’s Update function is called. This batch processing can be used to avoid flicker, by modifying more than one pane at a time, and then “committing” all of the changes at once by calling Update.

Panes can be added quite easily:

text1 = wx.TextCtrl(self)
text2 = wx.TextCtrl(self)
self.mgr.AddPane(text1, wx.LEFT, "Pane Caption")
self.mgr.AddPane(text2, wx.BOTTOM, "Pane Caption")
self.mgr.Update()

Later on, the positions can be modified easily. The following will float an existing pane in a tool window:

self.mgr.GetPane(text1).Float()

Layers, Rows and Directions, Positions¶

Inside AUI, the docking layout is figured out by checking several pane parameters. Four of these are important for determining where a pane will end up:

Direction: Each docked pane has a direction, Top, Bottom, Left, Right, or Center. This is fairly self-explanatory. The pane will be placed in the location specified by this variable.
Position: More than one pane can be placed inside of a dock. Imagine two panes being docked on the left side of a window. One pane can be placed over another. In proportionally managed docks, the pane position indicates its sequential position, starting with zero. So, in our scenario with two panes docked on the left side, the top pane in the dock would have position 0, and the second one would occupy position 1.
Row: A row can allow for two docks to be placed next to each other. One of the most common places for this to happen is in the toolbar. Multiple toolbar rows are allowed, the first row being row 0, and the second row 1. Rows can also be used on vertically docked panes.
Layer: A layer is akin to an onion. Layer 0 is the very center of the managed pane. Thus, if a pane is in layer 0, it will be closest to the center window (also sometimes known as the “content window”). Increasing layers “swallow up” all layers of a lower value. This can look very similar to multiple rows, but is different because all panes in a lower level yield to panes in higher levels. The best way to understand layers is by running the AUI sample.

Window Styles¶

This class supports the following styles:

wx.aui.AUI_MGR_ALLOW_FLOATING: Allow a pane to be undocked to take the form of a wx.MiniFrame.
wx.aui.AUI_MGR_ALLOW_ACTIVE_PANE: Change the color of the title bar of the pane when it is activated.
wx.aui.AUI_MGR_TRANSPARENT_DRAG: Make the pane transparent during its movement.
wx.aui.AUI_MGR_TRANSPARENT_HINT: The possible location for docking is indicated by a translucent area.
wx.aui.AUI_MGR_VENETIAN_BLINDS_HINT: The possible location for docking is indicated by gradually appearing partially transparent hint.
wx.aui.AUI_MGR_RECTANGLE_HINT: The possible location for docking is indicated by a rectangular outline.
wx.aui.AUI_MGR_HINT_FADE: The translucent area where the pane could be docked appears gradually.
wx.aui.AUI_MGR_NO_VENETIAN_BLINDS_FADE: Used in complement of wx.aui.AUI_MGR_VENETIAN_BLINDS_HINT to show the docking hint immediately.
wx.aui.AUI_MGR_LIVE_RESIZE: When a docked pane is resized, its content is refreshed in live (instead of moving the border alone and refreshing the content at the end).
wx.aui.AUI_MGR_DEFAULT: Default behavior, combines: wx.aui.AUI_MGR_ALLOW_FLOATING | wx.aui.AUI_MGR_TRANSPARENT_HINT | wx.aui.AUI_MGR_HINT_FADE | wx.aui.AUI_MGR_NO_VENETIAN_BLINDS_FADE.

Events Emitted by this Class¶

Handlers bound for the following event types will receive one of the wx.aui.AuiManagerEvent parameters.

EVT_AUI_PANE_BUTTON: Triggered when any button is pressed for any docked panes.
EVT_AUI_PANE_CLOSE: Triggered when a docked or floating pane is closed.
EVT_AUI_PANE_MAXIMIZE: Triggered when a pane is maximized.
EVT_AUI_PANE_RESTORE: Triggered when a pane is restored.
EVT_AUI_PANE_ACTIVATED: Triggered when a pane is made ‘active’. This event is new since wxWidgets 2.9.4.
EVT_AUI_RENDER: This event can be caught to override the default renderer in order to custom draw your wx.aui.AuiManager window (not recommended).

Class Hierarchy¶

Inheritance diagram for class AuiManager:

Methods Summary¶

`__init__`	Constructor.
`AddPane`	`AddPane` tells the frame manager to start managing a child window.
`DetachPane`	Tells the wx.aui.AuiManager to stop managing the pane specified by window.
`GetAllPanes`	Returns an array of all panes managed by the frame manager.
`GetArtProvider`	Returns the current art provider being used.
`GetDockSizeConstraint`	Returns the current dock constraint values.
`GetFlags`	Returns the current wx.aui.AuiManagerOption’s flags.
`GetManagedWindow`	Returns the frame currently being managed by wx.aui.AuiManager.
`GetManager`	Calling this method will return the wx.aui.AuiManager for a given window.
`GetPane`	`GetPane` is used to lookup a wx.aui.AuiPaneInfo object either by window pointer or by pane name, which acts as a unique id for a window pane.
`HideHint`	`HideHint` hides any docking hint that may be visible.
`InsertPane`	This method is used to insert either a previously unmanaged pane window into the frame manager, or to insert a currently managed pane somewhere else.
`LoadPaneInfo`	`LoadPaneInfo` is similar to LoadPerspective, with the exception that it only loads information about a single pane.
`LoadPerspective`	Loads a saved perspective.
`ProcessDockResult`	`ProcessDockResult` is a protected member of the `AUI` layout manager.
`SavePaneInfo`	`SavePaneInfo` is similar to SavePerspective, with the exception that it only saves information about a single pane.
`SavePerspective`	Saves the entire user interface layout into an encoded String , which can then be stored by the application (probably using Config).
`SetArtProvider`	Instructs wx.aui.AuiManager to use art provider specified by parameter art_provider for all drawing calls.
`SetDockSizeConstraint`	When a user creates a new dock by dragging a window into a docked position, often times the large size of the window will create a dock that is unwieldly large.
`SetFlags`	This method is used to specify wx.aui.AuiManagerOption’s flags.
`SetManagedWindow`	Called to specify the frame or window which is to be managed by wx.aui.AuiManager.
`ShowHint`	This function is used by controls to explicitly show a hint window at the specified rectangle.
`UnInit`	Uninitializes the framework and should be called before a managed frame or window is destroyed.
`Update`	This method is called after any number of changes are made to any of the managed panes.

Properties Summary¶

`AllPanes`	See `GetAllPanes`
`ArtProvider`	See `GetArtProvider` and `SetArtProvider`
`Flags`	See `GetFlags` and `SetFlags`
`ManagedWindow`	See `GetManagedWindow` and `SetManagedWindow`

Class API¶

class wx.aui.AuiManager(EvtHandler)¶

Possible constructors:

AuiManager(managed_wnd=None, flags=AUI_MGR_DEFAULT)

AuiManager is the central class of the AUI class framework.

Methods¶

__init__(self, managed_wnd=None, flags=AUI_MGR_DEFAULT)¶

Constructor.

Parameters

managed_wnd (wx.Window) – Specifies the wx.Frame which should be managed.
flags (int) – Specifies the frame management behaviour and visual effects with the wx.aui.AuiManagerOption’s style flags.

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

AddPane tells the frame manager to start managing a child window.

There are several versions of this function. The first version allows the full spectrum of pane parameter possibilities. The second version is used for simpler user interfaces which do not require as much configuration. The last version allows a drop position to be specified, which will determine where the pane will be added.

Overloaded Implementations:

AddPane (self, window, pane_info)

Parameters

window (wx.Window) –
pane_info (wx.aui.AuiPaneInfo) –

Return type

bool

AddPane (self, window, direction=LEFT, caption=””)

Parameters

window (wx.Window) –
direction (int) –
caption (string) –

Return type

bool

AddPane (self, window, pane_info, drop_pos)

Parameters

window (wx.Window) –
pane_info (wx.aui.AuiPaneInfo) –
drop_pos (wx.Point) –

Return type

bool

DetachPane(self, window)¶

Tells the wx.aui.AuiManager to stop managing the pane specified by window.

The window, if in a floated frame, is reparented to the frame managed by wx.aui.AuiManager.

Parameters: window (wx.Window) –
Return type: bool

GetAllPanes(self)¶

Returns an array of all panes managed by the frame manager.

Return type: AuiPaneInfoArray

GetArtProvider(self)¶

Returns the current art provider being used.

Return type: wx.aui.AuiDockArt

Properties¶

AllPanes¶: See GetAllPanes

ArtProvider¶: See GetArtProvider and SetArtProvider

Flags¶: See GetFlags and SetFlags

ManagedWindow¶: See GetManagedWindow and SetManagedWindow

Navigation

wx.aui.AuiManager¶

Layers, Rows and Directions, Positions¶

Window Styles¶

Events Emitted by this Class¶

Class Hierarchy¶

Methods Summary¶

Properties Summary¶

Class API¶

Methods¶

Properties¶