Référence de l'espace de nommage ftxui

L'espace de noms FTXUI ftxui:: Plus de détails...

Espaces de nommage
namespace	animation
	Le namespace FTXUI ftxui::animation::
namespace	box_helper
namespace	Container
namespace	Dimension
	Définit l'apparence des dimensions de l'écran.
namespace	flexbox_helper
namespace	literals
namespace	task
namespace	Terminal
	L'espace de noms FTXUI ftxui::Terminal::
namespace	util

Classes
struct	AnimatedColorOption
	Option concernant une couleur potentiellement animée. Plus de détails...
struct	AnimatedColorsOption
class	AnimationTask
class	AutoReset
	Assigne une valeur à une variable, restaure son ancienne valeur lorsque la portée est quittée. Plus de détails...
struct	Box
	Box est une structure qui représente une zone rectangulaire dans un espace 2D. Plus de détails...
struct	ButtonOption
	Option pour le composant AnimatedButton. Plus de détails...
struct	Canvas
	Canvas est un tampon dessinable associé aux opérations de dessin. Plus de détails...
class	CapturedMouseInterface
struct	CheckboxOption
	Option pour le composant Checkbox. Plus de détails...
class	Color
	Color est une classe qui représente une couleur dans l'interface utilisateur du terminal. Plus de détails...
struct	ColorInfo
	ColorInfo est une structure qui contient des informations sur la palette de couleurs du terminal. Plus de détails...
class	ComponentBase
	Il implémente son propre rendu en tant que ftxui::Element. Il implémente la navigation au clavier en répondant à ftxui::Event. Plus de détails...
class	ConstRef
	Un adaptateur. Possède ou référence un objet immuable. Plus de détails...
class	ConstStringListRef
	Un adaptateur. Référence une liste de chaînes de caractères. Plus de détails...
class	ConstStringRef
	Un adaptateur. Possède ou référence une chaîne constante. Par commodité, cette classe convertit plusieurs chaînes immuables vers une représentation partagée. Plus de détails...
struct	Dimensions
	Dimensions est une structure qui représente la taille du terminal. Plus de détails...
struct	DropdownOption
	Option pour le composant Dropdown.Un menu déroulant est une case à cocher qui ouvre/ferme une radiobox. Plus de détails...
struct	EntryState
	arguments pour la transformation depuis |ButtonOption|, |CheckboxOption|, |RadioboxOption|, |MenuEntryOption|, |MenuOption|. Plus de détails...
struct	Event
	Représente un événement. Il peut s'agir d'un événement de touche, d'un redimensionnement de terminal, ou plus encore... 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...
class	Image
	Une grille rectangulaire de pixels. Plus de détails...
struct	InputOption
	Option pour le composant Input. Plus de détails...
struct	InputState
	Utilisé pour définir le style du composant Input. 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	Loop
	Loop est une classe qui gère la boucle d'événements pour un composant. Plus de détails...
struct	MenuEntryOption
	Option pour le composant MenuEntry. Plus de détails...
struct	MenuOption
	Option pour le composant Menu. Plus de détails...
struct	Mouse
	Un événement de souris. Il contient les coordonnées de la souris, le bouton pressé et le modificateur (shift, ctrl, méta). 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...
class	NodeDecorator
struct	Pixel
	Un caractère Unicode et son style associé. Plus de détails...
struct	RadioboxOption
	Option pour le composant Radiobox. Plus de détails...
class	ReceiverImpl
class	Ref
	Un adaptateur. Possède ou référence un objet mutable. 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...
struct	ResizableSplitOption
class	Screen
	Une grille rectangulaire de pixels. Plus de détails...
class	ScreenInteractive
	ScreenInteractive est un Screen qui peut gérer les événements, exécuter une boucle principale et gérer les composants. Plus de détails...
class	Selection
	Représente une sélection dans une interface utilisateur de terminal. Plus de détails...
class	SenderImpl
struct	SliderOption
class	StringRef
	Un adaptateur. Possède ou référence une chaîne constante. Par commodité, cette classe convertit plusieurs chaînes mutables vers une représentation partagée. Plus de détails...
class	Table
	Table est un utilitaire pour dessiner des tableaux. Plus de détails...
class	TableSelection
class	TerminalInputParser
struct	UnderlineOption
	Option pour l'effet de soulignement. Plus de détails...
struct	WindowOptions
struct	WindowRenderState
	État passé à la fonction de rendu du composant Window. Plus de détails...

