libgeocode-glib-doc 3.25.4.1-4 / usr / share / gtk-doc / html / geocode-glib / GeocodeReverse.html

This file is indexed.

/usr/share/gtk-doc/html/geocode-glib/GeocodeReverse.html is in libgeocode-glib-doc 3.25.4.1-4.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GeocodeReverse: geocode-glib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="geocode-glib Reference Manual">
<link rel="up" href="ch01.html" title="Geocode-glib">
<link rel="prev" href="GeocodePlace.html" title="GeocodePlace">
<link rel="next" href="GeocodeBoundingBox.html" title="GeocodeBoundingBox">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GeocodeReverse.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GeocodeReverse.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GeocodePlace.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GeocodeBoundingBox.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GeocodeReverse"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GeocodeReverse.top_of_page"></a>GeocodeReverse</span></h2>
<p>GeocodeReverse — Geocode reverse geocoding object</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GeocodeReverse.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="returnvalue">GeocodeReverse</span></a> *
</td>
<td class="function_name">
<a class="link" href="GeocodeReverse.html#geocode-reverse-new-for-location" title="geocode_reverse_new_for_location ()">geocode_reverse_new_for_location</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GeocodeReverse.html#geocode-reverse-set-backend" title="geocode_reverse_set_backend ()">geocode_reverse_set_backend</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GeocodeReverse.html#geocode-reverse-resolve-async" title="geocode_reverse_resolve_async ()">geocode_reverse_resolve_async</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GeocodePlace.html" title="GeocodePlace"><span class="returnvalue">GeocodePlace</span></a> *
</td>
<td class="function_name">
<a class="link" href="GeocodeReverse.html#geocode-reverse-resolve-finish" title="geocode_reverse_resolve_finish ()">geocode_reverse_resolve_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GeocodePlace.html" title="GeocodePlace"><span class="returnvalue">GeocodePlace</span></a> *
</td>
<td class="function_name">
<a class="link" href="GeocodeReverse.html#geocode-reverse-resolve" title="geocode_reverse_resolve ()">geocode_reverse_resolve</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GeocodeReverse.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GeocodeReverse.html#GeocodeReverse-struct" title="struct GeocodeReverse">GeocodeReverse</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GeocodeReverse.html#GeocodeReverseClass" title="struct GeocodeReverseClass">GeocodeReverseClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GeocodeReverse.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GeocodeReverse
</pre>
</div>
<div class="refsect1">
<a name="GeocodeReverse.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;geocode-glib/geocode-glib.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GeocodeReverse.description"></a><h2>Description</h2>
<p>Contains functions for reverse geocoding using the</p>
<a class="ulink" href="http://wiki.openstreetmap.org/wiki/Nominatim" target="_top">OSM Nominatim APIs</a>
</div>
<div class="refsect1">
<a name="GeocodeReverse.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="geocode-reverse-new-for-location"></a><h3>geocode_reverse_new_for_location ()</h3>
<pre class="programlisting"><a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="returnvalue">GeocodeReverse</span></a> *
geocode_reverse_new_for_location (<em class="parameter"><code><a class="link" href="GeocodeLocation.html" title="GeocodeLocation"><span class="type">GeocodeLocation</span></a> *location</code></em>);</pre>
<p>Creates a new <a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="type">GeocodeReverse</span></a> to perform reverse geocoding with.
Use <a class="link" href="GeocodeReverse.html#geocode-reverse-resolve-async" title="geocode_reverse_resolve_async ()"><code class="function">geocode_reverse_resolve_async()</code></a> to perform the resolution.</p>
<div class="refsect3">
<a name="geocode-reverse-new-for-location.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>location</p></td>
<td class="parameter_description"><p>a <a class="link" href="GeocodeLocation.html" title="GeocodeLocation"><span class="type">GeocodeLocation</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="geocode-reverse-new-for-location.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="type">GeocodeReverse</span></a>. Use <code class="function">g_object_unref()</code> when done.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="geocode-reverse-set-backend"></a><h3>geocode_reverse_set_backend ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
geocode_reverse_set_backend (<em class="parameter"><code><a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="type">GeocodeReverse</span></a> *object</code></em>,
                             <em class="parameter"><code><a class="link" href="GeocodeBackend.html" title="GeocodeBackend"><span class="type">GeocodeBackend</span></a> *backend</code></em>);</pre>
