UI / WIDGETS / 选择与调节
ComboBox
结合输入与候选项选择
在演练场运行 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.combo_box(&options,"Design") or >>
screen.place(id,24.0,24.0,320.0,80.0) or >>
<< id
}
($&Screen) combo_box
pub fn (s $&Screen) combo_box(options &[]string,value string) int
用途
在 Screen 中创建 ComboBox,返回组件节点 ID;创建失败时抛出错误。
参数
s $&Screen- 本次调用使用的
Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
options &[]string- options(只读借用,调用方仍持有原值;类型 &[]string)
value string- value(string)
返回值
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 方法。
struct ComboBox
用途
下拉组合选择输入框控件,支持文本编辑与弹出项选择。
公开字段
此类型没有公开字段。
(&ComboBox) id
pub fn (combo &ComboBox) id() int
用途
返回当前控件、元素或节点的唯一标识 ID。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&ComboBox) bounds
pub fn (combo &ComboBox) bounds() layout.Rect
用途
返回当前控件或几何对象的有效外接矩形边界(Rectangle)。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
layout.Rect — 该类型的值
(&ComboBox) value
pub fn (combo &ComboBox) value() string
用途
&ComboBox 上的操作:值。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
string — 结果字符串
(&ComboBox) selected_text
pub fn (combo &ComboBox) selected_text() string
用途
&ComboBox 上的操作:执行 selected text 操作。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
string — 结果字符串
(&ComboBox) selected
pub fn (combo &ComboBox) selected() int
用途
读取当前文字匹配的原选项索引,适合检查输入是否对应已有选项。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
匹配选项的索引;文字不匹配任何选项时为 -1。
(&ComboBox) count
pub fn (combo &ComboBox) count() int
用途
返回该控件当前包含的项目数量。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&ComboBox) filtered_count
pub fn (combo &ComboBox) filtered_count() int
用途
&ComboBox 上的操作:执行 filtered count 操作。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&ComboBox) is_open
pub fn (combo &ComboBox) is_open() bool
用途
返回浮层、菜单或对话框当前是否打开。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&ComboBox) is_selectable
pub fn (combo &ComboBox) is_selectable() bool
用途
&ComboBox 上的操作:判断是否 selectable。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&ComboBox) is_focused
pub fn (combo &ComboBox) is_focused() bool
用途
返回控件当前是否拥有输入焦点。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&ComboBox) is_enabled
pub fn (combo &ComboBox) is_enabled() bool
用途
返回控件当前是否可用。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&ComboBox) needs_paint
pub fn (combo &ComboBox) needs_paint() bool
用途
返回控件是否需要重新绘制;绘制完成后调用 painted 清除标记。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&ComboBox) set_placeholder
pub fn (combo $&ComboBox) set_placeholder(value &string) int
用途
$&ComboBox 上的操作:设置 placeholder。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value &string- value(只读借用,调用方仍持有原值;类型 &string)
返回值
int — 该类型的值
(&ComboBox) style_or
pub fn (combo &ComboBox) style_or(styles &Styles) ControlStyle
用途
&ComboBox 上的操作:执行 style or 操作。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
ControlStyle — 该类型的值
($&ComboBox) set_style
pub fn (combo $&ComboBox) set_style(style &ControlStyle) int
用途
$&ComboBox 上的操作:设置 style。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
style &ControlStyle- style(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
int — 该类型的值
($&ComboBox) set_enabled
pub fn (combo $&ComboBox) set_enabled(enabled bool) int
用途
$&ComboBox 上的操作:设置 enabled。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool- enabled(bool)
返回值
int — 该类型的值
($&ComboBox) set_read_only
pub fn (combo $&ComboBox) set_read_only(read_only bool) int
用途
$&ComboBox 上的操作:设置 read only。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
read_only bool- read_only(bool)
返回值
int — 该类型的值
($&ComboBox) set_selectable
pub fn (combo $&ComboBox) set_selectable(selectable bool) int
用途
$&ComboBox 上的操作:设置 selectable。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selectable bool- selectable(bool)
返回值
int — 该类型的值
($&ComboBox) set_viewport
pub fn (combo $&ComboBox) set_viewport(viewport &layout.Rect)
用途
$&ComboBox 上的操作:设置 viewport。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
viewport &layout.Rect- viewport(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
不返回值。
($&ComboBox) set_invalid
pub fn (combo $&ComboBox) set_invalid(invalid bool)
用途
$&ComboBox 上的操作:设置 invalid。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
invalid bool- invalid(bool)
返回值
不返回值。
($&ComboBox) focus_session
pub fn (combo $&ComboBox) focus_session(focused bool) int
用途
$&ComboBox 上的操作:执行 focus session 操作。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
focused bool- focused(bool)
返回值
int — 该类型的值
($&ComboBox) set_bounds
pub fn (combo $&ComboBox) set_bounds(bounds &layout.Rect) int
用途
$&ComboBox 上的操作:设置 bounds。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds &layout.Rect- bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
int — 该类型的值
($&ComboBox) set_value
pub fn (combo $&ComboBox) set_value(value &string) int
用途
以程序方式更新可输入下拉框的文字,并刷新内部查询状态。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value &string- 新的完整文字;与已有选项完全一致时会更新匹配索引。
返回值
成功返回 0;失败时抛错,不以非零返回码表示失败。
错误处理
- 编辑器拒绝替换(例如输入法组合尚未完成)时继续抛错。
($&ComboBox) set_selected
pub fn (combo $&ComboBox) set_selected(index int) int
用途
选择下拉框中的一个已有选项,把该选项文字写入编辑器并关闭菜单。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
index int- 原选项列表中从
0 开始的索引;不是过滤后的可见行号。
返回值
成功返回 0;失败时抛错,不以非零返回码表示失败。
错误处理
- 索引越界抛出
widgets: combo choice out of range;编辑器处于输入法组合状态时,替换文字也可能抛错。
($&ComboBox) set_open
pub fn (combo $&ComboBox) set_open(open bool)
用途
控制下拉选项列表的打开状态。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
open booltrue 请求打开,false 关闭;禁用或只读时请求打开也会保持关闭。
返回值
不返回值;更新后的状态可用 is_open() 读取。
使用时注意
- 打开状态与绘制是两步:还需在合适的覆盖层调用
paint_popup_styled。
- 显式打开时先展示全部选项;随后编辑文字才按输入过滤。
($&ComboBox) apply_styles
pub fn (combo $&ComboBox) apply_styles(styles &Styles) int
用途
根据当前主题样式表解析并应用几何与视觉度量。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
(&ComboBox) option_bounds
pub fn (combo &ComboBox) option_bounds(index int) layout.Rect
用途
&ComboBox 上的操作:执行 option bounds 操作。失败时抛出错误,调用方需处理或继续传播。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
index int- index(int)
返回值
layout.Rect — 该类型的值
(&ComboBox) toggle_bounds
pub fn (combo &ComboBox) toggle_bounds() layout.Rect
用途
&ComboBox 上的操作:执行 toggle bounds 操作。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
layout.Rect — 该类型的值
($&ComboBox) input
pub fn (combo $&ComboBox) input(event &ui.InputEvent) Action
用途
处理可输入下拉框的菜单选择、展开按钮和编辑器输入。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.InputEvent- 同一窗口、画布和代次的输入事件;坐标按控件所在的画布空间传入。
返回值
Action 描述本次交互:kind 是动作类型,consumed 表示事件是否已处理,request_focus 请求焦点,needs_paint 表示需要重绘。
使用时注意
- 选中菜单项时返回
ACTION_CHANGE,value 为原选项列表中的索引;输入法组合期间把 Enter/方向键留给编辑器。
($&ComboBox) route
pub fn (combo $&ComboBox) route(kind int,event &ui.InputEvent) Action
用途
路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int- 类型标签(int)
event &ui.InputEvent- event(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
($&ComboBox) event
pub fn (combo $&ComboBox) event(event &ui.Event) Action
用途
接收窗口原生事件;输入事件转交 input,其余事件交给内部编辑器或基础控件处理。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event- 窗口提供的完整
ui.Event;需要输入法、失焦和生命周期处理时使用这个入口。
返回值
Action 描述本次交互:kind 是动作类型,consumed 表示事件是否已处理,request_focus 请求焦点,needs_paint 表示需要重绘。
使用时注意
($&ComboBox) tick
pub fn (combo $&ComboBox) tick(now time.Instant,reduced_motion bool) bool
用途
推进动画时间戳与状态过渡动画步进。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now time.Instant- now(time.Instant)
reduced_motion bool- reduced_motion(bool)
返回值
bool — 是否成立
(&ComboBox) next_caret_tick
pub fn (combo &ComboBox) next_caret_tick(now time.Instant,reduced_motion bool) time.Instant
用途
&ComboBox 上的操作:执行 next caret tick 操作。失败时抛出错误,调用方需处理或继续传播。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
now time.Instant- now(time.Instant)
reduced_motion bool- reduced_motion(bool)
返回值
time.Instant — 该类型的值
($&ComboBox) measure_styled
pub fn (combo $&ComboBox) measure_styled(styles &Styles) layout.Size
用途
$&ComboBox 上的操作:执行 measure styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
layout.Size — 该类型的值
($&ComboBox) paint_styled
pub fn (combo $&ComboBox) paint_styled(frame $&draw.Frame,styles &Styles) int
用途
$&ComboBox 上的操作:执行 paint styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
($&ComboBox) dispose
pub fn (combo $&ComboBox) dispose()
用途
释放并清理对象所持有的系统原生资源与底层句柄。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&ComboBox) set_allow_custom
pub fn (combo $&ComboBox) set_allow_custom(allowed bool)
用途
$&ComboBox 上的操作:设置 allow custom。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
allowed bool- allowed(bool)
返回值
不返回值。
(&ComboBox) is_valid_choice
pub fn (combo &ComboBox) is_valid_choice() bool
用途
&ComboBox 上的操作:判断是否 valid choice。
参数
combo &ComboBox- 本次调用使用的
ComboBox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&ComboBox) set_locale
pub fn (combo $&ComboBox) set_locale(locale &Locale) int
用途
$&ComboBox 上的操作:设置 locale。失败时抛出错误,调用方需处理或继续传播。
参数
combo $&ComboBox- 本次调用使用的
ComboBox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
locale &Locale- locale(只读借用,调用方仍持有原值;类型 &Locale)
返回值
int — 该类型的值
完整原生示例
Component Workshop · 返回 Widgets 目录