Detailed Description

Veuillez consulter le tutoriel du module ftxui/dom.

Enumerations
enum class	Direction : uint8_t { Up = 0 , Down = 1 , Left = 2 , Right = 3 }
	Direction est une énumération qui représente les quatre directions cardinales. More...

enum	BorderStyle : uint8_t { LIGHT , DASHED , HEAVY , DOUBLE , ROUNDED , EMPTY }
	BorderStyle est une énumération qui représente les différents styles de bordures pouvant être appliqués aux éléments de l'interface utilisateur du terminal. More...

Functions
struct	FTXUI_EXPORT (DOM) Canvas
	Canvas est un tampon dessinable associé aux opérations de dessin.

Element	automerge (Element child)
	Permet aux caractères d'être fusionnés automatiquement avec d'autres à proximité.

Element	blink (Element child)
	Le texte affiché alterne entre visible et masqué.

Element	bold (Element child)
	Utilise une police en gras, pour les éléments avec plus d'emphase.

Element	border (Element child)
	Dessine une bordure autour de l'élément.

Decorator	borderWith (const Cell &pixel)
	Identique à border mais avec une Cell constante autour de l'élément.

Decorator	borderStyled (BorderStyle style)
	Identique à border mais avec différents styles.

Decorator	borderStyled (Color foreground_color)
	Identique à border mais avec une couleur de premier plan.

Decorator	borderStyled (BorderStyle style, Color foreground_color)
	Identique à border mais avec une couleur de premier plan et un style différent.

Element	borderDashed (Element child)
	Dessine une bordure en pointillés autour de l'élément.

Element	borderLight (Element child)
	Dessine une bordure fine autour de l'élément.

Element	borderHeavy (Element child)
	Dessine une bordure épaisse autour de l'élément.

Element	borderDouble (Element child)
	Dessine une double bordure autour de l'élément.

Element	borderRounded (Element child)
	Dessine une bordure arrondie autour de l'élément.

Element	borderEmpty (Element child)
	Dessine une bordure vide autour de l'élément.

Element	window (Element title, Element content, BorderStyle border)
	Dessine une fenêtre avec un titre et une bordure autour de l'élément.

Element	clear_under (Element element)
	Avant de dessiner \|child\|, efface les cellules en dessous. Ceci est utile en combinaison avec dbox.

Element	color (Color color, Element child)
	Définit la couleur de premier plan d'un élément.

Element	bgcolor (Color color, Element child)
	Définit la couleur d'arrière-plan d'un élément.

Decorator	color (Color c)
	Décore en utilisant une couleur de premier plan.

Decorator	bgcolor (Color color)
	Décore en utilisant une couleur d'arrière-plan.

Element	hcenter (Element child)
	Centre un élément horizontalement.

Element	vcenter (Element child)
	Centre un élément verticalement.

Element	center (Element child)
	Centre un élément horizontalement et verticalement.

Element	align_right (Element child)
	Aligne un élément sur le côté droit.

Element	dbox (Elements children_)
	Empile plusieurs éléments les uns sur les autres.

Element	dim (Element child)
	Utilise une police de caractères claire, pour les éléments moins mis en valeur.

Element	filler ()
	Un élément qui s'étendra proportionnellement à l'espace restant dans un conteneur.

Element	flex (Element child)
	Permet à un élément enfant de s'étendre proportionnellement à l'espace restant dans un conteneur.

Element	xflex (Element child)
	Développer/Réduire si possible/nécessaire sur l'axe X.

Element	yflex (Element child)
	Développer/Réduire si possible/nécessaire sur l'axe Y.

Element	flex_grow (Element child)
	S'étend si possible.

Element	xflex_grow (Element child)
	S'étend si possible sur l'axe X.

Element	yflex_grow (Element child)
	S'étend si possible sur l'axe Y.

Element	flex_shrink (Element child)
	Minimiser si nécessaire.

Element	xflex_shrink (Element child)
	Minimiser si nécessaire sur l'axe X.

Element	yflex_shrink (Element child)
	Minimiser si nécessaire sur l'axe Y.

Element	notflex (Element child)
	Rend l'élément non flexible.

Decorator	focusPositionRelative (float x, float y)
	Utilisé à l'intérieur d'un `frame`, cela force la vue à être défilée vers une position donnée. La position est exprimée en proportion de la taille demandée.

Decorator	focusPosition (int x, int y)
	Utilisé à l'intérieur d'un `frame`, cela force la vue à être défilée vers une position donnée. La position est exprimée en nombre de cellules.

