FTXUI 6.1.9
C++ functional terminal UI.
Chargement...
Recherche...
Aucune correspondance
ftxui/dom

Description détaillée

Veuillez consulter le tutoriel du module ftxui/dom.

Classes

struct  Canvas
 Canvas est un tampon dessinable associé aux opérations de dessin. Plus de détails...
 
struct  FlexboxConfig
 FlexboxConfig est une structure de configuration qui définit les propriétés de mise en page pour un conteneur flexbox. Plus de détails...
 
struct  LinearGradient
 Une classe représentant les paramètres de l'effet de couleur en dégradé linéaire. Plus de détails...
 
class  Node
 Node est la classe de base pour tous les éléments de l'arbre DOM. Plus de détails...
 
struct  Requirement
 Requirement est une structure qui définit les exigences de mise en page pour un Nœud dans l'interface utilisateur du terminal. Plus de détails...
 
class  Selection
 Représente une sélection dans une interface utilisateur de terminal. Plus de détails...
 
class  Table
 Table est un utilitaire pour dessiner des tableaux. Plus de détails...
 

Énumérations

enum class  Direction {
  Up = 0 ,
  Down = 1 ,
  Left = 2 ,
  Right = 3
}
 Direction est une énumération qui représente les quatre directions cardinales. Plus de détails...
 
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...
 

Fonctions

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 Pixel &pixel)
 Identique à border mais avec un Pixel constant 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|, effacez les pixels 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 occupera proportionnellement l'espace disponible 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 inverted (Element child)
 Ajoute un filtre qui inversera les couleurs de premier plan et d'arrière-plan.
 
Element italic (Element child)
 Applique un style italique 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 (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 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 value)
 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é.
 
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 text)
 Affiche un morceau de texte unicode encodé en UTF8.
 
Element text (std::wstring text)
 Affiche un morceau de texte unicode.
 
Element vtext (std::string text)
 Affiche un morceau de texte unicode verticalement.
 
