FTXUI  5.0.0
C++ functional terminal UI.
component_options.hpp File Reference
+ This graph shows which files directly or indirectly include this file:

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
 

Namespaces

namespace  ftxui
 

Data Structure Documentation

◆ ftxui::EntryState

struct ftxui::EntryState

arguments for |ButtonOption::transform|, |CheckboxOption::transform|, |Radiobox::transform|, |MenuEntryOption::transform|, |MenuOption::transform|.

Examples
examples/component/button.cpp, examples/component/menu_entries.cpp, and examples/component/menu_style.cpp.

Definition at line 24 of file component_options.hpp.

Data Fields
string label The label to display.
bool state The state of the button/checkbox/radiobox.
bool active Whether the entry is the active one.
bool focused Whether the entry is one focused by the user.

◆ ftxui::AnimatedColorsOption

struct ftxui::AnimatedColorsOption

Definition at line 70 of file component_options.hpp.

Data Fields
AnimatedColorOption background
AnimatedColorOption foreground

◆ ftxui::MenuEntryOption

struct ftxui::MenuEntryOption

Option for the MenuEntry component.

Examples
examples/component/menu_entries.cpp, and examples/component/menu_entries_animated.cpp.

Definition at line 77 of file component_options.hpp.

Data Fields
ConstStringRef label
function< Element(const EntryState &state)> transform
AnimatedColorsOption animated_colors

◆ ftxui::InputState

struct ftxui::InputState

Used to define style for the Input component.

Examples
examples/component/input_style.cpp.

Definition at line 152 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.

◆ ftxui::ResizableSplitOption

struct ftxui::ResizableSplitOption

Definition at line 210 of file component_options.hpp.

Data Fields
Component main
Component back
Ref< Direction > direction
Ref< int > main_size
function< Element()> separator_func

◆ ftxui::SliderOption

struct ftxui::SliderOption
template<typename T>
struct ftxui::SliderOption< T >
Examples
examples/component/slider_direction.cpp.

Definition at line 223 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

◆ ftxui::WindowRenderState

struct ftxui::WindowRenderState

Definition at line 234 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.

◆ ftxui::WindowOptions

struct ftxui::WindowOptions

Definition at line 248 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: