UI / WIDGETS / 反馈与浮层
Popover
在锚点附近展示可操作内容
在演练场运行 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.popover(anchor,"Preferences") or >>
<< id
}
($&Screen) popover
pub fn (s $&Screen) popover(anchor int,text string) int
用途
在 Screen 中创建 Popover,返回组件节点 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 Popover
用途
气泡弹出浮层容器,锚定在指定界面元素周边。
公开字段
此类型没有公开字段。
(&Popover) id
pub fn (p &Popover) id() int
用途
返回当前控件、元素或节点的唯一标识 ID。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Popover) bounds
pub fn (p &Popover) bounds() layout.Rect
用途
返回当前控件或几何对象的有效外接矩形边界(Rectangle)。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
layout.Rect — 该类型的值
(&Popover) is_enabled
pub fn (p &Popover) is_enabled() bool
用途
返回控件当前是否可用。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Popover) is_selectable
pub fn (p &Popover) is_selectable() bool
用途
&Popover 上的操作:判断是否 selectable。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Popover) set_selectable
pub fn (p $&Popover) set_selectable(selectable bool)
用途
$&Popover 上的操作:设置 selectable。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
selectable bool- selectable(bool)
返回值
不返回值。
($&Popover) set_text
pub fn (p $&Popover) set_text(context &draw.Context,text &string) int
用途
$&Popover 上的操作:设置 text。失败时抛出错误,调用方需处理或继续传播。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
context &draw.Context- context(只读借用,调用方仍持有原值;类型 &draw.Context)
text &string- 文本(只读借用,调用方仍持有原值;类型 &string)
返回值
int — 该类型的值
(&Popover) selected_text
pub fn (p &Popover) selected_text() string
用途
&Popover 上的操作:执行 selected text 操作。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
string — 结果字符串
(&Popover) copy_selection
pub fn (p &Popover) copy_selection() int
用途
&Popover 上的操作:执行 copy selection 操作。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
(&Popover) selection_range
pub fn (p &Popover) selection_range() ui.TextRange
用途
&Popover 上的操作:执行 selection range 操作。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
ui.TextRange — 该类型的值
(&Popover) cursor
pub fn (p &Popover) cursor() int
用途
&Popover 上的操作:游标。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
int — 该类型的值
($&Popover) set_viewport
pub fn (p $&Popover) set_viewport(viewport &layout.Rect)
用途
$&Popover 上的操作:设置 viewport。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
viewport &layout.Rect- viewport(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
不返回值。
($&Popover) set_locale
pub fn (p $&Popover) set_locale(locale &Locale) int
用途
$&Popover 上的操作:设置 locale。失败时抛出错误,调用方需处理或继续传播。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
locale &Locale- locale(只读借用,调用方仍持有原值;类型 &Locale)
返回值
int — 该类型的值
(&Popover) is_open
pub fn (p &Popover) is_open() bool
用途
返回浮层、菜单或对话框当前是否打开。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
(&Popover) is_visible
pub fn (p &Popover) is_visible() bool
用途
判断弹出层是否仍需要绘制,包括正在退场的阶段。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
打开或仍有退场透明度时为 true;完全消失后为 false。
(&Popover) opacity
pub fn (p &Popover) opacity() f64
用途
在 &Popover 上执行 opacity 操作。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
f64 — 该类型的值
(&Popover) needs_paint
pub fn (p &Popover) needs_paint() bool
用途
返回控件是否需要重新绘制;绘制完成后调用 painted 清除标记。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
返回值
bool — 是否成立
($&Popover) painted
pub fn (p $&Popover) painted()
用途
确认当前帧已绘制,清除重绘标记;不是状态查询。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
($&Popover) set_geometry
pub fn (p $&Popover) set_geometry(anchor &layout.Rect,size &layout.Size,viewport &layout.Rect) int
用途
$&Popover 上的操作:设置 geometry。失败时抛出错误,调用方需处理或继续传播。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
anchor &layout.Rect- anchor(只读借用,调用方仍持有原值;类型 &layout.Rect)
size &layout.Size- size(只读借用,调用方仍持有原值;类型 &layout.Size)
viewport &layout.Rect- viewport(只读借用,调用方仍持有原值;类型 &layout.Rect)
返回值
int — 该类型的值
($&Popover) open
pub fn (p $&Popover) open(now time.Instant,reduced_motion bool) int
用途
打开弹出层并启动入场动画;禁用的弹出层保持关闭。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now time.Instant- 当前动画时间
time.Instant;打开、更新和关闭应使用同一时间基准。
reduced_motion bool- 是否减少动态效果;为
true 时直接到目标状态。
返回值
成功返回 0;失败时抛错,不以非零返回码表示失败。
使用时注意
- 每帧调用
tick 推进动画,用 is_visible 决定是否继续绘制。
错误处理
($&Popover) close
pub fn (p $&Popover) close(now time.Instant,reduced_motion bool) int
用途
请求关闭并启动退场动画;逻辑关闭之后可能还需要继续绘制几帧。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now time.Instant- 当前动画时间
time.Instant;打开、更新和关闭应使用同一时间基准。
reduced_motion bool- 是否减少动态效果;为
true 时直接到目标状态。
返回值
成功返回 0;失败时抛错,不以非零返回码表示失败。
使用时注意
is_open() 随关闭请求变为 false,is_visible() 在退场动画结束后才变为 false。
错误处理
($&Popover) set_enabled
pub fn (p $&Popover) set_enabled(enabled bool) int
用途
$&Popover 上的操作:设置 enabled。失败时抛出错误,调用方需处理或继续传播。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
enabled bool- enabled(bool)
返回值
int — 该类型的值
($&Popover) tick
pub fn (p $&Popover) tick(now time.Instant,reduced_motion bool) bool
用途
把淡入淡出动画推进到当前时间,用返回值决定是否安排重绘。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now time.Instant- 当前动画时间
time.Instant;打开、更新和关闭应使用同一时间基准。
reduced_motion bool- 是否减少动态效果;为
true 时直接到目标状态。
返回值
透明度发生变化时返回 true;没有变化返回 false。
错误处理
(&Popover) next_tick
pub fn (p &Popover) next_tick(now time.Instant) time.Instant
用途
&Popover 上的操作:执行 next tick 操作。失败时抛出错误,调用方需处理或继续传播。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
now time.Instant- now(time.Instant)
返回值
time.Instant — 该类型的值
($&Popover) input
pub fn (p $&Popover) input(event &ui.InputEvent) Action
用途
处理弹出层的外部点击、Escape 和取消输入,按关闭策略更新打开状态。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.InputEvent- 同一窗口、画布和代次的输入事件;坐标按控件所在的画布空间传入。
返回值
Action 描述本次交互:kind 是动作类型,consumed 表示事件是否已处理,request_focus 请求焦点,needs_paint 表示需要重绘。
使用时注意
- 锚点和面板内部的点击不会作为外部点击关闭;面板内容的业务交互由调用方继续分发。
($&Popover) route
pub fn (p $&Popover) route(kind int,event &ui.InputEvent) Action
用途
路由并分发交互事件至命中的子节点或处理器。失败时抛出错误,调用方需处理或继续传播。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
kind int- 类型标签(int)
event &ui.InputEvent- event(只读借用,调用方仍持有原值;类型 &ui.InputEvent)
返回值
Action — 输入处理结果,包含 kind、id、重绘与焦点请求。
(&Popover) paint_styled
pub fn (p &Popover) paint_styled(frame $&draw.Frame,styles &Styles) int
用途
绘制弹出面板的样式背景与边框。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame- 当前绘制帧;本调用向其中记录绘制命令。
styles &Styles- 当前生效的样式;提供颜色、间距、字体和状态外观。
返回值
成功返回 0;失败时抛错,不以非零返回码表示失败。
使用时注意
- 面板内容由调用方绘制;本调用不会自动创建、布局或分发内容控件。
错误处理
($&Popover) paint_content_styled
pub fn (p $&Popover) paint_content_styled(frame $&draw.Frame,styles &Styles) int
用途
$&Popover 上的操作:执行 paint content styled 操作。失败时抛出错误,调用方需处理或继续传播。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame $&draw.Frame- frame(独占借用,可修改原值;类型 $&draw.Frame)
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
int — 该类型的值
(&Popover) style_or
pub fn (p &Popover) style_or(styles &Styles) ControlStyle
用途
&Popover 上的操作:执行 style or 操作。
参数
p &Popover- 本次调用使用的
Popover 实例;以只读借用传入,调用方仍持有实例。
styles &Styles- styles(只读借用,调用方仍持有原值;类型 &Styles)
返回值
ControlStyle — 该类型的值
($&Popover) set_style
pub fn (p $&Popover) set_style(style &ControlStyle) int
用途
$&Popover 上的操作:设置 style。失败时抛出错误,调用方需处理或继续传播。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
style &ControlStyle- style(只读借用,调用方仍持有原值;类型 &ControlStyle)
返回值
int — 该类型的值
($&Popover) set_motion
pub fn (p $&Popover) set_motion(spec &MotionSpec) int
用途
$&Popover 上的操作:设置 motion。失败时抛出错误,调用方需处理或继续传播。
参数
p $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
spec &MotionSpec- spec(只读借用,调用方仍持有原值;类型 &MotionSpec)
返回值
int — 该类型的值
($&Popover) set_placement
pub fn (panel $&Popover) set_placement(placement &OverlayPlacement) int
用途
$&Popover 上的操作:设置 placement。失败时抛出错误,调用方需处理或继续传播。
参数
panel $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
placement &OverlayPlacement- placement(只读借用,调用方仍持有原值;类型 &OverlayPlacement)
返回值
int — 该类型的值
($&Popover) set_dismissal
pub fn (panel $&Popover) set_dismissal(outside bool,escape bool)
用途
$&Popover 上的操作:设置 dismissal。
参数
panel $&Popover- 本次调用使用的
Popover 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
outside bool- outside(bool)
escape bool- escape(bool)
返回值
不返回值。
完整原生示例
Component Workshop · 返回 Widgets 目录