ftxui Namespace Reference

Functions
template<class T , class... Args>
std::shared_ptr< T >	Make (Args &&... args)
Component	Button (ConstStringRef label, std::function< void()> on_click, Ref< ButtonOption > option)
	Draw a button. Execute a function when clicked.
Component	Checkbox (ConstStringRef label, bool *checked, Ref< CheckboxOption > option)
	Draw checkable element.
Component	Input (StringRef content, ConstStringRef placeholder, Ref< InputOption > option)
	An input box for editing text.
Component	Menu (ConstStringListRef entries, int *selected, Ref< MenuOption > option)
	A list of text. The focused element is selected.
Component	MenuEntry (ConstStringRef label, Ref< MenuEntryOption >={})
Component	Dropdown (ConstStringListRef entries, int *selected)
Component	Radiobox (ConstStringListRef entries, int *selected, Ref< RadioboxOption > option)
	A list of element, where only one can be selected.
Component	Toggle (ConstStringListRef entries, int *selected, Ref< ToggleOption > option)
	An horizontal list of elements. The user can navigate through them.
template<class T >
Component	Slider (ConstStringRef label, T *value, T min, T max, T increment)
	An horizontal slider.
Component	ResizableSplitLeft (Component main, Component back, int *main_size)
	An horizontal split in between two components, configurable using the mouse.
Component	ResizableSplitRight (Component main, Component back, int *main_size)
	An horizontal split in between two components, configurable using the mouse.
Component	ResizableSplitTop (Component main, Component back, int *main_size)
	An vertical split in between two components, configurable using the mouse.
Component	ResizableSplitBottom (Component main, Component back, int *main_size)
	An vertical split in between two components, configurable using the mouse.
Component	Renderer (Component child, std::function< Element()> render)
	Return a new Component, similar to |child|, but using |render| as the Component::Render() event.
Component	Renderer (std::function< Element()> render)
	Return a component, using |render| to render its interface.
Component	Renderer (std::function< Element(bool)> render)
	Return a focusable component, using |render| to render its interface.
Component	CatchEvent (Component child, std::function< bool(Event)>)
Component	Maybe (Component, bool *show)
Component	Input (WideStringRef content, ConstStringRef placeholder, Ref< InputOption > option)
	. An input box for editing text.
template<class T >
Receiver< T >	MakeReceiver ()
Element	text (std::wstring text)
	Display a piece of unicode text.
Element	vtext (std::wstring text)
	Display a piece unicode text vertically.
Elements	paragraph (std::wstring the_text)
	Return a vector of ftxui::text for every word of the string. This is useful combined with ftxui::hflow.
Element	operator| (Element element, Decorator decorator)
	From an element, apply a decorator.
Elements	operator| (Elements elements, Decorator decorator)
	From a set of element, apply a decorator to every elements.
Decorator	operator| (Decorator a, Decorator b)
	Compose two decorator into one.
Element	text (std::string text)
	Display a piece of UTF8 encoded unicode text.
Element	vtext (std::string text)
	Display a piece of unicode text vertically.
Element	separator ()
	Draw a vertical or horizontal separation in between two other elements.
Element	separatorLight ()
	Draw a vertical or horizontal separation in between two other elements, using the LIGHT style.
Element	separatorHeavy ()
	Draw a vertical or horizontal separation in between two other elements, using the HEAVY style.
Element	separatorDouble ()
	Draw a vertical or horizontal separation in between two other elements, using the DOUBLE style.
Element	separatorEmpty ()
	Draw a vertical or horizontal separation in between two other elements, using the EMPTY style.
Element	separatorStyled (BorderStyle style)
	Draw a vertical or horizontal separation in between two other elements.
Element	separator (Pixel pixel)
	Draw a separator in between two element filled with a given pixel.
Element	separatorCharacter (std::string value)
	Draw a vertical or horizontal separation in between two other elements.
Element	gauge (float progress)
	Draw a high definition progress bar.
Element	border (Element child)
	Draw a border around the element.
Element	borderLight (Element child)
	Draw a light border around the element.
Element	borderHeavy (Element child)
	Draw a heavy border around the element.
Element	borderDouble (Element child)
	Draw a double border around the element.
Element	borderRounded (Element child)
	Draw a rounded border around the element.
Element	borderEmpty (Element child)
	Draw an empty border around the element.
Decorator	borderStyled (BorderStyle style)
	Same as border but with different styles.
Decorator	borderWith (Pixel pixel)
	Same as border but with a constant Pixel around the element.
Element	window (Element title, Element content)
	Draw window with a title and a border around the element.
Element	spinner (int charset_index, size_t image_index)
	Useful to represent the effect of time and/or events. This display an ASCII art "video".
Elements	paragraph (std::string the_text)
	Return a vector of ftxui::text for every word of the string. This is useful combined with ftxui::hflow.
Element	graph (GraphFunction graph_function)
	Draw a graph using a GraphFunction.
Element	emptyElement ()
Element	bold (Element child)
	Use a bold font, for elements with more emphasis.
Element	dim (Element child)
	Use a light font, for elements with less emphasis.
Element	inverted (Element child)
	Add a filter that will invert the foreground and the background colors.
Element	underlined (Element child)
	Make the underlined element to be underlined.
Element	blink (Element child)
	The text drawn alternates in between visible and hidden.
Decorator	color (Color c)
	Decorate using a foreground color.
Decorator	bgcolor (Color color)
	Decorate using a background color.
Element	color (Color color, Element child)
	Set the foreground color of an element.