<p>Specifies the backend to use in the reverse geocoding operation.</p>
<p>If none is given, the default GNOME Nominatim server is used.</p>
<div class="refsect3">
<a name="geocode-reverse-set-backend.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>a <a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="type">GeocodeReverse</span></a> representing a query</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p> a <a class="link" href="GeocodeBackend.html" title="GeocodeBackend"><span class="type">GeocodeBackend</span></a>, or <code class="literal">NULL</code> to use the default one. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-full.html#api-index-3.23.1">3.23.1</a></p>
</div>
<hr>
<div class="refsect2">
<a name="geocode-reverse-resolve-async"></a><h3>geocode_reverse_resolve_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
geocode_reverse_resolve_async (<em class="parameter"><code><a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="type">GeocodeReverse</span></a> *object</code></em>,
                               <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                               <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
                               <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Asynchronously gets the result of a reverse geocoding
query using a web service. Use <a class="link" href="GeocodeReverse.html#geocode-reverse-resolve" title="geocode_reverse_resolve ()"><code class="function">geocode_reverse_resolve()</code></a> to do the same
thing synchronously.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
 will be called. You can then call
<a class="link" href="GeocodeReverse.html#geocode-reverse-resolve-finish" title="geocode_reverse_resolve_finish ()"><code class="function">geocode_reverse_resolve_finish()</code></a> to get the result of the operation.</p>
<div class="refsect3">
<a name="geocode-reverse-resolve-async.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>a <a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="type">GeocodeReverse</span></a> representing a query</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <span class="type">GCancellable</span> object, <code class="literal">NULL</code> to ignore.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>the data to pass to callback function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="geocode-reverse-resolve-finish"></a><h3>geocode_reverse_resolve_finish ()</h3>
<pre class="programlisting"><a class="link" href="GeocodePlace.html" title="GeocodePlace"><span class="returnvalue">GeocodePlace</span></a> *
geocode_reverse_resolve_finish (<em class="parameter"><code><a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="type">GeocodeReverse</span></a> *object</code></em>,
                                <em class="parameter"><code><span class="type">GAsyncResult</span> *res</code></em>,
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Finishes a reverse geocoding operation. See <a class="link" href="GeocodeReverse.html#geocode-reverse-resolve-async" title="geocode_reverse_resolve_async ()"><code class="function">geocode_reverse_resolve_async()</code></a>.</p>
<div class="refsect3">
<a name="geocode-reverse-resolve-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>a <a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="type">GeocodeReverse</span></a> representing a query</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>res</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncResult</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="geocode-reverse-resolve-finish.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="GeocodePlace.html" title="GeocodePlace"><span class="type">GeocodePlace</span></a> instance, or <code class="literal">NULL</code> in case of
errors. Free the returned instance with <code class="function"><GTKDOCLINK HREF="g-object-unref"><code class="function">g_object_unref()</code></code></GTKDOCLINK> when done. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="geocode-reverse-resolve"></a><h3>geocode_reverse_resolve ()</h3>
<pre class="programlisting"><a class="link" href="GeocodePlace.html" title="GeocodePlace"><span class="returnvalue">GeocodePlace</span></a> *
geocode_reverse_resolve (<em class="parameter"><code><a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="type">GeocodeReverse</span></a> *object</code></em>,
                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Gets the result of a reverse geocoding
query using the current backend (see <a class="link" href="GeocodeReverse.html#geocode-reverse-set-backend" title="geocode_reverse_set_backend ()"><code class="function">geocode_reverse_set_backend()</code></a>). By
default the GNOME Nominatim server is used. See <a class="link" href="GeocodeBackend.html" title="GeocodeBackend"><span class="type">GeocodeBackend</span></a> for more
information.</p>
<p>If no result could be found, a <a class="link" href="geocode-glib-geocode-error.html#GEOCODE-ERROR-NOT-SUPPORTED:CAPS"><code class="literal">GEOCODE_ERROR_NOT_SUPPORTED</code></a> error will be
returned. This typically happens if the coordinates to geocode are in the
middle of the ocean.</p>
<div class="refsect3">
<a name="geocode-reverse-resolve.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>a <a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="type">GeocodeReverse</span></a> representing a query</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="geocode-reverse-resolve.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="GeocodePlace.html" title="GeocodePlace"><span class="type">GeocodePlace</span></a> instance, or <code class="literal">NULL</code> in case of
errors. Free the returned instance with <code class="function"><GTKDOCLINK HREF="g-object-unref"><code class="function">g_object_unref()</code></code></GTKDOCLINK> when done. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GeocodeReverse.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GeocodeReverse-struct"></a><h3>struct GeocodeReverse</h3>
<pre class="programlisting">struct GeocodeReverse;</pre>
<p>All the fields in the <a class="link" href="GeocodeReverse.html" title="GeocodeReverse"><span class="type">GeocodeReverse</span></a> structure are private and should never be accessed directly.</p>
</div>
<hr>
<div class="refsect2">
<a name="GeocodeReverseClass"></a><h3>struct GeocodeReverseClass</h3>
<pre class="programlisting">struct GeocodeReverseClass {
};
</pre>
<p>All the fields in the <a class="link" href="GeocodeReverse.html#GeocodeReverseClass" title="struct GeocodeReverseClass"><span class="type">GeocodeReverseClass</span></a> structure are private and should never be accessed directly.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.