/usr/share/gtk-doc/html/geoclue/GeoclueReverseGeocode.html is in libgeoclue-dev 0.12.99-3ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GeoclueReverseGeocode</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Geoclue Reference Manual">
<link rel="up" href="rn01.html" title="C API">
<link rel="prev" href="GeoclueGeocode.html" title="GeoclueGeocode">
<link rel="next" href="geoclue-geoclue-types.html" title="geoclue-types">
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GeoclueGeocode.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="rn01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Geoclue Reference Manual</th>
<td><a accesskey="n" href="geoclue-geoclue-types.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GeoclueReverseGeocode.synopsis" class="shortcut">Top</a>
|
<a href="#GeoclueReverseGeocode.description" class="shortcut">Description</a>
|
<a href="#GeoclueReverseGeocode.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="GeoclueReverseGeocode"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GeoclueReverseGeocode.top_of_page"></a>GeoclueReverseGeocode</span></h2>
<p>GeoclueReverseGeocode — Geoclue reverse geocode client API</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GeoclueReverseGeocode.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="GeoclueReverseGeocode.html#GEOCLUE-REVERSE-GEOCODE-INTERFACE-NAME:CAPS" title="GEOCLUE_REVERSE_GEOCODE_INTERFACE_NAME">GEOCLUE_REVERSE_GEOCODE_INTERFACE_NAME</a>
<a class="link" href="GeoclueReverseGeocode.html#GeoclueReverseGeocode-struct" title="GeoclueReverseGeocode">GeoclueReverseGeocode</a>;
<span class="returnvalue">void</span> (<a class="link" href="GeoclueReverseGeocode.html#GeoclueReverseGeocodeCallback" title="GeoclueReverseGeocodeCallback ()">*GeoclueReverseGeocodeCallback</a>) (<em class="parameter"><code><a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="type">GeoclueReverseGeocode</span></a> *revgeocode</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *details</code></em>,
<em class="parameter"><code><a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a> *accuracy</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);
<a class="link" href="GeoclueReverseGeocode.html#GeoclueReverseGeocodeClass" title="GeoclueReverseGeocodeClass">GeoclueReverseGeocodeClass</a>;
<a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="returnvalue">GeoclueReverseGeocode</span></a> * <a class="link" href="GeoclueReverseGeocode.html#geoclue-reverse-geocode-new" title="geoclue_reverse_geocode_new ()">geoclue_reverse_geocode_new</a> (<em class="parameter"><code>const <span class="type">char</span> *service</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *path</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GeoclueReverseGeocode.html#geoclue-reverse-geocode-position-to-address" title="geoclue_reverse_geocode_position_to_address ()">geoclue_reverse_geocode_position_to_address</a>
(<em class="parameter"><code><a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="type">GeoclueReverseGeocode</span></a> *revgeocode</code></em>,
<em class="parameter"><code><span class="type">double</span> latitude</code></em>,
<em class="parameter"><code><span class="type">double</span> longitude</code></em>,
<em class="parameter"><code><a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a> *position_accuracy</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **details</code></em>,
<em class="parameter"><code><a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a> **address_accuracy</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeoclueReverseGeocode.html#geoclue-reverse-geocode-position-to-address-async" title="geoclue_reverse_geocode_position_to_address_async ()">geoclue_reverse_geocode_position_to_address_async</a>
(<em class="parameter"><code><a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="type">GeoclueReverseGeocode</span></a> *revgeocode</code></em>,
<em class="parameter"><code><span class="type">double</span> latitude</code></em>,
<em class="parameter"><code><span class="type">double</span> longitude</code></em>,
<em class="parameter"><code><a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a> *accuracy</code></em>,
<em class="parameter"><code><a class="link" href="GeoclueReverseGeocode.html#GeoclueReverseGeocodeCallback" title="GeoclueReverseGeocodeCallback ()"><span class="type">GeoclueReverseGeocodeCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GeoclueReverseGeocode.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="GeoclueProvider.html" title="GeoclueProvider">GeoclueProvider</a>
+----GeoclueReverseGeocode
</pre>
</div>
<div class="refsect1">
<a name="GeoclueReverseGeocode.description"></a><h2>Description</h2>
<p>
<a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="type">GeoclueReverseGeocode</span></a> contains reverse geocoding methods.
It is part of the Geoclue public C client API which uses D-Bus
to communicate with the actual provider.
</p>
<p>
After a <a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="type">GeoclueReverseGeocode</span></a> is created with
<a class="link" href="GeoclueReverseGeocode.html#geoclue-reverse-geocode-new" title="geoclue_reverse_geocode_new ()"><code class="function">geoclue_reverse_geocode_new()</code></a>, the
<a class="link" href="GeoclueReverseGeocode.html#geoclue-reverse-geocode-position-to-address" title="geoclue_reverse_geocode_position_to_address ()"><code class="function">geoclue_reverse_geocode_position_to_address()</code></a> and
<a class="link" href="GeoclueReverseGeocode.html#geoclue-reverse-geocode-position-to-address-async" title="geoclue_reverse_geocode_position_to_address_async ()"><code class="function">geoclue_reverse_geocode_position_to_address_async()</code></a> method can be used to
obtain the address of a known position.
</p>
</div>
<div class="refsect1">
<a name="GeoclueReverseGeocode.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GEOCLUE-REVERSE-GEOCODE-INTERFACE-NAME:CAPS"></a><h3>GEOCLUE_REVERSE_GEOCODE_INTERFACE_NAME</h3>
<pre class="programlisting">#define GEOCLUE_REVERSE_GEOCODE_INTERFACE_NAME "org.freedesktop.Geoclue.ReverseGeocode"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GeoclueReverseGeocode-struct"></a><h3>GeoclueReverseGeocode</h3>
<pre class="programlisting">typedef struct _GeoclueReverseGeocode GeoclueReverseGeocode;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GeoclueReverseGeocodeCallback"></a><h3>GeoclueReverseGeocodeCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GeoclueReverseGeocodeCallback) (<em class="parameter"><code><a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="type">GeoclueReverseGeocode</span></a> *revgeocode</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *details</code></em>,
<em class="parameter"><code><a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a> *accuracy</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);</pre>
<p>
Callback function for <a class="link" href="GeoclueReverseGeocode.html#geoclue-reverse-geocode-position-to-address-async" title="geoclue_reverse_geocode_position_to_address_async ()"><code class="function">geoclue_reverse_geocode_position_to_address_async()</code></a>.
</p>
<p>
see <a class="ulink" href="geoclue-types.html" target="_top">geoclue-types.h</a> for the
hashtable keys used in <em class="parameter"><code>details</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>revgeocode</code></em> :</span></p></td>
<td>A <a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="type">GeoclueReverseGeocode</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
<td>Address details as <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>accuracy</code></em> :</span></p></td>
<td>Accuracy of measurement as <a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Error as <span class="type">Gerror</span> (may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
<td>User data pointer set in <a class="link" href="GeoclueReverseGeocode.html#geoclue-reverse-geocode-position-to-address-async" title="geoclue_reverse_geocode_position_to_address_async ()"><code class="function">geoclue_reverse_geocode_position_to_address_async()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GeoclueReverseGeocodeClass"></a><h3>GeoclueReverseGeocodeClass</h3>
<pre class="programlisting">typedef struct {
GeoclueProviderClass provider_class;
} GeoclueReverseGeocodeClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="geoclue-reverse-geocode-new"></a><h3>geoclue_reverse_geocode_new ()</h3>
<pre class="programlisting"><a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="returnvalue">GeoclueReverseGeocode</span></a> * geoclue_reverse_geocode_new (<em class="parameter"><code>const <span class="type">char</span> *service</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre>
<p>
Creates a <a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="type">GeoclueReverseGeocode</span></a> with given D-Bus service name and path.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>D-Bus service name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>D-Bus path name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Pointer to a new <a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="type">GeoclueReverseGeocode</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="geoclue-reverse-geocode-position-to-address"></a><h3>geoclue_reverse_geocode_position_to_address ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> geoclue_reverse_geocode_position_to_address
(<em class="parameter"><code><a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="type">GeoclueReverseGeocode</span></a> *revgeocode</code></em>,
<em class="parameter"><code><span class="type">double</span> latitude</code></em>,
<em class="parameter"><code><span class="type">double</span> longitude</code></em>,
<em class="parameter"><code><a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a> *position_accuracy</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **details</code></em>,
<em class="parameter"><code><a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a> **address_accuracy</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Obtains an address for the position defined by <em class="parameter"><code>latitude</code></em> and <em class="parameter"><code>longitude</code></em>.
<em class="parameter"><code>details</code></em> is a <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> with the returned address data, see
<a class="ulink" href="geoclue-types.html" target="_top">geoclue-types.h</a> for the hashtable keys.
</p>
<p>
If the caller is not interested in some values, the pointers can be
left <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. If accuracy of the position is not known, an accuracy with
GeoclueAccuracyLevel GEOCLUE_ACCURACY_DETAILED should be used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>latitude</code></em> :</span></p></td>
<td>latitude in degrees</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>longitude</code></em> :</span></p></td>
<td>longitude in degrees</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position_accuracy</code></em> :</span></p></td>
<td>Accuracy of the given latitude and longitude</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
<td>Pointer to returned <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> with address details or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>address_accuracy</code></em> :</span></p></td>
<td>Pointer to accuracy of the returned address or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Pointer to returned <span class="type">Gerror</span> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there is no <em class="parameter"><code>error</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="geoclue-reverse-geocode-position-to-address-async"></a><h3>geoclue_reverse_geocode_position_to_address_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> geoclue_reverse_geocode_position_to_address_async
(<em class="parameter"><code><a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode"><span class="type">GeoclueReverseGeocode</span></a> *revgeocode</code></em>,
<em class="parameter"><code><span class="type">double</span> latitude</code></em>,
<em class="parameter"><code><span class="type">double</span> longitude</code></em>,
<em class="parameter"><code><a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a> *accuracy</code></em>,
<em class="parameter"><code><a class="link" href="GeoclueReverseGeocode.html#GeoclueReverseGeocodeCallback" title="GeoclueReverseGeocodeCallback ()"><span class="type">GeoclueReverseGeocodeCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> userdata</code></em>);</pre>
<p>
Function returns (essentially) immediately and calls <em class="parameter"><code>callback</code></em> when the reverse-geocoded
address data is available or when D-Bus timeouts.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>latitude</code></em> :</span></p></td>
<td>Latitude in degrees</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>longitude</code></em> :</span></p></td>
<td>Longitude in degrees</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>accuracy</code></em> :</span></p></td>
<td>Accuracy of the given position as <a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>A <a class="link" href="GeoclueAddress.html#GeoclueAddressCallback" title="GeoclueAddressCallback ()"><span class="type">GeoclueAddressCallback</span></a> function that should be called when return values are available</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
<td>pointer for user specified data</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|