/usr/share/qt5/doc/qtlocation/qplacemanagerengine.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 | <?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" />
<!-- qplacemanagerengine.cpp -->
<title>QPlaceManagerEngine 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>QPlaceManagerEngine</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="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QPlaceManagerEngine Class</h1>
<!-- $$$QPlaceManagerEngine-brief -->
<p>The QPlaceManagerEngine class provides an interface for implementers of <a href="qgeoserviceprovider.html">QGeoServiceProvider</a> plugins who want to provide access to place functionality. <a href="#details">More...</a></p>
<!-- @@@QPlaceManagerEngine -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QPlaceManagerEngine></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="qplacemanagerengine-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="qplacemanagerengine.html#QPlaceManagerEngine">QPlaceManagerEngine</a></b>(const QMap<QString, QVariant> &<i> parameters</i>, QObject *<i> parent</i> = 0)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#dtor.QPlaceManagerEngine">~QPlaceManagerEngine</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlaceCategory </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#category">category</a></b>(const QString &<i> categoryId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList<QPlaceCategory> </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#childCategories">childCategories</a></b>(const QString &<i> parentId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QStringList </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#childCategoryIds">childCategoryIds</a></b>(const QString &<i> categoryId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlace </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#compatiblePlace">compatiblePlace</a></b>(const QPlace &<i> original</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QUrl </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#constructIconUrl">constructIconUrl</a></b>(const QPlaceIcon &<i> icon</i>, const QSize &<i> size</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlaceContentReply * </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#getPlaceContent">getPlaceContent</a></b>(const QString &<i> placeId</i>, const QPlaceContentRequest &<i> request</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlaceDetailsReply * </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#getPlaceDetails">getPlaceDetails</a></b>(const QString &<i> placeId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlaceReply * </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#initializeCategories">initializeCategories</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList<QLocale> </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#locales">locales</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#managerName">managerName</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#managerVersion">managerVersion</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlaceMatchReply * </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#matchingPlaces">matchingPlaces</a></b>(const QPlaceMatchRequest &<i> request</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#parentCategoryId">parentCategoryId</a></b>(const QString &<i> categoryId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlaceIdReply * </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#removeCategory">removeCategory</a></b>(const QString &<i> categoryId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlaceIdReply * </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#removePlace">removePlace</a></b>(const QString &<i> placeId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlaceIdReply * </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#saveCategory">saveCategory</a></b>(const QPlaceCategory &<i> category</i>, const QString &<i> parentId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlaceIdReply * </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#savePlace">savePlace</a></b>(const QPlace &<i> place</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlaceSearchReply * </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#search">search</a></b>(const QPlaceSearchRequest &<i> request</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QPlaceSearchSuggestionReply * </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#searchSuggestions">searchSuggestions</a></b>(const QPlaceSearchRequest &<i> request</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#setLocales">setLocales</a></b>(const QList<QLocale> &<i> locales</i>)</td></tr>
</table>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#categoryAdded">categoryAdded</a></b>(const QPlaceCategory &<i> category</i>, const QString &<i> parentId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#categoryRemoved">categoryRemoved</a></b>(const QString &<i> categoryId</i>, const QString &<i> parentId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#categoryUpdated">categoryUpdated</a></b>(const QPlaceCategory &<i> category</i>, const QString &<i> parentId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#dataChanged">dataChanged</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#error">error</a></b>(QPlaceReply *<i> reply</i>, QPlaceReply::Error<i> error</i>, const QString &<i> errorString</i> = QString())</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#finished">finished</a></b>(QPlaceReply *<i> reply</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#placeAdded">placeAdded</a></b>(const QString &<i> placeId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#placeRemoved">placeRemoved</a></b>(const QString &<i> placeId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#placeUpdated">placeUpdated</a></b>(const QString &<i> placeId</i>)</td></tr>
</table>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QPlaceManager * </td><td class="memItemRight bottomAlign"><b><a href="qplacemanagerengine.html#manager">manager</a></b>() const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QPlaceManagerEngine-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QPlaceManagerEngine class provides an interface for implementers of <a href="qgeoserviceprovider.html">QGeoServiceProvider</a> plugins who want to provide access to place functionality.</p>
<p>Application developers need not concern themselves with the QPlaceManagerEngine. Backend implementers however will need to derive from QPlaceManagerEngine and provide implementations for the abstract virtual functions.</p>
<p>For more information on writing a backend see the <a href="location-places-backend.html">Places Backend</a> documentation.</p>
</div>
<p><b>See also </b><a href="qplacemanager.html">QPlaceManager</a>.</p>
<!-- @@@QPlaceManagerEngine -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QPlaceManagerEngine[overload1]$$$QPlaceManagerEngineconstQMap<QString,QVariant>&QObject* -->
<h3 class="fn"><a name="QPlaceManagerEngine"></a>QPlaceManagerEngine::<span class="name">QPlaceManagerEngine</span>(const <span class="type">QMap</span><<span class="type">QString</span>, <span class="type">QVariant</span>> &<i> parameters</i>, <span class="type">QObject</span> *<i> parent</i> = 0)</h3>
<p>Constructs a new engine with the specified <i>parent</i>, using <i>parameters</i> to pass any implementation specific data to the engine.</p>
<!-- @@@QPlaceManagerEngine -->
<!-- $$$~QPlaceManagerEngine[overload1]$$$~QPlaceManagerEngine -->
<h3 class="fn"><a name="dtor.QPlaceManagerEngine"></a>QPlaceManagerEngine::<span class="name">~QPlaceManagerEngine</span>()<tt> [virtual]</tt></h3>
<p>Destroys this engine.</p>
<!-- @@@~QPlaceManagerEngine -->
<!-- $$$category[overload1]$$$categoryconstQString& -->
<h3 class="fn"><a name="category"></a><span class="type"><a href="qplacecategory.html">QPlaceCategory</a></span> QPlaceManagerEngine::<span class="name">category</span>(const <span class="type">QString</span> &<i> categoryId</i>) const<tt> [virtual]</tt></h3>
<p>Returns the category corresponding to the given <i>categoryId</i>.</p>
<!-- @@@category -->
<!-- $$$categoryAdded[overload1]$$$categoryAddedconstQPlaceCategory&constQString& -->
<h3 class="fn"><a name="categoryAdded"></a><span class="type">void</span> QPlaceManagerEngine::<span class="name">categoryAdded</span>(const <span class="type"><a href="qplacecategory.html">QPlaceCategory</a></span> &<i> category</i>, const <span class="type">QString</span> &<i> parentId</i>)<tt> [signal]</tt></h3>
<p>This signal is emitted if a <i>category</i> has been added to the manager engine's datastore. The parent of the <i>category</i> is specified by <i>parentId</i>.</p>
<p>This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.</p>
<p><b>See also </b><a href="qplacemanagerengine.html#dataChanged">dataChanged</a>().</p>
<!-- @@@categoryAdded -->
<!-- $$$categoryRemoved[overload1]$$$categoryRemovedconstQString&constQString& -->
<h3 class="fn"><a name="categoryRemoved"></a><span class="type">void</span> QPlaceManagerEngine::<span class="name">categoryRemoved</span>(const <span class="type">QString</span> &<i> categoryId</i>, const <span class="type">QString</span> &<i> parentId</i>)<tt> [signal]</tt></h3>
<p>This signal is emitted when the category corresponding to <i>categoryId</i> has been removed from the manager engine's datastore. The parent of the removed category is specified by <i>parentId</i>.</p>
<p>This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.</p>
<p><b>See also </b><a href="qplacemanagerengine.html#dataChanged">dataChanged</a>().</p>
<!-- @@@categoryRemoved -->
<!-- $$$categoryUpdated[overload1]$$$categoryUpdatedconstQPlaceCategory&constQString& -->
<h3 class="fn"><a name="categoryUpdated"></a><span class="type">void</span> QPlaceManagerEngine::<span class="name">categoryUpdated</span>(const <span class="type"><a href="qplacecategory.html">QPlaceCategory</a></span> &<i> category</i>, const <span class="type">QString</span> &<i> parentId</i>)<tt> [signal]</tt></h3>
<p>This signal is emitted if a <i>category</i> has been modified in the manager engine's datastore. The parent of the modified category is specified by <i>parentId</i>.</p>
<p>This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.</p>
<p><b>See also </b><a href="qplacemanagerengine.html#dataChanged">dataChanged</a>().</p>
<!-- @@@categoryUpdated -->
<!-- $$$childCategories[overload1]$$$childCategoriesconstQString& -->
<h3 class="fn"><a name="childCategories"></a><span class="type">QList</span><<span class="type"><a href="qplacecategory.html">QPlaceCategory</a></span>> QPlaceManagerEngine::<span class="name">childCategories</span>(const <span class="type">QString</span> &<i> parentId</i>) const<tt> [virtual]</tt></h3>
<p>Returns a list of categories that are children of the category corresponding to <i>parentId</i>. If <i>parentId</i> is empty, all the top level categories are returned.</p>
<!-- @@@childCategories -->
<!-- $$$childCategoryIds[overload1]$$$childCategoryIdsconstQString& -->
<h3 class="fn"><a name="childCategoryIds"></a><span class="type">QStringList</span> QPlaceManagerEngine::<span class="name">childCategoryIds</span>(const <span class="type">QString</span> &<i> categoryId</i>) const<tt> [virtual]</tt></h3>
<p>Returns the child category identifiers of the category corresponding to <i>categoryId</i>. If <i>categoryId</i> is empty then all top level category identifiers are returned.</p>
<!-- @@@childCategoryIds -->
<!-- $$$compatiblePlace[overload1]$$$compatiblePlaceconstQPlace& -->
<h3 class="fn"><a name="compatiblePlace"></a><span class="type"><a href="qplace.html">QPlace</a></span> QPlaceManagerEngine::<span class="name">compatiblePlace</span>(const <span class="type"><a href="qplace.html">QPlace</a></span> &<i> original</i>) const<tt> [virtual]</tt></h3>
<p>Returns a pruned or modified version of the <i>original</i> place which is suitable to be saved by the manager engine.</p>
<p>Only place details that are supported by this manager is present in the modified version. Manager specific data such as the place id, is not copied over from the <i>original</i>.</p>
<!-- @@@compatiblePlace -->
<!-- $$$constructIconUrl[overload1]$$$constructIconUrlconstQPlaceIcon&constQSize& -->
<h3 class="fn"><a name="constructIconUrl"></a><span class="type">QUrl</span> QPlaceManagerEngine::<span class="name">constructIconUrl</span>(const <span class="type"><a href="qplaceicon.html">QPlaceIcon</a></span> &<i> icon</i>, const <span class="type">QSize</span> &<i> size</i>) const<tt> [virtual]</tt></h3>
<p>QUrl QPlaceManagerEngine::constructIconUrl(const <a href="qplaceicon.html">QPlaceIcon</a> &icon, const QSize &size)</p>
<p>Constructs an icon url from a given <i>icon</i>, <i>size</i>. The URL of the icon image that most closely matches the given parameters is returned.</p>
<!-- @@@constructIconUrl -->
<!-- $$$dataChanged[overload1]$$$dataChanged -->
<h3 class="fn"><a name="dataChanged"></a><span class="type">void</span> QPlaceManagerEngine::<span class="name">dataChanged</span>()<tt> [signal]</tt></h3>
<p>*</p>
<p>This signal is emitted by the engine if there are large scale changes to its underlying datastore and the engine considers these changes radical enough to require clients to reload all data.</p>
<p>If the signal is emitted, no other signals will be emitted for the associated changes.</p>
<!-- @@@dataChanged -->
<!-- $$$error[overload1]$$$errorQPlaceReply*QPlaceReply::ErrorconstQString& -->
<h3 class="fn"><a name="error"></a><span class="type">void</span> QPlaceManagerEngine::<span class="name">error</span>(<span class="type"><a href="qplacereply.html">QPlaceReply</a></span> *<i> reply</i>, <span class="type"><a href="qplacereply.html#Error-enum">QPlaceReply::Error</a></span><i> error</i>, const <span class="type">QString</span> &<i> errorString</i> = QString())<tt> [signal]</tt></h3>
<p>This signal is emitted when an error has been detected in the processing of <i>reply</i>. The <a href="qplacemanager.html#finished">QPlaceManager::finished</a>() signal will probably follow.</p>
<p>The error will be described by the error code <i>error</i>. If <i>errorString</i> is not empty it will contain a textual description of the error meant for developers and not end users.</p>
<p>This signal and <a href="qplacereply.html#error">QPlaceReply::error</a>() will be emitted at the same time.</p>
<p><b>Note: </b>Do not delete the <i>reply</i> object in the slot connected to this signal. Use deleteLater() instead.</p><!-- @@@error -->
<!-- $$$finished[overload1]$$$finishedQPlaceReply* -->
<h3 class="fn"><a name="finished"></a><span class="type">void</span> QPlaceManagerEngine::<span class="name">finished</span>(<span class="type"><a href="qplacereply.html">QPlaceReply</a></span> *<i> reply</i>)<tt> [signal]</tt></h3>
<p>This signal is emitted when <i>reply</i> has finished processing.</p>
<p>If reply-><a href="qplacemanagerengine.html#error">error</a>() equals <a href="qplacereply.html#Error-enum">QPlaceReply::NoError</a> then the processing finished successfully.</p>
<p>This signal and <a href="qplacereply.html#finished">QPlaceReply::finished</a>() will be emitted at the same time.</p>
<p><b>Note: </b>Do not delete the <i>reply</i> object in the slot connected to this signal. Use deleteLater() instead.</p><!-- @@@finished -->
<!-- $$$getPlaceContent[overload1]$$$getPlaceContentconstQString&constQPlaceContentRequest& -->
<h3 class="fn"><a name="getPlaceContent"></a><span class="type"><a href="qplacecontentreply.html">QPlaceContentReply</a></span> * QPlaceManagerEngine::<span class="name">getPlaceContent</span>(const <span class="type">QString</span> &<i> placeId</i>, const <span class="type"><a href="qplacecontentrequest.html">QPlaceContentRequest</a></span> &<i> request</i>)<tt> [virtual]</tt></h3>
<p>Retrieves content for the place corresponding to <i>placeId</i>, according to the parameters specified in <i>request</i>.</p>
<!-- @@@getPlaceContent -->
<!-- $$$getPlaceDetails[overload1]$$$getPlaceDetailsconstQString& -->
<h3 class="fn"><a name="getPlaceDetails"></a><span class="type"><a href="qplacedetailsreply.html">QPlaceDetailsReply</a></span> * QPlaceManagerEngine::<span class="name">getPlaceDetails</span>(const <span class="type">QString</span> &<i> placeId</i>)<tt> [virtual]</tt></h3>
<p>Retrieves details of place corresponding to the given <i>placeId</i>.</p>
<!-- @@@getPlaceDetails -->
<!-- $$$initializeCategories[overload1]$$$initializeCategories -->
<h3 class="fn"><a name="initializeCategories"></a><span class="type"><a href="qplacereply.html">QPlaceReply</a></span> * QPlaceManagerEngine::<span class="name">initializeCategories</span>()<tt> [virtual]</tt></h3>
<p>Initializes the categories of the manager engine.</p>
<!-- @@@initializeCategories -->
<!-- $$$locales[overload1]$$$locales -->
<h3 class="fn"><a name="locales"></a><span class="type">QList</span><<span class="type">QLocale</span>> QPlaceManagerEngine::<span class="name">locales</span>() const<tt> [virtual]</tt></h3>
<p>Returns a list of preferred locales. The locales are used as a hint to the manager engine for what language place and category details should be returned in.</p>
<p>If the first specified locale cannot be accommodated, the manager engine falls back to the next and so forth.</p>
<p>Support for locales may vary from provider to provider. For those that do support it, by default, the global default locale will be used. If the manager engine has no locales assigned to it, it implicitly uses the global default locale. For engines that do not support locales, the locale list is always empty.</p>
<p><b>See also </b><a href="qplacemanagerengine.html#setLocales">setLocales</a>().</p>
<!-- @@@locales -->
<!-- $$$manager[overload1]$$$manager -->
<h3 class="fn"><a name="manager"></a><span class="type"><a href="qplacemanager.html">QPlaceManager</a></span> * QPlaceManagerEngine::<span class="name">manager</span>() const<tt> [protected]</tt></h3>
<p>Returns the manager instance used to create this engine.</p>
<!-- @@@manager -->
<!-- $$$managerName[overload1]$$$managerName -->
<h3 class="fn"><a name="managerName"></a><span class="type">QString</span> QPlaceManagerEngine::<span class="name">managerName</span>() const</h3>
<p>Returns the name which this engine implementation uses to distinguish itself from the implementations provided by other plugins.</p>
<p>The manager name is automatically set to be the same as the QGeoServiceProviderFactory::providerName().</p>
<!-- @@@managerName -->
<!-- $$$managerVersion[overload1]$$$managerVersion -->
<h3 class="fn"><a name="managerVersion"></a><span class="type">int</span> QPlaceManagerEngine::<span class="name">managerVersion</span>() const</h3>
<p>Returns the version of this engine implementation.</p>
<p>The manager version is automatically set to be the same as the QGeoServiceProviderFactory::providerVersion().</p>
<!-- @@@managerVersion -->
<!-- $$$matchingPlaces[overload1]$$$matchingPlacesconstQPlaceMatchRequest& -->
<h3 class="fn"><a name="matchingPlaces"></a><span class="type"><a href="qplacematchreply.html">QPlaceMatchReply</a></span> * QPlaceManagerEngine::<span class="name">matchingPlaces</span>(const <span class="type"><a href="qplacematchrequest.html">QPlaceMatchRequest</a></span> &<i> request</i>)<tt> [virtual]</tt></h3>
<p>Returns a reply which contains a list of places which correspond/match those specified in <i>request</i>.</p>
<!-- @@@matchingPlaces -->
<!-- $$$parentCategoryId[overload1]$$$parentCategoryIdconstQString& -->
<h3 class="fn"><a name="parentCategoryId"></a><span class="type">QString</span> QPlaceManagerEngine::<span class="name">parentCategoryId</span>(const <span class="type">QString</span> &<i> categoryId</i>) const<tt> [virtual]</tt></h3>
<p>Returns the parent category identifier of the category corresponding to <i>categoryId</i>.</p>
<!-- @@@parentCategoryId -->
<!-- $$$placeAdded[overload1]$$$placeAddedconstQString& -->
<h3 class="fn"><a name="placeAdded"></a><span class="type">void</span> QPlaceManagerEngine::<span class="name">placeAdded</span>(const <span class="type">QString</span> &<i> placeId</i>)<tt> [signal]</tt></h3>
<p>This signal is emitted if a place has been added to the manager engine's datastore. The particular added place is specified by <i>placeId</i>.</p>
<p>This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.</p>
<p><b>See also </b><a href="qplacemanagerengine.html#dataChanged">dataChanged</a>().</p>
<!-- @@@placeAdded -->
<!-- $$$placeRemoved[overload1]$$$placeRemovedconstQString& -->
<h3 class="fn"><a name="placeRemoved"></a><span class="type">void</span> QPlaceManagerEngine::<span class="name">placeRemoved</span>(const <span class="type">QString</span> &<i> placeId</i>)<tt> [signal]</tt></h3>
<p>This signal is emitted if a place has been removed from the manager engine's datastore. The particular place that has been removed is specified by <i>placeId</i>.</p>
<p>This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.</p>
<p><b>See also </b><a href="qplacemanagerengine.html#dataChanged">dataChanged</a>().</p>
<!-- @@@placeRemoved -->
<!-- $$$placeUpdated[overload1]$$$placeUpdatedconstQString& -->
<h3 class="fn"><a name="placeUpdated"></a><span class="type">void</span> QPlaceManagerEngine::<span class="name">placeUpdated</span>(const <span class="type">QString</span> &<i> placeId</i>)<tt> [signal]</tt></h3>
<p>This signal is emitted if a place has been modified in the manager engine's datastore. The particular modified place is specified by <i>placeId</i>.</p>
<p>This signal is only emitted by manager engines that support the QPlaceManager::NotificationsFeature.</p>
<p><b>See also </b><a href="qplacemanagerengine.html#dataChanged">dataChanged</a>().</p>
<!-- @@@placeUpdated -->
<!-- $$$removeCategory[overload1]$$$removeCategoryconstQString& -->
<h3 class="fn"><a name="removeCategory"></a><span class="type"><a href="qplaceidreply.html">QPlaceIdReply</a></span> * QPlaceManagerEngine::<span class="name">removeCategory</span>(const <span class="type">QString</span> &<i> categoryId</i>)<tt> [virtual]</tt></h3>
<p>Removes the category corresponding to <i>categoryId</i> from the manager engine's datastore.</p>
<!-- @@@removeCategory -->
<!-- $$$removePlace[overload1]$$$removePlaceconstQString& -->
<h3 class="fn"><a name="removePlace"></a><span class="type"><a href="qplaceidreply.html">QPlaceIdReply</a></span> * QPlaceManagerEngine::<span class="name">removePlace</span>(const <span class="type">QString</span> &<i> placeId</i>)<tt> [virtual]</tt></h3>
<p>Removes the place corresponding to <i>placeId</i> from the manager engine's datastore.</p>
<!-- @@@removePlace -->
<!-- $$$saveCategory[overload1]$$$saveCategoryconstQPlaceCategory&constQString& -->
<h3 class="fn"><a name="saveCategory"></a><span class="type"><a href="qplaceidreply.html">QPlaceIdReply</a></span> * QPlaceManagerEngine::<span class="name">saveCategory</span>(const <span class="type"><a href="qplacecategory.html">QPlaceCategory</a></span> &<i> category</i>, const <span class="type">QString</span> &<i> parentId</i>)<tt> [virtual]</tt></h3>
<p>Saves a <i>category</i> that is a child of the category specified by <i>parentId</i>. An empty <i>parentId</i> means <i>category</i> is saved as a top level category.</p>
<!-- @@@saveCategory -->
<!-- $$$savePlace[overload1]$$$savePlaceconstQPlace& -->
<h3 class="fn"><a name="savePlace"></a><span class="type"><a href="qplaceidreply.html">QPlaceIdReply</a></span> * QPlaceManagerEngine::<span class="name">savePlace</span>(const <span class="type"><a href="qplace.html">QPlace</a></span> &<i> place</i>)<tt> [virtual]</tt></h3>
<p>Saves a specified <i>place</i> to the manager engine's datastore.</p>
<!-- @@@savePlace -->
<!-- $$$search[overload1]$$$searchconstQPlaceSearchRequest& -->
<h3 class="fn"><a name="search"></a><span class="type"><a href="qplacesearchreply.html">QPlaceSearchReply</a></span> * QPlaceManagerEngine::<span class="name">search</span>(const <span class="type"><a href="qplacesearchrequest.html">QPlaceSearchRequest</a></span> &<i> request</i>)<tt> [virtual]</tt></h3>
<p>Searches for places according to the parameters specified in <i>request</i>.</p>
<!-- @@@search -->
<!-- $$$searchSuggestions[overload1]$$$searchSuggestionsconstQPlaceSearchRequest& -->
<h3 class="fn"><a name="searchSuggestions"></a><span class="type"><a href="qplacesearchsuggestionreply.html">QPlaceSearchSuggestionReply</a></span> * QPlaceManagerEngine::<span class="name">searchSuggestions</span>(const <span class="type"><a href="qplacesearchrequest.html">QPlaceSearchRequest</a></span> &<i> request</i>)<tt> [virtual]</tt></h3>
<p>Requests a set of search term suggestions according to the parameters specified in <i>request</i>.</p>
<!-- @@@searchSuggestions -->
<!-- $$$setLocales[overload1]$$$setLocalesconstQList<QLocale>& -->
<h3 class="fn"><a name="setLocales"></a><span class="type">void</span> QPlaceManagerEngine::<span class="name">setLocales</span>(const <span class="type">QList</span><<span class="type">QLocale</span>> &<i> locales</i>)<tt> [virtual]</tt></h3>
<p>Set the list of preferred <i>locales</i>.</p>
<p><b>See also </b><a href="qplacemanagerengine.html#locales">locales</a>().</p>
<!-- @@@setLocales -->
</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>
|