Sophie

Sophie

distrib > Mageia > 5 > i586 > media > core-release > by-pkgid > 50facae208d4a6f280e44a513b104320 > files > 926

qt-mobility-doc-1.2.0-13.mga5.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.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" />
<!-- qgeosearchmanagerengine.cpp -->
  <title>Qt Mobility 1.2: QGeoSearchManagerEngine Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>QtMobility Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtlocation.html">QtLocation</a></li>
<li>QGeoSearchManagerEngine</li>
    </ul>
  </div>
</div>
<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">QGeoSearchManagerEngine Class Reference</h1>
<!-- $$$QGeoSearchManagerEngine-brief -->
<p>The QGeoSearchManagerEngine class provides an interface and convenience methods to implementers of <a href="qgeoserviceprovider.html">QGeoServiceProvider</a> plugins who want to provide support for searching operations related to geographic data. <a href="#details">More...</a></p>
<!-- @@@QGeoSearchManagerEngine -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QGeoSearchManagerEngine&gt;</span></pre><p><b>Inherits: </b><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a>.</p>
<p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qgeosearchmanagerengine-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="qgeosearchmanagerengine.html#QGeoSearchManagerEngine">QGeoSearchManagerEngine</a></b> ( const QMap&lt;QString, QVariant&gt; &amp; <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="qgeosearchmanagerengine.html#dtor.QGeoSearchManagerEngine">~QGeoSearchManagerEngine</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#addAdditionalLandmarkManager">addAdditionalLandmarkManager</a></b> ( QLandmarkManager * <i>landmarkManager</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList&lt;QLandmarkManager *&gt; </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#additionalLandmarkManagers">additionalLandmarkManagers</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLandmarkManager * </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#defaultLandmarkManager">defaultLandmarkManager</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QGeoSearchReply * </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#geocode">geocode</a></b> ( const QGeoAddress &amp; <i>address</i>, QGeoBoundingArea * <i>bounds</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QLocale </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#locale">locale</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#managerName">managerName</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#managerVersion">managerVersion</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QGeoSearchReply * </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#reverseGeocode">reverseGeocode</a></b> ( const QGeoCoordinate &amp; <i>coordinate</i>, QGeoBoundingArea * <i>bounds</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QGeoSearchReply * </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#search">search</a></b> ( const QString &amp; <i>searchString</i>, QGeoSearchManager::SearchTypes <i>searchTypes</i>, int <i>limit</i>, int <i>offset</i>, QGeoBoundingArea * <i>bounds</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#setAdditionalLandmarkManagers">setAdditionalLandmarkManagers</a></b> ( const QList&lt;QLandmarkManager *&gt; &amp; <i>landmarkManagers</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#setLocale">setLocale</a></b> ( const QLocale &amp; <i>locale</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoSearchManager::SearchTypes </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#supportedSearchTypes">supportedSearchTypes</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#supportsGeocoding">supportsGeocoding</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#supportsReverseGeocoding">supportsReverseGeocoding</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">29 public functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-functions">QObject</a></li>
</ul>
<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="qgeosearchmanagerengine.html#error">error</a></b> ( QGeoSearchReply * <i>reply</i>, QGeoSearchReply::Error <i>error</i>, QString <i>errorString</i> = QString() )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#finished">finished</a></b> ( QGeoSearchReply * <i>reply</i> )</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#setDefaultLandmarkManager">setDefaultLandmarkManager</a></b> ( QLandmarkManager * <i>landmarkManager</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#setSupportedSearchTypes">setSupportedSearchTypes</a></b> ( QGeoSearchManager::SearchTypes <i>searchTypes</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#setSupportsGeocoding">setSupportsGeocoding</a></b> ( bool <i>supported</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgeosearchmanagerengine.html#setSupportsReverseGeocoding">setSupportsReverseGeocoding</a></b> ( bool <i>supported</i> )</td></tr>
</table>
<ul>
<li class="fn">7 protected functions inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-functions">QObject</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#properties">QObject</a></li>
<li class="fn">1 public slot inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-slots">QObject</a></li>
<li class="fn">1 public variable inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#public-variables">QObject</a></li>
<li class="fn">4 static public members inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#static-public-members">QObject</a></li>
<li class="fn">2 protected variables inherited from <a href="http://qt.nokia.com/doc/4.7/qobject.html#protected-variables">QObject</a></li>
</ul>
<a name="details"></a>
<!-- $$$QGeoSearchManagerEngine-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoSearchManagerEngine class provides an interface and convenience methods to implementers of <a href="qgeoserviceprovider.html">QGeoServiceProvider</a> plugins who want to provide support for searching operations related to geographic data.</p>
<p>In the default implementation, <a href="qgeosearchmanagerengine.html#supportsGeocoding">supportsGeocoding</a>() and <a href="qgeosearchmanagerengine.html#supportsReverseGeocoding">supportsReverseGeocoding</a>() returns false while <a href="qgeosearchmanagerengine.html#geocode">geocode</a>() and <a href="qgeosearchmanagerengine.html#reverseGeocode">reverseGeocode</a>() cause <a href="qgeosearchreply.html#Error-enum">QGeoSearchReply::UnsupportedOptionError</a> to occur.</p>
<p>If the service provider supports geocoding the subclass should provide an implementation of <a href="qgeosearchmanagerengine.html#geocode">geocode</a>() and call setSupportsGeocoding(true) at some point in time before geoocode() is called.</p>
<p>Similarly, if the service provider supports reverse geocoding the subclass should provide an implementation <a href="qgeosearchmanagerengine.html#reverseGeocode">reverseGeocode</a>() and call setSupportsReverseGeocoding(true) at some point in time before reverseGeoocode() is called.</p>
<p>The <a href="qgeosearchmanagerengine.html#search">search</a>() function will make use of the <a href="qlandmarkmanager.html">QLandmarkManager</a> instances returned by <a href="qgeosearchmanagerengine.html#additionalLandmarkManagers">additionalLandmarkManagers</a>(). If a <a href="qlandmarkmanager.html">QLandmarkManager</a> is used internally to query the service providers landmark data the <a href="qlandmarkmanager.html">QLandmarkManager</a> can be made available to the users with <a href="qgeosearchmanagerengine.html#setDefaultLandmarkManager">setDefaultLandmarkManager</a>().</p>
<p>The subclass should call <a href="qgeosearchmanagerengine.html#setSupportedSearchTypes">setSupportedSearchTypes</a>() at some point in time before <a href="qgeosearchmanagerengine.html#search">search</a>() is called.</p>
<p>If the service supports searching for places the subclass should provide an implementetation of <a href="qgeosearchmanagerengine.html#search">search</a>() and call <a href="qgeosearchmanagerengine.html#setSupportedSearchTypes">setSupportedSearchTypes</a>() at some point in time before <a href="qgeosearchmanagerengine.html#search">search</a>() is called.</p>
<p>A subclass of QGeoSearchManagerEngine will often make use of a subclass fo <a href="qgeosearchreply.html">QGeoSearchReply</a> internally, in order to add any engine-specific data (such as a <a href="http://qt.nokia.com/doc/4.7/qnetworkreply.html">QNetworkReply</a> object for network-based services) to the <a href="qgeosearchreply.html">QGeoSearchReply</a> instances used by the engine.</p>
</div>
<p><b>See also </b><a href="qgeosearchmanager.html">QGeoSearchManager</a>.</p>
<!-- @@@QGeoSearchManagerEngine -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoSearchManagerEngine[overload1]$$$QGeoSearchManagerEngineconstQMap<QString,QVariant>&QObject* -->
<h3 class="fn"><a name="QGeoSearchManagerEngine"></a>QGeoSearchManagerEngine::<span class="name">QGeoSearchManagerEngine</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qmap.html">QMap</a></span>&lt;<span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span>&gt; &amp; <i>parameters</i>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qobject.html">QObject</a></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>
<!-- @@@QGeoSearchManagerEngine -->
<!-- $$$~QGeoSearchManagerEngine[overload1]$$$~QGeoSearchManagerEngine -->
<h3 class="fn"><a name="dtor.QGeoSearchManagerEngine"></a>QGeoSearchManagerEngine::<span class="name">~QGeoSearchManagerEngine</span> ()<tt> [virtual]</tt></h3>
<p>Destroys this engine.</p>
<!-- @@@~QGeoSearchManagerEngine -->
<!-- $$$addAdditionalLandmarkManager[overload1]$$$addAdditionalLandmarkManagerQLandmarkManager* -->
<h3 class="fn"><a name="addAdditionalLandmarkManager"></a><span class="type">void</span> QGeoSearchManagerEngine::<span class="name">addAdditionalLandmarkManager</span> ( <span class="type"><a href="qlandmarkmanager.html">QLandmarkManager</a></span> * <i>landmarkManager</i> )</h3>
<p>Adds <i>landmarkManager</i> to the list of landmark managers that will be used with <a href="qgeosearchmanagerengine.html#search">search</a>().</p>
<p>These landmark managers will be used along with the landmark manager returned by <a href="qgeosearchmanagerengine.html#defaultLandmarkManager">defaultLandmarkManager</a>().</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@addAdditionalLandmarkManager -->
<!-- $$$additionalLandmarkManagers[overload1]$$$additionalLandmarkManagers -->
<h3 class="fn"><a name="additionalLandmarkManagers"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span>&lt;<span class="type"><a href="qlandmarkmanager.html">QLandmarkManager</a></span> *&gt; QGeoSearchManagerEngine::<span class="name">additionalLandmarkManagers</span> () const</h3>
<p>Returns the landmark managers that will be used with <a href="qgeosearchmanagerengine.html#search">search</a>().</p>
<p>These landmark managers will be used along with the landmark manager returned by <a href="qgeosearchmanagerengine.html#defaultLandmarkManager">defaultLandmarkManager</a>().</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#setAdditionalLandmarkManagers">setAdditionalLandmarkManagers</a>().</p>
<!-- @@@additionalLandmarkManagers -->
<!-- $$$defaultLandmarkManager[overload1]$$$defaultLandmarkManager -->
<h3 class="fn"><a name="defaultLandmarkManager"></a><span class="type"><a href="qlandmarkmanager.html">QLandmarkManager</a></span> * QGeoSearchManagerEngine::<span class="name">defaultLandmarkManager</span> () const</h3>
<p>Returns the landmark manager provided by the service provider for use with <a href="qgeosearchmanagerengine.html#search">search</a>().</p>
<p>Will return 0 if the no landmark manager is associated with the service provider. This does not indicate that <a href="qgeosearchmanagerengine.html#search">search</a>() does not support landmark searching, only that any landmark searching which occurs within in <a href="qgeosearchmanagerengine.html#search">search</a>() is done without the use of a <a href="qlandmarkmanager.html">QLandmarkManager</a>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#setDefaultLandmarkManager">setDefaultLandmarkManager</a>().</p>
<!-- @@@defaultLandmarkManager -->
<!-- $$$error[overload1]$$$errorQGeoSearchReply*QGeoSearchReply::ErrorQString -->
<h3 class="fn"><a name="error"></a><span class="type">void</span> QGeoSearchManagerEngine::<span class="name">error</span> ( <span class="type"><a href="qgeosearchreply.html">QGeoSearchReply</a></span> * <i>reply</i>, <span class="type"><a href="qgeosearchreply.html#Error-enum">QGeoSearchReply::Error</a></span> <i>error</i>, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></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="qgeosearchmanagerengine.html#finished">QGeoSearchManagerEngine::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.</p>
<p>This signal and <a href="qgeosearchreply.html#error">QGeoSearchReply::error</a>() will be emitted at the same time.</p>
<p><b>Note:</b> Do no delete the <i>reply</i> object in the slot connected to this signal. Use <a href="http://qt.nokia.com/doc/4.7/qobject.html#deleteLater">deleteLater</a>() instead.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@error -->
<!-- $$$finished[overload1]$$$finishedQGeoSearchReply* -->
<h3 class="fn"><a name="finished"></a><span class="type">void</span> QGeoSearchManagerEngine::<span class="name">finished</span> ( <span class="type"><a href="qgeosearchreply.html">QGeoSearchReply</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::error() equals <a href="qgeosearchreply.html#Error-enum">QGeoSearchReply::NoError</a> then the processing finished successfully.</p>
<p>This signal and <a href="qgeosearchreply.html#finished">QGeoSearchReply::finished</a>() will be emitted at the same time.</p>
<p><b>Note:</b> Do no delete the <i>reply</i> object in the slot connected to this signal. Use <a href="http://qt.nokia.com/doc/4.7/qobject.html#deleteLater">deleteLater</a>() instead.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@finished -->
<!-- $$$geocode[overload1]$$$geocodeconstQGeoAddress&QGeoBoundingArea* -->
<h3 class="fn"><a name="geocode"></a><span class="type"><a href="qgeosearchreply.html">QGeoSearchReply</a></span> * QGeoSearchManagerEngine::<span class="name">geocode</span> ( const <span class="type"><a href="qgeoaddress.html">QGeoAddress</a></span> &amp; <i>address</i>, <span class="type"><a href="qgeoboundingarea.html">QGeoBoundingArea</a></span> * <i>bounds</i> )<tt> [virtual]</tt></h3>
<p>Begins the geocoding of <i>address</i>. Geocoding is the process of finding a coordinate that corresponds to a given address.</p>
<p>A <a href="qgeosearchreply.html">QGeoSearchReply</a> object will be returned, which can be used to manage the geocoding operation and to return the results of the operation.</p>
<p>This engine and the returned <a href="qgeosearchreply.html">QGeoSearchReply</a> object will emit signals indicating if the operation completes or if errors occur.</p>
<p>If <a href="qgeosearchmanagerengine.html#supportsGeocoding">supportsGeocoding</a>() returns false an <a href="qgeosearchreply.html#Error-enum">QGeoSearchReply::UnsupportedOptionError</a> will occur.</p>
<p>Once the operation has completed, <a href="qgeosearchreply.html#places">QGeoSearchReply::places</a>() can be used to retrieve the results, which will consist of a list of <a href="qgeoplace.html">QGeoPlace</a> objects. These object represent a combination of coordinate and address data.</p>
<p>The address data returned in the results may be different from <i>address</i>. This will usually occur if the geocoding service backend uses a different canonical form of addresses or if <i>address</i> was only partially filled out.</p>
<p>If <i>bounds</i> is non-null and a valid <a href="qgeoboundingarea.html">QGeoBoundingArea</a> it will be used to limit the results to those that are contained by <i>bounds</i>. This is particularly useful if <i>address</i> is only partially filled out, as the service will attempt to geocode all matches for the specified data.</p>
<p>The user is responsible for deleting the returned reply object, although this can be done in the slot connected to <a href="qgeosearchmanagerengine.html#finished">QGeoSearchManagerEngine::finished</a>(), <a href="qgeosearchmanagerengine.html#error">QGeoSearchManagerEngine::error</a>(), <a href="qgeosearchreply.html#finished">QGeoSearchReply::finished</a>() or <a href="qgeosearchreply.html#error">QGeoSearchReply::error</a>() with <a href="http://qt.nokia.com/doc/4.7/qobject.html#deleteLater">deleteLater</a>().</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@geocode -->
<!-- $$$locale[overload1]$$$locale -->
<h3 class="fn"><a name="locale"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qlocale.html">QLocale</a></span> QGeoSearchManagerEngine::<span class="name">locale</span> () const</h3>
<p>Returns the locale used to hint to this search manager about what language to use for the results.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#setLocale">setLocale</a>().</p>
<!-- @@@locale -->
<!-- $$$managerName[overload1]$$$managerName -->
<h3 class="fn"><a name="managerName"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QGeoSearchManagerEngine::<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 combination of managerName() and <a href="qgeosearchmanagerengine.html#managerVersion">managerVersion</a>() should be unique amongst plugin implementations.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@managerName -->
<!-- $$$managerVersion[overload1]$$$managerVersion -->
<h3 class="fn"><a name="managerVersion"></a><span class="type">int</span> QGeoSearchManagerEngine::<span class="name">managerVersion</span> () const</h3>
<p>Returns the version of this engine implementation.</p>
<p>The combination of <a href="qgeosearchmanagerengine.html#managerName">managerName</a>() and managerVersion() should be unique amongst plugin implementations.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@managerVersion -->
<!-- $$$reverseGeocode[overload1]$$$reverseGeocodeconstQGeoCoordinate&QGeoBoundingArea* -->
<h3 class="fn"><a name="reverseGeocode"></a><span class="type"><a href="qgeosearchreply.html">QGeoSearchReply</a></span> * QGeoSearchManagerEngine::<span class="name">reverseGeocode</span> ( const <span class="type"><a href="qgeocoordinate.html">QGeoCoordinate</a></span> &amp; <i>coordinate</i>, <span class="type"><a href="qgeoboundingarea.html">QGeoBoundingArea</a></span> * <i>bounds</i> )<tt> [virtual]</tt></h3>
<p>Begins the reverse geocoding of <i>coordinate</i>. Reverse geocoding is the process of finding an address that corresponds to a given coordinate.</p>
<p>A <a href="qgeosearchreply.html">QGeoSearchReply</a> object will be returned, which can be used to manage the reverse geocoding operation and to return the results of the operation.</p>
<p>This engine and the returned <a href="qgeosearchreply.html">QGeoSearchReply</a> object will emit signals indicating if the operation completes or if errors occur.</p>
<p>If <a href="qgeosearchmanagerengine.html#supportsReverseGeocoding">supportsReverseGeocoding</a>() returns false an <a href="qgeosearchreply.html#Error-enum">QGeoSearchReply::UnsupportedOptionError</a> will occur.</p>
<p>At that point <a href="qgeosearchreply.html#places">QGeoSearchReply::places</a>() can be used to retrieve the results, which will consist of a list of <a href="qgeoplace.html">QGeoPlace</a> objects. These object represent a combination of coordinate and address data.</p>
<p>The coordinate data returned in the results may be different from <i>coordinate</i>. This will usually occur if the reverse geocoding service backend shifts the coordinates to be closer to the matching addresses, or if the backend returns results at multiple levels of detail.</p>
<p>If multiple results are returned by the reverse geocoding service backend they will be provided in order of specificity. This normally occurs if the backend is configured to reverse geocode across multiple levels of detail. As an example, some services will return address and coordinate pairs for the street address, the city, the state and the country.</p>
<p>If <i>bounds</i> is non-null and a valid <a href="qgeoboundingarea.html">QGeoBoundingArea</a> it will be used to limit the results to those that are contained by <i>bounds</i>.</p>
<p>The user is responsible for deleting the returned reply object, although this can be done in the slot connected to <a href="qgeosearchmanagerengine.html#finished">QGeoSearchManagerEngine::finished</a>(), <a href="qgeosearchmanagerengine.html#error">QGeoSearchManagerEngine::error</a>(), <a href="qgeosearchreply.html#finished">QGeoSearchReply::finished</a>() or <a href="qgeosearchreply.html#error">QGeoSearchReply::error</a>() with <a href="http://qt.nokia.com/doc/4.7/qobject.html#deleteLater">deleteLater</a>().</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@reverseGeocode -->
<!-- $$$search[overload1]$$$searchconstQString&QGeoSearchManager::SearchTypesintintQGeoBoundingArea* -->
<h3 class="fn"><a name="search"></a><span class="type"><a href="qgeosearchreply.html">QGeoSearchReply</a></span> * QGeoSearchManagerEngine::<span class="name">search</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>searchString</i>, <span class="type"><a href="qgeosearchmanager.html#SearchType-enum">QGeoSearchManager::SearchTypes</a></span> <i>searchTypes</i>, <span class="type">int</span> <i>limit</i>, <span class="type">int</span> <i>offset</i>, <span class="type"><a href="qgeoboundingarea.html">QGeoBoundingArea</a></span> * <i>bounds</i> )<tt> [virtual]</tt></h3>
<p>Begins searching for a place matching <i>searchString</i>. The value of <i>searchTypes</i> will determine whether the search is for addresses only, for landmarks only or for both.</p>
<p>A <a href="qgeosearchreply.html">QGeoSearchReply</a> object will be returned, which can be used to manage the geocoding operation and to return the results of the operation.</p>
<p>This engine and the returned <a href="qgeosearchreply.html">QGeoSearchReply</a> object will emit signals indicating if the operation completes or if errors occur.</p>
<p>If <a href="qgeosearchmanagerengine.html#supportsGeocoding">supportsGeocoding</a>() returns false and <i>searchTypes</i> is QGeoSearchManagerEngine::SearchGeocode an <a href="qgeosearchreply.html#Error-enum">QGeoSearchReply::UnsupportedOptionError</a> will occur.</p>
<p>Once the operation has completed, <a href="qgeosearchreply.html#places">QGeoSearchReply::places</a>() can be used to retrieve the results, which will consist of a list of <a href="qgeoplace.html">QGeoPlace</a> objects. These object represent a combination of coordinate and address data.</p>
<p>If any of the <a href="qgeoplace.html">QGeoPlace</a> instances in the results have landmark associated data, <a href="qgeoplace.html#isLandmark">QGeoPlace::isLandmark</a>() will return true and QLandmark::QLandmark(const <a href="qgeoplace.html">QGeoPlace</a> &amp;place) can be used to convert the <a href="qgeoplace.html">QGeoPlace</a> instance into a <a href="qlandmark.html">QLandmark</a> instance.</p>
<p>If <i>searchTypes</i> is QGeoSearchManagerEngine::SearchLandmarks or QGeoSearchManagerEngine::SearchAll, a free text landmark search will be performed. The results will be a combination of the backend specific landmark search and the same free text search applied to each of the <a href="qlandmarkmanager.html">QLandmarkManager</a> instances in <a href="qgeosearchmanagerengine.html#additionalLandmarkManagers">additionalLandmarkManagers</a>().</p>
<p><b>Note:</b> At present the additional landmark managers only search for the search string in the name of the landmarks.</p>
<p>If <i>limit</i> is -1 the entire result set will be returned, otherwise at most <i>limit</i> results will be returned.</p>
<p>The <i>offset</i> parameter is used to ask the search service to not return the first <i>offset</i> results.</p>
<p>The <i>limit</i> and <i>offset</i> results are used together to implement paging.</p>
<p>If additional landmark managers have been setup the number of results returned will be at most (1 + number of additional landmark managers) * <i>limit</i>. This happens because the results are requested from all sources, combined, and returned once all sources have responded.</p>
<p>If <i>bounds</i> is non-null and a valid <a href="qgeoboundingarea.html">QGeoBoundingArea</a> it will be used to limit the results to those that are contained by <i>bounds</i>.</p>
<p>The user is responsible for deleting the returned reply object, although this can be done in the slot connected to <a href="qgeosearchmanagerengine.html#finished">QGeoSearchManagerEngine::finished</a>(), <a href="qgeosearchmanagerengine.html#error">QGeoSearchManagerEngine::error</a>(), <a href="qgeosearchreply.html#finished">QGeoSearchReply::finished</a>() or <a href="qgeosearchreply.html#error">QGeoSearchReply::error</a>() with <a href="http://qt.nokia.com/doc/4.7/qobject.html#deleteLater">deleteLater</a>().</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@search -->
<!-- $$$setAdditionalLandmarkManagers[overload1]$$$setAdditionalLandmarkManagersconstQList<QLandmarkManager*>& -->
<h3 class="fn"><a name="setAdditionalLandmarkManagers"></a><span class="type">void</span> QGeoSearchManagerEngine::<span class="name">setAdditionalLandmarkManagers</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qlist.html">QList</a></span>&lt;<span class="type"><a href="qlandmarkmanager.html">QLandmarkManager</a></span> *&gt; &amp; <i>landmarkManagers</i> )</h3>
<p>Sets the landmark managers to be used with <a href="qgeosearchmanagerengine.html#search">search</a>() to <i>landmarkManagers</i>.</p>
<p>These landmark managers will be used along with the landmark manager returned by <a href="qgeosearchmanagerengine.html#defaultLandmarkManager">defaultLandmarkManager</a>().</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#additionalLandmarkManagers">additionalLandmarkManagers</a>().</p>
<!-- @@@setAdditionalLandmarkManagers -->
<!-- $$$setDefaultLandmarkManager[overload1]$$$setDefaultLandmarkManagerQLandmarkManager* -->
<h3 class="fn"><a name="setDefaultLandmarkManager"></a><span class="type">void</span> QGeoSearchManagerEngine::<span class="name">setDefaultLandmarkManager</span> ( <span class="type"><a href="qlandmarkmanager.html">QLandmarkManager</a></span> * <i>landmarkManager</i> )<tt> [protected]</tt></h3>
<p>Sets the landmark manager provided by the service provider for use with <a href="qgeosearchmanagerengine.html#search">search</a>() to <i>landmarkManager</i>.</p>
<p>This should only be set if <a href="qgeosearchmanagerengine.html#search">search</a>() makes use of a <a href="qlandmarkmanager.html">QLandmarkManager</a> instance to provide landmark searching functionality.</p>
<p>It is important that subclasses use this method to ensure that the engine is able to carry out landmark searches. If this function is not used the engine will not be able to use or return the default landmark manager.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#defaultLandmarkManager">defaultLandmarkManager</a>().</p>
<!-- @@@setDefaultLandmarkManager -->
<!-- $$$setLocale[overload1]$$$setLocaleconstQLocale& -->
<h3 class="fn"><a name="setLocale"></a><span class="type">void</span> QGeoSearchManagerEngine::<span class="name">setLocale</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qlocale.html">QLocale</a></span> &amp; <i>locale</i> )</h3>
<p>Sets the locale to be used by the this manager to <i>locale</i>.</p>
<p>If this search manager supports returning the results in different languages, they will be returned in the language of <i>locale</i>.</p>
<p>The locale used defaults to the system locale if this is not set.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#locale">locale</a>().</p>
<!-- @@@setLocale -->
<!-- $$$setSupportedSearchTypes[overload1]$$$setSupportedSearchTypesQGeoSearchManager::SearchTypes -->
<h3 class="fn"><a name="setSupportedSearchTypes"></a><span class="type">void</span> QGeoSearchManagerEngine::<span class="name">setSupportedSearchTypes</span> ( <span class="type"><a href="qgeosearchmanager.html#SearchType-enum">QGeoSearchManager::SearchTypes</a></span> <i>searchTypes</i> )<tt> [protected]</tt></h3>
<p>Sets the search types supported by the <a href="qgeosearchmanagerengine.html#search">search</a>() with this engine to <i>searchTypes</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support any search types.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#supportedSearchTypes">supportedSearchTypes</a>().</p>
<!-- @@@setSupportedSearchTypes -->
<!-- $$$setSupportsGeocoding[overload1]$$$setSupportsGeocodingbool -->
<h3 class="fn"><a name="setSupportsGeocoding"></a><span class="type">void</span> QGeoSearchManagerEngine::<span class="name">setSupportsGeocoding</span> ( <span class="type">bool</span> <i>supported</i> )<tt> [protected]</tt></h3>
<p>Sets whether geocoding is supported by this engine to <i>supported</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support geocoding.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#supportsGeocoding">supportsGeocoding</a>().</p>
<!-- @@@setSupportsGeocoding -->
<!-- $$$setSupportsReverseGeocoding[overload1]$$$setSupportsReverseGeocodingbool -->
<h3 class="fn"><a name="setSupportsReverseGeocoding"></a><span class="type">void</span> QGeoSearchManagerEngine::<span class="name">setSupportsReverseGeocoding</span> ( <span class="type">bool</span> <i>supported</i> )<tt> [protected]</tt></h3>
<p>Sets whether reverse geocoding is supported by this engine to <i>supported</i>.</p>
<p>It is important that subclasses use this method to ensure that the engine reports its capabilities correctly. If this function is not used the engine will report that it does not support reverse geocoding.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#supportsReverseGeocoding">supportsReverseGeocoding</a>().</p>
<!-- @@@setSupportsReverseGeocoding -->
<!-- $$$supportedSearchTypes[overload1]$$$supportedSearchTypes -->
<h3 class="fn"><a name="supportedSearchTypes"></a><span class="type"><a href="qgeosearchmanager.html#SearchType-enum">QGeoSearchManager::SearchTypes</a></span> QGeoSearchManagerEngine::<span class="name">supportedSearchTypes</span> () const</h3>
<p>Returns the search types supported by the <a href="qgeosearchmanagerengine.html#search">search</a>() with this engine.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#setSupportedSearchTypes">setSupportedSearchTypes</a>().</p>
<!-- @@@supportedSearchTypes -->
<!-- $$$supportsGeocoding[overload1]$$$supportsGeocoding -->
<h3 class="fn"><a name="supportsGeocoding"></a><span class="type">bool</span> QGeoSearchManagerEngine::<span class="name">supportsGeocoding</span> () const</h3>
<p>Returns whether this engine supports geocoding.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#setSupportsGeocoding">setSupportsGeocoding</a>().</p>
<!-- @@@supportsGeocoding -->
<!-- $$$supportsReverseGeocoding[overload1]$$$supportsReverseGeocoding -->
<h3 class="fn"><a name="supportsReverseGeocoding"></a><span class="type">bool</span> QGeoSearchManagerEngine::<span class="name">supportsReverseGeocoding</span> () const</h3>
<p>Returns whether this engine supports reverse geocoding.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<p><b>See also </b><a href="qgeosearchmanagerengine.html#setSupportsReverseGeocoding">setSupportsReverseGeocoding</a>().</p>
<!-- @@@supportsReverseGeocoding -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
  <p>
     <acronym title="Copyright">&copy;</acronym> 2008-2011 Nokia Corporation and/or its
     subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
     in Finland and/or other countries worldwide.</p>
  <p>
     All other trademarks are property of their respective owners. <a title="Privacy Policy"
     href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
  <br />
  <p>
    Licensees holding valid Qt Commercial licenses may use this document in accordance with the    Qt Commercial License Agreement provided with the Software or, alternatively, in accordance    with the terms contained in a written agreement between you and Nokia.</p>
  <p>
    Alternatively, this document may be used 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.</p>
</div>
</body>
</html>