/usr/share/qt5/doc/qtlocation/qplaceicon.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 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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qplaceicon.cpp -->
<title>QPlaceIcon Class | 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-module.html">C++ Classes</a></li>
<li>QPlaceIcon</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QPlaceIcon Class</h1>
<!-- $$$QPlaceIcon-brief -->
<p>The <a href="qplaceicon.html">QPlaceIcon</a> class represents an icon. <a href="#details">More...</a></p>
<!-- @@@QPlaceIcon -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QPlaceIcon></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += location</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.5</td></tr></table></div><ul>
<li><a href="qplaceicon-members.html">List of all members, including inherited members</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"> </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#QPlaceIcon">QPlaceIcon</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#QPlaceIcon-2">QPlaceIcon</a></b>(const QPlaceIcon &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#dtor.QPlaceIcon">~QPlaceIcon</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#isEmpty">isEmpty</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceManager * </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#manager">manager</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariantMap </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#parameters">parameters</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#setManager">setManager</a></b>(QPlaceManager *<i> manager</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#setParameters">setParameters</a></b>(const QVariantMap &<i> parameters</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#url">url</a></b>(const QSize &<i> size</i> = QSize()) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#operator-not-eq">operator!=</a></b>(const QPlaceIcon &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceIcon & </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#operator-eq">operator=</a></b>(const QPlaceIcon &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#operator-eq-eq">operator==</a></b>(const QPlaceIcon &<i> other</i>) const</td></tr>
</table></div>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QString </td><td class="memItemRight bottomAlign"><b><a href="qplaceicon.html#SingleUrl-var">SingleUrl</a></b></td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QPlaceIcon-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>The <a href="qplaceicon.html">QPlaceIcon</a> class represents an icon.</p>
<p>The typical usage of an icon is to use the <a href="qplaceicon.html#url">url</a>() function to specify a preferred icon size.</p>
<pre class="cpp"><span class="type"><a href="../qtcore/qurl.html">QUrl</a></span> iconSourceUrl <span class="operator">=</span> place<span class="operator">.</span>icon()<span class="operator">.</span>url(<span class="type"><a href="../qtcore/qsize.html">QSize</a></span>(<span class="number">32</span><span class="operator">,</span><span class="number">32</span>));
<span class="comment">//A default icon may also be requested like so</span>
iconSourceUrl <span class="operator">=</span> place<span class="operator">.</span>icon()<span class="operator">.</span>url();</pre>
<p>The icons are typically backend dependent, if a manager backend does not support a given size, the URL of the icon that most closely matches those parameters is returned.</p>
<p>The icon class also has a key-value set of parameters. The precise key one needs to use depends on the <a href="qtlocation-index.html#plugin-references-and-parameters">plugin</a> being used. These parameters influence which icon URL is returned by the manager and may also be used to specify icon URL locations when saving icons.</p>
<p>If there is only ever one image for an icon, then <a href="qplaceicon.html#SingleUrl-var">QPlaceIcon::SingleUrl</a> can be used as a parameter key with a <a href="../qtcore/qurl.html">QUrl</a> as the associated value. If this key is set, then the <a href="qplaceicon.html#url">url</a>() function will always return the specified URL and not defer to any manager.</p>
</div>
<!-- @@@QPlaceIcon -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaceIcon[overload1]$$$QPlaceIcon -->
<h3 class="fn" id="QPlaceIcon"><a name="QPlaceIcon"></a>QPlaceIcon::<span class="name">QPlaceIcon</span>()</h3>
<p>Constructs an icon.</p>
<!-- @@@QPlaceIcon -->
<!-- $$$QPlaceIcon$$$QPlaceIconconstQPlaceIcon& -->
<h3 class="fn" id="QPlaceIcon-2"><a name="QPlaceIcon-2"></a>QPlaceIcon::<span class="name">QPlaceIcon</span>(const <span class="type"><a href="qplaceicon.html#QPlaceIcon">QPlaceIcon</a></span> &<i> other</i>)</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QPlaceIcon -->
<!-- $$$~QPlaceIcon[overload1]$$$~QPlaceIcon -->
<h3 class="fn" id="dtor.QPlaceIcon"><a name="dtor.QPlaceIcon"></a>QPlaceIcon::<span class="name">~QPlaceIcon</span>()</h3>
<p>Destroys the icon.</p>
<!-- @@@~QPlaceIcon -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn" id="isEmpty"><a name="isEmpty"></a><span class="type">bool</span> QPlaceIcon::<span class="name">isEmpty</span>() const</h3>
<p>Returns a boolean indicating whether the all the fields of the icon are empty or not.</p>
<!-- @@@isEmpty -->
<!-- $$$manager[overload1]$$$manager -->
<h3 class="fn" id="manager"><a name="manager"></a><span class="type"><a href="qplacemanager.html">QPlaceManager</a></span> * QPlaceIcon::<span class="name">manager</span>() const</h3>
<p>Returns the manager that this icon is associated with.</p>
<p><b>See also </b><a href="qplaceicon.html#setManager">setManager</a>().</p>
<!-- @@@manager -->
<!-- $$$parameters[overload1]$$$parameters -->
<h3 class="fn" id="parameters"><a name="parameters"></a><span class="type"><a href="../qtcore/qvariant.html#QVariantMap-typedef">QVariantMap</a></span> QPlaceIcon::<span class="name">parameters</span>() const</h3>
<p>Returns a set of parameters for the icon that are manager/plugin specific. These parameters are used by the manager to return the appropriate URL when <a href="qplaceicon.html#url">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><b>See also </b><a href="qplaceicon.html#setParameters">setParameters</a>().</p>
<!-- @@@parameters -->
<!-- $$$setManager[overload1]$$$setManagerQPlaceManager* -->
<h3 class="fn" id="setManager"><a name="setManager"></a><span class="type">void</span> QPlaceIcon::<span class="name">setManager</span>(<span class="type"><a href="qplacemanager.html">QPlaceManager</a></span> *<i> manager</i>)</h3>
<p>Sets the <i>manager</i> that this icon is associated with. The icon does not take ownership of the pointer.</p>
<p><b>See also </b><a href="qplaceicon.html#manager">manager</a>().</p>
<!-- @@@setManager -->
<!-- $$$setParameters[overload1]$$$setParametersconstQVariantMap& -->
<h3 class="fn" id="setParameters"><a name="setParameters"></a><span class="type">void</span> QPlaceIcon::<span class="name">setParameters</span>(const <span class="type"><a href="../qtcore/qvariant.html#QVariantMap-typedef">QVariantMap</a></span> &<i> parameters</i>)</h3>
<p>Sets the parameters of the icon to <i>parameters</i>.</p>
<p><b>See also </b><a href="qplaceicon.html#parameters">parameters</a>().</p>
<!-- @@@setParameters -->
<!-- $$$url[overload1]$$$urlconstQSize& -->
<h3 class="fn" id="url"><a name="url"></a><span class="type"><a href="../qtcore/qurl.html">QUrl</a></span> QPlaceIcon::<span class="name">url</span>(const <span class="type"><a href="../qtcore/qsize.html">QSize</a></span> &<i> size</i> = QSize()) const</h3>
<p>Returns an icon URL according to the given <i>size</i>.</p>
<p>If no manager has been assigned to the icon, and the parameters do not contain the <a href="qplaceicon.html#SingleUrl-var">QPlaceIcon::SingleUrl</a> key, a default constructed <a href="../qtcore/qurl.html">QUrl</a> is returned.</p>
<!-- @@@url -->
<!-- $$$operator!=[overload1]$$$operator!=constQPlaceIcon& -->
<h3 class="fn" id="operator-not-eq"><a name="operator-not-eq"></a><span class="type">bool</span> QPlaceIcon::<span class="name">operator!=</span>(const <span class="type"><a href="qplaceicon.html#QPlaceIcon">QPlaceIcon</a></span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is not equal to this icon, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQPlaceIcon& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qplaceicon.html#QPlaceIcon">QPlaceIcon</a></span> & QPlaceIcon::<span class="name">operator=</span>(const <span class="type"><a href="qplaceicon.html#QPlaceIcon">QPlaceIcon</a></span> &<i> other</i>)</h3>
<p>Assigns <i>other</i> to this icon and returns a reference to this icon.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQPlaceIcon& -->
<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> QPlaceIcon::<span class="name">operator==</span>(const <span class="type"><a href="qplaceicon.html#QPlaceIcon">QPlaceIcon</a></span> &<i> other</i>) const</h3>
<p>Returns true if this icon is equal to <i>other</i>, otherwise returns false.</p>
<!-- @@@operator== -->
</div>
<div class="vars">
<h2>Member Variable Documentation</h2>
<!-- $$$SingleUrl -->
<h3 class="fn" id="SingleUrl-var"><a name="SingleUrl-var"></a>const <span class="type"><a href="../qtcore/qstring.html">QString</a></span> QPlaceIcon::<span class="name">SingleUrl</span></h3>
<p>This variable holds parameter key for an icon that only has a single image URL.</p>
<p>The parameter value to be used with this key is a <a href="../qtcore/qurl.html">QUrl</a>. An icon with this parameter set will always return the specified URL regardless of the requested size when <a href="qplaceicon.html#url">url</a>() is called.</p>
<!-- @@@SingleUrl -->
</div>
</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>
|