Navigation

phoenix_title wx.lib.agw.aui.framemanager.AuiSingleDockingGuide

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


class_hierarchy Class Hierarchy

Inheritance diagram for class AuiSingleDockingGuide:

super_classes Known Superclasses

wx.lib.agw.aui.framemanager.AuiDockingGuide


method_summary Methods Summary

__init__

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

AeroMove

Moves the docking window to the new position. Overridden in children classes.

CreateShapesWithStyle

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

HitTest

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

IsValid

Returns whether the docking direction is valid.

SetGuideShape

Sets the correct shape for the docking guide window.

SetShape

If the platform supports it, sets the shape of the window to that depicted by region.

SetValid

Sets the docking direction as valid or invalid.

UpdateDockGuide

Updates the docking guide images depending on the mouse position, using focused

api Class API

class AuiSingleDockingGuide(AuiDockingGuide)

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


Methods

__init__(self, parent, direction=0)

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

Parameters:

  • parent – the AuiManager parent;

  • direction (integer) – one of wx.TOP, wx.BOTTOM, wx.LEFT, wx.RIGHT.


AeroMove(self, pos)

Moves the docking window to the new position. Overridden in children classes.

Parameters:

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


CreateShapesWithStyle(self, useWhidbey)

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

Parameters:

useWhidbey (bool) – if True, use Whidbey-style bitmaps; if False, use the Aero-style bitmaps.


HitTest(self, x, y)

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

Parameters:

  • x (integer) – the x mouse position;

  • y (integer) – the y mouse position.


IsValid(self)

Returns whether the docking direction is valid.


SetGuideShape(self, event=None)

Sets the correct shape for the docking guide window.

Parameters:

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


SetShape(self, region)

If the platform supports it, sets the shape of the window to that depicted by region. The system will not display or respond to any mouse event for the pixels that lie outside of the region. To reset the window to the normal rectangular shape simply call SetShape again with an empty region.

Parameters:

region (Region) – the shape of the frame.

Note

Overridden for wxMAC.


SetValid(self, valid)

Sets the docking direction as valid or invalid.

Parameters:

valid (bool) – whether the docking direction is allowed or not.


UpdateDockGuide(self, pos)

Updates the docking guide 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.