Enum zellij_utils::input::actions::Action

pub enum Action {
    Quit,
    Write(Vec<u8>),
    WriteChars(String),
    SwitchToMode(InputMode),
    SwitchModeForAllClients(InputMode),
    Resize(Resize, Option<Direction>),
    FocusNextPane,
    FocusPreviousPane,
    SwitchFocus,
    MoveFocus(Direction),
    MoveFocusOrTab(Direction),
    MovePane(Option<Direction>),
    MovePaneBackwards,
    ClearScreen,
    DumpScreen(String, bool),
    DumpLayout,
    EditScrollback,
    ScrollUp,
    ScrollUpAt(Position),
    ScrollDown,
    ScrollDownAt(Position),
    ScrollToBottom,
    ScrollToTop,
    PageScrollUp,
    PageScrollDown,
    HalfPageScrollUp,
    HalfPageScrollDown,
    ToggleFocusFullscreen,
    TogglePaneFrames,
    ToggleActiveSyncTab,
    NewPane(Option<Direction>, Option<String>),
    EditFile(PathBuf, Option<usize>, Option<PathBuf>, Option<Direction>, bool, bool, Option<FloatingPaneCoordinates>),
    NewFloatingPane(Option<RunCommandAction>, Option<String>, Option<FloatingPaneCoordinates>),
    NewTiledPane(Option<Direction>, Option<RunCommandAction>, Option<String>),
    NewInPlacePane(Option<RunCommandAction>, Option<String>),
    TogglePaneEmbedOrFloating,
    ToggleFloatingPanes,
    CloseFocus,
    PaneNameInput(Vec<u8>),
    UndoRenamePane,
    NewTab(Option<TiledPaneLayout>, Vec<FloatingPaneLayout>, Option<Vec<SwapTiledLayout>>, Option<Vec<SwapFloatingLayout>>, Option<String>),
    NoOp,
    GoToNextTab,
    GoToPreviousTab,
    CloseTab,
    GoToTab(u32),
    GoToTabName(String, bool),
    ToggleTab,
    TabNameInput(Vec<u8>),
    UndoRenameTab,
    MoveTab(Direction),
    Run(RunCommandAction),
    Detach,
    LeftClick(Position),
    RightClick(Position),
    MiddleClick(Position),
    LaunchOrFocusPlugin(RunPluginOrAlias, bool, bool, bool, bool),
    LaunchPlugin(RunPluginOrAlias, bool, bool, bool, Option<PathBuf>),
    LeftMouseRelease(Position),
    RightMouseRelease(Position),
    MiddleMouseRelease(Position),
    MouseHoldLeft(Position),
    MouseHoldRight(Position),
    MouseHoldMiddle(Position),
    Copy,
    Confirm,
    Deny,
    SkipConfirm(Box<Action>),
    SearchInput(Vec<u8>),
    Search(SearchDirection),
    SearchToggleOption(SearchOption),
    ToggleMouseMode,
    PreviousSwapLayout,
    NextSwapLayout,
    QueryTabNames,
    NewTiledPluginPane(RunPluginOrAlias, Option<String>, bool, Option<PathBuf>),
    NewFloatingPluginPane(RunPluginOrAlias, Option<String>, bool, Option<PathBuf>, Option<FloatingPaneCoordinates>),
    NewInPlacePluginPane(RunPluginOrAlias, Option<String>, bool),
    StartOrReloadPlugin(RunPluginOrAlias),
    CloseTerminalPane(u32),
    ClosePluginPane(u32),
    FocusTerminalPaneWithId(u32, bool),
    FocusPluginPaneWithId(u32, bool),
    RenameTerminalPane(u32, Vec<u8>),
    RenamePluginPane(u32, Vec<u8>),
    RenameTab(u32, Vec<u8>),
    BreakPane,
    BreakPaneRight,
    BreakPaneLeft,
    RenameSession(String),
    CliPipe {
        pipe_id: String,
        name: Option<String>,
        payload: Option<String>,
        args: Option<BTreeMap<String, String>>,
        plugin: Option<String>,
        configuration: Option<BTreeMap<String, String>>,
        launch_new: bool,
        skip_cache: bool,
        floating: Option<bool>,
        in_place: Option<bool>,
        cwd: Option<PathBuf>,
        pane_title: Option<String>,
    },
    KeybindPipe {
        name: Option<String>,
        payload: Option<String>,
        args: Option<BTreeMap<String, String>>,
        plugin: Option<String>,
        configuration: Option<BTreeMap<String, String>>,
        launch_new: bool,
        skip_cache: bool,
        floating: Option<bool>,
        in_place: Option<bool>,
        cwd: Option<PathBuf>,
        pane_title: Option<String>,
    },
    ListClients,
}

