ftxui::MenuBase
ComponentBase
MenuOption
int int selected_previous_ selected_previous_ ftxui::MenuBase::selected_previous_ = selected()
int int selected_focus_ selected_focus_ ftxui::MenuBase::selected_focus_ = selected()
std::vector< Box > std::vector<Box> boxes_ boxes_ ftxui::MenuBase::boxes_
Box Box box_ box_ ftxui::MenuBase::box_
float float first_ first_ ftxui::MenuBase::first_ = 0.F
float float second_ second_ ftxui::MenuBase::second_ = 0.F
animation::Animator animation::Animator animator_first_ animator_first_ ftxui::MenuBase::animator_first_ = animation::Animator(&first_, 0.F)
animation::Animator animation::Animator animator_second_ animator_second_ ftxui::MenuBase::animator_second_ = animation::Animator(&second_, 0.F)
std::vector< animation::Animator > std::vector<animation::Animator> animator_background_ animator_background_ ftxui::MenuBase::animator_background_
std::vector< animation::Animator > std::vector<animation::Animator> animator_foreground_ animator_foreground_ ftxui::MenuBase::animator_foreground_
std::vector< float > std::vector<float> animation_background_ animation_background_ ftxui::MenuBase::animation_background_
std::vector< float > std::vector<float> animation_foreground_ animation_foreground_ ftxui::MenuBase::animation_foreground_
Components Components children_ children_ ftxui::ComponentBase::children_
MenuBase
(const MenuOption &option)
MenuBase
ftxui::MenuBase::MenuBase
const MenuOption & option
bool bool IsHorizontal () IsHorizontal ftxui::MenuBase::IsHorizontal
void void OnChange () OnChange ftxui::MenuBase::OnChange
void void OnEnter () OnEnter ftxui::MenuBase::OnEnter
void void Clamp () Clamp ftxui::MenuBase::Clamp
void void OnAnimation (animation::Params &params) override OnAnimation ftxui::MenuBase::OnAnimation animation::Params & params
Element Element OnRender () override OnRender ftxui::MenuBase::OnRender
void void SelectedTakeFocus () SelectedTakeFocus ftxui::MenuBase::SelectedTakeFocus
void void OnUp () OnUp ftxui::MenuBase::OnUp
void void OnDown () OnDown ftxui::MenuBase::OnDown
void void OnLeft () OnLeft ftxui::MenuBase::OnLeft
void void OnRight () OnRight ftxui::MenuBase::OnRight
bool bool OnEvent (Event event) override OnEvent ftxui::MenuBase::OnEvent Event event
bool bool OnMouseEvent (Event event) OnMouseEvent ftxui::MenuBase::OnMouseEvent Event event
bool bool OnMouseWheel (Event event) OnMouseWheel ftxui::MenuBase::OnMouseWheel Event event
void void UpdateAnimationTarget () UpdateAnimationTarget ftxui::MenuBase::UpdateAnimationTarget
void void UpdateColorTarget () UpdateColorTarget ftxui::MenuBase::UpdateColorTarget
Decorator Decorator AnimatedColorStyle (int i) AnimatedColorStyle ftxui::MenuBase::AnimatedColorStyle int i
void void UpdateUnderlineTarget () UpdateUnderlineTarget ftxui::MenuBase::UpdateUnderlineTarget
bool bool Focusable () const final Focusable ftxui::MenuBase::Focusable
int int size () const size ftxui::MenuBase::size
float float FirstTarget () FirstTarget ftxui::MenuBase::FirstTarget
float float SecondTarget () SecondTarget ftxui::MenuBase::SecondTarget
ComponentBase * ComponentBase * Parent () const Parent ftxui::ComponentBase::Parent

Return the parent ComponentBase, or nul if any.

Detach

Parent

Component & Component & ChildAt (size_t i) ChildAt ftxui::ComponentBase::ChildAt size_t i

Access the child at index `i`.

size_t size_t ChildCount () const ChildCount ftxui::ComponentBase::ChildCount

