add IdoTimeStampMenuItem, a base class for appointments, locations, and alarms

2 files changed, 325 insertions, 0 deletions

diff --git a/src/idotimestampmenuitem.c b/src/idotimestampmenuitem.c
new file mode 100644
index 0000000..0d33deb
--- /dev/null
+++ b/src/idotimestampmenuitem.c
@@ -0,0 +1,253 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * Authors:
+ *   Charles Kerr <charles.kerr@canonical.com>
+ *   Ted Gould <ted@canonical.com>
+ *
+ * This program is free software: you can redistribute it and/or modify it 
+ * under the terms of the GNU General Public License version 3, as published 
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranties of 
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along 
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifdef HAVE_CONFIG_H
+ #include "config.h"
+#endif
+
+#include <string.h> /* strstr() */
+
+#include <gtk/gtk.h>
+
+#include "idoactionhelper.h"
+#include "idotimestampmenuitem.h"
+
+enum
+{
+  PROP_0,
+  PROP_FORMAT,
+  PROP_DATE_TIME,
+  PROP_LAST
+};
+
+static GParamSpec *properties[PROP_LAST];
+
+struct _IdoTimeStampMenuItemPrivate
+{
+  char * format;
+  GDateTime * date_time;
+};
+
+typedef IdoTimeStampMenuItemPrivate priv_t;
+
+G_DEFINE_TYPE (IdoTimeStampMenuItem,
+               ido_time_stamp_menu_item,
+               IDO_TYPE_BASIC_MENU_ITEM);
+
+/***
+****  GObject Virtual Functions
+***/
+
+static void
+my_get_property (GObject     * o,
+                 guint         property_id,
+                 GValue      * v,
+                 GParamSpec  * pspec)
+{
+  IdoTimeStampMenuItem * self = IDO_TIME_STAMP_MENU_ITEM (o);
+  priv_t * p = self->priv;
+
+  switch (property_id)
+    {
+      case PROP_FORMAT:
+        g_value_set_string (v, p->format);
+        break;
+
+      case PROP_DATE_TIME:
+        g_value_set_boxed (v, p->date_time);
+        break;
+
+      default:
+        G_OBJECT_WARN_INVALID_PROPERTY_ID (o, property_id, pspec);
+        break;
+    }
+}
+
+static void
+my_set_property (GObject       * o,
+                 guint           property_id,
+                 const GValue  * v,
+                 GParamSpec    * pspec)
+{
+  IdoTimeStampMenuItem * self = IDO_TIME_STAMP_MENU_ITEM (o);
+
+  switch (property_id)
+    {
+      case PROP_FORMAT:
+        ido_time_stamp_menu_item_set_format (self, g_value_get_string (v));
+        break;
+
+      case PROP_DATE_TIME:
+        ido_time_stamp_menu_item_set_date_time (self, g_value_get_boxed (v));
+        break;
+
+      default:
+        G_OBJECT_WARN_INVALID_PROPERTY_ID (o, property_id, pspec);
+        break;
+    }
+}
+
+static void
+my_dispose (GObject * object)
+{
+  IdoTimeStampMenuItem * self = IDO_TIME_STAMP_MENU_ITEM (object);
+  priv_t * p = self->priv;
+
+  g_clear_pointer (&p->date_time, g_date_time_unref);
+
+  G_OBJECT_CLASS (ido_time_stamp_menu_item_parent_class)->dispose (object);
+}
+
+static void
+my_finalize (GObject * object)
+{
+  IdoTimeStampMenuItem * self = IDO_TIME_STAMP_MENU_ITEM (object);
+  priv_t * p = self->priv;
+
+  g_free (p->format);
+
+  G_OBJECT_CLASS (ido_time_stamp_menu_item_parent_class)->finalize (object);
+}
+
+/***
+****  Instantiation
+***/
+
+static void
+ido_time_stamp_menu_item_class_init (IdoTimeStampMenuItemClass *klass)
+{
+  GParamFlags prop_flags;
+  GObjectClass * gobject_class = G_OBJECT_CLASS (klass);
+
+  g_type_class_add_private (klass, sizeof (IdoTimeStampMenuItemPrivate));
+
+  gobject_class->get_property = my_get_property;
+  gobject_class->set_property = my_set_property;
+  gobject_class->dispose = my_dispose;
+  gobject_class->finalize = my_finalize;
+
+  prop_flags = G_PARAM_CONSTRUCT
+             | G_PARAM_READWRITE
+             | G_PARAM_STATIC_STRINGS;
+
+  properties[PROP_FORMAT] = g_param_spec_string (
+    "format",
+    "strftime format",
+    "strftime-style format string for the timestamp",
+    "%F %T",
+    prop_flags);
+
+  properties[PROP_DATE_TIME] = g_param_spec_boxed (
+    "date-time",
+    "Date-Time",
+    "GDateTime specifying the time to render",
+    G_TYPE_DATE_TIME,
+    prop_flags);
+
+  g_object_class_install_properties (gobject_class, PROP_LAST, properties);
+}
+
+static void
+ido_time_stamp_menu_item_init (IdoTimeStampMenuItem *self)
+{
+  self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
+                                            IDO_TYPE_TIME_STAMP_MENU_ITEM,
+                                            IdoTimeStampMenuItemPrivate);
+
+}
+
+static void
+update_timestamp_label (IdoTimeStampMenuItem * self)
+{
+  char * str;
+  priv_t * p = self->priv;
+
+  if (p->date_time && p->format)
+    str = g_date_time_format (p->date_time, p->format);
+  else
+    str = NULL;
+
+  ido_basic_menu_item_set_secondary_text (IDO_BASIC_MENU_ITEM (self), str);
+  g_free (str);
+}
+
+/***
+****  Public API
+***/
+
+/* create  a new IdoTimeStampMenuItem */
+GtkWidget *
+ido_time_stamp_menu_item_new (void)
+{
+  return GTK_WIDGET (g_object_new (IDO_TYPE_TIME_STAMP_MENU_ITEM, NULL));
+}
+
+/**
+ * ido_time_stamp_menu_item_set_time:
+ * @time: the time to be rendered in the appointment's timestamp label.
+ *
+ * Set the time that will be displayed in the menuitem's
+ * right-justified timestamp label
+ */
+void
+ido_time_stamp_menu_item_set_date_time (IdoTimeStampMenuItem * self,
+                                        GDateTime            * date_time)
+{
+  priv_t * p;
+
+  g_return_if_fail (IDO_IS_TIME_STAMP_MENU_ITEM (self));
+  p = self->priv;
+
+  g_clear_pointer (&p->date_time, g_date_time_unref);
+  if (date_time != NULL)
+    p->date_time = g_date_time_ref (date_time);
+  update_timestamp_label (self);
+}
+
+/**
+ * ido_time_stamp_menu_item_set_format:
+ * @format: the format string used when showing the appointment's time
+ *
+ * Set the format string for rendering the appointment's time
+ * in its right-justified secondary label.
+ *
+ * See strfrtime(3) for more information on the format string.
+ */
+void
+ido_time_stamp_menu_item_set_format (IdoTimeStampMenuItem * self,
+                                     const char           * strftime_fmt)
+{
+  priv_t * p;
+
+  g_return_if_fail (IDO_IS_TIME_STAMP_MENU_ITEM (self));
+  p = self->priv;
+
+  g_free (p->format);
+  p->format = g_strdup (strftime_fmt);
+  update_timestamp_label (self);
+}
+
+const gchar *
+ido_time_stamp_menu_item_get_format (IdoTimeStampMenuItem * self)
+{
+  g_return_val_if_fail (IDO_IS_TIME_STAMP_MENU_ITEM (self), NULL);
+
+  return self->priv->format;
+}
diff --git a/src/idotimestampmenuitem.h b/src/idotimestampmenuitem.h
new file mode 100644
index 0000000..5847ba8
--- /dev/null
+++ b/src/idotimestampmenuitem.h
@@ -0,0 +1,72 @@
+/**
+ * Copyright 2013 Canonical Ltd.
+ *
+ * Authors:
+ *   Charles Kerr <charles.kerr@canonical.com>
+ *
+ * This program is free software: you can redistribute it and/or modify it 
+ * under the terms of the GNU General Public License version 3, as published 
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranties of 
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along 
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __IDO_TIME_STAMP_MENU_ITEM_H__
+#define __IDO_TIME_STAMP_MENU_ITEM_H__
+
+#include <gtk/gtk.h>
+#include "idobasicmenuitem.h"
+
+G_BEGIN_DECLS
+
+#define IDO_TYPE_TIME_STAMP_MENU_ITEM    (ido_time_stamp_menu_item_get_type ())
+#define IDO_TIME_STAMP_MENU_ITEM(obj)    (G_TYPE_CHECK_INSTANCE_CAST ((obj), IDO_TYPE_TIME_STAMP_MENU_ITEM, IdoTimeStampMenuItem))
+#define IDO_IS_TIME_STAMP_MENU_ITEM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), IDO_TYPE_TIME_STAMP_MENU_ITEM))
+
+typedef struct _IdoTimeStampMenuItem        IdoTimeStampMenuItem;
+typedef struct _IdoTimeStampMenuItemClass   IdoTimeStampMenuItemClass;
+typedef struct _IdoTimeStampMenuItemPrivate IdoTimeStampMenuItemPrivate;
+
+struct _IdoTimeStampMenuItemClass
+{
+  IdoBasicMenuItemClass parent_class;
+};
+
+/**
+ * A menuitem that contains a left-aligned optional icon and label
+ * and a right-aligned secondary label showing the specified time
+ * in the specified format.
+ *
+ * Used by IdoLocationMenuItem, IdoAppointmentMenuItem, and IdoAlarmMenuItem.
+ */
+struct _IdoTimeStampMenuItem
+{
+  /*< private >*/
+  IdoBasicMenuItem parent;
+  IdoTimeStampMenuItemPrivate * priv;
+};
+
+
+GType        ido_time_stamp_menu_item_get_type      (void) G_GNUC_CONST;
+
+GtkWidget  * ido_time_stamp_menu_item_new           (void);
+
+void         ido_time_stamp_menu_item_set_date_time (IdoTimeStampMenuItem * menuitem,
+                                                     GDateTime            * date_time);
+
+void         ido_time_stamp_menu_item_set_format    (IdoTimeStampMenuItem * menuitem,
+                                                     const char           * strftime_fmt);
+
+const char * ido_time_stamp_menu_item_get_format    (IdoTimeStampMenuItem * menuitem);
+
+
+
+G_END_DECLS
+
+#endif