diff options
Diffstat (limited to 'include')
| -rw-r--r-- | include/efl_util.h.in | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/include/efl_util.h.in b/include/efl_util.h.in index 6b72fb7..b248cb6 100644 --- a/include/efl_util.h.in +++ b/include/efl_util.h.in @@ -119,7 +119,7 @@ API int efl_util_set_notification_window_level(Evas_Object *window, efl_util_not API int efl_util_get_notification_window_level(Evas_Object *window, efl_util_notification_level_e *level); /** - * @brief Sets the alpha window's visual state to opaque state + * @brief Sets the alpha window's visual state to opaque state. * @details This API sets the alpha window's visual state to opaque state. * If the alpha window sets the visual state to the opaque, * then the window manager could handle it as the opaque window while calculating visibility. @@ -276,6 +276,7 @@ typedef enum * @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); @@ -297,6 +298,7 @@ API efl_util_inputgen_h efl_util_input_initialize_generator(unsigned int dev_typ * @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); @@ -336,6 +338,7 @@ API efl_util_inputgen_h efl_util_input_initialize_generator_with_sync(unsigned i * @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 * @see efl_util_input_initialize_generator() */ API int efl_util_input_deinitialize_generator(efl_util_inputgen_h inputgen_h); @@ -376,13 +379,13 @@ API int efl_util_input_generate_touch(efl_util_inputgen_h inputgen_h, int idx, e /** * @platform - * @brief Generate a pointer event using a opened device. + * @brief Generates a pointer event using a opened device. * @since_tizen 3.0 * @privlevel platform * @privilege %http://tizen.org/privilege/inputgenerator * @param[in] inputgen_h The #efl_util_inputgen_h handle * @param[in] buttons The number of button - * @param[in] pointer_type The pointer type (ex> EFL_UTIL_INPUT_POINTER_BUTTON_PRESS, EFL_UTIL_INPUT_POINTER_BUTTON_UP, EFL_UTIL_INPUT_POINTER_MOVE) + * @param[in] pointer_type The pointer type (ex> #EFL_UTIL_INPUT_POINTER_BUTTON_PRESS, #EFL_UTIL_INPUT_POINTER_BUTTON_UP, #EFL_UTIL_INPUT_POINTER_MOVE) * @param[in] x x coordination to move * @param[in] y y coordination to move * @return @c 0 on success, otherwise a negative error value @@ -438,7 +441,7 @@ API efl_util_screenshot_h efl_util_screenshot_initialize(int width, int height); * @privilege %http://tizen.org/privilege/screenshot * @remarks The specific error code can be obtained using the get_last_result() * The #tbm_surface_h must be free by caller - * @param[in] screenshot efl_util_screenshot_h handle + * @param[in] screenshot #efl_util_screenshot_h handle * @return #tbm_surface_h on success, otherwise @c NULL * @retval #tbm_surface_h The TBM surface handle * @exception #EFL_UTIL_ERROR_NONE Successful @@ -455,7 +458,7 @@ API tbm_surface_h efl_util_screenshot_take_tbm_surface(efl_util_screenshot_h scr * @since_tizen $TZ_CFG_VER_24_OR_30$ * @privlevel platform * @privilege %http://tizen.org/privilege/screenshot - * @param[in] screenshot efl_util_screenshot_h handle + * @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 @@ -503,7 +506,7 @@ API extern int EFL_UTIL_EVENT_GESTURE_TAP; API extern int EFL_UTIL_EVENT_GESTURE_PALM_COVER; /** - * @brief Enumeration of gesture type + * @brief Enumeration of gesture type. * @since_tizen 4.0 */ typedef enum _efl_util_gesture_type_e @@ -519,7 +522,7 @@ typedef enum _efl_util_gesture_type_e } efl_util_gesture_type_e; /** - * @brief Enumeration of gesture mode + * @brief Enumeration of gesture mode. * @since_tizen 4.0 */ typedef enum _efl_util_gesture_mode_e @@ -532,7 +535,7 @@ typedef enum _efl_util_gesture_mode_e } efl_util_gesture_mode_e; /** - * @brief Enumeration of gesture edge + * @brief Enumeration of gesture edge. * @since_tizen 4.0 */ typedef enum _efl_util_gesture_edge_e @@ -545,7 +548,7 @@ typedef enum _efl_util_gesture_edge_e } efl_util_gesture_edge_e; /** - * @brief Enumeration of gesture edge size + * @brief Enumeration of gesture edge size. * @since_tizen 4.0 */ typedef enum _efl_util_gesture_edge_size_e @@ -556,13 +559,13 @@ typedef enum _efl_util_gesture_edge_size_e } efl_util_gesture_edge_size_e; /** - * @brief Definition for the gesture data handle + * @brief Definition for the gesture data handle. * @since_tizen 4.0 */ typedef void *efl_util_gesture_data; /** - * @brief Definition for the edge swipe gesture's event data structure + * @brief Definition for the edge swipe gesture's event data structure. * @since_tizen 4.0 */ typedef struct _efl_util_event_gesture_edge_swipe_s @@ -575,7 +578,7 @@ typedef struct _efl_util_event_gesture_edge_swipe_s } efl_util_event_gesture_edge_swipe_s; /** - * @brief Definition for the edge drag gesture's event data structure + * @brief Definition for the edge drag gesture's event data structure. * @since_tizen 4.0 */ typedef struct efl_util_event_gesture_edge_drag_s @@ -588,7 +591,7 @@ typedef struct efl_util_event_gesture_edge_drag_s } efl_util_event_gesture_edge_drag_s; /** - * @brief Definition for the tap gesture's event data structure + * @brief Definition for the tap gesture's event data structure. * @since_tizen 4.0 */ typedef struct _efl_util_event_gesture_tap_s @@ -599,7 +602,7 @@ typedef struct _efl_util_event_gesture_tap_s } efl_util_event_gesture_tap_s; /** - * @brief Definition for the palm cover gesture's event data structure + * @brief Definition for the palm cover gesture's event data structure. * @since_tizen 4.0 */ typedef struct _efl_util_event_gesture_palm_cover_s |