XU XUv0.13.1
EN

UI / WIDGETS / 反馈与浮层

Progress

显示已完成的任务比例

在演练场运行 Xu 示例

示例由浏览器中的 Xu/WASM 运行器执行。

体验什么

点击按钮逐步增加进度,查看百分比。

使用要点

原生进度值使用 0 到 1,百分比显示由应用转换。已知进度使用 Progress,未知持续时间使用 Spinner。

通过 Screen 创建

下面的 Screen 构造方法返回节点 ID。将 ID 交给 Screen 的布局、状态与事件接口;它不是下方独立控件类型的实例。

原生 Xu 创建片段:在已有 Screen 的初始化阶段调用 configure;窗口创建、事件循环与资源释放参见完整原生示例。

#ui/widgets

fn configure(screen $&widgets.Screen) int {
    id := screen.progress(0.4) or >>
    screen.place(id,24.0,24.0,320.0,80.0) or >>
    << id
}

($&Screen) progress

XuAPI
pub fn (s $&Screen) progress(value f64) int

用途

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

参数

s $&Screen
本次调用使用的 Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
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 方法。

struct Progress

XuAPI
pub struct Progress {

}

用途

Progress 上下文或状态结构体。

公开字段

此类型没有公开字段。

查看用法示例

(&Progress) value

XuAPI
pub fn (progress &Progress) value() f64

用途

&Progress 上的操作:值。

参数

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

返回值

f64 — 该类型的值

(&Progress) needs_paint

XuAPI
pub fn (progress &Progress) needs_paint() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Progress) painted

XuAPI
pub fn (progress $&Progress) painted()

用途

确认当前帧已绘制,清除重绘标记;不是状态查询。

参数

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

返回值

不返回值。

(&Progress) is_selectable

XuAPI
pub fn (progress &Progress) is_selectable() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Progress) set_selectable

XuAPI
pub fn (progress $&Progress) set_selectable(selectable bool)

用途

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

参数

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

返回值

不返回值。

($&Progress) set_value

XuAPI
pub fn (progress $&Progress) set_value(value f64) int

用途

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

参数

progress $&Progress
本次调用使用的 Progress 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value f64
value(f64)

返回值

int — 该类型的值

($&Progress) set_bounds

XuAPI
pub fn (progress $&Progress) set_bounds(bounds &layout.Rect) int

用途

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

参数

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

返回值

int — 该类型的值

(&Progress) paint

XuAPI
pub fn (progress &Progress) paint(frame $&draw.Frame,theme &Theme) int

用途

在目标画布或渲染目标上执行控件的视觉绘制。失败时抛出错误,调用方需处理或继续传播。

参数

progress &Progress
本次调用使用的 Progress 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame
frame(独占借用,可修改原值;类型 $&draw.Frame)
theme &Theme
theme(只读借用,调用方仍持有原值;类型 &Theme)

返回值

int — 该类型的值

(&Progress) clone

XuAPI
pub fn (value &Progress) clone() Progress

用途

复制控件或样式快照,返回独立的 Progress 值。

参数

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

返回值

Progress — 该类型的值

(&Progress) bounds

XuAPI
pub fn (progress &Progress) bounds() layout.Rect

用途

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

参数

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

返回值

layout.Rect — 该类型的值

(&Progress) is_enabled

XuAPI
pub fn (progress &Progress) is_enabled() bool

用途

返回控件当前是否可用。

参数

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

返回值

bool — 是否成立

(&Progress) is_invalid

XuAPI
pub fn (progress &Progress) is_invalid() bool

用途

&Progress 上的操作:判断是否 invalid。

参数

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

返回值

bool — 是否成立

(&Progress) is_focused

XuAPI
pub fn (progress &Progress) is_focused() bool

用途

返回控件当前是否拥有输入焦点。

参数

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

返回值

bool — 是否成立

(&Progress) is_selected

XuAPI
pub fn (progress &Progress) is_selected() bool

用途

&Progress 上的操作:判断是否 selected。

参数

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

返回值

bool — 是否成立

($&Progress) set_focus

XuAPI
pub fn (progress $&Progress) set_focus(focused bool)

用途

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

参数

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

返回值

不返回值。

($&Progress) set_selected

XuAPI
pub fn (progress $&Progress) set_selected(selected bool)

用途

$&Progress 上的操作:设置 selected。

参数

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

返回值

不返回值。

(&Progress) visual_state

XuAPI
pub fn (progress &Progress) visual_state() int

用途

&Progress 上的操作:执行 visual state 操作。

参数

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

返回值

int — 该类型的值

(&Progress) has_style

XuAPI
pub fn (progress &Progress) has_style() bool

用途

&Progress 上的操作:判断是否具有 style。

参数

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

返回值

bool — 是否成立

(&Progress) style_or

XuAPI
pub fn (progress &Progress) style_or(styles &Styles) ControlStyle

用途

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

参数

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

返回值

ControlStyle — 该类型的值

($&Progress) set_style

XuAPI
pub fn (progress $&Progress) set_style(style &ControlStyle) int

用途

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

参数

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

返回值

int — 该类型的值

($&Progress) clear_style

XuAPI
pub fn (progress $&Progress) clear_style()

用途

$&Progress 上的操作:执行 clear style 操作。

参数

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

返回值

不返回值。

(&Progress) measure_styled

XuAPI
pub fn (progress &Progress) measure_styled(styles &Styles) layout.Size

用途

&Progress 上的操作:执行 measure styled 操作。

参数

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

返回值

layout.Size — 该类型的值

(&Progress) paint_styled

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

用途

使用当前完整主题绘制Progress;控件边界与 Frame 使用相同的局部坐标。

参数

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

返回值

成功为 0;失败抛出错误

($&Progress) set_enabled

XuAPI
pub fn (progress $&Progress) set_enabled(enabled bool)

用途

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

参数

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

返回值

不返回值。

($&Progress) set_invalid

XuAPI
pub fn (progress $&Progress) set_invalid(invalid bool)

用途

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

参数

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

返回值

不返回值。

($&Progress) set_buffer

XuAPI
pub fn (progress $&Progress) set_buffer(value f64) int

用途

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

参数

progress $&Progress
本次调用使用的 Progress 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
value f64
value(f64)

返回值

int — 该类型的值

完整原生示例

Component Workshop · 返回 Widgets 目录