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.

See also

wx.HScrolledWindow, wx.HVScrolledWindow, wx.VScrolledWindow

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:

None

---

GetFirstVisibleLine(self)

Deprecated compatibility helper.

Return type:

int

Deprecated

Use GetVisibleRowsBegin instead.

---

GetLastVisibleLine(self)

Deprecated compatibility helper.

Return type:

int

Deprecated

Use GetVisibleRowsEnd instead.

---

GetLineCount(self)

Deprecated compatibility helper.

Return type:

int

Deprecated

Use GetRowCount instead.

---

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

---

HitTest(self, *args)

Deprecated compatibility helper.

---

IsVisible(self, *args, **kw)

Returns True if both the given row and column are currently visible (even if only partially visible) or False otherwise.

Overloaded Implementations:

---

IsVisible (self, row, column)

Parameters:

• row (int)

• column (int)

Return type:

bool

---

IsVisible (self, pos)

Parameters:

pos (wx.Position)

Return type:

bool

---

---

RefreshLine(self, line)

Deprecated compatibility helper.

Return type:

None

Deprecated

Use RefreshRow instead.

---

RefreshLines(self, from_, to_)

Deprecated compatibility helper.

Return type:

None

Deprecated

Use RefreshRows instead.

---

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.

Overloaded Implementations:

---

RefreshRowColumn (self, row, column)

Parameters:

• row (int)

• column (int)

Return type:

None

---

RefreshRowColumn (self, pos)

Parameters:

pos (wx.Position)

Return type:

None

---

---

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.

Overloaded Implementations:

---

RefreshRowsColumns (self, fromRow, toRow, fromColumn, toColumn)

Parameters:

• fromRow (int)

• toRow (int)

• fromColumn (int)

• toColumn (int)

Return type:

None

---

RefreshRowsColumns (self, _from, to)

Parameters:

• from (wx.Position)

• to (wx.Position)

Return type:

None

---

---

ScrollLines(self, lines)

Deprecated compatibility helper.

Return type:

bool

Deprecated

Use ScrollRows instead.

---

ScrollPages(self, pages)

Deprecated compatibility helper.

Return type:

bool

Deprecated

Use ScrollRowPages instead.

---

ScrollToLine(self, line)

Deprecated compatibility helper.

Return type:

bool

Deprecated

Use ScrollToRow instead.

---

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.

Overloaded Implementations:

---

ScrollToRowColumn (self, row, column)

Parameters:

• row (int)

• column (int)

Return type:

bool

---

ScrollToRowColumn (self, pos)

Parameters:

pos (wx.Position)

Return type:

bool

---

---

SetLineCount(self, count)

Deprecated compatibility helper.

Return type:

None

Deprecated

Use SetRowCount instead.

---

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)

Return type:

None

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.

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

FirstVisibleLine

See GetFirstVisibleLine

---

LastVisibleLine

See GetLastVisibleLine

---

LineCount

See GetLineCount and SetLineCount

---

RowColumnCount

See GetRowColumnCount and SetRowColumnCount

---

VisibleBegin

See GetVisibleBegin

---

VisibleEnd

See GetVisibleEnd