wx.propgrid.ColourProperty

Allows to select a colour from the list or with colour dialog.

Value used is of wx.propgrid.ColourPropertyValue type.

Supported special attributes: PG_COLOUR_ALLOW_CUSTOM, PG_COLOUR_HAS_ALPHA

Class Hierarchy

Inheritance diagram for class ColourProperty:

Methods Summary

__init__
GetColour	Default is to use SystemSettings.GetColour(index).
ValueToString	Converts property value into a text representation.

Class API

class wx.propgrid.ColourProperty(SystemColourProperty)

Possible constructors:

ColourProperty(label: str=PG_LABEL, name: str=PG_LABEL, value:
               Colour=WHITE) -> None

Allows to select a colour from the list or with colour dialog.

Methods

__init__(self, label: str = PG_LABEL, name: str = PG_LABEL, value: Colour = WHITE)

Parameters:

• label (string)

• name (string)

• value (wx.Colour)

Return type:

None

---

GetColour(self, index: int)

Default is to use SystemSettings.GetColour(index).

Override to use custom colour tables etc.

Parameters:

index (int)

Return type:

Colour

---

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 .