Enum conrod_core::input::state::mouse::ButtonPosition

pub enum ButtonPosition {
    Up,
    Down(Point, Option<Id>),
}

Whether the button is up or down.

Variants

Up

The button is up (i.e. pressed).

Down(Point, Option<Id>)

The button is down and was originally pressed down at the given Point over the widget at the given widget::Id.

Implementations

impl ButtonPosition

pub fn relative_to(self, xy: Point) -> Self

If the mouse button is down, return a new one with position relative to the given xy.

pub fn is_down(&self) -> bool

Is the ButtonPosition down.

pub fn is_up(&self) -> bool

Is the ButtonPosition up.

pub fn if_down(&self) -> Option<(Point, Option<Id>)>

Returns the position at which the button was pressed along with the widget that was under the mouse at the time of pressing if the position is Down.

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

Returns the position at which the button was pressed if it's down.

Trait Implementations

impl Clone for ButtonPosition

fn clone(&self) -> ButtonPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ButtonPosition

impl Debug for ButtonPosition

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

Formats the value using the given formatter.

impl PartialEq<ButtonPosition> for ButtonPosition

fn eq(&self, other: &ButtonPosition) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ButtonPosition) -> bool

This method tests for !=.

impl StructuralPartialEq for ButtonPosition