XU XUv0.13.1
EN

UI / WIDGETS / 反馈与浮层

Spinner

表示尚不能确定进度的等待

在演练场运行 Xu 示例

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

体验什么

开始或暂停加载动画。

使用要点

只表达正在等待,不承诺完成比例。配合文字说明正在进行的工作,并在工作结束或取消后停止。

通过 Screen 创建

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

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

#ui/widgets

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

($&Screen) spinner

XuAPI
pub fn (s $&Screen) spinner() int

用途

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

参数

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

返回值

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 Spinner

XuAPI
pub struct Spinner {

}

用途

Spinner 上下文或状态结构体。

公开字段

此类型没有公开字段。

(&Spinner) is_running

XuAPI
pub fn (spinner &Spinner) is_running() bool

用途

&Spinner 上的操作:判断是否 running。

参数

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

返回值

bool — 是否成立

(&Spinner) needs_paint

XuAPI
pub fn (spinner &Spinner) needs_paint() bool

用途

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

参数

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

返回值

bool — 是否成立

(&Spinner) bounds

XuAPI
pub fn (spinner &Spinner) bounds() layout.Rect

用途

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

参数

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

返回值

layout.Rect — 该类型的值

($&Spinner) set_bounds

XuAPI
pub fn (spinner $&Spinner) set_bounds(bounds &layout.Rect) int

用途

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

参数

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

返回值

int — 该类型的值

($&Spinner) set_running

XuAPI
pub fn (spinner $&Spinner) set_running(running bool)

用途

$&Spinner 上的操作:设置 running。

参数

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

返回值

不返回值。

($&Spinner) set_enabled

XuAPI
pub fn (spinner $&Spinner) set_enabled(enabled bool)

用途

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

参数

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

返回值

不返回值。

($&Spinner) set_style

XuAPI
pub fn (spinner $&Spinner) set_style(style &ControlStyle) int

用途

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

参数

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

返回值

int — 该类型的值

(&Spinner) style_or

XuAPI
pub fn (spinner &Spinner) style_or(styles &Styles) ControlStyle

用途

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

参数

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

返回值

ControlStyle — 该类型的值

($&Spinner) tick

XuAPI
pub fn (spinner $&Spinner) tick(now time.Instant,reduced_motion bool) bool

用途

推进动画时间戳与状态过渡动画步进。失败时抛出错误,调用方需处理或继续传播。

参数

spinner $&Spinner
本次调用使用的 Spinner 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now time.Instant
now(time.Instant)
reduced_motion bool
reduced_motion(bool)

返回值

bool — 是否成立

(&Spinner) next_tick

XuAPI
pub fn (spinner &Spinner) next_tick(now time.Instant,reduced_motion bool) time.Instant

用途

&Spinner 上的操作:执行 next tick 操作。失败时抛出错误,调用方需处理或继续传播。

参数

spinner &Spinner
本次调用使用的 Spinner 实例;以只读借用传入,调用方仍持有实例。
now time.Instant
now(time.Instant)
reduced_motion bool
reduced_motion(bool)

返回值

time.Instant — 该类型的值

(&Spinner) measure_styled

XuAPI
pub fn (spinner &Spinner) measure_styled(styles &Styles) layout.Size

用途

&Spinner 上的操作:执行 measure styled 操作。失败时抛出错误,调用方需处理或继续传播。

参数

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

返回值

layout.Size — 该类型的值

($&Spinner) paint_styled

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

用途

$&Spinner 上的操作:执行 paint styled 操作。失败时抛出错误,调用方需处理或继续传播。

参数

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

返回值

int — 该类型的值

($&Spinner) set_appearance

XuAPI
pub fn (spinner $&Spinner) set_appearance(diameter f64,thickness f64,period time.Duration) int

用途

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

参数

spinner $&Spinner
本次调用使用的 Spinner 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
diameter f64
diameter(f64)
thickness f64
thickness(f64)
period time.Duration
period(time.Duration)

返回值

int — 该类型的值

完整原生示例

Component Workshop · 返回 Widgets 目录