Inheritance diagram for ScreenInteractive:

Data Structures
class	Private

Public Member Functions
void	TrackMouse (bool enable=true)
	Set whether mouse is tracked and events reported. called outside of the main loop. E.g `ScreenInteractive::Loop(...)`. More...

void	Loop (Component)
	Execute the main loop. More...

void	Exit ()
	Exit the main loop. More...

Closure	ExitLoopClosure ()
	Return a function to exit the main loop. More...

void	Post (Task task)
	Add a task to the main loop. It will be executed later, after every other scheduled tasks. More...

void	PostEvent (Event event)
	Add an event to the main loop. It will be executed later, after every other scheduled events. More...

void	RequestAnimationFrame ()
	Add a task to draw the screen one more time, until all the animations are done. More...

CapturedMouse	CaptureMouse ()
	Try to get the unique lock about behing able to capture the mouse. More...

Closure	WithRestoredIO (Closure)
	Decorate a function. It executes the same way, but with the currently active screen terminal hooks temporarilly uninstalled during its execution. More...

std::string &	at (int x, int y)
	Access a character in a cell at a given position. More...

const std::string &	at (int x, int y) const
	Access a character in a cell at a given position. More...

Pixel &	PixelAt (int x, int y)
	Access a cell (Pixel) at a given position. More...

const Pixel &	PixelAt (int x, int y) const
	Access a cell (Pixel) at a given position. More...

std::string	ToString () const

void	Print () const

int	dimx () const

int	dimy () const

std::string	ResetPosition (bool clear=false) const
	Return a string to be printed in order to reset the cursor position to the beginning of the screen. More...

void	Clear ()
	Clear all the pixel from the screen. More...

void	ApplyShader ()

Cursor	cursor () const

void	SetCursor (Cursor cursor)

uint8_t	RegisterHyperlink (const std::string &link)

const std::string &	Hyperlink (uint8_t id) const

Static Public Member Functions
static ScreenInteractive	FixedSize (int dimx, int dimy)

static ScreenInteractive	Fullscreen ()

static ScreenInteractive	FullscreenPrimaryScreen ()

static ScreenInteractive	FullscreenAlternateScreen ()

static ScreenInteractive	FitComponent ()

static ScreenInteractive	TerminalOutput ()

static ScreenInteractive *	Active ()
	Return the currently active screen, or null if none. More...

static Screen	Create (Dimensions dimension)
	Create a screen with the given dimension. More...

static Screen	Create (Dimensions width, Dimensions height)
	Create a screen with the given dimension along the x-axis and y-axis. More...

Data Fields
friend	Private

Box	stencil

Protected Attributes
int	dimx_

int	dimy_

std::vector< std::vector< Pixel > >	pixels_

Cursor	cursor_

std::vector< std::string >	hyperlinks_ = {""}

Detailed Description

Definition at line 29 of file screen_interactive.hpp.

Member Function Documentation

◆ FixedSize()

ScreenInteractive FixedSize	(	int	dimx,
		int	dimy
	)

static

Definition at line 356 of file screen_interactive.cpp.

◆ Fullscreen()

ScreenInteractive Fullscreen ( )

static

Create a ScreenInteractive taking the full terminal size. This is using the alternate screen buffer to avoid messing with the terminal content.

Note: This is the same as ScreenInteractive::FullscreenAlternateScreen()

Definition at line 370 of file screen_interactive.cpp.

◆ FullscreenPrimaryScreen()

ScreenInteractive FullscreenPrimaryScreen ( )

static

Create a ScreenInteractive taking the full terminal size. The primary screen buffer is being used. It means if the terminal is resized, the previous content might mess up with the terminal content.

Definition at line 379 of file screen_interactive.cpp.

◆ FullscreenAlternateScreen()

ScreenInteractive FullscreenAlternateScreen ( )

static

Create a ScreenInteractive taking the full terminal size. This is using the alternate screen buffer to avoid messing with the terminal content.

Definition at line 392 of file screen_interactive.cpp.

◆ FitComponent()

