Enum iced::widget::canvas::Cursor

pub enum Cursor {
    Available(Point),
    Unavailable,
}

Available on crate feature canvas only.

The mouse cursor state.

Variants

Available(Point)

The cursor has a defined position.

Unavailable

The cursor is currently unavailable (i.e. out of bounds or busy).

Implementations

impl Cursor

pub fn position(&self) -> Option<Point>

Returns the absolute position of the Cursor, if available.

pub fn position_in(&self, bounds: &Rectangle<f32>) -> Option<Point>

Returns the relative position of the Cursor inside the given bounds, if available.

If the Cursor is not over the provided bounds, this method will return None.

pub fn position_from(&self, origin: Point) -> Option<Point>

Returns the relative position of the Cursor from the given origin, if available.

pub fn is_over(&self, bounds: &Rectangle<f32>) -> bool

Returns whether the Cursor is currently over the provided bounds or not.

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl PartialEq<Cursor> for Cursor

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

impl StructuralPartialEq for Cursor