pango/auto/

tab_array.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::{ffi, TabAlign};
use glib::translate::*;

glib::wrapper! {
    /// A [`TabArray`][crate::TabArray] contains an array of tab stops.
    ///
    /// [`TabArray`][crate::TabArray] can be used to set tab stops in a [`Layout`][crate::Layout].
    /// Each tab stop has an alignment, a position, and optionally
    /// a character to use as decimal point.
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct TabArray(Boxed<ffi::PangoTabArray>);

    match fn {
        copy => |ptr| ffi::pango_tab_array_copy(mut_override(ptr)),
        free => |ptr| ffi::pango_tab_array_free(ptr),
        type_ => || ffi::pango_tab_array_get_type(),
    }
}

impl TabArray {
    /// Creates an array of @initial_size tab stops.
    ///
    /// Tab stops are specified in pixel units if @positions_in_pixels is [`true`],
    /// otherwise in Pango units. All stops are initially at position 0.
    /// ## `initial_size`
    /// Initial number of tab stops to allocate, can be 0
    /// ## `positions_in_pixels`
    /// whether positions are in pixel units
    ///
    /// # Returns
    ///
    /// the newly allocated [`TabArray`][crate::TabArray], which should
    ///   be freed with `Pango::TabArray::free()`.
    #[doc(alias = "pango_tab_array_new")]
    pub fn new(initial_size: i32, positions_in_pixels: bool) -> TabArray {
        unsafe {
            from_glib_full(ffi::pango_tab_array_new(
                initial_size,
                positions_in_pixels.into_glib(),
            ))
        }
    }

    //#[doc(alias = "pango_tab_array_new_with_positions")]
    //#[doc(alias = "new_with_positions")]
    //pub fn with_positions(size: i32, positions_in_pixels: bool, first_alignment: TabAlign, first_position: i32, : /*Unknown conversion*//*Unimplemented*/Basic: VarArgs) -> TabArray {
    //    unsafe { TODO: call ffi:pango_tab_array_new_with_positions() }
    //}

    /// Gets the Unicode character to use as decimal point.
    ///
    /// This is only relevant for tabs with [`TabAlign::Decimal`][crate::TabAlign::Decimal] alignment,
    /// which align content at the first occurrence of the decimal point
    /// character.
    ///
    /// The default value of 0 means that Pango will use the
    /// decimal point according to the current locale.
    /// ## `tab_index`
    /// the index of a tab stop
    #[cfg(feature = "v1_50")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_50")))]
    #[doc(alias = "pango_tab_array_get_decimal_point")]
    #[doc(alias = "get_decimal_point")]
    pub fn decimal_point(&self, tab_index: i32) -> char {
        unsafe {
            std::convert::TryFrom::try_from(ffi::pango_tab_array_get_decimal_point(
                mut_override(self.to_glib_none().0),
                tab_index,
            ))
            .expect("conversion from an invalid Unicode value attempted")
        }
    }

