status icon: Add support for scroll events

ref:
linuxmint/cinnamon#9152

Author: mtwebster

libxapp/meson.build

@@ -137,7 +137,7 @@ libxapp_dep = declare_dependency(
 gir = gnome.generate_gir(libxapp,
     namespace: 'XApp',
     nsversion: '1.0',
-    sources: xapp_headers + xapp_sources + dbus_headers,
+    sources: xapp_headers + xapp_sources + dbus_headers + xapp_enums,
     identifier_prefix: 'XApp',
     symbol_prefix: 'xapp_',
     includes: ['GObject-2.0', 'Gtk-3.0'],

libxapp/org.x.StatusIcon.xml

@@ -17,6 +17,11 @@
         <arg name='time' direction='in' type='u'/>
         <arg name='panel_position' direction='in' type='i'/>
     </method>
+    <method name='Scroll'>
+        <arg name='delta' direction='in' type='i'/>
+        <arg name='orientation' direction='in' type='i'/>
+        <arg name='time' direction='in' type='u'/>
+    </method>
     <property type='s' name='Name' access='read'/>
     <property type='s' name='IconName' access='read'/>
     <property type='s' name='TooltipText' access='read'/>

libxapp/xapp-status-icon.c

@@ -37,6 +37,7 @@ enum
     BUTTON_RELEASE,
     ACTIVATE,
     STATE_CHANGED,
+    SCROLL,
     LAST_SIGNAL
 };
 
@@ -163,6 +164,24 @@ state_to_str (XAppStatusIconState state)
     }
 }
 
+static const gchar *
+direction_to_str (XAppScrollDirection direction)
+{
+    switch (direction)
+    {
+        case XAPP_SCROLL_UP:
+            return "Up";
+        case XAPP_SCROLL_DOWN:
+            return "Down";
+        case XAPP_SCROLL_LEFT:
+            return "Left";
+        case XAPP_SCROLL_RIGHT:
+            return "Right";
+        default:
+            return "Unknown";
+    }
+}
+
 static gint
 adjust_y_for_monitor_bounds (gint init_x,
                              gint init_y,
@@ -438,6 +457,30 @@ handle_click_method (XAppStatusIconInterface *skeleton,
     return TRUE;
 }
 
+static gboolean
+handle_scroll_method (XAppStatusIconInterface *skeleton,
+                      GDBusMethodInvocation   *invocation,
+                      gint                     delta,
+                      XAppScrollDirection      direction,
+                      guint                    _time,
+                      XAppStatusIcon          *icon)
+{
+    g_debug ("XAppStatusIcon: received Scroll from monitor %s: "
+             "delta: %d , direction: %s , time: %u",
+             g_dbus_method_invocation_get_sender (invocation),
+             delta, direction_to_str (direction), _time);
+
+    g_signal_emit(icon, signals[SCROLL], 0,
+                  delta,
+                  direction,
+                  _time);
+
+    xapp_status_icon_interface_complete_scroll (skeleton,
+                                                invocation);
+
+    return TRUE;
+}
+
 static void
 popup_gtk_status_icon_with_menu (XAppStatusIcon *icon,
                                  GtkMenu        *menu,
@@ -724,7 +767,8 @@ typedef struct
 static SkeletonSignal skeleton_signals[] = {
     // signal name                                callback
     { "handle-button-press",                      handle_click_method },
-    { "handle-button-release",                    handle_click_method }
+    { "handle-button-release",                    handle_click_method },
+    { "handle-scroll",                            handle_scroll_method }
 };
 
 static gboolean
@@ -1344,6 +1388,25 @@ xapp_status_icon_class_init (XAppStatusIconClass *klass)
                       0,
                       NULL, NULL, NULL,
                       G_TYPE_NONE, 1, XAPP_TYPE_STATUS_ICON_STATE);
+
+    /**
+     * XAppStatusIcon::scroll-event:
+     * @icon: The #XAppStatusIcon
+     * @amount: The amount of movement for the scroll event
+     * @direction: the #XAppScrollDirection of the scroll event
+     * @time: The time supplied by the event, or 0
+     *
+     * Gets emitted when the user uses the mouse scroll wheel over the status icon.
+     * For the most part, amounts will always be 1, unless an applet supports smooth
+     * scrolling.  Generally the direction value is most important.
+     */
+    signals [SCROLL] =
+        g_signal_new ("scroll-event",
+                      XAPP_TYPE_STATUS_ICON,
+                      G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
+                      0,
+                      NULL, NULL, NULL,
+                      G_TYPE_NONE, 3, G_TYPE_INT, XAPP_TYPE_SCROLL_DIRECTION, G_TYPE_UINT);
 }
 
 /**

libxapp/xapp-status-icon.h

@@ -28,6 +28,24 @@ typedef enum
     XAPP_STATUS_ICON_STATE_NO_SUPPORT
 } XAppStatusIconState;
 
+/**
+ * XAppScrollDirection:
+ * @XAPP_SCROLL_UP: Scroll theoretical content up.
+ * @XAPP_SCROLL_DOWN: Scroll theoretical content down.
+ * @XAPP_SCROLL_LEFT: Scroll theoretical content left.
+ * @XAPP_SCROLL_RIGHT: Scroll theoretical content right.
+ *
+ * Represents the direction of icon scroll events.
+ */
+typedef enum
+{
+  XAPP_SCROLL_UP,
+  XAPP_SCROLL_DOWN,
+  XAPP_SCROLL_LEFT,
+  XAPP_SCROLL_RIGHT
+} XAppScrollDirection;
+
+
 XAppStatusIcon *xapp_status_icon_new                (void);
 void            xapp_status_icon_set_name           (XAppStatusIcon *icon, const gchar *name);
 void            xapp_status_icon_set_icon_name      (XAppStatusIcon *icon, const gchar *icon_name);