Element vtext (std::wstring 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.
 
Elements operator| (Elements, Decorator)
 
Elementoperator|= (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.
 

Documentation des classes

◆ ftxui::Canvas

struct ftxui::Canvas

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

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.

Exemples
examples/component/canvas_animated.cpp, et examples/dom/canvas.cpp.

Définition à la ligne 38 du fichier canvas.hpp.

Types publics

using Stylizer = std::function<void(Pixel&)>
 

Fonctions membres publiques

 Canvas ()=default
 
 Canvas (int width, int height)
 Constructeur.
 
int width () const
 
int height () const
 
Pixel GetPixel (int x, int y) const
 Récupère le contenu d'une cellule.
 
void DrawPointOn (int x, int y)
 Dessine un point braille.
 
void DrawPointOff (int x, int y)
 Efface un point braille.
 
void DrawPointToggle (int x, int y)
 Inverse un point braille. Un point rempli sera effacé, et un point vide sera dessiné.
 
void DrawPoint (int x, int y, bool value)
 Dessine un point braille.
 
void DrawPoint (int x, int y, bool value, const Stylizer &s)
 Dessine un point braille.
 
void DrawPoint (int x, int y, bool value, const Color &color)
 Dessine un point braille.
 
void DrawPointLine (int x1, int y1, int x2, int y2)
 Dessine une ligne de points braille.
 
void DrawPointLine (int x1, int y1, int x2, int y2, const Stylizer &s)
 Dessine une ligne de points braille.
 
void DrawPointLine (int x1, int y1, int x2, int y2, const Color &color)
 Dessine une ligne de points braille.
 
void DrawPointCircle (int x, int y, int radius)
 Dessine un cercle de points braille.
 
void DrawPointCircle (int x, int y, int radius, const Stylizer &s)
 Dessine un cercle de points braille.
 
void DrawPointCircle (int x, int y, int radius, const Color &color)
 Dessine un cercle de points braille.
 
void DrawPointCircleFilled (int x, int y, int radius)
 Dessine un cercle rempli de points braille.
 
void DrawPointCircleFilled (int x, int y, int radius, const Stylizer &s)
 Dessine un cercle rempli de points braille.
 
void DrawPointCircleFilled (int x, int y, int radius, const Color &color)
 Dessine un cercle rempli de points braille.
 
void DrawPointEllipse (int x, int y, int r1, int r2)
 Dessine une ellipse de points braille.
 
void DrawPointEllipse (int x, int y, int r1, int r2, const Color &color)
 Dessine une ellipse de points braille.
 
void DrawPointEllipse (int x, int y, int r1, int r2, const Stylizer &s)
 Dessine une ellipse de points braille.
 
void DrawPointEllipseFilled (int x, int y, int r1, int r2)
 Dessine une ellipse remplie de points braille.
 
void DrawPointEllipseFilled (int x, int y, int r1, int r2, const Color &color)
 Dessine une ellipse remplie de points braille.
 
void DrawPointEllipseFilled (int x, int y, int r1, int r2, const Stylizer &s)
 Dessine une ellipse remplie de points braille.
 
void DrawBlockOn (int x, int y)
 Dessine un bloc.
 
void DrawBlockOff (int x, int y)
 Efface un bloc.
 
void DrawBlockToggle (int x, int y)
 Inverse un bloc. S'il est rempli, il sera effacé. S'il est vide, il sera rempli.
 
void DrawBlock (int x, int y, bool value)
 Dessine un bloc.
 
void DrawBlock (int x, int y, bool value, const Stylizer &s)
 Dessine un bloc.
 
void DrawBlock (int x, int y, bool value, const Color &color)
 Dessine un bloc.
 
void DrawBlockLine (int x1, int y1, int x2, int y2)
 Dessine une ligne de caractères de bloc.
 
void DrawBlockLine (int x1, int y1, int x2, int y2, const Stylizer &s)
 Dessine une ligne de caractères de bloc.
 
void DrawBlockLine (int x1, int y1, int x2, int y2, const Color &color)
 Dessine une ligne de caractères de bloc.
 
void DrawBlockCircle (int x1, int y1, int radius)
 Dessine un cercle de caractères de bloc.
 
void DrawBlockCircle (int x1, int y1, int radius, const Stylizer &s)
 Dessine un cercle de caractères de bloc.
 
void DrawBlockCircle (int x1, int y1, int radius, const Color &color)
 Dessine un cercle de caractères de bloc.
 
void DrawBlockCircleFilled (int x1, int y1, int radius)
 Dessine un cercle rempli de caractères de bloc.
 
void DrawBlockCircleFilled (int x1, int y1, int radius, const Stylizer &s)
 Dessine un cercle rempli de caractères de bloc.
 
void DrawBlockCircleFilled (int x1, int y1, int radius, const Color &color)
 Dessine un cercle rempli de caractères de bloc.
 
void DrawBlockEllipse (int x1, int y1, int r1, int r2)
 Dessine une ellipse de caractères de bloc.
 
void DrawBlockEllipse (int x1, int y1, int r1, int r2, const Stylizer &s)
 Dessine une ellipse de caractères de bloc.
 
void DrawBlockEllipse (int x1, int y1, int r1, int r2, const Color &color)
 Dessine une ellipse de caractères de bloc.
 
void DrawBlockEllipseFilled (int x1, int y1, int r1, int r2)
 Dessine une ellipse remplie de caractères de bloc.
 
void DrawBlockEllipseFilled (int x1, int y1, int r1, int r2, const Stylizer &s)
 Dessine une ellipse remplie de caractères de bloc.
 
void DrawBlockEllipseFilled (int x1, int y1, int r1, int r2, const Color &color)
 Dessine une ellipse remplie de caractères de bloc.
 
void DrawText (int x, int y, const std::string &value)
 Dessine un morceau de texte.
 
void DrawText (int x, int y, const std::string &value, const Color &color)
 Dessine un morceau de texte.
 
void DrawText (int x, int y, const std::string &value, const Stylizer &style)
 Dessine un morceau de texte.
 
void DrawPixel (int x, int y, const Pixel &)
 Dessine directement un pixel prédéfini à la coordonnée donnée.
 
void DrawImage (int x, int y, const Image &)
 Dessine une image prédéfinie, avec le coin supérieur gauche à la coordonnée donnée Vous pouvez fournir des coordonnées négatives pour aligner l'image comme vous le souhaitez - seule la partie 'visible' sera dessinée.
 
void Style (int x, int y, const Stylizer &style)
 Modifie un pixel à un emplacement donné.
 

Documentation des définitions de type membres

◆ Stylizer

using Stylizer = std::function<void(Pixel&)>

Définition à la ligne 48 du fichier canvas.hpp.

Documentation des constructeurs et destructeur

◆ Canvas() [1/2]

Canvas ( )
default

◆ Canvas() [2/2]

Canvas ( int width,
int height )

Constructeur.

Paramètres
widthla largeur du canevas. Une cellule est un point braille 2x4.
heightla hauteur du canevas. Une cellule est un point braille 2x4.

Définition à la ligne 90 du fichier src/ftxui/dom/canvas.cpp.

Documentation des fonctions membres

◆ width()

int width ( ) const
inline

Définition à la ligne 44 du fichier canvas.hpp.

◆ height()

int height ( ) const
inline

Définition à la ligne 45 du fichier canvas.hpp.

◆ GetPixel()

Pixel GetPixel ( int x,
int y ) const

Récupère le contenu d'une cellule.

Paramètres
xla coordonnée x de la cellule.
yla coordonnée y de la cellule.

Définition à la ligne 98 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointOn()

void DrawPointOn ( int x,
int y )

Dessine un point braille.

Paramètres
xla coordonnée x du point.
yla coordonnée y du point.

Définition à la ligne 137 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointOff()

void DrawPointOff ( int x,
int y )

Efface un point braille.

Paramètres
xla coordonnée x du point.
yla coordonnée y du point.

Définition à la ligne 154 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointToggle()

void DrawPointToggle ( int x,
int y )

Inverse un point braille. Un point rempli sera effacé, et un point vide sera dessiné.

Paramètres
xla coordonnée x du point.
yla coordonnée y du point.

Définition à la ligne 172 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPoint() [1/3]

void DrawPoint ( int x,
int y,
bool value )

Dessine un point braille.

Paramètres
xla coordonnée x du point.
yla coordonnée y du point.
valueindique si le point est rempli ou non.

Définition à la ligne 107 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPoint() [2/3]

void DrawPoint ( int x,
int y,
bool value,
const Stylizer & style )

Dessine un point braille.

Paramètres
xla coordonnée x du point.
yla coordonnée y du point.
valueindique si le point est rempli ou non.
stylele style de la cellule.

Définition à la ligne 125 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPoint() [3/3]

void DrawPoint ( int x,
int y,
bool value,
const Color & color )

Dessine un point braille.

Paramètres
xla coordonnée x du point.
yla coordonnée y du point.
valueindique si le point est rempli ou non.
colorla couleur du point.

Définition à la ligne 116 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointLine() [1/3]

void DrawPointLine ( int x1,
int y1,
int x2,
int y2 )

Dessine une ligne de points braille.

Paramètres
x1la coordonnée x du premier point.
y1la coordonnée y du premier point.
x2la coordonnée x du second point.
y2la coordonnée y du second point.

Définition à la ligne 191 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointLine() [2/3]

void DrawPointLine ( int x1,
int y1,
int x2,
int y2,
const Stylizer & style )

Dessine une ligne de points braille.

Paramètres
x1la coordonnée x du premier point.
y1la coordonnée y du premier point.
x2la coordonnée x du second point.
y2la coordonnée y du second point.
stylele style de la ligne.

Définition à la ligne 212 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointLine() [3/3]

void DrawPointLine ( int x1,
int y1,
int x2,
int y2,
const Color & color )

Dessine une ligne de points braille.

Paramètres
x1la coordonnée x du premier point.
y1la coordonnée y du premier point.
x2la coordonnée x du second point.
y2la coordonnée y du second point.
colorla couleur de la ligne.

Définition à la ligne 201 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointCircle() [1/3]

void DrawPointCircle ( int x,
int y,
int radius )

Dessine un cercle de points braille.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.

Définition à la ligne 249 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointCircle() [2/3]

void DrawPointCircle ( int x,
int y,
int radius,
const Stylizer & style )

Dessine un cercle de points braille.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.
stylele style du cercle.

Définition à la ligne 268 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointCircle() [3/3]

void DrawPointCircle ( int x,
int y,
int radius,
const Color & color )

Dessine un cercle de points braille.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.
colorla couleur du cercle.

Définition à la ligne 258 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointCircleFilled() [1/3]

void DrawPointCircleFilled ( int x,
int y,
int radius )

Dessine un cercle rempli de points braille.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.

Définition à la ligne 276 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointCircleFilled() [2/3]

void DrawPointCircleFilled ( int x,
int y,
int radius,
const Stylizer & style )

Dessine un cercle rempli de points braille.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.
stylele style du cercle.

Définition à la ligne 298 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointCircleFilled() [3/3]

void DrawPointCircleFilled ( int x,
int y,
int radius,
const Color & color )

Dessine un cercle rempli de points braille.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.
colorla couleur du cercle.

Définition à la ligne 285 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointEllipse() [1/3]

void DrawPointEllipse ( int x,
int y,
int r1,
int r2 )

Dessine une ellipse de points braille.

Paramètres
xla coordonnée x du centre de l'ellipse.
yla coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.

Définition à la ligne 310 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointEllipse() [2/3]

void DrawPointEllipse ( int x,
int y,
int r1,
int r2,
const Color & color )

Dessine une ellipse de points braille.

Paramètres
xla coordonnée x du centre de l'ellipse.
yla coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.
colorla couleur de l'ellipse.

Définition à la ligne 320 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointEllipse() [3/3]

void DrawPointEllipse ( int x1,
int y1,
int r1,
int r2,
const Stylizer & s )

Dessine une ellipse de points braille.

Paramètres
x1la coordonnée x du centre de l'ellipse.
y1la coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.
sle style de l'ellipse.

Définition à la ligne 335 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointEllipseFilled() [1/3]

void DrawPointEllipseFilled ( int x1,
int y1,
int r1,
int r2 )

Dessine une ellipse remplie de points braille.

Paramètres
x1la coordonnée x du centre de l'ellipse.
y1la coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.

Définition à la ligne 374 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointEllipseFilled() [2/3]

void DrawPointEllipseFilled ( int x1,
int y1,
int r1,
int r2,
const Color & color )

Dessine une ellipse remplie de points braille.

Paramètres
x1la coordonnée x du centre de l'ellipse.
y1la coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.
colorla couleur de l'ellipse.

Définition à la ligne 384 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPointEllipseFilled() [3/3]

void DrawPointEllipseFilled ( int x1,
int y1,
int r1,
int r2,
const Stylizer & s )

Dessine une ellipse remplie de points braille.

Paramètres
x1la coordonnée x du centre de l'ellipse.
y1la coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.
sle style de l'ellipse.

Définition à la ligne 399 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockOn()

void DrawBlockOn ( int x,
int y )

Dessine un bloc.

Paramètres
xla coordonnée x du bloc.
yla coordonnée y du bloc.

Définition à la ligne 468 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockOff()

void DrawBlockOff ( int x,
int y )

Efface un bloc.

Paramètres
xla coordonnée x du bloc.
yla coordonnée y du bloc.

Définition à la ligne 488 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockToggle()

void DrawBlockToggle ( int x,
int y )

Inverse un bloc. S'il est rempli, il sera effacé. S'il est vide, il sera rempli.

Paramètres
xla coordonnée x du bloc.
yla coordonnée y du bloc.

Définition à la ligne 509 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlock() [1/3]

void DrawBlock ( int x,
int y,
bool value )

Dessine un bloc.

Paramètres
xla coordonnée x du bloc.
yla coordonnée y du bloc.
valueindique si le bloc est rempli ou non.

Définition à la ligne 438 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlock() [2/3]

void DrawBlock ( int x,
int y,
bool value,
const Stylizer & style )

Dessine un bloc.

Paramètres
xla coordonnée x du bloc.
yla coordonnée y du bloc.
valueindique si le bloc est rempli ou non.
stylele style du bloc.

Définition à la ligne 456 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlock() [3/3]

void DrawBlock ( int x,
int y,
bool value,
const Color & color )

Dessine un bloc.

Paramètres
xla coordonnée x du bloc.
yla coordonnée y du bloc.
valueindique si le bloc est rempli ou non.
colorla couleur du bloc.

Définition à la ligne 447 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockLine() [1/3]

void DrawBlockLine ( int x1,
int y1,
int x2,
int y2 )

Dessine une ligne de caractères de bloc.

Paramètres
x1la coordonnée x du premier point de la ligne.
y1la coordonnée y du premier point de la ligne.
x2la coordonnée x du second point de la ligne.
y2la coordonnée y du second point de la ligne.

Définition à la ligne 531 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockLine() [2/3]

void DrawBlockLine ( int x1,
int y1,
int x2,
int y2,
const Stylizer & style )

Dessine une ligne de caractères de bloc.

Paramètres
x1la coordonnée x du premier point de la ligne.
y1la coordonnée y du premier point de la ligne.
x2la coordonnée x du second point de la ligne.
y2la coordonnée y du second point de la ligne.
stylele style de la ligne.

Définition à la ligne 552 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockLine() [3/3]

void DrawBlockLine ( int x1,
int y1,
int x2,
int y2,
const Color & color )

Dessine une ligne de caractères de bloc.

Paramètres
x1la coordonnée x du premier point de la ligne.
y1la coordonnée y du premier point de la ligne.
x2la coordonnée x du second point de la ligne.
y2la coordonnée y du second point de la ligne.
colorla couleur de la ligne.

Définition à la ligne 541 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockCircle() [1/3]

void DrawBlockCircle ( int x,
int y,
int radius )

Dessine un cercle de caractères de bloc.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.

Définition à la ligne 592 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockCircle() [2/3]

void DrawBlockCircle ( int x,
int y,
int radius,
const Stylizer & style )

Dessine un cercle de caractères de bloc.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.
stylele style du cercle.

Définition à la ligne 611 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockCircle() [3/3]

void DrawBlockCircle ( int x,
int y,
int radius,
const Color & color )

Dessine un cercle de caractères de bloc.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.
colorla couleur du cercle.

Définition à la ligne 601 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockCircleFilled() [1/3]

void DrawBlockCircleFilled ( int x,
int y,
int radius )

Dessine un cercle rempli de caractères de bloc.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.

Définition à la ligne 619 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockCircleFilled() [2/3]

void DrawBlockCircleFilled ( int x,
int y,
int radius,
const Stylizer & s )

Dessine un cercle rempli de caractères de bloc.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.
sle style du cercle.

Définition à la ligne 641 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockCircleFilled() [3/3]

void DrawBlockCircleFilled ( int x,
int y,
int radius,
const Color & color )

Dessine un cercle rempli de caractères de bloc.

Paramètres
xla coordonnée x du centre du cercle.
yla coordonnée y du centre du cercle.
radiusle rayon du cercle.
colorla couleur du cercle.

Définition à la ligne 628 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockEllipse() [1/3]

void DrawBlockEllipse ( int x,
int y,
int r1,
int r2 )

Dessine une ellipse de caractères de bloc.

Paramètres
xla coordonnée x du centre de l'ellipse.
yla coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.

Définition à la ligne 653 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockEllipse() [2/3]

void DrawBlockEllipse ( int x1,
int y1,
int r1,
int r2,
const Stylizer & s )

Dessine une ellipse de caractères de bloc.

Paramètres
x1la coordonnée x du centre de l'ellipse.
y1la coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.
sle style de l'ellipse.

Définition à la ligne 678 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockEllipse() [3/3]

void DrawBlockEllipse ( int x,
int y,
int r1,
int r2,
const Color & color )

Dessine une ellipse de caractères de bloc.

Paramètres
xla coordonnée x du centre de l'ellipse.
yla coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.
colorla couleur de l'ellipse.

Définition à la ligne 663 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockEllipseFilled() [1/3]

void DrawBlockEllipseFilled ( int x,
int y,
int r1,
int r2 )

Dessine une ellipse remplie de caractères de bloc.

Paramètres
xla coordonnée x du centre de l'ellipse.
yla coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.

Définition à la ligne 719 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockEllipseFilled() [2/3]

void DrawBlockEllipseFilled ( int x1,
int y1,
int r1,
int r2,
const Stylizer & s )

Dessine une ellipse remplie de caractères de bloc.

Paramètres
x1la coordonnée x du centre de l'ellipse.
y1la coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.
sle style de l'ellipse.

Définition à la ligne 744 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawBlockEllipseFilled() [3/3]

void DrawBlockEllipseFilled ( int x,
int y,
int r1,
int r2,
const Color & color )

Dessine une ellipse remplie de caractères de bloc.

Paramètres
xla coordonnée x du centre de l'ellipse.
yla coordonnée y du centre de l'ellipse.
r1le rayon de l'ellipse le long de l'axe des x.
r2le rayon de l'ellipse le long de l'axe des y.
colorla couleur de l'ellipse.

Définition à la ligne 729 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawText() [1/3]

void DrawText ( int x,
int y,
const std::string & value )

Dessine un morceau de texte.

Paramètres
xla coordonnée x du texte.
yla coordonnée y du texte.
valuele texte à dessiner.

Définition à la ligne 785 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawText() [2/3]

void DrawText ( int x,
int y,
const std::string & value,
const Color & color )

Dessine un morceau de texte.

Paramètres
xla coordonnée x du texte.
yla coordonnée y du texte.
valuele texte à dessiner.
colorla couleur du texte.

Définition à la ligne 794 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawText() [3/3]

void DrawText ( int x,
int y,
const std::string & value,
const Stylizer & style )

Dessine un morceau de texte.

Paramètres
xla coordonnée x du texte.
yla coordonnée y du texte.
valuele texte à dessiner.
stylele style du texte.

Définition à la ligne 806 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawPixel()

void DrawPixel ( int x,
int y,
const Pixel & p )

Dessine directement un pixel prédéfini à la coordonnée donnée.

Paramètres
xla coordonnée x du pixel.
yla coordonnée y du pixel.
ple pixel à dessiner.

Définition à la ligne 827 du fichier src/ftxui/dom/canvas.cpp.

◆ DrawImage()

void DrawImage ( int x,
int y,
const Image & image )

Dessine une image prédéfinie, avec le coin supérieur gauche à la coordonnée donnée Vous pouvez fournir des coordonnées négatives pour aligner l'image comme vous le souhaitez - seule la partie 'visible' sera dessinée.

Paramètres
xla coordonnée x correspondant au coin supérieur gauche de l'image.
yla coordonnée y correspondant au coin supérieur gauche de l'image.
imagel'image à dessiner.

Définition à la ligne 839 du fichier src/ftxui/dom/canvas.cpp.

◆ Style()

void Style ( int x,
int y,
const Stylizer & style )

Modifie un pixel à un emplacement donné.

Paramètres
styleune fonction qui modifie le pixel.

Définition à la ligne 861 du fichier src/ftxui/dom/canvas.cpp.

◆ ftxui::FlexboxConfig

struct ftxui::FlexboxConfig

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

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.

Exemples
examples/component/flexbox_gallery.cpp, et examples/component/homescreen.cpp.

Définition à la ligne 27 du fichier flexbox_config.hpp.

Types publics

enum class  Direction {
  Row ,
  RowInversed ,
  Column ,
  ColumnInversed
}
 
enum class  Wrap {
  NoWrap ,
  Wrap ,
  WrapInversed
}
 
enum class  JustifyContent {
  FlexStart ,
  FlexEnd ,
  Center ,
  Stretch ,
  SpaceBetween ,
  SpaceAround ,
  SpaceEvenly
}
 
enum class  AlignItems {
  FlexStart ,
  FlexEnd ,
  Center ,
  Stretch
}
 
enum class  AlignContent {
  FlexStart ,
  FlexEnd ,
  Center ,
  Stretch ,
  SpaceBetween ,
  SpaceAround ,
  SpaceEvenly
}
 

Fonctions membres publiques

FlexboxConfigSet (FlexboxConfig::Direction)
 Définit la direction de la flexbox.
 
FlexboxConfigSet (FlexboxConfig::Wrap)
 Définit l'habillage (wrap) de la flexbox.
 
FlexboxConfigSet (FlexboxConfig::JustifyContent)
 Définit la justification du contenu (justify content) de la flexbox.
 
FlexboxConfigSet (FlexboxConfig::AlignItems)
 Définit l'alignement des éléments (align items) de la flexbox.
 
FlexboxConfigSet (FlexboxConfig::AlignContent)
 Définit l'alignement du contenu (align content) de la flexbox.
 
FlexboxConfigSetGap (int gap_x, int gap_y)
 Définit la direction de flex (flex direction) de la flexbox.
 

Attributs publics

Direction direction = Direction::Row
 
Wrap wrap = Wrap::Wrap
 
JustifyContent justify_content = JustifyContent::FlexStart
 
AlignItems align_items = AlignItems::FlexStart
 
AlignContent align_content = AlignContent::FlexStart
 
int gap_x = 0
 
int gap_y = 0
 

Documentation des énumérations membres

◆ Direction

enum class Direction
strong

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.

Valeurs énumérées
Row 

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

RowInversed 

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

Column 

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

ColumnInversed 

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

Définition à la ligne 33 du fichier flexbox_config.hpp.

◆ Wrap

enum class Wrap
strong

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é.

Valeurs énumérées
NoWrap 

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

Wrap 

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

WrapInversed 

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

Définition à la ligne 46 du fichier flexbox_config.hpp.

◆ JustifyContent

enum class JustifyContent
strong

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.

Valeurs énumérées
FlexStart 

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

FlexEnd 

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

Center 

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

Stretch 

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

SpaceBetween 

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.

SpaceAround 

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.

SpaceEvenly 

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

Définition à la ligne 61 du fichier flexbox_config.hpp.

◆ AlignItems

enum class AlignItems
strong

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

Valeurs énumérées
FlexStart 

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

FlexEnd 

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

Center 

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

Stretch 

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

Définition à la ligne 90 du fichier flexbox_config.hpp.

◆ AlignContent

enum class AlignContent
strong
Valeurs énumérées
FlexStart 

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

FlexEnd 

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

Center 

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

Stretch 

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

SpaceBetween 

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

SpaceAround 

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

SpaceEvenly 

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

Définition à la ligne 101 du fichier flexbox_config.hpp.

Documentation des fonctions membres

◆ Set() [1/5]

Définit la direction de la flexbox.

Exemples
examples/component/flexbox_gallery.cpp.

Définition à la ligne 9 du fichier flexbox_config.cpp.

◆ Set() [2/5]

Définit l'habillage (wrap) de la flexbox.

Définition à la ligne 15 du fichier flexbox_config.cpp.

◆ Set() [3/5]

Définit la justification du contenu (justify content) de la flexbox.

Définition à la ligne 21 du fichier flexbox_config.cpp.

◆ Set() [4/5]

Définit l'alignement des éléments (align items) de la flexbox.

Définition à la ligne 27 du fichier flexbox_config.cpp.

◆ Set() [5/5]

Définit l'alignement du contenu (align content) de la flexbox.

Définition à la ligne 33 du fichier flexbox_config.cpp.

◆ SetGap()

FlexboxConfig & SetGap ( int gap_x,
int gap_y )

Définit la direction de flex (flex direction) de la flexbox.

Exemples
examples/component/homescreen.cpp.

Définition à la ligne 39 du fichier flexbox_config.cpp.

Documentation des données membres

◆ direction

Exemples
examples/component/flexbox_gallery.cpp.

Définition à la ligne 41 du fichier flexbox_config.hpp.

◆ wrap

Wrap wrap = Wrap::Wrap
Exemples
examples/component/flexbox_gallery.cpp.

Définition à la ligne 54 du fichier flexbox_config.hpp.

◆ justify_content

Exemples
examples/component/flexbox_gallery.cpp.

Définition à la ligne 84 du fichier flexbox_config.hpp.

◆ align_items

Exemples
examples/component/flexbox_gallery.cpp.

Définition à la ligne 96 du fichier flexbox_config.hpp.

◆ align_content

Exemples
examples/component/flexbox_gallery.cpp.

Définition à la ligne 113 du fichier flexbox_config.hpp.

◆ gap_x

int gap_x = 0

Définition à la ligne 115 du fichier flexbox_config.hpp.

◆ gap_y

int gap_y = 0

Définition à la ligne 116 du fichier flexbox_config.hpp.

◆ ftxui::LinearGradient

struct ftxui::LinearGradient

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

Exemple:

.Angle(45)
.Stop(Color::Red, 0.0)
.Stop(Color::Green, 0.5)
.Stop(Color::Blue, 1.0);
LinearGradient()
Construit le dégradé "vide". Ceci est souvent suivi d'appels à LinearGradient::Angle() et LinearGradi...

Il existe aussi des constructeurs raccourcis:

Exemples
examples/component/input_style.cpp, examples/component/linear_gradient_gallery.cpp, examples/dom/linear_gradient.cpp, et examples/dom/style_color.cpp.

Définition à la ligne 32 du fichier linear_gradient.hpp.

Fonctions membres publiques

 LinearGradient ()
 Construit le dégradé "vide". Ceci est souvent suivi d'appels à LinearGradient::Angle() et LinearGradient::Stop(). Exemple:
 
 LinearGradient (Color begin, Color end)
 Construit un dégradé avec deux couleurs.
 
 LinearGradient (float angle, Color begin, Color end)
 
LinearGradientAngle (float angle)
 Définit l'angle du dégradé.
 
LinearGradientStop (Color color, float position)
 
LinearGradientStop (Color color)
 

Attributs publics

float angle = 0.f
 
std::vector< Stopstops
 

Documentation des constructeurs et destructeur

◆ LinearGradient() [1/3]

LinearGradient ( )
default

Construit le dégradé "vide". Ceci est souvent suivi d'appels à LinearGradient::Angle() et LinearGradient::Stop(). Exemple:

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

◆ LinearGradient() [2/3]

LinearGradient ( Color begin,
Color end )

Construit un dégradé avec deux couleurs.

Paramètres
beginLa couleur au début du dégradé.
endLa couleur à la fin du dégradé.

Définition à la ligne 193 du fichier src/ftxui/dom/linear_gradient.cpp.

◆ LinearGradient() [3/3]

LinearGradient ( float angle,
Color begin,
Color end )

Documentation des fonctions membres

◆ Angle()

LinearGradient & Angle ( float a)

Définit l'angle du dégradé.

Paramètres
aL'angle du dégradé.
Renvoie
Le dégradé.

Définition à la ligne 208 du fichier src/ftxui/dom/linear_gradient.cpp.

◆ Stop() [1/2]

LinearGradient & Stop ( Color color,
float position )

◆ Stop() [2/2]

LinearGradient & Stop ( Color color)

Documentation des données membres

◆ angle

float angle = 0.f

Définition à la ligne 33 du fichier linear_gradient.hpp.

◆ stops

std::vector<Stop> stops

Définition à la ligne 43 du fichier linear_gradient.hpp.

◆ ftxui::Node

class ftxui::Node

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

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.

Définition à la ligne 36 du fichier node.hpp.

+ Graphe d'héritage de Node:

Fonctions membres publiques

 Node ()
 
 Node (Elements children)
 
 Node (const Node &)=delete
 
 Node (const Node &&)=delete
 
Nodeoperator= (const Node &)=delete
 
Nodeoperator= (const Node &&)=delete
 
virtual ~Node ()
 
virtual void ComputeRequirement ()
 Calcule l'espace nécessaire à un élément.
 
Requirement requirement ()
 
virtual void SetBox (Box box)
 Assigne une position et une dimension à un élément pour le dessin.
 
virtual void Select (Selection &selection)
 Calcule la sélection d'un élément.
 
virtual void Render (Screen &screen)
 
virtual std::string GetSelectedContent (Selection &selection)
 
virtual void Check (Status *status)
 

Attributs protégés

Elements children_
 
Requirement requirement_
 
Box box_
 

Documentation des constructeurs et destructeur

◆ Node() [1/4]

Node ( )
default

◆ Node() [2/4]

Node ( Elements children)
explicit

Définition à la ligne 16 du fichier node.cpp.

◆ Node() [3/4]

Node ( const Node & )
delete

◆ Node() [4/4]

Node ( const Node && )
delete

◆ ~Node()

~Node ( )
virtualdefault

Documentation des fonctions membres

◆ operator=() [1/2]

Node & operator= ( const Node & )
delete

◆ operator=() [2/2]

Node & operator= ( const Node && )
delete

◆ ComputeRequirement()

void ComputeRequirement ( )
virtual

Calcule l'espace nécessaire à un élément.

Réimplémentée dans NodeDecorator.

Définition à la ligne 20 du fichier node.cpp.

◆ requirement()

Requirement requirement ( )
inline

Définition à la ligne 51 du fichier node.hpp.

◆ SetBox()

void SetBox ( Box box)
virtual

Assigne une position et une dimension à un élément pour le dessin.

Réimplémentée dans NodeDecorator.

Définition à la ligne 41 du fichier node.cpp.

◆ Select()

void Select ( Selection & selection)
virtual

Calcule la sélection d'un élément.

Définition à la ligne 46 du fichier node.cpp.

◆ Render()

virtual void Render ( Screen & screen)
virtual

◆ GetSelectedContent()

std::string GetSelectedContent ( Selection & selection)
virtual

Définition à la ligne 71 du fichier node.cpp.

◆ Check()

void Check ( Status * status)
virtual

Définition à la ligne 64 du fichier node.cpp.

Documentation des données membres

◆ children_

Elements children_
protected

Définition à la ligne 78 du fichier node.hpp.

◆ requirement_

Requirement requirement_
protected

Définition à la ligne 79 du fichier node.hpp.

◆ box_

Box box_
protected

Définition à la ligne 80 du fichier node.hpp.

◆ ftxui::Requirement

struct ftxui::Requirement

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

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

Définition à la ligne 18 du fichier requirement.hpp.

Attributs publics

int min_x = 0
 
int min_y = 0
 
int flex_grow_x = 0
 
int flex_grow_y = 0
 
int flex_shrink_x = 0
 
int flex_shrink_y = 0
 
Focused focused
 

Documentation des données membres

◆ min_x

int min_x = 0

Définition à la ligne 20 du fichier requirement.hpp.

◆ min_y

int min_y = 0

Définition à la ligne 21 du fichier requirement.hpp.

◆ flex_grow_x

int flex_grow_x = 0

Définition à la ligne 24 du fichier requirement.hpp.

◆ flex_grow_y

int flex_grow_y = 0

Définition à la ligne 25 du fichier requirement.hpp.

◆ flex_shrink_x

int flex_shrink_x = 0

Définition à la ligne 26 du fichier requirement.hpp.

◆ flex_shrink_y

int flex_shrink_y = 0

Définition à la ligne 27 du fichier requirement.hpp.

◆ focused

Focused focused

Définition à la ligne 51 du fichier requirement.hpp.

◆ ftxui::Selection

class ftxui::Selection

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

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

Définition à la ligne 22 du fichier selection.hpp.

Fonctions membres publiques

 Selection ()
 Crée une sélection vide.
 
 Selection (int start_x, int start_y, int end_x, int end_y)
 Crée une sélection.
 
const BoxGetBox () const
 Récupère la boîte de sélection.
 
Selection SaturateHorizontal (Box box)
 Sature la sélection pour qu'elle soit à l'intérieur de la boîte. Ceci est appelé par hbox pour propager la sélection à ses enfants.
 
Selection SaturateVertical (Box box)
 Sature la sélection pour qu'elle soit à l'intérieur de la boîte. Ceci est appelé par vbox pour propager la sélection à ses enfants.
 
bool IsEmpty () const
 
void AddPart (const std::string &part, int y, int left, int right)
 
std::string GetParts ()
 

Documentation des constructeurs et destructeur

◆ Selection() [1/2]

Selection ( )
default

Crée une sélection vide.

◆ Selection() [2/2]

Selection ( int start_x,
int start_y,
int end_x,
int end_y )

Crée une sélection.

Paramètres
start_xLa coordonnée x du début de la sélection.
start_yLa coordonnée y du début de la sélection.
end_xLa coordonnée x de la fin de la sélection.
end_yLa coordonnée y de la fin de la sélection.

Définition à la ligne 34 du fichier src/ftxui/dom/selection.cpp.

Documentation des fonctions membres

◆ GetBox()

const Box & GetBox ( ) const

Récupère la boîte de sélection.

Renvoie
La boîte de sélection.

Définition à la ligne 67 du fichier src/ftxui/dom/selection.cpp.

◆ SaturateHorizontal()

Selection SaturateHorizontal ( Box box)

Sature la sélection pour qu'elle soit à l'intérieur de la boîte. Ceci est appelé par hbox pour propager la sélection à ses enfants.

Paramètres
boxLa boîte dans laquelle saturer la sélection.
Renvoie
La sélection saturée.

Définition à la ligne 75 du fichier src/ftxui/dom/selection.cpp.

◆ SaturateVertical()

Selection SaturateVertical ( Box box)

Sature la sélection pour qu'elle soit à l'intérieur de la boîte. Ceci est appelé par vbox pour propager la sélection à ses enfants.

Paramètres
boxLa boîte dans laquelle saturer la sélection.
Renvoie
La sélection saturée.

Définition à la ligne 113 du fichier src/ftxui/dom/selection.cpp.

◆ IsEmpty()

bool IsEmpty ( ) const
inline

Définition à la ligne 31 du fichier selection.hpp.

◆ AddPart()

void AddPart ( const std::string & part,
int y,
int left,
int right )

Définition à la ligne 146 du fichier src/ftxui/dom/selection.cpp.

◆ GetParts()

std::string GetParts ( )
inline

Définition à la ligne 34 du fichier selection.hpp.

◆ ftxui::Table

class ftxui::Table

Table est un utilitaire pour dessiner des tableaux.

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();
Table()
Crée une table vide.
@ DOUBLE
Definition elements.hpp:39
@ LIGHT
Definition elements.hpp:36
Exemples
examples/dom/table.cpp.

Définition à la ligne 36 du fichier table.hpp.

Fonctions membres publiques

 Table ()
 Crée une table vide.
 
 Table (std::vector< std::vector< std::string > >)
 Crée une table à partir d'un vecteur de vecteurs de chaînes de caractères.
 
 Table (std::vector< std::vector< Element > >)
 Crée une table à partir d'un vecteur de vecteurs d'éléments.
 
 Table (std::initializer_list< std::vector< std::string > > init)
 
TableSelection SelectAll ()
 Sélectionne toute la table.
 
TableSelection SelectCell (int column, int row)
 Sélectionne une cellule de la table.
 
TableSelection SelectRow (int row_index)
 Sélectionne une ligne de la table.
 
TableSelection SelectRows (int row_min, int row_max)
 Sélectionne une plage de lignes de la table.
 
TableSelection SelectColumn (int column_index)
 Sélectionne une colonne de la table.
 
TableSelection SelectColumns (int column_min, int column_max)
 Sélectionne une plage de colonnes de la table.
 
TableSelection SelectRectangle (int column_min, int column_max, int row_min, int row_max)
 Sélectionne un rectangle de la table.
 
Element Render ()
 Rend la table.
 

Documentation des constructeurs et destructeur

◆ Table() [1/4]

Table ( )

Crée une table vide.

Définition à la ligne 47 du fichier src/ftxui/dom/table.cpp.

◆ Table() [2/4]

Table ( std::vector< std::vector< std::string > > input)
explicit

Crée une table à partir d'un vecteur de vecteurs de chaînes de caractères.

Paramètres
inputLes données d'entrée.

Définition à la ligne 53 du fichier src/ftxui/dom/table.cpp.

◆ Table() [3/4]

Table ( std::vector< std::vector< Element > > input)
explicit

Crée une table à partir d'un vecteur de vecteurs d'éléments.

Paramètres
inputLes éléments d'entrée.

Définition à la ligne 69 du fichier src/ftxui/dom/table.cpp.

◆ Table() [4/4]

Table ( std::initializer_list< std::vector< std::string > > init)

Définition à la ligne 75 du fichier src/ftxui/dom/table.cpp.

Documentation des fonctions membres

◆ SelectAll()

TableSelection SelectAll ( )

Sélectionne toute la table.

Exemples
examples/dom/table.cpp.

Définition à la ligne 200 du fichier src/ftxui/dom/table.cpp.

◆ SelectCell()

TableSelection SelectCell ( int column,
int row )

Sélectionne une cellule de la table.

Paramètres
columnLa colonne de la cellule à sélectionner.
rowLa ligne de la cellule à sélectionner.
Note
Vous pouvez utiliser des indices négatifs pour sélectionner à partir de la fin.

Définition à la ligne 169 du fichier src/ftxui/dom/table.cpp.

◆ SelectRow()

TableSelection SelectRow ( int index)

Sélectionne une ligne de la table.

Paramètres
indexL'indice de la ligne à sélectionner.
Note
Vous pouvez utiliser des indices négatifs pour sélectionner à partir de la fin.

Définition à la ligne 138 du fichier src/ftxui/dom/table.cpp.

◆ SelectRows()

TableSelection SelectRows ( int row_min,
int row_max )

Sélectionne une plage de lignes de la table.

Paramètres
row_minLa première ligne à sélectionner.
row_maxLa dernière ligne à sélectionner.
Note
Vous pouvez utiliser des indices négatifs pour sélectionner à partir de la fin.

Définition à la ligne 146 du fichier src/ftxui/dom/table.cpp.

◆ SelectColumn()

TableSelection SelectColumn ( int index)

Sélectionne une colonne de la table.

Paramètres
indexL'indice de la colonne à sélectionner.
Note
Vous pouvez utiliser des indices négatifs pour sélectionner à partir de la fin.

Définition à la ligne 153 du fichier src/ftxui/dom/table.cpp.

◆ SelectColumns()

TableSelection SelectColumns ( int column_min,
int column_max )

Sélectionne une plage de colonnes de la table.

Paramètres
column_minLa première colonne à sélectionner.
column_maxLa dernière colonne à sélectionner.
Note
Vous pouvez utiliser des indices négatifs pour sélectionner à partir de la fin.

Définition à la ligne 161 du fichier src/ftxui/dom/table.cpp.

◆ SelectRectangle()

TableSelection SelectRectangle ( int column_min,
int column_max,
int row_min,
int row_max )

Sélectionne un rectangle de la table.

Paramètres
column_minLa première colonne à sélectionner.
column_maxLa dernière colonne à sélectionner.
row_minLa première ligne à sélectionner.
row_maxLa dernière ligne à sélectionner.
Note
Vous pouvez utiliser des indices négatifs pour sélectionner à partir de la fin.

Définition à la ligne 179 du fichier src/ftxui/dom/table.cpp.

◆ Render()

Element Render ( )

Rend la table.

Renvoie
La table rendue. C'est un élément que vous pouvez dessiner.

Définition à la ligne 212 du fichier src/ftxui/dom/table.cpp.

Documentation du type de l'énumération

◆ Direction

enum class Direction
strong

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

Valeurs énumérées
Up 
Down 
Left 
Right 

Définition à la ligne 13 du fichier direction.hpp.

◆ BorderStyle

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.

Valeurs énumérées
LIGHT 
DASHED 
HEAVY 
DOUBLE 
ROUNDED 
EMPTY 

Définition à la ligne 35 du fichier elements.hpp.

Documentation des fonctions

◆ automerge()

Element automerge ( Element child)

Permet aux caractères d'être fusionnés automatiquement avec d'autres à proximité.

Définition à la ligne 17 du fichier automerge.cpp.

◆ blink()

Element blink ( Element child)

Le texte affiché alterne entre visible et masqué.

Définition à la ligne 33 du fichier blink.cpp.

◆ bold()

Element bold ( Element child)

Utilise une police en gras, pour les éléments avec plus d'emphase.

Définition à la ligne 33 du fichier bold.cpp.

◆ border()

Element border ( Element child)

Dessine une bordure autour de l'élément.

Voir également
border
borderLight
borderDashed
borderDouble
borderHeavy
borderEmpty
borderRounded
borderStyled
borderWith

Ajoute une bordure autour d'un élément

Exemple

// Utilisation de 'border' comme une fonction...
Element document = border(text("The element"));
// ...Ou comme un 'pipe'.
Element document = text("The element") | border;
Element text(std::wstring text)
Affiche un morceau de texte unicode.
Definition text.cpp:160
Element border(Element)
Dessine une bordure autour de l'élément.
std::shared_ptr< Node > Element
Definition elements.hpp:22

Sortie

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

Définition à la ligne 227 du fichier src/ftxui/dom/border.cpp.

◆ borderWith()

Decorator borderWith ( const Pixel & pixel)

Identique à border mais avec un Pixel constant autour de l'élément.

Voir également
border

Définition à la ligne 234 du fichier src/ftxui/dom/border.cpp.

◆ borderStyled() [1/3]

Decorator borderStyled ( BorderStyle style)

Identique à border mais avec différents styles.

Voir également
border

Définition à la ligne 243 du fichier src/ftxui/dom/border.cpp.

◆ borderStyled() [2/3]

Decorator borderStyled ( Color foreground_color)

Identique à border mais avec une couleur de premier plan.

Voir également
border

Définition à la ligne 252 du fichier src/ftxui/dom/border.cpp.

◆ borderStyled() [3/3]

Decorator borderStyled ( BorderStyle style,
Color foreground_color )

Identique à border mais avec une couleur de premier plan et un style différent.

Voir également
border

Définition à la ligne 262 du fichier src/ftxui/dom/border.cpp.

◆ borderDashed()

Element borderDashed ( Element child)

Dessine une bordure en pointillés autour de l'élément.

Voir également
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Ajoute une bordure autour d'un élément

Exemple

// Utilisation de 'borderDash' comme une fonction...
Element document = borderDashed(text("The element"));
// ...Ou comme un 'pipe'.
Element document = text("The element") | borderDashed;
Element borderDashed(Element)
Dessine une bordure en pointillés autour de l'élément.

Sortie

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

Définition à la ligne 300 du fichier src/ftxui/dom/border.cpp.

◆ borderLight()

Element borderLight ( Element child)

Dessine une bordure fine autour de l'élément.

Voir également
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Ajoute une bordure autour d'un élément

Exemple

// Utilisation de 'borderLight' comme une fonction...
Element document = borderLight(text("The element"));
// ...Ou comme un 'pipe'.
Element document = text("The element") | borderLight;
Element borderLight(Element)
Dessine une bordure fine autour de l'élément.

Sortie

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

Définition à la ligne 335 du fichier src/ftxui/dom/border.cpp.

◆ borderHeavy()

Element borderHeavy ( Element child)

Dessine une bordure épaisse autour de l'élément.

Voir également
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Ajoute une bordure autour d'un élément

Exemple

// Utilisation de 'borderHeavy' comme une fonction...
Element document = borderHeavy(text("The element"));
// ...Ou comme un 'pipe'.
Element document = text("The element") | borderHeavy;
Element borderHeavy(Element)
Dessine une bordure épaisse autour de l'élément.

Sortie

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

Définition à la ligne 370 du fichier src/ftxui/dom/border.cpp.

◆ borderDouble()

Element borderDouble ( Element child)

Dessine une double bordure autour de l'élément.

Voir également
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Ajoute une bordure autour d'un élément

Exemple

// Utilisation de 'borderDouble' comme une fonction...
Element document = borderDouble(text("The element"));
// ...Ou comme un 'pipe'.
Element document = text("The element") | borderDouble;
Element borderDouble(Element)
Dessine une double bordure autour de l'élément.

Sortie

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

Définition à la ligne 405 du fichier src/ftxui/dom/border.cpp.

◆ borderRounded()

Element borderRounded ( Element child)

Dessine une bordure arrondie autour de l'élément.

Voir également
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Ajoute une bordure autour d'un élément

Exemple

// Utilisation de 'borderRounded' comme une fonction...
Element document = borderRounded(text("The element"));
// ...Ou comme un 'pipe'.
Element document = text("The element") | borderRounded;
Element borderRounded(Element)
Dessine une bordure arrondie autour de l'élément.

Sortie

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

Définition à la ligne 440 du fichier src/ftxui/dom/border.cpp.

◆ borderEmpty()

Element borderEmpty ( Element child)

Dessine une bordure vide autour de l'élément.

Voir également
border
borderLight
borderDashed
borderDouble
borderHeavy
borderRounded
borderEmpty
borderStyled
borderWith

Ajoute une bordure autour d'un élément

Exemple

// Utilisation de 'borderEmpty' comme une fonction...
Element document = borderEmpty(text("The element"));
// ...Ou comme un 'pipe'.
Element document = text("The element") | borderEmpty;
Element borderEmpty(Element)
Dessine une bordure vide autour de l'élément.

Sortie

The element

Définition à la ligne 475 du fichier src/ftxui/dom/border.cpp.

◆ window()

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

Dessine une fenêtre avec un titre et une bordure autour de l'élément.

Paramètres
titleLe titre de la fenêtre.
contentL'élément à envelopper.
borderLe style de la bordure. La valeur par défaut est ROUNDED.
Voir également
border

Exemple

Element document = window(text("Title"),
text("content")
);
// En spécifiant la bordure
Element document = window(text("Title"),
text("content"),
);
Element window(Element title, Element content, BorderStyle border=ROUNDED)
Dessine une fenêtre avec un titre et une bordure autour de l'élément.
@ ROUNDED
Definition elements.hpp:40

Sortie

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

Définition à la ligne 507 du fichier src/ftxui/dom/border.cpp.

◆ clear_under()

Element clear_under ( Element element)

Avant de dessiner |child|, effacez les pixels en dessous. Ceci est utile en combinaison avec dbox.

Voir également
ftxui::dbox

Définition à la ligne 38 du fichier clear_under.cpp.

◆ color() [1/4]

Element color ( Color color,
Element child )

Définit la couleur de premier plan d'un élément.

Paramètres
colorLa couleur de l'élément de sortie.
childL'élément d'entrée.
Renvoie
L'élément de sortie coloré.

Exemple

Element document = color(Color::Green, text("Success")),
Decorator color(Color)
Décore en utilisant une couleur de premier plan.

Définition à la ligne 81 du fichier dom/color.cpp.

◆ bgcolor() [1/4]

Element bgcolor ( Color color,
Element child )

Définit la couleur d'arrière-plan d'un élément.

Paramètres
colorLa couleur de l'élément de sortie.
childL'élément d'entrée.
Renvoie
L'élément de sortie coloré.

Exemple

Element document = bgcolor(Color::Green, text("Success")),
Decorator bgcolor(Color)
Décore en utilisant une couleur d'arrière-plan.

Définition à la ligne 96 du fichier dom/color.cpp.

◆ color() [2/4]

Decorator color ( Color c)

Décore en utilisant une couleur de premier plan.

Paramètres
cLa couleur de premier plan à appliquer.
Renvoie
Le Decorator appliquant la couleur.

Exemple

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

Définition à la ligne 110 du fichier dom/color.cpp.

◆ bgcolor() [2/4]

Decorator bgcolor ( Color color)

Décore en utilisant une couleur d'arrière-plan.

Paramètres
colorLa couleur d'arrière-plan à appliquer.
Renvoie
Le Decorator appliquant la couleur.

Exemple

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

Définition à la ligne 124 du fichier dom/color.cpp.

◆ hcenter()

Element hcenter ( Element child)

Centre un élément horizontalement.

Paramètres
childL'élément décoré.
Renvoie
L'élément centré.

Définition à la ligne 15 du fichier composite_decorator.cpp.

◆ vcenter()

Element vcenter ( Element child)

Centre un élément verticalement.

Paramètres
childL'élément décoré.
Renvoie
L'élément centré.

Définition à la ligne 23 du fichier composite_decorator.cpp.

◆ center()

Element center ( Element child)

Centre un élément horizontalement et verticalement.

Paramètres
childL'élément décoré.
Renvoie
L'élément centré.

Définition à la ligne 31 du fichier composite_decorator.cpp.

◆ align_right()

Element align_right ( Element child)

Aligne un élément sur le côté droit.

Paramètres
childL'élément décoré.
Renvoie
L'élément aligné à droite.

Définition à la ligne 39 du fichier composite_decorator.cpp.

◆ dbox()

Element dbox ( Elements children_)

Empile plusieurs éléments les uns sur les autres.

Paramètres
children_L'élément d'entrée.
Renvoie
L'élément aligné à droite.

Définition à la ligne 55 du fichier src/ftxui/dom/dbox.cpp.

◆ dim()

Element dim ( Element child)

Utilise une police de caractères claire, pour les éléments moins mis en valeur.

Définition à la ligne 33 du fichier dim.cpp.

◆ filler()

Element filler ( )

Un élément qui occupera proportionnellement l'espace disponible dans un conteneur.

Définition à la ligne 98 du fichier flex.cpp.

◆ flex()

Element flex ( Element child)

Permet à un élément enfant de s'étendre proportionnellement à l'espace restant dans un conteneur.

Examples:

text("left") | border ,
text("middle") | border | flex,
text("right") | border,
});
Element flex(Element)
Permet à un élément enfant de s'étendre proportionnellement à l'espace restant dans un conteneur.
Definition flex.cpp:123
Element hbox(Elements)
Un conteneur affichant les éléments horizontalement un par un.
Definition hbox.cpp:94

