Merge lp:~lottanzb/lottanzb/appindicator into lp:lottanzb/0.5

[Severin H]

[Severin H (severinh)]

Tested it both on Ubuntu 10.04 and 9.10. I hope everyone is fine with the arranged panel menu entries. Both checkboxes are at the top now, which seems fairly logical to me. The problem is that otherwise, it will look odd on Ubuntu 10.04.

python-appindicator is not introduced as a dependency. If the "appindicator" module isn't found, LottaNZB will just fall back to a regular gtk.StatusIcon. We therefore don't need to mention it neither in the README nor in debian/control. Right?

[lp:~lottanzb/lottanzb/appindicator]

893. By Severin H on 2010-01-21

Also display an entry "Preferences" at the bottom of the panel menu,
as stated in https://wiki.ubuntu.com/CustomStatusMenuDesignGuidelines.

For that purpose, a new method `set_current_tab` has been added to `gui.prefs.Window`
and a new method `show_preferences_window` has been added to `gui.main.Window`.

One might want to rethink this as these guidelines still seem to be a work in progress.

=== modified file 'NEWS'
--- NEWS	2010-01-20 22:47:39 +0000
+++ NEWS	2010-01-21 11:18:11 +0000
@@ -1,6 +1,10 @@
 LottaNZB 0.5.3 - Development
 ============================
 