Définitions de type
using	CapturedMouse = std::unique_ptr<CapturedMouseInterface>
using	ComponentDecorator = std::function<Component(Component)>
using	ElementDecorator = std::function<Element(Element)>
using	Component = std::shared_ptr<ComponentBase>
using	Components = std::vector<Component>
template<class T >
using	Sender = std::unique_ptr<SenderImpl<T>>
template<class T >
using	Receiver = std::unique_ptr<ReceiverImpl<T>>
using	Closure = std::function<void()>
using	Task = std::variant<Event, Closure, AnimationTask>
using	Element = std::shared_ptr<Node>
using	Elements = std::vector<Element>
using	Decorator = std::function<Element(Element)>
using	GraphFunction = std::function<std::vector<int>(int, int)>

É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...
enum	WidthOrHeight {   WIDTH ,   HEIGHT }
enum	Constraint {   LESS_THAN ,   EQUAL ,   GREATER_THAN }
enum class	WordBreakProperty : int8_t {   ALetter ,   CR ,   Double_Quote ,   Extend ,   ExtendNumLet ,   Format ,   Hebrew_Letter ,   Katakana ,   LF ,   MidLetter ,   MidNum ,   MidNumLet ,   Newline ,   Numeric ,   Regional_Indicator ,   Single_Quote ,   WSegSpace ,   ZWJ }

Fonctions
template<class T , class... Args>
std::shared_ptr< T >	Make (Args &&... args)
Component	operator| (Component component, ComponentDecorator decorator)
Component	operator| (Component component, ElementDecorator decorator)
Component &	operator|= (Component &component, ComponentDecorator decorator)
Component &	operator|= (Component &component, ElementDecorator decorator)
Component	Button (ButtonOption option)
	Dessine un bouton. Exécute une fonction lors d'un clic.
Component	Button (ConstStringRef label, std::function< void()> on_click, ButtonOption option)
	Dessine un bouton. Exécute une fonction lors d'un clic.
Component	Checkbox (CheckboxOption option)
	Dessine un élément à cocher.
Component	Checkbox (ConstStringRef label, bool *checked, CheckboxOption option)
	Dessine un élément à cocher.
Component	Input (InputOption option)
	Une zone de saisie pour éditer du texte.
Component	Input (StringRef content, InputOption option)
	Une zone de saisie pour éditer du texte.
Component	Input (StringRef content, StringRef placeholder, InputOption option)
	Une zone de saisie pour éditer du texte.
Component	Menu (MenuOption option)
	Une liste de texte. L'élément sélectionné est mis en évidence.
Component	Menu (ConstStringListRef entries, int *selected, MenuOption option)
	Une liste de texte. L'élément sélectionné est mis en évidence.
Component	MenuEntry (MenuEntryOption option)
	Une entrée de menu spécifique. Elles peuvent être placées dans un Container::Vertical pour former un menu.
Component	MenuEntry (ConstStringRef label, MenuEntryOption option)
	Une entrée de menu spécifique. Elles peuvent être placées dans un Container::Vertical pour former un menu.
Component	Radiobox (RadioboxOption option)
	Une liste d'éléments, où un seul peut être sélectionné.
Component	Radiobox (ConstStringListRef entries, int *selected, RadioboxOption option)
	Une liste d'éléments, où un seul peut être sélectionné.
Component	Dropdown (ConstStringListRef entries, int *selected)
	Un menu déroulant.
Component	Dropdown (DropdownOption option)
	Un menu déroulant.
Component	Toggle (ConstStringListRef entries, int *selected)
	Une liste horizontale d'éléments. L'utilisateur peut naviguer à travers eux.
template<typename T >
Component	Slider (SliderOption< T > options)
	Un curseur dans n'importe quelle direction.
Component	Slider (ConstStringRef label, Ref< int > value, ConstRef< int > min, ConstRef< int > max, ConstRef< int > increment)
	Un curseur horizontal.
Component	Slider (ConstStringRef label, Ref< float > value, ConstRef< float > min=0.f, ConstRef< float > max=100.f, ConstRef< float > increment=5.f)
Component	Slider (ConstStringRef label, Ref< long > value, ConstRef< long > min=0L, ConstRef< long > max=100L, ConstRef< long > increment=5L)
Component	ResizableSplit (ResizableSplitOption options)
	Une séparation entre deux composants.