status-applets/mate/mate-xapp-status-applet.py

@@ -67,6 +67,8 @@ def __init__(self, icon, orientation, size):
         # this is the bus owned name
         self.name = self.proxy.get_name()
 
+        self.add_events(Gdk.EventMask.SCROLL_MASK)
+
         # this is (usually) the name of the remote process
         self.proc_name = self.proxy.props.name
 
@@ -99,6 +101,7 @@ def __init__(self, icon, orientation, size):
 
         self.connect("button-press-event", self.on_button_press)
         self.connect("button-release-event", self.on_button_release)
+        self.connect("scroll-event", self.on_scroll)
         self.connect("enter-notify-event", self.on_enter_notify)
         self.connect("leave-notify-event", self.on_leave_notify)
 
@@ -219,6 +222,26 @@ def on_button_release(self, widget, event):
 
         return Gdk.EVENT_PROPAGATE
 
+    def on_scroll(self, widget, event):
+        has, direction = event.get_scroll_direction()
+
+        x_dir = XApp.ScrollDirection.UP
+        delta = 0
+
+        if direction != Gdk.ScrollDirection.SMOOTH:
+            x_dir = XApp.ScrollDirection(int(direction))
+
+            if direction == Gdk.ScrollDirection.UP:
+                delta = -1
+            elif direction == Gdk.ScrollDirection.DOWN:
+                delta = 1
+            elif direction == Gdk.ScrollDirection.LEFT:
+                delta = -1
+            elif direction == Gdk.ScrollDirection.RIGHT:
+                delta = 1
+
+        self.proxy.call_scroll_sync(delta, x_dir, event.time, None)
+
     def calc_menu_origin(self, widget, orientation):
         alloc = widget.get_allocation()
         ignore, x, y = widget.get_window().get_origin()

test-scripts/xapp-status-applet

@@ -2,7 +2,7 @@
 import gi
 gi.require_version('Gtk', '3.0')
 gi.require_version('XApp', '1.0')
-from gi.repository import Gio, GLib, GObject, Gtk, XApp
+from gi.repository import Gio, GLib, GObject, Gtk, XApp, Gdk
 import os
 import sys
 
@@ -16,6 +16,7 @@ class StatusWidget(Gtk.Button):
 
         self.proxy = icon
         self.name = self.proxy.get_name()
+        self.add_events(Gdk.EventMask.SCROLL_MASK)
 
         box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL)
 
@@ -40,6 +41,7 @@ class StatusWidget(Gtk.Button):
 
         self.connect("button-press-event", self.on_button_press)
         self.connect("button-release-event", self.on_button_release)
+        self.connect("scroll-event", self.on_scroll)
 
     def on_icon_name_changed(self, proxy, gparamspec, data=None):
         string = self.proxy.props.icon_name
@@ -77,6 +79,27 @@ class StatusWidget(Gtk.Button):
         print ("Button release : %d:%d" % (x, y))
         self.proxy.call_button_release_sync(x, y, event.button, event.time, Gtk.PositionType.TOP, None)
 
+    def on_scroll(self, widget, event):
+        has, direction = event.get_scroll_direction()
+
+        x_dir = XApp.ScrollDirection.UP
+        delta = 0
+
+        if direction != Gdk.ScrollDirection.SMOOTH:
+            x_dir = XApp.ScrollDirection(int(direction))
+
+            if direction == Gdk.ScrollDirection.UP:
+                delta = -1
+            elif direction == Gdk.ScrollDirection.DOWN:
+                delta = 1
+            elif direction == Gdk.ScrollDirection.LEFT:
+                delta = -1
+            elif direction == Gdk.ScrollDirection.RIGHT:
+                delta = 1
+
+        print ("Scroll : delta: %d, orientation: %d" % (delta, x_dir))
+        self.proxy.call_scroll_sync(delta, x_dir, event.time, None)
+
 class StatusApplet(GObject.Object):
 
     def __init__(self):

test-scripts/xapp-status-icon-variants/xapp-status-icon-activate-and-menu

@@ -22,6 +22,10 @@ class App(GObject.Object):
         self.status_icon.set_tooltip_text("Testing primary activate and secondary menu")
         self.status_icon.set_label("label 1")
         self.status_icon.set_visible(True)
