ttx::Terminal Class Reference

#include <ttx/terminal.h>

Public Member Functions
	Terminal (u64 id, Size const &size)
auto	state_as_escape_sequences () const -> di::String
void	on_parser_results (di::Span< ParserResult > results)
auto	active_screen () const -> ScreenState const &
auto	active_screen () -> ScreenState &
auto	cursor_row () const -> u32
auto	cursor_col () const -> u32
auto	cursor_hidden () const -> bool
auto	cursor_style () const -> CursorStyle
auto	reverse_video () const -> bool
auto	allowed_to_draw () const -> bool
auto	total_rows () const -> u32
auto	visual_scroll_offset () const -> u64
auto	row_count () const -> u32
auto	col_count () const -> u32
auto	size () const -> Size
void	set_visible_size (Size const &size)
auto	visible_size () const -> Size
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
auto	shift_escape_options () const -> ShiftEscapeOptions
void	reset_mouse_reporting ()
auto	bracked_paste_mode () const -> BracketedPasteMode
void	soft_reset ()
void	invalidate_all ()
auto	outgoing_events () -> di::Vector< TerminalEvent >
void	set_allow_force_terminal_size (bool b=true)
void	hide_cursor ()
auto	seamless_navigation_protocol_active () const -> bool
auto	seamless_navigate_protocol_hide_cursor_on_enter () const -> bool

Friends
template<auto>
auto	make_mode_handler () ->ModeHandler

Constructor & Destructor Documentation

Terminal()

ttx::Terminal::Terminal ( u64 id, Size const & size )

explicit

Member Function Documentation

active_screen() [1/2]

auto ttx::Terminal::active_screen ( ) ->ScreenState &

inline

active_screen() [2/2]

auto ttx::Terminal::active_screen

(

)

const->ScreenStateconst &

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

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

hide_cursor()

void ttx::Terminal::hide_cursor ( )

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 >

results

)

outgoing_events()

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

inline

reset_mouse_reporting()

void ttx::Terminal::reset_mouse_reporting ( )

inline

reverse_video()

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

inline

row_count()

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

inline

seamless_navigate_protocol_hide_cursor_on_enter()

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

inline

seamless_navigation_protocol_active()

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

inline

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

(

Size const &

size

)

shift_escape_options()

auto ttx::Terminal::shift_escape_options ( ) const->ShiftEscapeOptions

inline

size()

auto ttx::Terminal::size ( ) const->Size

inline

soft_reset()

void ttx::Terminal::soft_reset

(

)

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->Size

inline

visual_scroll_offset()

auto ttx::Terminal::visual_scroll_offset ( ) const->u64

inline

Friends And Related Symbol Documentation

make_mode_handler

template<auto>

auto make_mode_handler ( ) ->ModeHandler

friend

---

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

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