Element	focus (Element child)
	Définit l'élément `child` comme étant celui qui est focalisé parmi ses frères.

Element	focusCursorBlock (Element child)
	Identique à `focus`, mais définit la forme du curseur comme un bloc fixe.

Element	focusCursorBlockBlinking (Element child)
	Identique à `focus`, mais définit la forme du curseur comme un bloc clignotant.

Element	focusCursorBar (Element child)
	Identique à `focus`, mais définit la forme du curseur comme un bloc fixe.

Element	focusCursorBarBlinking (Element child)
	Identique à `focus`, mais définit la forme du curseur comme une barre clignotante.

Element	focusCursorUnderline (Element child)
	Identique à `focus`, mais définit la forme du curseur comme un soulignement fixe.

Element	focusCursorUnderlineBlinking (Element child)
	Identique à `focus`, mais définit la forme du curseur comme un soulignement clignotant.

Element	gaugeDirection (float progress, Direction direction)
	Dessine une barre de progression haute définition progressant dans la direction spécifiée.

Element	gaugeRight (float progress)
	Dessine une barre de progression en haute définition progressant de gauche à droite.

Element	gaugeLeft (float progress)
	Dessine une barre de progression en haute définition progressant de droite à gauche.

Element	gaugeUp (float progress)
	Dessine une barre de progression en haute définition progressant de bas en haut.

Element	gaugeDown (float progress)
	Dessine une barre de progression haute définition progressant de haut en bas.

Element	gauge (float progress)
	Dessine une barre de progression haute définition.

Element	gaugeCharset (float progress, std::vector< std::string > charset, Direction direction)
	Dessine une barre de progression haute définition en utilisant un jeu de caractères personnalisé.

Element	hyperlink (std::string_view link, Element child)
	Rend la zone affichée cliquable à l'aide d'un navigateur web. Le lien sera ouvert lorsque l'utilisateur cliquera dessus. Ceci n'est pris en charge que par un ensemble limité d'émulateurs de terminal. Liste: https://github.com/Alhadis/OSC8-Adoption/.

Decorator	hyperlink (std::string_view link)
	Décore avec un hyperlien. Le lien sera ouvert lorsque l'utilisateur cliquera dessus. Ceci n'est pris en charge que par un ensemble limité d'émulateurs de terminal. Liste: https://github.com/Alhadis/OSC8-Adoption/.

Element	inverted (Element child)
	Ajoute un filtre qui inversera les couleurs de premier plan et d'arrière-plan.

Element	italic (Element child)
	Applique un double soulignement au texte.

Element	color (const LinearGradient &gradient, Element child)
	Définit la couleur de premier plan d'un élément avec un effet de dégradé linéaire.

Element	bgcolor (const LinearGradient &gradient, Element child)
	Définit la couleur de fond d'un élément avec un effet de dégradé linéaire.

Decorator	color (const LinearGradient &gradient)
	Décore en utilisant un effet de dégradé linéaire sur la couleur de premier plan.

Decorator	bgcolor (const LinearGradient &gradient)
	Décore en utilisant un effet de dégradé linéaire sur la couleur de fond.

void	Render (Screen &screen, const Element &element)
	Affiche un élément sur un ftxui::Screen.

void	Render (Screen &screen, Node *node)
	Affiche un élément sur un ftxui::Screen.

Element	paragraph (std::string_view the_text)
	Renvoie un élément affichant le paragraphe sur plusieurs lignes.

Element	paragraphAlignLeft (std::string_view the_text)
	Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné à gauche.

Element	paragraphAlignRight (std::string_view the_text)
	Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné à droite.

Element	paragraphAlignCenter (std::string_view the_text)
	Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné au centre.

Element	paragraphAlignJustify (std::string_view the_text)
	Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné en utilisant un alignement justifié.

Element	vscroll_indicator (Element child)
	Affiche une barre de défilement verticale à droite. Les couleurs suivent le contenu.

Element	hscroll_indicator (Element child)
	Affiche une barre de défilement horizontale en bas. Les couleurs suivent le contenu.

Element	separator ()
	Dessine une séparation verticale ou horizontale entre deux autres éléments.

Element	separatorStyled (BorderStyle style)
	Dessine une séparation verticale ou horizontale entre deux autres éléments.

Element	separatorLight ()
	Dessine une séparation verticale ou horizontale entre deux autres éléments, en utilisant le style LIGHT.

Element	separatorDashed ()
	Dessine une séparation verticale ou horizontale entre deux autres éléments, en utilisant le style DASHED.

