phoenix_title wx.propgrid.StringProperty

Basic property with string value.

Supported special attributes:

  • PG_STRING_PASSWORD: set to True in order to enable 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

Inheritance diagram for class StringProperty:

method_summary Methods Summary

__init__

DoSetAttribute

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

OnSetValue

This is updated so “<composed>” special value can be handled.

StringToValue

Converts text into Variant value appropriate for this property.

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.


Methods

__init__(self, label=PG_LABEL, name=PG_LABEL, value="")
Parameters:
  • label (string) –

  • name (string) –

  • value (string) –



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.



OnSetValue(self)

This is updated so “<composed>” special value can be handled.



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 .