FTXUI 7.0.3
C++ functional terminal UI.
Loading...
Searching...
No Matches
ftxui/dom

Detailed Description

Por favor, consulta el tutorial del módulo ftxui/dom.

Enumerations

enum class  Direction : uint8_t {
  Up = 0 ,
  Down = 1 ,
  Left = 2 ,
  Right = 3
}
 Direction es una enumeración que representa las cuatro cardinales direcciones. More...
 
enum  BorderStyle : uint8_t {
  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...
 

Functions

struct FTXUI_EXPORT (DOM) Canvas
 Canvas es un búfer dibujable asociado con operaciones de dibujo.
 
Element automerge (Element child)
 Permite que los caracteres se fusionen automáticamente con otros cercanos.
 
Element blink (Element child)
 El texto dibujado alterna entre visible y oculto.
 
Element bold (Element child)
 Utiliza una fuente en negrita, para elementos con más énfasis.
 
Element border (Element child)
 Dibuja un borde alrededor del elemento.
 
Decorator borderWith (const Cell &pixel)
 Igual que border pero con un Cell constante alrededor del elemento.
 
Decorator borderStyled (BorderStyle style)
 Igual que border pero con estilos diferentes.
 
Decorator borderStyled (Color foreground_color)
 Igual que border pero con un color de primer plano.
 
Decorator borderStyled (BorderStyle style, Color foreground_color)
 Igual que border pero con un color de primer plano y un estilo diferente.
 
Element borderDashed (Element child)
 Dibuja un borde discontinuo alrededor del elemento.
 
Element borderLight (Element child)
 Dibuja un borde ligero alrededor del elemento.
 
Element borderHeavy (Element child)
 Dibuja un borde grueso alrededor del elemento.
 
Element borderDouble (Element child)
 Dibuja un borde doble alrededor del elemento.
 
Element borderRounded (Element child)
 Dibuja un borde redondeado alrededor del elemento.
 
Element borderEmpty (Element child)
 Dibuja un borde vacío alrededor del elemento.
 
Element window (Element title, Element content, BorderStyle border)
 Dibuja una ventana con un título y un borde alrededor del elemento.
 
Element clear_under (Element element)
 Antes de dibujar |child|, limpia las celdas debajo. Esto es útil en combinación con dbox.
 
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.
 
Decorator color (Color c)
 Decora usando un color de primer plano.
 
Decorator bgcolor (Color color)
 Decora usando un color de fondo.
 
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 dbox (Elements children_)
 Apila varios elementos uno encima de otro.
 
Element dim (Element child)
 Usa una fuente clara para elementos con menos énfasis.
 
Element filler ()
 Un elemento que se expandirá proporcionalmente al espacio restante en un contenedor.
 
Element flex (Element child)
 Hace que un elemento hijo se expanda proporcionalmente al espacio restante en un contenedor.
 
Element xflex (Element child)
 Expandir/Minimizar si es posible/necesario en el eje X.
 
Element yflex (Element child)
 Expandir/Minimizar si es posible/necesario en el eje Y.
 
Element flex_grow (Element child)
 Expandir si es posible.
 
Element xflex_grow (Element child)
 Expandir si es posible en el eje X.
 
Element yflex_grow (Element child)
 Expandir si es posible en el eje Y.
 
Element flex_shrink (Element child)
 Minimizar si es necesario.
 
Element xflex_shrink (Element child)
 Minimizar si es necesario en el eje X.
 
Element yflex_shrink (Element child)
 Minimizar si es necesario en el eje Y.
 
Element notflex (Element child)
 Hace que el elemento no sea flexible.
 
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.
 
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.
 
Element focus (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 gaugeDirection (float progress, Direction direction)
 Dibuja una barra de progreso de alta definición que avanza en la dirección especificada.
 
Element gaugeRight (float progress)
 Dibuja una barra de progreso de alta definición que avanza de izquierda a derecha.
 
Element gaugeLeft (float progress)
 Dibuja una barra de progreso de alta definición que avanza de derecha a izquierda.
 
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 gauge (float progress)
 Dibuja una barra de progreso de alta definición.
 
Element gaugeCharset (float progress, std::vector< std::string > charset, Direction direction)
 Dibuja una barra de progreso de alta definición usando un conjunto de caracteres personalizado.
 
Element hyperlink (std::string_view 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/.
 
Decorator hyperlink (std::string_view 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 inverted (Element child)
 Agrega un filtro que invertirá los colores de primer plano y de fondo. colores.
 
Element italic (Element child)
 Aplica un doble subrayado al texto.
 
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 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.
 
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.
 
Element paragraph (std::string_view the_text)
 Devuelve un elemento que dibuja el párrafo en varias líneas.
 
Element paragraphAlignLeft (std::string_view the_text)
 Devuelve un elemento que dibuja el párrafo en varias líneas, alineado a la izquierda.
 
Element paragraphAlignRight (std::string_view the_text)
 Devuelve un elemento que dibuja el párrafo en varias líneas, alineado a la derecha.
 
Element paragraphAlignCenter (std::string_view the_text)
 Devuelve un elemento que dibuja el párrafo en varias líneas, alineado al centro.
 
Element paragraphAlignJustify (std::string_view the_text)
 Devuelve un elemento que dibuja el párrafo en varias líneas, alineado utilizando una alineación justificada.
 
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.
 
Element separator ()
 Dibuja una separación vertical u horizontal entre otros dos elementos.
 
Element separatorStyled (BorderStyle style)
 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 separatorCharacter (std::string_view value)
 Dibuja una separación vertical u horizontal entre otros dos elementos.
 
Element separator (Cell pixel)
 Dibuja un separador entre dos elementos rellenado con un pixel dado.
 
Decorator size (WidthOrHeight direction, Constraint constraint, int value)
 Aplica una restricción al tamaño de un elemento.
 
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 strikethrough (Element child)
 Aplica un tachado al texto.
 
Element text (std::string_view text)
 Muestra un fragmento de texto Unicode codificado en UTF8.
 
Element text (std::wstring_view text)
 Muestra un fragmento de texto Unicode.
 
Element vtext (std::string_view text)
 Muestra un fragmento de texto Unicode verticalmente.
 
Element vtext (std::wstring_view text)
 Muestra un fragmento de texto Unicode verticalmente.
 
Element underlined (Element child)
 Subraya el elemento dado.
 
Element underlinedDouble (Element child)
 Aplica un doble subrayado al texto.
 
Element nothing (Element element)
 Una decoración que no hace absolutamente nada.
 
Decorator operator| (Decorator a, Decorator b)
 Compone dos decoradores en uno.
 
Elements operator| (Elements elements, Decorator decorator)
 A partir de un conjunto de elementos, aplica un decorador a cada elemento.
 
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.
 
Element emptyElement ()
 
Element vbox (Elements children)
 Un contenedor que muestra elementos verticalmente uno por uno.
 
void SetColorSupport (Color color)
 Anula el soporte de color del terminal en caso de que la autodetección falle.
 

Enumeration Type Documentation

◆ Direction

enum class Direction : uint8_t
strong

Direction es una enumeración que representa las cuatro cardinales direcciones.

Enumerator
Up 
Down 
Left 
Right 

Definition at line 15 of file direction.hpp.

◆ BorderStyle

enum BorderStyle : uint8_t

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.

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. Se utiliza para definir la apariencia visual de los bordes alrededor de los elementos, como ventanas, marcos o separadores.

Enumerator
LIGHT 
DASHED 
HEAVY 
DOUBLE 
ROUNDED 
EMPTY 

Definition at line 38 of file elements.hpp.

Function Documentation

◆ FTXUI_EXPORT()

class FTXUI_EXPORT ( DOM )

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

Table es una utilidad para dibujar tablas.

Representa una selección en una interfaz de usuario de terminal.

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

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

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

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

Canvas es un área dibujable que se puede utilizar para crear gráficos complejos. Soporta dibujar puntos, líneas, círculos, elipses, texto e imágenes usando caracteres braille, de bloque o normales.

Nota: Un terminal contiene celdas. Una celda es una unidad de:

  • Caracteres braille de 2x4 (1x1 píxel)
  • Caracteres de bloque de 2x2 (2x2 píxeles)
  • Caracteres normales de 2x4 (2x4 píxeles)

Debe multiplicar la coordenada x por 2 y la coordenada y por 4 para obtener la posición correcta en el terminal.

Permite especificar la dirección de los elementos flex, si deben ajustarse (wrap), cómo deben justificarse a lo largo del eje principal y cómo deben alinearse a lo largo del eje transversal. También incluye propiedades para los espacios entre los elementos flex en ambos ejes, principal y transversal. Esta estructura se utiliza para configurar el comportamiento de diseño de los contenedores flexbox en una interfaz de usuario de terminal.

Ejemplo:

LinearGradient()
.Angle(45)
.Stop(Color::Red, 0.0)
.Stop(Color::Green, 0.5)
.Stop(Color::Blue, 1.0);

También hay constructores abreviados:

LinearGradient(Color::Red, Color::Blue);
LinearGradient(45, Color::Red, Color::Blue);

Representa un único nodo en el modelo de objeto de documento (DOM) y proporciona la estructura básica para el diseño y la representación. Contiene métodos para calcular los requisitos de diseño, establecer las dimensiones del cuadro, seleccionar contenido, renderizar en la pantalla y verificar el estado del diseño. Típicamente contiene elementos hijos, que también son instancias de Node.

Se espera que los usuarios deriven de esta clase para crear elementos personalizados.

Una lista de elementos incorporados se puede encontrar en el archivo elements.hpp.

Especifica el tamaño mínimo requerido para dibujar completamente el elemento,

Selection es una clase que representa los dos puntos finales de una selección en una interfaz de usuario de terminal.

ejemplo

auto table = Table({
{"X", "Y"},
{"-1", "1"},
{"+0", "0"},
{"+1", "1"},
});
table.SelectAll().Border(LIGHT);
table.SelectRow(1).Border(DOUBLE);
table.SelectRow(1).SeparatorInternal(LIGHT);
std::move(table).Render();
@ DOUBLE
Definition elements.hpp:42
@ LIGHT
Definition elements.hpp:39

Esto establece el eje principal, definiendo así la dirección en la que los elementos flex se colocan en el contenedor flex. Flexbox es (aparte del ajuste) un concepto de diseño de una sola dirección. Piense en los elementos flex como si se dispusieran principalmente en filas horizontales o columnas verticales.

< Los elementos flex se distribuyen en una fila.

< Los elementos flex se distribuyen en una fila, pero en orden inverso.

< Los elementos flex se distribuyen en una columna.

< Los elementos flex se distribuyen en una columna, pero en orden inverso.

Por defecto, todos los elementos flex intentarán ajustarse en una sola línea. Puede cambiar eso y permitir que los elementos se ajusten según sea necesario con esta propiedad.

< Todos los elementos flex intentarán ajustarse en una sola línea.

< Los elementos flex se ajustarán en varias líneas.

< Los elementos flex se ajustarán en varias líneas, pero en orden inverso.

Esto define la alineación a lo largo del eje principal. Ayuda a distribuir el espacio libre sobrante cuando todos los elementos flex en una línea son inflexibles, o son flexibles pero han alcanzado su tamaño máximo. También ejerce cierto control sobre la alineación de los elementos cuando desbordan la línea.

Los elementos se alinean al inicio de la dirección del flexbox.

Los elementos se alinean al final de la dirección del flexbox.

Los elementos se centran a lo largo de la línea.

Los elementos se estiran para llenar la línea.

Los elementos se distribuyen uniformemente en la línea; el primer elemento está al

Los elementos se distribuyen uniformemente en la línea con igual espacio a su alrededor. Tenga en cuenta que visualmente los espacios no son iguales, ya que todos los elementos tienen el mismo espacio en ambos lados. El primer elemento tendrá una unidad de espacio contra el borde del contenedor, pero dos unidades de espacio entre el siguiente elemento porque ese siguiente elemento tiene su propio espaciado que se aplica.

Los elementos se distribuyen de manera que el espacio entre dos elementos (y el espacio a los bordes) sea igual.

Esto define el comportamiento predeterminado de cómo se disponen los elementos flex a lo largo del eje transversal en la línea actual. Piense en ello como la versión de justify-content para el eje transversal (perpendicular al eje principal).

< Los elementos se colocan al inicio del eje transversal.

< Los elementos se colocan al final del eje transversal.

< Los elementos se centran a lo largo del eje transversal.

< Los elementos se estiran para llenar el eje transversal.

< Los elementos se colocan al inicio del eje transversal.

< Los elementos se colocan al final del eje transversal.

< Los elementos se centran a lo largo del eje transversal.

< Los elementos se estiran para llenar el eje transversal.

< Los elementos se distribuyen uniformemente en el eje transversal.

< Los elementos se distribuyen uniformemente con igual espacio alrededor de cada línea.

< Los elementos se distribuyen uniformemente en el eje transversal con igual espacio a su alrededor.

Un "stop" es un color en una posición específica en el gradiente. La posición es un valor entre 0.0 y 1.0, donde 0.0 es el inicio del gradiente y 1.0 es el final del gradiente.

Esto establece el eje principal, definiendo así la dirección en la que los elementos flex se colocan en el contenedor flex. Flexbox es (aparte del ajuste) un concepto de diseño de una sola dirección. Piense en los elementos flex como si se dispusieran principalmente en filas horizontales o columnas verticales.

< Los elementos flex se distribuyen en una fila.

< Los elementos flex se distribuyen en una fila, pero en orden inverso.

< Los elementos flex se distribuyen en una columna.

< Los elementos flex se distribuyen en una columna, pero en orden inverso.

Por defecto, todos los elementos flex intentarán ajustarse en una sola línea. Puede cambiar eso y permitir que los elementos se ajusten según sea necesario con esta propiedad.

< Todos los elementos flex intentarán ajustarse en una sola línea.

< Los elementos flex se ajustarán en varias líneas.

< Los elementos flex se ajustarán en varias líneas, pero en orden inverso.

Esto define la alineación a lo largo del eje principal. Ayuda a distribuir el espacio libre sobrante cuando todos los elementos flex en una línea son inflexibles, o son flexibles pero han alcanzado su tamaño máximo. También ejerce cierto control sobre la alineación de los elementos cuando desbordan la línea.

Los elementos se alinean al inicio de la dirección del flexbox.

Los elementos se alinean al final de la dirección del flexbox.

Los elementos se centran a lo largo de la línea.

Los elementos se estiran para llenar la línea.

Los elementos se distribuyen uniformemente en la línea; el primer elemento está al

Los elementos se distribuyen uniformemente en la línea con igual espacio a su alrededor. Tenga en cuenta que visualmente los espacios no son iguales, ya que todos los elementos tienen el mismo espacio en ambos lados. El primer elemento tendrá una unidad de espacio contra el borde del contenedor, pero dos unidades de espacio entre el siguiente elemento porque ese siguiente elemento tiene su propio espaciado que se aplica.

Los elementos se distribuyen de manera que el espacio entre dos elementos (y el espacio a los bordes) sea igual.

Esto define el comportamiento predeterminado de cómo se disponen los elementos flex a lo largo del eje transversal en la línea actual. Piense en ello como la versión de justify-content para el eje transversal (perpendicular al eje principal).

< Los elementos se colocan al inicio del eje transversal.

< Los elementos se colocan al final del eje transversal.

< Los elementos se centran a lo largo del eje transversal.

< Los elementos se estiran para llenar el eje transversal.

< Los elementos se colocan al inicio del eje transversal.

< Los elementos se colocan al final del eje transversal.

< Los elementos se centran a lo largo del eje transversal.

< Los elementos se estiran para llenar el eje transversal.

< Los elementos se distribuyen uniformemente en el eje transversal.

< Los elementos se distribuyen uniformemente con igual espacio alrededor de cada línea.

< Los elementos se distribuyen uniformemente en el eje transversal con igual espacio a su alrededor.

Un "stop" es un color en una posición específica en el gradiente. La posición es un valor entre 0.0 y 1.0, donde 0.0 es el inicio del gradiente y 1.0 es el final del gradiente.

Definition at line 1 of file canvas.hpp.

◆ automerge()

Element automerge ( Element child)

Permite que los caracteres se fusionen automáticamente con otros cercanos.

Definition at line 17 of file automerge.cpp.

◆ blink()

Element blink ( Element child)

El texto dibujado alterna entre visible y oculto.

Definition at line 33 of file blink.cpp.

◆ bold()

Element bold ( Element child)

Utiliza una fuente en negrita, para elementos con más énfasis.

Definition at line 33 of file bold.cpp.

◆ border()

Element border ( Element child)

Dibuja un borde alrededor del elemento.

See also
border
borderLight
borderDashed
borderDouble
borderHeavy
borderEmpty
borderRounded
borderStyled
borderWith

Agrega un borde alrededor de un elemento

Ejemplo

// Usa 'border' como una función...
Element document = border(text("The element"));
// ...O como una 'tubería' (pipe).
Element document = text("The element") | border;
Element text(std::string_view text)
Muestra un fragmento de texto Unicode codificado en UTF8.
Element border(Element child)
Dibuja un borde alrededor del elemento.
std::shared_ptr< Node > Element
Definition elements.hpp:25

Salida

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

Definition at line 235 of file src/ftxui/dom/border.cpp.

◆ borderWith()

Decorator borderWith ( const Cell & pixel)

Igual que border pero con un Cell constante alrededor del elemento.

See also
border

Definition at line 242 of file src/ftxui/dom/border.cpp.

◆ borderStyled() [1/3]

Decorator borderStyled ( BorderStyle style)

Igual que border pero con estilos diferentes.

See also
border

Definition at line 251 of file src/ftxui/dom/border.cpp.

◆ borderStyled() [2/3]

Decorator borderStyled ( Color foreground_color)

Igual que border pero con un color de primer plano.

See also
border

Definition at line 260 of file src/ftxui/dom/border.cpp.

◆ borderStyled() [3/3]

Decorator borderStyled ( BorderStyle style,
Color foreground_color )

Igual que border pero con un color de primer plano y un estilo diferente.

See also
border

Definition at line 270 of file src/ftxui/dom/border.cpp.

◆ borderDashed()

Element borderDashed ( Element child)

Dibuja un borde discontinuo alrededor del elemento.

See also
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Agrega un borde alrededor de un elemento

Ejemplo

// Usa 'borderDash' como una función...
Element document = borderDash(text("The element"));
// ...O como una 'tubería' (pipe).
Element document = text("The element") | borderDAsh;

Salida

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

Definition at line 308 of file src/ftxui/dom/border.cpp.

◆ borderLight()

Element borderLight ( Element child)

Dibuja un borde ligero alrededor del elemento.

See also
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Agrega un borde alrededor de un elemento

Ejemplo

// Usa 'borderLight' como una función...
Element document = borderLight(text("The element"));
// ...O como una 'tubería' (pipe).
Element document = text("The element") | borderLight;
Element borderLight(Element child)
Dibuja un borde ligero alrededor del elemento.

Salida

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

Definition at line 343 of file src/ftxui/dom/border.cpp.

◆ borderHeavy()

Element borderHeavy ( Element child)

Dibuja un borde grueso alrededor del elemento.

See also
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Agrega un borde alrededor de un elemento

Ejemplo

// Usa 'borderHeavy' como una función...
Element document = borderHeavy(text("The element"));
// ...O como una 'tubería' (pipe).
Element document = text("The element") | borderHeavy;
Element borderHeavy(Element child)
Dibuja un borde grueso alrededor del elemento.

Salida

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

Definition at line 378 of file src/ftxui/dom/border.cpp.

◆ borderDouble()

Element borderDouble ( Element child)

Dibuja un borde doble alrededor del elemento.

See also
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Agrega un borde alrededor de un elemento

Ejemplo

// Usa 'borderDouble' como una función...
Element document = borderDouble(text("The element"));
// ...O como una 'tubería' (pipe).
Element document = text("The element") | borderDouble;
Element borderDouble(Element child)
Dibuja un borde doble alrededor del elemento.

Salida

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

Definition at line 413 of file src/ftxui/dom/border.cpp.

◆ borderRounded()

Element borderRounded ( Element child)

Dibuja un borde redondeado alrededor del elemento.

See also
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Agrega un borde alrededor de un elemento

Ejemplo

// Usa 'borderRounded' como una función...
Element document = borderRounded(text("The element"));
// ...O como una 'tubería' (pipe).
Element document = text("The element") | borderRounded;
Element borderRounded(Element child)
Dibuja un borde redondeado alrededor del elemento.

Salida

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

Definition at line 448 of file src/ftxui/dom/border.cpp.

◆ borderEmpty()

Element borderEmpty ( Element child)

Dibuja un borde vacío alrededor del elemento.

See also
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Agrega un borde alrededor de un elemento

Ejemplo

// Usa 'borderRounded' como una función...
Element document = borderRounded(text("The element"));
// ...O como una 'tubería' (pipe).
Element document = text("The element") | borderRounded;

Salida

The element

Definition at line 483 of file src/ftxui/dom/border.cpp.

◆ window()

Element window ( Element title,
Element content,
BorderStyle border )

Dibuja una ventana con un título y un borde alrededor del elemento.

Parameters
titleEl título de la ventana.
contentEl elemento a envolver.
borderEl estilo del borde. Por defecto es ROUNDED.
See also
border

Ejemplo

Element document = window(text("Title"),
text("content")
);
// Especificando el borde
Element document = window(text("Title"),
text("content"),
);
Element window(Element title, Element content, BorderStyle border=ROUNDED)
Dibuja una ventana con un título y un borde alrededor del elemento.
@ ROUNDED
Definition elements.hpp:43

Salida

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

Definition at line 515 of file src/ftxui/dom/border.cpp.

◆ clear_under()

Element clear_under ( Element element)

Antes de dibujar |child|, limpia las celdas debajo. Esto es útil en combinación con dbox.

See also
ftxui::dbox

Definition at line 38 of file clear_under.cpp.

◆ color() [1/4]

Element color ( Color color,
Element child )

Establece el color de primer plano de un elemento.

Parameters
colorEl color del elemento de salida.
childEl elemento de entrada.
Returns
El elemento de salida coloreado.

Ejemplo

Element document = color(Color::Green, text("Success")),
Element color(Color color, Element child)
Establece el color de primer plano de un elemento.
Definition dom/color.cpp:81

Definition at line 81 of file dom/color.cpp.

◆ bgcolor() [1/4]

Element bgcolor ( Color color,
Element child )

Establece el color de fondo de un elemento.

Parameters
colorEl color del elemento de salida.
childEl elemento de entrada.
Returns
El elemento de salida coloreado.

Ejemplo

Element document = bgcolor(Color::Green, text("Success")),
Element bgcolor(Color color, Element child)
Establece el color de fondo de un elemento.
Definition dom/color.cpp:96

Definition at line 96 of file dom/color.cpp.

◆ color() [2/4]

Decorator color ( Color c)

Decora usando un color de primer plano.

Parameters
cEl color de primer plano a aplicar.
Returns
El Decorator que aplica el color.

Ejemplo

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

Definition at line 110 of file dom/color.cpp.

◆ bgcolor() [2/4]

Decorator bgcolor ( Color color)

Decora usando un color de fondo.

Parameters
colorEl color de fondo a aplicar.
Returns
El Decorator que aplica el color.

Ejemplo

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

Definition at line 124 of file dom/color.cpp.

◆ hcenter()

Element hcenter ( Element child)

Centra un elemento horizontalmente.

Parameters
childEl elemento decorado.
Returns
El elemento centrado.

Definition at line 15 of file composite_decorator.cpp.

◆ vcenter()

Element vcenter ( Element child)

Centra un elemento verticalmente.

Parameters
childEl elemento decorado.
Returns
El elemento centrado.

Definition at line 23 of file composite_decorator.cpp.

◆ center()

Element center ( Element child)

Centra un elemento horizontal y verticalmente.

Parameters
childEl elemento decorado.
Returns
El elemento centrado.

Definition at line 31 of file composite_decorator.cpp.

◆ align_right()

Element align_right ( Element child)

Alinea un elemento a la derecha.

Parameters
childEl elemento decorado.
Returns
El elemento alineado a la derecha.

Definition at line 39 of file composite_decorator.cpp.

◆ dbox()

Element dbox ( Elements children_)

Apila varios elementos uno encima de otro.

Parameters
children_Los elementos de entrada.
Returns
El elemento alineado a la derecha.

Definition at line 59 of file src/ftxui/dom/dbox.cpp.

◆ dim()

Element dim ( Element child)

Usa una fuente clara para elementos con menos énfasis.

Definition at line 33 of file dim.cpp.

◆ filler()

Element filler ( )

Un elemento que se expandirá proporcionalmente al espacio restante en un contenedor.

Definition at line 70 of file flex.cpp.

◆ flex()

Element flex ( Element child)

Hace que un elemento hijo se expanda proporcionalmente al espacio restante en un contenedor.

Ejemplos:

text("left") | border ,
text("middle") | border | flex,
text("right") | border,
});
Element flex(Element child)
Hace que un elemento hijo se expanda proporcionalmente al espacio restante en un contenedor.
Definition flex.cpp:95
Element hbox(Elements children)
Un contenedor que muestra elementos horizontalmente uno por uno.
Definition hbox.cpp:94

Salida:

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

Definition at line 95 of file flex.cpp.

◆ xflex()

Element xflex ( Element child)

Expandir/Minimizar si es posible/necesario en el eje X.

Definition at line 101 of file flex.cpp.

◆ yflex()

Element yflex ( Element child)

Expandir/Minimizar si es posible/necesario en el eje Y.

Definition at line 107 of file flex.cpp.

◆ flex_grow()

Element flex_grow ( Element child)

Expandir si es posible.

Definition at line 113 of file flex.cpp.

◆ xflex_grow()

Element xflex_grow ( Element child)

Expandir si es posible en el eje X.

Definition at line 119 of file flex.cpp.

◆ yflex_grow()

Element yflex_grow ( Element child)

Expandir si es posible en el eje Y.

Definition at line 125 of file flex.cpp.

◆ flex_shrink()

Element flex_shrink ( Element child)

Minimizar si es necesario.

Definition at line 131 of file flex.cpp.

◆ xflex_shrink()

Element xflex_shrink ( Element child)

Minimizar si es necesario en el eje X.

Definition at line 137 of file flex.cpp.

◆ yflex_shrink()

Element yflex_shrink ( Element child)

Minimizar si es necesario en el eje Y.

Definition at line 143 of file flex.cpp.

◆ notflex()

Element notflex ( Element child)

Hace que el elemento no sea flexible.

Definition at line 149 of file flex.cpp.

◆ focusPositionRelative()

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.

Por ejemplo:

  • (0, 0) significa que la vista se desplaza hacia la parte superior izquierda.
  • (1, 0) significa que la vista se desplaza hacia la parte superior derecha.
  • (0, 1) significa que la vista se desplaza hacia la parte inferior izquierda.

Ejemplo

Element document = huge_document()
| frame;
Decorator focusPositionRelative(float x, float y)
Utilizado dentro de un frame, esto fuerza que la vista se desplace hacia una posición determinada....
Element frame(Element child)
Permite que un elemento se muestre dentro de un área 'virtual'. Su tamaño puede ser mayor que su cont...
Definition frame.cpp:118

Definition at line 30 of file src/ftxui/dom/focus.cpp.

◆ focusPosition()

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.

Ejemplo

Element document = huge_document()
| focusPosition(10, 10)
| frame;
Decorator focusPosition(int x, int y)
Utilizado dentro de un frame, esto fuerza que la vista se desplace hacia una posición determinada....

Definition at line 68 of file src/ftxui/dom/focus.cpp.

◆ focus()

Element focus ( Element child)

Establece que child sea el elemento enfocado entre sus hermanos.

Parameters
childEl elemento a ser enfocado.

Definition at line 101 of file frame.cpp.

◆ focusCursorBlock()

Element focusCursorBlock ( Element child)

Igual que focus, pero establece la forma del cursor como un bloque fijo.

See also
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Definition at line 147 of file frame.cpp.

◆ focusCursorBlockBlinking()

Element focusCursorBlockBlinking ( Element child)

Igual que focus, pero establece la forma del cursor como un bloque parpadeante.

See also
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Definition at line 161 of file frame.cpp.

◆ focusCursorBar()

Element focusCursorBar ( Element child)

Igual que focus, pero establece la forma del cursor como un bloque fijo.

See also
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Definition at line 175 of file frame.cpp.

◆ focusCursorBarBlinking()

Element focusCursorBarBlinking ( Element child)

Igual que focus, pero establece la forma del cursor como una barra parpadeante.

See also
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Definition at line 189 of file frame.cpp.

◆ focusCursorUnderline()

Element focusCursorUnderline ( Element child)

Igual que focus, pero establece la forma del cursor como un subrayado fijo.

See also
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Definition at line 203 of file frame.cpp.

◆ focusCursorUnderlineBlinking()

Element focusCursorUnderlineBlinking ( Element child)

Igual que focus, pero establece la forma del cursor como un subrayado parpadeante.

See also
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Definition at line 217 of file frame.cpp.

◆ gaugeDirection()

Element gaugeDirection ( float progress,
Direction direction )

Dibuja una barra de progreso de alta definición que avanza en la dirección especificada.

Parameters
progressLa proporción del área a rellenar. Pertenece a [0,1].
directionDirección de progresión de la barra de progreso.

Definition at line 203 of file src/ftxui/dom/gauge.cpp.

◆ gaugeRight()

Element gaugeRight ( float progress)

Dibuja una barra de progreso de alta definición que avanza de izquierda a derecha.

Parameters
progressLa proporción del área a rellenar. Pertenece a [0,1].

Ejemplo

Un medidor. Puede ser usado para representar una barra de progreso.

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

Output

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

Definition at line 225 of file src/ftxui/dom/gauge.cpp.

◆ gaugeLeft()

Element gaugeLeft ( float progress)

Dibuja una barra de progreso de alta definición que avanza de derecha a izquierda.

Parameters
progressLa proporción del área a rellenar. Pertenece a [0,1].

Ejemplo

Un medidor. Puede ser usado para representar una barra de progreso.

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

Output

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

Definition at line 247 of file src/ftxui/dom/gauge.cpp.

◆ gaugeUp()

Element gaugeUp ( float progress)

Dibuja una barra de progreso de alta definición que avanza de abajo hacia arriba.

Parameters
progressLa proporción del área a rellenar. Pertenece a [0,1].

Ejemplo

Un medidor. Puede ser usado para representar una barra de progreso.

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

Output

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

Definition at line 276 of file src/ftxui/dom/gauge.cpp.

◆ gaugeDown()

Element gaugeDown ( float progress)

Dibuja una barra de progreso de alta definición que avanza de arriba hacia abajo.

Parameters
progressLa proporción del área a rellenar. Pertenece a [0,1].

Ejemplo

Un medidor. Puede ser usado para representar una barra de progreso.

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

Output

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

Definition at line 305 of file src/ftxui/dom/gauge.cpp.

◆ gauge()

Element gauge ( float progress)

Dibuja una barra de progreso de alta definición.

Parameters
progressLa proporción del área a rellenar. Pertenece a [0,1].

Ejemplo

Un medidor. Puede ser usado para representar una barra de progreso.

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

Output

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

Definition at line 327 of file src/ftxui/dom/gauge.cpp.

◆ gaugeCharset()

Element gaugeCharset ( float progress,
std::vector< std::string > charset,
Direction direction )

Dibuja una barra de progreso de alta definición usando un conjunto de caracteres personalizado.

Parameters
progressLa proporción del área a rellenar. Pertenece a [0,1].
charsetGlifos desde "vacío" (índice 0) hasta "lleno" (último índice); un conjunto de 2 entradas da una barra plana sin sombreado.
directionDirección de progresión de las barras de progreso. Por defecto, Derecha.

Ejemplo

Una barra de progreso renderizada con un conjunto de caracteres personalizado en lugar de los caracteres de bloque predeterminados.

border(gaugeCharset(0.5, {".", "#"}))
Element gaugeCharset(float progress, std::vector< std::string > charset, Direction direction=Direction::Right)
Dibuja una barra de progreso de alta definición usando un conjunto de caracteres personalizado.

Salida

┌──────────────────────────────────────────────────────────────────────────┐
│#####################################.....................................│
└──────────────────────────────────────────────────────────────────────────┘

Definition at line 354 of file src/ftxui/dom/gauge.cpp.

◆ hyperlink() [1/2]

Element hyperlink ( std::string_view 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/.

Parameters
linkEl enlace
childEl elemento de entrada.
Returns
El elemento de salida con el enlace.

Ejemplo

Element document =
hyperlink("https://github.com/ArthurSonzogni/FTXUI", "link");
Element hyperlink(std::string_view link, Element child)
Hace que el área renderizada sea clicable usando un navegador web. El enlace se abrirá cuando el usua...
Definition hyperlink.cpp:52

Definition at line 52 of file hyperlink.cpp.

◆ hyperlink() [2/2]

Decorator hyperlink ( std::string_view 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/.

Parameters
linkEl enlace al que se redirigirá a los usuarios.
Returns
El Decorator que aplica el hipervínculo.

Ejemplo

Element document =
text("red") | hyperlink("https://github.com/Arthursonzogni/FTXUI");

Definition at line 71 of file hyperlink.cpp.

◆ inverted()

Element inverted ( Element child)

Agrega un filtro que invertirá los colores de primer plano y de fondo. colores.

Definition at line 34 of file inverted.cpp.

◆ italic()

Element italic ( Element child)

Aplica un doble subrayado al texto.

Definition at line 17 of file italic.cpp.

◆ color() [3/4]

Element color ( const LinearGradient & gradient,
Element child )

Establece el color de primer plano de un elemento con efecto de gradiente lineal.

Parameters
gradientEl efecto de gradiente que se aplicará al elemento de salida.
childEl elemento de entrada.
Returns
El elemento de salida coloreado.

Ejemplo

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

Definition at line 245 of file src/ftxui/dom/linear_gradient.cpp.

◆ bgcolor() [3/4]

Element bgcolor ( const LinearGradient & gradient,
Element child )

Establece el color de fondo de un elemento con efecto de gradiente lineal.

Parameters
gradientEl efecto de gradiente que se aplicará al elemento de salida.
childEl elemento de entrada.
Returns
El elemento de salida coloreado.

Ejemplo

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

Definition at line 261 of file src/ftxui/dom/linear_gradient.cpp.

◆ color() [4/4]

Decorator color ( const LinearGradient & gradient)

Decora usando un efecto de gradiente lineal en el color de primer plano.

Parameters
gradientEl efecto de gradiente que se aplicará al elemento de salida.
Returns
El Decorator que aplica el color.

Ejemplo

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

Definition at line 276 of file src/ftxui/dom/linear_gradient.cpp.

◆ bgcolor() [4/4]

Decorator bgcolor ( const LinearGradient & gradient)

Decora usando un efecto de gradiente lineal en el color de fondo.

Parameters
gradientEl efecto de gradiente que se aplicará al elemento de salida.
Returns
El Decorator que aplica el color.

Ejemplo

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

Definition at line 291 of file src/ftxui/dom/linear_gradient.cpp.

◆ Render() [1/2]

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

Muestra un elemento en un ftxui::Screen.

Definition at line 93 of file node.cpp.

◆ Render() [2/2]

void Render ( Screen & screen,
Node * node )

Muestra un elemento en un ftxui::Screen.

Definition at line 100 of file node.cpp.

◆ paragraph()

Element paragraph ( std::string_view the_text)

Devuelve un elemento que dibuja el párrafo en varias líneas.

See also
flexbox.

Definition at line 48 of file src/ftxui/dom/paragraph.cpp.

◆ paragraphAlignLeft()

Element paragraphAlignLeft ( std::string_view the_text)

Devuelve un elemento que dibuja el párrafo en varias líneas, alineado a la izquierda.

See also
flexbox.

Definition at line 56 of file src/ftxui/dom/paragraph.cpp.

◆ paragraphAlignRight()

Element paragraphAlignRight ( std::string_view the_text)

Devuelve un elemento que dibuja el párrafo en varias líneas, alineado a la derecha.

See also
flexbox.

Definition at line 67 of file src/ftxui/dom/paragraph.cpp.

◆ paragraphAlignCenter()

Element paragraphAlignCenter ( std::string_view the_text)

Devuelve un elemento que dibuja el párrafo en varias líneas, alineado al centro.

See also
flexbox.

Definition at line 79 of file src/ftxui/dom/paragraph.cpp.

◆ paragraphAlignJustify()

Element paragraphAlignJustify ( std::string_view the_text)

Devuelve un elemento que dibuja el párrafo en varias líneas, alineado utilizando una alineación justificada.

See also
flexbox.

Definition at line 91 of file src/ftxui/dom/paragraph.cpp.

◆ vscroll_indicator()

Element vscroll_indicator ( Element child)

Muestra una barra de desplazamiento vertical a la derecha. Los colores siguen el contenido.

Definition at line 21 of file scroll_indicator.cpp.

◆ hscroll_indicator()

Element hscroll_indicator ( Element child)

Muestra una barra de desplazamiento horizontal en la parte inferior. Los colores siguen el contenido.

Definition at line 76 of file scroll_indicator.cpp.

◆ separator() [1/2]

Element separator ( )

Dibuja una separación vertical u horizontal entre otros dos elementos.

See also
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Añade una separación visual entre dos elementos.

Ejemplo

// Use 'border' as a function...
Element document = vbox({
text("up"),
text("down"),
});
Element separator()
Dibuja una separación vertical u horizontal entre otros dos elementos.
Element vbox(Elements children)
Un contenedor que muestra elementos verticalmente uno por uno.
Definition vbox.cpp:96

Salida

up
────
down

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

◆ separatorStyled()

Element separatorStyled ( BorderStyle style)

Dibuja una separación vertical u horizontal entre otros dos elementos.

Parameters
styleel estilo del separador.
See also
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Añade una separación visual entre dos elementos.

Ejemplo

// Use 'border' as a function...
Element document = vbox({
text("up"),
text("down"),
});
Element separatorStyled(BorderStyle style)
Dibuja una separación vertical u horizontal entre otros dos elementos.

Salida

up
════
down

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

◆ separatorLight()

Element separatorLight ( )

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

See also
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Añade una separación visual entre dos elementos.

Ejemplo

// Use 'border' as a function...
Element document = vbox({
text("up"),
text("down"),
});
Element separatorLight()
Dibuja una separación vertical u horizontal entre otros dos elementos, usando el estilo LIGERO.

Salida

up
────
down

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

◆ separatorDashed()

Element separatorDashed ( )

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

See also
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Añade una separación visual entre dos elementos.

Ejemplo

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

Salida

up
╍╍╍╍
down

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

◆ separatorHeavy()

Element separatorHeavy ( )

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

See also
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Añade una separación visual entre dos elementos.

Ejemplo

// Use 'border' as a function...
Element document = vbox({
text("up"),
text("down"),
});
Element separatorHeavy()
Dibuja una separación vertical u horizontal entre otros dos elementos, usando el estilo GRUESO.

Salida

up
━━━━
down

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

◆ separatorDouble()

Element separatorDouble ( )

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

See also
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Añade una separación visual entre dos elementos.

Ejemplo

// Use 'border' as a function...
Element document = vbox({
text("up"),
text("down"),
});
Element separatorDouble()
Dibuja una separación vertical u horizontal entre otros dos elementos, usando el estilo DOBLE.

Salida

up
════
down

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

◆ separatorEmpty()

Element separatorEmpty ( )

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

See also
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Añade una separación visual entre dos elementos.

Ejemplo

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

Salida

up
down

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

◆ separatorCharacter()

Element separatorCharacter ( std::string_view value)

Dibuja una separación vertical u horizontal entre otros dos elementos.

Parameters
valueel carácter para rellenar el área del separador.
See also
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Añade una separación visual entre dos elementos.

Ejemplo

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

Salida

up
────
down

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

◆ separator() [2/2]

Element separator ( Cell pixel)

Dibuja un separador entre dos elementos rellenado con un pixel dado.

See also
separator
separatorLight
separatorDashed
separatorHeavy
separatorDouble
separatorStyled

Ejemplo

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

Salida

Up
Down

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

◆ size()

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

Aplica una restricción al tamaño de un elemento.

Parameters
directionSi el ANCHO o el ALTO del elemento debe ser restringido.
constraintEl tipo de restricción.
valueEl valor.

Definition at line 89 of file src/ftxui/dom/size.cpp.

◆ spinner()

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.

Parameters
charset_indexEl tipo de "video".
image_indexEl "cuadro" del video. Necesitas aumentarlo para cada "paso".

Definition at line 282 of file src/ftxui/dom/spinner.cpp.

◆ strikethrough()

Element strikethrough ( Element child)

Aplica un tachado al texto.

Definition at line 17 of file strikethrough.cpp.

◆ text() [1/2]

Element text ( std::string_view text)

Muestra un fragmento de texto Unicode codificado en UTF8.

See also
ftxui::to_wstring

Ejemplo

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

Salida

Hello world!

Definition at line 218 of file src/ftxui/dom/text.cpp.

◆ text() [2/2]

Element text ( std::wstring_view text)

Muestra un fragmento de texto Unicode.

See also
ftxui::to_wstring

Ejemplo

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

Salida

Hello world!

Definition at line 237 of file src/ftxui/dom/text.cpp.

◆ vtext() [1/2]

Element vtext ( std::string_view text)

Muestra un fragmento de texto Unicode verticalmente.

See also
ftxui::to_wstring

Ejemplo

Element document = vtext("Hello world!");
Element vtext(std::string_view text)
Muestra un fragmento de texto Unicode verticalmente.

Salida

H
e
l
l
o
w
o
r
l
d
!

Definition at line 267 of file src/ftxui/dom/text.cpp.

◆ vtext() [2/2]

Element vtext ( std::wstring_view text)

Muestra un fragmento de texto Unicode verticalmente.

See also
ftxui::to_wstring

Ejemplo

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

Salida

H
e
l
l
o
w
o
r
l
d
!

Definition at line 297 of file src/ftxui/dom/text.cpp.

◆ underlined()

Element underlined ( Element child)

Subraya el elemento dado.

Definition at line 33 of file underlined.cpp.

◆ underlinedDouble()

Element underlinedDouble ( Element child)

Aplica un doble subrayado al texto.

Definition at line 17 of file underlined_double.cpp.

◆ nothing()

Element nothing ( Element element)

Una decoración que no hace absolutamente nada.

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

◆ operator|() [1/3]

Decorator operator| ( Decorator a,
Decorator b )

Compone dos decoradores en uno.

Ejemplo

auto decorator = bold | blink;
Element blink(Element child)
El texto dibujado alterna entre visible y oculto.
Definition blink.cpp:33

Definition at line 40 of file dom/util.cpp.

◆ operator|() [2/3]

Elements operator| ( Elements elements,
Decorator decorator )

A partir de un conjunto de elementos, aplica un decorador a cada elemento.

Returns
el conjunto de elementos decorados.

Definition at line 48 of file dom/util.cpp.

◆ operator|() [3/3]

Element operator| ( Element element,
Decorator decorator )

A partir de un elemento, aplica un decorador.

Returns
el elemento decorado.

Ejemplo

Ambos son equivalentes:

bold(text("Hello"));
Element bold(Element child)
Utiliza una fuente en negrita, para elementos con más énfasis.
Definition bold.cpp:33
text("Hello") | bold;

Definition at line 70 of file dom/util.cpp.

◆ operator|=()

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

Aplica un decorador a un elemento.

Returns
el elemento decorado.

Ejemplo

Ambos son equivalentes:

auto element = text("Hello");
const Element & element
Definition node.hpp:95

Definition at line 85 of file dom/util.cpp.

◆ emptyElement()

Element emptyElement ( )

Un elemento de tamaño 0x0 que no dibuja nada.

Definition at line 140 of file dom/util.cpp.

◆ vbox()

Element vbox ( Elements children)

Un contenedor que muestra elementos verticalmente uno por uno.

Parameters
childrenLos elementos en el contenedor
Returns
El contenedor.

Ejemplo

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

Definition at line 96 of file vbox.cpp.

◆ SetColorSupport()

void SetColorSupport ( Color color)

Anula el soporte de color del terminal en caso de que la autodetección falle.

Definition at line 348 of file terminal.cpp.