ScreenInteractive FitComponent ( )

static

Definition at line 412 of file screen_interactive.cpp.

◆ TerminalOutput()

ScreenInteractive TerminalOutput ( )

static

Definition at line 402 of file screen_interactive.cpp.

◆ TrackMouse()

void TrackMouse ( bool enable = true )

Set whether mouse is tracked and events reported. called outside of the main loop. E.g ScreenInteractive::Loop(...).

Parameters

enable Whether to enable mouse event tracking.

Note: This muse be called outside of the main loop. E.g. before calling ScreenInteractive::Loop.; Mouse tracking is enabled by default.; Mouse tracking is only supported on terminals that supports it.

Example

auto screen = ScreenInteractive::TerminalOutput();
screen.TrackMouse(false);
screen.Loop(component);

Definition at line 437 of file screen_interactive.cpp.

◆ Active()

ScreenInteractive * Active ( )

static

Return the currently active screen, or null if none.

Definition at line 565 of file screen_interactive.cpp.

◆ Loop()

void Loop ( Component component )

Execute the main loop.

Parameters

component The component to draw.

Definition at line 491 of file screen_interactive.cpp.

◆ Exit()

void Exit ( )

Exit the main loop.

Definition at line 887 of file screen_interactive.cpp.

◆ ExitLoopClosure()

Closure ExitLoopClosure ( )

Return a function to exit the main loop.

Definition at line 881 of file screen_interactive.cpp.

◆ Post()

void Post ( Task task )

Add a task to the main loop. It will be executed later, after every other scheduled tasks.

Definition at line 444 of file screen_interactive.cpp.

◆ PostEvent()

void PostEvent ( Event event )

Add an event to the main loop. It will be executed later, after every other scheduled events.

Definition at line 457 of file screen_interactive.cpp.

◆ RequestAnimationFrame()

void RequestAnimationFrame ( )

Add a task to draw the screen one more time, until all the animations are done.

Definition at line 463 of file screen_interactive.cpp.

◆ CaptureMouse()

CapturedMouse CaptureMouse ( )

Try to get the unique lock about behing able to capture the mouse.

Returns: A unique lock if the mouse is not already captured, otherwise a null.

Definition at line 479 of file screen_interactive.cpp.

◆ WithRestoredIO()

Closure WithRestoredIO ( Closure fn )

Decorate a function. It executes the same way, but with the currently active screen terminal hooks temporarilly uninstalled during its execution.

Parameters

fn	The function to decorate.

Definition at line 555 of file screen_interactive.cpp.

◆ Create() [1/2]

Screen Create ( Dimensions dimension )

staticinherited

Create a screen with the given dimension.

Definition at line 391 of file screen.cpp.

◆ Create() [2/2]

Screen Create	(	Dimensions	width,
		Dimensions	height
	)

staticinherited

Create a screen with the given dimension along the x-axis and y-axis.

Definition at line 385 of file screen.cpp.

◆ at() [1/2]

std::string & at	(	int	x,
		int	y
	)

inherited

Access a character in a cell at a given position.

Parameters

x	The cell position along the x-axis.
y	The cell position along the y-axis.

Definition at line 456 of file screen.cpp.

◆ at() [2/2]

const std::string & at	(	int	x,
		int	y
	)		const

inherited

Access a character in a cell at a given position.

Parameters

x	The cell position along the x-axis.
y	The cell position along the y-axis.

Definition at line 463 of file screen.cpp.

◆ PixelAt() [1/2]

Pixel & PixelAt	(	int	x,
		int	y
	)

inherited

Access a cell (Pixel) at a given position.

Parameters

x	The cell position along the x-axis.
y	The cell position along the y-axis.

Definition at line 470 of file screen.cpp.

◆ PixelAt() [2/2]

const Pixel & PixelAt	(	int	x,
		int	y
	)		const

inherited

Access a cell (Pixel) at a given position.

Parameters

x	The cell position along the x-axis.
y	The cell position along the y-axis.

Definition at line 477 of file screen.cpp.

