Merge lp:~3v1n0/libindicator/scroll-event-support into lp:libindicator/0.4

[Marco Trevisan (Treviño)]

libindicator support the new "scroll-entry" signal (which get called using the target entry as parameter too) I think that maybe we could simply rewrite the "scroll" signal, but I kept it there for compatibility reasons; however, actually just the indicator-sound should be fixed in case of switch...

This is part of the Indicators "scroll-event" support patch, see bug #708180

[Ted Gould (ted)]

69 -#define INDICATOR_OBJECT_SIGNAL_ENTRY_ADDED "entry-added"
70 +#define INDICATOR_OBJECT_SIGNAL_ENTRY_ADDED SCROLL "entry-added"

I'm not sure what the SCROLL here is for. Otherwise it looks good.

review: Needs Information

[Marco Trevisan (Treviño) (3v1n0)]

> 69 -#define INDICATOR_OBJECT_SIGNAL_ENTRY_ADDED "entry-added"
> 70 +#define INDICATOR_OBJECT_SIGNAL_ENTRY_ADDED SCROLL "entry-added"
>
> I'm not sure what the SCROLL here is for. Otherwise it looks good.

Ops, it was a typo (or bad paste :P)... I'm fixing it, sorry.

[lp:~3v1n0/libindicator/scroll-event-support]

396. By Marco Trevisan (Treviño) on 2011-01-27

Removed typo in code.

Pasted a more SCROLL value :P

[Marco Trevisan (Treviño) (3v1n0)]

Ah, let me know if you'd prefer to replace the old "scroll" signal with the new one, instead of adding one more (so using an extra slot of the struct for the very same reason); the current implementation could be considered not optimized and containing a duplicate.

In this case, indicator-sound (the only depending on this, right now) should be updated too, to use the scroll_entry signal instead of the scroll one.

[Ted Gould (ted)]

On Thu, 2011-01-27 at 11:37 +0000, Treviño (Marco Trevisan) wrote:
> Ah, let me know if you'd prefer to replace the old "scroll" signal with the new one, instead of adding one more (so using an extra slot of the struct for the very same reason); the current implementation could be considered not optimized and containing a duplicate.
>
> In this case, indicator-sound (the only depending on this, right now) should be updated too, to use the scroll_entry signal instead of the scroll one.

Yeah, from a coding perspective it's not a big deal. But every time we
break API we kinda mess with the distro folks in a bad way. So it's
worth not doing that if we don't need to. Next time we break ABI I'll
reclaim the reserved.

Thanks for fixing the typo!

  review approve

review: Approve

=== modified file 'libindicator/indicator-object-marshal.list'
--- libindicator/indicator-object-marshal.list	2011-01-04 21:56:53 +0000
+++ libindicator/indicator-object-marshal.list	2011-01-27 11:27:12 +0000
@@ -1,4 +1,5 @@
 VOID: POINTER, UINT, UINT
-VOID: UINT,ENUM
+VOID: UINT, ENUM
+VOID: POINTER, UINT, ENUM
 VOID: POINTER, UINT
 VOID: POINTER, BOOLEAN

=== modified file 'libindicator/indicator-object.c'
--- libindicator/indicator-object.c	2011-01-10 16:19:52 +0000
+++ libindicator/indicator-object.c	2011-01-27 11:27:12 +0000
@@ -58,6 +58,7 @@
 	ENTRY_REMOVED,
 	ENTRY_MOVED,
 	SCROLL,
+	SCROLL_ENTRY,
 	MENU_SHOW,
 	SHOW_NOW_CHANGED,
 	LAST_SIGNAL
@@ -146,7 +147,6 @@
 	                                     _indicator_object_marshal_VOID__POINTER_UINT_UINT,
 	                                     G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_UINT, G_TYPE_UINT, G_TYPE_NONE);
 
