Package org.gnome.pango

Class Language

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.pango.Language

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class Language
extends ProxyInstance

The PangoLanguage structure is used to represent a language.

PangoLanguage pointers can be efficiently copied and compared with each other.

Constructor Summary

Constructors

Constructor	Description
Language(MemorySegment address)	Create a Language proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static Language	fromString(@Nullable String language)	Convert a language tag to a PangoLanguage.
static Language	getDefault()	Returns the PangoLanguage for the current locale of the process.
static Language[]	getPreferred()	Returns the list of languages that the user prefers.
String	getSampleString()	Get a string that is representative of the characters needed to render a particular language.
Script[]	getScripts()	Determines the scripts used to to write this Language.
static Type	getType()	Get the GType of the Language class
boolean	includesScript(Script script)	Determines if script is one of the scripts used to write this Language.
boolean	matches(String rangeList)	Checks if a language tag matches one of the elements in a list of language ranges.
String	toString()	Gets the RFC-3066 format string representing the given language tag.

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Language

public Language(MemorySegment address)

Create a Language proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the Language class

Returns:

the GType

fromString

public static Language fromString(@Nullable
 @Nullable String language)

Convert a language tag to a PangoLanguage.

The language tag must be in a RFC-3066 format. PangoLanguage pointers 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 PangoLanguage for the current locale of the process.

Parameters:

language - a string representing a language tag

Returns:

a PangoLanguage

getDefault

public static Language getDefault()

Returns the PangoLanguage for the current locale of the process.

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 the setlocale() manpage for more details.

Note that the default language can change over the life of an application.

Also note that this function will not do the right thing if you use per-thread locales with uselocale(). In that case, you should just call pango_language_from_string() yourself.

Returns:

the default language as a PangoLanguage

getPreferred

public static Language[] getPreferred()

Returns the list of languages that the user prefers.

The list is specified by the PANGO_LANGUAGE or LANGUAGE environment variables, in order of preference. Note that this list does not necessarily include the language returned by getDefault().

When choosing language-specific resources, such as the sample text returned by getSampleString(), you should first try the default language, followed by the languages returned by this function.

Returns:

a null-terminated array of PangoLanguage*

getSampleString

public String getSampleString()

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 this Language is null, the default language as found by getDefault() is used.

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

Returns:

the sample string

getScripts

public Script[] getScripts()

Determines the scripts used to to write this Language.

If nothing is known about the language tag this Language, or if this 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 numScript 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(org.gnome.pango.Script) function uses this function internally.

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

Returns:

An array of PangoScript values, with the number of entries in the array stored in numScripts, or null if Pango does not have any information about this particular language tag (also the case if this Language is null).

includesScript

public boolean includesScript(Script script)

Determines if script is one of the scripts used to write this Language.

The returned value is conservative; if nothing is known about the language tag this Language, true will be returned, since, as far as Pango knows, script might be used to write this 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.

Parameters:

script - a PangoScript

Returns:

true if script is one of the scripts used to write this Language or if nothing is known about this Language (including the case that this Language is null), false otherwise.

matches

public boolean matches(String rangeList)

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

Parameters:

rangeList - 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(java.lang.String)

Returns:

true if a match was found

toString

public String toString()

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

Returns (transfer none): a string representing the language tag

Overrides:

toString in class Object