Libraries:Gtk:Pango:Language

Types

T

Constants

Nil : T

Functions

FromString(language @ Std.String.T) : Gtk.Pango.Language.T

Take a RFC-3066 format language tag as a string and convert it to a T 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 GetDefault if you want to get the T for the current locale of the process.

language	a string representing a language tag, or NULL. [allow-none]
Returns	an opaque pointer to a T structure, or NULL if language was NULL. The returned pointer will be valid forever after, and should not be freed.

GetDefault() : Gtk.Pango.Language.T

Returns the T 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.Gtk.Global.SetLocale). See man setlocale for more details.

Returns

the default language as a T, must not be freed.

GetType() : Gtk.GObject.Type.T

Methods

:"="(_ @ T, _ @ T)

:GetSampleString(self @ T) : Std.String.T

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 language is NULL, the default language as found by GetDefault is used.

If Pango does not have a sample string for language, 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"))

:GetScripts(self @ T, num_scripts @ Std.Object.T) : Std.Object.T

Determines the scripts used to to write language. If nothing is known about the language tag language, or if language is NULL, then NULL 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 NULL 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 NULL, and it is a small number.

The IncludesScript function uses this function internally.

language	a T, or NULL. [allow-none]
num_scripts	location to return number of scripts, or NULL. [out caller-allocates][allow-none]
Returns	An array of Gtk.Pango.Script.T values, with the number of entries in the array stored in num_scripts, or NULL if Pango does not have any information about this particular language tag (also the case if language is NULL). The returned array is owned by Pango and should not be modified or freed.

:IncludesScript(self @ T, script @ Gtk.Pango.Script.T) : Std.Symbol.T

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

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 GetScripts internally.

language	a T, or NULL
script	a Gtk.Pango.Script.T
Returns	TRUE if script is one of the scripts used to write language or if nothing is known about language (including the case that language is NULL), FALSE otherwise.

:Matches(self @ T, range_list @ Std.String.T) : Std.Symbol.T

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

language	a language tag (see FromString), NULL is allowed and matches nothing but '*'
range_list	a list of language ranges, separated by ';', ':', ',', or space characters. Each element must either be '*', or a RFC 3066 language range canonicalized as by FromString
Returns	TRUE if a match was found.

:ToString(self @ T) : Std.String.T

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

language	a language tag.
Returns	a string representing the language tag. This is owned by Pango and should not be freed.

:"~="(_ @ T, _ @ T)

Language