/usr/share/gtk-doc/html/gypsy/gypsy-GypsyTime.html is in libgypsy-doc 0.8-0ubuntu7.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GypsyTime</title>
<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.15 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="GypsySatellite.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<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>
</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" title="GypsyTime">
<a name="gypsy-GypsyTime"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<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" title="Synopsis">
<a name="gypsy-GypsyTime.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <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"><span class="returnvalue">GypsyTime</span></a> * <a class="link" href="gypsy-GypsyTime.html#gypsy-time-new" title="gypsy_time_new ()">gypsy_time_new</a> (<em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="gypsy-GypsyTime.html#gypsy-time-get-time" title="gypsy_time_get_time ()">gypsy_time_get_time</a> (<em class="parameter"><code><a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime"><span class="type">GypsyTime</span></a> *gps_time</code></em>,
<em class="parameter"><code><span class="type">int</span> *timestamp</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="gypsy-GypsyTime.description"></a><h2>Description</h2>
<p>
<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 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 class="link" href="gypsy-gypsy-control.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 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>
<p>
</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
12
13
14
15
16
17</pre></td>
<td class="listing_code"><pre class="programlisting">GypsyTime <span class="symbol">*</span>gps_time<span class="symbol">;</span>
GError <span class="symbol">*</span>error <span class="symbol">=</span> NULL<span class="symbol">;</span>
<span class="symbol">. . .</span>
<span class="comment">/* path comes from the gypsy_control_create() function */</span>
gps_time <span class="symbol">=</span> <span class="function"><a href="gypsy-GypsyTime.html#gypsy-time-new">gypsy_time_new</a></span> <span class="symbol">(</span>path<span class="symbol">);</span>
<span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#g-signal-connect">g_signal_connect</a></span> <span class="symbol">(</span>gps_time<span class="symbol">,</span> <span class="string">"time-changed"</span><span class="symbol">,</span> <span class="function"><a href="/usr/share/gtk-doc/html/gobject/gobject-Closures.html#G-CALLBACK:CAPS">G_CALLBACK</a></span> <span class="symbol">(</span>time_changed<span class="symbol">),</span> NULL<span class="symbol">);</span>
<span class="symbol">. . .</span>
<span class="gtkdoc kwb">static void</span> <span class="function">position_changed</span> <span class="symbol">(</span>GypsyTime <span class="symbol">*</span>gps_time<span class="symbol">,</span>
<span class="gtkdoc kwb">int</span> timestamp<span class="symbol">,</span>
gpointer userdata<span class="symbol">)</span>
<span class="symbol">{</span>
<span class="function"><a href="/usr/share/gtk-doc/html/glib/glib-Warnings-and-Assertions.html#g-print">g_print</a></span> <span class="symbol">(</span><span class="string">"timestamp: %d</span><span class="gtkdoc esc">\n</span><span class="string">"</span><span class="symbol">,</span> timestamp<span class="symbol">);</span>
<span class="symbol">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
</div>
<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 class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime"><span class="type">GypsyTime</span></a>.
</p>
</div>
<hr>
<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>
</div>
<hr>
<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>
</div>
<hr>
<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"><span class="returnvalue">GypsyTime</span></a> * gypsy_time_new (<em class="parameter"><code>const <span class="type">char</span> *object_path</code></em>);</pre>
<p>
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>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<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><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" title="gypsy_time_get_time ()">
<a name="gypsy-time-get-time"></a><h3>gypsy_time_get_time ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gypsy_time_get_time (<em class="parameter"><code><a class="link" href="gypsy-GypsyTime.html#GypsyTime" title="GypsyTime"><span class="type">GypsyTime</span></a> *gps_time</code></em>,
<em class="parameter"><code><span class="type">int</span> *timestamp</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Obtains the current time, if known, from the GPS device.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<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><p><span class="term"><em class="parameter"><code>timestamp</code></em> :</span></p></td>
<td>Pointer to store the timestamp
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Pointer to store a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE on success, FALSE on error.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.15</div>
</body>
</html>
|