UI / WIDGETS / 操作
ButtonGroup
将相关操作或选择组合成一组
在演练场运行 Xu 示例 ↗示例由浏览器中的 Xu/WASM 运行器执行。
体验什么
切换分组按钮,查看当前选项。
使用要点
根据用途选择独立操作、单选或多选模式。选项使用稳定的 key,显示标签变化不应改变其业务身份。
通过 Screen 创建
下面的 Screen 构造方法返回节点 ID。将 ID 交给 Screen 的布局、状态与事件接口;它不是下方独立控件类型的实例。
原生 Xu 创建片段:在已有 Screen 的初始化阶段调用 configure;窗口创建、事件循环与资源释放参见完整原生示例。
#ui/widgets
fn configure(screen $&widgets.Screen) int {
items := [widgets.button_group_item(1,"Save"),widgets.button_group_item(2,"Export")]
id := screen.button_group(&items,widgets.BUTTON_GROUP_SINGLE) or >>
screen.place(id,24.0,24.0,320.0,80.0) or >>
<< id
}
($&Screen) button_group
pub fn (s $&Screen) button_group(items &[]ButtonGroupItem,mode int) int
用途
在 Screen 中创建 ButtonGroup,返回组件节点 ID;创建失败时抛出错误。
参数
s $&Screen- 本次调用使用的
Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
items &[]ButtonGroupItem- 元素列表(只读借用,调用方仍持有原值;类型 &[]ButtonGroupItem)
mode int- 模式(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 方法。
struct ButtonGroup
pub struct ButtonGroup {
}
用途
ButtonGroup 上下文或状态结构体。
公开字段
此类型没有公开字段。
(&ButtonGroup) id
pub fn (g &ButtonGroup) id() int
用途
返回当前控件、元素或节点的唯一标识 ID。
参数
g &ButtonGroup- 本次调用使用的
ButtonGroup 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&ButtonGroup) bounds
pub fn (g &ButtonGroup) bounds() layout.Rect
用途
返回当前控件或几何对象的有效外接矩形边界(Rectangle)。
参数
g &ButtonGroup- 本次调用使用的
ButtonGroup 实例;以只读借用传入,调用方仍持有实例。
返回值
layout.Rect — 该类型的值
(&ButtonGroup) needs_paint
pub fn (g &ButtonGroup) needs_paint() bool
用途
返回控件是否需要重新绘制;绘制完成后调用 painted 清除标记。
参数
g &ButtonGroup- 本次调用使用的
ButtonGroup 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&ButtonGroup) painted
pub fn (g $&ButtonGroup) painted()
用途
确认当前帧已绘制,清除重绘标记;不是状态查询。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
(&ButtonGroup) is_enabled
pub fn (g &ButtonGroup) is_enabled() bool
用途
返回控件当前是否可用。
参数
g &ButtonGroup- 本次调用使用的
ButtonGroup 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&ButtonGroup) is_selectable
pub fn (g &ButtonGroup) is_selectable() bool
用途
&ButtonGroup 上的操作:判断是否 selectable。
参数
g &ButtonGroup- 本次调用使用的
ButtonGroup 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&ButtonGroup) set_selectable
pub fn (g $&ButtonGroup) set_selectable(selectable bool)
用途
$&ButtonGroup 上的操作:设置 selectable。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selectable bool- selectable(bool)
返回值
不返回值。
(&ButtonGroup) is_focused
pub fn (g &ButtonGroup) is_focused() bool
用途
返回控件当前是否拥有输入焦点。
参数
g &ButtonGroup- 本次调用使用的
ButtonGroup 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&ButtonGroup) active_key
pub fn (g &ButtonGroup) active_key() int
用途
&ButtonGroup 上的操作:执行 active key 操作。
参数
g &ButtonGroup- 本次调用使用的
ButtonGroup 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&ButtonGroup) values
pub fn (g &ButtonGroup) values() []int
用途
返回当前集合、参数表或映射中所有值的切片。
参数
g &ButtonGroup- 本次调用使用的
ButtonGroup 实例;以只读借用传入,调用方仍持有实例。
返回值
[]int — 切片结果
($&ButtonGroup) set_items
pub fn (g $&ButtonGroup) set_items(items &[]ButtonGroupItem) int
用途
$&ButtonGroup 上的操作:设置 items。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
items &[]ButtonGroupItem- 元素列表(只读借用,调用方仍持有原值;类型 &[]ButtonGroupItem)
返回值
int — 该类型的值
($&ButtonGroup) set_appearance
pub fn (g $&ButtonGroup) set_appearance(a &ButtonGroupAppearance) int
用途
$&ButtonGroup 上的操作:设置 appearance。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
a &ButtonGroupAppearance- 值(只读借用,调用方仍持有原值;类型 &ButtonGroupAppearance)
返回值
int — 该类型的值
($&ButtonGroup) set_item_enabled
pub fn (g $&ButtonGroup) set_item_enabled(key int,enabled bool) int
用途
$&ButtonGroup 上的操作:设置 item enabled。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
key int- 键(int)
enabled bool- enabled(bool)
返回值
int — 该类型的值
($&ButtonGroup) set_item_label
pub fn (g $&ButtonGroup) set_item_label(key int,label string) int
用途
$&ButtonGroup 上的操作:设置 item label。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
key int- 键(int)
label string- label(string)
返回值
int — 该类型的值
($&ButtonGroup) set_checked
pub fn (g $&ButtonGroup) set_checked(key int,selected bool) int
用途
$&ButtonGroup 上的操作:设置 checked。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
key int- 键(int)
selected bool- selected(bool)
返回值
int — 该类型的值
($&ButtonGroup) set_focus
pub fn (g $&ButtonGroup) set_focus(value bool)
用途
$&ButtonGroup 上的操作:设置 focus。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value bool- value(bool)
返回值
不返回值。
($&ButtonGroup) cancel
pub fn (g $&ButtonGroup) cancel()
用途
$&ButtonGroup 上的操作:取消。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&ButtonGroup) set_enabled
pub fn (g $&ButtonGroup) set_enabled(value bool)
用途
$&ButtonGroup 上的操作:设置 enabled。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value bool- value(bool)
返回值
不返回值。
($&ButtonGroup) set_read_only
pub fn (g $&ButtonGroup) set_read_only(value bool)
用途
$&ButtonGroup 上的操作:设置 read only。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value bool- value(bool)
返回值
不返回值。
($&ButtonGroup) set_bounds
pub fn (g $&ButtonGroup) set_bounds(bounds &layout.Rect) int
用途
$&ButtonGroup 上的操作:设置 bounds。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds &layout.Rect- bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
int — 该类型的值
($&ButtonGroup) set_style
pub fn (g $&ButtonGroup) set_style(style &ControlStyle) int
用途
$&ButtonGroup 上的操作:设置 style。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
style &ControlStyle- style(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
int — 该类型的值
($&ButtonGroup) clear_style
pub fn (g $&ButtonGroup) clear_style()
用途
$&ButtonGroup 上的操作:执行 clear style 操作。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&ButtonGroup) set_motion
pub fn (g $&ButtonGroup) set_motion(spec &MotionSpec) int
用途
$&ButtonGroup 上的操作:设置 motion。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
spec &MotionSpec- spec(只读借用,调用方仍持有原值;类型 &MotionSpec)
返回值
int — 该类型的值
($&ButtonGroup) apply_styles
pub fn (g $&ButtonGroup) apply_styles(styles &Styles) int
用途
根据当前主题样式表解析并应用几何与视觉度量。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
(&ButtonGroup) item_bounds
pub fn (g &ButtonGroup) item_bounds(key int) layout.Rect
用途
&ButtonGroup 上的操作:执行 item bounds 操作。失败时抛出错误,调用方需处理或继续传播。
参数
g &ButtonGroup- 本次调用使用的
ButtonGroup 实例;以只读借用传入,调用方仍持有实例。
key int- 键(int)
返回值
layout.Rect — 该类型的值
($&ButtonGroup) input
pub fn (g $&ButtonGroup) input(event &ui.InputEvent) Action
用途
接收并处理分发的鼠标、键盘或触摸交互输入事件。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.InputEvent- event(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
($&ButtonGroup) route
pub fn (g $&ButtonGroup) route(kind int,event &ui.InputEvent) Action
用途
路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int- 类型标签(int)
event &ui.InputEvent- event(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
($&ButtonGroup) tick
pub fn (g $&ButtonGroup) tick(styles &Styles,now time.Instant,reduced bool) bool
用途
推进动画时间戳与状态过渡动画步进。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
now time.Instant- now(time.Instant)
reduced bool- reduced(bool)
返回值
bool — 是否成立
(&ButtonGroup) next_tick
pub fn (g &ButtonGroup) next_tick(now time.Instant) time.Instant
用途
&ButtonGroup 上的操作:执行 next tick 操作。失败时抛出错误,调用方需处理或继续传播。
参数
g &ButtonGroup- 本次调用使用的
ButtonGroup 实例;以只读借用传入,调用方仍持有实例。
now time.Instant- now(time.Instant)
返回值
time.Instant — 该类型的值
($&ButtonGroup) paint_styled
pub fn (g $&ButtonGroup) paint_styled(frame $&draw.Frame,styles &Styles) int
用途
$&ButtonGroup 上的操作:执行 paint styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
($&ButtonGroup) dispose
pub fn (g $&ButtonGroup) dispose()
用途
释放并清理对象所持有的系统原生资源与底层句柄。
参数
g $&ButtonGroup- 本次调用使用的
ButtonGroup 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
完整原生示例
Component Workshop · 返回 Widgets 目录