ftxui Namespace Reference

Functions
template<class T , class... Args>
std::shared_ptr< T >	Make (Args &&... args)
Component	operator| (Component component, ComponentDecorator decorator)
Component	operator| (Component component, ElementDecorator decorator)
Component &	operator|= (Component &component, ComponentDecorator decorator)
Component &	operator|= (Component &component, ElementDecorator decorator)
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 > option)
	A specific menu entry. They can be put into a Container::Vertical to form a menu.
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)
	An horizontal list of elements. The user can navigate through them.
template<typename T >
Component	Slider (SliderOption< T > options)
	A slider in any direction.
Component	Slider (ConstStringRef label, Ref< int > value, ConstRef< int > min, ConstRef< int > max, ConstRef< int > increment)
	An horizontal slider.
Component	Slider (ConstStringRef label, Ref< float > value, ConstRef< float > min=0.f, ConstRef< float > max=100.f, ConstRef< float > increment=5.f)
Component	Slider (ConstStringRef label, Ref< long > value, ConstRef< long > min=0l, ConstRef< long > max=100l, ConstRef< long > increment=5l)
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	ResizableSplit (ResizableSplitOption options)
	A split in between two components.
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.
ComponentDecorator	Renderer (ElementDecorator decorator)
	Decorate a component, by decorating what it renders.
Component	CatchEvent (Component child, std::function< bool(Event)>)
ComponentDecorator	CatchEvent (std::function< bool(Event)> on_event)
	Decorate a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise.
Component	Maybe (Component child, const bool *show)
	Decorate a component |child|. It is shown only when |show| is true. @params child the compoennt to decorate. @params show a boolean. |child| is shown when |show| is true.
Component	Maybe (Component, std::function< bool()>)
ComponentDecorator	Maybe (const bool *show)
	Decorate a component. It is shown only when |show| is true. @params show a boolean. |child| is shown when |show| is true.
ComponentDecorator	Maybe (std::function< bool()> show)
	Decorate a component. It is shown only when the |show| function returns true. @params show a function returning whether the decoratorated component should be shown.
Component	Modal (Component main, Component modal, const bool *show_modal)
ComponentDecorator	Modal (Component modal, const bool *show_modal)
Component	Collapsible (ConstStringRef label, Component child, Ref< bool > show=false)
Component	Hoverable (Component component, bool *hover)
	Wrap a component. Gives the ability to know if it is hovered by the mouse.
Component	Hoverable (Component component, std::function< void()> on_enter, std::function< void()> on_leave)
	Wrap a component. Gives the ability to know if it is hovered by the mouse.
Component	Hoverable (Component component, std::function< void(bool)> on_change)
	Wrap a component. Gives the ability to know if it is hovered by the mouse.
ComponentDecorator	Hoverable (bool *hover)
	Wrap a component. Gives the ability to know if it is hovered by the mouse.
ComponentDecorator	Hoverable (std::function< void()> on_enter, std::function< void()> on_leave)
ComponentDecorator	Hoverable (std::function< void(bool)> on_change)
	Wrap a component. Gives the ability to know if it is hovered by the mouse.
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 text)
Element	operator| (Element element, Decorator decorator)
	From an element, apply a decorator.
Element &	operator|= (Element &e, Decorator d)
	Apply a decorator to an element.
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	separatorDashed ()
	Draw a vertical or horizontal separation in between two other elements, using the DASHED 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	separatorHSelector (float left, float right, Color unselected_color, Color selected_color)
	Draw an horizontal bar, with the area in between left/right colored differently.
Element	separatorVSelector (float up, float down, Color unselected_color, Color selected_color)
	Draw an vertical bar, with the area in between up/downcolored differently.
Element	gauge (float progress)
	Draw a high definition progress bar.
Element	gaugeLeft (float progress)
	Draw a high definition progress bar progressing from right to left.
Element	gaugeRight (float progress)
	Draw a high definition progress bar progressing from left to right.
Element	gaugeUp (float progress)
	Draw a high definition progress bar progressing from bottom to top.
Element	gaugeDown (float progress)
	Draw a high definition progress bar progressing from top to bottom.
Element	gaugeDirection (float progress, Direction direction)
	Draw a high definition progress bar progressing in specified direction.
Element	border (Element child)
	Draw a border around the element.
Element	borderLight (Element child)
	Draw a dashed border around the element.
