TermTui

Struct TermTui 

Source
pub struct TermTui {
    pub title: String,
    pub focused: bool,
    pub copy_mode: CopyMode,
    pub border_style: Style,
    pub focused_border_style: Style,
    pub keybindings: TermTuiKeyBindings,
    /* private fields */
}
Expand description

TermTui - Terminal widget with mprocs-style architecture

Features:

  • termwiz-based VT100 parsing
  • VecDeque scrollback buffer
  • Copy mode with frozen screen snapshots
  • Mouse and keyboard selection

Fields§

§title: String

Title for the terminal

§focused: bool

Whether the terminal has focus

§copy_mode: CopyMode

Copy mode state

§border_style: Style

Styling

§focused_border_style: Style§keybindings: TermTuiKeyBindings

Customizable keybindings

Implementations§

Source§

impl TermTui

Source

pub fn new(title: impl Into<String>) -> Self

Create a new terminal

Source

pub fn with_keybindings(self, keybindings: TermTuiKeyBindings) -> Self

Set custom keybindings (builder pattern)

Source

pub fn spawn_with_command( title: impl Into<String>, command: &str, args: &[&str], ) -> Result<Self>

Spawn a terminal with a command

Source

pub fn handle_key(&mut self, key: KeyEvent) -> bool

Handle keyboard input

Source

pub fn enter_copy_mode(&mut self)

Enter copy mode with frozen screen

Source

pub fn handle_mouse(&mut self, event: MouseEvent, area: Rect) -> bool

Handle mouse events

This method handles all mouse interactions:

  • Mouse drag: automatically enters copy mode and starts selection (like mprocs)
  • Mouse wheel: scrolls the terminal content
  • In copy mode: mouse click moves cursor, mouse drag selects
§Arguments
  • event - The mouse event from crossterm
  • area - The area where the terminal is rendered (for coordinate translation)
§Returns

true if the event was handled, false otherwise

Source

pub fn handle_mouse_down(&mut self, x: u16, y: u16)

👎Deprecated since 0.2.0: Use handle_mouse instead for comprehensive mouse handling

Handle mouse down (start selection)

Note: Consider using handle_mouse instead for comprehensive mouse handling.

Source

pub fn handle_mouse_drag(&mut self, x: u16, y: u16)

👎Deprecated since 0.2.0: Use handle_mouse instead for comprehensive mouse handling

Handle mouse drag (update selection)

Note: Consider using handle_mouse instead for comprehensive mouse handling.

Source

pub fn handle_mouse_up(&mut self)

👎Deprecated since 0.2.0: Use handle_mouse instead for comprehensive mouse handling

Handle mouse up

Note: Consider using handle_mouse instead for comprehensive mouse handling.

Source

pub fn scroll_up(&mut self, lines: usize)

Scroll up

Source

pub fn scroll_down(&mut self, lines: usize)

Scroll down

Source

pub fn clear_selection(&mut self)

Clear selection

Source

pub fn has_selection(&self) -> bool

Check if has selection

Source

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

Get selected text

Source

pub fn send_input(&self, text: &str)

Send input to the terminal

Source

pub fn resize(&mut self, rows: u16, cols: u16)

Resize the terminal

Source

pub fn render_content(&mut self, frame: &mut Frame<'_>, area: Rect)

Render terminal content (without borders)

Source

pub fn render(&mut self, frame: &mut Frame<'_>, area: Rect)

Render terminal with borders

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more