Struct TabArray

pub struct TabArray { /* private fields */ }

A TabArray contains an array of tab stops.

TabArray can be used to set tab stops in a Layout. Each tab stop has an alignment, a position, and optionally a character to use as decimal point.

GLib type: Boxed type with copy-on-clone semantics.

Implementations

impl TabArray

pub fn as_ptr(&self) -> *mut PangoTabArray

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut PangoTabArray) -> &Self

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut( ptr: &mut *mut PangoTabArray, ) -> &mut Self

Borrows the underlying C value mutably.

impl TabArray

pub fn new(initial_size: i32, positions_in_pixels: bool) -> 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, which should be freed with Pango::TabArray::free().

pub fn decimal_point(&self, tab_index: i32) -> char

Available on crate feature v1_50 only.

Gets the Unicode character to use as decimal point.

This is only relevant for tabs with 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

pub fn is_positions_in_pixels(&self) -> bool

Returns true if the tab positions are in pixels, false if they are in Pango units.

Returns

whether positions are in pixels.

pub fn size(&self) -> i32

Gets the number of tab stops in @self.

Returns

the number of tab stops in the array.

pub fn tab(&self, tab_index: i32) -> (TabAlign, i32)

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

pub fn resize(&mut self, new_size: i32)

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

pub fn set_decimal_point(&mut self, tab_index: i32, decimal_point: char)

Available on crate feature v1_50 only.

Sets the Unicode character to use as decimal point.

This is only relevant for tabs with 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

pub fn set_positions_in_pixels(&mut self, positions_in_pixels: bool)

Available on crate feature v1_50 only.

Sets whether positions in this array are specified in pixels.

positions_in_pixels

whether positions are in pixels

pub fn set_tab(&mut self, tab_index: i32, alignment: TabAlign, location: i32)

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

pub fn sort(&mut self)

Available on crate feature v1_50 only.

Utility function to ensure that the tab stops are in increasing order.

pub fn to_str(&self) -> GString

Available on crate feature v1_50 only.

Serializes a 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

pub fn from_string(text: &str) -> Result<TabArray, BoolError>

Available on crate feature v1_50 only.

Deserializes a TabArray from a string.

This is the counterpart to to_str(). See that functions for details about the format.

text

a string

Returns

a new TabArray

impl TabArray

pub fn tabs(&self) -> (Vec<TabAlign>, Slice<i32>)

If non-None, @alignments and @locations are filled with allocated arrays.

The arrays are of length size(). You must free the returned array.

Returns

alignments

location to store an array of tab stop alignments

locations

location to store an array of tab positions

Trait Implementations

impl Clone for TabArray

fn clone(&self) -> Self

Copies the boxed type with the type-specific copy function.

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

Performs copy-assignment from source.

impl Debug for TabArray

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

Formats the value using the given formatter.

impl Display for TabArray

Available on crate feature v1_50 only.

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

Formats the value using the given formatter.

impl From<TabArray> for Value

fn from(o: TabArray) -> Self

Converts to this type from the input type.

impl FromStr for TabArray

Available on crate feature v1_50 only.

type Err = BoolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl HasParamSpec for TabArray

type ParamSpec = ParamSpecBoxed

type SetValue = TabArray

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, TabArray>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for TabArray

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TabArray

fn cmp(&self, other: &TabArray) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TabArray

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TabArray

fn partial_cmp(&self, other: &TabArray) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for TabArray

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for TabArray

impl Send for TabArray

impl StructuralPartialEq for TabArray

impl Sync for TabArray