用户组件

用户组件集合 更多...

用户组件 的协作图:

类
struct	neforce::tui::components::container
	容器组件工厂 更多...
struct	neforce::tui::components::dropdown_option
	下拉选择组件配置 更多...
struct	neforce::tui::components::menu_option
	菜单选项配置 更多...
struct	neforce::tui::components::radiobox_option
	单选按钮组配置 更多...
struct	neforce::tui::components::scroll_view_option
	滚动视图配置 更多...
struct	neforce::tui::components::slider_options
	窗口配置 更多...
struct	neforce::tui::components::text_input_option
	文本输入组件配置 更多...
struct	neforce::tui::components::toggle_option
	切换组件配置 更多...
struct	neforce::tui::components::window_options
	窗口配置 更多...

函数
unique_ptr< component_base >	neforce::tui::components::collapsible (const string &title, unique_ptr< component_base > child, bool *show=nullptr)
	创建可折叠区域
unique_ptr< component_base >	neforce::tui::components::dropdown (dropdown_option option)
	创建下拉选择组件
unique_ptr< component_base >	neforce::tui::components::hoverable (unique_ptr< component_base > child, function< void()> on_enter, function< void()> on_leave)
	创建鼠标悬停检测组件
unique_ptr< component_base >	neforce::tui::components::hoverable (unique_ptr< component_base > child, bool *hovered)
	创建悬停状态绑定组件
unique_ptr< component_base >	neforce::tui::components::menu (menu_option option)
	创建菜单组件
unique_ptr< component_base >	neforce::tui::components::modal (unique_ptr< component_base > main, unique_ptr< component_base > overlay, const bool *show_modal)
	创建模态框组件
unique_ptr< component_base >	neforce::tui::components::radiobox (radiobox_option option)
	创建单选按钮组
unique_ptr< component_base >	neforce::tui::components::renderer (unique_ptr< component_base > child, function< element()> render_fn)
	使用渲染函数覆盖子组件的 render()
unique_ptr< component_base >	neforce::tui::components::renderer (unique_ptr< component_base > child, function< element(bool focused)> render_fn)
	带焦点感知的渲染器
unique_ptr< component_base >	neforce::tui::components::renderer (function< element()> render_fn)
	独立渲染器
unique_ptr< component_base >	neforce::tui::components::catch_event (unique_ptr< component_base > child, function< bool(const key_event &)> on_event)
	在事件传递到子组件前拦截处理
unique_ptr< component_base >	neforce::tui::components::maybe (unique_ptr< component_base > child, const bool *show)
	条件渲染组件
unique_ptr< component_base >	neforce::tui::components::resizable_split_left (unique_ptr< component_base > main, unique_ptr< component_base > back, int *main_size)
	创建垂直分割面板（主面板在左）
unique_ptr< component_base >	neforce::tui::components::resizable_split_right (unique_ptr< component_base > main, unique_ptr< component_base > back, int *main_size)
	创建垂直分割面板（主面板在右）
unique_ptr< component_base >	neforce::tui::components::resizable_split_top (unique_ptr< component_base > main, unique_ptr< component_base > back, int *main_size)
	创建水平分割面板（主面板在上）
unique_ptr< component_base >	neforce::tui::components::resizable_split_bottom (unique_ptr< component_base > main, unique_ptr< component_base > back, int *main_size)
	创建水平分割面板（主面板在下）
unique_ptr< component_base >	neforce::tui::components::scroll_view (scroll_view_option opt)
	创建滚动视图组件
unique_ptr< component_base >	neforce::tui::components::slider (slider_options options)
	滑块组件
unique_ptr< component_base >	neforce::tui::components::text_input (text_input_option opt)
	创建文本输入组件
unique_ptr< component_base >	neforce::tui::components::toggle (toggle_option option)
	创建切换组件
unique_ptr< component_base >	neforce::tui::components::window (window_options options)
	创建浮动窗口组件

详细描述

用户组件集合

函数说明

catch_event()

unique_ptr< component_base > neforce::tui::components::catch_event	(	unique_ptr< component_base >	child,
		function< bool(const key_event &)>	on_event )

在事件传递到子组件前拦截处理

参数

child	子组件
on_event	事件处理函数，返回 true 表示已消费

返回

组件指针

引用了 catch_event().

被这些函数引用 catch_event().

collapsible()

unique_ptr< component_base > neforce::tui::components::collapsible	(	const string &	title,
		unique_ptr< component_base >	child,
		bool *	show = nullptr )

创建可折叠区域

参数

title	折叠标题
child	内部子组件
show	展开状态指针

返回

组件指针

引用了 collapsible().

被这些函数引用 collapsible().

dropdown()

unique_ptr< component_base > neforce::tui::components::dropdown

(

dropdown_option

option

)

创建下拉选择组件

参数

option

配置

返回

组件指针

引用了 dropdown().

被这些函数引用 dropdown().

hoverable() [1/2]

unique_ptr< component_base > neforce::tui::components::hoverable	(	unique_ptr< component_base >	child,
		bool *	hovered )

创建悬停状态绑定组件

参数

child	子组件
hovered	悬停状态指针

返回

组件指针

引用了 hoverable().

hoverable() [2/2]

unique_ptr< component_base > neforce::tui::components::hoverable	(	unique_ptr< component_base >	child,
		function< void()>	on_enter,
		function< void()>	on_leave )

创建鼠标悬停检测组件

参数

child	子组件
on_enter	鼠标进入回调
on_leave	鼠标离开回调

返回

组件指针

引用了 hoverable().

被这些函数引用 hoverable() , 以及 hoverable().

maybe()

unique_ptr< component_base > neforce::tui::components::maybe	(	unique_ptr< component_base >	child,
		const bool *	show )

条件渲染组件

参数

child	子组件
show	条件指针

返回

组件指针

当 show 指向 false 时，组件 render() 返回 empty_element，且不会接收焦点或事件。

引用了 maybe().

被这些函数引用 maybe().

menu()

unique_ptr< component_base > neforce::tui::components::menu

(

menu_option

option

)

创建菜单组件

参数

option

菜单配置

返回

组件指针

引用了 menu().

被这些函数引用 menu().

modal()

unique_ptr< component_base > neforce::tui::components::modal	(	unique_ptr< component_base >	main,
		unique_ptr< component_base >	overlay,
		const bool *	show_modal )

创建模态框组件

参数

main	主内容组件
overlay	模态叠加组件
show_modal	是否显示模态框

返回

组件指针

当 show_modal 指向 true 时，overlay 覆盖在 main 上， 且所有事件发给 overlay。按 Escape 不会自动关闭。

引用了 modal().

被这些函数引用 modal().

radiobox()

unique_ptr< component_base > neforce::tui::components::radiobox

(

radiobox_option

option

)

创建单选按钮组

参数

option

配置

返回

组件指针

引用了 radiobox().

被这些函数引用 radiobox().

renderer() [1/3]

unique_ptr< component_base > neforce::tui::components::renderer

(

function< element()>

render_fn

)

独立渲染器

参数

render_fn

渲染函数

返回

组件指针

引用了 renderer().

renderer() [2/3]

unique_ptr< component_base > neforce::tui::components::renderer	(	unique_ptr< component_base >	child,
		function< element()>	render_fn )

使用渲染函数覆盖子组件的 render()

参数

child	子组件
render_fn	渲染函数

返回

组件指针

引用了 renderer().

被这些函数引用 renderer(), renderer() , 以及 renderer().

renderer() [3/3]

unique_ptr< component_base > neforce::tui::components::renderer	(	unique_ptr< component_base >	child,
		function< element(bool focused)>	render_fn )

带焦点感知的渲染器

参数

child	子组件
render_fn	渲染函数（参数 focused 指示组件是否拥有焦点）

返回

组件指针

引用了 renderer().

resizable_split_bottom()

unique_ptr< component_base > neforce::tui::components::resizable_split_bottom	(	unique_ptr< component_base >	main,
		unique_ptr< component_base >	back,
		int *	main_size )

创建水平分割面板（主面板在下）

参数

main	主面板组件
back	副面板组件
main_size	主面板大小

返回

组件指针

引用了 resizable_split_bottom().

被这些函数引用 resizable_split_bottom().

resizable_split_left()

unique_ptr< component_base > neforce::tui::components::resizable_split_left	(	unique_ptr< component_base >	main,
		unique_ptr< component_base >	back,
		int *	main_size )

创建垂直分割面板（主面板在左）

参数

main	主面板组件
back	副面板组件
main_size	主面板大小

返回

组件指针

引用了 resizable_split_left().

被这些函数引用 resizable_split_left().

resizable_split_right()

unique_ptr< component_base > neforce::tui::components::resizable_split_right	(	unique_ptr< component_base >	main,
		unique_ptr< component_base >	back,
		int *	main_size )

创建垂直分割面板（主面板在右）

参数

main	主面板组件
back	副面板组件
main_size	主面板大小

返回

组件指针

引用了 resizable_split_right().

被这些函数引用 resizable_split_right().

resizable_split_top()

unique_ptr< component_base > neforce::tui::components::resizable_split_top	(	unique_ptr< component_base >	main,
		unique_ptr< component_base >	back,
		int *	main_size )

创建水平分割面板（主面板在上）

参数

main	主面板组件
back	副面板组件
main_size	主面板大小

返回

组件指针

引用了 resizable_split_top().

被这些函数引用 resizable_split_top().

scroll_view()

unique_ptr< component_base > neforce::tui::components::scroll_view

(

scroll_view_option

opt

)

创建滚动视图组件

参数

opt

配置选项

返回

组件指针

引用了 scroll_view().

被这些函数引用 scroll_view().

slider()

unique_ptr< component_base > neforce::tui::components::slider

(

slider_options

options

)

滑块组件

使用箭头键调整值，范围 [min, max]，步长为 increment。

引用了 slider().

被这些函数引用 slider().

text_input()

unique_ptr< component_base > neforce::tui::components::text_input

(

text_input_option

opt

)

创建文本输入组件

参数

opt

配置选项

返回

组件指针

组件获取焦点后接收可打印字符和 Backspace， 通过 onAnimation 实现光标闪烁。

引用了 text_input().

被这些函数引用 text_input().

toggle()

unique_ptr< component_base > neforce::tui::components::toggle

(

toggle_option

option

)

创建切换组件

参数

option

配置

返回

组件指针

引用了 toggle().

被这些函数引用 toggle().

window()

unique_ptr< component_base > neforce::tui::components::window

(

window_options

options

)

创建浮动窗口组件

参数

options

窗口配置

返回

组件指针

引用了 window().

被这些函数引用 window().