This graph shows which files directly or indirectly include 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/menu_entries.cpp, and examples/component/menu_style.cpp.

Definition at line 24 of file component_options.hpp.

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

◆ 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 = "MenuEntry"
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
bool	focused	< Whether the input is hovered by the mouse.
bool	is_placeholder	< Whether the input is focused by the user.

◆ ftxui::ResizableSplitOption

struct ftxui::ResizableSplitOption

Definition at line 209 of file component_options.hpp.

Data Fields
Component	main
Component	back
Ref< Direction >	direction = Direction::Left
Ref< int >	main_size
function< Element()>	separator_func = [] { return ::ftxui::separator(); }

◆ ftxui::SliderOption

struct ftxui::SliderOption

template<typename T>
struct ftxui::SliderOption< T >

Examples: examples/component/slider_direction.cpp.

Definition at line 222 of file component_options.hpp.

Data Fields
Ref< T >	value
ConstRef< T >	min = T(0)
ConstRef< T >	max = T(100)
ConstRef< T >	increment = (max() - min()) / 20
Direction	direction = Direction::Right
Color	color_active = Color::White
Color	color_inactive = Color::GrayDark

◆ ftxui::WindowRenderState

struct ftxui::WindowRenderState

Definition at line 233 of file component_options.hpp.

Data Fields
Element	inner
const string &	title	< The element wrapped inside this window.
bool	active = false	< The title of the window.
bool	drag = false	< Whether the window is the active one.
bool	resize = false	< Whether the window is being dragged.
bool	hover_left = false	< Whether the window is being resized.
bool	hover_right = false	< Whether the resizeable left side is hovered.
bool	hover_top = false	< Whether the resizeable right side is hovered.
bool	hover_down = false	< Whether the resizeable top side is hovered.

◆ ftxui::WindowOptions

struct ftxui::WindowOptions

Definition at line 247 of file component_options.hpp.

Data Fields
Component	inner
ConstStringRef	title = ""	< The component wrapped by this window.
Ref< int >	left = 0	< The title displayed by this window.
Ref< int >	top = 0	< The left side position of the window.
Ref< int >	width = 20	< The top side position of the window.
Ref< int >	height = 10	< The width of the window.
Ref< bool >	resize_left = true	< The height of the window.
Ref< bool >	resize_right = true	< Can the left side be resized?
Ref< bool >	resize_top = true	< Can the right side be resized?
Ref< bool >	resize_down = true	< Can the top side be resized?
function< Element(const WindowRenderState &)>	render	< Can the down side be resized? An optional function to customize how the window looks like:

Data Structures

Namespaces