.. 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.ListView:

==========================================================================================================================================
|phoenix_title|  **wx.ListView**
==========================================================================================================================================

This class currently simply presents a simpler to use interface for the :ref:`wx.ListCtrl`  –  it can be thought of as a `façade`  for that complicated class. 
         

Using it is preferable to using :ref:`wx.ListCtrl`  directly whenever possible because in the future some ports might implement :ref:`wx.ListView`  but not the full set of :ref:`wx.ListCtrl`  features. 

Other than different interface, this class is identical to :ref:`wx.ListCtrl`. In particular, it uses the same events, same window styles and so on. 








         



.. seealso:: :meth:`wx.ListView.SetColumnImage`     







|

|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>ListView</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.ListView_inheritance.svg" alt="Inheritance diagram of ListView" 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.ListView.html" title="This class currently simply presents a simpler to use interface for the wx.ListCtrl  –  it can be thought of as a `façade`  for that complicated class." alt="" coords="65,389,178,418"/> <area shape="rect" id="node2" href="wx.ListCtrl.html" title="A list control presents lists in a number of formats: list view, report view, icon view and small icon view." alt="" coords="70,313,173,341"/> <area shape="rect" id="node3" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="69,236,174,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"/> </map> 
   </p>
   </div>

|


|appearance| Control Appearance
===============================

|

.. container:: control-appearance-figures

   .. figure:: _static/images/widgets/fullsize/wxmsw/../no_appearance.png
      :alt: wxMSW
      :figclass: appearance-figure

      **wxMSW**


   .. figure:: _static/images/widgets/fullsize/wxmac/../no_appearance.png
      :alt: wxMAC
      :figclass: appearance-figure

      **wxMAC**


   .. figure:: _static/images/widgets/fullsize/wxgtk/wx.listview.png
      :alt: wxGTK
      :figclass: appearance-figure

      **wxGTK**

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.ListView.__init__`                                                    Default constructor.
:meth:`~wx.ListView.ClearColumnImage`                                            Resets the column image –  after calling this function, no image will be shown.
:meth:`~wx.ListView.Focus`                                                       Sets focus to the item with the given `index`.
:meth:`~wx.ListView.GetClassDefaultAttributes`                                   
:meth:`~wx.ListView.GetFirstSelected`                                            Returns the first selected item in a (presumably) multiple selection control.
:meth:`~wx.ListView.GetFocusedItem`                                              Returns the currently focused item or -1 if none.
:meth:`~wx.ListView.GetNextSelected`                                             Used together with :meth:`~ListView.GetFirstSelected`   to iterate over all selected items in the control.
:meth:`~wx.ListView.IsSelected`                                                  Returns ``True`` if the item with the given `index`  is selected, ``False`` otherwise.
:meth:`~wx.ListView.Select`                                                      Selects or unselects the given item.
:meth:`~wx.ListView.SetColumnImage`                                              Sets the column image for the specified column.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.ListView.FirstSelected`                                               See :meth:`~wx.ListView.GetFirstSelected`
:attr:`~wx.ListView.FocusedItem`                                                 See :meth:`~wx.ListView.GetFocusedItem`
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: wx.ListView(ListCtrl)

   **Possible constructors**::

       ListView() -> None
       
       ListView(parent : Window, winid: int=ID_ANY, pos: Point=DefaultPosition,
                size: Size=DefaultSize, style: int=LC_REPORT, validator:
                Validator=DefaultValidator, name: str=ListCtrlNameStr) -> None
       
   
   This class currently simply presents a simpler to use interface for
   the ListCtrl  it can be thought of as a façade for that complicated
   class.



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations:**

      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self)`
      
      Default constructor. 
                       
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, parent : Window, winid: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=LC_REPORT, validator: Validator=DefaultValidator, name: str=ListCtrlNameStr)`
      
      Constructor, creating and showing a listview control. 
                       
      
      
      
      
      :param `parent`: Parent window. Must not be ``None``.   
      :type `parent`: wx.Window
      :param `winid`: Window identifier. The value ``wx.ID_ANY`` indicates a default value.   
      :type `winid`: wx.WindowID
      :param `pos`: Window position. If `wx.DefaultPosition`       is specified then a default position is chosen.   
      :type `pos`: wx.Point
      :param `size`: Window size. If `wx.DefaultSize`       is specified then the window is sized appropriately.   
      :type `size`: wx.Size
      :param `style`: Window style. See :ref:`wx.ListCtrl`.   
      :type `style`: long
      :param `validator`: Window validator.   
      :type `validator`: wx.Validator
      :param `name`: Window name.  
      :type `name`: string
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      :rtype: `None`     
      
      
      
      
                        
      
      
      
      .. seealso:: :meth:`~wx.ListCtrl.Create` , :ref:`wx.Validator`    
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






   .. method:: ClearColumnImage(self, col : int)

      Resets the column image –  after calling this function, no image will be shown. 
                 




      :param `col`: the column to clear image for  
      :type `col`: int






      :rtype: `None`     




                  



      .. seealso:: :meth:`SetColumnImage`     








   .. method:: Focus(self, index : int)

      Sets focus to the item with the given `index`. 
                 


      :param `index`: 
      :type `index`: long




      :rtype: `None`     








   .. staticmethod:: GetClassDefaultAttributes(variant: WindowVariant=WINDOW_VARIANT_NORMAL)




      :param `variant`: 
      :type `variant`: wx.WindowVariant




      :rtype: :ref:`wx.VisualAttributes`








   .. method:: GetFirstSelected(self)

      Returns the first selected item in a (presumably) multiple selection control. 
                 

      Together with :meth:`GetNextSelected`   it can be used to iterate over all selected items in the control. 


                

      :rtype: `int`







      :returns: 

         The first selected item, if any, -1 otherwise.   








   .. method:: GetFocusedItem(self)

      Returns the currently focused item or -1 if none. 
                 


                

      :rtype: `int`







      .. seealso:: :meth:`IsSelected` , :meth:`Focus`     








   .. method:: GetNextSelected(self, item : int)

      Used together with :meth:`GetFirstSelected`   to iterate over all selected items in the control. 
                 


                


      :param `item`: 
      :type `item`: long




      :rtype: `int`







      :returns: 

         Returns the next selected item or -1 if there are no more of them.   








   .. method:: IsSelected(self, index : int)

      Returns ``True`` if the item with the given `index`  is selected, ``False`` otherwise. 
                 


                


      :param `index`: 
      :type `index`: long




      :rtype: `bool`







      .. seealso:: :meth:`GetFirstSelected` , :meth:`GetNextSelected`     








   .. method:: Select(self, n : int, on: bool=True)

      Selects or unselects the given item. 
                 

      Notice that this method inherits the unusual behaviour of :meth:`wx.ListCtrl.SetItemState`   which sends a wxEVT_LIST_ITEM_SELECTED event when it is used to select an item, contrary to the usual rule that only the user actions result in selection. 




      :param `n`: the item to select or unselect   
      :type `n`: long
      :param `on`: if ``True`` (default), selects the item, otherwise unselects it   
      :type `on`: bool








      :rtype: `None`     




                  





   .. method:: SetColumnImage(self, col : int, image : int)

      Sets the column image for the specified column. 
                 

      To use the column images, the control must have a valid image list with at least one image. 




      :param `col`: the column to set image for   
      :type `col`: int
      :param `image`: the index of the column image in the controls image list   
      :type `image`: int








      :rtype: `None`     




                  





   .. attribute:: FirstSelected

      See :meth:`~wx.ListView.GetFirstSelected`


   .. attribute:: FocusedItem

      See :meth:`~wx.ListView.GetFocusedItem`