Struct embedded_text::rendering::cursor::Cursor

pub struct Cursor<F> {
    pub position: Point,
    pub bounds: Rectangle,
    // some fields omitted
}

Internal structure that keeps track of position information while rendering a TextBox.

Fields

position: Point

Current cursor position

bounds: Rectangle

TextBox bounding rectangle

Implementations

impl<F> Cursor<F> where
    F: Font, 

#[must_use]

pub fn new(bounds: Rectangle, line_spacing: i32) -> Self

Creates a new Cursor object located at the top left of the given bounding Rectangle.

#[must_use]

pub fn line_width(&self) -> u32

Returns the width of the textbox

pub fn new_line(&mut self)

Starts a new line.

pub fn carriage_return(&mut self)

Moves the cursor back to the start of the line.

#[must_use]

pub fn in_display_area(&self) -> bool

Returns whether the cursor is completely in the bounding box.

Completely means, that the line that is marked by the cursor can be drawn without any vertical clipping or drawing outside the bounds.

Note: Only vertical overrun is checked.

#[must_use]

pub fn fits_in_line(&self, width: u32) -> bool

Returns whether the current line has enough space to also include an object of given width.

#[must_use]

pub fn space(&self) -> u32

Returns the amount of empty space in the line.

pub fn advance_unchecked(&mut self, by: u32)

Advances the cursor by a given amount.

pub fn x_in_line(&self) -> i32

Returns the current horizontal offset relative to the left side.

pub fn advance(&mut self, by: u32) -> bool

Advances the cursor by a given amount.

pub fn rewind(&mut self, by: u32) -> bool

Rewinds the cursor by a given amount.

Trait Implementations

impl<F: Clone> Clone for Cursor<F>

fn clone(&self) -> Cursor<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Copy> Copy for Cursor<F>

impl<F: Debug> Debug for Cursor<F>

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

Formats the value using the given formatter.