wx.propgrid.BoolProperty

Basic property with boolean value.

Supported special attributes:

• PG_BOOL_USE_CHECKBOX: Set to True to use check box editor instead of combo box.

• PG_BOOL_USE_DOUBLE_CLICK_CYCLING: Set to True to cycle combo box instead showing the list.

Class Hierarchy

Inheritance diagram for class BoolProperty:

Methods Summary

__init__
DoSetAttribute	Reimplement this member function to add special handling for attributes of this property.
IntToValue	Converts integer (possibly a choice selection) into Variant value appropriate for this property.
StringToValue	Converts text into Variant value appropriate for this property.
ValueToString	Converts property value into a text representation.

Class API

class wx.propgrid.BoolProperty(PGProperty)

Possible constructors:

BoolProperty(label: str=PG_LABEL, name: str=PG_LABEL, value: bool=False)
             -> None

Basic property with boolean value.

Methods

__init__(self, label: str=PG_LABEL, name: str=PG_LABEL, value: bool=False)

Parameters:

• label (string) –

• name (string) –

• value (bool) –

Return type:

None

---

DoSetAttribute(self, name : str, value : PGVariant)

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.

---

IntToValue(self, number : int, argFlags: int=0)

Converts integer (possibly a choice selection) into Variant value appropriate for this property.

Parameters:

• number (int) – Integer to be translated into variant.

• argFlags (int) – If PG_FULL_VALUE is set, returns complete, storable value instead of displayable one.

Return type:

Tuple[bool, PGVariant]

Returns:

Returns True if resulting Variant value was different.

Note

• If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.

• Default implementation simply assign given int to m_value.

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

• You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).

---

StringToValue(self, text : str, argFlags: int=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 : PGVariant, argFlags: int=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 .