• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright © 2010 Codethink Limited
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
16  *
17  * Author: Ryan Lortie <desrt@desrt.ca>
18  */
19 
20 #ifndef __G_TIME_ZONE_H__
21 #define __G_TIME_ZONE_H__
22 
23 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
24 #error "Only <glib.h> can be included directly."
25 #endif
26 
27 #include <glib/gerror.h>
28 #include <glib/gtypes.h>
29 
30 G_BEGIN_DECLS
31 
32 typedef struct _GTimeZone GTimeZone;
33 
34 /**
35  * GTimeType:
36  * @G_TIME_TYPE_STANDARD: the time is in local standard time
37  * @G_TIME_TYPE_DAYLIGHT: the time is in local daylight time
38  * @G_TIME_TYPE_UNIVERSAL: the time is in UTC
39  *
40  * Disambiguates a given time in two ways.
41  *
42  * First, specifies if the given time is in universal or local time.
43  *
44  * Second, if the time is in local time, specifies if it is local
45  * standard time or local daylight time.  This is important for the case
46  * where the same local time occurs twice (during daylight savings time
47  * transitions, for example).
48  */
49 typedef enum
50 {
51   G_TIME_TYPE_STANDARD,
52   G_TIME_TYPE_DAYLIGHT,
53   G_TIME_TYPE_UNIVERSAL
54 } GTimeType;
55 
56 GLIB_DEPRECATED_IN_2_68_FOR (g_time_zone_new_identifier)
57 GTimeZone *             g_time_zone_new                                 (const gchar *identifier);
58 GLIB_AVAILABLE_IN_2_68
59 GTimeZone *             g_time_zone_new_identifier                      (const gchar *identifier);
60 GLIB_AVAILABLE_IN_ALL
61 GTimeZone *             g_time_zone_new_utc                             (void);
62 GLIB_AVAILABLE_IN_ALL
63 GTimeZone *             g_time_zone_new_local                           (void);
64 GLIB_AVAILABLE_IN_2_58
65 GTimeZone *             g_time_zone_new_offset                          (gint32       seconds);
66 
67 GLIB_AVAILABLE_IN_ALL
68 GTimeZone *             g_time_zone_ref                                 (GTimeZone   *tz);
69 GLIB_AVAILABLE_IN_ALL
70 void                    g_time_zone_unref                               (GTimeZone   *tz);
71 
72 GLIB_AVAILABLE_IN_ALL
73 gint                    g_time_zone_find_interval                       (GTimeZone   *tz,
74                                                                          GTimeType    type,
75                                                                          gint64       time_);
76 
77 GLIB_AVAILABLE_IN_ALL
78 gint                    g_time_zone_adjust_time                         (GTimeZone   *tz,
79                                                                          GTimeType    type,
80                                                                          gint64      *time_);
81 
82 GLIB_AVAILABLE_IN_ALL
83 const gchar *           g_time_zone_get_abbreviation                    (GTimeZone   *tz,
84                                                                          gint         interval);
85 GLIB_AVAILABLE_IN_ALL
86 gint32                  g_time_zone_get_offset                          (GTimeZone   *tz,
87                                                                          gint         interval);
88 GLIB_AVAILABLE_IN_ALL
89 gboolean                g_time_zone_is_dst                              (GTimeZone   *tz,
90                                                                          gint         interval);
91 GLIB_AVAILABLE_IN_2_58
92 const gchar *           g_time_zone_get_identifier                      (GTimeZone   *tz);
93 
94 G_END_DECLS
95 
96 #endif /* __G_TIME_ZONE_H__ */
97