Enum cursive_core::event::Event

pub enum Event {
    WindowResize,
    Refresh,
    Char(char),
    CtrlChar(char),
    AltChar(char),
    Key(Key),
    Shift(Key),
    Alt(Key),
    AltShift(Key),
    Ctrl(Key),
    CtrlShift(Key),
    CtrlAlt(Key),
    Mouse {
        offset: Vec2,
        position: Vec2,
        event: MouseEvent,
    },
    Unknown(Vec<u8>),
    // some variants omitted
}

Represents an event as seen by the application.

Variants

WindowResize

Event fired when the window is resized.

Refresh

Event fired regularly when a auto-refresh is set.

Char(char)

A character was entered (includes numbers, punctuation, ...).

CtrlChar(char)

A character was entered with the Ctrl key pressed.

AltChar(char)

A character was entered with the Alt key pressed.

Key(Key)

A non-character key was pressed.

Shift(Key)

A non-character key was pressed with the Shift key pressed.

Alt(Key)

A non-character key was pressed with the Alt key pressed.

AltShift(Key)

A non-character key was pressed with the Shift and Alt keys pressed.

Ctrl(Key)

A non-character key was pressed with the Ctrl key pressed.

CtrlShift(Key)

A non-character key was pressed with the Ctrl and Shift keys pressed.

CtrlAlt(Key)

A non-character key was pressed with the Ctrl and Alt keys pressed.

Mouse

A mouse event was sent.

Fields of Mouse

offset: Vec2

Position of the top-left corner of the view receiving this event.

position: Vec2

Position of the mouse when this event was fired.

event: MouseEvent

The mouse event itself.

Unknown(Vec<u8>)

An unknown event was received.

Implementations

impl Event

pub fn mouse_position(&self) -> Option<Vec2>

Returns the position of the mouse, if self is a mouse event.

pub fn mouse_position_mut(&mut self) -> Option<&mut Vec2>

Returns a mutable reference to the position of the mouse/

Returns None if self is not a mouse event.

pub fn relativize<V>(&mut self, top_left: V) where
    V: Into<Vec2>, 

Update self with the given offset.

If self is a mouse event, adds top_left to its offset. Otherwise, do nothing.

pub fn relativized<V>(&self, top_left: V) -> Self where
    V: Into<Vec2>, 

Returns a cloned, relativized event.

If self is a mouse event, adds top_left to its offset. Otherwise, returns a simple clone.

Trait Implementations

impl Clone for Event

pub fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Eq for Event

impl From<Event> for EventTrigger

pub fn from(event: Event) -> Self

Performs the conversion.

impl From<Key> for Event

pub fn from(k: Key) -> Event

Performs the conversion.

impl From<char> for Event

pub fn from(c: char) -> Event

Performs the conversion.

impl Hash for Event

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Event> for Event

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

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

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

This method tests for !=.

impl StructuralEq for Event

impl StructuralPartialEq for Event