/usr/share/qt5/doc/qtlocation/qtlocation-geoservices.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 | <?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" />
<!-- qtlocation-geoservices.qdoc -->
<title>Qt Location GeoServices | 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>Qt Location GeoServices</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="#plugin-description">Plugin description</a></li>
<li class="level1"><a href="#implementing-plugins">Implementing Plugins</a></li>
</ul>
</div>
<h1 class="title">Qt Location GeoServices</h1>
<span class="subtitle"></span>
<!-- $$$qtlocation-geoservices.html-description -->
<div class="descr"> <a name="details"></a>
<p>The Qt Location provides the majority of its functionality through GeoService plugins. This document outlines how to develop a new GeoService plugin.</p>
<a name="plugin-description"></a>
<h2>Plugin description</h2>
<p>Each plugin is described by a json file. The json describes the plugins capabilities and version. Below is an example of a json file used by the OpenStreenMap plugin:</p>
<pre class="cpp">{
"Keys": [<span class="string">"osm"</span>],
"Provider": <span class="string">"osm"</span>,
"Version": <span class="number">100</span>,
"Experimental": <span class="number">false</span>,
"Features": [
<span class="string">"OnlineMappingFeature"</span>,
<span class="string">"OnlineGeocodingFeature"</span>,
<span class="string">"ReverseGeocodingFeature"</span>,
<span class="string">"OnlineRoutingFeature"</span>
]
}</pre>
<p>The entries have the following meaning:</p>
<table class="generic">
<thead><tr class="qt-style"><th >Key</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td >Keys</td><td >The unique name/key of the plugin. Each GeoService plugin must have a unique name.</td></tr>
<tr valign="top" class="even"><td >Provider</td><td >The provider name of the services. Multiple plugins may have the same name. In such cases the Version string will be used to further distinguish the plugins.</td></tr>
<tr valign="top" class="odd"><td >Experimental</td><td >Marks the service plugin as experimental. API developers may choose to ignore such plugins when instanciating <a href="qgeoserviceprovider.html#QGeoServiceProvider">QGeoServiceProvider::QGeoServiceProvider</a>().</td></tr>
<tr valign="top" class="even"><td >Version</td><td >The plugin version. If multiple plugins have the same provider name, the plugin with the higest version will be used.</td></tr>
<tr valign="top" class="odd"><td >Features</td><td >List of features provided by the plugin/service. Each feature is a string representation of the corresponding features in <a href="qgeoserviceprovider.html">QGeoServiceProvider</a>. For more details see <a href="qgeoserviceprovider.html#routingFeatures">QGeoServiceProvider::routingFeatures</a>(), <a href="qgeoserviceprovider.html#geocodingFeatures">QGeoServiceProvider::geocodingFeatures</a>() and <a href="qgeoserviceprovider.html#placesFeatures">QGeoServiceProvider::placesFeatures</a>().</td></tr>
</table>
<a name="implementing-plugins"></a>
<h2>Implementing Plugins</h2>
<p>A plugin implementer needs to subclass <a href="qgeoserviceproviderfactory.html">QGeoServiceProviderFactory</a> and as many of the ManagerEngine classes as they want to provide implementations for.</p>
<p>Subclassing <a href="qgeoserviceproviderfactory.html">QGeoServiceProviderFactory</a> will only involves overriding of one of the following methods:</p>
<ul>
<li><a href="qgeoserviceproviderfactory.html#createGeocodingManagerEngine">QGeoServiceProviderFactory::createGeocodingManagerEngine</a>()</li>
<li><a href="qgeoserviceproviderfactory.html#createRoutingManagerEngine">QGeoServiceProviderFactory::createRoutingManagerEngine</a>()</li>
<li><a href="qgeoserviceproviderfactory.html#createPlaceManagerEngine">QGeoServiceProviderFactory::createPlaceManagerEngine</a>()</li>
</ul>
<p>If a plugin does not provide an engine the relevant function should return 0.</p>
<table class="annotated">
<tr class="odd topAlign"><td class="tblName"><p><a href="qgeocodingmanagerengine.html">QGeoCodingManagerEngine</a></p></td><td class="tblDescr"><p>Interface and convenience methods to implementers of QGeoServiceProvider plugins who want to provide support for geocoding operations</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qgeoroutingmanagerengine.html">QGeoRoutingManagerEngine</a></p></td><td class="tblDescr"><p>Interface and convenience methods to implementers of QGeoServiceProvider plugins who want to provide access to geographic routing information</p></td></tr>
<tr class="odd topAlign"><td class="tblName"><p><a href="qgeoserviceproviderfactory.html">QGeoServiceProviderFactory</a></p></td><td class="tblDescr"><p>Factory class used as the plugin interface for services related to geographical information</p></td></tr>
<tr class="even topAlign"><td class="tblName"><p><a href="qplacemanagerengine.html">QPlaceManagerEngine</a></p></td><td class="tblDescr"><p>Interface for implementers of QGeoServiceProvider plugins who want to provide access to place functionality</p></td></tr>
</table>
</div>
<!-- @@@qtlocation-geoservices.html -->
</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>
|