Fetches the attribute type name passed in when registering the type using
pango_attr_type_register().
The returned value is an interned string (see g_intern_string() for what
that means) that should not be modified or freed.
a built-in Pango attribute type or invalid.

Parameters:

Pango.AttrType type Required (not null)

an attribute type ID to fetch the name for

Returns:

String the type ID name (which may be NULL), or NULL if type is

Allocate a new attribute type ID. The attribute type name can be accessed
later by using pango_attr_type_get_name().

Parameters:

String name Required (not null)

an identifier for the type

Returns:

Pango.AttrType the new type ID.

Determines the normative bidirectional character type of a
character, as specified in the Unicode Character Database.
A simplified version of this function is available as
pango_unichar_get_direction().
Unicode bidirectional algorithm.

Parameters:

gunichar ch Required (not null)

a Unicode character

Returns:

Pango.BidiType the bidirectional character type, as used in the

Determines possible line, word, and character breaks
for a string of Unicode text with a single analysis. For most
purposes you may want to use pango_get_log_attrs().

Parameters:

String text Required (not null)

the text to process

gint32 length Required (not null)

length of text in bytes (may be -1 if text is nul-terminated)

Pango.Analysis analysis Required (not null)

PangoAnalysis structure from pango_itemize()

Pango.LogAttr attrs Required (not null)

an array to store character information in

gint32 attrs_len Required (not null)

size of the array passed as attrs

Returns:

none

Converts extents from Pango units to device units, dividing by the
PANGO_SCALE factor and performing rounding.
The inclusive rectangle is converted by flooring the x/y coordinates and extending
width/height, such that the final rectangle completely includes the original
rectangle.
The nearest rectangle is converted by rounding the coordinates
of the rectangle to the nearest device unit (pixel).
rectangle to completely contain the original rectangle, pass it in as inclusive.
If you want two touching-but-not-overlapping rectangles stay
touching-but-not-overlapping after rounding to device units, pass them in
as nearest.

Parameters:

Pango.Rectangle inclusive Required (not null)

rectangle to round to pixels inclusively, or NULL.

Pango.Rectangle nearest Required (not null)

rectangle to round to nearest pixels, or NULL.

Returns:

none

Searches a string the first character that has a strong
direction, according to the Unicode bidirectional algorithm.
If no such character is found, then PANGO_DIRECTION_NEUTRAL is returned.

Parameters:

String text Required (not null)

the text to process

gint32 length Required (not null)

length of text in bytes (may be -1 if text is nul-terminated)

Returns:

Pango.Direction The direction corresponding to the first strong character.

Locates a paragraph boundary in text. A boundary is caused by
delimiter characters, such as a newline, carriage return, carriage
return-newline pair, or Unicode paragraph separator character. The
index of the run of delimiters is returned in
(index after all delimiters) is stored in next_paragraph_start.
If no delimiters are found, both paragraph_delimiter_index and
off the end).

Parameters:

String text Required (not null)

UTF-8 text

gint32 length Required (not null)

length of text in bytes, or -1 if nul-terminated

gint32 paragraph_delimiter_index Required (not null)

return location for index of delimiter

gint32 next_paragraph_start Required (not null)

return location for start of next paragraph

Returns:

none

Creates a new font description from a string representation in the
form "[FAMILY-LIST] [STYLE-OPTIONS] [SIZE]", where FAMILY-LIST is a
comma separated list of families optionally terminated by a comma,
STYLE_OPTIONS is a whitespace separated list of words where each WORD
describes one of style, variant, weight, stretch, or gravity, and SIZE
is a decimal number (size in points) or optionally followed by the
unit modifier "px" for absolute size. Any one of the options may
be absent. If FAMILY-LIST is absent, then the family_name field of
the resulting font description will be initialized to NULL. If
STYLE-OPTIONS is missing, then all style options will be set to the
default values. If SIZE is missing, the size in the resulting font
description will be set to 0.

Parameters:

String str Required (not null)

string representation of a font description.

Returns:

Pango.FontDescription a new PangoFontDescription.

Computes a PangoLogAttr for each character in text. The log_attrs
array must have one PangoLogAttr for each position in text; if
last position at the end of the text. text should be an entire
paragraph; logical attributes can't be computed without context
(for example you need to see spaces on either side of a word to know
the word is a word).

Parameters:

String text Required (not null)

text to process

gint32 length Required (not null)

length in bytes of text

gint32 level Required (not null)

embedding level, or -1 if unknown

Pango.Language language Required (not null)

language tag

Pango.LogAttr log_attrs Required (not null)

array with one PangoLogAttr per character in text, plus one extra, to be filled in

gint32 attrs_len Required (not null)

length of log_attrs array

Returns:

none

