pango/auto/

attr_list.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{Attribute, ffi};
use glib::translate::*;

glib::wrapper! {
    /// A [`AttrList`][crate::AttrList] represents a list of attributes that apply to a section
    /// of text.
    ///
    /// The attributes in a [`AttrList`][crate::AttrList] are, in general, allowed to overlap in
    /// an arbitrary fashion. However, if the attributes are manipulated only through
    /// [`change()`][Self::change()], the overlap between properties will meet
    /// stricter criteria.
    ///
    /// Since the [`AttrList`][crate::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`][crate::AttrList] for more than one paragraph of text.
    #[derive(Debug)]
    pub struct AttrList(Shared<ffi::PangoAttrList>);

    match fn {
        ref => |ptr| ffi::pango_attr_list_ref(ptr),
        unref => |ptr| ffi::pango_attr_list_unref(ptr),
        type_ => || ffi::pango_attr_list_get_type(),
    }
}

impl AttrList {
    /// Create a new empty attribute list with a reference
    /// count of one.
    ///
    /// # Returns
    ///
    /// the newly allocated
    ///   [`AttrList`][crate::AttrList], which should be freed with
    ///   `Pango::AttrList::unref()`
    #[doc(alias = "pango_attr_list_new")]
    pub fn new() -> AttrList {
        unsafe { from_glib_full(ffi::pango_attr_list_new()) }
    }

    #[doc(alias = "pango_attr_list_copy")]
    #[must_use]
    pub fn copy(&self) -> Option<AttrList> {
        unsafe { from_glib_full(ffi::pango_attr_list_copy(self.to_glib_none().0)) }
    }

    /// Given a [`AttrList`][crate::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`][crate::AttrList] or [`None`] if no attributes of the
    ///   given types were found
    #[doc(alias = "pango_attr_list_filter")]
    #[must_use]
    pub fn filter<P: FnMut(&Attribute) -> bool>(&self, func: P) -> Option<AttrList> {
        let mut func_data: P = func;
        unsafe extern "C" fn func_func<P: FnMut(&Attribute) -> bool>(
            attribute: *mut ffi::PangoAttribute,
            user_data: glib::ffi::gpointer,
        ) -> glib::ffi::gboolean {
            unsafe {
                let attribute = from_glib_borrow(attribute);
                let callback = user_data as *mut P;
                (*callback)(&attribute).into_glib()
            }
        }
        let func = Some(func_func::<P> as _);
        let super_callback0: &mut P = &mut func_data;
        unsafe {
            from_glib_full(ffi::pango_attr_list_filter(
                self.to_glib_none().0,
                func,
                super_callback0 as *mut _ as *mut _,
            ))
        }
    }

    /// 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.
    #[cfg(feature = "v1_44")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_44")))]
    #[doc(alias = "pango_attr_list_get_attributes")]
    #[doc(alias = "get_attributes")]
    pub fn attributes(&self) -> Vec<Attribute> {
        unsafe {
            FromGlibPtrContainer::from_glib_full(ffi::pango_attr_list_get_attributes(
                self.to_glib_none().0,
            ))
        }
    }

    /// 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()`][Self::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 @self.
    ///
    /// This mode is useful for merging two lists of attributes together.
    /// ## `other`
    /// another [`AttrList`][crate::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)
    #[doc(alias = "pango_attr_list_splice")]
    pub fn splice(&self, other: &AttrList, pos: i32, len: i32) {
        unsafe {
            ffi::pango_attr_list_splice(self.to_glib_none().0, other.to_glib_none().0, pos, len);
        }
    }

    /// Serializes a [`AttrList`][crate::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 [`FontDescription::to_str()`][crate::FontDescription::to_str()], quoted
    /// - PangoColor as serialized by [`Color::to_str()`][crate::Color::to_str()]
    ///
    /// 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 [`from_string()`][Self::from_string()].
    ///
    /// Note that shape attributes can not be serialized.
    ///
    /// # Returns
    ///
    /// a newly allocated string
    #[cfg(feature = "v1_50")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_50")))]
    #[doc(alias = "pango_attr_list_to_string")]
    #[doc(alias = "to_string")]
    pub fn to_str(&self) -> glib::GString {
        unsafe { from_glib_full(ffi::pango_attr_list_to_string(self.to_glib_none().0)) }
    }

    /// 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
    #[cfg(feature = "v1_44")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_44")))]
    #[doc(alias = "pango_attr_list_update")]
    pub fn update(&self, pos: i32, remove: i32, add: i32) {
        unsafe {
            ffi::pango_attr_list_update(self.to_glib_none().0, pos, remove, add);
        }
    }

    /// Deserializes a [`AttrList`][crate::AttrList] from a string.
    ///
    /// This is the counterpart to [`to_str()`][Self::to_str()].
    /// See that functions for details about the format.
    /// ## `text`
    /// a string
    ///
    /// # Returns
    ///
    /// a new [`AttrList`][crate::AttrList]
    #[cfg(feature = "v1_50")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_50")))]
    #[doc(alias = "pango_attr_list_from_string")]
    pub fn from_string(text: &str) -> Result<AttrList, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(ffi::pango_attr_list_from_string(text.to_glib_none().0))
                .ok_or_else(|| glib::bool_error!("Can't parse AttrList"))
        }
    }
}

impl Default for AttrList {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(feature = "v1_50")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_50")))]
impl std::fmt::Display for AttrList {
    #[inline]
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.write_str(&self.to_str())
    }
}