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
|
.. 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.StringProperty:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.StringProperty**
==========================================================================================================================================
Basic property with string value.
**Supported special attributes:**
- "Password": set to 1 in order to enable ``wx.TE_PASSWORD`` on the editor.
.. note::
- If value "<composed>" is set, then actual value is formed (or composed) from values of child properties.
|
|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>StringProperty</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.StringProperty_inheritance.png" alt="Inheritance diagram of StringProperty" 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.Object.html" title="wx.Object" alt="" coords="59,5,140,35"/> <area shape="rect" id="node3" href="wx.propgrid.PGProperty.html" title="wx.propgrid.PGProperty" alt="" coords="15,83,185,112"/> <area shape="rect" id="node2" href="wx.propgrid.StringProperty.html" title="wx.propgrid.StringProperty" alt="" coords="5,160,195,189"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.StringProperty.__init__`
:meth:`~wx.propgrid.StringProperty.DoSetAttribute` Reimplement this member function to add special handling for attributes of this property.
:meth:`~wx.propgrid.StringProperty.OnSetValue` This is updated so "<composed>" special value can be handled.
:meth:`~wx.propgrid.StringProperty.StringToValue` Converts text into :ref:`Variant` value appropriate for this property.
:meth:`~wx.propgrid.StringProperty.ValueToString` Converts property value into a text representation.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.StringProperty(PGProperty)
**Possible constructors**::
StringProperty(label=PG_LABEL, name=PG_LABEL, value="")
Basic property with string value.
.. method:: __init__(self, label=PG_LABEL, name=PG_LABEL, value=EmptyString)
:param `label`:
:type `label`: string
:param `name`:
:type `name`: string
:param `value`:
:type `value`: string
.. 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:: OnSetValue(self)
This is updated so "<composed>" special value can be handled.
.. method:: StringToValue(self, text, argFlags=0)
Converts text into :ref:`Variant` value appropriate for this property.
:param `text`: Text to be translated into variant.
:type `text`: string
:param `argFlags`: If ``wx.propgrid.PG_FULL_VALUE`` is set, returns complete, storable value instead of displayable one (they may be different). If ``wx.propgrid.PG_COMPOSITE_FRAGMENT`` is set, text is interpreted as a part of composite property string value (as generated by :meth:`ValueToString` called with this same flag).
:type `argFlags`: int
:rtype: `tuple`
You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
:returns:
( `bool`, `variant` )
.. note::
Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.
.. method:: ValueToString(self, value, argFlags=0)
Converts property value into a text representation.
:param `value`: Value to be converted.
:type `value`: PGVariant
:param `argFlags`: If 0 (default value), then displayed string is returned. If ``wx.propgrid.PG_FULL_VALUE`` is set, returns complete, storable string value instead of displayable. If ``wx.propgrid.PG_EDITABLE_VALUE`` is set, returns string value that must be editable in textctrl. If ``wx.propgrid.PG_COMPOSITE_FRAGMENT`` is set, returns text that is appropriate to display as a part of string property's composite text representation.
:type `argFlags`: int
:rtype: `string`
.. note::
Default implementation calls :meth:`GenerateComposedValue` .
|
