/usr/share/qt5/doc/qtlocation/qml-qtlocation-icon.html is in qtlocation5-doc-html 5.5.1-3ubuntu1.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativeplaceicon.cpp -->
<title>Icon QML Type | Qt Location 5.5</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.5</li>
<li><a href="qtlocation-index.html">Qt Location</a></li>
<li><a href="qtlocation-qmlmodule.html">QML Types</a></li>
<li>Icon QML Type</li>
<li id="buildversion">Qt 5.5.1 Reference Documentation</li>
</ul>
</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="#methods">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">Icon QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Icon-brief -->
<p>The Icon type represents an icon image source which can have multiple sizes. <a href="#details">More...</a></p>
<!-- @@@Icon -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtLocation 5.3</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt Location 5.5</td></tr></table></div><ul>
<li><a href="qml-qtlocation-icon-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-qtlocation-icon.html#icon-prop">icon</a></b></b> : QPlaceIcon</li>
<li class="fn"><b><b><a href="qml-qtlocation-icon.html#parameters-prop">parameters</a></b></b> : Object</li>
<li class="fn"><b><b><a href="qml-qtlocation-icon.html#plugin-prop">plugin</a></b></b> : Plugin</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">url <b><b><a href="qml-qtlocation-icon.html#url-method">url</a></b></b>(size <i> size</i>)</li>
</ul>
<!-- $$$Icon-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
</p>
<p>The Icon type can be used in conjunction with an Image type to display an icon. The <a href="qml-qtlocation-icon.html#url-method">url()</a> function is used to construct an icon URL of a requested size, the icon which most closely matches the requested size is returned.</p>
<p>The Icon type also has a parameters map which is a set of key value pairs. The precise keys to use depend on the <a href="qtlocation-index.html#plugin-references-and-parameters">plugin</a> being used. The parameters map is used by the <a href="location-places-qml.html#plugin">Plugin</a> to determine which URL to return.</p>
<p>In the case where an icon can only possibly have one image URL, the parameter key of <code>"singleUrl"</code> can be used with a <a href="../qtcore/qurl.html">QUrl</a> value. Any Icon with this parameter will always return the specified URL regardless of the requested icon size and not defer to any Plugin.</p>
<p>The following code shows how to display a 64x64 pixel icon:</p>
<pre class="qml">import QtQuick 2.0
import QtPositioning 5.5
import QtLocation 5.5
<span class="type">Image</span> {
<span class="name">source</span>: <span class="name">icon</span>.<span class="name">url</span>(<span class="name">Qt</span>.<span class="name">size</span>(<span class="number">64</span>, <span class="number">64</span>))
}</pre>
<p>Alternatively, a default sized icon can be specified like so:</p>
<pre class="qml"> <span class="name">source</span>: <span class="name">icon</span>.<span class="name">url</span>()</pre>
<!-- @@@Icon -->
<h2>Property Documentation</h2>
<!-- $$$icon -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="icon-prop"><td class="tblQmlPropNode"><p><a name="icon-prop"></a><span class="name">icon</span> : <span class="type"><a href="qplaceicon.html">QPlaceIcon</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>For details on how to use this property to interface between C++ and QML see "<a href="location-cpp-qml.html#icon-qplaceicon">Interfaces between C++ and QML Code</a>".</p>
</div></div><!-- @@@icon -->
<br/>
<!-- $$$parameters -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="parameters-prop"><td class="tblQmlPropNode"><p><a name="parameters-prop"></a><span class="name">parameters</span> : <span class="type">Object</span></p></td></tr></table></div></div><div class="qmldoc"><p>This property holds the parameters of the icon and is a map. These parameters are used by the plugin to return the appropriate URL when <a href="qml-qtlocation-icon.html#url-method">url()</a> is called and to specify locations to save to when saving icons.</p>
<p>Consult the <a href="qtlocation-index.html#plugin-references-and-parameters">plugin documentation</a> for what parameters are supported and how they should be used.</p>
<p>Note, due to limitations of the QQmlPropertyMap, it is not possible to declaratively specify the parameters in QML, assignment of parameters keys and values can only be accomplished by JavaScript.</p>
</div></div><!-- @@@parameters -->
<br/>
<!-- $$$plugin -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="plugin-prop"><td class="tblQmlPropNode"><p><a name="plugin-prop"></a><span class="name">plugin</span> : <span class="type"><a href="qml-qtlocation-plugin.html">Plugin</a></span></p></td></tr></table></div></div><div class="qmldoc"><p>The property holds the plugin that is responsible for managing this icon.</p>
</div></div><!-- @@@plugin -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$url -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="odd" id="url-method"><td class="tblQmlFuncNode"><p><a name="url-method"></a><span class="type"><a href="qml-qtlocation-icon.html#url-method">url</a></span> <span class="name">url</span>(<span class="type">size</span><i> size</i>)</p></td></tr></table></div></div><div class="qmldoc"><p>Returns a URL for the icon image that most closely matches the given <i>size</i>.</p>
<p>If no plugin has been assigned to the icon, and the parameters do not contain the 'singleUrl' key, a default constructed URL is returned.</p>
</div></div><!-- @@@url -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 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>
|