XU XUv0.13.1
EN

UI / WIDGETS / 导航

Breadcrumbs

显示当前位置并返回上级

在演练场运行 Xu 示例

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

体验什么

点击路径段,查看触发的层级编号。

使用要点

展示从根到当前位置的路径。祖先可以返回,当前页应明确区分,长路径需要合理折叠或裁剪。

通过 Screen 创建

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

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

#ui/widgets

fn configure(screen $&widgets.Screen) int {
    options := ["Design","Develop","Review"]
    id := screen.breadcrumbs(&options) or >>
    screen.place(id,24.0,24.0,320.0,80.0) or >>
    << id
}

($&Screen) breadcrumbs

XuAPI
pub fn (s $&Screen) breadcrumbs(items &[]string) int

用途

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

参数

s $&Screen
本次调用使用的 Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
items &[]string
元素列表(只读借用,调用方仍持有原值;类型 &[]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 方法。

(&Breadcrumbs) overflow_bounds

XuAPI
pub fn (crumbs &Breadcrumbs) overflow_bounds() layout.Rect

用途

&Breadcrumbs 上的操作:执行 overflow bounds 操作。

参数

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

返回值

layout.Rect — 该类型的值

(&Breadcrumbs) popup_bounds

XuAPI
pub fn (crumbs &Breadcrumbs) popup_bounds() layout.Rect

用途

&Breadcrumbs 上的操作:执行 popup bounds 操作。

参数

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

返回值

layout.Rect — 该类型的值

($&Breadcrumbs) set_popup_above

XuAPI
pub fn (crumbs $&Breadcrumbs) set_popup_above(above bool)

用途

$&Breadcrumbs 上的操作:设置 popup above。

参数

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

返回值

不返回值。

($&Breadcrumbs) paint_popup_styled

XuAPI
pub fn (crumbs $&Breadcrumbs) paint_popup_styled(frame $&draw.Frame,styles &Styles) int

用途

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

参数

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

返回值

int — 该类型的值

struct Breadcrumbs

XuAPI
pub struct Breadcrumbs {

}

用途

面包屑路径层级导航控件,指示当前界面位置与层级跳转。

公开字段

此类型没有公开字段。

(&Breadcrumbs) id

XuAPI
pub fn (crumbs &Breadcrumbs) id() int

用途

返回当前控件、元素或节点的唯一标识 ID。

参数

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

返回值

int — 该类型的值

(&Breadcrumbs) bounds

XuAPI
pub fn (crumbs &Breadcrumbs) bounds() layout.Rect

用途

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

参数

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

返回值

layout.Rect — 该类型的值

(&Breadcrumbs) count

XuAPI
pub fn (crumbs &Breadcrumbs) count() int

用途

返回该控件当前包含的项目数量。

参数

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

返回值

int — 该类型的值

(&Breadcrumbs) is_selectable

XuAPI
pub fn (crumbs &Breadcrumbs) is_selectable() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Breadcrumbs) set_selectable

XuAPI
pub fn (crumbs $&Breadcrumbs) set_selectable(selectable bool)

用途

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

参数

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

返回值

不返回值。

(&Breadcrumbs) needs_paint

XuAPI
pub fn (crumbs &Breadcrumbs) needs_paint() bool

用途

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

参数

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

返回值

bool — 是否成立

(&Breadcrumbs) visual_state

XuAPI
pub fn (crumbs &Breadcrumbs) visual_state() int

用途

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

参数

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

返回值

int — 该类型的值

(&Breadcrumbs) style_or

XuAPI
pub fn (crumbs &Breadcrumbs) style_or(styles &Styles) ControlStyle

用途

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

参数

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

返回值

ControlStyle — 该类型的值

($&Breadcrumbs) set_style

XuAPI
pub fn (crumbs $&Breadcrumbs) set_style(style &ControlStyle) int

用途

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

参数

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

返回值

