Struct TerminalPane 

pub struct TerminalPane { /* private fields */ }

A terminal pane being built: terminal or terminal_with, then node (or .into()) to place it.

The program starts when the pane is first laid out, at the pane’s size, and is told every new size after. While the pane has the focus, every key goes to the program (Ctrl+C and Tab included) except the ones release_keys names, which go to the app; the mouse goes to it when it asked for the mouse, and pastes always do. Shift+PgUp and Shift+PgDn, and the wheel when the program does not want the mouse, scroll back through what scrolled off the top; any other key returns to the live screen. When the program exits its last screen stays, status is set, on_exit runs, and keys go to the app again. The program is ended when the pane leaves the tree.

Implementations

impl TerminalPane

pub fn on_exit( self, handler: impl FnMut(ExitStatus, &mut Ctx) + 'static, ) -> TerminalPane

Run handler on the app’s thread when the program exits, with how it ended.

pub fn status(&self) -> Signal<Option<ExitStatus>>

How the program ended: None while it runs. Read it in a node to show it.

pub fn scrollback(self, rows: usize) -> TerminalPane

Keep up to rows rows that scrolled off the top (default DEFAULT_SCROLLBACK). Before the pane is first laid out.

pub fn release_keys(self, keys: &str) -> TerminalPane

Keys (space-separated names, as Node::on_key takes them) that are not sent to the program but go on to the app’s bindings: a way out of the pane, such as "ctrl+q f10".

pub fn node(self) -> Node

The pane as a node: focusable, and flexible like any node until sized.

Trait Implementations

impl From<TerminalPane> for Node

fn from(pane: TerminalPane) -> Node

Converts to this type from the input type.