ftxui::CatchEventBase
ComponentBase
std::function< bool(Event)> std::function<bool(Event)> on_event_ on_event_ ftxui::CatchEventBase::on_event_
Components Components children_ children_ ftxui::ComponentBase::children_
CatchEventBase
(std::function< bool(Event)> on_event)
CatchEventBase
ftxui::CatchEventBase::CatchEventBase
std::function< bool(Event)> on_event
bool bool OnEvent (Event event) override OnEvent ftxui::CatchEventBase::OnEvent Event event
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.

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

Return the currently Active child.

the currently Active 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 (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

CatchEventBase
ComponentBase
CatchEventBase
ComponentBase
- ftxui::CatchEventBase
  Active
- ftxui::CatchEventBase
  ActiveChild
- ftxui::CatchEventBase
  Add
- ftxui::CatchEventBase
  CaptureMouse
- ftxui::CatchEventBase
  CatchEventBase
- ftxui::CatchEventBase
  ChildAt
- ftxui::CatchEventBase
  ChildCount
- ftxui::CatchEventBase
  children_
- ftxui::CatchEventBase
  ComponentBase
- ftxui::CatchEventBase
  ComponentBase
- ftxui::CatchEventBase
  ComponentBase
- ftxui::CatchEventBase
  ComponentBase
- ftxui::CatchEventBase
  Detach
- ftxui::CatchEventBase
  DetachAllChildren
- ftxui::CatchEventBase
  Focusable
- ftxui::CatchEventBase
  Focused
- ftxui::CatchEventBase
  Index
- ftxui::CatchEventBase
  on_event_
- ftxui::CatchEventBase
  OnAnimation
- ftxui::CatchEventBase
  OnEvent
- ftxui::CatchEventBase
  OnRender
- ftxui::CatchEventBase
  operator=
- ftxui::CatchEventBase
  operator=
- ftxui::CatchEventBase
  Parent
- ftxui::CatchEventBase
  Render
- ftxui::CatchEventBase
  SetActiveChild
- ftxui::CatchEventBase
  SetActiveChild
- ftxui::CatchEventBase
  TakeFocus
- ftxui::CatchEventBase
  ~ComponentBase