/usr/share/qt5/doc/qtquick/qml-qtquick-window-screen.html is in qtdeclarative5-doc-html 5.9.5-0ubuntu1.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickscreen.cpp -->
<title>Screen QML Type | Qt Quick 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="qtquick-index.html">Qt Quick</a></td><td ><a href="qtquick-qmlmodule.html">QML Types</a></td><td >Screen 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="#attached-properties">Attached Properties</a></li>
<li class="level1"><a href="#attached-methods">Attached Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Screen QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Screen-brief -->
<p>The Screen attached object provides information about the Screen an Item or Window is displayed on. <a href="#details">More...</a></p>
<!-- @@@Screen -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick.Window 2.2</td></tr></table></div><ul>
<li><a href="qml-qtquick-window-screen-members.html">List of all members, including inherited members</a></li>
<li><a href="qml-qtquick-window-screen-obsolete.html">Obsolete members</a></li>
</ul>
<a name="attached-properties"></a>
<h2 id="attached-properties">Attached Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#desktopAvailableHeight-attached-prop">desktopAvailableHeight</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#desktopAvailableWidth-attached-prop">desktopAvailableWidth</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#devicePixelRatio-attached-prop">devicePixelRatio</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#height-attached-prop">height</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#name-attached-prop">name</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#orientation-attached-prop">orientation</a></b></b> : Qt::ScreenOrientation</li>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#orientationUpdateMask-attached-prop">orientationUpdateMask</a></b></b> : Qt::ScreenOrientations</li>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#pixelDensity-attached-prop">pixelDensity</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#primaryOrientation-attached-prop">primaryOrientation</a></b></b> : Qt::ScreenOrientation</li>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#virtualX-attached-prop">virtualX</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#virtualY-attached-prop">virtualY</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-window-screen.html#width-attached-prop">width</a></b></b> : int</li>
</ul>
<a name="attached-methods"></a>
<h2 id="attached-methods">Attached Methods</h2>
<ul>
<li class="fn">int <b><b><a href="qml-qtquick-window-screen.html#angleBetween-method">angleBetween</a></b></b>(Qt::ScreenOrientation <i>a</i>, Qt::ScreenOrientation <i>b</i>)</li>
</ul>
<!-- $$$Screen-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>The Screen attached object is valid inside Item or Item derived types, after component completion. Inside these items it refers to the screen that the item is currently being displayed on.</p>
<p>The attached object is also valid inside Window or Window derived types, after component completion. In that case it refers to the screen where the Window was created. It is generally better to access the Screen from the relevant Item instead, because on a multi-screen desktop computer, the user can drag a Window into a position where it spans across multiple screens. In that case some Items will be on one screen, and others on a different screen.</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-qmlmodule.html">QtQuick</a></span><span class="operator">.</span>Window <span class="number">2.2</span>
</pre>
<p>It is a separate import in order to allow you to have a QML environment without access to window system features.</p>
<p>Note that the Screen type is not valid at Component.onCompleted, because the Item or Window has not been displayed on a screen by this time.</p>
<!-- @@@Screen -->
<h2>Attached Property Documentation</h2>
<!-- $$$desktopAvailableHeight -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="desktopAvailableHeight-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="desktopAvailableHeight-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Screen.desktopAvailableHeight</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This contains the available height of the collection of screens which make up the virtual desktop, in pixels, excluding window manager reserved areas such as task bars and system menus. If you want to position a Window at the bottom of the desktop, you can bind to it like this:</p>
<pre class="cpp">
y: Screen<span class="operator">.</span>desktopAvailableHeight <span class="operator">-</span> height
</pre>
<p>This QML property was introduced in Qt 5.1.</p>
</div></div><!-- @@@desktopAvailableHeight -->
<br/>
<!-- $$$desktopAvailableWidth -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="desktopAvailableWidth-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="desktopAvailableWidth-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Screen.desktopAvailableWidth</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This contains the available width of the collection of screens which make up the virtual desktop, in pixels, excluding window manager reserved areas such as task bars and system menus. If you want to position a Window at the right of the desktop, you can bind to it like this:</p>
<pre class="cpp">
x: Screen<span class="operator">.</span>desktopAvailableWidth <span class="operator">-</span> width
</pre>
<p>This QML property was introduced in Qt 5.1.</p>
</div></div><!-- @@@desktopAvailableWidth -->
<br/>
<!-- $$$devicePixelRatio -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="devicePixelRatio-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="devicePixelRatio-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Screen.devicePixelRatio</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The ratio between physical pixels and device-independent pixels for the screen.</p>
<p>Common values are 1.0 on normal displays and 2.0 on Apple "retina" displays.</p>
<p>This QML property was introduced in Qt 5.4.</p>
</div></div><!-- @@@devicePixelRatio -->
<br/>
<!-- $$$height -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="height-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="height-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Screen.height</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This contains the height of the screen in pixels.</p>
</div></div><!-- @@@height -->
<br/>
<!-- $$$name -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="name-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="name-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Screen.name</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The name of the screen.</p>
<p>This QML property was introduced in Qt 5.1.</p>
</div></div><!-- @@@name -->
<br/>
<!-- $$$orientation -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="orientation-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="orientation-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Screen.orientation</span> : <span class="type">Qt::ScreenOrientation</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This contains the current orientation of the screen, from the accelerometer (if any). On a desktop computer, this value typically does not change.</p>
<p>If <a href="qml-qtquick-window-screen.html#primaryOrientation-attached-prop">primaryOrientation</a> == orientation, it means that the screen automatically rotates all content which is displayed, depending on how you hold it. But if orientation changes while <a href="qml-qtquick-window-screen.html#primaryOrientation-attached-prop">primaryOrientation</a> does NOT change, then probably you are using a device which does not rotate its own display. In that case you may need to use <a href="qml-qtquick-item.html#rotation-prop">Item.rotation</a> or <a href="qml-qtquick-item.html#transform-prop">Item.transform</a> to rotate your content.</p>
<p><b>Note: </b>This property does not update unless a <a href="qml-qtquick-window-screen.html#orientationUpdateMask-attached-prop">Screen::orientationUpdateMask</a> is set to a value other than <code>0</code>.</p></div></div><!-- @@@orientation -->
<br/>
<!-- $$$orientationUpdateMask -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="orientationUpdateMask-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="orientationUpdateMask-attached-prop"></a><span class="name">Screen.orientationUpdateMask</span> : <span class="type">Qt::ScreenOrientations</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This contains the update mask for the orientation. <a href="qml-qtquick-window-screen.html#orientation-attached-prop">Screen::orientation</a> only emits changes for the screen orientations matching this mask.</p>
<p>By default it is set to the value of the <a href="../qtgui/qscreen.html">QScreen</a> that the window uses.</p>
<p>This QML property was introduced in Qt 5.4.</p>
</div></div><!-- @@@orientationUpdateMask -->
<br/>
<!-- $$$pixelDensity -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="pixelDensity-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="pixelDensity-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Screen.pixelDensity</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The number of physical pixels per millimeter.</p>
<p>This QML property was introduced in Qt 5.2.</p>
</div></div><!-- @@@pixelDensity -->
<br/>
<!-- $$$primaryOrientation -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="primaryOrientation-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="primaryOrientation-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Screen.primaryOrientation</span> : <span class="type">Qt::ScreenOrientation</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This contains the primary orientation of the screen. If the screen's height is greater than its width, then the orientation is Qt.PortraitOrientation; otherwise it is Qt.LandscapeOrientation.</p>
<p>If you are designing an application which changes its layout depending on device orientation, you probably want to use primaryOrientation to determine the layout. That is because on a desktop computer, you can expect primaryOrientation to change when the user rotates the screen via the operating system's control panel, even if the computer does not contain an accelerometer. Likewise on most handheld computers which do have accelerometers, the operating system will rotate the whole screen automatically, so again you will see the primaryOrientation change.</p>
</div></div><!-- @@@primaryOrientation -->
<br/>
<!-- $$$virtualX -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="virtualX-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="virtualX-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Screen.virtualX</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The x coordinate of the screen within the virtual desktop.</p>
<p>This QML property was introduced in Qt 5.9.</p>
</div></div><!-- @@@virtualX -->
<br/>
<!-- $$$virtualY -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="virtualY-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="virtualY-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Screen.virtualY</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>The y coordinate of the screen within the virtual desktop.</p>
<p>This QML property was introduced in Qt 5.9.</p>
</div></div><!-- @@@virtualY -->
<br/>
<!-- $$$width -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="width-attached-prop">
<td class="tblQmlPropNode"><p>
<a name="width-attached-prop"></a><span class="qmlreadonly">[read-only] </span><span class="name">Screen.width</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This contains the width of the screen in pixels.</p>
</div></div><!-- @@@width -->
<br/>
<h2>Attached Method Documentation</h2>
<!-- $$$angleBetween -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="angleBetween-method">
<td class="tblQmlFuncNode"><p>
<a name="angleBetween-method"></a><span class="type">int</span> <span class="name">angleBetween</span>(<span class="type">Qt::ScreenOrientation</span> <i>a</i>, <span class="type">Qt::ScreenOrientation</span> <i>b</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the rotation angle, in degrees, between the two specified angles.</p>
</div></div><!-- @@@angleBetween -->
<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>
|