/usr/share/qt5/doc/qtquick/qml-qtquick-window-window.html is in qtdeclarative5-doc-html 5.2.1-3ubuntu15.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickwindow.cpp -->
<title>Window | QtQuick 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtquick-index.html">Qt Quick</a></li>
<li><a href="qtquick-qmltypereference.html">QML Types</a></li>
<li>Window</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<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="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Window</h1>
<span class="subtitle"></span>
<!-- $$$Window-brief -->
<p>Creates a new top-level window <a href="#details">More...</a></p>
<!-- @@@Window -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> </b><tt>import QtQuick.Window 2.1</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qquickwindow.html">QQuickWindow</a></td></tr></table><ul>
<li><a href="qml-qtquick-window-window-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2>Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#activeFocusItem-prop">activeFocusItem</a></b></b> : Item</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#color-prop">color</a></b></b> : color</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#contentOrientation-prop">contentOrientation</a></b></b> : Qt::ScreenOrientation</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#data-prop">data</a></b></b> : list<Object></li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#flags-prop">flags</a></b></b> : Qt::WindowFlags</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#height-prop">height</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#maximumHeight-prop">maximumHeight</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#maximumWidth-prop">maximumWidth</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#minimumHeight-prop">minimumHeight</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#minimumWidth-prop">minimumWidth</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#modality-prop">modality</a></b></b> : Qt::WindowModality</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#opacity-prop">opacity</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#title-prop">title</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#visibility-prop">visibility</a></b></b> : QWindow::Visibility</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#visible-prop">visible</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#width-prop">width</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#x-prop">x</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-window.html#y-prop">y</a></b></b> : int</li>
</ul>
<!-- $$$Window-description -->
<a name="details"></a>
<h2>Detailed Description</h2>
<p>The Window object creates a new top-level window for a Qt Quick scene. It automatically sets up the window for use with <tt>QtQuick 2.x</tt> graphical types.</p>
<p>To use this type, you will need to import the module with the following line:</p>
<pre class="cpp">import <span class="type"><a href="qtquick-module.html">QtQuick</a></span><span class="operator">.</span>Window <span class="number">2.1</span></pre>
<p>Omitting this import will allow you to have a QML environment without access to window system features.</p>
<p>A Window can be declared inside an Item or inside another Window; in that case the inner Window will automatically become "transient for" the outer Window: that is, most platforms will show it centered upon the outer window by default, and there may be other platform-dependent behaviors, depending also on the <a href="qml-qtquick-window-window.html#flags-prop">flags</a>. If the nested window is intended to be a dialog in your application, you should also set <a href="qml-qtquick-window-window.html#flags-prop">flags</a> to Qt.Dialog, because some window managers will not provide the centering behavior without that flag. You can also declare multiple windows inside a top-level QtObject, in which case the windows will have no transient relationship.</p>
<p>Alternatively you can set or bind <a href="qml-qtquick-window-window.html#x-prop">x</a> and <a href="qml-qtquick-window-window.html#y-prop">y</a> to position the Window explicitly on the screen.</p>
<p>When the user attempts to close a window, the <i>closing</i> signal will be emitted. You can force the window to stay open (for example to prompt the user to save changes) by writing an onClosing handler and setting close.accepted = false.</p>
<!-- @@@Window -->
<h2>Property Documentation</h2>
<!-- $$$activeFocusItem -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="activeFocusItem-prop"></a><span class="name">activeFocusItem</span> : <span class="type"><a href="qml-qtquick-item.html">Item</a></span></p></td></tr></table></div><div class="qmldoc"><p>The item which currently has active focus or <tt>null</tt> if there is no item with active focus.</p>
<p>This QML property was introduced in Qt 5.1.</p>
</div></div><!-- @@@activeFocusItem -->
<br/>
<!-- $$$color -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="color-prop"></a><span class="name">color</span> : <span class="type"><a href="qml-color.html">color</a></span></p></td></tr></table></div><div class="qmldoc"><p>The background color for the window.</p>
<p>Setting this property is more efficient than using a separate Rectangle.</p>
</div></div><!-- @@@color -->
<br/>
<!-- $$$contentOrientation -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="contentOrientation-prop"></a><span class="name">contentOrientation</span> : <span class="type">Qt::ScreenOrientation</span></p></td></tr></table></div><div class="qmldoc"><p>This is a hint to the window manager in case it needs to display additional content like popups, dialogs, status bars, or similar in relation to the window.</p>
<p>The recommended orientation is <a href="qml-qtquick-window-screen.html#orientation-prop">Screen.orientation</a>, but an application doesn't have to support all possible orientations, and thus can opt to ignore the current screen orientation.</p>
<p>The difference between the window and the content orientation determines how much to rotate the content by.</p>
<p>The default value is Qt::PrimaryOrientation.</p>
<p>This QML property was introduced in Qt 5.1.</p>
<p><b>See also </b><a href="qml-qtquick-window-screen.html">Screen</a>.</p>
</div></div><!-- @@@contentOrientation -->
<br/>
<!-- $$$data -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="data-prop"></a><span class="qmldefault">default</span><span class="name">data</span> : <span class="type">list</span><<span class="type">Object</span>></p></td></tr></table></div><div class="qmldoc"><p>The data property allows you to freely mix visual children, resources and other Windows in a Window.</p>
<p>If you assign another Window to the data list, the nested window will become "transient for" the outer Window.</p>
<p>If you assign an <a href="qml-qtquick-item.html">Item</a> to the data list, it becomes a child of the Window's contentItem, so that it appears inside the window. The item's parent will be the window's contentItem, which is the root of the Item ownership tree within that Window.</p>
<p>If you assign any other object type, it is added as a resource.</p>
<p>It should not generally be necessary to refer to the <tt>data</tt> property, as it is the default property for Window and thus all child items are automatically assigned to this property.</p>
<p><b>See also </b>QWindow::transientParent().</p>
</div></div><!-- @@@data -->
<br/>
<!-- $$$flags -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="flags-prop"></a><span class="name">flags</span> : <span class="type">Qt::WindowFlags</span></p></td></tr></table></div><div class="qmldoc"><p>The window flags of the window.</p>
<p>The window flags control the window's appearance in the windowing system, whether it's a dialog, popup, or a regular window, and whether it should have a title bar, etc.</p>
<p>The flags which you read from this property might differ from the ones that you set if the requested flags could not be fulfilled.</p>
</div></div><!-- @@@flags -->
<br/>
<!-- $$$height -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="height-prop"></a><span class="name">height</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>Defines the window's position and size.</p>
<p>The (x,y) position is relative to the <a href="qml-qtquick-window-screen.html">Screen</a> if there is only one, or to the virtual desktop (arrangement of multiple screens).</p>
<pre class="qml"><span class="type"><a href="qml-qtquick-window-window.html">Window</a></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">100</span>; <span class="name">height</span>: <span class="number">100</span> }</pre>
<p class="centerAlign"><img src="images/screen-and-window-dimensions.jpg" alt="" /></p></div></div><!-- @@@height -->
<br/>
<!-- $$$maximumHeight -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="maximumHeight-prop"></a><span class="name">maximumHeight</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>Defines the window's maximum size.</p>
<p>This is a hint to the window manager to prevent resizing above the specified width and height.</p>
<p>This QML property was introduced in Qt 5.1.</p>
</div></div><!-- @@@maximumHeight -->
<br/>
<!-- $$$maximumWidth -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="maximumWidth-prop"></a><span class="name">maximumWidth</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>Defines the window's maximum size.</p>
<p>This is a hint to the window manager to prevent resizing above the specified width and height.</p>
<p>This QML property was introduced in Qt 5.1.</p>
</div></div><!-- @@@maximumWidth -->
<br/>
<!-- $$$minimumHeight -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="minimumHeight-prop"></a><span class="name">minimumHeight</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>Defines the window's minimum size.</p>
<p>This is a hint to the window manager to prevent resizing below the specified width and height.</p>
<p>This QML property was introduced in Qt 5.1.</p>
</div></div><!-- @@@minimumHeight -->
<br/>
<!-- $$$minimumWidth -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="minimumWidth-prop"></a><span class="name">minimumWidth</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>Defines the window's minimum size.</p>
<p>This is a hint to the window manager to prevent resizing below the specified width and height.</p>
<p>This QML property was introduced in Qt 5.1.</p>
</div></div><!-- @@@minimumWidth -->
<br/>
<!-- $$$modality -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="modality-prop"></a><span class="name">modality</span> : <span class="type">Qt::WindowModality</span></p></td></tr></table></div><div class="qmldoc"><p>The modality of the window.</p>
<p>A modal window prevents other windows from receiving input events. Possible values are Qt.NonModal (the default), Qt.WindowModal, and Qt.ApplicationModal.</p>
</div></div><!-- @@@modality -->
<br/>
<!-- $$$opacity -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><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 class="qmldoc"><p>The opacity of the window.</p>
<p>If the windowing system supports window opacity, this can be used to fade the window in and out, or to make it semitransparent.</p>
<p>A value of 1.0 or above is treated as fully opaque, whereas a value of 0.0 or below is treated as fully transparent. Values inbetween represent varying levels of translucency between the two extremes.</p>
<p>The default value is 1.0.</p>
<p>This QML property was introduced in Qt 5.1.</p>
</div></div><!-- @@@opacity -->
<br/>
<!-- $$$title -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><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 class="qmldoc"><p>The window's title in the windowing system.</p>
<p>The window title might appear in the title area of the window decorations, depending on the windowing system and the window flags. It might also be used by the windowing system to identify the window in other contexts, such as in the task switcher.</p>
</div></div><!-- @@@title -->
<br/>
<!-- $$$visibility -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="visibility-prop"></a><span class="name">visibility</span> : <span class="type">QWindow::Visibility</span></p></td></tr></table></div><div class="qmldoc"><p>The screen-occupation state of the window.</p>
<p>Visibility is whether the window should appear in the windowing system as normal, minimized, maximized, fullscreen or hidden.</p>
<p>To set the visibility to AutomaticVisibility means to give the window a default visible state, which might be fullscreen or windowed depending on the platform. However when reading the visibility property you will always get the actual state, never AutomaticVisibility.</p>
<p>When a window is not visible its visibility is Hidden, and setting visibility to Hidden is the same as setting <a href="qml-qtquick-window-window.html#visible-prop">visible</a> to false.</p>
<p>This QML property was introduced in Qt 5.1.</p>
<p><b>See also </b><a href="qml-qtquick-window-window.html#visible-prop">visible</a>.</p>
</div></div><!-- @@@visibility -->
<br/>
<!-- $$$visible -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><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 class="qmldoc"><p>Whether the window is visible on the screen.</p>
<p>Setting visible to false is the same as setting <a href="qml-qtquick-window-window.html#visibility-prop">visibility</a> to Hidden.</p>
<p><b>See also </b><a href="qml-qtquick-window-window.html#visibility-prop">visibility</a>.</p>
</div></div><!-- @@@visible -->
<br/>
<!-- $$$width -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="width-prop"></a><span class="name">width</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>Defines the window's position and size.</p>
<p>The (x,y) position is relative to the <a href="qml-qtquick-window-screen.html">Screen</a> if there is only one, or to the virtual desktop (arrangement of multiple screens).</p>
<pre class="qml"><span class="type"><a href="qml-qtquick-window-window.html">Window</a></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">100</span>; <span class="name">height</span>: <span class="number">100</span> }</pre>
<p class="centerAlign"><img src="images/screen-and-window-dimensions.jpg" alt="" /></p></div></div><!-- @@@width -->
<br/>
<!-- $$$x -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="x-prop"></a><span class="name">x</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>Defines the window's position and size.</p>
<p>The (x,y) position is relative to the <a href="qml-qtquick-window-screen.html">Screen</a> if there is only one, or to the virtual desktop (arrangement of multiple screens).</p>
<pre class="qml"><span class="type"><a href="qml-qtquick-window-window.html">Window</a></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">100</span>; <span class="name">height</span>: <span class="number">100</span> }</pre>
<p class="centerAlign"><img src="images/screen-and-window-dimensions.jpg" alt="" /></p></div></div><!-- @@@x -->
<br/>
<!-- $$$y -->
<div class="qmlitem"><div class="qmlproto"><table class="qmlname"><tr valign="top" class="odd"><td class="tblQmlPropNode"><p><a name="y-prop"></a><span class="name">y</span> : <span class="type">int</span></p></td></tr></table></div><div class="qmldoc"><p>Defines the window's position and size.</p>
<p>The (x,y) position is relative to the <a href="qml-qtquick-window-screen.html">Screen</a> if there is only one, or to the virtual desktop (arrangement of multiple screens).</p>
<pre class="qml"><span class="type"><a href="qml-qtquick-window-window.html">Window</a></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">100</span>; <span class="name">height</span>: <span class="number">100</span> }</pre>
<p class="centerAlign"><img src="images/screen-and-window-dimensions.jpg" alt="" /></p></div></div><!-- @@@y -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. 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> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|