aboutsummaryrefslogblamecommitdiffstats
path: root/src/lib/elementary/elm_gesture_layer_common.h
blob: 34f862b8ae86259e30613195fb03db051a5c5fe2 (plain) (tree)
1
2
3
4
5
6
7
8
9
   



                                
 
   
                           
   
                                                            

   









                                                                
                               
   
                                                                    

   






                                                                                                  




                                                                     
 

                                                               
 

                                         
 
                                            


   
                           
   
                                                            

   


                                                                                              


                                                                       


   
                           
   
                                                            

   










                                                                                         
                               
   
                                                                

   











                                                                                               





                                                                          



                                                                               

                                                                    

                                                                                         


                                     
             



                                                                                       




                                                                       
             



                                                                       

                                                                            



                                                                        


                                                         
             



                                                                                                              




                                                                               
             



                                                                                      

                                                                            

                                                                                                 


                                                         
             



                                                                                                              




                                                                               
             



                                                                                      

                                                                           

                                                                                               


                                                       
             



                                                                                                        




                                                                              
             



                                                                                 

                                                                      

                                                      


                                             
             



                                                                                              




                                                                         
             



                                                                            

                                                                       


                                                                             


                                               
             



                                                                                                




                                                                          
             



                                                                             

                                                                             

                                                                                                   
                                   
  


                                                           
             



                                                                                                            




                                                                                
             



                                                                                   

                                                                             

                                                                          


                                                      
             



                                                                                                        




                                                                                
             



                                                                                    

                                                                           

                                                                            
  


                                                       
             



                                                                                                        




                                                                              
             



                                                                                 

                                                                     

                                                                                       


                                           
             



                                                                                               




                                                                        
             



                                                                              

                                                                       
                                                                                          
                                                                              
  


                                               
             



                                                                                                




                                                                          
             


                                                                             
   




                                                                           
                        
  
             



                                                                                 




                                                                        
             

                                                                              



     
/**
 * @addtogroup Elm_Gesture_Layer
 *
 * @{
 */

/**
 * Holds taps info for user
 */
typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;

/**
 * Struct holds taps info for user
 */
struct _Elm_Gesture_Taps_Info
{
   Evas_Coord   x, y; /**< Holds center point between fingers */
   unsigned int n; /**< Number of fingers tapped           */
   unsigned int timestamp; /**< event timestamp       */
};

/**
 * holds momentum info for user
 */
typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;

/**
 * Struct holds momentum info for user
 * x1 and y1 are not necessarily in sync
 * x1 holds x value of x direction starting point
 * and same holds for y1.
 * This is noticeable when doing V-shape movement
 */
struct _Elm_Gesture_Momentum_Info /* Report line ends, timestamps, and momentum computed        */
{
   Evas_Coord   x1; /**< Final-swipe direction starting point on X */
   Evas_Coord   y1; /**< Final-swipe direction starting point on Y */
   Evas_Coord   x2; /**< Final-swipe direction ending point on X   */
   Evas_Coord   y2; /**< Final-swipe direction ending point on Y   */

   unsigned int tx; /**< Timestamp of start of final x-swipe */
   unsigned int ty; /**< Timestamp of start of final y-swipe */

   Evas_Coord   mx; /**< Momentum on X */
   Evas_Coord   my; /**< Momentum on Y */

   unsigned int n; /**< Number of fingers */
};

/**
 * Holds line info for user
 */
typedef struct _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;

/**
 * Struct holds line info for user
 */
struct _Elm_Gesture_Line_Info   /* Report line ends, timestamps, and momentum computed      */
{
   Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
   double                    angle; /**< Angle (direction) of lines  */
};

/**
 * Holds zoom info for user
 */
typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;

/**
 * Struct holds zoom info for user
 */
struct _Elm_Gesture_Zoom_Info
{
   Evas_Coord x, y; /**< Holds zoom center point reported to user  */
   Evas_Coord radius; /**< Holds radius between fingers reported to user */
   double     zoom; /**< Zoom value: 1.0 means no zoom             */
   double     momentum; /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
};

/**
 * Holds rotation info for user
 */
typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;

/**
 * Struct holds rotation info for user
 */
