Gjsify LogoGjsify Logo

A PangoLayoutLine represents one of the lines resulting from laying out a paragraph via PangoLayout.

PangoLayoutLine structures are obtained by calling [methodPango.Layout.get_line] and are only valid until the text, attributes, or settings of the parent PangoLayout are modified.

record

Hierarchy

  • LayoutLine

Index

Constructors

Properties

isParagraphStart: number

#TRUE if this is the first line of the paragraph

field
layout: Pango.Layout

the layout this line belongs to, might be %NULL

field
length: number

length of line in bytes

field
resolvedDir: number

#Resolved PangoDirection of line

field
runs: GlyphItem[]

list of runs in the line, from left to right

field
startIndex: number

start of line as byte index into layout->text

field
name: string

Methods

  • getHeight(): number
  • Computes the height of the line, as the maximum of the heights of fonts used in this line.

    Note that the actual baseline-to-baseline distance between lines of text is influenced by other factors, such as [methodPango.Layout.set_spacing] and [methodPango.Layout.set_line_spacing].

    Returns number

  • getLength(): number
  • Computes the logical and ink extents of layout_line in device units.

    This function just calls [methodPango.LayoutLine.get_extents] followed by two [funcextents_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 [funcextents_to_pixels]).

    Returns [Pango.Rectangle, Pango.Rectangle]

  • getStartIndex(): number
  • Returns the start index of the line, as byte index into the text of the layout.

    Returns number

  • getXRanges(startIndex: number, endIndex: number): number[]
  • Gets a list of visual ranges corresponding to a given logical range.

    This list is not necessarily minimal - there may be consecutive ranges which are adjacent. The ranges will be sorted from left to right. The ranges are with respect to the left edge of the entire layout, not with respect to the line.

    Parameters

    • startIndex: number

      Start byte index of the logical range. If this value is less than the start index for the line, then the first range will extend all the way to the leading edge of the layout. Otherwise, it will start at the leading edge of the first character.

    • endIndex: number

      Ending byte index of the logical range. If this value is greater than the end index for the line, then the last range will extend all the way to the trailing edge of the layout. Otherwise, it will end at the trailing edge of the last character.

    Returns number[]

  • indexToX(index: number, trailing: boolean): number
  • Converts an index within a line to a X position.

    Parameters

    • index: number

      byte offset of a grapheme within the layout

    • trailing: boolean

      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 number

  • unref(): void
  • Decrease the reference count of a PangoLayoutLine by one.

    If the result is zero, the line and all associated memory will be freed.

    Returns void

  • xToIndex(xPos: number): [boolean, number, number]
  • Converts from x offset to the byte index of the corresponding character within the text of the layout.

    If x_pos is outside the line, index_ and trailing will point to the very first or very last position in the line. This determination is based on the resolved direction of the paragraph; for example, if the resolved direction is right-to-left, then an X position to the right of the line (after it) results in 0 being stored in index_ and trailing. An X position to the left of the line results in index_ pointing to the (logical) last grapheme in the line and trailing being set to the number of characters in that grapheme. The reverse is true for a left-to-right line.

    Parameters

    • xPos: number

      the X offset (in Pango units) from the left edge of the line.

    Returns [boolean, number, number]

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method