/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-popup.html is in qtquickcontrols2-5-doc-html 5.9.5-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 | <?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 Quick Controls 2 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="qtquickcontrols2-index.html">Qt Quick Controls 2</a></td><td ><a href="qtquick-controls2-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.9.5 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="#signals">Signals</a></li>
<li class="level1"><a href="#methods">Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
<li class="level2"><a href="#popup-layout">Popup Layout</a></li>
<li class="level2"><a href="#popup-sizing">Popup Sizing</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>Base type of popup-like user interface controls. <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 QtQuick.Controls 2.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.7</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="../qtqml/qml-qtqml-qtobject.html">QtObject</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls2-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-qtquick-controls2-popup.html#activeFocus-prop">activeFocus</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#availableHeight-prop">availableHeight</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#availableWidth-prop">availableWidth</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#background-prop">background</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#bottomMargin-prop">bottomMargin</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#bottomPadding-prop">bottomPadding</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#clip-prop">clip</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#closePolicy-prop">closePolicy</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#contentChildren-prop">contentChildren</a></b></b> : list<Item></li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#contentData-prop">contentData</a></b></b> : list<Object></li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#contentHeight-prop">contentHeight</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#contentItem-prop">contentItem</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#contentWidth-prop">contentWidth</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#dim-prop">dim</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#enter-prop">enter</a></b></b> : Transition</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#exit-prop">exit</a></b></b> : Transition</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#focus-prop">focus</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#font-prop">font</a></b></b> : font</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#height-prop">height</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#implicitHeight-prop">implicitHeight</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#implicitWidth-prop">implicitWidth</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#leftMargin-prop">leftMargin</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#leftPadding-prop">leftPadding</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#locale-prop">locale</a></b></b> : Locale</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#margins-prop">margins</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#modal-prop">modal</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#opacity-prop">opacity</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#padding-prop">padding</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#parent-prop">parent</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#rightMargin-prop">rightMargin</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#rightPadding-prop">rightPadding</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#scale-prop">scale</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#spacing-prop">spacing</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#topMargin-prop">topMargin</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#topPadding-prop">topPadding</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#transformOrigin-prop">transformOrigin</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#visible-prop">visible</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#width-prop">width</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#x-prop">x</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#y-prop">y</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-popup.html#z-prop">z</a></b></b> : real</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-popup.html#aboutToHide-signal">aboutToHide</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-popup.html#aboutToShow-signal">aboutToShow</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-popup.html#closed-signal">closed</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-popup.html#opened-signal">opened</a></b></b>()</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-popup.html#close-method">close</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-popup.html#forceActiveFocus-method">forceActiveFocus</a></b></b>(<i>reason</i>)</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-popup.html#open-method">open</a></b></b>()</li>
</ul>
<!-- $$$Popup-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>Popup is the base type of popup-like user interface controls. It can be used with <a href="../qtquick/qml-qtquick-window-window.html">Window</a> or <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a>.</p>
<pre class="qml">
import QtQuick.Window 2.2
import QtQuick.Controls 2.1
<span class="type"><a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a></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-qtquick-controls2-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-qtquick-controls2-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">CloseOnEscape</span> <span class="operator">|</span> <span class="name">Popup</span>.<span class="name">CloseOnPressOutsideParent</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-qtquick-controls2-applicationwindow.html">ApplicationWindow</a>. <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a> also provides background dimming effects.</p>
<p>Popup does not provide a layout of its own, but requires you to position its contents, for instance by creating a <a href="../qtquick/qml-qtquick-layouts-rowlayout.html">RowLayout</a> or a <a href="../qtquick/qml-qtquick-layouts-columnlayout.html">ColumnLayout</a>.</p>
<p>Items declared as children of a Popup are automatically parented to the Popups's <a href="qml-qtquick-controls2-popup.html#contentItem-prop">contentItem</a>. Items created dynamically need to be explicitly parented to the <a href="qml-qtquick-controls2-popup.html#contentItem-prop">contentItem</a>.</p>
<a name="popup-layout"></a>
<h2 id="popup-layout">Popup Layout</h2>
<p>The following diagram illustrates the layout of a popup within a window:</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-popup.png" alt="" /></p><p>The <a href="qml-qtquick-controls2-popup.html#implicitWidth-prop">implicitWidth</a> and <a href="qml-qtquick-controls2-popup.html#implicitHeight-prop">implicitHeight</a> of a popup are typically based on the implicit sizes of the background and the content item plus any <a href="qml-qtquick-controls2-popup.html#padding-prop">padding</a>. These properties determine how large the popup will be when no explicit <a href="qml-qtquick-controls2-popup.html#width-prop">width</a> or <a href="qml-qtquick-controls2-popup.html#height-prop">height</a> is specified.</p>
<p>The <a href="qml-qtquick-controls2-popup.html#background-prop">background</a> item fills the entire width and height of the popup, unless an explicit size has been given for it.</p>
<p>The geometry of the <a href="qml-qtquick-controls2-popup.html#contentItem-prop">contentItem</a> is determined by the <a href="qml-qtquick-controls2-popup.html#padding-prop">padding</a>.</p>
<a name="popup-sizing"></a>
<h2 id="popup-sizing">Popup Sizing</h2>
<p>If only a single item is used within a Popup, it will resize to fit the implicit size of its contained item. This makes it particularly suitable for use together with layouts.</p>
<pre class="cpp">
Popup {
ColumnLayout {
anchors<span class="operator">.</span>fill: parent
CheckBox { text: qsTr(<span class="string">"E-mail"</span>) }
CheckBox { text: qsTr(<span class="string">"Calendar"</span>) }
CheckBox { text: qsTr(<span class="string">"Contacts"</span>) }
}
}
</pre>
<p>Sometimes there might be two items within the popup:</p>
<pre class="cpp">
Popup {
SwipeView {
<span class="comment">// ...</span>
}
PageIndicator {
anchors<span class="operator">.</span>horizontalCenter: parent<span class="operator">.</span>horizontalCenter
anchors<span class="operator">.</span>bottom: parent<span class="operator">.</span>bottom
}
}
</pre>
<p>In this case, Popup cannot calculate a sensible implicit size. Since we're anchoring the <a href="qml-qtquick-controls2-pageindicator.html">PageIndicator</a> over the <a href="qml-qtquick-controls2-swipeview.html">SwipeView</a>, we can simply set the content size to the view's implicit size:</p>
<pre class="cpp">
Popup {
contentWidth: view<span class="operator">.</span>implicitWidth
contentHeight: view<span class="operator">.</span>implicitHeight
SwipeView {
id: view
<span class="comment">// ...</span>
}
PageIndicator {
anchors<span class="operator">.</span>horizontalCenter: parent<span class="operator">.</span>horizontalCenter
anchors<span class="operator">.</span>bottom: parent<span class="operator">.</span>bottom
}
}
</pre>
<p><b>See also </b><a href="qtquickcontrols2-popups.html">Popup Controls</a>, <a href="qtquickcontrols2-customize.html#customizing-popup">Customizing Popup</a>, and <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a>.</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>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#focus-prop">focus</a> and <a href="../qtquick/qtquick-input-focus.html">Keyboard Focus in Qt Quick</a>.</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 to the <a href="qml-qtquick-controls2-popup.html#contentItem-prop">contentItem</a> after deducting vertical padding from the <a href="../qtquick/qml-qtquick-item.html#height-prop">height</a> of the popup.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#padding-prop">padding</a>, <a href="qml-qtquick-controls2-popup.html#topPadding-prop">topPadding</a>, and <a href="qml-qtquick-controls2-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 to the <a href="qml-qtquick-controls2-popup.html#contentItem-prop">contentItem</a> after deducting horizontal padding from the <a href="../qtquick/qml-qtquick-item.html#width-prop">width</a> of the popup.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#padding-prop">padding</a>, <a href="qml-qtquick-controls2-popup.html#leftPadding-prop">leftPadding</a>, and <a href="qml-qtquick-controls2-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"><a href="../qtquick/qml-qtquick-item.html">Item</a></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><p><b>Note: </b>Most popups use the implicit size of the background item to calculate the implicit size of the popup itself. If you replace the background item with a custom one, you should also consider providing a sensible implicit size for it (unless it is an item like <a href="../qtquick/qtquick-imageelements-example.html#image">Image</a> which has its own implicit size).</p><p><b>See also </b><a href="qtquickcontrols2-customize.html#customizing-popup">Customizing Popup</a>.</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 distance between the bottom edge of the popup and the bottom edge of its window.</p>
<p>A popup with a negative bottom margin is not pushed within the bottom edge of the enclosing window. The default value is <code>-1</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#margins-prop">margins</a>, <a href="qml-qtquick-controls2-popup.html#topMargin-prop">topMargin</a>, and <a href="qml-qtquick-controls2-popup.html#popup-layout">Popup Layout</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>The padding properties are used to control the geometry of the <a href="qml-qtquick-controls2-popup.html#contentItem-prop">content item</a>.</p>
<p>Popup uses the same approach to padding as <a href="qml-qtquick-controls2-control.html#padding-prop">Control</a>. For a visual explanation of the padding system, see the <a href="qml-qtquick-controls2-control.html#control-layout">Control Layout</a> section of the documentation.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#padding-prop">padding</a>, <a href="qml-qtquick-controls2-popup.html#topPadding-prop">topPadding</a>, and <a href="qml-qtquick-controls2-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.CloseOnPressOutside</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.CloseOnPressOutsideParent</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.CloseOnReleaseOutside</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.CloseOnReleaseOutsideParent</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.CloseOnEscape</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.CloseOnEscape | Popup.CloseOnPressOutside</code>.</p>
<p><b>Note: </b>There is a known limitation that the <code>Popup.CloseOnReleaseOutside</code> and <code>Popup.CloseOnReleaseOutsideParent</code> policies only work with <a href="qml-qtquick-controls2-popup.html#modal-prop">modal</a> popups.</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"><a href="../qtquick/qml-qtquick-item.html">Item</a></span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the list of content children.</p>
<p>The list contains all items that have been declared in QML as children of the popup.</p>
<p><b>Note: </b>Unlike <code>contentData</code>, <code>contentChildren</code> does not include non-visual QML objects.</p><p><b>See also </b><a href="../qtquick/qml-qtquick-item.html#children-prop">Item::children</a> and <a href="qml-qtquick-controls2-popup.html#contentData-prop">contentData</a>.</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>The list contains all objects that have been declared in QML as children of the popup.</p>
<p><b>Note: </b>Unlike <code>contentChildren</code>, <code>contentData</code> does include non-visual QML objects.</p><p><b>See also </b><a href="../qtquick/qml-qtquick-item.html#data-prop">Item::data</a> and <a href="qml-qtquick-controls2-popup.html#contentChildren-prop">contentChildren</a>.</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>For more information, see <a href="qml-qtquick-controls2-popup.html#popup-sizing">Popup Sizing</a>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#contentWidth-prop">contentWidth</a>.</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"><a href="../qtquick/qml-qtquick-item.html">Item</a></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-qtquick-controls2-applicationwindow.html#overlay-attached-prop">overlay item</a> of its application window.</p>
<p><b>Note: </b>The content item is automatically resized to fit within the <a href="qml-qtquick-controls2-popup.html#padding-prop">padding</a> of the popup.</p><p><b>Note: </b>Most popups use the implicit size of the content item to calculate the implicit size of the popup itself. If you replace the content item with a custom one, you should also consider providing a sensible implicit size for it (unless it is an item like <a href="../qtquick/qml-qtquick-text.html">Text</a> which has its own implicit size).</p><p><b>See also </b><a href="qtquickcontrols2-customize.html#customizing-popup">Customizing Popup</a>.</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>For more information, see <a href="qml-qtquick-controls2-popup.html#popup-sizing">Popup Sizing</a>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#contentHeight-prop">contentHeight</a>.</p>
</div></div><!-- @@@contentWidth -->
<br/>
<!-- $$$dim -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="dim-prop">
<td class="tblQmlPropNode"><p>
<a name="dim-prop"></a><span class="name">dim</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds whether the popup dims the background.</p>
<p>Unless explicitly set, this property follows the value of <a href="qml-qtquick-controls2-popup.html#modal-prop">modal</a>. To return to the default value, set this property to <code>undefined</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#modal-prop">modal</a>.</p>
</div></div><!-- @@@dim -->
<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"><a href="../qtquick/qml-qtquick-transition.html">Transition</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the transition that is applied to the popup item when the popup is opened and enters the screen.</p>
<p>The following example animates the opacity of the popup when it enters the screen:</p>
<pre class="cpp">
Popup {
enter: Transition {
NumberAnimation { property: <span class="string">"opacity"</span>; from: <span class="number">0.0</span>; to: <span class="number">1.0</span> }
}
}
</pre>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#exit-prop">exit</a>.</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"><a href="../qtquick/qml-qtquick-transition.html">Transition</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the transition that is applied to the popup item when the popup is closed and exits the screen.</p>
<p>The following example animates the opacity of the popup when it exits the screen:</p>
<pre class="cpp">
Popup {
exit: Transition {
NumberAnimation { property: <span class="string">"opacity"</span>; from: <span class="number">1.0</span>; to: <span class="number">0.0</span> }
}
}
</pre>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#enter-prop">enter</a>.</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 wants focus.</p>
<p>When the popup actually receives focus, <a href="qml-qtquick-controls2-popup.html#activeFocus-prop">activeFocus</a> will be <code>true</code>. For more information, see <a href="../qtquick/qtquick-input-focus.html">Keyboard Focus in Qt Quick</a>.</p>
<p>The default value is <code>false</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#activeFocus-prop">activeFocus</a>.</p>
</div></div><!-- @@@focus -->
<br/>
<!-- $$$font -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="font-prop">
<td class="tblQmlPropNode"><p>
<a name="font-prop"></a><span class="name">font</span> : <span class="type"><a href="qml-qtquick-controls2-popup.html#font-prop">font</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the font currently set for the popup.</p>
<p>Popup propagates explicit font properties to its children. If you change a specific property on a popup's font, that property propagates to all of the popup's children, overriding any system defaults for that property.</p>
<pre class="cpp">
Popup {
font<span class="operator">.</span>family: <span class="string">"Courier"</span>
Column {
Label {
text: qsTr(<span class="string">"This will use Courier..."</span>)
}
Switch {
text: qsTr(<span class="string">"... and so will this"</span>)
}
}
}
</pre>
<p><b>See also </b><a href="qml-qtquick-controls2-control.html#font-prop">Control::font</a> and <a href="qml-qtquick-controls2-applicationwindow.html#font-prop">ApplicationWindow::font</a>.</p>
</div></div><!-- @@@font -->
<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 distance between the left edge of the popup and the left edge of its window.</p>
<p>A popup with a negative left margin is not pushed within the left edge of the enclosing window. The default value is <code>-1</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#margins-prop">margins</a>, <a href="qml-qtquick-controls2-popup.html#rightMargin-prop">rightMargin</a>, and <a href="qml-qtquick-controls2-popup.html#popup-layout">Popup Layout</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>The padding properties are used to control the geometry of the <a href="qml-qtquick-controls2-popup.html#contentItem-prop">content item</a>.</p>
<p>Popup uses the same approach to padding as <a href="qml-qtquick-controls2-control.html#padding-prop">Control</a>. For a visual explanation of the padding system, see the <a href="qml-qtquick-controls2-control.html#control-layout">Control Layout</a> section of the documentation.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#padding-prop">padding</a>, <a href="qml-qtquick-controls2-popup.html#rightPadding-prop">rightPadding</a>, and <a href="qml-qtquick-controls2-popup.html#availableWidth-prop">availableWidth</a>.</p>
</div></div><!-- @@@leftPadding -->
<br/>
<!-- $$$locale -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="locale-prop">
<td class="tblQmlPropNode"><p>
<a name="locale-prop"></a><span class="name">locale</span> : <span class="type"><a href="../qtqml/qml-qtqml-locale.html">Locale</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the locale of the popup.</p>
<p><b>See also </b><a href="../qtquick/qml-qtquick-layoutmirroring.html">LayoutMirroring</a>.</p>
</div></div><!-- @@@locale -->
<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 distance between the edges of the popup and the edges of its window.</p>
<p>A popup with negative margins is not pushed within the bounds of the enclosing window. The default value is <code>-1</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#topMargin-prop">topMargin</a>, <a href="qml-qtquick-controls2-popup.html#leftMargin-prop">leftMargin</a>, <a href="qml-qtquick-controls2-popup.html#rightMargin-prop">rightMargin</a>, <a href="qml-qtquick-controls2-popup.html#bottomMargin-prop">bottomMargin</a>, and <a href="qml-qtquick-controls2-popup.html#popup-layout">Popup Layout</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.</p>
<p>Modal popups often have a distinctive background dimming effect defined in <a href="qml-qtquick-controls2-applicationwindow.html#overlay-attached-prop">overlay.modal</a>, and do not allow press or release events through to items beneath them.</p>
<p>On desktop platforms, it is common for modal popups to be closed only when the escape key is pressed. To achieve this behavior, set <a href="qml-qtquick-controls2-popup.html#closePolicy-prop">closePolicy</a> to <code>Popup.CloseOnEscape</code>.</p>
<p>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. Opacity is specified as a number between <code>0.0</code> (fully transparent) and <code>1.0</code> (fully opaque). The default value is <code>1.0</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#visible-prop">visible</a>.</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>The padding properties are used to control the geometry of the <a href="qml-qtquick-controls2-popup.html#contentItem-prop">content item</a>.</p>
<p>Popup uses the same approach to padding as <a href="qml-qtquick-controls2-control.html#padding-prop">Control</a>. For a visual explanation of the padding system, see the <a href="qml-qtquick-controls2-control.html#control-layout">Control Layout</a> section of the documentation.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#availableWidth-prop">availableWidth</a>, <a href="qml-qtquick-controls2-popup.html#availableHeight-prop">availableHeight</a>, <a href="qml-qtquick-controls2-popup.html#topPadding-prop">topPadding</a>, <a href="qml-qtquick-controls2-popup.html#leftPadding-prop">leftPadding</a>, <a href="qml-qtquick-controls2-popup.html#rightPadding-prop">rightPadding</a>, and <a href="qml-qtquick-controls2-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"><a href="../qtquick/qml-qtquick-item.html">Item</a></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 distance between the right edge of the popup and the right edge of its window.</p>
<p>A popup with a negative right margin is not pushed within the right edge of the enclosing window. The default value is <code>-1</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#margins-prop">margins</a>, <a href="qml-qtquick-controls2-popup.html#leftMargin-prop">leftMargin</a>, and <a href="qml-qtquick-controls2-popup.html#popup-layout">Popup Layout</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>The padding properties are used to control the geometry of the <a href="qml-qtquick-controls2-popup.html#contentItem-prop">content item</a>.</p>
<p>Popup uses the same approach to padding as <a href="qml-qtquick-controls2-control.html#padding-prop">Control</a>. For a visual explanation of the padding system, see the <a href="qml-qtquick-controls2-control.html#control-layout">Control Layout</a> section of the documentation.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#padding-prop">padding</a>, <a href="qml-qtquick-controls2-popup.html#leftPadding-prop">leftPadding</a>, and <a href="qml-qtquick-controls2-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>
<p>A scale of less than <code>1.0</code> causes the popup to be rendered at a smaller size, and a scale greater than <code>1.0</code> renders the popup at a larger size. A negative scale causes the popup to be mirrored when rendered.</p>
</div></div><!-- @@@scale -->
<br/>
<!-- $$$spacing -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="spacing-prop">
<td class="tblQmlPropNode"><p>
<a name="spacing-prop"></a><span class="name">spacing</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the spacing.</p>
<p>Spacing is useful for popups that have multiple or repetitive building blocks. For example, some styles use spacing to determine the distance between the header, content, and footer of <a href="qml-qtquick-controls2-dialog.html">Dialog</a>. Spacing is not enforced by Popup, so each style may interpret it differently, and some may ignore it altogether.</p>
<p>This QML property was introduced in QtQuick.Controls 2.1 (Qt 5.8).</p>
</div></div><!-- @@@spacing -->
<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 distance between the top edge of the popup and the top edge of its window.</p>
<p>A popup with a negative top margin is not pushed within the top edge of the enclosing window. The default value is <code>-1</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#margins-prop">margins</a>, <a href="qml-qtquick-controls2-popup.html#bottomMargin-prop">bottomMargin</a>, and <a href="qml-qtquick-controls2-popup.html#popup-layout">Popup Layout</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>The padding properties are used to control the geometry of the <a href="qml-qtquick-controls2-popup.html#contentItem-prop">content item</a>.</p>
<p>Popup uses the same approach to padding as <a href="qml-qtquick-controls2-control.html#padding-prop">Control</a>. For a visual explanation of the padding system, see the <a href="qml-qtquick-controls2-control.html#control-layout">Control Layout</a> section of the documentation.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#padding-prop">padding</a>, <a href="qml-qtquick-controls2-popup.html#bottomPadding-prop">bottomPadding</a>, and <a href="qml-qtquick-controls2-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/qtquickcontrols2-popup-transformorigin.png" alt="" /></p><p><b>See also </b><a href="qml-qtquick-controls2-popup.html#enter-prop">enter</a>, <a href="qml-qtquick-controls2-popup.html#exit-prop">exit</a>, and <a href="../qtquick/qml-qtquick-item.html#transformOrigin-prop">Item::transformOrigin</a>.</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>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#open-method">open()</a> and <a href="qml-qtquick-controls2-popup.html#close-method">close()</a>.</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>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#y-prop">y</a> and <a href="qml-qtquick-controls2-popup.html#z-prop">z</a>.</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>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#x-prop">x</a> and <a href="qml-qtquick-controls2-popup.html#z-prop">z</a>.</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.</p>
<p>If two visible popups have the same z-value, the last one that was opened will be on top.</p>
<p>The default z-value is <code>0</code>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#x-prop">x</a> and <a href="qml-qtquick-controls2-popup.html#y-prop">y</a>.</p>
</div></div><!-- @@@z -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$aboutToHide -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="aboutToHide-signal">
<td class="tblQmlFuncNode"><p>
<a name="aboutToHide-signal"></a><span class="type">void</span> <span class="name">aboutToHide</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the popup is about to hide.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#closed-signal">closed()</a>.</p>
</div></div><!-- @@@aboutToHide -->
<br/>
<!-- $$$aboutToShow -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="aboutToShow-signal">
<td class="tblQmlFuncNode"><p>
<a name="aboutToShow-signal"></a><span class="type">void</span> <span class="name">aboutToShow</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the popup is about to show.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#opened-signal">opened()</a>.</p>
</div></div><!-- @@@aboutToShow -->
<br/>
<!-- $$$closed -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="closed-signal">
<td class="tblQmlFuncNode"><p>
<a name="closed-signal"></a><span class="type">void</span> <span class="name">closed</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the popup is closed.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#aboutToHide-signal">aboutToHide()</a>.</p>
</div></div><!-- @@@closed -->
<br/>
<!-- $$$opened -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="opened-signal">
<td class="tblQmlFuncNode"><p>
<a name="opened-signal"></a><span class="type">void</span> <span class="name">opened</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the popup is opened.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#aboutToShow-signal">aboutToShow()</a>.</p>
</div></div><!-- @@@opened -->
<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>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#visible-prop">visible</a>.</p>
</div></div><!-- @@@close -->
<br/>
<!-- $$$forceActiveFocus -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="forceActiveFocus-method">
<td class="tblQmlFuncNode"><p>
<a name="forceActiveFocus-method"></a><span class="type">void</span> <span class="name">forceActiveFocus</span>(<i>reason</i> = Qt.OtherFocusReason)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Forces active focus on the popup with the given <i>reason</i>.</p>
<p>This method sets focus on the popup and ensures that all ancestor <a href="../qtquick/qml-qtquick-focusscope.html">FocusScope</a> objects in the object hierarchy are also given <a href="qml-qtquick-controls2-popup.html#focus-prop">focus</a>.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#activeFocus-prop">activeFocus</a> and <a href="../qtcore/qt.html#FocusReason-enum">Qt::FocusReason</a>.</p>
</div></div><!-- @@@forceActiveFocus -->
<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>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#visible-prop">visible</a>.</p>
</div></div><!-- @@@open -->
<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>
|