XU XUv0.13.1
EN

UI / WIDGETS / 反馈与浮层

Modal

在独立对话框中完成当前决策

在演练场运行 Xu 示例

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

体验什么

打开确认框,分别取消与确认。

使用要点

模态期间将交互限制在对话框,关闭后将焦点返回触发位置。确认、取消及关闭需要明确的业务含义。

通过 Screen 创建

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

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

#ui/widgets

fn configure(screen $&widgets.Screen) int {
    id := screen.modal("Apply changes?","Review before confirming.") or >>
    << id
}

($&Screen) modal

XuAPI
pub fn (s $&Screen) modal(title string,message string) int

用途

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

参数

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

XuAPI
pub struct Modal {

}

用途

模态弹窗遮罩对话框,独占用户交互与键盘焦点。

公开字段

此类型没有公开字段。

(&Modal) id

XuAPI
pub fn (m &Modal) id() int

用途

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

参数

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

返回值

int — 该类型的值

(&Modal) bounds

XuAPI
pub fn (m &Modal) bounds() layout.Rect

用途

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

参数

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

返回值

layout.Rect — 该类型的值

(&Modal) is_enabled

XuAPI
pub fn (m &Modal) is_enabled() bool

用途

返回控件当前是否可用。

参数

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

返回值

bool — 是否成立

(&Modal) is_selectable

XuAPI
pub fn (m &Modal) is_selectable() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Modal) set_selectable

XuAPI
pub fn (m $&Modal) set_selectable(selectable bool)

用途

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

参数

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

返回值

不返回值。

($&Modal) set_text

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

用途

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

参数

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

返回值

int — 该类型的值

(&Modal) has_popup_open

XuAPI
pub fn (m &Modal) has_popup_open() bool

用途

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

参数

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

返回值

bool — 是否成立

(&Modal) popup_bounds

XuAPI
pub fn (m &Modal) popup_bounds() layout.Rect

用途

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

参数

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

返回值

layout.Rect — 该类型的值

(&Modal) selected_text

XuAPI
pub fn (m &Modal) selected_text() string

用途

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

参数

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

返回值

string — 结果字符串

(&Modal) copy_selection

XuAPI
pub fn (m &Modal) copy_selection() int

用途

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

参数

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

返回值

int — 该类型的值

(&Modal) cursor

XuAPI
pub fn (m &Modal) cursor() int

用途

&Modal 上的操作:游标。

参数

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

返回值

int — 该类型的值

($&Modal) set_locale

XuAPI
pub fn (m $&Modal) set_locale(locale &Locale) int

用途

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

参数

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

返回值

int — 该类型的值

(&Modal) is_open

XuAPI
pub fn (m &Modal) is_open() bool

用途

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

参数

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

返回值

bool — 是否成立

(&Modal) is_visible

XuAPI
pub fn (m &Modal) is_visible() bool

用途

判断模态层是否仍需要绘制,包括正在退场的阶段。

参数

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

返回值

打开或仍有退场透明度时为 true;完全消失后为 false。

(&Modal) blocks_input

XuAPI
pub fn (m &Modal) blocks_input() bool

用途

&Modal 上的操作:执行 blocks input 操作。

参数

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

返回值

bool — 是否成立

(&Modal) opacity

XuAPI
pub fn (m &Modal) opacity() f64

用途

在 &Modal 上执行 opacity 操作。

参数

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

返回值

f64 — 该类型的值

(&Modal) needs_paint

XuAPI
pub fn (m &Modal) needs_paint() bool

用途

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

参数

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

返回值

bool — 是否成立

($&Modal) painted

XuAPI
pub fn (m $&Modal) painted()

用途

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

参数

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

返回值

不返回值。

($&Modal) set_dismiss_on_outside

XuAPI
pub fn (m $&Modal) set_dismiss_on_outside(enabled bool)

用途

$&Modal 上的操作:设置 dismiss on outside。

参数

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

返回值

不返回值。

(&Modal) focused_id

XuAPI
pub fn (m &Modal) focused_id() int

用途

&Modal 上的操作:执行 focused id 操作。

参数

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

返回值

int — 该类型的值

(&Modal) focus_restore_id

XuAPI
pub fn (m &Modal) focus_restore_id() int

用途

&Modal 上的操作:执行 focus restore id 操作。

参数

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

返回值

int — 该类型的值

($&Modal) take_restore_focus

XuAPI
pub fn (m $&Modal) take_restore_focus() int

用途

在模态层完全关闭后,取出一次性的焦点恢复目标并交给窗口焦点逻辑处理。

参数

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

返回值

待恢复的控件 ID;仍可见或没有待处理恢复请求时返回 0。同一请求只取一次。

(&Modal) contains_focus

XuAPI
pub fn (m &Modal) contains_focus(id int) bool

用途

&Modal 上的操作:执行 contains focus 操作。

参数

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

返回值

bool — 是否成立

($&Modal) set_focus_order

XuAPI
pub fn (m $&Modal) set_focus_order(ids &[]int) int

用途

设置模态层内部的 Tab 遍历顺序,让键盘焦点在指定控件中循环。

参数

m $&Modal
本次调用使用的 Modal 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
ids &[]int
内容控件 ID 的有序列表,最多 256 项;ID 必须为正数、不能重复,也不能等于模态层自身 ID。

返回值

成功返回 0;失败时抛错,不以非零返回码表示失败。

使用时注意

  • 原焦点仍在新列表中时保留它,否则选第一项;空列表表示没有内容焦点目标。

错误处理

  • 数量、ID 或重复校验失败时抛错。

($&Modal) set_content_focus

XuAPI
pub fn (m $&Modal) set_content_focus(id int) int