Element	bgcolor (Color color, Element child)
	Set the background color of an element.
Element	hbox (Elements children)
	A container displaying elements horizontally one by one.
Element	vbox (Elements children)
	A container displaying elements vertically one by one.
Element	dbox (Elements children_)
	Stack several element on top of each other.
Element	gridbox (std::vector< Elements > lines)
	A container displaying a grid of elements.
Element	hflow (Elements children)
	A container displaying elements horizontally one by one.
Element	flex (Element child)
	Make a child element to expand proportionnally to the space left in a container.
Element	flex_grow (Element child)
	Expand if possible.
Element	flex_shrink (Element child)
	Minimize if needed.
Element	xflex (Element child)
	Expand/Minimize if possible/needed on the X axis.
Element	xflex_grow (Element child)
	Expand if possible on the X axis.
Element	xflex_shrink (Element child)
	Minimize if needed on the X axis.
Element	yflex (Element child)
	Expand/Minimize if possible/needed on the Y axis.
Element	yflex_grow (Element child)
	Expand if possible on the Y axis.
Element	yflex_shrink (Element child)
	Minimize if needed on the Y axis.
Element	notflex (Element child)
	Make the element not flexible.
Element	filler ()
	An element that will take expand proportionnally to the space left in a container.
Decorator	size (Direction direction, Constraint constraint, int value)
	Apply a constraint on the size of an element.
Decorator	reflect (Box &box)
Element	frame (Element child)
	Allow an element to be displayed inside a 'virtual' area. It size can be larger than its container. In this case only a smaller portion is displayed. The view is scrollable to make the focused element visible.
Element	xframe (Element)
Element	yframe (Element)
Element	focus (Element)
Element	select (Element)
Element	vscroll_indicator (Element child)
	Add a filter that will invert the foreground and the background colors.
Element	hcenter (Element child)
	Center an element horizontally.
Element	vcenter (Element child)
	Center an element vertically.
Element	center (Element child)
	Center an element horizontally and vertically.
Element	align_right (Element child)
	Align an element on the right side.
Element	nothing (Element element)
	A decoration doing absolutely nothing.
Element	clear_under (Element child)
	Before drawing |child|, clear the pixels below. This is useful in.
void	Render (Screen &screen, const Element &element)
	Display an element on a ftxui::Screen.
void	Render (Screen &screen, Node *node)
	Display an element on a ftxui::Screen.
Color	operator""_rgb (unsigned long long int combined)
	Creates a color from a combined hex RGB representation, e.g. 0x808000_rgb.
ColorInfo	GetColorInfo (Color::Palette256 index)
ColorInfo	GetColorInfo (Color::Palette16 index)
int	wchar_width (wchar_t)
int	wstring_width (const std::wstring &)
std::string	to_string (const std::wstring &s)
	Convert a UTF8 std::string into a std::wstring.
std::wstring	to_wstring (const std::string &s)
	Convert a std::wstring into a UTF8 std::string.
template<typename T >
std::wstring	to_wstring (T s)
int	string_width (const std::string &)
std::vector< std::string >	Utf8ToGlyphs (const std::string &input)
Component	CatchEvent (Component child, std::function< bool(Event event)> on_event)
	Return a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise.
template Component	Slider (ConstStringRef label, int *value, int min, int max, int increment)
template Component	Slider (ConstStringRef label, float *value, float min, float max, float increment)
template Component	Slider (ConstStringRef label, long *value, long min, long max, long increment)

Enumerations
enum	BorderStyle {   LIGHT , HEAVY , DOUBLE , ROUNDED ,   EMPTY }
enum	Direction { WIDTH , HEIGHT }
enum	Constraint { LESS_THAN , EQUAL , GREATER_THAN }

Typedefs
using	CapturedMouse = std::unique_ptr<CapturedMouseInterface>
using	Component = std::shared_ptr<ComponentBase>
using	Components = std::vector<Component>
template<class T >
using	Sender = std::unique_ptr<SenderImpl<T>>
template<class T >
using	Receiver = std::unique_ptr<ReceiverImpl<T>>
using	Element = std::shared_ptr<Node>
using	Elements = std::vector<Element>
using	Decorator = std::function<Element(Element)>
using	GraphFunction = std::function<std::vector<int>(int, int)>

Data Structures
class	AutoReset
	Assign a value to a variable, reset its old value when going out of scope. More...
struct	Box
struct	ButtonOption
	Option for the Button component. More...
class	CapturedMouseInterface
struct	CheckboxOption
	Option for the Checkbox component. More...
class	Color
	A class representing terminal colors. More...
struct	ColorInfo
class	ComponentBase
	It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ftxui::Event. More...
class	ConstRef
	An adapter. Own or reference an immutable object. More...
class	ConstStringListRef
	An adapter. Reference a list of strings. More...
class	ConstStringRef
	An adapter. Own or reference a constant string. For convenience, this class convert multiple immutable string toward a shared representation. More...
struct	Dimensions
struct	Event
	Represent an event. It can be key press event, a terminal resize, or more ... More...
struct	InputOption
	Option for the Input component. More...
struct	MenuEntryOption
	Option for the MenuEntry component. More...
struct	MenuOption
	Option for the Menu component. More...
struct	Mouse
	A mouse event. It contains the coordinate of the mouse, the button pressed and the modifier (shift, ctrl, meta). More...
class	Node
class	NodeDecorator
struct	Pixel
	A unicode character and its associated style. More...
