wx.propgrid.MultiChoiceProperty

Property that manages a value resulting from wx.MultiChoiceDialog.

Value is array of strings. You can get value as array of choice values/indices by calling wx.propgrid.MultiChoiceProperty.GetValueAsArrayInt .

Supported special attributes:

• PG_ATTR_MULTICHOICE_USERSTRINGMODE: If > 0, allow user to manually enter strings that are not in the list of choices. If this value is 1, user strings are preferably placed in front of valid choices. If value is 2, then those strings will placed behind valid choices.

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

Class Hierarchy

Inheritance diagram for class MultiChoiceProperty:

Methods Summary

__init__
DisplayEditorDialog	Shows editor dialog.
GetValueAsArrayInt
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.

Properties Summary

ValueAsArrayInt

See GetValueAsArrayInt

Class API

class wx.propgrid.MultiChoiceProperty(EditorDialogProperty)

Possible constructors:

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

MultiChoiceProperty(label, name, choices, value=[]) -> None

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

Property that manages a value resulting from MultiChoiceDialog.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

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

Parameters:

• label (string)

• name (string)

• choices (list of strings)

• value (list of strings)

Return type:

None

---

__init__ (self, label, name, choices, value=[])

Parameters:

• label (string)

• name (string)

• choices (wx.propgrid.PGChoices)

• value (list of strings)

Return type:

None

---

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

Parameters:

• label (string)

• name (string)

• value (list of strings)

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.

---

GetValueAsArrayInt(self)

Return type:

List[int]

---

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 .

Properties

ValueAsArrayInt

See GetValueAsArrayInt