Element	borderDashed (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	borderStyled (BorderStyle style, Color foreground_color)
	Same as border but with a foreground color and a different style.
Decorator	borderStyled (Color foreground_color)
	Same as border but with a foreground color.
Decorator	borderWith (const 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".
Element	paragraph (const std::string &the_text)
	Return an element drawing the paragraph on multiple lines.
Element	paragraphAlignLeft (const std::string &the_text)
	Return an element drawing the paragraph on multiple lines, aligned on the left.
Element	paragraphAlignRight (const std::string &the_text)
	Return an element drawing the paragraph on multiple lines, aligned on the right.
Element	paragraphAlignCenter (const std::string &the_text)
	Return an element drawing the paragraph on multiple lines, aligned on the center.
Element	paragraphAlignJustify (const std::string &the_text)
	Return an element drawing the paragraph on multiple lines, aligned using a justified alignment. the center.
Element	graph (GraphFunction graph_function)
	Draw a graph using a GraphFunction.
Element	emptyElement ()
Element	canvas (ConstRef< Canvas > canvas)
	Produce an element from a Canvas, or a reference to a Canvas.
Element	canvas (int width, int height, std::function< void(Canvas &)> fn)
	Produce an element drawing a canvas of requested size.
Element	canvas (std::function< void(Canvas &)> fn)
	Produce an element drawing a canvas.
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	underlinedDouble (Element child)
	Apply a underlinedDouble to text.
Element	blink (Element child)
	The text drawn alternates in between visible and hidden.
Element	strikethrough (Element child)
	Apply a strikethrough to text.
Decorator	color (Color c)
	Decorate using a foreground color.
Decorator	bgcolor (Color color)
	Decorate using a background color.
Decorator	color (const LinearGradient &gradient)
	Decorate using a linear-gradient effect on the foreground color.
Decorator	bgcolor (const LinearGradient &gradient)
	Decorate using a linear-gradient effect on the 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	color (const LinearGradient &gradient, Element child)
	Set the foreground color of an element with linear-gradient effect.
Element	bgcolor (const LinearGradient &gradient, Element child)
	Set the background color of an element with linear-gradient effect.
Decorator	focusPosition (int x, int y)
	Used inside a frame, this force the view to be scrolled toward a a given position. The position is expressed in the numbers of cells.
Decorator	focusPositionRelative (float x, float y)
	Used inside a frame, this force the view to be scrolled toward a a given position. The position is expressed in proportion of the requested size.
Element	automerge (Element child)
	Enable character to be automatically merged with others nearby.
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	flexbox (Elements, FlexboxConfig config=FlexboxConfig())
Element	gridbox (std::vector< Elements > lines)
	A container displaying a grid of elements.
Element	hflow (Elements)
Element	vflow (Elements)
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 (WidthOrHeight direction, Constraint constraint, int value)
	Apply a constraint on the size of an element.
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	focusCursorBlock (Element)
Element	focusCursorBlockBlinking (Element)
Element	focusCursorBar (Element)
Element	focusCursorBarBlinking (Element)
Element	focusCursorUnderline (Element)
Element	focusCursorUnderlineBlinking (Element)
Element	vscroll_indicator (Element child)
	Add a filter that will invert the foreground and the background colors.
Decorator	reflect (Box &box)
Element	clear_under (Element element)
	Before drawing |child|, clear the pixels below. This is useful in.
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.
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)
int	GlyphPosition (const std::string &input, size_t glyph_index, size_t start=0)
int	GlyphCount (const std::string &input)
std::vector< WordBreakProperty >	Utf8ToWordBreakProperty (const std::string &input)
bool	IsWordBreakingCharacter (const std::string &input, size_t glyph_index)
std::vector< int >	CellToGlyphIndex (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 (SliderOption< int8_t >)
template Component	Slider (SliderOption< int16_t >)
template Component	Slider (SliderOption< int32_t >)
template Component	Slider (SliderOption< int64_t >)
template Component	Slider (SliderOption< uint8_t >)
template Component	Slider (SliderOption< uint16_t >)
template Component	Slider (SliderOption< uint32_t >)
template Component	Slider (SliderOption< uint64_t >)
template Component	Slider (SliderOption< float >)
template Component	Slider (SliderOption< double >)

Enumerations
enum class	Direction { Up = 0 , Down = 1 , Left = 2 , Right = 3 }
enum	BorderStyle {   LIGHT , DASHED , HEAVY , DOUBLE ,   ROUNDED , EMPTY }
enum	WidthOrHeight { WIDTH , HEIGHT }
enum	Constraint { LESS_THAN , EQUAL , GREATER_THAN }
enum class	WordBreakProperty {   ALetter , CR , Double_Quote , Extend ,   ExtendNumLet , Format , Hebrew_Letter , Katakana ,   LF , MidLetter , MidNum , MidNumLet ,   Newline , Numeric , Regional_Indicator , Single_Quote ,   WSegSpace , ZWJ }

Typedefs
using	CapturedMouse = std::unique_ptr<CapturedMouseInterface>
using	ComponentDecorator = std::function<Component(Component)>
using	ElementDecorator = std::function<Element(Element)>
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	Closure = std::function<void()>
using	Task = std::variant<Event, Closure, AnimationTask>
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)>
using	Charset = std::array<std::string, 6>
using	Charsets = std::array<Charset, 6>

Data Structures
struct	AnimatedColorOption
	Option about a potentially animated color. More...
struct	AnimatedColorsOption
class	AnimationTask
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 AnimatedButton component. More...
struct	Canvas
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	EntryState
	arguments for |ButtonOption::transform|, |CheckboxOption::transform|, |Radiobox::transform|, |MenuEntryOption::transform|, |MenuOption::transform|. More...
struct	Event
	Represent an event. It can be key press event, a terminal resize, or more ... More...
struct	FlexboxConfig
struct	InputOption
	Option for the Input component. More...
struct	LinearGradient
	A class representing the settings for linear-gradient color effect. More...
class	Loop
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
struct	ResizableSplitOption
class	Screen
	A rectangular grid of Pixel. More...
class	ScreenInteractive
class	SenderImpl
struct	SliderOption
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	UnderlineOption

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

Variables
const std::map< std::string, std::string >	g_uniformize
const std::array< ColorInfo, 256 >	palette256

---

Data Structure Documentation

ftxui::AnimatedColorsOption

struct ftxui::AnimatedColorsOption

ftxui::AnimationTask

class ftxui::AnimationTask

ftxui::ColorInfo

struct ftxui::ColorInfo

ftxui::Dimensions

struct ftxui::Dimensions

ftxui::EntryState

struct ftxui::EntryState

ftxui::InputOption

struct ftxui::InputOption

ftxui::MenuEntryOption

struct ftxui::MenuEntryOption

ftxui::ResizableSplitOption

struct ftxui::ResizableSplitOption

ftxui::SliderOption

struct ftxui::SliderOption

Typedef Documentation

CapturedMouse

using CapturedMouse = std::unique_ptr<CapturedMouseInterface>

Definition at line 11 of file captured_mouse.hpp.

ComponentDecorator

using ComponentDecorator = std::function<Component(Component)>

Definition at line 30 of file component.hpp.

ElementDecorator

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

Definition at line 31 of file component.hpp.

Component

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

Definition at line 21 of file component_base.hpp.

Components

using Components = std::vector<Component>

Definition at line 22 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.

Closure

using Closure = std::function<void()>

Definition at line 10 of file task.hpp.

Task

using Task = std::variant<Event, Closure, AnimationTask>

Definition at line 11 of file task.hpp.

Element

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

Definition at line 20 of file elements.hpp.

Elements

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

Definition at line 21 of file elements.hpp.

Decorator

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

Definition at line 22 of file elements.hpp.

GraphFunction

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

Definition at line 23 of file elements.hpp.

Charset

using Charset = std::array<std::string, 6>

Definition at line 18 of file border.cpp.

Charsets

using Charsets = std::array<Charset, 6>

Definition at line 19 of file border.cpp.

Enumeration Type Documentation

Direction

enum class Direction

strong

Enumerator
Up
Down
Left
Right

Definition at line 5 of file direction.hpp.

BorderStyle

enum BorderStyle

Enumerator
LIGHT
DASHED
HEAVY
DOUBLE
ROUNDED
EMPTY

Definition at line 25 of file elements.hpp.

WidthOrHeight

enum WidthOrHeight

Enumerator
WIDTH
HEIGHT

Definition at line 143 of file elements.hpp.

Constraint

enum Constraint

Enumerator
LESS_THAN
EQUAL
GREATER_THAN

Definition at line 144 of file elements.hpp.

WordBreakProperty

enum class WordBreakProperty

strong

Enumerator
ALetter
CR
Double_Quote
Extend
ExtendNumLet
Format
Hebrew_Letter
Katakana
LF
MidLetter
MidNum
MidNumLet
Newline
Numeric
Regional_Indicator
Single_Quote
WSegSpace
ZWJ

Definition at line 31 of file string.hpp.

Function Documentation

Make()

template<class T , class... Args>

std::shared_ptr< T > Make

(

Args &&...

args

)

Definition at line 25 of file component.hpp.

operator|() [1/5]

Component operator|	(	Component	component,
		ComponentDecorator	decorator )

Definition at line 9 of file util.cpp.

operator|() [2/5]

Component operator|	(	Component	component,
		ElementDecorator	decorator )

Definition at line 14 of file util.cpp.

operator|=() [1/3]

Component & operator|=	(	Component &	component,
		ComponentDecorator	decorator )

Definition at line 19 of file util.cpp.

operator|=() [2/3]

Component & operator|=	(	Component &	component,
		ElementDecorator	decorator )

Definition at line 25 of file util.cpp.

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 59 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 112 of file checkbox.cpp.

Input()

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 337 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.

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 512 of file menu.cpp.

MenuEntry()

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

A specific menu entry. They can be put into a Container::Vertical to form a menu.

Parameters

label	The text drawn representing this element.
option	Additional optional parameters.

Example

auto screen = ScreenInteractive::TerminalOutput();
int selected = 0;
auto menu = Container::Vertical({
   MenuEntry("entry 1"),
   MenuEntry("entry 2"),
   MenuEntry("entry 3"),
}, &selected);
screen.Loop(menu);

Output

> entry 1
  entry 2
  entry 3

Definition at line 553 of file menu.cpp.

Dropdown()

Component Dropdown	(	ConstStringListRef	entries,
		int *	selected )

Definition at line 14 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 211 of file radiobox.cpp.

Toggle()

Component Toggle	(	ConstStringListRef	entries,
		int *	selected )

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.
See	also |Menu|.

Definition at line 523 of file menu.cpp.

Slider() [1/14]

template<typename T >

Component Slider

(

SliderOption< T >

options

)

A slider in any direction.

Parameters

option

The options

Example

auto screen = ScreenInteractive::TerminalOutput();
int value = 50;
auto slider = Slider({
  .value = &value,
  .min = 0,
  .max = 100,
  .increment= 20,
});
screen.Loop(slider);

Definition at line 327 of file slider.cpp.

Slider() [2/14]

Component Slider	(	ConstStringRef	label,
		Ref< int >	value,
		ConstRef< int >	min,
		ConstRef< int >	max,
		ConstRef< int >	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 270 of file slider.cpp.

Slider() [3/14]

Component Slider	(	ConstStringRef	label,
		Ref< float >	value,
		ConstRef< float >	min = 0.f,
		ConstRef< float >	max = 100.f,
		ConstRef< float >	increment = 5.f )

Definition at line 284 of file slider.cpp.

Slider() [4/14]

Component Slider	(	ConstStringRef	label,
		Ref< long >	value,
		ConstRef< long >	min = 0l,
		ConstRef< long >	max = 100l,
		ConstRef< long >	increment = 5l )

Definition at line 297 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 191 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 225 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 259 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 293 of file resizable_split.cpp.

ResizableSplit()

Component ResizableSplit

(

ResizableSplitOption

options

)

A split in between two components.

Parameters

options

all the parameters.

Example

auto left = Renderer([] { return text("Left") | center;});
auto right = Renderer([] { return text("right") | center;});
int left_size = 10;
auto component = ResizableSplit({
  .main = left,
  .back = right,
  .direction = Direction::Left,
  .main_size = &left_size,
  .separator_func = [] { return separatorDouble(); },
});

Output

       ║
left   ║   right
       ║

Definition at line 162 of file resizable_split.cpp.

Renderer() [1/4]

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 60 of file renderer.cpp.

Renderer() [2/4]

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/4]

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 83 of file renderer.cpp.

Renderer() [4/4]

ComponentDecorator Renderer

(

ElementDecorator

decorator

)

Decorate a component, by decorating what it renders.

Parameters

decorator

the function modifying the element it renders.

Example

    auto screen = ScreenInteractive::TerminalOutput();
    auto renderer = */
//     Renderer([] { return text("Hello");)
/**  | Renderer(bold)
     | Renderer(inverted);
    screen.Loop(renderer);

Definition at line 124 of file renderer.cpp.

CatchEvent() [1/3]

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

CatchEvent() [2/3]

ComponentDecorator CatchEvent

(

std::function< bool(Event)>

on_event

)

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

Parameters

on_event

The function drawing the interface.

Example

auto screen = ScreenInteractive::TerminalOutput();
auto renderer = Renderer([] { return text("Hello world"); });
renderer |= CatchEvent([&](Event event) {
  if (event == Event::Character('q')) {
    screen.ExitLoopClosure()();
    return true;
  }
  return false;
});
screen.Loop(renderer);

Definition at line 79 of file catch_event.cpp.

Maybe() [1/4]

Component Maybe	(	Component	child,
		const bool *	show )

Decorate a component |child|. It is shown only when |show| is true. @params child the compoennt to decorate. @params show a boolean. |child| is shown when |show| is true.

Example

auto component = Renderer([]{ return text("Hello World!"); });
auto maybe_component = Maybe(component, &show);

Definition at line 67 of file maybe.cpp.

Maybe() [2/4]

Component Maybe	(	Component	child,
		std::function< bool()>	show )

Definition at line 14 of file maybe.cpp.

Maybe() [3/4]

ComponentDecorator Maybe

(

const bool *

show

)

Decorate a component. It is shown only when |show| is true. @params show a boolean. |child| is shown when |show| is true.

Example

auto component = Renderer([]{ return text("Hello World!"); });
auto maybe_component = component | Maybe(&show);

Definition at line 81 of file maybe.cpp.

Maybe() [4/4]

ComponentDecorator Maybe

(

std::function< bool()>

show

)

Decorate a component. It is shown only when the |show| function returns true. @params show a function returning whether the decoratorated component should be shown.

Example

auto component = Renderer([]{ return text("Hello World!"); });
auto maybe_component = component | Maybe([&]{ return counter == 42; });

Definition at line 50 of file maybe.cpp.

Modal() [1/2]

Component Modal	(	Component	main,
		Component	modal,
		const bool *	show_modal )

Definition at line 15 of file modal.cpp.

Modal() [2/2]

ComponentDecorator Modal	(	Component	modal,
		const bool *	show_modal )

Definition at line 55 of file modal.cpp.

Collapsible()

Component Collapsible	(	ConstStringRef	label,
		Component	child,
		Ref< bool >	show = false )

Hoverable() [1/6]

Component Hoverable	(	Component	component,
		bool *	hover )

Wrap a component. Gives the ability to know if it is hovered by the mouse.

Parameters

component	The wrapped component.
hover	The value to reflect whether the component is hovered or not.

Example

auto button = Button("exit", screen.ExitLoopClosure());
bool hover = false;
auto button_hover = Hoverable(button, &hover);

Definition at line 41 of file hoverable.cpp.

Hoverable() [2/6]

Component Hoverable	(	Component	component,
		std::function< void()>	on_enter,
		std::function< void()>	on_leave )

Wrap a component. Gives the ability to know if it is hovered by the mouse.

Parameters

component	The wrapped component.
hover	The value to reflect whether the component is hovered or not.

Example

auto button = Button("exit", screen.ExitLoopClosure());
bool hover = false;
auto button_hover = Hoverable(button, &hover);

Definition at line 84 of file hoverable.cpp.

Hoverable() [3/6]

Component Hoverable	(	Component	component,
		std::function< void(bool)>	on_change )

Wrap a component. Gives the ability to know if it is hovered by the mouse.

Parameters

on_enter	is called when the mouse hover the component.
on_leave	is called when the mouse leave the component.

Example

    auto button = Button("exit", screen.ExitLoopClosure());
    int on_enter_cnt = 0;
    int on_leave_cnt = 0;
    button |= Hoverable(
      [&]{ on_enter_cnt++; },
      [&]{ on_leave_cnt++; } */
//  );
/// 

// NOLINTNEXTLINE ComponentDecorator Hoverable(std::function<void()> on_enter, // NOLINTNEXTLINE std::function<void()> on_leave) { return [on_enter, on_leave](Component component) { return Hoverable(std::move(component), on_enter, on_leave); }; }

/** Wrap a component. Gives the ability to know if it is hovered by the mouse.

Parameters

component	the wrapped component.
on_change	is called when the mouse enter or leave the component.

Example

```cpp auto button = Button("exit", screen.ExitLoopClosure()); bool hovered = false; auto button_hoverable = Hoverable(button, ```

Definition at line 186 of file hoverable.cpp.

Hoverable() [4/6]

ComponentDecorator Hoverable

(

bool *

hover

)

Wrap a component. Gives the ability to know if it is hovered by the mouse.

Parameters

hover

The value to reflect whether the component is hovered or not.

Example

bool hover = false;
auto button = Button("exit", screen.ExitLoopClosure());
button |= Hoverable(&hover);

Definition at line 139 of file hoverable.cpp.

Hoverable() [5/6]

ComponentDecorator Hoverable	(	std::function< void()>	on_enter,
		std::function< void()>	on_leave )

Hoverable() [6/6]

ComponentDecorator Hoverable

(

std::function< void(bool)>

on_change

)

Wrap a component. Gives the ability to know if it is hovered by the mouse.

Parameters

on_change

is called when the mouse enter or leave the component.

Example

auto button = Button("exit", screen.ExitLoopClosure());
bool hovered = false;
button |= Hoverable([&](bool hover) { hovered = hover;});

Definition at line 207 of file hoverable.cpp.

MakeReceiver()

template<class T >

Receiver< T > MakeReceiver

(

)

Definition at line 131 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 111 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 171 of file text.cpp.

paragraph() [1/2]

Elements paragraph

(

std::wstring

text

)

operator|() [3/5]

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 68 of file util.cpp.

operator|=() [3/3]

Element & operator|=	(	Element &	e,
		Decorator	d )

Apply a decorator to an element.

Returns

the decorated element.

Example

Both of these are equivalent:

auto element = text("Hello");
element |= bold;

Definition at line 83 of file util.cpp.

operator|() [4/5]

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 47 of file util.cpp.

operator|() [5/5]

Decorator operator|	(	Decorator	a,
		Decorator	b )

Compose two decorator into one.

Example

auto decorator = bold | blink;

Definition at line 39 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 92 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 141 of file text.cpp.

separator() [1/2]

Element separator

(

)

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

See also

separator

separatorLight

separatorDashed

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 130 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

separatorDashed

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 205 of file separator.cpp.

separatorDashed()

Element separatorDashed

(

)

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

See also

separator

separatorLight

separatorDashed

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 242 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

separatorDashed

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 279 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

separatorDashed

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 316 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

separatorDashed

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 353 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

separatorDashed

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 168 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

separatorDashed

separatorHeavy

separatorDouble

separatorStyled

Example

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

Output

Up
 
Down

Definition at line 422 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

separatorDashed

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 391 of file separator.cpp.

separatorHSelector()

Element separatorHSelector	(	float	left,
		float	right,
		Color	unselected_color,
		Color	selected_color )

Draw an horizontal bar, with the area in between left/right colored differently.

Parameters

left	the left limit of the active area.
right	the right limit of the active area.
selected_color	the color of the selected area.
unselected_color	the color of the unselected area.

Example

Element document = separatorHSelector(2,5, Color::White, Color::Blue);

Definition at line 438 of file separator.cpp.

separatorVSelector()

Element separatorVSelector	(	float	up,
		float	down,
		Color	unselected_color,
		Color	selected_color )

Draw an vertical bar, with the area in between up/downcolored differently.

Parameters

up	the left limit of the active area.
down	the right limit of the active area.
selected_color	the color of the selected area.
unselected_color	the color of the unselected area.

Example

Element document = separatorHSelector(2,5, Color::White, Color::Blue);

Definition at line 508 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 287 of file gauge.cpp.

gaugeLeft()

Element gaugeLeft

(

float

progress

)

Draw a high definition progress bar progressing from right to left.

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(gaugeLeft(0.5))

Output

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

Definition at line 207 of file gauge.cpp.

gaugeRight()

Element gaugeRight

(

float

progress

)

Draw a high definition progress bar progressing from left to right.

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(gaugeRight(0.5))

Output

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

Definition at line 185 of file gauge.cpp.

gaugeUp()

Element gaugeUp

(

float

progress

)

Draw a high definition progress bar progressing from bottom to top.

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(gaugeUp(0.5))

Output

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

Definition at line 236 of file gauge.cpp.

gaugeDown()

Element gaugeDown

(

float

progress

)

Draw a high definition progress bar progressing from top to bottom.

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(gaugeDown(0.5))

Output

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

Definition at line 265 of file gauge.cpp.

gaugeDirection()

Element gaugeDirection	(	float	progress,
		Direction	direction )

Draw a high definition progress bar progressing in specified direction.

Parameters

progress

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

Definition at line 163 of file gauge.cpp.

border()

Element border

(

Element

child

)

Draw a border around the element.

See also

border

borderLight

borderDashed

borderDouble

borderHeavy

borderEmpty

borderRounded

borderStyled

borderWith

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 222 of file border.cpp.

borderLight()

Element borderLight

(

Element

child

)

Draw a dashed border around the element.

See also

border

borderLight

borderDashed

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 330 of file border.cpp.

borderDashed()

Element borderDashed

(

Element

child

)

Draw a light border around the element.

See also

border

borderLight

borderDashed

borderDouble

borderHeavy

borderRounded

borderEmpty

borderStyled

borderWith

Add a border around an element

Example

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

Output

┏╍╍╍╍╍╍╍╍╍╍╍╍╍╍┓
╏The element   ╏
┗╍╍╍╍╍╍╍╍╍╍╍╍╍╍┛

Definition at line 295 of file border.cpp.

borderHeavy()

Element borderHeavy

(

Element

child

)

Draw a heavy border around the element.

See also

border

borderLight

borderDashed

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 365 of file border.cpp.

borderDouble()

Element borderDouble

(

Element

child

)

Draw a double border around the element.

See also

border

borderLight

borderDashed

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 400 of file border.cpp.

borderRounded()

Element borderRounded

(

Element

child

)

Draw a rounded border around the element.

See also

border

borderLight

borderDashed

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 435 of file border.cpp.

borderEmpty()

Element borderEmpty

(

Element

child

)

Draw an empty border around the element.

See also

border

borderLight

borderDashed

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 470 of file border.cpp.

borderStyled() [1/3]

Decorator borderStyled

(

BorderStyle

style

)

Same as border but with different styles.

See also

border

Definition at line 238 of file border.cpp.

borderStyled() [2/3]

Decorator borderStyled	(	BorderStyle	style,
		Color	foreground_color )

Same as border but with a foreground color and a different style.

See also

border

Definition at line 257 of file border.cpp.

borderStyled() [3/3]

Decorator borderStyled

(

Color

foreground_color

)

Same as border but with a foreground color.

See also

border

Definition at line 247 of file border.cpp.

borderWith()

Decorator borderWith

(

const Pixel &

pixel

)

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

See also

border

Definition at line 229 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 495 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 280 of file spinner.cpp.

paragraph() [2/2]

Element paragraph

(

const std::string &

the_text

)

Return an element drawing the paragraph on multiple lines.

See also

flexbox.

Definition at line 25 of file paragraph.cpp.

paragraphAlignLeft()

Element paragraphAlignLeft

(

const std::string &

the_text

)

Return an element drawing the paragraph on multiple lines, aligned on the left.

See also

flexbox.

Definition at line 33 of file paragraph.cpp.

paragraphAlignRight()

Element paragraphAlignRight

(

const std::string &

the_text

)

Return an element drawing the paragraph on multiple lines, aligned on the right.

See also

flexbox.

Definition at line 42 of file paragraph.cpp.

paragraphAlignCenter()

Element paragraphAlignCenter

(

const std::string &

the_text

)

Return an element drawing the paragraph on multiple lines, aligned on the center.

See also

flexbox.

Definition at line 52 of file paragraph.cpp.

paragraphAlignJustify()

Element paragraphAlignJustify

(

const std::string &

the_text

)

Return an element drawing the paragraph on multiple lines, aligned using a justified alignment. the center.

See also

flexbox.

Definition at line 63 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 65 of file graph.cpp.

emptyElement()

Element emptyElement

(

)

An element of size 0x0 drawing nothing.

Definition at line 131 of file util.cpp.

canvas() [1/3]

Element canvas

(

ConstRef< Canvas >

canvas

)

Produce an element from a Canvas, or a reference to a Canvas.

Definition at line 848 of file canvas.cpp.

canvas() [2/3]

Element canvas	(	int	width,
		int	height,
		std::function< void(Canvas &)>	fn )

Produce an element drawing a canvas of requested size.

Parameters

width	the width of the canvas.
height	the height of the canvas.
fn	a function drawing the canvas.

Definition at line 865 of file canvas.cpp.

canvas() [3/3]

Element canvas

(

std::function< void(Canvas &)>

fn

)

Produce an element drawing a canvas.

Parameters

fn	a function drawing the canvas.

Definition at line 895 of file canvas.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.

underlinedDouble()

Element underlinedDouble

(

Element

child

)

Apply a underlinedDouble to text.

Definition at line 14 of file underlined_double.cpp.

blink()

Element blink

(

Element

child

)

The text drawn alternates in between visible and hidden.

Definition at line 28 of file blink.cpp.

strikethrough()

Element strikethrough

(

Element

child

)

Apply a strikethrough to text.

Definition at line 14 of file strikethrough.cpp.

color() [1/4]

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/4]

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/4]

Decorator color

(

const LinearGradient &

gradient

)

Decorate using a linear-gradient effect on the foreground color.

Parameters

gradient

The gradient effect to be applied on the output element.

Returns

The Decorator applying the color.

Example

text("Hello") | color(LinearGradient{0, {Color::Red, Color::Blue}})

Definition at line 269 of file linear_gradient.cpp.

bgcolor() [2/4]

Decorator bgcolor

(

const LinearGradient &

gradient

)

Decorate using a linear-gradient effect on the background color.

Parameters

gradient

The gradient effect to be applied on the output element.

Returns

The Decorator applying the color.

Example

text("Hello") | color(LinearGradient{0, {Color::Red, Color::Blue}})

Definition at line 284 of file linear_gradient.cpp.

color() [3/4]

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() [3/4]

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.

color() [4/4]

Element color	(	const LinearGradient &	gradient,
		Element	child )

Set the foreground color of an element with linear-gradient effect.

Parameters

gradient	The gradient effect to be applied on the output element.
child	The input element.

Returns

The output element colored.

Example

color(LinearGradient{0, {Color::Red, Color::Blue}}, text("Hello"))

Definition at line 238 of file linear_gradient.cpp.

bgcolor() [4/4]

Element bgcolor	(	const LinearGradient &	gradient,
		Element	child )

Set the background color of an element with linear-gradient effect.

Parameters

gradient	The gradient effect to be applied on the output element.
child	The input element.

Returns

The output element colored.

Example

bgcolor(LinearGradient{0, {Color::Red, Color::Blue}}, text("Hello"))

Definition at line 254 of file linear_gradient.cpp.

focusPosition()

Decorator focusPosition	(	int	x,
		int	y )

Used inside a frame, this force the view to be scrolled toward a a given position. The position is expressed in the numbers of cells.

Example

Element document = huge_document()
  | focusPosition(10, 10)
  | frame;

Definition at line 67 of file focus.cpp.

focusPositionRelative()

Decorator focusPositionRelative	(	float	x,
		float	y )

Used inside a frame, this force the view to be scrolled toward a a given position. The position is expressed in proportion of the requested size.

For instance:

• (0, 0) means that the view is scrolled toward the upper left.
• (1, 0) means that the view is scrolled toward the upper right.
• (0, 1) means that the view is scrolled toward the bottom left.

Example

Element document = huge_document()
  | focusPositionRelative(0.f, 1.f)
  | frame;

Definition at line 28 of file focus.cpp.

automerge()

Element automerge

(

Element

child

)

Enable character to be automatically merged with others nearby.

Definition at line 14 of file automerge.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 77 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 78 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 52 of file dbox.cpp.

flexbox()

Element flexbox	(	Elements	,
		FlexboxConfig	config = FlexboxConfig() )

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 178 of file gridbox.cpp.

hflow()

Element hflow

(

Elements

)

vflow()

Element vflow

(

Elements

)

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 120 of file flex.cpp.

flex_grow()

Element flex_grow

(

Element

child

)

Expand if possible.

Definition at line 138 of file flex.cpp.

flex_shrink()

Element flex_shrink

(

Element

child

)

Minimize if needed.

Definition at line 156 of file flex.cpp.

xflex()

Element xflex

(

Element

child

)

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

Definition at line 126 of file flex.cpp.

xflex_grow()

Element xflex_grow

(

Element

child

)

Expand if possible on the X axis.

Definition at line 144 of file flex.cpp.

xflex_shrink()

Element xflex_shrink

(

Element

child

)

Minimize if needed on the X axis.

Definition at line 162 of file flex.cpp.

yflex()

Element yflex

(

Element

child

)

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

Definition at line 132 of file flex.cpp.

yflex_grow()

Element yflex_grow

(

Element

child

)

Expand if possible on the Y axis.

Definition at line 150 of file flex.cpp.

yflex_shrink()

Element yflex_shrink

(

Element

child

)

Minimize if needed on the Y axis.

Definition at line 168 of file flex.cpp.

notflex()

Element notflex

(

Element

child

)

Make the element not flexible.

Definition at line 174 of file flex.cpp.

filler()

Element filler

(

)

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

Definition at line 95 of file flex.cpp.

size()

Decorator size	(	WidthOrHeight	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 85 of file size.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 142 of file frame.cpp.

xframe()

Element xframe

(

Element

child

)

Definition at line 146 of file frame.cpp.

yframe()

Element yframe

(

Element

child

)

Definition at line 150 of file frame.cpp.

focus()

Element focus

(

Element

child

)

Definition at line 83 of file frame.cpp.

select()

Element select

(

Element

child

)

Definition at line 38 of file frame.cpp.

focusCursorBlock()

Element focusCursorBlock

(

Element

child

)

Definition at line 171 of file frame.cpp.

focusCursorBlockBlinking()

Element focusCursorBlockBlinking

(

Element

child

)

Definition at line 175 of file frame.cpp.

focusCursorBar()

Element focusCursorBar

(

Element

child

)

Definition at line 179 of file frame.cpp.

focusCursorBarBlinking()

Element focusCursorBarBlinking

(

Element

child

)

Definition at line 183 of file frame.cpp.

focusCursorUnderline()

Element focusCursorUnderline

(

Element

child

)

Definition at line 187 of file frame.cpp.

focusCursorUnderlineBlinking()

Element focusCursorUnderlineBlinking

(

Element

child

)

Definition at line 191 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.

reflect()

Decorator reflect

(

Box &

box

)

Definition at line 39 of file reflect.cpp.

clear_under()

Element clear_under

(

Element

element

)

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

See also

ftxui::dbox

Definition at line 32 of file clear_under.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 27 of file util.cpp.

Render() [1/2]

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

Display an element on a ftxui::Screen.

Definition at line 44 of file node.cpp.

Render() [2/2]

void Render	(	Screen &	screen,
		Node *	node )

Display an element on a ftxui::Screen.

Definition at line 50 of file node.cpp.

GetColorInfo() [1/2]

ColorInfo GetColorInfo

(

Color::Palette256

index

)

Definition at line 269 of file color_info.cpp.

GetColorInfo() [2/2]

ColorInfo GetColorInfo

(

Color::Palette16

index

)

Definition at line 273 of file color_info.cpp.

wchar_width()

int wchar_width

(

wchar_t

ucs

)

Definition at line 1683 of file string.cpp.

wstring_width()

int wstring_width

(

const std::wstring &

text

)

Definition at line 1687 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 1899 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 1971 of file string.cpp.

to_wstring() [2/2]

template<typename T >

std::wstring to_wstring

(

T

s

)

Definition at line 13 of file string.hpp.

string_width()

int string_width

(

const std::string &

input

)

Definition at line 1700 of file string.cpp.

Utf8ToGlyphs()

std::vector< std::string > Utf8ToGlyphs

(

const std::string &

input

)

Definition at line 1727 of file string.cpp.

GlyphPosition()

int GlyphPosition	(	const std::string &	input,
		size_t	glyph_index,
		size_t	start = 0 )

Definition at line 1770 of file string.cpp.

GlyphCount()

int GlyphCount

(

const std::string &

input

)

Definition at line 1839 of file string.cpp.

Utf8ToWordBreakProperty()

std::vector< WordBreakProperty > Utf8ToWordBreakProperty

(

const std::string &

input

)

Definition at line 1867 of file string.cpp.

IsWordBreakingCharacter()

bool IsWordBreakingCharacter	(	const std::string &	input,
		size_t	glyph_index )

CellToGlyphIndex()

std::vector< int > CellToGlyphIndex

(

const std::string &

input

)

Definition at line 1798 of file string.cpp.

CatchEvent() [3/3]

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");
});
auto component = CatchEvent(renderer, [&](Event event) {
  if (event == Event::Character('q')) {
    screen.ExitLoopClosure()();
    return true;
  }
  return false;
});
screen.Loop(component);

Definition at line 53 of file catch_event.cpp.

Slider() [5/14]

template Component Slider

(

SliderOption< int8_t >

)

Slider() [6/14]

template Component Slider

(

SliderOption< int16_t >

)

Slider() [7/14]

template Component Slider

(

SliderOption< int32_t >

)

Slider() [8/14]

template Component Slider

(

SliderOption< int64_t >

)

Slider() [9/14]

template Component Slider

(

SliderOption< uint8_t >

)

Slider() [10/14]

template Component Slider

(

SliderOption< uint16_t >

)

Slider() [11/14]

template Component Slider

(

SliderOption< uint32_t >

)

Slider() [12/14]

template Component Slider

(

SliderOption< uint64_t >

)

Slider() [13/14]

template Component Slider

(

SliderOption< float >

)

Slider() [14/14]

template Component Slider

(

SliderOption< double >

)

Variable Documentation

g_uniformize

const std::map<std::string, std::string> g_uniformize

Definition at line 16 of file terminal_input_parser.cpp.

palette256

const std::array<ColorInfo, 256> palette256

Definition at line 10 of file color_info.cpp.