struct	RadioboxOption
	Option for the Radiobox component. More...
class	ReceiverImpl
class	Ref
	An adapter. Own or reference an mutable object. More...
struct	Requirement
class	Screen
	A rectangular grid of Pixel. More...
class	ScreenInteractive
class	SenderImpl
class	StringRef
	An adapter. Own or reference a constant string. For convenience, this class convert multiple mutable string toward a shared representation. More...
class	Table
class	TableSelection
class	TerminalInputParser
struct	ToggleOption
	Option for the Toggle component. More...
class	WideStringRef
	An adapter. Own or reference a constant string. For convenience, this class convert multiple mutable string toward a shared representation. More...

Namespaces
namespace	box_helper
namespace	Container
namespace	Dimension
	Define how the Screen's dimensions should look like.
namespace	literals
namespace	Terminal

Variables
const ColorInfo	palette256 []

---

Data Structure Documentation

ftxui::ButtonOption

struct ftxui::ButtonOption

ftxui::CheckboxOption

struct ftxui::CheckboxOption

ftxui::ColorInfo

struct ftxui::ColorInfo

ftxui::Dimensions

struct ftxui::Dimensions

ftxui::InputOption

struct ftxui::InputOption

ftxui::MenuEntryOption

struct ftxui::MenuEntryOption

ftxui::MenuOption

struct ftxui::MenuOption

ftxui::RadioboxOption

struct ftxui::RadioboxOption

ftxui::ToggleOption

struct ftxui::ToggleOption

Typedef Documentation

CapturedMouse

using CapturedMouse = std::unique_ptr<CapturedMouseInterface>

Definition at line 11 of file captured_mouse.hpp.

Component

typedef std::shared_ptr< ComponentBase > Component = std::shared_ptr<ComponentBase>

Definition at line 17 of file component_base.hpp.

Components

using Components = std::vector<Component>

Definition at line 18 of file component_base.hpp.

Sender

template<class T >

using Sender = std::unique_ptr<SenderImpl<T>>

Definition at line 44 of file receiver.hpp.

Receiver

template<class T >

using Receiver = std::unique_ptr<ReceiverImpl<T>>

Definition at line 45 of file receiver.hpp.

Element

typedef std::shared_ptr< Node > Element = std::shared_ptr<Node>

Definition at line 15 of file elements.hpp.

Elements

typedef std::vector< Element > Elements = std::vector<Element>

Definition at line 16 of file elements.hpp.

Decorator

using Decorator = std::function<Element(Element)>

Definition at line 17 of file elements.hpp.

GraphFunction

using GraphFunction = std::function<std::vector<int>(int, int)>

Definition at line 18 of file elements.hpp.

Enumeration Type Documentation

BorderStyle

enum BorderStyle

Enumerator
LIGHT
HEAVY
DOUBLE
ROUNDED
EMPTY

Definition at line 20 of file elements.hpp.

Direction

enum Direction

Enumerator
WIDTH
HEIGHT

Definition at line 94 of file elements.hpp.

Constraint

enum Constraint

Enumerator
LESS_THAN
EQUAL
GREATER_THAN

Definition at line 95 of file elements.hpp.

Function Documentation

Make()

template<class T , class... Args>

std::shared_ptr< T > Make

(

Args &&...

args

)

Definition at line 25 of file component.hpp.

Button()

Component Button	(	ConstStringRef	label,
		std::function< void()>	on_click,
		Ref< ButtonOption >	option )

Draw a button. Execute a function when clicked.

Parameters

label	The label of the button.
on_click	The action to execute when clicked.
option	Additional optional parameters.

See also

ButtonBase

Example

auto screen = ScreenInteractive::FitComponent();
std::string label = "Click to quit";
Component button = Button(&label, screen.ExitLoopClosure());
screen.Loop(button)

Output

┌─────────────┐
│Click to quit│
└─────────────┘

Definition at line 90 of file button.cpp.

Checkbox()

Component Checkbox	(	ConstStringRef	label,
		bool *	checked,
		Ref< CheckboxOption >	option )

Draw checkable element.

Parameters

label	The label of the checkbox.
checked	Whether the checkbox is checked or not.
option	Additional optional parameters.

See also

CheckboxBase

Example

auto screen = ScreenInteractive::FitComponent();
std::string label = "Make a sandwidth";
bool checked = false;
Component checkbox = Checkbox(&label, &checked);
screen.Loop(checkbox)

Output

☐ Make a sandwitch

Definition at line 117 of file checkbox.cpp.

Input() [1/2]

Component Input	(	StringRef	content,
		ConstStringRef	placeholder,
		Ref< InputOption >	option )

An input box for editing text.

Parameters

content	The editable content.
placeholder	The text displayed when content is still empty.
option	Additional optional parameters.

See also

InputBase

Example

auto screen = ScreenInteractive::FitComponent();
std::string content= "";
std::string placeholder = "placeholder";
Component input = Input(&content, &placeholder);
screen.Loop(input);

Output

placeholder

Definition at line 241 of file input.cpp.

Menu()

Component Menu	(	ConstStringListRef	entries,
		int *	selected,
		Ref< MenuOption >	option )

A list of text. The focused element is selected.

Parameters

entries	The list of entries in the menu.
selected	The index of the currently selected element.
option	Additional optional parameters.

See also

MenuBase

Example

auto screen = ScreenInteractive::TerminalOutput();
std::vector<std::string> entries = {
    "entry 1",
    "entry 2",
    "entry 3",
};
int selected = 0;
auto menu = Menu(&entries, &selected);
screen.Loop(menu);

Output

> entry 1
  entry 2
  entry 3

Definition at line 173 of file menu.cpp.

MenuEntry()

Component MenuEntry	(	ConstStringRef	label,
		Ref< MenuEntryOption >	option = {} )

Definition at line 179 of file menu.cpp.

Dropdown()

Component Dropdown	(	ConstStringListRef	entries,
		int *	selected )

Definition at line 13 of file dropdown.cpp.

Radiobox()

Component Radiobox	(	ConstStringListRef	entries,
		int *	selected,
		Ref< RadioboxOption >	option )

A list of element, where only one can be selected.

Parameters

entries	The list of entries in the list.
selected	The index of the currently selected element.
option	Additional optional parameters.

See also

RadioboxBase

Example

auto screen = ScreenInteractive::TerminalOutput();
std::vector<std::string> entries = {
    "entry 1",
    "entry 2",
    "entry 3",
};
int selected = 0;
auto menu = Radiobox(&entries, &selected);
screen.Loop(menu);

Output

◉ entry 1
○ entry 2
○ entry 3

Definition at line 190 of file radiobox.cpp.

Toggle()

Component Toggle	(	ConstStringListRef	entries,
		int *	selected,
		Ref< ToggleOption >	option )

An horizontal list of elements. The user can navigate through them.

Parameters

entries	The list of selectable entries to display.
selected	Reference the selected entry.
option	Additional optional parameters.

Definition at line 126 of file toggle.cpp.

Slider() [1/4]

template<class T >

Component Slider	(	ConstStringRef	label,
		T *	value,
		T	min,
		T	max,
		T	increment )

An horizontal slider.

Parameters

label	The name of the slider.
value	The current value of the slider.
min	The minimum value.
max	The maximum value.
increment	The increment when used by the cursor.

Example

auto screen = ScreenInteractive::TerminalOutput();
int value = 50;
auto slider = Slider("Value:", &value, 0, 100, 1);
screen.Loop(slider);

Output

Value:[██████████████████████████                          ]

Definition at line 123 of file slider.cpp.

ResizableSplitLeft()

Component ResizableSplitLeft	(	Component	main,
		Component	back,
		int *	main_size )

An horizontal split in between two components, configurable using the mouse.

Parameters

main	The main component of size |main_size|, on the left.
back	The back component taking the remaining size, on the right.
main_size	The size of the |main| component.

Example

auto screen = ScreenInteractive::Fullscreen();
int left_size = 10;
auto left = Renderer([] { return text("Left") | center;});
auto right = Renderer([] { return text("right") | center;});
auto split = ResizableSplitLeft(left, right, &left_size);
screen.Loop(split);

Output

       │
left   │   right
       │

Definition at line 266 of file resizable_split.cpp.

ResizableSplitRight()

Component ResizableSplitRight	(	Component	main,
		Component	back,
		int *	main_size )

An horizontal split in between two components, configurable using the mouse.

Parameters

main	The main component of size |main_size|, on the right.
back	The back component taking the remaining size, on the left.
main_size	The size of the |main| component.

Example

auto screen = ScreenInteractive::Fullscreen();
int right_size = 10;
auto left = Renderer([] { return text("Left") | center;});
auto right = Renderer([] { return text("right") | center;});
auto split = ResizableSplitRight(right, left, &right_size);
screen.Loop(split);

Output

       │
left   │   right
       │

Definition at line 296 of file resizable_split.cpp.

ResizableSplitTop()

Component ResizableSplitTop	(	Component	main,
		Component	back,
		int *	main_size )

An vertical split in between two components, configurable using the mouse.

Parameters

main	The main component of size |main_size|, on the top.
back	The back component taking the remaining size, on the bottom.
main_size	The size of the |main| component.

Example

auto screen = ScreenInteractive::Fullscreen();
int top_size = 1;
auto top = Renderer([] { return text("Top") | center;});
auto bottom = Renderer([] { return text("Bottom") | center;});
auto split = ResizableSplitTop(top, bottom, &top_size);
screen.Loop(split);

Output

   top
────────────
   bottom

Definition at line 326 of file resizable_split.cpp.

ResizableSplitBottom()

Component ResizableSplitBottom	(	Component	main,
		Component	back,
		int *	main_size )

An vertical split in between two components, configurable using the mouse.

Parameters

main	The main component of size |main_size|, on the bottom.
back	The back component taking the remaining size, on the top.
main_size	The size of the |main| component.

Example

auto screen = ScreenInteractive::Fullscreen();
int bottom_size = 1;
auto top = Renderer([] { return text("Top") | center;});
auto bottom = Renderer([] { return text("Bottom") | center;});
auto split = ResizableSplit::Bottom(bottom, top, &bottom_size);
screen.Loop(split);

Output

   top
────────────
   bottom

Definition at line 356 of file resizable_split.cpp.

Renderer() [1/3]

Component Renderer	(	Component	child,
		std::function< Element()>	render )

Return a new Component, similar to |child|, but using |render| as the Component::Render() event.

Parameters

child	The component to forward events to.
render	The function drawing the interface.

Example

auto screen = ScreenInteractive::TerminalOutput();
std::string label = "Click to quit";
auto button = Button(&label, screen.ExitLoopClosure());
auto renderer = Renderer(button, [&] {
  return hbox({
    text("A button:"),
    button->Render(),
  });
});
screen.Loop(renderer);

Definition at line 59 of file renderer.cpp.

