Pango.Layout¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`deserialize` (context, bytes, flags)
class	`new` (context)
	`context_changed` ()
	`copy` ()
	`get_alignment` ()
	`get_attributes` ()
	`get_auto_dir` ()
	`get_baseline` ()
	`get_caret_pos` (index_)
	`get_character_count` ()
	`get_context` ()
	`get_cursor_pos` (index_)
	`get_direction` (index)
	`get_ellipsize` ()
	`get_extents` ()
	`get_font_description` ()
	`get_height` ()
	`get_indent` ()
	`get_iter` ()
	`get_justify` ()
	`get_justify_last_line` ()
	`get_line` (line)
	`get_line_count` ()
	`get_line_readonly` (line)
	`get_line_spacing` ()
	`get_lines` ()
	`get_lines_readonly` ()
	`get_log_attrs` ()
	`get_log_attrs_readonly` ()
	`get_pixel_extents` ()
	`get_pixel_size` ()
	`get_serial` ()
	`get_single_paragraph_mode` ()
	`get_size` ()
	`get_spacing` ()
	`get_tabs` ()
	`get_text` ()
	`get_unknown_glyphs_count` ()
	`get_width` ()
	`get_wrap` ()
	`index_to_line_x` (index_, trailing)
	`index_to_pos` (index_)
	`is_ellipsized` ()
	`is_wrapped` ()
	`move_cursor_visually` (strong, old_index, old_trailing, direction)
	`serialize` (flags)
	`set_alignment` (alignment)
	`set_attributes` (attrs)
	`set_auto_dir` (auto_dir)
	`set_ellipsize` (ellipsize)
	`set_font_description` (desc)
	`set_height` (height)
	`set_indent` (indent)
	`set_justify` (justify)
	`set_justify_last_line` (justify)
	`set_line_spacing` (factor)
	`set_markup` (markup, length)
	`set_markup_with_accel` (markup, length, accel_marker)
	`set_single_paragraph_mode` (setting)
	`set_spacing` (spacing)
	`set_tabs` (tabs)
	`set_text` (text, length)
	`set_width` (width)
	`set_wrap` (wrap)
	`write_to_file` (flags, filename)
	`xy_to_index` (x, y)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Pango.Layout(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Pango.LayoutClass

A PangoLayout structure represents an entire paragraph of text.

While complete access to the layout capabilities of Pango is provided using the detailed interfaces for itemization and shaping, using that functionality directly involves writing a fairly large amount of code. PangoLayout provides a high-level driver for formatting entire paragraphs of text at once. This includes paragraph-level functionality such as line breaking, justification, alignment and ellipsization.

A PangoLayout is initialized with a PangoContext, UTF-8 string and set of attributes for that string. Once that is done, the set of formatted lines can be extracted from the object, the layout can be rendered, and conversion between logical character positions within the layout’s text, and the physical position of the resulting glyphs can be made.

There are a number of parameters to adjust the formatting of a PangoLayout. The following image shows adjustable parameters (on the left) and font metrics (on the right):

The following images demonstrate the effect of alignment and justification on the layout of text:

| |
— | — |
align=left | align=left, justify |
align=center | align=center, justify |
align=right | align=right, justify |

It is possible, as well, to ignore the 2-D setup, and simply treat the results of a PangoLayout as a list of lines.

classmethod deserialize(context, bytes, flags)[source]¶

Parameters:

context (Pango.Context) – a PangoContext
bytes (GLib.Bytes) – the bytes containing the data
flags (Pango.LayoutDeserializeFlags) – PangoLayoutDeserializeFlags

Raises:

GLib.Error

Returns:

a new PangoLayout

Return type:

Pango.Layout or None

Loads data previously created via [method`Pango`.Layout.serialize].

For a discussion of the supported format, see that function.

Note: to verify that the returned layout is identical to the one that was serialized, you can compare bytes to the result of serializing the layout again.

New in version 1.50.

classmethod new(context)[source]¶

Parameters:: context (Pango.Context) – a PangoContext
Returns:: the newly allocated PangoLayout
Return type:: Pango.Layout

Create a new PangoLayout object with attributes initialized to default values for a particular PangoContext.

context_changed()[source]¶

Forces recomputation of any state in the PangoLayout that might depend on the layout’s context.

This function should be called if you make changes to the context subsequent to creating the layout.

copy()[source]¶

Returns:: the newly allocated PangoLayout
Return type:: Pango.Layout

Creates a deep copy-by-value of the layout.

The attribute list, tab array, and text from the original layout are all copied by value.

get_alignment()[source]¶

Returns:: the alignment
Return type:: Pango.Alignment

Gets the alignment for the layout: how partial lines are positioned within the horizontal space available.

get_attributes()[source]¶

Returns:: a PangoAttrList
Return type:: Pango.AttrList or None

Gets the attribute list for the layout, if any.

get_auto_dir()[source]¶

Returns:: True if the bidirectional base direction is computed from the layout’s contents, False otherwise
Return type:: bool

Gets whether to calculate the base direction for the layout according to its contents.

See [method`Pango`.Layout.set_auto_dir].

New in version 1.4.

get_baseline()[source]¶

Returns:: baseline of first line, from top of self
Return type:: int

Gets the Y position of baseline of the first line in self.

New in version 1.22.

get_caret_pos(index_)[source]¶

Parameters:

index (int) – the byte index of the cursor

Returns:

strong_pos:: location to store the strong cursor position
weak_pos:: location to store the weak cursor position

Return type:

(strong_pos: Pango.Rectangle, weak_pos: Pango.Rectangle)

Given an index within a layout, determines the positions that of the strong and weak cursors if the insertion point is at that index.

This is a variant of [method`Pango`.Layout.get_cursor_pos] that applies font metric information about caret slope and offset to the positions it returns.

New in version 1.50.

get_character_count()[source]¶

Returns:: the number of Unicode characters in the text of self
Return type:: int

Returns the number of Unicode characters in the the text of self.

New in version 1.30.

get_context()[source]¶

Returns:: the PangoContext for the layout
Return type:: Pango.Context

Retrieves the PangoContext used for this layout.

get_cursor_pos(index_)[source]¶

Parameters:

index (int) – the byte index of the cursor

Returns:

strong_pos:: location to store the strong cursor position
weak_pos:: location to store the weak cursor position

Return type:

(strong_pos: Pango.Rectangle, weak_pos: Pango.Rectangle)

Given an index within a layout, determines the positions that of the strong and weak cursors if the insertion point is at that index.

The position of each cursor is stored as a zero-width rectangle with the height of the run extents.

The strong cursor location is the location where characters of the directionality equal to the base direction of the layout are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the layout are inserted.

The following example shows text with both a strong and a weak cursor.

The strong cursor has a little arrow pointing to the right, the weak cursor to the left. Typing a ‘c’ in this situation will insert the character after the ‘b’, and typing another Hebrew character, like ‘ג’, will insert it at the end.

get_direction(index)[source]¶

Parameters:: index (int) – the byte index of the str
Returns:: the text direction at index
Return type:: Pango.Direction

Gets the text direction at the given character position in self.

New in version 1.46.

get_ellipsize()[source]¶

Returns:: the current ellipsization mode for self
Return type:: Pango.EllipsizeMode

Gets the type of ellipsization being performed for self.

See [method`Pango`.Layout.set_ellipsize].

Use [method`Pango`.Layout.is_ellipsized] to query whether any paragraphs were actually ellipsized.

New in version 1.6.

get_extents()[source]¶

Returns:

ink_rect:: rectangle used to store the extents of the layout as drawn
logical_rect:: rectangle used to store the logical extents of the layout

Return type:

(ink_rect: Pango.Rectangle, logical_rect: Pango.Rectangle)

Computes the logical and ink extents of self.

Logical extents are usually what you want for positioning things. Note that both extents may have non-zero x and y. You may want to use those to offset where you render the layout. Not doing that is a very typical bug that shows up as right-to-left layouts not being correctly positioned in a layout with a set width.

The extents are given in layout coordinates and in Pango units; layout coordinates begin at the top left corner of the layout.

get_font_description()[source]¶

Returns:: a pointer to the layout’s font description, or None if the font description from the layout’s context is inherited.
Return type:: Pango.FontDescription or None

Gets the font description for the layout, if any.

New in version 1.8.

get_height()[source]¶

Returns:: the height, in Pango units if positive, or number of lines if negative.
Return type:: int

Gets the height of layout used for ellipsization.

See [method`Pango`.Layout.set_height] for details.

New in version 1.20.

get_indent()[source]¶

Returns:: the indent in Pango units
Return type:: int

Gets the paragraph indent width in Pango units.

A negative value indicates a hanging indentation.

get_iter()[source]¶

Returns:: the new PangoLayoutIter
Return type:: Pango.LayoutIter

Returns an iterator to iterate over the visual extents of the layout.

get_justify()[source]¶

Returns:: the justify value
Return type:: bool

Gets whether each complete line should be stretched to fill the entire width of the layout.

get_justify_last_line()[source]¶

Returns:: the justify value
Return type:: bool

Gets whether the last line should be stretched to fill the entire width of the layout.

New in version 1.50.

get_line(line)[source]¶

Parameters:: line (int) – the index of a line, which must be between 0 and pango_layout_get_line_count(layout) - 1, inclusive.
Returns:: the requested PangoLayoutLine, or None if the index is out of range. This layout line can be ref’ed and retained, but will become invalid if changes are made to the PangoLayout.
Return type:: Pango.LayoutLine or None

Retrieves a particular line from a PangoLayout.

Use the faster [method`Pango`.Layout.get_line_readonly] if you do not plan to modify the contents of the line (glyphs, glyph widths, etc.).

get_line_count()[source]¶

Returns:: the line count
Return type:: int

Retrieves the count of lines for the self.

get_line_readonly(line)[source]¶

Parameters:: line (int) – the index of a line, which must be between 0 and pango_layout_get_line_count(layout) - 1, inclusive.
Returns:: the requested PangoLayoutLine, or None if the index is out of range. This layout line can be ref’ed and retained, but will become invalid if changes are made to the PangoLayout. No changes should be made to the line.
Return type:: Pango.LayoutLine or None

Retrieves a particular line from a PangoLayout.

This is a faster alternative to [method`Pango`.Layout.get_line], but the user is not expected to modify the contents of the line (glyphs, glyph widths, etc.).

New in version 1.16.

get_line_spacing()[source]¶

Return type:: float

Gets the line spacing factor of self.

See [method`Pango`.Layout.set_line_spacing].

New in version 1.44.

get_lines()[source]¶

Returns:: a GSList containing the lines in the layout. This points to internal data of the PangoLayout and must be used with care. It will become invalid on any change to the layout’s text or properties.
Return type:: [Pango.LayoutLine]

Returns the lines of the self as a list.

Use the faster [method`Pango`.Layout.get_lines_readonly] if you do not plan to modify the contents of the lines (glyphs, glyph widths, etc.).

get_lines_readonly()[source]¶

Returns:: a GSList containing the lines in the layout. This points to internal data of the PangoLayout and must be used with care. It will become invalid on any change to the layout’s text or properties. No changes should be made to the lines.
Return type:: [Pango.LayoutLine]

Returns the lines of the self as a list.

This is a faster alternative to [method`Pango`.Layout.get_lines], but the user is not expected to modify the contents of the lines (glyphs, glyph widths, etc.).

New in version 1.16.

get_log_attrs()[source]¶

Returns:: location to store a pointer to an array of logical attributes. This value must be freed with GLib.free().
Return type:: attrs: [Pango.LogAttr]

Retrieves an array of logical attributes for each character in the self.

get_log_attrs_readonly()[source]¶

Returns:: an array of logical attributes
Return type:: [Pango.LogAttr]

Retrieves an array of logical attributes for each character in the self.

This is a faster alternative to [method`Pango`.Layout.get_log_attrs]. The returned array is part of self and must not be modified. Modifying the layout will invalidate the returned array.

The number of attributes returned in n_attrs will be one more than the total number of characters in the layout, since there need to be attributes corresponding to both the position before the first character and the position after the last character.

New in version 1.30.

get_pixel_extents()[source]¶

Returns:

ink_rect:: rectangle used to store the extents of the layout as drawn
logical_rect:: rectangle used to store the logical extents of the layout

Return type:

(ink_rect: Pango.Rectangle, logical_rect: Pango.Rectangle)

Computes the logical and ink extents of self in device units.

This function just calls [method`Pango`.Layout.get_extents] followed by two [func`extents_to_pixels`] calls, rounding ink_rect and logical_rect such that the rounded rectangles fully contain the unrounded one (that is, passes them as first argument to [func`Pango`.extents_to_pixels]).

get_pixel_size()[source]¶

Returns:

width:: location to store the logical width
height:: location to store the logical height

Return type:

(width: int, height: int)

Determines the logical width and height of a PangoLayout in device units.

[method`Pango`.Layout.get_size] returns the width and height scaled by Pango.SCALE. This is simply a convenience function around [method`Pango`.Layout.get_pixel_extents].

get_serial()[source]¶

Returns:: The current serial number of self.
Return type:: int

Returns the current serial number of self.

The serial number is initialized to an small number larger than zero when a new layout is created and is increased whenever the layout is changed using any of the setter functions, or the PangoContext it uses has changed. The serial may wrap, but will never have the value 0. Since it can wrap, never compare it with “less than”, always use “not equals”.

This can be used to automatically detect changes to a PangoLayout, and is useful for example to decide whether a layout needs redrawing. To force the serial to be increased, use [method`Pango`.Layout.context_changed].

New in version 1.32.4.

get_single_paragraph_mode()[source]¶

Returns:: True if the layout does not break paragraphs at paragraph separator characters, False otherwise
Return type:: bool

Obtains whether self is in single paragraph mode.

See [method`Pango`.Layout.set_single_paragraph_mode].

get_size()[source]¶

Returns:

width:: location to store the logical width
height:: location to store the logical height

Return type:

(width: int, height: int)

Determines the logical width and height of a PangoLayout in Pango units.

This is simply a convenience function around [method`Pango`.Layout.get_extents].

get_spacing()[source]¶

Returns:: the spacing in Pango units
Return type:: int

Gets the amount of spacing between the lines of the layout.

get_tabs()[source]¶

Returns:: a copy of the tabs for this layout
Return type:: Pango.TabArray or None

Gets the current PangoTabArray used by this layout.

If no PangoTabArray has been set, then the default tabs are in use and None is returned. Default tabs are every 8 spaces.

The return value should be freed with [method`Pango`.TabArray.free].

get_text()[source]¶

Returns:: the text in the self
Return type:: str

Gets the text in the layout.

The returned text should not be freed or modified.

get_unknown_glyphs_count()[source]¶

Returns:: The number of unknown glyphs in self
Return type:: int

Counts the number of unknown glyphs in self.

This function can be used to determine if there are any fonts available to render all characters in a certain string, or when used in combination with Pango.AttrType.FALLBACK, to check if a certain font supports all the characters in the string.

New in version 1.16.

get_width()[source]¶

Returns:: the width in Pango units, or -1 if no width set.
Return type:: int

Gets the width to which the lines of the PangoLayout should wrap.

get_wrap()[source]¶

Returns:: active wrap mode.
Return type:: Pango.WrapMode

Gets the wrap mode for the layout.

Use [method`Pango`.Layout.is_wrapped] to query whether any paragraphs were actually wrapped.

index_to_line_x(index_, trailing)[source]¶

Parameters:

index (int) – the byte index of a grapheme within the layout
trailing (bool) – an integer indicating the edge of the grapheme to retrieve the position of. If > 0, the trailing edge of the grapheme, if 0, the leading of the grapheme

Returns:

line:: location to store resulting line index. (which will between 0 and Pango.Layout.get_line_count(layout) - 1)
x_pos:: location to store resulting position within line (Pango.SCALE units per device unit)

Return type:

(line: int, x_pos: int)

Converts from byte index_ within the self to line and X position.

The X position is measured from the left edge of the line.

index_to_pos(index_)[source]¶

Parameters:: index (int) – byte index within self
Returns:: rectangle in which to store the position of the grapheme
Return type:: pos: Pango.Rectangle

Converts from an index within a PangoLayout to the onscreen position corresponding to the grapheme at that index.

The returns is represented as rectangle. Note that pos->x is always the leading edge of the grapheme and pos->x + pos->width the trailing edge of the grapheme. If the directionality of the grapheme is right-to-left, then pos->width will be negative.

is_ellipsized()[source]¶

Returns:: True if any paragraphs had to be ellipsized, False otherwise
Return type:: bool

Queries whether the layout had to ellipsize any paragraphs.

This returns True if the ellipsization mode for self is not Pango.EllipsizeMode.NONE, a positive width is set on self, and there are paragraphs exceeding that width that have to be ellipsized.

New in version 1.16.

is_wrapped()[source]¶

Returns:: True if any paragraphs had to be wrapped, False otherwise
Return type:: bool

Queries whether the layout had to wrap any paragraphs.

This returns True if a positive width is set on self, ellipsization mode of self is set to Pango.EllipsizeMode.NONE, and there are paragraphs exceeding the layout width that have to be wrapped.

New in version 1.16.

move_cursor_visually(strong, old_index, old_trailing, direction)[source]¶

Parameters:

strong (bool) – whether the moving cursor is the strong cursor or the weak cursor. The strong cursor is the cursor corresponding to text insertion in the base direction for the layout.
old_index (int) – the byte index of the current cursor position
old_trailing (int) – if 0, the cursor was at the leading edge of the grapheme indicated by old_index, if > 0, the cursor was at the trailing edge.
direction (int) – direction to move cursor. A negative value indicates motion to the left

Returns:

new_index:: location to store the new cursor byte index. A value of -1 indicates that the cursor has been moved off the beginning of the layout. A value of GObject.G_MAXINT indicates that the cursor has been moved off the end of the layout.
new_trailing:: number of characters to move forward from the location returned for new_index to get the position where the cursor should be displayed. This allows distinguishing the position at the beginning of one line from the position at the end of the preceding line. new_index is always on the line where the cursor should be displayed.

Return type:

(new_index: int, new_trailing: int)

Computes a new cursor position from an old position and a direction.

If direction is positive, then the new position will cause the strong or weak cursor to be displayed one position to right of where it was with the old cursor position. If direction is negative, it will be moved to the left.

In the presence of bidirectional text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run.

Motion here is in cursor positions, not in characters, so a single call to this function may move the cursor over multiple characters when multiple characters combine to form a single grapheme.

serialize(flags)[source]¶

Parameters:: flags (Pango.LayoutSerializeFlags) – PangoLayoutSerializeFlags
Returns:: a GBytes containing the serialized form of self
Return type:: GLib.Bytes

Serializes the self for later deserialization via [func`Pango`.Layout.deserialize].

There are no guarantees about the format of the output across different versions of Pango and [func`Pango`.Layout.deserialize] will reject data that it cannot parse.

The intended use of this function is testing, benchmarking and debugging. The format is not meant as a permanent storage format.

New in version 1.50.

set_alignment(alignment)[source]¶

Parameters:: alignment (Pango.Alignment) – the alignment

Sets the alignment for the layout: how partial lines are positioned within the horizontal space available.

The default alignment is Pango.Alignment.LEFT.

set_attributes(attrs)[source]¶

Parameters:: attrs (Pango.AttrList or None) – a PangoAttrList

Sets the text attributes for a layout object.

References attrs, so the caller can unref its reference.

set_auto_dir(auto_dir)[source]¶

Parameters:: auto_dir (bool) – if True, compute the bidirectional base direction from the layout’s contents

Sets whether to calculate the base direction for the layout according to its contents.

When this flag is on (the default), then paragraphs in self that begin with strong right-to-left characters (Arabic and Hebrew principally), will have right-to-left layout, paragraphs with letters from other scripts will have left-to-right layout. Paragraphs with only neutral characters get their direction from the surrounding paragraphs.

When False, the choice between left-to-right and right-to-left layout is done according to the base direction of the layout’s PangoContext. (See [method`Pango`.Context.set_base_dir]).

When the auto-computed direction of a paragraph differs from the base direction of the context, the interpretation of Pango.Alignment.LEFT and Pango.Alignment.RIGHT are swapped.

New in version 1.4.

set_ellipsize(ellipsize)[source]¶

Parameters:: ellipsize (Pango.EllipsizeMode) – the new ellipsization mode for self

Sets the type of ellipsization being performed for self.

Depending on the ellipsization mode ellipsize text is removed from the start, middle, or end of text so they fit within the width and height of layout set with [method`Pango`.Layout.set_width] and [method`Pango`.Layout.set_height].

If the layout contains characters such as newlines that force it to be layed out in multiple paragraphs, then whether each paragraph is ellipsized separately or the entire layout is ellipsized as a whole depends on the set height of the layout.

The default value is Pango.EllipsizeMode.NONE.

See [method`Pango`.Layout.set_height] for details.

New in version 1.6.

set_font_description(desc)[source]¶

Parameters:: desc (Pango.FontDescription or None) – the new PangoFontDescription to unset the current font description

Sets the default font description for the layout.

If no font description is set on the layout, the font description from the layout’s context is used.

set_height(height)[source]¶

Parameters:: height (int) – the desired height of the layout in Pango units if positive, or desired number of lines if negative.

Sets the height to which the PangoLayout should be ellipsized at.

There are two different behaviors, based on whether height is positive or negative.

If height is positive, it will be the maximum height of the layout. Only lines would be shown that would fit, and if there is any text omitted, an ellipsis added. At least one line is included in each paragraph regardless of how small the height value is. A value of zero will render exactly one line for the entire layout.

If height is negative, it will be the (negative of) maximum number of lines per paragraph. That is, the total number of lines shown may well be more than this value if the layout contains multiple paragraphs of text. The default value of -1 means that the first line of each paragraph is ellipsized. This behavior may be changed in the future to act per layout instead of per paragraph. File a bug against pango at https://gitlab.gnome.org/gnome/pango if your code relies on this behavior.

Height setting only has effect if a positive width is set on self and ellipsization mode of self is not Pango.EllipsizeMode.NONE. The behavior is undefined if a height other than -1 is set and ellipsization mode is set to Pango.EllipsizeMode.NONE, and may change in the future.

New in version 1.20.

set_indent(indent)[source]¶

Parameters:: indent (int) – the amount by which to indent

Sets the width in Pango units to indent each paragraph.

A negative value of indent will produce a hanging indentation. That is, the first line will have the full width, and subsequent lines will be indented by the absolute value of indent.

The indent setting is ignored if layout alignment is set to Pango.Alignment.CENTER.

The default value is 0.

set_justify(justify)[source]¶

Parameters:: justify (bool) – whether the lines in the layout should be justified

Sets whether each complete line should be stretched to fill the entire width of the layout.

Stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification may be done in more complex ways, like extending the characters.

Note that this setting is not implemented and so is ignored in Pango older than 1.18.

Note that tabs and justification conflict with each other: Justification will move content away from its tab-aligned positions.

The default value is False.

Also see [method`Pango`.Layout.set_justify_last_line].

set_justify_last_line(justify)[source]¶

Parameters:: justify (bool) – whether the last line in the layout should be justified

Sets whether the last line should be stretched to fill the entire width of the layout.

This only has an effect if [method`Pango`.Layout.set_justify] has been called as well.

The default value is False.

New in version 1.50.

set_line_spacing(factor)[source]¶

Parameters:: factor (float) – the new line spacing factor

Sets a factor for line spacing.

Typical values are: 0, 1, 1.5, 2. The default values is 0.

If factor is non-zero, lines are placed so that

baseline2 = baseline1 + factor * height2

where height2 is the line height of the second line (as determined by the font(s)). In this case, the spacing set with [method`Pango`.Layout.set_spacing] is ignored.

If factor is zero (the default), spacing is applied as before.

Note: for semantics that are closer to the CSS line-height property, see [func`Pango`.attr_line_height_new].

New in version 1.44.

set_markup(markup, length)[source]¶

Parameters:

markup (str) – marked-up text
length (int) – length of marked-up text in bytes, or -1 if markup is NUL-terminated

Sets the layout text and attribute list from marked-up text.

See Pango Markup).

