UI / WIDGETS / 选择与调节
Select
从给定选项中选择一个
在演练场运行 Xu 示例 ↗示例由浏览器中的 Xu/WASM 运行器执行。
体验什么
点击展开选项,或聚焦后用方向键更换选择。
使用要点
选项来自固定集合。需要分组或禁用项时使用带选项元数据的创建方法,不能把组标题当作可选值。
通过 Screen 创建
下面的 Screen 构造方法返回节点 ID。将 ID 交给 Screen 的布局、状态与事件接口;它不是下方独立控件类型的实例。
原生 Xu 创建片段:在已有 Screen 的初始化阶段调用 configure;窗口创建、事件循环与资源释放参见完整原生示例。
#ui/widgets
fn configure(screen $&widgets.Screen) int {
options := ["Design","Develop","Review"]
id := screen.select_box(&options,0) or >>
screen.place(id,24.0,24.0,320.0,80.0) or >>
<< id
}
($&Screen) select_box
pub fn (s $&Screen) select_box(options &[]string,selected int) int
用途
在 Screen 中创建 Select,返回组件节点 ID;创建失败时抛出错误。
参数
s $&Screen- 本次调用使用的
Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
options &[]string- options(只读借用,调用方仍持有原值;类型 &[]string)
selected int- selected(int)
返回值
int — 组件节点 ID,供 place 和其他 Screen 方法使用。
放置、状态与事件
组件由应用拥有。Screen.place 放置节点,Screen.set_enabled 和 Screen.set_visible 管理可用性与显示。状态变化后重新呈现;创建和修改时处理 or 错误,不在绘制回调中修改拓扑。ToastHost 使用自己的队列接口。
Action · Styles · 界面生命周期与样式指南
Screen.place · Screen.set_enabled · Screen.set_visible
独立控件对象 API
以下类型与方法用于自行管理控件、输入和绘制的进阶用法。接收者是控件对象,不是 Screen 返回的节点 ID;普通 Screen 用法请使用上面的创建接口及 Widgets 模块中的 Screen 方法。
(&Select) clone
pub fn (value &Select) clone() Select
用途
复制控件或样式快照,返回独立的 Select 值。
参数
value &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
Select — 该类型的值
struct Select
用途
Select 上下文或状态结构体。
公开字段
此类型没有公开字段。
查看用法示例
(&Select) is_selectable
pub fn (sel &Select) is_selectable() bool
用途
&Select 上的操作:判断是否 selectable。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Select) set_selectable
pub fn (sel $&Select) set_selectable(selectable bool)
用途
$&Select 上的操作:设置 selectable。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selectable bool- selectable(bool)
返回值
不返回值。
(&Select) id
pub fn (sel &Select) id() int
用途
返回当前控件、元素或节点的唯一标识 ID。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Select) bounds
pub fn (sel &Select) bounds() layout.Rect
用途
返回当前控件或几何对象的有效外接矩形边界(Rectangle)。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
layout.Rect — 该类型的值
(&Select) count
pub fn (sel &Select) count() int
用途
返回该控件当前包含的项目数量。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Select) selected
pub fn (sel &Select) selected() int
用途
获取或判断当前选中的项索引、节点或文本状态。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Select) is_open
pub fn (sel &Select) is_open() bool
用途
返回浮层、菜单或对话框当前是否打开。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Select) hovered_option
pub fn (sel &Select) hovered_option() int
用途
返回指针悬停的选项索引;无悬停项时返回 -1。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Select) needs_paint
pub fn (sel &Select) needs_paint() bool
用途
返回控件是否需要重新绘制;绘制完成后调用 painted 清除标记。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Select) painted
pub fn (sel $&Select) painted()
用途
确认当前帧已绘制,清除重绘标记;不是状态查询。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&Select) invalidate
pub fn (sel $&Select) invalidate()
用途
标记控件区域为脏,请求系统在下一帧重新绘制。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&Select) cancel
pub fn (sel $&Select) cancel()
用途
$&Select 上的操作:取消。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
(&Select) is_enabled
pub fn (sel &Select) is_enabled() bool
用途
返回控件当前是否可用。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Select) set_enabled
pub fn (sel $&Select) set_enabled(enabled bool)
用途
$&Select 上的操作:设置 enabled。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool- enabled(bool)
返回值
不返回值。
(&Select) is_focused
pub fn (sel &Select) is_focused() bool
用途
返回控件当前是否拥有输入焦点。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Select) set_focus
pub fn (sel $&Select) set_focus(focused bool)
用途
$&Select 上的操作:设置 focus。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
focused bool- focused(bool)
返回值
不返回值。
(&Select) is_hovered
pub fn (sel &Select) is_hovered() bool
用途
&Select 上的操作:判断是否 hovered。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Select) is_invalid
pub fn (sel &Select) is_invalid() bool
用途
&Select 上的操作:判断是否 invalid。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Select) set_invalid
pub fn (sel $&Select) set_invalid(invalid bool)
用途
$&Select 上的操作:设置 invalid。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
invalid bool- invalid(bool)
返回值
不返回值。
(&Select) is_read_only
pub fn (sel &Select) is_read_only() bool
用途
&Select 上的操作:判断是否 read only。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Select) set_read_only
pub fn (sel $&Select) set_read_only(read_only bool)
用途
$&Select 上的操作:设置 read only。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
read_only bool- read_only(bool)
返回值
不返回值。
($&Select) set_open
pub fn (sel $&Select) set_open(open bool)
用途
$&Select 上的操作:设置 open。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
open bool- open(bool)
返回值
不返回值。
($&Select) set_count
pub fn (sel $&Select) set_count(count int) int
用途
$&Select 上的操作:设置 count。失败时抛出错误,调用方需处理或继续传播。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
count int- count(int)
返回值
int — 该类型的值
($&Select) set_selected
pub fn (sel $&Select) set_selected(index int) int
用途
$&Select 上的操作:设置 selected。失败时抛出错误,调用方需处理或继续传播。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
index int- index(int)
返回值
int — 该类型的值
($&Select) set_bounds
pub fn (sel $&Select) set_bounds(bounds &layout.Rect) int
用途
$&Select 上的操作:设置 bounds。失败时抛出错误,调用方需处理或继续传播。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds &layout.Rect- bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
int — 该类型的值
(&Select) visual_state
pub fn (sel &Select) visual_state() int
用途
&Select 上的操作:执行 visual state 操作。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Select) has_style
pub fn (sel &Select) has_style() bool
用途
&Select 上的操作:判断是否具有 style。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Select) style_or
pub fn (sel &Select) style_or(styles &Styles) ControlStyle
用途
&Select 上的操作:执行 style or 操作。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
ControlStyle — 该类型的值
($&Select) set_style
pub fn (sel $&Select) set_style(style &ControlStyle) int
用途
$&Select 上的操作:设置 style。失败时抛出错误,调用方需处理或继续传播。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
style &ControlStyle- style(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
int — 该类型的值
($&Select) clear_style
pub fn (sel $&Select) clear_style()
用途
$&Select 上的操作:执行 clear style 操作。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&Select) apply_styles
pub fn (sel $&Select) apply_styles(styles &Styles) int
用途
根据当前主题样式表解析并应用几何与视觉度量。失败时抛出错误,调用方需处理或继续传播。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
(&Select) option_bounds
pub fn (sel &Select) option_bounds(index int,styles &Styles) layout.Rect
用途
&Select 上的操作:执行 option bounds 操作。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
index int- index(int)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
layout.Rect — 该类型的值
($&Select) input
pub fn (sel $&Select) input(input &ui.InputEvent) Action
用途
接收并处理分发的鼠标、键盘或触摸交互输入事件。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
input &ui.InputEvent- input(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
($&Select) event
pub fn (sel $&Select) event(event &ui.Event) Action
用途
处理并响应窗口与系统的交互及生命周期事件。失败时抛出错误,调用方需处理或继续传播。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event- event(只读借用,调用方仍持有原值;类型 &ui.Event)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
(&Select) paint
pub fn (sel &Select) paint(frame $&draw.Frame,labels &[]draw.TextLayout,theme &Theme) int
用途
在目标画布或渲染目标上执行控件的视觉绘制。失败时抛出错误,调用方需处理或继续传播。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
labels &[]draw.TextLayout- labels(只读借用,调用方仍持有原值;类型 &[]draw.TextLayout)
theme &Theme- theme(只读借用,调用方仍持有原值;类型 &Theme)
返回值
int — 该类型的值
(&Select) measure_styled
pub fn (sel &Select) measure_styled(label $&StyledLabel,styles &Styles) layout.Size
用途
&Select 上的操作:执行 measure styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
label $&StyledLabel- label(独占借用,可修改原值;类型 $&StyledLabel)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
layout.Size — 该类型的值
(&Select) paint_styled
pub fn (sel &Select) paint_styled(frame $&draw.Frame,label $&StyledLabel,styles &Styles) int
用途
&Select 上的操作:执行 paint styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
label $&StyledLabel- label(独占借用,可修改原值;类型 $&StyledLabel)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
(&Select) paint_option_styled
pub fn (sel &Select) paint_option_styled(frame $&draw.Frame,index int,label $&StyledLabel,styles &Styles) int
用途
&Select 上的操作:执行 paint option styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
index int- index(int)
label $&StyledLabel- label(独占借用,可修改原值;类型 $&StyledLabel)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
($&Select) set_option_enabled
pub fn (sel $&Select) set_option_enabled(index int,enabled bool) int
用途
$&Select 上的操作:设置 option enabled。失败时抛出错误,调用方需处理或继续传播。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
index int- index(int)
enabled bool- enabled(bool)
返回值
int — 该类型的值
($&Select) set_option_group
pub fn (sel $&Select) set_option_group(index int,group bool) int
用途
$&Select 上的操作:设置 option group。失败时抛出错误,调用方需处理或继续传播。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
index int- index(int)
group bool- group(bool)
返回值
int — 该类型的值
(&Select) is_group
pub fn (sel &Select) is_group(index int) bool
用途
&Select 上的操作:判断是否 group。
参数
sel &Select- 本次调用使用的
Select 实例;以只读借用传入,调用方仍持有实例。
index int- index(int)
返回值
bool — 是否成立
($&Select) route
pub fn (sel $&Select) route(kind int,input &ui.InputEvent) Action
用途
路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。
参数
sel $&Select- 本次调用使用的
Select 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int- 类型标签(int)
input &ui.InputEvent- input(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
完整原生示例
Component Workshop · 返回 Widgets 目录