input_generator: add a new initialize API work synchronously

[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 e8c82d9..6b72fb7 100644 (file)
--- a/include/efl_util.h.in
+++ b/include/efl_util.h.in
@@ -303,6 +303,31 @@ API efl_util_inputgen_h efl_util_input_initialize_generator_with_name(unsigned i
 
 /**
    * @platform
+   * @brief Initializes the system, checks if input generated functions are supported and then open events generator devices synchronously.
+   * @since_tizen 5.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 @a dev_type is changed into the unsigned int to perform bitwise operations.
+   * @remarks If the @a name is NULL, it will be set to "Input Generator"
+   * @remarks The returned object should be released with efl_util_input_deinitialize_generator().
+   * @param[in] dev_type The device type to generate events, values of #efl_util_input_device_type_e combined with bitwise 'or'\n
+   *            Example: #EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN | #EFL_UTIL_INPUT_DEVTYPE_KEYBOARD
+   * @param[in] name The device name (maximum 31 characters, can be NULL)
+   * @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
+   * @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);
+
+/**
+   * @platform
    * @brief Deinitializes system and close opened devices.
    * @since_tizen $TZ_CFG_VER_24_OR_30$
    * @privlevel platform