E SVN: glima IN trunk/elementary/src: bin lib

[Enlightenment S. <no-...@en...>]

Log:
Be clear about gesture layer's usage.
  Elm widget as parent, any Evas object as target.
  
  

Author:       glima
Date:         2012-06-13 10:21:13 -0700 (Wed, 13 Jun 2012)
New Revision: 72091
Trac:         http://trac.enlightenment.org/e/changeset/72091

Modified:
  trunk/elementary/src/bin/test_gesture_layer2.c trunk/elementary/src/lib/elm_gesture_layer.h 

Modified: trunk/elementary/src/bin/test_gesture_layer2.c
===================================================================
--- trunk/elementary/src/bin/test_gesture_layer2.c	2012-06-13 15:39:10 UTC (rev 72090)
+++ trunk/elementary/src/bin/test_gesture_layer2.c	2012-06-13 17:21:13 UTC (rev 72091)
@@ -671,7 +671,7 @@
    r = evas_object_rectangle_add(evas_object_evas_get(win));
    evas_object_color_set(r, 0, 0, 0, 0);
    elm_win_resize_object_add(win, r);
-   g = elm_gesture_layer_add(r);
+   g = elm_gesture_layer_add(win);
    elm_gesture_layer_attach(g, r);
    evas_object_show(r);
 

Modified: trunk/elementary/src/lib/elm_gesture_layer.h
===================================================================
--- trunk/elementary/src/lib/elm_gesture_layer.h	2012-06-13 15:39:10 UTC (rev 72090)
+++ trunk/elementary/src/lib/elm_gesture_layer.h	2012-06-13 17:21:13 UTC (rev 72091)
@@ -310,24 +310,31 @@
 EAPI double       elm_gesture_layer_rotate_step_get(const Evas_Object *obj);
 
 /**
- * This function called to attach gesture-layer to an Evas_Object.
- * @param obj gesture-layer.
- * @param target Pointer to underlying object (AKA Target)
+ * Attach a given gesture layer widget to an Evas object, thus setting
+ * the widget's @b target.
  *
- * @return TRUE, FALSE on success, failure.
+ * @param obj A gesture layer to attach an object to.
+ * @param target Object to attach to @a obj (target)
  *
+ * A gesture layer target may be whichever Evas object one
+ * chooses. This will be object @a obj will listen all mouse and key
+ * events from, to report the gestures made upon it back.
+ *
+ * @return @c EINA_TRUE, on success, @c EINA_FALSE otherwise.
+ *
  */
 EAPI Eina_Bool    elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *target);
 
 /**
  * Call this function to construct a new gesture-layer object.
- * This does not activate the gesture layer. You have to
- * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
  *
- * @param parent the parent object.
+ * @param parent The gesture layer's parent widget.
  *
- * @return new gesture-layer object.
+ * @return A new gesture layer object.
  *
+ * This does not activate the gesture layer. You have to
+ * call elm_gesture_layer_attach() in order to 'activate' gesture-layer.
+ *
  */
 EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent);