Merge lp:~facundo/magicicada-gui/icon-ftw into lp:magicicada-gui

[Facundo Batista]

Put an icon in the systray.

Put an icon in the systray.

This icon shows the options to show/hide, about, and exit the application.

Tests adjusted.

[Natalia Bidart (nataliabidart)]

Looks good!

review: Approve

=== modified file 'AUTHORS'
--- AUTHORS	2011-09-30 15:58:24 +0000
+++ AUTHORS	2014-01-05 05:47:45 +0000
@@ -1,2 +1,2 @@
-Copyright (C) 2010 Natalia Bidart <[e-mail]>
-Copyright (C) 2010 Facundo Batista <[e-mail]>
+Copyright (C) 2010-2014 Natalia Bidart <[e-mail]>
+Copyright (C) 2010-2014 Facundo Batista <[e-mail]>
 
=== modified file 'data/ui/main.ui'
--- data/ui/main.ui	2012-08-21 20:10:09 +0000
+++ data/ui/main.ui	2014-01-05 05:47:45 +0000
@@ -6,9 +6,9 @@
     <property name="border_width">5</property>
     <property name="type_hint">normal</property>
     <property name="program_name">Magicicada</property>
-    <property name="copyright" translatable="yes">Copyright 2010 Chicharreros
-Copyright 2010 Natalia Bidart &lt;[e-mail]&gt;
-Copyright 2010 Facundo Batista &lt;[e-mail]&gt;</property>
+    <property name="copyright" translatable="yes">Copyright 2010-2014 Chicharreros
+Copyright 2010-2014 Natalia Bidart &lt;[e-mail]&gt;
+Copyright 2010-2014 Facundo Batista &lt;[e-mail]&gt;</property>
     <property name="website">http://launchpad.net/magicicada</property>
     <property name="license" translatable="yes">GNU General Public License
 
@@ -127,10 +127,4 @@
       </object>
     </child>
   </object>
-  <object class="GtkStatusIcon" id="status_icon">
-    <property name="has_tooltip">True</property>
-    <property name="tooltip_text">Magicicada</property>
-    <property name="title">Magicicada</property>
-    <signal name="activate" handler="on_status_icon_activate" swapped="no"/>
-  </object>
 </interface>
 
=== modified file 'magicicada/gui/gtk/main.py'
--- magicicada/gui/gtk/main.py	2012-11-29 17:49:29 +0000
+++ magicicada/gui/gtk/main.py	2014-01-05 05:47:45 +0000
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2010-2012 Chicharreros
+# Copyright 2010-2014 Chicharreros
 #
 # 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
@@ -16,12 +16,13 @@
 
 """Magicicada GTK UI."""
 
-import sys
 import gettext
 import logging
+import os
+import sys
 
 # pylint: disable=E0611
-from gi.repository import GdkPixbuf
+from gi.repository import GdkPixbuf, AppIndicator3, Gtk
 # pylint: enable=E0611
 
 # optional Launchpad integration, pylint: disable=F0401
@@ -60,6 +61,67 @@
 # pylint: disable=W0613
 
 
+class Indicator(object):
+    """The indicator."""
+    def __init__(self, main_ui):
+        self.main_ui = main_ui
+
+        category = AppIndicator3.IndicatorCategory.APPLICATION_STATUS
+        icon_name = "icon-idle-16"
+        logos_path = os.path.join(get_data_file(), 'media')
+        ind = AppIndicator3.Indicator.new("magicicada", icon_name, category)
+        ind.set_status(AppIndicator3.IndicatorStatus.ACTIVE)
+        ind.set_title("Magicicada")
+        ind.set_icon_theme_path(logos_path)
+        ind.set_icon(icon_name)
+        self.indicator = ind
+        self.menu = None
+        self.set_menu()
+
+    def set_icon(self, name):
+        """Put a proper icon in the systray."""
+        full_name = "icon-%s-16" % (name,)
+        self.indicator.set_icon(full_name)
+
+    def set_menu(self):
+        """Set the menu in the indicator."""
+        menu = self._build_menu()
+        self.indicator.set_menu(menu)
+
+    def _build_menu(self):
+        """Build the menu according to the config."""
+        menu = Gtk.Menu()
+        accgroup = Gtk.AccelGroup()
+
+        # show / hide
+        item = Gtk.ImageMenuItem.new_from_stock("Show / Hide", accgroup)
+        menu.append(item)
+        item.connect("activate", self._show_hide)
+        item.show()
+
+        # about
+        item = Gtk.ImageMenuItem.new_from_stock("gtk-about", accgroup)
+        menu.append(item)
+        item.connect("activate", self._run_about_dialog)
+        item.show()
+
+        # quit!
+        item = Gtk.ImageMenuItem.new_from_stock("gtk-quit", accgroup)
+        menu.append(item)
+        item.connect("activate", self.main_ui.on_destroy)
+        item.show()
+
+        return menu
+
+    def _run_about_dialog(self, _):
+        """Run the About dialog."""
+        self.main_ui.on_about_activate(None)
+
+    def _show_hide(self, _):
+        """Show or hide the main window.."""
+        self.main_ui.show_hide()
+
+
 class MagicicadaUI(Buildable):
     """Magicicada GUI main class."""
 
