Navigation

phoenix_title wx.propgrid.FileProperty

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

Supported special attributes:

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

  • PG_FILE_DIALOG_STYLE: Sets a specific wx.FileDialog style for the file dialog (since 2.9.4).

  • PG_FILE_WILDCARD: Sets wildcard (see wx.FileDialog for format details), “All files…” is default.

  • PG_FILE_SHOW_FULL_PATH: Default True. When False, only the file name is shown (i.e. drive and directory are hidden).

  • PG_FILE_SHOW_RELATIVE_PATH: If set, then the filename is shown relative to the given path string.

  • PG_FILE_INITIAL_PATH: Sets the initial path of where to look for files.


class_hierarchy Class Hierarchy

Inheritance diagram for class FileProperty:

method_summary 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).

DoSetAttribute

Reimplement this member function to add special handling for attributes of this property.

GetClassValidator

GetFileName

Returns filename to file represented by current value.

OnSetValue

This virtual function is called after m_value has been set.

StringToValue

Converts text into Variant value appropriate for this property.

ValueToString

Converts property value into a text representation.

property_summary Properties Summary

FileName

See GetFileName

api Class API

class wx.propgrid.FileProperty(EditorDialogProperty)

Possible constructors:

FileProperty(label=PG_LABEL, name=PG_LABEL, value="")

Like LongStringProperty, but the button triggers file selector instead.


Methods

__init__(self, label=PG_LABEL, name=PG_LABEL, value="")
Parameters

  • label (string) –

  • name (string) –

  • value (string) –


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

Returns

( bool, value )


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.FileProperty):
    ...
    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.


DoSetAttribute(self, name, value)

Reimplement this member function to add special handling for attributes of this property.

Parameters

  • name (string) –

  • value (PGVariant) –

Return type

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 wx.propgrid.PGProperty.SetAttribute instead.


static GetClassValidator()
Return type

Validator


GetFileName(self)

Returns filename to file represented by current value.

Return type

string


OnSetValue(self)

This virtual function is called after m_value has been set.

Note

  • If m_value was set to Null variant (i.e. unspecified value), OnSetValue will not be called.

  • m_value may be of any variant type. Typically properties internally support only one variant type, and as such OnSetValue provides a good opportunity to convert supported values into internal type.

  • Default implementation does nothing.


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

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.


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

string

Note

Default implementation calls GenerateComposedValue .


Properties

FileName

See GetFileName