Element	separatorHeavy ()
	Dessine une séparation verticale ou horizontale entre deux autres éléments, en utilisant le style HEAVY.

Element	separatorDouble ()
	Dessine une séparation verticale ou horizontale entre deux autres éléments, en utilisant le style DOUBLE.

Element	separatorEmpty ()
	Dessine une séparation verticale ou horizontale entre deux autres éléments, en utilisant le style EMPTY.

Element	separatorCharacter (std::string_view value)
	Dessine une séparation verticale ou horizontale entre deux autres éléments.

Element	separator (Cell pixel)
	Dessine un séparateur entre deux éléments remplis avec un pixel donné.

Decorator	size (WidthOrHeight direction, Constraint constraint, int value)
	Applique une contrainte sur la taille d'un élément.

Element	spinner (int charset_index, size_t image_index)
	Utile pour représenter l'effet du temps et/ou des événements. Cela affiche une "vidéo" en art ASCII.

Element	strikethrough (Element child)
	Applique un barré au texte.

Element	text (std::string_view text)
	Affiche un morceau de texte unicode encodé en UTF8.

Element	text (std::wstring_view text)
	Affiche un morceau de texte unicode.

Element	vtext (std::string_view text)
	Affiche un morceau de texte unicode verticalement.

Element	vtext (std::wstring_view text)
	Affiche un morceau de texte unicode verticalement.

Element	underlined (Element child)
	Souligne l'élément donné.

Element	underlinedDouble (Element child)
	Applique un double soulignement au texte.

Element	nothing (Element element)
	Une décoration qui ne fait absolument rien.

Decorator	operator\| (Decorator a, Decorator b)
	Compose deux décorateurs en un seul.

Elements	operator\| (Elements elements, Decorator decorator)
	À partir d'un ensemble d'éléments, applique un décorateur à chaque élément.

Element	operator\| (Element element, Decorator decorator)
	À partir d'un élément, applique un décorateur.

Element &	operator\|= (Element &e, Decorator d)
	Applique un décorateur à un élément.

Element	emptyElement ()

Element	vbox (Elements children)
	Un conteneur affichant les éléments verticalement un par un.

void	SetColorSupport (Color color)
	Outrepasser le support couleur du terminal en cas d'échec de la détection automatique.

Enumeration Type Documentation

◆ Direction

enum class Direction : uint8_t

strong

Direction est une énumération qui représente les quatre directions cardinales.

Enumerator
Up
Down
Left
Right

Definition at line 15 of file direction.hpp.

◆ BorderStyle

enum BorderStyle : uint8_t

BorderStyle est une énumération qui représente les différents styles de bordures pouvant être appliqués aux éléments de l'interface utilisateur du terminal.

BorderStyle est une énumération qui représente les différents styles de bordures pouvant être appliqués aux éléments de l'interface utilisateur du terminal. Il est utilisé pour définir l'apparence visuelle des bordures autour des éléments, tels que les fenêtres, les cadres ou les séparateurs.

Enumerator
LIGHT
DASHED
HEAVY
DOUBLE
ROUNDED
EMPTY

Definition at line 38 of file elements.hpp.

Function Documentation

◆ FTXUI_EXPORT()

class FTXUI_EXPORT ( DOM )

Canvas est un tampon dessinable associé aux opérations de dessin.

Table est un utilitaire pour dessiner des tableaux.

Représente une sélection dans une interface utilisateur de terminal.

Requirement est une structure qui définit les exigences de mise en page pour un Nœud dans l'interface utilisateur du terminal.

Node est la classe de base pour tous les éléments de l'arbre DOM.

Une classe représentant les paramètres de l'effet de couleur en dégradé linéaire.

FlexboxConfig est une structure de configuration qui définit les propriétés de mise en page pour un conteneur flexbox.

Canvas est une zone de dessin qui peut être utilisée pour créer des graphiques complexes. Il prend en charge le dessin de points, de lignes, de cercles, d'ellipses, de texte et d'images à l'aide de caractères braille, de blocs ou de caractères normaux.

Note: Un terminal contient des cellules. Une cellule est une unité de:

caractères braille 2x4 (1x1 pixel)
caractères de bloc 2x2 (2x2 pixels)
caractères normaux 2x4 (2x4 pixels)

Vous devez multiplier la coordonnée x par 2 et la coordonnée y par 4 pour obtenir la position correcte dans le terminal.

