Detailed Description

ftxui/component` モジュールのチュートリアルをご確認ください。

Classes
class	ComponentBase
	ftxui::Elementとして自身のレンダリングを実装します。ftxui::Eventに応答してキーボードナビゲーションを実装します。 More...

struct	UnderlineOption
	下線効果のオプション。 More...

struct	AnimatedColorOption
	アニメーション化された可能性のある色に関するオプション。 More...

struct	MenuEntryOption
	MenuEntryコンポーネントのオプション。 More...

struct	MenuOption
	Menuコンポーネントのオプション。 More...

struct	ButtonOption
	AnimatedButtonコンポーネントのオプション。 More...

struct	CheckboxOption
	Checkboxコンポーネントのオプション。 More...

struct	InputOption
	Inputコンポーネントのオプション。 More...

struct	RadioboxOption
	Radioboxコンポーネントのオプション。 More...

struct	WindowRenderState
	`Window`コンポーネントのレンダー関数に渡される状態。 More...

struct	DropdownOption
	ドロップダウンコンポーネントのオプション。ドロップダウンメニューは、ラジオボックスを開閉するチェックボックスです。 More...

struct	Event
	イベントを表します。キープレスイベント、ターミナルのリサイズなど、さまざまなイベントがあります。 More...

class	Loop
	Loopは、コンポーネントのイベントループを管理するクラスです。 More...

struct	Mouse
	マウスイベント。マウスの座標、押されたボタン、および修飾子（shift, ctrl, meta）が含まれます。 More...

class	ScreenInteractive
	ScreenInteractive はイベントを処理し、メインループを実行し、コンポーネントを管理できる `Screen` です。 More...

Functions
void	RequestAnimationFrame ()
	RequestAnimationFrameは、次のアニメーションサイクルで新しいフレームが描画されるよう要求する関数です。

Component	Button (ButtonOption option)
	Draw a button. Execute a function when clicked. (ja: ボタンを描画します。クリックされたときに機能を実行します。)

Component	Button (ConstStringRef label, std::function< void()> on_click, ButtonOption option)
	Draw a button. Execute a function when clicked. (ja: ボタンを描画します。クリックされたときに機能を実行します。)

Component	CatchEvent (Component child, std::function< bool(Event event)> on_event)
	イベントをキャッチするために\|on_event\|を使用するコンポーネントを返します。この関数は、イベントが処理された場合はtrueを返し、それ以外の場合はfalseを返す必要があります。

ComponentDecorator	CatchEvent (std::function< bool(Event)> on_event)
	イベントをキャッチするために\|on_event\|を使用してコンポーネントを装飾します。この関数は、イベントが処理された場合はtrueを返し、それ以外の場合はfalseを返す必要があります。

Component	Checkbox (CheckboxOption option)
	チェック可能な要素を描画します。

Component	Checkbox (ConstStringRef label, bool *checked, CheckboxOption option)
	チェック可能な要素を描画します。

Component	Vertical (Components children)
	コンポーネントのリスト。垂直方向に1つずつ描画され、上下の矢印キーまたは'j'/'k'キーを使用して垂直方向にナビゲートされます。

Component	Vertical (Components children, int *selector)
	コンポーネントのリスト。垂直方向に1つずつ描画され、上下の矢印キーまたは'j'/'k'キーを使用して垂直方向にナビゲートされます。これは例えばMenuを実装するのに便利です。

Component	Horizontal (Components children)
	コンポーネントのリスト。水平方向に1つずつ描画され、左右の矢印キーまたは'h'/'l'キーを使用して水平方向にナビゲートされます。

Component	Horizontal (Components children, int *selector)
	コンポーネントのリスト。水平方向に1つずつ描画され、左右の矢印キーまたは'h'/'l'キーを使用して水平方向にナビゲートされます。

Component	Tab (Components children, int *selector)
	コンポーネントのリスト。一度に1つだけ描画され、操作されます。\|selector\|は選択されたコンポーネントのインデックスを提供します。これはタブを実装するのに便利です。

Component	Stacked (Components children)
	互いの上にスタックされるコンポーネントのリスト。イベントは、最初のコンポーネントに伝播され、処理されない場合は2番目のコンポーネントに伝播されます。コンポーネントは与えられた順序とは逆の順序で描画されます。コンポーネントがフォーカスを取得すると、他の要素の相対的な順序を変更せずに前面に配置されます。

Component	Dropdown (ConstStringListRef entries, int *selected)
	ドロップダウンメニュー。

Component	Dropdown (DropdownOption option)
	ドロップダウンメニュー。

Component	Hoverable (Component component, bool *hover)
	コンポーネントをラップします。マウスでホバーされているかどうかを知る機能を提供します。

Component	Hoverable (Component component, std::function< void()> on_enter, std::function< void()> on_leave)
	コンポーネントをラップします。コールバックを使用します。

ComponentDecorator	Hoverable (bool *hover)
	コンポーネントをラップします。マウスでホバーされているかどうかを知る機能を提供します。

ComponentDecorator	Hoverable (std::function< void()> on_enter, std::function< void()> on_leave)
	コンポーネントをラップします。マウスでホバーされているかどうかを知る機能を提供します。

Component	Hoverable (Component component, std::function< void(bool)> on_change)
	コンポーネントをラップします。マウスでホバーされているかどうかを知る機能を提供します。

ComponentDecorator	Hoverable (std::function< void(bool)> on_change)
	コンポーネントをラップします。マウスでホバーされているかどうかを知る機能を提供します。

Component	Maybe (Component child, std::function< bool()> show)
	コンポーネント\|child\|を装飾します。\|show\|がtrueを返す場合にのみ表示されます。

ComponentDecorator	Maybe (std::function< bool()> show)
	コンポーネントを装飾します。\|show\|関数がtrueを返す場合にのみ表示されます。

Component	Maybe (Component child, const bool *show)
	コンポーネント\|child\|を装飾します。\|show\|がtrueの場合にのみ表示されます。

ComponentDecorator	Maybe (const bool *show)
	コンポーネントを装飾します。\|show\|がtrueの場合にのみ表示されます。

Component	Menu (MenuOption option)
	テキストのリスト。フォーカスされた要素が選択されます。

Component	Menu (ConstStringListRef entries, int *selected, MenuOption option)
	テキストのリスト。フォーカスされた要素が選択されます。

Component	Toggle (ConstStringListRef entries, int *selected)
	要素の水平リスト。ユーザーはこれらを操作できます。

Component	MenuEntry (ConstStringRef label, MenuEntryOption option)
	特定のメニューエントリ。これらはContainer::Verticalに入れてメニューを形成できます。

Component	MenuEntry (MenuEntryOption option)
	特定のメニューエントリ。これらはContainer::Verticalに入れてメニューを形成できます。

Component	Modal (Component main, Component modal, const bool *show_modal)

ComponentDecorator	Modal (Component modal, const bool *show_modal)

Component	Radiobox (RadioboxOption option)
	1つだけ選択できる要素のリスト。

Component	Radiobox (ConstStringListRef entries, int *selected, RadioboxOption option)
	1つだけ選択できる要素のリスト。

Component	Renderer (std::function< Element()> render)
	インターフェースを描画するために\|render\|を使用するコンポーネントを返します。

Component	Renderer (Component child, std::function< Element()> render)
	\|child\|に似ていますが、\|render\|をComponentRender()イベントとして使用する新しいコンポーネントを返します。

Component	Renderer (std::function< Element(bool)> render)
	インターフェースを描画するために\|render\|を使用するフォーカス可能なコンポーネントを返します。

ComponentDecorator	Renderer (ElementDecorator decorator)
	コンポーネントがレンダリングするものを装飾することによって、コンポーネントを装飾します。

Component	ResizableSplitLeft (Component main, Component back, int *main_size)
	2つのコンポーネント間の水平分割。マウスで設定可能。

Component	ResizableSplitRight (Component main, Component back, int *main_size)
	2つのコンポーネント間の水平分割。マウスで設定可能。

Component	ResizableSplitTop (Component main, Component back, int *main_size)
	2つのコンポーネント間の垂直分割。マウスで設定可能。

Component	ResizableSplitBottom (Component main, Component back, int *main_size)
	2つのコンポーネント間の垂直分割。マウスで設定可能。

Component	Slider (ConstStringRef label, Ref< int > value, ConstRef< int > min, ConstRef< int > max, ConstRef< int > increment)
	水平スライダー。

Component	Window (WindowOptions option)
	ドラッグ可能/サイズ変更可能なウィンドウ。複数のウィンドウを使用するには、それらを Container::Stacked({...})コンポーネントを使用してスタックする必要があります。

Class Documentation

◆ ftxui::ComponentBase

class ftxui::ComponentBase

ftxui::Elementとして自身のレンダリングを実装します。ftxui::Eventに応答してキーボードナビゲーションを実装します。

Examples: examples/component/scrollbar.cpp, and examples/component/window.cpp.

Definition at line 28 of file component_base.hpp.

Public Member Functions
	ComponentBase (Components children)

virtual	~ComponentBase ()

	ComponentBase ()=default

	ComponentBase (const ComponentBase &)=delete

	ComponentBase (ComponentBase &&)=delete

ComponentBase &	operator= (const ComponentBase &)=delete

ComponentBase &	operator= (ComponentBase &&)=delete

ComponentBase *	Parent () const
	親のComponentBaseを返します。存在しない場合はnullを返します。

Component &	ChildAt (size_t i)
	インデックス`i`の子にアクセスします。

size_t	ChildCount () const
	子の数を返します。

int	Index () const
	親におけるコンポーネントのインデックスを返します。親がない場合は-1を返します。

void	Add (Component children)
	子を追加します。 @param child 添付する子。

void	Detach ()
	この子を親からデタッチします。

void	DetachAllChildren ()
	すべての子を削除します。

Element	Render ()
	コンポーネントを描画します。このftxui::ComponentBaseを表すftxui::Screen上に描画されるftxui::Elementを構築します。レンダリングを変更するにはOnRender()をオーバーライドしてください。

virtual Element	OnRender ()
	コンポーネントを描画します。このftxui::ComponentBaseを表すftxui::Screen上に描画されるftxui::Elementを構築します。この関数はオーバーライドされることを意図しています。

virtual bool	OnEvent (Event)
	イベントに応じて呼び出されます。

virtual void	OnAnimation (animation::Params &params)
	アニメーションイベントに応じて呼び出されます。

virtual Component	ActiveChild ()
	現在アクティブな子を返します。

virtual bool	Focusable () const
	コンポーネントがフォーカス可能な要素を含んでいる場合にtrueを返します。フォーカス不可能なコンポーネントは、キーボードでナビゲートする際にスキップされます。

bool	Active () const
	要素が現在親のアクティブな子であるかどうかを返します。

bool	Focused () const
	要素がユーザーによってフォーカスされているかどうかを返します。 ComponentBaseがユーザーによってフォーカスされている場合にtrueを返します。要素は、そのすべての子孫が親のActiveChild()であり、かつFocusable()である場合にフォーカスされます。

virtual void	SetActiveChild (ComponentBase *child)

void	SetActiveChild (Component child)
	\|child\|を「アクティブ」にします。

void	TakeFocus ()
	このコンポーネントにフォーカスを与えるように、すべての祖先を設定します。

Protected Member Functions
CapturedMouse	CaptureMouse (const Event &event)
	利用可能であればCapturedMouseを取得します。コンポーネントは1つしかありません。これは他のコンポーネントよりも優先されるコンポーネントを表します。

Protected Attributes
Components	children_

Constructor & Destructor Documentation

◆ ComponentBase() [1/4]

ComponentBase ( Components children )

inlineexplicit

Definition at line 30 of file component_base.hpp.

◆ ~ComponentBase()

~ComponentBase ( )

virtual

Definition at line 30 of file component.cpp.

◆ ComponentBase() [2/4]

ComponentBase ( )

default

◆ ComponentBase() [3/4]

ComponentBase ( const ComponentBase & )

delete

◆ ComponentBase() [4/4]

ComponentBase ( ComponentBase && )

delete

Member Function Documentation

◆ operator=() [1/2]

ComponentBase & operator= ( const ComponentBase & )

delete

◆ operator=() [2/2]

ComponentBase & operator= ( ComponentBase && )

delete

◆ Parent()

ComponentBase * Parent ( ) const

親のComponentBaseを返します。存在しない場合はnullを返します。

See also: Detach; Parent

Definition at line 37 of file component.cpp.

◆ ChildAt()

Component & ChildAt ( size_t i )

インデックスiの子にアクセスします。

Definition at line 42 of file component.cpp.

◆ ChildCount()

size_t ChildCount ( ) const

子の数を返します。

Definition at line 48 of file component.cpp.

◆ Index()

int Index ( ) const

親におけるコンポーネントのインデックスを返します。親がない場合は-1を返します。

Definition at line 53 of file component.cpp.

◆ Add()

void Add ( Component children )

子を追加します。 @param child 添付する子。

Definition at line 69 of file component.cpp.

◆ Detach()

void Detach ( )

この子を親からデタッチします。

See also: Detach; Parent

Definition at line 78 of file component.cpp.

◆ DetachAllChildren()

void DetachAllChildren ( )

すべての子を削除します。

Definition at line 93 of file component.cpp.

◆ Render()

Element Render ( )

コンポーネントを描画します。このftxui::ComponentBaseを表すftxui::Screen上に描画されるftxui::Elementを構築します。レンダリングを変更するにはOnRender()をオーバーライドしてください。

Definition at line 101 of file component.cpp.

◆ OnRender()

Element OnRender ( )

virtual

コンポーネントを描画します。このftxui::ComponentBaseを表すftxui::Screen上に描画されるftxui::Elementを構築します。この関数はオーバーライドされることを意図しています。

Definition at line 135 of file component.cpp.

◆ OnEvent()

bool OnEvent ( Event event )

virtual

イベントに応じて呼び出されます。

Parameters

event イベント。

Returns: イベントが処理された場合はtrue。デフォルトの実装では、いずれかの子がtrueを返すまで、すべての子でOnEventを呼び出します。どれもtrueを返さない場合は、falseを返します。

Definition at line 147 of file component.cpp.

◆ OnAnimation()

void OnAnimation ( animation::Params & params )

virtual

アニメーションイベントに応じて呼び出されます。

Parameters

params アニメーションのパラメータデフォルトの実装では、イベントをすべての子にディスパッチします。

Definition at line 159 of file component.cpp.

◆ ActiveChild()

Component ActiveChild ( )

virtual

現在アクティブな子を返します。

Returns: 現在アクティブな子。

Definition at line 167 of file component.cpp.

◆ Focusable()

bool Focusable ( ) const

virtual

コンポーネントがフォーカス可能な要素を含んでいる場合にtrueを返します。フォーカス不可能なコンポーネントは、キーボードでナビゲートする際にスキップされます。

Definition at line 178 of file component.cpp.

◆ Active()

bool Active ( ) const

要素が現在親のアクティブな子であるかどうかを返します。

Definition at line 188 of file component.cpp.

◆ Focused()

bool Focused ( ) const

要素がユーザーによってフォーカスされているかどうかを返します。 ComponentBaseがユーザーによってフォーカスされている場合にtrueを返します。要素は、そのすべての子孫が親のActiveChild()であり、かつFocusable()である場合にフォーカスされます。

Definition at line 194 of file component.cpp.

◆ SetActiveChild() [1/2]

virtual void SetActiveChild ( ComponentBase * child )

virtual

◆ SetActiveChild() [2/2]

void SetActiveChild ( Component child )

|child|を「アクティブ」にします。

Parameters

child アクティブにする子。

|child|を「アクティブ」にします。

Parameters

child アクティブにする子。

Definition at line 207 of file component.cpp.

◆ TakeFocus()

void TakeFocus ( )

このコンポーネントにフォーカスを与えるように、すべての祖先を設定します。

Definition at line 212 of file component.cpp.

◆ CaptureMouse()

CapturedMouse CaptureMouse ( const Event & event )

protected

利用可能であればCapturedMouseを取得します。コンポーネントは1つしかありません。これは他のコンポーネントよりも優先されるコンポーネントを表します。

Parameters

event イベント

Definition at line 222 of file component.cpp.

Member Data Documentation

◆ children_

Components children_

protected

Definition at line 92 of file component_base.hpp.

◆ ftxui::UnderlineOption

struct ftxui::UnderlineOption

下線効果のオプション。

Definition at line 33 of file component_options.hpp.

Public Member Functions
void	SetAnimation (animation::Duration d, animation::easing::Function f)
	下線のアニメーション方法を設定します。

void	SetAnimationDuration (animation::Duration d)
	下線のアニメーション方法を設定します。

void	SetAnimationFunction (animation::easing::Function f)
	下線のアニメーション方法を設定します。

void	SetAnimationFunction (animation::easing::Function f_leader, animation::easing::Function f_follower)
	下線のアニメーション方法を設定します。これは、リーダーとフォロワーのアニメーションを非同期にするのに役立ちます。

Public Attributes
bool	enabled = false

Color	color_active = Color::White

Color	color_inactive = Color::GrayDark

animation::easing::Function	leader_function

animation::easing::Function	follower_function

animation::Duration	leader_duration = std::chrono::milliseconds(250)

animation::Duration	leader_delay = std::chrono::milliseconds(0)

animation::Duration	follower_duration = std::chrono::milliseconds(250)

animation::Duration	follower_delay = std::chrono::milliseconds(0)

Member Function Documentation

◆ SetAnimation()

void SetAnimation	(	animation::Duration	d,
		animation::easing::Function	f )

下線のアニメーション方法を設定します。

Parameters

d	アニメーションの期間。
f	アニメーションのイージング関数。

Definition at line 34 of file component_options.cpp.

◆ SetAnimationDuration()

void SetAnimationDuration ( animation::Duration d )

下線のアニメーション方法を設定します。

Parameters

d	アニメーションの期間。

Definition at line 42 of file component_options.cpp.

◆ SetAnimationFunction() [1/2]

void SetAnimationFunction ( animation::easing::Function f )

下線のアニメーション方法を設定します。

Parameters

f	アニメーションのイージング関数。

Definition at line 49 of file component_options.cpp.

◆ SetAnimationFunction() [2/2]

void SetAnimationFunction	(	animation::easing::Function	f_leader,
		animation::easing::Function	f_follower )

下線のアニメーション方法を設定します。これは、リーダーとフォロワーのアニメーションを非同期にするのに役立ちます。

Parameters

f_leader	リーダーのアニメーション期間。
f_follower	フォロワーのアニメーション期間。

Definition at line 58 of file component_options.cpp.

Member Data Documentation

◆ enabled

bool enabled = false

Definition at line 34 of file component_options.hpp.

◆ color_active

Color color_active = Color::White

Definition at line 36 of file component_options.hpp.

◆ color_inactive

Color color_inactive = Color::GrayDark

Definition at line 37 of file component_options.hpp.

◆ leader_function

animation::easing::Function leader_function

Initial value:

=

animation::easing::QuadraticInOut

ftxui::animation::easing::QuadraticInOut

float QuadraticInOut(float p)

Definition animation.cpp:45

Definition at line 39 of file component_options.hpp.

◆ follower_function

animation::easing::Function follower_function

Initial value:

=

animation::easing::QuadraticInOut

Definition at line 41 of file component_options.hpp.

◆ leader_duration

animation::Duration leader_duration = std::chrono::milliseconds(250)

Definition at line 44 of file component_options.hpp.

◆ leader_delay

animation::Duration leader_delay = std::chrono::milliseconds(0)

Definition at line 45 of file component_options.hpp.

◆ follower_duration

animation::Duration follower_duration = std::chrono::milliseconds(250)

Definition at line 46 of file component_options.hpp.

◆ follower_delay

animation::Duration follower_delay = std::chrono::milliseconds(0)

Definition at line 47 of file component_options.hpp.

◆ ftxui::AnimatedColorOption

struct ftxui::AnimatedColorOption

アニメーション化された可能性のある色に関するオプション。

Definition at line 58 of file component_options.hpp.

Public Member Functions
void	Set (Color inactive, Color active, animation::Duration duration=std::chrono::milliseconds(250), animation::easing::Function function=animation::easing::QuadraticInOut)
	アニメーション可能なカラーオプション。 @params _inactive コンポーネントが非アクティブな時の色。 @params _active コンポーネントがアクティブな時の色。 @params _duration アニメーションの期間。 @params _function アニメーションのイージング関数。

Public Attributes
bool	enabled = false

Color	inactive

Color	active

animation::Duration	duration = std::chrono::milliseconds(250)

animation::easing::Function	function = animation::easing::QuadraticInOut

Member Function Documentation

◆ Set()

void Set	(	Color	inactive,
		Color	active,
		animation::Duration	duration = std::chrono::milliseconds(250),
		animation::easing::Function	function = animation::easing::QuadraticInOut )

アニメーション可能なカラーオプション。 @params _inactive コンポーネントが非アクティブな時の色。 @params _active コンポーネントがアクティブな時の色。 @params _duration アニメーションの期間。 @params _function アニメーションのイージング関数。

Definition at line 20 of file component_options.cpp.

Member Data Documentation

◆ enabled

bool enabled = false

Examples: examples/component/menu_entries_animated.cpp.

Definition at line 65 of file component_options.hpp.

◆ inactive

Color inactive

Examples: examples/component/menu_entries_animated.cpp.

Definition at line 66 of file component_options.hpp.

◆ active

Color active

Examples: examples/component/menu_entries_animated.cpp.

Definition at line 67 of file component_options.hpp.

◆ duration

animation::Duration duration = std::chrono::milliseconds(250)

Definition at line 68 of file component_options.hpp.

◆ function

animation::easing::Function function = animation::easing::QuadraticInOut

Definition at line 69 of file component_options.hpp.

◆ ftxui::MenuEntryOption

struct ftxui::MenuEntryOption

MenuEntryコンポーネントのオプション。

Examples: examples/component/menu_entries.cpp, and examples/component/menu_entries_animated.cpp.

Definition at line 79 of file component_options.hpp.

Public Attributes
ConstStringRef	label = "MenuEntry"

std::function< Element(const EntryState &state)>	transform

AnimatedColorsOption	animated_colors

Member Data Documentation

◆ label

ConstStringRef label = "MenuEntry"

Definition at line 80 of file component_options.hpp.

◆ transform

std::function<Element(const EntryState& state)> transform

Examples: examples/component/menu_entries.cpp.

Definition at line 81 of file component_options.hpp.

◆ animated_colors

AnimatedColorsOption animated_colors

Examples: examples/component/menu_entries_animated.cpp.

Definition at line 82 of file component_options.hpp.

◆ ftxui::MenuOption

struct ftxui::MenuOption

Menuコンポーネントのオプション。

Examples: examples/component/menu.cpp, and examples/component/menu2.cpp.

Definition at line 87 of file component_options.hpp.

Static Public Member Functions
static MenuOption	Horizontal ()
	水平メニューの標準オプション。これはタブバーの実装に役立ちます。

static MenuOption	HorizontalAnimated ()
	アニメーション付き水平メニューの標準オプション。これはタブバーの実装に役立ちます。

static MenuOption	Vertical ()
	垂直メニューの標準オプション。これは選択可能なアイテムのリストを実装するのに役立ちます。

static MenuOption	VerticalAnimated ()
	アニメーション付き垂直メニューの標準オプション。これは選択可能なアイテムのリストを実装するのに役立ちます。

static MenuOption	Toggle ()
	セパレータ付き水平メニューの標準オプション。これはタブバーの実装に役立ちます。

Public Attributes
ConstStringListRef	entries

Ref< int >	selected = 0

UnderlineOption	underline

MenuEntryOption	entries_option

Direction	direction = Direction::Down

std::function< Element()>	elements_prefix

std::function< Element()>	elements_infix

std::function< Element()>	elements_postfix

std::function< void()>	on_change

std::function< void()>	on_enter

Ref< int >	focused_entry = 0

Member Function Documentation

◆ Horizontal()

MenuOption Horizontal ( )

static

水平メニューの標準オプション。これはタブバーの実装に役立ちます。

Definition at line 68 of file component_options.cpp.

◆ HorizontalAnimated()

MenuOption HorizontalAnimated ( )

static

アニメーション付き水平メニューの標準オプション。これはタブバーの実装に役立ちます。

Definition at line 92 of file component_options.cpp.

◆ Vertical()

MenuOption Vertical ( )

static

垂直メニューの標準オプション。これは選択可能なアイテムのリストを実装するのに役立ちます。

Definition at line 101 of file component_options.cpp.

◆ VerticalAnimated()

MenuOption VerticalAnimated ( )

static

アニメーション付き垂直メニューの標準オプション。これは選択可能なアイテムのリストを実装するのに役立ちます。

Definition at line 122 of file component_options.cpp.

◆ Toggle()

MenuOption Toggle ( )

static

セパレータ付き水平メニューの標準オプション。これはタブバーの実装に役立ちます。

Definition at line 144 of file component_options.cpp.

Member Data Documentation

◆ entries

ConstStringListRef entries

Definition at line 95 of file component_options.hpp.

◆ selected

Ref<int> selected = 0

‍エントリのリスト。

Definition at line 96 of file component_options.hpp.

◆ underline

UnderlineOption underline

‍選択されたエントリのインデックス。

Definition at line 99 of file component_options.hpp.

◆ entries_option

MenuEntryOption entries_option

Definition at line 100 of file component_options.hpp.

◆ direction

Direction direction = Direction::Down

Definition at line 101 of file component_options.hpp.

◆ elements_prefix

std::function<Element()> elements_prefix

Definition at line 102 of file component_options.hpp.

◆ elements_infix

std::function<Element()> elements_infix

Definition at line 103 of file component_options.hpp.

◆ elements_postfix

std::function<Element()> elements_postfix

Definition at line 104 of file component_options.hpp.

◆ on_change

std::function<void()> on_change

Definition at line 107 of file component_options.hpp.

◆ on_enter

std::function<void()> on_enter

‍選択されたエントリが変更されたときに呼び出されます。

Examples: examples/component/menu.cpp.

Definition at line 108 of file component_options.hpp.

◆ focused_entry

Ref<int> focused_entry = 0

‍ユーザーがEnterを押したときに呼び出されます。

Definition at line 109 of file component_options.hpp.

◆ ftxui::ButtonOption

struct ftxui::ButtonOption

AnimatedButtonコンポーネントのオプション。

Examples: examples/component/button.cpp.

Definition at line 114 of file component_options.hpp.

Static Public Member Functions
static ButtonOption	Ascii ()
	[]文字を使用して強調表示されるButtonOptionを作成します。

static ButtonOption	Simple ()
	フォーカス時に反転するButtonOptionを作成します。

static ButtonOption	Border ()
	ButtonOptionを作成します。ボタンはボーダーを使用して表示され、フォーカス時に反転します。これが現在のデフォルトです。

static ButtonOption	Animated ()
	アニメーションカラーを使用するButtonOptionを作成します。

static ButtonOption	Animated (Color color)
	アニメーションカラーを使用するButtonOptionを作成します。

static ButtonOption	Animated (Color background, Color foreground)
	アニメーションカラーを使用するButtonOptionを作成します。

static ButtonOption	Animated (Color background, Color foreground, Color background_active, Color foreground_active)
	アニメーションカラーを使用するButtonOptionを作成します。

Public Attributes
ConstStringRef	label = "Button"

std::function< void()>	on_click = [] {}

std::function< Element(const EntryState &)>	transform

AnimatedColorsOption	animated_colors

Member Function Documentation

◆ Ascii()

ButtonOption Ascii ( )

static

[]文字を使用して強調表示されるButtonOptionを作成します。

Definition at line 152 of file component_options.cpp.

◆ Simple()

ButtonOption Simple ( )

static

フォーカス時に反転するButtonOptionを作成します。

Definition at line 164 of file component_options.cpp.

◆ Border()

ButtonOption Border ( )

static

ButtonOptionを作成します。ボタンはボーダーを使用して表示され、フォーカス時に反転します。これが現在のデフォルトです。

Definition at line 178 of file component_options.cpp.

◆ Animated() [1/4]

ButtonOption Animated ( )

static

アニメーションカラーを使用するButtonOptionを作成します。

Definition at line 195 of file component_options.cpp.

◆ Animated() [2/4]

ButtonOption Animated ( Color color )

static

アニメーションカラーを使用するButtonOptionを作成します。

Definition at line 202 of file component_options.cpp.

◆ Animated() [3/4]

ButtonOption Animated	(	Color	background,
		Color	foreground )

static

アニメーションカラーを使用するButtonOptionを作成します。

Definition at line 212 of file component_options.cpp.

◆ Animated() [4/4]

ButtonOption Animated	(	Color	background,
		Color	foreground,
		Color	background_active,
		Color	foreground_active )

static

アニメーションカラーを使用するButtonOptionを作成します。

Definition at line 224 of file component_options.cpp.

Member Data Documentation

◆ label

ConstStringRef label = "Button"

Definition at line 127 of file component_options.hpp.

◆ on_click

std::function<void()> on_click = [] {}

Definition at line 128 of file component_options.hpp.

◆ transform

std::function<Element(const EntryState&)> transform

Definition at line 131 of file component_options.hpp.

◆ animated_colors

AnimatedColorsOption animated_colors

Definition at line 132 of file component_options.hpp.

◆ ftxui::CheckboxOption

struct ftxui::CheckboxOption

Checkboxコンポーネントのオプション。

Definition at line 137 of file component_options.hpp.

Static Public Member Functions
static CheckboxOption	Simple ()
	標準チェックボックスのオプション。

Public Attributes
ConstStringRef	label = "Checkbox"

Ref< bool >	checked = false

std::function< Element(const EntryState &)>	transform

std::function< void()>	on_change = [] {}
	ユーザーが状態を変更したときに呼び出されます。

Member Function Documentation

◆ Simple()

CheckboxOption Simple ( )

static

標準チェックボックスのオプション。

Definition at line 243 of file component_options.cpp.

Member Data Documentation

◆ label

ConstStringRef label = "Checkbox"

Definition at line 141 of file component_options.hpp.

◆ checked

Ref<bool> checked = false

Definition at line 143 of file component_options.hpp.

◆ transform

std::function<Element(const EntryState&)> transform

Definition at line 146 of file component_options.hpp.

◆ on_change

std::function<void()> on_change = [] {}

ユーザーが状態を変更したときに呼び出されます。

Definition at line 150 of file component_options.hpp.

◆ ftxui::InputOption

struct ftxui::InputOption

Inputコンポーネントのオプション。

Examples: examples/component/homescreen.cpp, examples/component/input.cpp, and examples/component/input_style.cpp.

Definition at line 163 of file component_options.hpp.

Static Public Member Functions
static InputOption	Default ()
	デフォルトの入力スタイルを作成します:

static InputOption	Spacious ()
	余白の広い、白地に黒のスタイル:

Public Attributes
StringRef	content = ""
	入力の内容。

StringRef	placeholder = ""
	入力が空の場合の入力内容。

std::function< Element(InputState)>	transform

Ref< bool >	password = false
	入力内容を'*'で隠します。

Ref< bool >	multiline = true
	入力を複数行にできるかどうか。

Ref< bool >	insert = true
	文字の挿入または上書きモード。

std::function< void()>	on_change = [] {}
	内容が変更されたときに呼び出されます。

std::function< void()>	on_enter = [] {}
	ユーザーがEnterを押したときに呼び出されます。

Ref< int >	cursor_position = 0

Member Function Documentation

◆ Default()

InputOption Default ( )

static

デフォルトの入力スタイルを作成します:

入力コンポーネントの標準オプション。

Definition at line 291 of file component_options.cpp.

◆ Spacious()

InputOption Spacious ( )

static

余白の広い、白地に黒のスタイル:

より美しい入力コンポーネントの標準オプション。

Definition at line 313 of file component_options.cpp.

Member Data Documentation

◆ content

StringRef content = ""

入力の内容。

Definition at line 172 of file component_options.hpp.

◆ placeholder

StringRef placeholder = ""

入力が空の場合の入力内容。

Definition at line 175 of file component_options.hpp.

◆ transform

std::function<Element(InputState)> transform

Examples: examples/component/input_style.cpp.

Definition at line 178 of file component_options.hpp.

◆ password

Ref<bool> password = false

入力内容を'*'で隠します。

Examples: examples/component/input.cpp.

Definition at line 179 of file component_options.hpp.

◆ multiline

Ref<bool> multiline = true

入力を複数行にできるかどうか。

Definition at line 180 of file component_options.hpp.

◆ insert

Ref<bool> insert = true

文字の挿入または上書きモード。

Definition at line 181 of file component_options.hpp.

◆ on_change

std::function<void()> on_change = [] {}

内容が変更されたときに呼び出されます。

Definition at line 184 of file component_options.hpp.

◆ on_enter

std::function<void()> on_enter = [] {}

ユーザーがEnterを押したときに呼び出されます。

Definition at line 186 of file component_options.hpp.

◆ cursor_position

Ref<int> cursor_position = 0

Definition at line 189 of file component_options.hpp.

◆ ftxui::RadioboxOption

struct ftxui::RadioboxOption

Radioboxコンポーネントのオプション。

Definition at line 194 of file component_options.hpp.

Static Public Member Functions
static RadioboxOption	Simple ()
	標準ラジオボックスのオプション。

Public Attributes
ConstStringListRef	entries

Ref< int >	selected = 0

std::function< Element(const EntryState &)>	transform

std::function< void()>	on_change = [] {}
	選択されたエントリが変更されたときに呼び出されます。

Ref< int >	focused_entry = 0

Member Function Documentation

◆ Simple()

RadioboxOption Simple ( )

static

標準ラジオボックスのオプション。

Definition at line 267 of file component_options.cpp.

Member Data Documentation

◆ entries

ConstStringListRef entries

Definition at line 199 of file component_options.hpp.

◆ selected

Ref<int> selected = 0

Definition at line 200 of file component_options.hpp.

◆ transform

std::function<Element(const EntryState&)> transform

Definition at line 203 of file component_options.hpp.

◆ on_change

std::function<void()> on_change = [] {}

選択されたエントリが変更されたときに呼び出されます。

Definition at line 207 of file component_options.hpp.

◆ focused_entry

Ref<int> focused_entry = 0

Definition at line 208 of file component_options.hpp.

◆ ftxui::WindowRenderState

struct ftxui::WindowRenderState

Windowコンポーネントのレンダー関数に渡される状態。

Definition at line 241 of file component_options.hpp.

Public Attributes
Element	inner
	このウィンドウ内にラップされた要素。

const std::string &	title
	ウィンドウのタイトル。

bool	active = false
	ウィンドウがアクティブであるかどうか。

bool	drag = false
	ウィンドウがドラッグされているかどうか。

bool	resize = false
	ウィンドウがサイズ変更されているかどうか。

bool	hover_left = false
	サイズ変更可能な左側がホバーされているかどうか。

bool	hover_right = false
	サイズ変更可能な右側がホバーされているかどうか。

bool	hover_top = false
	サイズ変更可能な上側がホバーされているかどうか。

bool	hover_down = false
	サイズ変更可能な下側がホバーされているかどうか。

Member Data Documentation

◆ inner

Element inner

このウィンドウ内にラップされた要素。

Definition at line 242 of file component_options.hpp.

◆ title

const std::string& title

ウィンドウのタイトル。

Definition at line 243 of file component_options.hpp.

◆ active

bool active = false

ウィンドウがアクティブであるかどうか。

Definition at line 244 of file component_options.hpp.

◆ drag

bool drag = false

ウィンドウがドラッグされているかどうか。

Definition at line 245 of file component_options.hpp.

◆ resize

bool resize = false

ウィンドウがサイズ変更されているかどうか。

Definition at line 246 of file component_options.hpp.

◆ hover_left

bool hover_left = false

サイズ変更可能な左側がホバーされているかどうか。

Definition at line 247 of file component_options.hpp.

◆ hover_right

bool hover_right = false

サイズ変更可能な右側がホバーされているかどうか。

Definition at line 248 of file component_options.hpp.

◆ hover_top

bool hover_top = false

サイズ変更可能な上側がホバーされているかどうか。

Definition at line 249 of file component_options.hpp.

◆ hover_down

bool hover_down = false

サイズ変更可能な下側がホバーされているかどうか。

Definition at line 250 of file component_options.hpp.

◆ ftxui::DropdownOption

struct ftxui::DropdownOption

ドロップダウンコンポーネントのオプション。

ドロップダウンメニューは、ラジオボックスを開閉するチェックボックスです。

Definition at line 276 of file component_options.hpp.

Public Attributes
Ref< bool >	open = false
	ドロップダウンが開いているか閉じているか:

CheckboxOption	checkbox

RadioboxOption	radiobox

std::function< Element(bool open, Element checkbox, Element radiobox)>	transform

Member Data Documentation

◆ open

Ref<bool> open = false

ドロップダウンが開いているか閉じているか:

Definition at line 278 of file component_options.hpp.

◆ checkbox

CheckboxOption checkbox

Definition at line 280 of file component_options.hpp.

◆ radiobox

RadioboxOption radiobox

Definition at line 282 of file component_options.hpp.

◆ transform

std::function<Element(bool open, Element checkbox, Element radiobox)> transform

Definition at line 285 of file component_options.hpp.

◆ ftxui::Event

struct ftxui::Event

イベントを表します。キープレスイベント、ターミナルのリサイズなど、さまざまなイベントがあります。

例:

表示可能な文字はEvent::Character('a')を使用して作成できます。
Event::ArrowLeftのような特殊なイベントは事前に定義されています。
特別なイベントの任意のコードは、以下を使用して見つけることができます。 ./example/util/print_key_press 例えば、CTLR+AはEventSpecial({1})にマップされます。

xtermの仕様に関する役立つドキュメント: https://invisible-island.net/xterm/ctlseqs/ctlseqs.html

Examples: examples/component/canvas_animated.cpp, examples/component/custom_loop.cpp, examples/component/input.cpp, and examples/component/print_key_press.cpp.

Definition at line 28 of file event.hpp.

Public Member Functions
bool	operator== (const Event &other) const

bool	operator!= (const Event &other) const

bool	operator< (const Event &other) const

const std::string &	input () const

bool	is_character () const

std::string	character () const

bool	is_mouse () const

struct Mouse &	mouse ()

bool	is_cursor_position () const

int	cursor_x () const

int	cursor_y () const

bool	is_cursor_shape () const

int	cursor_shape () const

std::string	DebugString () const
	イベントの文字列表現を返します。

Static Public Member Functions
static Event	Character (std::string)
	入力された文字に対応するイベント。

static Event	Character (char)
	入力された文字に対応するイベント。

static Event	Character (wchar_t)
	入力された文字に対応するイベント。

static Event	Special (std::string)
	ライブラリのユーザーによって意味が定義されるカスタムイベント。

static Event	Mouse (std::string, Mouse mouse)
	入力された文字に対応するイベント。

static Event	CursorPosition (std::string, int x, int y)

static Event	CursorShape (std::string, int shape)
	端末のDCS（デバイス制御文字列）に対応するイベント。

Public Attributes
ScreenInteractive *	screen_ = nullptr

Static Public Attributes
static const Event	ArrowLeft = Event::Special("\x1B[D")

static const Event	ArrowRight = Event::Special("\x1B[C")

static const Event	ArrowUp = Event::Special("\x1B[A")

static const Event	ArrowDown = Event::Special("\x1B[B")

static const Event	ArrowLeftCtrl = Event::Special("\x1B[1;5D")

static const Event	ArrowRightCtrl = Event::Special("\x1B[1;5C")

static const Event	ArrowUpCtrl = Event::Special("\x1B[1;5A")

static const Event	ArrowDownCtrl = Event::Special("\x1B[1;5B")

static const Event	Backspace = Event::Special({127})

static const Event	Delete = Event::Special("\x1B[3~")

static const Event	Return = Event::Special({10})

static const Event	Escape = Event::Special("\x1B")

static const Event	Tab = Event::Special({9})

static const Event	TabReverse = Event::Special({27, 91, 90})

static const Event	Insert = Event::Special("\x1B[2~")

static const Event	Home = Event::Special({27, 91, 72})

static const Event	End = Event::Special({27, 91, 70})

static const Event	PageUp = Event::Special({27, 91, 53, 126})

static const Event	PageDown = Event::Special({27, 91, 54, 126})

static const Event	F1 = Event::Special("\x1BOP")

static const Event	F2 = Event::Special("\x1BOQ")

static const Event	F3 = Event::Special("\x1BOR")

static const Event	F4 = Event::Special("\x1BOS")

static const Event	F5 = Event::Special("\x1B[15~")

static const Event	F6 = Event::Special("\x1B[17~")

static const Event	F7 = Event::Special("\x1B[18~")

static const Event	F8 = Event::Special("\x1B[19~")

static const Event	F9 = Event::Special("\x1B[20~")

static const Event	F10 = Event::Special("\x1B[21~")

static const Event	F11 = Event::Special("\x1B[23~")

static const Event	F12 = Event::Special("\x1B[24~")

static const Event	a = Event::Character("a")

static const Event	A = Event::Character("A")

static const Event	CtrlA = Event::Special("\x01")

static const Event	AltA = Event::Special("\x1b""a")

static const Event	CtrlAltA = Event::Special("\x1b\x01")

static const Event	b = Event::Character("b")

static const Event	B = Event::Character("B")

static const Event	CtrlB = Event::Special("\x02")

static const Event	AltB = Event::Special("\x1b""b")

static const Event	CtrlAltB = Event::Special("\x1b\x02")

static const Event	c = Event::Character("c")

static const Event	C = Event::Character("C")

static const Event	CtrlC = Event::Special("\x03")

static const Event	AltC = Event::Special("\x1b""c")

static const Event	CtrlAltC = Event::Special("\x1b\x03")

static const Event	d = Event::Character("d")

static const Event	D = Event::Character("D")

static const Event	CtrlD = Event::Special("\x04")

static const Event	AltD = Event::Special("\x1b""d")

static const Event	CtrlAltD = Event::Special("\x1b\x04")

static const Event	e = Event::Character("e")

static const Event	E = Event::Character("E")

static const Event	CtrlE = Event::Special("\x05")

static const Event	AltE = Event::Special("\x1b""e")

static const Event	CtrlAltE = Event::Special("\x1b\x05")

static const Event	f = Event::Character("f")

static const Event	F = Event::Character("F")

static const Event	CtrlF = Event::Special("\x06")

static const Event	AltF = Event::Special("\x1b""f")

static const Event	CtrlAltF = Event::Special("\x1b\x06")

static const Event	g = Event::Character("g")

static const Event	G = Event::Character("G")

static const Event	CtrlG = Event::Special("\x07")

static const Event	AltG = Event::Special("\x1b""g")

static const Event	CtrlAltG = Event::Special("\x1b\x07")

static const Event	h = Event::Character("h")

static const Event	H = Event::Character("H")

static const Event	CtrlH = Event::Special("\x08")

static const Event	AltH = Event::Special("\x1b""h")

static const Event	CtrlAltH = Event::Special("\x1b\x08")

static const Event	i = Event::Character("i")

static const Event	I = Event::Character("I")

static const Event	CtrlI = Event::Special("\x09")

static const Event	AltI = Event::Special("\x1b""i")

static const Event	CtrlAltI = Event::Special("\x1b\x09")

static const Event	j = Event::Character("j")

static const Event	J = Event::Character("J")

static const Event	CtrlJ = Event::Special("\x0a")

static const Event	AltJ = Event::Special("\x1b""j")

static const Event	CtrlAltJ = Event::Special("\x1b\x0a")

static const Event	k = Event::Character("k")

static const Event	K = Event::Character("K")

static const Event	CtrlK = Event::Special("\x0b")

static const Event	AltK = Event::Special("\x1b""k")

static const Event	CtrlAltK = Event::Special("\x1b\x0b")

static const Event	l = Event::Character("l")

static const Event	L = Event::Character("L")

static const Event	CtrlL = Event::Special("\x0c")

static const Event	AltL = Event::Special("\x1b""l")

static const Event	CtrlAltL = Event::Special("\x1b\x0c")

static const Event	m = Event::Character("m")

static const Event	M = Event::Character("M")

static const Event	CtrlM = Event::Special("\x0d")

static const Event	AltM = Event::Special("\x1b""m")

static const Event	CtrlAltM = Event::Special("\x1b\x0d")

static const Event	n = Event::Character("n")

static const Event	N = Event::Character("N")

static const Event	CtrlN = Event::Special("\x0e")

static const Event	AltN = Event::Special("\x1b""n")

static const Event	CtrlAltN = Event::Special("\x1b\x0e")

static const Event	o = Event::Character("o")

static const Event	O = Event::Character("O")

static const Event	CtrlO = Event::Special("\x0f")

static const Event	AltO = Event::Special("\x1b""o")

static const Event	CtrlAltO = Event::Special("\x1b\x0f")

static const Event	p = Event::Character("p")

static const Event	P = Event::Character("P")

static const Event	CtrlP = Event::Special("\x10")

static const Event	AltP = Event::Special("\x1b""p")

static const Event	CtrlAltP = Event::Special("\x1b\x10")

static const Event	q = Event::Character("q")

static const Event	Q = Event::Character("Q")

static const Event	CtrlQ = Event::Special("\x11")

static const Event	AltQ = Event::Special("\x1b""q")

static const Event	CtrlAltQ = Event::Special("\x1b\x11")

static const Event	r = Event::Character("r")

static const Event	R = Event::Character("R")

static const Event	CtrlR = Event::Special("\x12")

static const Event	AltR = Event::Special("\x1b""r")

static const Event	CtrlAltR = Event::Special("\x1b\x12")

static const Event	s = Event::Character("s")

static const Event	S = Event::Character("S")

static const Event	CtrlS = Event::Special("\x13")

static const Event	AltS = Event::Special("\x1b""s")

static const Event	CtrlAltS = Event::Special("\x1b\x13")

static const Event	t = Event::Character("t")

static const Event	T = Event::Character("T")

static const Event	CtrlT = Event::Special("\x14")

static const Event	AltT = Event::Special("\x1b""t")

static const Event	CtrlAltT = Event::Special("\x1b\x14")

static const Event	u = Event::Character("u")

static const Event	U = Event::Character("U")

static const Event	CtrlU = Event::Special("\x15")

static const Event	AltU = Event::Special("\x1b""u")

static const Event	CtrlAltU = Event::Special("\x1b\x15")

static const Event	v = Event::Character("v")

static const Event	V = Event::Character("V")

static const Event	CtrlV = Event::Special("\x16")

static const Event	AltV = Event::Special("\x1b""v")

static const Event	CtrlAltV = Event::Special("\x1b\x16")

static const Event	w = Event::Character("w")

static const Event	W = Event::Character("W")

static const Event	CtrlW = Event::Special("\x17")

static const Event	AltW = Event::Special("\x1b""w")

static const Event	CtrlAltW = Event::Special("\x1b\x17")

static const Event	x = Event::Character("x")

static const Event	X = Event::Character("X")

static const Event	CtrlX = Event::Special("\x18")

static const Event	AltX = Event::Special("\x1b""x")

static const Event	CtrlAltX = Event::Special("\x1b\x18")

static const Event	y = Event::Character("y")

static const Event	Y = Event::Character("Y")

static const Event	CtrlY = Event::Special("\x19")

static const Event	AltY = Event::Special("\x1b""y")

static const Event	CtrlAltY = Event::Special("\x1b\x19")

static const Event	z = Event::Character("z")

static const Event	Z = Event::Character("Z")

static const Event	CtrlZ = Event::Special("\x1a")

static const Event	AltZ = Event::Special("\x1b""z")

static const Event	CtrlAltZ = Event::Special("\x1b\x1a")

static const Event	Custom = Event::Special({0})

Member Function Documentation

◆ Character() [1/3]

Event Character ( std::string input )

static

入力された文字に対応するイベント。

Parameters

input ユーザーが入力した文字。

Definition at line 27 of file event.cpp.

◆ Character() [2/3]

Event Character ( char c )

static

入力された文字に対応するイベント。

Parameters

c	ユーザーが入力した文字。

Definition at line 37 of file event.cpp.

◆ Character() [3/3]

Event Character ( wchar_t c )

static

入力された文字に対応するイベント。

Parameters

c	ユーザーが入力した文字。

Definition at line 44 of file event.cpp.

◆ Special()

Event Special ( std::string input )

static

ライブラリのユーザーによって意味が定義されるカスタムイベント。

Parameters

input 開発者によって定義された任意の文字シーケンス。

Definition at line 73 of file event.cpp.

◆ Mouse()

Event Mouse	(	std::string	input,
		Mouse	mouse )

static

入力された文字に対応するイベント。

Parameters

input	端末から送信される文字のシーケンス。
mouse	マウスの状態。

Definition at line 52 of file event.cpp.

◆ CursorPosition()

Event CursorPosition	(	std::string	input,
		int	x,
		int	y )

static

Definition at line 81 of file event.cpp.

◆ CursorShape()

Event CursorShape	(	std::string	input,
		int	shape )

static

端末のDCS（デバイス制御文字列）に対応するイベント。

Definition at line 62 of file event.cpp.

◆ operator==()

bool operator== ( const Event & other ) const

inline

Definition at line 99 of file event.hpp.

◆ operator!=()

bool operator!= ( const Event & other ) const

inline

Definition at line 100 of file event.hpp.

◆ operator<()

bool operator< ( const Event & other ) const

inline

Definition at line 101 of file event.hpp.

◆ input()

const std::string & input ( ) const

inline

Examples: examples/component/print_key_press.cpp.

Definition at line 103 of file event.hpp.

◆ is_character()

bool is_character ( ) const

inline

Definition at line 105 of file event.hpp.

◆ character()

std::string character ( ) const

inline

Examples: examples/component/input.cpp.

Definition at line 106 of file event.hpp.

◆ is_mouse()

bool is_mouse ( ) const

inline

Examples: examples/component/canvas_animated.cpp.

Definition at line 108 of file event.hpp.

◆ mouse()

struct Mouse & mouse ( )

inline

Definition at line 109 of file event.hpp.

◆ is_cursor_position()

bool is_cursor_position ( ) const

inline

Definition at line 112 of file event.hpp.

◆ cursor_x()

int cursor_x ( ) const

inline

Definition at line 113 of file event.hpp.

◆ cursor_y()

int cursor_y ( ) const

inline

Definition at line 114 of file event.hpp.

◆ is_cursor_shape()

bool is_cursor_shape ( ) const

inline

Definition at line 116 of file event.hpp.

◆ cursor_shape()

int cursor_shape ( ) const

inline

Definition at line 117 of file event.hpp.

◆ DebugString()

std::string DebugString ( ) const

イベントの文字列表現を返します。

Definition at line 90 of file event.cpp.

Member Data Documentation

◆ ArrowLeft

const Event ArrowLeft = Event::Special("\x1B[D")

static

Definition at line 39 of file event.hpp.

◆ ArrowRight

const Event ArrowRight = Event::Special("\x1B[C")

static

Definition at line 40 of file event.hpp.

◆ ArrowUp

const Event ArrowUp = Event::Special("\x1B[A")

static

Definition at line 41 of file event.hpp.

◆ ArrowDown

const Event ArrowDown = Event::Special("\x1B[B")

static

Definition at line 42 of file event.hpp.

◆ ArrowLeftCtrl

const Event ArrowLeftCtrl = Event::Special("\x1B[1;5D")

static

Definition at line 44 of file event.hpp.

◆ ArrowRightCtrl

const Event ArrowRightCtrl = Event::Special("\x1B[1;5C")

static

Definition at line 45 of file event.hpp.

◆ ArrowUpCtrl

const Event ArrowUpCtrl = Event::Special("\x1B[1;5A")

static

Definition at line 46 of file event.hpp.

◆ ArrowDownCtrl

const Event ArrowDownCtrl = Event::Special("\x1B[1;5B")

static

Definition at line 47 of file event.hpp.

◆ Backspace

const Event Backspace = Event::Special({127})

static

Definition at line 50 of file event.hpp.

◆ Delete

const Event Delete = Event::Special("\x1B[3~")

static

Definition at line 51 of file event.hpp.

◆ Return

const Event Return = Event::Special({10})

static

Definition at line 52 of file event.hpp.

◆ Escape

const Event Escape = Event::Special("\x1B")

static

Definition at line 53 of file event.hpp.

◆ Tab

const Event Tab = Event::Special({9})

static

Definition at line 54 of file event.hpp.

◆ TabReverse

const Event TabReverse = Event::Special({27, 91, 90})

static

Definition at line 55 of file event.hpp.

◆ Insert

const Event Insert = Event::Special("\x1B[2~")

static

Definition at line 58 of file event.hpp.

◆ Home

const Event Home = Event::Special({27, 91, 72})

static

Definition at line 59 of file event.hpp.

◆ End

const Event End = Event::Special({27, 91, 70})

static

Definition at line 60 of file event.hpp.

◆ PageUp

const Event PageUp = Event::Special({27, 91, 53, 126})

static

Definition at line 61 of file event.hpp.

◆ PageDown

const Event PageDown = Event::Special({27, 91, 54, 126})

static

Definition at line 62 of file event.hpp.