diff options
Diffstat (limited to 'docs/reference/html/gypsy-GypsyTime.html')
| -rw-r--r-- | docs/reference/html/gypsy-GypsyTime.html | 144 |
1 files changed, 71 insertions, 73 deletions
diff --git a/docs/reference/html/gypsy-GypsyTime.html b/docs/reference/html/gypsy-GypsyTime.html index 31223c1..46fa6d9 100644 --- a/docs/reference/html/gypsy-GypsyTime.html +++ b/docs/reference/html/gypsy-GypsyTime.html @@ -1,13 +1,13 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>GypsyTime</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.72.0"> -<link rel="start" href="index.html" title="Gypsy Reference Manual"> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="Gypsy Reference Manual"> <link rel="up" href="ch03.html" title="GPS Data Objects"> <link rel="prev" href="GypsySatellite.html" title="GypsySatellite"> -<meta name="generator" content="GTK-Doc V1.8 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.11 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> <link rel="reference" href="rn01.html" title="Gypsy Overview"> <link rel="reference" href="rn02.html" title="Tutorials"> @@ -25,54 +25,54 @@ <td><a accesskey="u" href="ch03.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">Gypsy Reference Manual</th> -<td> </td> +<td> </td> </tr> -<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2566220" class="shortcut">Top</a> -  |  - <a href="#id2565431" class="shortcut">Description</a></nobr></td></tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#gypsy-GypsyTime.synopsis" class="shortcut">Top</a> + | + <a href="#gypsy-GypsyTime.description" class="shortcut">Description</a> +</td></tr> </table> -<div class="refentry" lang="en"> +<div class="refentry" title="GypsyTime"> <a name="gypsy-GypsyTime"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> <td valign="top"> -<h2> -<a name="id2566220"></a><span class="refentrytitle">GypsyTime</span> -</h2> -<p>GypsyTime — Object for obtaining GPS time from gypsy-daemon</p> +<h2><span class="refentrytitle"><a name="gypsy-GypsyTime.top_of_page"></a>GypsyTime</span></h2> +<p>GypsyTime — Object for obtaining GPS time from gypsy-daemon</p> </td> <td valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv"> -<h2>Synopsis</h2> +<div class="refsynopsisdiv" title="Synopsis"> +<a name="gypsy-GypsyTime.synopsis"></a><h2>Synopsis</h2> <pre class="synopsis"> - - - - <a href="gypsy-GypsyTime.html#GypsyTime">GypsyTime</a>; -#define <a href="gypsy-GypsyTime.html#GYPSY-TIME-DBUS-SERVICE:CAPS">GYPSY_TIME_DBUS_SERVICE</a> -#define <a href="gypsy-GypsyTime.html#GYPSY-TIME-DBUS-INTERFACE:CAPS">GYPSY_TIME_DBUS_INTERFACE</a> -<a href="gypsy-GypsyTime.html#GypsyTime">GypsyTime</a>* <a href="gypsy-GypsyTime.html#gypsy-time-new">gypsy_time_new</a> (const char *object_path); -gboolean <a href="gypsy-GypsyTime.html#gypsy-time-get-time">gypsy_time_get_time</a> (<a href="gypsy-GypsyTime.html#GypsyTime">GypsyTime</a> *gps_time, + <a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime">GypsyTime</a>; +#define <a class="link" href="gypsy-GypsyTime.html#GYPSY-TIME-DBUS-SERVICE--CAPS" title="GYPSY_TIME_DBUS_SERVICE">GYPSY_TIME_DBUS_SERVICE</a> +#define <a class="link" href="gypsy-GypsyTime.html#GYPSY-TIME-DBUS-INTERFACE--CAPS" title="GYPSY_TIME_DBUS_INTERFACE">GYPSY_TIME_DBUS_INTERFACE</a> +<a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime">GypsyTime</a> * <a class="link" href="gypsy-GypsyTime.html#gypsy-time-new" title="gypsy_time_new ()">gypsy_time_new</a> (const char *object_path); +<a +href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean" +>gboolean</a> <a class="link" href="gypsy-GypsyTime.html#gypsy-time-get-time" title="gypsy_time_get_time ()">gypsy_time_get_time</a> (<a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime">GypsyTime</a> *gps_time, int *timestamp, - GError **error); - + <a +href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError" +>GError</a> **error); </pre> </div> -<div class="refsect1" lang="en"> -<a name="id2565431"></a><h2>Description</h2> +<div class="refsect1" title="Description"> +<a name="gypsy-GypsyTime.description"></a><h2>Description</h2> <p> -<a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a> is used whenever the client program wishes to know about +<a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime"><span class="type">GypsyTime</span></a> is used whenever the client program wishes to know about GPS time changes. It can report the current GPS time, and has a signal to notify listeners of changes. </p> <p> -A <a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a> object is created with <a href="gypsy-GypsyTime.html#gypsy-time-new"><code class="function">gypsy_time_new()</code></a> using the +A <a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime"><span class="type">GypsyTime</span></a> object is created with <a class="link" href="gypsy-GypsyTime.html#gypsy-time-new" title="gypsy_time_new ()"><code class="function">gypsy_time_new()</code></a> using the D-Bus path of the GPS device. This path is returned from the -<a href="GypsyControl.html#gypsy-control-create"><code class="function">gypsy_control_create()</code></a> function. The client can then find out about the -GPS time with <a href="gypsy-GypsyTime.html#gypsy-time-get-time"><code class="function">gypsy_time_get_time()</code></a>. +<a class="link" href="GypsyControl.html#gypsy-control-create" title="gypsy_control_create ()"><code class="function">gypsy_control_create()</code></a> function. The client can then find out about the +GPS time with <a class="link" href="gypsy-GypsyTime.html#gypsy-time-get-time" title="gypsy_time_get_time ()"><code class="function">gypsy_time_get_time()</code></a>. </p> <p> -As the GPS time information changes <a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a> will emit the +As the GPS time information changes <a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime"><span class="type">GypsyTime</span></a> will emit the time-changed signal. This signal contains the GPS time of the most recent GPS update that it received. </p> @@ -94,111 +94,106 @@ static void position_changed (GypsyTime *gps_time, int timestamp, gpointer userdata) { -  g_print ("timestamp: %d\n", timestamp); + g_print ("timestamp: %d\n", timestamp); } </pre></div> <p> - </p> </div> -<div class="refsect1" lang="en"> -<a name="id2565535"></a><h2>Details</h2> -<div class="refsect2" lang="en"> -<a name="id2565546"></a><h3> -<a name="GypsyTime"></a>GypsyTime</h3> -<a class="indexterm" name="id2565558"></a><pre class="programlisting">typedef struct { +<div class="refsect1" title="Details"> +<a name="gypsy-GypsyTime.details"></a><h2>Details</h2> +<div class="refsect2" title="GypsyTime"> +<a name="GypsyTime"></a><h3>GypsyTime</h3> +<pre class="programlisting">typedef struct { GObject parent_object; } GypsyTime; </pre> <p> -There are no public fields in <a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a>.</p> +There are no public fields in <a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime"><span class="type">GypsyTime</span></a>.</p> <p> - </p> </div> <hr> -<div class="refsect2" lang="en"> -<a name="id2580464"></a><h3> -<a name="GYPSY-TIME-DBUS-SERVICE:CAPS"></a>GYPSY_TIME_DBUS_SERVICE</h3> -<a class="indexterm" name="id2580476"></a><pre class="programlisting">#define GYPSY_TIME_DBUS_SERVICE "org.freedesktop.Gypsy" +<div class="refsect2" title="GYPSY_TIME_DBUS_SERVICE"> +<a name="GYPSY-TIME-DBUS-SERVICE--CAPS"></a><h3>GYPSY_TIME_DBUS_SERVICE</h3> +<pre class="programlisting">#define GYPSY_TIME_DBUS_SERVICE "org.freedesktop.Gypsy" </pre> <p> A define containing the address of the Time service</p> <p> - </p> </div> <hr> -<div class="refsect2" lang="en"> -<a name="id2580496"></a><h3> -<a name="GYPSY-TIME-DBUS-INTERFACE:CAPS"></a>GYPSY_TIME_DBUS_INTERFACE</h3> -<a class="indexterm" name="id2580507"></a><pre class="programlisting">#define GYPSY_TIME_DBUS_INTERFACE "org.freedesktop.Gypsy.Time" +<div class="refsect2" title="GYPSY_TIME_DBUS_INTERFACE"> +<a name="GYPSY-TIME-DBUS-INTERFACE--CAPS"></a><h3>GYPSY_TIME_DBUS_INTERFACE</h3> +<pre class="programlisting">#define GYPSY_TIME_DBUS_INTERFACE "org.freedesktop.Gypsy.Time" </pre> <p> A define containing the name of the Time interface</p> <p> - </p> </div> <hr> -<div class="refsect2" lang="en"> -<a name="id2580528"></a><h3> -<a name="gypsy-time-new"></a>gypsy_time_new ()</h3> -<a class="indexterm" name="id2580540"></a><pre class="programlisting"><a href="gypsy-GypsyTime.html#GypsyTime">GypsyTime</a>* gypsy_time_new (const char *object_path);</pre> +<div class="refsect2" title="gypsy_time_new ()"> +<a name="gypsy-time-new"></a><h3>gypsy_time_new ()</h3> +<pre class="programlisting"><a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime">GypsyTime</a> * gypsy_time_new (const char *object_path);</pre> <p> -Creates a new <a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a> object that listens for time changes +Creates a new <a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime"><span class="type">GypsyTime</span></a> object that listens for time changes from the GPS found at <em class="parameter"><code>object_path</code></em>.</p> <p> - </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> -<td><span class="term"><em class="parameter"><code>object_path</code></em> :</span></td> +<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td> <td> Object path to the GPS device </td> </tr> <tr> -<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td> -<td> A <a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a> object +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td> A <a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime"><span class="type">GypsyTime</span></a> object </td> </tr> </tbody> </table></div> </div> <hr> -<div class="refsect2" lang="en"> -<a name="id2509827"></a><h3> -<a name="gypsy-time-get-time"></a>gypsy_time_get_time ()</h3> -<a class="indexterm" name="id2509840"></a><pre class="programlisting">gboolean gypsy_time_get_time (<a href="gypsy-GypsyTime.html#GypsyTime">GypsyTime</a> *gps_time, +<div class="refsect2" title="gypsy_time_get_time ()"> +<a name="gypsy-time-get-time"></a><h3>gypsy_time_get_time ()</h3> +<pre class="programlisting"><a +href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean" +>gboolean</a> gypsy_time_get_time (<a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime">GypsyTime</a> *gps_time, int *timestamp, - GError **error);</pre> + <a +href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError" +>GError</a> **error);</pre> <p> Obtains the current time, if known, from the GPS device.</p> <p> - </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> <tbody> <tr> -<td><span class="term"><em class="parameter"><code>gps_time</code></em> :</span></td> -<td> A <a href="gypsy-GypsyTime.html#GypsyTime"><span class="type">GypsyTime</span></a> +<td><p><span class="term"><em class="parameter"><code>gps_time</code></em> :</span></p></td> +<td> A <a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime"><span class="type">GypsyTime</span></a> </td> </tr> <tr> -<td><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></td> +<td><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td> <td> Pointer to store the timestamp </td> </tr> <tr> -<td><span class="term"><em class="parameter"><code>error</code></em> :</span></td> -<td> Pointer to store a <span class="type">GError</span> +<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td> +<td> Pointer to store a <a +href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError" +><span class="type">GError</span></a> </td> </tr> <tr> -<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> <td> TRUE on success, FALSE on error. </td> </tr> @@ -207,5 +202,8 @@ Obtains the current time, if known, from the GPS device.</p> </div> </div> </div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.11</div> </body> </html> |