Enum KeyAction 

pub enum KeyAction {
    ActivateKeyTable {
        name: String,
        mode: ActivateKeyTableMode,
        replace_current: bool,
    },
    PopKeyTable,
    ClearKeyTableStack,
    ActivatePaneDirection(Direction),
    AdjustPaneSize {
        direction: Direction,
        amount: i32,
    },
    SplitPane {
        direction: SplitDirection,
    },
    ClosePane,
    ZoomPane,
    ActivateTab(i32),
    ActivateTabRelative(i32),
    SpawnTab,
    CloseTab,
    MoveTab(i32),
    SpawnWindow,
    CloseWindow,
    ToggleFullscreen,
    SendString(String),
    SendKey {
        key: KeyCode,
        mods: KeyModifiers,
    },
    ScrollByPage(i32),
    ScrollByLine(i32),
    ScrollToTop,
    ScrollToBottom,
    ClearScrollback,
    Copy,
    Paste,
    CopyTo(ClipboardKind),
    PasteFrom(ClipboardKind),
    ActivateCopyMode,
    ActivateSearchMode,
    CopyMode(CopyModeAction),
    Search(SearchAction),
    EmitEvent {
        event: String,
        args: Vec<String>,
    },
    RunCommand(String),
    Noop,
}

Actions that can be triggered by key bindings

Variants

ActivateKeyTable

Activate a key table by name

Fields

name: String

mode: ActivateKeyTableMode

replace_current: bool

PopKeyTable

Pop the current key table from the stack

ClearKeyTableStack

Clear the entire key table stack

ActivatePaneDirection(Direction)

Activate pane in a direction

AdjustPaneSize

Adjust pane size

Fields

direction: Direction

amount: i32

SplitPane

Split pane

Fields

direction: SplitDirection

ClosePane

Close current pane

ZoomPane

Zoom/maximize current pane

ActivateTab(i32)

Activate tab by index (0-based)

ActivateTabRelative(i32)

Activate tab relative to current (+1, -1, etc)

SpawnTab

Create new tab

CloseTab

Close current tab

MoveTab(i32)

Move tab to index

SpawnWindow

Create new window

CloseWindow

Close current window

ToggleFullscreen

Toggle fullscreen

SendString(String)

Send a string to the terminal

SendKey

Send a specific key combination

Fields

key: KeyCode

mods: KeyModifiers

ScrollByPage(i32)

Scroll by pages

ScrollByLine(i32)

Scroll by lines

ScrollToTop

Scroll to top

ScrollToBottom

Scroll to bottom

ClearScrollback

Clear scrollback buffer

Copy

Copy selection

Paste

Paste from clipboard

CopyTo(ClipboardKind)

Copy to specific clipboard

PasteFrom(ClipboardKind)

Paste from specific clipboard

ActivateCopyMode

Enter copy mode

ActivateSearchMode

Enter search mode

CopyMode(CopyModeAction)

Copy mode specific actions

Search(SearchAction)

Search mode specific actions

EmitEvent

Emit a custom event

Fields

event: String

args: Vec<String>

RunCommand(String)

Run a shell command

Noop

No operation

Trait Implementations

impl Clone for KeyAction

fn clone(&self) -> KeyAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyAction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyAction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for KeyAction

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for KeyAction

impl StructuralPartialEq for KeyAction