Returns the number of children.

int int Index () const Index ftxui::ComponentBase::Index

Return index of the component in its parent. -1 if no parent.

void void Add (Component children) Add ftxui::ComponentBase::Add Component children

Add a child. @param child The child to be attached.

void void Detach () Detach ftxui::ComponentBase::Detach

Detach this child from its parent.

Detach

Parent

void void DetachAllChildren () DetachAllChildren ftxui::ComponentBase::DetachAllChildren

Remove all children.

Element Element Render () Render ftxui::ComponentBase::Render

Draw the component. Build a ftxui::Element to be drawn on the ftxui::Screen representing this ftxui::ComponentBase. Please override OnRender() to modify the rendering.

Component Component ActiveChild () ActiveChild ftxui::ComponentBase::ActiveChild

Return the currently Active child.

the currently Active child.

bool bool Active () const Active ftxui::ComponentBase::Active

Returns if the element if the currently active child of its parent.

bool bool Focused () const Focused ftxui::ComponentBase::Focused

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().

void void SetActiveChild (ComponentBase *child) SetActiveChild ftxui::ComponentBase::SetActiveChild ComponentBase * child

Make the |child| to be the "active" one.

child

the child to become active.

void void SetActiveChild (Component child) SetActiveChild ftxui::ComponentBase::SetActiveChild Component child

Make the |child| to be the "active" one.

child

the child to become active.

void void TakeFocus () TakeFocus ftxui::ComponentBase::TakeFocus

Configure all the ancestors to give focus to this component.

CapturedMouse CapturedMouse CaptureMouse (const Event &event) CaptureMouse ftxui::ComponentBase::CaptureMouse const Event & event

Take the CapturedMouse if available. There is only one component of them. It represents a component taking priority over others.

event

The event

ConstStringListRef ConstStringListRef entries entries ftxui::MenuOption::entries
Ref< int > Ref<int> selected selected ftxui::MenuOption::selected = 0

> The list of entries.

UnderlineOption UnderlineOption underline underline ftxui::MenuOption::underline

> The index of the selected entry.

MenuEntryOption MenuEntryOption entries_option entries_option ftxui::MenuOption::entries_option
Direction Direction direction direction ftxui::MenuOption::direction = Direction::Down
std::function< Element()> std::function<Element()> elements_prefix elements_prefix ftxui::MenuOption::elements_prefix
std::function< Element()> std::function<Element()> elements_infix elements_infix ftxui::MenuOption::elements_infix
std::function< Element()> std::function<Element()> elements_postfix elements_postfix ftxui::MenuOption::elements_postfix
std::function< void()> std::function<void()> on_change on_change ftxui::MenuOption::on_change
std::function< void()> std::function<void()> on_enter on_enter ftxui::MenuOption::on_enter

> Called when the selected entry changes.

Ref< int > Ref<int> focused_entry focused_entry ftxui::MenuOption::focused_entry = 0

> Called when the user presses enter.

MenuOption MenuOption Horizontal () Horizontal ftxui::MenuOption::Horizontal

Standard options for an horizontal menu. This can be useful to implement a tab bar.

MenuOption MenuOption HorizontalAnimated () HorizontalAnimated ftxui::MenuOption::HorizontalAnimated

Standard options for an animated horizontal menu. This can be useful to implement a tab bar.

MenuOption MenuOption Vertical () Vertical ftxui::MenuOption::Vertical

Standard options for a vertical menu. This can be useful to implement a list of selectable items.

MenuOption MenuOption VerticalAnimated () VerticalAnimated ftxui::MenuOption::VerticalAnimated

Standard options for an animated vertical menu. This can be useful to implement a list of selectable items.

MenuOption MenuOption Toggle () Toggle ftxui::MenuOption::Toggle

Standard options for a horitontal menu with some separator. This can be useful to implement a tab bar.

A list of items. The user can navigate through them.

