FTXUI ftxui:: 名前空間 More...

Namespaces
namespace	animation
	FTXUIのftxui::animation::名前空間。

namespace	box_helper

namespace	Container

namespace	Dimension
	スクリーンがどのように見えるべきかを定義します。

namespace	flexbox_helper

namespace	literals

namespace	task

namespace	Terminal

namespace	util

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

struct	AnimatedColorsOption

class	AnimationTask

class	AutoReset
	変数に値を割り当て、スコープを抜けるときに古い値をリセットします。 More...

struct	Box
	Boxは、2D空間における矩形領域を表す構造体です。 More...

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

struct	Canvas
	Canvasは、描画操作に関連付けられた描画可能なバッファです。 More...

class	CapturedMouseInterface

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

class	Color
	Colorは、ターミナルユーザーインターフェースにおける色を表すクラスです。 More...

struct	ColorInfo
	ColorInfoは、ターミナルのカラーパレットに関する情報を含む構造体です。 More...

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

class	ConstRef
	アダプター。不変オブジェクトを所有または参照します。 More...

class	ConstStringListRef
	アダプター。文字列のリストを参照します。 More...

class	ConstStringRef
	アダプター。定数文字列を所有または参照します。便宜上、このクラスは複数の不変文字列を共有表現に変換します。 More...

struct	Dimensions
	Dimensionsは、ターミナルのサイズを表す構造体です。 More...

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

struct	EntryState
	\|ButtonOption\|、\|CheckboxOption\|、\|RadioboxOption\|、\|MenuEntryOption\|、\|MenuOption\|からの変換の引数。 More...

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

struct	FlexboxConfig
	FlexboxConfigは、flexboxコンテナのレイアウトプロパティを定義する構成構造体です。 More...

class	Image
	ピクセルの長方形グリッド。 More...

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

struct	InputState
	Inputコンポーネントのスタイルを定義するために使用されます。 More...

struct	LinearGradient
	線形グラデーションカラー効果の設定を表すクラスです。 More...

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

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

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

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

class	Node
	NodeはDOMツリー内のすべての要素の基底クラスです。 More...

class	NodeDecorator

struct	Pixel
	Unicode文字とそれに関連付けられたスタイル。 More...

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

class	ReceiverImpl

class	Ref
	アダプター。可変オブジェクトを所有または参照します。 More...

struct	Requirement
	Requirementは、ターミナルユーザーインターフェースにおけるNodeのレイアウト要件を定義する構造体です。 More...

struct	ResizableSplitOption

class	Screen
	ピクセルの長方形グリッド。 More...

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

class	Selection
	ターミナルユーザーインターフェースにおける選択範囲を表します。 More...

class	SenderImpl

struct	SliderOption

class	StringRef
	アダプター。定数文字列を所有または参照します。便宜上、このクラスは複数の可変文字列を共有表現に変換します。 More...

class	Table
	Tableは、テーブルを描画するためのユーティリティです。 More...

class	TableSelection

class	TerminalInputParser

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

struct	WindowOptions

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

Typedefs
using	CapturedMouse = std::unique_ptr<CapturedMouseInterface>

using	Component = std::shared_ptr<ComponentBase>

using	Components = std::vector<Component>

template<class T >
using	Sender = std::unique_ptr<SenderImpl<T>>

template<class T >
using	Receiver = std::unique_ptr<ReceiverImpl<T>>

using	Closure = std::function<void()>

using	Task = std::variant<Event, Closure, AnimationTask>

using	Element = std::shared_ptr<Node>

using	Elements = std::vector<Element>

using	Decorator = std::function<Element(Element)>

using	GraphFunction = std::function<std::vector<int>(int, int)>

Enumerations
enum class	Direction { Up = 0 , Down = 1 , Left = 2 , Right = 3 }
	Directionは、東西南北の4つの基本方向を表す列挙型です。 More...

enum	BorderStyle { LIGHT , DASHED , HEAVY , DOUBLE , ROUNDED , EMPTY }
	BorderStyleは、ターミナルUIの要素に適用できる様々なボーダースタイルを表す列挙型です。 More...

enum	WidthOrHeight { WIDTH , HEIGHT }

enum	Constraint { LESS_THAN , EQUAL , GREATER_THAN }

enum class	WordBreakProperty : int8_t { ALetter , CR , Double_Quote , Extend , ExtendNumLet , Format , Hebrew_Letter , Katakana , LF , MidLetter , MidNum , MidNumLet , Newline , Numeric , Regional_Indicator , Single_Quote , WSegSpace , ZWJ }

Functions
template<class T , class... Args>
std::shared_ptr< T >	Make (Args &&... args)

Component	operator\| (Component component, ElementDecorator decorator)

Component &	operator\|= (Component &component, ComponentDecorator decorator)

Component &	operator\|= (Component &component, ElementDecorator decorator)

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	Checkbox (CheckboxOption option)
	チェック可能な要素を描画します。

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

Component	Input (InputOption options={})

Component	Input (StringRef content, InputOption options={})

