Class LayoutIter

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.pango.LayoutIter
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class LayoutIter extends ProxyInstance

A PangoLayoutIter can be used to iterate over the visual extents of a PangoLayout.

To obtain a PangoLayoutIter, use Layout.getIter().

The PangoLayoutIter structure is opaque, and has no user-visible fields.

  • Constructor Details

    • LayoutIter

      public LayoutIter(MemorySegment address)
      Create a LayoutIter proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the LayoutIter class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • atLastLine

      public boolean atLastLine()
      Determines whether this LayoutIter is on the last line of the layout.
      Returns:
      true if this LayoutIter is on the last line

    • copy

      public @Nullable LayoutIter copy()
      Copies a PangoLayoutIter.
      Returns:
      the newly allocated PangoLayoutIter
      Since:
      1.20

    • free

      public void free()
      Frees an iterator that's no longer in use.

    • getBaseline

      public int getBaseline()

      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:
      baseline of current line

    • getCharExtents

      public void getCharExtents(Rectangle logicalRect)

      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.

      Parameters:
      logicalRect - rectangle to fill with logical extents

    • getClusterExtents

      public void getClusterExtents(@Nullable Rectangle inkRect, @Nullable Rectangle logicalRect)

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

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

      Parameters:
      inkRect - rectangle to fill with ink extents
      logicalRect - rectangle to fill with logical extents

    • getIndex

      public int getIndex()

      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 getRun()).

      Returns:
      current byte index

    • getLayout

      public @Nullable Layout getLayout()
      Gets the layout associated with a PangoLayoutIter.
      Returns:
      the layout associated with this LayoutIter
      Since:
      1.20

    • getLayoutExtents

      public void getLayoutExtents(@Nullable Rectangle inkRect, @Nullable Rectangle logicalRect)
      Obtains the extents of the PangoLayout being iterated over.
      Parameters:
      inkRect - rectangle to fill with ink extents
      logicalRect - rectangle to fill with logical extents

    • getLine

      public @Nullable LayoutLine getLine()

      Gets the current line.

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

      Returns:
      the current line

    • getLineExtents

      public void getLineExtents(@Nullable Rectangle inkRect, @Nullable Rectangle logicalRect)

      Obtains the extents of the current line.

      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 LayoutLine.getExtents(Rectangle, Rectangle).

      Parameters:
      inkRect - rectangle to fill with ink extents
      logicalRect - rectangle to fill with logical extents

    • getLineReadonly

      public @Nullable LayoutLine getLineReadonly()

      Gets the current line for read-only access.

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

      Returns:
      the current line, that should not be modified
      Since:
      1.16

    • getLineYrange

      public void getLineYrange(@Nullable Out<Integer> y0, @Nullable Out<Integer> y1)

      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 Layout.setSpacing(int) 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.

      Parameters:
      y0 - start of line
      y1 - end of line

    • getRun

      public @Nullable LayoutRun getRun()

      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 getRunReadonly() if you do not plan to modify the contents of the run (glyphs, glyph widths, etc.).

      Returns:
      the current run

    • getRunBaseline

      public int getRunBaseline()

      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.

      Since:
      1.50

    • getRunExtents

      public void getRunExtents(@Nullable Rectangle inkRect, @Nullable Rectangle logicalRect)

      Gets the extents of the current run in layout coordinates.

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

      Parameters:
      inkRect - rectangle to fill with ink extents
      logicalRect - rectangle to fill with logical extents

    • getRunReadonly

      public @Nullable LayoutRun getRunReadonly()

      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 getRun(), but the user is not expected to modify the contents of the run (glyphs, glyph widths, etc.).

      Returns:
      the current run, that should not be modified
      Since:
      1.16

    • nextChar

      public boolean nextChar()

      Moves this LayoutIter forward to the next character in visual order.

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

      Returns:
      whether motion was possible

    • nextCluster

      public boolean nextCluster()

      Moves this LayoutIter forward to the next cluster in visual order.

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

      Returns:
      whether motion was possible

    • nextLine

      public boolean nextLine()

      Moves this LayoutIter forward to the start of the next line.

      If this LayoutIter is already on the last line, returns false.

      Returns:
      whether motion was possible

    • nextRun

      public boolean nextRun()

      Moves this LayoutIter forward to the next run in visual order.

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

      Returns:
      whether motion was possible