.. include:: headings.inc

.. currentmodule:: lib.gestures

.. highlight:: python



.. _lib.gestures.MouseGestures:

==========================================================================================================================================
|phoenix_title|  **MouseGestures**
==========================================================================================================================================





|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **MouseGestures**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.gestures.MouseGestures_inheritance.png" alt="Inheritance diagram of MouseGestures" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.gestures.MouseGestures.html" title="gestures.MouseGestures" alt="" coords="5,5,208,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

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


|


|api| Class API
===============
   

.. class:: MouseGestures:



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


   .. method:: AddGesture(self, gesture, action, \*args)

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


   .. method:: DoAction(self, gesture)

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


   .. method:: End(self)

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


   .. method:: GetDirection(self, point1, point2)

      Gets the direction between two points.


   .. method:: GetRecording(self)

      Returns whether or not Gesture Recording has started.


   .. method:: OnMotion(self, event)

      Internal.  Used if Start() has been run


   .. method:: OnMouseEvent(self, event)

      Internal.  Used in Auto Mode.


   .. method:: RemoveGesture(self, gesture)

      Removes a gesture, and its associated action


   .. method:: SetAuto(self, auto)

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


   .. method:: SetGesturePen(self, colour, width)

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


   .. method:: SetGesturesVisible(self, vis)

      Sets whether a line is drawn to visually represent each gesture


   .. method:: SetModifiers(self, modifiers=[])

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


   .. method:: SetMouseButton(self, mousebutton)

      Takes the wx constant for the target mousebutton


   .. method:: SetWobbleTolerance(self, wobbletolerance)

      Sets just how much wobble this class can take!


   .. method:: Start(self)

      Starts recording the points to create the mouse gesture from