[gtk+/gestures: 2/117] Add GtkEventController

[Carlos Garnacho <carlosg src gnome org>]

commit a2a218089496139ee4c578d4551e25f9e27f683c
Author: Carlos Garnacho <carlosg gnome org>
Date:   Thu Jan 17 20:55:24 2013 +0100

    Add GtkEventController
    
    This is a basic abstract type that handles GdkEvents.

 gtk/Makefile.am          |    2 +
 gtk/gtk.h                |    1 +
 gtk/gtkeventcontroller.c |  265 ++++++++++++++++++++++++++++++++++++++++++++++
 gtk/gtkeventcontroller.h |   79 ++++++++++++++
 4 files changed, 347 insertions(+), 0 deletions(-)
---
diff --git a/gtk/Makefile.am b/gtk/Makefile.am
index c281666..80e9cc0 100644
--- a/gtk/Makefile.am
+++ b/gtk/Makefile.am
@@ -261,6 +261,7 @@ gtk_public_h_sources =              \
        gtkentrycompletion.h    \
        gtkenums.h              \
        gtkeventbox.h           \
+       gtkeventcontroller.h    \
        gtkexpander.h           \
        gtkfilechooser.h        \
        gtkfilechooserbutton.h  \
@@ -739,6 +740,7 @@ gtk_base_c_sources =                \
        gtkentrybuffer.c        \
        gtkentrycompletion.c    \
        gtkeventbox.c           \
+       gtkeventcontroller.c    \
        gtkexpander.c           \
        gtkfilechooser.c        \
        gtkfilechooserbutton.c  \
diff --git a/gtk/gtk.h b/gtk/gtk.h
index 16357c1..1b74eaf 100644
--- a/gtk/gtk.h
+++ b/gtk/gtk.h
@@ -93,6 +93,7 @@
 #include <gtk/gtkentrycompletion.h>
 #include <gtk/gtkenums.h>
 #include <gtk/gtkeventbox.h>
+#include <gtk/gtkeventcontroller.h>
 #include <gtk/gtkexpander.h>
 #include <gtk/gtkfixed.h>
 #include <gtk/gtkfilechooser.h>
