ftxui::VerticalContainer
ContainerBase
Box Box box_ box_ ftxui::VerticalContainer::box_
Element Element OnRender () override OnRender ftxui::VerticalContainer::OnRender
bool bool EventHandler (Event event) override EventHandler ftxui::VerticalContainer::EventHandler Event event
bool bool OnMouseEvent (Event event) override OnMouseEvent ftxui::VerticalContainer::OnMouseEvent Event event
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
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 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 TakeFocus () TakeFocus ftxui::ComponentBase::TakeFocus

Configure all the ancestors to give focus to this component.

int int selected_ selected_ ftxui::ContainerBase::selected_ = 0
int * int* selector_ selector_ ftxui::ContainerBase::selector_ = nullptr
Components Components children_ children_ ftxui::ComponentBase::children_
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

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