dimmus
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

gesture_layer: Fixed broken gesture layer documentation.

This commit is contained in:
Daniel Juyung Seo 2014-09-07 16:19:14 +09:00
parent fbee0944db
commit 9b50d76b4b
3 changed files with 93 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
legacy/elementary/src/lib/elm_gesture_layer.eo
View File

@ -9,7 +9,9 @@ class Elm_Gesture_Layer (Elm_Widget)
Set step to any positive value.
Cancel step setting by setting to 0
@see elm_gesture_layer_zoom_step_get() */
@see elm_gesture_layer_zoom_step_get()
@ingroup Elm_Gesture_Layer
*/
}
get {
/*@
@ -17,7 +19,9 @@ class Elm_Gesture_Layer (Elm_Widget)
@return zoom step value.
@see elm_gesture_layer_zoom_step_set() */
@see elm_gesture_layer_zoom_step_set()
@ingroup Elm_Gesture_Layer
*/
}
values {
double step; /*@ new zoom step value. */
@ -29,14 +33,18 @@ class Elm_Gesture_Layer (Elm_Widget)
@since 1.8
This function sets the gesture layer finger-size for taps
If not set, this size taken from elm_config.
Set to ZERO if you want GLayer to use system finger size value (default) */
Set to ZERO if you want GLayer to use system finger size value (default)
@ingroup Elm_Gesture_Layer
*/
}
get {
/*@
@since 1.8
This function returns the gesture layer finger-size for taps
@return Finger size that is currently used by Gesture Layer for taps. */
@return Finger size that is currently used by Gesture Layer for taps.
@ingroup Elm_Gesture_Layer
*/
}
values {
Evas_Coord sz; /*@ Finger size */
@ -48,14 +56,18 @@ class Elm_Gesture_Layer (Elm_Widget)
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. */
Clear this if you like gesture layer to forward events as testing gestures.
@ingroup Elm_Gesture_Layer
*/
}
get {
/*@
Call this function to get repeat-events settings.
@return repeat events settings.
@see elm_gesture_layer_hold_events_set() */
@see elm_gesture_layer_hold_events_set()
@ingroup Elm_Gesture_Layer
*/
}
values {
bool hold_events; /*@ hold events or not. */
@ -66,13 +78,17 @@ class Elm_Gesture_Layer (Elm_Widget)
/*@
This function sets step-value for rotate action.
Set step to any positive value.
Cancel step setting by setting to 0 */
Cancel step setting by setting to 0
@ingroup Elm_Gesture_Layer
*/
}
get {
/*@
This function returns step-value for rotate action.
@return rotate step value. */
@return rotate step value.
@ingroup Elm_Gesture_Layer
*/
}
values {
double step; /*@ new rotate step value. */
@ -88,7 +104,9 @@ class Elm_Gesture_Layer (Elm_Widget)
When ALL callbacks for a gesture are set to NULL
it means user isn't interested in gesture-state
and it will not be tested. */
and it will not be tested.
@ingroup Elm_Gesture_Layer
*/
}
values {
Elm_Gesture_Type idx; /*@ The gesture you would like to track its state. */
@ -108,7 +126,9 @@ class Elm_Gesture_Layer (Elm_Widget)
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. */
@return @c EINA_TRUE, on success, @c EINA_FALSE otherwise.
@ingroup Elm_Gesture_Layer
*/
return: bool;
params {
@ -118,7 +138,9 @@ class Elm_Gesture_Layer (Elm_Widget)
cb_del {
/*@
Use this function to remove a callback that has been added
to be notified about change of state of gesture. */
to be notified about change of state of gesture.
@ingroup Elm_Gesture_Layer
*/
params {
@in Elm_Gesture_Type idx; /*@ The gesture you would like to track its state. */
@ -141,7 +163,9 @@ class Elm_Gesture_Layer (Elm_Widget)
If a function was already set for this gesture/type/state, it will be
replaced by the new one. For ABI compat, callbacks added by
elm_gesture_layer_cb_add will be removed. It is recommended to
use only one of these functions for a gesture object. */
use only one of these functions for a gesture object.
@ingroup Elm_Gesture_Layer
*/
params {
@in Elm_Gesture_Type idx; /*@ The gesture you would like to track its state. */

53
legacy/elementary/src/lib/elm_gesture_layer_common.h
View File

@ -1,6 +1,8 @@
/**
* @enum _Elm_Gesture_Type
* Enum of supported gesture types.
* @ingroup Elm_Gesture_Layer
*/
enum _Elm_Gesture_Type
{
@ -25,12 +27,16 @@ enum _Elm_Gesture_Type
/**
* @typedef Elm_Gesture_Type
* Convenient macro around #_Elm_Gesture_Type
*
* @ingroup Elm_Gesture_Layer
*/
typedef enum _Elm_Gesture_Type Elm_Gesture_Type;
/**
* @enum _Elm_Gesture_State
* Enum of gesture states.
*
* @ingroup Elm_Gesture_Layer
*/
enum _Elm_Gesture_State
{
@ -44,12 +50,16 @@ enum _Elm_Gesture_State
/**
* @typedef Elm_Gesture_State
* Convenient macro around #_Elm_Gesture_State
*
* @ingroup Elm_Gesture_Layer
*/
typedef enum _Elm_Gesture_State Elm_Gesture_State;
/**
* @struct _Elm_Gesture_Taps_Info
* Struct holds taps info for user
*
* @ingroup Elm_Gesture_Layer
*/
struct _Elm_Gesture_Taps_Info
{
@ -61,6 +71,8 @@ struct _Elm_Gesture_Taps_Info
/**
* @typedef Elm_Gesture_Taps_Info
* holds taps info for user
*
* @ingroup Elm_Gesture_Layer
*/
typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
@ -71,6 +83,8 @@ typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
* x1 holds x value of x direction starting point
* and same holds for y1.
* This is noticeable when doing V-shape movement
*
* @ingroup Elm_Gesture_Layer
*/
struct _Elm_Gesture_Momentum_Info /* Report line ends, timestamps, and momentum computed */
{Evas_Coord x1; /**< Final-swipe direction starting point on X */
@ -90,12 +104,16 @@ struct _Elm_Gesture_Momentum_Info /* Report line ends, timestamps, and momentum
/**
* @typedef Elm_Gesture_Momentum_Info
* holds momentum info for user
*
* @ingroup Elm_Gesture_Layer
*/
typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
/**
* @struct _Elm_Gesture_Line_Info
* Struct holds line info for user
*
* @ingroup Elm_Gesture_Layer
*/
struct _Elm_Gesture_Line_Info /* Report line ends, timestamps, and momentum computed */
{Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
@ -105,12 +123,16 @@ struct _Elm_Gesture_Line_Info /* Report line ends, timestamps, and momentum co
/**
* @typedef Elm_Gesture_Line_Info
* Holds line info for user
*
* @ingroup Elm_Gesture_Layer
*/
typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
/**
* @struct _Elm_Gesture_Zoom_Info
* Struct holds zoom info for user
*
* @ingroup Elm_Gesture_Layer
*/
struct _Elm_Gesture_Zoom_Info
{
@ -123,12 +145,16 @@ struct _Elm_Gesture_Zoom_Info
/**
* @typedef Elm_Gesture_Zoom_Info
* Holds zoom info for user
*
* @ingroup Elm_Gesture_Layer
*/
typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
/**
* @struct _Elm_Gesture_Rotate_Info
* Struct holds rotation info for user
*
* @ingroup Elm_Gesture_Layer
*/
struct _Elm_Gesture_Rotate_Info
{
@ -142,6 +168,8 @@ struct _Elm_Gesture_Rotate_Info
/**
* @typedef Elm_Gesture_Rotate_Info
* Holds rotation info for user
*
* @ingroup Elm_Gesture_Layer
*/
typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
@ -154,6 +182,7 @@ typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
* You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
* upon the event, in an irreversible way.
*
* @ingroup Elm_Gesture_Layer
*/
typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb)(void *data, void *event_info);
@ -164,6 +193,7 @@ typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb)(void *data, void *event_info);
* @param obj gesture-layer.
* @param line_min_length the length.
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_line_min_length_set(Evas_Object *obj, int line_min_length);
@ -174,6 +204,7 @@ EAPI void elm_gesture_layer_line_min_length_set(Evas_Object *obj, int line_min_l
* @param obj gesture-layer.
* @return the length.
*
* @ingroup Elm_Gesture_Layer
*/
EAPI int elm_gesture_layer_line_min_length_get(const Evas_Object *obj);
@ -184,6 +215,7 @@ EAPI int elm_gesture_layer_line_min_length_get(const Evas_Object *obj);
* @param obj gesture-layer.
* @param zoom_distance_tolerance zoom distance tolerance
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_zoom_distance_tolerance_set(Evas_Object *obj, Evas_Coord zoom_distance_tolerance);
@ -194,6 +226,7 @@ EAPI void elm_gesture_layer_zoom_distance_tolerance_set(Evas_Object *obj, Evas_C
* @param obj gesture-layer.
* @return zoom distance tolerance
*
* @ingroup Elm_Gesture_Layer
*/
EAPI Evas_Coord elm_gesture_layer_zoom_distance_tolerance_get(const Evas_Object *obj);
@ -204,6 +237,7 @@ EAPI Evas_Coord elm_gesture_layer_zoom_distance_tolerance_get(const Evas_Object
* @param obj gesture-layer.
* @param line_distance_tolerance line distance tolerance
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_line_distance_tolerance_set(Evas_Object *obj, Evas_Coord line_distance_tolerance);
@ -214,6 +248,7 @@ EAPI void elm_gesture_layer_line_distance_tolerance_set(Evas_Object *obj, Evas_C
* @param obj gesture-layer.
* @return line distance tolerance
*
* @ingroup Elm_Gesture_Layer
*/
EAPI Evas_Coord elm_gesture_layer_line_distance_tolerance_get(const Evas_Object *obj);
@ -224,6 +259,7 @@ EAPI Evas_Coord elm_gesture_layer_line_distance_tolerance_get(const Evas_Object
* @param obj gesture-layer.
* @param line_angular_tolerance line angular tolerance
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_line_angular_tolerance_set(Evas_Object *obj, double line_angular_tolerance);
@ -234,6 +270,7 @@ EAPI void elm_gesture_layer_line_angular_tolerance_set(Evas_Object *obj, double
* @param obj gesture-layer.
* @return line angular tolerance
*
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_line_angular_tolerance_get(const Evas_Object *obj);
@ -244,6 +281,7 @@ EAPI double elm_gesture_layer_line_angular_tolerance_get(const Evas_Object *obj)
* @param obj gesture-layer.
* @param zoom_wheel_factor zoom wheel factor
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_zoom_wheel_factor_set(Evas_Object *obj, double zoom_wheel_factor);
@ -254,6 +292,7 @@ EAPI void elm_gesture_layer_zoom_wheel_factor_set(Evas_Object *obj, double zoom_
* @param obj gesture-layer.
* @return zoom wheel factor
*
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_zoom_wheel_factor_get(const Evas_Object *obj);
@ -264,6 +303,7 @@ EAPI double elm_gesture_layer_zoom_wheel_factor_get(const Evas_Object *obj);
* @param obj gesture-layer.
* @param zoom_finger_factor zoom finger factor
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_zoom_finger_factor_set(Evas_Object *obj, double zoom_finger_factor);
@ -274,6 +314,7 @@ EAPI void elm_gesture_layer_zoom_finger_factor_set(Evas_Object *obj, double zoom
* @param obj gesture-layer.
* @return zoom finger factor
*
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_zoom_finger_factor_get(const Evas_Object *obj);
@ -284,6 +325,7 @@ EAPI double elm_gesture_layer_zoom_finger_factor_get(const Evas_Object *obj);
* @param obj gesture-layer.
* @param rotate_angular_tolerance rotate angular tolerance
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_rotate_angular_tolerance_set(Evas_Object *obj, double rotate_angular_tolerance);
@ -294,6 +336,7 @@ EAPI void elm_gesture_layer_rotate_angular_tolerance_set(Evas_Object *obj, doubl
* @param obj gesture-layer.
* @return rotate angular tolerance
*
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_rotate_angular_tolerance_get(const Evas_Object *obj);
@ -304,6 +347,7 @@ EAPI double elm_gesture_layer_rotate_angular_tolerance_get(const Evas_Object *ob
* @param obj gesture-layer.
* @param flick_time_limit_ms flick time limit (in ms)
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_flick_time_limit_ms_set(Evas_Object *obj, unsigned int flick_time_limit_ms);
@ -314,6 +358,7 @@ EAPI void elm_gesture_layer_flick_time_limit_ms_set(Evas_Object *obj, unsigned i
* @param obj gesture-layer.
* @return flick time limit (in ms)
*
* @ingroup Elm_Gesture_Layer
*/
EAPI unsigned int elm_gesture_layer_flick_time_limit_ms_get(const Evas_Object *obj);
@ -324,6 +369,7 @@ EAPI unsigned int elm_gesture_layer_flick_time_limit_ms_get(const Evas_Object *o
* @param obj gesture-layer.
* @param long_tap_start_timeout long tap start timeout
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_long_tap_start_timeout_set(Evas_Object *obj, double long_tap_start_timeout);
@ -334,6 +380,7 @@ EAPI void elm_gesture_layer_long_tap_start_timeout_set(Evas_Object *obj, double
* @param obj gesture-layer.
* @return long tap start timeout
*
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_long_tap_start_timeout_get(const Evas_Object *obj);
@ -344,6 +391,7 @@ EAPI double elm_gesture_layer_long_tap_start_timeout_get(const Evas_Object *obj)
* @param obj gesture-layer.
* @param continues_enable continues enable
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_continues_enable_set(Evas_Object *obj, Eina_Bool continues_enable);
@ -354,6 +402,7 @@ EAPI void elm_gesture_layer_continues_enable_set(Evas_Object *obj, Eina_Bool con
* @param obj gesture-layer.
* @return continues enable
*
* @ingroup Elm_Gesture_Layer
*/
EAPI Eina_Bool elm_gesture_layer_continues_enable_get(const Evas_Object *obj);
@ -364,6 +413,7 @@ EAPI Eina_Bool elm_gesture_layer_continues_enable_get(const Evas_Object *obj);
* @param obj gesture-layer.
* @param double_tap_timeout double tap timeout
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_double_tap_timeout_set(Evas_Object *obj, double double_tap_timeout);
@ -374,6 +424,7 @@ EAPI void elm_gesture_layer_double_tap_timeout_set(Evas_Object *obj, double doub
* @param obj gesture-layer.
* @return double tap timeout
*
* @ingroup Elm_Gesture_Layer
*/
EAPI double elm_gesture_layer_double_tap_timeout_get(const Evas_Object *obj);
@ -386,6 +437,7 @@ EAPI double elm_gesture_layer_double_tap_timeout_get(const Evas_Object *obj);
* @param obj gesture-layer.
* @param fsize Finger size
*
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_tap_finger_size_set(Evas_Object *obj, Evas_Coord sz);
@ -396,5 +448,6 @@ EAPI void elm_gesture_layer_tap_finger_size_set(Evas_Object *obj, Evas_Coord sz)
* @param obj gesture-layer.
* @return Finger size that is currently used by Gesture Layer for taps.
*
* @ingroup Elm_Gesture_Layer
*/
EAPI Evas_Coord elm_gesture_layer_tap_finger_size_get(const Evas_Object *obj);

5
legacy/elementary/src/lib/elm_gesture_layer_legacy.h
View File

@ -8,6 +8,7 @@
* This does not activate the gesture layer. You have to
* call elm_gesture_layer_attach() in order to 'activate' gesture-layer.
*
* @ingroup Elm_Gesture_Layer
*/
EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent);
@ -29,6 +30,7 @@ EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent);
* You can remove the callbacks by using elm_gesture_layer_tap_longpress_cb_del.
*
* @see elm_gesture_layer_tap_longpress_cb_del
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_tap_longpress_cb_add(Evas_Object *obj, Elm_Gesture_State state, Elm_Gesture_Event_Cb cb, void *data);
@ -45,7 +47,8 @@ EAPI void elm_gesture_layer_tap_longpress_cb_add(Evas_Object *obj, Elm_Gesture_S
* this function.
*
* @see elm_gesture_layer_tap_longpress_cb_add
* @ingroup Elm_Gesture_Layer
*/
EAPI void elm_gesture_layer_tap_longpress_cb_del(Evas_Object *obj, Elm_Gesture_State state, Elm_Gesture_Event_Cb cb, void *data);
#include "elm_gesture_layer.eo.legacy.h"
#include "elm_gesture_layer.eo.legacy.h"