Struct rat_focus::event::util::MouseFlags

pub struct MouseFlags {
    pub click: Cell<bool>,
    pub clack: Cell<bool>,
    pub drag: Cell<bool>,
}

Some state for mouse interactions.

This helps with double-click and mouse drag recognition. Add this to your widget state.

Fields

click: Cell<bool>

Flag for the first down.

clack: Cell<bool>

Flag for the first up.

drag: Cell<bool>

Drag enabled.

Implementations

impl MouseFlags

pub fn pos_of(&self, event: &MouseEvent) -> (u16, u16)

Returns the last drag-position if drag is active.

pub fn drag(&self, area: Rect, event: &MouseEvent) -> bool

Checks if this is a drag event for the widget.

It makes sense to allow drag events outside the given area, if the drag has been started with a click to the given area.

This function handles that case.

pub fn drag2( &self, area: Rect, event: &MouseEvent, filter: KeyModifiers, ) -> bool

Checks if this is a drag event for the widget.

It makes sense to allow drag events outside the given area, if the drag has been started with a click to the given area.

This function handles that case.

pub fn doubleclick(&self, area: Rect, event: &MouseEvent) -> bool

Checks for double-click events.

This can be integrated in the event-match with a guard:

match event {
        Event::Mouse(m) if state.mouse.doubleclick(state.area, m) => {
            state.flip = !state.flip;
            Outcome::Changed
        }
}

pub fn doubleclick2( &self, area: Rect, event: &MouseEvent, filter: KeyModifiers, ) -> bool

Checks for double-click events. This one can have an extra KeyModifiers.

This can be integrated in the event-match with a guard:

match event {
        Event::Mouse(m) if state.mouse.doubleclick(state.area, m) => {
            state.flip = !state.flip;
            Outcome::Changed
        }
}

Trait Implementations

impl Clone for MouseFlags

fn clone(&self) -> MouseFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseFlags

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

Formats the value using the given formatter.

impl Default for MouseFlags

fn default() -> MouseFlags

Returns the “default value” for a type.

impl PartialEq for MouseFlags

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

impl StructuralPartialEq for MouseFlags