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
|
.. 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.ScrollWinEvent:
==========================================================================================================================================
|phoenix_title| **wx.ScrollWinEvent**
==========================================================================================================================================
A scroll event holds information about events sent from scrolling windows.
Note that you can use the ``EVT_SCROLLWIN`` macros for intercepting scroll window events from the receiving window.
.. _ScrollWinEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.ScrollWinEvent` parameter.
Event macros:
- EVT_SCROLLWIN: Process all scroll events.
- EVT_SCROLLWIN_TOP: Process ``wxEVT_SCROLLWIN_TOP`` scroll-to-top events.
- EVT_SCROLLWIN_BOTTOM: Process ``wxEVT_SCROLLWIN_BOTTOM`` scroll-to-bottom events.
- EVT_SCROLLWIN_LINEUP: Process ``wxEVT_SCROLLWIN_LINEUP`` line up events.
- EVT_SCROLLWIN_LINEDOWN: Process ``wxEVT_SCROLLWIN_LINEDOWN`` line down events.
- EVT_SCROLLWIN_PAGEUP: Process ``wxEVT_SCROLLWIN_PAGEUP`` page up events.
- EVT_SCROLLWIN_PAGEDOWN: Process ``wxEVT_SCROLLWIN_PAGEDOWN`` page down events.
- EVT_SCROLLWIN_THUMBTRACK: Process ``wxEVT_SCROLLWIN_THUMBTRACK`` thumbtrack events (frequent events sent as the user drags the thumbtrack).
- EVT_SCROLLWIN_THUMBRELEASE: Process ``wxEVT_SCROLLWIN_THUMBRELEASE`` thumb release events.
.. seealso:: :ref:`wx.ScrollEvent`, :ref:`Events and Event Handling <events and event handling>`
|
|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>ScrollWinEvent</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.ScrollWinEvent_inheritance.png" alt="Inheritance diagram of ScrollWinEvent" 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.ScrollWinEvent.html" title="wx.ScrollWinEvent" alt="" coords="5,160,139,189"/> <area shape="rect" id="node2" href="wx.Event.html" title="wx.Event" alt="" coords="33,83,111,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="31,5,112,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ScrollWinEvent.__init__` Constructor.
:meth:`~wx.ScrollWinEvent.GetOrientation` Returns ``wx.HORIZONTAL`` or ``wx.VERTICAL``, depending on the orientation of the scrollbar.
:meth:`~wx.ScrollWinEvent.GetPosition` Returns the position of the scrollbar for the thumb track and release events.
:meth:`~wx.ScrollWinEvent.SetOrientation`
:meth:`~wx.ScrollWinEvent.SetPosition`
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ScrollWinEvent.Orientation` See :meth:`~wx.ScrollWinEvent.GetOrientation` and :meth:`~wx.ScrollWinEvent.SetOrientation`
:attr:`~wx.ScrollWinEvent.Position` See :meth:`~wx.ScrollWinEvent.GetPosition` and :meth:`~wx.ScrollWinEvent.SetPosition`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ScrollWinEvent(Event)
**Possible constructors**::
ScrollWinEvent(commandType=wxEVT_NULL, pos=0, orientation=0)
A scroll event holds information about events sent from scrolling
windows.
.. method:: __init__(self, commandType=wxEVT_NULL, pos=0, orientation=0)
Constructor.
:param `commandType`:
:type `commandType`: wx.EventType
:param `pos`:
:type `pos`: int
:param `orientation`:
:type `orientation`: int
.. method:: GetOrientation(self)
Returns ``wx.HORIZONTAL`` or ``wx.VERTICAL``, depending on the orientation of the scrollbar.
:rtype: `int`
.. todo:: ``wx.HORIZONTAL`` and ``wx.VERTICAL`` should go in their own enum
.. method:: GetPosition(self)
Returns the position of the scrollbar for the thumb track and release events.
Note that this field can't be used for the other events, you need to query the window itself for the current position in that case.
:rtype: `int`
.. method:: SetOrientation(self, orient)
:param `orient`:
:type `orient`: int
.. method:: SetPosition(self, pos)
:param `pos`:
:type `pos`: int
.. attribute:: Orientation
See :meth:`~wx.ScrollWinEvent.GetOrientation` and :meth:`~wx.ScrollWinEvent.SetOrientation`
.. attribute:: Position
See :meth:`~wx.ScrollWinEvent.GetPosition` and :meth:`~wx.ScrollWinEvent.SetPosition`
|
