Functions

Create a new allow-breaks attribute.

If breaks are disabled, the range will be kept in a single run, as far as possible.

Create a new background alpha attribute.

Create a new background color attribute.

Create a new baseline displacement attribute.

The effect of this attribute is to shift the baseline of a run, relative to the run of preceding run.

<picture> <source srcset=“baseline-shift-dark.png” media=“(prefers-color-scheme: dark)”> <img alt=“Baseline Shift” src=“baseline-shift-light.png”> </picture>

Apply customization from attributes to the breaks in attrs.

The line breaks are assumed to have been produced by [funcPango.default_break] and [funcPango.tailor_break].

Create a new font fallback attribute.

If fallback is disabled, characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text.

Create a new font family attribute.

Create a new font description attribute.

This attribute allows setting family, style, weight, variant, stretch, and size simultaneously.

Create a new font features tag attribute.

You can use this attribute to select OpenType font features like small-caps, alternative glyphs, ligatures, etc. for fonts that support them.

Create a new font scale attribute.

The effect of this attribute is to change the font size of a run, relative to the size of preceding run.

Create a new foreground alpha attribute.

Create a new foreground color attribute.

Create a new gravity hint attribute.

Create a new gravity attribute.

Create a new insert-hyphens attribute.

Pango will insert hyphens when breaking lines in the middle of a word. This attribute can be used to suppress the hyphen.

Create a new language tag attribute.

Create a new letter-spacing attribute.

Modify the height of logical line extents by a factor.

This affects the values returned by [methodPango.LayoutLine.get_extents], [methodPango.LayoutLine.get_pixel_extents] and [methodPango.LayoutIter.get_line_extents].

Override the height of logical line extents to be height.

This affects the values returned by [methodPango.LayoutLine.get_extents], [methodPango.LayoutLine.get_pixel_extents] and [methodPango.LayoutIter.get_line_extents].

Deserializes a PangoAttrList from a string.

This is the counterpart to [methodPango.AttrList.to_string]. See that functions for details about the format.

Create a new overline color attribute.

This attribute modifies the color of overlines. If not set, overlines will use the foreground color.

Create a new overline-style attribute.

Create a new baseline displacement attribute.

Create a new font size scale attribute.

The base font for the affected text will have its size multiplied by scale_factor.

Marks the range of the attribute as a single sentence.

Note that this may require adjustments to word and sentence classification around the range.

Create a new shape attribute.

A shape is used to impose a particular ink and logical rectangle on the result of shaping a particular glyph. This might be used, for instance, for embedding a picture or a widget inside a PangoLayout.

Creates a new shape attribute.

Like [funcPango.AttrShape.new], but a user data pointer is also provided; this pointer can be accessed when later rendering the glyph.

Create a new attribute that influences how invisible characters are rendered.

Create a new font-size attribute in fractional points.

Create a new font-size attribute in device units.

Create a new font stretch attribute.

Create a new strikethrough color attribute.

This attribute modifies the color of strikethrough lines. If not set, strikethrough lines will use the foreground color.

Create a new strike-through attribute.

Create a new font slant style attribute.

Create a new attribute that influences how characters are transformed during shaping.

Fetches the attribute type name.

The attribute type name is the string passed in when registering the type using [funcPango.AttrType.register].

The returned value is an interned string (see g_intern_string() for what that means) that should not be modified or freed.

Allocate a new attribute type ID.

The attribute type name can be accessed later by using [funcPango.AttrType.get_name].

Create a new underline color attribute.

This attribute modifies the color of underlines. If not set, underlines will use the foreground color.

Create a new underline-style attribute.

Create a new font variant attribute (normal or small caps).

Create a new font weight attribute.

Marks the range of the attribute as a single word.

Note that this may require adjustments to word and sentence classification around the range.

Determines the bidirectional type of a character.

The bidirectional type is specified in the Unicode Character Database.

A simplified version of this function is available as [funcunichar_direction].

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 [funcPango.get_log_attrs].

break is deprecated: Use [func@Pango.default_break], [func@Pango.tailor_break] and [func@Pango.attr_break].

This is the default break algorithm.

It applies rules from the Unicode Line Breaking Algorithm without language-specific tailoring, therefore the analyis argument is unused and can be nil.

See [funcPango.tailor_break] for language-specific breaks.

See [funcPango.attr_break] for attribute-based customization.

This is the default break algorithm.

It applies rules from the Unicode Line Breaking Algorithm without language-specific tailoring, therefore the analyis argument is unused and can be nil.

See [funcPango.tailor_break] for language-specific breaks.

See [funcPango.attr_break] for attribute-based customization.

Converts extents from Pango units to device units.

The conversion is done by 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).

The rule to which argument to use is: if you want the resulting device-space 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.

Converts extents from Pango units to device units.

The conversion is done by 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).

The rule to which argument to use is: if you want the resulting device-space 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.

Searches a string the first character that has a strong direction, according to the Unicode bidirectional algorithm.

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 paragraph_delimiter_index. The index of the start of the next paragraph (index after all delimiters) is stored n next_paragraph_start.

