Enum ClickEvent 

pub enum ClickEvent {
    Mouse(MouseClickEvent),
    Keyboard(KeyboardClickEvent),
    Touch(TouchClickEvent),
}

A completed click from the mouse, keyboard or touch.

Click listeners receive this type. StatefulInteractiveElement::on_click handles the primary action, and StatefulInteractiveElement::on_aux_click handles the other mouse buttons. Use the methods on this type, such as ClickEvent::is_secondary, to tell the cases apart.

Examples

use gpui::{ClickEvent, KeyboardButton, KeyboardClickEvent, Modifiers, MouseButton,
    MouseClickEvent, MouseDownEvent, MouseUpEvent};

let right_click = ClickEvent::Mouse(MouseClickEvent {
    down: MouseDownEvent { button: MouseButton::Right, ..Default::default() },
    up: MouseUpEvent { button: MouseButton::Right, ..Default::default() },
});
assert!(right_click.is_right_click());
assert!(right_click.is_secondary());
assert!(!right_click.standard_click());

let enter = ClickEvent::Keyboard(KeyboardClickEvent {
    button: KeyboardButton::Enter,
    ..Default::default()
});
assert!(enter.is_keyboard());
assert_eq!(enter.click_count(), 1);
assert_eq!(enter.modifiers(), Modifiers::default());

Variants

Mouse(MouseClickEvent)

A click from a mouse button, a press and a release on the same element.

Keyboard(KeyboardClickEvent)

A click from Enter or Space on a focused element.

Touch(TouchClickEvent)

A touch tap or long press. GPUI reserves this variant for direct touch click delivery; the recognizer currently reports those gestures through mouse events instead.

Implementations

impl ClickEvent

pub fn modifiers(&self) -> Modifiers

Returns the modifier keys held during the click.

Keyboard and touch clicks have none, so this returns the default Modifiers. A mouse click returns the modifiers held when the button was released.

pub fn position(&self) -> Point<Pixels>

Returns the window position of the click, in logical pixels.

For a mouse click this is where the button was released. For a touch it is where the tap happened. For a keyboard click, which has no pointer, it is the bottom-left corner of the clicked element.

pub fn mouse_position(&self) -> Option<Point<Pixels>>

Returns the mouse position of the click, or None if it did not come from a mouse.

Keyboard and touch clicks return None. Use ClickEvent::position when you need a position for every kind.

pub fn is_right_click(&self) -> bool

Returns true if this is a mouse click made with the right button.

Keyboard and touch clicks always return false. Use ClickEvent::is_secondary to also match long presses.

pub fn is_middle_click(&self) -> bool

Returns true if this is a mouse click made with the middle button.

Keyboard and touch clicks always return false.

pub fn is_secondary(&self) -> bool

Returns true if this click is a secondary activation, the kind that usually opens a context menu.

That is a right-button mouse click, or a long press when a future direct touch click is delivered. On macOS, Control-clicks already arrive as right clicks. Keyboard clicks always return false.

pub fn standard_click(&self) -> bool

Returns true for a primary activation: a left-button click, a keyboard click, or a direct touch tap that is not a long press.

Right, middle and navigation button clicks return false. Use ClickEvent::is_secondary to test for the right button and long presses.

pub fn first_focus(&self) -> bool

Returns true if this click activated the window, as reported by the platform in MouseDownEvent::first_mouse.

Keyboard and touch clicks always return false. A keyboard click needs the element to be focused already.

pub fn click_count(&self) -> usize

Returns how many clicks in a row this click completes. A double click is 2.

A keyboard click always returns 1. A mouse click returns the count from its release. A touch click returns its tap count.

pub fn is_keyboard(&self) -> bool

Returns true if this click came from the keyboard.

Trait Implementations

impl Clone for ClickEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClickEvent

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

Formats the value using the given formatter.

impl Default for ClickEvent

fn default() -> Self

Returns the “default value” for a type.