<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qquickpopup.cpp --> <title>Popup QML Type | Qt Labs Controls 5.6</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> window.onload = function(){document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");}; </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.6</td><td ><a href="qtlabscontrols-index.html">Qt Labs Controls</a></td><td ><a href="qt-labs-controls-qmlmodule.html">QML Types</a></td><td >Popup QML Type</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.6.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="#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">Popup QML Type</h1> <span class="subtitle"></span> <!-- $$$Popup-brief --> <p>A popup control. <a href="#details">More...</a></p> <!-- @@@Popup --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Qt.labs.controls 1.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qt-labs-controls-menu.html">Menu</a></p> </td></tr></table></div><ul> <li><a href="qml-qt-labs-controls-popup-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-qt-labs-controls-popup.html#activeFocus-prop">activeFocus</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#availableHeight-prop">availableHeight</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#availableWidth-prop">availableWidth</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#background-prop">background</a></b></b> : Item</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#bottomMargin-prop">bottomMargin</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#bottomPadding-prop">bottomPadding</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#clip-prop">clip</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#closePolicy-prop">closePolicy</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#contentChildren-prop">contentChildren</a></b></b> : list<Item></li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#contentData-prop">contentData</a></b></b> : list<Object></li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#contentHeight-prop">contentHeight</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#contentItem-prop">contentItem</a></b></b> : Item</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#contentWidth-prop">contentWidth</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#data-prop">data</a></b></b> : list<Object></li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#enter-prop">enter</a></b></b> : Transition</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#exit-prop">exit</a></b></b> : Transition</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#focus-prop">focus</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#height-prop">height</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#implicitHeight-prop">implicitHeight</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#implicitWidth-prop">implicitWidth</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#leftMargin-prop">leftMargin</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#leftPadding-prop">leftPadding</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#margins-prop">margins</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#modal-prop">modal</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#opacity-prop">opacity</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#padding-prop">padding</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#parent-prop">parent</a></b></b> : Item</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#rightMargin-prop">rightMargin</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#rightPadding-prop">rightPadding</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#scale-prop">scale</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#topMargin-prop">topMargin</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#topPadding-prop">topPadding</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#transformOrigin-prop">transformOrigin</a></b></b> : enumeration</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#visible-prop">visible</a></b></b> : bool</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#width-prop">width</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#x-prop">x</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#y-prop">y</a></b></b> : real</li> <li class="fn"><b><b><a href="qml-qt-labs-controls-popup.html#z-prop">z</a></b></b> : real</li> </ul> <a name="methods"></a> <h2 id="methods">Methods</h2> <ul> <li class="fn">void <b><b><a href="qml-qt-labs-controls-popup.html#close-method">close</a></b></b>()</li> <li class="fn">void <b><b><a href="qml-qt-labs-controls-popup.html#open-method">open</a></b></b>()</li> </ul> <!-- $$$Popup-description --> <a name="details"></a> <h2 id="details">Detailed Description</h2> </p> <p>Popup is the base type of popup-like user interface controls. It can be used with Window or <a href="qml-qt-labs-controls-applicationwindow.html">ApplicationWindow</a>.</p> <pre class="qml"> import QtQuick.Window 2.2 import Qt.labs.controls 1.0 <span class="type">Window</span> { <span class="name">id</span>: <span class="name">window</span> <span class="name">width</span>: <span class="number">400</span> <span class="name">height</span>: <span class="number">400</span> <span class="name">visible</span>: <span class="number">true</span> <span class="type"><a href="qml-qt-labs-controls-button.html">Button</a></span> { <span class="name">text</span>: <span class="string">"Open"</span> <span class="name">onClicked</span>: <span class="name">popup</span>.<span class="name">open</span>() } <span class="type"><a href="qml-qt-labs-controls-popup.html">Popup</a></span> { <span class="name">id</span>: <span class="name">popup</span> <span class="name">x</span>: <span class="number">100</span> <span class="name">y</span>: <span class="number">100</span> <span class="name">width</span>: <span class="number">200</span> <span class="name">height</span>: <span class="number">300</span> <span class="name">modal</span>: <span class="number">true</span> <span class="name">focus</span>: <span class="number">true</span> <span class="name">closePolicy</span>: <span class="name">Popup</span>.<span class="name">OnEscape</span> <span class="operator">|</span> <span class="name">Popup</span>.<span class="name">OnPressOutside</span> } } </pre> <p>In order to ensure that a popup is displayed above other items in the scene, it is recommended to use <a href="qml-qt-labs-controls-applicationwindow.html">ApplicationWindow</a>. <a href="qml-qt-labs-controls-applicationwindow.html">ApplicationWindow</a> also provides background dimming effects.</p> <p><b>Note: </b><i>Types in the Qt.labs module are not guaranteed to remain compatible in future versions.</i></p><!-- @@@Popup --> <h2>Property Documentation</h2> <!-- $$$activeFocus --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="activeFocus-prop"> <td class="tblQmlPropNode"><p> <a name="activeFocus-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">activeFocus</span> : <span class="type">bool</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds whether the popup has active focus.</p> </div></div><!-- @@@activeFocus --> <br/> <!-- $$$availableHeight --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="availableHeight-prop"> <td class="tblQmlPropNode"><p> <a name="availableHeight-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">availableHeight</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the height available after deducting vertical padding.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#padding-prop">padding</a>, <a href="qml-qt-labs-controls-popup.html#topPadding-prop">topPadding</a>, and <a href="qml-qt-labs-controls-popup.html#bottomPadding-prop">bottomPadding</a>.</p> </div></div><!-- @@@availableHeight --> <br/> <!-- $$$availableWidth --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="availableWidth-prop"> <td class="tblQmlPropNode"><p> <a name="availableWidth-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">availableWidth</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the width available after deducting horizontal padding.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#padding-prop">padding</a>, <a href="qml-qt-labs-controls-popup.html#leftPadding-prop">leftPadding</a>, and <a href="qml-qt-labs-controls-popup.html#rightPadding-prop">rightPadding</a>.</p> </div></div><!-- @@@availableWidth --> <br/> <!-- $$$background --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="background-prop"> <td class="tblQmlPropNode"><p> <a name="background-prop"></a><span class="name">background</span> : <span class="type">Item</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the background item.</p> <p><b>Note: </b>If the background item has no explicit size specified, it automatically follows the popup's size. In most cases, there is no need to specify width or height for a background item.</p></div></div><!-- @@@background --> <br/> <!-- $$$bottomMargin --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="bottomMargin-prop"> <td class="tblQmlPropNode"><p> <a name="bottomMargin-prop"></a><span class="name">bottomMargin</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the bottom margin around the popup.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#margins-prop">margins</a> and <a href="qml-qt-labs-controls-popup.html#topMargin-prop">topMargin</a>.</p> </div></div><!-- @@@bottomMargin --> <br/> <!-- $$$bottomPadding --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="bottomPadding-prop"> <td class="tblQmlPropNode"><p> <a name="bottomPadding-prop"></a><span class="name">bottomPadding</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the bottom padding.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#padding-prop">padding</a>, <a href="qml-qt-labs-controls-popup.html#topPadding-prop">topPadding</a>, and <a href="qml-qt-labs-controls-popup.html#availableHeight-prop">availableHeight</a>.</p> </div></div><!-- @@@bottomPadding --> <br/> <!-- $$$clip --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="clip-prop"> <td class="tblQmlPropNode"><p> <a name="clip-prop"></a><span class="name">clip</span> : <span class="type">bool</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds whether clipping is enabled. The default value is <code>false</code>.</p> </div></div><!-- @@@clip --> <br/> <!-- $$$closePolicy --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="closePolicy-prop"> <td class="tblQmlPropNode"><p> <a name="closePolicy-prop"></a><span class="name">closePolicy</span> : <span class="type">enumeration</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property determines the circumstances under which the popup closes. The flags can be combined to allow several ways of closing the popup.</p> <p>The available 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>Popup.NoAutoClose</code></td><td class="topAlign">The popup will only close when manually instructed to do so.</td></tr> <tr><td class="topAlign"><code>Popup.OnPressOutside</code></td><td class="topAlign">The popup will close when the mouse is pressed outside of it.</td></tr> <tr><td class="topAlign"><code>Popup.OnPressOutsideParent</code></td><td class="topAlign">The popup will close when the mouse is pressed outside of its parent.</td></tr> <tr><td class="topAlign"><code>Popup.OnReleaseOutside</code></td><td class="topAlign">The popup will close when the mouse is released outside of it.</td></tr> <tr><td class="topAlign"><code>Popup.OnReleaseOutsideParent</code></td><td class="topAlign">The popup will close when the mouse is released outside of its parent.</td></tr> <tr><td class="topAlign"><code>Popup.OnEscape</code></td><td class="topAlign">The popup will close when the escape key is pressed while the popup has active focus.</td></tr> </table></div> <p>The default value is <code>Popup.OnEscape</code>.</p> </div></div><!-- @@@closePolicy --> <br/> <!-- $$$contentChildren --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="contentChildren-prop"> <td class="tblQmlPropNode"><p> <a name="contentChildren-prop"></a><span class="name">contentChildren</span> : <span class="type">list</span><<span class="type">Item</span>></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the list of content children.</p> <p><b>See also </b>Item::children.</p> </div></div><!-- @@@contentChildren --> <br/> <!-- $$$contentData --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="contentData-prop"> <td class="tblQmlPropNode"><p> <a name="contentData-prop"></a><span class="qmldefault">[default] </span><span class="name">contentData</span> : <span class="type">list</span><<span class="type">Object</span>></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the list of content data.</p> <p><b>See also </b>Item::data.</p> </div></div><!-- @@@contentData --> <br/> <!-- $$$contentHeight --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="contentHeight-prop"> <td class="tblQmlPropNode"><p> <a name="contentHeight-prop"></a><span class="name">contentHeight</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the content height. It is used for calculating the total implicit height of the Popup.</p> <p><b>Note: </b>If only a single item is used within the Popup, the implicit height of its contained item is used as the content height.</p></div></div><!-- @@@contentHeight --> <br/> <!-- $$$contentItem --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="contentItem-prop"> <td class="tblQmlPropNode"><p> <a name="contentItem-prop"></a><span class="name">contentItem</span> : <span class="type">Item</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the content item of the popup.</p> <p>The content item is the visual implementation of the popup. When the popup is made visible, the content item is automatically reparented to the <a href="qml-qt-labs-controls-applicationwindow.html#overlay-attached-prop">overlay item</a> of its application window.</p> </div></div><!-- @@@contentItem --> <br/> <!-- $$$contentWidth --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="contentWidth-prop"> <td class="tblQmlPropNode"><p> <a name="contentWidth-prop"></a><span class="name">contentWidth</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the content width. It is used for calculating the total implicit width of the Popup.</p> <p><b>Note: </b>If only a single item is used within the Popup, the implicit width of its contained item is used as the content width.</p></div></div><!-- @@@contentWidth --> <br/> <!-- $$$data --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="data-prop"> <td class="tblQmlPropNode"><p> <a name="data-prop"></a><span class="qmldefault">[default] </span><span class="name">data</span> : <span class="type">list</span><<span class="type">Object</span>></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the list of data.</p> <p><b>See also </b>Item::data.</p> </div></div><!-- @@@data --> <br/> <!-- $$$enter --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="enter-prop"> <td class="tblQmlPropNode"><p> <a name="enter-prop"></a><span class="name">enter</span> : <span class="type">Transition</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the transition that is applied to the content item when the popup is opened and enters the screen.</p> </div></div><!-- @@@enter --> <br/> <!-- $$$exit --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="exit-prop"> <td class="tblQmlPropNode"><p> <a name="exit-prop"></a><span class="name">exit</span> : <span class="type">Transition</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the transition that is applied to the content item when the popup is closed and exits the screen.</p> </div></div><!-- @@@exit --> <br/> <!-- $$$focus --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="focus-prop"> <td class="tblQmlPropNode"><p> <a name="focus-prop"></a><span class="name">focus</span> : <span class="type">bool</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds whether the popup has focus. The default value is <code>false</code>.</p> </div></div><!-- @@@focus --> <br/> <!-- $$$height --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="height-prop"> <td class="tblQmlPropNode"><p> <a name="height-prop"></a><span class="name">height</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the height of the popup.</p> </div></div><!-- @@@height --> <br/> <!-- $$$implicitHeight --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="implicitHeight-prop"> <td class="tblQmlPropNode"><p> <a name="implicitHeight-prop"></a><span class="name">implicitHeight</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the implicit height of the popup.</p> </div></div><!-- @@@implicitHeight --> <br/> <!-- $$$implicitWidth --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="implicitWidth-prop"> <td class="tblQmlPropNode"><p> <a name="implicitWidth-prop"></a><span class="name">implicitWidth</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the implicit width of the popup.</p> </div></div><!-- @@@implicitWidth --> <br/> <!-- $$$leftMargin --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="leftMargin-prop"> <td class="tblQmlPropNode"><p> <a name="leftMargin-prop"></a><span class="name">leftMargin</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the left margin around the popup.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#margins-prop">margins</a> and <a href="qml-qt-labs-controls-popup.html#rightMargin-prop">rightMargin</a>.</p> </div></div><!-- @@@leftMargin --> <br/> <!-- $$$leftPadding --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="leftPadding-prop"> <td class="tblQmlPropNode"><p> <a name="leftPadding-prop"></a><span class="name">leftPadding</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the left padding.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#padding-prop">padding</a>, <a href="qml-qt-labs-controls-popup.html#rightPadding-prop">rightPadding</a>, and <a href="qml-qt-labs-controls-popup.html#availableWidth-prop">availableWidth</a>.</p> </div></div><!-- @@@leftPadding --> <br/> <!-- $$$margins --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="margins-prop"> <td class="tblQmlPropNode"><p> <a name="margins-prop"></a><span class="name">margins</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the default margins around the popup.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#topMargin-prop">topMargin</a>, <a href="qml-qt-labs-controls-popup.html#leftMargin-prop">leftMargin</a>, <a href="qml-qt-labs-controls-popup.html#rightMargin-prop">rightMargin</a>, and <a href="qml-qt-labs-controls-popup.html#bottomMargin-prop">bottomMargin</a>.</p> </div></div><!-- @@@margins --> <br/> <!-- $$$modal --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="modal-prop"> <td class="tblQmlPropNode"><p> <a name="modal-prop"></a><span class="name">modal</span> : <span class="type">bool</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds whether the popup is modal. The default value is <code>false</code>.</p> </div></div><!-- @@@modal --> <br/> <!-- $$$opacity --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="opacity-prop"> <td class="tblQmlPropNode"><p> <a name="opacity-prop"></a><span class="name">opacity</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the opacity of the popup. The default value is <code>1.0</code>.</p> </div></div><!-- @@@opacity --> <br/> <!-- $$$padding --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="padding-prop"> <td class="tblQmlPropNode"><p> <a name="padding-prop"></a><span class="name">padding</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the default padding.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#availableWidth-prop">availableWidth</a>, <a href="qml-qt-labs-controls-popup.html#availableHeight-prop">availableHeight</a>, <a href="qml-qt-labs-controls-popup.html#topPadding-prop">topPadding</a>, <a href="qml-qt-labs-controls-popup.html#leftPadding-prop">leftPadding</a>, <a href="qml-qt-labs-controls-popup.html#rightPadding-prop">rightPadding</a>, and <a href="qml-qt-labs-controls-popup.html#bottomPadding-prop">bottomPadding</a>.</p> </div></div><!-- @@@padding --> <br/> <!-- $$$parent --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="parent-prop"> <td class="tblQmlPropNode"><p> <a name="parent-prop"></a><span class="name">parent</span> : <span class="type">Item</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the parent item.</p> </div></div><!-- @@@parent --> <br/> <!-- $$$rightMargin --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="rightMargin-prop"> <td class="tblQmlPropNode"><p> <a name="rightMargin-prop"></a><span class="name">rightMargin</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the right margin around the popup.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#margins-prop">margins</a> and <a href="qml-qt-labs-controls-popup.html#leftMargin-prop">leftMargin</a>.</p> </div></div><!-- @@@rightMargin --> <br/> <!-- $$$rightPadding --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="rightPadding-prop"> <td class="tblQmlPropNode"><p> <a name="rightPadding-prop"></a><span class="name">rightPadding</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the right padding.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#padding-prop">padding</a>, <a href="qml-qt-labs-controls-popup.html#leftPadding-prop">leftPadding</a>, and <a href="qml-qt-labs-controls-popup.html#availableWidth-prop">availableWidth</a>.</p> </div></div><!-- @@@rightPadding --> <br/> <!-- $$$scale --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="scale-prop"> <td class="tblQmlPropNode"><p> <a name="scale-prop"></a><span class="name">scale</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the scale factor of the popup. The default value is <code>1.0</code>.</p> </div></div><!-- @@@scale --> <br/> <!-- $$$topMargin --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="topMargin-prop"> <td class="tblQmlPropNode"><p> <a name="topMargin-prop"></a><span class="name">topMargin</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the top margin around the popup.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#margins-prop">margins</a> and <a href="qml-qt-labs-controls-popup.html#bottomMargin-prop">bottomMargin</a>.</p> </div></div><!-- @@@topMargin --> <br/> <!-- $$$topPadding --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="topPadding-prop"> <td class="tblQmlPropNode"><p> <a name="topPadding-prop"></a><span class="name">topPadding</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the top padding.</p> <p><b>See also </b><a href="qml-qt-labs-controls-popup.html#padding-prop">padding</a>, <a href="qml-qt-labs-controls-popup.html#bottomPadding-prop">bottomPadding</a>, and <a href="qml-qt-labs-controls-popup.html#availableHeight-prop">availableHeight</a>.</p> </div></div><!-- @@@topPadding --> <br/> <!-- $$$transformOrigin --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="transformOrigin-prop"> <td class="tblQmlPropNode"><p> <a name="transformOrigin-prop"></a><span class="name">transformOrigin</span> : <span class="type">enumeration</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the origin point for transformations in enter and exit transitions.</p> <p>Nine transform origins are available, as shown in the image below. The default transform origin is <code>Popup.Center</code>.</p> <p class="centerAlign"><img src="images/qtlabscontrols-popup-transformorigin.png" alt="" /></p><p><b>See also </b><a href="qml-qt-labs-controls-popup.html#enter-prop">enter</a>, <a href="qml-qt-labs-controls-popup.html#exit-prop">exit</a>, and Item::transformOrigin.</p> </div></div><!-- @@@transformOrigin --> <br/> <!-- $$$visible --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="visible-prop"> <td class="tblQmlPropNode"><p> <a name="visible-prop"></a><span class="name">visible</span> : <span class="type">bool</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds whether the popup is visible. The default value is <code>false</code>.</p> </div></div><!-- @@@visible --> <br/> <!-- $$$width --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="width-prop"> <td class="tblQmlPropNode"><p> <a name="width-prop"></a><span class="name">width</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the width of the popup.</p> </div></div><!-- @@@width --> <br/> <!-- $$$x --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="x-prop"> <td class="tblQmlPropNode"><p> <a name="x-prop"></a><span class="name">x</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the x-coordinate of the popup.</p> </div></div><!-- @@@x --> <br/> <!-- $$$y --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="y-prop"> <td class="tblQmlPropNode"><p> <a name="y-prop"></a><span class="name">y</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the y-coordinate of the popup.</p> </div></div><!-- @@@y --> <br/> <!-- $$$z --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="z-prop"> <td class="tblQmlPropNode"><p> <a name="z-prop"></a><span class="name">z</span> : <span class="type">real</span></p></td></tr> </table></div> </div><div class="qmldoc"><p>This property holds the z-value of the popup. Z-value determines the stacking order of popups. The default z-value is <code>0</code>.</p> </div></div><!-- @@@z --> <br/> <h2>Method Documentation</h2> <!-- $$$close --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="close-method"> <td class="tblQmlFuncNode"><p> <a name="close-method"></a><span class="type">void</span> <span class="name">close</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>Closes the popup.</p> </div></div><!-- @@@close --> <br/> <!-- $$$open --> <div class="qmlitem"><div class="qmlproto"> <div class="table"><table class="qmlname"> <tr valign="top" class="odd" id="open-method"> <td class="tblQmlFuncNode"><p> <a name="open-method"></a><span class="type">void</span> <span class="name">open</span>()</p></td></tr> </table></div> </div><div class="qmldoc"><p>Opens the popup.</p> </div></div><!-- @@@open --> <br/> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2016 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>