AuiManager manages the panes associated with it for a particular wx.Frame, using a pane’s AuiPaneInfo information to determine each pane’s docking and floating behavior. AuiManager uses wxPython’s 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 applications’ specific needs.
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, the 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, -1)
text2 = wx.TextCtrl(self, -1)
self._mgr.AddPane(text1, AuiPaneInfo().Left().Caption("Pane Number One"))
self._mgr.AddPane(text2, AuiPaneInfo().Bottom().Caption("Pane Number Two"))
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 it’s 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 in row 0, and the second in 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 (AUI.py).
__init__ | Default class constructor. |
ActivatePane | Activates the pane to which window is associated. |
AddPane | Tells the frame manager to start managing a child window. |
AddPane1 | See comments on AddPane. |
AddPane2 | See comments on AddPane. |
AddPane3 | See comments on AddPane. |
AddPane4 | See comments on AddPane. |
AnimateDocking | Animates the minimization/docking of a pane a la Eclipse, using a wx.ScreenDC |
CalculateDockSizerLimits | Calculates the minimum and maximum sizes allowed for the input dock. |
CalculateHintRect | Calculates the drop hint rectangle. |
CalculatePaneSizerLimits | Calculates the minimum and maximum sizes allowed for the input pane. |
CanDockPanel | Returns whether a pane can be docked or not. |
CanUseModernDockArt | Returns whether ModernDockArt can be used (Windows XP / Vista / 7 only, |
CheckMovableSizer | Checks if a UI part can be actually resized. |
CheckPaneMove | Checks if a pane has moved by a visible amount. |
ClosePane | Destroys or hides the pane depending on its flags. |
CopyTarget | Copies all the attributes of the input target into another AuiPaneInfo. |
CreateFloatingFrame | Creates a floating frame for the windows. |
CreateGuideWindows | Creates the VS2005 HUD guide windows. |
CreateHintWindow | Creates the standard wxAUI hint window. |
CreateNotebook | Creates an automatic AuiNotebook when a pane is docked on |
CreateNotebookBase | Creates an auto-notebook base from a pane, and then add that pane as a page. |
DestroyGuideWindows | Destroys the VS2005 HUD guide windows. |
DestroyHintWindow | Destroys the standard wxAUI hint window. |
DetachPane | Tells the AuiManager to stop managing the pane specified |
DoDrop | This is an important function. |
DoDropFloatingPane | Handles the situation in which the dropped pane contains a normal window. |
DoDropLayer | Handles the situation in which target is a single dock guide. |
DoDropNonFloatingPane | Handles the situation in which the dropped pane is not floating. |
DoDropPane | Drop a pane in the interface. |
DoDropRow | Insert a row in the interface before dropping. |
DoDropToolbar | Handles the situation in which the dropped pane contains a toolbar. |
DoEndResizeAction | Ends a resize action, or for live update, resizes the sash. |
DoFrameLayout | This is an internal function which invokes wx.Sizer.Layout |
DrawHintRect | Calculates the hint rectangle by calling |
DrawPaneButton | Draws a pane button in the caption (convenience function). |
FireEvent | Fires one of the EVT_AUI_PANE_FLOATED/FLOATING/DOCKING/DOCKED/ACTIVATED event. |
GetAGWFlags | Returns the current manager’s flags. |
GetAllPanes | Returns a reference to all the pane info structures. |
GetAnimationStep | Returns the animation step speed (a float) to use in AnimateDocking. |
GetArtProvider | Returns the current art provider being used. |
GetAttributes | Returns all the attributes of a AuiPaneInfo. |
GetAutoNotebookStyle | Returns the default AGW-specific window style for automatic notebooks. |
GetAutoNotebookTabArt | Returns the default tab art provider for automatic notebooks. |
GetDockPixelOffset | This is an internal function which returns a dock’s offset in pixels from the left side of the window (for horizontal docks) or from the top of the window (for vertical docks). |
GetDockSizeConstraint | Returns the current dock constraint values. |
GetFrame | Returns the window being managed by AuiManager. |
GetManagedWindow | Returns the window being managed by AuiManager. |
GetNotebooks | Returns all the automatic AuiNotebook in the AuiManager. |
GetOppositeDockTotalSize | Returns the dimensions of the dock which lives opposite of the input dock. |
GetPane | Looks up a AuiPaneInfo structure based |
GetPaneByName | This version of GetPane looks up a pane based on a |
GetPaneByWidget | This version of GetPane looks up a pane based on a |
GetPanePart | Looks up the pane border UI part of the |
GetPanePositionsAndSizes | Returns all the panes positions and sizes in a dock. |
GetPartSizerRect | Returns the rectangle surrounding the specified UI parts. |
GetPartnerDock | Returns the partner dock for the input dock. |
GetPartnerPane | Returns the partner pane for the input pane. |
GetSnapPosition | Returns the main frame snapping position. |
GetTotalPixSizeAndProportion | Returns the dimensions and proportion of the input dock. |
HideHint | Hides a transparent window hint if there is one. |
HitTest | This is an internal function which determines |
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. |
IsPaneButtonVisible | Returns whether a pane button in the pane caption is visible. |
LayoutAddDock | Adds a dock into the existing layout. |
LayoutAddPane | Adds a pane into the existing layout (in an existing dock). |
LayoutAll | Layouts all the UI structures in the interface. |
LoadPaneInfo | This method is similar to to LoadPerspective, with the exception that |
LoadPerspective | Loads a layout which was saved with SavePerspective. |
MaximizePane | Maximizes the input pane. |
MinimizePane | Minimizes a pane in a newly and automatically created AuiToolBar. |
OnCaptionDoubleClicked | Handles the mouse double click on the pane caption. |
OnCaptureLost | Handles the wx.EVT_MOUSE_CAPTURE_LOST event for AuiManager. |
OnChildFocus | Handles the wx.EVT_CHILD_FOCUS event for AuiManager. |
OnEraseBackground | Handles the wx.EVT_ERASE_BACKGROUND event for AuiManager. |
OnFindManager | Handles the EVT_AUI_FIND_MANAGER event for AuiManager. |
OnFloatingPaneActivated | Handles the activation event of a floating pane. |
OnFloatingPaneClosed | Handles the close event of a floating pane. |
OnFloatingPaneMoved | Handles the move event of a floating pane. |
OnFloatingPaneResized | Handles the resizing of a floating pane. |
OnGripperClicked | Handles the mouse click on the pane gripper. |
OnHintFadeTimer | Handles the wx.EVT_TIMER event for AuiManager. |
OnLeaveWindow | Handles the wx.EVT_LEAVE_WINDOW event for AuiManager. |
OnLeftDClick | Handles the wx.EVT_LEFT_DCLICK event for AuiManager. |
OnLeftDown | Handles the wx.EVT_LEFT_DOWN event for AuiManager. |
OnLeftUp | Handles the wx.EVT_LEFT_UP event for AuiManager. |
OnLeftUp_ClickButton | Sub-handler for the OnLeftUp event. |
OnLeftUp_DragFloatingPane | Sub-handler for the OnLeftUp event. |
OnLeftUp_DragToolbarPane | Sub-handler for the OnLeftUp event. |
OnLeftUp_Resize | Sub-handler for the OnLeftUp event. |
OnMotion | Handles the wx.EVT_MOTION event for AuiManager. |
OnMotion_ClickCaption | Sub-handler for the OnMotion event. |
OnMotion_DragFloatingPane | Sub-handler for the OnMotion event. |
OnMotion_DragToolbarPane | Sub-handler for the OnMotion event. |
OnMotion_Other | Sub-handler for the OnMotion event. |
OnMotion_Resize | Sub-handler for the OnMotion event. |
OnMove | Handles the wx.EVT_MOVE event for AuiManager. |
OnPaint | Handles the wx.EVT_PAINT event for AuiManager. |
OnPaneButton | Handles the EVT_AUI_PANE_BUTTON event for AuiManager. |
OnPaneDocked | Handles the EVT_AUI_PANE_DOCKED event for AuiManager. |
OnRender | Draws all of the pane captions, sashes, backgrounds, captions, grippers, pane borders and buttons. |
OnRestoreMinimizedPane | Handles the EVT_AUI_PANE_MIN_RESTORE event for AuiManager. |
OnSetCursor | Handles the wx.EVT_SET_CURSOR event for AuiManager. |
OnSize | Handles the wx.EVT_SIZE event for AuiManager. |
OnSysColourChanged | Handles the wx.EVT_SYS_COLOUR_CHANGED event for AuiManager. |
OnTabBeginDrag | Handles the EVT_AUINOTEBOOK_BEGIN_DRAG event. |
OnTabPageClose | Handles the EVT_AUINOTEBOOK_PAGE_CLOSE event. |
OnTabSelected | Handles the EVT_AUINOTEBOOK_PAGE_CHANGED event. |
PaneFromTabEvent | Returns a AuiPaneInfo from a AuiNotebookEvent event. |
PaneHitTest | Similar to HitTest, but it checks in which AuiPaneInfo rectangle the |
ProcessDockResult | This is a utility function used by DoDrop - it checks |
ProcessMgrEvent | Process the AUI events sent to the manager. |
RefreshButton | Refreshes a pane button in the caption. |
RefreshCaptions | Refreshes all pane captions. |
RemoveAutoNBCaption | Removes the caption on newly created automatic notebooks. |
Render | Fires a render event, which is normally handled by |
Repaint | Repaints the entire frame decorations (sashes, borders, buttons and so on). |
RepositionPane | Repositions a pane after the main frame has been moved/resized. |
RequestUserAttention | Requests the user attention by intermittently highlighting the pane caption. |
RestoreMaximizedPane | Restores the current maximized pane (if any). |
RestoreMinimizedPane | Restores a previously minimized pane. |
RestorePane | Restores the input pane from a previous maximized or minimized state. |
RestrictResize | Common method between DoEndResizeAction and OnLeftUp_Resize. |
SavePaneInfo | This method is similar to SavePerspective, with the exception |
SavePerspective | Saves the entire user interface layout into an encoded string, which can then |
SavePreviousDockSizes | Stores the previous dock sizes, to be used in a “restore” action later. |
SetAGWFlags | This method is used to specify AuiManager‘s settings flags. |
SetAnimationStep | Sets the animation step speed (a float) to use in AnimateDocking. |
SetArtProvider | Instructs AuiManager to use art provider specified by the parameter |
SetAttributes | Sets all the attributes contained in attrs to a AuiPaneInfo. |
SetAutoNotebookStyle | Sets the default AGW-specific window style for automatic notebooks. |
SetAutoNotebookTabArt | Sets the default tab art provider for automatic notebooks. |
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. |
SetFrame | Called to specify the frame or window which is to be managed by AuiManager. |
SetManagedWindow | Called to specify the frame or window which is to be managed by AuiManager. |
SetMasterManager | Sets the master manager for an automatic AuiNotebook. |
SetSnapLimits | Modifies the snap limits used when snapping the managed_window to the screen |
ShowHint | Shows the AUI hint window. |
ShowPane | Shows or hides a pane based on the window passed as input. |
SlideIn | Handles the wx.EVT_TIMER event for AuiManager. |
SlideOut | Slides out a preview of a minimized pane. |
SmartShrink | Used to intelligently shrink the docks’ size (if needed). |
SmoothDock | This method implements a smooth docking effect for floating panes, similar to |
Snap | Snaps the main frame to specified position on the screen. |
SnapPane | Snaps a floating pane to one of the main frame sides. |
SnapToScreen | Snaps the main frame to specified position on the screen. |
StartPreviewTimer | Starts a timer for sliding in and out a minimized pane. |
StopPreviewTimer | Stops a timer for sliding in and out a minimized pane. |
SwitchToolBarOrientation | Switches the toolbar orientation from vertical to horizontal and vice-versa. |
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. |
UpdateButtonOnScreen | Updates/redraws the UI part containing a pane button. |
UpdateDockingGuides | Updates the docking guide windows positions and appearance. |
UpdateNotebook | Updates the automatic AuiNotebook in the layout (if any exists). |
AuiManager manages the panes associated with it for a particular wx.Frame, using a pane’s AuiPaneInfo information to determine each pane’s docking and floating behavior. AuiManager uses wxPython’s 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 applications’ specific needs.
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, the AuiManager.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, -1)
text2 = wx.TextCtrl(self, -1)
self._mgr.AddPane(text1, AuiPaneInfo().Left().Caption("Pane Number One"))
self._mgr.AddPane(text2, AuiPaneInfo().Bottom().Caption("Pane Number Two"))
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 it’s 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 in row 0, and the second in 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 (AUI.py).
Default class constructor.
Parameters: |
|
---|
Activates the pane to which window is associated.
Parameters: | window – a wx.Window derived window. |
---|
Tells the frame manager to start managing a child window. There are four versions of this function. The first verison allows the full spectrum of pane parameter possibilities (AddPane1). The second version is used for simpler user interfaces which do not require as much configuration (AddPane2). The AddPane3 version allows a drop position to be specified, which will determine where the pane will be added. The AddPane4 version allows to turn the target AuiPaneInfo pane into a notebook and the added pane into a page.
In wxPython, simply call AddPane.
Parameters: |
|
---|
Animates the minimization/docking of a pane a la Eclipse, using a wx.ScreenDC to draw a “moving docking rectangle” on the screen.
Parameters: |
|
---|
Note
This functionality is not available on wxMAC as this platform doesn’t have the ability to use wx.ScreenDC to draw on-screen and on Windows > Vista.
Calculates the minimum and maximum sizes allowed for the input dock.
Parameters: | dock – the AuiDockInfo structure to analyze. |
---|
Calculates the drop hint rectangle.
The method first calls DoDrop to determine the exact position the pane would be at were if dropped. If the pane would indeed become docked at the specified drop point, the the rectangle hint will be returned in screen coordinates. Otherwise, an empty rectangle is returned.
Parameters: |
|
---|
Calculates the minimum and maximum sizes allowed for the input pane.
Parameters: |
|
---|
Returns whether a pane can be docked or not.
Parameters: | p – the AuiPaneInfo class with all the pane’s information. |
---|
Returns whether ModernDockArt can be used (Windows XP / Vista / 7 only, requires Mark Hammonds’s pywin32 package).
Checks if a UI part can be actually resized.
Parameters: | part – a UI part. |
---|
Checks if a pane has moved by a visible amount.
Parameters: | pane – an instance of AuiPaneInfo. |
---|
Destroys or hides the pane depending on its flags.
Parameters: | pane_info – a AuiPaneInfo instance. |
---|
Copies all the attributes of the input target into another AuiPaneInfo.
Parameters: | target – the source AuiPaneInfo from where to copy attributes. |
---|
Creates a floating frame for the windows.
Parameters: |
|
---|
Creates an automatic AuiNotebook when a pane is docked on top of another pane.
Creates an auto-notebook base from a pane, and then add that pane as a page.
Parameters: |
|
---|
Tells the AuiManager to stop managing the pane specified by window. The window, if in a floated frame, is reparented to the frame managed by AuiManager.
Parameters: | window – the window to be un-managed. |
---|
This is an important function. It basically takes a mouse position, and determines where the panes new position would be. If the pane is to be dropped, it performs the drop operation using the specified dock and pane arrays. By specifying copy dock and pane arrays when calling, a “what-if” scenario can be performed, giving precise coordinates for drop hints.
Parameters: |
|
---|
Handles the situation in which the dropped pane contains a normal window.
Parameters: |
|
---|
Handles the situation in which target is a single dock guide.
Parameters: |
|
---|
Handles the situation in which the dropped pane is not floating.
Parameters: |
|
---|
Drop a pane in the interface.
Parameters: |
|
---|
Insert a row in the interface before dropping.
Parameters: |
|
---|
Handles the situation in which the dropped pane contains a toolbar.
Parameters: |
|
---|
Ends a resize action, or for live update, resizes the sash.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
This is an internal function which invokes wx.Sizer.Layout on the frame’s main sizer, then measures all the various UI items and updates their internal rectangles.
Note
This should always be called instead of calling self._managed_window.Layout() directly.
Calculates the hint rectangle by calling CalculateHintRect. If there is a rectangle, it shows it by calling ShowHint, otherwise it hides any hint rectangle currently shown.
Parameters: |
|
---|
Draws a pane button in the caption (convenience function).
Parameters: |
---|
Fires one of the EVT_AUI_PANE_FLOATED/FLOATING/DOCKING/DOCKED/ACTIVATED event.
Parameters: |
|
---|
Returns the current manager’s flags.
See also
SetAGWFlags for a list of possible AuiManager flags.
Returns the animation step speed (a float) to use in AnimateDocking.
Returns all the attributes of a AuiPaneInfo.
Parameters: | pane – a AuiPaneInfo instance. |
---|
Returns the default AGW-specific window style for automatic notebooks.
See also
SetAutoNotebookStyle method for a list of possible styles.
This is an internal function which returns a dock’s offset in pixels from the left side of the window (for horizontal docks) or from the top of the window (for vertical docks).
This value is necessary for calculating fixed-pane/toolbar offsets when they are dragged.
Parameters: | test – a fake AuiPaneInfo for testing purposes. |
---|
Returns the window being managed by AuiManager.
Warning
This method is now deprecated, use GetManagedWindow instead.
Returns the window being managed by AuiManager.
Returns all the automatic AuiNotebook in the AuiManager.
Returns the dimensions of the dock which lives opposite of the input dock.
Parameters: |
|
---|
Looks up a AuiPaneInfo structure based on the supplied window pointer. Upon failure, GetPane returns an empty AuiPaneInfo, a condition which can be checked by calling AuiPaneInfo.IsOk().
The pane info’s structure may then be modified. Once a pane’s info is modified, Update must be called to realize the changes in the UI.
Parameters: | item – either a pane name or a wx.Window. |
---|
This version of GetPane looks up a pane based on a ‘pane name’.
Parameters: | name – the pane name. |
---|
See also
This version of GetPane looks up a pane based on a ‘pane window’.
Parameters: | window – a wx.Window derived window. |
---|
See also
Looks up the pane border UI part of the pane specified. This allows the caller to get the exact rectangle of the pane in question, including decorations like caption and border.
Parameters: | wnd – the window to which the pane border belongs to. |
---|
Returns all the panes positions and sizes in a dock.
Parameters: | dock – a AuiDockInfo instance. |
---|
Returns the rectangle surrounding the specified UI parts.
Parameters: | uiparts – UI parts. |
---|
Returns the partner dock for the input dock.
Parameters: | dock – a AuiDockInfo instance. |
---|
Returns the partner pane for the input pane. They both need to live in the same AuiDockInfo.
Parameters: |
|
---|
Returns the dimensions and proportion of the input dock.
Parameters: | dock – the AuiDockInfo structure to analyze. |
---|
This is an internal function which determines which UI item the specified coordinates are over.
Parameters: |
|
---|
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 pane_info.
Because pane_info 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.
Parameters: |
|
---|
Returns whether a pane button in the pane caption is visible.
Parameters: | part – the UI part to analyze. |
---|
Adds a dock into the existing layout.
Parameters: |
|
---|
Adds a pane into the existing layout (in an existing dock).
Parameters: |
|
---|
Layouts all the UI structures in the interface.
Parameters: |
|
---|
This method is similar to to LoadPerspective, with the exception that it only loads information about a single pane. It is used in combination with SavePaneInfo.
Parameters: |
|
---|
Loads a layout which was saved with SavePerspective.
If the update flag parameter is True, Update will be automatically invoked, thus realizing the saved perspective on screen.
Parameters: |
|
---|
Maximizes the input pane.
Parameters: |
|
---|
Minimizes a pane in a newly and automatically created AuiToolBar.
Clicking on the minimize button causes a new AuiToolBar to be created and added to the frame manager (currently the implementation is such that panes at West will have a toolbar at the right, panes at South will have toolbars at the bottom etc...) and the pane is hidden in the manager.
Clicking on the restore button on the newly created toolbar will result in the toolbar being removed and the original pane being restored.
Parameters: | paneInfo – a AuiPaneInfo instance for the pane to be minimized. |
---|
Handles the mouse double click on the pane caption.
Parameters: | pane_window – a wx.Window derived window, managed by the pane. |
---|
Handles the wx.EVT_MOUSE_CAPTURE_LOST event for AuiManager.
Parameters: | event – a wx.MouseCaptureLostEvent to be processed. |
---|
Handles the wx.EVT_CHILD_FOCUS event for AuiManager.
Parameters: | event – a wx.ChildFocusEvent to be processed. |
---|
Handles the wx.EVT_ERASE_BACKGROUND event for AuiManager.
Parameters: | event – wx.EraseEvent to be processed. |
---|
Note
This is intentionally empty (excluding wxMAC) to reduce flickering while drawing.
Handles the EVT_AUI_FIND_MANAGER event for AuiManager.
Parameters: | event – a AuiManagerEvent event to be processed. |
---|
Handles the activation event of a floating pane.
Parameters: | wnd – a wx.Window derived window, managed by the pane. |
---|
Handles the close event of a floating pane.
Parameters: |
|
---|
Handles the mouse click on the pane gripper.
Parameters: |
---|
Handles the wx.EVT_TIMER event for AuiManager.
Parameters: | event – a wx.TimerEvent to be processed. |
---|
Handles the wx.EVT_LEAVE_WINDOW event for AuiManager.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Handles the wx.EVT_LEFT_DCLICK event for AuiManager.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Handles the wx.EVT_LEFT_DOWN event for AuiManager.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Handles the wx.EVT_LEFT_UP event for AuiManager.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Sub-handler for the OnLeftUp event.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Sub-handler for the OnLeftUp event.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Sub-handler for the OnLeftUp event.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Sub-handler for the OnLeftUp event.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Handles the wx.EVT_MOTION event for AuiManager.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Sub-handler for the OnMotion event.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Sub-handler for the OnMotion event.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Sub-handler for the OnMotion event.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Sub-handler for the OnMotion event.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Sub-handler for the OnMotion event.
Parameters: | event – a wx.MouseEvent to be processed. |
---|
Handles the wx.EVT_MOVE event for AuiManager.
Parameters: | event – a wx.MoveEvent to be processed. |
---|
Handles the wx.EVT_PAINT event for AuiManager.
Parameters: | event – an instance of wx.PaintEvent to be processed. |
---|
Handles the EVT_AUI_PANE_BUTTON event for AuiManager.
Parameters: | event – a AuiManagerEvent event to be processed. |
---|
Handles the EVT_AUI_PANE_DOCKED event for AuiManager.
Parameters: | event – an instance of AuiManagerEvent to be processed. |
---|
Draws all of the pane captions, sashes, backgrounds, captions, grippers, pane borders and buttons. It renders the entire user interface. It binds the EVT_AUI_RENDER event.
Parameters: | event – an instance of AuiManagerEvent. |
---|
Handles the EVT_AUI_PANE_MIN_RESTORE event for AuiManager.
Parameters: | event – an instance of AuiManagerEvent to be processed. |
---|
Handles the wx.EVT_SET_CURSOR event for AuiManager.
Parameters: | event – a wx.SetCursorEvent to be processed. |
---|
Handles the wx.EVT_SIZE event for AuiManager.
Parameters: | event – a wx.SizeEvent to be processed. |
---|
Handles the wx.EVT_SYS_COLOUR_CHANGED event for AuiManager.
Parameters: | event – a wx.SysColourChangedEvent to be processed. |
---|
Handles the EVT_AUINOTEBOOK_BEGIN_DRAG event.
Parameters: | event – a AuiNotebookEvent event to be processed. |
---|
Handles the EVT_AUINOTEBOOK_PAGE_CLOSE event.
Parameters: | event – a AuiNotebookEvent event to be processed. |
---|
Handles the EVT_AUINOTEBOOK_PAGE_CHANGED event.
Parameters: | event – a AuiNotebookEvent event to be processed. |
---|
Returns a AuiPaneInfo from a AuiNotebookEvent event.
Parameters: | event – a AuiNotebookEvent event. |
---|
Similar to HitTest, but it checks in which AuiPaneInfo rectangle the input point belongs to.
Parameters: |
|
---|
This is a utility function used by DoDrop - it checks if a dock operation is allowed, the new dock position is copied into the target info. If the operation was allowed, the function returns True.
Parameters: |
|
---|
Process the AUI events sent to the manager.
Parameters: | event – the event to process, an instance of AuiManagerEvent. |
---|
Refreshes a pane button in the caption.
Parameters: | part – the UI part to analyze. |
---|
Removes the caption on newly created automatic notebooks.
Parameters: | pane – an instance of AuiPaneInfo (the target notebook). |
---|
Fires a render event, which is normally handled by OnRender. This allows the render function to be overridden via the render event.
This can be useful for painting custom graphics in the main window. Default behavior can be invoked in the overridden function by calling OnRender.
Parameters: | dc – a wx.DC device context object. |
---|
Repaints the entire frame decorations (sashes, borders, buttons and so on). It renders the entire user interface.
Parameters: | dc – if not None, an instance of wx.PaintDC. |
---|
Repositions a pane after the main frame has been moved/resized.
Parameters: |
|
---|
Requests the user attention by intermittently highlighting the pane caption.
Parameters: | pane_window – a wx.Window derived window, managed by the pane. |
---|
Restores a previously minimized pane.
Parameters: | paneInfo – a AuiPaneInfo instance for the pane to be restored. |
---|
Restores the input pane from a previous maximized or minimized state.
Parameters: | pane_info – a AuiPaneInfo instance. |
---|
Common method between DoEndResizeAction and OnLeftUp_Resize.
This method is similar to SavePerspective, with the exception that it only saves information about a single pane. It is used in combination with LoadPaneInfo.
Parameters: | pane – a AuiPaneInfo instance to save. |
---|
Saves the entire user interface layout into an encoded string, which can then be stored by the application (probably using wx.Config).
When a perspective is restored using LoadPerspective, the entire user interface will return to the state it was when the perspective was saved.
Stores the previous dock sizes, to be used in a “restore” action later.
Parameters: | pane_info – a AuiPaneInfo instance. |
---|
This method is used to specify AuiManager‘s settings flags.
Parameters: | agwFlags – specifies options which allow the frame management behavior
to be modified. agwFlags can be one of the following style bits:
Note If using the AUI_MGR_USE_NATIVE_MINIFRAMES, double-clicking on a floating pane caption will not re-dock the pane, but simply maximize it (if AuiPaneInfo.MaximizeButton() has been set to True) or do nothing. |
---|
Sets the animation step speed (a float) to use in AnimateDocking.
Parameters: | step – a floating point value for the animation speed. |
---|
Instructs AuiManager to use art provider specified by the parameter art_provider for all drawing calls. This allows plugable look-and-feel features.
Parameters: | art_provider – a AUI dock art provider. |
---|
Note
The previous art provider object, if any, will be deleted by AuiManager.
Sets all the attributes contained in attrs to a AuiPaneInfo.
Parameters: |
|
---|
Sets the default AGW-specific window style for automatic notebooks.
Parameters: | agwStyle – the underlying AuiNotebook window style.
This can be a combination of the following bits:
|
---|
Sets the default tab art provider for automatic notebooks.
Parameters: | art – a tab art provider. |
---|
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.
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 SetDockSizeConstraint with (0.5, 0.5) will cause new docks to be limited to half of the size of the entire managed window.
Parameters: |
|
---|
Called to specify the frame or window which is to be managed by AuiManager. Frame management is not restricted to just frames. Child windows or custom controls are also allowed.
Parameters: | managed_window – specifies the window which should be managed by the AUI manager. |
---|
Warning
This method is now deprecated, use SetManagedWindow instead.
Called to specify the frame or window which is to be managed by AuiManager. Frame management is not restricted to just frames. Child windows or custom controls are also allowed.
Parameters: | managed_window – specifies the window which should be managed by the AUI manager. |
---|
Sets the master manager for an automatic AuiNotebook.
Parameters: | manager – an instance of AuiManager. |
---|
Modifies the snap limits used when snapping the managed_window to the screen (using SnapToScreen) or when snapping the floating panes to one side of the managed_window (using SnapPane).
To change the limit after which the managed_window or the floating panes are automatically stickled to the screen border (or to the managed_window side), set these two variables. Default values are 15 pixels.
Parameters: |
|
---|
Shows the AUI hint window.
Parameters: | rect – the hint rect calculated in advance. |
---|
Shows or hides a pane based on the window passed as input.
Parameters: |
|
---|
Handles the wx.EVT_TIMER event for AuiManager.
Parameters: | event – a wx.TimerEvent to be processed. |
---|
Note
This is used solely for sliding in and out minimized panes.
Slides out a preview of a minimized pane.
Note
This is used solely for sliding in and out minimized panes.
Used to intelligently shrink the docks’ size (if needed).
Parameters: |
|
---|
This method implements a smooth docking effect for floating panes, similar to what the PyQT library does with its floating windows.
Parameters: | paneInfo – an instance of AuiPaneInfo. |
---|
Note
The smooth docking effect can only be used if you set the AUI_MGR_SMOOTH_DOCKING style to AuiManager.
Snaps a floating pane to one of the main frame sides.
Parameters: |
|
---|
Snaps the main frame to specified position on the screen.
Parameters: |
|
---|
Starts a timer for sliding in and out a minimized pane.
Parameters: | toolbar – the AuiToolBar containing the minimized pane tool. |
---|
Switches the toolbar orientation from vertical to horizontal and vice-versa. This is especially useful for vertical docked toolbars once they float.
Parameters: | pane – an instance of AuiPaneInfo, which may have a AuiToolBar window associated with it. |
---|
Uninitializes the framework and should be called before a managed frame or window is destroyed. UnInit is usually called in the managed wx.Frame / wx.Window destructor.
It is necessary to call this function before the managed frame or window is destroyed, otherwise the manager cannot remove its custom event handlers from a window.
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 AuiPaneInfo structures (retrieved with 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.
Updates/redraws the UI part containing a pane button.
Parameters: |
|
---|
Updates the docking guide windows positions and appearance.
Parameters: | paneInfo – a AuiPaneInfo instance. |
---|
Updates the automatic AuiNotebook in the layout (if any exists).