El espacio de nombres ftxui:: de FTXUI. More...

Namespaces
namespace	animation
	El espacio de nombres ftxui::animation:: de FTXUI.

namespace	box_helper

namespace	Container

namespace	Dimension
	Define cómo deben ser las dimensiones de la pantalla.

namespace	flexbox_helper

namespace	literals

namespace	task

namespace	Terminal

namespace	util

Classes
struct	AnimatedColorOption
	Opción sobre un color potencialmente animado. More...

struct	AnimatedColorsOption

class	AnimationTask

class	AutoReset
	Asigna un valor a una variable, restaurando su valor antiguo al salir del ámbito. More...

struct	Box
	Box es una estructura que representa un área rectangular en un espacio 2D. More...

struct	ButtonOption
	Opción para el componente AnimatedButton. More...

struct	Canvas
	Canvas es un búfer dibujable asociado con operaciones de dibujo. More...

class	CapturedMouseInterface

struct	CheckboxOption
	Opción para el componente Checkbox. More...

class	Color
	Color es una clase que representa un color en la interfaz de usuario de la terminal. More...

struct	ColorInfo
	ColorInfo es una estructura que contiene información sobre la paleta de colores del terminal. More...

class	ComponentBase
	Implementa el renderizado de sí mismo como ftxui::Element. Implementa la navegación por teclado respondiendo a ftxui::Event. More...

class	ConstRef
	Un adaptador. Posee o referencia un objeto inmutable. More...

class	ConstStringListRef
	Un adaptador. Referencia una lista de cadenas. More...

class	ConstStringRef
	Un adaptador. Posee o referencia una cadena constante. Para mayor comodidad, esta clase convierte múltiples cadenas inmutables hacia una representación compartida. More...

struct	Dimensions
	Dimensions es una estructura que representa el tamaño de la terminal. More...

struct	DropdownOption
	Opción para el componente Dropdown.Un menú desplegable es un checkbox que abre/cierra un radiobox. More...

struct	EntryState
	Argumentos para la transformación de \|ButtonOption\|, \|CheckboxOption\|, \|RadioboxOption\|, \|MenuEntryOption\|, \|MenuOption\|. More...

struct	Event
	Representa un evento. Puede ser un evento de pulsación de tecla, un redimensionamiento de terminal, o más... More...

struct	FlexboxConfig
	FlexboxConfig es una estructura de configuración que define las propiedades de diseño para un contenedor flexbox. More...

class	Image
	Una cuadrícula rectangular de píxeles. More...

struct	InputOption
	Opción para el componente Input. More...

struct	InputState
	Usado para definir el estilo del componente Input. More...

struct	LinearGradient
	Una clase que representa la configuración para el efecto de color de gradiente lineal. More...

class	Loop
	Loop es una clase que gestiona el bucle de eventos de un componente. More...

struct	MenuEntryOption
	Opción para el componente MenuEntry. More...

struct	MenuOption
	Opción para el componente Menu. More...

struct	Mouse
	Un evento del ratón. Contiene las coordenadas del ratón, el botón presionado y el modificador (shift, ctrl, meta). More...

class	Node
	Node es la clase base para todos los elementos en el árbol DOM. More...

class	NodeDecorator

struct	Pixel
	Un carácter Unicode y su estilo asociado. More...

struct	RadioboxOption
	Opción para el componente Radiobox. More...

class	ReceiverImpl

class	Ref
	Un adaptador. Posee o referencia un objeto mutable. More...

struct	Requirement
	Requirement es una estructura que define los requisitos de diseño para un Nodo en la interfaz de usuario del terminal. More...

struct	ResizableSplitOption

class	Screen
	Una cuadrícula rectangular de píxeles. More...

class	ScreenInteractive
	ScreenInteractive es una `Screen` que puede manejar eventos, ejecutar un bucle principal y administrar componentes. More...

class	Selection
	Representa una selección en una interfaz de usuario de terminal. More...

class	SenderImpl

struct	SliderOption

class	StringRef
	Un adaptador. Posee o referencia una cadena constante. Para mayor comodidad, esta clase convierte múltiples cadenas mutables hacia una representación compartida. More...

class	Table
	Table es una utilidad para dibujar tablas. More...

class	TableSelection

class	TerminalInputParser

struct	UnderlineOption
	Opción para el efecto de subrayado. More...

struct	WindowOptions

struct	WindowRenderState
	Estado pasado a la función de renderizado del componente `Window`. More...

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

Enumerations
enum class	Direction { Up = 0 , Down = 1 , Left = 2 , Right = 3 }
	Direction es una enumeración que representa las cuatro cardinales direcciones. More...

enum	BorderStyle { LIGHT , DASHED , HEAVY , DOUBLE , ROUNDED , EMPTY }
	BorderStyle es una enumeración que representa los diferentes estilos de bordes que se pueden aplicar a los elementos en la interfaz de usuario de la terminal. More...

enum	WidthOrHeight { WIDTH , HEIGHT }

enum	Constraint { LESS_THAN , EQUAL , GREATER_THAN }

enum class	WordBreakProperty : int8_t { ALetter , CR , Double_Quote , Extend , ExtendNumLet , Format , Hebrew_Letter , Katakana , LF , MidLetter , MidNum , MidNumLet , Newline , Numeric , Regional_Indicator , Single_Quote , WSegSpace , ZWJ }

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 (ButtonOption option)
	Dibuja un botón. Ejecuta una función al hacer clic.

Component	Button (ConstStringRef label, std::function< void()> on_click, ButtonOption option)
	Dibuja un botón. Ejecuta una función al hacer clic.

Component	Checkbox (CheckboxOption option)
	Dibuja un elemento seleccionable.

Component	Checkbox (ConstStringRef label, bool *checked, CheckboxOption option)
	Dibuja un elemento seleccionable.

Component	Input (InputOption option)
	Un cuadro de entrada para editar texto.

Component	Input (StringRef content, InputOption option)
	Un cuadro de entrada para editar texto.

Component	Input (StringRef content, StringRef placeholder, InputOption option)
	Un cuadro de entrada para editar texto.

Component	Menu (MenuOption option)
	Una lista de texto. El elemento enfocado es seleccionado.

Component	Menu (ConstStringListRef entries, int *selected, MenuOption option)
	Una lista de texto. El elemento enfocado es seleccionado.

Component	MenuEntry (MenuEntryOption option)
	Una entrada de menú específica. Se pueden colocar en un Container::Vertical para formar un menú.

Component	MenuEntry (ConstStringRef label, MenuEntryOption option)
	Una entrada de menú específica. Se pueden colocar en un Container::Vertical para formar un menú.

Component	Radiobox (RadioboxOption option)
	Una lista de elementos, donde solo uno puede ser seleccionado.

Component	Radiobox (ConstStringListRef entries, int *selected, RadioboxOption option)
	Una lista de elementos, donde solo uno puede ser seleccionado.

Component	Dropdown (ConstStringListRef entries, int *selected)
	Un menú desplegable.

Component	Dropdown (DropdownOption option)
	Un menú desplegable.

Component	Toggle (ConstStringListRef entries, int *selected)
	Una lista horizontal de elementos. El usuario puede navegar a través de ellos.

template<typename T >
Component	Slider (SliderOption< T > options)
	Un deslizador en cualquier dirección.

Component	Slider (ConstStringRef label, Ref< int > value, ConstRef< int > min, ConstRef< int > max, ConstRef< int > increment)
	Un deslizador horizontal.

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	ResizableSplit (ResizableSplitOption options)
	Una división entre dos componentes.

Component	ResizableSplitLeft (Component main, Component back, int *main_size)
	Una división horizontal entre dos componentes, configurable usando el ratón.

Component	ResizableSplitRight (Component main, Component back, int *main_size)
	Una división horizontal entre dos componentes, configurable usando el ratón.

Component	ResizableSplitTop (Component main, Component back, int *main_size)
	Una división vertical entre dos componentes, configurable usando el ratón.

Component	ResizableSplitBottom (Component main, Component back, int *main_size)
	Una división vertical entre dos componentes, configurable usando el ratón.

Component	Renderer (Component child, std::function< Element()> render)
	Retorna un nuevo Componente, similar a \|child\|, pero usando \|render\| como el evento Component::Render().

Component	Renderer (std::function< Element()> render)
	Retorna un componente, usando \|render\| para renderizar su interfaz.

Component	Renderer (std::function< Element(bool)> render)
	Retorna un componente enfocable, usando \|render\| para renderizar su interfaz.

ComponentDecorator	Renderer (ElementDecorator decorator)
	Decora un componente, decorando lo que renderiza.

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

ComponentDecorator	CatchEvent (std::function< bool(Event)> on_event)
	Decora un componente, usando \|on_event\| para capturar eventos. Esta función debe retornar true cuando el evento ha sido manejado, false en caso contrario.

Component	Maybe (Component child, const bool *show)
	Decora un componente \|child\|. Se muestra solo cuando \|show\| es verdadero.

Component	Maybe (Component child, std::function< bool()> show)
	Decora un componente \|child\|. Se muestra solo cuando \|show\| devuelve verdadero.

ComponentDecorator	Maybe (const bool *show)
	Decora un componente. Se muestra solo cuando \|show\| es verdadero.

ComponentDecorator	Maybe (std::function< bool()> show)
	Decora un componente. Se muestra solo cuando la función \|show\| devuelve verdadero.

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)
	Un componente plegable. Muestra una casilla de verificación con una flecha. Una vez activado, se muestra el componente hijo.

Component	Hoverable (Component component, bool *hover)
	Envuelve un componente. Permite saber si el ratón lo está "hovering".

Component	Hoverable (Component component, std::function< void()> on_enter, std::function< void()> on_leave)
	Envuelve un componente. Utiliza callbacks.

Component	Hoverable (Component component, std::function< void(bool)> on_change)
	Envuelve un componente. Permite saber si el ratón lo está "hovering".

ComponentDecorator	Hoverable (bool *hover)
	Envuelve un componente. Permite saber si el ratón lo está "hovering".

ComponentDecorator	Hoverable (std::function< void()> on_enter, std::function< void()> on_leave)
	Envuelve un componente. Permite saber si el ratón lo está "hovering".

