diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/animation_8cpp.html b/animation_8cpp.html new file mode 100644 index 00000000..663fd897 --- /dev/null +++ b/animation_8cpp.html @@ -0,0 +1,182 @@ + + + +
+ + + + + +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
ftxui::animation | |
ftxui::animation::easing | |
+Functions | |
float | Linear (float p) |
Modeled after the line y = x. More... | |
float | QuadraticIn (float p) |
Modeled after the parabola y = x^2. More... | |
float | QuadraticOut (float p) |
float | QuadraticInOut (float p) |
float | CubicIn (float p) |
float | CubicOut (float p) |
float | CubicInOut (float p) |
float | QuarticIn (float p) |
float | QuarticOut (float p) |
float | QuarticInOut (float p) |
float | QuinticIn (float p) |
float | QuinticOut (float p) |
float | QuinticInOut (float p) |
float | SineIn (float p) |
float | SineOut (float p) |
float | SineInOut (float p) |
float | CircularIn (float p) |
float | CircularOut (float p) |
float | CircularInOut (float p) |
float | ExponentialIn (float p) |
float | ExponentialOut (float p) |
float | ExponentialInOut (float p) |
float | ElasticIn (float p) |
float | ElasticOut (float p) |
float | ElasticInOut (float p) |
float | BackIn (float p) |
float | BackOut (float p) |
float | BackInOut (float p) |
float | BounceIn (float p) |
float | BounceOut (float p) |
float | BounceInOut (float p) |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Data Structures | |
class | Params |
class | Animator |
+Namespaces | |
ftxui | |
ftxui::animation | |
ftxui::animation::easing | |
+Typedefs | |
using | Clock = std::chrono::steady_clock |
using | TimePoint = std::chrono::time_point< Clock > |
using | Duration = std::chrono::duration< float > |
using | Function = std::function< float(float)> |
+Functions | |
void | RequestAnimationFrame () |
float | Linear (float p) |
Modeled after the line y = x. More... | |
float | QuadraticIn (float p) |
Modeled after the parabola y = x^2. More... | |
float | QuadraticOut (float p) |
float | QuadraticInOut (float p) |
float | CubicIn (float p) |
float | CubicOut (float p) |
float | CubicInOut (float p) |
float | QuarticIn (float p) |
float | QuarticOut (float p) |
float | QuarticInOut (float p) |
float | QuinticIn (float p) |
float | QuinticOut (float p) |
float | QuinticInOut (float p) |
float | SineIn (float p) |
float | SineOut (float p) |
float | SineInOut (float p) |
float | CircularIn (float p) |
float | CircularOut (float p) |
float | CircularInOut (float p) |
float | ExponentialIn (float p) |
float | ExponentialOut (float p) |
float | ExponentialInOut (float p) |
float | ElasticIn (float p) |
float | ElasticOut (float p) |
float | ElasticInOut (float p) |
float | BackIn (float p) |
float | BackOut (float p) |
float | BackInOut (float p) |
float | BounceIn (float p) |
float | BounceOut (float p) |
float | BounceInOut (float p) |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
▼Nftxui | |
▼Nanimation | |
CParams | |
CAnimator | |
▼Nbox_helper | |
CElement | |
▼Nflexbox_helper | |
CBlock | |
CGlobal | |
CCapturedMouseInterface | |
CComponentBase | It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ftxui::Event |
CEntryState | Arguments for |ButtonOption::transform|, |CheckboxOption::transform|, |Radiobox::transform|, |MenuEntryOption::transform|, |MenuOption::transform| |
CUnderlineOption | |
CAnimatedColorOption | Option about a potentially animated color |
CAnimatedColorsOption | |
CMenuEntryOption | Option for the MenuEntry component |
CMenuOption | Option for the Menu component |
CButtonOption | Option for the AnimatedButton component |
CCheckboxOption | Option for the Checkbox component |
CInputState | Used to define style for the Input component |
CInputOption | Option for the Input component |
CRadioboxOption | Option for the Radiobox component |
CResizableSplitOption | |
CSliderOption | |
CWindowRenderState | |
CWindowOptions | |
CDropdownOption | Option for the Dropdown component.A dropdown menu is a checkbox opening/closing a radiobox |
CEvent | Represent an event. It can be key press event, a terminal resize, or more .. |
CLoop | |
CMouse | A mouse event. It contains the coordinate of the mouse, the button pressed and the modifier (shift, ctrl, meta) |
CSenderImpl | |
CReceiverImpl | |
▼CScreenInteractive | |
CPrivate | |
CAnimationTask | |
CCanvas | |
CFlexboxConfig | |
▼CLinearGradient | A class representing the settings for linear-gradient color effect |
CStop | |
▼CNode | |
CStatus | |
CRequirement | |
CTable | |
CTableSelection | |
CBox | |
CColor | A class representing terminal colors |
CColorInfo | |
CImage | A rectangular grid of Pixel |
CPixel | A Unicode character and its associated style |
▼CScreen | A rectangular grid of Pixel |
CCursor | |
CDimensions | |
CAutoReset | Assign a value to a variable, reset its old value when going out of scope |
CConstRef | An adapter. Own or reference an immutable object |
CRef | An adapter. Own or reference an mutable object |
CStringRef | An adapter. Own or reference a constant string. For convenience, this class convert multiple mutable string toward a shared representation |
CConstStringRef | An adapter. Own or reference a constant string. For convenience, this class convert multiple immutable string toward a shared representation |
▼CConstStringListRef | An adapter. Reference a list of strings |
CAdapter | |
▼CTerminalInputParser | |
COutput.__unnamed2__ | |
CNodeDecorator |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | automerge (Element child) |
Enable character to be automatically merged with others nearby. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Data Structures | |
class | AutoReset< T > |
Assign a value to a variable, reset its old value when going out of scope. More... | |
+Namespaces | |
ftxui | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | blink (Element child) |
The text drawn alternates in between visible and hidden. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | bold (Element child) |
Use a bold font, for elements with more emphasis. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | border (Element child) |
Draw a border around the element. More... | |
Decorator | borderWith (const Pixel &pixel) |
Same as border but with a constant Pixel around the element. More... | |
Decorator | borderStyled (BorderStyle style) |
Same as border but with different styles. More... | |
Decorator | borderStyled (Color foreground_color) |
Same as border but with a foreground color. More... | |
Decorator | borderStyled (BorderStyle style, Color foreground_color) |
Same as border but with a foreground color and a different style. More... | |
Element | borderDashed (Element child) |
Draw a light border around the element. More... | |
Element | borderLight (Element child) |
Draw a dashed border around the element. More... | |
Element | borderHeavy (Element child) |
Draw a heavy border around the element. More... | |
Element | borderDouble (Element child) |
Draw a double border around the element. More... | |
Element | borderRounded (Element child) |
Draw a rounded border around the element. More... | |
Element | borderEmpty (Element child) |
Draw an empty border around the element. More... | |
Element | window (Element title, Element content, BorderStyle border) |
Draw window with a title and a border around the element. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Data Structures | |
struct | Box |
+Namespaces | |
ftxui | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
ftxui::box_helper | |
+Functions | |
void | Compute (std::vector< Element > *elements, int target_size) |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Data Structures | |
struct | Element |
+Namespaces | |
ftxui | |
ftxui::box_helper | |
+Functions | |
void | Compute (std::vector< Element > *elements, int target_size) |
struct ftxui::box_helper::Element | +
Definition at line 11 of file box_helper.hpp.
+Data Fields | ||
---|---|---|
+int | ++min_size | ++ |
+int | ++flex_grow | ++ |
+int | ++flex_shrink | ++ |
+int | ++size | ++ |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Component | Button (ButtonOption option) |
Draw a button. Execute a function when clicked. More... | |
Component | Button (ConstStringRef label, std::function< void()> on_click, ButtonOption option) |
Draw a button. Execute a function when clicked. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | canvas (ConstRef< Canvas > canvas) |
Produce an element from a Canvas, or a reference to a Canvas. More... | |
Element | canvas (int width, int height, std::function< void(Canvas &)> fn) |
Produce an element drawing a canvas of requested size. More... | |
Element | canvas (std::function< void(Canvas &)> fn) |
Produce an element drawing a canvas. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Data Structures | |
struct | Canvas |
+Namespaces | |
ftxui | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Data Structures | |
class | CapturedMouseInterface |
+Namespaces | |
ftxui | |
+Typedefs | |
using | CapturedMouse = std::unique_ptr< CapturedMouseInterface > |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Component | CatchEvent (Component child, std::function< bool(Event event)> on_event) |
Return a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise. More... | |
ComponentDecorator | CatchEvent (std::function< bool(Event)> on_event) |
Decorate a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Assign a value to a variable, reset its old value when going out of scope. + More...
++Public Member Functions | |
AutoReset (T *variable, T new_value) | |
AutoReset (const AutoReset &)=delete | |
AutoReset (AutoReset &&)=delete | |
AutoReset & | operator= (const AutoReset &)=delete |
AutoReset & | operator= (AutoReset &&)=delete |
~AutoReset () | |
Assign a value to a variable, reset its old value when going out of scope.
+ +Definition at line 13 of file autoreset.hpp.
+
+
|
+ +inline | +
Definition at line 15 of file autoreset.hpp.
+ +
+
|
+ +inline | +
Definition at line 23 of file autoreset.hpp.
+ +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Public Member Functions | |
CapturedMouseInterface ()=default | |
CapturedMouseInterface (const CapturedMouseInterface &)=default | |
CapturedMouseInterface (CapturedMouseInterface &&)=delete | |
CapturedMouseInterface & | operator= (const CapturedMouseInterface &)=default |
CapturedMouseInterface & | operator= (CapturedMouseInterface &&)=delete |
virtual | ~CapturedMouseInterface ()=default |
Definition at line 10 of file captured_mouse.hpp.
+
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +delete | +
+
|
+ +virtualdefault | +
+
|
+ +default | +
+
|
+ +delete | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
A class representing terminal colors. + More...
++Public Types | |
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 + + } |
+Public Member Functions | |
enum Palette1 uint8_t enum Palette16 uint8_t enum Palette256 uint8_t | Color () |
Build a transparent color. More... | |
Color (Palette1 index) | |
Build a transparent color. More... | |
Color (Palette16 index) | |
Build a color using the Palette16 colors. More... | |
Color (Palette256 index) | |
Build a color using Palette256 colors. More... | |
Color (uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha=255) | |
Build a Color from its RGB representation. https://en.wikipedia.org/wiki/RGB_color_model. More... | |
bool | operator== (const Color &rhs) const |
bool | operator!= (const Color &rhs) const |
std::string | Print (bool is_background_color) const |
bool | IsOpaque () const |
+Static Public Member Functions | |
static Color | RGB (uint8_t red, uint8_t green, uint8_t blue) |
Build a Color from its RGB representation. https://en.wikipedia.org/wiki/RGB_color_model. More... | |
static Color | HSV (uint8_t hue, uint8_t saturation, uint8_t value) |
Build a Color from its HSV representation. https://en.wikipedia.org/wiki/HSL_and_HSV. More... | |
static Color | RGBA (uint8_t red, uint8_t green, uint8_t blue, uint8_t alpha) |
Build a Color from its RGBA representation. https://en.wikipedia.org/wiki/RGB_color_model. More... | |
static Color | HSVA (uint8_t hue, uint8_t saturation, uint8_t value, uint8_t alpha) |
Build a Color from its HSV representation. https://en.wikipedia.org/wiki/HSL_and_HSV. More... | |
static Color | Interpolate (float t, const Color &a, const Color &b) |
static Color | Blend (const Color &lhs, const Color &rhs) |
Blend two colors together using the alpha channel. More... | |
A class representing terminal colors.
+ + + +enum Palette1 : uint8_t | +
enum Palette16 : uint8_t | +
enum Palette256 : uint8_t | +
+
|
+ +default | +
Build a transparent color.
+ +Color | +( | +Palette256 | +index | ) | ++ |
Color | +( | +uint8_t | +red, | +
+ | + | uint8_t | +green, | +
+ | + | uint8_t | +blue, | +
+ | + | uint8_t | +alpha = 255 |
+
+ | ) | ++ |
Build a Color from its RGB representation. https://en.wikipedia.org/wiki/RGB_color_model.
+red | The quantity of red [0,255] |
green | The quantity of green [0,255] |
blue | The quantity of blue [0,255] |
alpha | The quantity of alpha [0,255] |
+
|
+ +static | +
Build a Color from its RGB representation. https://en.wikipedia.org/wiki/RGB_color_model.
+red | The quantity of red [0,255] |
green | The quantity of green [0,255] |
blue | The quantity of blue [0,255] |
+
|
+ +static | +
Build a Color from its HSV representation. https://en.wikipedia.org/wiki/HSL_and_HSV.
+h | The hue of the color [0,255] |
s | The "colorfulness" [0,255]. |
v | The "Lightness" [0,255] |
+
|
+ +static | +
Build a Color from its RGBA representation. https://en.wikipedia.org/wiki/RGB_color_model.
+red | The quantity of red [0,255] |
green | The quantity of green [0,255] |
blue | The quantity of blue [0,255] |
alpha | The quantity of alpha [0,255] |
+
|
+ +static | +
Build a Color from its HSV representation. https://en.wikipedia.org/wiki/HSL_and_HSV.
+h | The hue of the color [0,255] |
s | The "colorfulness" [0,255]. |
v | The "Lightness" [0,255] |
alpha | The quantity of alpha [0,255] |
bool operator== | +( | +const Color & | +rhs | ) | +const | +
bool operator!= | +( | +const Color & | +rhs | ) | +const | +
std::string Print | +( | +bool | +is_background_color | ) | +const | +
+
|
+ +inline | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ftxui::Event. + More...
+ +Inherited by CatchEventBase, ContainerBase, and MenuBase.
++Public Member Functions | |
ComponentBase (Components children) | |
virtual | ~ComponentBase () |
ComponentBase ()=default | |
ComponentBase (const ComponentBase &)=delete | |
ComponentBase (ComponentBase &&)=delete | |
ComponentBase & | operator= (const ComponentBase &)=delete |
ComponentBase & | operator= (ComponentBase &&)=delete |
ComponentBase * | Parent () const |
Return the parent ComponentBase, or nul if any. More... | |
Component & | ChildAt (size_t i) |
Access the child at index i . More... | |
size_t | ChildCount () const |
Returns the number of children. More... | |
void | Add (Component children) |
Add a child. @param child The child to be attached. More... | |
void | Detach () |
Detach this child from its parent. More... | |
void | DetachAllChildren () |
Remove all children. More... | |
virtual Element | Render () |
Draw the component. Build a ftxui::Element to be drawn on the ftxi::Screen representing this ftxui::ComponentBase. More... | |
virtual bool | OnEvent (Event) |
Called in response to an event. More... | |
virtual void | OnAnimation (animation::Params ¶ms) |
Called in response to an animation event. More... | |
virtual Component | ActiveChild () |
Return the currently Active child. More... | |
virtual bool | Focusable () const |
Return true when the component contains focusable elements. The non focusable Components will be skipped when navigating using the keyboard. More... | |
bool | Active () const |
Returns if the element if the currently active child of its parent. More... | |
bool | Focused () const |
Returns if the elements if focused by the user. True when the ComponentBase is focused by the user. An element is Focused when it is with all its ancestors the ActiveChild() of their parents, and it Focusable(). More... | |
virtual void | SetActiveChild (ComponentBase *child) |
void | SetActiveChild (Component child) |
Make the |child| to be the "active" one. More... | |
void | TakeFocus () |
Configure all the ancestors to give focus to this component. More... | |
+Protected Member Functions | |
CapturedMouse | CaptureMouse (const Event &event) |
Take the CapturedMouse if available. There is only one component of them. It represents a component taking priority over others. More... | |
+Protected Attributes | |
Components | children_ |
It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ftxui::Event.
+ +Definition at line 30 of file component_base.hpp.
+
+
|
+ +inlineexplicit | +
Definition at line 32 of file component_base.hpp.
+ +
+
|
+ +virtual | +
Definition at line 28 of file component.cpp.
+ +
+
|
+ +default | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +delete | +
ComponentBase * Parent | +( | +) | +const | +
Return the parent ComponentBase, or nul if any.
+ + +Definition at line 36 of file component.cpp.
+ +Component & ChildAt | +( | +size_t | +i | ) | ++ |
Access the child at index i
.
Definition at line 42 of file component.cpp.
+ +size_t ChildCount | +( | +) | +const | +
Returns the number of children.
+ +Definition at line 49 of file component.cpp.
+ +void Add | +( | +Component | +children | ) | ++ |
Add a child. @param child The child to be attached.
+ +Definition at line 56 of file component.cpp.
+ +void Detach | +( | +) | ++ |
Detach this child from its parent.
+ + +Definition at line 66 of file component.cpp.
+ +void DetachAllChildren | +( | +) | ++ |
Remove all children.
+ +Definition at line 82 of file component.cpp.
+ +
+
|
+ +virtual | +
Draw the component. Build a ftxui::Element to be drawn on the ftxi::Screen representing this ftxui::ComponentBase.
+ +Definition at line 92 of file component.cpp.
+ +
+
|
+ +virtual | +
Called in response to an event.
+event | The event. |
Definition at line 106 of file component.cpp.
+ +
+
|
+ +virtual | +
Called in response to an animation event.
+params | the parameters of the animation The default implementation dispatch the event to every child. |
Definition at line 119 of file component.cpp.
+ +
+
|
+ +virtual | +
Return the currently Active child.
+Definition at line 128 of file component.cpp.
+ +
+
|
+ +virtual | +
Return true when the component contains focusable elements. The non focusable Components will be skipped when navigating using the keyboard.
+ +Definition at line 141 of file component.cpp.
+ +bool Active | +( | +) | +const | +
Returns if the element if the currently active child of its parent.
+ +Definition at line 152 of file component.cpp.
+ +bool Focused | +( | +) | +const | +
Returns if the elements if focused by the user. True when the ComponentBase is focused by the user. An element is Focused when it is with all its ancestors the ActiveChild() of their parents, and it Focusable().
+ +Definition at line 161 of file component.cpp.
+ +
+
|
+ +virtual | +
void SetActiveChild | +( | +Component | +child | ) | ++ |
Make the |child| to be the "active" one.
+child | the child to become active. |
Definition at line 177 of file component.cpp.
+ +void TakeFocus | +( | +) | ++ |
Configure all the ancestors to give focus to this component.
+ +Definition at line 183 of file component.cpp.
+ +
+
|
+ +protected | +
Take the CapturedMouse if available. There is only one component of them. It represents a component taking priority over others.
+event | The event |
Definition at line 195 of file component.cpp.
+ +
+
|
+ +protected | +
Definition at line 92 of file component_base.hpp.
+ +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
An adapter. Own or reference an immutable object. + More...
++Public Member Functions | |
ConstRef ()=default | |
ConstRef (T t) | |
ConstRef (const T *t) | |
ConstRef & | operator= (ConstRef &&) noexcept=default |
ConstRef (const ConstRef< T > &)=default | |
ConstRef (ConstRef< T > &&) noexcept=default | |
~ConstRef ()=default | |
ConstRef< T > & | operator= (const ConstRef< T > &)=default |
const T & | operator() () const |
const T & | operator* () const |
const T * | operator-> () const |
An adapter. Own or reference an immutable object.
+ + +
+
|
+ +default | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +default | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
An adapter. Reference a list of strings. + More...
++Data Structures | |
class | Adapter |
+Public Types | |
using | Variant = std::variant< const std::vector< std::string >, const std::vector< std::string > *, const std::vector< std::wstring > *, Adapter *, std::unique_ptr< Adapter > > |
+Public Member Functions | |
ConstStringListRef ()=default | |
~ConstStringListRef ()=default | |
ConstStringListRef & | operator= (const ConstStringListRef &)=default |
ConstStringListRef & | operator= (ConstStringListRef &&)=default |
ConstStringListRef (ConstStringListRef &&)=default | |
ConstStringListRef (const ConstStringListRef &)=default | |
ConstStringListRef (std::vector< std::string > value) | |
ConstStringListRef (const std::vector< std::string > *value) | |
ConstStringListRef (const std::vector< std::wstring > *value) | |
ConstStringListRef (Adapter *adapter) | |
template<typename AdapterType > | |
ConstStringListRef (std::unique_ptr< AdapterType > adapter) | |
size_t | size () const |
std::string | operator[] (size_t i) const |
An adapter. Reference a list of strings.
+Supported input:
std::vector<std::string>
std::vector<std::string>*
std::vector<std::wstring>*
Adapter*
std::unique_ptr<Adapter>
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +default | +
+
|
+ +default | +
+
|
+ +inline | +
+
|
+ +inline | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Public Member Functions | |
Adapter ()=default | |
Adapter (const Adapter &)=default | |
Adapter & | operator= (const Adapter &)=default |
Adapter (Adapter &&)=default | |
Adapter & | operator= (Adapter &&)=default |
virtual | ~Adapter ()=default |
virtual size_t | size () const =0 |
virtual std::string | operator[] (size_t i) const =0 |
+
|
+ +default | +
+
|
+ +virtualdefault | +
+
|
+ +pure virtual | +
+
|
+ +pure virtual | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
An adapter. Own or reference a constant string. For convenience, this class convert multiple immutable string toward a shared representation. + More...
++Public Member Functions | |
ConstStringRef (const std::wstring *ref) | |
ConstStringRef (const std::wstring ref) | |
ConstStringRef (const wchar_t *ref) | |
ConstStringRef (const char *ref) | |
const std::string & | operator() () const |
const std::string & | operator* () const |
const std::string * | operator-> () const |
An adapter. Own or reference a constant string. For convenience, this class convert multiple immutable string toward a shared representation.
+ + +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inlineinherited | +
+
|
+ +inlineinherited | +
+
|
+ +inlineinherited | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
A rectangular grid of Pixel. + More...
++Public Member Functions | |
Image ()=delete | |
Image (int dimx, int dimy) | |
std::string & | at (int x, int y) |
Access a character in a cell at a given position. More... | |
const std::string & | at (int x, int y) const |
Access a character in a cell at a given position. More... | |
Pixel & | PixelAt (int x, int y) |
Access a cell (Pixel) at a given position. More... | |
const Pixel & | PixelAt (int x, int y) const |
Access a cell (Pixel) at a given position. More... | |
int | dimx () const |
int | dimy () const |
void | Clear () |
Clear all the pixel from the screen. More... | |
+Data Fields | |
Box | stencil |
+Protected Attributes | |
int | dimx_ |
int | dimy_ |
std::vector< std::vector< Pixel > > | pixels_ |
+
|
+ +delete | +
Image | +( | +int | +dimx, | +
+ | + | int | +dimy | +
+ | ) | ++ |
std::string & at | +( | +int | +x, | +
+ | + | int | +y | +
+ | ) | ++ |
const std::string & at | +( | +int | +x, | +
+ | + | int | +y | +
+ | ) | +const | +
Pixel & PixelAt | +( | +int | +x, | +
+ | + | int | +y | +
+ | ) | ++ |
const Pixel & PixelAt | +( | +int | +x, | +
+ | + | int | +y | +
+ | ) | +const | +
+
|
+ +inline | +
+
|
+ +inline | +
void Clear | +( | +) | ++ |
+
|
+ +protected | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Public Member Functions | |
Loop (ScreenInteractive *screen, Component component) | |
A Loop is a wrapper around a Component and a ScreenInteractive. It is used to run a Component in a terminal. More... | |
~Loop () | |
bool | HasQuitted () |
Whether the loop has quitted. More... | |
void | RunOnce () |
Execute the loop. Make the component to process every pending tasks/events. A new frame might be drawn if the previous was invalidated. Return true until the loop hasn't completed. More... | |
void | RunOnceBlocking () |
Wait for at least one event to be handled and execute Loop::RunOnce() . More... | |
void | Run () |
Loop (const Loop &)=default | |
Loop (Loop &&)=delete | |
Loop & | operator= (Loop &&)=delete |
Loop (const ScreenInteractive &)=delete | |
Loop & | operator= (const Loop &)=delete |
Loop | +( | +ScreenInteractive * | +screen, | +
+ | + | Component | +component | +
+ | ) | ++ |
A Loop is a wrapper around a Component and a ScreenInteractive. It is used to run a Component in a terminal.
+[in] | screen | The screen to use. |
[in] | component | The component to run. |
+
|
+ +delete | +
bool HasQuitted | +( | +) | ++ |
void RunOnce | +( | +) | ++ |
void RunOnceBlocking | +( | +) | ++ |
Wait for at least one event to be handled and execute Loop::RunOnce()
.
void Run | +( | +) | ++ |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Data Structures | |
struct | Status |
+Public Member Functions | |
Node () | |
Node (Elements children) | |
Node (const Node &)=delete | |
Node (const Node &&)=delete | |
Node & | operator= (const Node &)=delete |
Node & | operator= (const Node &&)=delete |
virtual | ~Node () |
virtual void | ComputeRequirement () |
Compute how much space an elements needs. More... | |
Requirement | requirement () |
virtual void | SetBox (Box box) |
Assign a position and a dimension to an element for drawing. More... | |
virtual void | Render (Screen &screen) |
Display an element on a ftxui::Screen. More... | |
virtual void | Check (Status *status) |
+Protected Attributes | |
Elements | children_ |
Requirement | requirement_ |
Box | box_ |
struct ftxui::Node::Status | +
+
|
+ +default | +
+
|
+ +virtualdefault | +
+
|
+ +virtual | +
Compute how much space an elements needs.
+ +Reimplemented in NodeDecorator.
+ + + +
+
|
+ +inline | +
+
|
+ +virtual | +
Assign a position and a dimension to an element for drawing.
+ +Reimplemented in NodeDecorator.
+ + + +
+
|
+ +virtual | +
Display an element on a ftxui::Screen.
+ + + +
+
|
+ +virtual | +
+
|
+ +protected | +
+
|
+ +protected | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Public Member Functions | |
NodeDecorator (Element child) | |
void | ComputeRequirement () override |
Compute how much space an elements needs. More... | |
void | SetBox (Box box) override |
Assign a position and a dimension to an element for drawing. More... | |
Requirement | requirement () |
virtual void | Render (Screen &screen) |
Display an element on a ftxui::Screen. More... | |
virtual void | Check (Status *status) |
+Protected Attributes | |
Elements | children_ |
Requirement | requirement_ |
Box | box_ |
Definition at line 16 of file node_decorator.hpp.
+
+
|
+ +inlineexplicit | +
Definition at line 18 of file node_decorator.hpp.
+ +
+
|
+ +overridevirtual | +
Compute how much space an elements needs.
+ +Reimplemented from Node.
+ +Definition at line 12 of file node_decorator.cpp.
+ +
+
|
+ +overridevirtual | +
Assign a position and a dimension to an element for drawing.
+ +Reimplemented from Node.
+ +Definition at line 17 of file node_decorator.cpp.
+ +
+
|
+ +inlineinherited | +
+
|
+ +virtualinherited | +
Display an element on a ftxui::Screen.
+ + + +
+
|
+ +virtualinherited | +
+
|
+ +protectedinherited | +
+
|
+ +protectedinherited | +
+
|
+ +protectedinherited | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Public Member Functions | |
Sender< T > | MakeSender () |
ReceiverImpl ()=default | |
bool | Receive (T *t) |
bool | ReceiveNonBlocking (T *t) |
bool | HasPending () |
bool | HasQuitted () |
Definition at line 71 of file receiver.hpp.
+
+
|
+ +default | +
+
|
+ +inline | +
Definition at line 73 of file receiver.hpp.
+ +
+
|
+ +inline | +
Definition at line 80 of file receiver.hpp.
+ +
+
|
+ +inline | +
Definition at line 96 of file receiver.hpp.
+ +
+
|
+ +inline | +
Definition at line 106 of file receiver.hpp.
+ +
+
|
+ +inline | +
Definition at line 111 of file receiver.hpp.
+ +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
An adapter. Own or reference an mutable object. + More...
++Public Member Functions | |
Ref ()=default | |
Ref (T t) | |
Ref (T *t) | |
~Ref ()=default | |
Ref & | operator= (Ref &&) noexcept=default |
Ref (const Ref< T > &)=default | |
Ref (Ref< T > &&) noexcept=default | |
Ref< T > & | operator= (const Ref< T > &)=default |
T & | operator() () |
T & | operator* () |
T * | operator-> () |
const T & | operator() () const |
const T & | operator* () const |
const T * | operator-> () const |
An adapter. Own or reference an mutable object.
+ + +
+
|
+ +default | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +default | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
A rectangular grid of Pixel. + More...
++Data Structures | |
struct | Cursor |
+Public Member Functions | |
Screen (int dimx, int dimy) | |
std::string | ToString () const |
void | Print () const |
void | Clear () |
Clear all the pixel from the screen. More... | |
std::string | ResetPosition (bool clear=false) const |
Return a string to be printed in order to reset the cursor position to the beginning of the screen. More... | |
void | ApplyShader () |
Cursor | cursor () const |
void | SetCursor (Cursor cursor) |
uint8_t | RegisterHyperlink (const std::string &link) |
const std::string & | Hyperlink (uint8_t id) const |
std::string & | at (int x, int y) |
Access a character in a cell at a given position. More... | |
const std::string & | at (int x, int y) const |
Access a character in a cell at a given position. More... | |
Pixel & | PixelAt (int x, int y) |
Access a cell (Pixel) at a given position. More... | |
const Pixel & | PixelAt (int x, int y) const |
Access a cell (Pixel) at a given position. More... | |
int | dimx () const |
int | dimy () const |
+Static Public Member Functions | |
static Screen | Create (Dimensions dimension) |
Create a screen with the given dimension. More... | |
static Screen | Create (Dimensions width, Dimensions height) |
Create a screen with the given dimension along the x-axis and y-axis. More... | |
+Data Fields | |
Box | stencil |
+Protected Attributes | |
Cursor | cursor_ |
std::vector< std::string > | hyperlinks_ = {""} |
int | dimx_ |
int | dimy_ |
std::vector< std::vector< Pixel > > | pixels_ |
A rectangular grid of Pixel.
+ +Definition at line 25 of file screen.hpp.
+Screen | +( | +int | +dimx, | +
+ | + | int | +dimy | +
+ | ) | ++ |
Definition at line 389 of file screen.cpp.
+ +
+
|
+ +static | +
Create a screen with the given dimension.
+Definition at line 385 of file screen.cpp.
+ +
+
|
+ +static | +
Create a screen with the given dimension along the x-axis and y-axis.
+ +Definition at line 379 of file screen.cpp.
+ +std::string ToString | +( | +) | +const | +
Produce a std::string that can be used to print the Screen on the terminal.
Definition at line 406 of file screen.cpp.
+ +void Print | +( | +) | +const | +
Definition at line 443 of file screen.cpp.
+ +void Clear | +( | +) | ++ |
Clear all the pixel from the screen.
+ +Definition at line 485 of file screen.cpp.
+ +std::string ResetPosition | +( | +bool | +clear = false | ) | +const | +
Return a string to be printed in order to reset the cursor position to the beginning of the screen.
+Definition at line 466 of file screen.cpp.
+ +void ApplyShader | +( | +) | ++ |
Definition at line 497 of file screen.cpp.
+ +
+
|
+ +inline | +
Definition at line 62 of file screen.hpp.
+ +
+
|
+ +inline | +
Definition at line 63 of file screen.hpp.
+ +uint8_t RegisterHyperlink | +( | +const std::string & | +link | ) | ++ |
Definition at line 524 of file screen.cpp.
+ +const std::string & Hyperlink | +( | +uint8_t | +id | ) | +const | +
Definition at line 537 of file screen.cpp.
+ +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inlineinherited | +
+
|
+ +inlineinherited | +
+
|
+ +protected | +
Definition at line 71 of file screen.hpp.
+ +
+
|
+ +protected | +
Definition at line 72 of file screen.hpp.
+ +
+
|
+ +inherited | +
+
|
+ +protectedinherited | +
+
|
+ +protectedinherited | +
+
|
+ +protectedinherited | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Data Structures | |
class | Private |
+Public Member Functions | |
void | TrackMouse (bool enable=true) |
Set whether mouse is tracked and events reported. called outside of the main loop. E.g ScreenInteractive::Loop(...) . More... | |
void | Loop (Component) |
Execute the main loop. More... | |
void | Exit () |
Exit the main loop. More... | |
Closure | ExitLoopClosure () |
Return a function to exit the main loop. More... | |
void | Post (Task task) |
Add a task to the main loop. It will be executed later, after every other scheduled tasks. More... | |
void | PostEvent (Event event) |
Add an event to the main loop. It will be executed later, after every other scheduled events. More... | |
void | RequestAnimationFrame () |
Add a task to draw the screen one more time, until all the animations are done. More... | |
CapturedMouse | CaptureMouse () |
Try to get the unique lock about behing able to capture the mouse. More... | |
Closure | WithRestoredIO (Closure) |
Decorate a function. It executes the same way, but with the currently active screen terminal hooks temporarilly uninstalled during its execution. More... | |
void | ForceHandleCtrlC (bool force) |
Force FTXUI to handle or not handle Ctrl-C, even if the component catches the Event::CtrlC. More... | |
void | ForceHandleCtrlZ (bool force) |
Force FTXUI to handle or not handle Ctrl-Z, even if the component catches the Event::CtrlZ. More... | |
std::string | ToString () const |
void | Print () const |
void | Clear () |
Clear all the pixel from the screen. More... | |
std::string | ResetPosition (bool clear=false) const |
Return a string to be printed in order to reset the cursor position to the beginning of the screen. More... | |
void | ApplyShader () |
Cursor | cursor () const |
void | SetCursor (Cursor cursor) |
uint8_t | RegisterHyperlink (const std::string &link) |
const std::string & | Hyperlink (uint8_t id) const |
std::string & | at (int x, int y) |
Access a character in a cell at a given position. More... | |
const std::string & | at (int x, int y) const |
Access a character in a cell at a given position. More... | |
Pixel & | PixelAt (int x, int y) |
Access a cell (Pixel) at a given position. More... | |
const Pixel & | PixelAt (int x, int y) const |
Access a cell (Pixel) at a given position. More... | |
int | dimx () const |
int | dimy () const |
+Static Public Member Functions | |
static ScreenInteractive | FixedSize (int dimx, int dimy) |
static ScreenInteractive | Fullscreen () |
static ScreenInteractive | FullscreenPrimaryScreen () |
static ScreenInteractive | FullscreenAlternateScreen () |
static ScreenInteractive | FitComponent () |
static ScreenInteractive | TerminalOutput () |
static ScreenInteractive * | Active () |
Return the currently active screen, or null if none. More... | |
static Screen | Create (Dimensions dimension) |
Create a screen with the given dimension. More... | |
static Screen | Create (Dimensions width, Dimensions height) |
Create a screen with the given dimension along the x-axis and y-axis. More... | |
+Data Fields | |
friend | Private |
Box | stencil |
+Protected Attributes | |
Cursor | cursor_ |
std::vector< std::string > | hyperlinks_ = {""} |
int | dimx_ |
int | dimy_ |
std::vector< std::vector< Pixel > > | pixels_ |
Definition at line 29 of file screen_interactive.hpp.
+
+
|
+ +static | +
Definition at line 355 of file screen_interactive.cpp.
+ +
+
|
+ +static | +
Create a ScreenInteractive taking the full terminal size. This is using the alternate screen buffer to avoid messing with the terminal content.
ScreenInteractive::FullscreenAlternateScreen()
Definition at line 369 of file screen_interactive.cpp.
+ +
+
|
+ +static | +
Create a ScreenInteractive taking the full terminal size. The primary screen buffer is being used. It means if the terminal is resized, the previous content might mess up with the terminal content.
+ +Definition at line 378 of file screen_interactive.cpp.
+ +
+
|
+ +static | +
Create a ScreenInteractive taking the full terminal size. This is using the alternate screen buffer to avoid messing with the terminal content.
+ +Definition at line 391 of file screen_interactive.cpp.
+ +
+
|
+ +static | +
Definition at line 411 of file screen_interactive.cpp.
+ +
+
|
+ +static | +
Definition at line 401 of file screen_interactive.cpp.
+ +void TrackMouse | +( | +bool | +enable = true | ) | ++ |
Set whether mouse is tracked and events reported. called outside of the main loop. E.g ScreenInteractive::Loop(...)
.
enable | Whether to enable mouse event tracking. |
ScreenInteractive::Loop
. Definition at line 436 of file screen_interactive.cpp.
+ +
+
|
+ +static | +
Return the currently active screen, or null if none.
+ +Definition at line 576 of file screen_interactive.cpp.
+ +Execute the main loop.
+component | The component to draw. |
Definition at line 490 of file screen_interactive.cpp.
+ +void Exit | +( | +) | ++ |
Exit the main loop.
+ +Definition at line 939 of file screen_interactive.cpp.
+ +Closure ExitLoopClosure | +( | +) | ++ |
Return a function to exit the main loop.
+ +Definition at line 933 of file screen_interactive.cpp.
+ +void Post | +( | +Task | +task | ) | ++ |
Add a task to the main loop. It will be executed later, after every other scheduled tasks.
+ +Definition at line 443 of file screen_interactive.cpp.
+ +void PostEvent | +( | +Event | +event | ) | ++ |
Add an event to the main loop. It will be executed later, after every other scheduled events.
+ +Definition at line 456 of file screen_interactive.cpp.
+ +void RequestAnimationFrame | +( | +) | ++ |
Add a task to draw the screen one more time, until all the animations are done.
+ +Definition at line 462 of file screen_interactive.cpp.
+ +CapturedMouse CaptureMouse | +( | +) | ++ |
Try to get the unique lock about behing able to capture the mouse.
+Definition at line 478 of file screen_interactive.cpp.
+ +Decorate a function. It executes the same way, but with the currently active screen terminal hooks temporarilly uninstalled during its execution.
+fn | The function to decorate. |
Definition at line 554 of file screen_interactive.cpp.
+ +void ForceHandleCtrlC | +( | +bool | +force | ) | ++ |
Force FTXUI to handle or not handle Ctrl-C, even if the component catches the Event::CtrlC.
+ +Definition at line 564 of file screen_interactive.cpp.
+ +void ForceHandleCtrlZ | +( | +bool | +force | ) | ++ |
Force FTXUI to handle or not handle Ctrl-Z, even if the component catches the Event::CtrlZ.
+ +Definition at line 570 of file screen_interactive.cpp.
+ +
+
|
+ +staticinherited | +
Create a screen with the given dimension.
+Definition at line 385 of file screen.cpp.
+ +
+
|
+ +staticinherited | +
Create a screen with the given dimension along the x-axis and y-axis.
+ +Definition at line 379 of file screen.cpp.
+ +
+
|
+ +inherited | +
Produce a std::string that can be used to print the Screen on the terminal.
Definition at line 406 of file screen.cpp.
+ +
+
|
+ +inherited | +
Definition at line 443 of file screen.cpp.
+ +
+
|
+ +inherited | +
Clear all the pixel from the screen.
+ +Definition at line 485 of file screen.cpp.
+ +
+
|
+ +inherited | +
Return a string to be printed in order to reset the cursor position to the beginning of the screen.
+Definition at line 466 of file screen.cpp.
+ +
+
|
+ +inherited | +
Definition at line 497 of file screen.cpp.
+ +
+
|
+ +inlineinherited | +
Definition at line 62 of file screen.hpp.
+ +
+
|
+ +inlineinherited | +
Definition at line 63 of file screen.hpp.
+ +
+
|
+ +inherited | +
Definition at line 524 of file screen.cpp.
+ +
+
|
+ +inherited | +
Definition at line 537 of file screen.cpp.
+ +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inherited | +
+
|
+ +inlineinherited | +
+
|
+ +inlineinherited | +
friend Private | +
Definition at line 139 of file screen_interactive.hpp.
+ +
+
|
+ +protectedinherited | +
Definition at line 71 of file screen.hpp.
+ +
+
|
+ +protectedinherited | +
Definition at line 72 of file screen.hpp.
+ +
+
|
+ +inherited | +
+
|
+ +protectedinherited | +
+
|
+ +protectedinherited | +
+
|
+ +protectedinherited | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Static Public Member Functions | |
static void | Signal (ScreenInteractive &s, int signal) |
Definition at line 135 of file screen_interactive.hpp.
+
+
|
+ +inlinestatic | +
Definition at line 137 of file screen_interactive.hpp.
+ +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Public Member Functions | |
SenderImpl (const SenderImpl &)=delete | |
SenderImpl (SenderImpl &&)=delete | |
SenderImpl & | operator= (const SenderImpl &)=delete |
SenderImpl & | operator= (SenderImpl &&)=delete |
void | Send (T t) |
~SenderImpl () | |
Sender< T > | Clone () |
Definition at line 53 of file receiver.hpp.
+
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +inline | +
Definition at line 60 of file receiver.hpp.
+ +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +inline | +
Definition at line 59 of file receiver.hpp.
+ +
+
|
+ +inline | +
Definition at line 62 of file receiver.hpp.
+ +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
An adapter. Own or reference a constant string. For convenience, this class convert multiple mutable string toward a shared representation. + More...
++Public Member Functions | |
StringRef (const wchar_t *ref) | |
StringRef (const char *ref) | |
std::string & | operator() () |
const std::string & | operator() () const |
std::string & | operator* () |
const std::string & | operator* () const |
std::string * | operator-> () |
const std::string * | operator-> () const |
An adapter. Own or reference a constant string. For convenience, this class convert multiple mutable string toward a shared representation.
+ + +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inlineinherited | +
+
|
+ +inlineinherited | +
+
|
+ +inlineinherited | +
+
|
+ +inlineinherited | +
+
|
+ +inlineinherited | +
+
|
+ +inlineinherited | +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Public Member Functions | |
Table () | |
Create an empty table. More... | |
Table (std::vector< std::vector< std::string >>) | |
Create a table from a vector of vector of string. More... | |
Table (std::vector< std::vector< Element >>) | |
Create a table from a vector of vector of Element. More... | |
TableSelection | SelectAll () |
Select all the table. More... | |
TableSelection | SelectCell (int column, int row) |
Select a cell of the table. More... | |
TableSelection | SelectRow (int row_index) |
Select a row of the table. More... | |
TableSelection | SelectRows (int row_min, int row_max) |
Select a range of rows of the table. More... | |
TableSelection | SelectColumn (int column_index) |
Select a column of the table. More... | |
TableSelection | SelectColumns (int column_min, int column_max) |
Select a range of columns of the table. More... | |
TableSelection | SelectRectangle (int column_min, int column_max, int row_min, int row_max) |
Select a rectangle of the table. More... | |
Element | Render () |
Render the table. More... | |
Table | +( | +) | ++ |
+
|
+ +explicit | +
TableSelection SelectAll | +( | +) | ++ |
TableSelection SelectCell | +( | +int | +column, | +
+ | + | int | +row | +
+ | ) | ++ |
TableSelection SelectRow | +( | +int | +index | ) | ++ |
TableSelection SelectRows | +( | +int | +row_min, | +
+ | + | int | +row_max | +
+ | ) | ++ |
TableSelection SelectColumn | +( | +int | +index | ) | ++ |
TableSelection SelectColumns | +( | +int | +column_min, | +
+ | + | int | +column_max | +
+ | ) | ++ |
TableSelection SelectRectangle | +( | +int | +column_min, | +
+ | + | int | +column_max, | +
+ | + | int | +row_min, | +
+ | + | int | +row_max | +
+ | ) | ++ |
Select a rectangle of the table.
+column_min | The first column to select. |
column_max | The last column to select. |
row_min | The first row to select. |
row_max | The last row to select. |
Element Render | +( | +) | ++ |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Public Member Functions | |
void | Decorate (Decorator) |
Apply the decorator to the selection. This decorate both the cells, the lines and the corners. More... | |
void | DecorateAlternateRow (Decorator, int modulo=2, int shift=0) |
Apply the decorator to the selection. This decorate only the lines modulo modulo with a shift of shift . More... | |
void | DecorateAlternateColumn (Decorator, int modulo=2, int shift=0) |
Apply the decorator to the selection. This decorate only the lines modulo modulo with a shift of shift . More... | |
void | DecorateCells (Decorator) |
Apply the decorator to the selection. More... | |
void | DecorateCellsAlternateColumn (Decorator, int modulo=2, int shift=0) |
Apply the decorator to the selection. This decorate only the corners modulo modulo with a shift of shift . More... | |
void | DecorateCellsAlternateRow (Decorator, int modulo=2, int shift=0) |
Apply the decorator to the selection. This decorate only the corners modulo modulo with a shift of shift . More... | |
void | Border (BorderStyle border=LIGHT) |
Apply a border around the selection. More... | |
void | BorderLeft (BorderStyle border=LIGHT) |
Draw some separator lines to the left side of the selection. More... | |
void | BorderRight (BorderStyle border=LIGHT) |
Draw some separator lines to the right side of the selection. More... | |
void | BorderTop (BorderStyle border=LIGHT) |
Draw some separator lines to the top side of the selection. More... | |
void | BorderBottom (BorderStyle border=LIGHT) |
Draw some separator lines to the bottom side of the selection. More... | |
void | Separator (BorderStyle border=LIGHT) |
Draw some separator lines in the selection. More... | |
void | SeparatorVertical (BorderStyle border=LIGHT) |
Draw some vertical separator lines in the selection. More... | |
void | SeparatorHorizontal (BorderStyle border=LIGHT) |
Draw some horizontal separator lines in the selection. More... | |
void Decorate | +( | +Decorator | +decorator | ) | ++ |
void DecorateAlternateRow | +( | +Decorator | +decorator, | +
+ | + | int | +modulo = 2 , |
+
+ | + | int | +shift = 0 |
+
+ | ) | ++ |
void DecorateAlternateColumn | +( | +Decorator | +decorator, | +
+ | + | int | +modulo = 2 , |
+
+ | + | int | +shift = 0 |
+
+ | ) | ++ |
void DecorateCells | +( | +Decorator | +decorator | ) | ++ |
void DecorateCellsAlternateColumn | +( | +Decorator | +decorator, | +
+ | + | int | +modulo = 2 , |
+
+ | + | int | +shift = 0 |
+
+ | ) | ++ |
Apply the decorator
to the selection. This decorate only the corners modulo modulo
with a shift of shift
.
decorator | The decorator to apply. |
modulo | The modulo of the corners to decorate. |
shift | The shift of the corners to decorate. |
void DecorateCellsAlternateRow | +( | +Decorator | +decorator, | +
+ | + | int | +modulo = 2 , |
+
+ | + | int | +shift = 0 |
+
+ | ) | ++ |
Apply the decorator
to the selection. This decorate only the corners modulo modulo
with a shift of shift
.
decorator | The decorator to apply. |
modulo | The modulo of the corners to decorate. |
shift | The shift of the corners to decorate. |
void Border | +( | +BorderStyle | +border = LIGHT | ) | ++ |
void BorderLeft | +( | +BorderStyle | +border = LIGHT | ) | ++ |
void BorderRight | +( | +BorderStyle | +border = LIGHT | ) | ++ |
void BorderTop | +( | +BorderStyle | +border = LIGHT | ) | ++ |
void BorderBottom | +( | +BorderStyle | +border = LIGHT | ) | ++ |
void Separator | +( | +BorderStyle | +border = LIGHT | ) | ++ |
void SeparatorVertical | +( | +BorderStyle | +border = LIGHT | ) | ++ |
void SeparatorHorizontal | +( | +BorderStyle | +border = LIGHT | ) | ++ |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Data Structures | |
union | Output.__unnamed2__ |
+Public Member Functions | |
TerminalInputParser (Sender< Task > out) | |
void | Timeout (int time) |
void | Add (char c) |
Definition at line 18 of file terminal_input_parser.hpp.
+union ftxui::TerminalInputParser::Output.__unnamed2__ | +
Definition at line 45 of file terminal_input_parser.hpp.
+Data Fields | ||
---|---|---|
+Mouse | ++mouse | ++ |
+CursorPosition | ++cursor | ++ |
+int | ++cursor_shape | ++ |
+
|
+ +explicit | +
Definition at line 93 of file terminal_input_parser.cpp.
+ +void Timeout | +( | +int | +time | ) | ++ |
Definition at line 96 of file terminal_input_parser.cpp.
+ +void Add | +( | +char | +c | ) | ++ |
Definition at line 108 of file terminal_input_parser.cpp.
+ +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Public Member Functions | |
Animator (float *from, float to=0.f, Duration duration=std::chrono::milliseconds(250), easing::Function easing_function=easing::Linear, Duration delay=std::chrono::milliseconds(0)) | |
void | OnAnimation (Params &) |
float | to () const |
Definition at line 90 of file animation.hpp.
+
+
|
+ +explicit | +
Definition at line 253 of file animation.cpp.
+ +void OnAnimation | +( | +Params & | +params | ) | ++ |
Definition at line 267 of file animation.cpp.
+ +
+
|
+ +inline | +
Definition at line 100 of file animation.hpp.
+ +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Public Member Functions | |
Params (Duration duration) | |
Duration | duration () const |
The duration this animation step represents. More... | |
Definition at line 23 of file animation.hpp.
+Definition at line 25 of file animation.hpp.
+ +
+
|
+ +inline | +
The duration this animation step represents.
+ +Definition at line 28 of file animation.hpp.
+ +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | clear_under (Element element) |
Before drawing |child|, clear the pixels below. This is useful in. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Data Structures | |
class | Color |
A class representing terminal colors. More... | |
+Namespaces | |
ftxui | |
ftxui::literals | |
+Functions | |
Color | operator""_rgb (unsigned long long int combined) |
Creates a color from a combined hex RGB representation, e.g. 0x808000_rgb. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
ColorInfo | GetColorInfo (Color::Palette256 index) |
ColorInfo | GetColorInfo (Color::Palette16 index) |
+Variables | |
const std::array< ColorInfo, 256 > | palette256 |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Data Structures | |
struct | ColorInfo |
+Namespaces | |
ftxui | |
+Functions | |
ColorInfo | GetColorInfo (Color::Palette256 index) |
ColorInfo | GetColorInfo (Color::Palette16 index) |
struct ftxui::ColorInfo | +
Definition at line 12 of file color_info.hpp.
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Component | operator| (Component component, ComponentDecorator decorator) |
Component | operator| (Component component, ElementDecorator decorator) |
Component & | operator|= (Component &component, ComponentDecorator decorator) |
Component & | operator|= (Component &component, ElementDecorator decorator) |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
ftxui::animation | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
ftxui::Container | |
+Typedefs | |
using | ComponentDecorator = std::function< Component(Component)> |
using | ElementDecorator = std::function< Element(Element)> |
+Functions | |
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 | Vertical (Components children) |
A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. More... | |
Component | Vertical (Components children, int *selector) |
A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. This is useful for implementing a Menu for instance. More... | |
Component | Horizontal (Components children) |
A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. More... | |
Component | Horizontal (Components children, int *selector) |
A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. More... | |
Component | Tab (Components children, int *selector) |
A list of components, where only one is drawn and interacted with at a time. The |selector| gives the index of the selected component. This is useful to implement tabs. More... | |
Component | Stacked (Components children) |
A list of components to be stacked on top of each other. Events are propagated to the first component, then the second if not handled, etc. The components are drawn in the reverse order they are given. When a component take focus, it is put at the front, without changing the relative order of the other elements. More... | |
Component | Button (ButtonOption option) |
Draw a button. Execute a function when clicked. More... | |
Component | Button (ConstStringRef label, std::function< void()> on_click, ButtonOption option) |
Draw a button. Execute a function when clicked. More... | |
Component | Checkbox (CheckboxOption option) |
Draw checkable element. More... | |
Component | Checkbox (ConstStringRef label, bool *checked, CheckboxOption option) |
Draw checkable element. More... | |
Component | Input (InputOption option) |
An input box for editing text. More... | |
Component | Input (StringRef content, InputOption option) |
An input box for editing text. More... | |
Component | Input (StringRef content, StringRef placeholder, InputOption option) |
An input box for editing text. More... | |
Component | Menu (MenuOption option) |
A list of text. The focused element is selected. More... | |
Component | Menu (ConstStringListRef entries, int *selected, MenuOption option) |
A list of text. The focused element is selected. More... | |
Component | MenuEntry (MenuEntryOption option) |
A specific menu entry. They can be put into a Container::Vertical to form a menu. More... | |
Component | MenuEntry (ConstStringRef label, MenuEntryOption option) |
A specific menu entry. They can be put into a Container::Vertical to form a menu. More... | |
Component | Radiobox (RadioboxOption option) |
A list of element, where only one can be selected. More... | |
Component | Radiobox (ConstStringListRef entries, int *selected, RadioboxOption option) |
A list of element, where only one can be selected. More... | |
Component | Dropdown (ConstStringListRef entries, int *selected) |
A dropdown menu. More... | |
Component | Dropdown (DropdownOption option) |
A dropdown menu. More... | |
Component | Toggle (ConstStringListRef entries, int *selected) |
An horizontal list of elements. The user can navigate through them. More... | |
template<typename T > | |
Component | Slider (SliderOption< T > options) |
A slider in any direction. More... | |
Component | Slider (ConstStringRef label, Ref< int > value, ConstRef< int > min, ConstRef< int > max, ConstRef< int > increment) |
An horizontal slider. More... | |
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) |
A split in between two components. More... | |
Component | ResizableSplitLeft (Component main, Component back, int *main_size) |
An horizontal split in between two components, configurable using the mouse. More... | |
Component | ResizableSplitRight (Component main, Component back, int *main_size) |
An horizontal split in between two components, configurable using the mouse. More... | |
Component | ResizableSplitTop (Component main, Component back, int *main_size) |
An vertical split in between two components, configurable using the mouse. More... | |
Component | ResizableSplitBottom (Component main, Component back, int *main_size) |
An vertical split in between two components, configurable using the mouse. More... | |
Component | Renderer (Component child, std::function< Element()> render) |
Return a new Component, similar to |child|, but using |render| as the Component::Render() event. More... | |
Component | Renderer (std::function< Element()> render) |
Return a component, using |render| to render its interface. More... | |
Component | Renderer (std::function< Element(bool)> render) |
Return a focusable component, using |render| to render its interface. More... | |
ComponentDecorator | Renderer (ElementDecorator decorator) |
Decorate a component, by decorating what it renders. More... | |
Component | CatchEvent (Component child, std::function< bool(Event)>) |
ComponentDecorator | CatchEvent (std::function< bool(Event)> on_event) |
Decorate a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise. More... | |
Component | Maybe (Component child, const bool *show) |
Decorate a component |child|. It is shown only when |show| is true. More... | |
Component | Maybe (Component child, std::function< bool()> show) |
Decorate a component |child|. It is shown only when |show| returns true. More... | |
ComponentDecorator | Maybe (const bool *show) |
Decorate a component. It is shown only when |show| is true. More... | |
ComponentDecorator | Maybe (std::function< bool()> show) |
Decorate a component. It is shown only when the |show| function returns true. More... | |
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=false) |
Component | Hoverable (Component component, bool *hover) |
Wrap a component. Gives the ability to know if it is hovered by the mouse. More... | |
Component | Hoverable (Component component, std::function< void()> on_enter, std::function< void()> on_leave) |
Wrap a component. Uses callbacks. More... | |
Component | Hoverable (Component component, std::function< void(bool)> on_change) |
Wrap a component. Gives the ability to know if it is hovered by the mouse. More... | |
ComponentDecorator | Hoverable (bool *hover) |
Wrap a component. Gives the ability to know if it is hovered by the mouse. More... | |
ComponentDecorator | Hoverable (std::function< void()> on_enter, std::function< void()> on_leave) |
ComponentDecorator | Hoverable (std::function< void(bool)> on_change) |
Wrap a component. Gives the ability to know if it is hovered by the mouse. More... | |
Component | Window (WindowOptions option) |
A draggeable / resizeable window. To use multiple of them, they must be stacked using Container::Stacked({...}) component;. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Data Structures | |
class | ComponentBase |
It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ftxui::Event. More... | |
+Namespaces | |
ftxui | |
ftxui::animation | |
+Typedefs | |
using | Component = std::shared_ptr< ComponentBase > |
using | Components = std::vector< Component > |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Functions | |
int | LLVMFuzzerTestOneInput (const char *data, size_t size) |
int LLVMFuzzerTestOneInput | +( | +const char * | +data, | +
+ | + | size_t | +size | +
+ | ) | ++ |
Definition at line 193 of file component_fuzzer.cpp.
+ +
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Data Structures | |
struct | EntryState |
arguments for |ButtonOption::transform|, |CheckboxOption::transform|, |Radiobox::transform|, |MenuEntryOption::transform|, |MenuOption::transform|. More... | |
struct | UnderlineOption |
struct | AnimatedColorOption |
Option about a potentially animated color. More... | |
struct | AnimatedColorsOption |
struct | MenuEntryOption |
Option for the MenuEntry component. More... | |
struct | MenuOption |
Option for the Menu component. More... | |
struct | ButtonOption |
Option for the AnimatedButton component. More... | |
struct | CheckboxOption |
Option for the Checkbox component. More... | |
struct | InputState |
Used to define style for the Input component. More... | |
struct | InputOption |
Option for the Input component. More... | |
struct | RadioboxOption |
Option for the Radiobox component. More... | |
struct | ResizableSplitOption |
struct | SliderOption< T > |
struct | WindowRenderState |
struct | WindowOptions |
struct | DropdownOption |
Option for the Dropdown component.A dropdown menu is a checkbox opening/closing a radiobox. More... | |
+Namespaces | |
ftxui | |
struct ftxui::EntryState | +
arguments for |ButtonOption::transform|, |CheckboxOption::transform|, |Radiobox::transform|, |MenuEntryOption::transform|, |MenuOption::transform|.
+ +Definition at line 23 of file component_options.hpp.
+struct ftxui::AnimatedColorsOption | +
Definition at line 69 of file component_options.hpp.
+Data Fields | ||
---|---|---|
+AnimatedColorOption | ++background | ++ |
+AnimatedColorOption | ++foreground | ++ |
struct ftxui::MenuEntryOption | +
Option for the MenuEntry component.
+ +Definition at line 76 of file component_options.hpp.
+Data Fields | ||
---|---|---|
+ConstStringRef | ++label | ++ |
+function< Element(const EntryState &state)> | ++transform | ++ |
+AnimatedColorsOption | ++animated_colors | ++ |
struct ftxui::InputState | +
Used to define style for the Input component.
+ +Definition at line 151 of file component_options.hpp.
+Data Fields | ||
---|---|---|
+Element | ++element | ++ |
+bool | ++hovered | ++Whether the input is hovered by the mouse. |
+bool | ++focused | ++Whether the input is focused by the user. |
+bool | ++is_placeholder | +
+ Whether the input is empty and displaying the placeholder. + |
struct ftxui::ResizableSplitOption | +
struct ftxui::SliderOption | +
Definition at line 222 of file component_options.hpp.
+Data Fields | ||
---|---|---|
+Ref< T > | ++value | ++ |
+ConstRef< T > | ++min | ++ |
+ConstRef< T > | ++max | ++ |
+ConstRef< T > | ++increment | ++ |
+Direction | ++direction | ++ |
+Color | ++color_active | ++ |
+Color | ++color_inactive | ++ |
struct ftxui::WindowRenderState | +
Definition at line 233 of file component_options.hpp.
+Data Fields | ||
---|---|---|
+Element | ++inner | ++The element wrapped inside this window. |
+const string & | ++title | ++The title of the window. |
+bool | ++active | ++Whether the window is the active one. |
+bool | ++drag | ++Whether the window is being dragged. |
+bool | ++resize | ++Whether the window is being resized. |
+bool | ++hover_left | ++Whether the resizeable left side is hovered. |
+bool | ++hover_right | ++Whether the resizeable right side is hovered. |
+bool | ++hover_top | ++Whether the resizeable top side is hovered. |
+bool | ++hover_down | ++Whether the resizeable down side is hovered. |
struct ftxui::WindowOptions | +
Definition at line 247 of file component_options.hpp.
+Data Fields | ||
---|---|---|
+Component | ++inner | ++The component wrapped by this window. |
+ConstStringRef | ++title | ++The title displayed by this window. |
+Ref< int > | ++left | ++The left side position of the window. |
+Ref< int > | ++top | ++The top side position of the window. |
+Ref< int > | ++width | ++The width of the window. |
+Ref< int > | ++height | ++The height of the window. |
+Ref< bool > | ++resize_left | ++Can the left side be resized? |
+Ref< bool > | ++resize_right | ++Can the right side be resized? |
+Ref< bool > | ++resize_top | ++Can the top side be resized? |
+Ref< bool > | ++resize_down | ++Can the down side be resized? |
+function< Element(const WindowRenderState &)> | ++render | ++An optional function to customize how the window looks like: |
struct ftxui::DropdownOption | +
Option for the Dropdown component.
+A dropdown menu is a checkbox opening/closing a radiobox.
+ +Definition at line 268 of file component_options.hpp.
+Data Fields | ||
---|---|---|
+Ref< bool > | ++open | ++Whether the dropdown is open or closed: |
+CheckboxOption | ++checkbox | ++ |
+RadioboxOption | ++radiobox | ++ |
+function< Element(bool open, Element checkbox, Element radiobox)> | ++transform | ++ |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | hcenter (Element child) |
Center an element horizontally. More... | |
Element | vcenter (Element child) |
Center an element vertically. More... | |
Element | center (Element child) |
Center an element horizontally and vertically. More... | |
Element | align_right (Element child) |
Align an element on the right side. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
ftxui::Container | |
+Functions | |
Component | Vertical (Components children) |
A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. More... | |
Component | Vertical (Components children, int *selector) |
A list of components, drawn one by one vertically and navigated vertically using up/down arrow key or 'j'/'k' keys. This is useful for implementing a Menu for instance. More... | |
Component | Horizontal (Components children) |
A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. More... | |
Component | Horizontal (Components children, int *selector) |
A list of components, drawn one by one horizontally and navigated horizontally using left/right arrow key or 'h'/'l' keys. More... | |
Component | Tab (Components children, int *selector) |
A list of components, where only one is drawn and interacted with at a time. The |selector| gives the index of the selected component. This is useful to implement tabs. More... | |
Component | Stacked (Components children) |
A list of components to be stacked on top of each other. Events are propagated to the first component, then the second if not handled, etc. The components are drawn in the reverse order they are given. When a component take focus, it is put at the front, without changing the relative order of the other elements. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | dbox (Elements children_) |
Stack several element on top of each other. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | dim (Element child) |
Use a light font, for elements with less emphasis. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
File in include/ftxui/component | Includes file in include/ftxui/dom |
---|---|
component.hpp | elements.hpp |
component_base.hpp | elements.hpp |
component_options.hpp | direction.hpp |
component_options.hpp | elements.hpp |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
File in include/ftxui/component | Includes file in include/ftxui/screen |
---|---|
component_options.hpp | color.hpp |
screen_interactive.hpp | screen.hpp |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
File in include/ftxui/component | Includes file in include/ftxui/util |
---|---|
component.hpp | ref.hpp |
component_options.hpp | ref.hpp |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
File in include/ftxui/dom | Includes file in include/ftxui/screen |
---|---|
canvas.hpp | color.hpp |
canvas.hpp | image.hpp |
elements.hpp | box.hpp |
elements.hpp | color.hpp |
elements.hpp | terminal.hpp |
linear_gradient.hpp | color.hpp |
node.hpp | box.hpp |
node.hpp | screen.hpp |
requirement.hpp | box.hpp |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
File in include/ftxui/dom | Includes file in include/ftxui/util |
---|---|
elements.hpp | ref.hpp |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
File in include/ftxui/util | Includes file in include/ftxui/screen |
---|---|
ref.hpp | string.hpp |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
File in src/ftxui/component | Includes file in src/ftxui/dom |
---|---|
window.cpp | node_decorator.hpp |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
File in src/ftxui/component | Includes file in src/ftxui/screen |
---|---|
dropdown.cpp | util.hpp |
input.cpp | string_internal.hpp |
input.cpp | util.hpp |
menu.cpp | util.hpp |
radiobox.cpp | util.hpp |
slider.cpp | util.hpp |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
File in src/ftxui/screen | Includes file in include |
---|---|
box.cpp | ftxui / screen / box.hpp |
color.cpp | ftxui / screen / color.hpp |
color.cpp | ftxui / screen / color_info.hpp |
color.cpp | ftxui / screen / terminal.hpp |
color_info.cpp | ftxui / screen / color.hpp |
color_info.cpp | ftxui / screen / color_info.hpp |
image.cpp | ftxui / screen / image.hpp |
screen.cpp | ftxui / screen / screen.hpp |
screen.cpp | ftxui / screen / string.hpp |
screen.cpp | ftxui / screen / terminal.hpp |
string.cpp | ftxui / screen / deprecated.hpp |
string.cpp | ftxui / screen / string.hpp |
terminal.cpp | ftxui / screen / terminal.hpp |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Files | |
file | autoreset.hpp [code] |
file | ref.hpp [code] |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Files | |
file | box.cpp [code] |
file | color.cpp [code] |
file | color_info.cpp [code] |
file | image.cpp [code] |
file | screen.cpp [code] |
file | string.cpp [code] |
file | string_internal.hpp [code] |
file | terminal.cpp [code] |
file | util.hpp [code] |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Files | |
file | canvas.hpp [code] |
file | deprecated.hpp [code] |
file | direction.hpp [code] |
file | elements.hpp [code] |
file | flexbox_config.hpp [code] |
file | linear_gradient.hpp [code] |
file | node.hpp [code] |
file | requirement.hpp [code] |
file | table.hpp [code] |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Files | |
file | box.hpp [code] |
file | color.hpp [code] |
file | color_info.hpp [code] |
file | deprecated.hpp [code] |
file | image.hpp [code] |
file | pixel.hpp [code] |
file | screen.hpp [code] |
file | string.hpp [code] |
file | terminal.hpp [code] |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Files | |
file | animation.cpp [code] |
file | button.cpp [code] |
file | catch_event.cpp [code] |
file | checkbox.cpp [code] |
file | collapsible.cpp [code] |
file | component.cpp [code] |
file | component_fuzzer.cpp [code] |
file | component_options.cpp [code] |
file | container.cpp [code] |
file | dropdown.cpp [code] |
file | event.cpp [code] |
file | hoverable.cpp [code] |
file | input.cpp [code] |
file | loop.cpp [code] |
file | maybe.cpp [code] |
file | menu.cpp [code] |
file | modal.cpp [code] |
file | radiobox.cpp [code] |
file | renderer.cpp [code] |
file | resizable_split.cpp [code] |
file | screen_interactive.cpp [code] |
file | slider.cpp [code] |
file | terminal_input_parser.cpp [code] |
file | terminal_input_parser.hpp [code] |
file | terminal_input_parser_test_fuzzer.cpp [code] |
file | util.cpp [code] |
file | window.cpp [code] |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+Files | |
file | animation.hpp [code] |
file | captured_mouse.hpp [code] |
file | component.hpp [code] |
file | component_base.hpp [code] |
file | component_options.hpp [code] |
file | event.hpp [code] |
file | loop.hpp [code] |
file | mouse.hpp [code] |
file | receiver.hpp [code] |
file | screen_interactive.hpp [code] |
file | task.hpp [code] |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | color (Color color, Element child) |
Set the foreground color of an element. More... | |
Element | bgcolor (Color color, Element child) |
Set the background color of an element. More... | |
Decorator | color (Color c) |
Decorate using a foreground color. More... | |
Decorator | bgcolor (Color color) |
Decorate using a background color. More... | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | text (std::wstring text) |
Display a piece of unicode text. More... | |
Element | vtext (std::wstring text) |
Display a piece unicode text vertically. More... | |
Elements | paragraph (std::wstring text) |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+Functions | |
Element | nothing (Element element) |
A decoration doing absolutely nothing. More... | |
Decorator | operator| (Decorator a, Decorator b) |
Compose two decorator into one. More... | |
Elements | operator| (Elements elements, Decorator decorator) |
From a set of element, apply a decorator to every elements. More... | |
Element | operator| (Element element, Decorator decorator) |
From an element, apply a decorator. More... | |
Element & | operator|= (Element &e, Decorator d) |
Apply a decorator to an element. More... | |
Element | emptyElement () |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
ftxui::Dimension | |
Define how the Screen's dimensions should look like. | |
+Typedefs | |
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)> |
+Enumerations | |
enum | BorderStyle { + LIGHT +, DASHED +, HEAVY +, DOUBLE +, + ROUNDED +, EMPTY + + } |
enum | WidthOrHeight { WIDTH +, HEIGHT + } |
enum | Constraint { LESS_THAN +, EQUAL +, GREATER_THAN + } |
+Functions | |
Element | operator| (Element element, Decorator decorator) |
From an element, apply a decorator. More... | |
Element & | operator|= (Element &e, Decorator d) |
Apply a decorator to an element. More... | |
Elements | operator| (Elements elements, Decorator decorator) |
From a set of element, apply a decorator to every elements. More... | |
Decorator | operator| (Decorator a, Decorator b) |
Compose two decorator into one. More... | |
Element | text (std::string text) |
Display a piece of UTF8 encoded unicode text. More... | |
Element | vtext (std::string text) |
Display a piece of unicode text vertically. More... | |
Element | separator () |
Draw a vertical or horizontal separation in between two other elements. More... | |
Element | separatorLight () |
Draw a vertical or horizontal separation in between two other elements, using the LIGHT style. More... | |
Element | separatorDashed () |
Draw a vertical or horizontal separation in between two other elements, using the DASHED style. More... | |
Element | separatorHeavy () |
Draw a vertical or horizontal separation in between two other elements, using the HEAVY style. More... | |
Element | separatorDouble () |
Draw a vertical or horizontal separation in between two other elements, using the DOUBLE style. More... | |
Element | separatorEmpty () |
Draw a vertical or horizontal separation in between two other elements, using the EMPTY style. More... | |
Element | separatorStyled (BorderStyle style) |
Draw a vertical or horizontal separation in between two other elements. More... | |
Element | separator (Pixel pixel) |
Draw a separator in between two element filled with a given pixel. More... | |
Element | separatorCharacter (std::string value) |
Draw a vertical or horizontal separation in between two other elements. More... | |
Element | separatorHSelector (float left, float right, Color unselected_color, Color selected_color) |
Draw an horizontal bar, with the area in between left/right colored differently. More... | |
Element | separatorVSelector (float up, float down, Color unselected_color, Color selected_color) |
Draw an vertical bar, with the area in between up/downcolored differently. More... | |
Element | gauge (float progress) |
Draw a high definition progress bar. More... | |
Element | gaugeLeft (float progress) |
Draw a high definition progress bar progressing from right to left. More... | |
Element | gaugeRight (float progress) |
Draw a high definition progress bar progressing from left to right. More... | |
Element | gaugeUp (float progress) |
Draw a high definition progress bar progressing from bottom to top. More... | |
Element | gaugeDown (float progress) |
Draw a high definition progress bar progressing from top to bottom. More... | |
Element | gaugeDirection (float progress, Direction direction) |
Draw a high definition progress bar progressing in specified direction. More... | |
Element | border (Element child) |
Draw a border around the element. More... | |
Element | borderLight (Element child) |
Draw a dashed border around the element. More... | |
Element | borderDashed (Element child) |
Draw a light border around the element. More... | |
Element | borderHeavy (Element child) |
Draw a heavy border around the element. More... | |
Element | borderDouble (Element child) |
Draw a double border around the element. More... | |
Element | borderRounded (Element child) |
Draw a rounded border around the element. More... | |
Element | borderEmpty (Element child) |
Draw an empty border around the element. More... | |
Decorator | borderStyled (BorderStyle style) |
Same as border but with different styles. More... | |
Decorator | borderStyled (BorderStyle style, Color foreground_color) |
Same as border but with a foreground color and a different style. More... | |
Decorator | borderStyled (Color foreground_color) |
Same as border but with a foreground color. More... | |
Decorator | borderWith (const Pixel &pixel) |
Same as border but with a constant Pixel around the element. More... | |
Element | window (Element title, Element content, BorderStyle border) |
Draw window with a title and a border around the element. More... | |
Element | spinner (int charset_index, size_t image_index) |
Useful to represent the effect of time and/or events. This display an ASCII art "video". More... | |
Element | paragraph (const std::string &the_text) |
Return an element drawing the paragraph on multiple lines. More... | |
Element | paragraphAlignLeft (const std::string &the_text) |
Return an element drawing the paragraph on multiple lines, aligned on the left. More... | |
Element | paragraphAlignRight (const std::string &the_text) |
Return an element drawing the paragraph on multiple lines, aligned on the right. More... | |
Element | paragraphAlignCenter (const std::string &the_text) |
Return an element drawing the paragraph on multiple lines, aligned on the center. More... | |
Element | paragraphAlignJustify (const std::string &the_text) |
Return an element drawing the paragraph on multiple lines, aligned using a justified alignment. the center. More... | |
Element | graph (GraphFunction graph_function) |
Draw a graph using a GraphFunction. More... | |
Element | emptyElement () |
Element | canvas (ConstRef< Canvas > canvas) |
Produce an element from a Canvas, or a reference to a Canvas. More... | |
Element | canvas (int width, int height, std::function< void(Canvas &)> fn) |
Produce an element drawing a canvas of requested size. More... | |
Element | canvas (std::function< void(Canvas &)> fn) |
Produce an element drawing a canvas. More... | |
Element | bold (Element child) |
Use a bold font, for elements with more emphasis. More... | |
Element | dim (Element child) |
Use a light font, for elements with less emphasis. More... | |
Element | inverted (Element child) |
Add a filter that will invert the foreground and the background colors. More... | |
Element | underlined (Element child) |
Make the underlined element to be underlined. More... | |
Element | underlinedDouble (Element child) |
Apply a underlinedDouble to text. More... | |
Element | blink (Element child) |
The text drawn alternates in between visible and hidden. More... | |
Element | strikethrough (Element child) |
Apply a strikethrough to text. More... | |
Decorator | color (Color c) |
Decorate using a foreground color. More... | |
Decorator | bgcolor (Color color) |
Decorate using a background color. More... | |
Decorator | color (const LinearGradient &gradient) |
Decorate using a linear-gradient effect on the foreground color. More... | |
Decorator | bgcolor (const LinearGradient &gradient) |
Decorate using a linear-gradient effect on the background color. More... | |
Element | color (Color color, Element child) |
Set the foreground color of an element. More... | |
Element | bgcolor (Color color, Element child) |
Set the background color of an element. More... | |
Element | color (const LinearGradient &gradient, Element child) |
Set the foreground color of an element with linear-gradient effect. More... | |
Element | bgcolor (const LinearGradient &gradient, Element child) |
Set the background color of an element with linear-gradient effect. More... | |
Decorator | focusPosition (int x, int y) |
Used inside a frame , this force the view to be scrolled toward a a given position. The position is expressed in the numbers of cells. More... | |
Decorator | focusPositionRelative (float x, float y) |
Used inside a frame , this force the view to be scrolled toward a a given position. The position is expressed in proportion of the requested size. More... | |
Element | automerge (Element child) |
Enable character to be automatically merged with others nearby. More... | |
Decorator | hyperlink (std::string link) |
Decorate using an hyperlink. The link will be opened when the user click on it. This is supported only on a limited set of terminal emulator. List: https://github.com/Alhadis/OSC8-Adoption/. More... | |
Element | hyperlink (std::string link, Element child) |
Make the rendered area clickable using a web browser. The link will be opened when the user click on it. This is supported only on a limited set of terminal emulator. List: https://github.com/Alhadis/OSC8-Adoption/. More... | |
Element | hbox (Elements children) |
A container displaying elements horizontally one by one. More... | |
Element | vbox (Elements children) |
A container displaying elements vertically one by one. More... | |
Element | dbox (Elements children_) |
Stack several element on top of each other. More... | |
Element | flexbox (Elements, FlexboxConfig config=FlexboxConfig()) |
Element | gridbox (std::vector< Elements > lines) |
A container displaying a grid of elements. More... | |
Element | hflow (Elements) |
Element | vflow (Elements) |
Element | flex (Element child) |
Make a child element to expand proportionally to the space left in a container. More... | |
Element | flex_grow (Element child) |
Expand if possible. More... | |
Element | flex_shrink (Element child) |
Minimize if needed. More... | |
Element | xflex (Element child) |
Expand/Minimize if possible/needed on the X axis. More... | |
Element | xflex_grow (Element child) |
Expand if possible on the X axis. More... | |
Element | xflex_shrink (Element child) |
Minimize if needed on the X axis. More... | |
Element | yflex (Element child) |
Expand/Minimize if possible/needed on the Y axis. More... | |
Element | yflex_grow (Element child) |
Expand if possible on the Y axis. More... | |
Element | yflex_shrink (Element child) |
Minimize if needed on the Y axis. More... | |
Element | notflex (Element child) |
Make the element not flexible. More... | |
Element | filler () |
An element that will take expand proportionally to the space left in a container. More... | |
Decorator | size (WidthOrHeight direction, Constraint constraint, int value) |
Apply a constraint on the size of an element. More... | |
Element | frame (Element child) |
Allow an element to be displayed inside a 'virtual' area. It size can be larger than its container. In this case only a smaller portion is displayed. The view is scrollable to make the focused element visible. More... | |
Element | xframe (Element child) |
Same as frame , but only on the x-axis. More... | |
Element | yframe (Element child) |
Same as frame , but only on the y-axis. More... | |
Element | focus (Element child) |
Set the child to be the one in focus globally. More... | |
Element | select (Element child) |
Set the child to be the one selected among its siblings. More... | |
Element | focusCursorBlock (Element child) |
Same as focus , but set the cursor shape to be a still block. More... | |
Element | focusCursorBlockBlinking (Element child) |
Same as focus , but set the cursor shape to be a blinking block. More... | |
Element | focusCursorBar (Element child) |
Same as focus , but set the cursor shape to be a still block. More... | |
Element | focusCursorBarBlinking (Element child) |
Same as focus , but set the cursor shape to be a blinking bar. More... | |
Element | focusCursorUnderline (Element child) |
Same as focus , but set the cursor shape to be a still underline. More... | |
Element | focusCursorUnderlineBlinking (Element child) |
Same as focus , but set the cursor shape to be a blinking underline. More... | |
Element | vscroll_indicator (Element child) |
Display a vertical scrollbar to the right. colors. More... | |
Element | hscroll_indicator (Element child) |
Display an horizontal scrollbar to the bottom. colors. More... | |
Decorator | reflect (Box &box) |
Element | clear_under (Element element) |
Before drawing |child|, clear the pixels below. This is useful in. More... | |
Element | hcenter (Element child) |
Center an element horizontally. More... | |
Element | vcenter (Element child) |
Center an element vertically. More... | |
Element | center (Element child) |
Center an element horizontally and vertically. More... | |
Element | align_right (Element child) |
Align an element on the right side. More... | |
Element | nothing (Element element) |
A decoration doing absolutely nothing. More... | |
Dimensions | Fit (Element &) |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Namespaces | |
ftxui | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
Go to the source code of this file.
++Data Structures | |
struct | Event |
Represent an event. It can be key press event, a terminal resize, or more ... More... | |
+Namespaces | |
ftxui | |
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+
+ FTXUI
+ 5.0.0
+
+ C++ functional terminal UI.
+ |
+