XU XUv0.13.1
EN

UI / WIDGETS / 文本与标记

Badge

为内容补充数量或状态

在演练场运行 Xu 示例

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

体验什么

点击按钮增加徽标数字。

使用要点

数量、状态点与状态文字是不同用途。徽标应依附于它说明的内容,并保留文字或其他可访问的状态说明。

通过 Screen 创建

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

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

#ui/widgets

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

($&Screen) badge

XuAPI
pub fn (s $&Screen) badge(text string) int

用途

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

参数

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

(&Badge) variant

XuAPI
pub fn (badge &Badge) variant() int

用途

在 &Badge 上执行 variant 操作。

参数

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

返回值

int — 该类型的值

($&Badge) set_variant

XuAPI
pub fn (badge $&Badge) set_variant(variant int) int

用途

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

参数

badge $&Badge
本次调用使用的 Badge 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
variant int
variant(int)

返回值

int — 该类型的值

(&Badge) clone

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

用途

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

参数

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

返回值

Badge — 该类型的值

struct Badge

XuAPI
pub struct Badge {

}

用途

Badge 上下文或状态结构体。

公开字段

此类型没有公开字段。

查看用法示例

(&Badge) is_selectable

XuAPI
pub fn (bg &Badge) is_selectable() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Badge) set_selectable

XuAPI
pub fn (bg $&Badge) set_selectable(selectable bool)

用途

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

参数

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

返回值

不返回值。

(&Badge) bounds

XuAPI
pub fn (bg &Badge) bounds() layout.Rect

用途

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

参数

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

返回值

layout.Rect — 该类型的值

($&Badge) set_bounds

XuAPI
pub fn (bg $&Badge) set_bounds(bounds &layout.Rect) int

用途

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

参数

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

返回值

int — 该类型的值

(&Badge) needs_paint

XuAPI
pub fn (bg &Badge) needs_paint() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Badge) painted

XuAPI
pub fn (bg $&Badge) painted()

用途

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

参数

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

返回值

不返回值。

($&Badge) invalidate

XuAPI
pub fn (bg $&Badge) invalidate()

用途

标记控件区域为脏,请求系统在下一帧重新绘制。

参数

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

返回值

不返回值。

(&Badge) is_enabled

XuAPI
pub fn (bg &Badge) is_enabled() bool

用途

返回控件当前是否可用。

参数

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

返回值

bool — 是否成立

($&Badge) set_enabled

XuAPI
pub fn (bg $&Badge) set_enabled(enabled bool)

用途

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

参数

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

返回值

不返回值。

(&Badge) is_selected

XuAPI
pub fn (bg &Badge) is_selected() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Badge) set_selected

XuAPI
pub fn (bg $&Badge) set_selected(selected bool)

用途

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

参数

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

返回值

不返回值。

(&Badge) is_invalid

XuAPI
pub fn (bg &Badge) is_invalid() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Badge) set_invalid

XuAPI
pub fn (bg $&Badge) set_invalid(invalid bool)

用途

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

参数

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

返回值

不返回值。

(&Badge) is_focused

XuAPI
pub fn (bg &Badge) is_focused() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Badge) set_focus

XuAPI
pub fn (bg $&Badge) set_focus(focused bool)

用途

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

参数

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

返回值

不返回值。

(&Badge) is_hovered

XuAPI
pub fn (bg &Badge) is_hovered() bool

用途

&Badge 上的操作:判断是否 hovered。

参数

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

返回值

bool — 是否成立

($&Badge) set_hovered

XuAPI
pub fn (bg $&Badge) set_hovered(hovered bool)

用途

$&Badge 上的操作:设置 hovered。

参数

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

返回值

不返回值。

(&Badge) visual_state

XuAPI
pub fn (bg &Badge) visual_state() int

用途

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

参数

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

返回值

int — 该类型的值

(&Badge) has_style

XuAPI
pub fn (bg &Badge) has_style() bool

用途

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

参数

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

返回值

bool — 是否成立

(&Badge) style_or

XuAPI
pub fn (bg &Badge) style_or(styles &Styles) ControlStyle

用途

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

参数

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

返回值

ControlStyle — 该类型的值

($&Badge) set_style

XuAPI
pub fn (bg $&Badge) set_style(style &ControlStyle) int

用途

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

参数

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

返回值

int — 该类型的值

($&Badge) clear_style

XuAPI
pub fn (bg $&Badge) clear_style()

用途

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

参数

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

返回值

不返回值。

(&Badge) paint

XuAPI
pub fn (bg &Badge) paint(frame $&draw.Frame,label &draw.TextLayout,theme &Theme) int

用途

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

参数

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

返回值

int — 该类型的值

(&Badge) measure_styled

XuAPI
pub fn (bg &Badge) measure_styled(label $&StyledLabel,styles &Styles) layout.Size

用途

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

参数

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

返回值

layout.Size — 该类型的值

(&Badge) paint_styled

XuAPI
pub fn (bg &Badge) paint_styled(frame $&draw.Frame,label $&StyledLabel,styles &Styles) int

用途

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

参数

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

返回值

int — 该类型的值

($&Badge) set_tone

XuAPI
pub fn (bg $&Badge) set_tone(tone int) int

用途

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

参数

bg $&Badge
本次调用使用的 Badge 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
tone int
tone(int)

返回值

int — 该类型的值

完整原生示例

Component Workshop · 返回 Widgets 目录