ComponentDecorator	Hoverable (std::function< void(bool)> on_change)
	Envuelve un componente. Permite saber si el ratón lo está "hovering".

Component	Window (WindowOptions option)
	Una ventana arrastrable y redimensionable. Para usar varias, deben apilarse usando el componente `Container::Stacked({...})`;.

template<class T >
Receiver< T >	MakeReceiver ()

Element	text (std::wstring text)
	Muestra un fragmento de texto Unicode.

Element	vtext (std::wstring text)
	Muestra un fragmento de texto Unicode verticalmente.

Elements	paragraph (std::wstring text)

Element	operator\| (Element element, Decorator decorator)
	A partir de un elemento, aplica un decorador.

Element &	operator\|= (Element &e, Decorator d)
	Aplica un decorador a un elemento.

Elements	operator\| (Elements elements, Decorator decorator)
	A partir de un conjunto de elementos, aplica un decorador a cada elemento.

Decorator	operator\| (Decorator a, Decorator b)
	Compone dos decoradores en uno.

Element	text (std::string text)
	Muestra un fragmento de texto Unicode codificado en UTF8.

Element	vtext (std::string text)
	Muestra un fragmento de texto Unicode verticalmente.

Element	separator ()
	Dibuja una separación vertical u horizontal entre otros dos elementos.

Element	separatorLight ()
	Dibuja una separación vertical u horizontal entre otros dos elementos, usando el estilo LIGERO.

Element	separatorDashed ()
	Dibuja una separación vertical u horizontal entre otros dos elementos, usando el estilo DISCONTINUO.

Element	separatorHeavy ()
	Dibuja una separación vertical u horizontal entre otros dos elementos, usando el estilo GRUESO.

Element	separatorDouble ()
	Dibuja una separación vertical u horizontal entre otros dos elementos, usando el estilo DOBLE.

Element	separatorEmpty ()
	Dibuja una separación vertical u horizontal entre otros dos elementos, usando el estilo VACÍO.

Element	separatorStyled (BorderStyle style)
	Dibuja una separación vertical u horizontal entre otros dos elementos.

Element	separator (Pixel pixel)
	Dibuja un separador entre dos elementos, rellenado con un píxel dado.

Element	separatorCharacter (std::string value)
	Dibuja una separación vertical u horizontal entre otros dos elementos.

Element	separatorHSelector (float left, float right, Color unselected_color, Color selected_color)
	Dibuja una barra horizontal, con el área entre izquierda/derecha coloreada de forma diferente.

Element	separatorVSelector (float up, float down, Color unselected_color, Color selected_color)
	Dibuja una barra vertical, con el área entre arriba/abajo coloreada de forma diferente.

Element	gauge (float progress)
	Dibuja una barra de progreso de alta definición.

Element	gaugeLeft (float progress)
	Dibuja una barra de progreso de alta definición que avanza de derecha a izquierda.

Element	gaugeRight (float progress)
	Dibuja una barra de progreso de alta definición que avanza de izquierda a derecha.

Element	gaugeUp (float progress)
	Dibuja una barra de progreso de alta definición que avanza de abajo hacia arriba.

Element	gaugeDown (float progress)
	Dibuja una barra de progreso de alta definición que avanza de arriba hacia abajo.

Element	gaugeDirection (float progress, Direction direction)
	Dibuja una barra de progreso de alta definición que avanza en la dirección especificada.

Element	border (Element child)
	Draw a border around the element.

Element	borderLight (Element child)
	Draw a light border around the element.

Element	borderDashed (Element child)
	Draw a dashed 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, BorderStyle border)
	Draw window with a title and a border around the element.

Element	spinner (int charset_index, size_t image_index)
	Útil para representar el efecto del tiempo y/o eventos. Esto muestra un "video" de arte ASCII.

Element	paragraph (const std::string &the_text)
	Devuelve un elemento que dibuja el párrafo en varias líneas.

Element	paragraphAlignLeft (const std::string &the_text)
	Devuelve un elemento que dibuja el párrafo en varias líneas, alineado a la izquierda.

Element	paragraphAlignRight (const std::string &the_text)
	Devuelve un elemento que dibuja el párrafo en varias líneas, alineado a la derecha.

Element	paragraphAlignCenter (const std::string &the_text)
	Devuelve un elemento que dibuja el párrafo en varias líneas, alineado al centro.

Element	paragraphAlignJustify (const std::string &the_text)
	Devuelve un elemento que dibuja el párrafo en varias líneas, alineado utilizando una alineación justificada.

Element	graph (GraphFunction graph_function)
	Dibuja un gráfico usando una GraphFunction.

Element	emptyElement ()

Element	canvas (ConstRef< Canvas >)

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

Element	canvas (std::function< void(Canvas &)>)

Element	bold (Element child)
	Utiliza una fuente en negrita, para elementos con más énfasis.

Element	dim (Element child)
	Usa una fuente clara para elementos con menos énfasis.

Element	italic (Element child)
	Aplica un subrayado doble al texto.

Element	inverted (Element child)
	Agrega un filtro que invertirá los colores de primer plano y de fondo. colores.

Element	underlined (Element child)
	Subraya el elemento dado.

Element	underlinedDouble (Element child)
	Aplica un doble subrayado al texto.

