efl/src/lib/evas/gesture/efl_canvas_gesture_recogniz...

58 lines
2.3 KiB
Plaintext

import efl_canvas_gesture_types;
abstract @beta Efl.Canvas.Gesture_Recognizer extends Efl.Object
{
[[Base abstract class for Gesture Recognizers. For internal use only.
Gesture recognizers listen to events that occur on a target object
to see if a particular gesture has occurred.
Recognizer-specific configuration values can be modified through @Efl.Config.config,
and the global config object can be found using @Efl.Object.provider_find.
Default configuration values are taken from the system's configuration.
]]
c_prefix: efl_gesture_recognizer;
methods {
add @pure_virtual {
[[This function is called to create a new @Efl.Canvas.Gesture object for the given target.]]
params {
@in target: Efl.Object; [[The target canvas object.]]
}
return: Efl.Canvas.Gesture; [[Returns the gesture object that will be used to track this gesture.]]
}
recognize @pure_virtual {
[[Analyzes the given $event and the current state of the $gesture object to see if the state
has to be modified. For example, to signal a complete gesture detection.
Updates the state of the gesture object as required, and returns a
suitable result for the current recognition step.
]]
params {
@in gesture: Efl.Canvas.Gesture; [[The gesture object.]]
@in watched: Efl.Object; [[The target canvas object.]]
@in event: Efl.Canvas.Gesture_Touch; [[The pointer event being analyzed.]]
}
return: Efl.Canvas.Gesture_Recognizer_Result; [[Returns the result of the analysis.]]
}
/* FIXME: This function is not used? */
reset {
[[This function is called by the framework to reset a given gesture.]]
params {
@in gesture: Efl.Canvas.Gesture; [[The gesture object.]]
}
}
@property continues {
[[This property determines whether a gesture recognizer should continue
to try processing events after returning @Efl.Canvas.Gesture_Recognizer_Result.finish
or @Efl.Canvas.Gesture_Recognizer_Result.cancel.]]
get @protected {
}
set @protected {
}
values {
value: bool; [[Value of the property.]]
}
}
}
}