Component	Input (StringRef content, StringRef placeholder, InputOption options={})

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

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

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

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

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

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

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

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

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

template<typename T >
Component	Slider (SliderOption< T > options)
	どの方向にも対応するスライダー。

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

Component	Slider (ConstStringRef label, Ref< float > value, ConstRef< float > min=0.f, ConstRef< float > max=100.f, ConstRef< float > increment=5.f)

Component	Slider (ConstStringRef label, Ref< long > value, ConstRef< long > min=0L, ConstRef< long > max=100L, ConstRef< long > increment=5L)

Component	ResizableSplit (ResizableSplitOption options)
	2つのコンポーネント間の分割。

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

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

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

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

Component	CatchEvent (Component child, std::function< bool(Event)>)

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

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

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

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

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

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

ComponentDecorator	Modal (Component modal, const bool *show_modal)

Component	Collapsible (ConstStringRef label, Component child, Ref< bool > show)
	折りたたみ可能なコンポーネント。矢印付きのチェックボックスを表示します。アクティブ化されると、子が表示されます。

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

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

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

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

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

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

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

template<class T >
Receiver< T >	MakeReceiver ()

Element	text (std::wstring text)
	ユニコードテキストを表示します。

Element	vtext (std::wstring text)
	ユニコードテキストを垂直に表示します。

Elements	paragraph (std::wstring text)

Element	operator\| (Element element, Decorator decorator)
	要素にデコレーターを適用します。

Element &	operator\|= (Element &e, Decorator d)
	要素にデコレーターを適用します。

Elements	operator\| (Elements elements, Decorator decorator)
	要素のセットから、すべての要素にデコレーターを適用します。

Decorator	operator\| (Decorator a, Decorator b)
	2つのデコレーターを1つに合成します。

Element	text (std::string text)
	UTF8エンコードされたユニコードテキストを表示します。

Element	vtext (std::string text)
	ユニコードテキストを垂直に表示します。

Element	separator ()

Element	separatorLight ()

Element	separatorDashed ()
	他の2つの要素の間にLIGHTスタイルで垂直または水平の区切り線を描画します。

Element	separatorHeavy ()

Element	separatorDouble ()
	他の2つの要素の間にHEAVYスタイルで垂直または水平の区切り線を描画します。

Element	separatorEmpty ()
	他の2つの要素の間にEMPTYスタイルで垂直または水平の区切り線を描画します。

Element	separatorStyled (BorderStyle style)
	他の2つの要素の間に垂直または水平の区切り線を描画します。

Element	separator (Pixel)

Element	separatorCharacter (std::string)

Element	separatorHSelector (float left, float right, Color unselected_color, Color selected_color)

Element	separatorVSelector (float up, float down, Color unselected_color, Color selected_color)

Element	gauge (float progress)
	高精細プログレスバーを描画します。

Element	gaugeLeft (float progress)
	右から左へ進行する高精細プログレスバーを描画します。

Element	gaugeRight (float progress)
	左から右へ進行する高精細プログレスバーを描画します。

Element	gaugeUp (float progress)
	下から上へ進行する高精細プログレスバーを描画します。

Element	gaugeDown (float progress)
	上から下へ進行する高精細プログレスバーを描画します。

Element	gaugeDirection (float progress, Direction direction)
	指定された方向に進行する高精細プログレスバーを描画します。

Element	border (Element)

Element	borderLight (Element)

Element	borderDashed (Element)

Element	borderHeavy (Element)

Element	borderDouble (Element)

Element	borderRounded (Element)

Element	borderEmpty (Element)

Decorator	borderStyled (BorderStyle)

Decorator	borderStyled (BorderStyle, Color)

Decorator	borderStyled (Color)

Decorator	borderWith (const Pixel &)

Element	window (Element title, Element content, BorderStyle border=ROUNDED)

Element	spinner (int charset_index, size_t image_index)
	時間やイベントの効果を表現するのに便利です。これはアスキーアートの「ビデオ」を表示します。

Element	paragraph (const std::string &the_text)
	段落を複数行で描画する要素を返します。

Element	paragraphAlignLeft (const std::string &the_text)
	段落を複数行にわたって左揃えで描画する要素を返します。

Element	paragraphAlignRight (const std::string &the_text)
	段落を複数行にわたって右揃えで描画する要素を返します。

Element	paragraphAlignCenter (const std::string &the_text)
	段落を複数行にわたって中央揃えで描画する要素を返します。

Element	paragraphAlignJustify (const std::string &the_text)
	段落を複数行にわたって両端揃えで描画する要素を返します。中央に。

Element	graph (GraphFunction graph_function)
	GraphFunctionを使用してグラフを描画します。

Element	emptyElement ()

Element	canvas (ConstRef< Canvas > canvas)
	CanvasまたはCanvasへの参照から要素を生成します。

Element	canvas (int width, int height, std::function< void(Canvas &)> fn)
	要求されたサイズのキャンバスを描画する要素を生成します。

