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
|
.. 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.VarVScrollHelper:
==========================================================================================================================================
|phoenix_title| **wx.VarVScrollHelper**
==========================================================================================================================================
This class provides functions wrapping the :ref:`wx.VarScrollHelperBase` class, targeted for vertical-specific scrolling.
Like :ref:`wx.VarScrollHelperBase`, this class is mostly only useful to those classes built into wxWidgets deriving from here, and this documentation is mostly only provided for referencing the functions provided by this class. You will likely want to derive your window from :ref:`wx.VScrolledWindow` rather than from here directly.
.. seealso:: :ref:`wx.HScrolledWindow`, :ref:`wx.HVScrolledWindow`, :ref:`wx.VScrolledWindow`
|
|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>VarVScrollHelper</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.VarVScrollHelper_inheritance.png" alt="Inheritance diagram of VarVScrollHelper" 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.VarVScrollHelper.html" title="wx.VarVScrollHelper" alt="" coords="16,83,164,112"/> <area shape="rect" id="node2" href="wx.VarScrollHelperBase.html" title="wx.VarScrollHelperBase" alt="" coords="5,5,176,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.VarHVScrollHelper`, :ref:`wx.VScrolledWindow`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.VarVScrollHelper.__init__` Constructor taking the target window to be scrolled by this helper class.
:meth:`~wx.VarVScrollHelper.EstimateTotalHeight` This class forwards calls from :meth:`~VarVScrollHelper.EstimateTotalSize` to this function so derived classes can override either just the height or the width estimation, or just estimate both differently if desired in any :ref:`wx.HVScrolledWindow` derived class.
:meth:`~wx.VarVScrollHelper.GetRowCount` Returns the number of rows the target window contains.
:meth:`~wx.VarVScrollHelper.GetVisibleRowsBegin` Returns the index of the first visible row based on the scroll position.
:meth:`~wx.VarVScrollHelper.GetVisibleRowsEnd` Returns the index of the last visible row based on the scroll position.
:meth:`~wx.VarVScrollHelper.IsRowVisible` Returns ``True`` if the given row is currently visible (even if only partially visible) or ``False`` otherwise.
:meth:`~wx.VarVScrollHelper.OnGetRowHeight` This function must be overridden in the derived class, and should return the height of the given row in pixels.
:meth:`~wx.VarVScrollHelper.OnGetRowsHeightHint` This function doesn't have to be overridden but it may be useful to do so if calculating the rows' sizes is a relatively expensive operation as it gives your code a chance to calculate several of them at once and cache the result if necessary.
:meth:`~wx.VarVScrollHelper.RefreshRow` Triggers a refresh for just the given row's area of the window if it's visible.
:meth:`~wx.VarVScrollHelper.RefreshRows` Triggers a refresh for the area between the specified range of rows given (inclusively).
:meth:`~wx.VarVScrollHelper.ScrollRowPages` Scroll by the specified number of pages which may be positive (to scroll down) or negative (to scroll up).
:meth:`~wx.VarVScrollHelper.ScrollRows` Scroll by the specified number of rows which may be positive (to scroll down) or negative (to scroll up).
:meth:`~wx.VarVScrollHelper.ScrollToRow` Scroll to the specified row.
:meth:`~wx.VarVScrollHelper.SetRowCount` Set the number of rows the window contains.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.VarVScrollHelper.RowCount` See :meth:`~wx.VarVScrollHelper.GetRowCount` and :meth:`~wx.VarVScrollHelper.SetRowCount`
:attr:`~wx.VarVScrollHelper.VisibleRowsBegin` See :meth:`~wx.VarVScrollHelper.GetVisibleRowsBegin`
:attr:`~wx.VarVScrollHelper.VisibleRowsEnd` See :meth:`~wx.VarVScrollHelper.GetVisibleRowsEnd`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.VarVScrollHelper(VarScrollHelperBase)
**Possible constructors**::
VarVScrollHelper(winToScroll)
This class provides functions wrapping the VarScrollHelperBase
class, targeted for vertical-specific scrolling.
.. method:: __init__(self, winToScroll)
Constructor taking the target window to be scrolled by this helper class.
This will attach scroll event handlers to the target window to catch and handle scroll events appropriately.
:param `winToScroll`:
:type `winToScroll`: wx.Window
.. method:: EstimateTotalHeight(self)
This class forwards calls from :meth:`EstimateTotalSize` to this function so derived classes can override either just the height or the width estimation, or just estimate both differently if desired in any :ref:`wx.HVScrolledWindow` derived class.
:rtype: :ref:`wx.Coord`
.. note::
This function will not be called if :meth:`EstimateTotalSize` is overridden in your derived class.
.. method:: GetRowCount(self)
Returns the number of rows the target window contains.
:rtype: `int`
.. seealso:: :meth:`SetRowCount`
.. method:: GetVisibleRowsBegin(self)
Returns the index of the first visible row based on the scroll position.
:rtype: `int`
.. method:: GetVisibleRowsEnd(self)
Returns the index of the last visible row based on the scroll position.
This includes the last row even if it is only partially visible.
:rtype: `int`
.. method:: IsRowVisible(self, row)
Returns ``True`` if the given row is currently visible (even if only partially visible) or ``False`` otherwise.
:param `row`:
:type `row`: int
:rtype: `bool`
.. method:: OnGetRowHeight(self, row)
This function must be overridden in the derived class, and should return the height of the given row in pixels.
:param `row`:
:type `row`: int
:rtype: :ref:`wx.Coord`
.. method:: OnGetRowsHeightHint(self, rowMin, rowMax)
This function doesn't have to be overridden but it may be useful to do so if calculating the rows' sizes is a relatively expensive operation as it gives your code a chance to calculate several of them at once and cache the result if necessary.
:meth:`OnGetRowsHeightHint` is normally called just before :meth:`OnGetRowHeight` but you shouldn't rely on the latter being called for all rows in the interval specified here. It is also possible that :meth:`OnGetRowHeight` will be called for units outside of this interval, so this is really just a hint, not a promise.
Finally, note that `rowMin` is inclusive, while `rowMax` is exclusive.
:param `rowMin`:
:type `rowMin`: int
:param `rowMax`:
:type `rowMax`: int
.. method:: RefreshRow(self, row)
Triggers a refresh for just the given row's area of the window if it's visible.
:param `row`:
:type `row`: int
.. method:: RefreshRows(self, from_, to_)
Triggers a refresh for the area between the specified range of rows given (inclusively).
:param `from_`:
:type `from_`: int
:param `to_`:
:type `to_`: int
.. method:: ScrollRowPages(self, pages)
Scroll by the specified number of pages which may be positive (to scroll down) or negative (to scroll up).
:param `pages`:
:type `pages`: int
:rtype: `bool`
.. method:: ScrollRows(self, rows)
Scroll by the specified number of rows which may be positive (to scroll down) or negative (to scroll up).
:param `rows`:
:type `rows`: int
:rtype: `bool`
:returns:
``True`` if the window was scrolled, ``False`` otherwise (for example, if we're trying to scroll down but we are already showing the last row).
.. method:: ScrollToRow(self, row)
Scroll to the specified row.
It will become the first visible row in the window.
:param `row`:
:type `row`: int
:rtype: `bool`
:returns:
``True`` if we scrolled the window, ``False`` if nothing was done.
.. method:: SetRowCount(self, rowCount)
Set the number of rows the window contains.
The derived class must provide the heights for all rows with indices up to the one given here in it's :meth:`OnGetRowHeight` implementation.
:param `rowCount`:
:type `rowCount`: int
.. seealso:: :meth:`GetRowCount`
.. attribute:: RowCount
See :meth:`~wx.VarVScrollHelper.GetRowCount` and :meth:`~wx.VarVScrollHelper.SetRowCount`
.. attribute:: VisibleRowsBegin
See :meth:`~wx.VarVScrollHelper.GetVisibleRowsBegin`
.. attribute:: VisibleRowsEnd
See :meth:`~wx.VarVScrollHelper.GetVisibleRowsEnd`
|