Renderer() [2/3]

Component Renderer

(

std::function< Element()>

render

)

Return a component, using |render| to render its interface.

Parameters

render

The function drawing the interface.

Example

auto screen = ScreenInteractive::TerminalOutput();
auto renderer = Renderer([] {
  return text("My interface");
});
screen.Loop(renderer);

Definition at line 28 of file renderer.cpp.

Renderer() [3/3]

Component Renderer

(

std::function< Element(bool)>

render

)

Return a focusable component, using |render| to render its interface.

Parameters

render

The function drawing the interface, taking a boolean telling whether the component is focused or not.

Example

auto screen = ScreenInteractive::TerminalOutput();
auto renderer = Renderer([] (bool focused) {
  if (focused)
    return text("My interface") | inverted;
  else
    return text("My interface");
});
screen.Loop(renderer);

Definition at line 82 of file renderer.cpp.

CatchEvent() [1/2]

Component CatchEvent	(	Component	child,
		std::function< bool(Event)>	)

Maybe()

Component Maybe	(	Component	child,
		bool *	show )

Definition at line 12 of file maybe.cpp.

Input() [2/2]

Component Input	(	WideStringRef	content,
		ConstStringRef	placeholder,
		Ref< InputOption >	option )

. An input box for editing text.

Parameters

content	The editable content.
placeholder	The text displayed when content is still empty.
option	Additional optional parameters.

See also

InputBase

Example

auto screen = ScreenInteractive::FitComponent();
std::string content= "";
std::string placeholder = "placeholder";
Component input = Input(&content, &placeholder);
screen.Loop(input);

Output

placeholder

Definition at line 269 of file input.cpp.

MakeReceiver()

template<class T >

Receiver< T > MakeReceiver

(

)

Definition at line 117 of file receiver.hpp.

text() [1/2]

Element text

(

std::wstring

text

)

Display a piece of unicode text.

See also

ftxui::to_wstring

Example

Element document = text(L"Hello world!");

Output

Hello world!

Definition at line 106 of file text.cpp.

vtext() [1/2]

Element vtext

(

std::wstring

text

)

Display a piece unicode text vertically.

See also

ftxui::to_wstring

Example

Element document = vtext(L"Hello world!");

Output

H
e
l
l
o
 
w
o
r
l
d
!

Definition at line 166 of file text.cpp.

paragraph() [1/2]

Elements paragraph

(

std::wstring

the_text

)

Return a vector of ftxui::text for every word of the string. This is useful combined with ftxui::hflow.

Parameters

the_text

The string to be splitted.

See also

hflow.

Definition at line 14 of file paragraph.cpp.

operator|() [1/3]

Element operator|	(	Element	element,
		Decorator	decorator )

From an element, apply a decorator.

Returns

the decorated element.

Example

Both of these are equivalent:

bold(text("Hello"));

text("Hello") | bold;

Definition at line 64 of file util.cpp.

operator|() [2/3]

Elements operator|	(	Elements	elements,
		Decorator	decorator )

From a set of element, apply a decorator to every elements.

Returns

the set of decorated element.

Definition at line 44 of file util.cpp.

operator|() [3/3]

Decorator operator|	(	Decorator	a,
		Decorator	b )

Compose two decorator into one.

Example

auto decorator = bold | blink;

Definition at line 37 of file util.cpp.

text() [2/2]

Element text

(

std::string

text

)

Display a piece of UTF8 encoded unicode text.

See also

ftxui::to_wstring

Example

Element document = text("Hello world!");

Output

Hello world!

Definition at line 87 of file text.cpp.

vtext() [2/2]

Element vtext

(

std::string

text

)

Display a piece of unicode text vertically.

See also

ftxui::to_wstring

Example

Element document = vtext("Hello world!");

Output

H
e
l
l
o
 
w
o
r
l
d
!

Definition at line 136 of file text.cpp.

separator() [1/2]

Element separator

(

void

)

Draw a vertical or horizontal separation in between two other elements.

See also

separator

separatorLight

separatorDouble

separatorHeavy

separatorEmpty

separatorRounded

separatorStyled

separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separator(),
  text("down"),
});

Output

up
────
down

Definition at line 114 of file separator.cpp.

separatorLight()

Element separatorLight

(

)

Draw a vertical or horizontal separation in between two other elements, using the LIGHT style.

See also

separator

separatorLight

separatorDouble

separatorHeavy

separatorEmpty

separatorRounded

separatorStyled

separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separatorLight(),
  text("down"),
});

Output

up
────
down

Definition at line 187 of file separator.cpp.

separatorHeavy()

Element separatorHeavy

(

)

Draw a vertical or horizontal separation in between two other elements, using the HEAVY style.

See also

separator

separatorLight

separatorDouble

separatorHeavy

separatorEmpty

separatorRounded

separatorStyled

separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separatorHeavy(),
  text("down"),
});

Output

up
━━━━
down

Definition at line 223 of file separator.cpp.

separatorDouble()

Element separatorDouble

(

)

Draw a vertical or horizontal separation in between two other elements, using the DOUBLE style.

See also

separator

separatorLight

separatorDouble

separatorHeavy

separatorEmpty

separatorRounded

separatorStyled

separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separatorDouble(),
  text("down"),
});

Output

up
════
down

Definition at line 259 of file separator.cpp.

separatorEmpty()

Element separatorEmpty

(

)

Draw a vertical or horizontal separation in between two other elements, using the EMPTY style.

See also

separator

separatorLight

