wx.propgrid.FontProperty

Property representing wx.Font.

Supported special attributes:

• PG_DIALOG_TITLE: Sets a specific title for the font dialog (since 3.1.3).

Class Hierarchy

Inheritance diagram for class FontProperty:

Methods Summary

__init__
ChildChanged	Called after value of a child property has been altered.
DisplayEditorDialog	Shows editor dialog.
OnSetValue	This virtual function is called after m_value has been set.
RefreshChildren	Refresh values of child properties.
ValueToString	Converts property value into a text representation.

Class API

class wx.propgrid.FontProperty(EditorDialogProperty)

Possible constructors:

FontProperty(label=PG_LABEL, name=PG_LABEL, value=Font())

Property representing Font.

Methods

__init__(self, label=PG_LABEL, name=PG_LABEL, value=Font())

Parameters:

• label (string) –

• name (string) –

• value (wx.Font) –

---

ChildChanged(self, thisValue, childIndex, childValue)

Called after value of a child property has been altered.

Must return new value of the whole property (after any alterations warranted by child’s new value).

Note that this function is usually called at the time that value of this property, or given child property, is still pending for change, and as such, result of GetValue or m_value should not be relied on.

Sample pseudo-code implementation:

# TBW

Parameters:

• thisValue (PGVariant) – Value of this property. Changed value should be returned (in previous versions of wx.propgrid.PropertyGrid it was only necessary to write value back to this argument).

• childIndex (int) – Index of child changed (you can use Item(childIndex) to get child property).

• childValue (PGVariant) – (Pending) value of the child property.

Return type:

PGVariant

Returns:

Modified value of the whole property.

---

DisplayEditorDialog(self, pg, value)

Shows editor dialog.

Value to be edited should be read from value, and if dialog is not cancelled, it should be stored back and True should be returned.

Parameters:

• pg (wx.propgrid.PropertyGrid) – Property grid in which property is displayed.

• value (PGVariant) – Value to be edited.

Return type:

tuple

Returns:

( bool, value )

---

OnSetValue(self)

This virtual function is called after m_value has been set.

Note

• If m_value was set to Null variant (i.e. unspecified value), OnSetValue will not be called.

• m_value may be of any variant type. Typically properties internally support only one variant type, and as such OnSetValue provides a good opportunity to convert supported values into internal type.

• Default implementation does nothing.

---

RefreshChildren(self)

Refresh values of child properties.

Automatically called after value is set.

---

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

string

Note

Default implementation calls GenerateComposedValue .