Element	blink (Element child)
	El texto dibujado alterna entre visible y oculto.

Element	strikethrough (Element child)
	Aplica un tachado al texto.

Decorator	color (Color c)
	Decora usando un color de primer plano.

Decorator	bgcolor (Color color)
	Decora usando un color de fondo.

Decorator	color (const LinearGradient &gradient)
	Decora usando un efecto de gradiente lineal en el color de primer plano.

Decorator	bgcolor (const LinearGradient &gradient)
	Decora usando un efecto de gradiente lineal en el color de fondo.

Element	color (Color color, Element child)
	Establece el color de primer plano de un elemento.

Element	bgcolor (Color color, Element child)
	Establece el color de fondo de un elemento.

Element	color (const LinearGradient &gradient, Element child)
	Establece el color de primer plano de un elemento con efecto de gradiente lineal.

Element	bgcolor (const LinearGradient &gradient, Element child)
	Establece el color de fondo de un elemento con efecto de gradiente lineal.

Decorator	focusPosition (int x, int y)
	Utilizado dentro de un `frame`, esto fuerza que la vista se desplace hacia una posición determinada. La posición se expresa en el número de celdas.

Decorator	focusPositionRelative (float x, float y)
	Utilizado dentro de un `frame`, esto fuerza que la vista se desplace hacia una posición determinada. La posición se expresa en proporción del tamaño solicitado.

Element	automerge (Element child)
	Permite que los caracteres se fusionen automáticamente con otros cercanos.

Decorator	hyperlink (std::string link)
	Decora usando un hipervínculo. El enlace se abrirá cuando el usuario haga clic en él. Esto solo es compatible con un conjunto limitado de emuladores de terminal. Lista: https://github.com/Alhadis/OSC8-Adoption/.

Element	hyperlink (std::string link, Element child)
	Hace que el área renderizada sea clicable usando un navegador web. El enlace se abrirá cuando el usuario haga clic en él. Esto solo es compatible con un conjunto limitado de emuladores de terminal. Lista: https://github.com/Alhadis/OSC8-Adoption/.

Element	selectionStyleReset (Element child)
	Restablece el estilo de selección de un elemento.

Decorator	selectionColor (Color foreground)
	Establece el color de un elemento cuando está seleccionado.

Decorator	selectionBackgroundColor (Color foreground)
	Establece el color de fondo de un elemento cuando está seleccionado. Tenga en cuenta que el estilo se aplica además del estilo existente.

Decorator	selectionForegroundColor (Color foreground)
	Establece el color de primer plano de un elemento cuando está seleccionado. Tenga en cuenta que el estilo se aplica además del estilo existente.

Decorator	selectionStyle (std::function< void(Pixel &)> style)
	Establece el estilo de un elemento cuando está seleccionado.

Element	hbox (Elements children)
	Un contenedor que muestra elementos horizontalmente uno por uno.

Element	vbox (Elements)

Element	dbox (Elements children_)
	Apila varios elementos uno encima del otro.

Element	flexbox (Elements children, FlexboxConfig config)
	Un contenedor que muestra elementos en filas/columnas y es capaz de ajustarse a la siguiente columna/fila cuando está lleno.

Element	gridbox (std::vector< Elements > lines)
	Un contenedor que muestra una cuadrícula de elementos.

Element	hflow (Elements children)
	Un contenedor que muestra elementos en filas de izquierda a derecha. Cuando está lleno, comienza en una nueva fila debajo.

Element	vflow (Elements children)
	Un contenedor que muestra elementos en filas de arriba a abajo. Cuando está lleno, comienza en una nueva columna a la derecha.

Element	flex (Element child)
	Hace que un elemento hijo se expanda proporcionalmente al espacio restante en un contenedor.

Element	flex_grow (Element child)
	Expandir si es posible.

Element	flex_shrink (Element child)
	Minimizar si es necesario.

Element	xflex (Element child)
	Expandir/Minimizar si es posible/necesario en el eje X.

Element	xflex_grow (Element child)
	Expandir si es posible en el eje X.

Element	xflex_shrink (Element child)
	Minimizar si es necesario en el eje X.

Element	yflex (Element child)
	Expandir/Minimizar si es posible/necesario en el eje Y.

Element	yflex_grow (Element child)
	Expandir si es posible en el eje Y.

Element	yflex_shrink (Element child)
	Minimizar si es necesario en el eje Y.

Element	notflex (Element child)
	Hace que el elemento no sea flexible.

Element	filler ()
	Un elemento que se expandirá proporcionalmente al espacio restante en un contenedor.

Decorator	size (WidthOrHeight direction, Constraint constraint, int value)
	Aplica una restricción al tamaño de un elemento.

Element	frame (Element child)
	Permite que un elemento se muestre dentro de un área 'virtual'. Su tamaño puede ser mayor que su contenedor. En este caso, solo se muestra una porción más pequeña. La vista es desplazable para hacer visible el elemento enfocado.

Element	xframe (Element child)
	Igual que `frame`, pero solo en el eje x.

Element	yframe (Element child)
	Igual que `frame`, pero solo en el eje y.

Element	focus (Element child)
	Establece que `child` sea el elemento enfocado entre sus hermanos.