If ch has the Unicode mirrored property and there is another Unicode
character that typically has a glyph that is the mirror image of ch's
glyph, puts that character in the address pointed to by mirrored_ch.
Use g_unichar_get_mirror_char() instead; the docs for that function
provide full details.
filled in, FALSE otherwise

Parameters:

gunichar ch Required (not null)

a Unicode character

gunichar mirrored_ch Required (not null)

location to store the mirrored character

Returns:

gboolean TRUE if ch has a mirrored character and mirrored_ch is

Finds the gravity that best matches the rotation component
in a PangoMatrix.
PANGO_GRAVITY_AUTO, or PANGO_GRAVITY_SOUTH if matrix is NULL

Parameters:

Pango.Matrix matrix Required (not null)

a PangoMatrix

Returns:

Pango.Gravity the gravity of matrix, which will never be

Based on the script, base gravity, and hint, returns actual gravity
to use in laying out a single PangoItem.
If base_gravity is PANGO_GRAVITY_AUTO, it is first replaced with the
preferred gravity of script. To get the preferred gravity of a script,
pass PANGO_GRAVITY_AUTO and PANGO_GRAVITY_HINT_STRONG in.
with script.

Parameters:

Pango.Script script Required (not null)

PangoScript to query

Pango.Gravity base_gravity Required (not null)

base gravity of the paragraph

Pango.GravityHint hint Required (not null)

orientation hint

Returns:

Pango.Gravity resolved gravity suitable to use for a run of text

Based on the script, East Asian width, base gravity, and hint,
returns actual gravity to use in laying out a single character
or PangoItem.
This function is similar to pango_gravity_get_for_script() except
that this function makes a distinction between narrow/half-width and
wide/full-width characters also. Wide/full-width characters always
stand upright, that is, they always take the base gravity,
whereas narrow/full-width characters are always rotated in vertical
context.
If base_gravity is PANGO_GRAVITY_AUTO, it is first replaced with the
preferred gravity of script.
with script and wide.

Parameters:

Pango.Script script Required (not null)

PangoScript to query

gboolean wide Required (not null)

TRUE for wide characters as returned by g_unichar_iswide()

Pango.Gravity base_gravity Required (not null)

base gravity of the paragraph

Pango.GravityHint hint Required (not null)

orientation hint

Returns:

Pango.Gravity resolved gravity suitable to use for a run of text

Converts a PangoGravity value to its natural rotation in radians.
Note that pango_matrix_rotate() takes angle in degrees, not radians.
So, to call pango_matrix_rotate() with the output of this function
you should multiply it by (180. / G_PI).

Parameters:

Pango.Gravity gravity Required (not null)

gravity to query

Returns:

gdouble the rotation value corresponding to gravity.

Checks ch to see if it is a character that should not be
normally rendered on the screen. This includes all Unicode characters
with "ZERO WIDTH" in their name, as well as bidi formatting characters, and
a few other ones. This is totally different from g_unichar_iszerowidth()
and is at best misnamed.

Parameters:

gunichar ch Required (not null)

a Unicode character

Returns:

gboolean TRUE if ch is a zero-width character, FALSE otherwise

Take a RFC-3066 format language tag as a string and convert it to a
PangoLanguage 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 PangoLanguage for
the current locale of the process.
if language was NULL. The returned pointer will be valid
forever after, and should not be freed.

Parameters:

String language Required (not null)

a string representing a language tag, or NULL

Returns:

Pango.Language an opaque pointer to a PangoLanguage structure, or NULL

Returns the PangoLanguage 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.
freed.

Returns:

Pango.Language the default language as a PangoLanguage, must not be

This will return the bidirectional embedding levels of the input paragraph
as defined by the Unicode Bidirectional Algorithm available at:
http://www.unicode.org/reports/tr9/
If the input base direction is a weak direction, the direction of the
characters in the text will determine the final resolved direction.
character (not byte), that should be freed using g_free.

Parameters:

String text Required (not null)

the text to itemize.

gint32 length Required (not null)

the number of bytes (not characters) to process, or -1 if text is nul-terminated and the length should be calculated.

Pango.Direction pbase_dir Required (not null)

input base direction, and output resolved direction.

Returns:

guint8 a newly allocated array of embedding levels, one item per

Parses an enum type and stores the result in value.
If str does not match the nick name of any of the possible values for the
enum and is not an integer, FALSE is returned, a warning is issued
if warn is TRUE, and a
string representing the list of possible values is stored in
"none/start/middle/end". If failed and possible_values is not NULL,
returned string should be freed using g_free().

Parameters:

Number type Required (not null)

enum type to parse, eg. PANGO_TYPE_ELLIPSIZE_MODE.

String str Required (not null)

string to parse. May be NULL.

gint32 value Required (not null)

integer to store the result in, or NULL.

gboolean warn Required (not null)

if TRUE, issue a g_warning() on bad input.

