/usr/share/gtk-doc/html/geoclue/GeoclueGeocode.html is in libgeoclue-dev 0.12.99-4ubuntu1.
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 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GeoclueGeocode</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="GeoclueVelocity.html" title="GeoclueVelocity">
<link rel="next" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode">
<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="GeoclueVelocity.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="GeoclueReverseGeocode.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GeoclueGeocode.synopsis" class="shortcut">Top</a>
|
<a href="#GeoclueGeocode.description" class="shortcut">Description</a>
|
<a href="#GeoclueGeocode.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="GeoclueGeocode"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GeoclueGeocode.top_of_page"></a>GeoclueGeocode</span></h2>
<p>GeoclueGeocode — Geoclue geocode client API</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GeoclueGeocode.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="GeoclueGeocode.html#GEOCLUE-GEOCODE-INTERFACE-NAME:CAPS" title="GEOCLUE_GEOCODE_INTERFACE_NAME">GEOCLUE_GEOCODE_INTERFACE_NAME</a>
<a class="link" href="GeoclueGeocode.html#GeoclueGeocode-struct" title="GeoclueGeocode">GeoclueGeocode</a>;
<span class="returnvalue">void</span> (<a class="link" href="GeoclueGeocode.html#GeoclueGeocodeCallback" title="GeoclueGeocodeCallback ()">*GeoclueGeocodeCallback</a>) (<em class="parameter"><code><a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> *geocode</code></em>,
<em class="parameter"><code><a class="link" href="geoclue-geoclue-types.html#GeocluePositionFields" title="enum GeocluePositionFields"><span class="type">GeocluePositionFields</span></a> fields</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><span class="type">double</span> altitude</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="GeoclueGeocode.html#GeoclueGeocodeClass" title="GeoclueGeocodeClass">GeoclueGeocodeClass</a>;
<a class="link" href="geoclue-geoclue-types.html#GeocluePositionFields" title="enum GeocluePositionFields"><span class="returnvalue">GeocluePositionFields</span></a> <a class="link" href="GeoclueGeocode.html#geoclue-geocode-address-to-position" title="geoclue_geocode_address_to_position ()">geoclue_geocode_address_to_position</a>
(<em class="parameter"><code><a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> *geocode</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><span class="type">double</span> *latitude</code></em>,
<em class="parameter"><code><span class="type">double</span> *longitude</code></em>,
<em class="parameter"><code><span class="type">double</span> *altitude</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>);
<span class="returnvalue">void</span> <a class="link" href="GeoclueGeocode.html#geoclue-geocode-address-to-position-async" title="geoclue_geocode_address_to_position_async ()">geoclue_geocode_address_to_position_async</a>
(<em class="parameter"><code><a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> *geocode</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="GeoclueGeocode.html#GeoclueGeocodeCallback" title="GeoclueGeocodeCallback ()"><span class="type">GeoclueGeocodeCallback</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>);
<a class="link" href="geoclue-geoclue-types.html#GeocluePositionFields" title="enum GeocluePositionFields"><span class="returnvalue">GeocluePositionFields</span></a> <a class="link" href="GeoclueGeocode.html#geoclue-geocode-freeform-address-to-position" title="geoclue_geocode_freeform_address_to_position ()">geoclue_geocode_freeform_address_to_position</a>
(<em class="parameter"><code><a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> *geocode</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *address</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><span class="type">double</span> *altitude</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>);
<span class="returnvalue">void</span> <a class="link" href="GeoclueGeocode.html#geoclue-geocode-freeform-address-to-position-async" title="geoclue_geocode_freeform_address_to_position_async ()">geoclue_geocode_freeform_address_to_position_async</a>
(<em class="parameter"><code><a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> *geocode</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *address</code></em>,
<em class="parameter"><code><a class="link" href="GeoclueGeocode.html#GeoclueGeocodeCallback" title="GeoclueGeocodeCallback ()"><span class="type">GeoclueGeocodeCallback</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>);
<a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="returnvalue">GeoclueGeocode</span></a> * <a class="link" href="GeoclueGeocode.html#geoclue-geocode-new" title="geoclue_geocode_new ()">geoclue_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>);
</pre>
</div>
<div class="refsect1">
<a name="GeoclueGeocode.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>
+----GeoclueGeocode
</pre>
</div>
<div class="refsect1">
<a name="GeoclueGeocode.description"></a><h2>Description</h2>
<p>
<a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> contains 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="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> is created with <a class="link" href="GeoclueGeocode.html#geoclue-geocode-new" title="geoclue_geocode_new ()"><code class="function">geoclue_geocode_new()</code></a>, the
<a class="link" href="GeoclueGeocode.html#geoclue-geocode-address-to-position" title="geoclue_geocode_address_to_position ()"><code class="function">geoclue_geocode_address_to_position()</code></a>,
<a class="link" href="GeoclueGeocode.html#geoclue-geocode-freeform-address-to-position" title="geoclue_geocode_freeform_address_to_position ()"><code class="function">geoclue_geocode_freeform_address_to_position()</code></a> methods and their
asynchronous counterparts can be used to obtain the position (coordinates)
of the given address.
</p>
<p>
Address <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> keys are defined in
<a class="ulink" href="geoclue-types.html" target="_top">geoclue-types.h</a>. See also
convenience functions in
<a class="ulink" href="geoclue-address-details.html" target="_top">geoclue-address-details.h</a>.
</p>
</div>
<div class="refsect1">
<a name="GeoclueGeocode.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GEOCLUE-GEOCODE-INTERFACE-NAME:CAPS"></a><h3>GEOCLUE_GEOCODE_INTERFACE_NAME</h3>
<pre class="programlisting">#define GEOCLUE_GEOCODE_INTERFACE_NAME "org.freedesktop.Geoclue.Geocode"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GeoclueGeocode-struct"></a><h3>GeoclueGeocode</h3>
<pre class="programlisting">typedef struct _GeoclueGeocode GeoclueGeocode;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GeoclueGeocodeCallback"></a><h3>GeoclueGeocodeCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GeoclueGeocodeCallback) (<em class="parameter"><code><a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> *geocode</code></em>,
<em class="parameter"><code><a class="link" href="geoclue-geoclue-types.html#GeocluePositionFields" title="enum GeocluePositionFields"><span class="type">GeocluePositionFields</span></a> fields</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><span class="type">double</span> altitude</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 the asynchronous methods.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>geocode</code></em> :</span></p></td>
<td>A <a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fields</code></em> :</span></p></td>
<td>A <a class="link" href="geoclue-geoclue-types.html#GeocluePositionFields" title="enum GeocluePositionFields"><span class="type">GeocluePositionFields</span></a> bitfield representing the validity of the position values</td>
</tr>
<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>altitude</code></em> :</span></p></td>
<td>Altitude in meters</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> 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>userdata</code></em> :</span></p></td>
<td>User data pointer</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GeoclueGeocodeClass"></a><h3>GeoclueGeocodeClass</h3>
<pre class="programlisting">typedef struct {
GeoclueProviderClass provider_class;
} GeoclueGeocodeClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="geoclue-geocode-address-to-position"></a><h3>geoclue_geocode_address_to_position ()</h3>
<pre class="programlisting"><a class="link" href="geoclue-geoclue-types.html#GeocluePositionFields" title="enum GeocluePositionFields"><span class="returnvalue">GeocluePositionFields</span></a> geoclue_geocode_address_to_position
(<em class="parameter"><code><a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> *geocode</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><span class="type">double</span> *latitude</code></em>,
<em class="parameter"><code><span class="type">double</span> *longitude</code></em>,
<em class="parameter"><code><span class="type">double</span> *altitude</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>);</pre>
<p>
Geocodes given address to coordinates (<em class="parameter"><code>latitude</code></em>, <em class="parameter"><code>longitude</code></em>, <em class="parameter"><code>altitude</code></em>).
see <a class="ulink" href="geoclue-types.html" target="_top">geoclue-types.h</a> for the
hashtable keys usable in <em class="parameter"><code>details</code></em>. <em class="parameter"><code>accuracy</code></em> is a rough estimate of
the accuracy of the returned position.
</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>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>geocode</code></em> :</span></p></td>
<td>A <a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
<td>Hashtable with address data</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>latitude</code></em> :</span></p></td>
<td>Pointer to returned latitude in degrees 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>longitude</code></em> :</span></p></td>
<td>Pointer to returned longitude in degrees 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>altitude</code></em> :</span></p></td>
<td>Pointer to returned altitude in meters 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>accuracy</code></em> :</span></p></td>
<td>Pointer to returned <a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a> 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 <a class="link" href="geoclue-geoclue-types.html#GeocluePositionFields" title="enum GeocluePositionFields"><span class="type">GeocluePositionFields</span></a> bitfield representing the
validity of the returned coordinates.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="geoclue-geocode-address-to-position-async"></a><h3>geoclue_geocode_address_to_position_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> geoclue_geocode_address_to_position_async
(<em class="parameter"><code><a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> *geocode</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="GeoclueGeocode.html#GeoclueGeocodeCallback" title="GeoclueGeocodeCallback ()"><span class="type">GeoclueGeocodeCallback</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 geocoded
position data is available or when D-Bus timeouts.
</p>
<p>
see <a class="ulink" href="geoclue-types.html" target="_top">geoclue-types.h</a> for the
hashtable keys usable 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>geocode</code></em> :</span></p></td>
<td>A <span class="type">Geocluegeocode</span> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
<td>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> with address data</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>
<hr>
<div class="refsect2">
<a name="geoclue-geocode-freeform-address-to-position"></a><h3>geoclue_geocode_freeform_address_to_position ()</h3>
<pre class="programlisting"><a class="link" href="geoclue-geoclue-types.html#GeocluePositionFields" title="enum GeocluePositionFields"><span class="returnvalue">GeocluePositionFields</span></a> geoclue_geocode_freeform_address_to_position
(<em class="parameter"><code><a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> *geocode</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *address</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><span class="type">double</span> *altitude</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>);</pre>
<p>
Geocodes given address to coordinates (<em class="parameter"><code>latitude</code></em>, <em class="parameter"><code>longitude</code></em>, <em class="parameter"><code>altitude</code></em>).
<em class="parameter"><code>accuracy</code></em> is a rough estimate of the accuracy of the returned position.
</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>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>geocode</code></em> :</span></p></td>
<td>A <a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em> :</span></p></td>
<td>freeform address</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>latitude</code></em> :</span></p></td>
<td>Pointer to returned latitude in degrees 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>longitude</code></em> :</span></p></td>
<td>Pointer to returned longitude in degrees 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>altitude</code></em> :</span></p></td>
<td>Pointer to returned altitude in meters 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>accuracy</code></em> :</span></p></td>
<td>Pointer to returned <a class="link" href="geoclue-geoclue-accuracy.html#GeoclueAccuracy" title="GeoclueAccuracy"><span class="type">GeoclueAccuracy</span></a> 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 <a class="link" href="geoclue-geoclue-types.html#GeocluePositionFields" title="enum GeocluePositionFields"><span class="type">GeocluePositionFields</span></a> bitfield representing the
validity of the returned coordinates.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="geoclue-geocode-freeform-address-to-position-async"></a><h3>geoclue_geocode_freeform_address_to_position_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> geoclue_geocode_freeform_address_to_position_async
(<em class="parameter"><code><a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a> *geocode</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *address</code></em>,
<em class="parameter"><code><a class="link" href="GeoclueGeocode.html#GeoclueGeocodeCallback" title="GeoclueGeocodeCallback ()"><span class="type">GeoclueGeocodeCallback</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 geocoded
position 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>geocode</code></em> :</span></p></td>
<td>A <span class="type">Geocluegeocode</span> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>address</code></em> :</span></p></td>
<td>freeform address</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>
<hr>
<div class="refsect2">
<a name="geoclue-geocode-new"></a><h3>geoclue_geocode_new ()</h3>
<pre class="programlisting"><a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode"><span class="returnvalue">GeoclueGeocode</span></a> * geoclue_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="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</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="GeoclueGeocode.html" title="GeoclueGeocode"><span class="type">GeoclueGeocode</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|