◆ ToString()

std::string ToString ( ) const

inherited

Produce a std::string that can be used to print the Screen on the terminal.

Note: Don't forget to flush stdout. Alternatively, you can use Screen::Print();

Definition at line 416 of file screen.cpp.

◆ Print()

void Print ( ) const

inherited

Definition at line 449 of file screen.cpp.

◆ dimx()

int dimx ( ) const

inlineinherited

Definition at line 84 of file screen.hpp.

◆ dimy()

int dimy ( ) const

inlineinherited

Definition at line 85 of file screen.hpp.

◆ ResetPosition()

std::string ResetPosition ( bool clear = false ) const

inherited

Return a string to be printed in order to reset the cursor position to the beginning of the screen.

std::string reset_position;
while(true) {
  auto document = render();
  auto screen = Screen::Create(Dimension::Full(), Dimension::Fit(document));
  Render(screen, document);
  std::cout << reset_position << screen.ToString() << std::flush;
  reset_position = screen.ResetPosition();
 
  using namespace std::chrono_literals;
  std::this_thread::sleep_for(0.01s);
}

Returns: The string to print in order to reset the cursor position to the beginning.

Definition at line 500 of file screen.cpp.

◆ Clear()

void Clear ( )

inherited

Clear all the pixel from the screen.

Definition at line 519 of file screen.cpp.

◆ ApplyShader()

void ApplyShader ( )

inherited

Definition at line 534 of file screen.cpp.

◆ cursor()

Cursor cursor ( ) const

inlineinherited

Definition at line 110 of file screen.hpp.

◆ SetCursor()

void SetCursor ( Cursor cursor )

inlineinherited

Definition at line 111 of file screen.hpp.

◆ RegisterHyperlink()

uint8_t RegisterHyperlink ( const std::string & link )

inherited

Definition at line 561 of file screen.cpp.

◆ Hyperlink()

const std::string & Hyperlink ( uint8_t id ) const

inherited

Definition at line 574 of file screen.cpp.

Field Documentation

◆ Private

friend Private

Definition at line 128 of file screen_interactive.hpp.

◆ stencil

Box stencil

inherited

Definition at line 118 of file screen.hpp.

◆ dimx_

int dimx_

protectedinherited

Definition at line 121 of file screen.hpp.

◆ dimy_

int dimy_

protectedinherited

Definition at line 122 of file screen.hpp.

◆ pixels_

std::vector<std::vector<Pixel> > pixels_

protectedinherited

Definition at line 123 of file screen.hpp.

◆ cursor_

Cursor cursor_

protectedinherited

Definition at line 124 of file screen.hpp.

◆ hyperlinks_

std::vector<std::string> hyperlinks_ = {""}

protectedinherited

Definition at line 125 of file screen.hpp.

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

include/ftxui/component/screen_interactive.hpp
src/ftxui/component/screen_interactive.cpp

Data Structures

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Member Function Documentation

◆ FixedSize()

◆ Fullscreen()

◆ FullscreenPrimaryScreen()

◆ FullscreenAlternateScreen()

◆ FitComponent()

◆ TerminalOutput()

◆ TrackMouse()

Example

◆ Active()

◆ Loop()

◆ Exit()

◆ ExitLoopClosure()

◆ Post()

◆ PostEvent()

◆ RequestAnimationFrame()

◆ CaptureMouse()

◆ WithRestoredIO()

◆ Create() [1/2]

◆ Create() [2/2]

◆ at() [1/2]

◆ at() [2/2]

◆ PixelAt() [1/2]

◆ PixelAt() [2/2]

◆ ToString()

◆ Print()

◆ dimx()

◆ dimy()

◆ ResetPosition()

◆ Clear()

◆ ApplyShader()

◆ cursor()

◆ SetCursor()

◆ RegisterHyperlink()

◆ Hyperlink()

Field Documentation

◆ Private

◆ stencil

◆ dimx_

◆ dimy_

◆ pixels_

◆ cursor_

◆ hyperlinks_