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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
.. 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.agw.persist.persist_handlers
.. highlight:: python
.. _wx.lib.agw.persist.persist_handlers.TreeCtrlHandler:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.persist.persist_handlers.TreeCtrlHandler**
==========================================================================================================================================
Supports saving/restoring a :class:`TreeCtrl` expansion state, selections and
checked items state (meaningful only for :class:`lib.agw.customtreectrl.CustomTreeCtrl`).
This class handles the following wxPython widgets:
- :class:`TreeCtrl`;
- :class:`GenericDirCtrl`;
- :class:`lib.agw.customtreectrl.CustomTreeCtrl`;
- :class:`lib.agw.hypertreelist.HyperTreeList`;
|
|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>TreeCtrlHandler</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.agw.persist.persist_handlers.TreeCtrlHandler_inheritance.png" alt="Inheritance diagram of TreeCtrlHandler" 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.agw.persist.persist_handlers.AbstractHandler.html" title="wx.lib.agw.persist.persist_handlers.AbstractHandler" alt="" coords="5,5,352,35"/> <area shape="rect" id="node2" href="wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.html" title="wx.lib.agw.persist.persist_handlers.TreeCtrlHandler" alt="" coords="7,83,349,112"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.persist.persist_handlers.TreeListCtrlHandler`
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.persist.persist_handlers.AbstractHandler`
|
|method_summary| Methods Summary
================================
======================================================================================== ================================================================================
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.__init__`
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetCheckedState` Returns a list of checked items. Checked items are coded as determined by
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetCheckedStateOfChildren` Returns the checked/unchecked state of the children of a tree item.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetCheckedStateOfItem` Returns the checked/unchecked state of a tree item.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetExpansionState` Returns list of expanded items. Expanded items are coded as determined by
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetExpansionStateOfChildren` Returns the expansion state of the children of a tree item.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetExpansionStateOfItem` Returns the expansion state of a tree item.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetIndexOfItem` Return the index of item.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetItemChildren` Return the children of item as a list.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetItemIdentity` Return a hashable object that represents the identity of the
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetKind`
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetSelectionState` Returns a list of selected items. Selected items are coded as determined by
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetSelectionStateOfChildren` Returns the selection state of the children of a tree item.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.GetSelectionStateOfItem` Returns the selection state of a tree item.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.Restore`
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.Save`
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.SetCheckedState` Checks all tree items whose identity, as determined by :meth:`TreeCtrlHandler.GetItemIdentity() <TreeCtrlHandler.GetItemIdentity>`, is present
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.SetCheckedStateOfChildren` Sets the checked/unchecked state of the children of a tree item.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.SetCheckedStateOfItem` Sets the checked/unchecked state of a tree item.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.SetExpansionState` Expands all tree items whose identity, as determined by :meth:`TreeCtrlHandler.GetItemIdentity() <TreeCtrlHandler.GetItemIdentity>`,
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.SetExpansionStateOfChildren` Sets the expansion state of the children of a tree item (expanded or collapsed).
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.SetExpansionStateOfItem` Sets the expansion state of a tree item (expanded or collapsed).
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.SetSelectedStateOfChildren` Sets the selection state of the children of a tree item.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.SetSelectedStateOfItem` Sets the selection state of a tree item.
:meth:`~wx.lib.agw.persist.persist_handlers.TreeCtrlHandler.SetSelectionState` Selects all tree items whose identity, as determined by :meth:`TreeCtrlHandler.GetItemIdentity() <TreeCtrlHandler.GetItemIdentity>`,
======================================================================================== ================================================================================
|
|api| Class API
===============
.. class:: TreeCtrlHandler(AbstractHandler)
Supports saving/restoring a :class:`TreeCtrl` expansion state, selections and
checked items state (meaningful only for :class:`lib.agw.customtreectrl.CustomTreeCtrl`).
This class handles the following wxPython widgets:
- :class:`TreeCtrl`;
- :class:`GenericDirCtrl`;
- :class:`lib.agw.customtreectrl.CustomTreeCtrl`;
- :class:`lib.agw.hypertreelist.HyperTreeList`;
.. method:: __init__(self, pObject)
.. method:: GetCheckedState(self)
Returns a list of checked items. Checked items are coded as determined by
the result of :meth:`TreeCtrlHandler.GetItemIdentity() <TreeCtrlHandler.GetItemIdentity>`.
:note:
This is meaningful only for :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` and
:class:`~wx.lib.agw.hypertreelist.HyperTreeList`.
.. method:: GetCheckedStateOfChildren(self, item)
Returns the checked/unchecked state of the children of a tree item.
:param `item`: a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: GetCheckedStateOfItem(self, item)
Returns the checked/unchecked state of a tree item.
:param `item`: a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: GetExpansionState(self)
Returns list of expanded items. Expanded items are coded as determined by
the result of :meth:`TreeCtrlHandler.GetItemIdentity() <TreeCtrlHandler.GetItemIdentity>`.
.. method:: GetExpansionStateOfChildren(self, item)
Returns the expansion state of the children of a tree item.
:param `item`: a :class:`TreeCtrl` item or a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: GetExpansionStateOfItem(self, item)
Returns the expansion state of a tree item.
:param `item`: a :class:`TreeCtrl` item or a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: GetIndexOfItem(self, item)
Return the index of item.
:param `item`: a :class:`TreeCtrl` item or a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item;
.. method:: GetItemChildren(self, item=None, recursively=False)
Return the children of item as a list.
:param `item`: a :class:`TreeCtrl` item or a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item;
:param `recursively`: whether to recurse into the item hierarchy or not.
.. method:: GetItemIdentity(self, item)
Return a hashable object that represents the identity of the
item. By default this returns the position of the item in the
tree. You may want to override this to return the item label
(if you know that labels are unique and don't change), or return
something that represents the underlying domain object, e.g.
a database key.
:param `item`: a :class:`TreeCtrl` item or a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item;
.. method:: GetKind(self)
.. method:: GetSelectionState(self)
Returns a list of selected items. Selected items are coded as determined by
the result of :meth:`TreeCtrlHandler.GetItemIdentity() <TreeCtrlHandler.GetItemIdentity>`.
.. method:: GetSelectionStateOfChildren(self, item)
Returns the selection state of the children of a tree item.
:param `item`: a :class:`TreeCtrl` item or a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: GetSelectionStateOfItem(self, item)
Returns the selection state of a tree item.
:param `item`: a :class:`TreeCtrl` item or a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: Restore(self)
.. method:: Save(self)
.. method:: SetCheckedState(self, listOfCheckedItems)
Checks all tree items whose identity, as determined by :meth:`TreeCtrlHandler.GetItemIdentity() <TreeCtrlHandler.GetItemIdentity>`, is present
in the list and unchecks all other tree items.
:param `listOfCheckedItems`: a list of checked :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` items.
:note:
This is meaningful only for :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` and
:class:`~wx.lib.agw.hypertreelist.HyperTreeList`.
.. method:: SetCheckedStateOfChildren(self, listOfCheckedItems, item)
Sets the checked/unchecked state of the children of a tree item.
:param `listOfCheckedItems`: a list of checked :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` items;
:param `item`: a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: SetCheckedStateOfItem(self, listOfCheckedItems, item)
Sets the checked/unchecked state of a tree item.
:param `listOfCheckedItems`: a list of checked :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` items;
:param `item`: a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: SetExpansionState(self, listOfExpandedItems)
Expands all tree items whose identity, as determined by :meth:`TreeCtrlHandler.GetItemIdentity() <TreeCtrlHandler.GetItemIdentity>`,
is present in the list and collapses all other tree items.
:param `listOfExpandedItems`: a list of expanded :class:`TreeCtrl` or
:class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` items.
.. method:: SetExpansionStateOfChildren(self, listOfExpandedItems, item)
Sets the expansion state of the children of a tree item (expanded or collapsed).
:param `listOfExpandedItems`: a list of expanded :class:`TreeCtrl` or
:class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` items;
:param `item`: a :class:`TreeCtrl` item or a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: SetExpansionStateOfItem(self, listOfExpandedItems, item)
Sets the expansion state of a tree item (expanded or collapsed).
:param `listOfExpandedItems`: a list of expanded :class:`TreeCtrl` or
:class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` items;
:param `item`: a :class:`TreeCtrl` item or a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: SetSelectedStateOfChildren(self, listOfSelectedItems, item)
Sets the selection state of the children of a tree item.
:param `listOfSelectedItems`: a list of selected :class:`TreeCtrl` or
:class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` items;
:param `item`: a :class:`TreeCtrl` item or a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: SetSelectedStateOfItem(self, listOfSelectedItems, item)
Sets the selection state of a tree item.
:param `listOfSelectedItems`: a list of selected :class:`TreeCtrl` or
:class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` items;
:param `item`: a :class:`TreeCtrl` item or a :class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` item.
.. method:: SetSelectionState(self, listOfSelectedItems)
Selects all tree items whose identity, as determined by :meth:`TreeCtrlHandler.GetItemIdentity() <TreeCtrlHandler.GetItemIdentity>`,
is present in the list and unselects all other tree items.
:param `listOfSelectedItems`: a list of selected :class:`TreeCtrl` or
:class:`~wx.lib.agw.customtreectrl.CustomTreeCtrl` items.
|
