efl/legacy/elementary/src/lib/elm_gesture_layer.eo

189 lines
6.0 KiB
Plaintext

class Elm_Gesture_Layer (Elm_Widget)
{
eo_prefix: elm_obj_gesture_layer;
properties {
zoom_step {
set {
/*@
This function sets step-value for zoom action.
Set step to any positive value.
Cancel step setting by setting to 0
@see elm_gesture_layer_zoom_step_get()
@ingroup Elm_Gesture_Layer
*/
}
get {
/*@
This function returns step-value for zoom action.
@return zoom step value.
@see elm_gesture_layer_zoom_step_set()
@ingroup Elm_Gesture_Layer
*/
}
values {
double step; /*@ new zoom step value. */
}
}
tap_finger_size {
set {
/*@
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)
@since 1.8
@ingroup Elm_Gesture_Layer
*/
}
get {
/*@
This function returns the gesture layer finger-size for taps
@return Finger size that is currently used by Gesture Layer for taps.
@since 1.8
@ingroup Elm_Gesture_Layer
*/
}
values {
Evas_Coord sz; /*@ Finger size */
}
}
hold_events {
set {
/*@
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.
@ingroup Elm_Gesture_Layer
*/
}
get {
/*@
Call this function to get repeat-events settings.
@return repeat events settings.
@see elm_gesture_layer_hold_events_set()
@ingroup Elm_Gesture_Layer
*/
}
values {
bool hold_events; /*@ hold events or not. */
}
}
rotate_step {
set {
/*@
This function sets step-value for rotate action.
Set step to any positive value.
Cancel step setting by setting to 0
@ingroup Elm_Gesture_Layer
*/
}
get {
/*@
This function returns step-value for rotate action.
@return rotate step value.
@ingroup Elm_Gesture_Layer
*/
}
values {
double step; /*@ new rotate step value. */
}
}
cb {
set {
/*@
Use function to set callbacks to be notified about
change of state of gesture.
When a user registers a callback with this function
this means this gesture has to be tested.
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.
@ingroup Elm_Gesture_Layer
*/
}
values {
Elm_Gesture_Type idx; /*@ The gesture you would like to track its state. */
Elm_Gesture_State cb_type; /*@ what event this callback tracks: START, MOVE, END, ABORT. */
Elm_Gesture_Event_Cb cb; /*@ callback function pointer. */
void *data; /*@ user info to be sent to callback (usually, Smart Data) */
}
}
}
methods {
attach {
/*@
Attach a given gesture layer widget to an Evas object, thus setting
the widget's @b 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.
@ingroup Elm_Gesture_Layer
*/
return: bool;
params {
@in Evas_Object *target; /*@ Object to attach to @a obj (target) */
}
}
cb_del {
/*@
Use this function to remove a callback that has been added
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. */
@in Elm_Gesture_State cb_type; /*@ what event this callback tracks: START, MOVE, END, ABORT. */
@in Elm_Gesture_Event_Cb cb; /*@ callback function pointer. */
@in void *data; /*@ user info for the callback (usually, Smart Data) */
}
}
cb_add {
/*@
Use function to add callbacks to be notified about
change of state of gesture.
When a user registers a callback with this function
this means this gesture has to be tested.
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.
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.
@ingroup Elm_Gesture_Layer
*/
params {
@in Elm_Gesture_Type idx; /*@ The gesture you would like to track its state. */
@in Elm_Gesture_State cb_type; /*@ what event this callback tracks: START, MOVE, END, ABORT. */
@in Elm_Gesture_Event_Cb cb; /*@ callback function pointer. */
@in void *data; /*@ user info to be sent to callback (usually, Smart Data) */
}
}
}
implements {
class.constructor;
Eo.Base.constructor;
Evas.Object_Smart.add;
Evas.Object_Smart.del;
Elm_Widget.disable;
}
}