Element	canvas (std::function< void(Canvas &)> fn)
	キャンバスを描画する要素を生成します。

Element	bold (Element child)
	より強調したい要素に、太字フォントを使用します。

Element	dim (Element child)
	強調を抑えたい要素に、明るいフォントを使用します。

Element	italic (Element child)
	テキストに斜体を適用します。

Element	inverted (Element child)
	前景色と背景色を反転させるフィルターを追加します。

Element	underlined (Element child)
	指定された要素に下線を追加します。

Element	underlinedDouble (Element child)
	テキストに二重下線を適用します。

Element	blink (Element child)
	描画されたテキストは、可視と非可視の間で交互に切り替わります。

Element	strikethrough (Element child)
	テキストに打ち消し線を適用します。

Decorator	color (Color c)
	前景色を使用して装飾します。

Decorator	bgcolor (Color color)
	背景色を使用して装飾します。

Decorator	color (const LinearGradient &gradient)
	フォアグラウンドカラーに線形グラデーション効果を使用して装飾します。

Decorator	bgcolor (const LinearGradient &gradient)
	背景色に線形グラデーション効果を使用して装飾します。

Element	color (Color color, Element child)
	要素の前景色を設定します。

Element	bgcolor (Color color, Element child)
	要素の背景色を設定します。

Element	color (const LinearGradient &gradient, Element child)
	線形グラデーション効果を持つ要素のフォアグラウンドカラーを設定します。

Element	bgcolor (const LinearGradient &gradient, Element child)
	線形グラデーション効果を持つ要素の背景色を設定します。

Decorator	focusPosition (int x, int y)
	`frame`内で使用され、ビューを特定の位置にスクロールさせます。位置はセル数で表されます。

Decorator	focusPositionRelative (float x, float y)
	`frame`内で使用され、ビューを特定の位置にスクロールさせます。位置は要求されたサイズの割合で表されます。

Element	automerge (Element child)
	文字が近くの他の文字と自動的にマージされるようにします。

Decorator	hyperlink (std::string link)
	ハイパーリンクを使用して装飾します。ユーザーがクリックするとリンクが開きます。これは、限られたターミナルエミュレータでのみサポートされています。リスト: https://github.com/Alhadis/OSC8-Adoption/

Element	hyperlink (std::string link, Element child)
	ウェブブラウザを使用してレンダリングされた領域をクリック可能にします。ユーザーがクリックするとリンクが開きます。これは、限られたターミナルエミュレータでのみサポートされています。リスト: https://github.com/Alhadis/OSC8-Adoption/

Element	selectionStyleReset (Element child)
	要素の選択スタイルをリセットします。

Decorator	selectionColor (Color foreground)
	要素が選択されたときの色を設定します。

Decorator	selectionBackgroundColor (Color foreground)
	要素が選択されたときの背景色を設定します。スタイルは既存のスタイルに重ねて適用されることに注意してください。

Decorator	selectionForegroundColor (Color foreground)
	要素が選択されたときの描画色を設定します。スタイルは既存のスタイルに重ねて適用されることに注意してください。

Decorator	selectionStyle (std::function< void(Pixel &)> style)
	要素が選択されたときのスタイルを設定します。

Element	hbox (Elements children)
	要素を水平方向に1つずつ表示するコンテナ。

Element	vbox (Elements children)
	要素を縦に一つずつ表示するコンテナ。

Element	dbox (Elements children_)
	複数の要素を重ねて表示します。

Element	flexbox (Elements children, FlexboxConfig config)
	行/列に要素を表示し、一杯になると次の列/行に折り返すことができるコンテナ。

Element	gridbox (std::vector< Elements > lines)
	要素のグリッドを表示するコンテナ。

Element	hflow (Elements children)
	要素を左から右へ行で表示するコンテナ。一杯になると、下の新しい行から開始します。

Element	vflow (Elements children)
	要素を上から下へ行で表示するコンテナ。一杯になると、右側の新しい列から開始します。

Element	flex (Element child)
	子要素をコンテナに残されたスペースに比例して拡大させます。

Element	flex_grow (Element child)
	可能であれば拡大します。

Element	flex_shrink (Element child)
	必要であれば最小化します。

Element	xflex (Element child)
	必要に応じてX軸上で拡大・縮小します。

Element	xflex_grow (Element child)
	可能であればX軸上で拡大します。

Element	xflex_shrink (Element child)
	必要であればX軸上で最小化します。

Element	yflex (Element child)
	必要に応じてY軸上で拡大・縮小します。

Element	yflex_grow (Element child)
	可能であればY軸上で拡大します。

Element	yflex_shrink (Element child)
	必要であればY軸上で最小化します。

Element	notflex (Element child)
	要素を柔軟にしないようにします。

Element	filler ()
	コンテナに残されたスペースに比例して拡大する要素。

Decorator	size (WidthOrHeight direction, Constraint constraint, int value)
	要素のサイズに制約を適用します。

