Phoenix Logo

phoenix_title wx.propgrid.ColourProperty


class_hierarchy Class Hierarchy

Inheritance diagram for class ColourProperty:


method_summary Methods Summary

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

api Class API



class wx.propgrid.ColourProperty(SystemColourProperty)

Possible constructors:

ColourProperty(label=PG_LABEL, name=PG_LABEL, value=WHITE)

Methods



__init__(self, label=PG_LABEL, name=PG_LABEL, value=WHITE)
Parameters:
  • label (string) –
  • name (string) –
  • value (wx.Colour) –


GetColour(self, index)

Default is to use SystemSettings.GetColour(index).

Override to use custom colour tables etc.

Parameters:index (int) –
Return type:Colour


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 .