-
 	/**
 		IndicatorObject::scroll:
 		@arg0: The #IndicatorObject object
@@ -162,7 +162,28 @@
 	                                G_STRUCT_OFFSET (IndicatorObjectClass, scroll),
 	                                NULL, NULL,
 	                                _indicator_object_marshal_VOID__UINT_ENUM,
-	                                G_TYPE_NONE, 2, G_TYPE_UINT, INDICATOR_OBJECT_TYPE_SCROLL_DIRECTION);
+	                                G_TYPE_NONE, 2, G_TYPE_UINT,
+	                                INDICATOR_OBJECT_TYPE_SCROLL_DIRECTION);
+
+/**
+		IndicatorObject::scroll-entry:
+		@arg0: The #IndicatorObject object
+		@arg1: A pointer to the #IndicatorObjectEntry that
+			receives the scroll event.
+		@arg2: The delta of the scroll event
+		@arg3: The orientation of the scroll event.
+
+		When the indicator receives a mouse scroll wheel event
+		from the user, this signal is emitted.
+	*/
+	signals[SCROLL_ENTRY] = g_signal_new (INDICATOR_OBJECT_SIGNAL_SCROLL_ENTRY,
+	                                G_TYPE_FROM_CLASS(klass),
+	                                G_SIGNAL_RUN_LAST,
+	                                G_STRUCT_OFFSET (IndicatorObjectClass, scroll_entry),
+	                                NULL, NULL,
+	                                _indicator_object_marshal_VOID__POINTER_UINT_ENUM,
+	                                G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_UINT,
+	                                INDICATOR_OBJECT_TYPE_SCROLL_DIRECTION);
 
 	/**
 		IndicatorObject::menu-show:

=== modified file 'libindicator/indicator-object.h'
--- libindicator/indicator-object.h	2011-01-09 21:44:19 +0000
+++ libindicator/indicator-object.h	2011-01-27 11:27:12 +0000
@@ -51,6 +51,8 @@
 #define INDICATOR_OBJECT_SIGNAL_ENTRY_MOVED_ID    (g_signal_lookup(INDICATOR_OBJECT_SIGNAL_ENTRY_MOVED, INDICATOR_OBJECT_TYPE))
 #define INDICATOR_OBJECT_SIGNAL_SCROLL            "scroll"
 #define INDICATOR_OBJECT_SIGNAL_SCROLL_ID         (g_signal_lookup(INDICATOR_OBJECT_SIGNAL_SCROLL, INDICATOR_OBJECT_TYPE))
+#define INDICATOR_OBJECT_SIGNAL_SCROLL_ENTRY      "scroll-entry"
+#define INDICATOR_OBJECT_SIGNAL_SCROLL_ENTRY_ID   (g_signal_lookup(#define INDICATOR_OBJECT_SIGNAL_SCROLL_ENTRY, INDICATOR_OBJECT_TYPE))
 #define INDICATOR_OBJECT_SIGNAL_MENU_SHOW         "menu-show"
 #define INDICATOR_OBJECT_SIGNAL_MENU_SHOW_ID      (g_signal_lookup(INDICATOR_OBJECT_SIGNAL_MENU_SHOW, INDICATOR_OBJECT_TYPE))
 #define INDICATOR_OBJECT_SIGNAL_SHOW_NOW_CHANGED  "show-now-changed"
@@ -114,6 +116,7 @@
 	void       (*scroll)        (IndicatorObject * io, gint delta, IndicatorScrollDirection direction);
 	void       (*menu_show)     (IndicatorObject * io, IndicatorObjectEntry * entry, guint timestamp, gpointer user_data);
 	void       (*show_now_changed) (IndicatorObject * io, IndicatorObjectEntry * entry, gboolean show_now_state, gpointer user_data);
+	void       (*scroll_entry)  (IndicatorObject * io, IndicatorObjectEntry * entry, gint delta, IndicatorScrollDirection direction);
 
 	/* Reserved */
 	void       (*reserved1)     (void);
@@ -121,7 +124,6 @@
 	void       (*reserved3)     (void);
 	void       (*reserved4)     (void);
 	void       (*reserved5)     (void);
-	void       (*reserved6)     (void);
 };
 
 /**