[gtk+/gestures: 74/117] eventcontroller: Add documentation blurb
- From: Carlos Garnacho <carlosg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+/gestures: 74/117] eventcontroller: Add documentation blurb
- Date: Thu, 10 Apr 2014 20:30:55 +0000 (UTC)
commit b20f1ad11a5a72b0e66b5a9c9305eea834b34036
Author: Carlos Garnacho <carlosg gnome org>
Date: Tue Apr 8 21:01:13 2014 +0200
eventcontroller: Add documentation blurb
gtk/gtkeventcontroller.c | 21 +++++++++++++++++++++
1 files changed, 21 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkeventcontroller.c b/gtk/gtkeventcontroller.c
index a4d294d..1b3df34 100644
--- a/gtk/gtkeventcontroller.c
+++ b/gtk/gtkeventcontroller.c
@@ -17,6 +17,27 @@
*
* Author(s): Carlos Garnacho <carlosg gnome org>
*/
+
+/**
+ * SECTION:gtkeventcontroller
+ * @Short_description: Self-contained handler of series of events
+ * @Title: GtkEventController
+ * @See_also: #GtkGesture
+ *
+ * #GtkEventController is a base, low-level implementation for event
+ * controllers. Those react to a series of events, and possibly trigger
+ * actions as a consequence of those.
+ *
+ * Most usually, event controllers are attached to a widget through
+ * gtk_widget_add_controller(). This ensures events received by the
+ * widget are delivered to the controller. On special situations,
+ * manual delivery may be desired, this can be achieved by setting
+ * the capture phase to %GTK_PHASE_NONE and feeding events manually
+ * through gtk_event_controller_handle_event(). See
+ * gtk_event_controller_set_propagation_phase() and #GtkPropagationPhase
+ * to know more about how events are delivered to event controllers.
+ */
+
#include "config.h"
#include <gtk/gtkeventcontroller.h>
#include "gtktypebuiltins.h"
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]