Class (GI Struct)

Pango-1.0PangoAttrList

A Pango.AttrList represents a list of attributes that apply to a section of text.

The attributes in a Pango.AttrList are, in general, allowed to overlap in an arbitrary fashion. However, if the attributes are manipulated only through Pango.AttrList.change, the overlap between properties will meet stricter criteria.

Since the Pango.AttrList structure is stored as a linear list, it is not suitable for storing attributes for large amounts of text. In general, you should not use a single Pango.AttrList for more than one paragraph of text.

Index

Constructors

Properties

$gtype: GType<AttrList>

Methods

  • Insert the given attribute into the Pango.AttrList.

    It will replace any attributes of the same type on that segment and be merged with any adjoining attributes that are identical.

    This function is slower than Pango.AttrList.insert for creating an attribute list in order (potentially much slower for large lists). However, Pango.AttrList.insert is not suitable for continually changing a set of attributes since it never removes or combines existing attributes.

    Parameters

    Returns void

  • Checks whether list and other_list contain the same attributes and whether those attributes apply to the same ranges.

    Beware that this will return wrong values if any list contains duplicates.

    Parameters

    Returns boolean

    true if the lists are equal, false if they aren't

  • This function opens up a hole in list, fills it in with attributes from the left, and then merges other on top of the hole.

    This operation is equivalent to stretching every attribute that applies at position pos in list by an amount len, and then calling Pango.AttrList.change with a copy of each attribute in other in sequence (offset in position by pos, and limited in length to len).

    This operation proves useful for, for instance, inserting a pre-edit string in the middle of an edit buffer.

    For backwards compatibility, the function behaves differently when len is 0. In this case, the attributes from other are not imited to len, and are just overlayed on top of list.

    This mode is useful for merging two lists of attributes together.

    Parameters

    • other: AttrList
    • pos: number

      the position in list at which to insert other

    • len: number

      the length of the spliced segment. (Note that this must be specified since the attributes in other may only be present at some subsection of this range)

    Returns void

  • Serializes a Pango.AttrList to a string.

    In the resulting string, serialized attributes are separated by newlines or commas. Individual attributes are serialized to a string of the form

    [START END] TYPE VALUE
    

    Where START and END are the indices (with -1 being accepted in place of MAXUINT), TYPE is the nickname of the attribute value type, e.g. weight or stretch, and the value is serialized according to its type:

    Optionally, START and END can be omitted to indicate unlimited extent.

    • enum values as nick or numeric value
    • boolean values as true or false
    • integers and floats as numbers
    • strings as string, optionally quoted
    • font features as quoted string
    • PangoLanguage as string
    • PangoFontDescription as serialized by Pango.FontDescription.to_string, quoted
    • PangoColor as serialized by Pango.Color.to_string

    Examples:

    0 10 foreground red, 5 15 weight bold, 0 200 font-desc "Sans 10"
    
    0 -1 weight 700
    0 100 family Times
    
    weight bold
    

    To parse the returned value, use Pango.AttrList.from_string.

    Note that shape attributes can not be serialized.

    Returns string

    a newly allocated string

  • Decrease the reference count of the given attribute list by one.

    If the result is zero, free the attribute list and the attributes it contains.

    Returns void

  • Update indices of attributes in list for a change in the text they refer to.

    The change that this function applies is removing remove bytes at position pos and inserting add bytes instead.

    Attributes that fall entirely in the (pos, pos + remove) range are removed.

    Attributes that start or end inside the (pos, pos + remove) range are shortened to reflect the removal.

    Attributes start and end positions are updated if they are behind pos + remove.

    Parameters

    • pos: number

      the position of the change

    • remove: number

      the number of removed bytes

    • add: number

      the number of added bytes

    Returns void