glib/gtimezone.h

   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/gtypes.h>
  28
  29 G_BEGIN_DECLS
  30
  31 typedef struct _GTimeZone GTimeZone;
  32
  33 /**
  34  * GTimeType:
  35  * @G_TIME_TYPE_STANDARD: the time is in local standard time
  36  * @G_TIME_TYPE_DAYLIGHT: the time is in local daylight time
  37  * @G_TIME_TYPE_UNIVERSAL: the time is in UTC
  38  *
  39  * Disambiguates a given time in two ways.
  40  *
  41  * First, specifies if the given time is in universal or local time.
  42  *
  43  * Second, if the time is in local time, specifies if it is local
  44  * standard time or local daylight time.  This is important for the case
  45  * where the same local time occurs twice (during daylight savings time
  46  * transitions, for example).
  47  */
  48 typedef enum
  49 {
  50   G_TIME_TYPE_STANDARD,
  51   G_TIME_TYPE_DAYLIGHT,
  52   G_TIME_TYPE_UNIVERSAL
  53 } GTimeType;
  54
  55 GLIB_AVAILABLE_IN_ALL
  56 GTimeZone *             g_time_zone_new                                 (const gchar *identifier);
  57 GLIB_AVAILABLE_IN_ALL
  58 GTimeZone *             g_time_zone_new_utc                             (void);
  59 GLIB_AVAILABLE_IN_ALL
  60 GTimeZone *             g_time_zone_new_local                           (void);
  61 GLIB_AVAILABLE_IN_2_58
  62 GTimeZone *             g_time_zone_new_offset                          (gint32       seconds);
  63
  64 GLIB_AVAILABLE_IN_ALL
  65 GTimeZone *             g_time_zone_ref                                 (GTimeZone   *tz);
  66 GLIB_AVAILABLE_IN_ALL
  67 void                    g_time_zone_unref                               (GTimeZone   *tz);
  68
  69 GLIB_AVAILABLE_IN_ALL
  70 gint                    g_time_zone_find_interval                       (GTimeZone   *tz,
  71                                                                          GTimeType    type,
  72                                                                          gint64       time_);
  73
  74 GLIB_AVAILABLE_IN_ALL
  75 gint                    g_time_zone_adjust_time                         (GTimeZone   *tz,
  76                                                                          GTimeType    type,
  77                                                                          gint64      *time_);
  78
  79 GLIB_AVAILABLE_IN_ALL
  80 const gchar *           g_time_zone_get_abbreviation                    (GTimeZone   *tz,
  81                                                                          gint         interval);
  82 GLIB_AVAILABLE_IN_ALL
  83 gint32                  g_time_zone_get_offset                          (GTimeZone   *tz,
  84                                                                          gint         interval);
  85 GLIB_AVAILABLE_IN_ALL
  86 gboolean                g_time_zone_is_dst                              (GTimeZone   *tz,
  87                                                                          gint         interval);
  88 GLIB_AVAILABLE_IN_2_58
  89 const gchar *           g_time_zone_get_identifier                      (GTimeZone   *tz);
  90
  91 G_END_DECLS
  92
  93 #endif /* __G_TIME_ZONE_H__ */