ftxui::ContainerBase
ComponentBase
HorizontalContainer
StackedContainer
TabContainer
VerticalContainer
int int selected_ selected_ ftxui::ContainerBase::selected_ = 0
int * int* selector_ selector_ ftxui::ContainerBase::selector_ = nullptr
Components Components children_ children_ ftxui::ComponentBase::children_
ContainerBase
(Components children, int *selector)
ContainerBase
ftxui::ContainerBase::ContainerBase
Components children
int * selector
bool bool OnEvent (Event event) override OnEvent ftxui::ContainerBase::OnEvent Event event
Component Component ActiveChild () override ActiveChild ftxui::ContainerBase::ActiveChild
void void SetActiveChild (ComponentBase *child) override SetActiveChild ftxui::ContainerBase::SetActiveChild ComponentBase * child
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.

Element Element OnRender () OnRender ftxui::ComponentBase::OnRender

Draw the component. Build a ftxui::Element to be drawn on the ftxi::Screen representing this ftxui::ComponentBase. This function is means to be overridden.

void void OnAnimation (animation::Params &params) OnAnimation ftxui::ComponentBase::OnAnimation animation::Params & params

Called in response to an animation event.

params

the parameters of the animation The default implementation dispatch the event to every child.

bool bool Focusable () const Focusable ftxui::ComponentBase::Focusable

Return true when the component contains focusable elements. The non focusable Components will be skipped when navigating using the keyboard.

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

bool virtual bool EventHandler (Event) EventHandler ftxui::ContainerBase::EventHandler Event
bool virtual bool OnMouseEvent (Event event) OnMouseEvent ftxui::ContainerBase::OnMouseEvent Event event
void void MoveSelector (int dir) MoveSelector ftxui::ContainerBase::MoveSelector int dir
void void MoveSelectorWrap (int dir) MoveSelectorWrap ftxui::ContainerBase::MoveSelectorWrap int dir
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

ContainerBase
ComponentBase
ContainerBase
ComponentBase
- ftxui::ContainerBase
  Active
- ftxui::ContainerBase
  ActiveChild
- ftxui::ContainerBase
  Add
- ftxui::ContainerBase
  CaptureMouse
- ftxui::ContainerBase
  ChildAt
- ftxui::ContainerBase
  ChildCount
- ftxui::ContainerBase
  children_
- ftxui::ContainerBase
  ComponentBase
- ftxui::ContainerBase
  ComponentBase
- ftxui::ContainerBase
  ComponentBase
- ftxui::ContainerBase
  ComponentBase
- ftxui::ContainerBase
  ContainerBase
- ftxui::ContainerBase
  Detach
- ftxui::ContainerBase
  DetachAllChildren
- ftxui::ContainerBase
  EventHandler
- ftxui::ContainerBase
  Focusable
- ftxui::ContainerBase
  Focused
- ftxui::ContainerBase
  Index
- ftxui::ContainerBase
  MoveSelector
- ftxui::ContainerBase
  MoveSelectorWrap
- ftxui::ContainerBase
  OnAnimation
- ftxui::ContainerBase
  OnEvent
- ftxui::ContainerBase
  OnMouseEvent
- ftxui::ContainerBase
  OnRender
- ftxui::ContainerBase
  operator=
- ftxui::ContainerBase
  operator=
- ftxui::ContainerBase
  Parent
- ftxui::ContainerBase
  Render
- ftxui::ContainerBase
  selected_
- ftxui::ContainerBase
  selector_
- ftxui::ContainerBase
  SetActiveChild
- ftxui::ContainerBase
  SetActiveChild
- ftxui::ContainerBase
  TakeFocus
- ftxui::ContainerBase
  ~ComponentBase