UI / WIDGETS / 选择与调节
Checkbox
独立切换一个选项
在演练场运行 Xu 示例 ↗示例由浏览器中的 Xu/WASM 运行器执行。
体验什么
勾选复选框,查看布尔值的变化。
使用要点
用于独立布尔选项,可提供混合状态。值变化与操作激活不同;一组互斥选择使用 RadioGroup。
通过 Screen 创建
下面的 Screen 构造方法返回节点 ID。将 ID 交给 Screen 的布局、状态与事件接口;它不是下方独立控件类型的实例。
原生 Xu 创建片段:在已有 Screen 的初始化阶段调用 configure;窗口创建、事件循环与资源释放参见完整原生示例。
#ui/widgets
fn configure(screen $&widgets.Screen) int {
id := screen.checkbox("Receive updates",false) or >>
screen.place(id,24.0,24.0,320.0,80.0) or >>
<< id
}
($&Screen) checkbox
pub fn (s $&Screen) checkbox(text string,checked bool) int
用途
在 Screen 中创建 Checkbox,返回组件节点 ID;创建失败时抛出错误。
参数
s $&Screen- 本次调用使用的
Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
text string- 文本(string)
checked bool- checked(bool)
返回值
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 Checkbox
用途
Checkbox 上下文或状态结构体。
公开字段
此类型没有公开字段。
查看用法示例
($&Checkbox) set_focus
pub fn (checkbox $&Checkbox) set_focus(focused bool)
用途
$&Checkbox 上的操作:设置 focus。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
focused bool- focused(bool)
返回值
不返回值。
($&Checkbox) set_enabled
pub fn (checkbox $&Checkbox) set_enabled(enabled bool)
用途
$&Checkbox 上的操作:设置 enabled。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool- enabled(bool)
返回值
不返回值。
($&Checkbox) set_bounds
pub fn (checkbox $&Checkbox) set_bounds(bounds &layout.Rect) int
用途
$&Checkbox 上的操作:设置 bounds。失败时抛出错误,调用方需处理或继续传播。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds &layout.Rect- bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
int — 该类型的值
(&Checkbox) needs_paint
pub fn (checkbox &Checkbox) needs_paint() bool
用途
返回控件是否需要重新绘制;绘制完成后调用 painted 清除标记。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Checkbox) painted
pub fn (checkbox $&Checkbox) painted()
用途
确认当前帧已绘制,清除重绘标记;不是状态查询。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
(&Checkbox) is_selectable
pub fn (checkbox &Checkbox) is_selectable() bool
用途
&Checkbox 上的操作:判断是否 selectable。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Checkbox) set_selectable
pub fn (checkbox $&Checkbox) set_selectable(selectable bool)
用途
$&Checkbox 上的操作:设置 selectable。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selectable bool- selectable(bool)
返回值
不返回值。
(&Checkbox) value
pub fn (checkbox &Checkbox) value() bool
用途
&Checkbox 上的操作:值。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Checkbox) is_indeterminate
pub fn (checkbox &Checkbox) is_indeterminate() bool
用途
&Checkbox 上的操作:判断是否 indeterminate。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Checkbox) set_indeterminate
pub fn (checkbox $&Checkbox) set_indeterminate(mixed bool)
用途
$&Checkbox 上的操作:设置 indeterminate。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
mixed bool- mixed(bool)
返回值
不返回值。
($&Checkbox) set_value
pub fn (checkbox $&Checkbox) set_value(checked bool)
用途
设置复选框的勾选状态,并清除不确定状态,适合用业务数据更新控件。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
checked bool- 要显示的勾选状态。
返回值
不返回值;状态改变时会标记需要重绘,不生成用户输入动作。
($&Checkbox) input
pub fn (checkbox $&Checkbox) input(input &ui.InputEvent) Action
用途
处理复选框交互,并在用户激活时更新勾选状态。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
input &ui.InputEvent- 同一窗口、画布和代次的输入事件;坐标按控件所在的画布空间传入。
返回值
Action 描述本次交互:kind 是动作类型,consumed 表示事件是否已处理,request_focus 请求焦点,needs_paint 表示需要重绘。
使用时注意
- 改变时返回
ACTION_CHANGE,value 为 1.0(勾选)或 0.0(未勾选);不确定状态首次激活后变为勾选。
($&Checkbox) event
pub fn (checkbox $&Checkbox) event(event &ui.Event) Action
用途
处理并响应窗口与系统的交互及生命周期事件。失败时抛出错误,调用方需处理或继续传播。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event- event(只读借用,调用方仍持有原值;类型 &ui.Event)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
(&Checkbox) paint
pub fn (checkbox &Checkbox) paint(frame $&draw.Frame,label &draw.TextLayout,theme &Theme) int
用途
在目标画布或渲染目标上执行控件的视觉绘制。失败时抛出错误,调用方需处理或继续传播。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
label &draw.TextLayout- label(只读借用,调用方仍持有原值;类型 &draw.TextLayout)
theme &Theme- theme(只读借用,调用方仍持有原值;类型 &Theme)
返回值
int — 该类型的值
(&Checkbox) clone
pub fn (c &Checkbox) clone() Checkbox
用途
复制控件或样式快照,返回独立的 Checkbox 值。
参数
c &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
Checkbox — 该类型的值
($&Checkbox) set_motion
pub fn (control $&Checkbox) set_motion(spec &MotionSpec) int
用途
$&Checkbox 上的操作:设置 motion。失败时抛出错误,调用方需处理或继续传播。
参数
control $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
spec &MotionSpec- spec(只读借用,调用方仍持有原值;类型 &MotionSpec)
返回值
int — 该类型的值
($&Checkbox) tick
pub fn (control $&Checkbox) tick(now time.Instant,reduced bool) bool
用途
推进动画时间戳与状态过渡动画步进。失败时抛出错误,调用方需处理或继续传播。
参数
control $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now time.Instant- now(time.Instant)
reduced bool- reduced(bool)
返回值
bool — 是否成立
(&Checkbox) next_tick
pub fn (control &Checkbox) next_tick(now time.Instant) time.Instant
用途
&Checkbox 上的操作:执行 next tick 操作。失败时抛出错误,调用方需处理或继续传播。
参数
control &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
now time.Instant- now(time.Instant)
返回值
time.Instant — 该类型的值
(&Checkbox) id
pub fn (checkbox &Checkbox) id() int
用途
返回当前控件、元素或节点的唯一标识 ID。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Checkbox) bounds
pub fn (checkbox &Checkbox) bounds() layout.Rect
用途
返回当前控件或几何对象的有效外接矩形边界(Rectangle)。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
layout.Rect — 该类型的值
(&Checkbox) is_focused
pub fn (checkbox &Checkbox) is_focused() bool
用途
返回控件当前是否拥有输入焦点。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Checkbox) is_enabled
pub fn (checkbox &Checkbox) is_enabled() bool
用途
返回控件当前是否可用。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Checkbox) is_invalid
pub fn (checkbox &Checkbox) is_invalid() bool
用途
&Checkbox 上的操作:判断是否 invalid。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Checkbox) is_read_only
pub fn (checkbox &Checkbox) is_read_only() bool
用途
&Checkbox 上的操作:判断是否 read only。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Checkbox) set_read_only
pub fn (checkbox $&Checkbox) set_read_only(read_only bool)
用途
$&Checkbox 上的操作:设置 read only。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
read_only bool- read_only(bool)
返回值
不返回值。
(&Checkbox) visual_state
pub fn (checkbox &Checkbox) visual_state() int
用途
&Checkbox 上的操作:执行 visual state 操作。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Checkbox) has_style
pub fn (checkbox &Checkbox) has_style() bool
用途
&Checkbox 上的操作:判断是否具有 style。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Checkbox) style_or
pub fn (checkbox &Checkbox) style_or(styles &Styles) ControlStyle
用途
&Checkbox 上的操作:执行 style or 操作。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
ControlStyle — 该类型的值
($&Checkbox) set_style
pub fn (checkbox $&Checkbox) set_style(style &ControlStyle) int
用途
$&Checkbox 上的操作:设置 style。失败时抛出错误,调用方需处理或继续传播。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
style &ControlStyle- style(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
int — 该类型的值
($&Checkbox) clear_style
pub fn (checkbox $&Checkbox) clear_style()
用途
$&Checkbox 上的操作:执行 clear style 操作。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
(&Checkbox) measure_styled
pub fn (checkbox &Checkbox) measure_styled(label $&StyledLabel,styles &Styles) layout.Size
用途
按有效字体、密度、内容和最小尺寸测量Checkbox。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
label $&StyledLabel- label(独占借用,可修改原值;类型 $&StyledLabel)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
固有逻辑尺寸;原生排版失败时抛出错误
(&Checkbox) paint_styled
pub fn (checkbox &Checkbox) paint_styled(frame $&draw.Frame,label $&StyledLabel,styles &Styles) int
用途
使用当前完整主题绘制Checkbox;控件边界与 Frame 使用相同的局部坐标。
参数
checkbox &Checkbox- 本次调用使用的
Checkbox 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
label $&StyledLabel- label(独占借用,可修改原值;类型 $&StyledLabel)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
成功为 0;失败抛出错误
($&Checkbox) set_invalid
pub fn (checkbox $&Checkbox) set_invalid(invalid bool)
用途
$&Checkbox 上的操作:设置 invalid。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
invalid bool- invalid(bool)
返回值
不返回值。
($&Checkbox) route
pub fn (checkbox $&Checkbox) route(kind int,input &ui.InputEvent) Action
用途
路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。
参数
checkbox $&Checkbox- 本次调用使用的
Checkbox 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int- 类型标签(int)
input &ui.InputEvent- input(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
完整原生示例
Component Workshop · 返回 Widgets 目录