.. include:: headings.inc



.. _CheckListBox:

==========================================================================================================================================
|phoenix_title|  **CheckListBox**
==========================================================================================================================================

A :ref:`CheckListBox`  is like a :ref:`ListBox`, but allows items to be checked or unchecked.          

When using this class under Windows wxWidgets must be compiled with ``USE_OWNER_DRAWN`` set to 1. 





.. _CheckListBox-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`CommandEvent` parameter.

- EVT_CHECKLISTBOX: Process a  ``wxEVT_COMMAND_CHECKLISTBOX_TOGGLED``   event, when an item in the check list box is checked or unchecked.  :meth:`CommandEvent.GetInt`   will contain the index of the item that was checked or unchecked. :meth:`CommandEvent.IsChecked`   is not valid! Use :meth:`CheckListBox.IsChecked`   instead.  








         



.. seealso:: :ref:`ListBox`, :ref:`Choice`, :ref:`ComboBox`, :ref:`ListCtrl`, :ref:`CommandEvent`    







|

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

Inheritance diagram for class **CheckListBox**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/CheckListBox_inheritance.png" alt="Inheritance diagram of CheckListBox" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="569,58,644,89"/> <area shape="rect" id="node13" href="ControlWithItems.html" title="This is convenience class that derives from both Control  and ItemContainer." alt="" coords="717,31,864,62"/> <area shape="rect" id="node2" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="356,58,436,89"/> <area shape="rect" id="node4" href="ItemContainer.html" title="This class is an abstract base class for some wxWidgets controls which contain several items such as ListBox, CheckListBox, ComboBox  or Choice." alt="" coords="545,5,668,35"/> <area shape="rect" id="node5" href="ItemContainerImmutable.html" title="ItemContainer  defines an interface which is implemented by all controls which have string subitems each of which may be selected." alt="" coords="297,5,495,35"/> <area shape="rect" id="node7" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="16,31,88,62"/> <area shape="rect" id="node8" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="148,58,247,89"/> <area shape="rect" id="node10" href="CheckListBox.html" title="A CheckListBox  is like a ListBox, but allows items to be checked or unchecked." alt="" coords="1036,31,1156,62"/> <area shape="rect" id="node11" href="ListBox.html" title="A listbox is used to select one or more of a list of strings." alt="" coords="912,31,987,62"/> <area shape="rect" id="node16" href="Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,85,99,115"/> </map> 
   </p>

|


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

|

.. figure:: _static/images/widgets/fullsize/wxmsw/checklistbox.png
   :alt: wxMSW
   :figclass: floatleft
   
   **wxMSW**


.. figure:: _static/images/widgets/fullsize/wxmac/checklistbox.png
   :alt: wxMAC
   :figclass: floatright
   
   **wxMAC**


.. figure:: _static/images/widgets/fullsize/wxgtk/checklistbox.png
   :alt: wxGTK
   :figclass: floatcenter
   
   **wxGTK**


|


|sub_classes| Known Subclasses
==============================

`RearrangeList`

|


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

================================================================================ ================================================================================
:meth:`~CheckListBox.__init__`                                                   Constructor, creating and showing a list box.
:meth:`~CheckListBox.Check`                                                      Checks the given item.
:meth:`~CheckListBox.Create`                                                     Creates the listbox for two-step construction.
:meth:`~CheckListBox.GetChecked`                                                 GetChecked()
:meth:`~CheckListBox.GetCheckedStrings`                                          GetCheckedStrings()
:meth:`~CheckListBox.IsChecked`                                                  Returns ``True`` if the given item is checked, ``False`` otherwise.
:meth:`~CheckListBox.SetChecked`                                                 SetChecked(indexes)
:meth:`~CheckListBox.SetCheckedStrings`                                          SetCheckedStrings(strings)
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~CheckListBox.Checked`                                                    See :meth:`~CheckListBox.GetChecked` and :meth:`~CheckListBox.SetChecked`
:attr:`~CheckListBox.CheckedStrings`                                             See :meth:`~CheckListBox.GetCheckedStrings` and :meth:`~CheckListBox.SetCheckedStrings`
================================================================================ ================================================================================


|


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

.. class:: CheckListBox(ListBox)

   A CheckListBox is like a ListBox, but allows items to be checked or unchecked.
   
   **Possible constructors**::

       CheckListBox(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
                    choices=[], style=0, validator=DefaultValidator,
                    name="listBox")
       
       CheckListBox()
       



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



      |overload| **Overloaded Implementations**:

      **~~~**

      
      **__init__** `(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name="listBox")`
      
      Constructor, creating and showing a list box.                  
      
      
      
      
      :param `parent`: Parent window. Must not be ``None``.   
      :type `parent`: Window
      :param `id`: Window identifier. The value ``ID_ANY`` indicates a default value.   
      :type `id`: int
      :param `pos`: Window position.   
      :type `pos`: Point
      :param `size`: Window size. If DefaultSize is specified then the window is sized appropriately.   
      :type `size`: Size
      :param `choices`: An array of strings with which to initialise the control.   
      :type `choices`: list of strings
      :param `style`: Window style. See :ref:`CheckListBox`.   
      :type `style`: long
      :param `validator`: Window validator.   
      :type `validator`: Validator
      :param `name`: Window name.  
      :type `name`: string
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      
      **~~~**

      
      **__init__** `(self)`
      
      Default constructor.                   
      
      
      
      
      **~~~**






   .. method:: Check(self, item, check=True)

      Checks the given item.                  

      Note that calling this method does not result in a  ``wxEVT_COMMAND_CHECKLISTBOX_TOGGLE``   event being emitted. 




      :param `item`: Index of item to check.   
      :type `item`: int
      :param `check`: ``True`` if the item is to be checked, ``False`` otherwise.   
      :type `check`: bool






                  





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

      Creates the listbox for two-step construction.                  

      See :meth:`ListBox`   for further details.                   





   .. method:: GetChecked(self)

      GetChecked()
      
      Return a sequence of integers corresponding to the checked items in
      the control, based on `IsChecked`.



   .. method:: GetCheckedStrings(self)

      GetCheckedStrings()
      
      Return a tuple of strings corresponding to the checked
      items of the control, based on `GetChecked`.



   .. method:: IsChecked(self, item)

      Returns ``True`` if the given item is checked, ``False`` otherwise.                  




      :param `item`: Index of item whose check status is to be returned.   
      :type `item`: int






      :rtype: `bool`



                  





   .. method:: SetChecked(self, indexes)

      SetChecked(indexes)
      
      Sets the checked state of items if the index of the item is 
      found in the indexes sequence.



   .. method:: SetCheckedStrings(self, strings)

      SetCheckedStrings(strings)
      
      Sets the checked state of items if the item's string is found
      in the strings sequence.



   .. attribute:: Checked

      See :meth:`~CheckListBox.GetChecked` and :meth:`~CheckListBox.SetChecked`


   .. attribute:: CheckedStrings

      See :meth:`~CheckListBox.GetCheckedStrings` and :meth:`~CheckListBox.SetCheckedStrings`