Enum termimad::Event

pub enum Event {
    Key(KeyEvent),
    Click(u16, u16, KeyModifiers),
    RightClick(u16, u16, KeyModifiers),
    DoubleClick(u16, u16),
    Resize(u16, u16),
    Wheel(i32),
}

a valid user event

Variants

Key(KeyEvent)

Click(u16, u16, KeyModifiers)

RightClick(u16, u16, KeyModifiers)

DoubleClick(u16, u16)

Resize(u16, u16)

terminal was resized. Contains the new dimensions

Wheel(i32)

mouse wheel turns. contains -1 if up or 1 if down

Implementations

impl Event

pub fn from_crossterm_event(crossterm_event: Result<Event>) -> Option<Event>

convert a crossterm event into a termimad one.

normalize \r and \n into Enter (useful for key combinations)

To get a double-click you'll either need to use a termimad event-source or to do the computation yourself.

pub const fn crtl_key(code: KeyCode) -> Self

pub const fn simple_key(code: KeyCode) -> Self

pub fn mouse_pos(self) -> Option<(u16, u16)>

In case the event is mouse related, give the position

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Event

impl Debug for Event

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

Formats the value using the given formatter.

impl Eq for Event

impl PartialEq<Event> for Event

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Event

impl StructuralPartialEq for Event