Element	frame (Element child)
	要素を「仮想」領域内に表示できるようにします。そのサイズはコンテナよりも大きくすることができます。この場合、より小さい部分のみが表示されます。フォーカスされた要素を表示するためにビューはスクロール可能です。

Element	xframe (Element child)
	`frame` と同じですが、x軸のみに適用されます。

Element	yframe (Element child)
	`frame` と同じですが、y軸のみに適用されます。

Element	focus (Element child)
	子要素を兄弟要素の中でフォーカスされたものとして設定します。

Element	select (Element child)
	子要素を兄弟要素の中でフォーカスされたものとして設定します。

Element	focusCursorBlock (Element child)
	`focus` と同じですが、カーソル形状を静止ブロックに設定します。

Element	focusCursorBlockBlinking (Element child)
	`focus` と同じですが、カーソル形状を点滅ブロックに設定します。

Element	focusCursorBar (Element child)
	`focus` と同じですが、カーソル形状を静止ブロックに設定します。

Element	focusCursorBarBlinking (Element child)
	`focus` と同じですが、カーソル形状を点滅バーに設定します。

Element	focusCursorUnderline (Element child)
	`focus` と同じですが、カーソル形状を静止下線に設定します。

Element	focusCursorUnderlineBlinking (Element child)
	`focus` と同じですが、カーソル形状を点滅下線に設定します。

Element	vscroll_indicator (Element child)
	右側に垂直スクロールバーを表示します。色はコンテンツに従います。

Element	hscroll_indicator (Element child)
	下部に水平スクロールバーを表示します。色はコンテンツに従います。

Decorator	reflect (Box &box)

Element	clear_under (Element element)
	\|child\|を描画する前に、下にあるピクセルをクリアします。これは、 dboxと組み合わせて使用すると便利です。

Element	hcenter (Element child)
	要素を水平方向に中央揃えします。

Element	vcenter (Element child)
	要素を垂直方向に中央揃えします。

Element	center (Element child)
	要素を水平方向および垂直方向に中央揃えします。

Element	align_right (Element child)
	要素を右側に揃えます。

Element	nothing (Element element)
	何も行わないデコレーションです。

void	Render (Screen &screen, const Element &element)
	要素をftxui::Screenに表示します。

void	Render (Screen &screen, Node *node)
	要素をftxui::Screenに表示します。

void	Render (Screen &screen, Node *node, Selection &selection)

std::string	GetNodeSelectedContent (Screen &screen, Node *node, Selection &selection)

Color	operator""_rgb (unsigned long long int combined)
	結合された16進数RGB表現から色を作成します。例: 0x808000_rgb

ColorInfo	GetColorInfo (Color::Palette256 index)

ColorInfo	GetColorInfo (Color::Palette16 index)

int	wchar_width (wchar_t)

int	wstring_width (const std::wstring &)

std::string	to_string (const std::wstring &s)

std::wstring	to_wstring (const std::string &s)

template<typename T >
std::wstring	to_wstring (T s)

int	string_width (const std::string &)

std::vector< std::string >	Utf8ToGlyphs (const std::string &input)

std::vector< int >	CellToGlyphIndex (const std::string &input)

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

template Component	Slider (SliderOption< int8_t >)

template Component	Slider (SliderOption< int16_t >)

template Component	Slider (SliderOption< int32_t >)

template Component	Slider (SliderOption< int64_t >)

template Component	Slider (SliderOption< uint8_t >)

template Component	Slider (SliderOption< uint16_t >)

template Component	Slider (SliderOption< uint32_t >)

template Component	Slider (SliderOption< uint64_t >)

template Component	Slider (SliderOption< float >)

template Component	Slider (SliderOption< double >)

Component	operator\| (Component component, ComponentDecorator decorator)

return	PixelAt (x, y).character
	指定された位置のセル内の文字にアクセスします。

bool	EatCodePoint (const std::string &input, size_t start, size_t end, uint32_t ucs)

bool	EatCodePoint (const std::wstring &input, size_t start, size_t end, uint32_t ucs)

bool	IsCombining (uint32_t ucs)

bool	IsFullWidth (uint32_t ucs)

bool	IsControl (uint32_t ucs)

WordBreakProperty	CodepointToWordBreakProperty (uint32_t codepoint)

size_t	GlyphPrevious (const std::string &input, size_t start)

size_t	GlyphNext (const std::string &input, size_t start)

return	static_cast< int > (input.size())

size_t	GlyphIterate (const std::string &input, int glyph_offset, size_t start=0)

int	GlyphCount (const std::string &input)

std::vector< WordBreakProperty >	Utf8ToWordBreakProperty (const std::string &input)

bool	IsWordBreakingCharacter (const std::string &input, size_t glyph_index)

Variables
const std::map< std::string, std::string >	g_uniformize

const std::array< ColorInfo, 256 >	palette256

Detailed Description

FTXUI ftxui:: 名前空間

FTXUI ftxui::名前空間

FTXUIのftxui::名前空間

Typedef Documentation

◆ CapturedMouse

using CapturedMouse = std::unique_ptr<CapturedMouseInterface>

