Struct pango::GlyphItem

#[repr(transparent)]
pub struct GlyphItem { /* private fields */ }

A GlyphItem is a pair of a Item and the glyphs resulting from shaping the items text.

As an example of the usage of GlyphItem, the results of shaping text with Layout is a list of LayoutLine, each of which contains a list of GlyphItem.

Implementations

impl GlyphItem

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

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

Borrows the underlying C value mutably.

impl GlyphItem

pub fn apply_attrs(&mut self, text: &str, list: &AttrList) -> Vec<GlyphItem>

Splits a shaped item (GlyphItem) into multiple items based on an attribute list.

The idea is that if you have attributes that don’t affect shaping, such as color or underline, to avoid affecting shaping, you filter them out (AttrList::filter()), apply the shaping process and then reapply them to the result using this function.

All attributes that start or end inside a cluster are applied to that cluster; for instance, if half of a cluster is underlined and the other-half strikethrough, then the cluster will end up with both underline and strikethrough attributes. In these cases, it may happen that @item->extra_attrs for some of the result items can have multiple attributes of the same type.

This function takes ownership of @self; it will be reused as one of the elements in the list.

text

text that @list applies to

list

a AttrList

Returns

a list of glyph items resulting from splitting @self. Free the elements using Pango::GlyphItem::free(), the list using g_slist_free().

pub fn split(&mut self, text: &str, split_index: i32) -> Option<GlyphItem>

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

This function is similar in function to pango_item_split() (and uses it internally.)

text

text to which positions in @self apply

split_index

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

Returns

the newly allocated item representing text before @split_index, which should be freed with pango_glyph_item_free().

impl GlyphItem

pub fn item(&self) -> Item

pub fn glyph_string(&self) -> GlyphString

pub fn logical_widths(&self, text: &str) -> Vec<i32>

Given a GlyphItem and the corresponding text, determine the width corresponding to each character.

When multiple characters compose a single cluster, the width of the entire cluster is divided equally among the characters.

See also GlyphString::logical_widths().

text

text that @self corresponds to (glyph_item->item->offset is an offset from the start of @text)

logical_widths

an array whose length is the number of characters in glyph_item (equal to glyph_item->item->num_chars) to be filled in with the resulting character widths.

Trait Implementations

impl Clone for GlyphItem

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlyphItem

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

Formats the value using the given formatter.

impl From<GlyphItem> for Value

fn from(o: GlyphItem) -> Self

Converts to this type from the input type.

impl HasParamSpec for GlyphItem

type ParamSpec = ParamSpecBoxed

type SetValue = GlyphItem

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GlyphItem

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 GlyphItem

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<GlyphItem> for GlyphItem

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

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

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.

impl PartialOrd<GlyphItem> for GlyphItem

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for GlyphItem

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GlyphItem

impl StructuralEq for GlyphItem

impl StructuralPartialEq for GlyphItem