Output:

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

Définition à la ligne 123 du fichier flex.cpp.

◆ xflex()

Element xflex ( Element child)

Développer/Réduire si possible/nécessaire sur l'axe X.

Définition à la ligne 129 du fichier flex.cpp.

◆ yflex()

Element yflex ( Element child)

Développer/Réduire si possible/nécessaire sur l'axe Y.

Définition à la ligne 135 du fichier flex.cpp.

◆ flex_grow()

Element flex_grow ( Element child)

S'étend si possible.

Définition à la ligne 141 du fichier flex.cpp.

◆ xflex_grow()

Element xflex_grow ( Element child)

S'étend si possible sur l'axe X.

Définition à la ligne 147 du fichier flex.cpp.

◆ yflex_grow()

Element yflex_grow ( Element child)

S'étend si possible sur l'axe Y.

Définition à la ligne 153 du fichier flex.cpp.

◆ flex_shrink()

Element flex_shrink ( Element child)

Minimiser si nécessaire.

Définition à la ligne 159 du fichier flex.cpp.

◆ xflex_shrink()

Element xflex_shrink ( Element child)

Minimiser si nécessaire sur l'axe X.

Définition à la ligne 165 du fichier flex.cpp.

◆ yflex_shrink()

Element yflex_shrink ( Element child)

