Struct pango::TabArray

source ·
pub struct TabArray { /* private fields */ }
Expand description

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.

Implementations§

source§

impl TabArray

source

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

Return the inner pointer to the underlying C value.

source

pub unsafe fn from_glib_ptr_borrow<'a>( ptr: *const *const PangoTabArray ) -> &'a Self

Borrows the underlying C value.

source

pub unsafe fn from_glib_ptr_borrow_mut<'a>( ptr: *mut *mut PangoTabArray ) -> &'a mut Self

Borrows the underlying C value mutably.

source§

impl TabArray

source

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().

source

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

source

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.

source

pub fn size(&self) -> i32

Gets the number of tab stops in @self.

Returns

the number of tab stops in the array.

source

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

source

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

source

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

source

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

source

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

source

pub fn sort(&mut self)

Available on crate feature v1_50 only.

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

source

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

source

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

source§

impl TabArray

source

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§

source§

impl Clone for TabArray

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for TabArray

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for TabArray

Available on crate feature v1_50 only.
source§

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

Formats the value using the given formatter. Read more
source§

impl From<TabArray> for Value

source§

fn from(o: TabArray) -> Self

Converts to this type from the input type.
source§

impl FromStr for TabArray

Available on crate feature v1_50 only.
§

type Err = BoolError

The associated error which can be returned from parsing.
source§

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

Parses a string s to return a value of this type. Read more
source§

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>

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for TabArray

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for TabArray

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for TabArray

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd for TabArray

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl StaticType for TabArray

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for TabArray

source§

impl Send for TabArray

source§

impl StructuralEq for TabArray

source§

impl StructuralPartialEq for TabArray

source§

impl Sync for TabArray

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

source§

impl<T> Property for T
where T: HasParamSpec,

§

type Value = T

source§

impl<T> PropertyGet for T
where T: HasParamSpec,

§

type Value = T

source§

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToSendValue for T
where T: Send + ToValue + ?Sized,

source§

fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T> TransparentType for T

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<'a, T, C, E> FromValueOptional<'a> for T
where T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>, E: Error + Send + 'static,