<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qwaylandxdgshellv6.cpp --> <title>XdgShellV6 QML Type | Qt Wayland Compositor 5.11</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 ><a href="../qtdoc/index.html">Qt 5.11</a></td><td ><a href="qtwaylandcompositor-index.html">Qt Wayland Compositor</a></td><td ><a href="qtwayland-compositor-qmlmodule.html">QML Types</a></td><td >XdgShellV6 QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.11.2 Reference Documentation</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="#methods">Methods</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">XdgShellV6 QML Type</h1> <span class="subtitle"></span> <!-- $$$XdgShellV6-brief --> <p>Provides an extension for desktop-style user interfaces. <a href="#details">More...</a></p> <!-- @@@XdgShellV6 --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtWayland.Compositor 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.10</td></tr></table></div><ul> <li><a href="qml-qtwayland-compositor-xdgshellv6-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"><b><b><a href="qml-qtwayland-compositor-xdgshellv6.html#pong-signal">pong</a></b></b>(int <i>serial</i>)</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgshellv6.html#popupCreated-signal">popupCreated</a></b></b>(XdgPopupV6 <i>popup</i>, XdgSurfaceV6 <i>xdgSurface</i>)</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgshellv6.html#toplevelCreated-signal">toplevelCreated</a></b></b>(XdgToplevelV6 <i>toplevel</i>, XdgSurfaceV6 <i>xdgSurface</i>)</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgshellv6.html#xdgSurfaceCreated-signal">xdgSurfaceCreated</a></b></b>(XdgSurfaceV6 <i>xdgSurface</i>)</li> </ul> <a name="methods"></a> <h2 id="methods">Methods</h2> <ul> <li class="fn">void <b><b><a href="qml-qtwayland-compositor-xdgshellv6.html#ping-method">ping</a></b></b>(WaylandClient <i>client</i>)</li> </ul> <!-- $$$XdgShellV6-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>The <a href="qml-qtwayland-compositor-xdgshellv6.html">XdgShellV6</a> extension provides a way to associate a <a href="qml-qtwayland-compositor-xdgtoplevelv6.html">XdgToplevelV6</a> or <a href="qml-qtwayland-compositor-xdgpopupv6.html">XdgPopupV6</a> with a regular Wayland surface. Using the <a href="qml-qtwayland-compositor-xdgtoplevelv6.html">XdgToplevelV6</a> interface, the client can request that the surface is resized, moved, and so on.</p> <p><a href="qml-qtwayland-compositor-xdgshellv6.html">XdgShellV6</a> corresponds to the Wayland interface, <code>zxdg_shell_v6</code>.</p> <p>To provide the functionality of the shell extension in a compositor, create an instance of the <a href="qml-qtwayland-compositor-xdgshellv6.html">XdgShellV6</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.1</span> WaylandCompositor { XdgShellV6 { <span class="comment">// ...</span> } } </pre> <!-- @@@XdgShellV6 --> <h2>Signal Documentation</h2> <!-- $$$pong --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="pong-signal"> <td class="tblQmlFuncNode"><p> <a name="pong-signal"></a><span class="name">pong</span>(<span class="type"><a href="../qtqml/qml-int.html">int</a></span> <i>serial</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the client has responded to a ping event with serial, <i>serial</i>.</p> <p><b>See also </b><a href="qml-qtwayland-compositor-xdgshellv6.html#ping-method">ping()</a>.</p> </div></div><!-- @@@pong --> <br/> <!-- $$$popupCreated --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="popupCreated-signal"> <td class="tblQmlFuncNode"><p> <a name="popupCreated-signal"></a><span class="name">popupCreated</span>(<span class="type"><a href="qml-qtwayland-compositor-xdgpopupv6.html">XdgPopupV6</a></span> <i>popup</i>, <span class="type"><a href="qml-qtwayland-compositor-xdgsurfacev6.html">XdgSurfaceV6</a></span> <i>xdgSurface</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the client has created a <code>zxdg_popup_v6</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>popup</i> in a <a href="../qtqml/qtquick-qmlmodule.html">QtQuick</a> scene.</p> <p><i>xdgSurface</i> is the <a href="qml-qtwayland-compositor-xdgsurfacev6.html">XdgSurfaceV6</a> <i>popup</i> is the role object for.</p> </div></div><!-- @@@popupCreated --> <br/> <!-- $$$toplevelCreated --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="toplevelCreated-signal"> <td class="tblQmlFuncNode"><p> <a name="toplevelCreated-signal"></a><span class="name">toplevelCreated</span>(<span class="type"><a href="qml-qtwayland-compositor-xdgtoplevelv6.html">XdgToplevelV6</a></span> <i>toplevel</i>, <span class="type"><a href="qml-qtwayland-compositor-xdgsurfacev6.html">XdgSurfaceV6</a></span> <i>xdgSurface</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the client has created a <code>zxdg_toplevel_v6</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>toplevel</i> in a <a href="../qtqml/qtquick-qmlmodule.html">QtQuick</a> scene.</p> <p><i>xdgSurface</i> is the <a href="qml-qtwayland-compositor-xdgsurfacev6.html">XdgSurfaceV6</a> <i>toplevel</i> is the role object for.</p> </div></div><!-- @@@toplevelCreated --> <br/> <!-- $$$xdgSurfaceCreated --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="xdgSurfaceCreated-signal"> <td class="tblQmlFuncNode"><p> <a name="xdgSurfaceCreated-signal"></a><span class="name">xdgSurfaceCreated</span>(<span class="type"><a href="qml-qtwayland-compositor-xdgsurfacev6.html">XdgSurfaceV6</a></span> <i>xdgSurface</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the client has created a <code>zxdg_surface_v6</code>. Note that <i>xdgSurface</i> is not mapped, i.e. according to the <code>xdg-shell</code> protocol it should not be displayed, until it has received a role object.</p> <p><b>See also </b><a href="qml-qtwayland-compositor-xdgshellv6.html#toplevelCreated-signal">toplevelCreated()</a> and <a href="qml-qtwayland-compositor-xdgshellv6.html#popupCreated-signal">popupCreated()</a>.</p> </div></div><!-- @@@xdgSurfaceCreated --> <br/> <h2>Method Documentation</h2> <!-- $$$ping --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="ping-method"> <td class="tblQmlFuncNode"><p> <a name="ping-method"></a><span class="type">void</span> <span class="name">ping</span>(<span class="type"><a href="qml-qtwayland-compositor-waylandclient.html">WaylandClient</a></span> <i>client</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>Sends a ping event to <i>client</i>. If the client replies to the event the <a href="qml-qtwayland-compositor-xdgshellv6.html#pong-signal">pong</a> signal will be emitted.</p> </div></div><!-- @@@ping --> <br/> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2018 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>