<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qwaylandxdgshell.cpp --> <title>XdgPopup QML Type | 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="qtwayland-compositor-qmlmodule.html">QML Types</a></td><td >XdgPopup QML Type</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="#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">XdgPopup QML Type</h1> <span class="subtitle"></span> <!-- $$$XdgPopup-brief --> <p><a href="qml-qtwayland-compositor-xdgpopup.html">XdgPopup</a> represents the popup specific parts of and xdg surface. <a href="#details">More...</a></p> <!-- @@@XdgPopup --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtWayland.Compositor 1.3</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.12</td></tr></table></div><ul> <li><a href="qml-qtwayland-compositor-xdgpopup-members.html">List of all members, including inherited members</a></li> </ul> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#anchorEdges-prop">anchorEdges</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#anchorRect-prop">anchorRect</a></b></b> : rect</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#configuredGeometry-prop">configuredGeometry</a></b></b> : rect</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#flipConstraints-prop">flipConstraints</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#gravityEdges-prop">gravityEdges</a></b></b> : rect</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#offset-prop">offset</a></b></b> : point</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#parentXdgSurface-prop">parentXdgSurface</a></b></b> : XdgSurface</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#positionerSize-prop">positionerSize</a></b></b> : size</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#resizeConstraints-prop">resizeConstraints</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#slideConstraints-prop">slideConstraints</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#unconstrainedPosition-prop">unconstrainedPosition</a></b></b> : point</li> <li class="fn"><b><b><a href="qml-qtwayland-compositor-xdgpopup.html#xdgSurface-prop">xdgSurface</a></b></b> : XdgSurface</li> </ul> <a name="methods"></a> <h2 id="methods">Methods</h2> <ul> <li class="fn">int <b><b><a href="qml-qtwayland-compositor-xdgpopup.html#sendConfigure-method">sendConfigure</a></b></b>(rect <i>geometry</i>)</li> </ul> <!-- $$$XdgPopup-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> <p>This type is part of the <a href="qml-qtwayland-compositor-xdgshell.html">XdgShell</a> extension and provides a way to extend extend the functionality of an <a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a> with features specific to desktop-style menus for an xdg surface.</p> <p>It corresponds to the Wayland interface <code>xdg_popup</code>.</p> <!-- @@@XdgPopup --> <h2>Property Documentation</h2> <!-- $$$anchorEdges --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="anchorEdges-prop"> <td class="tblQmlPropNode"><p> <a name="anchorEdges-prop"></a><span class="name">anchorEdges</span> : <span class="type">enumeration</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds 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>The possible values are:</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>Qt.TopEdge</code></td><td class="topAlign">The top edge of the rectangle.</td></tr> <tr><td class="topAlign"><code>Qt.LeftEdge</code></td><td class="topAlign">The left edge of the rectangle.</td></tr> <tr><td class="topAlign"><code>Qt.RightEdge</code></td><td class="topAlign">The right edge of the rectangle.</td></tr> <tr><td class="topAlign"><code>Qt.BottomEdge</code></td><td class="topAlign">The bottom edge of the rectangle.</td></tr> </table></div> </div></div><!-- @@@anchorEdges --> <br/> <!-- $$$anchorRect --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="anchorRect-prop"> <td class="tblQmlPropNode"><p> <a name="anchorRect-prop"></a><span class="name">anchorRect</span> : <span class="type">rect</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>The anchor rectangle relative to the parent window geometry that the child surface should be placed relative to.</p> </div></div><!-- @@@anchorRect --> <br/> <!-- $$$configuredGeometry --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="configuredGeometry-prop"> <td class="tblQmlPropNode"><p> <a name="configuredGeometry-prop"></a><span class="name">configuredGeometry</span> : <span class="type">rect</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>The window geometry the popup received in the configure event. Relative to the upper left corner of the parent surface.</p> </div></div><!-- @@@configuredGeometry --> <br/> <!-- $$$flipConstraints --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="flipConstraints-prop"> <td class="tblQmlPropNode"><p> <a name="flipConstraints-prop"></a><span class="name">flipConstraints</span> : <span class="type">enumeration</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the orientations in which the child should flip to fit within the screen.</p> <p>Possible values:</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>Qt.Horizontal</code></td><td class="topAlign">Horizontal</td></tr> <tr><td class="topAlign"><code>Qt.Vertical</code></td><td class="topAlign">Vertical</td></tr> </table></div> </div></div><!-- @@@flipConstraints --> <br/> <!-- $$$gravityEdges --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="gravityEdges-prop"> <td class="tblQmlPropNode"><p> <a name="gravityEdges-prop"></a><span class="name">gravityEdges</span> : <span class="type">rect</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>Specifies in what direction the surface should be positioned, relative to the anchor point.</p> <p>The possible values are:</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>Qt.TopEdge</code></td><td class="topAlign">The surface should slide towards the top of the screen.</td></tr> <tr><td class="topAlign"><code>Qt.LeftEdge</code></td><td class="topAlign">The surface should slide towards the left of the screen.</td></tr> <tr><td class="topAlign"><code>Qt.RightEdge</code></td><td class="topAlign">The surface should slide towards the right of the screen.</td></tr> <tr><td class="topAlign"><code>Qt.BottomEdge</code></td><td class="topAlign">The surface should slide towards the bottom of the screen.</td></tr> </table></div> </div></div><!-- @@@gravityEdges --> <br/> <!-- $$$offset --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="offset-prop"> <td class="tblQmlPropNode"><p> <a name="offset-prop"></a><span class="name">offset</span> : <span class="type">point</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>The position relative to the position of the anchor on the anchor rectangle and the anchor on the surface.</p> </div></div><!-- @@@offset --> <br/> <!-- $$$parentXdgSurface --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="parentXdgSurface-prop"> <td class="tblQmlPropNode"><p> <a name="parentXdgSurface-prop"></a><span class="name">parentXdgSurface</span> : <span class="type"><a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the <a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a> associated with the parent of this <a href="qml-qtwayland-compositor-xdgpopup.html">XdgPopup</a>.</p> </div></div><!-- @@@parentXdgSurface --> <br/> <!-- $$$positionerSize --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="positionerSize-prop"> <td class="tblQmlPropNode"><p> <a name="positionerSize-prop"></a><span class="name">positionerSize</span> : <span class="type">size</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>The size requested for the window geometry by the positioner object.</p> </div></div><!-- @@@positionerSize --> <br/> <!-- $$$resizeConstraints --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="resizeConstraints-prop"> <td class="tblQmlPropNode"><p> <a name="resizeConstraints-prop"></a><span class="name">resizeConstraints</span> : <span class="type">enumeration</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the orientations in which the child should resize to fit within the screen.</p> <p>Possible values:</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>Qt.Horizontal</code></td><td class="topAlign">Horizontal</td></tr> <tr><td class="topAlign"><code>Qt.Vertical</code></td><td class="topAlign">Vertical</td></tr> </table></div> </div></div><!-- @@@resizeConstraints --> <br/> <!-- $$$slideConstraints --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="slideConstraints-prop"> <td class="tblQmlPropNode"><p> <a name="slideConstraints-prop"></a><span class="name">slideConstraints</span> : <span class="type">enumeration</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the orientations in which the child should slide to fit within the screen.</p> <p>Possible values:</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>Qt.Horizontal</code></td><td class="topAlign">Horizontal</td></tr> <tr><td class="topAlign"><code>Qt.Vertical</code></td><td class="topAlign">Vertical</td></tr> </table></div> </div></div><!-- @@@slideConstraints --> <br/> <!-- $$$unconstrainedPosition --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="unconstrainedPosition-prop"> <td class="tblQmlPropNode"><p> <a name="unconstrainedPosition-prop"></a><span class="name">unconstrainedPosition</span> : <span class="type">point</span></p></td></tr> </table></div> </div><div class="qmldoc"><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> </div></div><!-- @@@unconstrainedPosition --> <br/> <!-- $$$xdgSurface --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="xdgSurface-prop"> <td class="tblQmlPropNode"><p> <a name="xdgSurface-prop"></a><span class="name">xdgSurface</span> : <span class="type"><a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a></span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the <a href="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a> associated with this <a href="qml-qtwayland-compositor-xdgpopup.html">XdgPopup</a>.</p> </div></div><!-- @@@xdgSurface --> <br/> <h2>Method Documentation</h2> <!-- $$$sendConfigure --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="sendConfigure-method"> <td class="tblQmlFuncNode"><p> <a name="sendConfigure-method"></a><span class="type">int</span> <span class="name">sendConfigure</span>(<span class="type">rect</span> <i>geometry</i>)</p></td></tr> </table></div> </div><div class="qmldoc"><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="qml-qtwayland-compositor-xdgsurface.html">XdgSurface</a> as well.</p> </div></div><!-- @@@sendConfigure --> <br/> </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>