Minimiser si nécessaire sur l'axe Y.

Définition à la ligne 171 du fichier flex.cpp.

◆ notflex()

Element notflex ( Element child)

Rend l'élément non flexible.

Définition à la ligne 177 du fichier flex.cpp.

◆ focusPositionRelative()

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.

Par exemple:

  • (0, 0) signifie que la vue est défilée vers le coin supérieur gauche.
  • (1, 0) signifie que la vue est défilée vers le coin supérieur droit.
  • (0, 1) signifie que la vue est défilée vers le coin inférieur gauche.

Exemple

Element document = huge_document()
| frame;
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....
Element frame(Element)
Permet à un élément d'être affiché dans une zone 'virtuelle'. Sa taille peut être plus grande que son...
Definition frame.cpp:118

Définition à la ligne 30 du fichier src/ftxui/dom/focus.cpp.

◆ focusPosition()

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.

Exemple

Element document = huge_document()
| focusPosition(10, 10)
| frame;
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....

Définition à la ligne 68 du fichier src/ftxui/dom/focus.cpp.

◆ focus()

Element focus ( Element child)

Définit l'élément child comme étant celui qui est focalisé parmi ses frères.

Paramètres
childL'élément à focaliser.

Définition à la ligne 101 du fichier frame.cpp.