Definition at line 20 of file captured_mouse.hpp.

◆ Component

typedef std::shared_ptr< ComponentBase > Component = std::shared_ptr<ComponentBase>

Definition at line 23 of file component_base.hpp.

◆ Components

using Components = std::vector<Component>

Definition at line 24 of file component_base.hpp.

◆ Sender

template<class T >

using Sender = std::unique_ptr<SenderImpl<T>>

Definition at line 52 of file receiver.hpp.

◆ Receiver

template<class T >

using Receiver = std::unique_ptr<ReceiverImpl<T>>

Definition at line 54 of file receiver.hpp.

◆ Closure

using Closure = std::function<void()>

Definition at line 12 of file task.hpp.

◆ Task

using Task = std::variant<Event, Closure, AnimationTask>

Definition at line 13 of file task.hpp.

◆ Element

typedef std::shared_ptr< Node > Element = std::shared_ptr<Node>

Definition at line 21 of file elements.hpp.

◆ Elements

typedef std::vector< Element > Elements = std::vector<Element>

Definition at line 22 of file elements.hpp.

◆ Decorator

using Decorator = std::function<Element(Element)>

Definition at line 23 of file elements.hpp.

◆ GraphFunction

using GraphFunction = std::function<std::vector<int>(int, int)>

Definition at line 24 of file elements.hpp.

Enumeration Type Documentation

◆ WidthOrHeight

enum WidthOrHeight

Enumerator
WIDTH
HEIGHT

Definition at line 156 of file elements.hpp.

◆ Constraint

enum Constraint

Enumerator
LESS_THAN
EQUAL
GREATER_THAN

Definition at line 157 of file elements.hpp.

◆ WordBreakProperty

enum class WordBreakProperty : int8_t

strong

Enumerator
ALetter
CR
Double_Quote
Extend
ExtendNumLet
Format
Hebrew_Letter
Katakana
LF
MidLetter
MidNum
MidNumLet
Newline
Numeric
Regional_Indicator
Single_Quote
WSegSpace
ZWJ

Definition at line 39 of file string_internal.hpp.

Function Documentation

◆ Make()

template<class T , class... Args>

std::shared_ptr< T > Make ( Args &&... args )

Definition at line 26 of file component.hpp.

◆ operator|() [1/2]

Component operator\|	(	Component	component,
		ElementDecorator	decorator )

Definition at line 17 of file component/util.cpp.

◆ operator|=() [1/2]

Component & operator\|=	(	Component &	component,
		ComponentDecorator	decorator )

Definition at line 22 of file component/util.cpp.

◆ operator|=() [2/2]

Component & operator\|=	(	Component &	component,
		ElementDecorator	decorator )

Definition at line 28 of file component/util.cpp.

◆ Input() [1/3]

Component Input ( InputOption options = {} )

◆ Input() [2/3]

Component Input	(	StringRef	content,
		InputOption	options = {} )

◆ Input() [3/3]

Component Input	(	StringRef	content,
		StringRef	placeholder,
		InputOption	options = {} )

◆ Slider() [1/13]

template<typename T >

Component Slider ( SliderOption< T > options )

どの方向にも対応するスライダー。

Parameters

options オプション。

例

auto screen = ScreenInteractive::TerminalOutput();
int value = 50;
auto slider = Slider({
  .value = &value,
  .min = 0,
  .max = 100,
  .increment= 20,
});
screen.Loop(slider);

Definition at line 315 of file src/ftxui/component/slider.cpp.

◆ Slider() [2/13]

Component Slider	(	ConstStringRef	label,
		Ref< float >	value,
		ConstRef< float >	min = 0.f,
		ConstRef< float >	max = 100.f,
		ConstRef< float >	increment = 5.f )

Definition at line 272 of file src/ftxui/component/slider.cpp.

◆ Slider() [3/13]

Component Slider	(	ConstStringRef	label,
		Ref< long >	value,
		ConstRef< long >	min = 0L,
		ConstRef< long >	max = 100L,
		ConstRef< long >	increment = 5L )

Definition at line 285 of file src/ftxui/component/slider.cpp.

◆ ResizableSplit()

Component ResizableSplit ( ResizableSplitOption options )

2つのコンポーネント間の分割。

Parameters

options すべてのパラメータ。

例

auto left = Renderer([] { return text("Left") | center;});
auto right = Renderer([] { return text("right") | center;});
int left_size = 10;
auto component = ResizableSplit({
  .main = left,
  .back = right,
  .direction = Direction::Left,
  .main_size = &left_size,
  .separator_func = [] { return separatorDouble(); },
});

出力

       ║
left   ║   right
       ║

Definition at line 170 of file src/ftxui/component/resizable_split.cpp.

◆ CatchEvent()

Component CatchEvent	(	Component	child,
		std::function< bool(Event)>	)

◆ Collapsible()

Component Collapsible	(	ConstStringRef	label,
		Component	child,
		Ref< bool >	show )

