XU XUv0.13.1
EN

UI / WIDGETS / 选择与调节

MultiSelect

从列表中选择多项

在演练场运行 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.multi_select(&options) or >>
    screen.place(id,24.0,24.0,320.0,80.0) or >>
    << id
}

($&Screen) multi_select

XuAPI
pub fn (s $&Screen) multi_select(options &[]string) int

用途

在 Screen 中创建 MultiSelect,返回组件节点 ID;创建失败时抛出错误。

参数

s $&Screen
本次调用使用的 Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
options &[]string
options(只读借用,调用方仍持有原值;类型 &[]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 方法。

($&MultiSelect) set_locale

XuAPI
pub fn (multi $&MultiSelect) set_locale(locale &Locale) int

用途

$&MultiSelect 上的操作:设置 locale。失败时抛出错误,调用方需处理或继续传播。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
locale &Locale
locale(只读借用,调用方仍持有原值;类型 &Locale)

返回值

int — 该类型的值

(&MultiSelect) selection_text

XuAPI
pub fn (multi &MultiSelect) selection_text() string

用途

&MultiSelect 上的操作:执行 selection text 操作。失败时抛出错误,调用方需处理或继续传播。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。

返回值

string — 结果字符串

struct MultiSelect

XuAPI
pub struct MultiSelect {

}

用途

MultiSelect 上下文或状态结构体。

公开字段

此类型没有公开字段。

(&MultiSelect) id

XuAPI
pub fn (multi &MultiSelect) id() int

用途

返回当前控件、元素或节点的唯一标识 ID。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&MultiSelect) bounds

XuAPI
pub fn (multi &MultiSelect) bounds() layout.Rect

用途

返回当前控件或几何对象的有效外接矩形边界(Rectangle)。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。

返回值

layout.Rect — 该类型的值

(&MultiSelect) is_open

XuAPI
pub fn (multi &MultiSelect) is_open() bool

用途

返回浮层、菜单或对话框当前是否打开。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&MultiSelect) is_enabled

XuAPI
pub fn (multi &MultiSelect) is_enabled() bool

用途

返回控件当前是否可用。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&MultiSelect) is_selectable

XuAPI
pub fn (multi &MultiSelect) is_selectable() bool

用途

&MultiSelect 上的操作:判断是否 selectable。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

($&MultiSelect) set_selectable

XuAPI
pub fn (multi $&MultiSelect) set_selectable(selectable bool)

用途

$&MultiSelect 上的操作:设置 selectable。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selectable bool
selectable(bool)

返回值

不返回值。

(&MultiSelect) needs_paint

XuAPI
pub fn (multi &MultiSelect) needs_paint() bool

用途

返回控件是否需要重新绘制;绘制完成后调用 painted 清除标记。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。

返回值

bool — 是否成立

(&MultiSelect) count

XuAPI
pub fn (multi &MultiSelect) count() int

用途

返回该控件当前包含的项目数量。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。

返回值

int — 该类型的值

(&MultiSelect) selected

XuAPI
pub fn (multi &MultiSelect) selected(index int) bool

用途

检查某一选项当前是否勾选,适合在变化动作后读取最终状态。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。
index int
原选项列表中从 0 开始的索引。

返回值

勾选时为 true,否则为 false。

错误处理

  • 索引越界抛出 widgets: choice index out of range。

(&MultiSelect) values

XuAPI
pub fn (multi &MultiSelect) values() []int

用途

返回当前集合、参数表或映射中所有值的切片。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。

返回值

[]int — 切片结果

($&MultiSelect) set_selected

XuAPI
pub fn (multi $&MultiSelect) set_selected(index int,selected bool) int

用途

设置某一选项是否勾选,不改变其他选项,适合回填表单中的多选结果。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
index int
原选项列表中从 0 开始的索引。
selected bool
true 勾选,false 取消勾选。

返回值

成功返回 0;失败时抛错,不以非零返回码表示失败。