Element	select (Element child)
	Establece que `child` sea el elemento enfocado entre sus hermanos.

Element	focusCursorBlock (Element child)
	Igual que `focus`, pero establece la forma del cursor como un bloque fijo.

Element	focusCursorBlockBlinking (Element child)
	Igual que `focus`, pero establece la forma del cursor como un bloque parpadeante.

Element	focusCursorBar (Element child)
	Igual que `focus`, pero establece la forma del cursor como un bloque fijo.

Element	focusCursorBarBlinking (Element child)
	Igual que `focus`, pero establece la forma del cursor como una barra parpadeante.

Element	focusCursorUnderline (Element child)
	Igual que `focus`, pero establece la forma del cursor como un subrayado fijo.

Element	focusCursorUnderlineBlinking (Element child)
	Igual que `focus`, pero establece la forma del cursor como un subrayado parpadeante.

Element	vscroll_indicator (Element child)
	Muestra una barra de desplazamiento vertical a la derecha. Los colores siguen el contenido.

Element	hscroll_indicator (Element child)
	Muestra una barra de desplazamiento horizontal en la parte inferior. Los colores siguen el contenido.

Decorator	reflect (Box &box)

Element	clear_under (Element element)
	Antes de dibujar \|child\|, limpia los píxeles de abajo. Esto es útil en combinación con dbox.

Element	hcenter (Element child)
	Centra un elemento horizontalmente.

Element	vcenter (Element child)
	Centra un elemento verticalmente.

Element	center (Element child)
	Centra un elemento horizontal y verticalmente.

Element	align_right (Element child)
	Alinea un elemento a la derecha.

Element	nothing (Element element)
	Una decoración que no hace absolutamente nada.

void	Render (Screen &screen, const Element &element)
	Muestra un elemento en un ftxui::Screen.

void	Render (Screen &screen, Node *node)
	Muestra un elemento en un ftxui::Screen.

void	Render (Screen &screen, Node *node, Selection &selection)

std::string	GetNodeSelectedContent (Screen &screen, Node *node, Selection &selection)

Color	operator""_rgb (unsigned long long int combined)
	Crea un color a partir de una representación RGB hexadecimal combinada, por ejemplo, 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)

std::wstring	to_wstring (const std::string &s)

template<typename T >
std::wstring	to_wstring (T s)

int	string_width (const std::string &)

std::vector< std::string >	Utf8ToGlyphs (const std::string &input)

std::vector< int >	CellToGlyphIndex (const std::string &input)

Component	CatchEvent (Component child, std::function< bool(Event event)> on_event)
	Retorna un componente, usando \|on_event\| para capturar eventos. Esta función debe retornar true cuando el evento ha sido manejado, false en caso contrario.

return	Animated (Color::Black, Color::GrayLight, Color::GrayDark, Color::White)
	Crea una ButtonOption, usando colores animados.

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

	DrawBlockEllipseFilled (x, y, r1, r2, nostyle)
	Dibuja una elipse rellena de caracteres de bloque.

bool	EatCodePoint (const std::string &input, size_t start, size_t end, uint32_t ucs)

bool	EatCodePoint (const std::wstring &input, size_t start, size_t end, uint32_t ucs)

bool	IsCombining (uint32_t ucs)

bool	IsFullWidth (uint32_t ucs)

bool	IsControl (uint32_t ucs)

WordBreakProperty	CodepointToWordBreakProperty (uint32_t codepoint)

	if (IsFullWidth(codepoint))

out	push_back (append)

size_t	GlyphPrevious (const std::string &input, size_t start)

size_t	GlyphNext (const std::string &input, size_t start)

size_t	GlyphIterate (const std::string &input, int glyph_offset, 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)

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

const std::array< ColorInfo, 256 >	palette256

Detailed Description

El espacio de nombres ftxui:: de FTXUI.

El espacio de nombres ftxui de FTXUI.

/

Typedef Documentation

◆ CapturedMouse

using CapturedMouse = std::unique_ptr<CapturedMouseInterface>

Definition at line 20 of file captured_mouse.hpp.

◆ ComponentDecorator

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

Definition at line 32 of file component.hpp.

◆ ElementDecorator

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

Definition at line 33 of file component.hpp.

◆ Component

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

Definition at line 24 of file component_base.hpp.

◆ Components

using Components = std::vector<Component>

Definition at line 25 of file component_base.hpp.

◆ Sender

template<class T >

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

Definition at line 52 of file receiver.hpp.

◆ Receiver

template<class T >

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

Definition at line 54 of file receiver.hpp.

◆ Closure

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

Definition at line 13 of file task.hpp.

◆ Task

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

Definition at line 14 of file task.hpp.

◆ Element

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

Definition at line 22 of file elements.hpp.

◆ Elements

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

Definition at line 23 of file elements.hpp.

◆ Decorator

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

Definition at line 24 of file elements.hpp.

◆ GraphFunction

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

Definition at line 25 of file elements.hpp.

Enumeration Type Documentation

◆ WidthOrHeight

enum WidthOrHeight

Enumerator
WIDTH
HEIGHT

Definition at line 161 of file elements.hpp.

◆ Constraint