折りたたみ可能なコンポーネント。矢印付きのチェックボックスを表示します。アクティブ化されると、子が表示されます。

Parameters

label	チェックボックスのラベル。
child	表示する子。
show	子が表示されているかどうかを示す状態を保持します。

例

auto component = Collapsible("Show details", details);

ftxui::Collapsible

Component Collapsible(ConstStringRef label, Component child, Ref< bool > show=false)

折りたたみ可能なコンポーネント。矢印付きのチェックボックスを表示します。アクティブ化されると、子が表示されます。

Definition src/ftxui/component/collapsible.cpp:32

出力

▼ Show details

Definition at line 32 of file src/ftxui/component/collapsible.cpp.

◆ MakeReceiver()

template<class T >

Receiver< T > MakeReceiver ( )

Definition at line 149 of file receiver.hpp.

◆ paragraph()

Elements paragraph ( std::wstring text )

◆ separator() [1/2]

Element separator ( )

◆ separatorLight()

Element separatorLight ( )

◆ separatorHeavy()

Element separatorHeavy ( )

◆ separator() [2/2]

Element separator ( Pixel )

◆ separatorCharacter()

Element separatorCharacter ( std::string )

◆ separatorHSelector()

Element separatorHSelector	(	float	left,
		float	right,
		Color	unselected_color,
		Color	selected_color )

◆ separatorVSelector()

Element separatorVSelector	(	float	up,
		float	down,
		Color	unselected_color,
		Color	selected_color )

◆ border()

Element border ( Element )

◆ borderLight()

Element borderLight ( Element )

◆ borderDashed()

Element borderDashed ( Element )

◆ borderHeavy()

Element borderHeavy ( Element )

◆ borderDouble()

Element borderDouble ( Element )

◆ borderRounded()

Element borderRounded ( Element )

◆ borderEmpty()

Element borderEmpty ( Element )

◆ borderStyled() [1/3]

Decorator borderStyled ( BorderStyle )

◆ borderStyled() [2/3]

Decorator borderStyled	(	BorderStyle	,
		Color	)

◆ borderStyled() [3/3]

Decorator borderStyled ( Color )

◆ borderWith()

Decorator borderWith ( const Pixel & )

◆ window()

Element window	(	Element	title,
		Element	content,
		BorderStyle	border = ROUNDED )

◆ graph()

Element graph ( GraphFunction graph_function )

GraphFunctionを使用してグラフを描画します。

Parameters

graph_function データを取得するために呼び出される関数。

Definition at line 70 of file src/ftxui/dom/graph.cpp.

◆ canvas() [1/3]

Element canvas ( ConstRef< Canvas > canvas )

CanvasまたはCanvasへの参照から要素を生成します。

Definition at line 889 of file src/ftxui/dom/canvas.cpp.

◆ canvas() [2/3]

Element canvas	(	int	width,
		int	height,
		std::function< void(Canvas &)>	fn )

要求されたサイズのキャンバスを描画する要素を生成します。

Parameters

width	キャンバスの幅。
height	キャンバスの高さ。
fn	キャンバスを描画する関数。

Definition at line 906 of file src/ftxui/dom/canvas.cpp.

◆ canvas() [3/3]

Element canvas ( std::function< void(Canvas &)> fn )

キャンバスを描画する要素を生成します。

Parameters

fn	キャンバスを描画する関数。

Definition at line 936 of file src/ftxui/dom/canvas.cpp.

◆ selectionStyleReset()

Element selectionStyleReset ( Element child )

要素の選択スタイルをリセットします。

Parameters

child 入力要素。

Returns: 選択スタイルがリセットされた出力要素。

Definition at line 54 of file selection_style.cpp.

◆ selectionColor()

Decorator selectionColor ( Color foreground )

要素が選択されたときの色を設定します。

Parameters

foreground 適用する色。スタイルは既存のスタイルに重ねて適用されることに注意してください。

Definition at line 77 of file selection_style.cpp.

◆ selectionBackgroundColor()

Decorator selectionBackgroundColor ( Color foreground )

要素が選択されたときの背景色を設定します。スタイルは既存のスタイルに重ねて適用されることに注意してください。

Definition at line 60 of file selection_style.cpp.

◆ selectionForegroundColor()

Decorator selectionForegroundColor ( Color foreground )

要素が選択されたときの描画色を設定します。スタイルは既存のスタイルに重ねて適用されることに注意してください。

Definition at line 68 of file selection_style.cpp.

◆ selectionStyle()

Decorator selectionStyle ( std::function< void(Pixel &)> style )

要素が選択されたときのスタイルを設定します。

Parameters

style 適用するスタイル。スタイルは既存のスタイルに重ねて適用されることに注意してください。

Definition at line 85 of file selection_style.cpp.

◆ hbox()

Element hbox ( Elements children )

要素を水平方向に1つずつ表示するコンテナ。

Parameters

children コンテナ内の要素

Returns: コンテナ。

例

hbox({
  text("Left"),
  text("Right"),
});

Definition at line 93 of file hbox.cpp.