错误处理

  • 控件已释放或索引不在 0..count()-1 时抛错。

(&MultiSelect) style_or

XuAPI
pub fn (multi &MultiSelect) style_or(styles &Styles) ControlStyle

用途

&MultiSelect 上的操作:执行 style or 操作。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

ControlStyle — 该类型的值

($&MultiSelect) set_style

XuAPI
pub fn (multi $&MultiSelect) set_style(style &ControlStyle) int

用途

$&MultiSelect 上的操作:设置 style。失败时抛出错误,调用方需处理或继续传播。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
style &ControlStyle
style(只读借用,调用方仍持有原值;类型 &ControlStyle)

返回值

int — 该类型的值

($&MultiSelect) set_enabled

XuAPI
pub fn (multi $&MultiSelect) set_enabled(enabled bool)

用途

$&MultiSelect 上的操作:设置 enabled。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool
enabled(bool)

返回值

不返回值。

($&MultiSelect) set_read_only

XuAPI
pub fn (multi $&MultiSelect) set_read_only(read_only bool) int

用途

$&MultiSelect 上的操作:设置 read only。失败时抛出错误,调用方需处理或继续传播。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
read_only bool
read_only(bool)

返回值

int — 该类型的值

($&MultiSelect) set_invalid

XuAPI
pub fn (multi $&MultiSelect) set_invalid(invalid bool)

用途

$&MultiSelect 上的操作:设置 invalid。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
invalid bool
invalid(bool)

返回值

不返回值。

($&MultiSelect) set_focus

XuAPI
pub fn (multi $&MultiSelect) set_focus(focused bool)

用途

$&MultiSelect 上的操作:设置 focus。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
focused bool
focused(bool)

返回值

不返回值。

($&MultiSelect) set_open

XuAPI
pub fn (multi $&MultiSelect) set_open(open bool)

用途

控制下拉选项列表的打开状态。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
open bool
true 请求打开,false 关闭;禁用或只读时请求打开也会保持关闭。

返回值

不返回值;更新后的状态可用 is_open() 读取。

使用时注意

  • 打开状态与绘制是两步:还需在合适的覆盖层调用 paint_popup_styled。

($&MultiSelect) set_popup_above

XuAPI
pub fn (multi $&MultiSelect) set_popup_above(above bool)

用途

$&MultiSelect 上的操作:设置 popup above。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
above bool
above(bool)

返回值

不返回值。

($&MultiSelect) set_bounds

XuAPI
pub fn (multi $&MultiSelect) set_bounds(bounds &layout.Rect) int

用途

$&MultiSelect 上的操作:设置 bounds。失败时抛出错误,调用方需处理或继续传播。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds &layout.Rect
bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)

返回值

int — 该类型的值

($&MultiSelect) apply_styles

XuAPI
pub fn (multi $&MultiSelect) apply_styles(styles &Styles) int

用途

根据当前主题样式表解析并应用几何与视觉度量。失败时抛出错误,调用方需处理或继续传播。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

int — 该类型的值

(&MultiSelect) popup_bounds

XuAPI
pub fn (multi &MultiSelect) popup_bounds() layout.Rect

用途

读取下拉列表在画布中的矩形,用于覆盖层命中测试或布局判断。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。

返回值

弹出列表的 layout.Rect;读取矩形不会打开列表,应同时检查 is_open()。

(&MultiSelect) option_bounds

XuAPI
pub fn (multi &MultiSelect) option_bounds(index int) layout.Rect

用途

&MultiSelect 上的操作:执行 option bounds 操作。失败时抛出错误,调用方需处理或继续传播。

参数

multi &MultiSelect
本次调用使用的 MultiSelect 实例;以只读借用传入,调用方仍持有实例。
index int
index(int)

返回值

layout.Rect — 该类型的值

($&MultiSelect) input

XuAPI
pub fn (multi $&MultiSelect) input(event &ui.InputEvent) Action

用途

