/usr/share/gtk-doc/html/geoclue/GeoclueVelocity.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GeoclueVelocity</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="GeoclueAddress.html" title="GeoclueAddress">
<link rel="next" href="GeoclueGeocode.html" title="GeoclueGeocode">
<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="GeoclueAddress.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="GeoclueGeocode.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GeoclueVelocity.synopsis" class="shortcut">Top</a>
|
<a href="#GeoclueVelocity.description" class="shortcut">Description</a>
|
<a href="#GeoclueVelocity.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GeoclueVelocity.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry" title="GeoclueVelocity">
<a name="GeoclueVelocity"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GeoclueVelocity.top_of_page"></a>GeoclueVelocity</span></h2>
<p>GeoclueVelocity — Geoclue velocity client API</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GeoclueVelocity.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="GeoclueVelocity.html#GEOCLUE-VELOCITY-INTERFACE-NAME:CAPS" title="GEOCLUE_VELOCITY_INTERFACE_NAME">GEOCLUE_VELOCITY_INTERFACE_NAME</a>
<a class="link" href="GeoclueVelocity.html#GeoclueVelocity-struct" title="GeoclueVelocity">GeoclueVelocity</a>;
<a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="returnvalue">GeoclueVelocity</span></a> * <a class="link" href="GeoclueVelocity.html#geoclue-velocity-new" title="geoclue_velocity_new ()">geoclue_velocity_new</a> (const <span class="returnvalue">char</span> *service,
const <span class="returnvalue">char</span> *path);
<a class="link" href="geoclue-geoclue-types.html#GeoclueVelocityFields" title="enum GeoclueVelocityFields"><span class="returnvalue">GeoclueVelocityFields</span></a> <a class="link" href="GeoclueVelocity.html#geoclue-velocity-get-velocity" title="geoclue_velocity_get_velocity ()">geoclue_velocity_get_velocity</a> (<a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="returnvalue">GeoclueVelocity</span></a> *velocity,
<span class="returnvalue">int</span> *timestamp,
<span class="returnvalue">double</span> *speed,
<span class="returnvalue">double</span> *direction,
<span class="returnvalue">double</span> *climb,
<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="GeoclueVelocity.html#GeoclueVelocityCallback" title="GeoclueVelocityCallback ()">*GeoclueVelocityCallback</a>) (<a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="returnvalue">GeoclueVelocity</span></a> *velocity,
<a class="link" href="geoclue-geoclue-types.html#GeoclueVelocityFields" title="enum GeoclueVelocityFields"><span class="returnvalue">GeoclueVelocityFields</span></a> fields,
<span class="returnvalue">int</span> timestamp,
<span class="returnvalue">double</span> speed,
<span class="returnvalue">double</span> direction,
<span class="returnvalue">double</span> climb,
<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="GeoclueVelocity.html#geoclue-velocity-get-velocity-async" title="geoclue_velocity_get_velocity_async ()">geoclue_velocity_get_velocity_async</a> (<a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="returnvalue">GeoclueVelocity</span></a> *velocity,
<a class="link" href="GeoclueVelocity.html#GeoclueVelocityCallback" title="GeoclueVelocityCallback ()"><span class="returnvalue">GeoclueVelocityCallback</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="GeoclueVelocity.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>
+----GeoclueVelocity
</pre>
</div>
<div class="refsect1" title="Signals">
<a name="GeoclueVelocity.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GeoclueVelocity.html#GeoclueVelocity-velocity-changed" title='The "velocity-changed" signal'>velocity-changed</a>" : Run First / No Recursion
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GeoclueVelocity.description"></a><h2>Description</h2>
<p>
<a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="type">GeoclueVelocity</span></a> contains velocity-related methods and signals.
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="GeoclueVelocity.html" title="GeoclueVelocity"><span class="type">GeoclueVelocity</span></a> is created with
<a class="link" href="GeoclueVelocity.html#geoclue-velocity-new" title="geoclue_velocity_new ()"><code class="function">geoclue_velocity_new()</code></a>, the
<a class="link" href="GeoclueVelocity.html#geoclue-velocity-get-velocity" title="geoclue_velocity_get_velocity ()"><code class="function">geoclue_velocity_get_velocity()</code></a> method and the VelocityChanged-signal
can be used to obtain the current velocity.</p>
</div>
<div class="refsect1" title="Details">
<a name="GeoclueVelocity.details"></a><h2>Details</h2>
<div class="refsect2" title="GEOCLUE_VELOCITY_INTERFACE_NAME">
<a name="GEOCLUE-VELOCITY-INTERFACE-NAME:CAPS"></a><h3>GEOCLUE_VELOCITY_INTERFACE_NAME</h3>
<pre class="programlisting">#define GEOCLUE_VELOCITY_INTERFACE_NAME "org.freedesktop.Geoclue.Velocity"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="GeoclueVelocity">
<a name="GeoclueVelocity-struct"></a><h3>GeoclueVelocity</h3>
<pre class="programlisting">typedef struct _GeoclueVelocity GeoclueVelocity;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="geoclue_velocity_new ()">
<a name="geoclue-velocity-new"></a><h3>geoclue_velocity_new ()</h3>
<pre class="programlisting"><a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="returnvalue">GeoclueVelocity</span></a> * geoclue_velocity_new (const <span class="returnvalue">char</span> *service,
const <span class="returnvalue">char</span> *path);</pre>
<p>
Creates a <a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="type">GeoclueVelocity</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="GeoclueVelocity.html" title="GeoclueVelocity"><span class="type">GeoclueVelocity</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="geoclue_velocity_get_velocity ()">
<a name="geoclue-velocity-get-velocity"></a><h3>geoclue_velocity_get_velocity ()</h3>
<pre class="programlisting"><a class="link" href="geoclue-geoclue-types.html#GeoclueVelocityFields" title="enum GeoclueVelocityFields"><span class="returnvalue">GeoclueVelocityFields</span></a> geoclue_velocity_get_velocity (<a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="returnvalue">GeoclueVelocity</span></a> *velocity,
<span class="returnvalue">int</span> *timestamp,
<span class="returnvalue">double</span> *speed,
<span class="returnvalue">double</span> *direction,
<span class="returnvalue">double</span> *climb,
<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 velocity. <em class="parameter"><code>timestamp</code></em> will contain the time of
the actual velocity measurement.
</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>velocity</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="type">GeoclueVelocity</span></a> object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td> Pointer to returned time of velocity measurement (unix timestamp) 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>speed</code></em> :</span></p></td>
<td> Pointer to returned horizontal speed 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>direction</code></em> :</span></p></td>
<td> Pointer to returned horizontal direction (bearing) 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>climb</code></em> :</span></p></td>
<td> Pointer to returned vertical speed 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 <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 <a class="link" href="geoclue-geoclue-types.html#GeoclueVelocityFields" title="enum GeoclueVelocityFields"><span class="type">GeoclueVelocityFields</span></a> bitfield representing the
validity of the velocity values.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="GeoclueVelocityCallback ()">
<a name="GeoclueVelocityCallback"></a><h3>GeoclueVelocityCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GeoclueVelocityCallback) (<a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="returnvalue">GeoclueVelocity</span></a> *velocity,
<a class="link" href="geoclue-geoclue-types.html#GeoclueVelocityFields" title="enum GeoclueVelocityFields"><span class="returnvalue">GeoclueVelocityFields</span></a> fields,
<span class="returnvalue">int</span> timestamp,
<span class="returnvalue">double</span> speed,
<span class="returnvalue">double</span> direction,
<span class="returnvalue">double</span> climb,
<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="GeoclueVelocity.html#geoclue-velocity-get-velocity-async" title="geoclue_velocity_get_velocity_async ()"><code class="function">geoclue_velocity_get_velocity_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>velocity</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="type">GeoclueVelocity</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#GeoclueVelocityFields" title="enum GeoclueVelocityFields"><span class="type">GeoclueVelocityFields</span></a> bitfield representing the validity of the velocity values
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td> Time of velocity measurement (unix timestamp)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>speed</code></em> :</span></p></td>
<td> Horizontal speed
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
<td> Horizontal direction (bearing)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>climb</code></em> :</span></p></td>
<td> Vertical speed
</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> (may be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
<td> User data pointer set in <a class="link" href="GeoclueVelocity.html#geoclue-velocity-get-velocity-async" title="geoclue_velocity_get_velocity_async ()"><code class="function">geoclue_velocity_get_velocity_async()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="geoclue_velocity_get_velocity_async ()">
<a name="geoclue-velocity-get-velocity-async"></a><h3>geoclue_velocity_get_velocity_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> geoclue_velocity_get_velocity_async (<a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="returnvalue">GeoclueVelocity</span></a> *velocity,
<a class="link" href="GeoclueVelocity.html#GeoclueVelocityCallback" title="GeoclueVelocityCallback ()"><span class="returnvalue">GeoclueVelocityCallback</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>
Function returns (essentially) immediately and calls <em class="parameter"><code>callback</code></em> when current velocity
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>velocity</code></em> :</span></p></td>
<td> A <a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="type">GeoclueVelocity</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="GeoclueVelocity.html#GeoclueVelocityCallback" title="GeoclueVelocityCallback ()"><span class="type">GeoclueVelocityCallback</span></a> function that should be called when return values are available
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>userdata</code></em> :</span></p></td>
<td> pointer for user specified data
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Signal Details">
<a name="GeoclueVelocity.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2" title='The "velocity-changed" signal'>
<a name="GeoclueVelocity-velocity-changed"></a><h3>The <code class="literal">"velocity-changed"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="type">GeoclueVelocity</span></a> *velocity,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> fields,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> timestamp,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> speed,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> direction,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> climb,
<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 geoclue-changed signal is emitted each time the velocity changes.
</p>
<p>
Note that not all providers support signals.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>velocity</code></em> :</span></p></td>
<td> the <a class="link" href="GeoclueVelocity.html" title="GeoclueVelocity"><span class="type">GeoclueVelocity</span></a> object emitting the signal
</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#GeoclueVelocityFields" title="enum GeoclueVelocityFields"><span class="type">GeoclueVelocityFields</span></a> bitfield representing the validity of the velocity values
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td> Time of velocity measurement (Unix timestamp)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>speed</code></em> :</span></p></td>
<td> horizontal speed
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td>
<td> horizontal direction (bearing)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>climb</code></em> :</span></p></td>
<td> vertical speed
</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>
|