forked from enlightenment/efl
doc: improves single line description of gesture class.
Summary: This patch improves single line descriptions described on T7717 Test Plan: NA Reviewers: segfaultxavi, woohyun, Hermet, cedric Reviewed By: Hermet Subscribers: #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D10002
This commit is contained in:
parent
6f3841e4b4
commit
81b94b5a20
|
@ -4,7 +4,7 @@ abstract @beta Efl.Canvas.Gesture extends Efl.Object
|
|||
{
|
||||
[[EFL Gesture abstract class
|
||||
|
||||
A gesture class defines a method that spcific gesture event and privides information
|
||||
A gesture class defines a method that specific gesture event and privides information
|
||||
about the gesture's type, state, and associated pointer information.
|
||||
|
||||
For cetain gesture types, additional methods are defined to provide meaningful gesture
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
class @beta Efl.Canvas.Gesture_Double_Tap extends Efl.Canvas.Gesture
|
||||
{
|
||||
[[EFL Gesture Double Tap class]]
|
||||
[[EFL Gesture Double Tap class
|
||||
|
||||
A gesture class defines a method that double tap gesture event and provides information
|
||||
about the double tap gesture's type, state and associated pointer information.]]
|
||||
data: null;
|
||||
c_prefix: efl_gesture_double_tap;
|
||||
implements {
|
||||
|
|
|
@ -2,7 +2,11 @@ import eina_types;
|
|||
|
||||
class @beta Efl.Canvas.Gesture_Flick extends Efl.Canvas.Gesture
|
||||
{
|
||||
[[EFL Gesture Flick class]]
|
||||
[[EFL Gesture Flick class
|
||||
|
||||
This gesture class defines a method that flick gesture event and provides
|
||||
information about the flick gesture's type, state, and associated pointer
|
||||
information.]]
|
||||
c_prefix: efl_gesture_flick;
|
||||
methods {
|
||||
momentum_get {
|
||||
|
|
|
@ -1,6 +1,10 @@
|
|||
class @beta Efl.Canvas.Gesture_Long_Tap extends Efl.Canvas.Gesture
|
||||
{
|
||||
[[EFL Gesture Long Tap class]]
|
||||
[[EFL Gesture Long Tap class
|
||||
|
||||
This gesture class defines a method that long tap gesture event and provides
|
||||
information about the long tap gesture's type, state and associated pointer
|
||||
information.]]
|
||||
data: null;
|
||||
c_prefix: efl_gesture_long_tap;
|
||||
implements {
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
class @beta Efl.Canvas.Gesture_Manager extends Efl.Object
|
||||
{
|
||||
[[EFL Gesture Manager class]]
|
||||
[[EFL Gesture Manager class
|
||||
|
||||
This gesture class defines methods that register and unregister a recognizer and
|
||||
get a recognizer according to gesture event type.]]
|
||||
c_prefix: efl_gesture_manager;
|
||||
methods {
|
||||
recognizer_register {
|
||||
|
@ -18,7 +21,7 @@ class @beta Efl.Canvas.Gesture_Manager extends Efl.Object
|
|||
recognizer_get {
|
||||
[[Gets event type's recognizer]]
|
||||
params {
|
||||
@in gesture_type: Efl.Canvas.Gesture_Recognizer_Type; [[The gesture type]]
|
||||
@in gesture_type: Efl.Canvas.Gesture_Recognizer_Type; [[The gesture event type]]
|
||||
}
|
||||
return: const(Efl.Canvas.Gesture_Recognizer); [[The gesture recognizer]]
|
||||
}
|
||||
|
|
|
@ -2,7 +2,10 @@ import eina_types;
|
|||
|
||||
class @beta Efl.Canvas.Gesture_Momentum extends Efl.Canvas.Gesture
|
||||
{
|
||||
[[EFL Gesture Momentum class]]
|
||||
[[EFL Gesture Momentum class
|
||||
|
||||
This gesture class defines a method to get momentum value of specific
|
||||
gesture event such as flick.]]
|
||||
c_prefix: efl_gesture_momentum;
|
||||
methods {
|
||||
momentum_get {
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
class @beta Efl.Canvas.Gesture_Recognizer_Double_Tap extends Efl.Canvas.Gesture_Recognizer
|
||||
{
|
||||
[[EFL Gesture Recognizer Double Tap class]]
|
||||
[[EFL Gesture Recognizer Double Tap class
|
||||
|
||||
This gesture recognizer class grabs double tap gesture events that occur on
|
||||
target object that user register.]]
|
||||
c_prefix: efl_gesture_recognizer_double_tap;
|
||||
methods {
|
||||
@property timeout {
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
class @beta Efl.Canvas.Gesture_Recognizer_Flick extends Efl.Canvas.Gesture_Recognizer
|
||||
{
|
||||
[[EFL Gesture Recognizer Flick Class]]
|
||||
[[EFL Gesture Recognizer Flick Class
|
||||
|
||||
This gesture recognizer class grabs flick gesture events that occur on
|
||||
the target object that user register.]]
|
||||
c_prefix: efl_gesture_recognizer_flick;
|
||||
implements {
|
||||
Efl.Canvas.Gesture_Recognizer.add;
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
class @beta Efl.Canvas.Gesture_Recognizer_Long_Tap extends Efl.Canvas.Gesture_Recognizer
|
||||
{
|
||||
[[EFL Gesture Recognizer Long Tap class]]
|
||||
[[EFL Gesture Recognizer Long Tap class
|
||||
|
||||
This gesture recognizer class grabs long tap gesture events that occur
|
||||
on the target that user register.]]
|
||||
c_prefix: efl_gesture_recognizer_long_tap;
|
||||
methods {
|
||||
@property timeout {
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
class @beta Efl.Canvas.Gesture_Recognizer_Momentum extends Efl.Canvas.Gesture_Recognizer
|
||||
{
|
||||
[[EFL Gesture Recognizer Momentum class]]
|
||||
[[EFL Gesture Recognizer Momentum class
|
||||
|
||||
This gesture recognizer class grabs monentum based gesture events such as
|
||||
from flick on the target object that user register.]]
|
||||
c_prefix: efl_gesture_recognizer_momentum;
|
||||
implements {
|
||||
Efl.Canvas.Gesture_Recognizer.add;
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
class @beta Efl.Canvas.Gesture_Recognizer_Tap extends Efl.Canvas.Gesture_Recognizer
|
||||
{
|
||||
[[EFL Gesture Recognizer Tap class]]
|
||||
[[EFL Gesture Recognizer Tap class
|
||||
|
||||
This gesture recognizer class grabs tap based gesture events that occur on
|
||||
the target object that user register.]]
|
||||
c_prefix: efl_gesture_recognizer_tap;
|
||||
implements {
|
||||
Efl.Canvas.Gesture_Recognizer.add;
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
class @beta Efl.Canvas.Gesture_Recognizer_Triple_Tap extends Efl.Canvas.Gesture_Recognizer
|
||||
{
|
||||
[[EFL Gesture Recognizer Triple Tap class]]
|
||||
[[EFL Gesture Recognizer Triple Tap class
|
||||
|
||||
This gesture recognizer class grabs triple tap gesture events that occur on the
|
||||
target object that user register.]]
|
||||
c_prefix: efl_gesture_recognizer_triple_tap;
|
||||
methods {
|
||||
@property timeout {
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
class @beta Efl.Canvas.Gesture_Recognizer_Zoom extends Efl.Canvas.Gesture_Recognizer
|
||||
{
|
||||
[[EFL Gesture Recognizer Zoom class]]
|
||||
[[EFL Gesture Recognizer Zoom class
|
||||
|
||||
This gesture recognizer class grabs zoom gesture events that occur on the
|
||||
target object that user register.]]
|
||||
c_prefix: efl_gesture_recognizer_zoom;
|
||||
implements {
|
||||
Efl.Canvas.Gesture_Recognizer.add;
|
||||
|
|
|
@ -1,6 +1,10 @@
|
|||
class @beta Efl.Canvas.Gesture_Tap extends Efl.Canvas.Gesture
|
||||
{
|
||||
[[EFL Gesture Tap class]]
|
||||
[[EFL Gesture Tap class
|
||||
|
||||
This gesture class defines a method that tap gesture event and provides
|
||||
information about the tap gesture's type, state, and associated pointer
|
||||
information.]]
|
||||
data: null;
|
||||
c_prefix: efl_gesture_tap;
|
||||
implements {
|
||||
|
|
|
@ -5,7 +5,11 @@ import efl_input_types;
|
|||
|
||||
class @beta Efl.Canvas.Gesture_Touch extends Efl.Object
|
||||
{
|
||||
[[EFL Gesture Touch class]]
|
||||
[[EFL Gesture Touch class
|
||||
|
||||
This gesture class defines a method that records touch points and supports
|
||||
properties - first touch point, current touch point, timestamp, multi-touch
|
||||
and state information.]]
|
||||
c_prefix: efl_gesture_touch;
|
||||
methods {
|
||||
point_record {
|
||||
|
|
|
@ -1,6 +1,10 @@
|
|||
class @beta Efl.Canvas.Gesture_Triple_Tap extends Efl.Canvas.Gesture
|
||||
{
|
||||
[[EFL Gesture Triple Tap class]]
|
||||
[[EFL Gesture Triple Tap class
|
||||
|
||||
This gesture class defines a method that triple tap gesture event and provides
|
||||
information about the triple tap gesture's type, state and associated pointer
|
||||
information.]]
|
||||
data: null;
|
||||
c_prefix: efl_gesture_triple_tap;
|
||||
implements {
|
||||
|
|
|
@ -1,6 +1,10 @@
|
|||
class @beta Efl.Canvas.Gesture_Zoom extends Efl.Canvas.Gesture
|
||||
{
|
||||
[[EFL Gesture Zoom class]]
|
||||
[[EFL Gesture Zoom class
|
||||
|
||||
This gesture class defines methods to get zoom center point and zoom value
|
||||
and provides information about ghe zoom gesture's type, state and associated
|
||||
pointer information.]]
|
||||
c_prefix: efl_gesture_zoom;
|
||||
methods {
|
||||
radius_get {
|
||||
|
|
Loading…
Reference in New Issue