◆ flexbox()

Element flexbox	(	Elements	children,
		FlexboxConfig	config )

行/列に要素を表示し、一杯になると次の列/行に折り返すことができるコンテナ。

Parameters

children	コンテナ内の要素
config	オプション

Returns: コンテナ。

例

flexbox({
  text("element 1"),
  text("element 2"),
  text("element 3"),
}, FlexboxConfig()
     .Set(FlexboxConfig::Direction::Column)
     .Set(FlexboxConfig::Wrap::WrapInversed)
     .SetGapMainAxis(1)
     .SetGapCrossAxis(1)
)

Definition at line 250 of file flexbox.cpp.

◆ gridbox()

Element gridbox ( std::vector< Elements > lines )

要素のグリッドを表示するコンテナ。

Parameters

lines 各行が要素のリストである、行のリスト。

Returns: コンテナ。

例

auto cell = [](const char* t) { return text(t) | border; };
auto document = gridbox({
  {cell("north-west") , cell("north")  , cell("north-east")} ,
  {cell("west")       , cell("center") , cell("east")}       ,
  {cell("south-west") , cell("south")  , cell("south-east")} ,
});

Output:

╭──────────╮╭──────╮╭──────────╮
│north-west││north ││north-east│
╰──────────╯╰──────╯╰──────────╯
╭──────────╮╭──────╮╭──────────╮
│west      ││center││east      │
╰──────────╯╰──────╯╰──────────╯
╭──────────╮╭──────╮╭──────────╮
│south-west││south ││south-east│
╰──────────╯╰──────╯╰──────────╯

Definition at line 172 of file src/ftxui/dom/gridbox.cpp.

◆ hflow()

Element hflow ( Elements children )

要素を左から右へ行で表示するコンテナ。一杯になると、下の新しい行から開始します。

Parameters

children コンテナ内の要素

Returns: コンテナ。

例

hflow({
  text("element 1"),
  text("element 2"),
  text("element 3"),
});

Definition at line 267 of file flexbox.cpp.

◆ vflow()

Element vflow ( Elements children )

要素を上から下へ行で表示するコンテナ。一杯になると、右側の新しい列から開始します。

Parameters

children コンテナ内の要素

Returns: コンテナ。

例

vflow({
  text("element 1"),
  text("element 2"),
  text("element 3"),
});

Definition at line 284 of file flexbox.cpp.

◆ frame()

Element frame ( Element child )

要素を「仮想」領域内に表示できるようにします。そのサイズはコンテナよりも大きくすることができます。この場合、より小さい部分のみが表示されます。フォーカスされた要素を表示するためにビューはスクロール可能です。

See also: frame; xframe; yframe

Definition at line 117 of file frame.cpp.

◆ xframe()

Element xframe ( Element child )

frame と同じですが、x軸のみに適用されます。

See also: frame; xframe; yframe

Definition at line 125 of file frame.cpp.

◆ yframe()

Element yframe ( Element child )

frame と同じですが、y軸のみに適用されます。

See also: frame; xframe; yframe

Definition at line 133 of file frame.cpp.

◆ select()

Element select ( Element child )

子要素を兄弟要素の中でフォーカスされたものとして設定します。

これは非推奨です。代わりに focus を使用してください。

Parameters

child フォーカスされる要素。

Definition at line 108 of file frame.cpp.

◆ reflect()

Decorator reflect ( Box & box )

Definition at line 42 of file reflect.cpp.

◆ Render()

void Render	(	Screen &	screen,
		Node *	node,
		Selection &	selection )

Definition at line 96 of file node.cpp.

◆ GetNodeSelectedContent()

std::string GetNodeSelectedContent	(	Screen &	screen,
		Node *	node,
		Selection &	selection )

Definition at line 167 of file node.cpp.

◆ GetColorInfo() [1/2]

ColorInfo GetColorInfo ( Color::Palette256 index )

Definition at line 271 of file color_info.cpp.

◆ GetColorInfo() [2/2]

ColorInfo GetColorInfo ( Color::Palette16 index )

Definition at line 275 of file color_info.cpp.

◆ wchar_width()

int wchar_width ( wchar_t ucs )

Definition at line 1307 of file string.cpp.

◆ wstring_width()

int wstring_width ( const std::wstring & text )

Definition at line 1311 of file string.cpp.

◆ to_string()

std::string to_string ( const std::wstring & s )

◆ to_wstring() [1/2]

std::wstring to_wstring ( const std::string & s )

◆ to_wstring() [2/2]

template<typename T >

std::wstring to_wstring ( T s )

Definition at line 15 of file string.hpp.

◆ string_width()

int string_width ( const std::string & input )

Definition at line 1324 of file string.cpp.

◆ Utf8ToGlyphs()

std::vector< std::string > Utf8ToGlyphs ( const std::string & input )

Definition at line 1351 of file string.cpp.

◆ CellToGlyphIndex()

std::vector< int > CellToGlyphIndex ( const std::string & input )

◆ Slider() [4/13]

