diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/efl_util.h.in | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/include/efl_util.h.in b/include/efl_util.h.in index 202ce02..61eb29d 100644 --- a/include/efl_util.h.in +++ b/include/efl_util.h.in @@ -261,6 +261,17 @@ typedef enum } efl_util_input_pointer_type_e; /** + * @platform + * @brief Enumeration of pointer wheel event types. + * @since_tizen 5.5 + */ +typedef enum +{ + EFL_UTIL_INPUT_POINTER_WHEEL_VERT, /**< Vertical wheel. */ + EFL_UTIL_INPUT_POINTER_WHEEL_HORZ, /**< Horizontal wheel. */ +} efl_util_input_pointer_wheel_type_e; + +/** * @platform * @brief Initializes system and check input generate functions are supported, open devices generated events. * @since_tizen $TZ_CFG_VER_24_OR_30$ @@ -398,6 +409,67 @@ API int efl_util_input_generate_touch(efl_util_inputgen_h inputgen_h, int idx, e API int efl_util_input_generate_pointer(efl_util_inputgen_h inputgen_h, int buttons, efl_util_input_pointer_type_e pointer_type, int x, int y); /** + * @platform + * @brief Generates a wheel event using an opened device. + * @details Commonly wheel events are generated with one of two orientations, vertical and horizontal. + * #efl_util_input_pointer_wheel_type_e has enums for orientations. + * For each orientation there is a value which represents both size and direction. + * For #EFL_UTIL_INPUT_POINTER_WHEEL_VERT, if the value is positive, the direction is "up", if it's negative, the direction is "down" + * For #EFL_UTIL_INPUT_POINTER_WHEEL_HORZ, if the value is positive, the direction is "right", if it's negative, the direction is "left" + * General mouse devices generate wheel events with value 1 or -1, + * but some mouse devices have a smooth wheel which generates wheel events with value bigger than absolute 1. + * @since_tizen 5.5 + * @privlevel platform + * @privilege %http://tizen.org/privilege/inputgenerator + * @param[in] inputgen_h The #efl_util_inputgen_h handle + * @param[in] wheel_type The wheel type (ex> #EFL_UTIL_INPUT_POINTER_WHEEL_VERT, #EFL_UTIL_INPUT_POINTER_WHEEL_HORZ) + * @param[in] value The wheel value + * @return @c 0 on success, otherwise a negative error value + * @retval #EFL_UTIL_ERROR_NONE Successful + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED No permission to generate a wheel event + * @retval #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address + * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure + * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED Not supported + */ +API int efl_util_input_generate_wheel(efl_util_inputgen_h inputgen_h, efl_util_input_pointer_wheel_type_e wheel_type, int value); + +/** + * @platform + * @brief Generates a touch event using an opened device. + * @details Normally touch events are represented by a specific point (x, y). + * But there are many contact points between touchscreen and fingers. + * The coordinates (x, y) are the center of the contact area, and the area where the finger and the touchscreen come into contact is represented with an ellipse. + * To give information about the size of the touching cllipse, use @a radius_x and @a radius_y. + * The value of @a idx is touch index used in multi-touch. 0 means first touch, 1 means second touch and the index increases further. + * General devices support 10 touch indices(0 ~ 9), but this may differ depending on the device. + * Some devices may not support the @a palm value, and this value is closely dependent on device. + * The value of @a x, @a y, @a radius_x, @a radius_y, @a pressure and @a palm must be greater than 0. + * The @a angle is the angle between the vertical edge of the device and the y-axis of the ellipse. If the @a angle is 0, then the ellipse's y-axis is parallel to the device's vertical edge. + * @since_tizen 5.5 + * @privlevel platform + * @privilege %http://tizen.org/privilege/inputgenerator + * @param[in] inputgen_h The #efl_util_inputgen_h handle + * @param[in] idx The index of the touching finger, used in multi-touch + * @param[in] touch_type The touch type (ex> #EFL_UTIL_INPUT_TOUCH_BEGIN, #EFL_UTIL_INPUT_TOUCH_UPDATE, #EFL_UTIL_INPUT_TOUCH_END) + * @param[in] x The x coordinate of the touch point + * @param[in] y The y coordinate of the touch point + * @param[in] radius_x The x-axis radius of the touching ellipse before rotation + * @param[in] radius_y The y-axis radius of the touching ellipse before rotation + * @param[in] pressure The pressure on the contact touch area + * @param[in] angle The rotation angle of the touching ellipse, in degrees + * @param[in] palm The palm area of the contact touch area + * @return @c 0 on success, otherwise a negative error value + * @retval #EFL_UTIL_ERROR_NONE Successful + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED No permission to generate a touch event + * @retval #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address + * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure + * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED Not supported + */ +API int efl_util_input_generate_touch_axis(efl_util_inputgen_h inputgen_h, int idx, efl_util_input_touch_type_e touch_type, int x, int y, double radius_x, double radius_y, double pressure, double angle, double palm); + +/** * @} */ |