enum Constraint

Enumerator
LESS_THAN
EQUAL
GREATER_THAN

Definition at line 162 of file elements.hpp.

◆ WordBreakProperty

enum class WordBreakProperty : int8_t

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 40 of file string_internal.hpp.

Function Documentation

◆ Make()

template<class T , class... Args>

std::shared_ptr< T > Make ( Args &&... args )

Definition at line 27 of file component.hpp.

◆ operator|() [1/2]

Component operator\|	(	Component	component,
		ComponentDecorator	decorator )

Definition at line 12 of file component/util.cpp.

◆ operator|() [2/2]

Component operator\|	(	Component	component,
		ElementDecorator	decorator )

Definition at line 17 of file component/util.cpp.

◆ operator|=() [1/2]

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

Definition at line 22 of file component/util.cpp.

◆ operator|=() [2/2]

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

Definition at line 28 of file component/util.cpp.

◆ Slider() [1/13]

template<typename T >

Component Slider ( SliderOption< T > options )

Un deslizador en cualquier dirección.

Parameters

options Las opciones

Ejemplo

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

Definition at line 316 of file src/ftxui/component/slider.cpp.

◆ Slider() [2/13]

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 273 of file src/ftxui/component/slider.cpp.

◆ Slider() [3/13]

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

Definition at line 286 of file src/ftxui/component/slider.cpp.

◆ ResizableSplit()

Component ResizableSplit ( ResizableSplitOption options )

Una división entre dos componentes.

Parameters

options todos los parámetros.

Ejemplo

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(); },
});

Salida

       ║
left   ║   right
       ║

Definition at line 170 of file src/ftxui/component/resizable_split.cpp.

◆ CatchEvent()

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

◆ Collapsible()

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

Un componente plegable. Muestra una casilla de verificación con una flecha. Una vez activado, se muestra el componente hijo.

Parameters

label	La etiqueta de la casilla de verificación.
child	El componente hijo a mostrar.
show	Mantiene el estado sobre si el componente hijo se muestra o no.

Ejemplo

auto component = Collapsible("Show details", details);

ftxui::Collapsible

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

Un componente plegable. Muestra una casilla de verificación con una flecha. Una vez activado,...

Definition src/ftxui/component/collapsible.cpp:33

Salida

▼ Show details

Definition at line 33 of file src/ftxui/component/collapsible.cpp.

◆ MakeReceiver()

template<class T >

Receiver< T > MakeReceiver ( )

Definition at line 149 of file receiver.hpp.

◆ paragraph()

Elements paragraph ( std::wstring text )

◆ separatorHSelector()

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

Dibuja una barra horizontal, con el área entre izquierda/derecha coloreada de forma diferente.

Parameters

left	el límite izquierdo del área activa.
right	el límite derecho del área activa.
selected_color	el color del área seleccionada.
unselected_color	el color del área no seleccionada.

Ejemplo

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

ftxui::Color::White

@ White

Definition color.hpp:68

ftxui::Color::Blue

@ Blue

Definition color.hpp:57

ftxui::Element

std::shared_ptr< Node > Element

Definition elements.hpp:22

ftxui::separatorHSelector

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

Dibuja una barra horizontal, con el área entre izquierda/derecha coloreada de forma diferente.

Definition src/ftxui/dom/separator.cpp:442

Definition at line 442 of file src/ftxui/dom/separator.cpp.

◆ separatorVSelector()

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

Dibuja una barra vertical, con el área entre arriba/abajo coloreada de forma diferente.

Parameters

up	el límite superior del área activa.
down	el límite inferior del área activa.
selected_color	el color del área seleccionada.
unselected_color	el color del área no seleccionada.

Ejemplo

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

Definition at line 512 of file src/ftxui/dom/separator.cpp.

◆ graph()

Element graph ( GraphFunction graph_function )

Dibuja un gráfico usando una GraphFunction.

Parameters

graph_function la función a ser llamada para obtener los datos.

Definition at line 71 of file src/ftxui/dom/graph.cpp.

◆ canvas() [1/3]

Element canvas ( ConstRef< Canvas > )

◆ canvas() [2/3]

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

◆ canvas() [3/3]

Element canvas ( std::function< void(Canvas &)> )

◆ selectionStyleReset()

Element selectionStyleReset ( Element child )

Restablece el estilo de selección de un elemento.

Parameters

child El elemento de entrada.

Returns: El elemento de salida con el estilo de selección restablecido.

Definition at line 55 of file selection_style.cpp.

◆ selectionColor()

Decorator selectionColor ( Color foreground )

Establece el color de un elemento cuando está seleccionado.

Parameters

foreground El color a aplicar. Tenga en cuenta que el estilo se aplica además del estilo existente.

Definition at line 78 of file selection_style.cpp.

◆ selectionBackgroundColor()

Decorator selectionBackgroundColor ( Color foreground )

Establece el color de fondo de un elemento cuando está seleccionado. Tenga en cuenta que el estilo se aplica además del estilo existente.

Definition at line 61 of file selection_style.cpp.

◆ selectionForegroundColor()

Decorator selectionForegroundColor ( Color foreground )

Establece el color de primer plano de un elemento cuando está seleccionado. Tenga en cuenta que el estilo se aplica además del estilo existente.

