aui.framemanager functions

This is the description of standalone Python functions in the aui.framemanager module.

Functions Summary

AuiManager_HasLiveResize	Static function which returns if the input manager should have “live resize” behaviour.
AuiManager_UseNativeMiniframes	Static function which returns if the input manager should use native wx.MiniFrame as
CheckEdgeDrop	Checks on which edge of a window the drop action has taken place.
CheckOutOfWindow	Checks if a point is outside the window rectangle.
CopyDocksAndPanes	This utility function creates shallow copies of the dock and pane info.
CopyDocksAndPanes2	This utility function creates full copies of the dock and pane info.
DoInsertDockLayer	This is an internal function that inserts a new dock layer by incrementing all existing dock layer values by one.
DoInsertDockRow	This is an internal function that inserts a new dock row by incrementing all existing dock row values by one.
DoInsertPane	This is an internal function that inserts a new pane by incrementing all existing dock position values by one.
DrawResizeHint	Draws a resize hint while a sash is dragged.
EscapeDelimiters	Changes ; into \ and | into \| in the input string.
FindDocks	This is an internal function that returns a list of docks which meet the specified conditions in the parameters and returns a sorted array (sorted by layer and then row).
FindOppositeDocks	This is an internal function that returns a list of docks which is related to the opposite direction.
FindPaneInDock	This method looks up a specified window pointer inside a dock.
GetInternalFrameRect	Returns the window rectangle excluding toolbars.
GetManager	This function will return the aui manager for a given window.
GetMaxLayer	This is an internal function which returns the highest layer inside the specified dock.
GetMaxRow	This is an internal function which returns the highest layer inside the specified dock.
GetNotebookRoot	Returns the AuiPaneInfo which has the specified notebook_id.
GetToolBarDockOffsets	Returns the toolbar dock offsets (top-left and bottom-right).
IsDifferentDockingPosition	Returns whether pane1 and pane2 are in a different docking position based on pane status, docking direction, docking layer and docking row.
PaneSortFunc	This function is used to sort panes by dock position.
RefreshDockingGuides	Refreshes the docking guide windows.
RemovePaneFromDocks	Removes a pane window from all docks with a possible exception specified by parameter exc.
RenumberDockRows	Takes a dock and assigns sequential numbers to existing rows.
SetActivePane	Sets the active pane, as well as cycles through every other pane and makes sure that all others’ active flags are turned off.
ShowDockingGuides	Shows or hide the docking guide windows.

Functions API

---

AuiManager_HasLiveResize(manager)

Static function which returns if the input manager should have “live resize” behaviour.

Parameters:manager – an instance of AuiManager.

Note

This method always returns True on wxMac as this platform doesn’t have the ability to use wx.ScreenDC to draw sashes.

---

AuiManager_UseNativeMiniframes(manager)

Static function which returns if the input manager should use native wx.MiniFrame as floating panes.

Parameters:manager – an instance of AuiManager.

Note

This method always returns True on wxMac as this platform doesn’t have the ability to use custom drawn miniframes.

---

CheckEdgeDrop(window, docks, pt)

Checks on which edge of a window the drop action has taken place.

Parameters:

• window – a wx.Window derived window;
• docks – a list of AuiDockInfo structures;
• pt – a wx.Point object.

---

CheckOutOfWindow(window, pt)

Checks if a point is outside the window rectangle.

Parameters:

• window – a wx.Window derived window;

• pt – a wx.Point object.

---

CopyDocksAndPanes(src_docks, src_panes)

This utility function creates shallow copies of the dock and pane info. AuiDockInfo usually contain pointers to AuiPaneInfo classes, thus this function is necessary to reliably reconstruct that relationship in the new dock info and pane info arrays.

Parameters:

• src_docks – a list of AuiDockInfo classes;
• src_panes – a list of AuiPaneInfo classes.

---

CopyDocksAndPanes2(src_docks, src_panes)

This utility function creates full copies of the dock and pane info. AuiDockInfo usually contain pointers to AuiPaneInfo classes, thus this function is necessary to reliably reconstruct that relationship in the new dock info and pane info arrays.

Parameters:

• src_docks – a list of AuiDockInfo classes;
• src_panes – a list of AuiPaneInfo classes.

---

DoInsertDockLayer(panes, dock_direction, dock_layer)

This is an internal function that inserts a new dock layer by incrementing all existing dock layer values by one.

Parameters:

• panes – a list of AuiPaneInfo;
• dock_direction – the AuiPaneInfo docking direction to analyze;
• dock_layer – the AuiPaneInfo layer to analyze.

---

DoInsertDockRow(panes, dock_direction, dock_layer, dock_row)

This is an internal function that inserts a new dock row by incrementing all existing dock row values by one.

Parameters:

• panes – a list of AuiPaneInfo;
• dock_direction – the AuiPaneInfo docking direction to analyze;
• dock_layer – the AuiPaneInfo layer to analyze;
• dock_row – the AuiPaneInfo row to analyze.

---

DoInsertPane(panes, dock_direction, dock_layer, dock_row, dock_pos)

This is an internal function that inserts a new pane by incrementing all existing dock position values by one.

Parameters:

• panes – a list of AuiPaneInfo;
• dock_direction – the AuiPaneInfo docking direction to analyze;
• dock_layer – the AuiPaneInfo layer to analyze;
• dock_row – the AuiPaneInfo row to analyze;
• dock_pos – the AuiPaneInfo row to analyze.

---

DrawResizeHint(dc, rect)

Draws a resize hint while a sash is dragged.

Parameters:rect – a wx.Rect rectangle which specifies the sash dimensions.

---

EscapeDelimiters(s)

Changes ; into \ and | into \| in the input string.

Parameters:s – the string to be analyzed.

Note

This is an internal functions which is used for saving perspectives.

---

FindDocks(docks, dock_direction, dock_layer=-1, dock_row=-1, reverse=False)

This is an internal function that returns a list of docks which meet the specified conditions in the parameters and returns a sorted array (sorted by layer and then row).

Parameters:

• docks – a list of AuiDockInfo;
• dock_direction – the AuiDockInfo docking direction to analyze;
• dock_layer – the AuiDockInfo layer to analyze;
• dock_row – the AuiDockInfo row to analyze;

---

FindOppositeDocks(docks, dock_direction)

This is an internal function that returns a list of docks which is related to the opposite direction.

Parameters:

• docks – a list of AuiDockInfo;
• dock_direction – the AuiDockInfo docking direction to analyze;

---

FindPaneInDock(dock, window)

This method looks up a specified window pointer inside a dock. If found, the corresponding AuiPaneInfo pointer is returned, otherwise None.

Parameters:

• dock – a AuiDockInfo structure;
• window – a wx.Window derived window (associated to a pane).

---

GetInternalFrameRect(window, docks)

Returns the window rectangle excluding toolbars.

Parameters:

• window – a wx.Window derived window;

• docks – a list of AuiDockInfo structures.

---

GetManager(window)

This function will return the aui manager for a given window.

Parameters:window – this parameter should be any child window or grand-child window (and so on) of the frame/window managed by AuiManager. The window does not need to 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.

---

GetMaxLayer(docks, dock_direction)

This is an internal function which returns the highest layer inside the specified dock.

Parameters:

• docks – a list of AuiDockInfo;
• dock_direction – the AuiDockInfo docking direction to analyze.

---

GetMaxRow(panes, dock_direction, dock_layer)

This is an internal function which returns the highest layer inside the specified dock.

Parameters:

• panes – a list of AuiPaneInfo;
• dock_direction – the AuiPaneInfo docking direction to analyze;
• dock_layer – the AuiPaneInfo layer to analyze.

---

GetNotebookRoot(panes, notebook_id)

Returns the AuiPaneInfo which has the specified notebook_id.

Parameters:

• panes – a list of AuiPaneInfo instances;
• notebook_id – the target notebook id.

---

GetToolBarDockOffsets(docks)

Returns the toolbar dock offsets (top-left and bottom-right).

Parameters:docks – a list of AuiDockInfo to analyze.

---

IsDifferentDockingPosition(pane1, pane2)

Returns whether pane1 and pane2 are in a different docking position based on pane status, docking direction, docking layer and docking row.

Parameters:

• pane1 – a AuiPaneInfo instance;
• pane2 – another AuiPaneInfo instance.

---

PaneSortFunc(p1, p2)

This function is used to sort panes by dock position.

Parameters:

• p1 – a AuiPaneInfo instance;
• p2 – another AuiPaneInfo instance.

---

RefreshDockingGuides(guides)

Refreshes the docking guide windows.

Parameters:guides – a list of AuiDockingGuideInfo classes;

---

RemovePaneFromDocks(docks, pane, exc=None)

Removes a pane window from all docks with a possible exception specified by parameter exc.

Parameters:

• docks – a list of AuiDockInfo structures;
• pane – the AuiPaneInfo pane to be removed;
• exc – the possible pane exception.

---

RenumberDockRows(docks)

Takes a dock and assigns sequential numbers to existing rows. Basically it takes out the gaps so if a dock has rows with numbers 0, 2, 5, they will become 0, 1, 2.

Parameters:docks – a list of AuiDockInfo structures.

---

SetActivePane(panes, active_pane)

Sets the active pane, as well as cycles through every other pane and makes sure that all others’ active flags are turned off.

Parameters:

• panes – a list of AuiPaneInfo structures;
• active_pane – the pane to be made active (if found).

---

ShowDockingGuides(guides, show)

Shows or hide the docking guide windows.

Parameters:

• guides – a list of AuiDockingGuideInfo classes;
• show – whether to show or hide the docking guide windows.

AGW

• advancedsplash
• aquabutton
• artmanager
• aui
• balloontip
• buttonpanel
• cubecolourdialog
• customtreectrl
• flatmenu
• flatnotebook
• floatspin
• fmcustomizedlg
• foldpanelbar
• fourwaysplitter
• genericmessagedialog
• gradientbutton
• hyperlink
• hypertreelist
• infobar
• knobctrl
• labelbook
• multidirdialog
• peakmeter
• persist
• piectrl
• pybusyinfo
• pycollapsiblepane
• pygauge
• pyprogress
• ribbon
• rulerctrl
• shapedbutton
• shortcuteditor
• speedmeter
• supertooltip
• thumbnailctrl
• toasterbox
• ultimatelistctrl
• xlsgrid
• zoombar

Tree