/usr/share/qt5/doc/qtquick/qquickitemgrabresult.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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickitemgrabresult.cpp -->
<title>QQuickItemGrabResult Class | 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-module.html">C++ Classes</a></td><td >QQuickItemGrabResult</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#signals">Signals</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">QQuickItemGrabResult Class</h1>
<!-- $$$QQuickItemGrabResult-brief -->
<p>The <a href="qquickitemgrabresult.html">QQuickItemGrabResult</a> contains the result from <a href="qquickitem.html#grabToImage">QQuickItem::grabToImage</a>(). <a href="#details">More...</a></p>
<!-- @@@QQuickItemGrabResult -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QQuickItemGrabResult></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += quick</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qtquick-itemgrabresult.html">ItemGrabResult</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="../qtcore/qobject.html">QObject</a></td></tr></table></div><ul>
<li><a href="qquickitemgrabresult-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><a href="qquickitemgrabresult.html#image-prop">image</a></b> : const QImage</li>
<li class="fn"><b><a href="qquickitemgrabresult.html#url-prop">url</a></b> : const QUrl</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QImage </td><td class="memItemRight bottomAlign"><b><a href="qquickitemgrabresult.html#image-prop">image</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qquickitemgrabresult.html#saveToFile">saveToFile</a></b>(const QString &<i>fileName</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qquickitemgrabresult.html#url-prop">url</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">32 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qquickitemgrabresult.html#ready">ready</a></b>()</td></tr>
</table></div>
<ul>
<li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li>
<li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li>
<li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QQuickItemGrabResult-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qquickitemgrabresult.html">QQuickItemGrabResult</a> contains the result from <a href="qquickitem.html#grabToImage">QQuickItem::grabToImage</a>().</p>
</div>
<p><b>See also </b><a href="qquickitem.html#grabToImage">QQuickItem::grabToImage</a>().</p>
<!-- @@@QQuickItemGrabResult -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$image-prop$$$image -->
<h3 class="fn" id="image-prop"><a name="image-prop"></a><span class="name">image</span> : const <span class="type"><a href="../qtgui/qimage.html">QImage</a></span></h3>
<p>This property holds the pixel results from a grab.</p>
<p>If the grab is not yet complete or if it failed, an empty image is returned.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QImage </td><td class="memItemRight bottomAlign"><span class="name"><b>image</b></span>() const</td></tr>
</table></div>
<!-- @@@image -->
<!-- $$$url-prop$$$url -->
<h3 class="fn" id="url-prop"><a name="url-prop"></a><span class="name">url</span> : const <span class="type"><a href="../qtcore/qurl.html">QUrl</a></span></h3>
<p>This property holds a URL which can be used in conjunction with URL based image consumers, such as the <a href="qml-qtquick-image.html">QtQuick::Image</a> type.</p>
<p>The URL is valid until the <a href="qquickitemgrabresult.html">QQuickItemGrabResult</a> object is deleted.</p>
<p>The URL does not represent a valid file or location to read it from, it is primarily a key to access images through Qt Quick's image-based types.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QUrl </td><td class="memItemRight bottomAlign"><span class="name"><b>url</b></span>() const</td></tr>
</table></div>
<!-- @@@url -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$ready[overload1]$$$ready -->
<h3 class="fn" id="ready"><a name="ready"></a><code>[signal] </code><span class="type">void</span> QQuickItemGrabResult::<span class="name">ready</span>()</h3>
<p>This signal is emitted when the grab has completed.</p>
<!-- @@@ready -->
<!-- $$$saveToFile[overload1]$$$saveToFileconstQString& -->
<h3 class="fn" id="saveToFile"><a name="saveToFile"></a><span class="type">bool</span> QQuickItemGrabResult::<span class="name">saveToFile</span>(const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> &<i>fileName</i>) const</h3>
<p>Saves the grab result as an image to <i>fileName</i>. Returns true if successful; otherwise returns false.</p>
<p><b>Note: </b>In Qt versions prior to 5.9, this function is marked as non-<code>const</code>.</p><!-- @@@saveToFile -->
</div>
</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>
|