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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
.. 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.propgrid.PropertyGridEvent:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.PropertyGridEvent**
==========================================================================================================================================
A property grid event holds information about events associated with :ref:`wx.propgrid.PropertyGrid` objects.
|
|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>PropertyGridEvent</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.propgrid.PropertyGridEvent_inheritance.png" alt="Inheritance diagram of PropertyGridEvent" 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="73,83,151,112"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="wx.CommandEvent" alt="" coords="39,160,184,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="71,5,152,35"/> <area shape="rect" id="node4" href="wx.propgrid.PropertyGridEvent.html" title="wx.propgrid.PropertyGridEvent" alt="" coords="5,237,219,267"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.PropertyGridEvent.__init__` Constructor.
:meth:`~wx.propgrid.PropertyGridEvent.CanVeto` Returns ``True`` if you can veto the action that the event is signaling.
:meth:`~wx.propgrid.PropertyGridEvent.GetColumn` Returns the column index associated with this event.
:meth:`~wx.propgrid.PropertyGridEvent.GetMainParent` Returns highest level non-category, non-root parent of property for which event occurred.
:meth:`~wx.propgrid.PropertyGridEvent.GetProperty` Returns property associated with this event.
:meth:`~wx.propgrid.PropertyGridEvent.GetPropertyName` Returns name of the associated property.
:meth:`~wx.propgrid.PropertyGridEvent.GetPropertyValue` Returns value of the associated property.
:meth:`~wx.propgrid.PropertyGridEvent.GetValidationFailureBehavior` Returns current validation failure flags.
:meth:`~wx.propgrid.PropertyGridEvent.SetCanVeto` Set if event can be vetoed.
:meth:`~wx.propgrid.PropertyGridEvent.SetProperty` Changes the property associated with this event.
:meth:`~wx.propgrid.PropertyGridEvent.SetValidationFailureBehavior` Set override validation failure behaviour.
:meth:`~wx.propgrid.PropertyGridEvent.SetValidationFailureMessage` Sets custom failure message for this time only.
:meth:`~wx.propgrid.PropertyGridEvent.Veto` Call this from your event handler to veto action that the event is signaling.
:meth:`~wx.propgrid.PropertyGridEvent.WasVetoed` Returns ``True`` if event was vetoed.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.propgrid.PropertyGridEvent.Column` See :meth:`~wx.propgrid.PropertyGridEvent.GetColumn`
:attr:`~wx.propgrid.PropertyGridEvent.MainParent` See :meth:`~wx.propgrid.PropertyGridEvent.GetMainParent`
:attr:`~wx.propgrid.PropertyGridEvent.Property` See :meth:`~wx.propgrid.PropertyGridEvent.GetProperty` and :meth:`~wx.propgrid.PropertyGridEvent.SetProperty`
:attr:`~wx.propgrid.PropertyGridEvent.PropertyName` See :meth:`~wx.propgrid.PropertyGridEvent.GetPropertyName`
:attr:`~wx.propgrid.PropertyGridEvent.PropertyValue` See :meth:`~wx.propgrid.PropertyGridEvent.GetPropertyValue`
:attr:`~wx.propgrid.PropertyGridEvent.ValidationFailureBehavior` See :meth:`~wx.propgrid.PropertyGridEvent.GetValidationFailureBehavior` and :meth:`~wx.propgrid.PropertyGridEvent.SetValidationFailureBehavior`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.PropertyGridEvent(CommandEvent)
**Possible constructors**::
PropertyGridEvent(commandType=0, id=0)
PropertyGridEvent(event)
A property grid event holds information about events associated with
PropertyGrid objects.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self, commandType=0, id=0)`
Constructor.
:param `commandType`:
:type `commandType`: wx.EventType
:param `id`:
:type `id`: int
**~~~**
**__init__** `(self, event)`
Copy constructor.
:param `event`:
:type `event`: wx.propgrid.PropertyGridEvent
**~~~**
.. method:: CanVeto(self)
Returns ``True`` if you can veto the action that the event is signaling.
:rtype: `bool`
.. method:: GetColumn(self)
Returns the column index associated with this event.
For the column dragging events, it is the column to the left of the splitter being dragged
:rtype: `int`
.. method:: GetMainParent(self)
Returns highest level non-category, non-root parent of property for which event occurred.
Useful when you have nested properties with children.
:rtype: :ref:`wx.propgrid.PGProperty`
.. note::
If immediate parent is root or category, this will return the property itself.
.. method:: GetProperty(self)
Returns property associated with this event.
:rtype: :ref:`wx.propgrid.PGProperty`
.. note::
You should assume that this property can always be ``None``. For instance, ``wxEVT_PG_SELECTED`` is emitted not only when a new property is selected, but also when selection is cleared by user activity.
.. method:: GetPropertyName(self)
Returns name of the associated property.
:rtype: `string`
.. note::
Property name is stored in event, so it remains accessible even after the associated property or the property grid has been deleted.
.. method:: GetPropertyValue(self)
Returns value of the associated property.
Works for all event types, but for ``wxEVT_PG_CHANGING`` this member function returns the value that is pending, so you can call :meth:`Veto` if the value is not satisfactory.
:rtype: :ref:`PGVariant`
.. note::
Property value is stored in event, so it remains accessible even after the associated property or the property grid has been deleted.
.. seealso:: :meth:`GetPropertyValue`
.. method:: GetValidationFailureBehavior(self)
Returns current validation failure flags.
:rtype: :ref:`wx.propgrid.PGVFBFlags`
.. method:: SetCanVeto(self, canVeto)
Set if event can be vetoed.
:param `canVeto`:
:type `canVeto`: bool
.. method:: SetProperty(self, p)
Changes the property associated with this event.
:param `p`:
:type `p`: wx.propgrid.PGProperty
.. method:: SetValidationFailureBehavior(self, flags)
Set override validation failure behaviour.
Only effective if :meth:`Veto` was also called, and only allowed if event type is ``wxEVT_PG_CHANGING`` .
:param `flags`:
:type `flags`: wx.propgrid.PGVFBFlags
.. method:: SetValidationFailureMessage(self, message)
Sets custom failure message for this time only.
Only applies if ``wx.propgrid.PG_VFB_SHOW_MESSAGE`` is set in validation failure flags.
:param `message`:
:type `message`: string
.. method:: Veto(self, veto=True)
Call this from your event handler to veto action that the event is signaling.
You can only veto a shutdown if :meth:`wx.propgrid.PropertyGridEvent.CanVeto` returns ``True``.
:param `veto`:
:type `veto`: bool
.. note::
Currently only ``wxEVT_PG_CHANGING`` supports vetoing.
.. method:: WasVetoed(self)
Returns ``True`` if event was vetoed.
:rtype: `bool`
.. attribute:: Column
See :meth:`~wx.propgrid.PropertyGridEvent.GetColumn`
.. attribute:: MainParent
See :meth:`~wx.propgrid.PropertyGridEvent.GetMainParent`
.. attribute:: Property
See :meth:`~wx.propgrid.PropertyGridEvent.GetProperty` and :meth:`~wx.propgrid.PropertyGridEvent.SetProperty`
.. attribute:: PropertyName
See :meth:`~wx.propgrid.PropertyGridEvent.GetPropertyName`
.. attribute:: PropertyValue
See :meth:`~wx.propgrid.PropertyGridEvent.GetPropertyValue`
.. attribute:: ValidationFailureBehavior
See :meth:`~wx.propgrid.PropertyGridEvent.GetValidationFailureBehavior` and :meth:`~wx.propgrid.PropertyGridEvent.SetValidationFailureBehavior`
|
