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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
|
.. 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.VScrolledWindow:
==========================================================================================================================================
|phoenix_title| **wx.VScrolledWindow**
==========================================================================================================================================
In the name of this class, "V" may stand for "variable" because it can be used for scrolling rows of variable heights; "virtual", because it is not necessary to know the heights of all rows in advance
In any case, this is a generalization of :ref:`wx.Scrolled` which can be only used when all rows have the same heights. It lacks some other :ref:`wx.Scrolled` features however, notably it can't scroll specific pixel sizes of the window or its exact client area size.
To use this class, you need to derive from it and implement the :meth:`~wx.VScrolledWindow.OnGetRowHeight` pure virtual method. You also must call :meth:`~wx.VScrolledWindow.SetRowCount` to let the base class know how many rows it should display, but from that moment on the scrolling is handled entirely by :ref:`wx.VScrolledWindow`. You only need to draw the visible part of contents in your ``OnPaint()`` method as usual. You should use :meth:`~wx.VScrolledWindow.GetVisibleRowsBegin` and :meth:`~wx.VScrolledWindow.GetVisibleRowsEnd` to select the lines to display. Note that the device context origin is not shifted so the first visible row always appears at the point (0, 0) in physical as well as logical coordinates.
|phoenix_title| wxWidgets 2.8 Compatibility Functions
=====================================================
The following functions provide backwards compatibility for applications originally built using :ref:`wx.VScrolledWindow` in 2.6 or 2.8. Originally, :ref:`wx.VScrolledWindow` referred to scrolling "lines". We now use "units" in :ref:`wx.VarScrollHelperBase` to avoid implying any orientation (since the functions are used for both horizontal and vertical scrolling in derived classes). And in the new :ref:`wx.VScrolledWindow` and :ref:`wx.HScrolledWindow` classes, we refer to them as "rows" and "columns", respectively. This is to help clear some confusion in not only those classes, but also in :ref:`wx.HVScrolledWindow` where functions are inherited from both. You are encouraged to update any existing code using these function to use the new replacements mentioned below, and avoid using these functions for any new code as they are deprecated.
.. include:: rest_substitutions/tables/wx.VScrolledWindow.1.rst
.. seealso:: :ref:`wx.HScrolledWindow`, :ref:`wx.HVScrolledWindow`
|
|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>VScrolledWindow</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.VScrolledWindow_inheritance.png" alt="Inheritance diagram of VScrolledWindow" 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.VScrolledWindow.html" title="wx.VScrolledWindow" alt="" coords="105,315,253,344"/> <area shape="rect" id="node2" href="wx.Panel.html" title="wx.Panel" alt="" coords="70,237,145,267"/> <area shape="rect" id="node3" href="wx.VarVScrollHelper.html" title="wx.VarVScrollHelper" alt="" coords="179,237,327,267"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="48,83,159,112"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="59,160,148,189"/> <area shape="rect" id="node7" href="wx.VarScrollHelperBase.html" title="wx.VarScrollHelperBase" alt="" coords="173,160,344,189"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="112,5,213,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.VListBox`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.VScrolledWindow.__init__` Default constructor, you must call :meth:`~VScrolledWindow.Create` later.
:meth:`~wx.VScrolledWindow.Create` Same as the non-default constructor, but returns a status code: ``True`` if ok, ``False`` if the window couldn't be created.
:meth:`~wx.VScrolledWindow.GetFirstVisibleLine` Deprecated compatibility helper.
:meth:`~wx.VScrolledWindow.GetLastVisibleLine` Deprecated compatibility helper.
:meth:`~wx.VScrolledWindow.GetLineCount` Deprecated compatibility helper.
:meth:`~wx.VScrolledWindow.HitTest` Deprecated compatibility helper.
:meth:`~wx.VScrolledWindow.RefreshLine` Deprecated compatibility helper.
:meth:`~wx.VScrolledWindow.RefreshLines` Deprecated compatibility helper.
:meth:`~wx.VScrolledWindow.ScrollLines` Deprecated compatibility helper.
:meth:`~wx.VScrolledWindow.ScrollPages` Deprecated compatibility helper.
:meth:`~wx.VScrolledWindow.ScrollToLine` Deprecated compatibility helper.
:meth:`~wx.VScrolledWindow.SetLineCount` Deprecated compatibility helper.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.VScrolledWindow.FirstVisibleLine` See :meth:`~wx.VScrolledWindow.GetFirstVisibleLine`
:attr:`~wx.VScrolledWindow.LastVisibleLine` See :meth:`~wx.VScrolledWindow.GetLastVisibleLine`
:attr:`~wx.VScrolledWindow.LineCount` See :meth:`~wx.VScrolledWindow.GetLineCount` and :meth:`~wx.VScrolledWindow.SetLineCount`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.VScrolledWindow(Panel, VarVScrollHelper)
**Possible constructors**::
VScrolledWindow()
VScrolledWindow(parent, id=ID_ANY, pos=DefaultPosition,
size=DefaultSize, style=0, name=PanelNameStr)
In the name of this class, "V" may stand for "variable" because it can
be used for scrolling rows of variable heights; "virtual", because it
is not necessary to know the heights of all rows in advance only
those which are shown on the screen need to be measured; or even
"vertical", because this class only supports scrolling vertically.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor, you must call :meth:`Create` later.
**~~~**
**__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr)`
This is the normal constructor, no need to call :meth:`Create` after using this constructor.
:param `parent`: The parent window, must not be ``None``.
:type `parent`: wx.Window
:param `id`: The identifier of this window, ``wx.ID_ANY`` by default.
:type `id`: wx.WindowID
:param `pos`: The initial window position.
:type `pos`: wx.Point
:param `size`: The initial window size.
:type `size`: wx.Size
:param `style`: The window style. There are no special style bits defined for this class.
:type `style`: long
:param `name`: The name for this window; usually not used.
:type `name`: string
.. note::
``VSCROLL`` is always automatically added to the style, there is no need to specify it explicitly.
**~~~**
.. method:: Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr)
Same as the non-default constructor, but returns a status code: ``True`` if ok, ``False`` if the window couldn't be created.
Just as with the constructor, the ``VSCROLL`` style is always used, there is no need to specify it explicitly.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
:rtype: `bool`
.. method:: GetFirstVisibleLine(self)
Deprecated compatibility helper.
:rtype: `int`
.. wxdeprecated::
Use GetVisibleRowsBegin instead.
.. method:: GetLastVisibleLine(self)
Deprecated compatibility helper.
:rtype: `int`
.. wxdeprecated::
Use GetVisibleRowsEnd instead.
.. method:: GetLineCount(self)
Deprecated compatibility helper.
:rtype: `int`
.. wxdeprecated::
Use GetRowCount instead.
.. method:: HitTest(self, *args)
Deprecated compatibility helper.
.. method:: RefreshLine(self, line)
Deprecated compatibility helper.
.. wxdeprecated::
Use RefreshRow instead.
.. method:: RefreshLines(self, from_, to_)
Deprecated compatibility helper.
.. wxdeprecated::
Use RefreshRows instead.
.. method:: ScrollLines(self, lines)
Deprecated compatibility helper.
:rtype: `bool`
.. wxdeprecated::
Use ScrollRows instead.
.. method:: ScrollPages(self, pages)
Deprecated compatibility helper.
:rtype: `bool`
.. wxdeprecated::
Use ScrollRowPages instead.
.. method:: ScrollToLine(self, line)
Deprecated compatibility helper.
:rtype: `bool`
.. wxdeprecated::
Use ScrollToRow instead.
.. method:: SetLineCount(self, count)
Deprecated compatibility helper.
.. wxdeprecated::
Use SetRowCount instead.
.. attribute:: FirstVisibleLine
See :meth:`~wx.VScrolledWindow.GetFirstVisibleLine`
.. attribute:: LastVisibleLine
See :meth:`~wx.VScrolledWindow.GetLastVisibleLine`
.. attribute:: LineCount
See :meth:`~wx.VScrolledWindow.GetLineCount` and :meth:`~wx.VScrolledWindow.SetLineCount`
|