Component	ResizableSplitLeft (Component main, Component back, int *main_size)
	Une séparation horizontale entre deux composants, configurable à l'aide de la souris.
Component	ResizableSplitRight (Component main, Component back, int *main_size)
	Une séparation horizontale entre deux composants, configurable à l'aide de la souris.
Component	ResizableSplitTop (Component main, Component back, int *main_size)
	Une séparation verticale entre deux composants, configurable à l'aide de la souris.
Component	ResizableSplitBottom (Component main, Component back, int *main_size)
	Une séparation verticale entre deux composants, configurable à l'aide de la souris.
Component	Renderer (Component child, std::function< Element()> render)
	Renvoie un nouveau composant, similaire à |child|, mais utilisant |render| comme événement Component::Render().
Component	Renderer (std::function< Element()> render)
	Renvoie un composant, utilisant |render| pour afficher son interface.
Component	Renderer (std::function< Element(bool)> render)
	Renvoie un composant focusable, utilisant |render| pour afficher son interface.
ComponentDecorator	Renderer (ElementDecorator decorator)
	Décore un composant, en décorant ce qu'il rend.
Component	CatchEvent (Component child, std::function< bool(Event)>)
ComponentDecorator	CatchEvent (std::function< bool(Event)> on_event)
	Décore un composant, utilisant |on_event| pour intercepter les événements. Cette fonction doit retourner 'true' si l'événement a été géré, 'false' sinon.
Component	Maybe (Component child, const bool *show)
	Décore un composant |child|. Il est affiché uniquement lorsque |show| est vrai.
Component	Maybe (Component child, std::function< bool()> show)
	Décore un composant |child|. Il est affiché uniquement lorsque |show| retourne vrai.
ComponentDecorator	Maybe (const bool *show)
	Décore un composant. Il est affiché uniquement lorsque |show| est vrai.
ComponentDecorator	Maybe (std::function< bool()> show)
	Décore un composant. Il est affiché uniquement lorsque la fonction |show| retourne vrai.
Component	Modal (Component main, Component modal, const bool *show_modal)
ComponentDecorator	Modal (Component modal, const bool *show_modal)
Component	Collapsible (ConstStringRef label, Component child, Ref< bool > show)
	Un composant repliable. Il affiche une case à cocher avec une flèche. Une fois activé, l'enfant est affiché.
Component	Hoverable (Component component, bool *hover)
	Encapsule un composant. Donne la possibilité de savoir s'il est survolé par la souris.
Component	Hoverable (Component component, std::function< void()> on_enter, std::function< void()> on_leave)
	Encapsule un composant. Utilise des callbacks.
Component	Hoverable (Component component, std::function< void(bool)> on_change)
	Encapsule un composant. Donne la possibilité de savoir s'il est survolé par la souris.
ComponentDecorator	Hoverable (bool *hover)
	Encapsule un composant. Donne la possibilité de savoir s'il est survolé par la souris.
ComponentDecorator	Hoverable (std::function< void()> on_enter, std::function< void()> on_leave)
	Encapsule un composant. Donne la possibilité de savoir s'il est survolé par la souris.
ComponentDecorator	Hoverable (std::function< void(bool)> on_change)
	Encapsule un composant. Donne la possibilité de savoir s'il est survolé par la souris.
Component	Window (WindowOptions option)
template<class T >
Receiver< T >	MakeReceiver ()
Element	text (std::wstring text)
	Affiche un morceau de texte unicode.
Element	vtext (std::wstring text)
	Affiche un morceau de texte unicode verticalement.
Elements	paragraph (std::wstring text)
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.
void	Render (Screen &screen, const Element &element)
void	Render (Screen &screen, Node *node)
void	Render (Screen &screen, Node *node, Selection &selection)
std::string	GetNodeSelectedContent (Screen &screen, Node *node, Selection &selection)
Color	operator""_rgb (unsigned long long int combined)
	Crée une couleur à partir d'une représentation RGB hexadécimale combinée, par exemple 0x808000_rgb.
ColorInfo	GetColorInfo (Color::Palette256 index)
ColorInfo	GetColorInfo (Color::Palette16 index)
int	wchar_width (wchar_t)
int	wstring_width (const std::wstring &)
std::string	to_string (const std::wstring &s)
	Convertit un std::wstring en un std::string UTF8.
std::wstring	to_wstring (const std::string &s)
	Convertit un std::string UTF8 en un std::wstring.