◆ focusCursorBlock()

Element focusCursorBlock ( Element child)

Identique à focus, mais définit la forme du curseur comme un bloc fixe.

Voir également
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Définition à la ligne 147 du fichier frame.cpp.

◆ focusCursorBlockBlinking()

Element focusCursorBlockBlinking ( Element child)

Identique à focus, mais définit la forme du curseur comme un bloc clignotant.

Voir également
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Définition à la ligne 161 du fichier frame.cpp.

◆ focusCursorBar()

Element focusCursorBar ( Element child)

Identique à focus, mais définit la forme du curseur comme un bloc fixe.

Voir également
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Définition à la ligne 175 du fichier frame.cpp.

◆ focusCursorBarBlinking()

Element focusCursorBarBlinking ( Element child)

Identique à focus, mais définit la forme du curseur comme une barre clignotante.

Voir également
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Définition à la ligne 189 du fichier frame.cpp.

◆ focusCursorUnderline()

Element focusCursorUnderline ( Element child)

Identique à focus, mais définit la forme du curseur comme un soulignement fixe.

Voir également
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Définition à la ligne 203 du fichier frame.cpp.

◆ focusCursorUnderlineBlinking()

Element focusCursorUnderlineBlinking ( Element child)

Identique à focus, mais définit la forme du curseur comme un soulignement clignotant.

