git.maemo.org Git - modest/blob - src/modest-datetime-formatter.h

   1 /* Copyright (c) 2008, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30
  31 /* modest-text-utils.h */
  32
  33 #ifndef __MODEST_DATETIME_FORMATTER_H__
  34 #define __MODEST_DATETIME_FORMATTER_H__
  35
  36 #include <glib-object.h>
  37 #include <time.h>
  38 G_BEGIN_DECLS
  39
  40 /* convenience macros */
  41 #define MODEST_TYPE_DATETIME_FORMATTER             (modest_datetime_formatter_get_type())
  42 #define MODEST_DATETIME_FORMATTER(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_DATETIME_FORMATTER,ModestDatetimeFormatter))
  43 #define MODEST_DATETIME_FORMATTER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_DATETIME_FORMATTER,ModestDatetimeFormatterClass))
  44 #define MODEST_IS_DATETIME_FORMATTER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_DATETIME_FORMATTER))
  45 #define MODEST_IS_DATETIME_FORMATTER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_DATETIME_FORMATTER))
  46 #define MODEST_DATETIME_FORMATTER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_DATETIME_FORMATTER,ModestDatetimeFormatterClass))
  47
  48 typedef struct _ModestDatetimeFormatter      ModestDatetimeFormatter;
  49 typedef struct _ModestDatetimeFormatterClass ModestDatetimeFormatterClass;
  50
  51 struct _ModestDatetimeFormatter {
  52         GObject parent;
  53 };
  54
  55 struct _ModestDatetimeFormatterClass {
  56         GObjectClass parent_class;
  57
  58         /* signals */
  59         void (*format_changed) (ModestDatetimeFormatter *self,
  60                                 gpointer userdata);
  61 };
  62
  63 /**
  64  * modest_datetime_formatter_get_type:
  65  *
  66  * Returns: GType of the datetime formatter
  67  */
  68 GType  modest_datetime_formatter_get_type   (void) G_GNUC_CONST;
  69
  70 ModestDatetimeFormatter *modest_datetime_formatter_new ();
  71
  72 const gchar *modest_datetime_formatter_format_date (ModestDatetimeFormatter *self,
  73                                                     time_t date);
  74 const gchar *modest_datetime_formatter_format_time (ModestDatetimeFormatter *self,
  75                                                     time_t date);
  76 const gchar *modest_datetime_formatter_display_datetime (ModestDatetimeFormatter *self,
  77                                                          time_t date);
  78 const gchar *modest_datetime_formatter_display_long_datetime (ModestDatetimeFormatter *self,
  79                                                               time_t date);
  80 G_END_DECLS
  81
  82 #endif