← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-updates

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/html/libedataserver-e-time-utils.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-09-07 15:43:29 UTC
  • mfrom: (1.1.73 upstream)
  • Revision ID: james.westby@ubuntu.com-20090907154329-ig45a78mkhotc4af
Tags: 2.27.92-0ubuntu1
* New upstream version
  Bug Fixes:
  Mailer:
  - #350007 - evolution busy-waits on GPG signing operations 
  - #578910 - Fixes problem of missing migration for left out folders
  Other Fixes:
  Show filename in password file load/save warnings 
  Paste of e-mail always goes to the left most position 
  Expand <group> inline adds control codes 
  vee_rebuild_folder
* debian/patches/11_it_translation.patch:
  - don't use this debian change, the translation changed and those issues
    should be fixed upstream or in rosetta but not in source changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/html/libedataserver-e-time-utils.html
41
41
<a name="libedataserver-e-time-utils.synopsis"></a><h2>Synopsis</h2>
42
42
<pre class="synopsis">
43
43
enum                <a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>;
44
 
<a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    <a class="link" href="libedataserver-e-time-utils.html#e-time-parse-date-and-time" title="e_time_parse_date_and_time ()">e_time_parse_date_and_time</a>          (const <a
45
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
46
 
>gchar</a> *value,
47
 
                                                         struct tm *result);
48
 
<a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    <a class="link" href="libedataserver-e-time-utils.html#e-time-parse-date" title="e_time_parse_date ()">e_time_parse_date</a>                   (const <a
49
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
50
 
>gchar</a> *value,
51
 
                                                         struct tm *result);
52
 
<a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    <a class="link" href="libedataserver-e-time-utils.html#e-time-parse-date-and-time-ex" title="e_time_parse_date_and_time_ex ()">e_time_parse_date_and_time_ex</a>       (const <a
53
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
54
 
>gchar</a> *value,
55
 
                                                         struct tm *result,
56
 
                                                         <a
57
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
58
 
>gboolean</a> *two_digit_year);
59
 
<a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    <a class="link" href="libedataserver-e-time-utils.html#e-time-parse-date-ex" title="e_time_parse_date_ex ()">e_time_parse_date_ex</a>                (const <a
60
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
61
 
>gchar</a> *value,
62
 
                                                         struct tm *result,
63
 
                                                         <a
64
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
65
 
>gboolean</a> *two_digit_year);
66
 
<a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    <a class="link" href="libedataserver-e-time-utils.html#e-time-parse-time" title="e_time_parse_time ()">e_time_parse_time</a>                   (const <a
67
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
68
 
>gchar</a> *value,
 
44
<a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    <a class="link" href="libedataserver-e-time-utils.html#e-time-parse-date-and-time" title="e_time_parse_date_and_time ()">e_time_parse_date_and_time</a>          (const gchar *value,
 
45
                                                         struct tm *result);
 
46
<a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    <a class="link" href="libedataserver-e-time-utils.html#e-time-parse-date" title="e_time_parse_date ()">e_time_parse_date</a>                   (const gchar *value,
 
47
                                                         struct tm *result);
 
48
<a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    <a class="link" href="libedataserver-e-time-utils.html#e-time-parse-date-and-time-ex" title="e_time_parse_date_and_time_ex ()">e_time_parse_date_and_time_ex</a>       (const gchar *value,
 
49
                                                         struct tm *result,
 
50
                                                         gboolean *two_digit_year);
 
51
<a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    <a class="link" href="libedataserver-e-time-utils.html#e-time-parse-date-ex" title="e_time_parse_date_ex ()">e_time_parse_date_ex</a>                (const gchar *value,
 
52
                                                         struct tm *result,
 
53
                                                         gboolean *two_digit_year);
 
54
<a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    <a class="link" href="libedataserver-e-time-utils.html#e-time-parse-time" title="e_time_parse_time ()">e_time_parse_time</a>                   (const gchar *value,
69
55
                                                         struct tm *result);
70
56
void                <a class="link" href="libedataserver-e-time-utils.html#e-time-format-date-and-time" title="e_time_format_date_and_time ()">e_time_format_date_and_time</a>         (struct tm *date_tm,
71
 
                                                         <a
72
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
73
 
>gboolean</a> use_24_hour_format,
74
 
                                                         <a
75
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
76
 
>gboolean</a> show_midnight,
77
 
                                                         <a
78
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
79
 
>gboolean</a> show_zero_seconds,
80
 
                                                         <a
81
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
82
 
>gchar</a> *buffer,
83
 
                                                         <a
84
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
85
 
>gint</a> buffer_size);
 
57
                                                         gboolean use_24_hour_format,
 
58
                                                         gboolean show_midnight,
 
59
                                                         gboolean show_zero_seconds,
 
60
                                                         gchar *buffer,
 
61
                                                         gint buffer_size);
