Navigation

Phoenix Logo

phoenix_title wx.HScrolledWindow

In the name of this class, “H” stands for “horizontal” because it can be used for scrolling columns of variable widths.

It is not necessary to know the widths of all columns in advance

In any case, this is a generalization of wx.Scrolled which can be only used when all columns have the same widths. 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 OnGetColumnWidth pure virtual method. You also must call SetColumnCount to let the base class know how many columns it should display, but from that moment on the scrolling is handled entirely by wx.HScrolledWindow. You only need to draw the visible part of contents in your OnPaint() method as usual. You should use GetVisibleColumnsBegin and GetVisibleColumnsEnd to select the lines to display. Note that the device context origin is not shifted so the first visible column always appears at the point (0, 0) in physical as well as logical coordinates.

See also

wx.HVScrolledWindow, wx.VScrolledWindow


class_hierarchy Class Hierarchy

Inheritance diagram for class HScrolledWindow:

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.

api Class API


class wx.HScrolledWindow(Panel, VarHScrollHelper)

Possible constructors:

HScrolledWindow()

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

In the name of this class, “H” stands for “horizontal” because it can be used for scrolling columns of variable widths.


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

HSCROLL 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 HSCROLL style is always used, there is no need to specify it explicitly.

Parameters:
Return type:

bool