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
|
.. 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.DirProperty:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.DirProperty**
==========================================================================================================================================
Like :ref:`wx.propgrid.LongStringProperty`, but the button triggers dir selector instead.
**Supported special attributes:**
- "DialogMessage": Sets specific message in the dir selector.
|
|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>DirProperty</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.DirProperty_inheritance.png" alt="Inheritance diagram of DirProperty" 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="75,5,156,35"/> <area shape="rect" id="node3" href="wx.propgrid.PGProperty.html" title="wx.propgrid.PGProperty" alt="" coords="31,83,201,112"/> <area shape="rect" id="node2" href="wx.propgrid.LongStringProperty.html" title="wx.propgrid.LongStringProperty" alt="" coords="5,160,227,189"/> <area shape="rect" id="node4" href="wx.propgrid.DirProperty.html" title="wx.propgrid.DirProperty" alt="" coords="31,237,201,267"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.DirProperty.__init__`
:meth:`~wx.propgrid.DirProperty.DoGetValidator` Returns pointer to the :ref:`wx.Validator` that should be used with the editor of this property (``None`` for no validator).
:meth:`~wx.propgrid.DirProperty.DoSetAttribute` Reimplement this member function to add special handling for attributes of this property.
:meth:`~wx.propgrid.DirProperty.OnButtonClick`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.DirProperty(LongStringProperty)
**Possible constructors**::
DirProperty(name=PG_LABEL, label=PG_LABEL, value="")
Like LongStringProperty, but the button triggers dir selector
instead.
.. method:: __init__(self, name=PG_LABEL, label=PG_LABEL, value=EmptyString)
:param `name`:
:type `name`: string
:param `label`:
:type `label`: string
:param `value`:
:type `value`: string
.. method:: DoGetValidator(self)
Returns pointer to the :ref:`wx.Validator` that should be used with the editor of this property (``None`` for no validator).
Setting validator explicitly via SetPropertyValidator will override this.
In most situations, code like this should work well (macros are used to maintain one actual validator instance, so on the second call the function exits within the first macro):
::
class MyPropertyClass(wx.propgrid.DirProperty):
...
def DoGetValidator(self):
validator = MyValidator(...)
... prepare validator...
return validator
:rtype: :ref:`Validator`
.. note::
You can get common filename validator by returning :meth:`wx.propgrid.FileProperty.GetClassValidator` . :ref:`wx.propgrid.DirProperty`, for example, uses it.
.. 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:: OnButtonClick(self, propGrid, value)
:param `propGrid`:
:type `propGrid`: wx.propgrid.PropertyGrid
:param `value`:
:type `value`: string
:rtype: `tuple`
:returns:
( `bool`, `value` )
|
