phoenix_title wx.propgrid.ArrayStringProperty

Property that manages a list of strings.

Supported special attributes:

  • PG_ARRAY_DELIMITER: Sets string delimiter character.

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


class_hierarchy Class Hierarchy

Inheritance diagram of ArrayStringProperty


method_summary Methods Summary

__init__

ArrayStringToString

Generates string based on the contents of list of strings src.

ConvertArrayToString

Implement in derived class for custom array-to-string conversion.

CreateEditorDialog

Creates wx.propgrid.PGArrayEditorDialog for string editing.

DisplayEditorDialog

Shows editor dialog.

DoSetAttribute

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

GenerateValueAsString

Previously this was to be implemented in derived class for array-to- string conversion.

OnCustomStringEdit

Shows string editor dialog to edit the individual item.

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.

api Class API

class wx.propgrid.ArrayStringProperty(EditorDialogProperty)

Possible constructors:

ArrayStringProperty(label=PG_LABEL, name=PG_LABEL, value=[]) -> None

Property that manages a list of strings.


Methods

__init__(self, label=PG_LABEL, name=PG_LABEL, value=[])
Parameters:

  • label (string)

  • name (string)

  • value (list of strings)

Return type:

None


static ArrayStringToString(src, delimiter, flags)

Generates string based on the contents of list of strings src.

Parameters:

  • src (list of strings)

  • delimiter (wx.UniChar)

  • flags (int)

Return type:

str


ConvertArrayToString(self, arr, delimiter)

Implement in derived class for custom array-to-string conversion.

Parameters:
Return type:

str


CreateEditorDialog(self)

Creates wx.propgrid.PGArrayEditorDialog for string editing.

Return type:

wx.propgrid.PGArrayEditorDialog


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.


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.


GenerateValueAsString(self)

Previously this was to be implemented in derived class for array-to- string conversion.

Now you should implement ConvertValueToString() instead.

Return type:

None


OnCustomStringEdit(self, parent, value)

Shows string editor dialog to edit the individual item.

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 if that was the case.

Parameters:
Return type:

bool


OnSetValue(self)

This virtual function is called after m_value has been set.

Return type:

None

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[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 .