/usr/share/qt5/doc/qtlocation/qplaceresult.html is in qtlocation5-doc-html 5.2.1-1ubuntu2.
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 | <?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" />
<!-- qplaceresult.cpp -->
<title>QPlaceResult Class | QtLocation 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="qtlocation-index.html">Qt Location</a></li>
<li><a href="qtlocation-module.html">C++ Classes</a></li>
<li>QPlaceResult</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QPlaceResult Class</h1>
<!-- $$$QPlaceResult-brief -->
<p>The QPlaceResult class represents a search result containing a place. <a href="#details">More...</a></p>
<!-- @@@QPlaceResult -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QPlaceResult></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += location</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt Location 5.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qplacesearchresult.html">QPlaceSearchResult</a>.</td></tr></table><ul>
<li><a href="qplaceresult-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplaceresult.html#QPlaceResult">QPlaceResult</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplaceresult.html#QPlaceResult-2">QPlaceResult</a></b>(const QPlaceSearchResult &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qplaceresult.html#dtor.QPlaceResult">~QPlaceResult</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qplaceresult.html#distance">distance</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplaceresult.html#isSponsored">isSponsored</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlace </td><td class="memItemRight bottomAlign"><b><a href="qplaceresult.html#place">place</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaceresult.html#setDistance">setDistance</a></b>(qreal<i> distance</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaceresult.html#setPlace">setPlace</a></b>(const QPlace &<i> place</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplaceresult.html#setSponsored">setSponsored</a></b>(bool<i> sponsored</i>)</td></tr>
</table>
<ul>
<li class="fn">8 public functions inherited from <a href="qplacesearchresult.html#public-functions">QPlaceSearchResult</a></li>
</ul>
<a name="details"></a>
<!-- $$$QPlaceResult-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QPlaceResult class represents a search result containing a place.</p>
<p>The <a href="qplacesearchresult.html#SearchResultType-enum">PlaceResult</a> holds the distance to the place from the center of the search request, an instance of the place and an indication of whether the result is sponsored or <a href="http://en.wikipedia.org/wiki/Organic_search">organic</a>.</p>
<p>The intended usage is that a <a href="qplacesearchresult.html">QPlaceSearchResult</a> can be converted into a QPlaceResult like so:</p>
<pre class="cpp"><span class="keyword">if</span> (result<span class="operator">.</span>type() <span class="operator">=</span><span class="operator">=</span> <span class="type"><a href="qplacesearchresult.html">QPlaceSearchResult</a></span><span class="operator">::</span>PlaceResult) {
<span class="type">QPlaceResult</span> placeResult <span class="operator">=</span> result;
qDebug() <span class="operator"><</span><span class="operator"><</span> placeResult<span class="operator">.</span>place()<span class="operator">.</span>name();
qDebug() <span class="operator"><</span><span class="operator"><</span> placeResult<span class="operator">.</span>place()<span class="operator">.</span>location()<span class="operator">.</span>coordinate();
qDebug() <span class="operator"><</span><span class="operator"><</span> placeResult<span class="operator">.</span>distance();
}</pre>
<p>The implmentation is handled in such a way that object slicing is not an issue.</p>
</div>
<p><b>See also </b><a href="qplacesearchresult.html">QPlaceSearchResult</a>.</p>
<!-- @@@QPlaceResult -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaceResult[overload1]$$$QPlaceResult -->
<h3 class="fn"><a name="QPlaceResult"></a>QPlaceResult::<span class="name">QPlaceResult</span>()</h3>
<p>Constructs a new place result object.</p>
<!-- @@@QPlaceResult -->
<!-- $$$QPlaceResult$$$QPlaceResultconstQPlaceSearchResult& -->
<h3 class="fn"><a name="QPlaceResult-2"></a>QPlaceResult::<span class="name">QPlaceResult</span>(const <span class="type"><a href="qplacesearchresult.html">QPlaceSearchResult</a></span> &<i> other</i>)</h3>
<p>Constructs a copy of <i>other</i> if possible, otherwise constructs a default place result.</p>
<!-- @@@QPlaceResult -->
<!-- $$$~QPlaceResult[overload1]$$$~QPlaceResult -->
<h3 class="fn"><a name="dtor.QPlaceResult"></a>QPlaceResult::<span class="name">~QPlaceResult</span>()<tt> [virtual]</tt></h3>
<p>Destructor.</p>
<!-- @@@~QPlaceResult -->
<!-- $$$distance[overload1]$$$distance -->
<h3 class="fn"><a name="distance"></a><span class="type">qreal</span> QPlaceResult::<span class="name">distance</span>() const</h3>
<p>Returns the distance of the place to the search center. This field is only relevant provided the search request contained a search area with a search center. Otherwise, the distance is NaN indicating an undefined distance. The default value for distance is NaN.</p>
<p><b>See also </b><a href="qplaceresult.html#setDistance">setDistance</a>().</p>
<!-- @@@distance -->
<!-- $$$isSponsored[overload1]$$$isSponsored -->
<h3 class="fn"><a name="isSponsored"></a><span class="type">bool</span> QPlaceResult::<span class="name">isSponsored</span>() const</h3>
<p>Returns true if the result is a sponsored result.</p>
<p><b>See also </b><a href="qplaceresult.html#setSponsored">setSponsored</a>().</p>
<!-- @@@isSponsored -->
<!-- $$$place[overload1]$$$place -->
<h3 class="fn"><a name="place"></a><span class="type"><a href="qplace.html">QPlace</a></span> QPlaceResult::<span class="name">place</span>() const</h3>
<p>Returns the place of the search result.</p>
<p><b>See also </b><a href="qplaceresult.html#setPlace">setPlace</a>().</p>
<!-- @@@place -->
<!-- $$$setDistance[overload1]$$$setDistanceqreal -->
<h3 class="fn"><a name="setDistance"></a><span class="type">void</span> QPlaceResult::<span class="name">setDistance</span>(<span class="type">qreal</span><i> distance</i>)</h3>
<p>Set the <i>distance</i> of the search result's place from a search center.</p>
<p><b>See also </b><a href="qplaceresult.html#distance">distance</a>().</p>
<!-- @@@setDistance -->
<!-- $$$setPlace[overload1]$$$setPlaceconstQPlace& -->
<h3 class="fn"><a name="setPlace"></a><span class="type">void</span> QPlaceResult::<span class="name">setPlace</span>(const <span class="type"><a href="qplace.html">QPlace</a></span> &<i> place</i>)</h3>
<p>Sets the <i>place</i> that this result refers to.</p>
<p><b>See also </b><a href="qplaceresult.html#place">place</a>().</p>
<!-- @@@setPlace -->
<!-- $$$setSponsored[overload1]$$$setSponsoredbool -->
<h3 class="fn"><a name="setSponsored"></a><span class="type">void</span> QPlaceResult::<span class="name">setSponsored</span>(<span class="type">bool</span><i> sponsored</i>)</h3>
<p>Sets whether the result is a <i>sponsored</i> result or not.</p>
<p><b>See also </b><a href="qplaceresult.html#isSponsored">isSponsored</a>().</p>
<!-- @@@setSponsored -->
</div>
</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>
|