.. module:: wx.dataview


.. include:: headings.inc

=========================================================================
**wx.dataview**
=========================================================================

The classes in this module provide views and data models for viewing tabular
or hierarchical data in a more advanced way than what is provided by classes
such as :ref:`wx.ListCtrl`, :ref:`wx.TreeCtrl`, etc.


Class Summary
=============

================================================================================ ================================================================================
**Class**                                                                        **Short Description**
================================================================================ ================================================================================
`~wx.dataview.DataViewBitmapRenderer`                                            This class is used by :ref:`wx.dataview.DataViewCtrl`  to render bitmaps.
`~wx.dataview.DataViewCheckIconText`                                             :ref:`wx.dataview.DataViewCheckIconText`  is used by :ref:`wx.dataview.DataViewCheckIconTextRenderer`  for data transfer.
`~wx.dataview.DataViewCheckIconTextRenderer`                                     This renderer class shows a checkbox in addition to the icon and text shown by the base class and also allows the user to toggle this checkbox.
`~wx.dataview.DataViewChoiceRenderer`                                            A :ref:`wx.dataview.DataViewCtrl`  renderer using :ref:`wx.Choice`  control and values of strings in it.
`~wx.dataview.DataViewColumn`                                                    This class represents a column in a :ref:`wx.dataview.DataViewCtrl`.
`~wx.dataview.DataViewCtrl`                                                      :ref:`wx.dataview.DataViewCtrl`  is a control to display data either in a tree like fashion or in a tabular form or both.
`~wx.dataview.DataViewCustomRenderer`                                            You need to derive a new class from :ref:`wx.dataview.DataViewCustomRenderer`  in order to write a new renderer.
`~wx.dataview.DataViewDateRenderer`                                              This class is used by :ref:`wx.dataview.DataViewCtrl`  to render calendar controls.
`~wx.dataview.DataViewEvent`                                                     This is the event class for the :ref:`wx.dataview.DataViewCtrl`  notifications.
`~wx.dataview.DataViewIconText`                                                  :ref:`wx.dataview.DataViewIconText`  is used by :ref:`wx.dataview.DataViewIconTextRenderer`  for data transfer.
`~wx.dataview.DataViewIconTextRenderer`                                          The :ref:`wx.dataview.DataViewIconTextRenderer`  class is used to display text with a small icon next to it as it is typically done in a file manager.
`~wx.dataview.DataViewIndexListModel`                                            :ref:`wx.dataview.DataViewIndexListModel`  is a specialized data model which lets you address an item by its position (row) rather than its :ref:`wx.dataview.DataViewItem`  (which you can obtain from this class).
`~wx.dataview.DataViewItem`                                                      :ref:`wx.dataview.DataViewItem`  is a small opaque class that represents an item in a :ref:`wx.dataview.DataViewCtrl`  in a persistent way, i.e.
`~wx.dataview.DataViewItemAttr`                                                  This class is used to indicate to a :ref:`wx.dataview.DataViewCtrl`  that a certain item (see :ref:`wx.dataview.DataViewItem`) has extra font attributes for its renderer.
`~wx.dataview.DataViewItemObjectMapper`                                          This class provides a mechanism for mapping between Python objects and the
`~wx.dataview.DataViewListCtrl`                                                  This class is a :ref:`wx.dataview.DataViewCtrl`  which internally uses a :ref:`wx.dataview.DataViewListStore`  and forwards most of its API to that class.
`~wx.dataview.DataViewListModel`                                                 Base class with abstract API for :ref:`wx.dataview.DataViewIndexListModel`  and :ref:`wx.dataview.DataViewVirtualListModel`.
`~wx.dataview.DataViewListStore`                                                 :ref:`wx.dataview.DataViewListStore`  is a specialised :ref:`wx.dataview.DataViewModel`  for storing a simple table of data.
`~wx.dataview.DataViewModel`                                                     :ref:`wx.dataview.DataViewModel`  is the base class for all data model to be displayed by a :ref:`wx.dataview.DataViewCtrl`.
`~wx.dataview.DataViewModelNotifier`                                             A :ref:`wx.dataview.DataViewModelNotifier`  instance is owned by a :ref:`wx.dataview.DataViewModel`  and mirrors its notification interface.
`~wx.dataview.DataViewProgressRenderer`                                          This class is used by :ref:`wx.dataview.DataViewCtrl`  to render progress bars.
`~wx.dataview.DataViewRenderer`                                                  This class is used by :ref:`wx.dataview.DataViewCtrl`  to render the individual cells.
`~wx.dataview.DataViewSpinRenderer`                                              This is a specialized renderer for rendering integer values.
`~wx.dataview.DataViewTextRenderer`                                              :ref:`wx.dataview.DataViewTextRenderer`  is used for rendering text.
`~wx.dataview.DataViewToggleRenderer`                                            This class is used by :ref:`wx.dataview.DataViewCtrl`  to render toggle controls.
`~wx.dataview.DataViewTreeCtrl`                                                  This class is a :ref:`wx.dataview.DataViewCtrl`  which internally uses a :ref:`wx.dataview.DataViewTreeStore`  and forwards most of its API to that class.
`~wx.dataview.DataViewTreeStore`                                                 :ref:`wx.dataview.DataViewTreeStore`  is a specialised :ref:`wx.dataview.DataViewModel`  for storing simple trees very much like :ref:`wx.TreeCtrl`  does and it offers a similar API.
`~wx.dataview.DataViewValueAdjuster`                                             This class can be used with :meth:`wx.dataview.DataViewRenderer.SetValueAdjuster`   to customize rendering of model values with standard renderers.
`~wx.dataview.DataViewVirtualListModel`                                          :ref:`wx.dataview.DataViewVirtualListModel`  is a specialized data model which lets you address an item by its position (row) rather than its :ref:`wx.dataview.DataViewItem`  and as such offers the exact same interface as :ref:`wx.dataview.DataViewIndexListModel`.
`~wx.dataview.PyDataViewModel`                                                   A convenience class that is a :class:`DataViewModel` combined with an object mapper.
`~wx.dataview.TreeListCtrl`                                                      A control combining :ref:`wx.TreeCtrl`  and :ref:`wx.ListCtrl`  features.
`~wx.dataview.TreeListEvent`                                                     Event generated by :ref:`wx.dataview.TreeListCtrl`.
`~wx.dataview.TreeListItem`                                                      Unique identifier of an item in :ref:`wx.dataview.TreeListCtrl`.
`~wx.dataview.TreeListItemComparator`                                            Class defining sort order for the items in :ref:`wx.dataview.TreeListCtrl`.
================================================================================ ================================================================================


