.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.HScrolledWindow:
==========================================================================================================================================
|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 – only those which are shown on the screen need to be measured.
In any case, this is a generalization of :ref:`wx.Scrolled` which can be only used when all columns have the same widths. It lacks some other :ref:`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 :meth:`~wx.VarHScrollHelper.OnGetColumnWidth` pure virtual method. You also must call :meth:`~wx.VarHScrollHelper.SetColumnCount` to let the base class know how many columns it should display, but from that moment on the scrolling is handled entirely by :ref:`wx.HScrolledWindow`. You only need to draw the visible part of contents in your ``OnPaint()`` method as usual. You should use :meth:`~wx.VarHScrollHelper.GetVisibleColumnsBegin` and :meth:`~wx.VarHScrollHelper.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.
.. seealso:: :ref:`wx.HVScrolledWindow`, :ref:`wx.VScrolledWindow`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>HScrolledWindow</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.HScrolledWindow_inheritance.svg" alt="Inheritance diagram of HScrolledWindow" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.HScrolledWindow.html" title="In the name of this class, 'H' stands for 'horizontal' because it can be used for scrolling columns of variable widths." alt="" coords="120,313,302,341"/> <area shape="rect" id="node2" href="wx.Panel.html" title="A panel is a window on which controls are placed." alt="" coords="83,236,178,265"/> <area shape="rect" id="node3" href="wx.VarHScrollHelper.html" title="This class provides functions wrapping the wx.VarScrollHelperBase class, targeted for horizontal-specific scrolling." alt="" coords="208,236,384,265"/> <area shape="rect" id="node4" href="wx.Window.html" title="wx.Window is the base class for all windows and represents any visible object on screen." alt="" coords="66,159,177,188"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="55,82,188,111"/> <area shape="rect" id="node6" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="5,5,104,34"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="128,5,251,34"/> <area shape="rect" id="node8" href="wx.VarScrollHelperBase.html" title="This class provides all common base functionality for scroll calculations shared among all variable scrolled window implementations as well as automatic scrollbar functionality, saved scroll positions, controlling target windows to be scrolled, as well as defining all required virtual functions that need to be implemented for any orientation specific work." alt="" coords="200,159,402,188"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.HScrolledWindow.__init__` Default constructor, you must call :meth:`~HScrolledWindow.Create` later.
:meth:`~wx.HScrolledWindow.Create` Same as the non-default constructor, but returns a status code: ``True`` if ok, ``False`` if the window couldn't be created.
:meth:`~wx.HScrolledWindow.GetClassDefaultAttributes`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.HScrolledWindow(Panel, VarHScrollHelper)
**Possible constructors**::
HScrolledWindow() -> None
HScrolledWindow(parent : Window, id: int=ID_ANY, pos:
Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name:
str=PanelNameStr) -> None
In the name of this class, "H" stands for "horizontal" because it can
be used for scrolling columns of variable widths.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self)`
Default constructor, you must call :meth:`Create` later.
:rtype: `None`
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name: str=PanelNameStr)`
This is the normal constructor, no need to call :meth:`Create` after using this constructor.
:param `parent`: The parent window, must not be ``None``.
:type `parent`: wx.Window
:param `id`: The identifier of this window, ``wx.ID_ANY`` by default.
:type `id`: wx.WindowID
:param `pos`: The initial window position.
:type `pos`: wx.Point
:param `size`: The initial window size.
:type `size`: wx.Size
:param `style`: The window style. There are no special style bits defined for this class.
:type `style`: long
:param `name`: The name for this window; usually not used.
:type `name`: string
:rtype: `None`
.. note::
``HSCROLL`` is always automatically added to the style, there is no need to specify it explicitly.
:html:`<hr class="overloadsep" /><br />`
.. method:: Create(self, parent : Window, id: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name: str=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.
:param `parent`:
:type `parent`: wx.Window
:param `id`:
:type `id`: wx.WindowID
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
:rtype: `bool`
.. staticmethod:: GetClassDefaultAttributes(variant: WindowVariant=WINDOW_VARIANT_NORMAL)
:param `variant`:
:type `variant`: wx.WindowVariant
:rtype: :ref:`wx.VisualAttributes`