template<typename T >
std::wstring	to_wstring (T s)
int	string_width (const std::string &)
std::vector< std::string >	Utf8ToGlyphs (const std::string &input)
std::vector< int >	CellToGlyphIndex (const std::string &input)
Component	CatchEvent (Component child, std::function< bool(Event event)> on_event)
	Retourne un composant, utilisant |on_event| pour intercepter les événements. Cette fonction doit retourner 'true' si l'événement a été géré, 'false' sinon.
template Component	Slider (SliderOption< int8_t >)
template Component	Slider (SliderOption< int16_t >)
template Component	Slider (SliderOption< int32_t >)
template Component	Slider (SliderOption< int64_t >)
template Component	Slider (SliderOption< uint8_t >)
template Component	Slider (SliderOption< uint16_t >)
template Component	Slider (SliderOption< uint32_t >)
template Component	Slider (SliderOption< uint64_t >)
template Component	Slider (SliderOption< float >)
template Component	Slider (SliderOption< double >)
	for (auto &child :children_)
	Affiche un élément sur un ftxui::Screen.
	for (int y=y_min_;y<=y_max_;++y)
	Applique le décorateur à la sélection. Ceci décore uniquement les coins modulo modulo avec un décalage de shift.
Element	operator| (Element element, Decorator decorator)
	À partir d'un élément, appliquer un décorateur.
bool	EatCodePoint (const std::string &input, size_t start, size_t *end, uint32_t *ucs)
bool	EatCodePoint (const std::wstring &input, size_t start, size_t *end, uint32_t *ucs)
bool	IsCombining (uint32_t ucs)
bool	IsFullWidth (uint32_t ucs)
bool	IsControl (uint32_t ucs)
WordBreakProperty	CodepointToWordBreakProperty (uint32_t codepoint)
size_t	GlyphPrevious (const std::string &input, size_t start)
size_t	GlyphNext (const std::string &input, size_t start)
size_t	GlyphIterate (const std::string &input, int glyph_offset, size_t start)
int	GlyphCount (const std::string &input)
std::vector< WordBreakProperty >	Utf8ToWordBreakProperty (const std::string &input)
bool	IsWordBreakingCharacter (const std::string &input, size_t glyph_index)

Variables
const std::map< std::string, std::string >	g_uniformize
const std::array< ColorInfo, 256 >	palette256

Description détaillée

L'espace de noms FTXUI ftxui::

L'espace de nommage ftxui:: de FTXUI.

L'espace de noms FTXUI ftxui:: namespace.

L'espace de noms ftxui:: de FTXUI.

Le namespace FTXUI ftxui::

/

Documentation des définitions de type

CapturedMouse

using CapturedMouse = std::unique_ptr<CapturedMouseInterface>

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

ComponentDecorator

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

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

ElementDecorator

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

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

Component

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

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

Components

using Components = std::vector<Component>

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

Sender

template<class T >

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

Définition à la ligne 52 du fichier receiver.hpp.

Receiver

template<class T >

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

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

Closure

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

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

Task

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

Définition à la ligne 14 du fichier task.hpp.

Element

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

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

Elements

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

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

Decorator

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

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

GraphFunction

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

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

Documentation du type de l'énumération

WidthOrHeight

enum WidthOrHeight

Valeurs énumérées
WIDTH
HEIGHT

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

Constraint

enum Constraint

Valeurs énumérées
LESS_THAN
EQUAL
GREATER_THAN

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

WordBreakProperty

enum class WordBreakProperty : int8_t

strong

Valeurs énumérées
ALetter
CR
Double_Quote
Extend
ExtendNumLet
Format
Hebrew_Letter
Katakana
LF
MidLetter
MidNum
MidNumLet
Newline
Numeric
Regional_Indicator
Single_Quote
WSegSpace
ZWJ

Définition à la ligne 40 du fichier string_internal.hpp.

Documentation des fonctions

Make()

template<class T , class... Args>

std::shared_ptr< T > Make

(

Args &&...

args

)

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

operator|() [1/4]

Component operator|	(	Component	component,
		ComponentDecorator	decorator )

Définition à la ligne 12 du fichier component/util.cpp.

operator|() [2/4]

Component operator|	(	Component	component,
		ElementDecorator	decorator )

Définition à la ligne 17 du fichier component/util.cpp.

operator|=() [1/2]

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

