elements.hpp File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

Typedefs
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)>

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

Functions
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.
Dimensions	Fit (Element &)