String possible_values Required (not null)

place to store list of possible values on failure, or NULL.

Returns:

gboolean TRUE if str was successfully parsed.

Parses marked-up text (see
markup format) to create
a plain-text string and an attribute list.
If accel_marker is nonzero, the given character will mark the
character following it as an accelerator. For example, accel_marker
might be an ampersand or underscore. All characters marked
as an accelerator will receive a PANGO_UNDERLINE_LOW attribute,
and the first character so marked will be returned in accel_char.
Two accel_marker characters following each other produce a single
literal accel_marker character.
If any error happens, none of the output arguments are touched except
for error.

Parameters:

String markup_text Required (not null)

markup to parse (see markup format)

gint32 length Required (not null)

length of markup_text, or -1 if nul-terminated

gunichar accel_marker Required (not null)

character that precedes an accelerator, or 0 for none

Object out_values

Pango.AttrList attr_list

String text

gunichar accel_char

Returns:

gboolean FALSE if error is set, otherwise TRUE

Parses a font stretch. The allowed values are
"ultra_condensed", "extra_condensed", "condensed",
"semi_condensed", "normal", "semi_expanded", "expanded",
"extra_expanded" and "ultra_expanded". Case variations are
ignored and the '_' characters may be omitted.

Parameters:

String str Required (not null)

a string to parse.

Pango.Stretch stretch Required (not null)

a PangoStretch to store the result in.

gboolean warn Required (not null)

if TRUE, issue a g_warning() on bad input.

Returns:

gboolean TRUE if str was successfully parsed.

Parses a font style. The allowed values are "normal",
"italic" and "oblique", case variations being
ignored.

Parameters:

String str Required (not null)

a string to parse.

Pango.Style style Required (not null)

a PangoStyle to store the result in.

gboolean warn Required (not null)

if TRUE, issue a g_warning() on bad input.

Returns:

gboolean TRUE if str was successfully parsed.

Parses a font variant. The allowed values are "normal"
and "smallcaps" or "small_caps", case variations being
ignored.

Parameters:

String str Required (not null)

a string to parse.

Pango.Variant variant Required (not null)

a PangoVariant to store the result in.

gboolean warn Required (not null)

if TRUE, issue a g_warning() on bad input.

Returns:

gboolean TRUE if str was successfully parsed.

Parses a font weight. The allowed values are "heavy",
"ultrabold", "bold", "normal", "light", "ultraleight"
and integers. Case variations are ignored.

Parameters:

String str Required (not null)

a string to parse.

Pango.Weight weight Required (not null)

a PangoWeight to store the result in.

gboolean warn Required (not null)

if TRUE, issue a g_warning() on bad input.

Returns:

gboolean TRUE if str was successfully parsed.

Quantizes the thickness and position of a line, typically an
underline or strikethrough, to whole device pixels, that is integer
multiples of PANGO_SCALE. The purpose of this function is to avoid
such lines looking blurry.
Care is taken to make sure thickness is at least one pixel when this
function returns, but returned position may become zero as a result
of rounding.

Parameters:

gint32 thickness Required (not null)

pointer to the thickness of a line, in Pango units

gint32 position Required (not null)

corresponding position

Returns:

none

