Struct MouseFlags 

pub struct MouseFlags {
    pub time: Cell<Option<SystemTime>>,
    pub click: Cell<Clicks>,
    pub drag: Cell<bool>,
    pub hover: Cell<bool>,
    pub non_exhaustive: NonExhaustive,
}

Some state for mouse interactions.

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

Fields

time: Cell<Option<SystemTime>>

Timestamp for double click

click: Cell<Clicks>

State for double click.

drag: Cell<bool>

Drag enabled.

hover: Cell<bool>

Hover detect.

non_exhaustive: NonExhaustive

Implementations

impl MouseFlags

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

Returns column/row extracted from the Mouse-Event.

pub fn item_at(&self, areas: &[Rect], x_pos: u16, y_pos: u16) -> Option<usize>

Which of the given rects is at the position.

pub fn row_at(&self, areas: &[Rect], y_pos: u16) -> Option<usize>

Which row of the given contains the position. This uses only the vertical components of the given areas.

You might want to limit calling this functions when the full position is inside your target rect.

pub fn column_at(&self, areas: &[Rect], x_pos: u16) -> Option<usize>

Column at given position. This uses only the horizontal components of the given areas.

You might want to limit calling this functions when the full position is inside your target rect.

pub fn row_at_drag( &self, encompassing: Rect, areas: &[Rect], y_pos: u16, ) -> Result<usize, isize>

Find a row position when dragging with the mouse. This uses positions outside the given areas to estimate an invisible row that could be meant by the mouse position. It uses the heuristic 1 row == 1 item for simplicity’s sake.

Rows outside the bounds are returned as Err(isize), rows inside as Ok(usize).

pub fn column_at_drag( &self, encompassing: Rect, areas: &[Rect], x_pos: u16, ) -> Result<usize, isize>

Find a column position when dragging with the mouse. This uses positions outside the given areas to estimate an invisible column that could be meant by the mouse position. It uses the heuristic 1 column == 1 item for simplicity’s sake.

Columns outside the bounds are returned as Err(isize), rows inside as Ok(usize).

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

Checks if this is a hover event for the widget.

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 can be integrated in the event-match with a guard:

match event {
        Event::Mouse(m) if state.mouse.drag(state.area, m) => {
            // ...
            Outcome::Changed
        }
}

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 duplicate 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

Tests for self and other values to be equal, and is used by ==.

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

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