/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-dialog.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickdialog.cpp -->
<title>Dialog 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 >Dialog 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="#dialog-title-and-buttons">Dialog Title and Buttons</a></li>
<li class="level2"><a href="#modal-dialogs">Modal Dialogs</a></li>
<li class="level2"><a href="#modeless-dialogs">Modeless Dialogs</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Dialog QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Dialog-brief -->
<p>Popup dialog with standard buttons and a title, used for short-term interaction with the user. <a href="#details">More...</a></p>
<!-- @@@Dialog -->
<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.8</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls2-dialog-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-dialog.html#footer-prop">footer</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dialog.html#header-prop">header</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dialog.html#standardButtons-prop">standardButtons</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-dialog.html#title-prop">title</a></b></b> : string</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-dialog.html#accepted-signal">accepted</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-dialog.html#rejected-signal">rejected</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-dialog.html#accept-method">accept</a></b></b>()</li>
<li class="fn">void <b><b><a href="qml-qtquick-controls2-dialog.html#reject-method">reject</a></b></b>()</li>
</ul>
<!-- $$$Dialog-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>A dialog is a popup mostly used for short-term tasks and brief communications with the user. Similarly to <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a> and <a href="qml-qtquick-controls2-page.html">Page</a>, Dialog is organized into three sections: <a href="qml-qtquick-controls2-dialog.html#header-prop">header</a>, <a href="qml-qtquick-controls2-popup.html#contentItem-prop">contentItem</a>, and <a href="qml-qtquick-controls2-dialog.html#footer-prop">footer</a>.</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-page-wireframe.png" alt="" /></p><a name="dialog-title-and-buttons"></a>
<h2 id="dialog-title-and-buttons">Dialog Title and Buttons</h2>
<p>Dialog's <a href="qml-qtquick-controls2-dialog.html#title-prop">title</a> is displayed by a style-specific title bar that is assigned as a dialog <a href="qml-qtquick-controls2-dialog.html#header-prop">header</a> by default.</p>
<p>Dialog's standard buttons are managed by a <a href="qml-qtquick-controls2-dialogbuttonbox.html">DialogButtonBox</a> that is assigned as a dialog <a href="qml-qtquick-controls2-dialog.html#footer-prop">footer</a> by default. The dialog's <a href="qml-qtquick-controls2-dialog.html#standardButtons-prop">standardButtons</a> property is forwarded to the respective property of the button box. Furthermore, the <a href="qml-qtquick-controls2-dialogbuttonbox.html#accepted-signal">accepted()</a> and <a href="qml-qtquick-controls2-dialogbuttonbox.html#rejected-signal">rejected()</a> signals of the button box are connected to the respective signals in Dialog.</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-controls2-dialog.html">Dialog</a></span> {
<span class="name">id</span>: <span class="name">dialog</span>
<span class="name">title</span>: <span class="string">"Title"</span>
<span class="name">standardButtons</span>: <span class="name">Dialog</span>.<span class="name">Ok</span> <span class="operator">|</span> <span class="name">Dialog</span>.<span class="name">Cancel</span>
<span class="name">onAccepted</span>: <span class="name">console</span>.<span class="name">log</span>(<span class="string">"Ok clicked"</span>)
<span class="name">onRejected</span>: <span class="name">console</span>.<span class="name">log</span>(<span class="string">"Cancel clicked"</span>)
}
</pre>
<a name="modal-dialogs"></a>
<h2 id="modal-dialogs">Modal Dialogs</h2>
<p>A <a href="qml-qtquick-controls2-popup.html#modal-prop">modal</a> dialog blocks input to other content beneath the dialog. When a modal dialog is opened, the user must finish interacting with the dialog and close it before they can access any other content in the same window.</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-controls2-dialog.html">Dialog</a></span> {
<span class="name">id</span>: <span class="name">dialog</span>
<span class="name">modal</span>: <span class="number">true</span>
<span class="name">standardButtons</span>: <span class="name">Dialog</span>.<span class="name">Ok</span>
}
</pre>
<a name="modeless-dialogs"></a>
<h2 id="modeless-dialogs">Modeless Dialogs</h2>
<p>A modeless dialog is a dialog that operates independently of other content around the dialog. When a modeless dialog is opened, the user is allowed to interact with both the dialog and the other content in the same window.</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-controls2-dialog.html">Dialog</a></span> {
<span class="name">id</span>: <span class="name">dialog</span>
<span class="name">modal</span>: <span class="number">false</span>
<span class="name">standardButtons</span>: <span class="name">Dialog</span>.<span class="name">Ok</span>
}
</pre>
<p><b>See also </b><a href="qml-qtquick-controls2-dialogbuttonbox.html">DialogButtonBox</a> and <a href="qtquickcontrols2-popups.html">Popup Controls</a>.</p>
<!-- @@@Dialog -->
<h2>Property Documentation</h2>
<!-- $$$footer -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="footer-prop">
<td class="tblQmlPropNode"><p>
<a name="footer-prop"></a><span class="name">footer</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 dialog footer item. The footer item is positioned to the bottom, and resized to the width of the dialog. The default value is <code>null</code>.</p>
<p><b>Note: </b>Assigning a <a href="qml-qtquick-controls2-dialogbuttonbox.html">DialogButtonBox</a> as a dialog footer automatically connects its <a href="qml-qtquick-controls2-dialogbuttonbox.html#accepted-signal">accepted()</a> and <a href="qml-qtquick-controls2-dialogbuttonbox.html#rejected-signal">rejected()</a> signals to the respective signals in Dialog.</p><p><b>Note: </b>Assigning a <a href="qml-qtquick-controls2-dialogbuttonbox.html">DialogButtonBox</a>, <a href="qml-qtquick-controls2-toolbar.html">ToolBar</a>, or <a href="qtquickcontrols2-navigation.html#tabbar">TabBar</a> as a dialog footer automatically sets the respective <a href="qml-qtquick-controls2-dialogbuttonbox.html#position-prop">DialogButtonBox::position</a>, <a href="qml-qtquick-controls2-toolbar.html#position-prop">ToolBar::position</a>, or <a href="qml-qtquick-controls2-tabbar.html#position-prop">TabBar::position</a> property to <code>Footer</code>.</p><p><b>See also </b><a href="qml-qtquick-controls2-dialog.html#header-prop">header</a>.</p>
</div></div><!-- @@@footer -->
<br/>
<!-- $$$header -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="header-prop">
<td class="tblQmlPropNode"><p>
<a name="header-prop"></a><span class="name">header</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 dialog header item. The header item is positioned to the top, and resized to the width of the dialog. The default value is <code>null</code>.</p>
<p><b>Note: </b>Assigning a <a href="qml-qtquick-controls2-dialogbuttonbox.html">DialogButtonBox</a> as a dialog header automatically connects its <a href="qml-qtquick-controls2-dialogbuttonbox.html#accepted-signal">accepted()</a> and <a href="qml-qtquick-controls2-dialogbuttonbox.html#rejected-signal">rejected()</a> signals to the respective signals in Dialog.</p><p><b>Note: </b>Assigning a <a href="qml-qtquick-controls2-dialogbuttonbox.html">DialogButtonBox</a>, <a href="qml-qtquick-controls2-toolbar.html">ToolBar</a>, or <a href="qtquickcontrols2-navigation.html#tabbar">TabBar</a> as a dialog header automatically sets the respective <a href="qml-qtquick-controls2-dialogbuttonbox.html#position-prop">DialogButtonBox::position</a>, <a href="qml-qtquick-controls2-toolbar.html#position-prop">ToolBar::position</a>, or <a href="qml-qtquick-controls2-tabbar.html#position-prop">TabBar::position</a> property to <code>Header</code>.</p><p><b>See also </b><a href="qml-qtquick-controls2-dialog.html#footer-prop">footer</a>.</p>
</div></div><!-- @@@header -->
<br/>
<!-- $$$standardButtons -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="standardButtons-prop">
<td class="tblQmlPropNode"><p>
<a name="standardButtons-prop"></a><span class="name">standardButtons</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds a combination of standard buttons that are used by the dialog.</p>
<pre class="qml">
<span class="type"><a href="qml-qtquick-controls2-dialog.html">Dialog</a></span> {
<span class="name">id</span>: <span class="name">dialog</span>
<span class="name">title</span>: <span class="string">"Title"</span>
<span class="name">standardButtons</span>: <span class="name">Dialog</span>.<span class="name">Ok</span> <span class="operator">|</span> <span class="name">Dialog</span>.<span class="name">Cancel</span>
<span class="name">onAccepted</span>: <span class="name">console</span>.<span class="name">log</span>(<span class="string">"Ok clicked"</span>)
<span class="name">onRejected</span>: <span class="name">console</span>.<span class="name">log</span>(<span class="string">"Cancel clicked"</span>)
}
</pre>
<p>The buttons will be positioned in the appropriate order for the user's platform.</p>
<p>Possible flags:</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>Dialog.Ok</code></td><td class="topAlign">An "OK" button defined with the <code>AcceptRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Open</code></td><td class="topAlign">An "Open" button defined with the <code>AcceptRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Save</code></td><td class="topAlign">A "Save" button defined with the <code>AcceptRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Cancel</code></td><td class="topAlign">A "Cancel" button defined with the <code>RejectRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Close</code></td><td class="topAlign">A "Close" button defined with the <code>RejectRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Discard</code></td><td class="topAlign">A "Discard" or "Don't Save" button, depending on the platform, defined with the <code>DestructiveRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Apply</code></td><td class="topAlign">An "Apply" button defined with the <code>ApplyRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Reset</code></td><td class="topAlign">A "Reset" button defined with the <code>ResetRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.RestoreDefaults</code></td><td class="topAlign">A "Restore Defaults" button defined with the <code>ResetRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Help</code></td><td class="topAlign">A "Help" button defined with the <code>HelpRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.SaveAll</code></td><td class="topAlign">A "Save All" button defined with the <code>AcceptRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Yes</code></td><td class="topAlign">A "Yes" button defined with the <code>YesRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.YesToAll</code></td><td class="topAlign">A "Yes to All" button defined with the <code>YesRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.No</code></td><td class="topAlign">A "No" button defined with the <code>NoRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.NoToAll</code></td><td class="topAlign">A "No to All" button defined with the <code>NoRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Abort</code></td><td class="topAlign">An "Abort" button defined with the <code>RejectRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Retry</code></td><td class="topAlign">A "Retry" button defined with the <code>AcceptRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.Ignore</code></td><td class="topAlign">An "Ignore" button defined with the <code>AcceptRole</code>.</td></tr>
<tr><td class="topAlign"><code>Dialog.NoButton</code></td><td class="topAlign">An invalid button.</td></tr>
</table></div>
<p><b>See also </b><a href="qml-qtquick-controls2-dialogbuttonbox.html">DialogButtonBox</a>.</p>
</div></div><!-- @@@standardButtons -->
<br/>
<!-- $$$title -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="title-prop">
<td class="tblQmlPropNode"><p>
<a name="title-prop"></a><span class="name">title</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the dialog title.</p>
<p>The title is displayed in the dialog header.</p>
<pre class="cpp">
Dialog {
title: qsTr(<span class="string">"About"</span>)
Label {
text: <span class="string">"Lorem ipsum..."</span>
}
}
</pre>
</div></div><!-- @@@title -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$accepted -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="accepted-signal">
<td class="tblQmlFuncNode"><p>
<a name="accepted-signal"></a><span class="type">void</span> <span class="name">accepted</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the dialog has been accepted either interactively or by calling <a href="qml-qtquick-controls2-dialog.html#accept-method">accept()</a>.</p>
<p><b>Note: </b>This signal is <i>not</i> emitted when closing the dialog with <a href="qml-qtquick-controls2-popup.html#close-method">close()</a> or setting <a href="qml-qtquick-controls2-popup.html#visible-prop">visible</a> to <code>false</code>.</p><p><b>See also </b><a href="qml-qtquick-controls2-dialog.html#rejected-signal">rejected()</a>.</p>
</div></div><!-- @@@accepted -->
<br/>
<!-- $$$rejected -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="rejected-signal">
<td class="tblQmlFuncNode"><p>
<a name="rejected-signal"></a><span class="type">void</span> <span class="name">rejected</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when the dialog has been rejected either interactively or by calling <a href="qml-qtquick-controls2-dialog.html#reject-method">reject()</a>.</p>
<p><b>Note: </b>This signal is <i>not</i> emitted when closing the dialog with <a href="qml-qtquick-controls2-popup.html#close-method">close()</a> or setting <a href="qml-qtquick-controls2-popup.html#visible-prop">visible</a> to <code>false</code>.</p><p><b>See also </b><a href="qml-qtquick-controls2-dialog.html#accepted-signal">accepted()</a>.</p>
</div></div><!-- @@@rejected -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$accept -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="accept-method">
<td class="tblQmlFuncNode"><p>
<a name="accept-method"></a><span class="type">void</span> <span class="name">accept</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Closes the dialog and emits the <a href="qml-qtquick-controls2-dialog.html#accepted-signal">accepted()</a> signal.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-dialog.html#reject-method">reject()</a>.</p>
</div></div><!-- @@@accept -->
<br/>
<!-- $$$reject -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="reject-method">
<td class="tblQmlFuncNode"><p>
<a name="reject-method"></a><span class="type">void</span> <span class="name">reject</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Closes the dialog and emits the <a href="qml-qtquick-controls2-dialog.html#rejected-signal">rejected()</a> signal.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-dialog.html#accept-method">accept()</a>.</p>
</div></div><!-- @@@reject -->
<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>
|