用途

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

参数

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

返回值

int — 该类型的值

($&Modal) open

XuAPI
pub fn (m $&Modal) open(now time.Instant,reduced_motion bool,restore_focus int) int

用途

打开模态层并记录关闭后的焦点恢复目标。

参数

m $&Modal
本次调用使用的 Modal 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now time.Instant
当前动画时间 time.Instant;打开、更新和关闭应使用同一时间基准。
reduced_motion bool
是否减少动态效果;为 true 时直接到目标状态。
restore_focus int
关闭完成后需要恢复的控件 ID;0 表示没有恢复目标,不能为负数。

返回值

成功返回 0;失败时抛错,不以非零返回码表示失败。

使用时注意

  • 每帧调用 tick 推进动画,用 is_visible 决定是否继续绘制。

错误处理

  • 动画参数或状态无效时抛错。焦点恢复 ID 为负数也会抛错。

($&Modal) close

XuAPI
pub fn (m $&Modal) close(now time.Instant,reduced_motion bool) int

用途

请求关闭并启动退场动画;逻辑关闭之后可能还需要继续绘制几帧。

参数

m $&Modal
本次调用使用的 Modal 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now time.Instant
当前动画时间 time.Instant;打开、更新和关闭应使用同一时间基准。
reduced_motion bool
是否减少动态效果;为 true 时直接到目标状态。

返回值

成功返回 0;失败时抛错,不以非零返回码表示失败。

使用时注意

  • is_open() 随关闭请求变为 false,is_visible() 在退场动画结束后才变为 false。

错误处理

  • 动画操作失败时继续抛错。

($&Modal) set_enabled

XuAPI
pub fn (m $&Modal) set_enabled(enabled bool) int

用途

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

参数

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

返回值

int — 该类型的值

($&Modal) set_geometry

XuAPI
pub fn (m $&Modal) set_geometry(bounds &layout.Rect,viewport &layout.Rect) int

用途

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

参数

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

返回值

int — 该类型的值

(&Modal) close_bounds

XuAPI
pub fn (m &Modal) close_bounds() layout.Rect

用途

&Modal 上的操作:执行 close bounds 操作。

参数

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

返回值

layout.Rect — 该类型的值

(&Modal) allows_content

XuAPI
pub fn (m &Modal) allows_content(event &ui.InputEvent) bool

用途

判断当前输入能否交给模态面板内部的控件,用于模态层优先分发后的下一步。

参数

m &Modal
本次调用使用的 Modal 实例;以只读借用传入,调用方仍持有实例。
event &ui.InputEvent
同一窗口、画布和代次的输入事件;坐标按控件所在的画布空间传入。

返回值

允许时为 true;未打开、身份不匹配、Tab/Escape 或落在关闭按钮上的输入为 false。

使用时注意

  • 键盘输入还要求存在内容焦点目标;指针输入需要落在面板内。

($&Modal) input

XuAPI
pub fn (m $&Modal) input(event &ui.InputEvent) Action

用途

先处理模态层的关闭和 Tab 焦点循环,再决定是否把输入交给面板内容。

参数

m $&Modal
本次调用使用的 Modal 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
event &ui.InputEvent
同一窗口、画布和代次的输入事件;坐标按控件所在的画布空间传入。

返回值

Action 描述本次交互:kind 是动作类型,consumed 表示事件是否已处理,request_focus 请求焦点,needs_paint 表示需要重绘。

使用时注意

  • 先于背景控件分发;用 allows_content 判断内容输入。退出动画尚未结束时仍阻止背景交互。

($&Modal) route

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

用途

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

参数

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

返回值

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

($&Modal) tick

XuAPI
pub fn (m $&Modal) tick(now time.Instant,reduced_motion bool) bool

用途

把淡入淡出动画推进到当前时间,用返回值决定是否安排重绘。

参数

m $&Modal
本次调用使用的 Modal 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
now time.Instant
当前动画时间 time.Instant;打开、更新和关闭应使用同一时间基准。
reduced_motion bool
是否减少动态效果;为 true 时直接到目标状态。

返回值

透明度发生变化时返回 true;没有变化返回 false。

错误处理

  • 时间或动画状态无效时抛错。

(&Modal) next_tick

XuAPI
pub fn (m &Modal) next_tick(now time.Instant) time.Instant

用途

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

参数

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

返回值

time.Instant — 该类型的值

(&Modal) paint_styled

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

用途

绘制模态遮罩、面板和关闭按钮。

参数

m &Modal
本次调用使用的 Modal 实例;以只读借用传入,调用方仍持有实例。
frame $&draw.Frame
当前绘制帧;本调用向其中记录绘制命令。
styles &Styles
当前生效的样式;提供颜色、间距、字体和状态外观。

返回值

成功返回 0;失败时抛错,不以非零返回码表示失败。

使用时注意

  • 遮罩取自 Styles.overlay_scrim(),其透明度随模态动画变化。
  • 面板内容由调用方绘制;本调用不会自动创建、布局或分发内容控件。

错误处理

  • 绘制命令失败时继续抛错。

($&Modal) paint_content_styled

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

用途

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

参数

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

返回值

int — 该类型的值

($&Modal) paint_popup_styled

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

用途

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

参数

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

返回值

int — 该类型的值

($&Modal) set_style

XuAPI
pub fn (m $&Modal) set_style(style &ControlStyle) int

用途

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

参数

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

返回值

int — 该类型的值

($&Modal) set_motion

XuAPI
pub fn (m $&Modal) set_motion(spec &MotionSpec) int

用途

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

参数

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

返回值

int — 该类型的值

完整原生示例

Component Workshop · 返回 Widgets 目录