Struct Item

pub struct Item { /* private fields */ }

The Item structure stores information about a segment of text.

You typically obtain PangoItems by itemizing a piece of text with itemize().

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

Implementations

impl Item

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

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

Borrows the underlying C value mutably.

impl Item

pub fn new() -> Item

Creates a new Item structure initialized to default values.

Returns

the newly allocated Item, which should be freed with Pango::Item::free().

pub fn apply_attrs(&mut self, iter: &mut AttrIterator<'_>)

Available on crate feature v1_44 only.

Add attributes to a Item.

The idea is that you have attributes that don’t affect itemization, such as font features, so you filter them out using AttrList::filter(), itemize your text, then reapply the attributes to the resulting items using this function.

The @iter should be positioned before the range of the item, and will be advanced past it. This function is meant to be called in a loop over the items resulting from itemization, while passing the iter to each call.

iter

a AttrIterator

pub fn char_offset(&self) -> i32

Available on crate feature v1_54 only.

Returns the character offset of the item from the beginning of the itemized text.

If the item has not been obtained from Pango’s itemization machinery, then the character offset is not available. In that case, this function returns -1.

Returns

the character offset of the item from the beginning of the itemized text, or -1

pub fn split(&mut self, split_index: i32, split_offset: i32) -> Item

Modifies @self to cover only the text after @split_index, and returns a new item that covers the text before @split_index that used to be in @self.

You can think of @split_index as the length of the returned item. @split_index may not be 0, and it may not be greater than or equal to the length of @self (that is, there must be at least one byte assigned to each item, you can’t create a zero-length item). @split_offset is the length of the first item in chars, and must be provided because the text used to generate the item isn’t available, so pango_item_split() can’t count the char length of the split items itself.

split_index

byte index of position to split item, relative to the start of the item

split_offset

number of chars between start of @self and @split_index

Returns

new item representing text before @split_index, which should be freed with Pango::Item::free().

impl Item

pub fn offset(&self) -> i32

pub fn length(&self) -> i32

pub fn num_chars(&self) -> i32

pub fn analysis(&self) -> &Analysis

Trait Implementations

impl Clone for Item

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 Item

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

Formats the value using the given formatter.

impl Default for Item

fn default() -> Self

Returns the “default value” for a type.

impl From<Item> for Value

fn from(o: Item) -> Self

Converts to this type from the input type.

impl HasParamSpec for Item

type ParamSpec = ParamSpecBoxed

type SetValue = Item

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Item

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 Item

fn cmp(&self, other: &Item) -> 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 Item

fn eq(&self, other: &Item) -> 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 Item

fn partial_cmp(&self, other: &Item) -> 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 Item

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Item

impl StructuralPartialEq for Item