Struct MouseEvent 

pub struct MouseEvent {
    pub event_type: MouseEventType,
    pub left: bool,
    pub right: bool,
    pub middle: bool,
    pub wheel_up: bool,
    pub wheel_down: bool,
    pub shift: bool,
    pub alt: bool,
    pub ctrl: bool,
    pub position: Position,
}

A mouse event can have any number of buttons (including no buttons) pressed or released.

Fields

event_type: MouseEventType

A mouse event can current be a Press, Release, or Motion. Future events could consider double-click and triple-click.

left: bool

right: bool

middle: bool

wheel_up: bool

wheel_down: bool

shift: bool

alt: bool

ctrl: bool

position: Position

The coordinates are zero-based.

Implementations

impl MouseEvent

pub fn new() -> Self

pub fn new_buttonless_motion(position: Position) -> Self

pub fn new_left_press_event(position: Position) -> Self

pub fn new_right_press_event(position: Position) -> Self

pub fn new_middle_press_event(position: Position) -> Self

pub fn new_middle_release_event(position: Position) -> Self

pub fn new_left_release_event(position: Position) -> Self

pub fn new_left_motion_event(position: Position) -> Self

pub fn new_right_release_event(position: Position) -> Self

pub fn new_right_motion_event(position: Position) -> Self

pub fn new_middle_motion_event(position: Position) -> Self

pub fn new_left_press_with_alt_event(position: Position) -> Self

pub fn new_right_press_with_alt_event(position: Position) -> Self

pub fn new_left_press_with_ctrl_event(position: Position) -> Self

pub fn new_left_motion_with_ctrl_event(position: Position) -> Self

pub fn new_left_release_with_ctrl_event(position: Position) -> Self

pub fn new_left_motion_with_alt_event(position: Position) -> Self

pub fn new_scroll_up_event(position: Position) -> Self

pub fn new_scroll_down_event(position: Position) -> Self

pub fn new_ctrl_scroll_up_event(position: Position) -> Self

pub fn new_ctrl_scroll_down_event(position: Position) -> Self

Trait Implementations

impl Clone for MouseEvent

fn clone(&self) -> MouseEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MouseEvent

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

Formats the value using the given formatter.

impl Default for MouseEvent

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MouseEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MouseEvent> for MouseEvent

fn from(event: MouseEvent) -> Self

Converts to this type from the input type.

impl Hash for MouseEvent

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 PartialEq for MouseEvent

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<MouseEvent> for MouseEvent

type Error = Error

The type returned in the event of a conversion error.

fn try_from(event: MouseEvent) -> Result<Self>

Performs the conversion.

impl TryFrom<MouseEvent> for ProtobufMouseEventPayload

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(event: MouseEvent) -> Result<Self, &'static str>

Performs the conversion.

impl TryFrom<MouseEventPayload> for MouseEvent

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from( protobuf_event: ProtobufMouseEventPayload, ) -> Result<Self, &'static str>

Performs the conversion.

impl Copy for MouseEvent

impl Eq for MouseEvent

impl StructuralPartialEq for MouseEvent