Enum ComponentEvent 

#[non_exhaustive]
pub enum ComponentEvent {
    Key(String),
    Paste(String),
    Resize {
        columns: u16,
        rows: u16,
    },
    Tick,
    Mouse {
        kind: String,
        column: u16,
        row: u16,
    },
    Link(String),
}

An event for a PluginComponent.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Key(String)

A key, by name: a, A, enter, down, space, tab, backspace, f5, with ctrl+, alt+ and shift+ before it, in that order (ctrl+shift+left, shift+tab). A key that does one of the component’s bindings arrives as the first key declared for that action, spelled as declared (esc stays esc), even when the user rebound it.

Paste(String)

Text pasted at once.

Resize

The terminal is now this size.

Fields

columns: u16

rows: u16

Tick

The component’s tick interval passed.

Mouse

The mouse, in the component’s own view (0-based), when it asked for it with mouse.

Fields

kind: String

down, up, drag, moved, scroll_up or scroll_down.

column: u16

row: u16

Link(String)

A click on a hyperlink in the component’s view: its URL.

Implementations

impl ComponentEvent

pub fn key(&self) -> Option<&str>

The key’s name, when this is a key.

Trait Implementations

impl Clone for ComponentEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentEvent

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

Formats the value using the given formatter.

impl Eq for ComponentEvent

impl PartialEq for ComponentEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ComponentEvent