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
|
.. 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.customtreectrl
.. highlight:: python
.. _wx.lib.agw.customtreectrl.CommandTreeEvent:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.customtreectrl.CommandTreeEvent**
==========================================================================================================================================
:class:`CommandTreeEvent` is a special subclassing of :class:`CommandEvent`.
:note: Not all the accessors make sense for all the events, see the event description for every method in this class.
|
|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>CommandTreeEvent</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.customtreectrl.CommandTreeEvent_inheritance.png" alt="Inheritance diagram of CommandTreeEvent" 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="123,83,201,112"/> <area shape="rect" id="node4" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="90,160,235,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="121,5,203,35"/> <area shape="rect" id="node3" href="wx.lib.agw.customtreectrl.CommandTreeEvent.html" title="wx.lib.agw.customtreectrl.CommandTreeEvent" alt="" coords="5,237,320,267"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.customtreectrl.TreeEvent`
|
|super_classes| Known Superclasses
==================================
:class:`wx.CommandEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.__init__` Default class constructor.
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.GetItem` Gets the item on which the operation was performed or the newly selected
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.GetKeyCode` Returns the virtual key code. ASCII events return normal ASCII values, while
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.GetKeyEvent` Returns the keyboard data (for ``EVT_TREE_KEY_DOWN`` event only).
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.GetLabel` Returns the item text (for ``EVT_TREE_BEGIN_LABEL_EDIT`` and
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.GetOldItem` Returns the previously selected item for ``EVT_TREE_SEL_CHANGED`` and
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.GetPoint` Returns the point where the mouse was when the drag operation started
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.GetToolTip` Returns the tooltip for the item (for ``EVT_TREE_ITEM_GETTOOLTIP`` events).
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.IsEditCancelled` Returns the edit cancel flag (for ``EVT_TREE_BEGIN_LABEL_EDIT`` and
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.SetEditCanceled` Sets the edit cancel flag (for ``EVT_TREE_BEGIN_LABEL_EDIT`` and
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.SetItem` Sets the item on which the operation was performed or the newly selected
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.SetKeyEvent` Sets the keyboard data (for ``EVT_TREE_KEY_DOWN`` event only).
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.SetLabel` Sets the item text (for ``EVT_TREE_BEGIN_LABEL_EDIT`` and
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.SetOldItem` Returns the previously selected item for ``EVT_TREE_SEL_CHANGED`` and
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.SetPoint` Sets the point where the mouse was when the drag operation started
:meth:`~wx.lib.agw.customtreectrl.CommandTreeEvent.SetToolTip` Sets the tooltip for the item (for ``EVT_TREE_ITEM_GETTOOLTIP`` events).
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: CommandTreeEvent(wx.CommandEvent)
:class:`CommandTreeEvent` is a special subclassing of :class:`CommandEvent`.
:note: Not all the accessors make sense for all the events, see the event description for every method in this class.
.. method:: __init__(self, evtType, evtId, item=None, evtKey=None, point=None, label=None, \*\*kwargs)
Default class constructor.
For internal use: do not call it in your code!
:param integer `evtType`: the event type;
:param integer `evtId`: the event identifier;
:param `item`: an instance of :class:`GenericTreeItem`;
:param integer `evtKey`: a character ordinal;
:param `point`: an instance of :class:`wx.Point`;
:param string `label`: a :class:`GenericTreeItem` text label.
.. method:: GetItem(self)
Gets the item on which the operation was performed or the newly selected
item for ``EVT_TREE_SEL_CHANGED`` and ``EVT_TREE_SEL_CHANGING`` events.
:return: An instance of :class:`GenericTreeItem`.
.. method:: GetKeyCode(self)
Returns the virtual key code. ASCII events return normal ASCII values, while
non-ASCII events return values such as ``wx.WXK_LEFT`` for the left cursor key.
This method is for ``EVT_TREE_KEY_DOWN`` events only.
:return: An integer representing the virtual key code.
:note: In Unicode build, the returned value is meaningful only if the user entered
a character that can be represented in current locale's default charset. You can
obtain the corresponding Unicode character using `GetUnicodeKey`.
.. method:: GetKeyEvent(self)
Returns the keyboard data (for ``EVT_TREE_KEY_DOWN`` event only).
:return: An instance of :class:`KeyEvent`.
.. method:: GetLabel(self)
Returns the item text (for ``EVT_TREE_BEGIN_LABEL_EDIT`` and
``EVT_TREE_END_LABEL_EDIT`` events only).
:return: A string containing the item text.
.. method:: GetOldItem(self)
Returns the previously selected item for ``EVT_TREE_SEL_CHANGED`` and
``EVT_TREE_SEL_CHANGING`` events.
:return: An instance of :class:`GenericTreeItem`.
.. method:: GetPoint(self)
Returns the point where the mouse was when the drag operation started
(for ``EVT_TREE_BEGIN_DRAG`` and ``EVT_TREE_BEGIN_RDRAG`` events only)
or the click position.
:return: An instance of :class:`wx.Point`.
.. method:: GetToolTip(self)
Returns the tooltip for the item (for ``EVT_TREE_ITEM_GETTOOLTIP`` events).
:return: A string containing the item tooltip.
.. method:: IsEditCancelled(self)
Returns the edit cancel flag (for ``EVT_TREE_BEGIN_LABEL_EDIT`` and
``EVT_TREE_END_LABEL_EDIT`` events only).
:return: ``True`` is the item editing has been cancelled, ``False`` otherwise.
.. method:: SetEditCanceled(self, editCancelled)
Sets the edit cancel flag (for ``EVT_TREE_BEGIN_LABEL_EDIT`` and
``EVT_TREE_END_LABEL_EDIT`` events only).
:param bool `editCancelled`: ``True`` to cancel the editing, ``False`` otherwise.
.. method:: SetItem(self, item)
Sets the item on which the operation was performed or the newly selected
item for ``EVT_TREE_SEL_CHANGED`` and ``EVT_TREE_SEL_CHANGING`` events.
:param `item`: an instance of :class:`GenericTreeItem`.
.. method:: SetKeyEvent(self, event)
Sets the keyboard data (for ``EVT_TREE_KEY_DOWN`` event only).
:param `event`: a :class:`CommandTreeEvent` event to be processed.
.. method:: SetLabel(self, label)
Sets the item text (for ``EVT_TREE_BEGIN_LABEL_EDIT`` and
``EVT_TREE_END_LABEL_EDIT`` events only).
:param string `label`: a string containing the new item text.
.. method:: SetOldItem(self, item)
Returns the previously selected item for ``EVT_TREE_SEL_CHANGED`` and
``EVT_TREE_SEL_CHANGING`` events.
:param `item`: an instance of :class:`GenericTreeItem`.
.. method:: SetPoint(self, pt)
Sets the point where the mouse was when the drag operation started
(for ``EVT_TREE_BEGIN_DRAG`` and ``EVT_TREE_BEGIN_RDRAG`` events only)
or the click position.
:param `pt`: an instance of :class:`wx.Point`.
.. method:: SetToolTip(self, toolTip)
Sets the tooltip for the item (for ``EVT_TREE_ITEM_GETTOOLTIP`` events).
:param string `tooltip`: a string representing the item tooltip.
|