Voir également
focus
focusCursorBlock
focusCursorBlockBlinking
focusCursorBar
focusCursorBarBlinking
focusCursorUnderline
focusCursorUnderlineBlinking

Définition à la ligne 217 du fichier frame.cpp.

◆ inverted()

Element inverted ( Element child)

Ajoute un filtre qui inversera les couleurs de premier plan et d'arrière-plan.

Définition à la ligne 33 du fichier inverted.cpp.

◆ italic()

Element italic ( Element child)

Applique un style italique au texte.

Définition à la ligne 17 du fichier italic.cpp.

◆ color() [3/4]

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.

Paramètres
gradientL'effet de dégradé à appliquer sur l'élément de sortie.
childL'élément d'entrée.
Renvoie
L'élément de sortie coloré.

Exemple

color(LinearGradient{0, {Color::Red, Color::Blue}}, text("Hello"))
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.
Exemples
examples/component/flexbox_gallery.cpp, examples/component/homescreen.cpp, examples/component/input_style.cpp, examples/component/maybe.cpp, examples/component/menu_entries.cpp, examples/component/menu_style.cpp, examples/component/renderer.cpp, examples/dom/border_colored.cpp, examples/dom/color_gallery.cpp, examples/dom/color_truecolor_HSV.cpp, examples/dom/graph.cpp, examples/dom/html_like.cpp, examples/dom/package_manager.cpp, examples/dom/style_color.cpp, examples/dom/style_gallery.cpp, et examples/dom/table.cpp.

