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
|
.. 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.PGComboBoxEditor:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.PGComboBoxEditor**
==========================================================================================================================================
|
|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>PGComboBoxEditor</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.PGComboBoxEditor_inheritance.png" alt="Inheritance diagram of PGComboBoxEditor" 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.propgrid.PGChoiceEditor.html" title="wx.propgrid.PGChoiceEditor" alt="" coords="17,160,215,189"/> <area shape="rect" id="node4" href="wx.propgrid.PGComboBoxEditor.html" title="wx.propgrid.PGComboBoxEditor" alt="" coords="4,237,227,267"/> <area shape="rect" id="node2" href="wx.propgrid.PGEditor.html" title="wx.propgrid.PGEditor" alt="" coords="39,83,192,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="75,5,156,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.PGComboBoxEditor.__init__`
:meth:`~wx.propgrid.PGComboBoxEditor.CreateControls` Instantiates editor controls.
:meth:`~wx.propgrid.PGComboBoxEditor.GetName` Returns pointer to the name of the editor.
:meth:`~wx.propgrid.PGComboBoxEditor.GetValueFromControl` Returns value from control, via parameter 'variant'.
:meth:`~wx.propgrid.PGComboBoxEditor.OnEvent` Handles events.
:meth:`~wx.propgrid.PGComboBoxEditor.OnFocus` Extra processing when control gains focus.
:meth:`~wx.propgrid.PGComboBoxEditor.UpdateControl` Loads value from property to the control.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.propgrid.PGComboBoxEditor.Name` See :meth:`~wx.propgrid.PGComboBoxEditor.GetName`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.PGComboBoxEditor(PGChoiceEditor)
**Possible constructors**::
PGComboBoxEditor()
.. method:: __init__(self)
.. method:: CreateControls(self, propgrid, property, pos, size)
Instantiates editor controls.
:param `propgrid`: :ref:`wx.propgrid.PropertyGrid` to which the property belongs (use as parent for control).
:type `propgrid`: wx.propgrid.PropertyGrid
:param `property`: Property for which this method is called.
:type `property`: wx.propgrid.PGProperty
:param `pos`: Position, inside :ref:`wx.propgrid.PropertyGrid`, to create control(s) to.
:type `pos`: wx.Point
:param `size`: Initial size for control(s).
:type `size`: wx.Size
:rtype: :ref:`wx.propgrid.PGWindowList`
.. note::
- Primary control shall use id ``PG_SUBID1``, and secondary (button) control shall use ``PG_SUBID2``.
- Unlike in previous version of :ref:`wx.propgrid.PropertyGrid`, it is no longer necessary to call :meth:`wx.EvtHandler.Connect` for interesting editor events. Instead, all events from control are now automatically forwarded to :meth:`wx.propgrid.PGEditor.OnEvent` and :meth:`wx.propgrid.PGProperty.OnEvent` .
.. method:: GetName(self)
Returns pointer to the name of the editor.
For example, PGEditor_TextCtrl has name "TextCtrl". If you dont' need to access your custom editor by string name, then you do not need to implement this function.
:rtype: `string`
.. method:: GetValueFromControl(self, variant, property, ctrl)
Returns value from control, via parameter 'variant'.
Usually ends up calling property's StringToValue() or IntToValue(). Returns ``True`` if value was different.
:param `variant`:
:type `variant`: PGVariant
:param `property`:
:type `property`: wx.propgrid.PGProperty
:param `ctrl`:
:type `ctrl`: wx.Window
:rtype: `bool`
.. method:: OnEvent(self, propgrid, property, wnd_primary, event)
Handles events.
Returns ``True`` if value in control was modified (see :meth:`wx.propgrid.PGProperty.OnEvent` for more information).
:param `propgrid`:
:type `propgrid`: wx.propgrid.PropertyGrid
:param `property`:
:type `property`: wx.propgrid.PGProperty
:param `wnd_primary`:
:type `wnd_primary`: wx.Window
:param `event`:
:type `event`: wx.Event
:rtype: `bool`
.. note::
:ref:`wx.propgrid.PropertyGrid` will automatically unfocus the editor when ``wxEVT_TEXT_ENTER`` is received and when it results in property value being modified. This happens regardless of editor type (ie. behaviour is same for any :ref:`wx.TextCtrl` and :ref:`wx.ComboBox` based editor).
.. method:: OnFocus(self, property, wnd)
Extra processing when control gains focus.
For example, :ref:`wx.TextCtrl` based controls should select all text.
:param `property`:
:type `property`: wx.propgrid.PGProperty
:param `wnd`:
:type `wnd`: wx.Window
.. method:: UpdateControl(self, property, ctrl)
Loads value from property to the control.
:param `property`:
:type `property`: wx.propgrid.PGProperty
:param `ctrl`:
:type `ctrl`: wx.Window
.. attribute:: Name
See :meth:`~wx.propgrid.PGComboBoxEditor.GetName`
|
