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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.propgrid.EditorDialogProperty:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.EditorDialogProperty**
==========================================================================================================================================
This is an abstract class which serves as a base class for the properties having a button triggering an editor dialog, like e.g.
:ref:`wx.propgrid.LongStringProperty`, :ref:`wx.propgrid.DirProperty`, :ref:`wx.propgrid.FileProperty`.
**Supported special attributes:**
- ``PG_DIALOG_TITLE``: Sets a specific title for the editor dialog.
.. versionadded:: 4.1/wxWidgets-3.1.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>EditorDialogProperty</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.EditorDialogProperty_inheritance.png" alt="Inheritance diagram of EditorDialogProperty" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.propgrid.EditorDialogProperty.html" title="wx.propgrid.EditorDialogProperty" alt="" coords="5,160,244,189"/> <area shape="rect" id="node2" href="wx.propgrid.PGProperty.html" title="wx.propgrid.PGProperty" alt="" coords="37,83,213,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="81,5,168,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.propgrid.ArrayStringProperty`, :ref:`wx.propgrid.DirProperty`, :ref:`wx.propgrid.FileProperty`, :ref:`wx.propgrid.FontProperty`, :ref:`wx.propgrid.LongStringProperty`, :ref:`wx.propgrid.MultiChoiceProperty`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.EditorDialogProperty.DisplayEditorDialog` Shows editor dialog.
:meth:`~wx.propgrid.EditorDialogProperty.DoSetAttribute` Reimplement this member function to add special handling for attributes of this property.
:meth:`~wx.propgrid.EditorDialogProperty.GetEditorDialog` Returns instance of a new :ref:`wx.propgrid.PGEditorDialogAdapter` instance, which is used when user presses the (optional) button next to the editor control;.
:meth:`~wx.propgrid.EditorDialogProperty.__init__` Constructor is protected because :ref:`wx.propgrid.EditorDialogProperty` is only the base class for other property classes.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.propgrid.EditorDialogProperty.EditorDialog` See :meth:`~wx.propgrid.EditorDialogProperty.GetEditorDialog`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.EditorDialogProperty(PGProperty)
**Possible constructors**::
EditorDialogProperty(label, name)
This is an abstract class which serves as a base class for the
properties having a button triggering an editor dialog, like e.g.
.. method:: DisplayEditorDialog(self, pg, value)
Shows editor dialog.
Value to be edited should be read from `value`, and if dialog is not cancelled, it should be stored back and ``True`` should be returned.
:param `pg`: Property grid in which property is displayed.
:type `pg`: wx.propgrid.PropertyGrid
:param `value`: Value to be edited.
:type `value`: PGVariant
:rtype: `bool`
:returns:
Returns ``True`` if editor dialog was not cancelled and `value` was updated.
.. method:: DoSetAttribute(self, name, value)
Reimplement this member function to add special handling for attributes of this property.
:param `name`:
:type `name`: string
:param `value`:
:type `value`: PGVariant
:rtype: `bool`
:returns:
Return ``False`` to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
.. note::
To actually set property attribute values from the application, use :meth:`wx.propgrid.PGProperty.SetAttribute` instead.
.. method:: GetEditorDialog(self)
Returns instance of a new :ref:`wx.propgrid.PGEditorDialogAdapter` instance, which is used when user presses the (optional) button next to the editor control;.
Default implementation returns ``None`` (i.e. no action is generated when button is pressed).
:rtype: :ref:`wx.propgrid.PGEditorDialogAdapter`
.. method:: __init__(self, label, name)
Constructor is protected because :ref:`wx.propgrid.EditorDialogProperty` is only the base class for other property classes.
:param `label`:
:type `label`: string
:param `name`:
:type `name`: string
.. attribute:: EditorDialog
See :meth:`~wx.propgrid.EditorDialogProperty.GetEditorDialog`
|