Définition à la ligne 241 du fichier src/ftxui/dom/linear_gradient.cpp.

◆ bgcolor() [3/4]

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.

Paramètres
gradientL'effet de dégradé à appliquer sur l'élément de sortie.
childL'élément d'entrée.
Renvoie
L'élément de sortie coloré.

Exemple

bgcolor(LinearGradient{0, {Color::Red, Color::Blue}}, text("Hello"))
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.
Exemples
examples/component/dropdown_custom.cpp, examples/component/flexbox_gallery.cpp, examples/component/focus.cpp, examples/component/homescreen.cpp, examples/component/input_style.cpp, examples/component/linear_gradient_gallery.cpp, examples/component/menu_entries_animated.cpp, examples/component/menu_style.cpp, examples/component/slider_rgb.cpp, examples/dom/color_gallery.cpp, examples/dom/color_info_palette256.cpp, examples/dom/color_truecolor_HSV.cpp, examples/dom/color_truecolor_RGB.cpp, examples/dom/linear_gradient.cpp, examples/dom/style_color.cpp, et examples/dom/style_gallery.cpp.

Définition à la ligne 257 du fichier src/ftxui/dom/linear_gradient.cpp.

◆ color() [4/4]

Decorator color ( const LinearGradient & gradient)

Décore en utilisant un effet de dégradé linéaire sur la couleur de premier plan.

Paramètres
gradientL'effet de dégradé à appliquer sur l'élément de sortie.
Renvoie
Le Decorator appliquant la couleur.

Exemple

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

Définition à la ligne 272 du fichier src/ftxui/dom/linear_gradient.cpp.

◆ bgcolor() [4/4]

Decorator bgcolor ( const LinearGradient & gradient)

Décore en utilisant un effet de dégradé linéaire sur la couleur de fond.

Paramètres
gradientL'effet de dégradé à appliquer sur l'élément de sortie.
Renvoie
Le Decorator appliquant la couleur.

Exemple

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

Définition à la ligne 287 du fichier src/ftxui/dom/linear_gradient.cpp.

◆ Render() [1/2]

◆ Render() [2/2]

void Render ( Screen & screen,
Node * node )

Affiche un élément sur un ftxui::Screen.

Définition à la ligne 90 du fichier node.cpp.

◆ paragraph()

Element paragraph ( const std::string & the_text)

Renvoie un élément affichant le paragraphe sur plusieurs lignes.

Voir également
flexbox.

Définition à la ligne 41 du fichier src/ftxui/dom/paragraph.cpp.

◆ paragraphAlignLeft()

Element paragraphAlignLeft ( const std::string & the_text)

Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné à gauche.

Voir également
flexbox.

Définition à la ligne 49 du fichier src/ftxui/dom/paragraph.cpp.

◆ paragraphAlignRight()

Element paragraphAlignRight ( const std::string & the_text)

Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné à droite.

Voir également
flexbox.

Définition à la ligne 60 du fichier src/ftxui/dom/paragraph.cpp.

◆ paragraphAlignCenter()

Element paragraphAlignCenter ( const std::string & the_text)

Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné au centre.

Voir également
flexbox.

Définition à la ligne 72 du fichier src/ftxui/dom/paragraph.cpp.