int — 该类型的值

($&Breadcrumbs) set_enabled

XuAPI
pub fn (crumbs $&Breadcrumbs) set_enabled(enabled bool)

用途

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

参数

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

返回值

不返回值。

($&Breadcrumbs) set_read_only

XuAPI
pub fn (crumbs $&Breadcrumbs) set_read_only(read_only bool) int

用途

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

参数

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

返回值

int — 该类型的值

($&Breadcrumbs) set_bounds

XuAPI
pub fn (crumbs $&Breadcrumbs) set_bounds(bounds &layout.Rect) int

用途

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

参数

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

返回值

int — 该类型的值

($&Breadcrumbs) set_focus

XuAPI
pub fn (crumbs $&Breadcrumbs) set_focus(focused bool)

用途

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

参数

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

返回值

不返回值。

($&Breadcrumbs) set_text

XuAPI
pub fn (crumbs $&Breadcrumbs) set_text(index int,text &string) int

用途

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

参数

crumbs $&Breadcrumbs
本次调用使用的 Breadcrumbs 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
index int
index(int)
text &string
文本(只读借用,调用方仍持有原值;类型 &string)

返回值

int — 该类型的值

($&Breadcrumbs) apply_styles

XuAPI
pub fn (crumbs $&Breadcrumbs) apply_styles(styles &Styles) int

用途

根据当前主题样式表解析并应用几何与视觉度量。失败时抛出错误,调用方需处理或继续传播。

参数

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

返回值

int — 该类型的值

($&Breadcrumbs) measure_styled

XuAPI
pub fn (crumbs $&Breadcrumbs) measure_styled(styles &Styles) layout.Size

用途

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

参数

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

返回值

layout.Size — 该类型的值

(&Breadcrumbs) item_bounds

XuAPI
pub fn (crumbs &Breadcrumbs) item_bounds(index int) layout.Rect

用途

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

参数

crumbs &Breadcrumbs
本次调用使用的 Breadcrumbs 实例;以只读借用传入,调用方仍持有实例。
index int
index(int)

返回值

layout.Rect — 该类型的值

(&Breadcrumbs) cursor_at

XuAPI
pub fn (crumbs &Breadcrumbs) cursor_at(x f64,y f64) int

用途

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

参数

crumbs &Breadcrumbs
本次调用使用的 Breadcrumbs 实例;以只读借用传入,调用方仍持有实例。
x f64
值(f64)
y f64
值(f64)

返回值

int — 该类型的值

($&Breadcrumbs) input

XuAPI
pub fn (crumbs $&Breadcrumbs) input(event &ui.InputEvent) Action

用途

接收并处理分发的鼠标、键盘或触摸交互输入事件。失败时抛出错误,调用方需处理或继续传播。

参数

crumbs $&Breadcrumbs
本次调用使用的 Breadcrumbs 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.InputEvent
event(只读借用,调用方仍持有原值;类型 &ui.InputEvent)

返回值

Action — 输入处理结果,包含 kind、id、重绘与焦点请求。

($&Breadcrumbs) route

XuAPI
pub fn (crumbs $&Breadcrumbs) route(kind int,event &ui.InputEvent) Action

用途

路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。

参数

crumbs $&Breadcrumbs
本次调用使用的 Breadcrumbs 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int
类型标签(int)
event &ui.InputEvent
event(只读借用,调用方仍持有原值;类型 &ui.InputEvent)

返回值

Action — 输入处理结果,包含 kind、id、重绘与焦点请求。

($&Breadcrumbs) paint_styled

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

用途

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

参数

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

返回值

int — 该类型的值

($&Breadcrumbs) dispose

XuAPI
pub fn (crumbs $&Breadcrumbs) dispose()

用途

释放并清理对象所持有的系统原生资源与底层句柄。

参数

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

返回值

不返回值。

完整原生示例

Component Workshop · 返回 Widgets 目录