wx.HVScrolledWindow¶

This window inherits all functionality of both vertical and horizontal, variable scrolled windows.

It automatically handles everything needed to scroll both axis simultaneously with both variable row heights and variable column widths.

In any case, this is a generalization of wx.Scrolled which can be only used when all rows and columns are the same size. 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 must derive from it and implement both the OnGetRowHeight and OnGetColumnWidth pure virtual methods to let the base class know how many rows and columns it should display. You also need to set the total rows and columns the window contains, but from that moment on the scrolling is handled entirely by wx.HVScrolledWindow. You only need to draw the visible part of contents in your OnPaint() method as usual. You should use GetVisibleBegin and GetVisibleEnd to select the lines to display. Note that the device context origin is not shifted so the first visible row and column always appear at the point (0, 0) in physical as well as logical coordinates.

Class Hierarchy¶

Inheritance diagram for class HVScrolledWindow:

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.
`GetClassDefaultAttributes`

Class API¶

class wx.HVScrolledWindow(Panel, VarHVScrollHelper)¶

Possible constructors:

HVScrolledWindow()

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

This window inherits all functionality of both vertical and horizontal, variable scrolled windows.

Methods¶

__init__(self, *args, **kw)¶

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

HSCROLL and VSCROLL are 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 HSCROLL and VSCROLL styles are always used, there is no need to specify them explicitly.

Parameters:

parent (wx.Window) –
id (wx.WindowID) –
pos (wx.Point) –
size (wx.Size) –
style (long) –
name (string) –

Return type:

bool

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶

Parameters:: variant (WindowVariant) –
Return type:: wx.VisualAttributes

Navigation