Functions to run the rendering pipeline.

• The Pango rendering pipeline takes a string of Unicode characters and converts it into glyphs. The functions described in this module accomplish various steps of this process.

TODO

• Functions that are missing: pango_layout_set_attributes, pango_layout_get_attributes, pango_layout_set_font_description, pango_layout_set_tabs, pango_layout_get_tabs, pango_layout_get_log_attrs, pango_layout_iter_get_run
• The following functions cannot be bound easily due to Unicode/UTF8 issues: pango_layout_xy_to_index, pango_layout_index_to_pos, pango_layout_get_cursor_pos, pango_layout_move_cursor_visually, pango_layout_iter_get_index, pango_layout_line_index_to_x, pango_layout_line_x_to_index, pango_layout_line_get_x_ranges
• These functions are not bound, because they're too easy: pango_layout_get_size, pango_layout_get_pixel_size, pango_layout_get_line

Signal a Context change.

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

Set the string in the layout.

• The string may include Markup.

Set the string in the layout.

• The string may include Markup. Furthermore, any underscore character indicates that the next character should be marked as accelerator (i.e. underlined). A literal underscore character can be produced by placing it twice in the string.
• The character which follows the underscore is returned so it can be used to add the actual keyboard shortcut.

Set the width of this paragraph.

• Sets the width to which the lines of the PangoLayout should be wrapped.
• width is the desired width, or -1 to indicate that no wrapping should be performed.

Gets the width of this paragraph.

• Gets the width to which the lines of the PangoLayout should be wrapped.
• Returns is the current width, or -1 to indicate that no wrapping is performed.

Set how this paragraph is wrapped.

• Sets the wrap style; the wrap style only has an effect if a width is set on the layout with layoutSetWidth. To turn off wrapping, set the width to -1.

Set the indentation of this paragraph.

• Sets the amount by which the first line should be shorter than the rest of the lines. This may be negative, in which case the subsequent lines will be shorter than the first line. (However, in either case, the entire width of the layout will be given by the value.

Gets the indentation of this paragraph.

• Gets the amount by which the first line should be shorter than the rest of the lines.

Set if text should be streched to fit width.

• Sets whether or not each complete line should be stretched to fill the entire width of the layout. This stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification is done by extending the characters.

Retrieve the justification flag.

• See layoutSetJustify.

Set how this paragraph is aligned.

• Sets the alignment for the layout (how partial lines are positioned within the horizontal space available.)

Honor newlines or not.

• If honor 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.

Retrieve if newlines are honored.

• See layoutSetSingleParagraphMode.

Compute the physical size of the layout.

• Computes the logical and the ink size of the Layout. The logical layout is used for positioning, the ink size is the smallest bounding box that includes all character pixels. The ink size can be smaller or larger that the logical layout.
• All values are in layout units. To get to device units (pixel for Drawables) divide by pangoScale.

Compute the physical size of the layout.

• Computes the logical and the ink size of the Layout. The logical layout is used for positioning, the ink size is the smallest bounding box that includes all character pixels. The ink size can be smaller or larger that the logical layout.
• All values are in device units. This function is a wrapper around layoutGetExtents with scaling.

Extract the single lines of the layout.

• The lines of each layout are regenerated if any attribute changes. Thus the returned list does not reflect the current state of lines after a change has been made.

Move to the next run.

• Returns False if this was the last run in the layout.

Move to the next char.

• Returns False if this was the last char in the layout.

Move to the next cluster.

• Returns False if this was the last cluster in the layout.

Move to the next line.

• Returns False if this was the last line in the layout.

Check if the iterator is on the last line.

• Returns True if the iterator is on the last line of this paragraph.

Query the vertical position within the layout.

• Gets the y position of the current line's baseline, in layout coordinates (origin at top left of the entire layout).

Retrieve a rectangle surrounding a character.

• Get the extents of the current character in layout cooridnates (origin is the top left of the entire layout). Only logical extents can sensibly be obtained for characters.

Compute the physical size of the cluster.

• Computes the logical and the ink size of the cluster pointed to by LayoutIter.
• All values are in layoutIter units. To get to device units (pixel for Drawables) divide by pangoScale.

Compute the physical size of the run.

• Computes the logical and the ink size of the run pointed to by LayoutIter.
• All values are in layoutIter units. To get to device units (pixel for Drawables) divide by pangoScale.

Retrieve vertical extent of this line.

• Divides the vertical space in the PangoLayout being iterated over between the lines in the layout, and returns the space belonging to the current line. A line's range includes the line's logical extents, plus half of the spacing above and below the line, if pangoLayoutSetSpacing has been called to set layout spacing. The y positions are in layout coordinates (origin at top left of the entire layout).
• The first element in the returned tuple is the start, the second is the end of this line.

Compute the physical size of the line.

• Computes the logical and the ink size of the line pointed to by LayoutIter.
• Extents are in layout coordinates (origin is the top-left corner of the entire PangoLayout). Thus the extents returned by this function will be the same width/height but not at the same x/y as the extents returned from pangoLayoutLineGetExtents.

Compute the physical size of the line.

• Computes the logical and the ink size of the LayoutLine. The logical layout is used for positioning, the ink size is the smallest bounding box that includes all character pixels. The ink size can be smaller or larger that the logical layout.
• All values are in layout units. To get to device units (pixel for Drawables) divide by pangoScale.

Compute the physical size of the line.

• Computes the logical and the ink size of the LayoutLine. The logical layout is used for positioning, the ink size is the smallest bounding box that includes all character pixels. The ink size can be smaller or larger that the logical layout.
• All values are in device units. This function is a wrapper around layoutLineGetExtents with scaling.