If no delimiters are found, both paragraph_delimiter_index and next_paragraph_start are filled with the length of text (an index one off the end).

Creates a new font description from a string representation.

The string must have the form

"\[FAMILY-LIST] \[STYLE-OPTIONS] \[SIZE] \[VARIATIONS]",

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. VARIATIONS is a comma-separated list of font variation specifications of the form “`axis`=value” (the = sign is optional).

The following words are understood as styles: “Normal”, “Roman”, “Oblique”, “Italic”.

The following words are understood as variants: “Small-Caps”, “All-Small-Caps”, “Petite-Caps”, “All-Petite-Caps”, “Unicase”, “Title-Caps”.

The following words are understood as weights: “Thin”, “Ultra-Light”, “Extra-Light”, “Light”, “Semi-Light”, “Demi-Light”, “Book”, “Regular”, “Medium”, “Semi-Bold”, “Demi-Bold”, “Bold”, “Ultra-Bold”, “Extra-Bold”, “Heavy”, “Black”, “Ultra-Black”, “Extra-Black”.

The following words are understood as stretch values: “Ultra-Condensed”, “Extra-Condensed”, “Condensed”, “Semi-Condensed”, “Semi-Expanded”, “Expanded”, “Extra-Expanded”, “Ultra-Expanded”.

The following words are understood as gravity values: “Not-Rotated”, “South”, “Upside-Down”, “North”, “Rotated-Left”, “East”, “Rotated-Right”, “West”.

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

A typical example:

"Cantarell Italic Light 15 \`wght`=200"

Computes a PangoLogAttr for each character in text.

The attrs array must have one PangoLogAttr for each position in text; if text contains N characters, it has N+1 positions, including the 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).

Returns the mirrored character of a Unicode character.

Mirror characters are determined by the Unicode mirrored property.

get_mirror_char is deprecated: Use [func@GLib.unichar_get_mirror_char] instead; the docs for that function provide full details.

Finds the gravity that best matches the rotation component in a PangoMatrix.

Finds the gravity that best matches the rotation component in a PangoMatrix.

Returns the gravity to use in laying out a PangoItem.

The gravity is determined based on the script, base gravity, and hint.

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.

Returns the gravity to use in laying out a single character or PangoItem.

The gravity is determined based on the script, East Asian width, base gravity, and hint,

