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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
|
.. 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.VarHVScrollHelper:
==========================================================================================================================================
|phoenix_title| **wx.VarHVScrollHelper**
==========================================================================================================================================
This class provides functions wrapping the :ref:`wx.VarHScrollHelper` and :ref:`wx.VarVScrollHelper` classes, targeted for scrolling a window in both axis.
Since this class is also the join class of the horizontal and vertical scrolling functionality, it also addresses some wrappers that help avoid the need to specify class scope in your :ref:`wx.HVScrolledWindow` derived class when using :ref:`wx.VarScrollHelperBase` functionality.
Like all three of it's scroll helper base classes, 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.HVScrolledWindow` 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>VarHVScrollHelper</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.VarHVScrollHelper_inheritance.png" alt="Inheritance diagram of VarHVScrollHelper" 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.VarHVScrollHelper.html" title="wx.VarHVScrollHelper" alt="" coords="87,160,245,189"/> <area shape="rect" id="node2" href="wx.VarVScrollHelper.html" title="wx.VarVScrollHelper" alt="" coords="5,83,153,112"/> <area shape="rect" id="node3" href="wx.VarHScrollHelper.html" title="wx.VarHScrollHelper" alt="" coords="179,83,329,112"/> <area shape="rect" id="node4" href="wx.VarScrollHelperBase.html" title="wx.VarScrollHelperBase" alt="" coords="81,5,252,35"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.HVScrolledWindow`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.VarHVScrollHelper.__init__` Constructor taking the target window to be scrolled by this helper class.
:meth:`~wx.VarHVScrollHelper.EnablePhysicalScrolling` With physical scrolling on (when this is ``True``), the device origin is changed properly when a :ref:`wx.PaintDC` is prepared, children are actually moved and laid out properly, and the contents of the window (pixels) are actually moved.
:meth:`~wx.VarHVScrollHelper.GetRowColumnCount` Returns the number of columns and rows the target window contains.
:meth:`~wx.VarHVScrollHelper.GetVisibleBegin` Returns the index of the first visible column and row based on the current scroll position.
:meth:`~wx.VarHVScrollHelper.GetVisibleEnd` Returns the index of the last visible column and row based on the scroll position.
:meth:`~wx.VarHVScrollHelper.IsVisible` Returns ``True`` if both the given row and column are currently visible (even if only partially visible) or ``False`` otherwise.
:meth:`~wx.VarHVScrollHelper.RefreshRowColumn` Triggers a refresh for just the area shared between the given row and column of the window if it is visible.
:meth:`~wx.VarHVScrollHelper.RefreshRowsColumns` Triggers a refresh for the visible area shared between all given rows and columns (inclusive) of the window.
:meth:`~wx.VarHVScrollHelper.ScrollToRowColumn` Scroll to the specified row and column.
:meth:`~wx.VarHVScrollHelper.SetRowColumnCount` Set the number of rows and columns the target window will contain.
:meth:`~wx.VarHVScrollHelper.VirtualHitTest` Returns the virtual scroll unit under the device unit given accounting for scroll position or ``NOT_FOUND`` (for the row, column, or possibly both values) if none.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.VarHVScrollHelper.RowColumnCount` See :meth:`~wx.VarHVScrollHelper.GetRowColumnCount` and :meth:`~wx.VarHVScrollHelper.SetRowColumnCount`
:attr:`~wx.VarHVScrollHelper.VisibleBegin` See :meth:`~wx.VarHVScrollHelper.GetVisibleBegin`
:attr:`~wx.VarHVScrollHelper.VisibleEnd` See :meth:`~wx.VarHVScrollHelper.GetVisibleEnd`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.VarHVScrollHelper(VarVScrollHelper, VarHScrollHelper)
**Possible constructors**::
VarHVScrollHelper(winToScroll)
This class provides functions wrapping the VarHScrollHelper and
VarVScrollHelper classes, targeted for scrolling a window in both
axis.
.. 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:: EnablePhysicalScrolling(self, vscrolling=True, hscrolling=True)
With physical scrolling on (when this is ``True``), the device origin is changed properly when a :ref:`wx.PaintDC` is prepared, children are actually moved and laid out properly, and the contents of the window (pixels) are actually moved.
When this is ``False``, you are responsible for repainting any invalidated areas of the window yourself to account for the new scroll position.
:param `vscrolling`: Specifies if physical scrolling should be turned on when scrolling vertically.
:type `vscrolling`: bool
:param `hscrolling`: Specifies if physical scrolling should be turned on when scrolling horizontally.
:type `hscrolling`: bool
.. method:: GetRowColumnCount(self)
Returns the number of columns and rows the target window contains.
:rtype: :ref:`wx.Size`
.. seealso:: :meth:`SetRowColumnCount`
.. method:: GetVisibleBegin(self)
Returns the index of the first visible column and row based on the current scroll position.
:rtype: :ref:`wx.Position`
.. method:: GetVisibleEnd(self)
Returns the index of the last visible column and row based on the scroll position.
This includes any partially visible columns or rows.
:rtype: :ref:`wx.Position`
.. method:: IsVisible(self, *args, **kw)
Returns ``True`` if both the given row and column are currently visible (even if only partially visible) or ``False`` otherwise.
|overload| Overloaded Implementations:
**~~~**
**IsVisible** `(self, row, column)`
:param `row`:
:type `row`: int
:param `column`:
:type `column`: int
:rtype: `bool`
**~~~**
**IsVisible** `(self, pos)`
:param `pos`:
:type `pos`: wx.Position
:rtype: `bool`
**~~~**
.. method:: RefreshRowColumn(self, *args, **kw)
Triggers a refresh for just the area shared between the given row and column of the window if it is visible.
|overload| Overloaded Implementations:
**~~~**
**RefreshRowColumn** `(self, row, column)`
:param `row`:
:type `row`: int
:param `column`:
:type `column`: int
**~~~**
**RefreshRowColumn** `(self, pos)`
:param `pos`:
:type `pos`: wx.Position
**~~~**
.. method:: RefreshRowsColumns(self, *args, **kw)
Triggers a refresh for the visible area shared between all given rows and columns (inclusive) of the window.
If the target window for both orientations is the same, the rectangle of cells is refreshed; if the target windows differ, the entire client size opposite the orientation direction is refreshed between the specified limits.
|overload| Overloaded Implementations:
**~~~**
**RefreshRowsColumns** `(self, fromRow, toRow, fromColumn, toColumn)`
:param `fromRow`:
:type `fromRow`: int
:param `toRow`:
:type `toRow`: int
:param `fromColumn`:
:type `fromColumn`: int
:param `toColumn`:
:type `toColumn`: int
**~~~**
**RefreshRowsColumns** `(self, from, to)`
:param `from`:
:type `from`: wx.Position
:param `to`:
:type `to`: wx.Position
**~~~**
.. method:: ScrollToRowColumn(self, *args, **kw)
Scroll to the specified row and column.
It will become the first visible row and column in the window. Returns ``True`` if we scrolled the window, ``False`` if nothing was done.
|overload| Overloaded Implementations:
**~~~**
**ScrollToRowColumn** `(self, row, column)`
:param `row`:
:type `row`: int
:param `column`:
:type `column`: int
:rtype: `bool`
**~~~**
**ScrollToRowColumn** `(self, pos)`
:param `pos`:
:type `pos`: wx.Position
:rtype: `bool`
**~~~**
.. method:: SetRowColumnCount(self, rowCount, columnCount)
Set the number of rows and columns the target window will contain.
The derived class must provide the sizes for all rows and columns with indices up to the ones given here in it's :meth:`OnGetRowHeight` and :meth:`OnGetColumnWidth` implementations, respectively.
:param `rowCount`:
:type `rowCount`: int
:param `columnCount`:
:type `columnCount`: int
.. seealso:: :meth:`GetRowColumnCount`
.. method:: VirtualHitTest(self, *args, **kw)
Returns the virtual scroll unit under the device unit given accounting for scroll position or ``NOT_FOUND`` (for the row, column, or possibly both values) if none.
|overload| Overloaded Implementations:
**~~~**
**VirtualHitTest** `(self, x, y)`
:param `x`:
:type `x`: int
:param `y`:
:type `y`: int
:rtype: :ref:`wx.Position`
**~~~**
**VirtualHitTest** `(self, pos)`
:param `pos`:
:type `pos`: wx.Point
:rtype: :ref:`wx.Position`
**~~~**
.. attribute:: RowColumnCount
See :meth:`~wx.VarHVScrollHelper.GetRowColumnCount` and :meth:`~wx.VarHVScrollHelper.SetRowColumnCount`
.. attribute:: VisibleBegin
See :meth:`~wx.VarHVScrollHelper.GetVisibleBegin`
.. attribute:: VisibleEnd
See :meth:`~wx.VarHVScrollHelper.GetVisibleEnd`
|
