Phoenix Logo

phoenix_title wx.propgrid.PropertyCategory

Category (caption) property.


class_hierarchy Class Hierarchy

Inheritance diagram for class PropertyCategory:


method_summary Methods Summary

__init__ Default constructor is only used in special cases.
GetTextExtent  
GetValueAsString Returns text representation of property’s value.
ValueToString Converts property value into a text representation.

property_summary Properties Summary

ValueAsString See GetValueAsString

api Class API



class wx.propgrid.PropertyCategory(PGProperty)

Possible constructors:

PropertyCategory()

PropertyCategory(label, name=PG_LABEL)

Category (caption) property.


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor is only used in special cases.



__init__ (self, label, name=PG_LABEL)

Parameters:
  • label (string) –
  • name (string) –





GetTextExtent(self, wnd, font)
Parameters:
Return type:

int



GetValueAsString(self, argFlags=0)

Returns text representation of property’s value.

Parameters: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

In older versions, this function used to be overridden to convert property’s value into a string representation. This function is now handled by ValueToString , and overriding this function now will result in run-time assertion failure.



ValueToString(self, value, argFlags)

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 .


Properties



ValueAsString

See GetValueAsString