Package ch.bailu.gtk.pango

Class GlyphItem

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.type.Record
ch.bailu.gtk.pango.GlyphItem
All Implemented Interfaces:
PointerInterface
public class GlyphItem extends Record
A `PangoGlyphItem` is a pair of a `PangoItem` and the glyphs
resulting from shaping the items text.

As an example of the usage of `PangoGlyphItem`, the results
of shaping text with `PangoLayout` is a list of `PangoLayoutLine`,
each of which contains a list of `PangoGlyphItem`.

https://docs.gtk.org/Pango/struct.GlyphItem.html

  • Field Details

    • ITEM

      public static final String ITEM
      corresponding `PangoItem`
      See Also:

    • GLYPHS

      public static final String GLYPHS
      corresponding `PangoGlyphString`
      See Also:

    • Y_OFFSET

      public static final String Y_OFFSET
      shift of the baseline, relative to the baseline
      of the containing line. Positive values shift upwards
      See Also:

    • START_X_OFFSET

      public static final String START_X_OFFSET
      horizontal displacement to apply before the
      glyph item. Positive values shift right
      See Also:

    • END_X_OFFSET

      public static final String END_X_OFFSET
      horizontal displacement to apply after th
      glyph item. Positive values shift right
      See Also:

  • Constructor Details

    • GlyphItem

      public GlyphItem(PointerContainer pointer)

    • GlyphItem

      public GlyphItem()

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • setFieldItem

      public void setFieldItem(Item item)
      corresponding `PangoItem`

    • getFieldItem

      public Item getFieldItem()
      corresponding `PangoItem`

    • setFieldGlyphs

      public void setFieldGlyphs(GlyphString glyphs)
      corresponding `PangoGlyphString`

    • getFieldGlyphs

      public GlyphString getFieldGlyphs()
      corresponding `PangoGlyphString`

    • setFieldYOffset

      public void setFieldYOffset(int y_offset)
      shift of the baseline, relative to the baseline
      of the containing line. Positive values shift upwards

    • getFieldYOffset

      public int getFieldYOffset()
      shift of the baseline, relative to the baseline
      of the containing line. Positive values shift upwards

    • setFieldStartXOffset

      public void setFieldStartXOffset(int start_x_offset)
      horizontal displacement to apply before the
      glyph item. Positive values shift right

    • getFieldStartXOffset

      public int getFieldStartXOffset()
      horizontal displacement to apply before the
      glyph item. Positive values shift right

    • setFieldEndXOffset

      public void setFieldEndXOffset(int end_x_offset)
      horizontal displacement to apply after th
      glyph item. Positive values shift right

    • getFieldEndXOffset

      public int getFieldEndXOffset()
      horizontal displacement to apply after th
      glyph item. Positive values shift right

    • applyAttrs

      public SList applyAttrs(@Nonnull Str text, @Nonnull AttrList list)
      Splits a shaped item (`PangoGlyphItem`) into multiple items based
      on an attribute list.

      The idea is that if you have attributes that don't affect shaping,
      such as color or underline, to avoid affecting shaping, you filter
      them out ([method@Pango.AttrList.filter]), apply the shaping process
      and then reapply them to the result using this function.

      All attributes that start or end inside a cluster are applied
      to that cluster; for instance, if half of a cluster is underlined
      and the other-half strikethrough, then the cluster will end
      up with both underline and strikethrough attributes. In these
      cases, it may happen that @item->extra_attrs for some of the
      result items can have multiple attributes of the same type.

      This function takes ownership of @glyph_item; it will be reused
      as one of the elements in the list.
      Parameters:
      text - text that @list applies to
      list - a `PangoAttrList`
      Returns:
      a list of glyph items resulting from splitting @glyph_item. Free the elements using [method@Pango.GlyphItem.free], the list using g_slist_free().

    • applyAttrs

      public SList applyAttrs(String text, @Nonnull AttrList list)
      Splits a shaped item (`PangoGlyphItem`) into multiple items based
      on an attribute list.

      The idea is that if you have attributes that don't affect shaping,
      such as color or underline, to avoid affecting shaping, you filter
      them out ([method@Pango.AttrList.filter]), apply the shaping process
      and then reapply them to the result using this function.

      All attributes that start or end inside a cluster are applied
      to that cluster; for instance, if half of a cluster is underlined
      and the other-half strikethrough, then the cluster will end
      up with both underline and strikethrough attributes. In these
      cases, it may happen that @item->extra_attrs for some of the
      result items can have multiple attributes of the same type.

      This function takes ownership of @glyph_item; it will be reused
      as one of the elements in the list.
      Parameters:
      text - text that @list applies to
      list - a `PangoAttrList`
      Returns:
      a list of glyph items resulting from splitting @glyph_item. Free the elements using [method@Pango.GlyphItem.free], the list using g_slist_free().

    • copy

      public GlyphItem copy()
      Make a deep copy of an existing `PangoGlyphItem` structure.
      Returns:
      the newly allocated `PangoGlyphItem`

    • free

      public void free()
      Frees a `PangoGlyphItem` and resources to which it points.

    • getLogicalWidths

      public void getLogicalWidths(@Nonnull Str text, @Nonnull Int logical_widths)
      Given a `PangoGlyphItem` and the corresponding text, determine the
      width corresponding to each character.

      When multiple characters compose a single cluster, the width of the
      entire cluster is divided equally among the characters.

      See also [method@Pango.GlyphString.get_logical_widths].
      Parameters:
      text - text that @glyph_item corresponds to (glyph_item->item->offset is an offset from the start of @text)
      logical_widths - an array whose length is the number of characters in glyph_item (equal to glyph_item->item->num_chars) to be filled in with the resulting character widths.

    • getLogicalWidths

      public void getLogicalWidths(String text, @Nonnull Int logical_widths)
      Given a `PangoGlyphItem` and the corresponding text, determine the
      width corresponding to each character.

      When multiple characters compose a single cluster, the width of the
      entire cluster is divided equally among the characters.

      See also [method@Pango.GlyphString.get_logical_widths].
      Parameters:
      text - text that @glyph_item corresponds to (glyph_item->item->offset is an offset from the start of @text)
      logical_widths - an array whose length is the number of characters in glyph_item (equal to glyph_item->item->num_chars) to be filled in with the resulting character widths.

    • split

      public GlyphItem split(@Nonnull Str text, int split_index)
      Modifies @orig to cover only the text after @split_index, and
      returns a new item that covers the text before @split_index that
      used to be in @orig.

      You can think of @split_index as the length of the returned item.
      @split_index may not be 0, and it may not be greater than or equal
      to the length of @orig (that is, there must be at least one byte
      assigned to each item, you can't create a zero-length item).

      This function is similar in function to pango_item_split() (and uses
      it internally.)
      Parameters:
      text - text to which positions in @orig apply
      split_index - byte index of position to split item, relative to the start of the item
      Returns:
      the newly allocated item representing text before @split_index, which should be freed with pango_glyph_item_free().

    • split

      public GlyphItem split(String text, int split_index)
      Modifies @orig to cover only the text after @split_index, and
      returns a new item that covers the text before @split_index that
      used to be in @orig.

      You can think of @split_index as the length of the returned item.
      @split_index may not be 0, and it may not be greater than or equal
      to the length of @orig (that is, there must be at least one byte
      assigned to each item, you can't create a zero-length item).

      This function is similar in function to pango_item_split() (and uses
      it internally.)
      Parameters:
      text - text to which positions in @orig apply
      split_index - byte index of position to split item, relative to the start of the item
      Returns:
      the newly allocated item representing text before @split_index, which should be freed with pango_glyph_item_free().

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()