[PATCH wayland-protocols v2] xdg-shell: Introduce xdg_tooltip

Jonas Ådahl jadahl at gmail.com
Wed Feb 3 08:39:52 UTC 2016

An xdg_tooltip is a new window type used to implement tooltip like
surfaces. See the interface documentation for details.

Signed-off-by: Jonas Ådahl <jadahl at gmail.com>

Changes since v1:

Various wording changes as suggested by Mike.

Added missing version attribute and <description/>.

 unstable/xdg-shell/xdg-shell-unstable-v6.xml | 41 ++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)

diff --git a/unstable/xdg-shell/xdg-shell-unstable-v6.xml b/unstable/xdg-shell/xdg-shell-unstable-v6.xml
index f2eba64..a164bd6 100644
--- a/unstable/xdg-shell/xdg-shell-unstable-v6.xml
+++ b/unstable/xdg-shell/xdg-shell-unstable-v6.xml
@@ -168,6 +168,20 @@
       <arg name="y" type="int"/>
+    <request name="get_tooltip">
+      <description summary="assign the xdg_tooltip surface role">
+	This creates an xdg_tooltip for the given xdg_surface and gives the
+	associated wl_surface the xdg_tooltip role.
+	See the documentation of xdg_tooltip for more details about what an
+	xdg_tooltip is and how it is used.
+      </description>
+      <arg name="id" type="new_id" interface="zxdg_tooltip_v6"/>
+      <arg name="parent" type="object" interface="zxdg_surface_v6"/>
+      <arg name="x" type="int"/>
+      <arg name="y" type="int"/>
+    </request>
     <request name="set_window_geometry">
       <description summary="set the new window geometry">
 	The window geometry of a surface is its "visible bounds" from the
@@ -650,4 +664,31 @@
+  <interface name="zxdg_tooltip_v6" version="1">
+    <description summary="tooltip surface">
+      This interface defines an xdg_tooltip role that provides functionality
+      related to tooltip like surfaces.
+      An xdg_tooltip is a temporary surface which is displayed over its parent
+      xdg_surface. The last-created xdg_tooltip surface will always be the
+      top-most child of the parent xdg_surface.
+      The parent surface must either have the surface role xdg_toplevel,
+      xdg_popup or xdg_tooltip.
+      An xdg_tooltip does not take an active grab while mapped. xdg_tooltip
+      surfaces are either directly unmapped by clients using the
+      xdg_tooltip.destroy request or indirectly unmapped when their parent
+      surface is unmapped.
+      An xdg_tooltip obeys normal input region semantics.
+    </description>
+    <request name="destroy" type="destructor">
+      <description summary="destroy the xdg_tooltip object">
+	Unmap the tooltip surface and destroy the object.
+      </description>
+    </request>
+  </interface>

More information about the wayland-devel mailing list