***********
wx.FontData
***********

Inheritance diagram for `wx.FontData`:

|

.. inheritance-diagram:: wx.FontData

|

Description
===========

This class holds a variety of information related to font dialogs.

.. seealso:: `wx.Font <wx.Font.html>`_, `wx.FontDialog <wx.FontDialog.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.Object <wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `EnableEffects <#EnableEffects>`_ 
* `GetAllowSymbols <#GetAllowSymbols>`_ 
* `GetChosenFont <#GetChosenFont>`_ 
* `GetColour <#GetColour>`_ 
* `GetEnableEffects <#GetEnableEffects>`_ 
* `GetInitialFont <#GetInitialFont>`_ 
* `GetShowHelp <#GetShowHelp>`_ 
* `SetAllowSymbols <#SetAllowSymbols>`_ 
* `SetChosenFont <#SetChosenFont>`_ 
* `SetColour <#SetColour>`_ 
* `SetInitialFont <#SetInitialFont>`_ 
* `SetRange <#SetRange>`_ 
* `SetShowHelp <#SetShowHelp>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `AllowSymbols <#AllowSymbols>`_ 
* `ChosenFont <#ChosenFont>`_ 
* `Colour <#Colour>`_ 
* `InitialFont <#InitialFont>`_ 
* `ShowHelp <#ShowHelp>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   This class holds a variety of information related to font dialogs and
   is used to transfer settings to and results from a `wx.FontDialog <wx.FontDialog.html>`_ .
   
   Initializes `fontColour` to black, `showHelp` to ``False``, `allowSymbols` to ``True``, `enableEffects` to ``True``, 
   `minSize` to 0 and `maxSize` to 0.

   |

   **Returns:**

   `wx.FontData <wx.FontData.html>`_
 

--------

.. method:: EnableEffects(enable)

   Enables or disables 'effects' under MS Windows or generic only. This refers to the controls for manipulating 
   colour, strikeout and underline properties.

   The default value is ``True``.

   **Parameters:**

   * `enable` (bool) 

--------

.. method:: GetAllowSymbols()

   Under MS Windows, returns a flag determining whether symbol fonts can be selected. Has no effect on other platforms.

   The default value is ``True``.

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetChosenFont()

   Gets the font chosen by the user if the user pressed ``OK`` (`wx.FontDialog.ShowModal <wx.FontDialog.html#ShowModal>`_ returned ``wx.ID_OK``).

   |  

   **Returns:**

   `wx.Font <wx.Font.html>`_
 

--------

.. method:: GetColour()

   Gets the colour associated with the font dialog.

   The default value is black.

   |  

   **Returns:**

   `wx.Colour <wx.Colour.html>`_
 

--------

.. method:: GetEnableEffects()

   Determines whether 'effects' are enabled under Windows. This refers to the controls for manipulating colour, 
   strikeout and underline properties.

   The default value is ``True``.

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetInitialFont()

   Gets the font that will be initially used by the font dialog. This should have previously been set by the application.

   |  

   **Returns:**

   `wx.Font <wx.Font.html>`_
 

--------

.. method:: GetShowHelp()

   Returns ``True`` if the Help button will be shown (Windows only).

   The default value is ``False``.

   |  

   **Returns:**

   `bool` 

--------

.. method:: SetAllowSymbols(allowSymbols)

   Under MS Windows, determines whether symbol fonts can be selected. Has no effect on other platforms.

   The default value is ``True``.

   **Parameters:**

   * `allowSymbols` (bool) 

--------

.. method:: SetChosenFont(font)

   Sets the font that will be returned to the user (for internal use only).

   **Parameters:**

   * `font` (`wx.Font <wx.Font.html>`_) 

--------

.. method:: SetColour(colour)

   Sets the colour that will be used for the font foreground colour.

   The default colour is black.

   **Parameters:**

   * `colour` (`wx.Colour <wx.Colour.html>`_) 

--------

.. method:: SetInitialFont(font)

   Sets the font that will be initially used by the font dialog.

   **Parameters:**

   * `font` (`wx.Font <wx.Font.html>`_) 

--------

.. method:: SetRange(min, max)

   Sets the valid range for the font point size (Windows only).

   The default is 0, 0 (unrestricted range).

   **Parameters:**

   * `min` (int) 
   * `max` (int) 

--------

.. method:: SetShowHelp(showHelp)

   Determines whether the Help button will be displayed in the font dialog (Windows only).

   The default value is ``False``.

   **Parameters:**

   * `showHelp` (bool) 

--------

Properties
^^^^^^^^^^


.. attribute:: AllowSymbols

   See `GetAllowSymbols <#GetAllowSymbols>`_ and `SetAllowSymbols <#SetAllowSymbols>`_

.. attribute:: ChosenFont

   See `GetChosenFont <#GetChosenFont>`_ and `SetChosenFont <#SetChosenFont>`_

.. attribute:: Colour

   See `GetColour <#GetColour>`_ and `SetColour <#SetColour>`_

.. attribute:: InitialFont

   See `GetInitialFont <#GetInitialFont>`_ and `SetInitialFont <#SetInitialFont>`_

.. attribute:: ShowHelp

   See `GetShowHelp <#GetShowHelp>`_ and `SetShowHelp <#SetShowHelp>`_