UI / WIDGETS / 操作
TaskButton
用按钮呈现任务执行状态
在演练场运行 Xu 示例 ↗示例由浏览器中的 Xu/WASM 运行器执行。
体验什么
开始任务,等待完成后重试。
使用要点
任务按钮需要区分未开始、执行中、成功与失败。实际任务由应用执行,控件的进度显示不会启动后台工作。
通过 Screen 创建
下面的 Screen 构造方法返回节点 ID。将 ID 交给 Screen 的布局、状态与事件接口;它不是下方独立控件类型的实例。
原生 Xu 创建片段:在已有 Screen 的初始化阶段调用 configure;窗口创建、事件循环与资源释放参见完整原生示例。
#ui/widgets
fn configure(screen $&widgets.Screen) int {
id := screen.task_button("Export") or >>
screen.place(id,24.0,24.0,320.0,80.0) or >>
<< id
}
($&Screen) task_button
pub fn (s $&Screen) task_button(label string) int
用途
在 Screen 中创建 TaskButton,返回组件节点 ID;创建失败时抛出错误。
参数
s $&Screen- 本次调用使用的
Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
label string- label(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 方法。
($&TaskButton) set_locale
pub fn (task $&TaskButton) set_locale(locale &Locale) int
用途
$&TaskButton 上的操作:设置 locale。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
locale &Locale- locale(只读借用,调用方仍持有原值;类型 &Locale)
返回值
int — 该类型的值
($&TaskButton) use_locale_labels
pub fn (task $&TaskButton) use_locale_labels() int
用途
$&TaskButton 上的操作:执行 use locale labels 操作。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
int — 该类型的值
(&TaskButton) label_text
pub fn (task &TaskButton) label_text() string
用途
&TaskButton 上的操作:执行 label text 操作。失败时抛出错误,调用方需处理或继续传播。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
string — 结果字符串
struct TaskButton
pub struct TaskButton {
}
用途
TaskButton 上下文或状态结构体。
公开字段
此类型没有公开字段。
(&TaskButton) id
pub fn (task &TaskButton) id() int
用途
返回当前控件、元素或节点的唯一标识 ID。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&TaskButton) bounds
pub fn (task &TaskButton) bounds() layout.Rect
用途
返回当前控件或几何对象的有效外接矩形边界(Rectangle)。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
layout.Rect — 该类型的值
(&TaskButton) state
pub fn (task &TaskButton) state() int
用途
在 &TaskButton 上执行 state 操作。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&TaskButton) task_id
pub fn (task &TaskButton) task_id() int
用途
&TaskButton 上的操作:执行 task id 操作。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&TaskButton) is_running
pub fn (task &TaskButton) is_running() bool
用途
&TaskButton 上的操作:判断是否 running。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&TaskButton) is_determinate
pub fn (task &TaskButton) is_determinate() bool
用途
&TaskButton 上的操作:判断是否 determinate。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&TaskButton) progress
pub fn (task &TaskButton) progress() f64
用途
在 &TaskButton 上执行 progress 操作。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
f64 — 该类型的值
(&TaskButton) is_enabled
pub fn (task &TaskButton) is_enabled() bool
用途
返回控件当前是否可用。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&TaskButton) is_selectable
pub fn (task &TaskButton) is_selectable() bool
用途
&TaskButton 上的操作:判断是否 selectable。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&TaskButton) set_selectable
pub fn (task $&TaskButton) set_selectable(selectable bool)
用途
$&TaskButton 上的操作:设置 selectable。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selectable bool- selectable(bool)
返回值
不返回值。
(&TaskButton) is_focused
pub fn (task &TaskButton) is_focused() bool
用途
返回控件当前是否拥有输入焦点。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&TaskButton) needs_paint
pub fn (task &TaskButton) needs_paint() bool
用途
返回控件是否需要重新绘制;绘制完成后调用 painted 清除标记。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&TaskButton) painted
pub fn (task $&TaskButton) painted()
用途
确认当前帧已绘制,清除重绘标记;不是状态查询。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&TaskButton) cancel
pub fn (task $&TaskButton) cancel()
用途
$&TaskButton 上的操作:取消。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&TaskButton) set_focus
pub fn (task $&TaskButton) set_focus(focused bool)
用途
$&TaskButton 上的操作:设置 focus。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
focused bool- focused(bool)
返回值
不返回值。
($&TaskButton) set_enabled
pub fn (task $&TaskButton) set_enabled(enabled bool)
用途
$&TaskButton 上的操作:设置 enabled。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool- enabled(bool)
返回值
不返回值。
($&TaskButton) set_bounds
pub fn (task $&TaskButton) set_bounds(bounds &layout.Rect) int
用途
$&TaskButton 上的操作:设置 bounds。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds &layout.Rect- bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
int — 该类型的值
($&TaskButton) set_style
pub fn (task $&TaskButton) set_style(style &ControlStyle) int
用途
$&TaskButton 上的操作:设置 style。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
style &ControlStyle- style(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
int — 该类型的值
($&TaskButton) set_motion
pub fn (task $&TaskButton) set_motion(spec &MotionSpec) int
用途
$&TaskButton 上的操作:设置 motion。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
spec &MotionSpec- spec(只读借用,调用方仍持有原值;类型 &MotionSpec)
返回值
int — 该类型的值
($&TaskButton) set_progress_mode
pub fn (task $&TaskButton) set_progress_mode(mode int) int
用途
$&TaskButton 上的操作:设置 progress mode。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
mode int- 模式(int)
返回值
int — 该类型的值
($&TaskButton) set_labels
pub fn (task $&TaskButton) set_labels(running &string,success &string,error &string,cancelled &string) int
用途
$&TaskButton 上的操作:设置 labels。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
running &string- running(只读借用,调用方仍持有原值;类型 &string)
success &string- success(只读借用,调用方仍持有原值;类型 &string)
error &string- error(只读借用,调用方仍持有原值;类型 &string)
cancelled &string- cancelled(只读借用,调用方仍持有原值;类型 &string)
返回值
int — 该类型的值
($&TaskButton) set_cancellable
pub fn (task $&TaskButton) set_cancellable(enabled bool)
用途
$&TaskButton 上的操作:设置 cancellable。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool- enabled(bool)
返回值
不返回值。
($&TaskButton) begin
pub fn (task $&TaskButton) begin(id int,now time.Instant) int
用途
在 $&TaskButton 上执行 begin 操作。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
id int- id(int)
now time.Instant- now(time.Instant)
返回值
int — 该类型的值
($&TaskButton) set_progress
pub fn (task $&TaskButton) set_progress(id int,value f64) bool
用途
$&TaskButton 上的操作:设置 progress。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
id int- id(int)
value f64- value(f64)
返回值
bool — 是否成立
($&TaskButton) complete
pub fn (task $&TaskButton) complete(id int,state int) bool
用途
在 $&TaskButton 上执行 complete 操作。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
id int- id(int)
state int- state(int)
返回值
bool — 是否成立
($&TaskButton) reset
pub fn (task $&TaskButton) reset() int
用途
$&TaskButton 上的操作:清空内部状态,可再写入或读取。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
int — 该类型的值
($&TaskButton) input
pub fn (task $&TaskButton) input(input &ui.InputEvent) Action
用途
接收并处理分发的鼠标、键盘或触摸交互输入事件。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
input &ui.InputEvent- input(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
($&TaskButton) route
pub fn (task $&TaskButton) route(kind int,input &ui.InputEvent) Action
用途
路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int- 类型标签(int)
input &ui.InputEvent- input(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
($&TaskButton) event
pub fn (task $&TaskButton) event(event &ui.Event) Action
用途
处理并响应窗口与系统的交互及生命周期事件。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event- event(只读借用,调用方仍持有原值;类型 &ui.Event)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
($&TaskButton) tick
pub fn (task $&TaskButton) tick(now time.Instant,reduced bool) bool
用途
推进动画时间戳与状态过渡动画步进。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now time.Instant- now(time.Instant)
reduced bool- reduced(bool)
返回值
bool — 是否成立
(&TaskButton) next_tick
pub fn (task &TaskButton) next_tick(now time.Instant) time.Instant
用途
&TaskButton 上的操作:执行 next tick 操作。失败时抛出错误,调用方需处理或继续传播。
参数
task &TaskButton- 本次调用使用的
TaskButton 实例;以只读借用传入,调用方仍持有实例。
now time.Instant- now(time.Instant)
返回值
time.Instant — 该类型的值
($&TaskButton) measure_styled
pub fn (task $&TaskButton) measure_styled(styles &Styles) layout.Size
用途
$&TaskButton 上的操作:执行 measure styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
layout.Size — 该类型的值
($&TaskButton) paint_styled
pub fn (task $&TaskButton) paint_styled(frame $&draw.Frame,styles &Styles) int
用途
$&TaskButton 上的操作:执行 paint styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
($&TaskButton) dispose
pub fn (task $&TaskButton) dispose()
用途
释放并清理对象所持有的系统原生资源与底层句柄。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&TaskButton) set_feedback
pub fn (task $&TaskButton) set_feedback(feedback &TaskFeedback) int
用途
$&TaskButton 上的操作:设置 feedback。失败时抛出错误,调用方需处理或继续传播。
参数
task $&TaskButton- 本次调用使用的
TaskButton 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
feedback &TaskFeedback- feedback(只读借用,调用方仍持有原值;类型 &TaskFeedback)
返回值
int — 该类型的值
完整原生示例
Component Workshop · 返回 Widgets 目录