elements.hpp File Reference

Go to the source code of this file.

Namespaces
namespace	ftxui
	The FTXUI ftxui:: namespace.
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 ,   DASHED ,   HEAVY ,   DOUBLE ,   ROUNDED ,   EMPTY }
	BorderStyle is an enumeration that represents the different styles of borders that can be applied to elements in the terminal UI. More...
enum	WidthOrHeight {   WIDTH ,   HEIGHT }
enum	Constraint {   LESS_THAN ,   EQUAL ,   GREATER_THAN }

Functions
struct	FTXUI_EXPORT (DOM) Canvas
	Canvas is a drawable buffer associated with drawing operations.
	FTXUI_EXPORT (DOM) Element &operator|
FTXUI_EXPORT(DOM) Element separatorCharacter(std Element	separatorHSelector (float left, float right, Color unselected_color, Color selected_color)
	Draw a 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	window (Element title, Element content, BorderStyle border)
	Draw window with a title and a border around the element.
Element	canvas (int width, int height, std::function< void(Canvas &)> fn)
	Produce an element drawing a canvas of requested size.
Element	flexbox (Elements children, FlexboxConfig config)
	A container displaying elements on row/columns and capable of wrapping on the next column/row when full.
FTXUI_EXPORT(DOM) Element gridbox(std Element	hflow (Elements children)
	A container displaying elements in rows from left to right. When filled, it starts on a new row below.
Element	vflow (Elements children)
	A container displaying elements in rows from top to bottom. When filled, it starts on a new columns on the right. filled, it starts on a new row. is full, it starts a new row.
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.
	FTXUI_EXPORT (DOM) Dimensions Fit(Element &

Variables
Direction	direction
	Color
	Build a transparent color.
size_t	image_index
int	y
	Constraint
int	value
bool	extend_beyond_screen = false)