ftxui::Screen
Image
ScreenInteractive
screen.hpp
ftxui::Screen::Cursor
std::function< void(Pixel &)> using SelectionStyle = std::function<void(Pixel&)> SelectionStyle ftxui::Screen::SelectionStyle
Cursor Cursor cursor_ cursor_ ftxui::Screen::cursor_
std::vector< std::string > std::vector<std::string> hyperlinks_ hyperlinks_ ftxui::Screen::hyperlinks_ = {""}
SelectionStyle SelectionStyle selection_style_ selection_style_ ftxui::Screen::selection_style_ = [](Pixel& pixel) { pixel.inverted ^= true; }
int int dimx_ dimx_ ftxui::Image::dimx_
int int dimy_ dimy_ ftxui::Image::dimy_
std::vector< std::vector< Pixel > > std::vector<std::vector<Pixel> > pixels_ pixels_ ftxui::Image::pixels_
Screen
(int dimx, int dimy)
Screen
ftxui::Screen::Screen
int dimx
int dimy
std::string std::string ToString () const ToString ftxui::Screen::ToString

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

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

void void Print () const Print ftxui::Screen::Print
void void Clear () Clear ftxui::Screen::Clear

Clear all the pixel from the screen.

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

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

    std::stringreset_position;
    while(true){
    autodocument=render();
    autoscreen=Screen::Create(Dimension::Full(),Dimension::Fit(document));
    Render(screen,document);
    std::cout<<reset_position<<screen.ToString()<<std::flush;
    reset_position=screen.ResetPosition();

    usingnamespacestd::chrono_literals;
    std::this_thread::sleep_for(0.01s);
    }

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

void void ApplyShader () ApplyShader ftxui::Screen::ApplyShader
Cursor Cursor cursor () const cursor ftxui::Screen::cursor
void void SetCursor (Cursor cursor) SetCursor ftxui::Screen::SetCursor Cursor cursor
uint8_t std::uint8_t RegisterHyperlink (const std::string &link) RegisterHyperlink ftxui::Screen::RegisterHyperlink const std::string & link
const std::string & const std::string & Hyperlink (uint8_t id) const Hyperlink ftxui::Screen::Hyperlink uint8_t id
const SelectionStyle & const Screen::SelectionStyle & GetSelectionStyle () const GetSelectionStyle ftxui::Screen::GetSelectionStyle

Return the current selection style.

SetSelectionStyle

void void SetSelectionStyle (SelectionStyle decorator) SetSelectionStyle ftxui::Screen::SetSelectionStyle SelectionStyle decorator

Set the current selection style.

GetSelectionStyle

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

Access a character in a cell at a given position.

x

The cell position along the x-axis.

y

The cell position along the y-axis.

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

Access a character in a cell at a given position.

x

The cell position along the x-axis.

y

The cell position along the y-axis.

Pixel & Pixel & PixelAt (int x, int y) PixelAt ftxui::Image::PixelAt int x int y

Access a cell (Pixel) at a given position.

x

The cell position along the x-axis.

y

The cell position along the y-axis.

const Pixel & const Pixel & PixelAt (int x, int y) const PixelAt ftxui::Image::PixelAt int x int y

Access a cell (Pixel) at a given position.

x

The cell position along the x-axis.

y

The cell position along the y-axis.

int int dimx () const dimx ftxui::Image::dimx
int int dimy () const dimy ftxui::Image::dimy
Screen Screen Create (Dimensions dimension) Create ftxui::Screen::Create Dimensions dimension

Create a screen with the given dimension.

Screen Screen Create (Dimensions width, Dimensions height) Create ftxui::Screen::Create Dimensions width Dimensions height

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

Box Box stencil stencil ftxui::Image::stencil

A rectangular grid of Pixel.

Screen
Image
ScreenInteractive
Screen
cursor_
Box
Image
stencil
Cursor
- ftxui::Screen
  ApplyShader
- ftxui::Screen
  at
- ftxui::Screen
  at
- ftxui::Screen
  Clear
- ftxui::Screen
  Create
- ftxui::Screen
  Create
- ftxui::Screen
  cursor
- ftxui::Screen
  cursor_
- ftxui::Screen
  dimx
- ftxui::Screen
  dimx_
- ftxui::Screen
  dimy
- ftxui::Screen
  dimy_
- ftxui::Screen
  GetSelectionStyle
- ftxui::Screen
  Hyperlink
- ftxui::Screen
  hyperlinks_
- ftxui::Screen
  Image
- ftxui::Screen
  Image
- ftxui::Screen
  PixelAt
- ftxui::Screen
  PixelAt
- ftxui::Screen
  pixels_
- ftxui::Screen
  Print
- ftxui::Screen
  RegisterHyperlink
- ftxui::Screen
  ResetPosition
- ftxui::Screen
  Screen
- ftxui::Screen
  selection_style_
- ftxui::Screen
  SelectionStyle
- ftxui::Screen
  SetCursor
- ftxui::Screen
  SetSelectionStyle
- ftxui::Screen
  stencil
- ftxui::Screen
  ToString