[−][src]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`[src]

`pub fn from_crossterm_event(crossterm_event: Event) -> Option<Event>`[src]

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`[src]

`pub const fn simple_key(code: KeyCode) -> Self`[src]

`pub fn mouse_pos(self) -> Option<(u16, u16)>`[src]

In case the event is mouse related, give the position

Trait Implementations

`impl Clone for Event`[src]

`fn clone(&self) -> Event`[src]

`pub fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Copy for Event`[src]

`impl Debug for Event`[src]

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

`impl Eq for Event`[src]

`impl PartialEq<Event> for Event`[src]

`fn eq(&self, other: &Event) -> bool`[src]

`fn ne(&self, other: &Event) -> bool`[src]

`impl StructuralEq for Event`[src]

`impl StructuralPartialEq for Event`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Event`[src]

`impl Send for Event`[src]

`impl Sync for Event`[src]

`impl Unpin for Event`[src]

`impl UnwindSafe for Event`[src]

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`pub fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`pub fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`pub fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`pub fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`pub fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

`pub fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

[−][src]Enum termimad::Event

Variants

Implementations

impl Event[src]

pub fn from_crossterm_event(crossterm_event: Event) -> Option<Event>[src]

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

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

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

Trait Implementations

impl Clone for Event[src]

fn clone(&self) -> Event[src]

pub fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Copy for Event[src]

impl Debug for Event[src]

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

impl Eq for Event[src]

impl PartialEq<Event> for Event[src]

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

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

impl StructuralEq for Event[src]

impl StructuralPartialEq for Event[src]

Auto Trait Implementations

impl RefUnwindSafe for Event[src]

impl Send for Event[src]

impl Sync for Event[src]

impl Unpin for Event[src]

impl UnwindSafe for Event[src]

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

pub fn into(self) -> U[src]

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

pub fn to_owned(&self) -> T[src]

pub fn clone_into(&self, target: &mut T)[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]