XU XUv0.13.1
EN

UI / WIDGETS / 反馈与浮层

Tooltip

为锚点补充简短说明

在演练场运行 Xu 示例

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

体验什么

悬停或聚焦帮助按钮。

使用要点

补充说明而不承载必须执行的操作。鼠标悬停与键盘焦点都应能触达提示,重要信息不能只存在于提示中。

通过 Screen 创建

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

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

#ui/widgets

fn configure(screen $&widgets.Screen) int {
    anchor := screen.button("Preferences") or >>
    screen.place(anchor,24.0,24.0,180.0,40.0) or >>
    id := screen.tooltip(anchor,"Project name") or >>
    << id
}

($&Screen) tooltip

XuAPI
pub fn (s $&Screen) tooltip(anchor int,text string) int

用途

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

参数

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

struct Tooltip

XuAPI
pub struct Tooltip {

}

用途

浮动提示框控件,跟随鼠标悬停显示补充说明。

公开字段

此类型没有公开字段。

(&Tooltip) id

XuAPI
pub fn (t &Tooltip) id() int

用途

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

参数

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

返回值

int — 该类型的值

(&Tooltip) bounds

XuAPI
pub fn (t &Tooltip) bounds() layout.Rect

用途

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

参数

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

返回值

layout.Rect — 该类型的值

(&Tooltip) is_enabled

XuAPI
pub fn (t &Tooltip) is_enabled() bool

用途

返回控件当前是否可用。

参数

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

返回值

bool — 是否成立

(&Tooltip) is_selectable

XuAPI
pub fn (t &Tooltip) is_selectable() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Tooltip) set_selectable

XuAPI
pub fn (t $&Tooltip) set_selectable(selectable bool)

用途

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

参数

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

返回值

不返回值。

($&Tooltip) set_text

XuAPI
pub fn (t $&Tooltip) set_text(context &draw.Context,text &string) int

用途

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

参数

t $&Tooltip
本次调用使用的 Tooltip 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
context &draw.Context
context(只读借用,调用方仍持有原值;类型 &draw.Context)
text &string
文本(只读借用,调用方仍持有原值;类型 &string)

返回值

int — 该类型的值

(&Tooltip) has_popup_open

XuAPI
pub fn (t &Tooltip) has_popup_open() bool

用途

&Tooltip 上的操作:判断是否具有 popup open。

参数

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

返回值

bool — 是否成立

(&Tooltip) popup_bounds

XuAPI
pub fn (t &Tooltip) popup_bounds() layout.Rect

用途

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

参数

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

返回值

layout.Rect — 该类型的值

(&Tooltip) selected_text

XuAPI
pub fn (t &Tooltip) selected_text() string

用途

&Tooltip 上的操作:执行 selected text 操作。

参数

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

返回值

string — 结果字符串

(&Tooltip) copy_selection

XuAPI
pub fn (t &Tooltip) copy_selection() int

用途

&Tooltip 上的操作:执行 copy selection 操作。

参数

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

返回值

int — 该类型的值

(&Tooltip) cursor

XuAPI
pub fn (t &Tooltip) cursor() int

用途

&Tooltip 上的操作:游标。

参数

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

返回值

int — 该类型的值

($&Tooltip) set_viewport

XuAPI
pub fn (t $&Tooltip) set_viewport(viewport &layout.Rect)

用途

$&Tooltip 上的操作:设置 viewport。

参数

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

返回值

不返回值。

($&Tooltip) set_locale

XuAPI
pub fn (t $&Tooltip) set_locale(locale &Locale) int

用途

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

参数

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

返回值

int — 该类型的值

(&Tooltip) is_open

XuAPI
pub fn (t &Tooltip) is_open() bool

用途

返回浮层、菜单或对话框当前是否打开。

参数

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

返回值

bool — 是否成立

(&Tooltip) is_visible

XuAPI
pub fn (t &Tooltip) is_visible() bool

用途

&Tooltip 上的操作:判断是否 visible。

参数

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

返回值

bool — 是否成立

(&Tooltip) opacity

XuAPI
pub fn (t &Tooltip) opacity() f64

用途

在 &Tooltip 上执行 opacity 操作。

参数

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

返回值

f64 — 该类型的值

(&Tooltip) needs_paint

XuAPI
pub fn (t &Tooltip) needs_paint() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Tooltip) painted

XuAPI
pub fn (t $&Tooltip) painted()

用途

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

参数

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

返回值

不返回值。

($&Tooltip) set_delay

XuAPI
pub fn (t $&Tooltip) set_delay(delay time.Duration) int

用途

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

参数

t $&Tooltip
本次调用使用的 Tooltip 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
delay time.Duration
delay(time.Duration)

返回值

int — 该类型的值

($&Tooltip) set_geometry

XuAPI
pub fn (t $&Tooltip) set_geometry(anchor &layout.Rect,size &layout.Size,viewport &layout.Rect) int

用途

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

参数

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

返回值

int — 该类型的值

($&Tooltip) set_placement

XuAPI
pub fn (t $&Tooltip) set_placement(placement &OverlayPlacement) int

用途

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

参数

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

返回值

int — 该类型的值

($&Tooltip) set_enabled

XuAPI
pub fn (t $&Tooltip) set_enabled(enabled bool) int

用途

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

参数

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

返回值

int — 该类型的值

($&Tooltip) set_blocked

XuAPI
pub fn (t $&Tooltip) set_blocked(blocked bool,now time.Instant) int

用途

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

参数

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

返回值

int — 该类型的值

($&Tooltip) set_focus

XuAPI
pub fn (t $&Tooltip) set_focus(focused bool,now time.Instant) int

用途

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

参数

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

返回值

int — 该类型的值

($&Tooltip) dismiss

XuAPI
pub fn (t $&Tooltip) dismiss(now time.Instant,reduced_motion bool) int

用途

在 $&Tooltip 上执行 dismiss 操作。失败时抛出错误,调用方需处理或继续传播。

参数

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

返回值

int — 该类型的值

($&Tooltip) input

XuAPI
pub fn (t $&Tooltip) input(event &ui.InputEvent) Action

用途

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

参数

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

返回值

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

($&Tooltip) route

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

用途

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

参数

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

返回值

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

($&Tooltip) tick

XuAPI
pub fn (t $&Tooltip) tick(now time.Instant,reduced_motion bool) bool

用途

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

参数

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

返回值

bool — 是否成立

(&Tooltip) next_tick

XuAPI
pub fn (t &Tooltip) next_tick(now time.Instant) time.Instant

用途

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

参数

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

返回值

time.Instant — 该类型的值

(&Tooltip) paint_styled

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

用途

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

参数

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

返回值

int — 该类型的值

($&Tooltip) paint_content_styled

XuAPI
pub fn (t $&Tooltip) paint_content_styled(frame $&draw.Frame,styles &Styles) int

用途

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

参数

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

返回值

int — 该类型的值

($&Tooltip) paint_popup_styled

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

用途

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

参数

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

返回值

int — 该类型的值

($&Tooltip) set_style

XuAPI
pub fn (t $&Tooltip) set_style(style &ControlStyle) int

用途

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

参数

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

返回值

int — 该类型的值

($&Tooltip) set_motion

XuAPI
pub fn (t $&Tooltip) set_motion(spec &MotionSpec) int

用途

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

参数

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

返回值

int — 该类型的值

完整原生示例

Component Workshop · 返回 Widgets 目录