*************
wx.FontMapper
*************

Inheritance diagram for `wx.FontMapper`:

|

.. inheritance-diagram:: wx.FontMapper

|

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

`wx.FontMapper` manages user-definable correspondence between logical font names and the fonts present on the machine.

The default implementations of all functions will ask the user if they are not capable of finding the answer themselves 
and store the answer in a config file (configurable via `SetConfigXXX` functions). This behaviour may be disabled by giving 
the value of ``False`` to `interactive` parameter.

However, the functions will always consult the config file to allow the user-defined values override the default logic and 
there is no way to disable this - which shouldn't be ever needed because if `interactive` was never ``True``, the config 
file is never created anyhow.

In case everything else fails (i.e. there is no record in config file and `interactive` is ``False`` or user denied to 
choose any replacement), the class queries `wx.EncodingConverter <wx.EncodingConverter.html>`_ for "equivalent" encodings 
(e.g. iso8859-2 and cp1250) and tries them.


.. seealso:: `wx.EncodingConverter <wx.EncodingConverter.html>`_ 


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

* `__init__ <#__init__>`_ 
* `CharsetToEncoding <#CharsetToEncoding>`_ 
* `Get <#Get>`_ 
* `GetAltForEncoding <#GetAltForEncoding>`_ 
* `GetDefaultConfigPath <#GetDefaultConfigPath>`_ 
* `GetEncoding <#GetEncoding>`_ 
* `GetEncodingDescription <#GetEncodingDescription>`_ 
* `GetEncodingFromName <#GetEncodingFromName>`_ 
* `GetEncodingName <#GetEncodingName>`_ 
* `GetSupportedEncodingsCount <#GetSupportedEncodingsCount>`_ 
* `IsEncodingAvailable <#IsEncodingAvailable>`_ 
* `Set <#Set>`_ 
* `SetConfigPath <#SetConfigPath>`_ 
* `SetDialogParent <#SetDialogParent>`_ 
* `SetDialogTitle <#SetDialogTitle>`_ 

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

* `AltForEncoding <#AltForEncoding>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   `No docstrings available for this method.` 

--------


.. method:: CharsetToEncoding(charset, interactive=True)

   Returns the encoding for the given charset (in the form of RFC 2046) or ``wx.FONTENCODING_SYSTEM`` if couldn't decode it.

   **Parameters:**

   * `charset` (string) 
   * `interactive` (bool) 

   |  

   **Returns:**

   `int` 

.. warning:: Be careful when using this function with `interactive` set to ``True`` (default value) as the function then may show 
   a dialog box to the user which may lead to unexpected reentrancies and may also take a significantly longer time than a simple 
   function call. For these reasons, it is almost always a bad idea to call this function from the event handlers for repeatedly 
   generated events such as ``wx.EVT_PAINT``.

--------

.. method:: Get()

   Get the current font mapper object. If there is no current object, creates one.

   |

   **Returns:**

   `wx.FontMapper <wx.FontMapper.html>`_
 

.. seealso:: `Set <#Set>`_
  

--------

.. method:: GetAltForEncoding(encoding, facename="", interactive=True)

   Find an alternative for the given encoding (which is supposed to not be available on this system). If successful, returns an 
   info structure with the parameters required to create the font.

   It returns `wx.FontEncoding` which can consequently be passed to `wx.Font <wx.Font.html>`_ constructor.

   **Parameters:**

   * `encoding` (int) 
   * `facename` (string) 
   * `interactive` (bool) 

   |  

   **Returns:**

   `PyObject` 

--------

.. method:: GetDefaultConfigPath()

   `No docstrings available for this method.` 

--------


.. method:: GetEncoding(n)

   Returns the `n`-th supported encoding. Together with `GetSupportedEncodingsCount <#GetSupportedEncodingsCount>`_ 
   this method may be used to get all supported encodings.

   **Parameters:**

   * `n` (long) 

   |  

   **Returns:**

   `int` 

--------

.. method:: GetEncodingDescription(encoding)

   Return user-readable string describing the given encoding.

   **Parameters:**

   * `encoding` (int) 

   |  

   **Returns:**

   `string` 

--------

.. method:: GetEncodingFromName(encoding)

   Return the encoding corresponding to the given internal name. This function is the inverse of `GetEncodingName <#GetEncodingName>`_ 
   and is intentionally less general than `CharsetToEncoding <#CharsetToEncoding>`_, i.e. it doesn't try to make any guesses nor ever 
   asks the user. It is meant just as a way of restoring objects previously serialized using `GetEncodingName <#GetEncodingName>`_.

   **Parameters:**

   * `encoding` (string) 

   |  

   **Returns:**

   `int` 

--------

.. method:: GetEncodingName(encoding)

   Return internal string identifier for the encoding

   **Parameters:**

   * `encoding` (int) 

   |  

   **Returns:**

   `string` 

.. seealso:: `GetEncodingFromName <#GetEncodingFromName>`_, `GetEncodingDescription <#GetEncodingDescription>`_ 
  

--------

.. method:: GetSupportedEncodingsCount()

   Returns the number of the font encodings supported by this class. Together with `GetEncoding <#GetEncoding>`_ 
   this method may be used to get all supported encodings.

   |  

   **Returns:**

   `long` 

--------

.. method:: IsEncodingAvailable(encoding, facename="")

   Check whether given encoding is available in given face or not. If no `facename` is given, find *any* font in this encoding.

   **Parameters:**

   * `encoding` (int) 
   * `facename` (string) 

   |  

   **Returns:**

   `bool` 

--------

.. method:: Set(mapper)

   Set the current font mapper object and return previous one (may be ``None``). This method is only useful if you want to plug-in 
   an alternative font mapper into wxPython.

   **Parameters:**

   * `mapper` (`wx.FontMapper <wx.FontMapper.html>`_) 

   |  

   **Returns:**

   `wx.FontMapper <wx.FontMapper.html>`_
 

.. seealso:: `Get <#Get>`_
  

--------

.. method:: SetConfigPath(prefix)

   Set the root config path to use (should be an absolute path).

   **Parameters:**

   * `prefix` (string) 

--------

.. method:: SetDialogParent(parent)

   The parent window for modal dialogs.

   **Parameters:**

   * `parent` (`wx.Window <wx.Window.html>`_) 

--------

.. method:: SetDialogTitle(title)

   The title for the dialogs (note that default is quite reasonable).

   **Parameters:**

   * `title` (string) 

--------

Properties
^^^^^^^^^^


.. attribute:: AltForEncoding

   See `GetAltForEncoding <#GetAltForEncoding>`_