◆ paragraphAlignJustify()

Element paragraphAlignJustify ( const std::string & the_text)

Renvoie un élément affichant le paragraphe sur plusieurs lignes, aligné en utilisant un alignement justifié.

Voir également
flexbox.

Définition à la ligne 84 du fichier src/ftxui/dom/paragraph.cpp.

◆ vscroll_indicator()

Element vscroll_indicator ( Element child)

Affiche une barre de défilement verticale à droite. Les couleurs suivent le contenu.

Définition à la ligne 21 du fichier scroll_indicator.cpp.

◆ hscroll_indicator()

Element hscroll_indicator ( Element child)

Affiche une barre de défilement horizontale en bas. Les couleurs suivent le contenu.

Définition à la ligne 76 du fichier scroll_indicator.cpp.

◆ separator() [1/2]

Element separator ( )

Dessine une séparation verticale ou horizontale entre deux autres éléments.

Voir également
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Ajoute une séparation visuelle entre deux éléments.

Example

// Utilisation de 'border' comme fonction...
Element document = vbox({
text("up"),
text("down"),
});
Element separator()
Dessine une séparation verticale ou horizontale entre deux autres éléments.
Element vbox(Elements)
Un conteneur affichant les éléments verticalement un par un.
Definition vbox.cpp:96

Output

up
────
down

Définition à la ligne 134 du fichier src/ftxui/dom/separator.cpp.

◆ separatorStyled()

Element separatorStyled ( BorderStyle style)

Dessine une séparation verticale ou horizontale entre deux autres éléments.

Paramètres
stylele style du séparateur.
Voir également
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Ajoute une séparation visuelle entre deux éléments.

Exemple

// Utilisation de 'border' comme fonction...
Element document = vbox({
text("up"),
text("down"),
});
Element separatorStyled(BorderStyle)
Dessine une séparation verticale ou horizontale entre deux autres éléments.

Output

up
════
down

Définition à la ligne 172 du fichier src/ftxui/dom/separator.cpp.

◆ separatorLight()

Element separatorLight ( )

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

Voir également
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Ajoute une séparation visuelle entre deux éléments.

Exemple

// Utilisation de 'border' comme fonction...
Element document = vbox({
text("up"),
text("down"),
});
Element separatorLight()
Dessine une séparation verticale ou horizontale entre deux autres éléments, en utilisant le style LIG...

Output

up
────
down

Définition à la ligne 209 du fichier src/ftxui/dom/separator.cpp.

◆ separatorDashed()

Element separatorDashed ( )

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

Voir également
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Ajoute une séparation visuelle entre deux éléments.

Exemple

// Utilisation de 'border' comme fonction...
Element document = vbox({
text("up"),
text("down"),
});

Output

up
╍╍╍╍
down

Définition à la ligne 246 du fichier src/ftxui/dom/separator.cpp.

◆ separatorHeavy()

Element separatorHeavy ( )

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

Voir également
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Ajoute une séparation visuelle entre deux éléments.

Exemple

// Utilisation de 'border' comme fonction...
Element document = vbox({
text("up"),
text("down"),
});
Element separatorHeavy()
Dessine une séparation verticale ou horizontale entre deux autres éléments, en utilisant le style HEA...

Output

up
━━━━
down

Définition à la ligne 283 du fichier src/ftxui/dom/separator.cpp.

◆ separatorDouble()

Element separatorDouble ( )

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

Voir également
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Ajoute une séparation visuelle entre deux éléments.

Exemple

// Utilisation de 'border' comme fonction...
Element document = vbox({
text("up"),
text("down"),
});
Element separatorDouble()
Dessine une séparation verticale ou horizontale entre deux autres éléments, en utilisant le style DOU...

Output

up
════
down

Définition à la ligne 320 du fichier src/ftxui/dom/separator.cpp.

◆ separatorEmpty()

Element separatorEmpty ( )

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

Voir également
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Ajoute une séparation visuelle entre deux éléments.

Exemple

// Utilisation de 'border' comme fonction...
Element document = vbox({
text("up"),
text("down"),
});

Output

up
down

Définition à la ligne 357 du fichier src/ftxui/dom/separator.cpp.

◆ separatorCharacter()

Element separatorCharacter ( std::string value)

Dessine une séparation verticale ou horizontale entre deux autres éléments.

Paramètres
valuele caractère pour remplir la zone du séparateur.
Voir également
separator
separatorLight
separatorDashed
separatorDouble
separatorHeavy
separatorEmpty
separatorRounded
separatorStyled
separatorCharacter

Ajoute une séparation visuelle entre deux éléments.

Exemple

// Utilisation de 'border' comme fonction...
Element document = vbox({
text("up"),
text("down"),
});

Output

up
────
down

Définition à la ligne 395 du fichier src/ftxui/dom/separator.cpp.

◆ separator() [2/2]

Element separator ( Pixel pixel)

Dessine un séparateur entre deux éléments remplis avec un pixel donné.

Voir également
separator
separatorLight
separatorDashed
separatorHeavy
separatorDouble
separatorStyled

Exemple

Pixel empty;
Element document = vbox({
text("Up"),
separator(empty),
text("Down"),
})
Un caractère Unicode et son style associé.
Definition pixel.hpp:15

Output

Up
Down

Définition à la ligne 426 du fichier src/ftxui/dom/separator.cpp.

◆ size()

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

Applique une contrainte sur la taille d'un élément.

Paramètres
directionSi la LARGEUR ou la HAUTEUR de l'élément doit être contrainte.
constraintLe type de contrainte.
valueLa valeur.

Définition à la ligne 89 du fichier src/ftxui/dom/size.cpp.

◆ spinner()

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.

Paramètres
charset_indexLe type de "vidéo".
image_indexL'"image" de la vidéo. Vous devez l'augmenter pour chaque "étape".

Définition à la ligne 295 du fichier src/ftxui/dom/spinner.cpp.

◆ strikethrough()

Element strikethrough ( Element child)

Applique un barré au texte.

Définition à la ligne 17 du fichier strikethrough.cpp.

◆ text() [1/2]

Element text ( std::string text)

Affiche un morceau de texte unicode encodé en UTF8.

Voir également
ftxui::to_wstring

Exemple

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

Sortie

Hello world!

Définition à la ligne 141 du fichier text.cpp.

◆ text() [2/2]

Element text ( std::wstring text)

Affiche un morceau de texte unicode.

Voir également
ftxui::to_wstring

Exemple

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

Sortie

Hello world!

Définition à la ligne 160 du fichier text.cpp.

◆ vtext() [1/2]

Element vtext ( std::string text)

Affiche un morceau de texte unicode verticalement.

Voir également
ftxui::to_wstring

Exemple

Element document = vtext("Hello world!");
Element vtext(std::wstring text)
Affiche un morceau de texte unicode verticalement.
Definition text.cpp:220

Sortie

H
e
l
l
o
w
o
r
l
d
!

Définition à la ligne 190 du fichier text.cpp.

◆ vtext() [2/2]

Element vtext ( std::wstring text)

Affiche un morceau de texte unicode verticalement.

Voir également
ftxui::to_wstring

Exemple

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

Sortie

H
e
l
l
o
w
o
r
l
d
!

Définition à la ligne 220 du fichier text.cpp.

◆ underlined()

Element underlined ( Element child)

Souligne l'élément donné.

Définition à la ligne 33 du fichier underlined.cpp.

◆ underlinedDouble()

Element underlinedDouble ( Element child)

Applique un double soulignement au texte.

Définition à la ligne 17 du fichier underlined_double.cpp.

◆ nothing()

Element nothing ( Element element)

Une décoration qui ne fait absolument rien.

Définition à la ligne 28 du fichier dom/util.cpp.

◆ operator|()

Elements operator| ( Elements elements,
Decorator decorator )

À partir d'un ensemble d'éléments, appliquer un décorateur à tous les éléments.

Renvoie
l'ensemble des éléments décorés.

Définition à la ligne 47 du fichier dom/util.cpp.

◆ operator|=()

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

Applique un décorateur à un élément.

Renvoie
l'élément décoré.

Exemple

Les deux sont équivalents :

auto element = text("Hello");
element |= bold;
Element bold(Element)
Utilise une police en gras, pour les éléments avec plus d'emphase.
Definition bold.cpp:33

Définition à la ligne 77 du fichier dom/util.cpp.

◆ emptyElement()

Element emptyElement ( )

Un élément de taille 0x0 ne dessinant rien.

Définition à la ligne 132 du fichier dom/util.cpp.

◆ vbox()

Element vbox ( Elements children)

Un conteneur affichant les éléments verticalement un par un.

Paramètres
childrenLes éléments dans le conteneur
Renvoie
Le conteneur.

Exemple

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

Définition à la ligne 96 du fichier vbox.cpp.

◆ SetColorSupport()

void SetColorSupport ( Color color)

Outrepasser le support couleur du terminal en cas d'échec de la détection automatique.

Définition à la ligne 137 du fichier terminal.cpp.