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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="OobsTimeConfig">
<refmeta>
<refentrytitle role="top_of_page" id="OobsTimeConfig.top_of_page">OobsTimeConfig</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsTimeConfig</refname>
<refpurpose>Object that represents time and date configuration.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsTimeConfig.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OobsTimeConfig-struct">OobsTimeConfig</link>;
<link linkend="OobsObject">OobsObject</link>* <link linkend="oobs-time-config-get">oobs_time_config_get</link> (void);
<link linkend="glong">glong</link> <link linkend="oobs-time-config-get-unix-time">oobs_time_config_get_unix_time</link> (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config);
<link linkend="void">void</link> <link linkend="oobs-time-config-set-unix-time">oobs_time_config_set_unix_time</link> (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
<link linkend="glong">glong</link> unix_time);
<link linkend="void">void</link> <link linkend="oobs-time-config-get-time">oobs_time_config_get_time</link> (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
<link linkend="gint">gint</link> *year,
<link linkend="gint">gint</link> *month,
<link linkend="gint">gint</link> *day,
<link linkend="gint">gint</link> *hour,
<link linkend="gint">gint</link> *minute,
<link linkend="gint">gint</link> *second);
<link linkend="void">void</link> <link linkend="oobs-time-config-set-time">oobs_time_config_set_time</link> (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
<link linkend="gint">gint</link> year,
<link linkend="gint">gint</link> month,
<link linkend="gint">gint</link> day,
<link linkend="gint">gint</link> hour,
<link linkend="gint">gint</link> minute,
<link linkend="gint">gint</link> second);
<link linkend="void">void</link> <link linkend="oobs-time-config-get-utc-time">oobs_time_config_get_utc_time</link> (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
<link linkend="gint">gint</link> *year,
<link linkend="gint">gint</link> *month,
<link linkend="gint">gint</link> *day,
<link linkend="gint">gint</link> *hour,
<link linkend="gint">gint</link> *minute,
<link linkend="gint">gint</link> *second);
<link linkend="void">void</link> <link linkend="oobs-time-config-set-utc-time">oobs_time_config_set_utc_time</link> (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
<link linkend="gint">gint</link> year,
<link linkend="gint">gint</link> month,
<link linkend="gint">gint</link> day,
<link linkend="gint">gint</link> hour,
<link linkend="gint">gint</link> minute,
<link linkend="gint">gint</link> second);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-time-config-get-timezone">oobs_time_config_get_timezone</link> (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config);
<link linkend="void">void</link> <link linkend="oobs-time-config-set-timezone">oobs_time_config_set_timezone</link> (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
const <link linkend="gchar">gchar</link> *timezone);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsTimeConfig.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="OobsObject">OobsObject</link>
+----OobsTimeConfig
</synopsis>
</refsect1>
<refsect1 id="OobsTimeConfig.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsTimeConfig--timezone">timezone</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="OobsTimeConfig--unix-time">unix-time</link>" <link linkend="glong">glong</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 id="OobsTimeConfig.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsTimeConfig.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsTimeConfig-struct" role="struct">
<title>OobsTimeConfig</title>
<indexterm zone="OobsTimeConfig-struct"><primary>OobsTimeConfig</primary></indexterm><programlisting>typedef struct _OobsTimeConfig OobsTimeConfig;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-time-config-get" role="function">
<title>oobs_time_config_get ()</title>
<indexterm zone="oobs-time-config-get"><primary>oobs_time_config_get</primary></indexterm><programlisting><link linkend="OobsObject">OobsObject</link>* oobs_time_config_get (void);</programlisting>
<para>
Returns the <link linkend="OobsTimeConfig"><type>OobsTimeConfig</type></link> singleton, this object
represents the date and time configuration.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the singleton <link linkend="OobsTimeConfig"><type>OobsTimeConfig</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-time-config-get-unix-time" role="function">
<title>oobs_time_config_get_unix_time ()</title>
<indexterm zone="oobs-time-config-get-unix-time"><primary>oobs_time_config_get_unix_time</primary></indexterm><programlisting><link linkend="glong">glong</link> oobs_time_config_get_unix_time (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config);</programlisting>
<para>
Returns the time, measured in seconds, since the "epoch" (1970-01-01T00:00:00Z).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsTimeConfig"><type>OobsTimeConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The unix time of the system.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-time-config-set-unix-time" role="function">
<title>oobs_time_config_set_unix_time ()</title>
<indexterm zone="oobs-time-config-set-unix-time"><primary>oobs_time_config_set_unix_time</primary></indexterm><programlisting><link linkend="void">void</link> oobs_time_config_set_unix_time (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
<link linkend="glong">glong</link> unix_time);</programlisting>
<para>
This function sets the <link linkend="config"><type>config</type></link> time to be <link linkend="unix-time"><type>unix_time</type></link>. <link linkend="unix-time"><type>unix_time</type></link>
is measured in seconds, since the "epoch" (1970-01-01T00:00:00Z).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsTimeConfig"><type>OobsTimeConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>unix_time</parameter> :</term>
<listitem><simpara> new Unix time.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-time-config-get-time" role="function">
<title>oobs_time_config_get_time ()</title>
<indexterm zone="oobs-time-config-get-time"><primary>oobs_time_config_get_time</primary></indexterm><programlisting><link linkend="void">void</link> oobs_time_config_get_time (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
<link linkend="gint">gint</link> *year,
<link linkend="gint">gint</link> *month,
<link linkend="gint">gint</link> *day,
<link linkend="gint">gint</link> *hour,
<link linkend="gint">gint</link> *minute,
<link linkend="gint">gint</link> *second);</programlisting>
<para>
Gets the system time and date in human readable values.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsTimeConfig"><type>OobsTimeConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> gint pointer to store the year, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>month</parameter> :</term>
<listitem><simpara> gint pointer to store the month, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> gint pointer to store the day, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hour</parameter> :</term>
<listitem><simpara> gint pointer to store the hour, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>minute</parameter> :</term>
<listitem><simpara> gint pointer to store the minute, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>second</parameter> :</term>
<listitem><simpara> gint pointer to store the second, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-time-config-set-time" role="function">
<title>oobs_time_config_set_time ()</title>
<indexterm zone="oobs-time-config-set-time"><primary>oobs_time_config_set_time</primary></indexterm><programlisting><link linkend="void">void</link> oobs_time_config_set_time (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
<link linkend="gint">gint</link> year,
<link linkend="gint">gint</link> month,
<link linkend="gint">gint</link> day,
<link linkend="gint">gint</link> hour,
<link linkend="gint">gint</link> minute,
<link linkend="gint">gint</link> second);</programlisting>
<para>
Sets the time and date of <link linkend="config"><type>config</type></link> to be the specified in the parameters.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsTimeConfig"><type>OobsTimeConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> year.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>month</parameter> :</term>
<listitem><simpara> month.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> day.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hour</parameter> :</term>
<listitem><simpara> hour.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>minute</parameter> :</term>
<listitem><simpara> minute.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>second</parameter> :</term>
<listitem><simpara> second.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-time-config-get-utc-time" role="function">
<title>oobs_time_config_get_utc_time ()</title>
<indexterm zone="oobs-time-config-get-utc-time"><primary>oobs_time_config_get_utc_time</primary></indexterm><programlisting><link linkend="void">void</link> oobs_time_config_get_utc_time (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
<link linkend="gint">gint</link> *year,
<link linkend="gint">gint</link> *month,
<link linkend="gint">gint</link> *day,
<link linkend="gint">gint</link> *hour,
<link linkend="gint">gint</link> *minute,
<link linkend="gint">gint</link> *second);</programlisting>
<para>
Gets the system time and date in human readable values (UTC).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsTimeConfig"><type>OobsTimeConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> gint pointer to store the year, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>month</parameter> :</term>
<listitem><simpara> gint pointer to store the month, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> gint pointer to store the day, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hour</parameter> :</term>
<listitem><simpara> gint pointer to store the hour, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>minute</parameter> :</term>
<listitem><simpara> gint pointer to store the minute, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>second</parameter> :</term>
<listitem><simpara> gint pointer to store the second, or <link linkend="NULL:CAPS"><type>NULL</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-time-config-set-utc-time" role="function">
<title>oobs_time_config_set_utc_time ()</title>
<indexterm zone="oobs-time-config-set-utc-time"><primary>oobs_time_config_set_utc_time</primary></indexterm><programlisting><link linkend="void">void</link> oobs_time_config_set_utc_time (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
<link linkend="gint">gint</link> year,
<link linkend="gint">gint</link> month,
<link linkend="gint">gint</link> day,
<link linkend="gint">gint</link> hour,
<link linkend="gint">gint</link> minute,
<link linkend="gint">gint</link> second);</programlisting>
<para>
Sets the time and date of <parameter>config</parameter> to be the specified in the parameters (assuming they're in UTC).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsTimeConfig"><type>OobsTimeConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>year</parameter> :</term>
<listitem><simpara> year.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>month</parameter> :</term>
<listitem><simpara> month.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>day</parameter> :</term>
<listitem><simpara> day.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>hour</parameter> :</term>
<listitem><simpara> hour.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>minute</parameter> :</term>
<listitem><simpara> minute.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>second</parameter> :</term>
<listitem><simpara> second.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-time-config-get-timezone" role="function">
<title>oobs_time_config_get_timezone ()</title>
<indexterm zone="oobs-time-config-get-timezone"><primary>oobs_time_config_get_timezone</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_time_config_get_timezone (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config);</programlisting>
<para>
Returns the timezone set for <link linkend="config"><type>config</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsTimeConfig"><type>OobsTimeConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the timezone as a string or <link linkend="NULL:CAPS"><type>NULL</type></link>.
This string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-time-config-set-timezone" role="function">
<title>oobs_time_config_set_timezone ()</title>
<indexterm zone="oobs-time-config-set-timezone"><primary>oobs_time_config_set_timezone</primary></indexterm><programlisting><link linkend="void">void</link> oobs_time_config_set_timezone (<link linkend="OobsTimeConfig">OobsTimeConfig</link> *config,
const <link linkend="gchar">gchar</link> *timezone);</programlisting>
<para>
Sets the timezone of <link linkend="config"><type>config</type></link> to be <link linkend="timezone"><type>timezone</type></link>,
overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsTimeConfig"><type>OobsTimeConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>timezone</parameter> :</term>
<listitem><simpara> A new timezone for <link linkend="config"><type>config</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsTimeConfig.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsTimeConfig--timezone"><title>The <literal>"timezone"</literal> property</title>
<indexterm zone="OobsTimeConfig--timezone"><primary>OobsTimeConfig:timezone</primary></indexterm><programlisting> "timezone" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Timezone for the computer.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsTimeConfig--unix-time"><title>The <literal>"unix-time"</literal> property</title>
<indexterm zone="OobsTimeConfig--unix-time"><primary>OobsTimeConfig:unix-time</primary></indexterm><programlisting> "unix-time" <link linkend="glong">glong</link> : Read / Write</programlisting>
<para>Current unix time for the computer.</para><para>Allowed values: >= 0</para>
<para>Default value: 0</para>
</refsect2>
</refsect1>
</refentry>
|