86
62
void                <a class="link" href="libedataserver-e-time-utils.html#e-time-format-time" title="e_time_format_time ()">e_time_format_time</a>                  (struct tm *date_tm,
87
 
                                                         <a
88
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
89
 
>gboolean</a> use_24_hour_format,
90
 
                                                         <a
91
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
92
 
>gboolean</a> show_zero_seconds,
93
 
                                                         <a
94
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
95
 
>gchar</a> *buffer,
96
 
                                                         <a
97
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
98
 
>gint</a> buffer_size);
 
63
                                                         gboolean use_24_hour_format,
 
64
                                                         gboolean show_zero_seconds,
 
65
                                                         gchar *buffer,
 
66
                                                         gint buffer_size);
99
67
time_t              <a class="link" href="libedataserver-e-time-utils.html#e-mktime-utc" title="e_mktime_utc ()">e_mktime_utc</a>                        (struct tm *tm);
100
68
void                <a class="link" href="libedataserver-e-time-utils.html#e-localtime-with-offset" title="e_localtime_with_offset ()">e_localtime_with_offset</a>             (time_t tt,
101
69
                                                         struct tm *tm,
102
 
                                                         <a
103
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
104
 
>gint</a> *offset);
105
 
<a
106
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
107
 
>gchar</a> *             <a class="link" href="libedataserver-e-time-utils.html#e-time-get-d-fmt-with-4digit-year" title="e_time_get_d_fmt_with_4digit_year ()">e_time_get_d_fmt_with_4digit_year</a>   (void);
 
70
                                                         gint *offset);
 
71
gchar *             <a class="link" href="libedataserver-e-time-utils.html#e-time-get-d-fmt-with-4digit-year" title="e_time_get_d_fmt_with_4digit_year ()">e_time_get_d_fmt_with_4digit_year</a>   (void);
108
72
</pre>
109
73
</div>
110
74
<div class="refsect1" lang="en">
150
114
<hr>
151
115
<div class="refsect2" lang="en">
152
116
<a name="e-time-parse-date-and-time"></a><h3>e_time_parse_date_and_time ()</h3>
153
 
<pre class="programlisting"><a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    e_time_parse_date_and_time          (const <a
154
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
155
 
>gchar</a> *value,
 
117
<pre class="programlisting"><a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    e_time_parse_date_and_time          (const gchar *value,
156
118
                                                         struct tm *result);</pre>
157
119
<p>
158
120
</p>
180
142
<hr>
181
143
<div class="refsect2" lang="en">
182
144
<a name="e-time-parse-date"></a><h3>e_time_parse_date ()</h3>
183
 
<pre class="programlisting"><a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    e_time_parse_date                   (const <a
184
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
185
 
>gchar</a> *value,
 
145
<pre class="programlisting"><a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    e_time_parse_date                   (const gchar *value,
186
146
                                                         struct tm *result);</pre>
187
147
<p>
188
148
</p>
210
170
<hr>
211
171
<div class="refsect2" lang="en">
212
172
<a name="e-time-parse-date-and-time-ex"></a><h3>e_time_parse_date_and_time_ex ()</h3>
213
 
<pre class="programlisting"><a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    e_time_parse_date_and_time_ex       (const <a
214
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
215
 
>gchar</a> *value,
 
173
<pre class="programlisting"><a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    e_time_parse_date_and_time_ex       (const gchar *value,
216
174
                                                         struct tm *result,
217
 
                                                         <a
218
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
219
 
>gboolean</a> *two_digit_year);</pre>
 
175
                                                         gboolean *two_digit_year);</pre>
220
176
<p>
221
177
Parses a string <em class="parameter"><code>value</code></em> containing a date and a time and stores the
222
178
result in <em class="parameter"><code>result</code></em>. The date in <em class="parameter"><code>value</code></em> is expected to be in a format
223
 
like "Wed 3/13/00 14:20:00", though <a
224
 
href="/usr/share/gtk-doc/html/camel/camel-camel-i18n.html#gettext"
225
 
><code class="function">gettext()</code></a> is used to support the
 
179
like "Wed 3/13/00 14:20:00", though <code class="function">gettext()</code> is used to support the
226
180
appropriate local formats. There is also some leniency on the
227
181
format of the string, e.g. the weekday can be skipped or 12-hour
228
182
formats with am/pm can be used.</p>
260
214
<hr>
261
215
<div class="refsect2" lang="en">
262
216
<a name="e-time-parse-date-ex"></a><h3>e_time_parse_date_ex ()</h3>
263
 
<pre class="programlisting"><a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    e_time_parse_date_ex                (const <a
264
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
265
 
>gchar</a> *value,
 
217
<pre class="programlisting"><a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    e_time_parse_date_ex                (const gchar *value,
266
218
                                                         struct tm *result,
267
 
                                                         <a
268
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
269
 
>gboolean</a> *two_digit_year);</pre>
 
219
                                                         gboolean *two_digit_year);</pre>
270
220
<p>
271
221
Takes in a date string entered by the user and tries to convert it to
272
222
a struct <a class="link" href="libedataserver-e-util.html#tm" title="struct tm"><span class="type">tm</span></a>.</p>
303
253
<hr>
304
254
<div class="refsect2" lang="en">
305
255
<a name="e-time-parse-time"></a><h3>e_time_parse_time ()</h3>
306
 
<pre class="programlisting"><a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    e_time_parse_time                   (const <a
307
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
308
 
>gchar</a> *value,
 
256
<pre class="programlisting"><a class="link" href="libedataserver-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a>    e_time_parse_time                   (const gchar *value,
309
257
                                                         struct tm *result);</pre>
310
258
<p>
311
259
Parses <em class="parameter"><code>value</code></em>, a string containing a time. <em class="parameter"><code>value</code></em> is expected to be
312
 
in a format like "14:20:00". <a
313
 
href="/usr/share/gtk-doc/html/camel/camel-camel-i18n.html#gettext"
314
 
><code class="function">gettext()</code></a> is used to
 
260
in a format like "14:20:00". <code class="function">gettext()</code> is used to
315
261
support the appropriate local formats and slightly
316
262
different formats, such as 12-hour formats with am/pm,
317
263
are accepted as well.</p>
343
289
<div class="refsect2" lang="en">
344
290
<a name="e-time-format-date-and-time"></a><h3>e_time_format_date_and_time ()</h3>
345
291
<pre class="programlisting">void                e_time_format_date_and_time         (struct tm *date_tm,
346
 
                                                         <a
347
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
348
 
>gboolean</a> use_24_hour_format,
349
 
                                                         <a
350
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
351
 
>gboolean</a> show_midnight,
352
 
                                                         <a
353
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
354
 
>gboolean</a> show_zero_seconds,
355
 
                                                         <a
356
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
357
 
>gchar</a> *buffer,
358
 
                                                         <a
359
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
360
 
>gint</a> buffer_size);</pre>
 
292
                                                         gboolean use_24_hour_format,
 
293
                                                         gboolean show_midnight,
 
294
                                                         gboolean show_zero_seconds,
 
295
                                                         gchar *buffer,
 
296
                                                         gint buffer_size);</pre>
361
297
<p>
362
298
Creates a string representation of the time value <em class="parameter"><code>date_tm</code></em> and
363
299
stores it in <em class="parameter"><code>buffer</code></em>.  <em class="parameter"><code>buffer_size</code></em> should be at least 64 to be
364
 
safe. If <em class="parameter"><code>show_midnight</code></em> is <a
365
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
366
 
><span class="type">FALSE</span></a>, and the time is midnight, then
 
300
safe. If <em class="parameter"><code>show_midnight</code></em> is <span class="type">FALSE</span>, and the time is midnight, then
367
301
only the date is stored in <em class="parameter"><code>buffer</code></em>. If <em class="parameter"><code>show_zero_seconds</code></em> is
368
 
<a
369
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE--CAPS"
370
 
><span class="type">FALSE</span></a>, then if the time has zero seconds only the hour and minute
 
302
<span class="type">FALSE</span>, then if the time has zero seconds only the hour and minute
371
303
of the time are stored in <em class="parameter"><code>buffer</code></em>.</p>
372
304
<p>
373
305
</p>
381
313
</tr>
382
314
<tr>
383
315
<td><p><span class="term"><em class="parameter"><code>use_24_hour_format</code></em> :</span></p></td>
384
 
<td> A <a
385
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
386
 
><span class="type">gboolean</span></a>.
 
316
<td> A <span class="type">gboolean</span>.
387
317
</td>
388
318
</tr>
389
319
<tr>
390
320
<td><p><span class="term"><em class="parameter"><code>show_midnight</code></em> :</span></p></td>
391
 
<td> A <a
392
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
393
 
><span class="type">gboolean</span></a>.
 
321
<td> A <span class="type">gboolean</span>.
394
322
</td>
395
323
</tr>
396
324
<tr>
397
325
<td><p><span class="term"><em class="parameter"><code>show_zero_seconds</code></em> :</span></p></td>
398
 
<td> A <a
399
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
400
 
><span class="type">gboolean</span></a>.
 
326
<td> A <span class="type">gboolean</span>.
401
327
</td>
402
328
</tr>
403
329
<tr>
417
343
<div class="refsect2" lang="en">
418
344
<a name="e-time-format-time"></a><h3>e_time_format_time ()</h3>
419
345
<pre class="programlisting">void                e_time_format_time                  (struct tm *date_tm,
420
 
                                                         <a
421
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
422
 
>gboolean</a> use_24_hour_format,
423
 
                                                         <a
424
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
425
 
>gboolean</a> show_zero_seconds,
426
 
                                                         <a
427
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
428
 
>gchar</a> *buffer,
429
 
                                                         <a
430
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
431
 
>gint</a> buffer_size);</pre>
 
346
                                                         gboolean use_24_hour_format,
 
347
                                                         gboolean show_zero_seconds,
 
348
                                                         gchar *buffer,
 
349
                                                         gint buffer_size);</pre>
432
350
<p>
433
351
Creates a string representation of a time value in <em class="parameter"><code>date_tm</code></em> and
434
352
stores it in <em class="parameter"><code>buffer</code></em>. <em class="parameter"><code>buffer_size</code></em> should be at least 64.</p>
444
362
</tr>
445
363
<tr>
446
364
<td><p><span class="term"><em class="parameter"><code>use_24_hour_format</code></em> :</span></p></td>
447
 
<td> A <a
448
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
449
 
><span class="type">gboolean</span></a>.
 
365
<td> A <span class="type">gboolean</span>.
450
366
</td>
451
367
</tr>
452
368
<tr>
453
369
<td><p><span class="term"><em class="parameter"><code>show_zero_seconds</code></em> :</span></p></td>
454
 
<td> A <a
455
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
456
 
><span class="type">gboolean</span></a>.
 
370
<td> A <span class="type">gboolean</span>.
457
371
</td>
458
372
</tr>
459
373
<tr>
498
412
<a name="e-localtime-with-offset"></a><h3>e_localtime_with_offset ()</h3>
499
413
<pre class="programlisting">void                e_localtime_with_offset             (time_t tt,
500
414
                                                         struct tm *tm,
501
 
                                                         <a
502
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
503
 
>gint</a> *offset);</pre>
 
415
                                                         gint *offset);</pre>
504
416
<p>
505
417
Converts the calendar time time representation <em class="parameter"><code>tt</code></em> to a broken-down
506
418
time representation, store in <em class="parameter"><code>tm</code></em>, and provides the offset in
531
443
<hr>
532
444
<div class="refsect2" lang="en">
533
445
<a name="e-time-get-d-fmt-with-4digit-year"></a><h3>e_time_get_d_fmt_with_4digit_year ()</h3>
534
 
<pre class="programlisting"><a
535
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
536
 
>gchar</a> *             e_time_get_d_fmt_with_4digit_year   (void);</pre>
 
446
<pre class="programlisting">gchar *             e_time_get_d_fmt_with_4digit_year   (void);</pre>
537
447
<p>
538
448
</p>
539
449
<div class="variablelist"><table border="0">