diff --git a/gtk/gtkeventcontroller.c b/gtk/gtkeventcontroller.c
new file mode 100644
index 0000000..cf89152
--- /dev/null
+++ b/gtk/gtkeventcontroller.c
@@ -0,0 +1,265 @@
+/* GTK - The GIMP Toolkit
+ * Copyright (C) 2012, One Laptop Per Child.
+ * Copyright (C) 2014, Red Hat, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author(s): Carlos Garnacho <carlosg gnome org>
+ */
+#include "config.h"
+#include <gtk/gtkeventcontroller.h>
+#include "gtkmarshalers.h"
+#include "gtkprivate.h"
+#include "gtkintl.h"
+
+typedef struct _GtkEventControllerPrivate GtkEventControllerPrivate;
+
+enum {
+  PROP_WIDGET = 1,
+  PROP_EVENT_MASK
+};
+
+enum {
+  HANDLE_EVENT,
+  RESET,
+  N_SIGNALS
+};
+
+struct _GtkEventControllerPrivate
+{
+  GtkWidget *widget;
+  guint evmask;
+};
+
+guint signals[N_SIGNALS] = { 0 };
+
+G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (GtkEventController, gtk_event_controller, G_TYPE_OBJECT)
+
+static gboolean
+gtk_event_controller_handle_event_default (GtkEventController *controller,
+                                           const GdkEvent     *event)
+{
+  return FALSE;
+}
+
+static void
+gtk_event_controller_set_property (GObject      *object,
+                                   guint         prop_id,
+                                   const GValue *value,
+                                   GParamSpec   *pspec)
+{
+  GtkEventControllerPrivate *priv;
+
+  priv = gtk_event_controller_get_instance_private (GTK_EVENT_CONTROLLER (object));
+
+  switch (prop_id)
+    {
+    case PROP_WIDGET:
+      priv->widget = g_value_get_object (value);
+      break;
+    case PROP_EVENT_MASK:
+      priv->evmask = g_value_get_flags (value);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+gtk_event_controller_get_property (GObject    *object,
+                                   guint       prop_id,
+                                   GValue     *value,
+                                   GParamSpec *pspec)
+{
+  GtkEventControllerPrivate *priv;
+
+  priv = gtk_event_controller_get_instance_private (GTK_EVENT_CONTROLLER (object));
+
+  switch (prop_id)
+    {
+    case PROP_WIDGET:
+      g_value_set_object (value, priv->widget);
+      break;
+    case PROP_EVENT_MASK:
+      g_value_set_flags (value, priv->evmask);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+
+static void
+gtk_event_controller_class_init (GtkEventControllerClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  klass->handle_event = gtk_event_controller_handle_event_default;
+
+  object_class->set_property = gtk_event_controller_set_property;
+  object_class->get_property = gtk_event_controller_get_property;
+
+  g_object_class_install_property (object_class,
+                                   PROP_WIDGET,
+                                   g_param_spec_object ("widget",
+                                                        P_("Widget"),
+                                                        P_("Widget the gesture relates to"),
+                                                        GTK_TYPE_WIDGET,
+                                                        GTK_PARAM_READWRITE |
+                                                        G_PARAM_CONSTRUCT_ONLY));
+  g_object_class_install_property (object_class,
+                                   PROP_EVENT_MASK,
+                                   g_param_spec_flags ("event-mask",
+                                                       P_("Event mask"),
+                                                       P_("Event mask the controller handles"),
+                                                       GDK_TYPE_EVENT_MASK, 0,
+                                                       GTK_PARAM_READWRITE));
+  signals[HANDLE_EVENT] =
+    g_signal_new ("handle-event",
+                  G_TYPE_FROM_CLASS (klass),
+                  G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
+                  G_STRUCT_OFFSET (GtkEventControllerClass, handle_event),
+                  g_signal_accumulator_true_handled, NULL, NULL,
+                  G_TYPE_BOOLEAN, 1,
+                  GDK_TYPE_EVENT | G_SIGNAL_TYPE_STATIC_SCOPE);
+  signals[RESET] =
+    g_signal_new ("reset",
+                  G_TYPE_FROM_CLASS (klass),
+                  G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
+                  G_STRUCT_OFFSET (GtkEventControllerClass, reset),
+                  NULL, NULL, NULL,
+                  G_TYPE_NONE, 0);
+}
+
+static void
+gtk_event_controller_init (GtkEventController *controller)
+{
+}
+
+/**
+ * gtk_event_controller_handle_event:
+ * @controller: a #GtkEventController
+ * @event: a #GdkEvent
+ *
+ * Feeds an events into @controller, so it can be interpreted
+ * and the controller actions triggered.
+ *
+ * Returns: %TRUE if the event was potentially useful to trigger the
+ *          controller action.
+ *
+ * Since: 3.14
+ **/
+gboolean
+gtk_event_controller_handle_event (GtkEventController *controller,
+                                   const GdkEvent     *event)
+{
+  gboolean retval = FALSE;
+
+  g_return_val_if_fail (GTK_IS_EVENT_CONTROLLER (controller), FALSE);
+  g_return_val_if_fail (event != NULL, FALSE);
+
+  g_signal_emit (controller, signals[HANDLE_EVENT], 0, event, &retval);
+
+  return retval;
+}
+
+/**
+ * gtk_event_controller_set_event_mask:
+ * @controller: a #GtkEventController
+ * @event_mask: mask for the events the controller handles
+ *
+ * Sets the event mask that the controller handles. This is only
+ * meant for #GtkEventController implementations and should not be
+ * called in applications.
+ *
+ * Since: 3.14
+ **/
+void
+gtk_event_controller_set_event_mask (GtkEventController *controller,
+                                     GdkEventMask        event_mask)
+{
+  GtkEventControllerPrivate *priv;
+
+  g_return_if_fail (GTK_IS_EVENT_CONTROLLER (controller));
+
+  priv = gtk_event_controller_get_instance_private (controller);
+
+  if (priv->evmask == event_mask)
+    return;
+
+  priv->evmask = event_mask;
+  g_object_notify (G_OBJECT (controller), "event-mask");
+}
+
+/**
+ * gtk_event_controller_get_event_mask:
+ * @controller: a #GtkEventController
+ *
+ * Returns the event mask necessary for the events handled by @controller.
+ *
+ * Returns: the controller event mask.
+ *
+ * Since: 3.14
+ **/
+GdkEventMask
+gtk_event_controller_get_event_mask (GtkEventController *controller)
+{
+  GtkEventControllerPrivate *priv;
+
+  g_return_val_if_fail (GTK_IS_EVENT_CONTROLLER (controller), 0);
+
+  priv = gtk_event_controller_get_instance_private (controller);
+
+  return priv->evmask;
+}
+
+/**
+ * gtk_event_controller_get_widget:
+ * @controller: a #GtkEventController
+ *
+ * Returns the #GtkWidget this controller relates to.
+ *
+ * Returns: a #GtkWidget
+ *
+ * Since: 3.14
+ **/
+GtkWidget *
+gtk_event_controller_get_widget (GtkEventController *controller)
+{
+  GtkEventControllerPrivate *priv;
+
+  g_return_val_if_fail (GTK_IS_EVENT_CONTROLLER (controller), 0);
+
+  priv = gtk_event_controller_get_instance_private (controller);
+
+  return priv->widget;
+}
+
+/**
+ * gtk_event_controller_reset:
+ * @controller: a #GtkEventController
+ *
+ * Resets the @controller to a clean state. Every interaction
+ * the controller did through #GtkEventController::handle-event
+ * will be dropped at this point.
+ *
+ * Since: 3.14
+ **/
+void
+gtk_event_controller_reset (GtkEventController *controller)
+{
+  g_return_if_fail (GTK_IS_EVENT_CONTROLLER (controller));
+
+  g_signal_emit (controller, signals[RESET], 0);
+}
diff --git a/gtk/gtkeventcontroller.h b/gtk/gtkeventcontroller.h
new file mode 100644
index 0000000..12c5d2a
--- /dev/null
+++ b/gtk/gtkeventcontroller.h
@@ -0,0 +1,79 @@
+/* GTK - The GIMP Toolkit
+ * Copyright (C) 2012, One Laptop Per Child.
+ * Copyright (C) 2014, Red Hat, Inc.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Author(s): Carlos Garnacho <carlosg gnome org>
+ */
+#ifndef __GTK_EVENT_CONTROLLER_H__
+#define __GTK_EVENT_CONTROLLER_H__
+
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
+typedef struct _GtkEventController GtkEventController;
+typedef struct _GtkEventControllerClass GtkEventControllerClass;
+
+#include <gdk/gdk.h>
+#include <gtk/gtktypes.h>
+
+G_BEGIN_DECLS
+
+#define GTK_TYPE_EVENT_CONTROLLER         (gtk_event_controller_get_type ())
+#define GTK_EVENT_CONTROLLER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GTK_TYPE_EVENT_CONTROLLER, 
GtkEventController))
+#define GTK_EVENT_CONTROLLER_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), GTK_TYPE_EVENT_CONTROLLER, 
GtkEventControllerClass))
+#define GTK_IS_EVENT_CONTROLLER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_EVENT_CONTROLLER))
+#define GTK_IS_EVENT_CONTROLLER_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), GTK_TYPE_EVENT_CONTROLLER))
+#define GTK_EVENT_CONTROLLER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GTK_TYPE_EVENT_CONTROLLER, 
GtkEventControllerClass))
+
+struct _GtkEventController
+{
+  GObject parent_instance;
+};
+
+struct _GtkEventControllerClass
+{
+  GObjectClass parent_class;
+
+  gboolean (* handle_event) (GtkEventController *controller,
+                             const GdkEvent     *event);
+  void     (* reset)        (GtkEventController *controller);
+
+  /*<private>*/
+  gpointer padding[10];
+};
+
+GDK_AVAILABLE_IN_3_14
+GType        gtk_event_controller_get_type       (void) G_GNUC_CONST;
+
+GDK_AVAILABLE_IN_3_14
+GtkWidget  * gtk_event_controller_get_widget     (GtkEventController *controller);
+
+GDK_AVAILABLE_IN_3_14
+void         gtk_event_controller_set_event_mask (GtkEventController *controller,
+                                                  GdkEventMask        event_mask);
+GDK_AVAILABLE_IN_3_14
+GdkEventMask gtk_event_controller_get_event_mask (GtkEventController *controller);
+
+GDK_AVAILABLE_IN_3_14
+gboolean     gtk_event_controller_handle_event   (GtkEventController *controller,
+                                                  const GdkEvent     *event);
+GDK_AVAILABLE_IN_3_14
+void         gtk_event_controller_reset          (GtkEventController *controller);
+
+G_END_DECLS
+
+#endif /* __GTK_EVENT_CONTROLLER_H__ */