Detailed Description

Please check the tutorial of the ftxui/screen module.

Namespaces
namespace	ftxui::Dimension
	Define how the Screen's dimensions should look like.

Enumerations
enum	Color { Palette1 , Palette16 , Palette256 , TrueColor }
	Color is an enumeration that represents the color support of the terminal. More...

Functions
struct	FTXUI_EXPORT (SCREEN) Box
	Box is a structure that represents a rectangular area in a 2D space.

	FTXUI_EXPORT (SCREEN) Quirks
	Quirks is a structure that represents various terminal-specific behaviors that may require fallbacks.

Dimensions	Size ()
	Get the terminal size.

Color	ColorSupport ()
	Get the color support of the terminal.

Quirks	GetQuirks ()
	Get the terminal quirks.

void	SetQuirks (const Quirks &quirks)
	Override terminal quirks.

Enumeration Type Documentation

◆ Color

enum Color

Color is an enumeration that represents the color support of the terminal.

Enumerator
Palette1
Palette16
Palette256
TrueColor

Definition at line 29 of file terminal.hpp.

Function Documentation

◆ FTXUI_EXPORT() [1/2]

class FTXUI_EXPORT ( SCREEN )

Box is a structure that represents a rectangular area in a 2D space.

An adapter. Own or reference a constant string. For convenience, this class convert multiple mutable string toward a shared representation.

Dimensions is a structure that represents the size of the terminal.

A rectangular grid of Cell.

ColorInfo is a structure that contains information about the terminal color palette.

Color is a class that represents a color in the terminal user interface.

A Unicode character and its associated style.

It is defined by its minimum and maximum coordinates along the x and y axes. Note that the coordinates are inclusive, meaning that the box includes both the minimum and maximum values.

Note: This struct was previously named Pixel.; This class was previously named Image.

An adapter. Own or reference a constant string. For convenience, this class convert multiple immutable string toward a shared representation.

An adapter. Reference a list of strings.

Supported input:

std::vector<std::string>
std::vector<std::string>*
std::vector<std::wstring>*
Adapter*
std::unique_ptr<Adapter>

Definition at line 1 of file box.hpp.

◆ FTXUI_EXPORT() [2/2]

class FTXUI_EXPORT ( SCREEN )

Quirks is a structure that represents various terminal-specific behaviors that may require fallbacks.

TerminalInfo is a structure that contains information about the terminal.

Whether the terminal font supports the 8 Unicode block characters.

Whether the terminal correctly handles hiding the cursor.

Whether the terminal should use ASCII characters for components.

The level of color support of the terminal.

Whether the terminal font supports the 8 Unicode block characters.

Whether the terminal correctly handles hiding the cursor.

Whether the terminal should use ASCII characters for components.

The level of color support of the terminal.

Definition at line 36 of file terminal.hpp.

◆ Size()

Dimensions Size ( )

Get the terminal size.

Returns: The terminal size.

Definition at line 264 of file terminal.cpp.

◆ ColorSupport()

Color ColorSupport ( )

Get the color support of the terminal.

Definition at line 300 of file terminal.cpp.

◆ GetQuirks()

Quirks GetQuirks ( )

Get the terminal quirks.

Definition at line 317 of file terminal.cpp.

◆ SetQuirks()

void SetQuirks ( const Quirks & quirks )

Override terminal quirks.

Definition at line 327 of file terminal.cpp.