Définition à la ligne 22 du fichier component/util.cpp.

operator|=() [2/2]

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

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

Slider() [1/13]

template<typename T >

Component Slider

(

SliderOption< T >

options

)

Un curseur dans n'importe quelle direction.

Paramètres

options

Les options

Exemple

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

Définition à la ligne 316 du fichier src/ftxui/component/slider.cpp.

Slider() [2/13]

Component Slider	(	ConstStringRef	label,
		Ref< float >	value,
		ConstRef< float >	min = 0.f,
		ConstRef< float >	max = 100.f,
		ConstRef< float >	increment = 5.f )

Définition à la ligne 273 du fichier src/ftxui/component/slider.cpp.

Slider() [3/13]

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

Définition à la ligne 286 du fichier src/ftxui/component/slider.cpp.

ResizableSplit()

Component ResizableSplit

(

ResizableSplitOption

options

)

Une séparation entre deux composants.

Paramètres

options

tous les paramètres.

Exemple

auto left = Renderer([] { return text("Left") | center;});
auto right = Renderer([] { return text("right") | center;});
int left_size = 10;
auto component = ResizableSplit({
  .main = left,
  .back = right,
  .direction = Direction::Left,
  .main_size = &left_size,
  .separator_func = [] { return separatorDouble(); },
});

Sortie

       ║
left   ║   right
       ║

Définition à la ligne 170 du fichier src/ftxui/component/resizable_split.cpp.

CatchEvent()

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

Collapsible()

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

Un composant repliable. Il affiche une case à cocher avec une flèche. Une fois activé, l'enfant est affiché.

Paramètres

label	Le libellé de la case à cocher.
child	L'enfant à afficher.
show	Contient l'état indiquant si l'enfant est affiché ou non.

Exemple

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

Sortie

▼ Show details
<details component>

Définition à la ligne 33 du fichier src/ftxui/component/collapsible.cpp.

Window()

Component Window

(

WindowOptions

option

)

MakeReceiver()

template<class T >

Receiver< T > MakeReceiver

(

)

Définition à la ligne 149 du fichier receiver.hpp.

paragraph()

Elements paragraph

(

std::wstring

text

)

operator|() [3/4]

Decorator operator|	(	Decorator	a,
		Decorator	b )

Compose deux décorateurs en un seul.

Exemple

auto decorator = bold | blink;

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

separatorHSelector()

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.

Paramètres

left	la limite gauche de la zone active.
right	la limite droite de la zone active.
selected_color	la couleur de la zone sélectionnée.
unselected_color	la couleur de la zone non sélectionnée.

Exemple

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

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

separatorVSelector()

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.

Paramètres

up	la limite supérieure de la zone active.
down	la limite inférieure de la zone active.
selected_color	la couleur de la zone sélectionnée.
unselected_color	la couleur de la zone non sélectionnée.

Exemple

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

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

gauge()

Element gauge

(

float

progress

)

gaugeLeft()

Element gaugeLeft

(

float

progress

)

gaugeRight()

Element gaugeRight

(

float

progress

)

gaugeUp()

Element gaugeUp

(

float

progress

)

gaugeDown()

Element gaugeDown

(

float

progress

)

gaugeDirection()

Element gaugeDirection	(	float	progress,
		Direction	direction )

graph()

Element graph

(

GraphFunction

graph_function

)

Dessine un graphique en utilisant une GraphFunction.

Paramètres

graph_function

la fonction à appeler pour obtenir les données.

Définition à la ligne 80 du fichier src/ftxui/dom/graph.cpp.

canvas() [1/3]

Element canvas

(

ConstRef< Canvas >

canvas

)

Produit un élément à partir d'un Canevas, ou une référence à un Canevas.

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

canvas() [2/3]

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

Produit un élément dessinant un canevas de la taille demandée.

Paramètres

width	la largeur du canevas.
height	la hauteur du canevas.
fn	une fonction dessinant le canevas.

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

canvas() [3/3]

Element canvas

(

std::function< void(Canvas &)>

fn

)

Produit un élément dessinant un canevas.

Paramètres

fn	une fonction dessinant le canevas.

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

color() [1/2]

Decorator color

(

const LinearGradient &

)

bgcolor() [1/2]

Decorator bgcolor

(

const LinearGradient &

)

color() [2/2]

Element color	(	const LinearGradient &	,
		Element	)

bgcolor() [2/2]

