wx.propgrid.DirProperty

Like wx.propgrid.LongStringProperty, but the button triggers directory selector instead.

Supported special attributes:

• PG_DIALOG_TITLE: Sets a specific title for the file dialog (since 3.1.3).

Class Hierarchy

Inheritance diagram for class DirProperty:

Methods Summary

__init__
DisplayEditorDialog	Shows editor dialog.
DoGetValidator	Returns pointer to the wx.Validator that should be used with the editor of this property (None for no validator).
StringToValue	Converts text into Variant value appropriate for this property.
ValueToString	Converts property value into a text representation.

Class API

class wx.propgrid.DirProperty(EditorDialogProperty)

Possible constructors:

DirProperty(label=PG_LABEL, name=PG_LABEL, value='') -> None

Like LongStringProperty, but the button triggers directory selector instead.

Methods

__init__(self, label=PG_LABEL, name=PG_LABEL, value='')

Parameters:

• label (string)

• name (string)

• value (string)

Return type:

None

---

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.

Parameters:

• pg (wx.propgrid.PropertyGrid) – Property grid in which property is displayed.

• value (PGVariant) – Value to be edited.

Return type:

Tuple[bool, PGVariant]

Returns:

Returns True if editor dialog was not cancelled and value was updated.

---

DoGetValidator(self)

Returns pointer to the 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

Return type:

Validator

Note

You can get common filename validator by returning wx.propgrid.FileProperty.GetClassValidator . wx.propgrid.DirProperty, for example, uses it.

---

StringToValue(self, text, argFlags=0)

Converts text into Variant value appropriate for this property.

Parameters:

• text (string) – Text to be translated into variant.

• argFlags (int) – If PG_FULL_VALUE is set, returns complete, storable value instead of displayable one (they may be different). If PG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of composite property string value (as generated by ValueToString called with this same flag).

Return type:

Tuple[bool, PGVariant]

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:

Returns True if resulting Variant value was different.

Note

Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.

---

ValueToString(self, value, argFlags=0)

Converts property value into a text representation.

Parameters:

• value (PGVariant) – Value to be converted.

• argFlags (int) – If 0 (default value), then displayed string is returned. If PG_FULL_VALUE is set, returns complete, storable string value instead of displayable. If PG_EDITABLE_VALUE is set, returns string value that must be editable in textctrl. If PG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to display as a part of string property’s composite text representation.

Return type:

str

Note

Default implementation calls GenerateComposedValue .