input_generator: Add a new API for initialize

[platform/core/api/efl-util.git] / include / efl_util.h.in

diff --git a/include/efl_util.h.in b/include/efl_util.h.in
index 5f07701..258648f 100644 (file)
--- a/include/efl_util.h.in
+++ b/include/efl_util.h.in
@@ -191,9 +191,6 @@ API int efl_util_set_window_opaque_state(Evas_Object *window, int opaque);
  * @privilege %http://tizen.org/privilege/display
  * @remarks This API needs the privilege.
  *          If the application which is not get the privilege use this API, the window manager generates the permission deny error.
- $TZ_CFG_KEEP_BEGIN$
- *          The application can notice this error if it set the callback function using the efl_util_set_window_screen_mode_error_cb().
- $TZ_CFG_KEEP_END$
  * @param[in] window The EFL window
  * @param[in] mode The screen mode
  * @return @c 0 on success, otherwise a negative error value
@@ -214,7 +211,6 @@ API int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mod
  */
 API int efl_util_get_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e *mode);
 
-$TZ_CFG_KEEP_BEGIN$
 /**
  * @deprecated Deprecated since 3.0.
  * @brief Called when an error occurs for setting window's screen mode
@@ -258,7 +254,6 @@ API int efl_util_set_window_screen_mode_error_cb(Evas_Object *window, efl_util_w
  * @see efl_util_set_window_screen_mode_error_cb()
  */
 API int efl_util_unset_window_screen_mode_error_cb(Evas_Object *window) TIZEN_DEPRECATED_API;
-$TZ_CFG_KEEP_END$
 
 /**
  * @brief Sets the user's preferred brightness of the specified window.
@@ -377,6 +372,27 @@ API efl_util_inputgen_h efl_util_input_initialize_generator(unsigned int dev_typ
 
 /**
    * @platform
+   * @brief Initializes system, check input generate functions are supported and then open events generator devices with given name.
+   * @since_tizen 4.0
+   * @privlevel platform
+   * @privilege %http://tizen.org/privilege/inputgenerator
+   * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
+   * @remarks The dev_type is changed into the unsigned int to perform bitwise operations.
+   * @param[in] dev_type The device type want to generate events (ex> #EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN | #EFL_UTIL_INPUT_DEVTYPE_KEYBOARD)
+   * @param[in] name The device name (maximum 31 characters)
+   * @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_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
+   * @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);
+
+/**
+   * @platform
    * @brief Deinitializes system and close opened devices.
    * @since_tizen $TZ_CFG_VER_24_OR_30$
    * @privlevel platform
@@ -429,8 +445,9 @@ API int efl_util_input_generate_touch(efl_util_inputgen_h inputgen_h, int idx, e
    * @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] efl_util_input_pointer_type_e 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
@@ -485,7 +502,7 @@ API efl_util_screenshot_h efl_util_screenshot_initialize(int width, int height);
  * @privlevel platform
  * @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
+ *          The #tbm_surface_h must be free by caller
  * @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