Struct TerminalState 

#[non_exhaustive]
pub struct TerminalState { /* private fields */ }

A terminal: the latest frame, the program’s status and everything the element needs to draw and to send input.

Implementations

impl TerminalState

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

Text being composed by an input method, drawn at the cursor.

impl TerminalState

pub fn new( source: impl FrameSource, config: TerminalConfig, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

A terminal fed by source, started at once.

pub fn local( options: LocalTerminalOptions, config: TerminalConfig, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

A terminal running a local program in a pty.

pub fn apply(&mut self, snapshot: &TerminalSnapshot, cx: &mut Context<'_, Self>)

Install a snapshot. Public so a host driving its own frames can use the same path as the engine.

pub fn frame(&self) -> &Arc<TerminalFrame>

The frame being drawn.

pub fn status(&self) -> &TerminalStatus

The program’s status.

pub fn title(&self) -> &SharedString

The title the program set.

pub fn cwd(&self) -> Option<&Path>

The working directory: the one the shell reported through its integration (OSC 7), or else the foreground process’s.

pub fn foreground(&self) -> Option<&ForegroundProcess>

The process in the foreground, such as the shell at its prompt or an editor it started, when the source reports one. A local pty does. TerminalEvent::ForegroundChanged reports a change.

pub fn needs_confirm_close(&self) -> bool

Whether closing the terminal would end a program other than the one it started, such as an editor or a build in the foreground, so an application should ask first, as Ghostty does. Without a foreground process, as from a stream, it is whether the cursor is away from a shell prompt.

pub fn input_backlog(&self) -> usize

Queued input bytes not yet delivered; the busy signal.

pub fn appearance(&self) -> &TerminalAppearance

The appearance.

pub fn font_size(&self, cx: &App) -> Pixels

The font size the grid draws with: the zoomed size, else the appearance’s, else the theme’s code font size.

pub fn set_font_size( &mut self, size: impl Into<Pixels>, cx: &mut Context<'_, Self>, )

Draw the grid at size, clamped to 1-255 points as Ghostty clamps it. The grid is measured again at the next paint, which resizes the program’s grid to fit. Emits TerminalEvent::FontSizeChanged.

pub fn increase_font_size( &mut self, points: impl Into<Pixels>, cx: &mut Context<'_, Self>, )

Zoom the font in by points, as Ghostty’s increase_font_size.

pub fn decrease_font_size( &mut self, points: impl Into<Pixels>, cx: &mut Context<'_, Self>, )

Zoom the font out by points, as Ghostty’s decrease_font_size.

pub fn reset_font_size(&mut self, cx: &mut Context<'_, Self>)

Go back to the appearance’s font size, or the theme’s.

pub fn set_appearance( &mut self, appearance: TerminalAppearance, cx: &mut Context<'_, Self>, )

Change the appearance. The grid is measured again at the next paint.

pub fn colors(&self) -> &TerminalColors

The colors.

pub fn set_colors(&mut self, colors: TerminalColors, cx: &mut Context<'_, Self>)

Change the colors. The next frame carries them.

pub fn is_live(&self) -> bool

Whether a program is running.

pub fn is_closed(&self) -> bool

Whether the terminal was closed.

pub fn is_visible(&self) -> bool

Whether the terminal is visible.

pub fn set_visible(&mut self, visible: bool, cx: &mut Context<'_, Self>)

Hidden terminals keep parsing output but stop producing frames and stop the cursor cadence. Revealing one asks for a current frame.

pub fn close(&mut self, cx: &mut Context<'_, Self>)

Stop the program and the source. Idempotent.

pub fn set_right_click_passthrough(&mut self, passthrough: bool)

Whether a right click goes to a program that reports the mouse. It does by default. When it does not, or a modifier is held, or no program reports the mouse, the click is left to the host, such as for a context menu.

pub fn has_selection(&self) -> bool

Whether a non-empty selection exists.

pub fn selected_text(&self) -> Option<String>

The selected text as shown, without scrollback.

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

The link under the pointer while the platform modifier is held.

pub fn copy(&mut self, cx: &mut Context<'_, Self>)

Copy the selection to the clipboard. A live engine is asked for the text because it can reach scrollback the frame does not carry.

pub fn select_all(&mut self, cx: &mut Context<'_, Self>)

Select the whole viewport.

pub fn clear_selection(&mut self, cx: &mut Context<'_, Self>) -> bool

Drop the selection. Returns whether there was one.

pub fn clear(&mut self, cx: &mut Context<'_, Self>)

Send form feed, which clears the screen at most shells.

pub fn paste(&mut self, cx: &mut Context<'_, Self>)

Paste the clipboard text.

pub fn paste_text( &mut self, text: impl Into<String>, cx: &mut Context<'_, Self>, )

Paste text, bracketed when the program asked for it.

pub fn send_text(&mut self, text: impl Into<String>, cx: &mut Context<'_, Self>)

Send raw text to the program.

pub fn scroll(&mut self, request: ScrollRequest, cx: &mut Context<'_, Self>)

Scroll the viewport.

pub fn scroll_pages(&mut self, pages: isize, cx: &mut Context<'_, Self>)

Scroll by whole pages; negative is toward older output.

pub fn is_scrolled(&self) -> bool

Whether the viewport is scrolled into history.

pub fn focus_handle(&self) -> &FocusHandle

The focus handle.

Trait Implementations

impl EntityInputHandler for TerminalState

fn bounds_for_range( &mut self, _range_utf16: Range<usize>, element_bounds: Bounds<Pixels>, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<Bounds<Pixels>>

The candidate window follows the cursor cell.

fn text_for_range( &mut self, range: Range<usize>, adjusted: &mut Option<Range<usize>>, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<String>

See InputHandler::text_for_range for details

fn selected_text_range( &mut self, _ignore_disabled_input: bool, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<UTF16Selection>

See InputHandler::selected_text_range for details

fn marked_text_range( &self, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<Range<usize>>

See InputHandler::marked_text_range for details

fn unmark_text(&mut self, _window: &mut Window, cx: &mut Context<'_, Self>)

See InputHandler::unmark_text for details

fn replace_text_in_range( &mut self, _range: Option<Range<usize>>, text: &str, _window: &mut Window, cx: &mut Context<'_, Self>, )

See InputHandler::replace_text_in_range for details

fn replace_and_mark_text_in_range( &mut self, _range: Option<Range<usize>>, new_text: &str, _new_selected_range: Option<Range<usize>>, _window: &mut Window, cx: &mut Context<'_, Self>, )

See InputHandler::replace_and_mark_text_in_range for details

fn character_index_for_point( &mut self, _point: Point<Pixels>, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<usize>

See InputHandler::character_index_for_point for details

fn paste( &mut self, item: ClipboardItem, window: &mut Window, cx: &mut Context<'_, Self>, )

See InputHandler::paste for details

fn selection_bounds_for_range( &mut self, _range_utf16: Range<usize>, _element_bounds: Bounds<Pixels>, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Vec<Bounds<Pixels>>

See InputHandler::selection_bounds_for_range for details.

fn set_selected_text_range( &mut self, _range_utf16: Range<usize>, _window: &mut Window, _cx: &mut Context<'_, Self>, )

See InputHandler::set_selected_text_range for details

fn text_length_utf16( &mut self, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<usize>

See InputHandler::text_length_utf16 for details

fn accepts_text_input( &self, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> bool

See InputHandler::accepts_text_input for details

fn text_input_configuration( &mut self, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> TextInputConfiguration

See InputHandler::text_input_configuration for details

fn text_input_editable_range( &mut self, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<Range<usize>>

See InputHandler::text_input_editable_range for details

impl EventEmitter<TerminalEvent> for TerminalState

impl Focusable for TerminalState

fn focus_handle(&self, _: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for TerminalState

fn render( &mut self, _: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.