XU XUv0.13.1
EN

UI / WIDGETS / 操作

Menu

以命令列表呈现操作

在演练场运行 Xu 示例

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

体验什么

打开菜单并选择命令。

使用要点

命令、分组、勾选项和子菜单有不同语义。菜单项使用稳定标识,激活后由应用执行命令。

通过 Screen 创建

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

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

#ui/widgets

fn configure(screen $&widgets.Screen) int {
    items := [widgets.menu_item(1,"Save"),widgets.menu_item(2,"Export")]
    id := screen.menu("Actions",&items,widgets.MENU_DROPDOWN,0) or >>
    screen.place(id,24.0,24.0,320.0,80.0) or >>
    << id
}

($&Screen) menu

XuAPI
pub fn (s $&Screen) menu(label string,items &[]MenuItem,mode int,primary_key int) int

用途

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

参数

s $&Screen
本次调用使用的 Screen 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
label string
label(string)
items &[]MenuItem
元素列表(只读借用,调用方仍持有原值;类型 &[]MenuItem)
mode int
模式(int)
primary_key int
primary_key(int)

返回值

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 Menu

XuAPI
pub struct Menu {

}

用途

Menu 上下文或状态结构体。

公开字段

此类型没有公开字段。

(&Menu) id

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

用途

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

参数

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

返回值

int — 该类型的值

(&Menu) bounds

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

用途

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

参数

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

返回值

layout.Rect — 该类型的值

(&Menu) is_enabled

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

用途

返回控件当前是否可用。

参数

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

返回值

bool — 是否成立

(&Menu) is_selectable

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

用途

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

参数

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

返回值

bool — 是否成立

($&Menu) set_selectable

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

用途

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

参数

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

返回值

不返回值。

(&Menu) is_open

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

用途

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

参数

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

返回值

bool — 是否成立

(&Menu) opacity

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

用途

在 &Menu 上执行 opacity 操作。

参数

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

返回值

f64 — 该类型的值

(&Menu) needs_paint

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

用途

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

参数

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

返回值

bool — 是否成立

($&Menu) painted

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

用途

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

参数

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

返回值

不返回值。

($&Menu) set_items

XuAPI
pub fn (m $&Menu) set_items(items &[]MenuItem) int

用途

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

参数

m $&Menu
本次调用使用的 Menu 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
items &[]MenuItem
元素列表(只读借用,调用方仍持有原值;类型 &[]MenuItem)

返回值

int — 该类型的值

($&Menu) set_item_label

XuAPI
pub fn (m $&Menu) set_item_label(key int,label string) int

用途

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

参数

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

返回值

int — 该类型的值

($&Menu) set_label

XuAPI
pub fn (m $&Menu) set_label(label string)

用途

$&Menu 上的操作:设置 label。

参数

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

返回值

不返回值。

(&Menu) checked

XuAPI
pub fn (m &Menu) checked(key int) bool

用途

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

参数

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

返回值

bool — 是否成立

($&Menu) set_checked

XuAPI
pub fn (m $&Menu) set_checked(key int,value bool) int

用途

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

参数

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

返回值

int — 该类型的值

($&Menu) set_item_enabled

XuAPI
pub fn (m $&Menu) set_item_enabled(key int,value bool) int

用途

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

参数

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

返回值

int — 该类型的值

($&Menu) set_appearance

XuAPI
pub fn (m $&Menu) set_appearance(a &MenuAppearance) int

用途

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

参数

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

返回值

int — 该类型的值

($&Menu) close

XuAPI
pub fn (m $&Menu) close() int

用途

$&Menu 上的操作:关闭资源。失败时抛出错误,调用方需处理或继续传播。

参数

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

返回值

int — 该类型的值

($&Menu) cancel

XuAPI
pub fn (m $&Menu) cancel()

用途

$&Menu 上的操作:取消。

参数

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

返回值

不返回值。

($&Menu) set_focus

XuAPI
pub fn (m $&Menu) set_focus(value bool)

用途

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

参数

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

返回值

不返回值。

($&Menu) set_enabled

XuAPI
pub fn (m $&Menu) set_enabled(value bool)

用途

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

参数

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

返回值

不返回值。

($&Menu) set_read_only

XuAPI
pub fn (m $&Menu) set_read_only(value bool)

用途

$&Menu 上的操作:设置 read only。

参数

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

返回值

不返回值。

($&Menu) set_bounds

XuAPI
pub fn (m $&Menu) set_bounds(b &layout.Rect) int

用途

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

参数

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

返回值

int — 该类型的值

($&Menu) set_style

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

用途

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

参数

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

返回值

int — 该类型的值

($&Menu) clear_style

XuAPI
pub fn (m $&Menu) clear_style()

用途

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

参数

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

返回值

不返回值。

($&Menu) set_motion

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

用途

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

参数

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

返回值

int — 该类型的值

($&Menu) dispose

XuAPI
pub fn (m $&Menu) dispose()

用途

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

参数

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

返回值

不返回值。

(&Menu) popup_bounds

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

用途

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

参数

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

返回值

layout.Rect — 该类型的值

($&Menu) set_viewport

XuAPI
pub fn (m $&Menu) set_viewport(viewport &layout.Rect) int

用途

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

参数

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

返回值

int — 该类型的值

($&Menu) apply_styles

XuAPI
pub fn (m $&Menu) apply_styles(styles &Styles) int

用途

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

参数

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

返回值

int — 该类型的值

($&Menu) tick

XuAPI
pub fn (m $&Menu) tick(styles &Styles,now time.Instant,reduced bool) bool

用途

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

参数

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

返回值

bool — 是否成立

(&Menu) next_tick

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

用途

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

参数

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

返回值

time.Instant — 该类型的值

($&Menu) open_at

XuAPI
pub fn (m $&Menu) open_at(x f64,y f64,context bool) int

用途

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

参数

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

返回值

int — 该类型的值

($&Menu) shortcut

XuAPI
pub fn (m $&Menu) shortcut(event &ui.InputEvent) Action

用途

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

参数

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

返回值

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

($&Menu) input

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

用途

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

参数

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

返回值

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

($&Menu) route

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

用途

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

参数

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

返回值

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

($&Menu) paint_styled

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

用途

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

参数

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

返回值

int — 该类型的值

($&Menu) paint_popup_styled

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

用途

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

参数

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

返回值

int — 该类型的值

完整原生示例

Component Workshop · 返回 Widgets 目录