Public Member Functions
	Loop (ScreenInteractive *screen, Component component)
	A Loop is a wrapper around a Component and a ScreenInteractive. It is used to run a Component in a terminal. More...

	~Loop ()

bool	HasQuitted ()
	Whether the loop has quitted. More...

void	RunOnce ()
	Execute the loop. Make the `component` to process every pending tasks/events. A new frame might be drawn if the previous was invalidated. Return true until the loop hasn't completed. More...

void	RunOnceBlocking ()
	Wait for at least one event to be handled and execute `Loop::RunOnce()`. More...

void	Run ()

Detailed Description

Examples: examples/component/custom_loop.cpp.

Definition at line 17 of file loop.hpp.

Constructor & Destructor Documentation

◆ Loop()

Loop	(	ScreenInteractive *	screen,
		Component	component
	)

A Loop is a wrapper around a Component and a ScreenInteractive. It is used to run a Component in a terminal.

See also: Component, ScreenInteractive.; ScreenInteractive::Loop().; ScreenInteractive::ExitLoop().

Parameters

screen	The screen to use.
component	The component to run.

Definition at line 21 of file loop.cpp.

◆ ~Loop()

~Loop ( )

Definition at line 26 of file loop.cpp.

Member Function Documentation

◆ HasQuitted()

bool HasQuitted ( )

Whether the loop has quitted.

Definition at line 32 of file loop.cpp.

◆ RunOnce()

void RunOnce ( )

Execute the loop. Make the component to process every pending tasks/events. A new frame might be drawn if the previous was invalidated. Return true until the loop hasn't completed.

Definition at line 39 of file loop.cpp.

◆ RunOnceBlocking()

void RunOnceBlocking ( )

Wait for at least one event to be handled and execute Loop::RunOnce().

Definition at line 45 of file loop.cpp.

◆ Run()

void Run ( )

Execute the loop, blocking the current thread, up until the loop has quitted.

Definition at line 51 of file loop.cpp.

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

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

Public Member Functions