Actions that can be bound to keys.

Variants

Quit

Quit Zellij.

Write(Vec<u8>)

Write to the terminal.

WriteChars(String)

Write Characters to the terminal.

SwitchToMode(InputMode)

Switch to the specified input mode.

SwitchModeForAllClients(InputMode)

Switch all connected clients to the specified input mode.

Resize(Resize, Option<Direction>)

Shrink/enlarge focused pane at specified border

FocusNextPane

Switch focus to next pane in specified direction.

FocusPreviousPane

SwitchFocus

Move the focus pane in specified direction.

MoveFocus(Direction)

MoveFocusOrTab(Direction)

Tries to move the focus pane in specified direction. If there is no pane in the direction, move to previous/next Tab.

MovePane(Option<Direction>)

MovePaneBackwards

ClearScreen

Clear all buffers of a current screen

DumpScreen(String, bool)

Dumps the screen to a file

DumpLayout

Dumps

EditScrollback

Scroll up in focus pane.

ScrollUp

ScrollUpAt(Position)

Scroll up at point

ScrollDown

Scroll down in focus pane.

ScrollDownAt(Position)

Scroll down at point

ScrollToBottom

Scroll down to bottom in focus pane.

ScrollToTop

Scroll up to top in focus pane.

PageScrollUp

Scroll up one page in focus pane.

PageScrollDown

Scroll down one page in focus pane.

HalfPageScrollUp

Scroll up half page in focus pane.

HalfPageScrollDown

Scroll down half page in focus pane.

ToggleFocusFullscreen

Toggle between fullscreen focus pane and normal layout.

TogglePaneFrames

Toggle frames around panes in the UI

ToggleActiveSyncTab

Toggle between sending text commands to all panes on the current tab and normal mode.

NewPane(Option<Direction>, Option<String>)

Open a new pane in the specified direction (relative to focus). If no direction is specified, will try to use the biggest available space.

EditFile(PathBuf, Option<usize>, Option<PathBuf>, Option<Direction>, bool, bool, Option<FloatingPaneCoordinates>)

Open the file in a new pane using the default editor

NewFloatingPane(Option<RunCommandAction>, Option<String>, Option<FloatingPaneCoordinates>)

Open a new floating pane

NewTiledPane(Option<Direction>, Option<RunCommandAction>, Option<String>)

Open a new tiled (embedded, non-floating) pane

NewInPlacePane(Option<RunCommandAction>, Option<String>)

Open a new pane in place of the focused one, suppressing it instead

TogglePaneEmbedOrFloating

Embed focused pane in tab if floating or float focused pane if embedded

ToggleFloatingPanes

Toggle the visibility of all floating panes (if any) in the current Tab

CloseFocus

Close the focus pane.

PaneNameInput(Vec<u8>)

UndoRenamePane

NewTab(Option<TiledPaneLayout>, Vec<FloatingPaneLayout>, Option<Vec<SwapTiledLayout>>, Option<Vec<SwapFloatingLayout>>, Option<String>)

Create a new tab, optionally with a specified tab layout.

NoOp

Do nothing.

GoToNextTab

Go to the next tab.

GoToPreviousTab

Go to the previous tab.

CloseTab

Close the current tab.

GoToTab(u32)

GoToTabName(String, bool)

ToggleTab

TabNameInput(Vec<u8>)

