Sophie

Sophie

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

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" />
<!-- qgeoserviceprovider.cpp -->
  <title>Qt Mobility 1.2: QGeoServiceProvider 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>QGeoServiceProvider</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-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QGeoServiceProvider Class Reference</h1>
<!-- $$$QGeoServiceProvider-brief -->
<p>The QGeoServiceProvider class aggregates access to services which provide geographical information. <a href="#details">More...</a></p>
<!-- @@@QGeoServiceProvider -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QGeoServiceProvider&gt;</span></pre><p>This class was introduced in Qt Mobility 1.1.</p>
<ul>
<li><a href="qgeoserviceprovider-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qgeoserviceprovider.html#Error-enum">Error</a></b> { NoError, NotSupportedError, UnknownParameterError, MissingRequiredParameterError }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoserviceprovider.html#QGeoServiceProvider">QGeoServiceProvider</a></b> ( const QString &amp; <i>providerName</i>, const QMap&lt;QString, QVariant&gt; &amp; <i>parameters</i> = ( QMap&lt;QString, QVariant )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qgeoserviceprovider.html#dtor.QGeoServiceProvider">~QGeoServiceProvider</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Error </td><td class="memItemRight bottomAlign"><b><a href="qgeoserviceprovider.html#error">error</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qgeoserviceprovider.html#errorString">errorString</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoMappingManager * </td><td class="memItemRight bottomAlign"><b><a href="qgeoserviceprovider.html#mappingManager">mappingManager</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoRoutingManager * </td><td class="memItemRight bottomAlign"><b><a href="qgeoserviceprovider.html#routingManager">routingManager</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QGeoSearchManager * </td><td class="memItemRight bottomAlign"><b><a href="qgeoserviceprovider.html#searchManager">searchManager</a></b> () const</td></tr>
</table>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qgeoserviceprovider.html#availableServiceProviders">availableServiceProviders</a></b> ()</td></tr>
</table>
<a name="details"></a>
<!-- $$$QGeoServiceProvider-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGeoServiceProvider class aggregates access to services which provide geographical information.</p>
<p>The Maps and Navigation API allows people to access various kinds of geographical information, including functionality to perform geocoding, routing and the display of maps. The QGeoServiceProvider aggregates the access to a set of these services that are provided by a single vendor.</p>
<p>It is possible to mix and match service providers for the various domains, so that a geocoding manager from one service provider can be used with a geographic routing manager from another service provider.</p>
<p>This is not recommended unless the client is able to verify that the data provided by the different services are compatible, as differences in the underlying data sets could cause serious incongruences between the services.</p>
<p>Subclasses of QGeoServiceProvider guarantee that the different services that they provide are interoperable.</p>
<p>At this point only the Nokia Services plugin is pacakged with Qt Mobility, which is accessible using the provider name &quot;nokia&quot;.</p>
</div>
<!-- @@@QGeoServiceProvider -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Error$$$NoError$$$NotSupportedError$$$UnknownParameterError$$$MissingRequiredParameterError -->
<h3 class="fn"><a name="Error-enum"></a>enum QGeoServiceProvider::<span class="name">Error</span></h3>
<p>Describes an error related to the loading and setup of a service provider plugin.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QGeoServiceProvider::NoError</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">No error has occurred.</td></tr>
<tr><td class="topAlign"><tt>QGeoServiceProvider::NotSupportedError</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The plugin does not support this functionality.</td></tr>
<tr><td class="topAlign"><tt>QGeoServiceProvider::UnknownParameterError</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The plugin did not recognise one of the parameters it was given.</td></tr>
<tr><td class="topAlign"><tt>QGeoServiceProvider::MissingRequiredParameterError</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">The plugin did not find one of the parameters it was expecting.</td></tr>
</table>
<!-- @@@Error -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QGeoServiceProvider[overload1]$$$QGeoServiceProviderconstQString&constQMap<QString,QVariant>&QVariant -->
<h3 class="fn"><a name="QGeoServiceProvider"></a>QGeoServiceProvider::<span class="name">QGeoServiceProvider</span> ( const <span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> &amp; <i>providerName</i>, 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> = ( QMap&lt;QString, <span class="type"><a href="http://qt.nokia.com/doc/4.7/qvariant.html">QVariant</a></span> )</h3>
<!-- @@@QGeoServiceProvider -->
<!-- $$$~QGeoServiceProvider[overload1]$$$~QGeoServiceProvider -->
<h3 class="fn"><a name="dtor.QGeoServiceProvider"></a>QGeoServiceProvider::<span class="name">~QGeoServiceProvider</span> ()</h3>
<p>Destroys the service provider object.</p>
<!-- @@@~QGeoServiceProvider -->
<!-- $$$availableServiceProviders[overload1]$$$availableServiceProviders -->
<h3 class="fn"><a name="availableServiceProviders"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstringlist.html">QStringList</a></span> QGeoServiceProvider::<span class="name">availableServiceProviders</span> ()<tt> [static]</tt></h3>
<p>Returns a list of names of the available service providers, for use with the <a href="qgeoserviceprovider.html">QGeoServiceProvider</a> constructors.</p>
<!-- @@@availableServiceProviders -->
<!-- $$$error[overload1]$$$error -->
<h3 class="fn"><a name="error"></a><span class="type"><a href="qgeoserviceprovider.html#Error-enum">Error</a></span> QGeoServiceProvider::<span class="name">error</span> () const</h3>
<p>Returns an error code describing the error which occurred during the last operation that was performed by this class.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@error -->
<!-- $$$errorString[overload1]$$$errorString -->
<h3 class="fn"><a name="errorString"></a><span class="type"><a href="http://qt.nokia.com/doc/4.7/qstring.html">QString</a></span> QGeoServiceProvider::<span class="name">errorString</span> () const</h3>
<p>Returns a string describing the error which occurred during the last operation that was performed by this class.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@errorString -->
<!-- $$$mappingManager[overload1]$$$mappingManager -->
<h3 class="fn"><a name="mappingManager"></a><span class="type"><a href="qgeomappingmanager.html">QGeoMappingManager</a></span> * QGeoServiceProvider::<span class="name">mappingManager</span> () const</h3>
<p>Returns the <a href="qgeomappingmanager.html">QGeoMappingManager</a> made available by the service provider.</p>
<p>This function will return 0 if the service provider does not provide any mapping services.</p>
<p>This function will attempt to construct a <a href="qgeomappingmanager.html">QGeoMappingManager</a> instance when it is called for the first time. If the attempt is successful the <a href="qgeomappingmanager.html">QGeoMappingManager</a> will be cached, otherwise each call of this function will attempt to construct a <a href="qgeomappingmanager.html">QGeoMappingManager</a> instance until the construction is successful.</p>
<p>After this function has been called, <a href="qgeoserviceprovider.html#error">error</a>() and <a href="qgeoserviceprovider.html#errorString">errorString</a>() will report any errors which occurred during the construction of the <a href="qgeomappingmanager.html">QGeoMappingManager</a>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@mappingManager -->
<!-- $$$routingManager[overload1]$$$routingManager -->
<h3 class="fn"><a name="routingManager"></a><span class="type"><a href="qgeoroutingmanager.html">QGeoRoutingManager</a></span> * QGeoServiceProvider::<span class="name">routingManager</span> () const</h3>
<p>Returns the <a href="qgeoroutingmanager.html">QGeoRoutingManager</a> made available by the service provider.</p>
<p>This function will return 0 if the service provider does not provide any geographic routing services.</p>
<p>This function will attempt to construct a <a href="qgeoroutingmanager.html">QGeoRoutingManager</a> instance when it is called for the first time. If the attempt is successful the <a href="qgeoroutingmanager.html">QGeoRoutingManager</a> will be cached, otherwise each call of this function will attempt to construct a <a href="qgeoroutingmanager.html">QGeoRoutingManager</a> instance until the construction is successful.</p>
<p>After this function has been called, <a href="qgeoserviceprovider.html#error">error</a>() and <a href="qgeoserviceprovider.html#errorString">errorString</a>() will report any errors which occurred during the construction of the <a href="qgeoroutingmanager.html">QGeoRoutingManager</a>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@routingManager -->
<!-- $$$searchManager[overload1]$$$searchManager -->
<h3 class="fn"><a name="searchManager"></a><span class="type"><a href="qgeosearchmanager.html">QGeoSearchManager</a></span> * QGeoServiceProvider::<span class="name">searchManager</span> () const</h3>
<p>Returns the <a href="qgeosearchmanager.html">QGeoSearchManager</a> made available by the service provider.</p>
<p>This function will return 0 if the service provider does not provide any geocoding services.</p>
<p>This function will attempt to construct a <a href="qgeosearchmanager.html">QGeoSearchManager</a> instance when it is called for the first time. If the attempt is successful the <a href="qgeosearchmanager.html">QGeoSearchManager</a> will be cached, otherwise each call of this function will attempt to construct a <a href="qgeosearchmanager.html">QGeoSearchManager</a> instance until the construction is successful.</p>
<p>After this function has been called, <a href="qgeoserviceprovider.html#error">error</a>() and <a href="qgeoserviceprovider.html#errorString">errorString</a>() will report any errors which occurred during the construction of the <a href="qgeosearchmanager.html">QGeoSearchManager</a>.</p>
<p>This function was introduced in Qt Mobility 1.1.</p>
<!-- @@@searchManager -->
</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>