<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qwaylandwlshell.cpp -->
<title>WlShell QML Type | Qt Wayland Compositor 5.12.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qtwaylandcompositor-index.html">Qt Wayland Compositor</a></td><td ><a href="qtwayland-compositor-qmlmodule.html">QML Types</a></td><td >WlShell QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtwaylandcompositor-index.html">Qt 5.12.6 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">WlShell QML Type</h1>
<span class="subtitle"></span>
<!-- $$$WlShell-brief -->
<p>Provides an extension for desktop-style user interfaces. <a href="#details">More...</a></p>
<!-- @@@WlShell -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtWayland.Compositor 1.3</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.8</td></tr></table></div><ul>
<li><a href="qml-qtwayland-compositor-wlshell-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtwayland-compositor-wlshell.html#wlShellSurfaceCreated-signal">wlShellSurfaceCreated</a></b></b>(WlShellSurface <i>shellSurface</i>)</li>
<li class="fn">void <b><b><a href="qml-qtwayland-compositor-wlshell.html#wlShellSurfaceRequested-signal">wlShellSurfaceRequested</a></b></b>(WaylandSurface <i>surface</i>, WaylandResource <i>resource</i>)</li>
</ul>
<!-- $$$WlShell-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The <a href="qml-qtwayland-compositor-wlshell.html">WlShell</a> extension provides a way to associate a <a href="qml-qtwayland-compositor-shellsurface.html">ShellSurface</a> with a regular Wayland surface. Using the shell surface interface, the client can request that the surface is resized, moved, and so on.</p>
<p><a href="qml-qtwayland-compositor-wlshell.html">WlShell</a> corresponds to the Wayland interface <code>wl_shell</code>.</p>
<p>To provide the functionality of the shell extension in a compositor, create an instance of the <a href="qml-qtwayland-compositor-wlshell.html">WlShell</a> component and add it to the list of extensions supported by the compositor:</p>
<pre class="cpp">
import <span class="type">QtWayland</span><span class="operator">.</span>Compositor <span class="number">1.0</span>
WaylandCompositor {
WlShell {
<span class="comment">// ...</span>
}
}
</pre>
<!-- @@@WlShell -->
<h2>Signal Documentation</h2>
<!-- $$$wlShellSurfaceCreated -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="wlShellSurfaceCreated-signal">
<td class="tblQmlFuncNode"><p>
<a name="wlShellSurfaceCreated-signal"></a><span class="type">void</span> <span class="name">wlShellSurfaceCreated</span>(<span class="type"><a href="qml-qtwayland-compositor-wlshellsurface.html">WlShellSurface</a></span> <i>shellSurface</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the client has created a <code>wl_shell_surface</code>. A common use case is to let the handler of this signal instantiate a <a href="qml-qtwayland-compositor-shellsurfaceitem.html">ShellSurfaceItem</a> or <a href="qml-qtwayland-compositor-waylandquickitem.html">WaylandQuickItem</a> for displaying <i>shellSurface</i> in a QtQuick scene.</p>
</div></div><!-- @@@wlShellSurfaceCreated -->
<br/>
<!-- $$$wlShellSurfaceRequested -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="wlShellSurfaceRequested-signal">
<td class="tblQmlFuncNode"><p>
<a name="wlShellSurfaceRequested-signal"></a><span class="type">void</span> <span class="name">wlShellSurfaceRequested</span>(<span class="type"><a href="qml-qtwayland-compositor-waylandsurface.html">WaylandSurface</a></span> <i>surface</i>, <span class="type">WaylandResource</span> <i>resource</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the client has requested a <code>wl_shell_surface</code> to be associated with <i>surface</i>. The handler for this signal may create a shell surface for <i>resource</i> and initialize it within the scope of the signal emission. Otherwise a <a href="qml-qtwayland-compositor-wlshellsurface.html">WlShellSurface</a> will be created automatically.</p>
</div></div><!-- @@@wlShellSurfaceRequested -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> 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. </p>
</div>
</body>
</html>
