Référence du fichier elements.hpp

Aller au code source de ce fichier.

Espaces de nommage
namespace	ftxui
	L'espace de noms FTXUI ftxui::
namespace	ftxui::Dimension
	Définit l'apparence des dimensions de l'écran.

Définitions de type
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)>

Énumérations
enum	BorderStyle {   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. Plus de détails...
enum	WidthOrHeight {   WIDTH ,   HEIGHT }
enum	Constraint {   LESS_THAN ,   EQUAL ,   GREATER_THAN }

Fonctions
Element &	operator|= (Element &e, Decorator d)
	Applique un décorateur à un élément.
Elements	operator| (Elements, Decorator)
Decorator	operator| (Decorator a, Decorator b)
	Compose deux décorateurs en un seul.
Element	text (std::string text)
	Affiche un morceau de texte unicode encodé en UTF8.
Element	vtext (std::string text)
	Affiche un morceau de texte unicode verticalement.
Element	separator ()
	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	separatorStyled (BorderStyle style)
	Dessine une séparation verticale ou horizontale entre deux autres éléments.
Element	separator (Pixel pixel)
	Dessine un séparateur entre deux éléments remplis avec un pixel donné.
Element	separatorCharacter (std::string value)
	Dessine une séparation verticale ou horizontale entre deux autres éléments.
Element	separatorHSelector (float left, float right, Color unselected_color, Color selected_color)
	Dessine une barre horizontale, avec la zone entre la gauche et la droite colorée différemment.
Element	separatorVSelector (float up, float down, Color unselected_color, Color selected_color)
	Dessine une barre verticale, avec la zone entre le haut et le bas colorée différemment.
Element	gauge (float progress)
Element	gaugeLeft (float progress)
Element	gaugeRight (float progress)
Element	gaugeUp (float progress)
Element	gaugeDown (float progress)
Element	gaugeDirection (float progress, Direction direction)
Element	border (Element child)
	Dessine une bordure autour de l'élément.
Element	borderLight (Element child)
	Dessine une bordure fine autour de l'élément.
Element	borderDashed (Element child)
	Dessine une bordure en pointillés 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.
Decorator	borderStyled (BorderStyle style)
	Identique à border mais avec différents styles.
Decorator	borderStyled (BorderStyle style, Color foreground_color)
	Identique à border mais avec une couleur de premier plan et un style différent.
Decorator	borderStyled (Color foreground_color)
	Identique à border mais avec une couleur de premier plan.
Decorator	borderWith (const Pixel &pixel)
	Identique à border mais avec un Pixel constant 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	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	paragraph (const std::string &the_text)
	Renvoie un élément affichant le paragraphe sur plusieurs lignes.
Element	paragraphAlignLeft (const std::string &the_text)
	Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné à gauche.
Element	paragraphAlignRight (const std::string &the_text)
	Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné à droite.
Element	paragraphAlignCenter (const std::string &the_text)
	Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné au centre.
Element	paragraphAlignJustify (const std::string &the_text)
	Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné en utilisant un alignement justifié.
Element	graph (GraphFunction graph_function)
	Dessine un graphique en utilisant une GraphFunction.
Element	emptyElement ()
Element	canvas (ConstRef< Canvas > canvas)
	Produit un élément à partir d'un Canevas, ou une référence à un Canevas.
Element	canvas (int width, int height, std::function< void(Canvas &)> fn)
	Produit un élément dessinant un canevas de la taille demandée.
Element	canvas (std::function< void(Canvas &)> fn)
	Produit un élément dessinant un canevas.
Element	bold (Element child)
	Utilise une police en gras, pour les éléments avec plus d'emphase.
Element	dim (Element child)
	Utilise une police de caractères claire, pour les éléments moins mis en valeur.
Element	italic (Element child)
	Applique un style italique au texte.
Element	inverted (Element child)
	Ajoute un filtre qui inversera les couleurs de premier plan et d'arrière-plan.
Element	underlined (Element child)
	Souligne l'élément donné.
Element	underlinedDouble (Element child)
	Applique un double soulignement au texte.
Element	blink (Element child)
	Le texte affiché alterne entre visible et masqué.
Element	strikethrough (Element child)
	Applique un barré au texte.
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.
Decorator	color (const LinearGradient &)
Decorator	bgcolor (const LinearGradient &)
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.
Element	color (const LinearGradient &, Element)
Element	bgcolor (const LinearGradient &, Element)
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.
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.
Element	automerge (Element child)
	Permet aux caractères d'être fusionnés automatiquement avec d'autres à proximité.
Decorator	hyperlink (std::string link)
Element	hyperlink (std::string link, Element child)
Element	selectionStyleReset (Element child)
	Réinitialise le style de sélection d'un élément.
Decorator	selectionColor (Color foreground)
	Définit la couleur d'un élément lorsqu'il est sélectionné.
Decorator	selectionBackgroundColor (Color foreground)
	Définit la couleur d'arrière-plan d'un élément lorsqu'il est sélectionné. Notez que le style est appliqué en plus du style existant.
Decorator	selectionForegroundColor (Color foreground)
	Définit la couleur de premier plan d'un élément lorsqu'il est sélectionné. Notez que le style est appliqué en plus du style existant.
Decorator	selectionStyle (std::function< void(Pixel &)> style)
	Définit le style d'un élément lorsqu'il est sélectionné.
Element	hbox (Elements children)
	Un conteneur affichant les éléments horizontalement un par un.
Element	vbox (Elements children)
	Un conteneur affichant les éléments verticalement un par un.
Element	dbox (Elements children_)
	Empile plusieurs éléments les uns sur les autres.
Element	flexbox (Elements children, FlexboxConfig config)
	Un conteneur affichant des éléments sur des lignes/colonnes et capable de passer à la colonne/ligne suivante lorsqu'il est plein.
Element	gridbox (std::vector< Elements > lines)
	Un conteneur affichant une grille d'éléments.
Element	hflow (Elements children)
	Un conteneur affichant des éléments en lignes de gauche à droite. Quand il est rempli, il commence sur une nouvelle ligne en dessous.
Element	vflow (Elements children)
	Un conteneur affichant des éléments en colonnes de haut en bas. Quand il est rempli, il commence sur une nouvelle colonne à droite.
Element	flex (Element child)
	Permet à un élément enfant de s'étendre proportionnellement à l'espace restant dans un conteneur.
Element	flex_grow (Element child)
	S'étend si possible.
Element	flex_shrink (Element child)
	Minimiser si nécessaire.
Element	xflex (Element child)
	Développer/Réduire si possible/nécessaire sur l'axe X.
Element	xflex_grow (Element child)
	S'étend si possible sur l'axe X.
Element	xflex_shrink (Element child)
	Minimiser si nécessaire sur l'axe X.
Element	yflex (Element child)
	Développer/Réduire si possible/nécessaire sur l'axe Y.
Element	yflex_grow (Element child)
	S'étend si possible sur l'axe Y.
Element	yflex_shrink (Element child)
	Minimiser si nécessaire sur l'axe Y.
Element	notflex (Element child)
	Rend l'élément non flexible.
Element	filler ()
	Un élément qui occupera proportionnellement l'espace disponible dans un conteneur.
Decorator	size (WidthOrHeight direction, Constraint constraint, int value)
	Applique une contrainte sur la taille d'un élément.
Element	frame (Element child)
	Permet à un élément d'être affiché dans une zone 'virtuelle'. Sa taille peut être plus grande que son conteneur. Dans ce cas, seule une plus petite partie est affichée. La vue est défilable pour rendre l'élément focalisé visible.
Element	xframe (Element child)
	Identique à frame, mais seulement sur l'axe x.
Element	yframe (Element child)
	Identique à frame, mais seulement sur l'axe y.
Element	focus (Element child)
	Définit l'élément child comme étant celui qui est focalisé parmi ses frères.
Element	select (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	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.
Decorator	reflect (Box &box)
Element	clear_under (Element element)
	Avant de dessiner |child|, effacez les pixels en dessous. Ceci est utile en combinaison avec dbox.
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	nothing (Element element)
	Une décoration qui ne fait absolument rien.
Dimensions	Fit (Element &, bool extend_beyond_screen=false)