diff options
author | Carlos Garnacho <carlosg@gnome.org> | 2023-07-05 13:58:20 +0200 |
---|---|---|
committer | Vlad Zahorodnii <vlad.zahorodnii@kde.org> | 2024-03-14 12:47:54 +0000 |
commit | 9408483fb19ebd88b64e0bf2252d08f63f861e83 (patch) | |
tree | a3a9b4791fe13d8a050072385042700d3b92d749 | |
parent | 0819d97313b3ad008aeb3aa3e11b8dc0d7d3867c (diff) |
staging/dialog: Add "dialog" protocol
This simple protocol definition allows clients to express a "dialog"
relationship of a toplevel with its parent and extend the possible
hints. This allows compositors to attach certain behavior according
to these hints.
Signed-off-by: Carlos Garnacho <carlosg@gnome.org>
Reviewed-by: Sebastian Wick <sebastian.wick@redhat.com>
-rw-r--r-- | meson.build | 1 | ||||
-rw-r--r-- | staging/xdg-dialog/README | 5 | ||||
-rw-r--r-- | staging/xdg-dialog/xdg-dialog-v1.xml | 110 |
3 files changed, 116 insertions, 0 deletions
diff --git a/meson.build b/meson.build index 8f5fac2..5adc800 100644 --- a/meson.build +++ b/meson.build @@ -49,6 +49,7 @@ staging_protocols = { 'tearing-control': ['v1'], 'ext-transient-seat': ['v1'], 'xdg-activation': ['v1'], + 'xdg-dialog': ['v1'], 'xdg-toplevel-drag': ['v1'], 'xwayland-shell': ['v1'], } diff --git a/staging/xdg-dialog/README b/staging/xdg-dialog/README new file mode 100644 index 0000000..23b56e4 --- /dev/null +++ b/staging/xdg-dialog/README @@ -0,0 +1,5 @@ +Dialog windows + +Maintainers: +Carlos Garnacho <carlosg@gnome.org> +Jonas Ådahl <jadahl@gmail.com> diff --git a/staging/xdg-dialog/xdg-dialog-v1.xml b/staging/xdg-dialog/xdg-dialog-v1.xml new file mode 100644 index 0000000..ed21411 --- /dev/null +++ b/staging/xdg-dialog/xdg-dialog-v1.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8"?> +<protocol name="dialog_v1"> + <copyright> + 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. + </copyright> + + <interface name="xdg_wm_dialog_v1" version="1"> + <description summary="create dialogs related to other toplevels"> + The xdg_wm_dialog_v1 interface is exposed as a global object allowing + to register surfaces with a xdg_toplevel role as "dialogs" relative to + another toplevel. + + The compositor may let this relation influence how the surface is + placed, displayed or interacted with. + + Warning! The protocol described in this file is currently in the testing + phase. Backward compatible changes may be added together with the + corresponding interface version bump. Backward incompatible changes can + only be done by creating a new major version of the extension. + </description> + + <enum name="error"> + <entry name="already_used" value="0" + summary="the xdg_toplevel object has already been used to create a xdg_dialog_v1"/> + </enum> + + <request name="destroy" type="destructor"> + <description summary="destroy the dialog manager object"> + Destroys the xdg_wm_dialog_v1 object. This does not affect + the xdg_dialog_v1 objects generated through it. + </description> + </request> + + <request name="get_xdg_dialog"> + <description summary="create a dialog object"> + Creates a xdg_dialog_v1 object for the given toplevel. See the interface + description for more details. + + Compositors must raise an already_used error if clients attempt to + create multiple xdg_dialog_v1 objects for the same xdg_toplevel. + </description> + <arg name="id" type="new_id" interface="xdg_dialog_v1"/> + <arg name="toplevel" type="object" interface="xdg_toplevel"/> + </request> + </interface> + + <interface name="xdg_dialog_v1" version="1"> + <description summary="dialog object"> + A xdg_dialog_v1 object is an ancillary object tied to a xdg_toplevel. Its + purpose is hinting the compositor that the toplevel is a "dialog" (e.g. a + temporary window) relative to another toplevel (see + xdg_toplevel.set_parent). If the xdg_toplevel is destroyed, the xdg_dialog_v1 + becomes inert. + + Through this object, the client may provide additional hints about + the purpose of the secondary toplevel. This interface has no effect + on toplevels that are not attached to a parent toplevel. + </description> + + <request name="destroy" type="destructor"> + <description summary="destroy the dialog object"> + Destroys the xdg_dialog_v1 object. If this object is destroyed + before the related xdg_toplevel, the compositor should unapply its + effects. + </description> + </request> + + <request name="set_modal"> + <description summary="mark dialog as modal"> + Hints that the dialog has "modal" behavior. Modal dialogs typically + require to be fully addressed by the user (i.e. closed) before resuming + interaction with the parent toplevel, and may require a distinct + presentation. + + Clients must implement the logic to filter events in the parent + toplevel on their own. + + Compositors may choose any policy in event delivery to the parent + toplevel, from delivering all events unfiltered to using them for + internal consumption. + </description> + </request> + + <request name="unset_modal"> + <description summary="mark dialog as not modal"> + Drops the hint that this dialog has "modal" behavior. See + xdg_dialog_v1.set_modal for more details. + </description> + </request> + </interface> +</protocol> |