separatorDouble

separatorHeavy

separatorEmpty

separatorRounded

separatorStyled

separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separator(),
  text("down"),
});

Output

up
 
down

Definition at line 295 of file separator.cpp.

separatorStyled()

Element separatorStyled

(

BorderStyle

style

)

Draw a vertical or horizontal separation in between two other elements.

Parameters

style

the style of the separator.

See also

separator

separatorLight

separatorDouble

separatorHeavy

separatorEmpty

separatorRounded

separatorStyled

separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separatorStyled(DOUBLE),
  text("down"),
});

Output

up
════
down

Definition at line 151 of file separator.cpp.

separator() [2/2]

Element separator

(

Pixel

pixel

)

Draw a separator in between two element filled with a given pixel.

See also

separator

separatorLight

separatorHeavy

separatorDouble

separatorStyled

Example

Pixel empty;
Element document = vbox({
  text("Up"),
  separator(empty),
  text("Down"),
})

Output

Up
 
Down

Definition at line 362 of file separator.cpp.

separatorCharacter()

Element separatorCharacter

(

std::string

value

)

Draw a vertical or horizontal separation in between two other elements.

Parameters

value

the character to fill the separator area.

See also

separator

separatorLight

separatorDouble

separatorHeavy

separatorEmpty

separatorRounded

separatorStyled

separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separator(),
  text("down"),
});

Output

up
────
down

Definition at line 332 of file separator.cpp.

gauge()

Element gauge

(

float

progress

)

Draw a high definition progress bar.

Parameters

progress

The proportion of the area to be filled. Belong to [0,1].

Example

A gauge. It can be used to represent a progress bar.

border(gauge(0.5))

Output

┌──────────────────────────────────────────────────────────────────────────┐
│█████████████████████████████████████                                     │
└──────────────────────────────────────────────────────────────────────────┘

Definition at line 75 of file gauge.cpp.

border()

Element border

(

Element

child

)

Draw a border around the element.

See also

border

borderLight

borderDouble

borderHeavy

borderEmpty

borderRounded

Add a border around an element

Example

