Navigation

Phoenix Logo

phoenix_title wx.VScrolledWindow

In the name of this class, “V” may stand for “variable” because it can be used for scrolling rows of variable heights; “virtual”, because it is not necessary to know the heights of all rows in advance

In any case, this is a generalization of wx.Scrolled which can be only used when all rows have the same heights. It lacks some other wx.Scrolled features however, notably it can’t scroll specific pixel sizes of the window or its exact client area size.

To use this class, you need to derive from it and implement the OnGetRowHeight pure virtual method. You also must call SetRowCount to let the base class know how many rows it should display, but from that moment on the scrolling is handled entirely by wx.VScrolledWindow. You only need to draw the visible part of contents in your OnPaint() method as usual. You should use GetVisibleRowsBegin and GetVisibleRowsEnd to select the lines to display. Note that the device context origin is not shifted so the first visible row always appears at the point (0, 0) in physical as well as logical coordinates.

phoenix_title wxWidgets 2.8 Compatibility Functions

The following functions provide backwards compatibility for applications originally built using wx.VScrolledWindow in 2.6 or 2.8. Originally, wx.VScrolledWindow referred to scrolling “lines”. We now use “units” in wx.VarScrollHelperBase to avoid implying any orientation (since the functions are used for both horizontal and vertical scrolling in derived classes). And in the new wx.VScrolledWindow and wx.HScrolledWindow classes, we refer to them as “rows” and “columns”, respectively. This is to help clear some confusion in not only those classes, but also in wx.HVScrolledWindow where functions are inherited from both. You are encouraged to update any existing code using these function to use the new replacements mentioned below, and avoid using these functions for any new code as they are deprecated.

GetFirstVisibleLine() Deprecated for GetVisibleRowsBegin
GetLastVisibleLine() Deprecated for GetVisibleRowsEnd This function originally had a slight design flaw in that it was possible to return sys.maxint-1 (ie: a large positive number) if the scroll position was 0 and the first line wasn’t completely visible.
GetLineCount() Deprecated for GetRowCount
HitTest(x, y)  
HitTest(pt) Deprecated for VirtualHitTest.
OnGetLineHeight(line) Deprecated for OnGetRowHeight
OnGetLinesHint(lineMin, lineMax) Deprecated for OnGetRowsHeightHint
RefreshLine(line) Deprecated for RefreshRow
RefreshLines(from_, to_) Deprecated for RefreshRows
ScrollLines(lines) Deprecated for ScrollRows
ScrollPages(pages) Deprecated for ScrollRowPages
ScrollToLine(line) Deprecated for ScrollToRow
SetLineCount(count) Deprecated for SetRowCount

See also

wx.HScrolledWindow, wx.HVScrolledWindow


class_hierarchy Class Hierarchy

Inheritance diagram for class VScrolledWindow:

sub_classes Known Subclasses

wx.VListBox


method_summary Methods Summary

__init__ Default constructor, you must call Create later.
Create Same as the non-default constructor, but returns a status code: True if ok, False if the window couldn’t be created.
GetFirstVisibleLine Deprecated compatibility helper.
GetLastVisibleLine Deprecated compatibility helper.
GetLineCount Deprecated compatibility helper.
HitTest Deprecated compatibility helper.
RefreshLine Deprecated compatibility helper.
RefreshLines Deprecated compatibility helper.
ScrollLines Deprecated compatibility helper.
ScrollPages Deprecated compatibility helper.
ScrollToLine Deprecated compatibility helper.
SetLineCount Deprecated compatibility helper.

api Class API


class wx.VScrolledWindow(Panel, VarVScrollHelper)

Possible constructors:

VScrolledWindow()

VScrolledWindow(parent, id=ID_ANY, pos=DefaultPosition,
                size=DefaultSize, style=0, name=PanelNameStr)

In the name of this class, “V” may stand for “variable” because it can be used for scrolling rows of variable heights; “virtual”, because it is not necessary to know the heights of all rows in advance only those which are shown on the screen need to be measured; or even “vertical”, because this class only supports scrolling vertically.


Methods


__init__(self, *args, **kw)

overload Overloaded Implementations:


__init__ (self)

Default constructor, you must call Create later.


__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr)

This is the normal constructor, no need to call Create after using this constructor.

Parameters:
  • parent (wx.Window) – The parent window, must not be None.
  • id (wx.WindowID) – The identifier of this window, wx.ID_ANY by default.
  • pos (wx.Point) – The initial window position.
  • size (wx.Size) – The initial window size.
  • style (long) – The window style. There are no special style bits defined for this class.
  • name (string) – The name for this window; usually not used.

Note

VSCROLL is always automatically added to the style, there is no need to specify it explicitly.



Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=PanelNameStr)

Same as the non-default constructor, but returns a status code: True if ok, False if the window couldn’t be created.

Just as with the constructor, the VSCROLL style is always used, there is no need to specify it explicitly.

Parameters:
Return type:

bool

GetFirstVisibleLine(self)

Deprecated compatibility helper.

Return type:int

Deprecated since version 4.0.1: 4.0.1

Deprecated since version 4.0.1: Use GetVisibleRowsBegin instead.


GetLastVisibleLine(self)

Deprecated compatibility helper.

Return type:int

Deprecated since version 4.0.1: 4.0.1

Deprecated since version 4.0.1: Use GetVisibleRowsEnd instead.


GetLineCount(self)

Deprecated compatibility helper.

Return type:int

Deprecated since version 4.0.1: 4.0.1

Deprecated since version 4.0.1: Use GetRowCount instead.


HitTest(self, *args)

Deprecated compatibility helper.

Deprecated since version 4.0.1: Use VirtualHitTest instead.


RefreshLine(self, line)

Deprecated compatibility helper.

Deprecated since version 4.0.1: 4.0.1

Deprecated since version 4.0.1: Use RefreshRow instead.


RefreshLines(self, from_, to_)

Deprecated compatibility helper.

Deprecated since version 4.0.1: 4.0.1

Deprecated since version 4.0.1: Use RefreshRows instead.


ScrollLines(self, lines)

Deprecated compatibility helper.

Return type:bool

Deprecated since version 4.0.1: 4.0.1

Deprecated since version 4.0.1: Use ScrollRows instead.


ScrollPages(self, pages)

Deprecated compatibility helper.

Return type:bool

Deprecated since version 4.0.1: 4.0.1

Deprecated since version 4.0.1: Use ScrollRowPages instead.


ScrollToLine(self, line)

Deprecated compatibility helper.

Return type:bool

Deprecated since version 4.0.1: 4.0.1

Deprecated since version 4.0.1: Use ScrollToRow instead.


SetLineCount(self, count)

Deprecated compatibility helper.

Deprecated since version 4.0.1: 4.0.1

Deprecated since version 4.0.1: Use SetRowCount instead.


Properties


FirstVisibleLine

See GetFirstVisibleLine


LastVisibleLine

See GetLastVisibleLine


LineCount

See GetLineCount and SetLineCount