UI / WIDGETS / 选择与调节
Slider
在连续区间内调节数值
在演练场运行 Xu 示例 ↗示例由浏览器中的 Xu/WASM 运行器执行。
体验什么
拖动滑块,或聚焦后按方向键,查看当前数值。
使用要点
创建时提供最小值、最大值与当前值。按业务设置步长,并说明拖动时更新还是完成后提交。
通过 Screen 创建
下面的 Screen 构造方法返回节点 ID。将 ID 交给 Screen 的布局、状态与事件接口;它不是下方独立控件类型的实例。
原生 Xu 创建片段:在已有 Screen 的初始化阶段调用 configure;窗口创建、事件循环与资源释放参见完整原生示例。
#ui/widgets
fn configure(screen $&widgets.Screen) int {
id := screen.slider(0.0,100.0,40.0) or >>
screen.place(id,24.0,24.0,320.0,80.0) or >>
<< id
}
($&Screen) slider
pub fn (s $&Screen) slider(minimum f64,maximum f64,value f64) int
用途
在 Screen 中创建 Slider,返回组件节点 ID;创建失败时抛出错误。
参数
s $&Screen- 本次调用使用的
Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
minimum f64- minimum(f64)
maximum f64- maximum(f64)
value f64- value(f64)
返回值
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 方法。
(&Slider) clone
pub fn (value &Slider) clone() Slider
用途
复制控件或样式快照,返回独立的 Slider 值。
参数
value &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
Slider — 该类型的值
($&Slider) set_locale
pub fn (slider $&Slider) set_locale(locale &Locale) int
用途
$&Slider 上的操作:设置 locale。失败时抛出错误,调用方需处理或继续传播。
参数
slider $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
locale &Locale- locale(只读借用,调用方仍持有原值;类型 &Locale)
返回值
int — 该类型的值
struct Slider
用途
Slider 上下文或状态结构体。
公开字段
此类型没有公开字段。
查看用法示例
(&Slider) id
pub fn (s &Slider) id() int
用途
返回当前控件、元素或节点的唯一标识 ID。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Slider) is_selectable
pub fn (s &Slider) is_selectable() bool
用途
&Slider 上的操作:判断是否 selectable。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Slider) set_selectable
pub fn (s $&Slider) set_selectable(selectable bool)
用途
$&Slider 上的操作:设置 selectable。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selectable bool- selectable(bool)
返回值
不返回值。
(&Slider) bounds
pub fn (s &Slider) bounds() layout.Rect
用途
返回当前控件或几何对象的有效外接矩形边界(Rectangle)。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
layout.Rect — 该类型的值
(&Slider) value
pub fn (s &Slider) value() f64
用途
&Slider 上的操作:值。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
f64 — 该类型的值
(&Slider) min
pub fn (s &Slider) min() f64
用途
&Slider 上的操作:返回两数值中的较小值。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
f64 — 该类型的值
(&Slider) max
pub fn (s &Slider) max() f64
用途
&Slider 上的操作:返回两数值中的较大值。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
f64 — 该类型的值
(&Slider) step
pub fn (s &Slider) step() f64
用途
在 &Slider 上执行 step 操作。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
f64 — 该类型的值
(&Slider) ratio
pub fn (s &Slider) ratio() f64
用途
在 &Slider 上执行 ratio 操作。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
f64 — 该类型的值
(&Slider) needs_paint
pub fn (s &Slider) needs_paint() bool
用途
返回控件是否需要重新绘制;绘制完成后调用 painted 清除标记。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Slider) painted
pub fn (s $&Slider) painted()
用途
确认当前帧已绘制,清除重绘标记;不是状态查询。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&Slider) invalidate
pub fn (s $&Slider) invalidate()
用途
标记控件区域为脏,请求系统在下一帧重新绘制。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&Slider) cancel
pub fn (s $&Slider) cancel()
用途
$&Slider 上的操作:取消。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
(&Slider) is_enabled
pub fn (s &Slider) is_enabled() bool
用途
返回控件当前是否可用。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Slider) set_enabled
pub fn (s $&Slider) set_enabled(enabled bool)
用途
$&Slider 上的操作:设置 enabled。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool- enabled(bool)
返回值
不返回值。
(&Slider) is_focused
pub fn (s &Slider) is_focused() bool
用途
返回控件当前是否拥有输入焦点。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Slider) set_focus
pub fn (s $&Slider) set_focus(focused bool)
用途
$&Slider 上的操作:设置 focus。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
focused bool- focused(bool)
返回值
不返回值。
(&Slider) is_hovered
pub fn (s &Slider) is_hovered() bool
用途
&Slider 上的操作:判断是否 hovered。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Slider) is_dragging
pub fn (s &Slider) is_dragging() bool
用途
&Slider 上的操作:判断是否 dragging。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Slider) is_invalid
pub fn (s &Slider) is_invalid() bool
用途
&Slider 上的操作:判断是否 invalid。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Slider) set_invalid
pub fn (s $&Slider) set_invalid(invalid bool)
用途
$&Slider 上的操作:设置 invalid。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
invalid bool- invalid(bool)
返回值
不返回值。
(&Slider) is_read_only
pub fn (s &Slider) is_read_only() bool
用途
&Slider 上的操作:判断是否 read only。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Slider) set_read_only
pub fn (s $&Slider) set_read_only(read_only bool)
用途
$&Slider 上的操作:设置 read only。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
read_only bool- read_only(bool)
返回值
不返回值。
($&Slider) set_value
pub fn (s $&Slider) set_value(value f64) int
用途
设置滑块数值,按已配置范围和步长约束结果。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value f64- 有限浮点数;超出范围会被限制到端点,并按步长对齐。
返回值
成功返回 0;失败时抛错,不以非零返回码表示失败。
错误处理
NaN 或无穷值抛出 widgets: invalid slider value。
($&Slider) set_range
pub fn (s $&Slider) set_range(min f64,max f64) int
用途
$&Slider 上的操作:设置 range。失败时抛出错误,调用方需处理或继续传播。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
min f64- 下限(f64)
max f64- 上限(f64)
返回值
int — 该类型的值
($&Slider) set_step
pub fn (s $&Slider) set_step(step f64) int
用途
$&Slider 上的操作:设置 step。失败时抛出错误,调用方需处理或继续传播。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
step f64- step(f64)
返回值
int — 该类型的值
($&Slider) set_bounds
pub fn (s $&Slider) set_bounds(bounds &layout.Rect) int
用途
$&Slider 上的操作:设置 bounds。失败时抛出错误,调用方需处理或继续传播。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds &layout.Rect- bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
int — 该类型的值
(&Slider) visual_state
pub fn (s &Slider) visual_state() int
用途
&Slider 上的操作:执行 visual state 操作。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Slider) has_style
pub fn (s &Slider) has_style() bool
用途
&Slider 上的操作:判断是否具有 style。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Slider) style_or
pub fn (s &Slider) style_or(styles &Styles) ControlStyle
用途
&Slider 上的操作:执行 style or 操作。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
ControlStyle — 该类型的值
($&Slider) set_style
pub fn (s $&Slider) set_style(style &ControlStyle) int
用途
$&Slider 上的操作:设置 style。失败时抛出错误,调用方需处理或继续传播。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
style &ControlStyle- style(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
int — 该类型的值
($&Slider) clear_style
pub fn (s $&Slider) clear_style()
用途
$&Slider 上的操作:执行 clear style 操作。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&Slider) input
pub fn (s $&Slider) input(input &ui.InputEvent) Action
用途
处理拖动和键盘调节,在连续变化和最终提交之间区分动作类型。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
input &ui.InputEvent- 同一窗口、画布和代次的输入事件;坐标按控件所在的画布空间传入。
返回值
Action 描述本次交互:kind 是动作类型,consumed 表示事件是否已处理,request_focus 请求焦点,needs_paint 表示需要重绘。
使用时注意
ACTION_CHANGE 表示连续变化,ACTION_COMMIT 表示一次已改变数值的交互完成;value 是当前数值。启用 set_commit_only 后不发送连续变化。
($&Slider) event
pub fn (s $&Slider) event(event &ui.Event) Action
用途
处理并响应窗口与系统的交互及生命周期事件。失败时抛出错误,调用方需处理或继续传播。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event- event(只读借用,调用方仍持有原值;类型 &ui.Event)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
(&Slider) paint
pub fn (s &Slider) paint(frame $&draw.Frame,theme &Theme) int
用途
在目标画布或渲染目标上执行控件的视觉绘制。失败时抛出错误,调用方需处理或继续传播。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
theme &Theme- theme(只读借用,调用方仍持有原值;类型 &Theme)
返回值
int — 该类型的值
(&Slider) measure_styled
pub fn (s &Slider) measure_styled(styles &Styles) layout.Size
用途
&Slider 上的操作:执行 measure styled 操作。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
layout.Size — 该类型的值
(&Slider) paint_styled
pub fn (s &Slider) paint_styled(frame $&draw.Frame,styles &Styles) int
用途
&Slider 上的操作:执行 paint styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
($&Slider) set_commit_only
pub fn (s $&Slider) set_commit_only(enabled bool)
用途
选择只在一次调节结束时发出提交动作,适合变化处理较昂贵的业务。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool- 为
true 时抑制拖动中的 ACTION_CHANGE,保留结束时的 ACTION_COMMIT。
返回值
不返回值;设置时会清除当前待提交标记。
使用时注意
- 拖动时控件内部数值仍更新并重绘;调用方把昂贵操作放到提交动作中处理。
($&Slider) apply_styles
pub fn (s $&Slider) apply_styles(styles &Styles) int
用途
根据当前主题样式表解析并应用几何与视觉度量。失败时抛出错误,调用方需处理或继续传播。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
($&Slider) set_appearance
pub fn (s $&Slider) set_appearance(appearance &SliderAppearance) int
用途
$&Slider 上的操作:设置 appearance。失败时抛出错误,调用方需处理或继续传播。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
appearance &SliderAppearance- appearance(只读借用,调用方仍持有原值;类型 &SliderAppearance)
返回值
int — 该类型的值
(&Slider) shows_value
pub fn (s &Slider) shows_value() bool
用途
&Slider 上的操作:执行 shows value 操作。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Slider) value_text
pub fn (s &Slider) value_text() string
用途
&Slider 上的操作:值文本。失败时抛出错误,调用方需处理或继续传播。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
返回值
string — 结果字符串
(&Slider) paint_value_styled
pub fn (s &Slider) paint_value_styled(frame $&draw.Frame,label $&StyledLabel,styles &Styles) int
用途
&Slider 上的操作:执行 paint value styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
s &Slider- 本次调用使用的
Slider 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
label $&StyledLabel- label(独占借用,可修改原值;类型 $&StyledLabel)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
($&Slider) route
pub fn (s $&Slider) route(kind int,input &ui.InputEvent) Action
用途
路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。
参数
s $&Slider- 本次调用使用的
Slider 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int- 类型标签(int)
input &ui.InputEvent- input(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
完整原生示例
Component Workshop · 返回 Widgets 目录