Struct embedded_text::rendering::cursor::Cursor

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

Internal structure that keeps track of rendering a [TextBox].

Fields

position: Point

Current cursor position

Implementations

impl<F: Font> Cursor<F>

#[must_use]pub fn new(bounds: Rectangle) -> Self

Creates a new Cursor located at the top left of the bounding box.

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.

pub fn in_display_area(&self) -> bool

Returns whether the cursor is in the bounding box.

Note: Only vertical overrun is checked.

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.

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

Advances the cursor by a given amount.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.