FTXUI  5.0.0
C++ functional terminal UI.
Loading...
Searching...
No Matches
ScreenInteractive Class Reference
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(...).
void Loop (Component)
 Execute the main loop.
void Exit ()
 Exit the main loop.
Closure ExitLoopClosure ()
 Return a function to exit the main loop.
void Post (Task task)
 Add a task to the main loop. It will be executed later, after every other scheduled tasks.
void PostEvent (Event event)
 Add an event to the main loop. It will be executed later, after every other scheduled events.
void RequestAnimationFrame ()
 Add a task to draw the screen one more time, until all the animations are done.
CapturedMouse CaptureMouse ()
 Try to get the unique lock about behing able to capture the mouse.
Closure WithRestoredIO (Closure)
 Decorate a function. It executes the same way, but with the currently active screen terminal hooks temporarilly uninstalled during its execution.
std::string & at (int x, int y)
 Access a character in a cell at a given position.
const std::string & at (int x, int y) const
 Access a character in a cell at a given position.
Pixel & PixelAt (int x, int y)
 Access a cell (Pixel) at a given position.
const Pixel & PixelAt (int x, int y) const
 Access a cell (Pixel) at a given position.
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.
void Clear ()
 Clear all the pixel from the screen.
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 FitComponent ()
static ScreenInteractive TerminalOutput ()
static ScreenInteractive * Active ()
 Return the currently active screen, or null if none.
static Screen Create (Dimensions dimension)
 Create a screen with the given dimension.
static Screen Create (Dimensions width, Dimensions height)
 Create a screen with the given dimension along the x-axis and y-axis.

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 346 of file screen_interactive.cpp.

◆ Fullscreen()

ScreenInteractive Fullscreen ( )
static
Examples
examples/component/flexbox_gallery.cpp, examples/component/focus.cpp, examples/component/focus_cursor.cpp, examples/component/homescreen.cpp, examples/component/linear_gradient_gallery.cpp, examples/component/resizable_split.cpp, examples/component/textarea.cpp, examples/component/window.cpp, and examples/component/with_restored_io.cpp.

Definition at line 356 of file screen_interactive.cpp.

◆ FitComponent()

ScreenInteractive FitComponent ( )
static
Examples
examples/component/button.cpp, examples/component/button_animated.cpp, examples/component/button_in_frame.cpp, examples/component/button_style.cpp, examples/component/canvas_animated.cpp, examples/component/checkbox_in_frame.cpp, examples/component/collapsible.cpp, examples/component/composition.cpp, examples/component/custom_loop.cpp, examples/component/dropdown.cpp, examples/component/gallery.cpp, examples/component/menu_in_frame.cpp, examples/component/nested_screen.cpp, examples/component/radiobox_in_frame.cpp, and examples/component/renderer.cpp.

Definition at line 376 of file screen_interactive.cpp.

◆ TerminalOutput()

ScreenInteractive TerminalOutput ( )
static
Examples
examples/component/checkbox.cpp, examples/component/input.cpp, examples/component/input_style.cpp, examples/component/maybe.cpp, examples/component/menu.cpp, examples/component/menu2.cpp, examples/component/menu_entries.cpp, examples/component/menu_entries_animated.cpp, examples/component/menu_multiple.cpp, examples/component/menu_style.cpp, examples/component/menu_underline_animated_gallery.cpp, examples/component/modal_dialog.cpp, examples/component/modal_dialog_custom.cpp, examples/component/print_key_press.cpp, examples/component/radiobox.cpp, examples/component/slider.cpp, examples/component/slider_direction.cpp, examples/component/slider_rgb.cpp, examples/component/tab_horizontal.cpp, examples/component/tab_vertical.cpp, and examples/component/toggle.cpp.

Definition at line 366 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
enableWhether 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);
ftxui::ScreenInteractive::TerminalOutput
static ScreenInteractive TerminalOutput()
Definition screen_interactive.cpp:366

Definition at line 401 of file screen_interactive.cpp.

◆ Active()

ScreenInteractive * Active ( )
static

Return the currently active screen, or null if none.

Definition at line 529 of file screen_interactive.cpp.

◆ Loop()

void Loop ( Component component)

Execute the main loop.

Parameters
componentThe component to draw.

Definition at line 455 of file screen_interactive.cpp.

◆ Exit()

void Exit ( )

Exit the main loop.

Definition at line 836 of file screen_interactive.cpp.

◆ ExitLoopClosure()

Closure ExitLoopClosure ( )

Return a function to exit the main loop.

Definition at line 830 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 408 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 421 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 427 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 443 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
fnThe function to decorate.

Definition at line 519 of file screen_interactive.cpp.

◆ Create() [1/2]

Screen Create ( Dimensions dimension)
staticinherited

Create a screen with the given dimension.

Examples
examples/dom/border.cpp, examples/dom/border_colored.cpp, examples/dom/border_style.cpp, examples/dom/canvas.cpp, examples/dom/color_gallery.cpp, examples/dom/color_info_palette256.cpp, examples/dom/color_truecolor_HSV.cpp, examples/dom/color_truecolor_RGB.cpp, examples/dom/dbox.cpp, examples/dom/graph.cpp, examples/dom/gridbox.cpp, examples/dom/hflow.cpp, examples/dom/html_like.cpp, examples/dom/linear_gradient.cpp, examples/dom/package_manager.cpp, examples/dom/paragraph.cpp, examples/dom/separator.cpp, examples/dom/separator_style.cpp, examples/dom/size.cpp, examples/dom/spinner.cpp, examples/dom/style_blink.cpp, examples/dom/style_bold.cpp, examples/dom/style_color.cpp, examples/dom/style_dim.cpp, examples/dom/style_gallery.cpp, examples/dom/style_hyperlink.cpp, examples/dom/style_inverted.cpp, examples/dom/style_strikethrough.cpp, examples/dom/style_underlined.cpp, examples/dom/style_underlined_double.cpp, examples/dom/table.cpp, examples/dom/vbox_hbox.cpp, and examples/dom/vflow.cpp.

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
xThe cell position along the x-axis.
yThe 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
xThe cell position along the x-axis.
yThe 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
xThe cell position along the x-axis.
yThe 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
xThe cell position along the x-axis.
yThe 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);
}
ftxui::Screen::Create
static Screen Create(Dimensions dimension)
Create a screen with the given dimension.
Definition screen.cpp:391
ftxui::Dimension::Fit
Dimensions Fit(Element &)
Definition util.cpp:95
ftxui::Dimension::Full
Dimensions Full()
Definition screen.cpp:379
ftxui::Render
void Render(Screen &screen, const Element &element)
Display an element on a ftxui::Screen.
Definition node.cpp:47
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 122 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: