Pango-1.0 ▶ Pango ▶ LayoutIterAbstract

constructor

• new LayoutIter(): LayoutIter

  Returns LayoutIter

Static$gtype

at_last_line

• at_last_line(): boolean

  Determines whether iter is on the last line of the layout.

  Returns boolean

  true if iter is on the last line

copy

• copy(): LayoutIter

  Copies a Pango.LayoutIter.

  Returns LayoutIter

  the newly allocated Pango.LayoutIter

free

• free(): void

  Frees an iterator that's no longer in use.

  Returns void

get_baseline

• get_baseline(): number

  Gets the Y position of the current line's baseline, in layout coordinates.

  Layout coordinates have the origin at the top left of the entire layout.

  Returns number

  baseline of current line

get_char_extents

• get_char_extents(): Pango.Rectangle

  Gets the extents of the current character, in layout coordinates.

  Layout coordinates have the origin at the top left of the entire layout.

  Only logical extents can sensibly be obtained for characters; ink extents make sense only down to the level of clusters.

  Returns Pango.Rectangle

get_cluster_extents

• get_cluster_extents(): [Pango.Rectangle, Pango.Rectangle]

  Gets the extents of the current cluster, in layout coordinates.

  Layout coordinates have the origin at the top left of the entire layout.

  Returns [Pango.Rectangle, Pango.Rectangle]

get_index

• get_index(): number

  Gets the current byte index.

  Note that iterating forward by char moves in visual order, not logical order, so indexes may not be sequential. Also, the index may be equal to the length of the text in the layout, if on the null run (see Pango.LayoutIter.get_run).

  Returns number

  current byte index

get_layout

• get_layout(): Pango.Layout

  Gets the layout associated with a Pango.LayoutIter.

  Returns Pango.Layout

  the layout associated with iter

get_layout_extents

• get_layout_extents(): [Pango.Rectangle, Pango.Rectangle]

  Obtains the extents of the Pango.Layout being iterated over.

  Returns [Pango.Rectangle, Pango.Rectangle]

get_line

• get_line(): LayoutLine

  Gets the current line.

  Use the faster Pango.LayoutIter.get_line_readonly if you do not plan to modify the contents of the line (glyphs, glyph widths, etc.).

  Returns LayoutLine

  the current line

get_line_extents

• get_line_extents(): [Pango.Rectangle, Pango.Rectangle]

  Obtains the extents of the current line.

  Extents are in layout coordinates (origin is the top-left corner of the entire Pango.Layout). 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 Pango.LayoutLine.get_extents.

  Returns [Pango.Rectangle, Pango.Rectangle]

get_line_readonly

• get_line_readonly(): LayoutLine

  Gets the current line for read-only access.

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

  Returns LayoutLine

  the current line, that should not be modified

get_line_yrange

• get_line_yrange(): [number, number]

  Divides the vertical space in the Pango.Layout 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 Pango.Layout.set_spacing has been called to set layout spacing. The Y positions are in layout coordinates (origin at top left of the entire layout).

  Note: Since 1.44, Pango uses line heights for placing lines, and there may be gaps between the ranges returned by this function.

  Returns [number, number]

get_run

• get_run(): GlyphItem

  Gets the current run.

  When iterating by run, at the end of each line, there's a position with a null run, so this function can return null. The null run at the end of each line ensures that all lines have at least one run, even lines consisting of only a newline.

  Use the faster Pango.LayoutIter.get_run_readonly if you do not plan to modify the contents of the run (glyphs, glyph widths, etc.).

  Returns GlyphItem

  the current run

get_run_baseline

• get_run_baseline(): number

  Gets the Y position of the current run's baseline, in layout coordinates.

  Layout coordinates have the origin at the top left of the entire layout.

  The run baseline can be different from the line baseline, for example due to superscript or subscript positioning.

  Returns number

get_run_extents

• get_run_extents(): [Pango.Rectangle, Pango.Rectangle]

  Gets the extents of the current run in layout coordinates.

  Layout coordinates have the origin at the top left of the entire layout.

  Returns [Pango.Rectangle, Pango.Rectangle]

get_run_readonly

• get_run_readonly(): GlyphItem

  Gets the current run for read-only access.

  When iterating by run, at the end of each line, there's a position with a null run, so this function can return null. The null run at the end of each line ensures that all lines have at least one run, even lines consisting of only a newline.

  This is a faster alternative to Pango.LayoutIter.get_run, but the user is not expected to modify the contents of the run (glyphs, glyph widths, etc.).

  Returns GlyphItem

  the current run, that should not be modified

next_char

• next_char(): boolean

  Moves iter forward to the next character in visual order.

  If iter was already at the end of the layout, returns false.

  Returns boolean

  whether motion was possible

next_cluster

• next_cluster(): boolean

  Moves iter forward to the next cluster in visual order.

  If iter was already at the end of the layout, returns false.

  Returns boolean

  whether motion was possible

next_line

• next_line(): boolean

  Moves iter forward to the start of the next line.

  If iter is already on the last line, returns false.

  Returns boolean

  whether motion was possible

next_run

• next_run(): boolean

  Moves iter forward to the next run in visual order.

  If iter was already at the end of the layout, returns false.

  Returns boolean

  whether motion was possible