Definition at line 69 of file selection_style.cpp.

◆ selectionStyle()

Decorator selectionStyle ( std::function< void(Pixel &)> style )

Establece el estilo de un elemento cuando está seleccionado.

Parameters

style El estilo a aplicar. Tenga en cuenta que el estilo se aplica además del estilo existente.

Definition at line 86 of file selection_style.cpp.

◆ hbox()

Element hbox ( Elements children )

Un contenedor que muestra elementos horizontalmente uno por uno.

Parameters

children Los elementos en el contenedor

Returns: El contenedor.

Ejemplo

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

Definition at line 94 of file hbox.cpp.

◆ vbox()

Element vbox ( Elements )

◆ flexbox()

Element flexbox	(	Elements	children,
		FlexboxConfig	config )

Un contenedor que muestra elementos en filas/columnas y es capaz de ajustarse a la siguiente columna/fila cuando está lleno.

Parameters

children	Los elementos en el contenedor
config	La opción

Returns: El contenedor.

Ejemplo

flexbox({
  text("element 1"),
  text("element 2"),
  text("element 3"),
}, FlexboxConfig()
     .Set(FlexboxConfig::Direction::Column)
     .Set(FlexboxConfig::Wrap::WrapInversed)
     .SetGapMainAxis(1)
     .SetGapCrossAxis(1)
)

Definition at line 251 of file flexbox.cpp.

◆ gridbox()

Element gridbox ( std::vector< Elements > lines )

Un contenedor que muestra una cuadrícula de elementos.

Parameters

lines Una lista de líneas, cada línea siendo una lista de elementos.

Returns: El contenedor.

Ejemplo

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")} ,
});

Salida:

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

Definition at line 173 of file src/ftxui/dom/gridbox.cpp.

◆ hflow()

Element hflow ( Elements children )

Un contenedor que muestra elementos en filas de izquierda a derecha. Cuando está lleno, comienza en una nueva fila debajo.

Parameters

children Los elementos en el contenedor

Returns: El contenedor.

Ejemplo

hflow({
  text("element 1"),
  text("element 2"),
  text("element 3"),
});

Definition at line 269 of file flexbox.cpp.

◆ vflow()

Element vflow ( Elements children )

Un contenedor que muestra elementos en filas de arriba a abajo. Cuando está lleno, comienza en una nueva columna a la derecha.

Parameters

children Los elementos en el contenedor

Returns: El contenedor.

Ejemplo

vflow({
  text("element 1"),
  text("element 2"),
  text("element 3"),
});

Definition at line 287 of file flexbox.cpp.

◆ frame()

Element frame ( Element child )

Permite que un elemento se muestre dentro de un área 'virtual'. Su tamaño puede ser mayor que su contenedor. En este caso, solo se muestra una porción más pequeña. La vista es desplazable para hacer visible el elemento enfocado.

See also: frame; xframe; yframe

Definition at line 118 of file frame.cpp.

◆ xframe()

Element xframe ( Element child )

Igual que frame, pero solo en el eje x.

See also: frame; xframe; yframe

Definition at line 126 of file frame.cpp.

◆ yframe()

Element yframe ( Element child )

Igual que frame, pero solo en el eje y.

See also: frame; xframe; yframe

Definition at line 134 of file frame.cpp.

◆ select()

Element select ( Element child )

Establece que child sea el elemento enfocado entre sus hermanos.

Esto está obsoleto. Usa focus en su lugar.

Parameters

child El elemento a ser enfocado.

Definition at line 108 of file frame.cpp.

◆ reflect()

Decorator reflect ( Box & box )

Definition at line 43 of file reflect.cpp.

◆ Render()

void Render	(	Screen &	screen,
		Node *	node,
		Selection &	selection )

Definition at line 96 of file node.cpp.

◆ GetNodeSelectedContent()

std::string GetNodeSelectedContent	(	Screen &	screen,
		Node *	node,
		Selection &	selection )

Definition at line 168 of file node.cpp.

◆ GetColorInfo() [1/2]

ColorInfo GetColorInfo ( Color::Palette256 index )

Definition at line 272 of file color_info.cpp.

◆ GetColorInfo() [2/2]

ColorInfo GetColorInfo ( Color::Palette16 index )

Definition at line 276 of file color_info.cpp.

◆ wchar_width()

int wchar_width ( wchar_t ucs )

Definition at line 1322 of file string.cpp.

◆ wstring_width()

int wstring_width ( const std::wstring & text )

Definition at line 1326 of file string.cpp.

◆ to_string()

std::string to_string ( const std::wstring & s )

◆ to_wstring() [1/2]

std::wstring to_wstring ( const std::string & s )

◆ to_wstring() [2/2]

template<typename T >

std::wstring to_wstring ( T s )

Definition at line 15 of file string.hpp.

◆ string_width()

int string_width ( const std::string & input )

Definition at line 1339 of file string.cpp.

◆ Utf8ToGlyphs()

std::vector< std::string > Utf8ToGlyphs ( const std::string & input )

Definition at line 1366 of file string.cpp.

◆ CellToGlyphIndex()

std::vector< int > CellToGlyphIndex ( const std::string & input )

