Pango-1.0 ▶ Pango ▶ GlyphItem

constructor

• new GlyphItem(): GlyphItem

  Returns GlyphItem

end_x_offset

glyphs

start_x_offset

y_offset

Static$gtype

apply_attrs

• apply_attrs(text: string, list: AttrList): GlyphItem[]

  Splits a shaped item (Pango.GlyphItem) 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 (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: string

    text that list applies to

  • list: AttrList

    a Pango.AttrList

  Returns GlyphItem[]

  a list of glyph items resulting from splitting glyph_item. Free the elements using Pango.GlyphItem.free, the list using g_slist_free().

copy

• copy(): GlyphItem

  Make a deep copy of an existing Pango.GlyphItem structure.

  Returns GlyphItem

  the newly allocated Pango.GlyphItem

free

• free(): void

  Frees a Pango.GlyphItem and resources to which it points.

  Returns void

get_logical_widths

• get_logical_widths(text: string): number[]

  Given a Pango.GlyphItem 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 Pango.GlyphString.get_logical_widths.

  Parameters

  • text: string

    text that glyph_item corresponds to (glyph_item->item->offset is an offset from the start of text)

  Returns number[]

letter_space

• letter_space(text: string, log_attrs: LogAttr[], letter_spacing: number): void

  Adds spacing between the graphemes of glyph_item to give the effect of typographic letter spacing.

  Parameters

  • text: string

    text that glyph_item corresponds to (glyph_item->item->offset is an offset from the start of text)

  • log_attrs: LogAttr[]

    logical attributes for the item (the first logical attribute refers to the position before the first character in the item)

  • letter_spacing: number

    amount of letter spacing to add in Pango units. May be negative, though too large negative values will give ugly results.

  Returns void

split

• split(text: string, split_index: number): GlyphItem

  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: string

    text to which positions in orig apply

  • split_index: number

    byte index of position to split item, relative to the start of the item

  Returns GlyphItem

  the newly allocated item representing text before split_index, which should be freed with pango_glyph_item_free().