Replaces the current text and attribute list.

This is the same as [method`Pango`.Layout.set_markup_with_accel], but the markup text isn’t scanned for accelerators.

set_markup_with_accel(markup, length, accel_marker)[source]¶

Parameters:

markup (str) – marked-up text (see Pango Markup)
length (int) – length of marked-up text in bytes, or -1 if markup is NUL-terminated
accel_marker (str) – marker for accelerators in the text

Returns:

return location for first located accelerator

Return type:

accel_char: str

Sets the layout text and attribute list from marked-up text.

See Pango Markup).

Replaces the current text and 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.

set_single_paragraph_mode(setting)[source]¶

Parameters:: setting (bool) – new setting

Sets the single paragraph mode of self.

If setting is True, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters. Used when you want to allow editing of newlines on a single text line.

The default value is False.

set_spacing(spacing)[source]¶

Parameters:: spacing (int) – the amount of spacing

Sets the amount of spacing in Pango units between the lines of the layout.

When placing lines with spacing, Pango arranges things so that

line2.top = line1.bottom + spacing

The default value is 0.

Note: Since 1.44, Pango is using the line height (as determined by the font) for placing lines when the line spacing factor is set to a non-zero value with [method`Pango`.Layout.set_line_spacing]. In that case, the spacing set with this function is ignored.

