File: wx.lib.mixins.listctrl.CheckListCtrlMixin.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (123 lines) | stat: -rw-r--r-- 4,103 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.mixins.listctrl

.. highlight:: python



.. _wx.lib.mixins.listctrl.CheckListCtrlMixin:

==========================================================================================================================================
|phoenix_title|  **wx.lib.mixins.listctrl.CheckListCtrlMixin**
==========================================================================================================================================

This is a mixin for ListCtrl which add a checkbox in the first
column of each row. It is inspired by limodou's CheckList.py(which
can be got from his NewEdit) and improved:

    - You can just use InsertStringItem() to insert new items;

    - Once a checkbox is checked/unchecked, the corresponding item
      is not selected;

    - You can use SetItemData() and GetItemData();

    - Interfaces are changed to OnCheckItem(), IsChecked(),
      CheckItem().

You should not set a imagelist for the ListCtrl once this mixin is used.



|

|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>CheckListCtrlMixin</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.lib.mixins.listctrl.CheckListCtrlMixin_inheritance.png" alt="Inheritance diagram of CheckListCtrlMixin" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.mixins.listctrl.CheckListCtrlMixin.html" title="wx.lib.mixins.listctrl.CheckListCtrlMixin" alt="" coords="5,5,267,35"/> </map> 
   </p>

|


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

:class:`wx.lib.eventwatcher.EventChooserLC`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.mixins.listctrl.CheckListCtrlMixin.__init__`                      
:meth:`~wx.lib.mixins.listctrl.CheckListCtrlMixin.CheckItem`                     
:meth:`~wx.lib.mixins.listctrl.CheckListCtrlMixin.IsChecked`                     
:meth:`~wx.lib.mixins.listctrl.CheckListCtrlMixin.OnCheckItem`                   
:meth:`~wx.lib.mixins.listctrl.CheckListCtrlMixin.ToggleItem`                    
================================================================================ ================================================================================


|


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


.. class:: CheckListCtrlMixin(object)

   This is a mixin for ListCtrl which add a checkbox in the first
   column of each row. It is inspired by limodou's CheckList.py(which
   can be got from his NewEdit) and improved:
   
       - You can just use InsertStringItem() to insert new items;
   
       - Once a checkbox is checked/unchecked, the corresponding item
         is not selected;
   
       - You can use SetItemData() and GetItemData();
   
       - Interfaces are changed to OnCheckItem(), IsChecked(),
         CheckItem().
   
   You should not set a imagelist for the ListCtrl once this mixin is used.

   .. method:: __init__(self, check_image=None, uncheck_image=None, imgsz=(16,16))


   .. method:: CheckItem(self, index, check=True)


   .. method:: IsChecked(self, index)


   .. method:: OnCheckItem(self, index, flag)


   .. method:: ToggleItem(self, index)