File: wx.dataview.TreeListEvent.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 (161 lines) | stat: -rw-r--r-- 5,115 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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
.. 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



.. _wx.dataview.TreeListEvent:

==========================================================================================================================================
|phoenix_title|  **wx.dataview.TreeListEvent**
==========================================================================================================================================

Event generated by :ref:`wx.dataview.TreeListCtrl`.          

         



.. versionadded:: 2.9.3 
     







|

|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>TreeListEvent</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.dataview.TreeListEvent_inheritance.png" alt="Inheritance diagram of TreeListEvent" 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.Event.html" title="wx.Event" alt="" coords="58,83,136,112"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="25,160,169,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="56,5,137,35"/> <area shape="rect" id="node5" href="wx.NotifyEvent.html" title="wx.NotifyEvent" alt="" coords="40,237,155,267"/> <area shape="rect" id="node4" href="wx.dataview.TreeListEvent.html" title="wx.dataview.TreeListEvent" alt="" coords="5,315,189,344"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~wx.dataview.TreeListEvent.__init__`                                      
:meth:`~wx.dataview.TreeListEvent.GetColumn`                                     Return the column affected by the event.
:meth:`~wx.dataview.TreeListEvent.GetItem`                                       Return the item affected by the event.
:meth:`~wx.dataview.TreeListEvent.GetOldCheckedState`                            Return the previous state of the item checkbox.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.dataview.TreeListEvent.Column`                                        See :meth:`~wx.dataview.TreeListEvent.GetColumn`
:attr:`~wx.dataview.TreeListEvent.Item`                                          See :meth:`~wx.dataview.TreeListEvent.GetItem`
:attr:`~wx.dataview.TreeListEvent.OldCheckedState`                               See :meth:`~wx.dataview.TreeListEvent.GetOldCheckedState`
================================================================================ ================================================================================


|


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


.. class:: wx.dataview.TreeListEvent(NotifyEvent)

   **Possible constructors**::

       TreeListEvent()
       
   
   Event generated by TreeListCtrl.



   .. method:: __init__(self)






   .. method:: GetColumn(self)

      Return the column affected by the event.                  

      This is currently only used with  ``wxEVT_TREELIST_COLUMN_SORTED``   event.                    





   .. method:: GetItem(self)

      Return the item affected by the event.                  

      This is the item being selected, expanded, checked or activated (depending on the event type).                  

      :rtype: :ref:`wx.dataview.TreeListItem`








   .. method:: GetOldCheckedState(self)

      Return the previous state of the item checkbox.                  

      This method can be used with  ``wxEVT_TREELIST_ITEM_CHECKED``   events only. 

      Notice that the new state of the item can be retrieved using :meth:`wx.dataview.TreeListCtrl.GetCheckedState` .                  

      :rtype: :ref:`wx.CheckBoxState`








   .. attribute:: Column

      See :meth:`~wx.dataview.TreeListEvent.GetColumn`


   .. attribute:: Item

      See :meth:`~wx.dataview.TreeListEvent.GetItem`


   .. attribute:: OldCheckedState

      See :meth:`~wx.dataview.TreeListEvent.GetOldCheckedState`