Enum InputAction 

pub enum InputAction {
    Clear,
    NewLine,
    LineStart,
    LineEnd,
    Left,
    Right,
    WordLeft,
    WordRight,
    Backspace,
    Delete,
    DeleteWordBefore,
    DeleteWordAfter,
    DeleteToLineStart,
    DeleteToLineEnd,
    LineUp,
    LineDown,
    Up,
    Down,
    ScrollUp,
    ScrollDown,
    PageUp,
    PageDown,
    Tab,
    Send,
    Stop,
    PasteImage,
    SelectUp,
    SelectDown,
    Deselect,
    AnswerInline(u8),
    DismissInline,
}

A built-in action of the input. On a KeyBinding’s entity it is what the binding does, in order with the other keys of the frame, instead of triggering KeyPressed: the view’s own keys are such bindings, and a plugin rebinds one by spawning its own. Pushed onto the PendingInput as KeyInput::Action, it is done where it stands among the keys.

use rig_harness::prelude::*;
use rig_tui::{InputAction, KeyBinding, KeyPress};

fn build(app: &mut App) {
    // Ctrl+K browses back as Up does: the completion, the line, the history.
    app.world_mut().spawn((KeyBinding::new(KeyPress::ctrl('k'), "Up"), InputAction::Up));
}

Variants

Clear

Empties the input.

NewLine

Types a newline.

LineStart

The start of the cursor’s line.

LineEnd

The end of the cursor’s line.

Left

A character back.

Right

A character forward.

WordLeft

The start of the word before the cursor.

WordRight

The end of the word after the cursor.

Backspace

Deletes the character before the cursor.

Delete

Deletes the character after the cursor.

DeleteWordBefore

Deletes the word before the cursor.

DeleteWordAfter

Deletes the word after the cursor.

DeleteToLineStart

Deletes to the start of the line, or the newline before it.

DeleteToLineEnd

Deletes to the end of the line, or the newline after it.

LineUp

The line above, or an earlier prompt of the history: Ctrl+P.

LineDown

The line below, or a later prompt of the history: Ctrl+N.

Up

The completion’s previous item, else the line above, else an earlier prompt.

Down

The completion’s next item, else the line below, else a later prompt.

ScrollUp

Scrolls the transcript a row up.

ScrollDown

Scrolls the transcript a row down.

PageUp

Scrolls the transcript a page up.

PageDown

Scrolls the transcript a page down.

Tab

Completes, or with a turn running and nothing to complete, sends for after the turn.

Send

Completes a partly typed command or path, continues a line ending in \, else sends.

Stop

Closes the completion, else interrupts the shown agent.

PasteImage

Saves the clipboard’s image in the session’s Scratch::images and types @path for it, which attaches it to the message, or says there is none. A pasted path to an image file (a file dropped on the terminal) becomes @path too.

SelectUp

Selects the item of the transcript above the one selected, or the newest.

SelectDown

Selects the item below the one selected; past the newest, none.

Deselect

Selects none, which gives the keys back to the input: Esc while the person reads the transcript (KeyScope::Transcript).

AnswerInline(u8)

Answers the question shown beside the work with its choice of this number, counted from 1, or the number after its choices: types its answer in the input.

DismissInline

Closes the question shown beside the work, refused.

Trait Implementations

impl Clone for InputAction

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for InputAction

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn map_entities<M: EntityMapper>(this: &mut Self, mapper: &mut M)

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Copy for InputAction

impl Debug for InputAction

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

Formats the value using the given formatter.

impl Eq for InputAction

impl PartialEq for InputAction

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InputAction