wx.lib.gestures.MouseGestures

Class Hierarchy

Inheritance diagram for class MouseGestures:

Methods Summary

__init__	Initialize self. See help(type(self)) for accurate signature.
AddGesture	Registers a gesture, and an associated function, with any arguments needed.
DoAction	If the gesture is in the array of registered gestures, run the associated function.
End	Stops recording the points to create the mouse gesture from,
GetDirection	Gets the direction between two points.
GetRecording	Returns whether or not Gesture Recording has started.
OnMotion	Internal. Used if Start() has been run
OnMouseEvent	Internal. Used in Auto Mode.
RemoveGesture	Removes a gesture, and its associated action
SetAuto	Warning: Once auto is set, it stays set, unless you manually use UnBind
SetGesturePen	Sets the colour and width of the line drawn to visually represent each gesture
SetGesturesVisible	Sets whether a line is drawn to visually represent each gesture
SetModifiers	Takes an array of wx Key constants (Control, Shift, and/or Alt).
SetMouseButton	Takes the wx constant for the target mousebutton
SetWobbleTolerance	Sets just how much wobble this class can take!
Start	Starts recording the points to create the mouse gesture from

Class API

MouseGestures:

Methods

__init__(self, parent, Auto=True, MouseButton=wx.MOUSE_BTN_MIDDLE)

Initialize self. See help(type(self)) for accurate signature.

---

AddGesture(self, gesture, action, *args)

Registers a gesture, and an associated function, with any arguments needed.

---

DoAction(self, gesture)

If the gesture is in the array of registered gestures, run the associated function.

---

End(self)

Stops recording the points to create the mouse gesture from, and creates the mouse gesture, returns the result as a string.

---

GetDirection(self, point1, point2)

Gets the direction between two points.

---

GetRecording(self)

Returns whether or not Gesture Recording has started.

---

OnMotion(self, event)

Internal. Used if Start() has been run

---

OnMouseEvent(self, event)

Internal. Used in Auto Mode.

---

RemoveGesture(self, gesture)

Removes a gesture, and its associated action

---

SetAuto(self, auto)

Warning: Once auto is set, it stays set, unless you manually use UnBind

---

SetGesturePen(self, colour, width)

Sets the colour and width of the line drawn to visually represent each gesture

---

SetGesturesVisible(self, vis)

Sets whether a line is drawn to visually represent each gesture

---

SetModifiers(self, modifiers=[])

Takes an array of wx Key constants (Control, Shift, and/or Alt). Leave empty to unset all modifiers.

---

SetMouseButton(self, mousebutton)

Takes the wx constant for the target mousebutton

---

SetWobbleTolerance(self, wobbletolerance)

Sets just how much wobble this class can take!

---

Start(self)

Starts recording the points to create the mouse gesture from