wx.VarHVScrollHelper¶

This class provides functions wrapping the wx.VarHScrollHelper and 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 wx.HVScrolledWindow derived class when using wx.VarScrollHelperBase functionality.

Like all three of its 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 wx.HVScrolledWindow rather than from here directly.

Class Hierarchy¶

Inheritance diagram for class VarHVScrollHelper:

Known Subclasses¶

wx.HVScrolledWindow

Methods Summary¶

`__init__`	Constructor taking the target window to be scrolled by this helper class.
`EnablePhysicalScrolling`	With physical scrolling on (when this is `True`), the device origin is changed properly when a wx.PaintDC is prepared, children are actually moved and laid out properly, and the contents of the window (pixels) are actually moved.
`GetFirstVisibleLine`	Deprecated compatibility helper.
`GetLastVisibleLine`	Deprecated compatibility helper.
`GetLineCount`	Deprecated compatibility helper.
`GetRowColumnCount`	Returns the number of columns and rows the target window contains.
`GetVisibleBegin`	Returns the index of the first visible column and row based on the current scroll position.
`GetVisibleEnd`	Returns the index of the last visible column and row based on the scroll position.
`HitTest`	Deprecated compatibility helper.
`IsVisible`	Returns `True` if both the given row and column are currently visible (even if only partially visible) or `False` otherwise.
`RefreshLine`	Deprecated compatibility helper.
`RefreshLines`	Deprecated compatibility helper.
`RefreshRowColumn`	Triggers a refresh for just the area shared between the given row and column of the window if it is visible.
`RefreshRowsColumns`	Triggers a refresh for the visible area shared between all given rows and columns (inclusive) of the window.
`ScrollLines`	Deprecated compatibility helper.
`ScrollPages`	Deprecated compatibility helper.
`ScrollToLine`	Deprecated compatibility helper.
`ScrollToRowColumn`	Scroll to the specified row and column.
`SetLineCount`	Deprecated compatibility helper.
`SetRowColumnCount`	Set the number of rows and columns the target window will contain.
`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.

Properties Summary¶

`FirstVisibleLine`	See `GetFirstVisibleLine`
`LastVisibleLine`	See `GetLastVisibleLine`
`LineCount`	See `GetLineCount` and `SetLineCount`
`RowColumnCount`	See `GetRowColumnCount` and `SetRowColumnCount`
`VisibleBegin`	See `GetVisibleBegin`
`VisibleEnd`	See `GetVisibleEnd`

Class API¶

class wx.VarHVScrollHelper(VarVScrollHelper, VarHScrollHelper)¶

Possible constructors:

VarHVScrollHelper(winToScroll) -> None

This class provides functions wrapping the VarHScrollHelper and VarVScrollHelper classes, targeted for scrolling a window in both axis.

Methods¶

__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.

Parameters:: winToScroll (wx.Window)
Return type:: None

EnablePhysicalScrolling(self, vscrolling=True, hscrolling=True)¶

With physical scrolling on (when this is True), the device origin is changed properly when a 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.

Parameters:

vscrolling (bool) – Specifies if physical scrolling should be turned on when scrolling vertically.
hscrolling (bool) – Specifies if physical scrolling should be turned on when scrolling horizontally.

Return type: