FTXUI 6.1.9
C++ functional terminal UI.
Chargement...
Recherche...
Aucune correspondance
Espaces de nommage | Classes | Énumérations | Fonctions
ftxui/screen

Description détaillée

Veuillez consulter le tutoriel du module ftxui/screen.

Espaces de nommage

namespace  ftxui::Dimension
 Définit l'apparence des dimensions de l'écran.
 

Classes

struct  Box
 Box est une structure qui représente une zone rectangulaire dans un espace 2D. 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  Image
 Une grille rectangulaire de pixels. Plus de détails...
 
struct  Pixel
 Un caractère Unicode et son style associé. Plus de détails...
 
class  Screen
 Une grille rectangulaire de pixels. Plus de détails...
 
struct  Dimensions
 Dimensions est une structure qui représente la taille du terminal. Plus de détails...
 

Énumérations

enum  Color {
  Palette1 ,
  Palette16 ,
  Palette256 ,
  TrueColor
}
 Color est une énumération qui représente le support des couleurs du terminal. Plus de détails...
 

Fonctions

Dimensions Size ()
 Obtenir la taille du terminal.
 
Color ColorSupport ()
 Obtenir le support couleur du terminal.
 

Documentation des classes

◆ ftxui::Box

struct ftxui::Box

Box est une structure qui représente une zone rectangulaire dans un espace 2D.

Elle est définie par ses coordonnées minimales et maximales le long des axes x et y. Notez que les coordonnées sont inclusives, ce qui signifie que la boîte comprend à la fois les valeurs minimales et maximales.

Définition à la ligne 16 du fichier box.hpp.

Fonctions membres publiques

void Shift (int x, int y)
 
bool Contain (int x, int y) const
 
bool IsEmpty () const
 
bool operator== (const Box &other) const
 
bool operator!= (const Box &other) const
 

Fonctions membres publiques statiques

static auto Intersection (Box a, Box b) -> Box
 
static auto Union (Box a, Box b) -> Box
 

Attributs publics

int x_min = 0
 
int x_max = 0
 
int y_min = 0
 
int y_max = 0
 

Documentation des fonctions membres

◆ Intersection()

Box Intersection ( Box a,
Box b ) -> Box
static
Renvoie
la plus grande Box contenue dans |a| et |b|.

Définition à la ligne 11 du fichier box.cpp.

◆ Union()

Box Union ( Box a,
Box b ) -> Box
static
Renvoie
la plus petite Box contenant à la fois |a| et |b|.

Définition à la ligne 22 du fichier box.cpp.

◆ Shift()

void Shift ( int x,
int y )

Décale la boîte de (x,y).

Paramètres
xdécalage horizontal.
ydécalage vertical.

Définition à la ligne 34 du fichier box.cpp.

◆ Contain()

bool Contain ( int x,
int y ) const
Renvoie
si (x,y) est contenu dans la boîte.

Définition à la ligne 42 du fichier box.cpp.

◆ IsEmpty()

bool IsEmpty ( ) const
Renvoie
si la boîte est vide.

Définition à la ligne 50 du fichier box.cpp.

◆ operator==()

bool operator== ( const Box & other) const
Renvoie
si |other| est identique à |this|

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

◆ operator!=()

bool operator!= ( const Box & other) const
Renvoie
si |other| et |this| sont différents.

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

Documentation des données membres

◆ x_min

int x_min = 0

Définition à la ligne 17 du fichier box.hpp.

◆ x_max

int x_max = 0

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

◆ y_min

int y_min = 0

Définition à la ligne 19 du fichier box.hpp.

◆ y_max

int y_max = 0

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

◆ ftxui::Color

class ftxui::Color

Color est une classe qui représente une couleur dans l'interface utilisateur du terminal.

Exemples
examples/component/homescreen.cpp, examples/component/menu_entries.cpp, examples/component/menu_entries_animated.cpp, examples/dom/color_gallery.cpp, et examples/dom/color_info_palette256.cpp.

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

Types publics

enum  Palette1 : uint8_t { Default }
 
enum  Palette16 : uint8_t {
  Black = 0 ,
  Red = 1 ,
  Green = 2 ,
  Yellow = 3 ,
  Blue = 4 ,
  Magenta = 5 ,
  Cyan = 6 ,
  GrayLight = 7 ,
  GrayDark = 8 ,
  RedLight = 9 ,
  GreenLight = 10 ,
  YellowLight = 11 ,
  BlueLight = 12 ,
  MagentaLight = 13 ,
  CyanLight = 14 ,
  White = 15
}
 
enum  Palette256 : uint8_t {
  Aquamarine1 = 122 ,
  Aquamarine1Bis = 86 ,
  Aquamarine3 = 79 ,
  Blue1 = 21 ,
  Blue3 = 19 ,
  Blue3Bis = 20 ,
  BlueViolet = 57 ,
  CadetBlue = 72 ,
  CadetBlueBis = 73 ,
  Chartreuse1 = 118 ,
  Chartreuse2 = 112 ,
  Chartreuse2Bis = 82 ,
  Chartreuse3 = 70 ,
  Chartreuse3Bis = 76 ,
  Chartreuse4 = 64 ,
  CornflowerBlue = 69 ,
  Cornsilk1 = 230 ,
  Cyan1 = 51 ,
  Cyan2 = 50 ,
  Cyan3 = 43 ,
  DarkBlue = 18 ,
  DarkCyan = 36 ,
  DarkGoldenrod = 136 ,
  DarkGreen = 22 ,
  DarkKhaki = 143 ,
  DarkMagenta = 90 ,
  DarkMagentaBis = 91 ,
  DarkOliveGreen1 = 191 ,
  DarkOliveGreen1Bis = 192 ,
  DarkOliveGreen2 = 155 ,
  DarkOliveGreen3 = 107 ,
  DarkOliveGreen3Bis = 113 ,
  DarkOliveGreen3Ter = 149 ,
  DarkOrange = 208 ,
  DarkOrange3 = 130 ,
  DarkOrange3Bis = 166 ,
  DarkRed = 52 ,
  DarkRedBis = 88 ,
  DarkSeaGreen = 108 ,
  DarkSeaGreen1 = 158 ,
  DarkSeaGreen1Bis = 193 ,
  DarkSeaGreen2 = 151 ,
  DarkSeaGreen2Bis = 157 ,
  DarkSeaGreen3 = 115 ,
  DarkSeaGreen3Bis = 150 ,
  DarkSeaGreen4 = 65 ,
  DarkSeaGreen4Bis = 71 ,
  DarkSlateGray1 = 123 ,
  DarkSlateGray2 = 87 ,
  DarkSlateGray3 = 116 ,
  DarkTurquoise = 44 ,
  DarkViolet = 128 ,
  DarkVioletBis = 92 ,
  DeepPink1 = 198 ,
  DeepPink1Bis = 199 ,
  DeepPink2 = 197 ,
  DeepPink3 = 161 ,
  DeepPink3Bis = 162 ,
  DeepPink4 = 125 ,
  DeepPink4Bis = 89 ,
  DeepPink4Ter = 53 ,
  DeepSkyBlue1 = 39 ,
  DeepSkyBlue2 = 38 ,
  DeepSkyBlue3 = 31 ,
  DeepSkyBlue3Bis = 32 ,
  DeepSkyBlue4 = 23 ,
  DeepSkyBlue4Bis = 24 ,
  DeepSkyBlue4Ter = 25 ,
  DodgerBlue1 = 33 ,
  DodgerBlue2 = 27 ,
  DodgerBlue3 = 26 ,
  Gold1 = 220 ,
  Gold3 = 142 ,
  Gold3Bis = 178 ,
  Green1 = 46 ,
  Green3 = 34 ,
  Green3Bis = 40 ,
  Green4 = 28 ,
  GreenYellow = 154 ,
  Grey0 = 16 ,
  Grey100 = 231 ,
  Grey11 = 234 ,
  Grey15 = 235 ,
  Grey19 = 236 ,
  Grey23 = 237 ,
  Grey27 = 238 ,
  Grey3 = 232 ,
  Grey30 = 239 ,
  Grey35 = 240 ,
  Grey37 = 59 ,
  Grey39 = 241 ,
  Grey42 = 242 ,
  Grey46 = 243 ,
  Grey50 = 244 ,
  Grey53 = 102 ,
  Grey54 = 245 ,
  Grey58 = 246 ,
  Grey62 = 247 ,
  Grey63 = 139 ,
  Grey66 = 248 ,
  Grey69 = 145 ,
  Grey7 = 233 ,
  Grey70 = 249 ,
  Grey74 = 250 ,
  Grey78 = 251 ,
  Grey82 = 252 ,
  Grey84 = 188 ,
  Grey85 = 253 ,
  Grey89 = 254 ,
  Grey93 = 255 ,
  Honeydew2 = 194 ,
  HotPink = 205 ,
  HotPink2 = 169 ,
  HotPink3 = 132 ,
  HotPink3Bis = 168 ,
  HotPinkBis = 206 ,
  IndianRed = 131 ,
  IndianRed1 = 203 ,
  IndianRed1Bis = 204 ,
  IndianRedBis = 167 ,
  Khaki1 = 228 ,
  Khaki3 = 185 ,
  LightCoral = 210 ,
  LightCyan1Bis = 195 ,
  LightCyan3 = 152 ,
  LightGoldenrod1 = 227 ,
  LightGoldenrod2 = 186 ,
  LightGoldenrod2Bis = 221 ,
  LightGoldenrod2Ter = 222 ,
  LightGoldenrod3 = 179 ,
  LightGreen = 119 ,
  LightGreenBis = 120 ,
  LightPink1 = 217 ,
  LightPink3 = 174 ,
  LightPink4 = 95 ,
  LightSalmon1 = 216 ,
  LightSalmon3 = 137 ,
  LightSalmon3Bis = 173 ,
  LightSeaGreen = 37 ,
  LightSkyBlue1 = 153 ,
  LightSkyBlue3 = 109 ,
  LightSkyBlue3Bis = 110 ,
  LightSlateBlue = 105 ,
  LightSlateGrey = 103 ,
  LightSteelBlue = 147 ,
  LightSteelBlue1 = 189 ,
  LightSteelBlue3 = 146 ,
  LightYellow3 = 187 ,
  Magenta1 = 201 ,
  Magenta2 = 165 ,
  Magenta2Bis = 200 ,
  Magenta3 = 127 ,
  Magenta3Bis = 163 ,
  Magenta3Ter = 164 ,
  MediumOrchid = 134 ,
  MediumOrchid1 = 171 ,
  MediumOrchid1Bis = 207 ,
  MediumOrchid3 = 133 ,
  MediumPurple = 104 ,
  MediumPurple1 = 141 ,
  MediumPurple2 = 135 ,
  MediumPurple2Bis = 140 ,
  MediumPurple3 = 97 ,
  MediumPurple3Bis = 98 ,
  MediumPurple4 = 60 ,
  MediumSpringGreen = 49 ,
  MediumTurquoise = 80 ,
  MediumVioletRed = 126 ,
  MistyRose1 = 224 ,
  MistyRose3 = 181 ,
  NavajoWhite1 = 223 ,
  NavajoWhite3 = 144 ,
  NavyBlue = 17 ,
  Orange1 = 214 ,
  Orange3 = 172 ,
  Orange4 = 58 ,
  Orange4Bis = 94 ,
  OrangeRed1 = 202 ,
  Orchid = 170 ,
  Orchid1 = 213 ,
  Orchid2 = 212 ,
  PaleGreen1 = 121 ,
  PaleGreen1Bis = 156 ,
  PaleGreen3 = 114 ,
  PaleGreen3Bis = 77 ,
  PaleTurquoise1 = 159 ,
  PaleTurquoise4 = 66 ,
  PaleVioletRed1 = 211 ,
  Pink1 = 218 ,
  Pink3 = 175 ,
  Plum1 = 219 ,
  Plum2 = 183 ,
  Plum3 = 176 ,
  Plum4 = 96 ,
  Purple = 129 ,
  Purple3 = 56 ,
  Purple4 = 54 ,
  Purple4Bis = 55 ,
  PurpleBis = 93 ,
  Red1 = 196 ,
  Red3 = 124 ,
  Red3Bis = 160 ,
  RosyBrown = 138 ,
  RoyalBlue1 = 63 ,
  Salmon1 = 209 ,
  SandyBrown = 215 ,
  SeaGreen1 = 84 ,
  SeaGreen1Bis = 85 ,
  SeaGreen2 = 83 ,
  SeaGreen3 = 78 ,
  SkyBlue1 = 117 ,
  SkyBlue2 = 111 ,
  SkyBlue3 = 74 ,
  SlateBlue1 = 99 ,
  SlateBlue3 = 61 ,
  SlateBlue3Bis = 62 ,
  SpringGreen1 = 48 ,
  SpringGreen2 = 42 ,
  SpringGreen2Bis = 47 ,
  SpringGreen3 = 35 ,
  SpringGreen3Bis = 41 ,
  SpringGreen4 = 29 ,
  SteelBlue = 67 ,
  SteelBlue1 = 75 ,
  SteelBlue1Bis = 81 ,
  SteelBlue3 = 68 ,
  Tan = 180 ,
  Thistle1 = 225 ,
  Thistle3 = 182 ,
  Turquoise2 = 45 ,
  Turquoise4 = 30 ,
  Violet = 177 ,
  Wheat1 = 229 ,
  Wheat4 = 101 ,
  Yellow1 = 226 ,
  Yellow2 = 190 ,
  Yellow3 = 148 ,
  Yellow3Bis = 184 ,
  Yellow4 = 100 ,
  Yellow4Bis = 106
}
 

Fonctions membres publiques

 Color ()
 Construit une couleur transparente.
 
 Color (Palette1 index)
 Construit une couleur transparente.
 
 Color (Palette16 index)
 Construit une couleur en utilisant les couleurs de la Palette16.
 
 Color (Palette256 index)
 Construit une couleur en utilisant les couleurs de la Palette256.
 
 Color (uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha=255)
 Construit une couleur à partir de sa représentation RGB. https://en.wikipedia.org/wiki/RGB_color_model.
 
bool operator== (const Color &rhs) const
 
bool operator!= (const Color &rhs) const
 
std::string Print (bool is_background_color) const
 
bool IsOpaque () const
 

Fonctions membres publiques statiques

static Color RGB (uint8_t red, uint8_t green, uint8_t blue)
 Construit une couleur à partir de sa représentation RGB. https://en.wikipedia.org/wiki/RGB_color_model.
 
static Color HSV (uint8_t hue, uint8_t saturation, uint8_t value)
 Construit une couleur à partir de sa représentation HSV. https://en.wikipedia.org/wiki/HSL_and_HSV.
 
static Color RGBA (uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha)
 Construit une couleur à partir de sa représentation RGBA. https://en.wikipedia.org/wiki/RGB_color_model.
 
static Color HSVA (uint8_t hue, uint8_t saturation, uint8_t value, uint8_t alpha)
 Construit une couleur à partir de sa représentation HSV. https://en.wikipedia.org/wiki/HSL_and_HSV.
 
static Color Interpolate (float t, const Color &a, const Color &b)
 
static Color Blend (const Color &lhs, const Color &rhs)
 Mélange deux couleurs en utilisant le canal alpha.
 

Documentation des énumérations membres

◆ Palette1

enum Palette1 : uint8_t
Valeurs énumérées
Default 

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

◆ Palette16

enum Palette16 : uint8_t
Valeurs énumérées
Black 
Red 
Green 
Yellow 
Blue 
Magenta 
Cyan 
GrayLight 
GrayDark 
RedLight 
GreenLight 
YellowLight 
BlueLight 
MagentaLight 
CyanLight 
White 

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

◆ Palette256

enum Palette256 : uint8_t
Valeurs énumérées
Aquamarine1 
Aquamarine1Bis 
Aquamarine3 
Blue1 
Blue3 
Blue3Bis 
BlueViolet 
CadetBlue 
CadetBlueBis 
Chartreuse1 
Chartreuse2 
Chartreuse2Bis 
Chartreuse3 
Chartreuse3Bis 
Chartreuse4 
CornflowerBlue 
Cornsilk1 
Cyan1 
Cyan2 
Cyan3 
DarkBlue 
DarkCyan 
DarkGoldenrod 
DarkGreen 
DarkKhaki 
DarkMagenta 
DarkMagentaBis 
DarkOliveGreen1 
DarkOliveGreen1Bis 
DarkOliveGreen2 
DarkOliveGreen3 
DarkOliveGreen3Bis 
DarkOliveGreen3Ter 
DarkOrange 
DarkOrange3 
DarkOrange3Bis 
DarkRed 
DarkRedBis 
DarkSeaGreen 
DarkSeaGreen1 
DarkSeaGreen1Bis 
DarkSeaGreen2 
DarkSeaGreen2Bis 
DarkSeaGreen3 
DarkSeaGreen3Bis 
DarkSeaGreen4 
DarkSeaGreen4Bis 
DarkSlateGray1 
DarkSlateGray2 
DarkSlateGray3 
DarkTurquoise 
DarkViolet 
DarkVioletBis 
DeepPink1 
DeepPink1Bis 
DeepPink2 
DeepPink3 
DeepPink3Bis 
DeepPink4 
DeepPink4Bis 
DeepPink4Ter 
DeepSkyBlue1 
DeepSkyBlue2 
DeepSkyBlue3 
DeepSkyBlue3Bis 
DeepSkyBlue4 
DeepSkyBlue4Bis 
DeepSkyBlue4Ter 
DodgerBlue1 
DodgerBlue2 
DodgerBlue3 
Gold1 
Gold3 
Gold3Bis 
Green1 
Green3 
Green3Bis 
Green4 
GreenYellow 
Grey0 
Grey100 
Grey11 
Grey15 
Grey19 
Grey23 
Grey27 
Grey3 
Grey30 
Grey35 
Grey37 
Grey39 
Grey42 
Grey46 
Grey50 
Grey53 
Grey54 
Grey58 
Grey62 
Grey63 
Grey66 
Grey69 
Grey7 
Grey70 
Grey74 
Grey78 
Grey82 
Grey84 
Grey85 
Grey89 
Grey93 
Honeydew2 
HotPink 
HotPink2 
HotPink3 
HotPink3Bis 
HotPinkBis 
IndianRed 
IndianRed1 
IndianRed1Bis 
IndianRedBis 
Khaki1 
Khaki3 
LightCoral 
LightCyan1Bis 
LightCyan3 
LightGoldenrod1 
LightGoldenrod2 
LightGoldenrod2Bis 
LightGoldenrod2Ter 
LightGoldenrod3 
LightGreen 
LightGreenBis 
LightPink1 
LightPink3 
LightPink4 
LightSalmon1 
LightSalmon3 
LightSalmon3Bis 
LightSeaGreen 
LightSkyBlue1 
LightSkyBlue3 
LightSkyBlue3Bis 
LightSlateBlue 
LightSlateGrey 
LightSteelBlue 
LightSteelBlue1 
LightSteelBlue3 
LightYellow3 
Magenta1 
Magenta2 
Magenta2Bis 
Magenta3 
Magenta3Bis 
Magenta3Ter 
MediumOrchid 
MediumOrchid1 
MediumOrchid1Bis 
MediumOrchid3 
MediumPurple 
MediumPurple1 
MediumPurple2 
MediumPurple2Bis 
MediumPurple3 
MediumPurple3Bis 
MediumPurple4 
MediumSpringGreen 
MediumTurquoise 
MediumVioletRed 
MistyRose1 
MistyRose3 
NavajoWhite1 
NavajoWhite3 
NavyBlue 
Orange1 
Orange3 
Orange4 
Orange4Bis 
OrangeRed1 
Orchid 
Orchid1 
Orchid2 
PaleGreen1 
PaleGreen1Bis 
PaleGreen3 
PaleGreen3Bis 
PaleTurquoise1 
PaleTurquoise4 
PaleVioletRed1 
Pink1 
Pink3 
Plum1 
Plum2 
Plum3 
Plum4 
Purple 
Purple3 
Purple4 
Purple4Bis 
PurpleBis 
Red1 
Red3 
Red3Bis 
RosyBrown 
RoyalBlue1 
Salmon1 
SandyBrown 
SeaGreen1 
SeaGreen1Bis 
SeaGreen2 
SeaGreen3 
SkyBlue1 
SkyBlue2 
SkyBlue3 
SlateBlue1 
SlateBlue3 
SlateBlue3Bis 
SpringGreen1 
SpringGreen2 
SpringGreen2Bis 
SpringGreen3 
SpringGreen3Bis 
SpringGreen4 
SteelBlue 
SteelBlue1 
SteelBlue1Bis 
SteelBlue3 
Tan 
Thistle1 
Thistle3 
Turquoise2 
Turquoise4 
Violet 
Wheat1 
Wheat4 
Yellow1 
Yellow2 
Yellow3 
Yellow3Bis 
Yellow4 
Yellow4Bis 

Définition à la ligne 71 du fichier color.hpp.

Documentation des constructeurs et destructeur

◆ Color() [1/5]

Color ( )
default

Construit une couleur transparente.

◆ Color() [2/5]

Color ( Palette1 index)

Construit une couleur transparente.

Définition à la ligne 80 du fichier screen/color.cpp.

◆ Color() [3/5]

Color ( Palette16 index)

Construit une couleur en utilisant les couleurs de la Palette16.

Définition à la ligne 83 du fichier screen/color.cpp.

◆ Color() [4/5]

Color ( Palette256 index)

Construit une couleur en utilisant les couleurs de la Palette256.

Définition à la ligne 87 du fichier screen/color.cpp.

◆ Color() [5/5]

Color ( uint8_t red,
uint8_t green,
uint8_t blue,
uint8_t alpha = 255 )

Construit une couleur à partir de sa représentation RGB. https://en.wikipedia.org/wiki/RGB_color_model.

Paramètres
redLa quantité de rouge [0,255]
greenLa quantité de vert [0,255]
blueLa quantité de bleu [0,255]
alphaLa quantité d'alpha [0,255]

Définition à la ligne 103 du fichier screen/color.cpp.

Documentation des fonctions membres

◆ RGB()

return RGB ( uint8_t red,
uint8_t green,
uint8_t blue )
static

Construit une couleur à partir de sa représentation RGB. https://en.wikipedia.org/wiki/RGB_color_model.

Paramètres
redLa quantité de rouge [0,255]
greenLa quantité de vert [0,255]
blueLa quantité de bleu [0,255]

Définition à la ligne 147 du fichier screen/color.cpp.

◆ HSV()

Color HSV ( uint8_t h,
uint8_t s,
uint8_t v )
static

Construit une couleur à partir de sa représentation HSV. https://en.wikipedia.org/wiki/HSL_and_HSV.

Paramètres
hLa teinte de la couleur [0,255]
sLa "saturation" [0,255].
vLa "luminosité" [0,255]

Définition à la ligne 198 du fichier screen/color.cpp.

◆ RGBA()

Color RGBA ( uint8_t red,
uint8_t green,
uint8_t blue,
uint8_t alpha )
static

Construit une couleur à partir de sa représentation RGBA. https://en.wikipedia.org/wiki/RGB_color_model.

Paramètres
redLa quantité de rouge [0,255]
greenLa quantité de vert [0,255]
blueLa quantité de bleu [0,255]
alphaLa quantité d'alpha [0,255]
Voir également
Color::RGB

Définition à la ligne 159 du fichier screen/color.cpp.

◆ HSVA()

Color HSVA ( uint8_t h,
uint8_t s,
uint8_t v,
uint8_t alpha )
static

Construit une couleur à partir de sa représentation HSV. https://en.wikipedia.org/wiki/HSL_and_HSV.

Paramètres
hLa teinte de la couleur [0,255]
sLa "saturation" [0,255].
vLa "luminosité" [0,255]
alphaLa quantité d'alpha [0,255]

Définition à la ligne 171 du fichier screen/color.cpp.

◆ Interpolate()

Color Interpolate ( float t,
const Color & a,
const Color & b )
static

Définition à la ligne 203 du fichier screen/color.cpp.

◆ Blend()

Color Blend ( const Color & lhs,
const Color & rhs )
static

Mélange deux couleurs en utilisant le canal alpha.

Définition à la ligne 271 du fichier screen/color.cpp.

◆ operator==()

bool operator== ( const Color & rhs) const

Définition à la ligne 37 du fichier screen/color.cpp.

◆ operator!=()

bool operator!= ( const Color & rhs) const

Définition à la ligne 42 du fichier screen/color.cpp.

◆ Print()

std::string Print ( bool is_background_color) const

Définition à la ligne 46 du fichier screen/color.cpp.

◆ IsOpaque()

bool IsOpaque ( ) const
inline

Définition à la ligne 320 du fichier color.hpp.

◆ ftxui::ColorInfo

struct ftxui::ColorInfo

ColorInfo est une structure qui contient des informations sur la palette de couleurs du terminal.

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

Attributs publics

const char * name
 
uint8_t index_256
 
uint8_t index_16
 
uint8_t red
 
uint8_t green
 
uint8_t blue
 
uint8_t hue
 
uint8_t saturation
 
uint8_t value
 

Documentation des données membres

◆ name

const char* name

Définition à la ligne 16 du fichier color_info.hpp.

◆ index_256

uint8_t index_256

Définition à la ligne 17 du fichier color_info.hpp.

◆ index_16

uint8_t index_16

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

◆ red

uint8_t red

Définition à la ligne 19 du fichier color_info.hpp.

◆ green

uint8_t green

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

◆ blue

uint8_t blue

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

◆ hue

uint8_t hue

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

◆ saturation

uint8_t saturation

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

◆ value

uint8_t value

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

◆ ftxui::Image

class ftxui::Image

Une grille rectangulaire de pixels.

Définition à la ligne 17 du fichier image.hpp.

+ Graphe d'héritage de Image:

Fonctions membres publiques

 Image ()=delete
 
 Image (int dimx, int dimy)
 
virtual ~Image ()=default
 
std::string & at (int x, int y)
 Accède à un caractère dans une cellule à une position donnée.
 
const std::string & at (int x, int y) const
 Accède à un caractère dans une cellule à une position donnée.
 
Pixel & PixelAt (int x, int y)
 Accède à une cellule (Pixel) à une position donnée.
 
const Pixel & PixelAt (int x, int y) const
 Accède à une cellule (Pixel) à une position donnée.
 
int dimx () const
 
int dimy () const
 
void Clear ()
 Efface tous les pixels de l'écran.
 

Attributs publics

Box stencil
 

Attributs protégés

int dimx_
 
int dimy_
 
std::vector< std::vector< Pixel > > pixels_
 

Documentation des constructeurs et destructeur

◆ Image() [1/2]

Image ( )
delete

◆ Image() [2/2]

Image ( int dimx,
int dimy )

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

◆ ~Image()

virtual ~Image ( )
virtualdefault

Documentation des fonctions membres

◆ at() [1/2]

std::string & at ( int x,
int y )

Accède à un caractère dans une cellule à une position donnée.

Paramètres
xLa position de la cellule le long de l'axe des x.
yLa position de la cellule le long de l'axe des y.

Définition à la ligne 29 du fichier image.cpp.

◆ at() [2/2]

const std::string & at ( int x,
int y ) const

Accède à un caractère dans une cellule à une position donnée.

Paramètres
xLa position de la cellule le long de l'axe des x.
yLa position de la cellule le long de l'axe des y.

Définition à la ligne 36 du fichier image.cpp.

◆ PixelAt() [1/2]

Pixel & PixelAt ( int x,
int y )

Accède à une cellule (Pixel) à une position donnée.

Paramètres
xLa position de la cellule le long de l'axe des x.
yLa position de la cellule le long de l'axe des y.

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

◆ PixelAt() [2/2]

const Pixel & PixelAt ( int x,
int y ) const

Accède à une cellule (Pixel) à une position donnée.

Paramètres
xLa position de la cellule le long de l'axe des x.
yLa position de la cellule le long de l'axe des y.

Définition à la ligne 50 du fichier image.cpp.

◆ dimx()

int dimx ( ) const
inline

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

◆ dimy()

int dimy ( ) const
inline

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

◆ Clear()

void Clear ( )

Efface tous les pixels de l'écran.

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

Documentation des données membres

◆ stencil

Box stencil

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

◆ dimx_

int dimx_
protected

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

◆ dimy_

int dimy_
protected

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

◆ pixels_

std::vector<std::vector<Pixel> > pixels_
protected

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

◆ ftxui::Pixel

struct ftxui::Pixel

Un caractère Unicode et son style associé.

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

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

Fonctions membres publiques

 Pixel ()
 

Attributs publics

bool blink: 1
 
bool bold: 1
 
bool dim: 1
 
bool italic: 1
 
bool inverted: 1
 
bool underlined: 1
 
bool underlined_double: 1
 
bool strikethrough: 1
 
bool automerge: 1
 
uint8_t hyperlink = 0
 
std::string character = ""
 
Color background_color = Color::Default
 
Color foreground_color = Color::Default
 

Documentation des constructeurs et destructeur

◆ Pixel()

Pixel ( )
inline

Définition à la ligne 16 du fichier pixel.hpp.

Documentation des données membres

◆ blink

bool blink

Définition à la ligne 28 du fichier pixel.hpp.

◆ bold

bool bold
Exemples
examples/component/canvas_animated.cpp.

Définition à la ligne 29 du fichier pixel.hpp.

◆ dim

bool dim

Définition à la ligne 30 du fichier pixel.hpp.

◆ italic

bool italic

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

◆ inverted

bool inverted

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

◆ underlined

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

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

◆ underlined_double

bool underlined_double
Exemples
examples/component/selection.cpp.

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

◆ strikethrough

bool strikethrough

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

◆ automerge

bool automerge

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

◆ hyperlink

uint8_t hyperlink = 0

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

◆ character

std::string character = ""

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

◆ background_color

Color background_color = Color::Default

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

◆ foreground_color

Color foreground_color = Color::Default
Exemples
examples/component/canvas_animated.cpp, et examples/dom/canvas.cpp.

Définition à la ligne 49 du fichier pixel.hpp.

◆ ftxui::Screen

class ftxui::Screen

Une grille rectangulaire de pixels.

Exemples
examples/dom/gauge.cpp, et examples/dom/gauge_direction.cpp.

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

+ Graphe d'héritage de Screen:

Types publics

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

Fonctions membres publiques

 Screen (int dimx, int dimy)
 
 ~Screen () override=default
 
std::string ToString () const
 
void Print () const
 
void Clear ()
 
std::string ResetPosition (bool clear=false) const
 
void ApplyShader ()
 
Cursor cursor () const
 
void SetCursor (Cursor cursor)
 
uint8_t RegisterHyperlink (const std::string &link)
 
const std::string & Hyperlink (uint8_t id) const
 
const SelectionStyle & GetSelectionStyle () const
 
void SetSelectionStyle (SelectionStyle decorator)
 
std::string & at (int x, int y)
 Accède à un caractère dans une cellule à une position donnée.
 
const std::string & at (int x, int y) const
 Accède à un caractère dans une cellule à une position donnée.
 
Pixel & PixelAt (int x, int y)
 Accède à une cellule (Pixel) à une position donnée.
 
const Pixel & PixelAt (int x, int y) const
 Accède à une cellule (Pixel) à une position donnée.
 
int dimx () const
 
int dimy () const
 

Fonctions membres publiques statiques

