AGW Logo

agw_title AuiCenterDockingGuide

A docking guide window for multiple docking hint (diamond-shaped HUD).

hierarchy Inheritance Diagram

Inheritance diagram for: AuiCenterDockingGuide

Inheritance diagram of AuiCenterDockingGuide


method_summary Methods Summary

__init__Default class constructor.
AeroMoveMoves the docking guide window to the new position.
CreateShapesWithStyleCreates the docking guide window shape based on which docking bitmaps are used.
HitTestChecks if the mouse position is inside the target windows rect.
OnEraseBackgroundHandles the wx.EVT_ERASE_BACKGROUND event for AuiCenterDockingGuide.
OnPaintHandles the wx.EVT_PAINT event for AuiCenterDockingGuide.
SetGuideShapeSets the correct shape for the docking guide window.
UpdateDockGuideUpdates the docking guides images depending on the mouse position, using focused images if the mouse is inside the docking guide or unfocused images if it is outside.
ValidateNotebookDockingSets whether a pane can be docked on top of another to create an automatic

API Class API

class AuiCenterDockingGuide(AuiDockingGuide)[source]

A docking guide window for multiple docking hint (diamond-shaped HUD).



__init__(parent)[source]

Default class constructor. Used internally, do not call it in your code!

Parameters:parent – the AuiCenterDockingGuide parent.


AeroMove(pos)[source]

Moves the docking guide window to the new position.

Parameters:pos – the new docking guide position.


CreateShapesWithStyle()[source]

Creates the docking guide window shape based on which docking bitmaps are used.



HitTest(x, y)[source]

Checks if the mouse position is inside the target windows rect.

Parameters:
  • x – the x mouse position;
  • y – the y mouse position.


OnEraseBackground(event)[source]

Handles the wx.EVT_ERASE_BACKGROUND event for AuiCenterDockingGuide.

Parameters:eventwx.EraseEvent to be processed.

Note

This is intentionally empty to reduce flickering while drawing.



OnPaint(event)[source]

Handles the wx.EVT_PAINT event for AuiCenterDockingGuide.

Parameters:event – a wx.PaintEvent to be processed.


SetGuideShape(event=None)[source]

Sets the correct shape for the docking guide window.

Parameters:event – on wxGTK, a wx.WindowCreateEvent event to process.


UpdateDockGuide(pos)[source]

Updates the docking guides images depending on the mouse position, using focused images if the mouse is inside the docking guide or unfocused images if it is outside.

Parameters:pos – a wx.Point mouse position.


ValidateNotebookDocking(valid)[source]

Sets whether a pane can be docked on top of another to create an automatic AuiNotebook.

Parameters:valid – whether a pane can be docked on top to another to form an automatic AuiNotebook.
Tree

Table Of Contents

Previous topic

aui.framemanager

Next topic

AuiDockInfo