ttx::Terminal Class Reference

#include </home/runner/work/ttx/ttx/lib/include/ttx/terminal.h>

Classes
struct	Cell

Public Types
using	Row = di::Vector<Cell>

Public Member Functions
	Terminal (dius::SyncFile &psuedo_terminal)
auto	clone () const -> Terminal
auto	state_as_escape_sequences () const -> di::String
void	on_parser_results (di::Span< ParserResult const > results)
auto	cursor_row () const -> u32
auto	cursor_col () const -> u32
auto	cursor_hidden () const -> bool
auto	should_display_cursor_at_position (u32 r, u32 c) const -> bool
auto	cursor_style () const -> CursorStyle
auto	scroll_relative_offset (u32 display_row) const -> u32
auto	allowed_to_draw () const -> bool
void	scroll_to_bottom ()
void	scroll_up ()
void	scroll_down ()
auto	total_rows () const -> u32
auto	row_offset () const -> u32
auto	row_count () const -> u32
auto	col_count () const -> u32
auto	size () const -> dius::tty::WindowSize
void	set_visible_size (dius::tty::WindowSize const &window_size)
auto	visible_size () const -> dius::tty::WindowSize
void	scroll_down_if_needed ()
void	scroll_up_if_needed ()
auto	application_cursor_keys_mode () const -> ApplicationCursorKeysMode
auto	key_reporting_flags () const -> KeyReportingFlags
auto	alternate_scroll_mode () const -> AlternateScrollMode
auto	mouse_protocol () const -> MouseProtocol
auto	mouse_encoding () const -> MouseEncoding
auto	in_alternate_screen_buffer () const -> bool
auto	focus_event_mode () const -> FocusEventMode
void	reset_mouse_reporting ()
auto	bracked_paste_mode () const -> BracketedPasteMode
auto	rows () const -> di::Vector< Row > const &
auto	row_at_scroll_relative_offset (u32 offset) const -> Row const &
void	invalidate_all ()
auto	outgoing_events () -> di::Vector< TerminalEvent >
void	set_allow_force_terminal_size (bool b=true)

Member Typedef Documentation

Row

using ttx::Terminal::Row = di::Vector<Cell>

Constructor & Destructor Documentation

Terminal()

ttx::Terminal::Terminal ( dius::SyncFile & psuedo_terminal )

inlineexplicit

Member Function Documentation

allowed_to_draw()

auto ttx::Terminal::allowed_to_draw ( ) const -> bool

inline

alternate_scroll_mode()

auto ttx::Terminal::alternate_scroll_mode ( ) const -> AlternateScrollMode

inline

application_cursor_keys_mode()

auto ttx::Terminal::application_cursor_keys_mode ( ) const -> ApplicationCursorKeysMode

inline

bracked_paste_mode()

auto ttx::Terminal::bracked_paste_mode ( ) const -> BracketedPasteMode

inline

clone()

auto ttx::Terminal::clone ( ) const -> Terminal

inline

col_count()

auto ttx::Terminal::col_count ( ) const -> u32

inline

cursor_col()

auto ttx::Terminal::cursor_col ( ) const -> u32

inline

cursor_hidden()

auto ttx::Terminal::cursor_hidden ( ) const -> bool

inline

cursor_row()

auto ttx::Terminal::cursor_row ( ) const -> u32

inline

cursor_style()

auto ttx::Terminal::cursor_style ( ) const -> CursorStyle

inline

focus_event_mode()

auto ttx::Terminal::focus_event_mode ( ) const -> FocusEventMode

inline

in_alternate_screen_buffer()

auto ttx::Terminal::in_alternate_screen_buffer ( ) const -> bool

inline

invalidate_all()

void ttx::Terminal::invalidate_all

(

)

key_reporting_flags()

auto ttx::Terminal::key_reporting_flags ( ) const -> KeyReportingFlags

inline

mouse_encoding()

auto ttx::Terminal::mouse_encoding ( ) const -> MouseEncoding

inline

mouse_protocol()

auto ttx::Terminal::mouse_protocol ( ) const -> MouseProtocol

inline

on_parser_results()

void ttx::Terminal::on_parser_results

(

di::Span< ParserResult const >

results

)

outgoing_events()

auto ttx::Terminal::outgoing_events ( ) -> di::Vector<TerminalEvent>

inline

reset_mouse_reporting()

void ttx::Terminal::reset_mouse_reporting ( )

inline

row_at_scroll_relative_offset()

auto ttx::Terminal::row_at_scroll_relative_offset

(

u32

offset

)

const -> Row const&

row_count()

auto ttx::Terminal::row_count ( ) const -> u32

inline

row_offset()

auto ttx::Terminal::row_offset ( ) const -> u32

inline

rows()

auto ttx::Terminal::rows ( ) const -> di::Vector<Row> const&

inline

scroll_down()

void ttx::Terminal::scroll_down

(

)

scroll_down_if_needed()

void ttx::Terminal::scroll_down_if_needed

(

)

scroll_relative_offset()

auto ttx::Terminal::scroll_relative_offset

(

u32

display_row

)

const -> u32

scroll_to_bottom()

void ttx::Terminal::scroll_to_bottom

(

)

scroll_up()

void ttx::Terminal::scroll_up

(

)

scroll_up_if_needed()

void ttx::Terminal::scroll_up_if_needed

(

)

set_allow_force_terminal_size()

void ttx::Terminal::set_allow_force_terminal_size ( bool b = true )

inline

set_visible_size()

void ttx::Terminal::set_visible_size

(

dius::tty::WindowSize const &

window_size

)

should_display_cursor_at_position()

auto ttx::Terminal::should_display_cursor_at_position	(	u32	r,
		u32	c ) const -> bool

size()

auto ttx::Terminal::size ( ) const -> dius::tty::WindowSize

inline

state_as_escape_sequences()

auto ttx::Terminal::state_as_escape_sequences

(

)

const -> di::String

total_rows()

auto ttx::Terminal::total_rows ( ) const -> u32

inline

visible_size()

auto ttx::Terminal::visible_size ( ) const -> dius::tty::WindowSize

inline

---

The documentation for this class was generated from the following files:

• lib/include/ttx/terminal.h
• lib/src/terminal.cpp