template Component Slider ( SliderOption< int8_t > )

◆ Slider() [5/13]

template Component Slider ( SliderOption< int16_t > )

◆ Slider() [6/13]

template Component Slider ( SliderOption< int32_t > )

◆ Slider() [7/13]

template Component Slider ( SliderOption< int64_t > )

◆ Slider() [8/13]

template Component Slider ( SliderOption< uint8_t > )

◆ Slider() [9/13]

template Component Slider ( SliderOption< uint16_t > )

◆ Slider() [10/13]

template Component Slider ( SliderOption< uint32_t > )

◆ Slider() [11/13]

template Component Slider ( SliderOption< uint64_t > )

◆ Slider() [12/13]

template Component Slider ( SliderOption< float > )

◆ Slider() [13/13]

template Component Slider ( SliderOption< double > )

◆ operator|() [2/2]

Component operator\|	(	Component	component,
		ComponentDecorator	decorator )

Definition at line 12 of file component/util.cpp.

◆ PixelAt()

return PixelAt	(	x	,
		y	)

指定された位置のセル内の文字にアクセスします。

Parameters

x	x軸に沿ったセルの位置。
y	y軸に沿ったセルの位置。

◆ EatCodePoint() [1/2]

bool EatCodePoint	(	const std::string &	input,
		size_t	start,
		size_t *	end,
		uint32_t *	ucs )

Definition at line 1170 of file string.cpp.

◆ EatCodePoint() [2/2]

bool EatCodePoint	(	const std::wstring &	input,
		size_t	start,
		size_t *	end,
		uint32_t *	ucs )

Definition at line 1237 of file string.cpp.

◆ IsCombining()

bool IsCombining ( uint32_t ucs )

Definition at line 1275 of file string.cpp.

◆ IsFullWidth()

bool IsFullWidth ( uint32_t ucs )

Definition at line 1279 of file string.cpp.

◆ IsControl()

bool IsControl ( uint32_t ucs )

Definition at line 1287 of file string.cpp.

◆ CodepointToWordBreakProperty()

WordBreakProperty CodepointToWordBreakProperty ( uint32_t codepoint )

Definition at line 1301 of file string.cpp.

◆ GlyphPrevious()

size_t GlyphPrevious	(	const std::string &	input,
		size_t	start )

Definition at line 1392 of file string.cpp.

◆ GlyphNext()

size_t GlyphNext	(	const std::string &	input,
		size_t	start )

Definition at line 1414 of file string.cpp.

◆ static_cast< int >()

return static_cast< int > ( input. size() )

◆ GlyphIterate()

size_t GlyphIterate	(	const std::string &	input,
		int	glyph_offset,
		size_t	start = 0 )

◆ GlyphCount()

int GlyphCount ( const std::string & input )

◆ Utf8ToWordBreakProperty()

std::vector< WordBreakProperty > Utf8ToWordBreakProperty ( const std::string & input )

◆ IsWordBreakingCharacter()

bool IsWordBreakingCharacter	(	const std::string &	input,
		size_t	glyph_index )

Variable Documentation

◆ g_uniformize

const std::map<std::string, std::string> g_uniformize

Definition at line 19 of file terminal_input_parser.cpp.

◆ palette256

const std::array<ColorInfo, 256> palette256

Definition at line 12 of file color_info.cpp.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ CapturedMouse

◆ Component

◆ Components

◆ Sender

◆ Receiver

◆ Closure

◆ Task

◆ Element

◆ Elements

◆ Decorator

◆ GraphFunction

Enumeration Type Documentation

◆ WidthOrHeight

◆ Constraint

◆ WordBreakProperty

Function Documentation

◆ Make()

◆ operator|() [1/2]

◆ operator|=() [1/2]

◆ operator|=() [2/2]

◆ Input() [1/3]

◆ Input() [2/3]

◆ Input() [3/3]

◆ Slider() [1/13]

例

◆ Slider() [2/13]

◆ Slider() [3/13]

◆ ResizableSplit()

例

出力

◆ CatchEvent()

◆ Collapsible()

例

出力

◆ MakeReceiver()

◆ paragraph()

◆ separator() [1/2]

◆ separatorLight()

◆ separatorHeavy()

◆ separator() [2/2]

◆ separatorCharacter()

◆ separatorHSelector()

◆ separatorVSelector()

◆ border()

◆ borderLight()

◆ borderDashed()

◆ borderHeavy()

◆ borderDouble()

◆ borderRounded()

◆ borderEmpty()

◆ borderStyled() [1/3]

◆ borderStyled() [2/3]

◆ borderStyled() [3/3]

◆ borderWith()

◆ window()

◆ graph()

◆ canvas() [1/3]

◆ canvas() [2/3]

◆ canvas() [3/3]

◆ selectionStyleReset()

◆ selectionColor()

◆ selectionBackgroundColor()

◆ selectionForegroundColor()

◆ selectionStyle()

◆ hbox()

例

◆ flexbox()

例

◆ gridbox()

例

◆ hflow()

例