<?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>QWaylandXdgPopupV6 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 >QWaylandXdgPopupV6</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="#properties">Properties</a></li> <li class="level1"><a href="#public-functions">Public Functions</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">QWaylandXdgPopupV6 Class</h1> <!-- $$$QWaylandXdgPopupV6-brief --> <p>The <a href="qwaylandxdgpopupv6.html">QWaylandXdgPopupV6</a> class represents the popup specific parts of an xdg surface. <a href="#details">More...</a></p> <!-- @@@QWaylandXdgPopupV6 --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QWaylandXdgPopupV6></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.10</td></tr></table></div><ul> <li><a href="qwaylandxdgpopupv6-members.html">List of all members, including inherited members</a></li> </ul> <a name="properties"></a> <h2 id="properties">Properties</h2> <div class="table"><table class="propsummary"> <tr><td class="topAlign"><ul> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#anchorEdges-prop">anchorEdges</a></b> : const Qt::Edges</li> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#anchorRect-prop">anchorRect</a></b> : const QRect</li> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#configuredGeometry-prop">configuredGeometry</a></b> : const QRect</li> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#flipConstraints-prop">flipConstraints</a></b> : const Qt::Orientations</li> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#gravityEdges-prop">gravityEdges</a></b> : const Qt::Edges</li> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#offset-prop">offset</a></b> : const QPoint</li> </ul></td><td class="topAlign"><ul> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#parentXdgSurface-prop">parentXdgSurface</a></b> : QWaylandXdgSurfaceV6* const</li> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#positionerSize-prop">positionerSize</a></b> : const QSize</li> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#resizeConstraints-prop">resizeConstraints</a></b> : const Qt::Orientations</li> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#slideConstraints-prop">slideConstraints</a></b> : const Qt::Orientations</li> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#unconstrainedPosition-prop">unconstrainedPosition</a></b> : const QPoint</li> <li class="fn"><b><a href="qwaylandxdgpopupv6.html#xdgSurface-prop">xdgSurface</a></b> : QWaylandXdgSurfaceV6* const</li> </ul> </td></tr> </table></div> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Qt::Edges </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#anchorEdges-prop">anchorEdges</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QRect </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#anchorRect-prop">anchorRect</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QRect </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#configuredGeometry-prop">configuredGeometry</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt::Orientations </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#flipConstraints-prop">flipConstraints</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt::Edges </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#gravityEdges-prop">gravityEdges</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QPoint </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#offset-prop">offset</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QWaylandXdgSurfaceV6 *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#parentXdgSurface-prop">parentXdgSurface</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QSize </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#positionerSize-prop">positionerSize</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt::Orientations </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#resizeConstraints-prop">resizeConstraints</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> uint </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#sendConfigure">sendConfigure</a></b>(const QRect &<i>geometry</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt::Orientations </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#slideConstraints-prop">slideConstraints</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QPoint </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#unconstrainedPosition-prop">unconstrainedPosition</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QWaylandXdgSurfaceV6 *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#xdgSurface-prop">xdgSurface</a></b>() const</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="qwaylandxdgpopupv6.html#configuredGeometry-prop">configuredGeometryChanged</a></b>()</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"> QWaylandSurfaceRole *</td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#role">role</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qwaylandxdgpopupv6.html#staticMetaObject-var">staticMetaObject</a></b></td></tr> </table></div> <a name="details"></a> <!-- $$$QWaylandXdgPopupV6-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qwaylandxdgpopupv6.html">QWaylandXdgPopupV6</a> class represents the popup specific parts of an xdg surface.</p> <p>This class is part of the <a href="qwaylandxdgshellv6.html">QWaylandXdgShellV6</a> extension and provides a way to extend the functionality of a <a href="qwaylandxdgsurfacev6.html">QWaylandXdgSurfaceV6</a> with features specific to desktop-style menus for an xdg surface.</p> <p>It corresponds to the Wayland interface <code>zxdg_popup_v6</code>.</p> </div> <!-- @@@QWaylandXdgPopupV6 --> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$anchorEdges-prop$$$anchorEdges --> <h3 class="fn" id="anchorEdges-prop"><a name="anchorEdges-prop"></a><span class="name">anchorEdges</span> : const <span class="type">Qt::Edges</span></h3> <p>Returns the set of edges on the anchor rect that the child surface should be placed relative to. If no edges are specified in a direction, the anchor point should be centered between the edges.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Qt::Edges </td><td class="memItemRight bottomAlign"><span class="name"><b>anchorEdges</b></span>() const</td></tr> </table></div> <!-- @@@anchorEdges --> <!-- $$$anchorRect-prop$$$anchorRect --> <h3 class="fn" id="anchorRect-prop"><a name="anchorRect-prop"></a><span class="name">anchorRect</span> : const <span class="type">QRect</span></h3> <p>Returns the anchor rectangle relative to the parent window geometry that the child surface should be placed relative to.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QRect </td><td class="memItemRight bottomAlign"><span class="name"><b>anchorRect</b></span>() const</td></tr> </table></div> <!-- @@@anchorRect --> <!-- $$$configuredGeometry-prop$$$configuredGeometry$$$configuredGeometryChanged --> <h3 class="fn" id="configuredGeometry-prop"><a name="configuredGeometry-prop"></a><span class="name">configuredGeometry</span> : const <span class="type">QRect</span></h3> <p>The window geometry the popup received in the configure event. Relative to the upper left corner of the parent surface.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QRect </td><td class="memItemRight bottomAlign"><span class="name"><b>configuredGeometry</b></span>() const</td></tr> </table></div> <p><b>Notifier signal:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>configuredGeometryChanged</b></span>()</td></tr> </table></div> <!-- @@@configuredGeometry --> <!-- $$$flipConstraints-prop$$$flipConstraints --> <h3 class="fn" id="flipConstraints-prop"><a name="flipConstraints-prop"></a><span class="name">flipConstraints</span> : const <span class="type">Qt::Orientations</span></h3> <p>This property holds the orientations in which the child should flip to fit within the screen.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Qt::Orientations </td><td class="memItemRight bottomAlign"><span class="name"><b>flipConstraints</b></span>() const</td></tr> </table></div> <!-- @@@flipConstraints --> <!-- $$$gravityEdges-prop$$$gravityEdges --> <h3 class="fn" id="gravityEdges-prop"><a name="gravityEdges-prop"></a><span class="name">gravityEdges</span> : const <span class="type">Qt::Edges</span></h3> <p>Specifies in what direction the surface should be positioned, relative to the anchor point.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Qt::Edges </td><td class="memItemRight bottomAlign"><span class="name"><b>gravityEdges</b></span>() const</td></tr> </table></div> <!-- @@@gravityEdges --> <!-- $$$offset-prop$$$offset --> <h3 class="fn" id="offset-prop"><a name="offset-prop"></a><span class="name">offset</span> : const <span class="type">QPoint</span></h3> <p>Returns the surface position relative to the position of the anchor on the anchor rectangle and the anchor on the surface.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QPoint </td><td class="memItemRight bottomAlign"><span class="name"><b>offset</b></span>() const</td></tr> </table></div> <!-- @@@offset --> <!-- $$$parentXdgSurface-prop$$$parentXdgSurface --> <h3 class="fn" id="parentXdgSurface-prop"><a name="parentXdgSurface-prop"></a><span class="name">parentXdgSurface</span> : <span class="type"><a href="qwaylandxdgsurfacev6.html">QWaylandXdgSurfaceV6</a></span>* const</h3> <p>This property holds the <a href="qwaylandxdgsurfacev6.html">QWaylandXdgSurfaceV6</a> associated with the parent of this <a href="qwaylandxdgpopupv6.html">QWaylandXdgPopupV6</a>.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QWaylandXdgSurfaceV6 *</td><td class="memItemRight bottomAlign"><span class="name"><b>parentXdgSurface</b></span>() const</td></tr> </table></div> <!-- @@@parentXdgSurface --> <!-- $$$positionerSize-prop$$$positionerSize --> <h3 class="fn" id="positionerSize-prop"><a name="positionerSize-prop"></a><span class="name">positionerSize</span> : const <span class="type">QSize</span></h3> <p>Returns the size requested for the window geometry by the positioner object.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QSize </td><td class="memItemRight bottomAlign"><span class="name"><b>positionerSize</b></span>() const</td></tr> </table></div> <!-- @@@positionerSize --> <!-- $$$resizeConstraints-prop$$$resizeConstraints --> <h3 class="fn" id="resizeConstraints-prop"><a name="resizeConstraints-prop"></a><span class="name">resizeConstraints</span> : const <span class="type">Qt::Orientations</span></h3> <p>This property holds the orientations in which the child should resize to fit within the screen.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Qt::Orientations </td><td class="memItemRight bottomAlign"><span class="name"><b>resizeConstraints</b></span>() const</td></tr> </table></div> <!-- @@@resizeConstraints --> <!-- $$$slideConstraints-prop$$$slideConstraints --> <h3 class="fn" id="slideConstraints-prop"><a name="slideConstraints-prop"></a><span class="name">slideConstraints</span> : const <span class="type">Qt::Orientations</span></h3> <p>This property holds the orientations in which the child should slide to fit within the screen.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Qt::Orientations </td><td class="memItemRight bottomAlign"><span class="name"><b>slideConstraints</b></span>() const</td></tr> </table></div> <!-- @@@slideConstraints --> <!-- $$$unconstrainedPosition-prop$$$unconstrainedPosition --> <h3 class="fn" id="unconstrainedPosition-prop"><a name="unconstrainedPosition-prop"></a><span class="name">unconstrainedPosition</span> : const <span class="type">QPoint</span></h3> <p>The position of the surface relative to the parent window geometry if the surface is not constrained. I.e. when not moved to fit inside the screen or similar.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QPoint </td><td class="memItemRight bottomAlign"><span class="name"><b>unconstrainedPosition</b></span>() const</td></tr> </table></div> <!-- @@@unconstrainedPosition --> <!-- $$$xdgSurface-prop$$$xdgSurface --> <h3 class="fn" id="xdgSurface-prop"><a name="xdgSurface-prop"></a><span class="name">xdgSurface</span> : <span class="type"><a href="qwaylandxdgsurfacev6.html">QWaylandXdgSurfaceV6</a></span>* const</h3> <p>This property holds the <a href="qwaylandxdgsurfacev6.html">QWaylandXdgSurfaceV6</a> associated with this <a href="qwaylandxdgpopupv6.html">QWaylandXdgPopupV6</a>.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QWaylandXdgSurfaceV6 *</td><td class="memItemRight bottomAlign"><span class="name"><b>xdgSurface</b></span>() const</td></tr> </table></div> <!-- @@@xdgSurface --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$role[overload1]$$$role --> <h3 class="fn" id="role"><a name="role"></a><code>[static] </code><span class="type">QWaylandSurfaceRole</span> *QWaylandXdgPopupV6::<span class="name">role</span>()</h3> <p>Returns the surface role for the QWaylandPopupV6.</p> <!-- @@@role --> <!-- $$$sendConfigure[overload1]$$$sendConfigureconstQRect& --> <h3 class="fn" id="sendConfigure"><a name="sendConfigure"></a><span class="type">uint</span> QWaylandXdgPopupV6::<span class="name">sendConfigure</span>(const <span class="type">QRect</span> &<i>geometry</i>)</h3> <p>Sends a configure event to the client. <i>geometry</i> contains the window geometry relative to the upper left corner of the window geometry of the parent surface.</p> <p>This implicitly sends a configure event to the corresponding <a href="qwaylandxdgsurfacev6.html">QWaylandXdgSurfaceV6</a> as well.</p> <p><b>Note: </b>This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.</p> <!-- @@@sendConfigure --> </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>