.. toctree::
   :maxdepth: 1
   :hidden:

   wx.dataview.DataViewBitmapRenderer
   wx.dataview.DataViewCellMode.enumeration
   wx.dataview.DataViewCellRenderState.enumeration
   wx.dataview.DataViewCheckIconText
   wx.dataview.DataViewCheckIconTextRenderer
   wx.dataview.DataViewChoiceRenderer
   wx.dataview.DataViewColumn
   wx.dataview.DataViewColumnFlags.enumeration
   wx.dataview.DataViewCtrl
   wx.dataview.DataViewCustomRenderer
   wx.dataview.DataViewDateRenderer
   wx.dataview.DataViewEvent
   wx.dataview.DataViewIconText
   wx.dataview.DataViewIconTextRenderer
   wx.dataview.DataViewIndexListModel
   wx.dataview.DataViewItem
   wx.dataview.DataViewItemAttr
   wx.dataview.DataViewItemObjectMapper
   wx.dataview.DataViewListCtrl
   wx.dataview.DataViewListModel
   wx.dataview.DataViewListStore
   wx.dataview.DataViewModel
   wx.dataview.DataViewModelNotifier
   wx.dataview.DataViewProgressRenderer
   wx.dataview.DataViewRenderer
   wx.dataview.DataViewSpinRenderer
   wx.dataview.DataViewTextRenderer
   wx.dataview.DataViewToggleRenderer
   wx.dataview.DataViewTreeCtrl
   wx.dataview.DataViewTreeStore
   wx.dataview.DataViewValueAdjuster
   wx.dataview.DataViewVirtualListModel
   wx.dataview.PyDataViewModel
   wx.dataview.TreeListCtrl
   wx.dataview.TreeListEvent
   wx.dataview.TreeListItem
   wx.dataview.TreeListItemComparator