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
231
232
233
234
|
.. 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
.. _wx.SetCursorEvent:
==========================================================================================================================================
|phoenix_title| **wx.SetCursorEvent**
==========================================================================================================================================
A :ref:`wx.SetCursorEvent` is generated from :ref:`wx.Window` when the mouse cursor is about to be set as a result of mouse motion.
This event gives the application the chance to perform specific mouse cursor processing based on the current position of the mouse within the window. Use :meth:`wx.SetCursorEvent.SetCursor` to specify the cursor you want to be displayed.
.. _SetCursorEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.SetCursorEvent` parameter.
Event macros:
- EVT_SET_CURSOR: Process a ``wxEVT_SET_CURSOR`` event.
.. seealso:: :ref:`wx.SetCursor`, :meth:`wx.Window.SetCursor`
|
|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>SetCursorEvent</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.SetCursorEvent_inheritance.png" alt="Inheritance diagram of SetCursorEvent" 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.Event.html" title="wx.Event" alt="" coords="37,83,115,112"/> <area shape="rect" id="node3" href="wx.SetCursorEvent.html" title="wx.SetCursorEvent" alt="" coords="5,160,147,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="35,5,116,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.SetCursorEvent.__init__` Constructor, used by the library itself internally to initialize the event object.
:meth:`~wx.SetCursorEvent.GetCursor` Returns a reference to the cursor specified by this event.
:meth:`~wx.SetCursorEvent.GetX` Returns the X coordinate of the mouse in client coordinates.
:meth:`~wx.SetCursorEvent.GetY` Returns the Y coordinate of the mouse in client coordinates.
:meth:`~wx.SetCursorEvent.HasCursor` Returns ``True`` if the cursor specified by this event is a valid cursor.
:meth:`~wx.SetCursorEvent.SetCursor` Sets the cursor associated with this event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.SetCursorEvent.Cursor` See :meth:`~wx.SetCursorEvent.GetCursor` and :meth:`~wx.SetCursorEvent.SetCursor`
:attr:`~wx.SetCursorEvent.X` See :meth:`~wx.SetCursorEvent.GetX`
:attr:`~wx.SetCursorEvent.Y` See :meth:`~wx.SetCursorEvent.GetY`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.SetCursorEvent(Event)
**Possible constructors**::
SetCursorEvent(x=0, y=0)
A SetCursorEvent is generated from Window when the mouse cursor is
about to be set as a result of mouse motion.
.. method:: __init__(self, x=0, y=0)
Constructor, used by the library itself internally to initialize the event object.
:param `x`:
:type `x`: int
:param `y`:
:type `y`: int
.. method:: GetCursor(self)
Returns a reference to the cursor specified by this event.
:rtype: :ref:`wx.Cursor`
.. method:: GetX(self)
Returns the X coordinate of the mouse in client coordinates.
:rtype: :ref:`wx.Coord`
.. method:: GetY(self)
Returns the Y coordinate of the mouse in client coordinates.
:rtype: :ref:`wx.Coord`
.. method:: HasCursor(self)
Returns ``True`` if the cursor specified by this event is a valid cursor.
:rtype: `bool`
.. note::
You cannot specify NullCursor with this event, as it is not considered a valid cursor.
.. method:: SetCursor(self, cursor)
Sets the cursor associated with this event.
:param `cursor`:
:type `cursor`: wx.Cursor
.. attribute:: Cursor
See :meth:`~wx.SetCursorEvent.GetCursor` and :meth:`~wx.SetCursorEvent.SetCursor`
.. attribute:: X
See :meth:`~wx.SetCursorEvent.GetX`
.. attribute:: Y
See :meth:`~wx.SetCursorEvent.GetY`
|