Elle vous permet de spécifier la direction des éléments flexibles, s'ils doivent s'enrouler, comment ils doivent être justifiés le long de l'axe principal, et comment ils doivent être alignés le long de l'axe transversal. Elle inclut également des propriétés pour les espacements entre les éléments flexibles dans les deux axes principal et transversal. Cette structure est utilisée pour configurer le comportement de la mise en page des conteneurs flexbox dans une interface utilisateur de terminal.

Exemple:

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

Il existe aussi des constructeurs raccourcis:

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

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

Il représente un nœud unique dans le modèle d'objet de document (DOM) et fournit la structure de base pour la mise en page et le rendu. Il contient des méthodes pour calculer les exigences de mise en page, définir les dimensions de la boîte, sélectionner le contenu, rendre à l'écran et vérifier l'état de la mise en page. Il contient généralement des éléments enfants, qui sont également des instances de Node.

Les utilisateurs sont censés dériver de cette classe pour créer des éléments personnalisés.

Une liste des éléments intégrés peut être trouvée dans le fichier elements.hpp.

Elle spécifie la taille minimale requise pour dessiner entièrement l'élément,

Selection est une classe qui représente les deux extrémités d'une sélection dans une interface utilisateur de terminal.

exemple

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

Ceci établit l'axe principal, définissant ainsi la direction dans laquelle les éléments flexibles sont placés dans le conteneur flex. Flexbox est (à part l'enveloppement) un concept de mise en page unidirectionnel. Pensez aux éléments flexibles comme étant principalement disposés en rangées horizontales ou en colonnes verticales.

< Les éléments flexibles sont disposés en ligne.

< Les éléments flexibles sont disposés en ligne, mais en ordre inverse.

< Les éléments flexibles sont disposés en colonne.

< Les éléments flexibles sont disposés en colonne, mais en ordre inverse.

Par défaut, tous les éléments flexibles tenteront de tenir sur une seule ligne. Vous pouvez modifier cela et permettre aux éléments de s'enrouler si nécessaire avec cette propriété.

< Tous les éléments flexibles tenteront de tenir sur une seule ligne.

< Les éléments flexibles s'enrouleront sur plusieurs lignes.

< Les éléments flexibles s'enrouleront sur plusieurs lignes, mais en ordre inverse.

Ceci définit l'alignement le long de l'axe principal. Il aide à distribuer l'espace libre supplémentaire restant lorsque tous les éléments flexibles sur une ligne sont inflexibles, ou sont flexibles mais ont atteint leur

taille maximale. Il exerce également un certain contrôle sur l'alignement des éléments lorsqu'ils débordent de la ligne.

Les éléments sont alignés au début de la direction du flexbox.

Les éléments sont alignés à la fin de la direction du flexbox.

Les éléments sont centrés le long de la ligne.

Les éléments sont étirés pour remplir la ligne.

Les éléments sont répartis uniformément sur la ligne ; le premier élément est sur la ligne de début, le dernier élément sur la ligne de fin.

Les éléments sont répartis uniformément sur la ligne avec un espace égal autour d'eux. Notez que visuellement les espaces ne sont pas égaux, car tous les éléments ont un espace égal des deux côtés. Le premier élément aura une unité d'espace contre le bord du conteneur, mais deux unités d'espace entre le prochain élément car cet élément a son propre espacement qui s'applique.

Les éléments sont répartis de sorte que l'espacement entre deux éléments (et l'espace jusqu'aux bords) soit égal.

Ceci définit le comportement par défaut de la disposition des éléments flexibles le long de l'axe transversal sur la ligne actuelle. Considérez-le comme la version de justify-content pour l'axe transversal (perpendiculaire à l'axe principal).

< Les éléments sont placés au début de l'axe transversal.

< Les éléments sont placés à la fin de l'axe transversal.

< Les éléments sont centrés le long de l'axe transversal.

< Les éléments sont étirés pour remplir l'axe transversal.

< Les éléments sont placés au début de l'axe transversal.

< Les éléments sont placés à la fin de l'axe transversal.

< Les éléments sont centrés le long de l'axe transversal.

< Les éléments sont étirés pour remplir l'axe transversal.

< Les éléments sont répartis uniformément dans l'axe transversal.

< Les éléments sont répartis uniformément avec un espace égal autour de chaque ligne.

< Les éléments sont répartis uniformément dans l'axe transversal avec un espace égal autour d'eux.

Un "stop" est une couleur à une position spécifique dans le dégradé. La position est une valeur entre 0.0 et 1.0, où 0.0 est le début du dégradé et 1.0 est la fin du dégradé.