处理展开、多项勾选和已选标签交互,把用户选择写回控件状态。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.InputEvent
同一窗口、画布和代次的输入事件;坐标按控件所在的画布空间传入。

返回值

Action 描述本次交互:kind 是动作类型,consumed 表示事件是否已处理,request_focus 请求焦点,needs_paint 表示需要重绘。

使用时注意

  • 选项切换返回 ACTION_CHANGE,value 为发生变化的选项索引;读取 selected(index) 获取该项现在的勾选状态。

($&MultiSelect) route

XuAPI
pub fn (multi $&MultiSelect) route(kind int,event &ui.InputEvent) Action

用途

路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int
类型标签(int)
event &ui.InputEvent
event(只读借用,调用方仍持有原值;类型 &ui.InputEvent)

返回值

Action — 输入处理结果,包含 kind、id、重绘与焦点请求。

($&MultiSelect) event

XuAPI
pub fn (multi $&MultiSelect) event(event &ui.Event) Action

用途

接收窗口原生事件;输入事件转交 input,其余事件交给内部编辑器或基础控件处理。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event
窗口提供的完整 ui.Event;需要输入法、失焦和生命周期处理时使用这个入口。

返回值

Action 描述本次交互:kind 是动作类型,consumed 表示事件是否已处理,request_focus 请求焦点,needs_paint 表示需要重绘。

使用时注意

  • 内部失去焦点后会关闭下拉列表。

($&MultiSelect) measure_styled

XuAPI
pub fn (multi $&MultiSelect) measure_styled(styles &Styles) layout.Size

用途

$&MultiSelect 上的操作:执行 measure styled 操作。失败时抛出错误,调用方需处理或继续传播。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

layout.Size — 该类型的值

($&MultiSelect) paint_styled

XuAPI
pub fn (multi $&MultiSelect) paint_styled(frame $&draw.Frame,styles &Styles) int

用途

$&MultiSelect 上的操作:执行 paint styled 操作。失败时抛出错误,调用方需处理或继续传播。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame
frame(独占借用,可修改原值;类型 $&draw.Frame)
styles &Styles
styles(只读借用,调用方仍持有原值;类型 &Styles)

返回值

int — 该类型的值

($&MultiSelect) paint_popup_styled

XuAPI
pub fn (multi $&MultiSelect) paint_popup_styled(frame $&draw.Frame,styles &Styles) int

用途

绘制展开的选项列表;与输入框本体分开绘制,以便选项覆盖后面的控件。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame
当前绘制帧;本调用向其中记录绘制命令。
styles &Styles
当前生效的样式;提供颜色、间距、字体和状态外观。

返回值

成功返回 0;失败时抛错,不以非零返回码表示失败。

使用时注意

  • 在画布坐标空间中绘制,通常放在普通控件之后;不要沿用输入框内部的局部变换或裁剪,否则列表可能被截掉。

错误处理

  • 绘制帧、文字或样式操作失败时继续抛出错误。

($&MultiSelect) dispose

XuAPI
pub fn (multi $&MultiSelect) dispose()

用途

释放并清理对象所持有的系统原生资源与底层句柄。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。

返回值

不返回值。

($&MultiSelect) set_filter

XuAPI
pub fn (multi $&MultiSelect) set_filter(query &string) int

用途

$&MultiSelect 上的操作:设置 filter。失败时抛出错误,调用方需处理或继续传播。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
query &string
query(只读借用,调用方仍持有原值;类型 &string)

返回值

int — 该类型的值

($&MultiSelect) select_all

XuAPI
pub fn (multi $&MultiSelect) select_all(selected bool) int

用途

$&MultiSelect 上的操作:执行 select all 操作。失败时抛出错误,调用方需处理或继续传播。

参数

multi $&MultiSelect
本次调用使用的 MultiSelect 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selected bool
selected(bool)

返回值

int — 该类型的值

完整原生示例

Component Workshop · 返回 Widgets 目录