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 behaviour, 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¶Constructor. |
|
|
|
Returns |
|
This function is used by controls to calculate the drop hint rectangle. |
|
Check if a key modifier is pressed (actually or ) while dragging the frame to not dock the window. |
|
Destroys or hides the given pane depending on its flags. |
|
Creates a floating frame in this wx.aui.AuiManager with the given parent and wx.aui.AuiPaneInfo. |
|
Tells the wx.aui.AuiManager to stop managing the pane specified by window. |
|
This function is used by controls to draw the hint window. |
|
Returns an array of all panes managed by the frame manager. |
|
Returns the current art provider being used. |
|
Returns the current dock constraint values. |
|
Returns the current wx.aui.AuiManagerOption’s flags. |
|
Returns the frame currently being managed by wx.aui.AuiManager. |
|
Calling this method will return the wx.aui.AuiManager for a given window. |
|
|
|
Returns |
|
|
|
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. |
|
|
|
Loads a saved perspective. |
|
Maximize the given pane. |
|
|
|
Restore the previously maximized pane. |
|
Restore the last state of the given pane. |
|
|
|
Saves the entire user interface layout into an encoded String , which can then be stored by the application (probably using Config). |
|
Instructs wx.aui.AuiManager to use art provider specified by parameter art_provider for all drawing calls. |
|
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 unwieldy large. |
|
This method is used to specify wx.aui.AuiManagerOption’s flags. |
|
Called to specify the frame or window which is to be managed by wx.aui.AuiManager. |
|
This function is used by controls to explicitly show a hint window at the specified rectangle. |
|
Mostly used internally to define the drag action parameters. |
|
Dissociate the managed window from the manager. |
|
This method is called after any number of changes are made to any of the managed panes. |
Properties Summary¶See |
|
See |
|
See |
Class API¶
wx.aui.AuiManager(EvtHandler)¶Possible constructors:
AuiManager(managed_wnd=None, flags=AUI_MGR_DEFAULT)
AuiManager is the central class of the AUI class framework.
__init__(self, managed_wnd=None, flags=AUI_MGR_DEFAULT)¶Constructor.
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)
window (wx.Window) –
pane_info (wx.aui.AuiPaneInfo) –
bool
AddPane (self, window, direction=LEFT, caption=””)
window (wx.Window) –
direction (int) –
caption (string) –
bool
AddPane (self, window, pane_info, drop_pos)
window (wx.Window) –
pane_info (wx.aui.AuiPaneInfo) –
drop_pos (wx.Point) –
bool
AlwaysUsesLiveResize()¶Returns True if live resize is always used on the current platform.
If this function returns True, AUI_MGR_LIVE_RESIZE flag is ignored and live resize is always used, whether it’s specified or not.
Currently this is the case for wxOSX and GTK3 ports, as live resizing is the only implemented method there.
bool
New in version 4.1/wxWidgets-3.1.4.
CalculateHintRect(self, paneWindow, pt, offset)¶This function is used by controls to calculate the drop hint rectangle.
The method first calls DoDrop() to determine the exact position the pane would be at were if dropped.
Rect
The rectangle hint will be returned in screen coordinates if the pane would indeed become docked at the specified drop point. Otherwise, an empty rectangle is returned.
CanDockPanel(self, p)¶Check if a key modifier is pressed (actually or ) while dragging the frame to not dock the window.
p (wx.aui.AuiPaneInfo) –
bool
ClosePane(self, paneInfo)¶Destroys or hides the given pane depending on its flags.
paneInfo (wx.aui.AuiPaneInfo) –
See also
CreateFloatingFrame(self, parent, p)¶Creates a floating frame in this wx.aui.AuiManager with the given parent and wx.aui.AuiPaneInfo.
parent (wx.Window) –
p (wx.aui.AuiPaneInfo) –
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.
window (wx.Window) –
bool
DrawHintRect(self, paneWindow, pt, offset)¶This function is used by controls to draw the hint window.
It is rarely called, and is mostly used by controls implementing custom pane drag/drop behaviour.
GetAllPanes(self)¶Returns an array of all panes managed by the frame manager.
AuiPaneInfoArray
GetArtProvider(self)¶Returns the current art provider being used.
See also
GetDockSizeConstraint(self, widthpct, heightpct)¶Returns the current dock constraint values.
See SetDockSizeConstraint for more information.
widthpct (float) –
heightpct (float) –
GetFlags(self)¶Returns the current wx.aui.AuiManagerOption’s flags.
int
GetManagedWindow(self)¶Returns the frame currently being managed by wx.aui.AuiManager.
Window
GetManager(window)¶Calling this method will return the wx.aui.AuiManager for a given window.
The window parameter should specify any child window or sub-child window of the frame or window managed by wx.aui.AuiManager.
The window parameter need not be managed by the manager itself, nor does it even need to be a child or sub-child of a managed window. It must however be inside the window hierarchy underneath the managed window.
window (wx.Window) –
GetPane(self, *args, **kw)¶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.
The returned wx.aui.AuiPaneInfo object may then be modified to change a pane’s look, state or position. After one or more modifications to wx.aui.AuiPaneInfo, wx.aui.AuiManager.Update should be called to commit the changes to the user interface. If the lookup failed (meaning the pane could not be found in the manager), a call to the returned wx.aui.AuiPaneInfo’s IsOk() method will return False.
Overloaded Implementations:
GetPane (self, window)
window (wx.Window) –
GetPane (self, name)
name (string) –
HasLiveResize(self)¶Returns True if windows are resized live.
This function combines the check for AlwaysUsesLiveResize and, for the platforms where live resizing is optional, the check for wx.aui.AUI_MGR_LIVE_RESIZE flag.
Using this accessor allows to verify whether live resizing is being actually used.
bool
New in version 4.1/wxWidgets-3.1.4.
InsertPane(self, window, insert_location, insert_level=AUI_INSERT_PANE)¶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.
InsertPane will push all panes, rows, or docks aside and insert the window into the position specified by insert_location.
Because insert_location can specify either a pane, dock row, or dock layer, the insert_level parameter is used to disambiguate this. The parameter insert_level can take a value of AUI_INSERT_PANE, AUI_INSERT_ROW or AUI_INSERT_DOCK.
window (wx.Window) –
insert_location (wx.aui.AuiPaneInfo) –
insert_level (int) –
bool
LoadPaneInfo(self, pane_part, pane)¶LoadPaneInfo is similar to LoadPerspective, with the exception that it only loads information about a single pane.
This method writes the serialized data into the passed pane. Pointers to UI elements are not modified.
pane_part (string) –
pane (wx.aui.AuiPaneInfo) –
Note
This operation also changes the name in the pane information!
LoadPerspective(self, perspective, update=True)¶Loads a saved perspective.
A perspective is the layout state of an AUI managed window.
All currently existing panes that have an object in “perspective” with the same name (“equivalent”) will receive the layout parameters of the object in “perspective”. Existing panes that do not have an equivalent in “perspective” remain unchanged, objects in “perspective” having no equivalent in the manager are ignored.
perspective (string) – Serialized layout information of a perspective (excl. pointers to UI elements).
update (bool) – If update is True, wx.aui.AuiManager.Update is automatically invoked, thus realizing the specified perspective on screen.
bool
MaximizePane(self, paneInfo)¶Maximize the given pane.
paneInfo (wx.aui.AuiPaneInfo) –
ProcessDockResult(self, target, new_pos)¶ProcessDockResult is a protected member of the AUI layout manager.
It can be overridden by derived classes to provide custom docking calculations.
target (wx.aui.AuiPaneInfo) –
new_pos (wx.aui.AuiPaneInfo) –
bool
RestoreMaximizedPane(self)¶Restore the previously maximized pane.
RestorePane(self, paneInfo)¶Restore the last state of the given pane.
paneInfo (wx.aui.AuiPaneInfo) –
SavePaneInfo(self, pane)¶SavePaneInfo is similar to SavePerspective, with the exception that it only saves information about a single pane.
pane (wx.aui.AuiPaneInfo) – Pane whose layout parameters should be serialized.
string
The serialized layout parameters of the pane are returned within the string. Information about the pointers to UI elements stored in the pane are not serialized.
SavePerspective(self)¶Saves the entire user interface layout into an encoded String , which can then be stored by the application (probably using Config).
string
SetArtProvider(self, art_provider)¶Instructs wx.aui.AuiManager to use art provider specified by parameter art_provider for all drawing calls.
This allows pluggable look-and-feel features. The previous art provider object, if any, will be deleted by wx.aui.AuiManager.
art_provider (wx.aui.AuiDockArt) –
See also
SetDockSizeConstraint(self, widthpct, heightpct)¶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 unwieldy large.
wx.aui.AuiManager by default limits the size of any new dock to 1/3 of the window size. For horizontal docks, this would be 1/3 of the window height. For vertical docks, 1/3 of the width.
Calling this function will adjust this constraint value. The numbers must be between 0.0 and 1.0. For instance, calling SetDockSizeContraint with 0.5, 0.5 will cause new docks to be limited to half of the size of the entire managed window.
widthpct (float) –
heightpct (float) –
SetFlags(self, flags)¶This method is used to specify wx.aui.AuiManagerOption’s flags.
flags specifies options which allow the frame management behaviour to be modified.
flags (int) –
SetManagedWindow(self, managed_wnd)¶Called to specify the frame or window which is to be managed by wx.aui.AuiManager.
Frame management is not restricted to just frames. Child windows or custom controls are also allowed.
managed_wnd (wx.Window) –
ShowHint(self, rect)¶This function is used by controls to explicitly show a hint window at the specified rectangle.
It is rarely called, and is mostly used by controls implementing custom pane drag/drop behaviour. The specified rectangle should be in screen coordinates.
rect (wx.Rect) –
StartPaneDrag(self, paneWindow, offset)¶Mostly used internally to define the drag action parameters.
UnInit(self)¶Dissociate the managed window from the manager.
This function may be called before the managed frame or window is destroyed, but, since wxWidgets 3.1.4, it’s unnecessary to call it explicitly, as it will be called automatically when this window is destroyed, as well as when the manager itself is.
Update(self)¶This method is called after any number of changes are made to any of the managed panes.
Update must be invoked after AddPane or InsertPane are called in order to “realize” or “commit” the changes. In addition, any number of changes may be made to wx.aui.AuiPaneInfo structures (retrieved with wx.aui.AuiManager.GetPane ), but to realize the changes, Update must be called. This construction allows pane flicker to be avoided by updating the whole layout at one time.
AllPanes¶See GetAllPanes
ArtProvider¶See GetArtProvider and SetArtProvider
ManagedWindow¶See GetManagedWindow and SetManagedWindow