UI / WIDGETS / 布局与容器
Scroll
让受限区域容纳更多内容
在演练场运行 Xu 示例 ↗示例由浏览器中的 Xu/WASM 运行器执行。
体验什么
滚动列表,保持页面其余部分不动。
使用要点
内容范围决定可滚动距离,视口决定裁剪范围。滚动内容中的子控件仍需使用正确的父节点与坐标。
通过 Screen 创建
下面的 Screen 构造方法返回节点 ID。将 ID 交给 Screen 的布局、状态与事件接口;它不是下方独立控件类型的实例。
原生 Xu 创建片段:在已有 Screen 的初始化阶段调用 configure;窗口创建、事件循环与资源释放参见完整原生示例。
#ui/widgets
fn configure(screen $&widgets.Screen) int {
id := screen.scroll_area(widgets.AXIS_VERTICAL,600.0) or >>
screen.place(id,24.0,24.0,320.0,80.0) or >>
<< id
}
($&Screen) scroll_area
pub fn (s $&Screen) scroll_area(axis int,content_extent f64) int
用途
在 Screen 中创建 Scroll,返回组件节点 ID;创建失败时抛出错误。
参数
s $&Screen- 本次调用使用的
Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
axis int- axis(int)
content_extent f64- content_extent(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 方法。
(&Scroll) clone
pub fn (value &Scroll) clone() Scroll
用途
复制控件或样式快照,返回独立的 Scroll 值。
参数
value &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
Scroll — 该类型的值
(&Scroll) axis
pub fn (scroll &Scroll) axis() int
用途
在 &Scroll 上执行 axis 操作。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Scroll) content_bounds
pub fn (scroll &Scroll) content_bounds() layout.Rect
用途
&Scroll 上的操作:执行 content bounds 操作。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
layout.Rect — 该类型的值
struct Scroll
用途
Scroll 上下文或状态结构体。
公开字段
此类型没有公开字段。
查看用法示例
(&Scroll) offset
pub fn (scroll &Scroll) offset() f64
用途
在 &Scroll 上执行 offset 操作。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
f64 — 该类型的值
(&Scroll) needs_paint
pub fn (scroll &Scroll) needs_paint() bool
用途
返回控件是否需要重新绘制;绘制完成后调用 painted 清除标记。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Scroll) painted
pub fn (scroll $&Scroll) painted()
用途
确认当前帧已绘制,清除重绘标记;不是状态查询。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&Scroll) set_focus
pub fn (scroll $&Scroll) set_focus(focused bool)
用途
$&Scroll 上的操作:设置 focus。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
focused bool- focused(bool)
返回值
不返回值。
($&Scroll) set_offset
pub fn (scroll $&Scroll) set_offset(offset f64) int
用途
$&Scroll 上的操作:设置 offset。失败时抛出错误,调用方需处理或继续传播。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
offset f64- 偏移(f64)
返回值
int — 该类型的值
($&Scroll) set_content_extent
pub fn (scroll $&Scroll) set_content_extent(extent f64) int
用途
$&Scroll 上的操作:设置 content extent。失败时抛出错误,调用方需处理或继续传播。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
extent f64- extent(f64)
返回值
int — 该类型的值
($&Scroll) set_bounds
pub fn (scroll $&Scroll) set_bounds(bounds &layout.Rect) int
用途
$&Scroll 上的操作:设置 bounds。失败时抛出错误,调用方需处理或继续传播。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
bounds &layout.Rect- bounds(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
int — 该类型的值
($&Scroll) input
pub fn (scroll $&Scroll) input(input &ui.InputEvent) Action
用途
接收并处理分发的鼠标、键盘或触摸交互输入事件。失败时抛出错误,调用方需处理或继续传播。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
input &ui.InputEvent- input(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
($&Scroll) event
pub fn (scroll $&Scroll) event(event &ui.Event) Action
用途
处理并响应窗口与系统的交互及生命周期事件。失败时抛出错误,调用方需处理或继续传播。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.Event- event(只读借用,调用方仍持有原值;类型 &ui.Event)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
(&Scroll) visible_items
pub fn (scroll &Scroll) visible_items(count int,item_extent f64,gap f64,overscan int) layout.VisibleRange
用途
&Scroll 上的操作:执行 visible items 操作。失败时抛出错误,调用方需处理或继续传播。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
count int- count(int)
item_extent f64- item_extent(f64)
gap f64- gap(f64)
overscan int- overscan(int)
返回值
layout.VisibleRange — 该类型的值
($&Scroll) layout_items
pub fn (scroll $&Scroll) layout_items(count int,item_extent f64,gap f64,overscan int) layout.VisibleRange
用途
$&Scroll 上的操作:执行 layout items 操作。失败时抛出错误,调用方需处理或继续传播。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
count int- count(int)
item_extent f64- item_extent(f64)
gap f64- gap(f64)
overscan int- overscan(int)
返回值
layout.VisibleRange — 该类型的值
(&Scroll) begin
pub fn (scroll &Scroll) begin(frame $&draw.Frame) int
用途
在 &Scroll 上执行 begin 操作。失败时抛出错误,调用方需处理或继续传播。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
返回值
int — 该类型的值
(&Scroll) end
pub fn (scroll &Scroll) end(frame $&draw.Frame) int
用途
在 &Scroll 上执行 end 操作。失败时抛出错误,调用方需处理或继续传播。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
返回值
int — 该类型的值
(&Scroll) is_enabled
pub fn (scroll &Scroll) is_enabled() bool
用途
返回控件当前是否可用。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Scroll) set_enabled
pub fn (scroll $&Scroll) set_enabled(enabled bool)
用途
$&Scroll 上的操作:设置 enabled。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool- enabled(bool)
返回值
不返回值。
(&Scroll) id
pub fn (scroll &Scroll) id() int
用途
返回当前控件、元素或节点的唯一标识 ID。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Scroll) bounds
pub fn (scroll &Scroll) bounds() layout.Rect
用途
返回当前控件或几何对象的有效外接矩形边界(Rectangle)。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
layout.Rect — 该类型的值
(&Scroll) is_focused
pub fn (scroll &Scroll) is_focused() bool
用途
返回控件当前是否拥有输入焦点。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Scroll) is_hovered
pub fn (scroll &Scroll) is_hovered() bool
用途
&Scroll 上的操作:判断是否 hovered。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Scroll) is_dragging
pub fn (scroll &Scroll) is_dragging() bool
用途
&Scroll 上的操作:判断是否 dragging。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Scroll) is_invalid
pub fn (scroll &Scroll) is_invalid() bool
用途
&Scroll 上的操作:判断是否 invalid。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Scroll) set_invalid
pub fn (scroll $&Scroll) set_invalid(invalid bool)
用途
$&Scroll 上的操作:设置 invalid。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
invalid bool- invalid(bool)
返回值
不返回值。
(&Scroll) visual_state
pub fn (scroll &Scroll) visual_state() int
用途
&Scroll 上的操作:执行 visual state 操作。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Scroll) has_style
pub fn (scroll &Scroll) has_style() bool
用途
&Scroll 上的操作:判断是否具有 style。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Scroll) style_or
pub fn (scroll &Scroll) style_or(styles &Styles) ControlStyle
用途
&Scroll 上的操作:执行 style or 操作。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
ControlStyle — 该类型的值
($&Scroll) set_style
pub fn (scroll $&Scroll) set_style(style &ControlStyle) int
用途
$&Scroll 上的操作:设置 style。失败时抛出错误,调用方需处理或继续传播。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
style &ControlStyle- style(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
int — 该类型的值
($&Scroll) clear_style
pub fn (scroll $&Scroll) clear_style()
用途
$&Scroll 上的操作:执行 clear style 操作。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&Scroll) apply_styles
pub fn (scroll $&Scroll) apply_styles(styles &Styles) int
用途
应用并验证主题;指标变化时更新布局 / 几何并标记重绘。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
成功为 0;失败抛出错误
($&Scroll) measure_styled
pub fn (scroll $&Scroll) measure_styled(styles &Styles) layout.Size
用途
$&Scroll 上的操作:执行 measure styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
layout.Size — 该类型的值
(&Scroll) scrollbar_track
pub fn (scroll &Scroll) scrollbar_track() layout.Rect
用途
返回与交互命中共用的滚动条轨道矩形。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
控件坐标系中的轨道
(&Scroll) scrollbar_thumb
pub fn (scroll &Scroll) scrollbar_thumb() layout.Rect
用途
返回按内容长度、偏移和最小滑块尺寸计算的矩形。
参数
scroll &Scroll- 本次调用使用的
Scroll 实例;以只读借用传入,调用方仍持有实例。
返回值
控件坐标系中的滑块
($&Scroll) paint_scrollbar
pub fn (scroll $&Scroll) paint_scrollbar(frame $&draw.Frame,styles &Styles) int
用途
绘制滚动条并清除其脏标记;在 overlay_styled 中于子内容之后调用。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
成功为 0;失败抛出错误
($&Scroll) route
pub fn (scroll $&Scroll) route(kind int,input &ui.InputEvent) Action
用途
路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。
参数
scroll $&Scroll- 本次调用使用的
Scroll 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int- 类型标签(int)
input &ui.InputEvent- input(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
完整原生示例
Component Workshop · 返回 Widgets 目录