Shell Extensions - Qt Wayland Compositor

In Wayland, shells are extensions which provide surface semantics. This means that they provide ways for the server and client to communicate about surfaces. Surfaces, in this context, are often also referred to as "windows", which is typically the representation of the surface in the compositor.

Shell extensions provide tools for the client and server to communicate about certain things:

  • They can provide a way for the client to inform the server about the purpose of a surface: Is it a tool-tip, a pop-up menu, or a regular application window, for instance? Based on this, the server can decide on the geometry of the window and how the user can interact with it.
  • They can also provide protocols for manipulating the surface, such as resizing, moving, and hiding them.

Like other extensions, support for shells is added to a compositor by instantiating them as direct children of the WaylandCompositor top-level object. The shell extensions supported by Qt are: WlShell, XdgShell and IviApplication.

  • XdgShell is an appropriate shell for desktop-style systems, where any number of applications can connect and where windows can be manually resized and repositioned by the user.
  • IviApplication is a minimalistic protocol, originally intended for In-vehicle Infotainment systems. It is useful for embedded systems, where a pre-defined set of applications can run, often with pre-assigned screen real estate. For some more details on this protocol, see the IVI Compositor example.
  • WlShell is mostly useful for compatibility with third-party applications. This is also a desktop-style shell, but it has been deprecated and replaced by XdgShell.

When designing an embedded system from the bottom up, there are no rules determining which shell extension to use. It will typically be either XdgShell or IviApplication. The decision should be influenced by what features the system will need, and whether there are applications involved which are not written in Qt and which have their own requirements.

A Qt Wayland Compositor can also support multiple shell extensions at once. See the Minimal QML example for an example where all three shell extensions listed above are supported.

© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.