1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.gestures
.. highlight:: python
.. _wx.lib.gestures.MouseGestures:
==========================================================================================================================================
|phoenix_title| **wx.lib.gestures.MouseGestures**
==========================================================================================================================================
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>MouseGestures</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.gestures.MouseGestures_inheritance.png" alt="Inheritance diagram of MouseGestures" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.gestures.MouseGestures.html" title="wx.lib.gestures.MouseGestures" alt="" coords="5,5,224,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.gestures.MouseGestures.__init__`
:meth:`~wx.lib.gestures.MouseGestures.AddGesture` Registers a gesture, and an associated function, with any arguments needed.
:meth:`~wx.lib.gestures.MouseGestures.DoAction` If the gesture is in the array of registered gestures, run the associated function.
:meth:`~wx.lib.gestures.MouseGestures.End` Stops recording the points to create the mouse gesture from,
:meth:`~wx.lib.gestures.MouseGestures.GetDirection` Gets the direction between two points.
:meth:`~wx.lib.gestures.MouseGestures.GetRecording` Returns whether or not Gesture Recording has started.
:meth:`~wx.lib.gestures.MouseGestures.OnMotion` Internal. Used if Start() has been run
:meth:`~wx.lib.gestures.MouseGestures.OnMouseEvent` Internal. Used in Auto Mode.
:meth:`~wx.lib.gestures.MouseGestures.RemoveGesture` Removes a gesture, and its associated action
:meth:`~wx.lib.gestures.MouseGestures.SetAuto` Warning: Once auto is set, it stays set, unless you manually use UnBind
:meth:`~wx.lib.gestures.MouseGestures.SetGesturePen` Sets the colour and width of the line drawn to visually represent each gesture
:meth:`~wx.lib.gestures.MouseGestures.SetGesturesVisible` Sets whether a line is drawn to visually represent each gesture
:meth:`~wx.lib.gestures.MouseGestures.SetModifiers` Takes an array of wx Key constants (Control, Shift, and/or Alt).
:meth:`~wx.lib.gestures.MouseGestures.SetMouseButton` Takes the wx constant for the target mousebutton
:meth:`~wx.lib.gestures.MouseGestures.SetWobbleTolerance` Sets just how much wobble this class can take!
:meth:`~wx.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=wx.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
|
