Struct ButtonMask 

pub struct ButtonMask(/* private fields */);

Set of pointer buttons a gesture recognizer is configured to fire for. Used by the four click-style recognizers (TapRecognizer, DoubleTapRecognizer, TripleTapRecognizer, LongPressRecognizer) and the matching widget-level builders (accept_tap_buttons, …).

Default for every recognizer is ButtonMask::PRIMARY — left-click only — which matches the user’s expectation for a “tap” and keeps right-click free to open a context menu without spuriously activating the widget. Use ButtonMask::ALL or a hand-built PRIMARY | SECONDARY etc. to opt into broader button sets.

Implementations

impl ButtonMask

pub const NONE: Self

Empty mask — no buttons accepted.

pub const PRIMARY: Self

Left-click on most desktop pointing devices.

pub const SECONDARY: Self

Right-click on most desktop pointing devices.

pub const MIDDLE: Self

Middle / wheel-click.

pub const BACK: Self

“Back” auxiliary button (mouse 4).

pub const FORWARD: Self

“Forward” auxiliary button (mouse 5).

pub const ALL: Self

All buttons currently representable by PointerButton.

pub const fn contains(self, button: PointerButton) -> bool

true when the mask contains the given button.

pub const fn is_empty(self) -> bool

true when no buttons are accepted.

pub const fn union(self, other: Self) -> Self

Union — accept any button in either mask.

pub const fn intersection(self, other: Self) -> Self

Intersection — accept only buttons present in both masks.

Trait Implementations

impl BitAnd for ButtonMask

type Output = ButtonMask

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self

Performs the & operation.

impl BitAndAssign for ButtonMask

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for ButtonMask

type Output = ButtonMask

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl BitOrAssign for ButtonMask

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl Clone for ButtonMask

fn clone(&self) -> ButtonMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ButtonMask

impl Debug for ButtonMask

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

Formats the value using the given formatter.

impl Default for ButtonMask

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ButtonMask

impl From<PointerButton> for ButtonMask

fn from(button: PointerButton) -> Self

Converts to this type from the input type.

impl<const N: usize> From<[PointerButton; N]> for ButtonMask

fn from(buttons: [PointerButton; N]) -> Self

Converts to this type from the input type.

impl Hash for ButtonMask

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 ButtonMask

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ButtonMask