.. include:: headings.inc

.. module:: lib.mixins.listctrl

.. currentmodule:: lib.mixins.listctrl

.. highlight:: python



.. _lib.mixins.listctrl:

==========================================================================================================================================
|phoenix_title|  **listctrl**
==========================================================================================================================================





|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for module **listctrl**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.mixins.listctrl_inheritance.png" alt="Inheritance diagram of listctrl" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.mixins.listctrl.CheckListCtrlMixin.html" title="This is a mixin for ListCtrl which add a checkbox in the first" alt="" coords="41,271,244,302"/> <area shape="rect" id="node2" href="lib.mixins.listctrl.ListRowHighlighter.html" title="Editra Control Library: ListRowHighlighter" alt="" coords="43,218,243,249"/> <area shape="rect" id="node3" href="lib.mixins.listctrl.ColumnSorterMixin.html" title="A mixin class that handles sorting of a wx.ListCtrl in REPORT mode when" alt="" coords="40,165,245,195"/> <area shape="rect" id="node4" href="lib.mixins.listctrl.ListCtrlAutoWidthMixin.html" title="A mix-in class that automatically resizes the last column to take up" alt="" coords="28,111,257,142"/> <area shape="rect" id="node5" href="lib.mixins.listctrl.ListCtrlSelectionManagerMix.html" title="Mixin that defines a platform independent selection policy" alt="" coords="7,58,279,89"/> <area shape="rect" id="node6" href="lib.mixins.listctrl.TextEditMixin.html" title="A mixin class that enables any text in any column of a" alt="" coords="61,5,224,35"/> </map> 
   </p>

|


|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~lib.mixins.listctrl.getListCtrlSelection`                                Returns list of item indexes of given state (selected by defaults)
:func:`~lib.mixins.listctrl.selectBeforePopup`                                   Ensures the item the mouse is pointing at is selected before a popup.
================================================================================ ================================================================================


|


|class_summary| Classes Summary
===============================

================================================================================ ================================================================================
:ref:`lib.mixins.listctrl.CheckListCtrlMixin`                                    This is a mixin for ListCtrl which add a checkbox in the first
:ref:`lib.mixins.listctrl.ColumnSorterMixin`                                     A mixin class that handles sorting of a wx.ListCtrl in REPORT mode when
:ref:`lib.mixins.listctrl.ListCtrlAutoWidthMixin`                                A mix-in class that automatically resizes the last column to take up
:ref:`lib.mixins.listctrl.ListCtrlSelectionManagerMix`                           Mixin that defines a platform independent selection policy
:ref:`lib.mixins.listctrl.ListRowHighlighter`                                    Editra Control Library: ListRowHighlighter
:ref:`lib.mixins.listctrl.TextEditMixin`                                         A mixin class that enables any text in any column of a
================================================================================ ================================================================================


|


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

   lib.mixins.listctrl.CheckListCtrlMixin
   lib.mixins.listctrl.ColumnSorterMixin
   lib.mixins.listctrl.ListCtrlAutoWidthMixin
   lib.mixins.listctrl.ListCtrlSelectionManagerMix
   lib.mixins.listctrl.ListRowHighlighter
   lib.mixins.listctrl.TextEditMixin





Functions
------------

.. function:: getListCtrlSelection(listctrl, state=LIST_STATE_SELECTED)

   Returns list of item indexes of given state (selected by defaults) 


.. function:: selectBeforePopup(event)

   Ensures the item the mouse is pointing at is selected before a popup.
   
   Works with both single-select and multi-select lists.