[PATCH wayland-protocols 3/3] xdg-shell: Introduce xdg_tooltip

[Bill Spitzak]

On Tue, Jan 12, 2016 at 12:16 AM, Jonas Ådahl <jadahl at gmail.com> wrote:

> An xdg_tooltip is a new window type used to implement tooltip like
> surfaces. See the interface documentation for details.
>
> +    <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. >>>A wl_surface can
> only have
> +       one xdg_tooltip role. If the wl_surface is given the xdg_tooltip
> role
> +       while it already has an active xdg_tooltip role, or if it has been
> given
> +       any other role before, an error is raised.<<<
>

I believe all the text between >>> and <<< is redundant, it has already
been established that you can set the role of a surface exactly once.


> +       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"/>
>

This seems to combine creation of the surface and assignment of a role, at
least that is my best guess. No matter what this does this documentation
seems misleading.

If in fact this is assigning the "tooltip role" to an existing surface,
then the "parent" argument name is really misleading. That surface *is* the
tooltip.

If this is creating a new surface with the "tooltip role" then the text
"assign the xdg_tooltip surface role" is misleading. It is also rather
mysterious how you do things like set the buffer.

>
> +  <interface name="zxdg_tooltip_v6">
> +    <request name="destroy" type="destructor">
> +      Unmap the tooltip surface and destroy the object.
> +    </request>
>

Why isn't the wl_surface destroy request used? Or if you do not have access
to surface methods, how do you do basic things like set the buffer?
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.freedesktop.org/archives/wayland-devel/attachments/20160112/1b47f921/attachment.html>