+        self.status_icon.connect("scroll-event", self.handle_scroll_event)
+
+        self.label = None
+        self.window = None
 
         self.counter = 1
 
@@ -48,6 +52,31 @@ class App(GObject.Object):
         print("Activated via button %d" % button)
         self.counter = 0
         self.status_icon.set_label("label %d" % self.counter)
+        self.make_window()
+
+    def make_window(self):
+        w = Gtk.Window(default_width=300, default_height=130)
+        b = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
+        w.add(b)
+        self.label = Gtk.Label("How can I help you?")
+        b.pack_start(self.label, True, True, 0)
+
+        self.window = w
+        w.show_all()
+
+    def handle_scroll_event(self, icon, amount, orientation, time, data=None):
+        if self.window == None:
+            self.make_window()
+
+        if orientation == XApp.ScrollDirection.UP:
+            self.label.set_text("Scrolled Up !")
+        elif orientation == XApp.ScrollDirection.DOWN:
+            self.label.set_text("Scrolled Down!")
+        elif orientation == XApp.ScrollDirection.LEFT:
+            self.label.set_text("Scrolled Left!")
+        else:
+            self.label.set_text("Scrolled Right!")
+
 
 if __name__ == '__main__':
     GLib.setenv ("G_MESSAGES_DEBUG", "all", True)

test-scripts/xapp-status-icon-variants/xapp-status-icon-ai

@@ -17,6 +17,8 @@ sets both primary and secondary menus on the XAppStatusIcon.
 class App(GObject.Object):
     def __init__(self):
         super(App, self).__init__()
+        self.window = None
+
         self.indicator = AppIndicator3.Indicator.new("xapp-status-icon-via-libappindicator",
                                                        "info",
                                                        AppIndicator3.IndicatorCategory.SYSTEM_SERVICES)
@@ -39,15 +41,32 @@ class App(GObject.Object):
 
         self.indicator.set_menu(self.menu)
 
+        self.indicator.connect("scroll-event", self.handle_scroll_event)
         GLib.timeout_add_seconds(2, self.on_timeout_cb)
 
     def activate_window(self, item, data=None):
         w = Gtk.Window(default_width=300, default_height=130)
         b = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
         w.add(b)
-        b.pack_start(Gtk.Label("How can I help you?"), True, True, 0)
+        self.label = Gtk.Label("How can I help you?")
+        b.pack_start(self.label, True, True, 0)
+
+        self.window = w
         w.show_all()
 
+    def handle_scroll_event(self, icon, amount, direction, data=None):
+        if self.window == None:
+            self.activate_window(None)
+
+        if direction == Gdk.ScrollDirection.UP:
+            self.label.set_text("Scrolled Up!")
+        elif direction == Gdk.ScrollDirection.DOWN:
+            self.label.set_text("Scrolled Down!")
+        elif direction == Gdk.ScrollDirection.LEFT:
+            self.label.set_text("Scrolled Left!")
+        else:
+            self.label.set_text("Scrolled Right!")
+
     def on_timeout_cb(self):
         self.counter += 1
         self.indicator.set_label("AppIndicator3 %d" % self.counter, "AppIndicator3 1000")

test-scripts/xapp-status-icon-variants/xapp-status-icon-all-menus

@@ -22,9 +22,13 @@ class App(GObject.Object):
         self.status_icon.set_tooltip_text("Testing primary and secondary menus")
         self.status_icon.set_label("label 1")
         self.status_icon.set_visible(True)
+        self.status_icon.connect("scroll-event", self.handle_scroll_event)
 
         self.counter = 1
 
+        self.label = None
+        self.window = None
+
         menu = Gtk.Menu()
         menu.append(Gtk.MenuItem.new_with_label("Engage the hyperdrive"))
         menu.append(Gtk.SeparatorMenuItem())
@@ -51,6 +55,29 @@ class App(GObject.Object):
         self.status_icon.set_label("label %d" % self.counter)
         return True
 
+    def make_window(self):
+        w = Gtk.Window(default_width=300, default_height=130)
+        b = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
+        w.add(b)
+        self.label = Gtk.Label("How can I help you?")
+        b.pack_start(self.label, True, True, 0)
+
+        self.window = w
+        w.show_all()
+
+    def handle_scroll_event(self, icon, amount, orientation, time, data=None):
+        if self.window == None:
+            self.make_window()
+
+        if orientation == XApp.ScrollDirection.UP:
+            self.label.set_text("Scrolled Up !")
+        elif orientation == XApp.ScrollDirection.DOWN:
+            self.label.set_text("Scrolled Down!")
+        elif orientation == XApp.ScrollDirection.LEFT:
+            self.label.set_text("Scrolled Left!")
+        else:
+            self.label.set_text("Scrolled Right!")
+
 if __name__ == '__main__':
     GLib.setenv ("G_MESSAGES_DEBUG", "all", True)
     app = App()