ftxui::StackedContainer
ContainerBase
StackedContainer
(Components children)
StackedContainer
ftxui::StackedContainer::StackedContainer
Components children
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.

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.

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 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 TakeFocus () TakeFocus ftxui::ComponentBase::TakeFocus

Configure all the ancestors to give focus to this component.

Element Element OnRender () final OnRender ftxui::StackedContainer::OnRender
bool bool Focusable () const final Focusable ftxui::StackedContainer::Focusable
Component Component ActiveChild () final ActiveChild ftxui::StackedContainer::ActiveChild
void void SetActiveChild (ComponentBase *child) final SetActiveChild ftxui::StackedContainer::SetActiveChild ComponentBase * child
bool bool OnEvent (Event event) final OnEvent ftxui::StackedContainer::OnEvent Event event
int int selected_ selected_ ftxui::ContainerBase::selected_ = 0
int * int* selector_ selector_ ftxui::ContainerBase::selector_ = nullptr
Components Components children_ children_ ftxui::ComponentBase::children_
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

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