wx.FontMapper

Inheritance diagram for 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 for “equivalent” encodings (e.g. iso8859-2 and cp1250) and tries them.

Properties Summary

Class API

Methods

__init__()
No docstrings available for this 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.


Get()

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


Returns:

wx.FontMapper

See also

Set


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 constructor.

Parameters:

  • encoding (int)
  • facename (string)
  • interactive (bool)

Returns:

PyObject


GetDefaultConfigPath()
No docstrings available for this method.

GetEncoding(n)

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

Parameters:

  • n (long)

Returns:

int


GetEncodingDescription(encoding)

Return user-readable string describing the given encoding.

Parameters:

  • encoding (int)

Returns:

string


GetEncodingFromName(encoding)

Return the encoding corresponding to the given internal name. This function is the inverse of GetEncodingName and is intentionally less general than 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.

Parameters:

  • encoding (string)

Returns:

int


GetEncodingName(encoding)

Return internal string identifier for the encoding

Parameters:

  • encoding (int)

Returns:

string


GetSupportedEncodingsCount()

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


Returns:

long


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


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:


Returns:

wx.FontMapper

See also

Get


SetConfigPath(prefix)

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

Parameters:

  • prefix (string)

SetDialogParent(parent)

The parent window for modal dialogs.

Parameters:


SetDialogTitle(title)

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

Parameters:

  • title (string)

Properties

AltForEncoding
See GetAltForEncoding