Struct LayoutIter

pub struct LayoutIter { /* private fields */ }

A LayoutIter can be used to iterate over the visual extents of a Layout.

To obtain a LayoutIter, use Layout::iter().

The LayoutIter structure is opaque, and has no user-visible fields.

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

Implementations

impl LayoutIter

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

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

Borrows the underlying C value mutably.

impl LayoutIter

pub fn at_last_line(&mut self) -> bool

Determines whether @self is on the last line of the layout.

Returns

true if @self is on the last line

pub fn baseline(&mut self) -> i32

Gets the Y position of the current line’s baseline, in layout coordinates.

Layout coordinates have the origin at the top left of the entire layout.

Returns

baseline of current line

pub fn char_extents(&mut self) -> Rectangle

Gets the extents of the current character, in layout coordinates.

Layout coordinates have the origin at the top left of the entire layout.

Only logical extents can sensibly be obtained for characters; ink extents make sense only down to the level of clusters.

Returns

logical_rect

rectangle to fill with logical extents

pub fn cluster_extents(&mut self) -> (Rectangle, Rectangle)

Gets the extents of the current cluster, in layout coordinates.

Layout coordinates have the origin at the top left of the entire layout.

Returns

ink_rect

rectangle to fill with ink extents

logical_rect

rectangle to fill with logical extents

pub fn index(&mut self) -> i32

Gets the current byte index.

Note that iterating forward by char moves in visual order, not logical order, so indexes may not be sequential. Also, the index may be equal to the length of the text in the layout, if on the None run (see run()).

Returns

current byte index

pub fn layout(&mut self) -> Option<Layout>

Gets the layout associated with a LayoutIter.

Returns

the layout associated with @self

pub fn layout_extents(&mut self) -> (Rectangle, Rectangle)

Obtains the extents of the Layout being iterated over.

Returns

ink_rect

rectangle to fill with ink extents

logical_rect

rectangle to fill with logical extents

pub fn line(&mut self) -> Option<LayoutLine>

Gets the current line.

Use the faster line_readonly() if you do not plan to modify the contents of the line (glyphs, glyph widths, etc.).

Returns

the current line

pub fn line_extents(&mut self) -> (Rectangle, Rectangle)

Obtains the extents of the current line.

Extents are in layout coordinates (origin is the top-left corner of the entire Layout). Thus the extents returned by this function will be the same width/height but not at the same x/y as the extents returned from LayoutLine::extents().

Returns

ink_rect

rectangle to fill with ink extents

logical_rect

rectangle to fill with logical extents

pub fn line_readonly(&mut self) -> Option<LayoutLine>

Gets the current line for read-only access.

This is a faster alternative to line(), but the user is not expected to modify the contents of the line (glyphs, glyph widths, etc.).

Returns

the current line, that should not be modified

pub fn line_yrange(&mut self) -> (i32, i32)

Divides the vertical space in the Layout being iterated over between the lines in the layout, and returns the space belonging to the current line.

A line’s range includes the line’s logical extents. plus half of the spacing above and below the line, if Layout::set_spacing() has been called to set layout spacing. The Y positions are in layout coordinates (origin at top left of the entire layout).

Note: Since 1.44, Pango uses line heights for placing lines, and there may be gaps between the ranges returned by this function.

Returns

y0_

start of line

y1_

end of line

pub fn run(&mut self) -> Option<LayoutRun>

Gets the current run.

When iterating by run, at the end of each line, there’s a position with a None run, so this function can return None. The None run at the end of each line ensures that all lines have at least one run, even lines consisting of only a newline.

Use the faster run_readonly() if you do not plan to modify the contents of the run (glyphs, glyph widths, etc.).

Returns

the current run

pub fn run_baseline(&mut self) -> i32

Available on crate feature v1_50 only.

Gets the Y position of the current run’s baseline, in layout coordinates.

Layout coordinates have the origin at the top left of the entire layout.

The run baseline can be different from the line baseline, for example due to superscript or subscript positioning.

pub fn run_extents(&mut self) -> (Rectangle, Rectangle)

Gets the extents of the current run in layout coordinates.

Layout coordinates have the origin at the top left of the entire layout.

Returns

ink_rect

rectangle to fill with ink extents

logical_rect

rectangle to fill with logical extents

pub fn run_readonly(&mut self) -> Option<LayoutRun>

Gets the current run for read-only access.

When iterating by run, at the end of each line, there’s a position with a None run, so this function can return None. The None run at the end of each line ensures that all lines have at least one run, even lines consisting of only a newline.

This is a faster alternative to run(), but the user is not expected to modify the contents of the run (glyphs, glyph widths, etc.).

Returns

the current run, that should not be modified

pub fn next_char(&mut self) -> bool

Moves @self forward to the next character in visual order.

If @self was already at the end of the layout, returns false.

Returns

whether motion was possible

pub fn next_cluster(&mut self) -> bool

Moves @self forward to the next cluster in visual order.

If @self was already at the end of the layout, returns false.

Returns

whether motion was possible

pub fn next_line(&mut self) -> bool

Moves @self forward to the start of the next line.

If @self is already on the last line, returns false.

Returns

whether motion was possible

pub fn next_run(&mut self) -> bool

Moves @self forward to the next run in visual order.

If @self was already at the end of the layout, returns false.

Returns

whether motion was possible

Trait Implementations

impl Clone for LayoutIter

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 LayoutIter

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

Formats the value using the given formatter.

impl From<LayoutIter> for Value

fn from(o: LayoutIter) -> Self

Converts to this type from the input type.

impl HasParamSpec for LayoutIter

type ParamSpec = ParamSpecBoxed

type SetValue = LayoutIter

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for LayoutIter

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 LayoutIter

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for LayoutIter

impl StructuralPartialEq for LayoutIter