diff options
| -rw-r--r-- | include/efl_util.h | 76 |
1 files changed, 38 insertions, 38 deletions
diff --git a/include/efl_util.h b/include/efl_util.h index 2c1edc3..d104df4 100644 --- a/include/efl_util.h +++ b/include/efl_util.h @@ -96,9 +96,9 @@ typedef enum * @param[in] level The notification window level * @return @c 0 on success, otherwise a negative error value * @retval #EFL_UTIL_ERROR_NONE Successful + * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported - * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied */ API int efl_util_set_notification_window_level(Evas_Object *window, efl_util_notification_level_e level); @@ -149,8 +149,8 @@ API int efl_util_set_window_opaque_state(Evas_Object *window, int opaque); * @param[in] mode The screen mode * @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 Permission denied + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter */ API int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e mode); @@ -181,8 +181,8 @@ API int efl_util_get_window_screen_mode(Evas_Object *window, efl_util_screen_mod * @param[in] brightness The preferred brightness * @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 Permission denied + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory * @see efl_util_get_window_brightness() */ @@ -283,11 +283,11 @@ typedef enum * @return #efl_util_inputgen_h on success, otherwise @c NULL * @retval #efl_util_inputgen_h The input generator handle * @exception #EFL_UTIL_ERROR_NONE Successful + * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to initialize input generator * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @exception #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address * @exception #EFL_UTIL_ERROR_INVALID_OPERATION Function not implemented * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure - * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to initialize input generator * @see efl_util_input_deinitialize_generator() */ API efl_util_inputgen_h efl_util_input_initialize_generator(unsigned int dev_type); @@ -305,11 +305,11 @@ API efl_util_inputgen_h efl_util_input_initialize_generator(unsigned int dev_typ * @return #efl_util_inputgen_h on success, otherwise @c NULL * @retval #efl_util_inputgen_h The input generator handle * @exception #EFL_UTIL_ERROR_NONE Successful + * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to initialize input generator * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @exception #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address * @exception #EFL_UTIL_ERROR_INVALID_OPERATION Function not implemented * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure - * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to initialize input generator * @see efl_util_input_deinitialize_generator() */ API efl_util_inputgen_h efl_util_input_initialize_generator_with_name(unsigned int dev_type, const char *name); @@ -330,11 +330,11 @@ API efl_util_inputgen_h efl_util_input_initialize_generator_with_name(unsigned i * @return #efl_util_inputgen_h on success, otherwise @c NULL * @retval #efl_util_inputgen_h The input generator handle * @exception #EFL_UTIL_ERROR_NONE Successful + * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to initialize input generator * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @exception #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address * @exception #EFL_UTIL_ERROR_INVALID_OPERATION Function not implemented * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure - * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to initialize input generator * @see efl_util_input_deinitialize_generator() */ API efl_util_inputgen_h efl_util_input_initialize_generator_with_sync(unsigned int dev_type, const char *name); @@ -352,8 +352,8 @@ API efl_util_inputgen_h efl_util_input_initialize_generator_with_sync(unsigned i * @param[in] max_count The maximum number of touches want to generate. * @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 Has no permission to deinitialize input generator + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available */ API int efl_util_input_set_touch_count(int max_count); @@ -367,8 +367,8 @@ API int efl_util_input_set_touch_count(int max_count); * @param[in] inputgen_h The #efl_util_inputgen_h handle * @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 Has no permission to deinitialize input generator + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @see efl_util_input_initialize_generator() */ API int efl_util_input_deinitialize_generator(efl_util_inputgen_h inputgen_h); @@ -384,8 +384,8 @@ API int efl_util_input_deinitialize_generator(efl_util_inputgen_h inputgen_h); * @param[in] pressed The value that select key press or release (0: release, 1: press) * @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 Has no permission to generate key + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter */ API int efl_util_input_generate_key(efl_util_inputgen_h inputgen_h, const char *key_name, int pressed); @@ -402,8 +402,8 @@ API int efl_util_input_generate_key(efl_util_inputgen_h inputgen_h, const char * * @param[in] y The y axis of touch point * @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 Has no permission to generate touch + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter */ API int efl_util_input_generate_touch(efl_util_inputgen_h inputgen_h, int idx, efl_util_input_touch_type_e touch_type, int x, int y); @@ -420,8 +420,8 @@ API int efl_util_input_generate_touch(efl_util_inputgen_h inputgen_h, int idx, e * @param[in] y y coordination to move * @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 Has no permission to generate pointer + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure */ @@ -445,11 +445,11 @@ API int efl_util_input_generate_pointer(efl_util_inputgen_h inputgen_h, int butt * @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_NOT_SUPPORTED Not supported * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED No permission to generate a wheel event + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @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); @@ -480,11 +480,11 @@ API int efl_util_input_generate_wheel(efl_util_inputgen_h inputgen_h, efl_util_i * @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_NOT_SUPPORTED Not supported * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED No permission to generate a touch event + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @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); @@ -517,10 +517,10 @@ typedef struct _efl_util_screenshot_h * efl_util_screenshot_h; * @return #efl_util_screenshot_h on success, otherwise @c NULL * @retval #efl_util_screenshot_h The screenshot handle * @exception #EFL_UTIL_ERROR_NONE Successful + * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED No permission for screenshot * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure * @exception #EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL Initialization failure - * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED No permission for screenshot * @see efl_util_screenshot_deinitialize() */ API efl_util_screenshot_h efl_util_screenshot_initialize(int width, int height); @@ -537,9 +537,9 @@ API efl_util_screenshot_h efl_util_screenshot_initialize(int width, int height); * @return #tbm_surface_h on success, otherwise @c NULL * @retval #tbm_surface_h The TBM surface handle * @exception #EFL_UTIL_ERROR_NONE Successful + * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED No permission for screenshot * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @exception #EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL Execution failure - * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED No permission for screenshot * @see efl_util_screenshot_initialize() * @see efl_util_screenshot_deinitialize() */ @@ -554,8 +554,8 @@ API tbm_surface_h efl_util_screenshot_take_tbm_surface(efl_util_screenshot_h scr * @param[in] screenshot #efl_util_screenshot_h handle * @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 for screenshot + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @see efl_util_screenshot_initialize() */ API int efl_util_screenshot_deinitialize(efl_util_screenshot_h screenshot); @@ -718,8 +718,8 @@ typedef struct _efl_util_event_gesture_palm_cover_s * @return #efl_util_gesture_h on success, otherwise @c NULL * @retval #efl_util_gesture_h The global gesture handle * @exception #EFL_UTIL_ERROR_NONE Successful - * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure * @exception #EFL_UTIL_ERROR_NOT_SUPPORTED Not supported + * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure * @exception #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available * @see efl_util_gesture_deinitialize() */ @@ -739,11 +739,11 @@ API int efl_util_gesture_deinitialize(efl_util_gesture_h gesture_h); /** * @brief Generates a edge swipe gesture's grab info handle. * @since_tizen 4.0 + * @remarks The specific error code can be obtained using the get_last_result() method. + * Error codes are described in Exception section. * @param[in] gesture_h The #efl_util_gesture_h handle * @param[in] fingers The number of fingers * @param[in] edge The position of edge - * @remarks The specific error code can be obtained using the get_last_result() method. - * Error codes are described in Exception section. * @return #efl_util_gesture_data on success, otherwise @c NULL * @retval #efl_util_gesture_data The specific gesture data handle * @exception #EFL_UTIL_ERROR_NONE Successful @@ -782,16 +782,16 @@ API int efl_util_gesture_edge_swipe_size_set(efl_util_gesture_data data, efl_uti /** * @brief Generates a edge drag gesture's grab info handle. * @since_tizen 4.0 + * @remarks The specific error code can be obtained using the get_last_result() method. + * Error codes are described in Exception section. * @param[in] gesture_h The #efl_util_gesture_h handle * @param[in] fingers The number of fingers * @param[in] edge The position of edge - * @remarks The specific error code can be obtained using the get_last_result() method. - * Error codes are described in Exception section. * @return #efl_util_gesture_data on success, otherwise @c NULL * @retval #efl_util_gesture_data The specific gesture data handle * @exception #EFL_UTIL_ERROR_NONE Successful - * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter + * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure * @exception #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available */ API efl_util_gesture_data efl_util_gesture_edge_drag_new(efl_util_gesture_h gesture_h, unsigned int fingers, efl_util_gesture_edge_e edge); @@ -824,16 +824,16 @@ API int efl_util_gesture_edge_drag_size_set(efl_util_gesture_data data, efl_util /** * @brief Generates a tap gesture's grab info handle. * @since_tizen 4.0 + * @remarks The specific error code can be obtained using the get_last_result() method. + * Error codes are described in Exception section. * @param[in] gesture_h The #efl_util_gesture_h handle * @param[in] fingers The number of fingers * @param[in] repeats The number of repeats - * @remarks The specific error code can be obtained using the get_last_result() method. - * Error codes are described in Exception section. * @return #efl_util_gesture_data on success, otherwise @c NULL * @retval #efl_util_gesture_data The specific gesture data handle * @exception #EFL_UTIL_ERROR_NONE Successful - * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter + * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure * @exception #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available */ API efl_util_gesture_data efl_util_gesture_tap_new(efl_util_gesture_h gesture_h, unsigned int fingers, unsigned int repeats); @@ -852,14 +852,14 @@ API int efl_util_gesture_tap_free(efl_util_gesture_h gesture_h, efl_util_gesture /** * @brief Generates a palm cover gesture's grab info handle. * @since_tizen 4.0 - * @param[in] gesture_h The #efl_util_gesture_h handle * @remarks The specific error code can be obtained using the get_last_result() method. * Error codes are described in Exception section. + * @param[in] gesture_h The #efl_util_gesture_h handle * @return #efl_util_gesture_data on success, otherwise @c NULL * @retval #efl_util_gesture_data The specific gesture data handle * @exception #EFL_UTIL_ERROR_NONE Successful - * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter + * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure * @exception #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available */ API efl_util_gesture_data efl_util_gesture_palm_cover_new(efl_util_gesture_h gesture_h); @@ -885,10 +885,10 @@ API int efl_util_gesture_palm_cover_free(efl_util_gesture_h gesture_h, efl_util_ * @param[in] data The #efl_util_gesture_data handle. * @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_NOT_SUPPORTED Not supported * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure - * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED Not supported * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available */ API int efl_util_gesture_grab(efl_util_gesture_h gesture_h, efl_util_gesture_data data); @@ -903,10 +903,10 @@ API int efl_util_gesture_grab(efl_util_gesture_h gesture_h, efl_util_gesture_dat * @param[in] data The #efl_util_gesture_data handle. * @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_NOT_SUPPORTED Not supported * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure - * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED Not supported * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available */ API int efl_util_gesture_ungrab(efl_util_gesture_h gesture_h, efl_util_gesture_data data); @@ -950,8 +950,8 @@ API int efl_util_gesture_deselect(efl_util_gesture_h gesture_h, Evas_Object *win * @param[in] active The activated boolean 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 Permission denied + * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available */ @@ -978,7 +978,7 @@ typedef void (*efl_util_gesture_tap_cb)(void *data, int mode, int fingers, int r typedef void (*efl_util_gesture_palm_cover_cb)(void *data, int mode, int duration, int cx, int cy, int size, double pressure); /** - * @brief Set edge swipe gesture callback function of given efl util gesture handle + * @brief Set edge swipe gesture callback function of given efl util gesture handle. * @since_tizen 7.0 * @param[in] gesture_h The #efl_util_gesture_h handle * @param[in] cb_func The callback function pointer @@ -990,7 +990,7 @@ typedef void (*efl_util_gesture_palm_cover_cb)(void *data, int mode, int duratio API int efl_util_gesture_edge_swipe_cb_set(efl_util_gesture_h gesture_h, efl_util_gesture_edge_swipe_cb cb_func, void *data); /** - * @brief Set edge drag gesture callback function of given efl util gesture handle + * @brief Set edge drag gesture callback function of given efl util gesture handle. * @since_tizen 7.0 * @param[in] gesture_h The #efl_util_gesture_h handle * @param[in] cb_func The callback function pointer @@ -1002,7 +1002,7 @@ API int efl_util_gesture_edge_swipe_cb_set(efl_util_gesture_h gesture_h, efl_uti API int efl_util_gesture_edge_drag_cb_set(efl_util_gesture_h gesture_h, efl_util_gesture_edge_drag_cb cb_func, void *data); /** - * @brief Set tap gesture callback function of given efl util gesture handle + * @brief Set tap gesture callback function of given efl util gesture handle. * @since_tizen 7.0 * @param[in] gesture_h The #efl_util_gesture_h handle * @param[in] cb_func The callback function pointer @@ -1014,7 +1014,7 @@ API int efl_util_gesture_edge_drag_cb_set(efl_util_gesture_h gesture_h, efl_util API int efl_util_gesture_tap_cb_set(efl_util_gesture_h gesture_h, efl_util_gesture_tap_cb cb_func, void *data); /** - * @brief Set palm cover gesture callback function of given efl util gesture handle + * @brief Set palm cover gesture callback function of given efl util gesture handle. * @since_tizen 7.0 * @param[in] gesture_h The #efl_util_gesture_h handle * @param[in] cb_func The callback function pointer |