Enum Event

pub enum Event {
    Close,
    Resize {
        width: i32,
        height: i32,
    },
    MouseMove {
        x: i32,
        y: i32,
    },
    MouseScroll {
        delta: i32,
    },
    KeyPressed {
        key: KeyCode,
        ctrl: bool,
        shift: bool,
    },
    KeyReleased {
        key: KeyCode,
        ctrl: bool,
        shift: bool,
    },
    ShiftPressed,
    ShiftReleased,
    ControlPressed,
    ControlReleased,
    AltPressed,
    AltReleased,
}

A single input event.

Variants

Close

Terminal window closed.

Resize

Terminal window resized. Needs to have window.resizeable = true to occur.

Note, that, as of 40e6253, the terminal window is cleared when resized.

Fields

width: i32

Width the terminal was resized to.

height: i32

Heigth the terminal was resized to.

MouseMove

Mouse moved.

If precise-mouse is off, generated each time mouse moves from cell to cell, otherwise, when it moves from pixel to pixel.

Fields

x: i32

0-based cell index from the left to which the mouse cursor moved.

y: i32

0-based cell index from the top to which the mouse cursor moved.

MouseScroll

Mouse wheel moved.

Fields

delta: i32

Amount of steps the wheel rotated.

Positive when scrolled “down”/“backwards”.

Negative when scrolled “up”/“forwards”/“away”.

KeyPressed

A keyboard or mouse button pressed (might repeat, if set in OS).

Fields

key: KeyCode

The key pressed.

ctrl: bool

Whether the Control key is pressed.

shift: bool

Whether the Shift key is pressed.

KeyReleased

A keyboard or mouse button released.

Fields

key: KeyCode

The key released.

ctrl: bool

Whether the Control key is pressed.

shift: bool

Whether the Shift key is pressed.

ShiftPressed

The Shift key pressed (might repeat, if set in OS).

ShiftReleased

The Shift key released.

ControlPressed

The Shift key pressed (might repeat, if set in OS).

ControlReleased

The Control key released.

AltPressed

The Alt key pressed (might repeat, if set in OS).

AltReleased

The Alt key released.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Hash for Event

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Event

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

impl Eq for Event

impl StructuralPartialEq for Event