.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.propgrid.FontProperty:
==========================================================================================================================================
|phoenix_title| **wx.propgrid.FontProperty**
==========================================================================================================================================
Property representing :ref:`wx.Font`.
**Supported special attributes:**
- ``PG_DIALOG_TITLE``: Sets a specific title for the font dialog (since 3.1.3).
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>FontProperty</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.propgrid.FontProperty_inheritance.svg" alt="Inheritance diagram of FontProperty" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.propgrid.FontProperty.html" title="Property representing wx.Font." alt="" coords="34,236,242,265"/> <area shape="rect" id="node2" href="wx.propgrid.EditorDialogProperty.html" title="This is an abstract class which serves as a base class for the properties having a button triggering an editor dialog, like e.g." alt="" coords="5,159,270,188"/> <area shape="rect" id="node3" href="wx.propgrid.PGProperty.html" title="wx.propgrid.PGProperty is base class for all wx.propgrid.PropertyGrid properties and as such it is not intended to be instantiated directly." alt="" coords="38,82,237,111"/> <area shape="rect" id="node4" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="88,5,187,34"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.propgrid.FontProperty.__init__`
:meth:`~wx.propgrid.FontProperty.ChildChanged` Called after value of a child property has been altered.
:meth:`~wx.propgrid.FontProperty.DisplayEditorDialog` Shows editor dialog.
:meth:`~wx.propgrid.FontProperty.OnSetValue` This virtual function is called after m_value has been set.
:meth:`~wx.propgrid.FontProperty.RefreshChildren` Refresh values of child properties.
:meth:`~wx.propgrid.FontProperty.ValueToString` Converts property value into a text representation.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.propgrid.FontProperty(EditorDialogProperty)
**Possible constructors**::
FontProperty(label=PG_LABEL, name=PG_LABEL, value=Font()) -> None
Property representing Font.
.. method:: __init__(self, label=PG_LABEL, name=PG_LABEL, value=Font())
:param `label`:
:type `label`: string
:param `name`:
:type `name`: string
:param `value`:
:type `value`: wx.Font
:rtype: `None`
.. method:: 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 :meth:`GetValue` or m_value should not be relied on.
Sample pseudo-code implementation:
::
# TBW
:param `thisValue`: Value of this property. Changed value should be returned (in previous versions of :ref:`wx.propgrid.PropertyGrid` it was only necessary to write value back to this argument).
:type `thisValue`: PGVariant
:param `childIndex`: Index of child changed (you can use Item(childIndex) to get child property).
:type `childIndex`: int
:param `childValue`: (Pending) value of the child property.
:type `childValue`: PGVariant
:rtype: `PGVariant`
:returns:
Modified value of the whole property.
.. method:: 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.
:param `pg`: Property grid in which property is displayed.
:type `pg`: wx.propgrid.PropertyGrid
:param `value`: Value to be edited.
:type `value`: PGVariant
:rtype: :ref:`Tuple[bool, PGVariant]`
:returns:
Returns ``True`` if editor dialog was not cancelled and `value` was updated.
.. method:: OnSetValue(self)
This virtual function is called after m_value has been set.
:rtype: `None`
.. note::
- If m_value was set to Null variant (i.e. unspecified value), :meth:`OnSetValue` will not be called.
- m_value may be of any variant type. Typically properties internally support only one variant type, and as such :meth:`OnSetValue` provides a good opportunity to convert supported values into internal type.
- Default implementation does nothing.
.. method:: RefreshChildren(self)
Refresh values of child properties.
Automatically called after value is set.
:rtype: `None`
.. method:: ValueToString(self, value, argFlags=0)
Converts property value into a text representation.
:param `value`: Value to be converted.
:type `value`: PGVariant
:param `argFlags`: 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.
:type `argFlags`: int
:rtype: `str`
.. note::
Default implementation calls :meth:`GenerateComposedValue` .