Struct GlyphString

pub struct GlyphString { /* private fields */ }

A GlyphString is used to store strings of glyphs with geometry and visual attribute information.

The storage for the glyph information is owned by the structure which simplifies memory management.

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

Implementations

impl GlyphString

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

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

Borrows the underlying C value mutably.

impl GlyphString

pub fn new() -> GlyphString

Create a new GlyphString.

Returns

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

pub fn extents(&mut self, font: &impl IsA<Font>) -> (Rectangle, Rectangle)

Compute the logical and ink extents of a glyph string.

See the documentation for FontExt::glyph_extents() for details about the interpretation of the rectangles.

Examples of logical (red) and ink (green) rects:

font

a Font

Returns

ink_rect

rectangle used to store the extents of the glyph string as drawn

logical_rect

rectangle used to store the logical extents of the glyph string

pub fn extents_range( &mut self, start: i32, end: i32, font: &impl IsA<Font>, ) -> (Rectangle, Rectangle)

Computes the extents of a sub-portion of a glyph string.

The extents are relative to the start of the glyph string range (the origin of their coordinate system is at the start of the range, not at the start of the entire glyph string).

start

start index

end

end index (the range is the set of bytes with indices such that start <= index < end)

font

a Font

Returns

ink_rect

rectangle used to store the extents of the glyph string range as drawn

logical_rect

rectangle used to store the logical extents of the glyph string range

pub fn width(&self) -> i32

Computes the logical width of the glyph string.

This can also be computed using extents(). However, since this only computes the width, it’s much faster. This is in fact only a convenience function that computes the sum of @geometry.width for each glyph in the @self.

Returns

the logical width of the glyph string.

pub fn index_to_x( &self, text: &str, analysis: &Analysis, index_: i32, trailing: bool, ) -> i32

Converts from character position to x position.

The X position is measured from the left edge of the run. Character positions are obtained using font metrics for ligatures where available, and computed by dividing up each cluster into equal portions, otherwise.

## `text` the text for the run ## `length` the number of bytes (not characters) in @text. ## `analysis` the analysis information return from [`itemize()`][crate::itemize()] ## `index_` the byte index within @text ## `trailing` whether we should compute the result for the beginning ([`false`]) or end ([`true`]) of the character.

Returns

x_pos

location to store result

pub fn set_size(&mut self, new_len: i32)

Resize a glyph string to the given length.

new_len

the new length of the string

pub fn x_to_index( &self, text: &str, analysis: &Analysis, x_pos: i32, ) -> (i32, i32)

Convert from x offset to character position.

Character positions are computed by dividing up each cluster into equal portions. In scripts where positioning within a cluster is not allowed (such as Thai), the returned value may not be a valid cursor position; the caller must combine the result with the logical attributes for the text to compute the valid cursor position.

text

the text for the run

length

the number of bytes (not characters) in text.

analysis

the analysis information return from itemize()

x_pos

the x offset (in Pango units)

Returns

index_

location to store calculated byte index within @text

trailing

location to store a boolean indicating whether the user clicked on the leading or trailing edge of the character

impl GlyphString

pub fn num_glyphs(&self) -> i32

pub fn glyph_info(&self) -> &[GlyphInfo]

pub fn glyph_info_mut(&mut self) -> &mut [GlyphInfo]

pub fn log_clusters(&self) -> &[i32]

pub fn log_clusters_mut(&mut self) -> &mut [i32]

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

Given a GlyphString and 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 GlyphItem::logical_widths().

text

the text corresponding to the glyphs

length

the length of @text, in bytes

embedding_level

the embedding level of the string

logical_widths

an array whose length is the number of characters in text (equal to g_utf8_strlen (text, length) unless text has NUL bytes) to be filled in with the resulting character widths.

Trait Implementations

impl Clone for GlyphString

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 GlyphString

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

Formats the value using the given formatter.

impl Default for GlyphString

fn default() -> Self

Returns the “default value” for a type.

impl From<GlyphString> for Value

fn from(o: GlyphString) -> Self

Converts to this type from the input type.

impl HasParamSpec for GlyphString

type ParamSpec = ParamSpecBoxed

type SetValue = GlyphString

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GlyphString

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 GlyphString

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GlyphString

impl Send for GlyphString

impl StructuralPartialEq for GlyphString

impl Sync for GlyphString