input_generator: Add a new API for initialize
[platform/core/api/efl-util.git] / include / efl_util.h.in
index 0fbaa14..258648f 100644 (file)
@@ -372,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