Navigation

Phoenix Logo

phoenix_title 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 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 wx.HVScrolledWindow rather than from here directly.

See also

wx.HScrolledWindow, wx.HVScrolledWindow, wx.VScrolledWindow


class_hierarchy Class Hierarchy

Inheritance diagram for class VarHVScrollHelper:


sub_classes Known Subclasses

wx.HVScrolledWindow


method_summary 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.
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.
IsVisible Returns True if both the given row and column are currently visible (even if only partially visible) or False otherwise.
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.
ScrollToRowColumn Scroll to the specified row and column.
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.

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.


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) –

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.

GetRowColumnCount(self)

Returns the number of columns and rows the target window contains.

Return type: wx.Size

See also

SetRowColumnCount


GetVisibleBegin(self)

Returns the index of the first visible column and row based on the current scroll position.

Return type: wx.Position

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.

Return type: wx.Position

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)

Parameters:
  • row (int) –
  • column (int) –
Return type:

bool


IsVisible (self, pos)

Parameters:pos (wx.Position) –
Return type:bool



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)

Parameters:
  • row (int) –
  • column (int) –


RefreshRowColumn (self, pos)

Parameters:pos (wx.Position) –



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)

Parameters:
  • fromRow (int) –
  • toRow (int) –
  • fromColumn (int) –
  • toColumn (int) –


RefreshRowsColumns (self, from, to)

Parameters:



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)

Parameters:
  • row (int) –
  • column (int) –
Return type:

bool


ScrollToRowColumn (self, pos)

Parameters:pos (wx.Position) –
Return type:bool



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 OnGetRowHeight and OnGetColumnWidth implementations, respectively.

Parameters:
  • rowCount (int) –
  • columnCount (int) –

See also

GetRowColumnCount


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)

Parameters:
  • x (int) –
  • y (int) –
Return type:

wx.Position


VirtualHitTest (self, pos)

Parameters:pos (wx.Point) –
Return type: wx.Position



Properties


RowColumnCount

See GetRowColumnCount and SetRowColumnCount


VisibleBegin

See GetVisibleBegin


VisibleEnd

See GetVisibleEnd