/usr/share/qt5/doc/qtlocation/qplace.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 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 | <?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" />
<!-- qplace.cpp -->
<title>QPlace 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>QPlace</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>
<li class="level2"><a href="#contact-information">Contact Information</a></li>
<li class="level2"><a href="#extended-attributes">Extended Attributes</a></li>
<li class="level2"><a href="#content">Content</a></li>
<li class="level3"><a href="#attribution">Attribution</a></li>
<li class="level2"><a href="#categories">Categories</a></li>
<li class="level2"><a href="#saving-caveats">Saving Caveats</a></li>
</ul>
</div>
<h1 class="title">QPlace Class</h1>
<!-- $$$QPlace-brief -->
<p>The QPlace class represents a set of data about a place. <a href="#details">More...</a></p>
<!-- @@@QPlace -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QPlace></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="qplace-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="qplace.html#QPlace">QPlace</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#QPlace-2">QPlace</a></b>(const QPlace &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#dtor.QPlace">~QPlace</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#appendContactDetail">appendContactDetail</a></b>(const QString &<i> contactType</i>, const QPlaceContactDetail &<i> detail</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#attribution">attribution</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QPlaceCategory> </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#categories">categories</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QPlaceContactDetail> </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#contactDetails">contactDetails</a></b>(const QString &<i> contactType</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#contactTypes">contactTypes</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceContent::Collection </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#content">content</a></b>(QPlaceContent::Type<i> type</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#detailsFetched">detailsFetched</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceAttribute </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#extendedAttribute">extendedAttribute</a></b>(const QString &<i> attributeType</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#extendedAttributeTypes">extendedAttributeTypes</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceIcon </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#icon">icon</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#insertContent">insertContent</a></b>(QPlaceContent::Type<i> type</i>, const QPlaceContent::Collection &<i> content</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#isEmpty">isEmpty</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoLocation </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#location">location</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#name">name</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#placeId">placeId</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#primaryEmail">primaryEmail</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#primaryFax">primaryFax</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#primaryPhone">primaryPhone</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#primaryWebsite">primaryWebsite</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceRatings </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#ratings">ratings</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#removeContactDetails">removeContactDetails</a></b>(const QString &<i> contactType</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#removeExtendedAttribute">removeExtendedAttribute</a></b>(const QString &<i> attributeType</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#setAttribution">setAttribution</a></b>(const QString &<i> attribution</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.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="qplace.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="qplace.html#setContactDetails">setContactDetails</a></b>(const QString &<i> contactType</i>, QList<QPlaceContactDetail><i> details</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#setContent">setContent</a></b>(QPlaceContent::Type<i> type</i>, const QPlaceContent::Collection &<i> content</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#setDetailsFetched">setDetailsFetched</a></b>(bool<i> fetched</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#setExtendedAttribute">setExtendedAttribute</a></b>(const QString &<i> attributeType</i>, const QPlaceAttribute &<i> attribute</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.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="qplace.html#setLocation">setLocation</a></b>(const QGeoLocation &<i> location</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#setName">setName</a></b>(const QString &<i> name</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#setPlaceId">setPlaceId</a></b>(const QString &<i> identifier</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#setRatings">setRatings</a></b>(const QPlaceRatings &<i> rating</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#setSupplier">setSupplier</a></b>(const QPlaceSupplier &<i> supplier</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#setTotalContentCount">setTotalContentCount</a></b>(QPlaceContent::Type<i> type</i>, int<i> totalCount</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#setVisibility">setVisibility</a></b>(QLocation::Visibility<i> visibility</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceSupplier </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#supplier">supplier</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#totalContentCount">totalContentCount</a></b>(QPlaceContent::Type<i> type</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLocation::Visibility </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#visibility">visibility</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#operator-not-eq">operator!=</a></b>(const QPlace &<i> other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPlace & </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#operator-eq">operator=</a></b>(const QPlace &<i> other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qplace.html#operator-eq-eq">operator==</a></b>(const QPlace &<i> other</i>) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QPlace-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QPlace class represents a set of data about a place.</p>
<p>A place is a point of interest, it could be a favorite restaurant, a park or someone's home. A QPlace object represents a place by acting as a container for various information about that place.</p>
<p>This information can be divided into 2 broad classifications</p>
<ul>
<li>Details</li>
<li>Rich content</li>
</ul>
<p>The place details consist of properties of the place, such as the name, location, contact information and so on. When a place is returned during a search, these details are filled in. Sometimes in order to save bandwidth, there are further details about the place that can be retrieved on an individual place by place basis, if the user is interested. The <a href="qplace.html#detailsFetched">QPlace::detailsFetched</a>() function can be queried to see if all available details have been fetched, and if not, <a href="qplacemanager.html#getPlaceDetails">QPlaceManager::getPlaceDetails</a>() can be used to retrieve them. Precisely which details are populated during a search and which need to be fetched individually may vary from provider to provider. See <a href="qtlocation-index.html#plugin-references-and-parameters">plugin documentation</a> for more details.</p>
<p>The rich content of a place consists of items such as images, reviews and editorials. Potentially there may be many rich content items, so they are treated separately from the place details. They can be retrieved in a paged fashion via <a href="qplacemanager.html#getPlaceContent">QPlaceManager::getPlaceContent</a>(). If necessary, the content may be assigned to a place so it can act as a convenient container.</p>
<a name="contact-information"></a>
<h4>Contact Information</h4>
<p>The contact information of a place is based around a common set of <a href="qplacecontactdetail.html#contact-types">contact types</a>. To retrieve all the phone numbers of a place, one would do:</p>
<pre class="cpp"><span class="keyword">if</span> (place<span class="operator">.</span>contactTypes()<span class="operator">.</span>contains(<span class="type"><a href="qplacecontactdetail.html">QPlaceContactDetail</a></span><span class="operator">::</span>Phone)) {
foreach (<span class="keyword">const</span> <span class="type"><a href="qplacecontactdetail.html">QPlaceContactDetail</a></span> <span class="operator">&</span>number<span class="operator">,</span> place<span class="operator">.</span>contactDetails(<span class="type"><a href="qplacecontactdetail.html">QPlaceContactDetail</a></span><span class="operator">::</span>Phone))
qDebug() <span class="operator"><</span><span class="operator"><</span> number<span class="operator">.</span>label() <span class="operator"><</span><span class="operator"><</span> <span class="string">":"</span> <span class="operator"><</span><span class="operator"><</span> number<span class="operator">.</span>value();
}</pre>
<p>The contact types are string values by design to allow for providers to introduce new contact types.</p>
<p>For convenience there are a set of functions which return the value of the first contact detail of each type.</p>
<ul>
<li><a href="qplace.html#primaryPhone">QPlace::primaryPhone</a>()</li>
<li><a href="qplace.html#primaryEmail">QPlace::primaryEmail</a>()</li>
<li><a href="qplace.html#primaryWebsite">QPlace::primaryWebsite</a>()</li>
<li><a href="qplace.html#primaryFax">QPlace::primaryFax</a>()</li>
</ul>
<a name="extended-attributes"></a>
<h4>Extended Attributes</h4>
<p>Places may have additional attributes which are not covered in the formal API. Similar to contacts attributes are based around a common set of <a href="qplaceattribute.html#attribute-types">attribute types</a>. To retrieve an extended attribute one would do:</p>
<pre class="cpp"><span class="keyword">if</span> (place<span class="operator">.</span>extendedAttributeTypes()<span class="operator">.</span>contains(<span class="type"><a href="qplaceattribute.html">QPlaceAttribute</a></span><span class="operator">::</span>OpeningHours))
qDebug() <span class="operator"><</span><span class="operator"><</span> place<span class="operator">.</span>extendedAttribute(<span class="type"><a href="qplaceattribute.html">QPlaceAttribute</a></span><span class="operator">::</span>OpeningHours)<span class="operator">.</span>text();</pre>
<p>The attribute types are string values by design to allow providers to introduce new attribute types.</p>
<a name="content"></a>
<h4>Content</h4>
<p>The QPlace object is only meant to be a convenient container to hold rich content such as images, reviews and so on. Retrieval of content should happen via <a href="qplacemanager.html#getPlaceContent">QPlaceManager::getPlaceContent</a>().</p>
<p>The content is stored as a <a href="qplacecontent.html#Collection-typedef">QPlaceContent::Collection</a> which contains both the index of the content, as well as the content itself. This enables developers to check whether a particular item has already been retrieved and if not, then request that content.</p>
<a name="attribution"></a>
<h5>Attribution</h5>
<p>Places have a field for a rich text attribution string. Some providers may require that the attribution be shown when a place is displayed to a user.</p>
<a name="categories"></a>
<h4>Categories</h4>
<p>Different categories may be assigned to a place to indicate that the place is associated with those categories. When saving a place, the only meaningful data is the category id, the rest of the category data is effectively ignored. The category must already exist before saving the place (it is not possible to create a new category, assign it to the place, save the place and expect the category to be created).</p>
<a name="saving-caveats"></a>
<h4>Saving Caveats</h4>
<p>The Places API is currently designed for only saving <i>core</i> details. Saving rich content like images and reviews or details like supplier and rating is not a supported use case. Typically a manager will generally ignore these fields upon save and may produce a warning message if they are populated.</p>
<p>The Places API only supports saving of the following <i>core details</i>:</p>
<ul>
<li>name</li>
<li>place id</li>
<li>location</li>
<li>contact details</li>
<li>icon</li>
<li>categories (tag-like names to describe a place)</li>
<li>visibility scope</li>
</ul>
<p>It is possible that providers may only support a subset of these. See the <a href="qtlocation-index.html#plugin-references-and-parameters">plugin documentation</a> for more details.</p>
<p>Saving of properties such as the rating, extended attributes, images, reviews, editorials and supplier is explicitly not supported by the Places API.</p>
</div>
<!-- @@@QPlace -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlace[overload1]$$$QPlace -->
<h3 class="fn"><a name="QPlace"></a>QPlace::<span class="name">QPlace</span>()</h3>
<p>Constructs an empty place object.</p>
<!-- @@@QPlace -->
<!-- $$$QPlace$$$QPlaceconstQPlace& -->
<h3 class="fn"><a name="QPlace-2"></a>QPlace::<span class="name">QPlace</span>(const <span class="type">QPlace</span> &<i> other</i>)</h3>
<p>Constructs a copy of <i>other</i>.</p>
<!-- @@@QPlace -->
<!-- $$$~QPlace[overload1]$$$~QPlace -->
<h3 class="fn"><a name="dtor.QPlace"></a>QPlace::<span class="name">~QPlace</span>()</h3>
<p>Destroys this place.</p>
<!-- @@@~QPlace -->
<!-- $$$appendContactDetail[overload1]$$$appendContactDetailconstQString&constQPlaceContactDetail& -->
<h3 class="fn"><a name="appendContactDetail"></a><span class="type">void</span> QPlace::<span class="name">appendContactDetail</span>(const <span class="type">QString</span> &<i> contactType</i>, const <span class="type"><a href="qplacecontactdetail.html">QPlaceContactDetail</a></span> &<i> detail</i>)</h3>
<p>Appends a contact <i>detail</i> of a specified <i>contactType</i>.</p>
<p>See <a href="qplacecontactdetail.html">QPlaceContactDetail</a> for a list of common <a href="qplacecontactdetail.html#Email-var">contact types</a>.</p>
<!-- @@@appendContactDetail -->
<!-- $$$attribution[overload1]$$$attribution -->
<h3 class="fn"><a name="attribution"></a><span class="type">QString</span> QPlace::<span class="name">attribution</span>() const</h3>
<p>Returns a rich text attribution string of the place. Note, some providers may have a requirement where the attribution must be shown whenever a place is displayed to an end user.</p>
<p><b>See also </b><a href="qplace.html#setAttribution">setAttribution</a>().</p>
<!-- @@@attribution -->
<!-- $$$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>> QPlace::<span class="name">categories</span>() const</h3>
<p>Returns categories that this place belongs to.</p>
<p><b>See also </b><a href="qplace.html#setCategories">setCategories</a>().</p>
<!-- @@@categories -->
<!-- $$$contactDetails[overload1]$$$contactDetailsconstQString& -->
<h3 class="fn"><a name="contactDetails"></a><span class="type">QList</span><<span class="type"><a href="qplacecontactdetail.html">QPlaceContactDetail</a></span>> QPlace::<span class="name">contactDetails</span>(const <span class="type">QString</span> &<i> contactType</i>) const</h3>
<p>Returns a list of contact details of the specified <i>contactType</i>.</p>
<p>See <a href="qplacecontactdetail.html">QPlaceContactDetail</a> for a list of common <a href="qplacecontactdetail.html#Email-var">contact types</a>.</p>
<p><b>See also </b><a href="qplace.html#setContactDetails">setContactDetails</a>().</p>
<!-- @@@contactDetails -->
<!-- $$$contactTypes[overload1]$$$contactTypes -->
<h3 class="fn"><a name="contactTypes"></a><span class="type">QStringList</span> QPlace::<span class="name">contactTypes</span>() const</h3>
<p>Returns the type of contact details this place has.</p>
<p>See <a href="qplacecontactdetail.html">QPlaceContactDetail</a> for a list of common <a href="qplacecontactdetail.html#Email-var">contact types</a>.</p>
<!-- @@@contactTypes -->
<!-- $$$content[overload1]$$$contentQPlaceContent::Type -->
<h3 class="fn"><a name="content"></a><span class="type"><a href="qplacecontent.html#Collection-typedef">QPlaceContent::Collection</a></span> QPlace::<span class="name">content</span>(<span class="type"><a href="qplacecontent.html#Type-enum">QPlaceContent::Type</a></span><i> type</i>) const</h3>
<p>Returns a collection of content associated with a place. This collection is a map with the key being the index of the content object and value being the content object itself.</p>
<p>The <i>type</i> specifies which kind of content is to be retrieved.</p>
<p><b>See also </b><a href="qplace.html#setContent">setContent</a>().</p>
<!-- @@@content -->
<!-- $$$detailsFetched[overload1]$$$detailsFetched -->
<h3 class="fn"><a name="detailsFetched"></a><span class="type">bool</span> QPlace::<span class="name">detailsFetched</span>() const</h3>
<p>Returns true if the details of this place have been fetched, otherwise returns false.</p>
<p><b>See also </b><a href="qplace.html#setDetailsFetched">setDetailsFetched</a>().</p>
<!-- @@@detailsFetched -->
<!-- $$$extendedAttribute[overload1]$$$extendedAttributeconstQString& -->
<h3 class="fn"><a name="extendedAttribute"></a><span class="type"><a href="qplaceattribute.html">QPlaceAttribute</a></span> QPlace::<span class="name">extendedAttribute</span>(const <span class="type">QString</span> &<i> attributeType</i>) const</h3>
<p>Returns the exteded attribute corresponding to the specified <i>attributeType</i>. If the place does not have that particular attribute type, a default constructed QPlaceExtendedAttribute is returned.</p>
<p><b>See also </b><a href="qplace.html#setExtendedAttribute">setExtendedAttribute</a>().</p>
<!-- @@@extendedAttribute -->
<!-- $$$extendedAttributeTypes[overload1]$$$extendedAttributeTypes -->
<h3 class="fn"><a name="extendedAttributeTypes"></a><span class="type">QStringList</span> QPlace::<span class="name">extendedAttributeTypes</span>() const</h3>
<p>Returns the types of extended attributes that this place has.</p>
<!-- @@@extendedAttributeTypes -->
<!-- $$$icon[overload1]$$$icon -->
<h3 class="fn"><a name="icon"></a><span class="type"><a href="qplaceicon.html">QPlaceIcon</a></span> QPlace::<span class="name">icon</span>() const</h3>
<p>Returns the icon of the place.</p>
<p><b>See also </b><a href="qplace.html#setIcon">setIcon</a>().</p>
<!-- @@@icon -->
<!-- $$$insertContent[overload1]$$$insertContentQPlaceContent::TypeconstQPlaceContent::Collection& -->
<h3 class="fn"><a name="insertContent"></a><span class="type">void</span> QPlace::<span class="name">insertContent</span>(<span class="type"><a href="qplacecontent.html#Type-enum">QPlaceContent::Type</a></span><i> type</i>, const <span class="type"><a href="qplacecontent.html#Collection-typedef">QPlaceContent::Collection</a></span> &<i> content</i>)</h3>
<p>Adds a collection of <i>content</i> of the given <i>type</i> to the place. Any index in <i>content</i> that already exists is overwritten.</p>
<!-- @@@insertContent -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn"><a name="isEmpty"></a><span class="type">bool</span> QPlace::<span class="name">isEmpty</span>() const</h3>
<p>Returns a boolean indicating whether the all the fields of the place are empty or not.</p>
<!-- @@@isEmpty -->
<!-- $$$location[overload1]$$$location -->
<h3 class="fn"><a name="location"></a><span class="type">QGeoLocation</span> QPlace::<span class="name">location</span>() const</h3>
<p>Returns the location of the place.</p>
<p><b>See also </b><a href="qplace.html#setLocation">setLocation</a>().</p>
<!-- @@@location -->
<!-- $$$name[overload1]$$$name -->
<h3 class="fn"><a name="name"></a><span class="type">QString</span> QPlace::<span class="name">name</span>() const</h3>
<p>Returns the name of the place.</p>
<p><b>See also </b><a href="qplace.html#setName">setName</a>().</p>
<!-- @@@name -->
<!-- $$$placeId[overload1]$$$placeId -->
<h3 class="fn"><a name="placeId"></a><span class="type">QString</span> QPlace::<span class="name">placeId</span>() const</h3>
<p>Returns the identifier of the place. The place identifier is only meaningful to the <a href="qplacemanager.html">QPlaceManager</a> that generated it and is not transferable between managers. The place identifier is not guaranteed to be universally unique, but unique for the manager that generated it.</p>
<p><b>See also </b><a href="qplace.html#setPlaceId">setPlaceId</a>().</p>
<!-- @@@placeId -->
<!-- $$$primaryEmail[overload1]$$$primaryEmail -->
<h3 class="fn"><a name="primaryEmail"></a><span class="type">QString</span> QPlace::<span class="name">primaryEmail</span>() const</h3>
<p>Returns the primary email address for this place. This convenience function accesses the first contact detail of the <a href="qplacecontactdetail.html#Email-var">email type</a>. If no email addresses exist, then an empty string is returned.</p>
<!-- @@@primaryEmail -->
<!-- $$$primaryFax[overload1]$$$primaryFax -->
<h3 class="fn"><a name="primaryFax"></a><span class="type">QString</span> QPlace::<span class="name">primaryFax</span>() const</h3>
<p>Returns the primary fax number for this place. This convenience function accesses the first contact detail of the <a href="qplacecontactdetail.html#Fax-var">fax type</a>. If no fax details exist, then an empty string is returned.</p>
<!-- @@@primaryFax -->
<!-- $$$primaryPhone[overload1]$$$primaryPhone -->
<h3 class="fn"><a name="primaryPhone"></a><span class="type">QString</span> QPlace::<span class="name">primaryPhone</span>() const</h3>
<p>Returns the primary phone number for this place. This accesses the first contact detail of the <a href="qplacecontactdetail.html#Phone-var">phone number type</a>. If no phone details exist, then an empty string is returned.</p>
<!-- @@@primaryPhone -->
<!-- $$$primaryWebsite[overload1]$$$primaryWebsite -->
<h3 class="fn"><a name="primaryWebsite"></a><span class="type">QUrl</span> QPlace::<span class="name">primaryWebsite</span>() const</h3>
<p>Returns the primary website of the place. This convenience function accesses the first contact detail of the <a href="qplacecontactdetail.html#Website-var">website type</a>. If no websites exist, then an empty string is returned.</p>
<!-- @@@primaryWebsite -->
<!-- $$$ratings[overload1]$$$ratings -->
<h3 class="fn"><a name="ratings"></a><span class="type"><a href="qplaceratings.html">QPlaceRatings</a></span> QPlace::<span class="name">ratings</span>() const</h3>
<p>Returns an aggregated rating of the place.</p>
<p><b>See also </b><a href="qplace.html#setRatings">setRatings</a>().</p>
<!-- @@@ratings -->
<!-- $$$removeContactDetails[overload1]$$$removeContactDetailsconstQString& -->
<h3 class="fn"><a name="removeContactDetails"></a><span class="type">void</span> QPlace::<span class="name">removeContactDetails</span>(const <span class="type">QString</span> &<i> contactType</i>)</h3>
<p>Removes all the contact details of a given <i>contactType</i>.</p>
<p>The <i>contactType</i> is no longer returned when <a href="qplace.html#contactTypes">QPlace::contactTypes</a>() is called.</p>
<!-- @@@removeContactDetails -->
<!-- $$$removeExtendedAttribute[overload1]$$$removeExtendedAttributeconstQString& -->
<h3 class="fn"><a name="removeExtendedAttribute"></a><span class="type">void</span> QPlace::<span class="name">removeExtendedAttribute</span>(const <span class="type">QString</span> &<i> attributeType</i>)</h3>
<p>Remove the attribute of <i>attributeType</i> from the place.</p>
<p>The attribute will no longer be listed by <a href="qplace.html#extendedAttributeTypes">QPlace::extendedAttributeTypes</a>()</p>
<!-- @@@removeExtendedAttribute -->
<!-- $$$setAttribution[overload1]$$$setAttributionconstQString& -->
<h3 class="fn"><a name="setAttribution"></a><span class="type">void</span> QPlace::<span class="name">setAttribution</span>(const <span class="type">QString</span> &<i> attribution</i>)</h3>
<p>Sets the <i>attribution</i> string of the place.</p>
<p><b>See also </b><a href="qplace.html#attribution">attribution</a>().</p>
<!-- @@@setAttribution -->
<!-- $$$setCategories[overload1]$$$setCategoriesconstQList<QPlaceCategory>& -->
<h3 class="fn"><a name="setCategories"></a><span class="type">void</span> QPlace::<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 <i>categories</i> that this place belongs to.</p>
<p><b>See also </b><a href="qplace.html#categories">categories</a>().</p>
<!-- @@@setCategories -->
<!-- $$$setCategory[overload1]$$$setCategoryconstQPlaceCategory& -->
<h3 class="fn"><a name="setCategory"></a><span class="type">void</span> QPlace::<span class="name">setCategory</span>(const <span class="type"><a href="qplacecategory.html">QPlaceCategory</a></span> &<i> category</i>)</h3>
<p>Sets a single <i>category</i> that this place belongs to.</p>
<!-- @@@setCategory -->
<!-- $$$setContactDetails[overload1]$$$setContactDetailsconstQString&QList<QPlaceContactDetail> -->
<h3 class="fn"><a name="setContactDetails"></a><span class="type">void</span> QPlace::<span class="name">setContactDetails</span>(const <span class="type">QString</span> &<i> contactType</i>, <span class="type">QList</span><<span class="type"><a href="qplacecontactdetail.html">QPlaceContactDetail</a></span>><i> details</i>)</h3>
<p>Sets the contact <i>details</i> of a specified <i>contactType</i>.</p>
<p>If <i>details</i> is empty, then the <i>contactType</i> is removed from the place such that it is no longer returned by <a href="qplace.html#contactTypes">QPlace::contactTypes</a>().</p>
<p>See <a href="qplacecontactdetail.html">QPlaceContactDetail</a> for a list of common <a href="qplacecontactdetail.html#Email-var">contact types</a>.</p>
<p><b>See also </b><a href="qplace.html#contactDetails">contactDetails</a>().</p>
<!-- @@@setContactDetails -->
<!-- $$$setContent[overload1]$$$setContentQPlaceContent::TypeconstQPlaceContent::Collection& -->
<h3 class="fn"><a name="setContent"></a><span class="type">void</span> QPlace::<span class="name">setContent</span>(<span class="type"><a href="qplacecontent.html#Type-enum">QPlaceContent::Type</a></span><i> type</i>, const <span class="type"><a href="qplacecontent.html#Collection-typedef">QPlaceContent::Collection</a></span> &<i> content</i>)</h3>
<p>Sets a collection of <i>content</i> for the given <i>type</i>.</p>
<p><b>See also </b><a href="qplace.html#content">content</a>().</p>
<!-- @@@setContent -->
<!-- $$$setDetailsFetched[overload1]$$$setDetailsFetchedbool -->
<h3 class="fn"><a name="setDetailsFetched"></a><span class="type">void</span> QPlace::<span class="name">setDetailsFetched</span>(<span class="type">bool</span><i> fetched</i>)</h3>
<p>Sets whether the details of this place have been <i>fetched</i> or not.</p>
<p><b>See also </b><a href="qplace.html#detailsFetched">detailsFetched</a>().</p>
<!-- @@@setDetailsFetched -->
<!-- $$$setExtendedAttribute[overload1]$$$setExtendedAttributeconstQString&constQPlaceAttribute& -->
<h3 class="fn"><a name="setExtendedAttribute"></a><span class="type">void</span> QPlace::<span class="name">setExtendedAttribute</span>(const <span class="type">QString</span> &<i> attributeType</i>, const <span class="type"><a href="qplaceattribute.html">QPlaceAttribute</a></span> &<i> attribute</i>)</h3>
<p>Assigns an <i>attribute</i> of the given <i>attributeType</i> to a place. If the given <i>attributeType</i> already exists in the place, then it is overwritten.</p>
<p>If <i>attribute</i> is a default constructed <a href="qplaceattribute.html">QPlaceAttribute</a>, then the <i>attributeType</i> is removed from the place which means it will not be listed by <a href="qplace.html#extendedAttributeTypes">QPlace::extendedAttributeTypes</a>().</p>
<p><b>See also </b><a href="qplace.html#extendedAttribute">extendedAttribute</a>().</p>
<!-- @@@setExtendedAttribute -->
<!-- $$$setIcon[overload1]$$$setIconconstQPlaceIcon& -->
<h3 class="fn"><a name="setIcon"></a><span class="type">void</span> QPlace::<span class="name">setIcon</span>(const <span class="type"><a href="qplaceicon.html">QPlaceIcon</a></span> &<i> icon</i>)</h3>
<p>Sets the <i>icon</i> of the place.</p>
<p><b>See also </b><a href="qplace.html#icon">icon</a>().</p>
<!-- @@@setIcon -->
<!-- $$$setLocation[overload1]$$$setLocationconstQGeoLocation& -->
<h3 class="fn"><a name="setLocation"></a><span class="type">void</span> QPlace::<span class="name">setLocation</span>(const <span class="type">QGeoLocation</span> &<i> location</i>)</h3>
<p>Sets the <i>location</i> of the place.</p>
<p><b>See also </b><a href="qplace.html#location">location</a>().</p>
<!-- @@@setLocation -->
<!-- $$$setName[overload1]$$$setNameconstQString& -->
<h3 class="fn"><a name="setName"></a><span class="type">void</span> QPlace::<span class="name">setName</span>(const <span class="type">QString</span> &<i> name</i>)</h3>
<p>Sets the <i>name</i> of the place.</p>
<p><b>See also </b><a href="qplace.html#name">name</a>().</p>
<!-- @@@setName -->
<!-- $$$setPlaceId[overload1]$$$setPlaceIdconstQString& -->
<h3 class="fn"><a name="setPlaceId"></a><span class="type">void</span> QPlace::<span class="name">setPlaceId</span>(const <span class="type">QString</span> &<i> identifier</i>)</h3>
<p>Sets the <i>identifier</i> of the place.</p>
<p><b>See also </b><a href="qplace.html#placeId">placeId</a>().</p>
<!-- @@@setPlaceId -->
<!-- $$$setRatings[overload1]$$$setRatingsconstQPlaceRatings& -->
<h3 class="fn"><a name="setRatings"></a><span class="type">void</span> QPlace::<span class="name">setRatings</span>(const <span class="type"><a href="qplaceratings.html">QPlaceRatings</a></span> &<i> rating</i>)</h3>
<p>Sets the aggregated <i>rating</i> of the place.</p>
<p><b>See also </b><a href="qplace.html#ratings">ratings</a>().</p>
<!-- @@@setRatings -->
<!-- $$$setSupplier[overload1]$$$setSupplierconstQPlaceSupplier& -->
<h3 class="fn"><a name="setSupplier"></a><span class="type">void</span> QPlace::<span class="name">setSupplier</span>(const <span class="type"><a href="qplacesupplier.html">QPlaceSupplier</a></span> &<i> supplier</i>)</h3>
<p>Sets the supplier of this place to <i>supplier</i>.</p>
<p><b>See also </b><a href="qplace.html#supplier">supplier</a>().</p>
<!-- @@@setSupplier -->
<!-- $$$setTotalContentCount[overload1]$$$setTotalContentCountQPlaceContent::Typeint -->
<h3 class="fn"><a name="setTotalContentCount"></a><span class="type">void</span> QPlace::<span class="name">setTotalContentCount</span>(<span class="type"><a href="qplacecontent.html#Type-enum">QPlaceContent::Type</a></span><i> type</i>, <span class="type">int</span><i> totalCount</i>)</h3>
<p>Sets the <i>totalCount</i> of content objects of the given <i>type</i>.</p>
<p><b>See also </b><a href="qplace.html#totalContentCount">totalContentCount</a>().</p>
<!-- @@@setTotalContentCount -->
<!-- $$$setVisibility[overload1]$$$setVisibilityQLocation::Visibility -->
<h3 class="fn"><a name="setVisibility"></a><span class="type">void</span> QPlace::<span class="name">setVisibility</span>(<span class="type"><a href="qlocation.html#Visibility-enum">QLocation::Visibility</a></span><i> visibility</i>)</h3>
<p>Sets the visibility of the place to <i>visibility</i>.</p>
<p><b>See also </b><a href="qplace.html#visibility">visibility</a>().</p>
<!-- @@@setVisibility -->
<!-- $$$supplier[overload1]$$$supplier -->
<h3 class="fn"><a name="supplier"></a><span class="type"><a href="qplacesupplier.html">QPlaceSupplier</a></span> QPlace::<span class="name">supplier</span>() const</h3>
<p>Returns the supplier of this place.</p>
<p><b>See also </b><a href="qplace.html#setSupplier">setSupplier</a>().</p>
<!-- @@@supplier -->
<!-- $$$totalContentCount[overload1]$$$totalContentCountQPlaceContent::Type -->
<h3 class="fn"><a name="totalContentCount"></a><span class="type">int</span> QPlace::<span class="name">totalContentCount</span>(<span class="type"><a href="qplacecontent.html#Type-enum">QPlaceContent::Type</a></span><i> type</i>) const</h3>
<p>Returns the total count of content objects of the given <i>type</i>. This total count indicates how many the manager/provider should have available. (As opposed to how many objects this place instance is currently assigned).</p>
<p>A negative count indicates that the total number of items is unknown. By default the total content count is set to 0.</p>
<p><b>See also </b><a href="qplace.html#setTotalContentCount">setTotalContentCount</a>().</p>
<!-- @@@totalContentCount -->
<!-- $$$visibility[overload1]$$$visibility -->
<h3 class="fn"><a name="visibility"></a><span class="type"><a href="qlocation.html#Visibility-enum">QLocation::Visibility</a></span> QPlace::<span class="name">visibility</span>() const</h3>
<p>Returns the visibility of the place.</p>
<p>The default visibility of a new place is set to QtLocatin::Unspecified visibility. If a place is saved with unspecified visibility the backend chooses an appropriate default visibility to use when saving.</p>
<p><b>See also </b><a href="qplace.html#setVisibility">setVisibility</a>().</p>
<!-- @@@visibility -->
<!-- $$$operator!=[overload1]$$$operator!=constQPlace& -->
<h3 class="fn"><a name="operator-not-eq"></a><span class="type">bool</span> QPlace::<span class="name">operator!=</span>(const <span class="type">QPlace</span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is not equal to this place, otherwise returns false.</p>
<!-- @@@operator!= -->
<!-- $$$operator=[overload1]$$$operator=constQPlace& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QPlace</span> & QPlace::<span class="name">operator=</span>(const <span class="type">QPlace</span> &<i> other</i>)</h3>
<p>Assigns <i>other</i> to this place and returns a reference to this place.</p>
<!-- @@@operator= -->
<!-- $$$operator==[overload1]$$$operator==constQPlace& -->
<h3 class="fn"><a name="operator-eq-eq"></a><span class="type">bool</span> QPlace::<span class="name">operator==</span>(const <span class="type">QPlace</span> &<i> other</i>) const</h3>
<p>Returns true if <i>other</i> is equal to this place, 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>
|