    /// Returns [`true`] if the tab positions are in pixels,
    /// [`false`] if they are in Pango units.
    ///
    /// # Returns
    ///
    /// whether positions are in pixels.
    #[doc(alias = "pango_tab_array_get_positions_in_pixels")]
    #[doc(alias = "get_positions_in_pixels")]
    pub fn is_positions_in_pixels(&self) -> bool {
        unsafe {
            from_glib(ffi::pango_tab_array_get_positions_in_pixels(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Gets the number of tab stops in @self.
    ///
    /// # Returns
    ///
    /// the number of tab stops in the array.
    #[doc(alias = "pango_tab_array_get_size")]
    #[doc(alias = "get_size")]
    pub fn size(&self) -> i32 {
        unsafe { ffi::pango_tab_array_get_size(mut_override(self.to_glib_none().0)) }
    }

    /// Gets the alignment and position of a tab stop.
    /// ## `tab_index`
    /// tab stop index
    ///
    /// # Returns
    ///
    ///
    /// ## `alignment`
    /// location to store alignment
    ///
    /// ## `location`
    /// location to store tab position
    #[doc(alias = "pango_tab_array_get_tab")]
    #[doc(alias = "get_tab")]
    pub fn tab(&self, tab_index: i32) -> (TabAlign, i32) {
        unsafe {
            let mut alignment = std::mem::MaybeUninit::uninit();
            let mut location = std::mem::MaybeUninit::uninit();
            ffi::pango_tab_array_get_tab(
                mut_override(self.to_glib_none().0),
                tab_index,
                alignment.as_mut_ptr(),
                location.as_mut_ptr(),
            );
            (from_glib(alignment.assume_init()), location.assume_init())
        }
    }

    /// Resizes a tab array.
    ///
    /// You must subsequently initialize any tabs
    /// that were added as a result of growing the array.
    /// ## `new_size`
    /// new size of the array
    #[doc(alias = "pango_tab_array_resize")]
    pub fn resize(&mut self, new_size: i32) {
        unsafe {
            ffi::pango_tab_array_resize(self.to_glib_none_mut().0, new_size);
        }
    }

    /// Sets the Unicode character to use as decimal point.
    ///
    /// This is only relevant for tabs with [`TabAlign::Decimal`][crate::TabAlign::Decimal] alignment,
    /// which align content at the first occurrence of the decimal point
    /// character.
    ///
    /// By default, Pango uses the decimal point according
    /// to the current locale.
    /// ## `tab_index`
    /// the index of a tab stop
    /// ## `decimal_point`
    /// the decimal point to use
    #[cfg(feature = "v1_50")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_50")))]
    #[doc(alias = "pango_tab_array_set_decimal_point")]
    pub fn set_decimal_point(&mut self, tab_index: i32, decimal_point: char) {
        unsafe {
            ffi::pango_tab_array_set_decimal_point(
                self.to_glib_none_mut().0,
                tab_index,
                decimal_point.into_glib(),
            );
        }
    }

    /// Sets whether positions in this array are specified in
    /// pixels.
    /// ## `positions_in_pixels`
    /// whether positions are in pixels
    #[cfg(feature = "v1_50")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_50")))]
    #[doc(alias = "pango_tab_array_set_positions_in_pixels")]
    pub fn set_positions_in_pixels(&mut self, positions_in_pixels: bool) {
        unsafe {
            ffi::pango_tab_array_set_positions_in_pixels(
                self.to_glib_none_mut().0,
                positions_in_pixels.into_glib(),
            );
        }
    }

    /// Sets the alignment and location of a tab stop.
    /// ## `tab_index`
    /// the index of a tab stop
    /// ## `alignment`
    /// tab alignment
    /// ## `location`
    /// tab location in Pango units
    #[doc(alias = "pango_tab_array_set_tab")]
    pub fn set_tab(&mut self, tab_index: i32, alignment: TabAlign, location: i32) {
        unsafe {
            ffi::pango_tab_array_set_tab(
                self.to_glib_none_mut().0,
                tab_index,
                alignment.into_glib(),
                location,
            );
        }
    }

    /// Utility function to ensure that the tab stops are in increasing order.
    #[cfg(feature = "v1_50")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_50")))]
    #[doc(alias = "pango_tab_array_sort")]
    pub fn sort(&mut self) {
        unsafe {
            ffi::pango_tab_array_sort(self.to_glib_none_mut().0);
        }
    }

    /// Serializes a [`TabArray`][crate::TabArray] to a string.
    ///
    /// No guarantees are made about the format of the string,
    /// it may change between Pango versions.
    ///
    /// The intended use of this function is testing and
    /// debugging. The format is not meant as a permanent
    /// storage format.
    ///
    /// # Returns
    ///
    /// a newly allocated string
    #[cfg(feature = "v1_50")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_50")))]
    #[doc(alias = "pango_tab_array_to_string")]
    #[doc(alias = "to_string")]
    pub fn to_str(&self) -> glib::GString {
        unsafe {
            from_glib_full(ffi::pango_tab_array_to_string(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Deserializes a [`TabArray`][crate::TabArray] 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 [`TabArray`][crate::TabArray]
    #[cfg(feature = "v1_50")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_50")))]
    #[doc(alias = "pango_tab_array_from_string")]
    pub fn from_string(text: &str) -> Result<TabArray, glib::BoolError> {
        unsafe {
            Option::<_>::from_glib_full(ffi::pango_tab_array_from_string(text.to_glib_none().0))
                .ok_or_else(|| glib::bool_error!("Can't parse a TabArray"))
        }
    }
}

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

unsafe impl Send for TabArray {}
unsafe impl Sync for TabArray {}