It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ftxui::Event. More...

Inherited by CatchEventBase, ContainerBase, and MenuBase.

Public Member Functions
virtual	~ComponentBase ()

	ComponentBase ()=default

	ComponentBase (const ComponentBase &)=delete

void	operator= (const ComponentBase &)=delete

ComponentBase *	Parent () const
	Return the parent ComponentBase, or nul if any. More...

Component &	ChildAt (size_t i)
	Access the child at index `i`. More...

size_t	ChildCount () const
	Returns the number of children. More...

void	Add (Component children)
	Add a child. @param child The child to be attached. More...

void	Detach ()
	Detach this child from its parent. More...

void	DetachAllChildren ()
	Remove all children. More...

virtual Element	Render ()
	Draw the component. Build a ftxui::Element to be drawn on the ftxi::Screen representing this ftxui::ComponentBase. More...

virtual bool	OnEvent (Event)
	Called in response to an event. More...

virtual void	OnAnimation (animation::Params &params)
	Called in response to an animation event. More...

virtual Component	ActiveChild ()
	Return the currently Active child. More...

virtual bool	Focusable () const
	Return true when the component contains focusable elements. The non focusable Components will be skipped when navigating using the keyboard. More...

bool	Active () const
	Returns if the element if the currently active child of its parent. More...

bool	Focused () const
	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(). More...

virtual void	SetActiveChild (ComponentBase *child)
	Make the \|child\| to be the "active" one. More...

void	SetActiveChild (Component child)
	Make the \|child\| to be the "active" one. More...

void	TakeFocus ()
	Configure all the ancestors to give focus to this component. More...

Protected Member Functions
CapturedMouse	CaptureMouse (const Event &event)
	Take the CapturedMouse if available. There is only one component of them. It represents a component taking priority over others. More...

Protected Attributes
Components	children_

Detailed Description

It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ftxui::Event.

Examples: examples/component/window.cpp.

Definition at line 30 of file component_base.hpp.

Constructor & Destructor Documentation

◆ ~ComponentBase()

~ComponentBase ( )

virtual

Definition at line 28 of file component.cpp.

◆ ComponentBase() [1/2]

ComponentBase ( )

default

◆ ComponentBase() [2/2]

ComponentBase ( const ComponentBase & )

delete

Member Function Documentation

◆ operator=()

void operator= ( const ComponentBase & )

delete

◆ Parent()

ComponentBase * Parent ( ) const

Return the parent ComponentBase, or nul if any.

See also: Detach; Parent

Definition at line 36 of file component.cpp.

◆ ChildAt()

Component & ChildAt ( size_t i )

Access the child at index i.

Definition at line 42 of file component.cpp.

◆ ChildCount()

size_t ChildCount ( ) const

Returns the number of children.

Definition at line 49 of file component.cpp.

◆ Add()

void Add ( Component children )

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

Definition at line 56 of file component.cpp.

◆ Detach()

void Detach ( )

Detach this child from its parent.

See also: Detach; Parent

Definition at line 66 of file component.cpp.

◆ DetachAllChildren()

void DetachAllChildren ( )

Remove all children.

Definition at line 82 of file component.cpp.

◆ Render()

Element Render ( )

virtual

Draw the component. Build a ftxui::Element to be drawn on the ftxi::Screen representing this ftxui::ComponentBase.

Definition at line 92 of file component.cpp.

◆ OnEvent()

bool OnEvent ( Event event )

virtual

Called in response to an event.

Parameters

event The event.

Returns: True when the event has been handled. The default implementation called OnEvent on every child until one return true. If none returns true, return false.

Definition at line 106 of file component.cpp.

◆ OnAnimation()

void OnAnimation ( animation::Params & params )

virtual

Called in response to an animation event.

Parameters

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

Definition at line 119 of file component.cpp.

◆ ActiveChild()

Component ActiveChild ( )

virtual

Return the currently Active child.

Returns: the currently Active child.

Definition at line 128 of file component.cpp.

◆ Focusable()

bool Focusable ( ) const

virtual

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

Definition at line 141 of file component.cpp.

◆ Active()

bool Active ( ) const

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

Definition at line 152 of file component.cpp.

◆ Focused()

bool Focused ( ) const

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

Definition at line 161 of file component.cpp.

◆ SetActiveChild() [1/2]

void SetActiveChild ( ComponentBase * child )

virtual

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

Parameters

child the child to become active.

Definition at line 172 of file component.cpp.

◆ SetActiveChild() [2/2]

void SetActiveChild ( Component child )

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

Parameters

child the child to become active.

Definition at line 177 of file component.cpp.

◆ TakeFocus()

void TakeFocus ( )

Configure all the ancestors to give focus to this component.

Definition at line 183 of file component.cpp.

◆ CaptureMouse()

CapturedMouse CaptureMouse ( const Event & event )

protected

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

Parameters

event The event

Definition at line 195 of file component.cpp.

Field Documentation

◆ children_

Components children_

protected

Definition at line 90 of file component_base.hpp.

The documentation for this class was generated from the following files:

include/ftxui/component/component_base.hpp
src/ftxui/component/component.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~ComponentBase()

◆ ComponentBase() [1/2]

◆ ComponentBase() [2/2]

Member Function Documentation

◆ operator=()

◆ Parent()

◆ ChildAt()

◆ ChildCount()

◆ Add()

◆ Detach()

◆ DetachAllChildren()

◆ Render()

◆ OnEvent()

◆ OnAnimation()

◆ ActiveChild()

◆ Focusable()

◆ Active()

◆ Focused()

◆ SetActiveChild() [1/2]

◆ SetActiveChild() [2/2]

◆ TakeFocus()

◆ CaptureMouse()

Field Documentation

◆ children_