Element bgcolor	(	const LinearGradient &	,
		Element	)

hyperlink() [1/2]

Decorator hyperlink

(

std::string

link

)

hyperlink() [2/2]

Element hyperlink	(	std::string	link,
		Element	child )

selectionStyleReset()

Element selectionStyleReset

(

Element

child

)

Réinitialise le style de sélection d'un élément.

Paramètres

child

L'élément d'entrée.

Renvoie

L'élément de sortie avec le style de sélection réinitialisé.

Définition à la ligne 55 du fichier selection_style.cpp.

selectionColor()

Decorator selectionColor

(

Color

foreground

)

Définit la couleur d'un élément lorsqu'il est sélectionné.

Paramètres

foreground

La couleur à appliquer. Notez que le style est appliqué en plus du style existant.

Définition à la ligne 78 du fichier selection_style.cpp.

selectionBackgroundColor()

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.

Définition à la ligne 61 du fichier selection_style.cpp.

selectionForegroundColor()

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.

Définition à la ligne 69 du fichier selection_style.cpp.

selectionStyle()

Decorator selectionStyle

(

std::function< void(Pixel &)>

style

)

Définit le style d'un élément lorsqu'il est sélectionné.

Paramètres

style

Le style à appliquer. Notez que le style est appliqué en plus du style existant.

Définition à la ligne 86 du fichier selection_style.cpp.

hbox()

Element hbox

(

Elements

children

)

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

Paramètres

children

Les éléments dans le conteneur

Renvoie

Le conteneur.

Exemple

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

Définition à la ligne 94 du fichier hbox.cpp.

flexbox()

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.

Paramètres

children	Les éléments dans le conteneur
config	Les options

Renvoie

Le conteneur.

Example

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

Définition à la ligne 251 du fichier flexbox.cpp.

gridbox()

Element gridbox

(

std::vector< Elements >

lines

)

Un conteneur affichant une grille d'éléments.

Paramètres

lines

Une liste de lignes, chaque ligne étant une liste d'éléments.

Renvoie

Le conteneur.

Exemple

auto cell = [](const char* t) { return text(t) | border; };
auto document = gridbox({
  {cell("nord-ouest") , cell("nord")  , cell("nord-est")} ,
  {cell("ouest")       , cell("centre") , cell("est")}       ,
  {cell("sud-ouest") , cell("sud")  , cell("sud-est")} ,
});

Output:

╭──────────╮╭──────╮╭──────────╮
│nord-ouest││nord  ││nord-est  │
╰──────────╯╰──────╯╰──────────╯
╭──────────╮╭──────╮╭──────────╮
│ouest     ││centre││est       │
╰──────────╯╰──────╯╰──────────╯
╭──────────╮╭──────╮╭──────────╮
│sud-ouest ││sud   ││sud-est   │
╰──────────╯╰──────╯╰──────────╯

Définition à la ligne 173 du fichier src/ftxui/dom/gridbox.cpp.

hflow()

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.

Paramètres

children

Les éléments dans le conteneur

Renvoie

Le conteneur.

Example

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

Définition à la ligne 269 du fichier flexbox.cpp.

vflow()

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.

Paramètres

children

Les éléments dans le conteneur

Renvoie

Le conteneur.

Example

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

Définition à la ligne 287 du fichier flexbox.cpp.

frame()

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.

Voir également

frame

xframe

yframe

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

xframe()

Element xframe

(

Element

child

)

Identique à frame, mais seulement sur l'axe x.

Voir également

frame

xframe

yframe

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

yframe()

Element yframe

(

Element

child

)

Identique à frame, mais seulement sur l'axe y.

Voir également

frame

xframe

yframe

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

select()

Element select

(

Element

child

)

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

Ceci est obsolète. Utilisez focus à la place.

Paramètres

child

L'élément à focaliser.

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

reflect()

Decorator reflect

(

Box &

box

)

Définition à la ligne 43 du fichier reflect.cpp.

Render() [1/3]

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

Render() [2/3]

void Render	(	Screen &	screen,
		Node *	node )

Render() [3/3]

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

GetNodeSelectedContent()

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

GetColorInfo() [1/2]

ColorInfo GetColorInfo

(

Color::Palette256

index

)

Définition à la ligne 272 du fichier color_info.cpp.

GetColorInfo() [2/2]

ColorInfo GetColorInfo

(

Color::Palette16

index

)

