wx.propgrid.PropertyCategory

Category (caption) property.

Class Hierarchy

Inheritance diagram for class PropertyCategory:

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.

Properties Summary

ValueAsString

See GetValueAsString

Class API

class wx.propgrid.PropertyCategory(PGProperty)

Possible constructors:

PropertyCategory() -> None

PropertyCategory(label, name=PG_LABEL) -> None

Category (caption) property.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor is only used in special cases.

Return type:

None

---

__init__ (self, label, name=PG_LABEL)

Parameters:

• label (string)

• name (string)

Return type:

None

---

---

GetTextExtent(self, wnd, font)

Parameters:

• wnd (wx.Window)

• font (wx.Font)

Return type:

int

---

GetValueAsString(self, flags=PGPropValFormatFlags.Null)

Returns text representation of property’s value.

Parameters:

flags (PGPropValFormatFlags) – If wx.propgrid.PGPropValFormatFlags.Null (default value), then displayed string is returned. If wx.propgrid.PGPropValFormatFlags.FullValue is set, returns complete, storable string value instead of displayable. If wx.propgrid.PGPropValFormatFlags.EditableValue is set, returns string value that must be editable in textctrl. If wx.propgrid.PGPropValFormatFlags.CompositeFragment is set, returns text that is appropriate to display as a part of string property’s composite text representation.

Return type:

str

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, flags)

Converts property value into a text representation.

Parameters:

• value (PGVariant) – Value to be converted.

• flags (PGPropValFormatFlags) – If wx.propgrid.PGPropValFormatFlags.Null (default value), then displayed string is returned. If wx.propgrid.PGPropValFormatFlags.FullValue is set, returns complete, storable string value instead of displayable. If wx.propgrid.PGPropValFormatFlags.EditableValue is set, returns string value that must be editable in textctrl. If wx.propgrid.PGPropValFormatFlags.CompositeFragment 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

ValueAsString

See GetValueAsString