/usr/share/qt5/doc/qtlocation/qplacesearchresult.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 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | <?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" />
<!-- qplacesearchresult.cpp -->
<title>QPlaceSearchResult 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>QPlaceSearchResult</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-types">Public Types</a></li>
<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">QPlaceSearchResult Class</h1>
<!-- $$$QPlaceSearchResult-brief -->
<p>The QPlaceSearchResult class is the base class for search results. <a href="#details">More...</a></p>
<!-- @@@QPlaceSearchResult -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QPlaceSearchResult></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"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qplaceproposedsearchresult.html">QPlaceProposedSearchResult</a> and <a href="qplaceresult.html">QPlaceResult</a>.</p>
</td></tr></table><ul>
<li><a href="qplacesearchresult-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchresult.html#SearchResultType-enum">SearchResultType</a></b> { UnknownSearchResult, PlaceResult, ProposedSearchResult }</td></tr>
</table>
<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="qplacesearchresult.html#QPlaceSearchResult">QPlaceSearchResult</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchresult.html#QPlaceSearchResult-2">QPlaceSearchResult</a></b>(const QPlaceSearchResult &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchresult.html#dtor.QPlaceSearchResult">~QPlaceSearchResult</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceIcon </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchresult.html#icon">icon</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchresult.html#setIcon">setIcon</a></b>(const QPlaceIcon &<i> icon</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchresult.html#setTitle">setTitle</a></b>(const QString &<i> title</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchresult.html#title">title</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> SearchResultType </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchresult.html#type">type</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchresult.html#operator-not-eq">operator!=</a></b>(const QPlaceSearchResult &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceSearchResult & </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchresult.html#operator-eq">operator=</a></b>(const QPlaceSearchResult &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchresult.html#operator-eq-eq">operator==</a></b>(const QPlaceSearchResult &<i> other</i>) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QPlaceSearchResult-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QPlaceSearchResult class is the base class for search results.</p>
<p>A list of search results can be retrieved from the <a href="qplacesearchreply.html">QPlaceSearchReply</a> after it has successfully completed the request. Common to all search results are the <a href="qplacesearchresult.html#title">title</a> and <a href="qplacesearchresult.html#icon">icon</a>, which can be used to present the search result to the user.</p>
<p>The intended usage is that depending on the <a href="qplacesearchresult.html#type">type</a>, the search result can be converted to a more detailed subclass 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">QPlaceSearchResult</span><span class="operator">::</span>PlaceResult) {
<span class="type"><a href="qplaceresult.html">QPlaceResult</a></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. It is not expected that client applications or backend plugins instantiate a QPlaceSearchResult directly, but rather client applications simply convert to search result subclasses and backend plugins only instantiate subclasses.</p>
</div>
<p><b>See also </b><a href="qplaceresult.html">QPlaceResult</a>.</p>
<!-- @@@QPlaceSearchResult -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$SearchResultType$$$UnknownSearchResult$$$PlaceResult$$$ProposedSearchResult -->
<h3 class="fn"><a name="SearchResultType-enum"></a>enum QPlaceSearchResult::<span class="name">SearchResultType</span></h3>
<p>Defines the type of search result</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QPlaceSearchResult::UnknownSearchResult</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The contents of the search result are unknown.</td></tr>
<tr><td class="topAlign"><tt>QPlaceSearchResult::PlaceResult</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The search result contains a place.</td></tr>
<tr><td class="topAlign"><tt>QPlaceSearchResult::ProposedSearchResult</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The search result contains a proposed search which may be relevant.</td></tr>
</table>
<!-- @@@SearchResultType -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaceSearchResult[overload1]$$$QPlaceSearchResult -->
<h3 class="fn"><a name="QPlaceSearchResult"></a>QPlaceSearchResult::<span class="name">QPlaceSearchResult</span>()</h3>
<p>Constructs a new search result.</p>
<!-- @@@QPlaceSearchResult -->
<!-- $$$QPlaceSearchResult$$$QPlaceSearchResultconstQPlaceSearchResult& -->
<h3 class="fn"><a name="QPlaceSearchResult-2"></a>QPlaceSearchResult::<span class="name">QPlaceSearchResult</span>(const <span class="type">QPlaceSearchResult</span> &<i> other</i>)</h3>
<p>Constructs a copy of <i>other</i></p>
<!-- @@@QPlaceSearchResult -->
<!-- $$$~QPlaceSearchResult[overload1]$$$~QPlaceSearchResult -->
<h3 class="fn"><a name="dtor.QPlaceSearchResult"></a>QPlaceSearchResult::<span class="name">~QPlaceSearchResult</span>()<tt> [virtual]</tt></h3>
<p>Destroys the search result.</p>
<!-- @@@~QPlaceSearchResult -->
<!-- $$$icon[overload1]$$$icon -->
<h3 class="fn"><a name="icon"></a><span class="type"><a href="qplaceicon.html">QPlaceIcon</a></span> QPlaceSearchResult::<span class="name">icon</span>() const</h3>
<p>Returns an icon that can be used to represent the search result.</p>
<p><b>See also </b><a href="qplacesearchresult.html#setIcon">setIcon</a>().</p>
<!-- @@@icon -->
<!-- $$$setIcon[overload1]$$$setIconconstQPlaceIcon& -->
<h3 class="fn"><a name="setIcon"></a><span class="type">void</span> QPlaceSearchResult::<span class="name">setIcon</span>(const <span class="type"><a href="qplaceicon.html">QPlaceIcon</a></span> &<i> icon</i>)</h3>
<p>Sets the icon of the search result to <i>icon</i>.</p>
<p><b>See also </b><a href="qplacesearchresult.html#icon">icon</a>().</p>
<!-- @@@setIcon -->
<!-- $$$setTitle[overload1]$$$setTitleconstQString& -->
<h3 class="fn"><a name="setTitle"></a><span class="type">void</span> QPlaceSearchResult::<span class="name">setTitle</span>(const <span class="type">QString</span> &<i> title</i>)</h3>
<p>Sets the title of the search result to <i>title</i>.</p>
<p><b>See also </b><a href="qplacesearchresult.html#title">title</a>().</p>
<!-- @@@setTitle -->
<!-- $$$title[overload1]$$$title -->
<h3 class="fn"><a name="title"></a><span class="type">QString</span> QPlaceSearchResult::<span class="name">title</span>() const</h3>
<p>Returns the title of the search result. This string can be used to display the search result to the user.</p>
<p><b>See also </b><a href="qplacesearchresult.html#setTitle">setTitle</a>().</p>
<!-- @@@title -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn"><a name="type"></a><span class="type"><a href="qplacesearchresult.html#SearchResultType-enum">SearchResultType</a></span> QPlaceSearchResult::<span class="name">type</span>() const</h3>
<p>Returns the result type.</p>
<!-- @@@type -->
<!-- $$$operator!=[overload1]$$$operator!=constQPlaceSearchResult& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QPlaceSearchResult::<span class="name">operator!=</span>(const <span class="type">QPlaceSearchResult</span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> not equal to this search result, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQPlaceSearchResult& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QPlaceSearchResult</span> & QPlaceSearchResult::<span class="name">operator=</span>(const <span class="type">QPlaceSearchResult</span> &<i> other</i>)</h3>
<p>Assigns <i>other</i> to this search result and returns a reference to this search result.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQPlaceSearchResult& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QPlaceSearchResult::<span class="name">operator==</span>(const <span class="type">QPlaceSearchResult</span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is equal to this search result, otherwise returns false.</p>
<!-- @@@operator== -->
</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>
|