static Screen Create (Dimensions dimension)
 
static Screen Create (Dimensions width, Dimensions height)
 

Attributs publics

Box stencil
 

Attributs protégés

Cursor cursor_
 
std::vector< std::string > hyperlinks_ = {""}
 
SelectionStyle selection_style_
 
int dimx_
 
int dimy_
 
std::vector< std::vector< Pixel > > pixels_
 

Documentation des définitions de type membres

◆ SelectionStyle

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

Définition à la ligne 74 du fichier screen.hpp.

Documentation des constructeurs et destructeur

◆ Screen()

Screen ( int dimx,
int dimy )

◆ ~Screen()

~Screen ( )
overridedefault

Documentation des fonctions membres

◆ Create() [1/2]

static Screen Create ( Dimensions dimension)
static

◆ Create() [2/2]

static Screen Create ( Dimensions width,
Dimensions height )
static

◆ ToString()

std::string ToString ( ) const

◆ Print()

void Print ( ) const

◆ Clear()

void Clear ( )

◆ ResetPosition()

std::string ResetPosition ( bool clear = false) const

◆ ApplyShader()

void ApplyShader ( )

◆ cursor()

Cursor cursor ( ) const
inline

Définition à la ligne 66 du fichier screen.hpp.

◆ SetCursor()

void SetCursor ( Cursor cursor)
inline

Définition à la ligne 67 du fichier screen.hpp.

◆ RegisterHyperlink()

uint8_t RegisterHyperlink ( const std::string & link)

◆ Hyperlink()

const std::string & Hyperlink ( uint8_t id) const

◆ GetSelectionStyle()

const SelectionStyle & GetSelectionStyle ( ) const

◆ SetSelectionStyle()

void SetSelectionStyle ( SelectionStyle decorator)

◆ at() [1/2]

std::string & at ( int x,
int y )
inherited

Accède à un caractère dans une cellule à une position donnée.

Paramètres
xLa position de la cellule le long de l'axe des x.
yLa position de la cellule le long de l'axe des y.

Définition à la ligne 29 du fichier image.cpp.

◆ at() [2/2]

const std::string & at ( int x,
int y ) const
inherited

Accède à un caractère dans une cellule à une position donnée.

Paramètres
xLa position de la cellule le long de l'axe des x.
yLa position de la cellule le long de l'axe des y.

Définition à la ligne 36 du fichier image.cpp.

◆ PixelAt() [1/2]

Pixel & PixelAt ( int x,
int y )
inherited

Accède à une cellule (Pixel) à une position donnée.

Paramètres
xLa position de la cellule le long de l'axe des x.
yLa position de la cellule le long de l'axe des y.

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

◆ PixelAt() [2/2]

const Pixel & PixelAt ( int x,
int y ) const
inherited

Accède à une cellule (Pixel) à une position donnée.

Paramètres
xLa position de la cellule le long de l'axe des x.
yLa position de la cellule le long de l'axe des y.

Définition à la ligne 50 du fichier image.cpp.

◆ dimx()

int dimx ( ) const
inlineinherited

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

◆ dimy()

int dimy ( ) const
inlineinherited

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

Documentation des données membres

◆ cursor_

Cursor cursor_
protected

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

◆ hyperlinks_

std::vector<std::string> hyperlinks_ = {""}
protected

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

◆ selection_style_

SelectionStyle selection_style_
protected
Valeur initiale :
= [](Pixel& pixel) {
pixel.inverted ^= true;
}

Définition à la ligne 83 du fichier screen.hpp.

◆ stencil

Box stencil
inherited

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

◆ dimx_

int dimx_
protectedinherited

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

◆ dimy_

int dimy_
protectedinherited

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

◆ pixels_

std::vector<std::vector<Pixel> > pixels_
protectedinherited

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

◆ ftxui::Dimensions

struct ftxui::Dimensions

Dimensions est une structure qui représente la taille du terminal.

Définition à la ligne 11 du fichier terminal.hpp.

Attributs publics

int dimx
 
int dimy
 

Documentation des données membres

◆ dimx

int dimx

Définition à la ligne 12 du fichier terminal.hpp.

◆ dimy

int dimy

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

Documentation du type de l'énumération

◆ Color

enum Color

Color est une énumération qui représente le support des couleurs du terminal.

Valeurs énumérées
Palette1 
Palette16 
Palette256 
TrueColor 

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

Documentation des fonctions

◆ Size()

Dimensions Size ( )

Obtenir la taille du terminal.

Renvoie
La taille du terminal.

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

◆ ColorSupport()

Color ColorSupport ( )

Obtenir le support couleur du terminal.

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