Create a new Pango.Layout

Parameters:

Object properties

Create a new Pango.Layout

Parameters:

Pango.Context context Required (not null)

Returns:

Pango.Layout

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.

Returns:

none

Does a deep copy-by-value of the src layout. The attribute list, tab array, and text from the original layout are all copied by value. count of one, which should be freed with g_object_unref().

Returns:

Pango.Layout

positioned within the horizontal space available.

Returns:

Pango.Alignment

Gets the attribute list for the layout, if any.

Returns:

Pango.AttrList

Gets whether to calculate the bidirectional base direction for the layout according to the contents of the layout. See pango_layout_set_auto_dir(). is computed from the layout's contents, FALSE otherwise.

Returns:

Boolean

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

Returns:

Number

Retrieves the PangoContext used for this layout. have an additional refcount added, so if you want to keep a copy of this around, you must reference it yourself.

Returns:

Pango.Context

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

Parameters:

Number index_ Required (not null)

Pango.Rectangle strong_pos Required (not null)

Pango.Rectangle weak_pos Required (not null)

Returns:

none

Gets the type of ellipsization being performed for layout. See pango_layout_set_ellipsize() Use pango_layout_is_ellipsized() to query whether any paragraphs were actually ellipsized.

Returns:

Pango.EllipsizeMode

Computes the logical and ink extents of layout. 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.

Parameters:

Pango.Rectangle ink_rect Required (not null)

or NULL to indicate that the result is not needed.

Pango.Rectangle logical_rect Required (not null)

NULL to indicate that the result is not needed.

Returns:

none

Gets the font description for the layout, if any. or NULL if the font description from the layout's context is inherited. This value is owned by the layout and must not be modified or freed.

Returns:

Pango.FontDescription

Gets the height of layout used for ellipsization. See pango_layout_set_height() for details. number of lines if negative.

Returns:

Number

Gets the paragraph indent width in Pango units. A negative value indicates a hanging indentation.

Returns:

Number

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

Returns:

Pango.LayoutIter

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

Returns:

Boolean

Retrieves a particular line from a PangoLayout. Use the faster pango_layout_get_line_readonly() if you do not plan to modify the contents of the line (glyphs, glyph widths, etc.). 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.

Parameters:

Number line Required (not null)

pango_layout_get_line_count(layout) - 1, inclusive.

Returns:

Pango.LayoutLine

Retrieves the count of lines for the layout.

Returns:

Number

Retrieves a particular line from a PangoLayout. This is a faster alternative to pango_layout_get_line(), but the user is not expected to modify the contents of the line (glyphs, glyph widths, etc.). 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.

Parameters:

Number line Required (not null)

pango_layout_get_line_count(layout) - 1, inclusive.

Returns:

Pango.LayoutLine

Returns the lines of the layout as a list. Use the faster pango_layout_get_lines_readonly() if you do not plan to modify the contents of the lines (glyphs, glyph widths, etc.). 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.

Returns:

Array a GSList containing

Returns the lines of the layout as a list. This is a faster alternative to pango_layout_get_lines(), but the user is not expected to modify the contents of the lines (glyphs, glyph widths, etc.). 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.

Returns:

Array a GSList containing

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

Parameters:

Pango.LogAttr attrs Required (not null)

This value must be freed with g_free().

Returns:

Number

Computes the logical and ink extents of layout in device units. This function just calls pango_layout_get_extents() followed by two pango_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 pango_extents_to_pixels()).

Parameters:

Pango.Rectangle ink_rect Required (not null)

or NULL to indicate that the result is not needed.

Pango.Rectangle logical_rect Required (not null)

layout or NULL to indicate that the result is not needed.

Returns:

none

Determines the logical width and height of a PangoLayout in device units. (pango_layout_get_size() returns the width and height scaled by PANGO_SCALE.) This is simply a convenience function around pango_layout_get_pixel_extents().

Returns:

width: Number

height: Number

Obtains the value set by pango_layout_set_single_paragraph_mode(). paragraph separator characters, FALSE otherwise.

Returns:

Boolean

Determines the logical width and height of a PangoLayout in Pango units (device units scaled by PANGO_SCALE). This is simply a convenience function around pango_layout_get_extents().

Returns:

width: Number

height: Number

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

Returns:

Number

Gets the current PangoTabArray used by this layout. If no PangoTabArray has been set, then the default tabs are in use and NULL is returned. Default tabs are every 8 spaces. The return value should be freed with pango_tab_array_free().

Returns:

Pango.TabArray

Gets the text in the layout. The returned text should not be freed or modified.

Returns:

String

Counts the number unknown glyphs in layout. That is, zero if glyphs for all characters in the layout text were found, or more than zero otherwise. 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_ATTR_FALLBACK, to check if a certain font supports all the characters in the string.

Returns:

Number

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

Returns:

Number

Gets the wrap mode for the layout. Use pango_layout_is_wrapped() to query whether any paragraphs were actually wrapped.

Returns:

Pango.WrapMode

