/usr/share/qt5/doc/qtlocation/qplacesearchrequest.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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | <?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" />
<!-- qplacesearchrequest.cpp -->
<title>QPlaceSearchRequest 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>QPlaceSearchRequest</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">QPlaceSearchRequest Class</h1>
<!-- $$$QPlaceSearchRequest-brief -->
<p>The QPlaceSearchRequest class represents the set of parameters for a search request. <a href="#details">More...</a></p>
<!-- @@@QPlaceSearchRequest -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QPlaceSearchRequest></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></table><ul>
<li><a href="qplacesearchrequest-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="qplacesearchrequest.html#RelevanceHint-enum">RelevanceHint</a></b> { UnspecifiedHint, DistanceHint, LexicalPlaceNameHint }</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="qplacesearchrequest.html#QPlaceSearchRequest">QPlaceSearchRequest</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#QPlaceSearchRequest-2">QPlaceSearchRequest</a></b>(const QPlaceSearchRequest &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#dtor.QPlaceSearchRequest">~QPlaceSearchRequest</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QPlaceCategory> </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#categories">categories</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#clear">clear</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#limit">limit</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#offset">offset</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#recommendationId">recommendationId</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> RelevanceHint </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#relevanceHint">relevanceHint</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoShape </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#searchArea">searchArea</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#searchContext">searchContext</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#searchTerm">searchTerm</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#setCategories">setCategories</a></b>(const QList<QPlaceCategory> &<i> categories</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#setCategory">setCategory</a></b>(const QPlaceCategory &<i> category</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#setLimit">setLimit</a></b>(int<i> limit</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#setOffset">setOffset</a></b>(int<i> offset</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#setRecommendationId">setRecommendationId</a></b>(const QString &<i> placeId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#setRelevanceHint">setRelevanceHint</a></b>(RelevanceHint<i> hint</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#setSearchArea">setSearchArea</a></b>(const QGeoShape &<i> area</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#setSearchContext">setSearchContext</a></b>(const QVariant &<i> context</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#setSearchTerm">setSearchTerm</a></b>(const QString &<i> term</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#setVisibilityScope">setVisibilityScope</a></b>(QLocation::VisibilityScope<i> scope</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLocation::VisibilityScope </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#visibilityScope">visibilityScope</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#operator-not-eq">operator!=</a></b>(const QPlaceSearchRequest &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceSearchRequest & </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#operator-eq">operator=</a></b>(const QPlaceSearchRequest &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplacesearchrequest.html#operator-eq-eq">operator==</a></b>(const QPlaceSearchRequest &<i> other</i>) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QPlaceSearchRequest-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QPlaceSearchRequest class represents the set of parameters for a search request.</p>
<p>A typical search request may look like the following:</p>
<pre class="cpp"><span class="type">QPlaceSearchRequest</span> searchRequest;
searchRequest<span class="operator">.</span>setSearchTerm(<span class="string">"Fast food"</span>); <span class="comment">//search term for what we are interested in</span>
<span class="comment">//set a search center</span>
searchRequest<span class="operator">.</span>setSearchArea(<span class="type">QGeoCircle</span>(<span class="type">QGeoCoordinate</span>(<span class="number">2.3</span><span class="operator">,</span> <span class="number">48.87</span>)));
<span class="comment">//set a distance hint as a relevancy hint.</span>
<span class="comment">//closer places have greater weighting in the ranking of results.</span>
searchRequest<span class="operator">.</span>setRelevanceHint(<span class="type">QPlaceSearchRequest</span><span class="operator">::</span>DistanceHint);
<span class="comment">//use offset and limit to provide pagination.</span>
<span class="comment">//this retrieves the next 5 items from the 10th index</span>
searchRequest<span class="operator">.</span>setOffset(<span class="number">9</span>);
searchRequest<span class="operator">.</span>setLimit(<span class="number">5</span>);
<span class="comment">//provide some categories to narrow down search</span>
<span class="type">QList</span><span class="operator"><</span><span class="type"><a href="qplacecategory.html">QPlaceCategory</a></span><span class="operator">></span> categories;
categories <span class="operator"><</span><span class="operator"><</span> diner <span class="operator"><</span><span class="operator"><</span> restaurant;
searchRequest<span class="operator">.</span>setCategories(categories);</pre>
<p>Note that specifying a search center can be done by setting a circular search area that has a center but no radius. The default radius is set to -1, which indicates an undefined radius. The provider will interpret this as being free to choose its own default radius.</p>
<p>The QPlaceSearchRequest is primarily used with the <a href="qplacemanager.html">QPlaceManager</a> to <a href="qplacemanager.html#search">search for places</a>, however it is also used to provide parameters for <a href="qplacemanager.html#searchSuggestions">generating search term suggestions</a>. Note that in this context only some of the parameters may be relevant. For example, the search area is useful in narrowing down relevant search suggestions, while other parameters such as relevance hint are not so applicable.</p>
<p>Also be aware that providers may vary by which parameters they support for example some providers may not support paging while others do, some providers may honor relevance hints while others may completely ignore them, see the <a href="qtlocation-index.html#plugin-references-and-parameters">plugin documentation</a> for more details.</p>
</div>
<!-- @@@QPlaceSearchRequest -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$RelevanceHint$$$UnspecifiedHint$$$DistanceHint$$$LexicalPlaceNameHint -->
<h3 class="fn"><a name="RelevanceHint-enum"></a>enum QPlaceSearchRequest::<span class="name">RelevanceHint</span></h3>
<p>Defines hints to help rank place results.</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>QPlaceSearchRequest::UnspecifiedHint</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">No explicit hint has been specified.</td></tr>
<tr><td class="topAlign"><tt>QPlaceSearchRequest::DistanceHint</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">Distance to a search center is relevant for the user. Closer places are more highly weighted. This hint is only useful if a circular search area is used in the query.</td></tr>
<tr><td class="topAlign"><tt>QPlaceSearchRequest::LexicalPlaceNameHint</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">Alphabetic ordering of places according to name is relevant to the user.</td></tr>
</table>
<!-- @@@RelevanceHint -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaceSearchRequest[overload1]$$$QPlaceSearchRequest -->
<h3 class="fn"><a name="QPlaceSearchRequest"></a>QPlaceSearchRequest::<span class="name">QPlaceSearchRequest</span>()</h3>
<p>Default constructor. Constructs an new request object.</p>
<!-- @@@QPlaceSearchRequest -->
<!-- $$$QPlaceSearchRequest$$$QPlaceSearchRequestconstQPlaceSearchRequest& -->
<h3 class="fn"><a name="QPlaceSearchRequest-2"></a>QPlaceSearchRequest::<span class="name">QPlaceSearchRequest</span>(const <span class="type">QPlaceSearchRequest</span> &<i> other</i>)</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QPlaceSearchRequest -->
<!-- $$$~QPlaceSearchRequest[overload1]$$$~QPlaceSearchRequest -->
<h3 class="fn"><a name="dtor.QPlaceSearchRequest"></a>QPlaceSearchRequest::<span class="name">~QPlaceSearchRequest</span>()</h3>
<p>Destroys the request object.</p>
<!-- @@@~QPlaceSearchRequest -->
<!-- $$$categories[overload1]$$$categories -->
<h3 class="fn"><a name="categories"></a><span class="type">QList</span><<span class="type"><a href="qplacecategory.html">QPlaceCategory</a></span>> QPlaceSearchRequest::<span class="name">categories</span>() const</h3>
<p>Return the categories to be used in the search request. Places need only to belong to one of the categories to be considered a match by the request.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#setCategories">setCategories</a>().</p>
<!-- @@@categories -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn"><a name="clear"></a><span class="type">void</span> QPlaceSearchRequest::<span class="name">clear</span>()</h3>
<p>Clears the search request.</p>
<!-- @@@clear -->
<!-- $$$limit[overload1]$$$limit -->
<h3 class="fn"><a name="limit"></a><span class="type">int</span> QPlaceSearchRequest::<span class="name">limit</span>() const</h3>
<p>Returns the maximum number of search results to retrieve.</p>
<p>A negative value for limit means that it is undefined. It is left up to the backend provider to choose an appropriate number of results to return. The default limit is -1.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#setLimit">setLimit</a>().</p>
<!-- @@@limit -->
<!-- $$$offset[overload1]$$$offset -->
<h3 class="fn"><a name="offset"></a><span class="type">int</span> QPlaceSearchRequest::<span class="name">offset</span>() const</h3>
<p>Returns the offset index of the first item that is to be retrieved.</p>
<p>The default offset is 0.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#setOffset">setOffset</a>().</p>
<!-- @@@offset -->
<!-- $$$recommendationId[overload1]$$$recommendationId -->
<h3 class="fn"><a name="recommendationId"></a><span class="type">QString</span> QPlaceSearchRequest::<span class="name">recommendationId</span>() const</h3>
<p>Returns the place id which will be used to search for recommendations for similar places.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#setRecommendationId">setRecommendationId</a>().</p>
<!-- @@@recommendationId -->
<!-- $$$relevanceHint[overload1]$$$relevanceHint -->
<h3 class="fn"><a name="relevanceHint"></a><span class="type"><a href="qplacesearchrequest.html#RelevanceHint-enum">RelevanceHint</a></span> QPlaceSearchRequest::<span class="name">relevanceHint</span>() const</h3>
<p>Returns the relevance hint of the request. The hint is given to the provider to help but not dictate the ranking of results. For example providing a distance hint may give closer places a higher ranking but it doesn't necessarily mean that he results will be ordered strictly according to distance.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#setRelevanceHint">setRelevanceHint</a>().</p>
<!-- @@@relevanceHint -->
<!-- $$$searchArea[overload1]$$$searchArea -->
<h3 class="fn"><a name="searchArea"></a><span class="type">QGeoShape</span> QPlaceSearchRequest::<span class="name">searchArea</span>() const</h3>
<p>Returns the search area which will be used to limit search results. The default search area is an invalid QGeoShape, indicating that no specific search area is defined.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#setSearchArea">setSearchArea</a>().</p>
<!-- @@@searchArea -->
<!-- $$$searchContext[overload1]$$$searchContext -->
<h3 class="fn"><a name="searchContext"></a><span class="type">QVariant</span> QPlaceSearchRequest::<span class="name">searchContext</span>() const</h3>
<p>Returns backend specific additional search context associated with this place search request. The search context is typically set as part of a <a href="qplacesearchresult.html#SearchResultType-enum">proposed search results</a>.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#setSearchContext">setSearchContext</a>().</p>
<!-- @@@searchContext -->
<!-- $$$searchTerm[overload1]$$$searchTerm -->
<h3 class="fn"><a name="searchTerm"></a><span class="type">QString</span> QPlaceSearchRequest::<span class="name">searchTerm</span>() const</h3>
<p>Returns the search term.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#setSearchTerm">setSearchTerm</a>().</p>
<!-- @@@searchTerm -->
<!-- $$$setCategories[overload1]$$$setCategoriesconstQList<QPlaceCategory>& -->
<h3 class="fn"><a name="setCategories"></a><span class="type">void</span> QPlaceSearchRequest::<span class="name">setCategories</span>(const <span class="type">QList</span><<span class="type"><a href="qplacecategory.html">QPlaceCategory</a></span>> &<i> categories</i>)</h3>
<p>Sets the search request to search from the list of given <i>categories</i>. Any places returned during the search will match at least one of the <i>categories</i>.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#categories">categories</a>() and <a href="qplacesearchrequest.html#setCategory">setCategory</a>().</p>
<!-- @@@setCategories -->
<!-- $$$setCategory[overload1]$$$setCategoryconstQPlaceCategory& -->
<h3 class="fn"><a name="setCategory"></a><span class="type">void</span> QPlaceSearchRequest::<span class="name">setCategory</span>(const <span class="type"><a href="qplacecategory.html">QPlaceCategory</a></span> &<i> category</i>)</h3>
<p>Sets the search request to search by a single <i>category</i></p>
<p><b>See also </b><a href="qplacesearchrequest.html#setCategories">setCategories</a>().</p>
<!-- @@@setCategory -->
<!-- $$$setLimit[overload1]$$$setLimitint -->
<h3 class="fn"><a name="setLimit"></a><span class="type">void</span> QPlaceSearchRequest::<span class="name">setLimit</span>(<span class="type">int</span><i> limit</i>)</h3>
<p>Set the maximum number of search results to retrieve to <i>limit</i>.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#limit">limit</a>().</p>
<!-- @@@setLimit -->
<!-- $$$setOffset[overload1]$$$setOffsetint -->
<h3 class="fn"><a name="setOffset"></a><span class="type">void</span> QPlaceSearchRequest::<span class="name">setOffset</span>(<span class="type">int</span><i> offset</i>)</h3>
<p>Sets the starting index of the first item to be retrieved to <i>offset</i>.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#offset">offset</a>().</p>
<!-- @@@setOffset -->
<!-- $$$setRecommendationId[overload1]$$$setRecommendationIdconstQString& -->
<h3 class="fn"><a name="setRecommendationId"></a><span class="type">void</span> QPlaceSearchRequest::<span class="name">setRecommendationId</span>(const <span class="type">QString</span> &<i> placeId</i>)</h3>
<p>Sets the <i>placeId</i> which will be used to search for recommendations.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#recommendationId">recommendationId</a>().</p>
<!-- @@@setRecommendationId -->
<!-- $$$setRelevanceHint[overload1]$$$setRelevanceHintRelevanceHint -->
<h3 class="fn"><a name="setRelevanceHint"></a><span class="type">void</span> QPlaceSearchRequest::<span class="name">setRelevanceHint</span>(<span class="type"><a href="qplacesearchrequest.html#RelevanceHint-enum">RelevanceHint</a></span><i> hint</i>)</h3>
<p>Sets the relevance <i>hint</i> to be used when searching for a place.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#relevanceHint">relevanceHint</a>().</p>
<!-- @@@setRelevanceHint -->
<!-- $$$setSearchArea[overload1]$$$setSearchAreaconstQGeoShape& -->
<h3 class="fn"><a name="setSearchArea"></a><span class="type">void</span> QPlaceSearchRequest::<span class="name">setSearchArea</span>(const <span class="type">QGeoShape</span> &<i> area</i>)</h3>
<p>Sets the search request to search within the given <i>area</i>.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#searchArea">searchArea</a>().</p>
<!-- @@@setSearchArea -->
<!-- $$$setSearchContext[overload1]$$$setSearchContextconstQVariant& -->
<h3 class="fn"><a name="setSearchContext"></a><span class="type">void</span> QPlaceSearchRequest::<span class="name">setSearchContext</span>(const <span class="type">QVariant</span> &<i> context</i>)</h3>
<p>Sets the search context to <i>context</i>.</p>
<p><b>Note: </b>This method is intended to be used by geo service plugins when returning search results of type <a href="qplacesearchresult.html#SearchResultType-enum">QPlaceSearchResult::ProposedSearchResult</a>.</p><p>The search context is used by backends to store additional search context related to the search request. Other relevant fields should also be filled in. For example, if the search context encodes a text search the search term should also be set with <a href="qplacesearchrequest.html#setSearchTerm">setSearchTerm</a>(). The search context allows additional search context to be kept which is not directly accessible via the Qt Location API.</p>
<p>The search context can be of any type storable in a QVariant. The value of the search context is not intended to be use directly by applications.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#searchContext">searchContext</a>().</p>
<!-- @@@setSearchContext -->
<!-- $$$setSearchTerm[overload1]$$$setSearchTermconstQString& -->
<h3 class="fn"><a name="setSearchTerm"></a><span class="type">void</span> QPlaceSearchRequest::<span class="name">setSearchTerm</span>(const <span class="type">QString</span> &<i> term</i>)</h3>
<p>Sets the search <i>term</i>.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#searchTerm">searchTerm</a>().</p>
<!-- @@@setSearchTerm -->
<!-- $$$setVisibilityScope[overload1]$$$setVisibilityScopeQLocation::VisibilityScope -->
<h3 class="fn"><a name="setVisibilityScope"></a><span class="type">void</span> QPlaceSearchRequest::<span class="name">setVisibilityScope</span>(<span class="type"><a href="qlocation.html#Visibility-enum">QLocation::VisibilityScope</a></span><i> scope</i>)</h3>
<p>Sets the visibility <i>scope</i> used when searching for places.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#visibilityScope">visibilityScope</a>().</p>
<!-- @@@setVisibilityScope -->
<!-- $$$visibilityScope[overload1]$$$visibilityScope -->
<h3 class="fn"><a name="visibilityScope"></a><span class="type"><a href="qlocation.html#Visibility-enum">QLocation::VisibilityScope</a></span> QPlaceSearchRequest::<span class="name">visibilityScope</span>() const</h3>
<p>Returns the visibility scope used when searching for places. The default value is <a href="qlocation.html#Visibility-enum">QLocation::UnspecifiedVisibility</a> meaning that no explicit scope has been assigned. Places of any scope may be returned during the search.</p>
<p><b>See also </b><a href="qplacesearchrequest.html#setVisibilityScope">setVisibilityScope</a>().</p>
<!-- @@@visibilityScope -->
<!-- $$$operator!=[overload1]$$$operator!=constQPlaceSearchRequest& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QPlaceSearchRequest::<span class="name">operator!=</span>(const <span class="type">QPlaceSearchRequest</span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is not equal to this search request, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQPlaceSearchRequest& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QPlaceSearchRequest</span> & QPlaceSearchRequest::<span class="name">operator=</span>(const <span class="type">QPlaceSearchRequest</span> &<i> other</i>)</h3>
<p>Assigns <i>other</i> to this search request and returns a reference to this search request.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQPlaceSearchRequest& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QPlaceSearchRequest::<span class="name">operator==</span>(const <span class="type">QPlaceSearchRequest</span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is equal to this search request, 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>
|