.. 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
.. currentmodule:: wx.lib.gizmos.treelistctrl
.. highlight:: python
.. _wx.lib.gizmos.treelistctrl.TreeListCtrl:
==========================================================================================================================================
|phoenix_title| **wx.lib.gizmos.treelistctrl.TreeListCtrl**
==========================================================================================================================================
See documentation for :class:`~wx.lib.agw.hypertreelist.HyperTreeList` and
:class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl`. This class is just a
simple derivation of the former in order to provide a mostly compatible
class to replace the C++ TreeListCtrl class in Classic, and most
CustomTreeCtrl methods are available here as well via monkey-patched
delegates.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
TreeListCtrl:
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.hypertreelist.HyperTreeList`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.gizmos.treelistctrl.TreeListCtrl.__init__` Default class constructor.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: TreeListCtrl(HTL.HyperTreeList)
See documentation for :class:`~wx.lib.agw.hypertreelist.HyperTreeList` and
:class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl`. This class is just a
simple derivation of the former in order to provide a mostly compatible
class to replace the C++ TreeListCtrl class in Classic, and most
CustomTreeCtrl methods are available here as well via monkey-patched
delegates.
.. method:: __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, agwStyle=wx.TR_DEFAULT_STYLE, validator=wx.DefaultValidator, name="treelistctrl")
Default class constructor.
:param `parent`: parent window. Must not be ``None``;
:param `id`: window identifier. A value of -1 indicates a default value;
:param `pos`: the control position. A value of (-1, -1) indicates a default position,
chosen by either the windowing system or wxPython, depending on platform;
:param `size`: the control size. A value of (-1, -1) indicates a default size,
chosen by either the windowing system or wxPython, depending on platform;
:param `style`: the underlying :class:`wx.Control` style;
:param `agwStyle`: the AGW-specific :class:`HyperTreeList` window style.
see :mod:`~wx.lib.agw.hypertreelist` for a full list of flags.
:param `validator`: window validator;
:param `name`: window name.