Enum MouseButton 

pub enum MouseButton {
    Primary,
    Secondary,
    Middle,
    Other(u8),
}

Which button a press came from — driver-facing rather than shaped after any one windowing library, so every driver maps its own vocabulary onto this one.

Only MouseButton::Primary drives the pointer model: it presses, drags, places the caret and produces on_click. A MouseButton::Secondary press asks the node under it for a context menu (NodeSpec::on_context_menu) and touches nothing else — not focus, not the caret, not a scrollbar thumb — because a right-click on a selection has to leave that selection alone. Every non-primary button, the secondary one included, reaches a node that claims it with NodeSpec::on_button: its press, the motion while it is held and its release, captured by that node; a claimed secondary press is that node’s instead of a context menu. A non-primary press moves no focus, caret, selection or scrollbar either way.

Variants

Primary

The button that clicks and drags. The OS has already applied a left-handed swap, so this is not necessarily the left one.

Secondary

The context-menu button.

Middle

Other(u8)

A button this vocabulary does not name (back, forward, thumb buttons), by driver index.

Implementations

impl MouseButton

pub const NAMED: [MouseButton; 3]

The three buttons that have a name, in code order. Other has no name: a binding that needs one takes a MouseButton::code.

pub fn code(self) -> u32

The number bindings pass buttons as: 0 primary, 1 secondary, 2 middle, 3 + n for Other(n).

pub fn from_code(code: u32) -> MouseButton

Inverse of MouseButton::code; anything past the named three is an Other, saturating rather than wrapping.

pub fn name(self) -> Option<&'static str>

The wire name of a named button ("primary", "secondary", "middle"); None for an Other.

pub fn from_name(name: &str) -> Option<MouseButton>

The three named buttons by name, for bindings that spell them as strings: the inverse of Self::name.

pub fn to_value(self) -> Value

The value a button event carries for this button: its name for a named one, its MouseButton::code for an Other.

Trait Implementations

impl Clone for MouseButton

fn clone(&self) -> MouseButton

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MouseButton

impl Debug for MouseButton

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

Formats the value using the given formatter.

impl Default for MouseButton

fn default() -> MouseButton

Returns the “default value” for a type.

impl Eq for MouseButton

impl PartialEq for MouseButton

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MouseButton