GTimeZoneMonitor: Revert addition of this class
[platform/upstream/glib.git] / glib / gtimezone.h
1 /*
2  * Copyright © 2010 Codethink Limited
3  *
4  * This library is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * licence, 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, write to the Free Software
16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
17  * USA.
18  *
19  * Author: Ryan Lortie <desrt@desrt.ca>
20  */
21
22 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
23 #error "Only <glib.h> can be included directly."
24 #endif
25
26 #ifndef __G_TIME_ZONE_H__
27 #define __G_TIME_ZONE_H__
28
29 #include <glib/gtypes.h>
30
31 G_BEGIN_DECLS
32
33 typedef struct _GTimeZone GTimeZone;
34
35 /**
36  * GTimeType:
37  * @G_TIME_TYPE_STANDARD: the time is in local standard time
38  * @G_TIME_TYPE_DAYLIGHT: the time is in local daylight time
39  * @G_TIME_TYPE_UNIVERSAL: the time is in UTC
40  *
41  * Disambiguates a given time in two ways.
42  *
43  * First, specifies if the given time is in universal or local time.
44  *
45  * Second, if the time is in local time, specifies if it is local
46  * standard time or local daylight time.  This is important for the case
47  * where the same local time occurs twice (during daylight savings time
48  * transitions, for example).
49  */
50 typedef enum
51 {
52   G_TIME_TYPE_STANDARD,
53   G_TIME_TYPE_DAYLIGHT,
54   G_TIME_TYPE_UNIVERSAL
55 } GTimeType;
56
57 GTimeZone *             g_time_zone_new                                 (const gchar *identifier);
58 GTimeZone *             g_time_zone_new_utc                             (void);
59 GTimeZone *             g_time_zone_new_local                           (void);
60
61 GTimeZone *             g_time_zone_ref                                 (GTimeZone   *tz);
62 void                    g_time_zone_unref                               (GTimeZone   *tz);
63
64 gint                    g_time_zone_find_interval                       (GTimeZone   *tz,
65                                                                          GTimeType    type,
66                                                                          gint64       time_);
67
68 gint                    g_time_zone_adjust_time                         (GTimeZone   *tz,
69                                                                          GTimeType    type,
70                                                                          gint64      *time_);
71
72 const gchar *           g_time_zone_get_abbreviation                    (GTimeZone   *tz,
73                                                                          gint         interval);
74 gint32                  g_time_zone_get_offset                          (GTimeZone   *tz,
75                                                                          gint         interval);
76 gboolean                g_time_zone_is_dst                              (GTimeZone   *tz,
77                                                                          gint         interval);
78
79 G_END_DECLS
80
81 #endif /* __G_TIME_ZONE_H__ */