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
|
.. 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.TreeListItemComparator:
==========================================================================================================================================
|phoenix_title| **wx.dataview.TreeListItemComparator**
==========================================================================================================================================
Class defining sort order for the items in :ref:`wx.dataview.TreeListCtrl`.
.. versionadded:: 2.9.3
.. seealso:: :ref:`wx.dataview.TreeListCtrl`
|
|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>TreeListItemComparator</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.TreeListItemComparator_inheritance.png" alt="Inheritance diagram of TreeListItemComparator" 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.dataview.TreeListItemComparator.html" title="wx.dataview.TreeListItemComparator" alt="" coords="5,5,259,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.dataview.TreeListItemComparator.__init__` Default constructor.
:meth:`~wx.dataview.TreeListItemComparator.Compare` Pure virtual function which must be overridden to define sort order.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.dataview.TreeListItemComparator(object)
**Possible constructors**::
TreeListItemComparator()
Class defining sort order for the items in TreeListCtrl.
.. method:: __init__(self)
Default constructor.
Notice that this class is not copyable, comparators are not passed by value.
.. method:: Compare(self, treelist, column, first, second)
Pure virtual function which must be overridden to define sort order.
The comparison function should return negative, null or positive value depending on whether the first item is less than, equal to or greater than the second one. The items should be compared using their values for the given column.
:param `treelist`: The control whose contents is being sorted.
:type `treelist`: wx.dataview.TreeListCtrl
:param `column`: The column of this control used for sorting.
:param `first`: First item to compare.
:type `first`: wx.dataview.TreeListItem
:param `second`: Second item to compare.
:type `second`: wx.dataview.TreeListItem
:rtype: `int`
:returns:
A negative value if the first item is less than (i.e. should appear above) the second one, zero if the two items are equal or a positive value if the first item is greater than (i.e. should appear below) the second one.
|
