wx.lib.agw.aui.framemanager.AuiCenterDockingGuide

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

Class Hierarchy

Inheritance diagram for class AuiCenterDockingGuide:

Known Superclasses

wx.lib.agw.aui.framemanager.AuiDockingGuide

Methods Summary

__init__	Default class constructor.
AeroMove	Moves the docking guide window to the new position.
CreateShapesWithStyle	Creates the docking guide window shape based on which docking bitmaps are used.
HitTest	Checks if the mouse position is inside the target windows rect.
OnEraseBackground	Handles the wx.EVT_ERASE_BACKGROUND event for AuiCenterDockingGuide.
OnPaint	Handles the wx.EVT_PAINT event for AuiCenterDockingGuide.
SetGuideShape	Sets the correct shape for the docking guide window.
UpdateDockGuide	Updates the docking guides images depending on the mouse position, using focused
ValidateNotebookDocking	Sets whether a pane can be docked on top of another to create an automatic

Class API

---

class AuiCenterDockingGuide(AuiDockingGuide)

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

Methods

---

__init__(self, parent)

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

Parameters:parent – the AuiManager parent.

---

AeroMove(self, pos)

Moves the docking guide window to the new position.

Parameters:pos (wx.Point) – the new docking guide position.

---

CreateShapesWithStyle(self)

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

---

HitTest(self, x, y)

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

Parameters:

• x (integer) – the x mouse position;
• y (integer) – the y mouse position.

---

OnEraseBackground(self, event)

Handles the wx.EVT_ERASE_BACKGROUND event for AuiCenterDockingGuide.

Parameters:event – EraseEvent to be processed.

Note

This is intentionally empty to reduce flickering while drawing.

---

OnPaint(self, event)

Handles the wx.EVT_PAINT event for AuiCenterDockingGuide.

Parameters:event – a PaintEvent to be processed.

---

SetGuideShape(self, event=None)

Sets the correct shape for the docking guide window.

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

---

UpdateDockGuide(self, pos)

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 (wx.Point) – the mouse position.

---

ValidateNotebookDocking(self, valid)

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

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