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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.GestureEvent:
==========================================================================================================================================
|phoenix_title| **wx.GestureEvent**
==========================================================================================================================================
This is the base class for all supported gesture events.
.. versionadded:: 4.1/wxWidgets-3.1.1
.. note::
Gesture events are not generated by default, you must call :meth:`wx.Window.EnableTouchEvents` with the appropriate parameter to request their generation.
.. seealso:: :ref:`wx.PanGestureEvent`, :ref:`wx.ZoomGestureEvent`, :ref:`wx.RotateGestureEvent`
|
|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>GestureEvent</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.GestureEvent_inheritance.png" alt="Inheritance diagram of GestureEvent" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.GestureEvent.html" title="wx.GestureEvent" alt="" coords="5,160,139,189"/> <area shape="rect" id="node2" href="wx.Event.html" title="wx.Event" alt="" coords="31,83,113,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="29,5,115,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.LongPressEvent`, :ref:`wx.PanGestureEvent`, :ref:`wx.PressAndTapEvent`, :ref:`wx.RotateGestureEvent`, :ref:`wx.TwoFingerTapEvent`, :ref:`wx.ZoomGestureEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.GestureEvent.__init__` Constructor.
:meth:`~wx.GestureEvent.GetPosition` Returns the position where the event took effect, in client coordinates: position of Pan event, center of zoom for Zoom event, center of rotation for Rotate event, center of box formed by 2 fingers for Two Finger Tap event and position of the pressed finger for Press and Tap Event.
:meth:`~wx.GestureEvent.IsGestureEnd` Returns ``True`` if the event was the last in a gesture sequence.
:meth:`~wx.GestureEvent.IsGestureStart` Returns ``True`` if the event was the first in a gesture sequence.
:meth:`~wx.GestureEvent.SetGestureEnd` Sets the event to be the last in a gesture sequence.
:meth:`~wx.GestureEvent.SetGestureStart` Sets the event to be the first in a gesture sequence.
:meth:`~wx.GestureEvent.SetPosition` Sets the position where the event took effect, in client coordinates: position of Pan event, center of zoom for Zoom event, center of rotation for Rotate event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.GestureEvent.Position` See :meth:`~wx.GestureEvent.GetPosition` and :meth:`~wx.GestureEvent.SetPosition`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.GestureEvent(Event)
**Possible constructors**::
GestureEvent(winid=0, type=wxEVT_NULL)
This is the base class for all supported gesture events.
.. method:: __init__(self, winid=0, type=wxEVT_NULL)
Constructor.
:param `winid`:
:type `winid`: wx.WindowID
:param `type`:
:type `type`: wx.EventType
.. method:: GetPosition(self)
Returns the position where the event took effect, in client coordinates: position of Pan event, center of zoom for Zoom event, center of rotation for Rotate event, center of box formed by 2 fingers for Two Finger Tap event and position of the pressed finger for Press and Tap Event.
:rtype: :ref:`wx.Point`
.. method:: IsGestureEnd(self)
Returns ``True`` if the event was the last in a gesture sequence.
:rtype: `bool`
.. method:: IsGestureStart(self)
Returns ``True`` if the event was the first in a gesture sequence.
:rtype: `bool`
.. method:: SetGestureEnd(self, isEnd=True)
Sets the event to be the last in a gesture sequence.
:param `isEnd`:
:type `isEnd`: bool
.. method:: SetGestureStart(self, isStart=True)
Sets the event to be the first in a gesture sequence.
:param `isStart`:
:type `isStart`: bool
.. method:: SetPosition(self, pos)
Sets the position where the event took effect, in client coordinates: position of Pan event, center of zoom for Zoom event, center of rotation for Rotate event.
:param `pos`:
:type `pos`: wx.Point
.. attribute:: Position
See :meth:`~wx.GestureEvent.GetPosition` and :meth:`~wx.GestureEvent.SetPosition`
|
