<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qwaylandxdgshellv5.cpp --> <title>XdgShellV5 QML Type | Qt Wayland Compositor 5.9</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.9</td><td ><a href="qtwaylandcompositor-index.html">Qt Wayland Compositor</a></td><td ><a href="qtwayland-compositor-qmlmodule.html">QML Types</a></td><td >XdgShellV5 QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 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">XdgShellV5 QML Type</h1> <span class="subtitle"></span> <!-- $$$XdgShellV5-brief --> <p>Provides an extension for desktop-style user interfaces. <a href="#details">More...</a></p> <!-- @@@XdgShellV5 --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtWayland.Compositor 1.0</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-xdgshellv5-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-xdgshellv5.html#pong-signal">pong</a></b></b>(int <i>serial</i>)</li> <li class="fn">void <b><b><a href="qml-qtwayland-compositor-xdgshellv5.html#xdgPopupCreated-signal">xdgPopupCreated</a></b></b>(XdgPopupV5 <i>xdgPopup</i>)</li> <li class="fn">void <b><b><a href="qml-qtwayland-compositor-xdgshellv5.html#xdgPopupRequested-signal">xdgPopupRequested</a></b></b>(WaylandSurface <i>surface</i>, WaylandSurface <i>parent</i>, WaylandSeat <i>seat</i>, point <i>position</i>, WaylandResource <i>resource</i>)</li> <li class="fn">void <b><b><a href="qml-qtwayland-compositor-xdgshellv5.html#xdgSurfaceCreated-signal">xdgSurfaceCreated</a></b></b>(XdgSurfaceV5 <i>xdgSurface</i>)</li> <li class="fn">void <b><b><a href="qml-qtwayland-compositor-xdgshellv5.html#xdgSurfaceRequested-signal">xdgSurfaceRequested</a></b></b>(WaylandSurface <i>surface</i>, WaylandResource <i>resource</i>)</li> </ul> <a name="methods"></a> <h2 id="methods">Methods</h2> <ul> <li class="fn">void <b><b><a href="qml-qtwayland-compositor-xdgshellv5.html#ping-method">ping</a></b></b>()</li> </ul> <!-- $$$XdgShellV5-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>The <a href="qml-qtwayland-compositor-xdgshellv5.html">XdgShellV5</a> extension provides a way to associate an <a href="qml-qtwayland-compositor-xdgsurfacev5.html">XdgSurfaceV5</a> with a regular Wayland surface. Using the xdg_surface interface, the client can request that the surface is resized, moved, and so on.</p> <p><a href="qml-qtwayland-compositor-xdgshellv5.html">XdgShellV5</a> corresponds to the Wayland interface <code>xdg_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-xdgshellv5.html">XdgShellV5</a> component and add it as a child of the compositor:</p> <pre class="cpp"> import <span class="type">QtWayland</span><span class="operator">.</span>Compositor <span class="number">1.0</span> WaylandCompositor { XdgShellV5 { <span class="comment">// ...</span> } } </pre> <!-- @@@XdgShellV5 --> <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="type">void</span> <span class="name">pong</span>(<span class="type">int</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-xdgshellv5.html#ping-method">QtWaylandCompositor::XdgShellV5::ping()</a>.</p> </div></div><!-- @@@pong --> <br/> <!-- $$$xdgPopupCreated --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="xdgPopupCreated-signal"> <td class="tblQmlFuncNode"><p> <a name="xdgPopupCreated-signal"></a><span class="type">void</span> <span class="name">xdgPopupCreated</span>(<span class="type"><a href="qml-qtwayland-compositor-xdgpopupv5.html">XdgPopupV5</a></span> <i>xdgPopup</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the client has created an <code>xdg_popup</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>xdgPopup</i> in a QtQuick scene.</p> </div></div><!-- @@@xdgPopupCreated --> <br/> <!-- $$$xdgPopupRequested --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="xdgPopupRequested-signal"> <td class="tblQmlFuncNode"><p> <a name="xdgPopupRequested-signal"></a><span class="type">void</span> <span class="name">xdgPopupRequested</span>(<span class="type"><a href="qml-qtwayland-compositor-waylandsurface.html">WaylandSurface</a></span> <i>surface</i>, <span class="type"><a href="qml-qtwayland-compositor-waylandsurface.html">WaylandSurface</a></span> <i>parent</i>, <span class="type"><a href="qml-qtwayland-compositor-waylandseat.html">WaylandSeat</a></span> <i>seat</i>, <span class="type">point</span> <i>position</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 an <code>xdg_popup</code> to be associated with <i>surface</i>. The handler for this signal may create the xdg popup for <i>resource</i> and initialize it within the scope of the signal emission. Otherwise an <a href="qml-qtwayland-compositor-xdgpopupv5.html">XdgPopupV5</a> will be created automatically.</p> <p>The <i>seat</i> is the <code>wl_seat</code> that caused the popup to be opened.</p> <p><i>position</i> is the desired position of the popup, relative to the <i>parent</i>.</p> </div></div><!-- @@@xdgPopupRequested --> <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="type">void</span> <span class="name">xdgSurfaceCreated</span>(<span class="type"><a href="qml-qtwayland-compositor-xdgsurfacev5.html">XdgSurfaceV5</a></span> <i>xdgSurface</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><p>This signal is emitted when the client has created an <code>xdg_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>xdgSurface</i> in a QtQuick scene.</p> </div></div><!-- @@@xdgSurfaceCreated --> <br/> <!-- $$$xdgSurfaceRequested --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="xdgSurfaceRequested-signal"> <td class="tblQmlFuncNode"><p> <a name="xdgSurfaceRequested-signal"></a><span class="type">void</span> <span class="name">xdgSurfaceRequested</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 an <code>xdg_surface</code> to be associated with <i>surface</i>. The handler for this signal may create the shell surface for <i>resource</i> and initialize it within the scope of the signal emission. Otherwise an <a href="qml-qtwayland-compositor-xdgsurfacev5.html">XdgSurfaceV5</a> will be created automatically.</p> </div></div><!-- @@@xdgSurfaceRequested --> <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>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>Sends a ping event to the <i>client</i>. If the client replies to the event, the pong signal will be emitted.</p> </div></div><!-- @@@ping --> <br/> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2017 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>