+- Use the new application indicator approach to be introduced in Ubuntu 10.04.
+  The "Notification area" plug-in has therefore been renamed to "Panel menu".
+  Users of other distributions or older Ubuntu versions will only notice a
+  slight change in the order of panel menu items.
 - Fix crash on machines with GTK 2.19 or later (e.g. Ubuntu 10.04).
   (LP: #507739)
 - Add 64x64 application icon to fix scaling issue in Ubuntu's Software Center.

=== renamed file 'data/ui/plugin_notification_area_menu.ui' => 'data/ui/plugin_panel_menu.ui'
--- data/ui/plugin_notification_area_menu.ui	2009-09-08 18:37:03 +0000
+++ data/ui/plugin_panel_menu.ui	2010-01-21 11:18:11 +0000
@@ -2,54 +2,7 @@
 <interface>
   <requires lib="gtk+" version="2.16"/>
   <!-- interface-naming-policy toplevel-contextual -->
-  <object class="GtkMenu" id="menu">
-    <property name="visible">True</property>
-    <property name="events">GDK_POINTER_MOTION_MASK | GDK_POINTER_MOTION_HINT_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK</property>
-    <child>
-      <object class="GtkCheckMenuItem" id="menuitem3">
-        <property name="visible">True</property>
-        <property name="related_action">open</property>
-        <property name="use_action_appearance">True</property>
-        <property name="use_underline">True</property>
-      </object>
-    </child>
-    <child>
-      <object class="GtkSeparatorMenuItem" id="menuitem5">
-        <property name="visible">True</property>
-      </object>
-    </child>
-    <child>
-      <object class="GtkImageMenuItem" id="menuitem1">
-        <property name="visible">True</property>
-        <property name="related_action">add</property>
-        <property name="use_action_appearance">True</property>
-        <property name="use_underline">True</property>
-        <property name="use_stock">True</property>
-      </object>
-    </child>
-    <child>
-      <object class="GtkCheckMenuItem" id="menuitem4">
-        <property name="visible">True</property>
-        <property name="related_action">pause</property>
-        <property name="use_action_appearance">True</property>
-      </object>
-    </child>
-    <child>
-      <object class="GtkSeparatorMenuItem" id="menuitem6">
-        <property name="visible">True</property>
-      </object>
-    </child>
-    <child>
-      <object class="GtkImageMenuItem" id="menuitem2">
-        <property name="visible">True</property>
-        <property name="related_action">quit</property>
-        <property name="use_action_appearance">True</property>
-        <property name="use_underline">True</property>
-        <property name="use_stock">True</property>
-      </object>
-    </child>
-  </object>
-  <object class="GtkWindow" id="plugin_notification_area_menu">
+  <object class="GtkWindow" id="plugin_panel_menu">
     <child>
       <object class="GtkHBox" id="hbox1">
         <property name="visible">True</property>
@@ -72,4 +25,63 @@
     <property name="label" translatable="yes">Pause all</property>
     <property name="stock_id">gtk-media-pause</property>
   </object>
+  <object class="GtkAction" id="show_preferences">
+    <property name="stock_id">gtk-preferences</property>
+  </object>
+  <object class="GtkMenu" id="menu">
+    <property name="visible">True</property>
+    <property name="events">GDK_POINTER_MOTION_MASK | GDK_POINTER_MOTION_HINT_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK</property>
+    <child>
+      <object class="GtkCheckMenuItem" id="menuitem3">
+        <property name="visible">True</property>
+        <property name="use_action_appearance">True</property>
+        <property name="related_action">open</property>
+        <property name="use_underline">True</property>
+      </object>
+    </child>
+    <child>
+      <object class="GtkCheckMenuItem" id="menuitem4">
+        <property name="visible">True</property>
+        <property name="use_action_appearance">True</property>
+        <property name="related_action">pause</property>
+      </object>
+    </child>
+    <child>
+      <object class="GtkSeparatorMenuItem" id="menuitem5">
+        <property name="visible">True</property>
+      </object>
+    </child>
+    <child>
+      <object class="GtkImageMenuItem" id="menuitem1">
+        <property name="visible">True</property>
+        <property name="use_action_appearance">True</property>
+        <property name="related_action">add</property>
+        <property name="use_underline">True</property>
+        <property name="use_stock">True</property>
+      </object>
+    </child>
+    <child>
+      <object class="GtkImageMenuItem" id="menuitem2">
+        <property name="visible">True</property>
+        <property name="use_action_appearance">True</property>
+        <property name="related_action">quit</property>
+        <property name="use_underline">True</property>
+        <property name="use_stock">True</property>
+      </object>
+    </child>
+    <child>
+      <object class="GtkSeparatorMenuItem" id="menuitem6">
+        <property name="visible">True</property>
+      </object>
+    </child>
+    <child>
+      <object class="GtkImageMenuItem" id="menuitem7">
+        <property name="visible">True</property>
+        <property name="use_action_appearance">True</property>
+        <property name="related_action">show_preferences</property>
+        <property name="use_stock">True</property>
+        <property name="use_underline">True</property>
+      </object>
+    </child>
+  </object>
 </interface>

=== modified file 'lottanzb/config.py'
--- lottanzb/config.py	2010-01-16 09:22:53 +0000
+++ lottanzb/config.py	2010-01-21 11:18:11 +0000
@@ -811,7 +811,7 @@
     backend = gproperty(type=object)
     plugins = gproperty(type=object)
     
-    revision = gproperty(type=int, default=2)
+    revision = gproperty(type=int, default=3)
     
     def load(self):
         """
@@ -893,6 +893,14 @@
             ["gui", "start_minimized"],
             ["plugins", "start_minimized", "enabled"]
         )
+
+    def upgrade_2_to_3(self):
+        """The "notification_area" plug-in has been renamed to "panel_menu"."""
+        
+        self.try_to_move_option(
+            ["plugins", "notification_area"],
+            ["plugins", "panel_menu"]
+        )
     
     def convert_xml_config(self):
         """

=== modified file 'lottanzb/gui/main.py'
--- lottanzb/gui/main.py	2010-01-16 09:22:53 +0000
+++ lottanzb/gui/main.py	2010-01-21 11:18:11 +0000
@@ -126,6 +126,24 @@
         
         self.emit("add-file-dialog-opened", dialog)
     
+    def show_preferences_window(self):
+        """
+        Displays the preferences window. If it has already been opened, bring
+        it to the front.
+        """
+        
+        if self.prefs_window:
+            self.prefs_window.toplevel.present()
+        else:
+            def on_prefs_window_destroy(*args):
+                self.prefs_window = None
+            
+            self.prefs_window = prefs.Window()
+            self.prefs_window.show(self)
+            
+            self.prefs_window.toplevel.connect("destroy",
+                on_prefs_window_destroy)
+    
     def remove_download(self, download):
         q = _("Are you sure you want to cancel this download?")
         
@@ -236,22 +254,7 @@
         return False
     
     def on_edit_preferences__activate(self, widget):
-        """
-        Displays the preferences window. If it has already been opened, bring
-        it to the front.
-        """
-        
-        if self.prefs_window:
-            self.prefs_window.toplevel.present()
-        else:
-            def on_prefs_window_destroy(*args):
-                self.prefs_window = None
-            
-            self.prefs_window = prefs.Window()
-            self.prefs_window.show(self)
-            
-            self.prefs_window.toplevel.connect("destroy",
-                on_prefs_window_destroy)
+        self.show_preferences_window()
     
     def on_select_mode__activate(self, widget):
         dialog = mode_selection.Dialog()

=== modified file 'lottanzb/gui/prefs.py'
--- lottanzb/gui/prefs.py	2010-01-16 09:22:53 +0000
+++ lottanzb/gui/prefs.py	2010-01-21 11:18:11 +0000
@@ -153,6 +153,12 @@
             self.detach_slave(name)
             self.notebook.remove_page(self.notebook.page_num(eventbox))
     
+    def set_current_tab(self, tab):
+        eventbox = tab.toplevel.parent
+        page_num = self.notebook.page_num(eventbox)
+        
+        self.notebook.set_current_page(page_num)
+    
     def _compare_tabs(self, tab, other_tab):
         """
         Can be used to check if a tab has a higher priority than an other tab.

=== renamed directory 'lottanzb/plugins/notification_area' => 'lottanzb/plugins/panel_menu'
=== modified file 'lottanzb/plugins/panel_menu/__init__.py'
--- lottanzb/plugins/notification_area/__init__.py	2010-01-16 09:22:53 +0000
+++ lottanzb/plugins/panel_menu/__init__.py	2010-01-21 11:18:11 +0000
@@ -20,110 +20,85 @@
 from lottanzb.plugins import PluginBase, PluginConfig, PluginPrefsTabBase
 from lottanzb.util import gproperty, _
 
+try:
+    import appindicator
+except ImportError:
+    appindicator = None
+
 class Config(PluginConfig):
     """The plug-in is enabled by default."""
     
     enabled = gproperty(type=bool, default=True)
 
+
 class Plugin(PluginBase):
-    title = _("Notification area icon")
-    description = _("Displays an icon in the notification area and allows "
-        "LottaNZB to be controlled through it.")
+    title = _("Panel menu")
+    description = _("Control LottaNZB using a menu in the panel.")
     author = _("LottaNZB Development Team")
     
-    # The gtk.StatusIcon object that represents the icon in the
-    # notification area.
-    icon = None
+    # Contains a `MenuContainer` object that represents the actual icon in
+    # the panel. On Ubuntu 10.04 or later, this comes in the form of an
+    # application indicator. On other systems, a simple gtk.StatusIcon is
+    # used instead.
+    menu_container = None
     
+    # The `GladeDelegate` object holding the `gtk.Menu` as a property `menu`.
     menu_delegate = None
+    
     main_window = None
     
     def refresh(self):
         """
-        Makes sure that the application is not entirely shut down if the main
+        Make sure that the application is not entirely shut down if the main
         window is closed while the plug-in is enabled.
         """
         
-        if self.main_window:
+        if self.main_window is not None:
             self.main_window.quit_on_close = not self.enabled
     
     def load(self):
         """
-        Creates the status icon if necessary and makes sure that it's visible.
+        Create the `menu_container` if necessary and make sure that it's
+        visible.
         """
         
-        if self.icon:
-            def show_icon():
-                self.icon.set_visible(True)
-            
-            self.do_with_rgb_colormap(show_icon)
-        elif self.main_window:
-            def create_icon():
-                """
-                Helper method that creates the notification area icon and
-                registers all event handlers.
-                """
+        if self.menu_container is None:
+            if self.main_window is not None:
+                # Choose the right `MenuContainer`.
+                menu_container_classes = (IndicatorMenuContainer,
+                    StatusIconMenuContainer)
                 
-                self.icon = gtk.StatusIcon()
-                self.icon.set_from_icon_name("lottanzb")
-                self.icon.set_tooltip("LottaNZB")
-                self.icon.connect("popup-menu", self.show_menu)
-                self.icon.connect("activate", self.toggle_main_window)
-            
-            self.do_with_rgb_colormap(create_icon)
+                for menu_container_class in menu_container_classes:
+                    try:
+                        self.menu_container = menu_container_class("lottanzb",
+                            self.menu_delegate.menu, self.main_window)
+                    except:
+                        pass
+                    else:
+                        break
+
+                # Left-clicking on the `gtk.StatusIcon` should cause the main
+                # window to be toggled. For the new-fasioned application
+                # indicators, it will just open the associated menu.
+                # TODO: This unelegant code breaks the otherwise okay-ish
+                # abstraction of `MenuContainer`, but it works.
+                if isinstance(self.menu_container, StatusIconMenuContainer):
+                    self.menu_container._icon.connect("activate",
+                        self.toggle_main_window)
+        else:
+            self.menu_container.set_visible(True)
         
         PluginBase.load(self)
     
     def unload(self):
-        """Hides the status menu if necessary."""
+        """Hide the `menu_container`."""
         
-        if self.icon:
-            self.icon.set_visible(False)
+        if self.menu_container:
+            self.menu_container.set_visible(False)
         
         PluginBase.unload(self)
     
-    def do_with_rgb_colormap(self, function):
-        """
-        Workaround for bug http://bugzilla.gnome.org/show_bug.cgi?id=501842
-        
-        This method ensures that the default RGB color map is active while the
-        passed function is being executed and returns to the previous color
-        map afterwards.
-        """
-        
-        # We cannot do it without the gtk.Screen provided by the main window.
-        if self.main_window:
-            screen = self.main_window.toplevel.get_screen()
-            current_colormap = screen.get_default_colormap()
-            
-            try:
-                assert current_colormap == screen.get_rgba_colormap()
-            except (AttributeError, AssertionError):
-                rgba_support = False
-            else:
-                screen.set_default_colormap(screen.get_rgb_colormap())
-                rgba_support = True
-            
-            function()
-            
-            # Restore the RGBA color map if necessary.
-            if rgba_support:
-                screen.set_default_colormap(current_colormap)
-    
-    def show_menu(self, icon, button, activate_time):
-        """Display the status icon menu."""
-        
-        position = gtk.status_icon_position_menu
-        
-        self.menu_delegate.menu.popup(None, None, position, button, \
-            activate_time, icon)
-    
     def toggle_main_window(self, *args):
-        """
-        Does what the method name says. ;-) It just changes the visibility of
-        the main window.
-        """
-        
         if self.main_window_visible:
             self.main_window.hide()
         else:
@@ -132,10 +107,7 @@
         return True
     
     def on_main_window_ready(self, main_window):
-        """
-        Internal method that registers the 'Close' file menu entry as well
-        as the notification area icon menu.
-        """
+        """Register the 'Close' file menu entry as well as the panel menu."""
         
         self.main_window = main_window
         
@@ -156,17 +128,22 @@
         self.menu_delegate.add.connect("activate", self.on_add_activated)
         self.menu_delegate.pause.connect("toggled", self.on_pause_toggled)
         self.menu_delegate.quit.connect("activate", self.on_quit_activated)
+        self.menu_delegate.show_preferences.connect("activate",
+            self.on_show_preferences_activated)
         
         self.main_window.toplevel.connect("show", self.update_open_checkbox)
         self.main_window.toplevel.connect("hide", self.update_open_checkbox)
         self.main_window.pause.connect("activate", self.update_pause_checkbox)
         
+        self.update_open_checkbox()
+        self.update_pause_checkbox()
+        
         if self.enabled:
             self.load()
     
     def on_open_toggled(self, widget):
         """
-        Makes sure that the main window's visibility matches the state of the
+        Make sure that the main window's visibility matches the state of the
         'Show main window' checkbox.
         """
         
@@ -198,22 +175,40 @@
         
         self.app.quit()
     
-    def update_open_checkbox(self, window):
+    def on_show_preferences_activated(self, *args):
+        """
+        Show the preferences window, but also jump to the "Plug-ins" tab and
+        select the "Panel menu" item.
+        
+        This behaviour is meant to make it easy for a user to hide the panel
+        item again and is recommended by
+        https://wiki.ubuntu.com/CustomStatusMenuDesignGuidelines
+        """
+        
+        if self.main_window is not None:
+            self.main_window.show_preferences_window()
+            
+            prefs_window = self.main_window.prefs_window
+            prefs_window.set_current_tab(prefs_window.plugins_tab)
+            prefs_window.plugins_tab.plugin_list.select(self)
+    
+    def update_open_checkbox(self, *args):
         """
         If the main window is visibility of the main window is changed by the
         user by closing the window etc, this method changes the 'Show main
-        window' checkbox in the notification area icon menu accordingly.
+        window' checkbox in the panel menu accordingly.
         """
         
-        self.menu_delegate.open.set_active(window.get_property("visible"))
+        self.menu_delegate.open.set_active(self.main_window_visible)
     
-    def update_pause_checkbox(self, widget):
+    def update_pause_checkbox(self, *args):
         """
         If the downloads are paused from the main window, also update the
