Pango.Language¶

Fields¶

None

Methods¶

class	`from_string` (language)
class	`get_default` ()
	`get_sample_string` ()
	`get_scripts` ()
	`includes_script` (script)
	`matches` (range_list)
	`to_string` ()

Details¶

class Pango.Language¶

The Pango.Language structure is used to represent a language.

Pango.Language pointers can be efficiently copied and compared with each other.

classmethod from_string(language)[source]¶

Parameters:	language (`str` or `None`) – a string representing a language tag, or `None`
Returns:	an opaque pointer to a `Pango.Language` structure, or `None` if language was `None`. The returned pointer will be valid forever after, and should not be freed.
Return type:	`Pango.Language` or `None`

Take a RFC-3066 format language tag as a string and convert it to a Pango.Language pointer that can be efficiently copied (copy the pointer) and compared with other language tags (compare the pointer.)

This function first canonicalizes the string by converting it to lowercase, mapping ‘_’ to ‘-’, and stripping all characters other than letters and ‘-‘.

Use Pango.Language.get_default() if you want to get the Pango.Language for the current locale of the process.

classmethod get_default()[source]¶

Returns:	the default language as a `Pango.Language`, must not be freed.
Return type:	`Pango.Language`

Returns the Pango.Language for the current locale of the process. Note that this can change over the life of an application.

On Unix systems, this is the return value is derived from setlocale(LC_CTYPE, NULL), and the user can affect this through the environment variables LC_ALL, LC_CTYPE or LANG (checked in that order). The locale string typically is in the form lang_COUNTRY, where lang is an ISO-639 language code, and COUNTRY is an ISO-3166 country code. For instance, sv_FI for Swedish as written in Finland or pt_BR for Portuguese as written in Brazil.

On Windows, the C library does not use any such environment variables, and setting them won’t affect the behavior of functions like ctime(). The user sets the locale through the Regional Options in the Control Panel. The C library (in the setlocale() function) does not use country and language codes, but country and language names spelled out in English. However, this function does check the above environment variables, and does return a Unix-style locale string based on either said environment variables or the thread’s current locale.

Your application should call setlocale(LC_ALL, ""); for the user settings to take effect. Gtk+ does this in its initialization functions automatically (by calling gtk_set_locale()). See man setlocale for more details.

New in version 1.16.

get_sample_string()[source]¶

Returns:	the sample string. This value is owned by Pango and should not be freed.
Return type:	`str`

Get a string that is representative of the characters needed to render a particular language.

The sample text may be a pangram, but is not necessarily. It is chosen to be demonstrative of normal text in the language, as well as exposing font feature requirements unique to the language. It is suitable for use as sample text in a font selection dialog.

If self is None, the default language as found by Pango.Language.get_default() is used.

If Pango does not have a sample string for self, the classic “The quick brown fox…” is returned. This can be detected by comparing the returned pointer value to that returned for (non-existent) language code “xx”. That is, compare to:

pango_language_get_sample_string (pango_language_from_string ("xx"))

get_scripts()[source]¶

Returns:	An array of `Pango.Script` values, with the number of entries in the array stored in num_scripts, or `None` if Pango does not have any information about this particular language tag (also the case if self is `None`). The returned array is owned by Pango and should not be modified or freed.
Return type:	[`Pango.Script`] or `None`

Determines the scripts used to to write self. If nothing is known about the language tag self, or if self is None, then None is returned. The list of scripts returned starts with the script that the language uses most and continues to the one it uses least.

The value num_script points at will be set to the number of scripts in the returned array (or zero if None is returned).

Most languages use only one script for writing, but there are some that use two (Latin and Cyrillic for example), and a few use three (Japanese for example). Applications should not make any assumptions on the maximum number of scripts returned though, except that it is positive if the return value is not None, and it is a small number.

The Pango.Language.includes_script() function uses this function internally.

Note: while the return value is declared as Pango.Script, the returned values are from the GLib.UnicodeScript enumeration, which may have more values. Callers need to handle unknown values.

New in version 1.22.

includes_script(script)[source]¶

Parameters:	script (`Pango.Script`) – a `Pango.Script`
Returns:	`True` if script is one of the scripts used to write self or if nothing is known about self (including the case that self is `None`), `False` otherwise.
Return type:	`bool`

Determines if script is one of the scripts used to write self. The returned value is conservative; if nothing is known about the language tag self, True will be returned, since, as far as Pango knows, script might be used to write self.

This routine is used in Pango’s itemization process when determining if a supplied language tag is relevant to a particular section of text. It probably is not useful for applications in most circumstances.

This function uses Pango.Language.get_scripts() internally.

New in version 1.4.

matches(range_list)[source]¶

Parameters:	range_list (`str`) – a list of language ranges, separated by ‘;’, ‘:’, ‘,’, or space characters. Each element must either be ‘*’, or a RFC 3066 language range canonicalized as by `Pango.Language.from_string`()
Returns:	`True` if a match was found.
Return type:	`bool`

Checks if a language tag matches one of the elements in a list of language ranges. A language tag is considered to match a range in the list if the range is ‘*’, the range is exactly the tag, or the range is a prefix of the tag, and the character after it in the tag is ‘-‘.

to_string()[source]¶

Returns:	a string representing the language tag. This is owned by Pango and should not be freed.
Return type:	`str`

Gets the RFC-3066 format string representing the given language tag.