Navigation

phoenix_title wx.propgrid.ArrayStringProperty

Property that manages a list of strings.


class_hierarchy Class Hierarchy

Inheritance diagram for class ArrayStringProperty:

method_summary Methods Summary

__init__

ArrayStringToString

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

ConvertArrayToString

CreateEditorDialog

DoSetAttribute

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

GenerateValueAsString

OnButtonClick

OnCustomStringEdit

OnEvent

Events received by editor widgets are processed here.

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(PGProperty)

Possible constructors:

ArrayStringProperty(label=PG_LABEL, name=PG_LABEL, value=[])

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) –


static ArrayStringToString(dst, src, delimiter, flags)

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

Parameters

  • dst (string) –

  • src (list of strings) –

  • delimiter (wx.UniChar) –

  • flags (int) –


ConvertArrayToString(self, arr, pString, delimiter)
Parameters

  • arr (list of strings) –

  • pString (string) –

  • delimiter (wx.UniChar) –


CreateEditorDialog(self)
Return type

wx.propgrid.PGArrayEditorDialog


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)

OnButtonClick(self, propgrid, primary, cbt)
Parameters
Return type

bool


OnCustomStringEdit(self, parent, value)
Parameters
Return type

bool


OnEvent(self, propgrid, wnd_primary, event)

Events received by editor widgets are processed here.

Note that editor class usually processes most events. Some, such as button press events of TextCtrlAndButton class, can be handled here. Also, if custom handling for regular events is desired, then that can also be done (for example, wx.propgrid.SystemColourProperty custom handles wxEVT_CHOICE to display colour picker dialog when ‘custom’ selection is made).

If the event causes value to be changed, SetValueInEvent should be called to set the new value.

The parameter event is the associated wx.Event.

Parameters

return True if any changes in value should be reported.

Return type

bool

Note

  • If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.


OnSetValue(self)

This virtual function is called after m_value has been set.

Note

  • If m_value was set to Null variant (ie. 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 wx.propgrid.PG_FULL_VALUE is set, returns complete, storable value instead of displayable one (they may be different). If wx.propgrid.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 wx.propgrid.PG_FULL_VALUE is set, returns complete, storable string value instead of displayable. If wx.propgrid.PG_EDITABLE_VALUE is set, returns string value that must be editable in textctrl. If wx.propgrid.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 .