-        checkbox in the notification area menu.
+        checkbox in the panel menu.
         """
         
-        self.menu_delegate.pause.set_active(widget.get_active())
+        paused = self.main_window.pause.get_active()
+        self.menu_delegate.pause.set_active(paused)
     
     @property
     def main_window_visible(self):
@@ -224,11 +219,100 @@
         
         return self.main_window.toplevel.get_property("visible")
 
+
 class MenuDelegate(GladeDelegate):
     """
-    This glade file contains a nearly empty gtk.Window, which isn't actually
+    This UI file contains a nearly empty gtk.Window, which isn't actually
     used, but necessary because Kiwi doesn't allow delegates with a gtk.Menu
     root object.
     """
     
-    gladefile = "plugin_notification_area_menu"
+    gladefile = "plugin_panel_menu"
+
+
+class MenuContainer(object):
+    def __init__(self, application, menu, main_window):
+        self.application = application
+        self.menu = menu
+        self.main_window = main_window
+    
+    def set_visible(self, visible):
+        raise NotImplementedError
+
+
+class IndicatorMenuContainer(MenuContainer):
+    def __init__(self, application, menu, main_window):
+        MenuContainer.__init__(self, application, menu, main_window)
+        
+        self._indicator = appindicator.Indicator(self.application,
+            self.application, appindicator.CATEGORY_APPLICATION_STATUS)
+        
+        self._indicator.set_status(appindicator.STATUS_ACTIVE)
+        self._indicator.set_menu(self.menu)
+    
+    def set_visible(self, visible):
+        if visible:
+            status = appindicator.STATUS_ACTIVE
+        else:
+            status = appindicator.STATUS_PASSIVE
+        
+        self._indicator.set_status(status)
+
+
+class StatusIconMenuContainer(MenuContainer):
+    def __init__(self, application, menu, main_window):
+        MenuContainer.__init__(self, application, menu, main_window)
+        
+        self._icon = None
+        self._do_with_rgb_colormap(self._create_icon)
+        
+    def set_visible(self, visible):
+        def show_icon():
+            self._icon.set_visible(visible)
+        
+        self._do_with_rgb_colormap(show_icon)
+    
+    def _do_with_rgb_colormap(self, function):
+        """
+        Workaround for bug http://bugzilla.gnome.org/show_bug.cgi?id=501842
+        
+        This method ensures that the default RGB color map is active while the
+        passed function is being executed and returns to the previous color
+        map afterwards.
+        """
+        
+        # We cannot do it without the gtk.Screen provided by the main window.
+        screen = self.main_window.toplevel.get_screen()
+        current_colormap = screen.get_default_colormap()
+        
+        try:
+            assert current_colormap == screen.get_rgba_colormap()
+        except (AttributeError, AssertionError):
+            rgba_support = False
+        else:
+            screen.set_default_colormap(screen.get_rgb_colormap())
+            rgba_support = True
+        
+        function()
+        
+        # Restore the RGBA color map if necessary.
+        if rgba_support:
+            screen.set_default_colormap(current_colormap)
+    
+    def _show_menu(self, icon, button, activate_time):
+        """Display the status icon menu."""
+        
+        position = gtk.status_icon_position_menu
+        
+        self.menu.popup(None, None, position, button, \
+            activate_time, icon)
+    
+    def _create_icon(self):
+        """
+        Helper method that creates the `gtk.StatusIcon` and
+        registers all event handlers.
+        """
+        
+        self._icon = gtk.StatusIcon()
+        self._icon.set_from_icon_name(self.application)
+        self._icon.connect("popup-menu", self._show_menu)

=== modified file 'lottanzb/plugins/start_minimized/__init__.py'
--- lottanzb/plugins/start_minimized/__init__.py	2010-01-16 09:22:53 +0000
+++ lottanzb/plugins/start_minimized/__init__.py	2010-01-21 11:18:11 +0000
@@ -20,7 +20,7 @@
     title = _("Start minimized")
     description = _("Only display the notification area icon when starting.")
     author = _("LottaNZB Development Team")
-    requires = ["notification_area"]
+    requires = ["panel_menu"]
     
     def __init__(self, app, config):
         PluginBase.__init__(self, app, config)
@@ -28,4 +28,4 @@
         # Prevent the main window from being displayed if the plug-in is 
         # enabled.
         if self.enabled:
-            self.app.silent_start = True
\ No newline at end of file
+            self.app.silent_start = True