struct _Elm_Gesture_Rotate_Info
{
   Evas_Coord x, y; /**< Holds zoom center point reported to user      */
   Evas_Coord radius; /**< Holds radius between fingers reported to user */
   double     base_angle; /**< Holds start-angle */
   double     angle; /**< Rotation value: 0.0 means no rotation         */
   double     momentum; /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
};

/**
 * User callback used to stream gesture info from gesture layer
 * @param data user data
 * @param event_info gesture report info
 * Returns a flag field to be applied on the causing event.
 * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
 * upon the event, in an irreversible way.
 */
typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb)(void *data, void *event_info);

/**
 * This function sets the gesture layer line min length of an object
 *
 * Sets the minimum line length at which the user's gesture will be recognized as a line.
 *
 * @param obj gesture-layer.
 * @param line_min_length the length.
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_line_min_length_set(Evas_Object *obj, int line_min_length);

/**
 * This function returns the gesture layer line min length of an object
 *
 * @param obj gesture-layer.
 * @return the length.
 *
 * @since 1.8
 */
EAPI int elm_gesture_layer_line_min_length_get(const Evas_Object *obj);

/**
 * This function sets the gesture layer zoom distance tolerance of an object
 *
 * If the distance between the two tab events becomes larger or smaller
 * than @c zoom_distance_tolerance, it is recognized as the start of the
 * zoom gesture.
 *
 * @param obj gesture-layer.
 * @param zoom_distance_tolerance zoom distance tolerance
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_zoom_distance_tolerance_set(Evas_Object *obj, Evas_Coord zoom_distance_tolerance);

/**
 * This function returns the gesture layer zoom distance tolerance of an object
 *
 * @param obj gesture-layer.
 * @return zoom distance tolerance
 *
 * @since 1.8
 */
EAPI Evas_Coord elm_gesture_layer_zoom_distance_tolerance_get(const Evas_Object *obj);

/**
 * This function sets the gesture layer line distance tolerance of an object
 *
 * Sets the minimum @c line_distance_tolerance length for the gesture to be recognized as a line.
 *
 * @param obj gesture-layer.
 * @param line_distance_tolerance line distance tolerance
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_line_distance_tolerance_set(Evas_Object *obj, Evas_Coord line_distance_tolerance);

/**
 * This function returns the gesture layer line distance tolerance of an object
 *
 * @param obj gesture-layer.
 * @return line distance tolerance
 *
 * @since 1.8
 */
EAPI Evas_Coord elm_gesture_layer_line_distance_tolerance_get(const Evas_Object *obj);

/**
 * This function sets the gesture layer line angular tolerance of an object
 *
 * Sets the minimum @c line_angular_tolerance angle for the gesture to be recognized as a line.
 *
 * @param obj gesture-layer.
 * @param line_angular_tolerance line angular tolerance
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_line_angular_tolerance_set(Evas_Object *obj, double line_angular_tolerance);

/**
 * This function returns the gesture layer line angular tolerance of an object
 *
 * @param obj gesture-layer.
 * @return line angular tolerance
 *
 * @since 1.8
 */
EAPI double elm_gesture_layer_line_angular_tolerance_get(const Evas_Object *obj);

/**
 * This function sets the gesture layer zoom wheel factor of an object
 *
 * Sets the zoom size when a mouse wheel event occurs.
 *
 * @param obj gesture-layer.
 * @param zoom_wheel_factor zoom wheel factor
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_zoom_wheel_factor_set(Evas_Object *obj, double zoom_wheel_factor);

/**
 * This function returns the gesture layer zoom wheel factor of an object
 *
 * @param obj gesture-layer.
 * @return zoom wheel factor
 *
 * @since 1.8
 */
EAPI double elm_gesture_layer_zoom_wheel_factor_get(const Evas_Object *obj);

/**
 * This function sets the gesture layer zoom finger factor of an object
 *
 * Sets the zoom size by multiplaying the zoom value by @c zoom_finger_factor
 * when zooming.
 *
 * @param obj gesture-layer.
 * @param zoom_finger_factor zoom finger factor
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_zoom_finger_factor_set(Evas_Object *obj, double zoom_finger_factor);

/**
 * This function returns the gesture layer zoom finger factor of an object
 *
 * @param obj gesture-layer.
 * @return zoom finger factor
 *
 * @since 1.8
 */
