Merge branch 'dev-timer-applet'

Closes #45
https://github.com/mate-desktop/mate-applets/issues/45

5 files changed, 526 insertions, 0 deletions

diff --git a/timerapplet/Makefile.am b/timerapplet/Makefile.am
new file mode 100644
index 00000000..e0af8402
--- /dev/null
+++ b/timerapplet/Makefile.am
@@ -0,0 +1,45 @@
+AM_CPPFLAGS = \
+	$(MATE_APPLETS4_CFLAGS) \
+	$(LIBNOTIFY_CFLAGS) \
+	-I$(srcdir) \
+	-DMATELOCALEDIR=\""$(prefix)/$(DATADIRNAME)/locale"\" \
+	$(DISABLE_DEPRECATED_CFLAGS)
+
+APPLET_LOCATION = $(libexecdir)/timer-applet
+
+libexec_PROGRAMS = timer-applet
+timer_applet_SOURCES = timerapplet.c
+timer_applet_LDADD = $(MATE_APPLETS4_LIBS) $(LIBNOTIFY_LIBS)
+timer_applet_CFLAGS = $(WARN_CFLAGS)
+
+appletsdir       = $(datadir)/mate-panel/applets
+applets_in_files = org.mate.applets.TimerApplet.mate-panel-applet.in
+applets_DATA     = $(applets_in_files:.mate-panel-applet.in=.mate-panel-applet)
+
+$(applets_in_files): $(applets_in_files).in Makefile
+	$(AM_V_GEN)sed \
+		-e "s|\@LOCATION\@|$(APPLET_LOCATION)|" \
+		$< > $@
+%.mate-panel-applet: %.mate-panel-applet.in $(INTLTOOL_MERGE) $(wildcard $(top_srcdir)/po/*po) ; $(INTLTOOL_MERGE) $(top_srcdir)/po $< $@ -d -u -c $(top_builddir)/po/.intltool-merge-cache
+
+servicedir       = $(datadir)/dbus-1/services
+service_in_files = org.mate.panel.applet.TimerAppletFactory.service.in
+service_DATA     = $(service_in_files:.service.in=.service)
+
+org.mate.panel.applet.TimerAppletFactory.service: $(service_in_files)
+	$(AM_V_GEN)sed \
+		-e "s|\@LOCATION\@|$(APPLET_LOCATION)|" \
+		$< > $@
+
+@INTLTOOL_XML_NOMERGE_RULE@
+gsettings_SCHEMAS = org.mate.panel.applet.timer.gschema.xml
+@GSETTINGS_RULES@
+
+%.gschema.xml.in: %.gschema.xml.in.in Makefile
+	$(AM_V_GEN) $(SED) -e 's^\@GETTEXT_PACKAGE\@^$(GETTEXT_PACKAGE)^g' < $< > $@
+
+EXTRA_DIST = \
+	$(applets_in_files) \
+	$(service_in_files) \
+	$(gsettings_SCHEMAS).in.in
+
diff --git a/timerapplet/org.mate.applets.TimerApplet.mate-panel-applet.in.in b/timerapplet/org.mate.applets.TimerApplet.mate-panel-applet.in.in
new file mode 100644
index 00000000..38a23a63
--- /dev/null
+++ b/timerapplet/org.mate.applets.TimerApplet.mate-panel-applet.in.in
@@ -0,0 +1,10 @@
+[Applet Factory]
+Id=TimerAppletFactory
+Location=@LOCATION@
+_Name=Timer Factory
+_Description=Timer Factory
+
+[TimerApplet]
+_Name=Timer
+_Description=Start a timer and receive a notification when it is finished
+Icon=time
diff --git a/timerapplet/org.mate.panel.applet.TimerAppletFactory.service.in b/timerapplet/org.mate.panel.applet.TimerAppletFactory.service.in
new file mode 100644
index 00000000..b8cd68cc
--- /dev/null
+++ b/timerapplet/org.mate.panel.applet.TimerAppletFactory.service.in
@@ -0,0 +1,3 @@
+[D-BUS Service]
+Name=org.mate.panel.applet.TimerAppletFactory
+Exec=@LOCATION@
diff --git a/timerapplet/org.mate.panel.applet.timer.gschema.xml.in.in b/timerapplet/org.mate.panel.applet.timer.gschema.xml.in.in
new file mode 100644
index 00000000..8e2b40b9
--- /dev/null
+++ b/timerapplet/org.mate.panel.applet.timer.gschema.xml.in.in
@@ -0,0 +1,20 @@
+<schemalist gettext-domain="@GETTEXT_PACKAGE@">
+  <schema id="org.mate.panel.applet.timer">
+    <key name="name" type="s">
+      <default>'Timer'</default>
+      <_summary>Name of timer</_summary>
+    </key>
+    <key name="duration" type="i">
+      <default>10</default>
+      <_summary>Duration of timer in seconds</_summary>
+    </key>
+    <key name="show-notification" type="b">
+      <default>true</default>
+      <_summary>Show notification popup when timer finish</_summary>
+    </key>
+    <key name="show-dialog" type="b">
+      <default>false</default>
+      <_summary>Show dialog window when timer finish</_summary>
+    </key>
+  </schema>
+</schemalist>
diff --git a/timerapplet/timerapplet.c b/timerapplet/timerapplet.c
new file mode 100644
index 00000000..8e64c14f
--- /dev/null
+++ b/timerapplet/timerapplet.c
@@ -0,0 +1,448 @@
+/* timerapplet.c:
+ *
+ * Copyright (C) 2014 Stefano Karapetsas
+ *
+ *  This file is part of MATE Applets.
+ *
+ *  MATE Applets is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  MATE Applets is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY 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 MATE Applets.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *      Stefano Karapetsas <[email protected]>
+ */
+
+#include <config.h>
+
+#include <glib.h>
+#include <glib/gi18n.h>
+#include <gio/gio.h>
+#include <gtk/gtk.h>
+
+#include <libnotify/notify.h>
+
+#include <mate-panel-applet.h>
+#include <mate-panel-applet-gsettings.h>
+
+/* Applet constants */
+#define APPLET_ICON  "time"
+#define STEP         100
+
+/* GSettings constants */
+#define TIMER_SCHEMA            "org.mate.panel.applet.timer"
+#define NAME_KEY                "name"
+#define DURATION_KEY            "duration"
+#define SHOW_NOTIFICATION_KEY   "show-notification"
+#define SHOW_DIALOG_KEY         "show-dialog"
+
+typedef struct
+{
+    MatePanelApplet   *applet;
+
+    GSettings         *settings;
+
+    GtkActionGroup    *action_group;
+    GtkLabel          *label;
+    GtkImage          *image;
+    GtkImage          *pause_image;
+    GtkHBox           *hbox;
+
+    GtkSpinButton     *hours;
+    GtkSpinButton     *minutes;
+    GtkSpinButton     *seconds;
+
+    gboolean           active;
+    gboolean           pause;
+    gint               elapsed;
+
+    guint              timeout_id;
+} TimerApplet;
+
+static void timer_start_callback (GtkAction *action, TimerApplet *applet);
+static void timer_pause_callback (GtkAction *action, TimerApplet *applet);
+static void timer_stop_callback (GtkAction *action, TimerApplet *applet);
+static void timer_about_callback (GtkAction *action, TimerApplet *applet);
+static void timer_preferences_callback (GtkAction *action, TimerApplet *applet);
+
+static const GtkActionEntry applet_menu_actions [] = {
+    { "Start", GTK_STOCK_MEDIA_PLAY, N_("_Start timer"), NULL, NULL, G_CALLBACK (timer_start_callback) },
+    { "Pause", GTK_STOCK_MEDIA_PAUSE, N_("P_ause timer"), NULL, NULL, G_CALLBACK (timer_pause_callback) },
+    { "Stop", GTK_STOCK_MEDIA_STOP, N_("S_top timer"), NULL, NULL, G_CALLBACK (timer_stop_callback) },
+    { "Preferences", GTK_STOCK_PROPERTIES, N_("_Preferences"), NULL, NULL, G_CALLBACK (timer_preferences_callback) },
+    { "About", GTK_STOCK_ABOUT, N_("_About"), NULL, NULL, G_CALLBACK (timer_about_callback) }
+};
+
+static char *ui = "<menuitem name='Item 1' action='Start' />"
+                  "<menuitem name='Item 2' action='Pause' />"
+                  "<menuitem name='Item 3' action='Stop' />"
+                  "<menuitem name='Item 4' action='Preferences' />"
+                  "<menuitem name='Item 5' action='About' />";
+
+static void
+timer_applet_destroy (MatePanelApplet *applet_widget, TimerApplet *applet)
+{
+    g_assert (applet);
+
+    if (applet->timeout_id != 0)
+    {
+        g_source_remove(applet->timeout_id);
+        applet->timeout_id = 0;
+    }
+
+    g_object_unref (applet->settings);
+
+    notify_uninit ();
+}
+
+/* timer management */
+static gboolean
+timer_callback (TimerApplet *applet)
+{
+    gboolean retval = TRUE;
+    gchar *label;
+    gchar *name;
+    gchar *tooltip;
+    gint hours, minutes, seconds, duration, remaining;
+
+    label = NULL;
+    name = NULL;
+    tooltip = NULL;
+
+    if (!applet->active)
+    {
+        gtk_label_set_text (applet->label, "");
+        gtk_widget_set_tooltip_text (GTK_WIDGET (applet->label), "");
+        gtk_widget_hide (GTK_WIDGET (applet->pause_image));
+    }
+    else
+    {
+        if (applet->active && !applet->pause)
+            applet->elapsed += STEP;
+
+        duration = g_settings_get_int (applet->settings, DURATION_KEY);
+        name = g_settings_get_string (applet->settings, NAME_KEY);
+
+        remaining = duration - (applet->elapsed / 1000);
+
+        if (remaining <= 0)
+        {
+            applet->active = FALSE;
+            gtk_label_set_text (applet->label, _("Finished"));
+            gtk_widget_set_tooltip_text (GTK_WIDGET (applet->label), name);
+            gtk_widget_hide (GTK_WIDGET (applet->pause_image));
+
+            if (g_settings_get_boolean (applet->settings, SHOW_NOTIFICATION_KEY))
+            {
+                NotifyNotification *n;
+                n = notify_notification_new (name, _("Timer finished!"), "time");
+                notify_notification_set_timeout (n, 30000);
+                notify_notification_show (n, NULL);
+                g_object_unref (G_OBJECT (n));
+            }
+
+            if (g_settings_get_boolean (applet->settings, SHOW_DIALOG_KEY))
+            {
+                GtkWidget *dialog = gtk_message_dialog_new_with_markup (NULL,
+                                                                        GTK_DIALOG_MODAL,
+                                                                        GTK_MESSAGE_INFO,
+                                                                        GTK_BUTTONS_OK,
+                                                                        "<b>%s</b>\n\n%s", name, _("Timer finished!"));
+                gtk_dialog_run (GTK_DIALOG (dialog));
+                gtk_widget_destroy (dialog);
+            }
+
+            /* stop further calls */
+            retval = FALSE;
+        }
+        else
+        {
+            hours = remaining / 60 / 60;
+            minutes = remaining / 60 % 60;
+            seconds = remaining % 60;
+
+            if (hours > 0)
+                label = g_strdup_printf ("%02d:%02d:%02d", hours, minutes, seconds);
+            else
+                label = g_strdup_printf ("%02d:%02d", minutes, seconds);
+
+            hours = duration / 60 / 60;
+            minutes = duration / 60 % 60;
+            seconds = duration % 60;
+
+            if (hours > 0)
+                tooltip = g_strdup_printf ("%s (%02d:%02d:%02d)", name, hours, minutes, seconds);
+            else
+                tooltip = g_strdup_printf ("%s (%02d:%02d)", name, minutes, seconds);
+
+            gtk_label_set_text (applet->label, label);
+            gtk_widget_set_tooltip_text (GTK_WIDGET (applet->label), tooltip);
+            gtk_widget_set_visible (GTK_WIDGET (applet->pause_image), applet->pause);
+        }
+
+        g_free (label);
+        g_free (name);
+        g_free (tooltip);
+    }
+
+    /* update actions sensitiveness */
+    gtk_action_set_sensitive (gtk_action_group_get_action (applet->action_group, "Start"), !applet->active || applet->pause);
+    gtk_action_set_sensitive (gtk_action_group_get_action (applet->action_group, "Pause"), applet->active && !applet->pause);
+    gtk_action_set_sensitive (gtk_action_group_get_action (applet->action_group, "Stop"), applet->active);
+    gtk_action_set_sensitive (gtk_action_group_get_action (applet->action_group, "Preferences"), !applet->active && !applet->pause);
+
+    return retval;
+}
+
+/* start action */
+static void
+timer_start_callback (GtkAction *action, TimerApplet *applet)
+{
+    applet->active = TRUE;
+    if (applet->pause)
+        applet->pause = FALSE;
+    else
+        applet->elapsed = 0;
+    applet->timeout_id = g_timeout_add (STEP, (GSourceFunc) timer_callback, applet);
+}
+
+/* pause action */
+static void
+timer_pause_callback (GtkAction *action, TimerApplet *applet)
+{
+    applet->pause = TRUE;
+    if (applet->timeout_id != 0)
+    {
+        g_source_remove(applet->timeout_id);
+        applet->timeout_id = 0;
+    }
+    timer_callback (applet);
+}
+
+/* stop action */
+static void
+timer_stop_callback (GtkAction *action, TimerApplet *applet)
+{
+    applet->active = FALSE;
+    if (applet->timeout_id != 0)
+    {
+        g_source_remove(applet->timeout_id);
+        applet->timeout_id = 0;
+    }
+    timer_callback (applet);
+}
+
+/* Show the about dialog */
+static void
+timer_about_callback (GtkAction *action, TimerApplet *applet)
+{
+    const char* authors[] = { "Stefano Karapetsas <[email protected]>", NULL };
+
+    gtk_show_about_dialog(NULL,
+                          "version", VERSION,
+                          "copyright", "Copyright © 2014 Stefano Karapetsas",
+                          "authors", authors,
+                          "comments", _("Start a timer and receive a notification when it is finished"),
+                          "translator-credits", _("translator-credits"),
+                          "logo-icon-name", APPLET_ICON,
+                          NULL);
+}
+
+/* calculate duration and save in GSettings */
+static void
+timer_spin_button_value_changed (GtkSpinButton *spinbutton, TimerApplet *applet)
+{
+    gint duration = 0;
+
+    duration += gtk_spin_button_get_value (applet->hours) * 60 * 60;
+    duration += gtk_spin_button_get_value (applet->minutes) * 60;
+    duration += gtk_spin_button_get_value (applet->seconds);
+
+    g_settings_set_int (applet->settings, DURATION_KEY, duration);
+}
+
+/* Show the preferences dialog */
+static void
+timer_preferences_callback (GtkAction *action, TimerApplet *applet)
+{
+    GtkDialog *dialog;
+    GtkTable *table;
+    GtkWidget *widget;
+    gint duration, hours, minutes, seconds;
+
+    duration = g_settings_get_int (applet->settings, DURATION_KEY);
+    hours = duration / 60 / 60;
+    minutes = duration / 60 % 60;
+    seconds = duration % 60;
+
+    dialog = GTK_DIALOG (gtk_dialog_new_with_buttons(_("Timer Applet Preferences"),
+                                                     NULL,
+                                                     GTK_DIALOG_MODAL,
+                                                     GTK_STOCK_CLOSE,
+                                                     GTK_RESPONSE_CLOSE,
+                                                     NULL));
+    table = gtk_table_new (6, 2, FALSE);
+    gtk_table_set_row_spacings (table, 12);
+    gtk_table_set_col_spacings (table, 12);
+
+    gtk_window_set_default_size (GTK_WINDOW (dialog), 350, 150);
+
+    widget = gtk_label_new (_("Name:"));
+    gtk_misc_set_alignment (GTK_MISC (widget), 1.0, 0.5);
+    gtk_table_attach (table, widget, 1, 2, 0, 1,
+                      GTK_FILL, GTK_FILL,
+                      0, 0);
+
+    widget = gtk_entry_new ();
+    gtk_table_attach (table, widget, 2, 3, 0, 1,
+                      GTK_EXPAND | GTK_FILL | GTK_SHRINK, GTK_FILL,
+                      0, 0);
+    g_settings_bind (applet->settings, NAME_KEY, widget, "text", G_SETTINGS_BIND_DEFAULT);
+
+    widget = gtk_label_new (_("Hours:"));
+    gtk_misc_set_alignment (GTK_MISC (widget), 1.0, 0.5);
+    gtk_table_attach (table, widget, 1, 2, 1, 2,
+                      GTK_FILL, GTK_FILL,
+                      0, 0);
+
+    widget = gtk_spin_button_new_with_range (0.0, 100.0, 1.0);
+    gtk_spin_button_set_value (GTK_SPIN_BUTTON (widget), hours);
+    gtk_table_attach (table, widget, 2, 3, 1, 2,
+                      GTK_EXPAND | GTK_FILL | GTK_SHRINK, GTK_FILL,
+                      0, 0);
+    applet->hours = GTK_SPIN_BUTTON (widget);
+    g_signal_connect (widget, "value-changed", G_CALLBACK (timer_spin_button_value_changed), applet);
+
+    widget = gtk_label_new (_("Minutes:"));
+    gtk_misc_set_alignment (GTK_MISC (widget), 1.0, 0.5);
+    gtk_table_attach (table, widget, 1, 2, 2, 3,
+                      GTK_FILL, GTK_FILL,
+                      0, 0);
+
+    widget = gtk_spin_button_new_with_range (0.0, 59.0, 1.0);
+    gtk_spin_button_set_value (GTK_SPIN_BUTTON (widget), minutes);
+    gtk_table_attach (table, widget, 2, 3, 2, 3,
+                      GTK_EXPAND | GTK_FILL | GTK_SHRINK, GTK_FILL,
+                      0, 0);
+    applet->minutes = GTK_SPIN_BUTTON (widget);
+    g_signal_connect (widget, "value-changed", G_CALLBACK (timer_spin_button_value_changed), applet);
+
+    widget = gtk_label_new (_("Seconds:"));
+    gtk_misc_set_alignment (GTK_MISC (widget), 1.0, 0.5);
+    gtk_table_attach (table, widget, 1, 2, 3, 4,
+                      GTK_FILL, GTK_FILL,
+                      0, 0);
+
+    widget = gtk_spin_button_new_with_range (0.0, 59.0, 1.0);
+    gtk_spin_button_set_value (GTK_SPIN_BUTTON (widget), seconds);
+    gtk_table_attach (table, widget, 2, 3, 3, 4,
+                      GTK_EXPAND | GTK_FILL | GTK_SHRINK, GTK_FILL,
+                      0, 0);
+    applet->seconds = GTK_SPIN_BUTTON (widget);
+    g_signal_connect (widget, "value-changed", G_CALLBACK (timer_spin_button_value_changed), applet);
+
+    widget = gtk_check_button_new_with_label (_("Show notification popup"));
+    gtk_table_attach (table, widget, 2, 3, 4, 5,
+                      GTK_EXPAND | GTK_FILL | GTK_SHRINK, GTK_FILL,
+                      0, 0);
+    g_settings_bind (applet->settings, SHOW_NOTIFICATION_KEY, widget, "active", G_SETTINGS_BIND_DEFAULT);
+
+    widget = gtk_check_button_new_with_label (_("Show dialog"));
+    gtk_table_attach (table, widget, 2, 3, 5, 6,
+                      GTK_EXPAND | GTK_FILL | GTK_SHRINK, GTK_FILL,
+                      0, 0);
+    g_settings_bind (applet->settings, SHOW_DIALOG_KEY, widget, "active", G_SETTINGS_BIND_DEFAULT);
+
+    gtk_box_pack_start_defaults (GTK_BOX (dialog->vbox), GTK_WIDGET (table));
+
+    g_signal_connect (dialog, "response", G_CALLBACK (gtk_widget_destroy), dialog);
+
+    gtk_widget_show_all (GTK_WIDGET (dialog));
+}
+
+static gboolean
+timer_applet_fill (MatePanelApplet* applet_widget)
+{
+    TimerApplet *applet;
+
+    g_set_application_name (_("Timer Applet"));
+    gtk_window_set_default_icon_name (APPLET_ICON);
+
+    if (!notify_is_initted ())
+        notify_init ("timer-applet");
+
+    mate_panel_applet_set_flags (applet_widget, MATE_PANEL_APPLET_EXPAND_MINOR);
+    mate_panel_applet_set_background_widget (applet_widget, GTK_WIDGET (applet));
+
+    applet = g_malloc0(sizeof(TimerApplet));
+    applet->applet = applet_widget;
+    applet->settings = mate_panel_applet_settings_new (applet_widget,TIMER_SCHEMA);
+    applet->timeout_id = 0;
+    applet->active = FALSE;
+    applet->pause = FALSE;
+
+    applet->hbox = GTK_HBOX (gtk_hbox_new (FALSE, 0));
+    applet->image = GTK_IMAGE (gtk_image_new_from_icon_name (APPLET_ICON, GTK_ICON_SIZE_BUTTON));
+    applet->pause_image = GTK_IMAGE (gtk_image_new_from_icon_name (GTK_STOCK_MEDIA_PAUSE, GTK_ICON_SIZE_BUTTON));
+    applet->label = GTK_LABEL (gtk_label_new (""));
+
+    /* we add the Gtk label into the applet */
+    gtk_box_pack_start (GTK_BOX (applet->hbox),
+                        GTK_WIDGET (applet->image),
+                        TRUE, TRUE, 0);
+    gtk_box_pack_start (GTK_BOX (applet->hbox),
+                        GTK_WIDGET (applet->pause_image),
+                        TRUE, TRUE, 0);
+    gtk_box_pack_start (GTK_BOX (applet->hbox),
+                        GTK_WIDGET (applet->label),
+                        TRUE, TRUE, 3);
+
+    gtk_container_add (GTK_CONTAINER (applet_widget),
+                       GTK_WIDGET (applet->hbox));
+
+    gtk_widget_show_all (GTK_WIDGET (applet->applet));
+    gtk_widget_hide (GTK_WIDGET (applet->pause_image));
+
+    g_signal_connect(G_OBJECT (applet->applet), "destroy",
+                     G_CALLBACK (timer_applet_destroy),
+                     applet);
+
+    /* set up context menu */
+    applet->action_group = gtk_action_group_new ("Timer Applet Actions");
+    gtk_action_group_set_translation_domain (applet->action_group, GETTEXT_PACKAGE);
+    gtk_action_group_add_actions (applet->action_group, applet_menu_actions,
+                                  G_N_ELEMENTS (applet_menu_actions), applet);
+    mate_panel_applet_setup_menu (applet->applet, ui, applet->action_group);
+
+    /* execute callback to set actions sensitiveness */
+    timer_callback (applet);
+
+    return TRUE;
+}
+
+/* this function, called by mate-panel, will create the applet */
+static gboolean
+timer_factory (MatePanelApplet* applet, const char* iid, gpointer data)
+{
+    gboolean retval = FALSE;
+
+    if (!g_strcmp0 (iid, "TimerApplet"))
+        retval = timer_applet_fill (applet);
+
+    return retval;
+}
+
+/* needed by mate-panel applet library */
+MATE_PANEL_APPLET_OUT_PROCESS_FACTORY("TimerAppletFactory",
+                                      PANEL_TYPE_APPLET,
+                                      "Timer applet",
+                                      timer_factory,
+                                      NULL)