UndoRenameTab

MoveTab(Direction)

Run(RunCommandAction)

Run specified command in new pane.

Detach

Detach session and exit

LeftClick(Position)

RightClick(Position)

MiddleClick(Position)

LaunchOrFocusPlugin(RunPluginOrAlias, bool, bool, bool, bool)

LaunchPlugin(RunPluginOrAlias, bool, bool, bool, Option<PathBuf>)

LeftMouseRelease(Position)

RightMouseRelease(Position)

MiddleMouseRelease(Position)

MouseHoldLeft(Position)

MouseHoldRight(Position)

MouseHoldMiddle(Position)

Copy

Confirm

Confirm a prompt

Deny

Deny a prompt

SkipConfirm(Box<Action>)

Confirm an action that invokes a prompt automatically

SearchInput(Vec<u8>)

Search for String

Search(SearchDirection)

Search for something

SearchToggleOption(SearchOption)

Toggle case sensitivity of search

ToggleMouseMode

PreviousSwapLayout

NextSwapLayout

QueryTabNames

Query all tab names

NewTiledPluginPane(RunPluginOrAlias, Option<String>, bool, Option<PathBuf>)

Open a new tiled (embedded, non-floating) plugin pane

NewFloatingPluginPane(RunPluginOrAlias, Option<String>, bool, Option<PathBuf>, Option<FloatingPaneCoordinates>)

NewInPlacePluginPane(RunPluginOrAlias, Option<String>, bool)

StartOrReloadPlugin(RunPluginOrAlias)

CloseTerminalPane(u32)

ClosePluginPane(u32)

FocusTerminalPaneWithId(u32, bool)

FocusPluginPaneWithId(u32, bool)

RenameTerminalPane(u32, Vec<u8>)

RenamePluginPane(u32, Vec<u8>)

RenameTab(u32, Vec<u8>)

BreakPane

BreakPaneRight

BreakPaneLeft

RenameSession(String)

CliPipe

Fields

pipe_id: String

name: Option<String>

payload: Option<String>

args: Option<BTreeMap<String, String>>

plugin: Option<String>

configuration: Option<BTreeMap<String, String>>

launch_new: bool

skip_cache: bool

floating: Option<bool>

in_place: Option<bool>

cwd: Option<PathBuf>

pane_title: Option<String>

KeybindPipe

Fields

name: Option<String>

payload: Option<String>

args: Option<BTreeMap<String, String>>

plugin: Option<String>

configuration: Option<BTreeMap<String, String>>

launch_new: bool

skip_cache: bool

floating: Option<bool>

in_place: Option<bool>

cwd: Option<PathBuf>

pane_title: Option<String>

ListClients

Implementations

impl Action

pub fn shallow_eq(&self, other_action: &Action) -> bool

Checks that two Action are match except their mutable attributes.

pub fn actions_from_cli( cli_action: CliAction, get_current_dir: Box<dyn Fn() -> PathBuf>, config: Option<Config> ) -> Result<Vec<Action>, String>

impl Action

pub fn new_from_bytes( action_name: &str, bytes: Vec<u8>, action_node: &KdlNode ) -> Result<Self, ConfigError>

pub fn new_from_string( action_name: &str, string: String, action_node: &KdlNode ) -> Result<Self, ConfigError>

Trait Implementations

impl Clone for Action

fn clone(&self) -> Action

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Action

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Action

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<OnForceClose> for Action

fn from(ofc: OnForceClose) -> Action

Converts to this type from the input type.

impl PartialEq for Action

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Action

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<(&KdlNode, &Options)> for Action

type Error = ConfigError

The type returned in the event of a conversion error.

fn try_from( (kdl_action, config_options): (&KdlNode, &Options) ) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Action> for ProtobufAction

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(action: Action) -> Result<Self, &'static str>

Performs the conversion.

impl TryFrom<Action> for Action

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(protobuf_action: ProtobufAction) -> Result<Self, &'static str>

Performs the conversion.

impl Eq for Action

impl StructuralPartialEq for Action