Définition à la ligne 276 du fichier color_info.cpp.

wchar_width()

int wchar_width

(

wchar_t

ucs

)

Définition à la ligne 1314 du fichier string.cpp.

wstring_width()

int wstring_width

(

const std::wstring &

text

)

Définition à la ligne 1318 du fichier string.cpp.

to_string()

std::string to_string

(

const std::wstring &

s

)

Convertit un std::wstring en un std::string UTF8.

Définition à la ligne 1566 du fichier string.cpp.

to_wstring() [1/2]

std::wstring to_wstring

(

const std::string &

s

)

Convertit un std::string UTF8 en un std::wstring.

Définition à la ligne 1638 du fichier string.cpp.

to_wstring() [2/2]

template<typename T >

std::wstring to_wstring

(

T

s

)

Définition à la ligne 15 du fichier string.hpp.

string_width()

int string_width

(

const std::string &

input

)

Définition à la ligne 1331 du fichier string.cpp.

Utf8ToGlyphs()

std::vector< std::string > Utf8ToGlyphs

(

const std::string &

input

)

Définition à la ligne 1358 du fichier string.cpp.

CellToGlyphIndex()

std::vector< int > CellToGlyphIndex

(

const std::string &

input

)

Définition à la ligne 1465 du fichier string.cpp.

Slider() [4/13]

template Component Slider

(

SliderOption< int8_t >

)

Slider() [5/13]

template Component Slider

(

SliderOption< int16_t >

)

Slider() [6/13]

template Component Slider

(

SliderOption< int32_t >

)

Slider() [7/13]

template Component Slider

(

SliderOption< int64_t >

)

Slider() [8/13]

template Component Slider

(

SliderOption< uint8_t >

)

Slider() [9/13]

template Component Slider

(

SliderOption< uint16_t >

)

Slider() [10/13]

template Component Slider

(

SliderOption< uint32_t >

)

Slider() [11/13]

template Component Slider

(

SliderOption< uint64_t >

)

Slider() [12/13]

template Component Slider

(

SliderOption< float >

)

Slider() [13/13]

template Component Slider

(

SliderOption< double >

)

for() [1/2]

for

(

auto &child :children_

)

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

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

for() [2/2]

for

(

int

y = y_min_; y <= y_max_; ++y

)

Applique le décorateur à la sélection. Ceci décore uniquement les coins modulo modulo avec un décalage de shift.

Paramètres

decorator	Le décorateur à appliquer.
modulo	Le modulo des coins à décorer.
shift	Le décalage des coins à décorer. {

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

operator|() [4/4]

Element operator|	(	Element	element,
		Decorator	decorator )

À partir d'un élément, appliquer un décorateur.

Renvoie

l'élément décoré.

Exemple

Les deux sont équivalents :

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

EatCodePoint() [1/2]

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

Définition à la ligne 1174 du fichier string.cpp.

EatCodePoint() [2/2]

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

Définition à la ligne 1244 du fichier string.cpp.

IsCombining()

bool IsCombining

(

uint32_t

ucs

)

Définition à la ligne 1282 du fichier string.cpp.

IsFullWidth()

bool IsFullWidth

(

uint32_t

ucs

)

Définition à la ligne 1286 du fichier string.cpp.

IsControl()

bool IsControl

(

uint32_t

ucs

)

Définition à la ligne 1294 du fichier string.cpp.

CodepointToWordBreakProperty()

WordBreakProperty CodepointToWordBreakProperty

(

uint32_t

codepoint

)

Définition à la ligne 1308 du fichier string.cpp.

GlyphPrevious()

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

Définition à la ligne 1400 du fichier string.cpp.

GlyphNext()

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

Définition à la ligne 1425 du fichier string.cpp.

GlyphIterate()

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

Définition à la ligne 1451 du fichier string.cpp.

GlyphCount()

int GlyphCount

(

const std::string &

input

)

Définition à la ligne 1506 du fichier string.cpp.

Utf8ToWordBreakProperty()

std::vector< WordBreakProperty > Utf8ToWordBreakProperty

(

const std::string &

input

)

Définition à la ligne 1534 du fichier string.cpp.

IsWordBreakingCharacter()

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

Documentation des variables

g_uniformize

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

Définition à la ligne 19 du fichier terminal_input_parser.cpp.

palette256

const std::array<ColorInfo, 256> palette256

Définition à la ligne 13 du fichier color_info.cpp.