* Now you need to tell gesture layer what gestures you follow.
* This is done with @ref elm_gesture_layer_cb_set call.
* By setting the callback you actually saying to gesture layer:
- * I would like to know when the gesture @ref Elm_Gesture_Types
+ * I would like to know when the gesture @ref Elm_Gesture_Type
* switches to state @ref Elm_Gesture_State.
*
* Next, you need to implement the actual action that follows the input
* (again with @ref elm_gesture_layer_cb_set)
*
* The information reported by gesture layer to your callback is depending
- * on @ref Elm_Gesture_Types:
+ * on @ref Elm_Gesture_Type:
* @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
* @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
* @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
* Setting glayer_continues_enable to false in @ref Config will change this behavior
* so gesture starts when user touches (a *DOWN event) touch-surface
* and ends when no fingers touches surface (a *UP event).
+ *
+ * Supported elm_object common APIs.
+ * @li elm_object_disabled_set
+ * @li elm_object_disabled_get
+ *
*/
/**
ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
- ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
+ ELM_GESTURE_MOMENTUM, /**< Reports momentum in the direction of move */
ELM_GESTURE_N_LINES, /**< N fingers line gesture */
ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
ELM_GESTURE_ROTATE, /**< Rotate */
ELM_GESTURE_LAST
-} Elm_Gesture_Types;
+} Elm_Gesture_Type;
/**
* @enum _Elm_Gesture_State
ELM_GESTURE_STATE_START, /**< Gesture STARTed */
ELM_GESTURE_STATE_MOVE, /**< Gesture is ongoing */
ELM_GESTURE_STATE_END, /**< Gesture completed */
- ELM_GESTURE_STATE_ABORT /**< Onging gesture was ABORTed */
+ ELM_GESTURE_STATE_ABORT /**< Ongoing gesture was ABORTed */
} Elm_Gesture_State;
/**
* it means user isn't interested in gesture-state
* and it will not be tested.
*
- * @param obj Pointer to gesture-layer.
+ * @param obj gesture-layer.
* @param idx The gesture you would like to track its state.
* @param cb callback function pointer.
* @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
*
* @ingroup Elm_Gesture_Layer
*/
-EAPI void elm_gesture_layer_cb_set(Evas_Object *obj, Elm_Gesture_Types idx, Elm_Gesture_State cb_type, Elm_Gesture_Event_Cb cb, void *data);
+EAPI void elm_gesture_layer_cb_set(Evas_Object *obj, Elm_Gesture_Type idx, Elm_Gesture_State cb_type, Elm_Gesture_Event_Cb cb, void *data);
/**
* Call this function to get repeat-events settings.
*
- * @param obj Pointer to gesture-layer.
+ * @param obj gesture-layer.
*
* @return repeat events settings.
* @see elm_gesture_layer_hold_events_set()
* @ingroup Elm_Gesture_Layer
*/
-EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj);
+EAPI Eina_Bool elm_gesture_layer_hold_events_get(const Evas_Object *obj);
/**
- * This function called in order to make gesture-layer repeat events.
- * Set this of you like to get the raw events only if gestures were not detected.
- * Clear this if you like gesture layer to fwd events as testing gestures.
+ * This function is to make gesture-layer repeat events.
+ * Set this if you like to get the raw events only if gestures were not
+ * detected.
+ * Clear this if you like gesture layer to forward events as testing gestures.
*
- * @param obj Pointer to gesture-layer.
- * @param r Repeat: TRUE/FALSE
+ * @param obj gesture layer.
+ * @param hold_events hold events or not.
*
* @ingroup Elm_Gesture_Layer
*/
-EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r);
+EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool hold_events);
/**
* This function sets step-value for zoom action.
* Set step to any positive value.
- * Cancel step setting by setting to 0.0
+ * Cancel step setting by setting to 0
+ *
+ * @param obj gesture-layer.
+ * @param step new zoom step value.
+ *
+ * @see elm_gesture_layer_zoom_step_get()
+ * @ingroup Elm_Gesture_Layer
+ */
+EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double step);
+
+/**
+ * This function returns step-value for zoom action.
*
- * @param obj Pointer to gesture-layer.
- * @param s new zoom step value.
+ * @param obj gesture-layer.
+ * @return zoom step value.
*
+ * @see elm_gesture_layer_zoom_step_set()
* @ingroup Elm_Gesture_Layer
*/
-EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s);
+EAPI double elm_gesture_layer_zoom_step_get(const Evas_Object *obj);
/**
* This function sets step-value for rotate action.
* Set step to any positive value.
- * Cancel step setting by setting to 0.0
+ * Cancel step setting by setting to 0
+ *
+ * @param obj gesture-layer.
+ * @param step new rotate step value.
+ *
+ * @ingroup Elm_Gesture_Layer
+ */
+EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double step);
+
+/**
+ * This function returns step-value for rotate action.
*
- * @param obj Pointer to gesture-layer.
- * @param s new roatate step value.
+ * @param obj gesture-layer.
+ * @return rotate step value.
*
* @ingroup Elm_Gesture_Layer
*/
-EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s);
+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 Pointer to gesture-layer.
- * @param t Pointer to underlying object (AKA Target)
+ * @param obj gesture-layer.
+ * @param target Pointer to underlying object (AKA Target)
*
* @return TRUE, FALSE on success, failure.
*
* @ingroup Elm_Gesture_Layer
*/
-EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t);
+EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *target);
/**
* Call this function to construct a new gesture-layer object.
*
* @param parent the parent object.
*
- * @return Pointer to new gesture-layer object.
+ * @return new gesture-layer object.
*
* @ingroup Elm_Gesture_Layer
*/
projects / framework / uifw / elementary.git / blobdiff