Note: for semantics that are closer to the CSS line-height property, see [func`Pango`.attr_line_height_new].

set_tabs(tabs)[source]¶

Parameters:: tabs (Pango.TabArray or None) – a PangoTabArray

Sets the tabs to use for self, overriding the default tabs.

PangoLayout will place content at the next tab position whenever it meets a Tab character (U+0009).

By default, tabs are every 8 spaces. If tabs is None, the default tabs are reinstated. tabs is copied into the layout; you must free your copy of tabs yourself.

Note that tabs and justification conflict with each other: Justification will move content away from its tab-aligned positions. The same is true for alignments other than Pango.Alignment.LEFT.

set_text(text, length)[source]¶

Parameters:

text (str) – the text
length (int) – maximum length of text, in bytes. -1 indicates that the string is nul-terminated and the length should be calculated. The text will also be truncated on encountering a nul-termination even when length is positive.

Sets the text of the layout.

This function validates text and renders invalid UTF-8 with a placeholder glyph.

Note that if you have used [method`Pango`.Layout.set_markup] or [method`Pango`.Layout.set_markup_with_accel] on self before, you may want to call [method`Pango`.Layout.set_attributes] to clear the attributes set on the layout from the markup as this function does not clear attributes.

set_width(width)[source]¶

Parameters:: width (int) – the desired width in Pango units, or -1 to indicate that no wrapping or ellipsization should be performed.

