Struct crossterm_winapi::ButtonState

pub struct ButtonState { /* private fields */ }

The status of the mouse buttons. The least significant bit corresponds to the leftmost mouse button. The next least significant bit corresponds to the rightmost mouse button. The next bit indicates the next-to-leftmost mouse button. The bits then correspond left to right to the mouse buttons. A bit is 1 if the button was pressed.

The state can be one of the following:

Release = 0x0000,
/// The leftmost mouse button.
FromLeft1stButtonPressed = 0x0001,
/// The second button from the left.
FromLeft2ndButtonPressed = 0x0004,
/// The third button from the left.
FromLeft3rdButtonPressed = 0x0008,
/// The fourth button from the left.
FromLeft4thButtonPressed = 0x0010,
/// The rightmost mouse button.
RightmostButtonPressed = 0x0002,
/// This button state is not recognized.
Unknown = 0x0021,
/// The wheel was rotated backward, toward the user; this will only be activated for `MOUSE_WHEELED ` from `dwEventFlags`
Negative = 0x0020,

Ms Docs

Implementations

impl ButtonState

pub fn release_button(&self) -> bool

Get whether no buttons are being pressed.

pub fn left_button(&self) -> bool

Returns whether the left button was pressed.

pub fn right_button(&self) -> bool

Returns whether the right button was pressed.

pub fn middle_button(&self) -> bool

Returns whether the right button was pressed.

pub fn scroll_down(&self) -> bool

Returns whether there is a down scroll.

pub fn scroll_up(&self) -> bool

Returns whether there is a up scroll.

pub fn scroll_right(&self) -> bool

Returns whether there is a horizontal scroll to the right.

pub fn scroll_left(&self) -> bool

Returns whether there is a horizontal scroll to the left.

pub fn state(&self) -> i32

Returns the raw state.

Trait Implementations

impl Clone for ButtonState

fn clone(&self) -> ButtonState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ButtonState

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

Formats the value using the given formatter.

impl From<u32> for ButtonState

fn from(event: DWORD) -> Self

Converts to this type from the input type.

impl PartialEq<ButtonState> for ButtonState

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

impl Eq for ButtonState

impl StructuralEq for ButtonState

impl StructuralPartialEq for ButtonState