<?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>QWaylandWlShell Class | 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="qtwaylandcompositor-module.html">C++ Classes</a></td><td >QWaylandWlShell</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QWaylandWlShell Class</h1>
<!-- $$$QWaylandWlShell-brief -->
<p>The <a href="qwaylandwlshell.html">QWaylandWlShell</a> class is an extension for desktop-style user interfaces. <a href="#details">More...</a></p>
<!-- @@@QWaylandWlShell -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QWaylandWlShell></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += waylandcompositor</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="qwaylandwlshell-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#QWaylandWlShell">QWaylandWlShell</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#QWaylandWlShell-1">QWaylandWlShell</a></b>(QWaylandCompositor *<i>compositor</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#initialize">initialize</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QWaylandWlShellSurface *> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#mappedPopups">mappedPopups</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QWaylandClient *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#popupClient">popupClient</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QWaylandWlShellSurface *> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#shellSurfaces">shellSurfaces</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QWaylandWlShellSurface *> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#shellSurfacesForClient">shellSurfacesForClient</a></b>(QWaylandClient *<i>client</i>) const</td></tr>
</table></div>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#closeAllPopups">closeAllPopups</a></b>()</td></tr>
</table></div>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#wlShellSurfaceCreated">wlShellSurfaceCreated</a></b>(QWaylandWlShellSurface *<i>shellSurface</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#wlShellSurfaceRequested">wlShellSurfaceRequested</a></b>(QWaylandSurface *<i>surface</i>, const QWaylandResource &<i>resource</i>)</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const struct wl_interface *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#interface">interface</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qwaylandwlshell.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QWaylandWlShell-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qwaylandwlshell.html">QWaylandWlShell</a> class is an extension for desktop-style user interfaces.</p>
<p>The <a href="qwaylandwlshell.html">QWaylandWlShell</a> extension provides a way to associate a <a href="qwaylandwlshellsurface.html">QWaylandWlShellSurface</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>
</div>
<!-- @@@QWaylandWlShell -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QWaylandWlShell[overload1]$$$QWaylandWlShell -->
<h3 class="fn" id="QWaylandWlShell"><a name="QWaylandWlShell"></a>QWaylandWlShell::<span class="name">QWaylandWlShell</span>()</h3>
<p>Constructs a <a href="qwaylandwlshell.html">QWaylandWlShell</a> object.</p>
<!-- @@@QWaylandWlShell -->
<!-- $$$QWaylandWlShell$$$QWaylandWlShellQWaylandCompositor* -->
<h3 class="fn" id="QWaylandWlShell-1"><a name="QWaylandWlShell-1"></a>QWaylandWlShell::<span class="name">QWaylandWlShell</span>(<span class="type"><a href="qwaylandcompositor.html">QWaylandCompositor</a></span> *<i>compositor</i>)</h3>
<p>Constructs a <a href="qwaylandwlshell.html">QWaylandWlShell</a> object for the provided <i>compositor</i>.</p>
<!-- @@@QWaylandWlShell -->
<!-- $$$closeAllPopups[overload1]$$$closeAllPopups -->
<h3 class="fn" id="closeAllPopups"><a name="closeAllPopups"></a><code>[slot] </code><span class="type">void</span> QWaylandWlShell::<span class="name">closeAllPopups</span>()</h3>
<!-- @@@closeAllPopups -->
<!-- $$$initialize[overload1]$$$initialize -->
<h3 class="fn" id="initialize"><a name="initialize"></a><span class="type">void</span> QWaylandWlShell::<span class="name">initialize</span>()</h3>
<p>Initializes the <a href="qml-qtwayland-compositor-wlshell.html">WlShell</a> extension.</p>
<!-- @@@initialize -->
<!-- $$$interface[overload1]$$$interface -->
<h3 class="fn" id="interface"><a name="interface"></a><code>[static] </code>const <span class="type">struct</span> <span class="type">wl_interface</span> *QWaylandWlShell::<span class="name">interface</span>()</h3>
<p>Returns the Wayland interface for the <a href="qwaylandwlshell.html">QWaylandWlShell</a>.</p>
<!-- @@@interface -->
<!-- $$$mappedPopups[overload1]$$$mappedPopups -->
<h3 class="fn" id="mappedPopups"><a name="mappedPopups"></a><span class="type">QList</span><<span class="type"><a href="qwaylandwlshellsurface.html">QWaylandWlShellSurface</a></span> *> QWaylandWlShell::<span class="name">mappedPopups</span>() const</h3>
<!-- @@@mappedPopups -->
<!-- $$$popupClient[overload1]$$$popupClient -->
<h3 class="fn" id="popupClient"><a name="popupClient"></a><span class="type"><a href="qwaylandclient.html">QWaylandClient</a></span> *QWaylandWlShell::<span class="name">popupClient</span>() const</h3>
<!-- @@@popupClient -->
<!-- $$$shellSurfaces[overload1]$$$shellSurfaces -->
<h3 class="fn" id="shellSurfaces"><a name="shellSurfaces"></a><span class="type">QList</span><<span class="type"><a href="qwaylandwlshellsurface.html">QWaylandWlShellSurface</a></span> *> QWaylandWlShell::<span class="name">shellSurfaces</span>() const</h3>
<!-- @@@shellSurfaces -->
<!-- $$$shellSurfacesForClient[overload1]$$$shellSurfacesForClientQWaylandClient* -->
<h3 class="fn" id="shellSurfacesForClient"><a name="shellSurfacesForClient"></a><span class="type">QList</span><<span class="type"><a href="qwaylandwlshellsurface.html">QWaylandWlShellSurface</a></span> *> QWaylandWlShell::<span class="name">shellSurfacesForClient</span>(<span class="type"><a href="qwaylandclient.html">QWaylandClient</a></span> *<i>client</i>) const</h3>
<!-- @@@shellSurfacesForClient -->
<!-- $$$wlShellSurfaceCreated[overload1]$$$wlShellSurfaceCreatedQWaylandWlShellSurface* -->
<h3 class="fn" id="wlShellSurfaceCreated"><a name="wlShellSurfaceCreated"></a><code>[signal] </code><span class="type">void</span> QWaylandWlShell::<span class="name">wlShellSurfaceCreated</span>(<span class="type"><a href="qwaylandwlshellsurface.html">QWaylandWlShellSurface</a></span> *<i>shellSurface</i>)</h3>
<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 QWaylandShellSurfaceItem or <a href="qwaylandquickitem.html">QWaylandQuickItem</a> for displaying <i>shellSurface</i> in a QtQuick scene.</p>
<!-- @@@wlShellSurfaceCreated -->
<!-- $$$wlShellSurfaceRequested[overload1]$$$wlShellSurfaceRequestedQWaylandSurface*constQWaylandResource& -->
<h3 class="fn" id="wlShellSurfaceRequested"><a name="wlShellSurfaceRequested"></a><code>[signal] </code><span class="type">void</span> QWaylandWlShell::<span class="name">wlShellSurfaceRequested</span>(<span class="type"><a href="qwaylandsurface.html">QWaylandSurface</a></span> *<i>surface</i>, const <span class="type">QWaylandResource</span> &<i>resource</i>)</h3>
<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="qwaylandwlshellsurface.html">QWaylandWlShellSurface</a> will be created automatically.</p>
<!-- @@@wlShellSurfaceRequested -->
</div>
</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>
