qtquickcontrols2-5-doc-html 5.7.1-1 / usr / share / qt5 / doc / qtquickcontrols2 / qml-qtquick-controls2-applicationwindow.html

This file is indexed.

/usr/share/qt5/doc/qtquickcontrols2/qml-qtquick-controls2-applicationwindow.html is in qtquickcontrols2-5-doc-html 5.7.1-1.

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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickapplicationwindow.cpp -->
  <title>ApplicationWindow QML Type | Qt Quick Controls 2 5.7</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.7</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 >ApplicationWindow QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.7.1 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="#attached-properties">Attached Properties</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">ApplicationWindow QML Type</h1>
<span class="subtitle"></span>
<!-- $$$ApplicationWindow-brief -->
<p>Provides a top-level application window. <a href="#details">More...</a></p>
<!-- @@@ApplicationWindow -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Controls 2.0</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="../qtquick/qml-qtquick-window-window.html">Window</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtquick-controls2-applicationwindow-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-applicationwindow.html#activeFocusControl-prop">activeFocusControl</a></b></b> : Control</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#background-prop">background</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#contentData-prop">contentData</a></b></b> : list&lt;Object&gt;</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#contentItem-prop">contentItem</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#font-prop">font</a></b></b> : font</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#footer-prop">footer</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#header-prop">header</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#overlay-prop">overlay</a></b></b><ul>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#overlay-prop">overlay</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#overlay.modal-prop">overlay.modal</a></b></b> : Component</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#overlay.modeless-prop">overlay.modeless</a></b></b> : Component</li>
</ul>
</li>
</ul>
<a name="attached-properties"></a>
<h2 id="attached-properties">Attached Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#activeFocusControl-attached-prop">activeFocusControl</a></b></b> : Control</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#contentItem-attached-prop">contentItem</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#footer-attached-prop">footer</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#header-attached-prop">header</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#overlay-attached-prop">overlay</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-controls2-applicationwindow.html#window-attached-prop">window</a></b></b> : ApplicationWindow</li>
</ul>
<!-- $$$ApplicationWindow-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p><a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a> is a <a href="../qtquick/qml-qtquick-window-window.html">Window</a> which makes it convenient to add a <a href="qml-qtquick-controls2-applicationwindow.html#header-attached-prop">header</a> and <a href="qml-qtquick-controls2-applicationwindow.html#footer-attached-prop">footer</a> item to the window.</p>
<p>You can declare <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a> as the root item of your application, and run it by using <a href="../qtqml/qqmlapplicationengine.html">QQmlApplicationEngine</a>. In this way you can control the window's properties, appearance and layout from QML.</p>
<p class="centerAlign"><img src="images/qtquickcontrols2-applicationwindow-wireframe.png" alt="" /></p><pre class="qml">

  import QtQuick.Controls 2.0

  <span class="type"><a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a></span> {
      <span class="name">visible</span>: <span class="number">true</span>

      <span class="name">header</span>: <span class="name">ToolBar</span> {
          <span class="comment">// ...</span>
      }

      <span class="name">footer</span>: <span class="name">TabBar</span> {
          <span class="comment">// ...</span>
      }

      <span class="type"><a href="qml-qtquick-controls2-stackview.html">StackView</a></span> {
          <span class="name">anchors</span>.fill: <span class="name">parent</span>
      }
  }

</pre>
<p><a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a> supports popups via its <a href="qml-qtquick-controls2-applicationwindow.html#overlay-attached-prop">overlay</a> property, which ensures that popups are displayed above other content and that the background is dimmed when a modal popup is visible.</p>
<p><b>Note: </b>By default, an <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a> is not visible.</p><p><b>See also </b><a href="qml-qtquick-controls2-page.html">Page</a> and <a href="qtquickcontrols2-containers.html">Container Controls</a>.</p>
<!-- @@@ApplicationWindow -->
<h2>Property Documentation</h2>
<!-- $$$activeFocusControl -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="activeFocusControl-prop">
<td class="tblQmlPropNode"><p>
<a name="activeFocusControl-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">activeFocusControl</span> : <span class="type"><a href="qml-qtquick-controls2-control.html">Control</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the control that currently has active focus, or <code>null</code> if there is no control with active focus.</p>
<p>The difference between <a href="../qtquick/qml-qtquick-window-window.html#activeFocusItem-attached-prop">Window::activeFocusItem</a> and <a href="qml-qtquick-controls2-applicationwindow.html#activeFocusControl-attached-prop">ApplicationWindow::activeFocusControl</a> is that the former may point to a building block of a control, whereas the latter points to the enclosing control. For example, when <a href="qml-qtquick-controls2-spinbox.html">SpinBox</a> has focus, activeFocusItem points to the editor and <a href="qml-qtquick-controls2-applicationwindow.html#activeFocusControl-attached-prop">activeFocusControl</a> to the <a href="qml-qtquick-controls2-spinbox.html">SpinBox</a> itself.</p>
<p><b>See also </b><a href="../qtquick/qml-qtquick-window-window.html#activeFocusItem-attached-prop">Window::activeFocusItem</a>.</p>
</div></div><!-- @@@activeFocusControl -->
<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>The background item is stacked under the <a href="qml-qtquick-controls2-applicationwindow.html#contentItem-attached-prop">content item</a>, but above the <a href="../qtquick/qml-qtquick-window-window.html#color-prop">background color</a> of the window.</p>
<p><b>Note: </b>If the background item has no explicit size specified, it automatically follows the control's size. In most cases, there is no need to specify width or height for a background item.</p></div></div><!-- @@@background -->
<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>&lt;<span class="type">Object</span>&gt;</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This default property holds the list of all objects declared as children of the window.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-applicationwindow.html#contentItem-attached-prop">contentItem</a>.</p>
</div></div><!-- @@@contentData -->
<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="qmlreadonly">[read-only] </span><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 window content item.</p>
</div></div><!-- @@@contentItem -->
<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-applicationwindow.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 window.</p>
<p>The default font depends on the system environment. <a href="../qtgui/qguiapplication.html">QGuiApplication</a> maintains a system/theme font which serves as a default for all application windows. You can also set the default font for windows by passing a custom font to <a href="../qtgui/qguiapplication.html#setFont">QGuiApplication::setFont()</a>, before loading any QML. Finally, the font is matched against Qt's font database to find the best match.</p>
<p><a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a> propagates explicit font properties to child controls. If you change a specific property on the window's font, that property propagates to all child controls in the window, overriding any system defaults for that property.</p>
<p><b>See also </b><a href="qml-qtquick-controls2-control.html#font-prop">Control::font</a>.</p>
</div></div><!-- @@@font -->
<br/>
<!-- $$$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 window footer item. The footer item is positioned to the bottom, and resized to the width of the window. The default value is <code>null</code>.</p>
<p><b>Note: </b>Assigning a <a href="qml-qtquick-controls2-toolbar.html">ToolBar</a> or <a href="qtquickcontrols2-navigation.html#tabbar">TabBar</a> as a window footer sets the respective <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 automatically to <code>Footer</code>.</p><p><b>See also </b><a href="qml-qtquick-controls2-applicationwindow.html#header-attached-prop">header</a> and <a href="qml-qtquick-controls2-page.html#footer-prop">Page::footer</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 window header item. The header item is positioned to the top, and resized to the width of the window. The default value is <code>null</code>.</p>
<p><b>Note: </b>Assigning a <a href="qml-qtquick-controls2-toolbar.html">ToolBar</a> or <a href="qtquickcontrols2-navigation.html#tabbar">TabBar</a> as a window header sets the respective <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 automatically to <code>Header</code>.</p><p><b>See also </b><a href="qml-qtquick-controls2-applicationwindow.html#footer-attached-prop">footer</a> and <a href="qml-qtquick-controls2-page.html#header-prop">Page::header</a>.</p>
</div></div><!-- @@@header -->
<br/>
<!-- $$$overlay -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="even" id="overlay-prop"><th class="centerAlign"><p><a name="overlay-prop"></a><b>overlay group</b></p></th></tr><tr valign="top" class="odd" id="overlay-prop"><td class="tblQmlPropNode"><p><a name="overlay-prop"></a><span class="name">overlay</span> : <span class="type"><a href="../qtquick/qml-qtquick-item.html">Item</a></span></p></td></tr><tr valign="top" class="odd" id="overlay.modal-prop"><td class="tblQmlPropNode"><p><a name="overlay.modal-prop"></a><span class="name">overlay.modal</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr><tr valign="top" class="odd" id="overlay.modeless-prop"><td class="tblQmlPropNode"><p><a name="overlay.modeless-prop"></a><span class="name">overlay.modeless</span> : <span class="type"><a href="../qtqml/qml-qtqml-component.html">Component</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the window overlay item. Popups are automatically reparented to the overlay.</p>
<div class="table"><table class="generic">
 <thead><tr class="qt-style"><th >Property</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td >overlay.modal</td><td >This property holds a component to use as a visual item that implements background dimming for modal popups. It is created for and stacked below visible modal popups.</td></tr>
<tr valign="top" class="even"><td >overlay.modeless</td><td >This property holds a component to use as a visual item that implements background dimming for modeless popups. It is created for and stacked below visible dimming popups.</td></tr>
</table></div>
<p><b>See also </b><a href="qml-qtquick-controls2-popup.html#modal-prop">Popup::modal</a> and <a href="qml-qtquick-controls2-popup.html#dim-prop">Popup::dim</a>.</p>
</div></div><!-- @@@overlay -->
<br/>
<h2>Attached Property Documentation</h2>
<!-- $$$activeFocusControl -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="activeFocusControl-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="activeFocusControl-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">ApplicationWindow.activeFocusControl</span> : <span class="type"><a href="qml-qtquick-controls2-control.html">Control</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This attached property holds the control that currently has active focus, or <code>null</code> if there is no control with active focus. The property can be attached to any item. The value is <code>null</code> if the item is not in an <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a>, or the window has no active focus.</p>
<p><b>See also </b><a href="../qtquick/qml-qtquick-window-window.html#activeFocusItem-attached-prop">Window::activeFocusItem</a>.</p>
</div></div><!-- @@@activeFocusControl -->
<br/>
<!-- $$$contentItem -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="contentItem-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="contentItem-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">ApplicationWindow.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 attached property holds the window content item. The property can be attached to any item. The value is <code>null</code> if the item is not in an <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a>.</p>
</div></div><!-- @@@contentItem -->
<br/>
<!-- $$$footer -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="footer-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="footer-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">ApplicationWindow.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 attached property holds the window footer item. The property can be attached to any item. The value is <code>null</code> if the item is not in an <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a>, or the window has no footer item.</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-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="header-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">ApplicationWindow.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 attached property holds the window header item. The property can be attached to any item. The value is <code>null</code> if the item is not in an <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a>, or the window has no header item.</p>
</div></div><!-- @@@header -->
<br/>
<!-- $$$overlay -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="overlay-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="overlay-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">ApplicationWindow.overlay</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 attached property holds the window overlay item. The property can be attached to any item. The value is <code>null</code> if the item is not in an <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a>.</p>
</div></div><!-- @@@overlay -->
<br/>
<!-- $$$window -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="window-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="window-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">ApplicationWindow.window</span> : <span class="type"><a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This attached property holds the application window. The property can be attached to any item. The value is <code>null</code> if the item is not in an <a href="qml-qtquick-controls2-applicationwindow.html">ApplicationWindow</a>.</p>
</div></div><!-- @@@window -->
<br/>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>

APT Browse - Built by Thomas Orozco.