<?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>QWaylandXdgShellV5 Class | 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="qtwaylandcompositor-module.html">C++ Classes</a></td><td >QWaylandXdgShellV5</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="#public-functions">Public Functions</a></li> <li class="level1"><a href="#reimplemented-public-functions">Reimplemented 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">QWaylandXdgShellV5 Class</h1> <!-- $$$QWaylandXdgShellV5-brief --> <p>The <a href="qwaylandxdgshellv5.html">QWaylandXdgShellV5</a> class is an extension for desktop-style user interfaces. <a href="#details">More...</a></p> <!-- @@@QWaylandXdgShellV5 --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QWaylandXdgShellV5></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><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> QWaylandShellTemplate</td></tr></table></div><ul> <li><a href="qwaylandxdgshellv5-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="qwaylandxdgshellv5.html#QWaylandXdgShellV5">QWaylandXdgShellV5</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgshellv5.html#QWaylandXdgShellV5-1">QWaylandXdgShellV5</a></b>(QWaylandCompositor *<i>compositor</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QWaylandClient *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgshellv5.html#popupClient">popupClient</a></b>() const</td></tr> </table></div> <a name="reimplemented-public-functions"></a> <h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgshellv5.html#initialize">initialize</a></b>() override</td></tr> </table></div> <ul> <li class="fn">2 public functions inherited from <a href="qwaylandshell.html#public-functions">QWaylandShell</a></li> <li class="fn">4 public functions inherited from <a href="qwaylandcompositorextension.html#public-functions">QWaylandCompositorExtension</a></li> <li class="fn">5 public functions inherited from <a href="qwaylandobject.html#public-functions">QWaylandObject</a></li> </ul> <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="qwaylandxdgshellv5.html#closeAllPopups">closeAllPopups</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgshellv5.html#ping">ping</a></b>(QWaylandClient *<i>client</i>)</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="qwaylandxdgshellv5.html#pong">pong</a></b>(uint <i>serial</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgshellv5.html#xdgPopupCreated">xdgPopupCreated</a></b>(QWaylandXdgPopupV5 *<i>xdgPopup</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgshellv5.html#xdgPopupRequested">xdgPopupRequested</a></b>(QWaylandSurface *<i>surface</i>, QWaylandSurface *<i>parent</i>, QWaylandSeat *<i>seat</i>, const QPoint &<i>position</i>, const QWaylandResource &<i>resource</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgshellv5.html#xdgSurfaceCreated">xdgSurfaceCreated</a></b>(QWaylandXdgSurfaceV5 *<i>xdgSurface</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgshellv5.html#xdgSurfaceRequested">xdgSurfaceRequested</a></b>(QWaylandSurface *<i>surface</i>, const QWaylandResource &<i>resource</i>)</td></tr> </table></div> <ul> <li class="fn">1 signal inherited from <a href="qwaylandshell.html#signals">QWaylandShell</a></li> </ul> <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"> QByteArray </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgshellv5.html#interfaceName">interfaceName</a></b>()</td></tr> </table></div> <h3>Additional Inherited Members</h3> <ul> <li class="fn">1 property inherited from <a href="qwaylandshell.html#properties">QWaylandShell</a></li> <li class="fn">1 protected function inherited from <a href="qwaylandcompositorextension.html#protected-functions">QWaylandCompositorExtension</a></li> </ul> <a name="details"></a> <!-- $$$QWaylandXdgShellV5-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qwaylandxdgshellv5.html">QWaylandXdgShellV5</a> class is an extension for desktop-style user interfaces.</p> <p>The <a href="qwaylandxdgshellv5.html">QWaylandXdgShellV5</a> extension provides a way to associate a <a href="qwaylandxdgsurfacev5.html">QWaylandXdgSurfaceV5</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="qwaylandxdgshellv5.html">QWaylandXdgShellV5</a> corresponds to the Wayland interface <code>xdg_shell</code>.</p> </div> <!-- @@@QWaylandXdgShellV5 --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QWaylandXdgShellV5[overload1]$$$QWaylandXdgShellV5 --> <h3 class="fn" id="QWaylandXdgShellV5"><a name="QWaylandXdgShellV5"></a>QWaylandXdgShellV5::<span class="name">QWaylandXdgShellV5</span>()</h3> <p>Constructs a <a href="qwaylandxdgshellv5.html">QWaylandXdgShellV5</a> object.</p> <!-- @@@QWaylandXdgShellV5 --> <!-- $$$QWaylandXdgShellV5$$$QWaylandXdgShellV5QWaylandCompositor* --> <h3 class="fn" id="QWaylandXdgShellV5-1"><a name="QWaylandXdgShellV5-1"></a>QWaylandXdgShellV5::<span class="name">QWaylandXdgShellV5</span>(<span class="type"><a href="qwaylandcompositor.html">QWaylandCompositor</a></span> *<i>compositor</i>)</h3> <p>Constructs a <a href="qwaylandxdgshellv5.html">QWaylandXdgShellV5</a> object for the provided <i>compositor</i>.</p> <!-- @@@QWaylandXdgShellV5 --> <!-- $$$closeAllPopups[overload1]$$$closeAllPopups --> <h3 class="fn" id="closeAllPopups"><a name="closeAllPopups"></a><code>[slot] </code><span class="type">void</span> QWaylandXdgShellV5::<span class="name">closeAllPopups</span>()</h3> <!-- @@@closeAllPopups --> <!-- $$$initialize[overload1]$$$initialize --> <h3 class="fn" id="initialize"><a name="initialize"></a><code>[override virtual] </code><span class="type">void</span> QWaylandXdgShellV5::<span class="name">initialize</span>()</h3> <p>Initializes the shell extension.</p> <!-- @@@initialize --> <!-- $$$interfaceName[overload1]$$$interfaceName --> <h3 class="fn" id="interfaceName"><a name="interfaceName"></a><code>[static] </code><span class="type">QByteArray</span> QWaylandXdgShellV5::<span class="name">interfaceName</span>()</h3> <!-- @@@interfaceName --> <!-- $$$ping[overload1]$$$pingQWaylandClient* --> <h3 class="fn" id="ping"><a name="ping"></a><code>[slot] </code><span class="type">uint</span> QWaylandXdgShellV5::<span class="name">ping</span>(<span class="type"><a href="qwaylandclient.html">QWaylandClient</a></span> *<i>client</i>)</h3> <p>Sends a ping event to the <i>client</i>. If the client replies to the event, the pong signal will be emitted.</p> <!-- @@@ping --> <!-- $$$pong[overload1]$$$ponguint --> <h3 class="fn" id="pong"><a name="pong"></a><code>[signal] </code><span class="type">void</span> QWaylandXdgShellV5::<span class="name">pong</span>(<span class="type">uint</span> <i>serial</i>)</h3> <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="qwaylandxdgshellv5.html#ping">QWaylandXdgShellV5::ping</a>().</p> <!-- @@@pong --> <!-- $$$popupClient[overload1]$$$popupClient --> <h3 class="fn" id="popupClient"><a name="popupClient"></a><span class="type"><a href="qwaylandclient.html">QWaylandClient</a></span> *QWaylandXdgShellV5::<span class="name">popupClient</span>() const</h3> <!-- @@@popupClient --> <!-- $$$xdgPopupCreated[overload1]$$$xdgPopupCreatedQWaylandXdgPopupV5* --> <h3 class="fn" id="xdgPopupCreated"><a name="xdgPopupCreated"></a><code>[signal] </code><span class="type">void</span> QWaylandXdgShellV5::<span class="name">xdgPopupCreated</span>(<span class="type"><a href="qwaylandxdgpopupv5.html">QWaylandXdgPopupV5</a></span> *<i>xdgPopup</i>)</h3> <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 QWaylandShellSurfaceItem or <a href="qwaylandquickitem.html">QWaylandQuickItem</a> for displaying <i>xdgPopup</i> in a QtQuick scene.</p> <!-- @@@xdgPopupCreated --> <!-- $$$xdgPopupRequested[overload1]$$$xdgPopupRequestedQWaylandSurface*QWaylandSurface*QWaylandSeat*constQPoint&constQWaylandResource& --> <h3 class="fn" id="xdgPopupRequested"><a name="xdgPopupRequested"></a><code>[signal] </code><span class="type">void</span> QWaylandXdgShellV5::<span class="name">xdgPopupRequested</span>(<span class="type"><a href="qwaylandsurface.html">QWaylandSurface</a></span> *<i>surface</i>, <span class="type"><a href="qwaylandsurface.html">QWaylandSurface</a></span> *<i>parent</i>, <span class="type"><a href="qwaylandseat.html">QWaylandSeat</a></span> *<i>seat</i>, const <span class="type">QPoint</span> &<i>position</i>, const <span class="type">QWaylandResource</span> &<i>resource</i>)</h3> <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 xdg poup for <i>resource</i> and initialize it within the scope of the signal emission. Otherwise a <a href="qwaylandxdgpopupv5.html">QWaylandXdgPopupV5</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> <!-- @@@xdgPopupRequested --> <!-- $$$xdgSurfaceCreated[overload1]$$$xdgSurfaceCreatedQWaylandXdgSurfaceV5* --> <h3 class="fn" id="xdgSurfaceCreated"><a name="xdgSurfaceCreated"></a><code>[signal] </code><span class="type">void</span> QWaylandXdgShellV5::<span class="name">xdgSurfaceCreated</span>(<span class="type"><a href="qwaylandxdgsurfacev5.html">QWaylandXdgSurfaceV5</a></span> *<i>xdgSurface</i>)</h3> <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 QWaylandShellSurfaceItem or <a href="qwaylandquickitem.html">QWaylandQuickItem</a> for displaying <i>xdgSurface</i> in a QtQuick scene.</p> <!-- @@@xdgSurfaceCreated --> <!-- $$$xdgSurfaceRequested[overload1]$$$xdgSurfaceRequestedQWaylandSurface*constQWaylandResource& --> <h3 class="fn" id="xdgSurfaceRequested"><a name="xdgSurfaceRequested"></a><code>[signal] </code><span class="type">void</span> QWaylandXdgShellV5::<span class="name">xdgSurfaceRequested</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 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 a <a href="qwaylandxdgsurfacev5.html">QWaylandXdgSurfaceV5</a> will be created automatically.</p> <!-- @@@xdgSurfaceRequested --> </div> </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>