This function is similar to [funcPango.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.

Converts a PangoGravity value to its natural rotation in radians.

Note that [methodPango.Matrix.rotate] takes angle in degrees, not radians. So, to call [methodPango.Matrix,rotate] with the output of this function you should multiply it by (180. / G_PI).

Checks if a character that should not be normally rendered.

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 [funcGLib.unichar_iszerowidth] and is at best misnamed.

Breaks a piece of text into segments with consistent directional level and font.

Each byte of text will be contained in exactly one of the items in the returned list; the generated list of items will be in logical order (the start offsets of the items are ascending).

cached_iter should be an iterator over attrs currently positioned at a range before or containing start_index; cached_iter will be advanced to the range covering the position just after start_index + length. (i.e. if itemizing in a loop, just keep passing in the same cached_iter).

Breaks a piece of text into segments with consistent directional level and font.

Each byte of text will be contained in exactly one of the items in the returned list; the generated list of items will be in logical order (the start offsets of the items are ascending).

cached_iter should be an iterator over attrs currently positioned at a range before or containing start_index; cached_iter will be advanced to the range covering the position just after start_index + length. (i.e. if itemizing in a loop, just keep passing in the same cached_iter).

Like pango_itemize(), but with an explicitly specified base direction.

The base direction is used when computing bidirectional levels. [funcitemize] gets the base direction from the PangoContext (see [methodPango.Context.set_base_dir]).

Like pango_itemize(), but with an explicitly specified base direction.

The base direction is used when computing bidirectional levels. [funcitemize] gets the base direction from the PangoContext (see [methodPango.Context.set_base_dir]).

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 [funcPango.Language.get_default].

When choosing language-specific resources, such as the sample text returned by [methodPango.Language.get_sample_string], you should first try the default language, followed by the languages returned by this function.

Undocumented

Return the bidirectional embedding levels of the input paragraph.

The bidirectional embedding levels are defined by the Unicode Bidirectional Algorithm.

If the input base direction is a weak direction, the direction of the characters in the text will determine the final resolved direction.

Finishes parsing markup.

After feeding a Pango markup parser some data with [methodGLib.MarkupParseContext.parse], use this function to get the list of attributes and text out of the markup. This function will not free context, use [methodGLib.MarkupParseContext.free] to do so.

Incrementally parses marked-up text to create a plain-text string and an attribute list.

See the Pango Markup docs for details about the supported markup.

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, when calling [funcmarkup_parser_finish]. Two accel_marker characters following each other produce a single literal accel_marker character.

To feed markup to the parser, use [methodGLib.MarkupParseContext.parse] on the returned [structGLib.MarkupParseContext]. When done with feeding markup to the parser, use [funcmarkup_parser_finish] to get the data out of it, and then use [methodGLib.MarkupParseContext.free] to free it.

This function is designed for applications that read Pango markup from streams. To simply parse a string containing Pango markup, the [funcPango.parse_markup] API is recommended instead.

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 possible_values. The list is slash-separated, eg. “none/start/middle/end”.

If failed and possible_values is not nil, returned string should be freed using g_free().

parse_enum is deprecated: This method is deprecated.

Parses marked-up text to create a plain-text string and an attribute list.

See the Pango Markup docs for details about the supported markup.

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.

To parse a stream of pango markup incrementally, use [funcmarkup_parser_new].

If any error happens, none of the output arguments are touched except for error.

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.

Parses a font style.

The allowed values are “normal”, “italic” and “oblique”, case variations being ignored.

Parses a font variant.

The allowed values are “normal”, “small-caps”, “all-small-caps”, “petite-caps”, “all-petite-caps”, “unicase” and “title-caps”, case variations being ignored.

Parses a font weight.

The allowed values are “heavy”, “ultrabold”, “bold”, “normal”, “light”, “ultraleight” and integers. Case variations are ignored.

Quantizes the thickness and position of a line to whole device pixels.

This is typically used for underline or strikethrough. 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.

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.

read_line is deprecated: This method is deprecated.

Reorder items from logical order to visual order.

The visual order is determined from the associated directional levels of the items. The original list is unmodified.

(Please open a bug if you use this function. It is not a particularly convenient interface, and the code is duplicated elsewhere in Pango for that reason.)

Scans an integer.

Leading white space is skipped.

scan_int is deprecated: This method is deprecated.

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.

scan_string is deprecated: This method is deprecated.

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.

scan_word is deprecated: This method is deprecated.

Looks up the script for a particular character.

The script of a character is defined by Unicode Standard Annex 24: Script names.

No check is made for ch being a valid Unicode character; if you pass in invalid character, the result is undefined.

Note that while the return type of this function is declared as PangoScript, as of Pango 1.18, this function simply returns the return value of [funcGLib.unichar_get_script]. Callers must be prepared to handle unknown values.

script_for_unichar is deprecated: Use g_unichar_get_script()

Finds a language tag that is reasonably representative of script.

The language 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 [methodPango.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.

Convert the characters in item into glyphs.

This is similar to [funcPango.shape_with_flags], except it takes a PangoItem instead of separate item_text and analysis arguments. It also takes log_attrs, which may be used in implementing text transforms.

Note that the extra attributes in the analyis that is returned from [funcPango.itemize] have indices that are relative to the entire paragraph, so you do not pass the full paragraph text as paragraph_text, you need to subtract the item offset from their indices before calling [funcPango.shape_with_flags].

Convert the characters in item into glyphs.

This is similar to [funcPango.shape_with_flags], except it takes a PangoItem instead of separate item_text and analysis arguments. It also takes log_attrs, which may be used in implementing text transforms.

Note that the extra attributes in the analyis that is returned from [funcPango.itemize] have indices that are relative to the entire paragraph, so you do not pass the full paragraph text as paragraph_text, you need to subtract the item offset from their indices before calling [funcPango.shape_with_flags].

Convert the characters in text into glyphs.

Given a segment of text and the corresponding PangoAnalysis structure returned from [funcPango.itemize], convert the characters into glyphs. You may also pass in only a substring of the item from [funcPango.itemize].

This is similar to [funcPango.shape_full], except it also takes flags that can influence the shaping process.

Note that the extra attributes in the analyis that is returned from [funcPango.itemize] have indices that are relative to the entire paragraph, so you do not pass the full paragraph text as paragraph_text, you need to subtract the item offset from their indices before calling [funcPango.shape_with_flags].

Skips 0 or more characters of white space.

skip_space is deprecated: This method is deprecated.

Splits a G_SEARCHPATH_SEPARATOR-separated list of files, stripping white space and substituting ~/ with $HOME/.

split_file_list is deprecated: This method is deprecated.

Deserializes a PangoTabArray from a string.

This is the counterpart to [methodPango.TabArray.to_string]. See that functions for details about the format.

Apply language-specific tailoring to the breaks in attrs.

The line breaks are assumed to have been produced by [funcPango.default_break].

If offset is not -1, it is used to apply attributes from analysis that are relevant to line breaking.

Note that it is better to pass -1 for offset and use [funcPango.attr_break] to apply attributes to the whole paragraph.

Trims leading and trailing whitespace from a string.

trim_string is deprecated: This method is deprecated.

Determines the inherent direction of a character.

The inherent direction is 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, [funcPango.BidiType.for_unichar] can be used instead.

Converts a floating-point number to Pango units.

The conversion is done by multiplying d by PANGO_SCALE and rounding the result to nearest integer.

Converts a number in Pango units to floating-point.

The conversion is done by dividing i by PANGO_SCALE.

Returns the encoded version of Pango available at run-time.

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

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.

Compatibility is defined by two things: first the version of the running library is newer than the version required_major.required_minor.required_micro. Second 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().

Returns the version of Pango available at run-time.

This is similar to the macro PANGO_VERSION_STRING except that the macro returns the version available at compile-time.