// Use 'border' as a function...
Element document = border(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | border;

Output

┌───────────┐
│The element│
└───────────┘

Definition at line 150 of file border.cpp.

borderLight()

Element borderLight

(

Element

child

)

Draw a light border around the element.

See also

border

borderLight

borderDouble

borderHeavy

borderRounded

borderEmpty

borderStyled

borderWith

Add a border around an element

Example

// Use 'borderLight' as a function...
Element document = borderLight(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | borderLight;

Output

┌──────────────┐
│The element   │
└──────────────┘

Definition at line 202 of file border.cpp.

borderHeavy()

Element borderHeavy

(

Element

child

)

Draw a heavy border around the element.

See also

border

borderLight

borderDouble

borderHeavy

borderRounded

borderEmpty

borderStyled

borderWith

Add a border around an element

Example

// Use 'borderHeavy' as a function...
Element document = borderHeavy(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | borderHeavy;

Output

┏━━━━━━━━━━━━━━┓
┃The element   ┃
┗━━━━━━━━━━━━━━┛

Definition at line 236 of file border.cpp.

borderDouble()

Element borderDouble

(

Element

child

)

Draw a double border around the element.

See also

border

borderLight

borderDouble

borderHeavy

borderRounded

borderEmpty

borderStyled

borderWith

Add a border around an element

Example

// Use 'borderDouble' as a function...
Element document = borderDouble(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | borderDouble;

Output

╔══════════════╗
║The element   ║
╚══════════════╝

Definition at line 270 of file border.cpp.

borderRounded()

Element borderRounded

(

Element

child

)

Draw a rounded border around the element.

See also

border

borderLight

borderDouble

borderHeavy

borderRounded

borderEmpty

borderStyled

borderWith

Add a border around an element

Example

// Use 'borderRounded' as a function...
Element document = borderRounded(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | borderRounded;

Output

╭──────────────╮
│The element   │
╰──────────────╯

Definition at line 304 of file border.cpp.

borderEmpty()

Element borderEmpty

(

Element

child

)

Draw an empty border around the element.

See also

border

borderLight

borderDouble

borderHeavy

borderRounded

borderEmpty

borderStyled

borderWith

Add a border around an element

Example

// Use 'borderRounded' as a function...
Element document = borderRounded(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | borderRounded;

Output

The element

Definition at line 338 of file border.cpp.

borderStyled()

Decorator borderStyled

(

BorderStyle

style

)

Same as border but with different styles.

See also

border

Definition at line 166 of file border.cpp.

borderWith()

Decorator borderWith

(

Pixel

pixel

)

Same as border but with a constant Pixel around the element.

See also

border

Definition at line 157 of file border.cpp.

window()

Element window	(	Element	title,
		Element	content )

Draw window with a title and a border around the element.

Parameters

title	The title of the window.
content	The element to be wrapped.

See also

border

Example

Element document = window(text("Title"),
                          text("content")
                   );

Output

┌Title──┐
│content│
└───────┘

Definition at line 363 of file border.cpp.

spinner()

Element spinner	(	int	charset_index,
		size_t	image_index )

Useful to represent the effect of time and/or events. This display an ASCII art "video".

Parameters

charset_index	The type of "video".
image_index	The "frame" of the video. You need to increase this for every "step".

Definition at line 255 of file spinner.cpp.

paragraph() [2/2]

Elements paragraph

(

std::string

the_text

)

Return a vector of ftxui::text for every word of the string. This is useful combined with ftxui::hflow.

Parameters

the_text

The string to be splitted.

See also

hflow.

Definition at line 28 of file paragraph.cpp.

graph()

Element graph

(

GraphFunction

graph_function

)

Draw a graph using a GraphFunction.

Parameters

graph_function

the function to be called to get the data.

Definition at line 59 of file graph.cpp.

emptyElement()

Element emptyElement

(

)

An element of size 0x0 drawing nothing.

Definition at line 80 of file util.cpp.

bold()

Element bold

(

Element

child

)

Use a bold font, for elements with more emphasis.

Definition at line 28 of file bold.cpp.

dim()

Element dim

(

Element

child

)

Use a light font, for elements with less emphasis.

Definition at line 28 of file dim.cpp.

inverted()

Element inverted

(

Element

child

)

Add a filter that will invert the foreground and the background colors.

Definition at line 29 of file inverted.cpp.

underlined()

Element underlined

(

Element

child

)

Make the underlined element to be underlined.

Definition at line 28 of file underlined.cpp.

blink()

Element blink

(

Element

child

)

The text drawn alternates in between visible and hidden.

Definition at line 28 of file blink.cpp.

color() [1/2]

Decorator color

(

Color

c

)

Decorate using a foreground color.

Parameters

c	The foreground color to be applied.

Returns

The Decorator applying the color.

Example

Element document = text("red") | color(Color::Red);

Definition at line 86 of file color.cpp.

bgcolor() [1/2]

Decorator bgcolor

(

Color

color

)

Decorate using a background color.

Parameters

color

The background color to be applied.

Returns

The Decorator applying the color.

Example

Element document = text("red") | bgcolor(Color::Red);

Definition at line 100 of file color.cpp.

color() [2/2]

Element color	(	Color	color,
		Element	child )

Set the foreground color of an element.

Parameters

color	The color of the output element.
child	The input element.

Returns

The output element colored.

Example

Element document = color(Color::Green, text("Success")),

Definition at line 57 of file color.cpp.

bgcolor() [2/2]

Element bgcolor	(	Color	color,
		Element	child )

Set the background color of an element.

Parameters

color	The color of the output element.
child	The input element.

Returns

The output element colored.

Example

Element document = bgcolor(Color::Green, text("Success")),

Definition at line 72 of file color.cpp.

hbox()

Element hbox

(

Elements

children

)

A container displaying elements horizontally one by one.

Parameters

children

The elements in the container

Returns

The container.

Example

hbox({
  text("Left"),
  text("Right"),
});

Definition at line 76 of file hbox.cpp.

vbox()

Element vbox

(

Elements

children

)

A container displaying elements vertically one by one.

Parameters

children

The elements in the container

Returns

The container.

Example

vbox({
  text("Up"),
  text("Down"),
});

Definition at line 77 of file vbox.cpp.

dbox()

Element dbox

(

Elements

children_

)

Stack several element on top of each other.

Parameters

children_

The input element.

Returns

The right aligned element.

Definition at line 50 of file dbox.cpp.

gridbox()

Element gridbox

(

std::vector< Elements >

lines

)

A container displaying a grid of elements.

Parameters

lines

A list of lines, each line being a list of elements.

Returns

The container.

Example

auto cell = [](const char* t) { return text(t) | border; };
auto document = gridbox({
  {cell("north-west") , cell("north")  , cell("north-east")} ,
  {cell("west")       , cell("center") , cell("east")}       ,
  {cell("south-west") , cell("south")  , cell("south-east")} ,
});

Output:

╭──────────╮╭──────╮╭──────────╮
│north-west││north ││north-east│
╰──────────╯╰──────╯╰──────────╯
╭──────────╮╭──────╮╭──────────╮
│west      ││center││east      │
╰──────────╯╰──────╯╰──────────╯
╭──────────╮╭──────╮╭──────────╮
│south-west││south ││south-east│
╰──────────╯╰──────╯╰──────────╯

Definition at line 154 of file gridbox.cpp.

hflow()

Element hflow

(

Elements

children

)

A container displaying elements horizontally one by one.

Parameters

children

The elements in the container

Returns

The container.

Example

hbox({
  text("Left"),
  text("Right"),
});

Definition at line 75 of file hflow.cpp.

flex()

Element flex

(

Element

child

)

Make a child element to expand proportionnally to the space left in a container.

Examples:

hbox({
  text("left") | border ,
  text("middle") | border | flex,
  text("right") | border,
});

Output:

┌────┐┌─────────────────────────────────────────────────────────┐┌─────┐
│left││middle                                                   ││right│
└────┘└─────────────────────────────────────────────────────────┘└─────┘

Definition at line 119 of file flex.cpp.

flex_grow()

Element flex_grow

(

Element

child

)

Expand if possible.

Definition at line 137 of file flex.cpp.

flex_shrink()

Element flex_shrink

(

Element

child

)

Minimize if needed.

Definition at line 155 of file flex.cpp.

xflex()

Element xflex

(

Element

child

)

Expand/Minimize if possible/needed on the X axis.

Definition at line 125 of file flex.cpp.

xflex_grow()

Element xflex_grow

(

Element

child

)

Expand if possible on the X axis.

Definition at line 143 of file flex.cpp.

xflex_shrink()

Element xflex_shrink

(

Element

child

)

Minimize if needed on the X axis.

Definition at line 161 of file flex.cpp.

yflex()

Element yflex

(

Element

child

)

Expand/Minimize if possible/needed on the Y axis.

Definition at line 131 of file flex.cpp.

yflex_grow()

Element yflex_grow

(

Element

child

)

Expand if possible on the Y axis.

Definition at line 149 of file flex.cpp.

yflex_shrink()

Element yflex_shrink

(

Element

child

)

Minimize if needed on the Y axis.

Definition at line 167 of file flex.cpp.

notflex()

Element notflex

(

Element

child

)

Make the element not flexible.

Definition at line 173 of file flex.cpp.

filler()

Element filler

(

)

An element that will take expand proportionnally to the space left in a container.

Definition at line 94 of file flex.cpp.

size()

Decorator size	(	Direction	direction,
		Constraint	constraint,
		int	value )

Apply a constraint on the size of an element.

Parameters

direction	Whether the WIDTH of the HEIGHT of the element must be constrained.
constraint	The type of constaint.
value	The value.

Definition at line 86 of file size.cpp.

reflect()

Decorator reflect

(

Box &

box

)

Definition at line 39 of file reflect.cpp.

frame()

Element frame

(

Element

child

)

Allow an element to be displayed inside a 'virtual' area. It size can be larger than its container. In this case only a smaller portion is displayed. The view is scrollable to make the focused element visible.

See also

focus

Definition at line 138 of file frame.cpp.

xframe()

Element xframe

(

Element

child

)

Definition at line 142 of file frame.cpp.

yframe()

Element yframe

(

Element

child

)

Definition at line 146 of file frame.cpp.

focus()

Element focus

(

Element

child

)

Definition at line 79 of file frame.cpp.

select()

Element select

(

Element

child

)

Definition at line 38 of file frame.cpp.

vscroll_indicator()

Element vscroll_indicator

(

Element

child

)

Add a filter that will invert the foreground and the background colors.

Definition at line 19 of file scroll_indicator.cpp.

hcenter()

Element hcenter

(

Element

child

)

Center an element horizontally.

Parameters

child

The decorated element.

Returns

The centered element.

Definition at line 12 of file composite_decorator.cpp.

vcenter()

Element vcenter

(

Element

child

)

Center an element vertically.

Parameters

child

The decorated element.

Returns

The centered element.

Definition at line 20 of file composite_decorator.cpp.

center()

Element center

(

Element

child

)

Center an element horizontally and vertically.

Parameters

child

The decorated element.

Returns

The centered element.

Definition at line 28 of file composite_decorator.cpp.

align_right()

Element align_right

(

Element

child

)

Align an element on the right side.

Parameters

child

The decorated element.

Returns

The right aligned element.

Definition at line 36 of file composite_decorator.cpp.

nothing()

Element nothing

(

Element

element

)

A decoration doing absolutely nothing.

Definition at line 25 of file util.cpp.

clear_under()

Element clear_under

(

Element

child

)

Before drawing |child|, clear the pixels below. This is useful in.

See also

ftxui::dbox

Definition at line 32 of file clear_under.cpp.

Render() [1/2]

void Render	(	Screen &	screen,
		const Element &	node )

Display an element on a ftxui::Screen.

Definition at line 34 of file node.cpp.

Render() [2/2]

void Render	(	Screen &	screen,
		Node *	node )

Display an element on a ftxui::Screen.

Definition at line 40 of file node.cpp.

GetColorInfo() [1/2]

ColorInfo GetColorInfo

(

Color::Palette256

index

)

Definition at line 266 of file color_info.cpp.

GetColorInfo() [2/2]

ColorInfo GetColorInfo

(

Color::Palette16

index

)

Definition at line 270 of file color_info.cpp.

wchar_width()

int wchar_width

(

wchar_t

ucs

)

Definition at line 210 of file string.cpp.

wstring_width()

int wstring_width

(

const std::wstring &

text

)

Definition at line 214 of file string.cpp.

to_string()

std::string to_string

(

const std::wstring &

s

)

Convert a UTF8 std::string into a std::wstring.

Definition at line 297 of file string.cpp.

to_wstring() [1/2]

std::wstring to_wstring

(

const std::string &

s

)

Convert a std::wstring into a UTF8 std::string.

Definition at line 303 of file string.cpp.

to_wstring() [2/2]

template<typename T >

std::wstring to_wstring

(

T

s

)

Definition at line 12 of file string.hpp.

string_width()

int string_width

(

const std::string &

input

)

Definition at line 226 of file string.cpp.

Utf8ToGlyphs()

std::vector< std::string > Utf8ToGlyphs

(

const std::string &

input

)

Definition at line 250 of file string.cpp.

CatchEvent() [2/2]

Component CatchEvent	(	Component	child,
		std::function< bool(Event event)>	on_event )

Return a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise.

Parameters

child	The wrapped component.
on_event	The function drawing the interface.

Example

auto screen = ScreenInteractive::TerminalOutput();
auto renderer = Renderer([] {
  return text("My interface");
});
screen.Loop(renderer);

Definition at line 44 of file catch_event.cpp.

Slider() [2/4]

template Component Slider	(	ConstStringRef	label,
		int *	value,
		int	min,
		int	max,
		int	increment )

Slider() [3/4]

template Component Slider	(	ConstStringRef	label,
		float *	value,
		float	min,
		float	max,
		float	increment )

Slider() [4/4]

template Component Slider	(	ConstStringRef	label,
		long *	value,
		long	min,
		long	max,
		long	increment )

Variable Documentation

palette256

const ColorInfo palette256[]

Definition at line 7 of file color_info.cpp.