创建与其他顶层窗口关联的对话框

xdg_wm_dialog_v1 接口作为一个全局对象暴露,允许将具有 xdg_toplevel 角色的 surface 注册为相对于另一个顶层窗口的"对话框"。

合成器可以利用此关联来影响 surface 的放置、显示或交互方式。

警告!此文件中描述的协议目前处于测试阶段。可能会添加向后兼容的更改,并更新相应的接口版本。向后不兼容的更改只能通过创建新的扩展主版本来完成。

destroy
类型: destructor
destroy()
销毁对话框管理器对象

销毁 xdg_wm_dialog_v1 对象。这不会影响通过它创建的 xdg_dialog_v1 对象。

get_xdg_dialog(id: new_id<xdg_dialog_v1>, toplevel: object<xdg_toplevel>)
参数
类型
描述
idnew_id<xdg_dialog_v1>
toplevelobject<xdg_toplevel>
创建对话框对象

为给定的顶层窗口创建 xdg_dialog_v1 对象。详情请参阅接口描述。

如果客户端尝试为同一个 xdg_toplevel 创建多个 xdg_dialog_v1 对象,合成器必须触发 already_used 错误。

error { already_used } 
参数
描述
already_used0
该 xdg_toplevel 对象已用于创建 xdg_dialog_v1

对话框对象

xdg_dialog_v1 对象是绑定到 xdg_toplevel 的辅助对象。其目的是向合成器提示该顶层窗口是相对于另一个顶层窗口的"对话框"(例如临时窗口)(参见 xdg_toplevel.set_parent)。如果 xdg_toplevel 被销毁,xdg_dialog_v1 将变为无效状态。

通过此对象,客户端可以提供关于辅助顶层窗口用途的额外提示。此接口对未附加到父顶层窗口的顶层窗口没有效果。

destroy
类型: destructor
destroy()
销毁对话框对象

销毁 xdg_dialog_v1 对象。如果此对象在关联的 xdg_toplevel 之前被销毁,合成器应取消其效果。

set_modal()
将对话框标记为模态

提示对话框具有"模态"行为。模态对话框通常要求用户完全处理(即关闭)后才能恢复与父顶层窗口的交互,并可能需要不同的呈现方式。

客户端必须自行实现在父顶层窗口上过滤事件的逻辑。

合成器可以选择任何事件传递策略,从不经过滤地传递所有事件,到将其用于内部处理。

unset_modal()
将对话框标记为非模态

取消此对话框具有"模态"行为的提示。详情请参阅 xdg_dialog_v1.set_modal。


合成器支持

Cage
Cage
0.2.0
COSMIC
COSMIC
1.0.0~beta.8
GameScope
GameScope
3.15.14
Hyprland
Hyprland
0.52.1
Jay
1.12.0
KWin
KWin
6.6
Labwc
Labwc
0.9.2
Louvre
Louvre
2.14.1
Mir
Mir
2.26
Muffin
Muffin
6.6.0
Mutter
Mutter
49.2
niri
niri
25.11
phoc
phoc
0.52
river
river
0.3.13
Sway
Sway
1.11
Treeland
Treeland
0.8.0
Wayfire
Wayfire
0.9.0
Weston
Weston
14.0.2
xdg_wm_dialog_v1
x
x
x
1
1
1
x
x
x
1
1
x
x
x
x
x
x
x

Copyright © 2023 Carlos Garnacho

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Footer

© 2026 Wayland Explorer

本网站与 Wayland 官方项目无任何关联。网站所有内容均根据 Wayland 协议 XML 文件自动生成。

本网站使用的 Visual Studio Code - Codicons 遵循 CC BY 4.0 许可。