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
|
.. 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.SpinEvent:
==========================================================================================================================================
|phoenix_title| **wx.SpinEvent**
==========================================================================================================================================
This event class is used for the events generated by :ref:`wx.SpinButton` and :ref:`wx.SpinCtrl`.
.. _SpinEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.SpinEvent` parameter.
Event macros:
- EVT_SPIN: Generated whenever an arrow is pressed.
- EVT_SPIN_UP: Generated when left/up arrow is pressed.
- EVT_SPIN_DOWN: Generated when right/down arrow is pressed.
Note that if you handle both ``SPIN`` and ``wx.UP`` or ``wx.DOWN`` events, you will be notified about each of them twice: first the UP/DOWN event will be received and then, if it wasn't vetoed, the ``SPIN`` event will be sent.
.. seealso:: :ref:`wx.SpinButton` and :ref:`wx.SpinCtrl`
|
|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>SpinEvent</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.SpinEvent_inheritance.png" alt="Inheritance diagram of SpinEvent" 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.SpinEvent.html" title="wx.SpinEvent" alt="" coords="24,315,131,344"/> <area shape="rect" id="node2" href="wx.NotifyEvent.html" title="wx.NotifyEvent" alt="" coords="20,237,135,267"/> <area shape="rect" id="node3" href="wx.Event.html" title="wx.Event" alt="" coords="38,83,116,112"/> <area shape="rect" id="node5" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="5,160,149,189"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="36,5,117,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.SpinEvent.__init__` The constructor is not normally used by the user code.
:meth:`~wx.SpinEvent.GetPosition` Retrieve the current spin button or control value.
:meth:`~wx.SpinEvent.SetPosition` Set the value associated with the event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.SpinEvent.Position` See :meth:`~wx.SpinEvent.GetPosition` and :meth:`~wx.SpinEvent.SetPosition`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.SpinEvent(NotifyEvent)
**Possible constructors**::
SpinEvent(commandType=wxEVT_NULL, id=0)
This event class is used for the events generated by SpinButton and
SpinCtrl.
.. method:: __init__(self, commandType=wxEVT_NULL, id=0)
The constructor is not normally used by the user code.
:param `commandType`:
:type `commandType`: wx.EventType
:param `id`:
:type `id`: int
.. method:: GetPosition(self)
Retrieve the current spin button or control value.
:rtype: `int`
.. method:: SetPosition(self, pos)
Set the value associated with the event.
:param `pos`:
:type `pos`: int
.. attribute:: Position
See :meth:`~wx.SpinEvent.GetPosition` and :meth:`~wx.SpinEvent.SetPosition`
|