Reads an entire line from a file into a buffer. Lines may
be delimited with '\n', '\r', '\n\r', or '\r\n'. The delimiter
is not written into the buffer. Text after a '#' character is treated as
a comment and skipped. '\' can be used to escape a # character.
'\' proceeding a line delimiter combines adjacent lines. A '\' proceeding
any other character is ignored and written into the output buffer
unmodified.
the number of lines read (this is useful for maintaining
a line number counter which doesn't combine lines with '\')

Parameters:

void* stream Required (not null)

a stdio stream

GLib.String str Required (not null)

GString buffer into which to write the result

Returns:

gint32 0 if the stream was already at an EOF character, otherwise

Scans an integer.
Leading white space is skipped.

Parameters:

String pos Required (not null)

in/out string position

gint32 out Required (not null)

an int into which to write the result

Returns:

gboolean FALSE if a parse error occurred.

Scans a string into a GString buffer. The string may either
be a sequence of non-white-space characters, or a quoted
string with '"'. Instead a quoted string, '\"' represents
a literal quote. Leading white space outside of quotes is skipped.

Parameters:

String pos Required (not null)

in/out string position

GLib.String out Required (not null)

a GString into which to write the result

Returns:

gboolean FALSE if a parse error occurred.

Scans a word into a GString buffer. A word consists
of [A-Za-z_] followed by zero or more [A-Za-z_0-9]
Leading white space is skipped.

Parameters:

String pos Required (not null)

in/out string position

GLib.String out Required (not null)

a GString into which to write the result

Returns:

gboolean FALSE if a parse error occurred.

Looks up the PangoScript for a particular character (as defined by
Unicode Standard Annex #24). No check is made for ch being a
valid Unicode character; if you pass in invalid character, the
result is undefined.
As of Pango 1.18, this function simply returns the return value of
g_unichar_get_script().

Parameters:

gunichar ch Required (not null)

a Unicode character

Returns:

Pango.Script the PangoScript for the character.

Given a script, finds a language tag that is reasonably
representative of that script. This will usually be the
most widely spoken or used language written in that script:
for instance, the sample language for PANGO_SCRIPT_CYRILLIC
is ru (Russian), the sample language
for PANGO_SCRIPT_ARABIC is ar.
For some
scripts, no sample language will be returned because there
is no language that is sufficiently representative. The best
example of this is PANGO_SCRIPT_HAN, where various different
variants of written Chinese, Japanese, and Korean all use
significantly different sets of Han characters and forms
of shared characters. No sample language can be provided
for many historical scripts as well.
As of 1.18, this function checks the environment variables
PANGO_LANGUAGE and LANGUAGE (checked in that order) first.
If one of them is set, it is parsed as a list of language tags
separated by colons or other separators. This function
will return the first language in the parsed list that Pango
believes may use script for writing. This last predicate
is tested using pango_language_includes_script(). This can
be used to control Pango's font selection for non-primary
languages. For example, a PANGO_LANGUAGE enviroment variable
set to "en:fa" makes Pango choose fonts suitable for Persian (fa)
instead of Arabic (ar) when a segment of Arabic text is found
in an otherwise non-Arabic text. The same trick can be used to
choose a default language for PANGO_SCRIPT_HAN when setting
context language is not feasible.
of the script, or NULL if no such language exists.

Parameters:

Pango.Script script Required (not null)

a PangoScript

Returns:

Pango.Language a PangoLanguage that is representative

Given a segment of text and the corresponding
PangoAnalysis structure returned from pango_itemize(),
convert the characters into glyphs. You may also pass
in only a substring of the item from pango_itemize().

Parameters:

String text Required (not null)

the text to process

gint32 length Required (not null)

the length (in bytes) of text

Pango.Analysis analysis Required (not null)

PangoAnalysis structure from pango_itemize()

Pango.GlyphString glyphs Required (not null)

glyph string in which to store results

Returns:

none

Skips 0 or more characters of white space.
the position at a '\0' character.

Parameters:

String pos Required (not null)

in/out string position

Returns:

gboolean FALSE if skipping the white space leaves

Trims leading and trailing whitespace from a string.

Parameters:

String str Required (not null)

a string

Returns:

String A newly-allocated string that must be freed with g_free()

Determines the inherent direction of a character; either
PANGO_DIRECTION_LTR, PANGO_DIRECTION_RTL, or
PANGO_DIRECTION_NEUTRAL.
This function is useful to categorize characters into left-to-right
letters, right-to-left letters, and everything else. If full
Unicode bidirectional type of a character is needed,
pango_bidi_type_for_gunichar() can be used instead.

Parameters:

gunichar ch Required (not null)

a Unicode character

Returns:

Pango.Direction the direction of the character.

it by PANGO_SCALE and rounds to nearest integer.

Parameters:

gdouble d Required (not null)

double floating-point value

Returns:

gint32 the value in Pango units.

it by PANGO_SCALE.

Parameters:

gint32 i Required (not null)

value in Pango units

Returns:

gdouble the double value.

This is similar to the macro PANGO_VERSION except that
it returns the encoded version of Pango available at run-time,
as opposed to the version available at compile-time.
A version number can be encoded into an integer using
PANGO_VERSION_ENCODE().
available at run time.

Returns:

gint32 The encoded version of Pango library

Checks that the Pango library in use is compatible with the
given version. Generally you would pass in the constants
PANGO_VERSION_MAJOR, PANGO_VERSION_MINOR, PANGO_VERSION_MICRO
as the three arguments to this function; that produces
a check that the library in use at run-time is compatible with
the version of Pango the application or module was compiled against.
of the running library is newer than the version
the running library must be binary compatible with the
version required_major.required_minor.required_micro
(same major version.)
For compile-time version checking use PANGO_VERSION_CHECK().
given version, or a string describing the version mismatch.
The returned string is owned by Pango and should not be modified
or freed.

Parameters:

gint32 required_major Required (not null)

the required major version.

gint32 required_minor Required (not null)

the required minor version.

gint32 required_micro Required (not null)

the required major version.

Returns:

String NULL if the Pango library is compatible with the

This is similar to the macro PANGO_VERSION_STRING except that
it returns the version of Pango available at run-time, as opposed to
the version available at compile-time.
available at run time.
The returned string is owned by Pango and should not be modified
or freed.

Returns:

String A string containing the version of Pango library