Merge lp:~ted/libdbusmenu/handle-event-signal into lp:libdbusmenu/0.5

[Ted Gould]

Add a signal for generic events to make some situations where we don't have to subclass.

[Mikkel Kamstrup Erlandsen (kamstrup)]

It may be a good idea to follow the standard gtk event model here - use a signal which returns a gboolean TRUE if event propogation should be stopped?

Now that GLib has a build in accumulator g_signal_accumulator_true_handled this should be fairly easy.

review: Needs Information

[Ted Gould (ted)]

Good idea. Fixed in r204.

  review resubmit

review: Needs Resubmitting

[lp:~ted/libdbusmenu/handle-event-signal]

204. By Ted Gould on 2011-02-23

Switch signal handler to return bool so that we can signal if someone has handled it

[Mikkel Kamstrup Erlandsen (kamstrup)]

I like!

review: Approve

=== modified file 'libdbusmenu-glib/menuitem-marshal.list'
--- libdbusmenu-glib/menuitem-marshal.list	2010-11-18 03:11:40 +0000
+++ libdbusmenu-glib/menuitem-marshal.list	2011-02-23 15:38:29 +0000
@@ -4,3 +4,4 @@
 VOID: OBJECT
 VOID: VOID
 VOID: UINT
+BOOLEAN: STRING, VARIANT, UINT

=== modified file 'libdbusmenu-glib/menuitem.c'
--- libdbusmenu-glib/menuitem.c	2011-02-22 03:41:54 +0000
+++ libdbusmenu-glib/menuitem.c	2011-02-23 15:38:29 +0000
@@ -73,6 +73,7 @@
 	REALIZED,
 	SHOW_TO_USER,
 	ABOUT_TO_SHOW,
+	EVENT,
 	LAST_SIGNAL
 };
 
@@ -246,6 +247,23 @@
 	                                          NULL, NULL,
 	                                          _dbusmenu_menuitem_marshal_VOID__VOID,
 	                                          G_TYPE_BOOLEAN, 0, G_TYPE_NONE);
+	/**
+		DbusmenuMenuitem::event:
+		@arg0: The #DbusmenuMenuitem object.
+		@arg1: Name of the event
+		@arg2: Information passed along with the event
+		@arg3: X11 timestamp of when the event happened
+
+		Emitted when an event is passed through.  The event is signalled
+		after handle_event is called.
+	*/
+	signals[EVENT] =             g_signal_new(DBUSMENU_MENUITEM_SIGNAL_EVENT,
+	                                          G_TYPE_FROM_CLASS(klass),
+	                                          G_SIGNAL_RUN_LAST,
+	                                          G_STRUCT_OFFSET(DbusmenuMenuitemClass, event),
+	                                          g_signal_accumulator_true_handled, NULL,
+	                                          _dbusmenu_menuitem_marshal_BOOLEAN__STRING_VARIANT_UINT,
+	                                          G_TYPE_BOOLEAN, 3, G_TYPE_STRING, G_TYPE_VARIANT, G_TYPE_UINT);
 
 	g_object_class_install_property (object_class, PROP_ID,
 	                                 g_param_spec_int(PROP_ID_S, "ID for the menu item",
@@ -1515,9 +1533,13 @@
 	#endif
 	DbusmenuMenuitemClass * class = DBUSMENU_MENUITEM_GET_CLASS(mi);
 
-	if (class->handle_event != NULL) {
+	gboolean handled = FALSE;
+	g_signal_emit(G_OBJECT(mi), EVENT, g_quark_from_string(name), name, variant, timestamp, &handled);
+
+	if (!handled && class->handle_event != NULL) {
 		return class->handle_event(mi, name, variant, timestamp);
 	}
+
 	return;
 }
 

=== modified file 'libdbusmenu-glib/menuitem.h'
--- libdbusmenu-glib/menuitem.h	2011-02-21 12:12:33 +0000
+++ libdbusmenu-glib/menuitem.h	2011-02-23 15:38:29 +0000
@@ -51,6 +51,7 @@
 #define DBUSMENU_MENUITEM_SIGNAL_REALIZED_ID         (g_signal_lookup(DBUSMENU_MENUITEM_SIGNAL_REALIZED, DBUSMENU_TYPE_MENUITEM))
 #define DBUSMENU_MENUITEM_SIGNAL_SHOW_TO_USER        "show-to-user"
 #define DBUSMENU_MENUITEM_SIGNAL_ABOUT_TO_SHOW       "about-to-show"
+#define DBUSMENU_MENUITEM_SIGNAL_EVENT               "event"
 
 #define DBUSMENU_MENUITEM_PROP_TYPE                  "type"
 #define DBUSMENU_MENUITEM_PROP_VISIBLE               "visible"
@@ -134,6 +135,7 @@
  * @handle_event: This function is to override how events are handled by subclasses.  Look at #dbusmenu_menuitem_handle_event for lots of good information.
  * @send_about_to_show: Virtual function that notifies server that the client is about to show a menu.
  * @show_to_user: Slot for #DbusmenuMenuitem::show-to-user.
+ * @event: Slot for #DbsumenuMenuitem::event.
  *
  * @reserved1: Reserved for future use.
  * @reserved2: Reserved for future use.
@@ -163,13 +165,14 @@
 	void (*show_to_user) (DbusmenuMenuitem * mi, guint timestamp, gpointer cb_data);
 	gboolean (*about_to_show) (void);
 
+	void (*event) (const gchar * name, GVariant * value, guint timestamp);
+
 	/*< Private >*/
 	void (*reserved1) (void);
 	void (*reserved2) (void);
 	void (*reserved3) (void);
 	void (*reserved4) (void);
 	void (*reserved5) (void);
-	void (*reserved6) (void);
 };
 
 GType dbusmenu_menuitem_get_type (void);