/usr/share/gtk-doc/html/geocode-glib-1.0/GeocodeForward.html is in libgeocode-glib-doc 3.10.0-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>geocode-glib Reference Manual: GeocodeForward</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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="geocode-glib-geocode-error.html" title="geocode-error">
<link rel="next" href="GeocodeLocation.html" title="GeocodeLocation">
<meta name="generator" content="GTK-Doc V1.19.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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#GeocodeForward.description" class="shortcut">Description</a>
|
<a href="#GeocodeForward.object-hierarchy" class="shortcut">Object Hierarchy</a>
</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="geocode-glib-geocode-error.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GeocodeLocation.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GeocodeForward"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GeocodeForward.top_of_page"></a>GeocodeForward</span></h2>
<p>GeocodeForward — Geocode forward geocoding object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GeocodeForward.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <geocode-glib/geocode-glib.h>
struct <a class="link" href="GeocodeForward.html#GeocodeForward-struct" title="struct GeocodeForward">GeocodeForward</a>;
struct <a class="link" href="GeocodeForward.html#GeocodeForwardClass" title="struct GeocodeForwardClass">GeocodeForwardClass</a>;
<a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="returnvalue">GeocodeForward</span></a> * <a class="link" href="GeocodeForward.html#geocode-forward-new-for-string" title="geocode_forward_new_for_string ()">geocode_forward_new_for_string</a> (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
<a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="returnvalue">GeocodeForward</span></a> * <a class="link" href="GeocodeForward.html#geocode-forward-new-for-params" title="geocode_forward_new_for_params ()">geocode_forward_new_for_params</a> (<em class="parameter"><code><span class="type">GHashTable</span> *params</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeocodeForward.html#geocode-forward-set-answer-count" title="geocode_forward_set_answer_count ()">geocode_forward_set_answer_count</a> (<em class="parameter"><code><a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> *forward</code></em>,
<em class="parameter"><code><span class="type">guint</span> count</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GeocodeForward.html#geocode-forward-search-async" title="geocode_forward_search_async ()">geocode_forward_search_async</a> (<em class="parameter"><code><a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> *forward</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>);
<span class="returnvalue">GList</span> * <a class="link" href="GeocodeForward.html#geocode-forward-search-finish" title="geocode_forward_search_finish ()">geocode_forward_search_finish</a> (<em class="parameter"><code><a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> *forward</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>);
<span class="returnvalue">GList</span> * <a class="link" href="GeocodeForward.html#geocode-forward-search" title="geocode_forward_search ()">geocode_forward_search</a> (<em class="parameter"><code><a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> *forward</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GeocodeForward.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GeocodeForward
</pre>
</div>
<div class="refsect1">
<a name="GeocodeForward.description"></a><h2>Description</h2>
<p>
Contains functions for geocoding using the
<a class="ulink" href="http://wiki.openstreetmap.org/wiki/Nominatim" target="_top">OSM Nominatim APIs</a>
</p>
</div>
<div class="refsect1">
<a name="GeocodeForward.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GeocodeForward-struct"></a><h3>struct GeocodeForward</h3>
<pre class="programlisting">struct GeocodeForward;</pre>
<p>
All the fields in the <a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> structure are private and should never be accessed directly.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GeocodeForwardClass"></a><h3>struct GeocodeForwardClass</h3>
<pre class="programlisting">struct GeocodeForwardClass {
};
</pre>
<p>
All the fields in the <a class="link" href="GeocodeForward.html#GeocodeForwardClass" title="struct GeocodeForwardClass"><span class="type">GeocodeForwardClass</span></a> structure are private and should never be accessed directly.
</p>
</div>
<hr>
<div class="refsect2">
<a name="geocode-forward-new-for-string"></a><h3>geocode_forward_new_for_string ()</h3>
<pre class="programlisting"><a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="returnvalue">GeocodeForward</span></a> * geocode_forward_new_for_string (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
<p>
Creates a new <a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> to perform forward geocoding with. The
string is in free-form format.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>a string containing a free-form description of the location</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a>. Use <code class="function">g_object_unref()</code> when done.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="geocode-forward-new-for-params"></a><h3>geocode_forward_new_for_params ()</h3>
<pre class="programlisting"><a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="returnvalue">GeocodeForward</span></a> * geocode_forward_new_for_params (<em class="parameter"><code><span class="type">GHashTable</span> *params</code></em>);</pre>
<p>
Creates a new <a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> to perform geocoding with. The
<span class="type">GHashTable</span> is in the format used by Telepathy, and documented
on <a class="ulink" href="http://telepathy.freedesktop.org/spec/Connection_Interface_Location.html#Mapping:Location" target="_top">Telepathy's specification site</a>.
</p>
<p>
See also: <a class="ulink" href="http://xmpp.org/extensions/xep-0080.html" target="_top">XEP-0080 specification</a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
<td>a <span class="type">GHashTable</span> with string keys, and <span class="type">GValue</span> values. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GValue]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a>. Use <code class="function">g_object_unref()</code> when done.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="geocode-forward-set-answer-count"></a><h3>geocode_forward_set_answer_count ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> geocode_forward_set_answer_count (<em class="parameter"><code><a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> *forward</code></em>,
<em class="parameter"><code><span class="type">guint</span> count</code></em>);</pre>
<p>
Sets the number of requested results to <em class="parameter"><code>count</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>forward</code></em> :</span></p></td>
<td>a <a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> representing a query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
<td>the number of requested results</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="geocode-forward-search-async"></a><h3>geocode_forward_search_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> geocode_forward_search_async (<em class="parameter"><code><a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> *forward</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 performs a forward geocoding
query using a web service. Use <a class="link" href="GeocodeForward.html#geocode-forward-search" title="geocode_forward_search ()"><code class="function">geocode_forward_search()</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="GeocodeForward.html#geocode-forward-search-finish" title="geocode_forward_search_finish ()"><code class="function">geocode_forward_search_finish()</code></a> to get the result of the operation.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>forward</code></em> :</span></p></td>
<td>a <a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> representing a query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> forward, <code class="literal">NULL</code> to ignore.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a <span class="type">GAsyncReadyCallback</span> to call when the request is satisfied</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>the data to pass to callback function</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="geocode-forward-search-finish"></a><h3>geocode_forward_search_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * geocode_forward_search_finish (<em class="parameter"><code><a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> *forward</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 forward geocoding operation. See <a class="link" href="GeocodeForward.html#geocode-forward-search-async" title="geocode_forward_search_async ()"><code class="function">geocode_forward_search_async()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>forward</code></em> :</span></p></td>
<td>a <a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> representing a query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>res</code></em> :</span></p></td>
<td>a <span class="type">GAsyncResult</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <span class="type">GError</span>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A list of
places or <code class="literal">NULL</code> in case of errors. Free the returned list with
<code class="function">g_list_free()</code> when done. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GeocodePlace][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="geocode-forward-search"></a><h3>geocode_forward_search ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> * geocode_forward_search (<em class="parameter"><code><a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> *forward</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Gets the result of a forward geocoding
query using a web service.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>forward</code></em> :</span></p></td>
<td>a <a class="link" href="GeocodeForward.html" title="GeocodeForward"><span class="type">GeocodeForward</span></a> representing a query</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <span class="type">GError</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A list of
places or <code class="literal">NULL</code> in case of errors. Free the returned list with
<code class="function">g_list_free()</code> when done. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GeocodePlace][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19.1</div>
</body>
</html>
|