.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.HVScrolledWindow:
==========================================================================================================================================
|phoenix_title| **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 :ref:`wx.Scrolled` which can be only used when all rows and columns are the same size. 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 must derive from it and implement both the :meth:`~wx.HVScrolledWindow.OnGetRowHeight` and :meth:`~wx.HVScrolledWindow.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 :ref:`wx.HVScrolledWindow`. You only need to draw the visible part of contents in your ``OnPaint()`` method as usual. You should use :meth:`~wx.VarHVScrollHelper.GetVisibleBegin` and :meth:`~wx.VarHVScrollHelper.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.
.. seealso:: :ref:`wx.HScrolledWindow`, :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>HVScrolledWindow</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.HVScrolledWindow_inheritance.png" alt="Inheritance diagram of HVScrolledWindow" 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.HVScrolledWindow.html" title="This window inherits all functionality of both vertical and horizontal, variable scrolled windows." alt="" coords="101,315,272,344"/> <area shape="rect" id="node2" href="wx.Panel.html" title="A panel is a window on which controls are placed." alt="" coords="71,237,153,267"/> <area shape="rect" id="node3" href="wx.VarHVScrollHelper.html" title="This class provides functions wrapping the wx.VarHScrollHelper and wx.VarVScrollHelper classes, targeted for scrolling a window in both axis." alt="" coords="179,237,347,267"/> <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="62,160,159,189"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="51,83,170,112"/> <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,93,35"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="118,5,229,35"/> <area shape="rect" id="node8" href="wx.VarVScrollHelper.html" title="This class provides functions wrapping the wx.VarScrollHelperBase class, targeted for vertical-specific scrolling." alt="" coords="184,160,341,189"/> <area shape="rect" id="node9" href="wx.VarHScrollHelper.html" title="This class provides functions wrapping the wx.VarScrollHelperBase class, targeted for horizontal-specific scrolling." alt="" coords="366,160,525,189"/> <area shape="rect" id="node10" 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="275,83,456,112"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.HVScrolledWindow.__init__` Default constructor, you must call :meth:`~HVScrolledWindow.Create` later.
:meth:`~wx.HVScrolledWindow.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.HVScrolledWindow.GetClassDefaultAttributes`
================================================================================ ================================================================================
|
|api| 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.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self)`
Default constructor, you must call :meth:`Create` later.
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=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
.. note::
``HSCROLL`` and ``VSCROLL`` are always automatically added to the style, there is no need to specify it explicitly.
:html:`<hr class="overloadsep" /><br />`
.. method:: 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.
: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=WINDOW_VARIANT_NORMAL)
:param `variant`:
:type `variant`: wx.WindowVariant
:rtype: :ref:`wx.VisualAttributes`