Struct tuikit::term::Term

pub struct Term<UserEvent: Send + 'static = ()> { /* fields omitted */ }

Implementations

impl<UserEvent: Send + 'static> Term<UserEvent>

pub fn with_height(height: TermHeight) -> Result<Term<UserEvent>>

Create a Term with height specified.

Internally if the calculated height would fill the whole screen, Alternate Screen will be enabled, otherwise only part of the screen will be used.

If the preferred height is larger than the current screen, whole screen is used.

use tuikit::term::{Term, TermHeight};

let term: Term<()> = Term::with_height(TermHeight::Percent(30)).unwrap(); // 30% of the terminal height
let term: Term<()> = Term::with_height(TermHeight::Fixed(20)).unwrap(); // fixed 20 lines

pub fn new() -> Result<Term<UserEvent>>

Create a Term (with 100% height)

use tuikit::term::{Term, TermHeight};

let term: Term<()> = Term::new().unwrap();
let term: Term<()> = Term::with_height(TermHeight::Percent(100)).unwrap();

pub fn with_options(options: TermOptions) -> Result<Term<UserEvent>>

Create a Term with custom options

use tuikit::term::{Term, TermHeight, TermOptions};

let term: Term<()> = Term::with_options(TermOptions::default().height(TermHeight::Percent(100))).unwrap();

pub fn restart(&self) -> Result<()>

restart the terminal if it had been stopped

pub fn pause(&self) -> Result<()>

Pause the Term

This function will cause the Term to give away the control to the terminal(such as listening to the key strokes). After the Term was "paused", poll_event will block indefinitely and recover after the Term was restarted.

pub fn peek_event(&self, timeout: Duration) -> Result<Event<UserEvent>>

Wait an event up to timeout and return it

pub fn poll_event(&self) -> Result<Event<UserEvent>>

Wait for an event indefinitely and return it

pub fn send_event(&self, event: Event<UserEvent>) -> Result<()>

An interface to inject event to the terminal's event queue

pub fn present(&self) -> Result<()>

Sync internal buffer with terminal

pub fn term_size(&self) -> Result<(usize, usize)>

Return the printable size(width, height) of the term

pub fn clear(&self) -> Result<()>

Clear internal buffer

pub fn put_cell(&self, row: usize, col: usize, cell: Cell) -> Result<usize>

Change a cell of position (row, col) to cell

pub fn print(&self, row: usize, col: usize, content: &str) -> Result<usize>

Print content starting with position (row, col)

pub fn print_with_attr(
    &self,
    row: usize,
    col: usize,
    content: &str,
    attr: impl Into<Attr>
) -> Result<usize>

print content starting with position (row, col) with attr

pub fn set_cursor(&self, row: usize, col: usize) -> Result<()>

Set cursor position to (row, col), and show the cursor

pub fn show_cursor(&self, show: bool) -> Result<()>

show/hide cursor, set show to false to hide the cursor

pub fn enable_mouse_support(&self) -> Result<()>

Enable mouse support

pub fn disable_mouse_support(&self) -> Result<()>

Disable mouse support

pub fn clear_on_exit(&self, clear: bool) -> Result<()>

Whether to clear the terminal upon exiting. Defaults to true.

pub fn draw(&self, draw: &dyn Draw) -> Result<()>

Trait Implementations

impl<'a, UserEvent: Send + 'static> Drop for Term<UserEvent>

fn drop(&mut self)

Executes the destructor for this type.