Sets the width to which the lines of the PangoLayout should wrap or ellipsized.

The default value is -1: no width set.

set_wrap(wrap)[source]¶

Parameters:: wrap (Pango.WrapMode) – the wrap mode

Sets the wrap mode.

The wrap mode only has effect if a width is set on the layout with [method`Pango`.Layout.set_width]. To turn off wrapping, set the width to -1.

The default value is Pango.WrapMode.WORD.

write_to_file(flags, filename)[source]¶

Parameters:

flags (Pango.LayoutSerializeFlags) – PangoLayoutSerializeFlags
filename (str) – the file to save it to

Raises:

GLib.Error

Returns:

True if saving was successful

Return type:

bool

A convenience method to serialize a layout to a file.

It is equivalent to calling [method`Pango`.Layout.serialize] followed by [func`GLib`.file_set_contents].

See those two functions for details on the arguments.

It is mostly intended for use inside a debugger to quickly dump a layout to a file for later inspection.

New in version 1.50.

xy_to_index(x, y)[source]¶

Parameters:

x (int) – the X offset (in Pango units) from the left edge of the layout
y (int) – the Y offset (in Pango units) from the top edge of the layout

Returns:

True if the coordinates were inside text, False otherwise

index_:: location to store calculated byte index
trailing:: location to store a integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the leading edge of the grapheme.

Return type:

(bool, index_: int, trailing: int)

Converts from X and Y position within a layout to the byte index to the character at that logical position.

If the Y position is not inside the layout, the closest position is chosen (the position will be clamped inside the layout). If the X position is not within the layout, then the start or the end of the line is chosen as described for [method`Pango`.LayoutLine.x_to_index]. If either the X or Y positions were not inside the layout, then the function returns False; on an exact hit, it returns True.