Converts from byte index_ within the layout to line and X position. (X position is measured from the left edge of the line)

Parameters:

Number index_ Required (not null)

Boolean trailing Required (not null)

position of. If 0, the trailing edge of the grapheme, if > 0, the leading of the grapheme.

Returns:

line: Number

x_pos: Number

Converts from an index within a PangoLayout to the onscreen position corresponding to the grapheme at that index, which 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.

Parameters:

Number index_ Required (not null)

Pango.Rectangle pos Required (not null)

Returns:

none

Queries whether the layout had to ellipsize any paragraphs. This returns TRUE if the ellipsization mode for layout is not PANGO_ELLIPSIZE_NONE, a positive width is set on layout, and there are paragraphs exceeding that width that have to be ellipsized. otherwise.

Returns:

Boolean

Queries whether the layout had to wrap any paragraphs. This returns TRUE if a positive width is set on layout, ellipsization mode of layout is set to PANGO_ELLIPSIZE_NONE, and there are paragraphs exceeding the layout width that have to be wrapped. otherwise.

Returns:

Boolean

Computes a new cursor position from an old position and a count of positions to move visually. If direction is positive, then the new strong cursor position will be one position to the right of the old cursor position. If direction is negative, then the new strong cursor position will be one position to the left of the old cursor position. 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 pango_layout_move_cursor_visually() may move the cursor over multiple characters when multiple characters combine to form a single grapheme.

Parameters:

Boolean strong Required (not null)

weak cursor. The strong cursor is the cursor corresponding to text insertion in the base direction for the layout.

Number old_index Required (not null)

Number old_trailing Required (not null)

grapheme indicated by old_index, if > 0, the cursor was at the leading edge.

Number direction Required (not null)

value indicates motion to the left.

Returns:

new_index: Number

new_trailing: Number

positioned within the horizontal space available.

Parameters:

Pango.Alignment alignment Required (not null)

Returns:

none

Sets the text attributes for a layout object. References attrs, so the caller can unref its reference.

Parameters:

Pango.AttrList attrs Required (not null)

Returns:

none

Sets whether to calculate the bidirectional base direction for the layout according to the contents of the layout; when this flag is on (the default), then paragraphs in ayout 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 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_ALIGN_LEFT and PANGO_ALIGN_RIGHT are swapped.

Parameters:

Boolean auto_dir Required (not null)

from the layout's contents.

Returns:

none

Sets the type of ellipsization being performed for layout. 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 pango_layout_set_width() and 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. See pango_layout_set_height() for details.

Parameters:

Pango.EllipsizeMode ellipsize Required (not null)

Returns:

none

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.

Parameters:

Pango.FontDescription desc Required (not null)

current font description

Returns:

none

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 first line of each paragraph is ellipsized. This behvaior may be changed in the future to act per layout instead of per paragraph. File a bug against pango at http://bugzilla.gnome.org/ if your code relies on this behavior. Height setting only has effect if a positive width is set on The behavior is undefined if a height other than -1 is set and ellipsization mode is set to PANGO_ELLIPSIZE_NONE, and may change in the future.

Parameters:

Number height Required (not null)

or desired number of lines if negative.

Returns:

none

Parameters:

Number indent Required (not null)

Returns:

none

Sets whether 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 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.

Parameters:

Boolean justify Required (not null)

Returns:

none

Same as pango_layout_set_markup_with_accel(), but the markup text isn't scanned for accelerators.

Parameters:

String markup Required (not null)

Number length Required (not null)

nul-terminated

Returns:

none

Sets the layout text and attribute list from marked-up text (see markup format). 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.

Parameters:

String markup Required (not null)

(see markup format)

Number length Required (not null)

nul-terminated

Number accel_marker Required (not null)

Number accel_char Required (not null)

Returns:

none

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.

Parameters:

Boolean setting Required (not null)

Returns:

none

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

Parameters:

Number spacing Required (not null)

Returns:

none

Sets the tabs to use for layout, overriding the default tabs (by default, tabs are every 8 spaces). If tabs is NULL, the default tabs are reinstated. tabs is copied into the layout; you must free your copy of tabs yourself.

Parameters:

Pango.TabArray tabs Required (not null)

Returns:

none

Sets the text of the layout. Note that if you have used pango_layout_set_markup() or pango_layout_set_markup_with_accel() on the attributes set on the layout from the markup as this function does not clear attributes.

Parameters:

String text Required (not null)

Number length Required (not null)

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.

Returns:

none

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

Parameters:

Number width Required (not null)

wrapping or ellipsization should be performed.

Returns:

none

Sets the wrap mode; the wrap mode only has effect if a width is set on the layout with pango_layout_set_width(). To turn off wrapping, set the width to -1.

Parameters:

Pango.WrapMode wrap Required (not null)

Returns:

none

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

Parameters:

Number x Required (not null)

from the left edge of the layout.

Number y Required (not null)

from the top edge of the layout

Object out_values

Number index_

Number trailing

Returns:

Boolean