/usr/share/gtk-doc/html/geoclue/GeoclueProvider.html is in libgeoclue-dev 0.12.0-1ubuntu12.
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 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GeoclueProvider</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Geoclue Reference Manual">
<link rel="up" href="rn01.html" title="C API">
<link rel="prev" href="GeoclueMasterClient.html" title="GeoclueMasterClient">
<link rel="next" href="GeocluePosition.html" title="GeocluePosition">
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Using Geoclue in applications">
<link rel="reference" href="rn01.html" title="C API">
<link rel="reference" href="rn02.html" title="D-Bus API">
</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="GeoclueMasterClient.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="GeocluePosition.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GeoclueProvider.synopsis" class="shortcut">Top</a>
|
<a href="#GeoclueProvider.description" class="shortcut">Description</a>
|
<a href="#GeoclueProvider.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GeoclueProvider.properties" class="shortcut">Properties</a>
|
<a href="#GeoclueProvider.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="GeoclueProvider">
<a name="GeoclueProvider"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GeoclueProvider.top_of_page"></a>GeoclueProvider</span></h2>
<p>GeoclueProvider — Common client API for Geoclue providers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GeoclueProvider.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="GeoclueProvider.html#GeoclueProvider-struct" title="GeoclueProvider">GeoclueProvider</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GeoclueProvider.html#geoclue-provider-get-status" title="geoclue_provider_get_status ()">geoclue_provider_get_status</a> (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a class="link" href="geoclue-geoclue-types.html#GeoclueStatus" title="enum GeoclueStatus"><span class="returnvalue">GeoclueStatus</span></a> *status,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> **error);
<span class="returnvalue">void</span> (<a class="link" href="GeoclueProvider.html#GeoclueProviderStatusCallback" title="GeoclueProviderStatusCallback ()">*GeoclueProviderStatusCallback</a>) (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a class="link" href="geoclue-geoclue-types.html#GeoclueStatus" title="enum GeoclueStatus"><span class="returnvalue">GeoclueStatus</span></a> status,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *error,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);
<span class="returnvalue">void</span> <a class="link" href="GeoclueProvider.html#geoclue-provider-get-status-async" title="geoclue_provider_get_status_async ()">geoclue_provider_get_status_async</a> (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a class="link" href="GeoclueProvider.html#GeoclueProviderStatusCallback" title="GeoclueProviderStatusCallback ()"><span class="returnvalue">GeoclueProviderStatusCallback</span></a> callback,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GeoclueProvider.html#geoclue-provider-get-provider-info" title="geoclue_provider_get_provider_info ()">geoclue_provider_get_provider_info</a> (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<span class="returnvalue">char</span> **name,
<span class="returnvalue">char</span> **description,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> **error);
<span class="returnvalue">void</span> (<a class="link" href="GeoclueProvider.html#GeoclueProviderInfoCallback" title="GeoclueProviderInfoCallback ()">*GeoclueProviderInfoCallback</a>) (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<span class="returnvalue">char</span> *name,
<span class="returnvalue">char</span> *description,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *error,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);
<span class="returnvalue">void</span> <a class="link" href="GeoclueProvider.html#geoclue-provider-get-provider-info-async" title="geoclue_provider_get_provider_info_async ()">geoclue_provider_get_provider_info_async</a>
(<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a class="link" href="GeoclueProvider.html#GeoclueProviderInfoCallback" title="GeoclueProviderInfoCallback ()"><span class="returnvalue">GeoclueProviderInfoCallback</span></a> callback,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GeoclueProvider.html#geoclue-provider-set-options" title="geoclue_provider_set_options ()">geoclue_provider_set_options</a> (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *options,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> **error);
<span class="returnvalue">void</span> (<a class="link" href="GeoclueProvider.html#GeoclueProviderOptionsCallback" title="GeoclueProviderOptionsCallback ()">*GeoclueProviderOptionsCallback</a>) (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *error,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);
<span class="returnvalue">void</span> <a class="link" href="GeoclueProvider.html#geoclue-provider-set-options-async" title="geoclue_provider_set_options_async ()">geoclue_provider_set_options_async</a> (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *options,
<a class="link" href="GeoclueProvider.html#GeoclueProviderOptionsCallback" title="GeoclueProviderOptionsCallback ()"><span class="returnvalue">GeoclueProviderOptionsCallback</span></a> callback,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GeoclueProvider.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>
+----GeoclueProvider
+----<a class="link" href="GeocluePosition.html" title="GeocluePosition">GeocluePosition</a>
+----<a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity">GeoclueVelocity</a>
+----<a class="link" href="GeoclueAddress.html" title="GeoclueAddress">GeoclueAddress</a>
+----<a class="link" href="GeoclueGeocode.html" title="GeoclueGeocode">GeoclueGeocode</a>
+----<a class="link" href="GeoclueReverseGeocode.html" title="GeoclueReverseGeocode">GeoclueReverseGeocode</a>
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="GeoclueProvider.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GeoclueProvider.html#GeoclueProvider--interface" title='The "interface" property'>interface</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only
"<a class="link" href="GeoclueProvider.html#GeoclueProvider--path" title='The "path" property'>path</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only
"<a class="link" href="GeoclueProvider.html#GeoclueProvider--service" title='The "service" property'>service</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="GeoclueProvider.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GeoclueProvider.html#GeoclueProvider-status-changed" title='The "status-changed" signal'>status-changed</a>" : Run First / No Recursion
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GeoclueProvider.description"></a><h2>Description</h2>
<p>
<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> contains the methods and signals common to all Geoclue
providers. It is part of the public C client API which uses D-Bus
to communicate with the actual provider.
</p>
<p>
A <a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> is not explicitly created. Instead any provider
object can be cast to <a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a>. Using a <a class="link" href="GeocluePosition.html" title="GeocluePosition"><span class="type">GeocluePosition</span></a> as
example here:
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11</pre></td>
<td class="listing_code"><pre class="programlisting">GeocluePosition <span class="symbol">*</span>pos<span class="symbol">;</span>
<span class="gtkdoc kwb">char</span> <span class="symbol">*</span>name<span class="symbol">;</span>
GError <span class="symbol">*</span>error<span class="symbol">;</span>
pos <span class="symbol">=</span> <span class="function"><a href="GeocluePosition.html#geoclue-position-new">geoclue_position_new</a></span> <span class="symbol">(</span><span class="string">"org.freedesktop.Geoclue.Providers.Example"</span><span class="symbol">,</span>
<span class="string">"/org/freedesktop/Geoclue/Providers/Example"</span><span class="symbol">);</span>
<span class="keyword">if</span> <span class="symbol">(</span><span class="function"><a href="GeoclueProvider.html#geoclue-provider-get-provider-info">geoclue_provider_get_provider_info</a></span> <span class="symbol">(</span><span class="function">GEOCLUE_PROVIDER</span> <span class="symbol">(</span>pos<span class="symbol">),</span>
<span class="symbol">&</span>name<span class="symbol">,</span> NULL<span class="symbol">, &</span>error<span class="symbol">)) {</span>
<span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Warnings-and-Assertions.html#g-print">g_print</a></span> <span class="symbol">(</span><span class="string">"name = %s"</span><span class="symbol">,</span> name<span class="symbol">);</span>
<span class="symbol">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> can be used to obtain generic
information about the provider and to set provider
options.</p>
</div>
<div class="refsect1" title="Details">
<a name="GeoclueProvider.details"></a><h2>Details</h2>
<div class="refsect2" title="GeoclueProvider">
<a name="GeoclueProvider-struct"></a><h3>GeoclueProvider</h3>
<pre class="programlisting">typedef struct _GeoclueProvider GeoclueProvider;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="geoclue_provider_get_status ()">
<a name="geoclue-provider-get-status"></a><h3>geoclue_provider_get_status ()</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_provider_get_status (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a class="link" href="geoclue-geoclue-types.html#GeoclueStatus" title="enum GeoclueStatus"><span class="returnvalue">GeoclueStatus</span></a> *status,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> **error);</pre>
<p>
Obtains the current status of the provider.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
<td> Pointer for returned status as <a class="link" href="geoclue-geoclue-types.html#GeoclueStatus" title="enum GeoclueStatus"><span class="type">GeoclueStatus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> Pointer for returned <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</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"><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> on success
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="GeoclueProviderStatusCallback ()">
<a name="GeoclueProviderStatusCallback"></a><h3>GeoclueProviderStatusCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GeoclueProviderStatusCallback) (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a class="link" href="geoclue-geoclue-types.html#GeoclueStatus" title="enum GeoclueStatus"><span class="returnvalue">GeoclueStatus</span></a> status,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *error,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);</pre>
<p>
Callback function for <a class="link" href="GeoclueProvider.html#geoclue-provider-get-status-async" title="geoclue_provider_get_status_async ()"><code class="function">geoclue_provider_get_status_async()</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>provider</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
<td> A <a class="link" href="geoclue-geoclue-types.html#GeoclueStatus" title="enum GeoclueStatus"><span class="type">GeoclueStatus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> Error as <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</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>userdata</code></em> :</span></p></td>
<td> User data pointer set in <a class="link" href="GeoclueProvider.html#geoclue-provider-get-status-async" title="geoclue_provider_get_status_async ()"><code class="function">geoclue_provider_get_status_async()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="geoclue_provider_get_status_async ()">
<a name="geoclue-provider-get-status-async"></a><h3>geoclue_provider_get_status_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> geoclue_provider_get_status_async (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a class="link" href="GeoclueProvider.html#GeoclueProviderStatusCallback" title="GeoclueProviderStatusCallback ()"><span class="returnvalue">GeoclueProviderStatusCallback</span></a> callback,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);</pre>
<p>
Asynchronous version of <a class="link" href="GeoclueProvider.html#geoclue-provider-get-status" title="geoclue_provider_get_status ()"><code class="function">geoclue_provider_get_status()</code></a>. Function returns
(essentially) immediately and calls <em class="parameter"><code>callback</code></em> when status is available or
when there is an error.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html#GeoclueProviderStatusCallback" title="GeoclueProviderStatusCallback ()"><span class="type">GeoclueProviderStatusCallback</span></a> function that will 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" title="geoclue_provider_get_provider_info ()">
<a name="geoclue-provider-get-provider-info"></a><h3>geoclue_provider_get_provider_info ()</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_provider_get_provider_info (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<span class="returnvalue">char</span> **name,
<span class="returnvalue">char</span> **description,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> **error);</pre>
<p>
Obtains name and a short description of the provider.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> Pointer for returned provider name 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>description</code></em> :</span></p></td>
<td> Pointer for returned provider description 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 for returned <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</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"><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> on success
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="GeoclueProviderInfoCallback ()">
<a name="GeoclueProviderInfoCallback"></a><h3>GeoclueProviderInfoCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GeoclueProviderInfoCallback) (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<span class="returnvalue">char</span> *name,
<span class="returnvalue">char</span> *description,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *error,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);</pre>
<p>
Callback function for <a class="link" href="GeoclueProvider.html#geoclue-provider-get-provider-info-async" title="geoclue_provider_get_provider_info_async ()"><code class="function">geoclue_provider_get_provider_info_async()</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>provider</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> Name of the provider
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
<td> one-line description of the provider
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> Error as <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</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>userdata</code></em> :</span></p></td>
<td> User data pointer set in <a class="link" href="GeoclueProvider.html#geoclue-provider-get-provider-info-async" title="geoclue_provider_get_provider_info_async ()"><code class="function">geoclue_provider_get_provider_info_async()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="geoclue_provider_get_provider_info_async ()">
<a name="geoclue-provider-get-provider-info-async"></a><h3>geoclue_provider_get_provider_info_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> geoclue_provider_get_provider_info_async
(<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a class="link" href="GeoclueProvider.html#GeoclueProviderInfoCallback" title="GeoclueProviderInfoCallback ()"><span class="returnvalue">GeoclueProviderInfoCallback</span></a> callback,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);</pre>
<p>
Asynchronous version of <a class="link" href="GeoclueProvider.html#geoclue-provider-get-provider-info" title="geoclue_provider_get_provider_info ()"><code class="function">geoclue_provider_get_provider_info()</code></a>. Function returns
(essentially) immediately and calls <em class="parameter"><code>callback</code></em> when info is available or
when there is an error.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html#GeoclueProviderInfoCallback" title="GeoclueProviderInfoCallback ()"><span class="type">GeoclueProviderInfoCallback</span></a> function that will be called when info is 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" title="geoclue_provider_set_options ()">
<a name="geoclue-provider-set-options"></a><h3>geoclue_provider_set_options ()</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_provider_set_options (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *options,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> **error);</pre>
<p>
Sets the options on the provider.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>options</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> containing the options
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> Pointer for returned <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</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"><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 setting options succeeded
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="GeoclueProviderOptionsCallback ()">
<a name="GeoclueProviderOptionsCallback"></a><h3>GeoclueProviderOptionsCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GeoclueProviderOptionsCallback) (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *error,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);</pre>
<p>
Callback function for <a class="link" href="GeoclueProvider.html#geoclue-provider-set-options-async" title="geoclue_provider_set_options_async ()"><code class="function">geoclue_provider_set_options_async()</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>provider</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> Error as <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</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>userdata</code></em> :</span></p></td>
<td> User data pointer set in <a class="link" href="GeoclueProvider.html#geoclue-provider-set-options-async" title="geoclue_provider_set_options_async ()"><code class="function">geoclue_provider_set_options_async()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="geoclue_provider_set_options_async ()">
<a name="geoclue-provider-set-options-async"></a><h3>geoclue_provider_set_options_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> geoclue_provider_set_options_async (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="returnvalue">GeoclueProvider</span></a> *provider,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *options,
<a class="link" href="GeoclueProvider.html#GeoclueProviderOptionsCallback" title="GeoclueProviderOptionsCallback ()"><span class="returnvalue">GeoclueProviderOptionsCallback</span></a> callback,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a> userdata);</pre>
<p>
Asynchronous version of <a class="link" href="GeoclueProvider.html#geoclue-provider-set-options" title="geoclue_provider_set_options ()"><code class="function">geoclue_provider_set_options()</code></a>. Function returns
(essentially) immediately and calls <em class="parameter"><code>callback</code></em> when options have been set or
when there is an error.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>options</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> of options
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueProvider.html#GeoclueProviderOptionsCallback" title="GeoclueProviderOptionsCallback ()"><span class="type">GeoclueProviderOptionsCallback</span></a> function that will be called when options are set
</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 class="refsect1" title="Property Details">
<a name="GeoclueProvider.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "interface" property'>
<a name="GeoclueProvider--interface"></a><h3>The <code class="literal">"interface"</code> property</h3>
<pre class="programlisting"> "interface" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only</pre>
<p>The D-Bus interface implemented by the object.</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2" title='The "path" property'>
<a name="GeoclueProvider--path"></a><h3>The <code class="literal">"path"</code> property</h3>
<pre class="programlisting"> "path" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only</pre>
<p>The D-Bus path to this provider.</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2" title='The "service" property'>
<a name="GeoclueProvider--service"></a><h3>The <code class="literal">"service"</code> property</h3>
<pre class="programlisting"> "service" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write / Construct Only</pre>
<p>The D-Bus service this object represents.</p>
<p>Default value: ""</p>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="GeoclueProvider.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "status-changed" signal'>
<a name="GeoclueProvider-status-changed"></a><h3>The <code class="literal">"status-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GeoclueProvider.html" title="GeoclueProvider"><span class="type">GeoclueProvider</span></a> *provider,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> status,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : Run First / No Recursion</pre>
<p>
The status-changed signal is emitted each time the provider
status changes</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>provider</code></em> :</span></p></td>
<td> the provider object emitting the signal
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
<td> New provider status as <a class="link" href="geoclue-geoclue-types.html#GeoclueStatus" title="enum GeoclueStatus"><span class="type">GeoclueStatus</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.13</div>
</body>
</html>
|