@@ -96,9 +158,7 @@
         self.main_window.set_default_icon_list(self._icons.values())
         self.main_window.set_icon_list(self._icons.values())
 
-        self._status_icons = build_icon_dict(16)
-        self.status_icon = self.builder.get_object('status_icon')
-        self.status_icon.set_from_pixbuf(self._status_icons['idle'])
+        self.indicator = Indicator(self)
 
         about_fname = get_data_file('media', 'logo-128.png')
         self.about_dialog.set_logo(GdkPixbuf.Pixbuf.new_from_file(about_fname))
@@ -132,8 +192,8 @@
         self.about_dialog.run()
         self.about_dialog.hide()
 
-    def on_status_icon_activate(self, widget, data=None):
-        """Systray icon was clicked."""
+    def show_hide(self):
+        """Show or hide the main window.."""
         if self.main_window.get_visible():
             self.main_window.hide()
         else:
@@ -147,11 +207,11 @@
         # change status icon
         state = kwargs.get('state')
         if state == syncdaemon.STATE_IDLE:
-            self.status_icon.set_from_pixbuf(self._status_icons['idle'])
+            self.indicator.set_icon('idle')
         elif state == syncdaemon.STATE_WORKING:
-            self.status_icon.set_from_pixbuf(self._status_icons['working'])
+            self.indicator.set_icon('working')
         else:
-            self.status_icon.set_from_pixbuf(self._status_icons['alert'])
+            self.indicator.set_icon('alert')
 
     @log(logger, level=logging.INFO)
     def on_initial_data_ready(self):
 
=== modified file 'magicicada/gui/gtk/tests/test_main.py'
--- magicicada/gui/gtk/tests/test_main.py	2012-08-21 22:38:50 +0000
+++ magicicada/gui/gtk/tests/test_main.py	2014-01-05 05:47:45 +0000
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2010-2012 Chicharreros
+# Copyright 2010-2014 Chicharreros
 #
 # 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
@@ -132,31 +132,31 @@
     def test_update_statusicon_idle(self):
         """Status icon is updated to idle."""
         self.ui.on_status_changed(state=syncdaemon.STATE_IDLE)
-        pixbuf_set = self.ui.status_icon.get_pixbuf()
-        self.assertEqual(pixbuf_set, self.ui._status_icons['idle'])
+        icon_name = self.ui.indicator.indicator.get_icon()
+        self.assertEqual(icon_name, "icon-idle-16")
 
     def test_update_statusicon_working(self):
         """Status icon is updated to working."""
         self.ui.on_status_changed(state=syncdaemon.STATE_WORKING)
-        pixbuf_set = self.ui.status_icon.get_pixbuf()
-        self.assertEqual(pixbuf_set, self.ui._status_icons['working'])
+        icon_name = self.ui.indicator.indicator.get_icon()
+        self.assertEqual(icon_name, "icon-working-16")
 
     def test_update_statusicon_alert(self):
         """Status icon is updated to alert."""
         self.ui.on_status_changed(state=syncdaemon.STATE_STOPPED)
-        pixbuf_set = self.ui.status_icon.get_pixbuf()
-        self.assertEqual(pixbuf_set, self.ui._status_icons['alert'])
+        icon_name = self.ui.indicator.indicator.get_icon()
+        self.assertEqual(icon_name, "icon-alert-16")
 
     def test_main_window_is_hid_when_icon_clicked(self):
         """Main window is hid when the systray icon is clicked."""
-        self.ui.on_status_icon_activate(self.ui.status_icon)
+        self.ui.show_hide()
         self.assertFalse(self.ui.main_window.get_visible(),
                          'main_window should be invisible when icon clicked.')
 
     def test_main_window_is_shown_when_clicked_after_hidden(self):
         """Main window is shown when the icon is clicked after hidden."""
-        self.ui.on_status_icon_activate(self.ui.status_icon)  # hide
-        self.ui.on_status_icon_activate(self.ui.status_icon)  # show
+        self.ui.show_hide()  # hide
+        self.ui.show_hide()  # show
         msg = 'main_window should be visible when icon clicked after hidden.'
         self.assertTrue(self.ui.main_window.get_visible(), msg)