MenuBase
ComponentBase
MenuOption
MenuBase
box_
animator_first_
animator_second_
AnimatedColorOption
active
inactive
AnimatedColorsOption
background
foreground
Box
Color
ComponentBase
ConstRef< std::string >
ConstStringListRef
ConstStringRef
MenuEntryOption
label
animated_colors
MenuOption
entries
focused_entry
selected
underline
entries_option
Ref< int >
UnderlineOption
color_active
color_inactive
Animator
- ftxui::MenuBase
  Active
- ftxui::MenuBase
  ActiveChild
- ftxui::MenuBase
  Add
- ftxui::MenuBase
  AnimatedColorStyle
- ftxui::MenuBase
  animation_background_
- ftxui::MenuBase
  animation_foreground_
- ftxui::MenuBase
  animator_background_
- ftxui::MenuBase
  animator_first_
- ftxui::MenuBase
  animator_foreground_
- ftxui::MenuBase
  animator_second_
- ftxui::MenuBase
  box_
- ftxui::MenuBase
  boxes_
- ftxui::MenuBase
  CaptureMouse
- ftxui::MenuBase
  ChildAt
- ftxui::MenuBase
  ChildCount
- ftxui::MenuBase
  children_
- ftxui::MenuBase
  Clamp
- ftxui::MenuBase
  ComponentBase
- ftxui::MenuBase
  ComponentBase
- ftxui::MenuBase
  ComponentBase
- ftxui::MenuBase
  ComponentBase
- ftxui::MenuBase
  Detach
- ftxui::MenuBase
  DetachAllChildren
- ftxui::MenuBase
  direction
- ftxui::MenuBase
  elements_infix
- ftxui::MenuBase
  elements_postfix
- ftxui::MenuBase
  elements_prefix
- ftxui::MenuBase
  entries
- ftxui::MenuBase
  entries_option
- ftxui::MenuBase
  first_
- ftxui::MenuBase
  FirstTarget
- ftxui::MenuBase
  Focusable
- ftxui::MenuBase
  Focused
- ftxui::MenuBase
  focused_entry
- ftxui::MenuBase
  Horizontal
- ftxui::MenuBase
  HorizontalAnimated
- ftxui::MenuBase
  Index
- ftxui::MenuBase
  IsHorizontal
- ftxui::MenuBase
  MenuBase
- ftxui::MenuBase
  on_change
- ftxui::MenuBase
  on_enter
- ftxui::MenuBase
  OnAnimation
- ftxui::MenuBase
  OnChange
- ftxui::MenuBase
  OnDown
- ftxui::MenuBase
  OnEnter
- ftxui::MenuBase
  OnEvent
- ftxui::MenuBase
  OnLeft
- ftxui::MenuBase
  OnMouseEvent
- ftxui::MenuBase
  OnMouseWheel
- ftxui::MenuBase
  OnRender
- ftxui::MenuBase
  OnRight
- ftxui::MenuBase
  OnUp
- ftxui::MenuBase
  operator=
- ftxui::MenuBase
  operator=
- ftxui::MenuBase
  Parent
- ftxui::MenuBase
  Render
- ftxui::MenuBase
  second_
- ftxui::MenuBase
  SecondTarget
- ftxui::MenuBase
  selected
- ftxui::MenuBase
  selected_focus_
- ftxui::MenuBase
  selected_previous_
- ftxui::MenuBase
  SelectedTakeFocus
- ftxui::MenuBase
  SetActiveChild
- ftxui::MenuBase
  SetActiveChild
- ftxui::MenuBase
  size
- ftxui::MenuBase
  TakeFocus
- ftxui::MenuBase
  Toggle
- ftxui::MenuBase
  underline
- ftxui::MenuBase
  UpdateAnimationTarget
- ftxui::MenuBase
  UpdateColorTarget
- ftxui::MenuBase
  UpdateUnderlineTarget
- ftxui::MenuBase
  Vertical
- ftxui::MenuBase
  VerticalAnimated
- ftxui::MenuBase
  ~ComponentBase