Struct pango::AttrList

pub struct AttrList(_);

The AttrList structure represents a list of attributes that apply to a section of text. The attributes are, in general, allowed to overlap in an arbitrary fashion, however, if the attributes are manipulated only through change(), the overlap between properties will meet stricter criteria.

Since the 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 AttrList for more than one paragraph of text.

Implementations

impl AttrList

pub fn new() -> AttrList

Create a new empty attribute list with a reference count of one.

Returns

the newly allocated AttrList, which should be freed with pango_attr_list_unref().

pub fn copy(&self) -> Option<AttrList>

Copy self and return an identical new list.

Returns

the newly allocated AttrList, with a reference count of one, which should be freed with pango_attr_list_unref(). Returns None if self was None.

pub fn filter<P: FnMut(&Attribute) -> bool>(&self, func: P) -> Option<AttrList>

Given a AttrList and callback function, removes any elements of self for which func returns true and inserts them into a new list.

func

callback function; returns true if an attribute should be filtered out.

Returns

the new AttrList or None if no attributes of the given types were found.

pub fn attributes(&self) -> Vec<Attribute>

This is supported on crate feature v1_44 only.

Gets a list of all attributes in self.

Returns

a list of all attributes in self. To free this value, call pango_attribute_destroy() on each value and g_slist_free() on the list.

pub fn iterator(&self) -> Option<AttrIterator>

Create a iterator initialized to the beginning of the list. self must not be modified until this iterator is freed.

Returns

the newly allocated AttrIterator, which should be freed with pango_attr_iterator_destroy().

pub fn splice(&self, other: &AttrList, pos: i32, len: i32)

This function opens up a hole in self, 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 self by an amount len, and then calling change() with a copy of each attribute in other in sequence (offset in position by pos).

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

other

another AttrList

pos

the position in self at which to insert other

len

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)

pub fn update(&self, pos: i32, remove: i32, add: i32)

This is supported on crate feature v1_44 only.

Update indices of attributes in self 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.

pos

the position of the change

remove

the number of removed bytes

add

the number of added bytes

impl AttrList

pub fn change(&self, attr: Attribute)

Insert the given attribute into the 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 insert() for creating an attribute list in order (potentially much slower for large lists). However, insert() is not suitable for continually changing a set of attributes since it never removes or combines existing attributes.

attr

the attribute to insert. Ownership of this value is assumed by the list.

pub fn insert(&self, attr: Attribute)

Insert the given attribute into the AttrList. It will be inserted after all other attributes with a matching start_index.

attr

the attribute to insert. Ownership of this value is assumed by the list.

pub fn insert_before(&self, attr: Attribute)

Insert the given attribute into the AttrList. It will be inserted before all other attributes with a matching start_index.

attr

the attribute to insert. Ownership of this value is assumed by the list.

Trait Implementations

impl Clone for AttrList

fn clone(&self) -> AttrList

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AttrList

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AttrList

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<AttrList> for AttrList

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StaticType for AttrList

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AttrList