EAPI double elm_gesture_layer_zoom_finger_factor_get(const Evas_Object *obj);

/**
 * This function sets the gesture layer rotate angular tolerance of an object
 *
 * Sets the minimum @c rotate_angular_tolerance angle for the gesture to be recognized as a rotate.
 * Rotate should be rotated beyond the givin @c rotate_angular_tolerance to recognize
 * the start of the rotate gesture.
 *
 * @param obj gesture-layer.
 * @param rotate_angular_tolerance rotate angular tolerance
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_rotate_angular_tolerance_set(Evas_Object *obj, double rotate_angular_tolerance);

/**
 * This function returns the gesture layer rotate angular tolerance of an object
 *
 * @param obj gesture-layer.
 * @return rotate angular tolerance
 *
 * @since 1.8
 */
EAPI double elm_gesture_layer_rotate_angular_tolerance_get(const Evas_Object *obj);

/**
 * This function sets the gesture layer flick time limit (in ms) of an object
 *
 * Recognize as a flick when a gesture occurs over @c flick_time_limit_ms.
 *
 * @param obj gesture-layer.
 * @param flick_time_limit_ms flick time limit (in ms)
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_flick_time_limit_ms_set(Evas_Object *obj, unsigned int flick_time_limit_ms);

/**
 * This function returns the gesture layer flick time limit (in ms) of an object
 *
 * @param obj gesture-layer.
 * @return flick time limit (in ms)
 *
 * @since 1.8
 */
EAPI unsigned int elm_gesture_layer_flick_time_limit_ms_get(const Evas_Object *obj);

/**
 * This function sets the gesture layer long tap start timeout of an object
 *
 * Recognize as a long tap when a tab occurs over @c long_tap_start_timeout,
 * if set negative value, timeout will be 0.
 *
 * @param obj gesture-layer.
 * @param long_tap_start_timeout long tap start timeout
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_long_tap_start_timeout_set(Evas_Object *obj, double long_tap_start_timeout);

/**
 * this function returns the gesture layer long tap start timeout of an object
 *
 * @param obj gesture-layer.
 * @return long tap start timeout
 *
 * @since 1.8
 */
EAPI double elm_gesture_layer_long_tap_start_timeout_get(const Evas_Object *obj);

/**
 * This function sets the gesture layer continues enable of an object
 *
 * An option that allows user to start a gesture even when user is in touch move state.
 *
 * @param obj gesture-layer.
 * @param continues_enable continues enable
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_continues_enable_set(Evas_Object *obj, Eina_Bool continues_enable);

/**
 * This function returns the gesture layer continues enable of an object
 *
 * @param obj gesture-layer.
 * @return continues enable
 *
 * @since 1.8
 */
EAPI Eina_Bool elm_gesture_layer_continues_enable_get(const Evas_Object *obj);

/**
 * This function sets the gesture layer double tap timeout of an object
 *
 * When the time difference between two tabs is less than the @c double_tap_timeout value,
 * it is recognized as a double tab, if set negative value, timeout will be 0.
 *
 * @param obj gesture-layer.
 * @param double_tap_timeout double tap timeout
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_double_tap_timeout_set(Evas_Object *obj, double double_tap_timeout);

/**
 * this function returns the gesture layer double tap timeout of an object
 *
 * @param obj gesture-layer.
 * @return double tap timeout
 *
 * @since 1.8
 */
EAPI double elm_gesture_layer_double_tap_timeout_get(const Evas_Object *obj);

/**
 * 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)
 *
 * @param obj gesture-layer.
 * @param sz Finger size
 *
 * @since 1.8
 */
EAPI void elm_gesture_layer_tap_finger_size_set(Evas_Object *obj, Evas_Coord sz);

/**
 * This function returns the gesture layer finger-size for taps
 *
 * @param obj gesture-layer.
 * @return Finger size that is currently used by Gesture Layer for taps.
 *
 * @since 1.8
 */
EAPI Evas_Coord elm_gesture_layer_tap_finger_size_get(const Evas_Object *obj);

/**
 * @}
 */