◆ Animated()

return Animated	(	Color::Black	,
		Color::GrayLight	,
		Color::GrayDark	,
		Color::White	)

Crea una ButtonOption, usando colores animados.

◆ Slider() [4/13]

template Component Slider ( SliderOption< int8_t > )

◆ Slider() [5/13]

template Component Slider ( SliderOption< int16_t > )

◆ Slider() [6/13]

template Component Slider ( SliderOption< int32_t > )

◆ Slider() [7/13]

template Component Slider ( SliderOption< int64_t > )

◆ Slider() [8/13]

template Component Slider ( SliderOption< uint8_t > )

◆ Slider() [9/13]

template Component Slider ( SliderOption< uint16_t > )

◆ Slider() [10/13]

template Component Slider ( SliderOption< uint32_t > )

◆ Slider() [11/13]

template Component Slider ( SliderOption< uint64_t > )

◆ Slider() [12/13]

template Component Slider ( SliderOption< float > )

◆ Slider() [13/13]

template Component Slider ( SliderOption< double > )

◆ DrawBlockEllipseFilled()

DrawBlockEllipseFilled	(	x	,
		y	,
		r1	,
		r2	,
		nostyle	)

Dibuja una elipse rellena de caracteres de bloque.

Parameters

x	el coordenada x del centro de la elipse.
y	el coordenada y del centro de la elipse.
r1	el radio de la elipse a lo largo del eje x.
r2	el radio de la elipse a lo largo del eje y.

◆ EatCodePoint() [1/2]

bool EatCodePoint	(	const std::string &	input,
		size_t	start,
		size_t *	end,
		uint32_t *	ucs )

Definition at line 1178 of file string.cpp.

◆ EatCodePoint() [2/2]

bool EatCodePoint	(	const std::wstring &	input,
		size_t	start,
		size_t *	end,
		uint32_t *	ucs )

Definition at line 1252 of file string.cpp.

◆ IsCombining()

bool IsCombining ( uint32_t ucs )

Definition at line 1290 of file string.cpp.

◆ IsFullWidth()

bool IsFullWidth ( uint32_t ucs )

Definition at line 1294 of file string.cpp.

◆ IsControl()

bool IsControl ( uint32_t ucs )

Definition at line 1302 of file string.cpp.

◆ CodepointToWordBreakProperty()

WordBreakProperty CodepointToWordBreakProperty ( uint32_t codepoint )

Definition at line 1316 of file string.cpp.

◆ if()

if ( IsFullWidth(codepoint) )

Definition at line 1390 of file string.cpp.

◆ push_back()

out push_back ( append )

◆ GlyphPrevious()

size_t GlyphPrevious	(	const std::string &	input,
		size_t	start )

◆ GlyphNext()

size_t GlyphNext	(	const std::string &	input,
		size_t	start )

◆ GlyphIterate()

size_t GlyphIterate	(	const std::string &	input,
		int	glyph_offset,
		size_t	start = 0 )

◆ GlyphCount()

int GlyphCount ( const std::string & input )

◆ Utf8ToWordBreakProperty()

std::vector< WordBreakProperty > Utf8ToWordBreakProperty ( const std::string & input )

◆ IsWordBreakingCharacter()

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

Variable Documentation

◆ g_uniformize

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

Definition at line 19 of file terminal_input_parser.cpp.

◆ palette256

const std::array<ColorInfo, 256> palette256

Definition at line 13 of file color_info.cpp.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ CapturedMouse

◆ ComponentDecorator

◆ ElementDecorator

◆ Component

◆ Components

◆ Sender

◆ Receiver

◆ Closure

◆ Task

◆ Element

◆ Elements

◆ Decorator

◆ GraphFunction

Enumeration Type Documentation

◆ WidthOrHeight

◆ Constraint

◆ WordBreakProperty

Function Documentation

◆ Make()

◆ operator|() [1/2]

◆ operator|() [2/2]

◆ operator|=() [1/2]

◆ operator|=() [2/2]

◆ Slider() [1/13]

Ejemplo

◆ Slider() [2/13]

◆ Slider() [3/13]

◆ ResizableSplit()

Ejemplo

Salida

◆ CatchEvent()

◆ Collapsible()

Ejemplo

Salida

◆ MakeReceiver()

◆ paragraph()

◆ separatorHSelector()

Ejemplo

◆ separatorVSelector()

Ejemplo

◆ graph()

◆ canvas() [1/3]

◆ canvas() [2/3]

◆ canvas() [3/3]

◆ selectionStyleReset()

◆ selectionColor()

◆ selectionBackgroundColor()

◆ selectionForegroundColor()

◆ selectionStyle()

◆ hbox()

Ejemplo

◆ vbox()

◆ flexbox()

Ejemplo

◆ gridbox()

Ejemplo

◆ hflow()

Ejemplo

◆ vflow()

Ejemplo

◆ frame()

◆ xframe()

◆ yframe()

◆ select()

◆ reflect()

◆ Render()

◆ GetNodeSelectedContent()

◆ GetColorInfo() [1/2]

◆ GetColorInfo() [2/2]

◆ wchar_width()

◆ wstring_width()

◆ to_string()