From: Jihoon Kim Date: Fri, 4 Oct 2024 02:21:23 +0000 (+0900) Subject: Improve input documentation X-Git-Tag: accepted/tizen/unified/20241108.105428~7 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=616451cd4eec4ef57a6c28768cc7946b18b42162;p=platform%2Fcore%2Fapi%2Fefl-util.git Improve input documentation Change-Id: Ib7ad63817edf20ad651ab6dee18ce28d70d9a80a Signed-off-by: Jihoon Kim --- diff --git a/doc/ui_efl_util_input_doc.h b/doc/ui_efl_util_input_doc.h index a7a1844..133925f 100644 --- a/doc/ui_efl_util_input_doc.h +++ b/doc/ui_efl_util_input_doc.h @@ -27,8 +27,27 @@ * * @section CAPI_EFL_UTIL_INPUT_MODULE_OVERVIEW Overview * The EFL UTIL API provides functions to initialize/deinitialize input devices - * and to generation touch / key events. + * and to generate touch / key events. * + * You can generate key input events that emulate various hardware key presses, touch input events that emulate screen touches, and point input events that emulate mouse moves or clicks. + * + * @section CAPI_EFL_UTIL_INPUT_MODULE_GENERATING_KEY_INPUT Generating Key Input Events + * To generate key input events, follow these steps: + * 1. Create the efl_util_inputgen_h structure and initialize the structure members with efl_util_input_initialize_generator(), efl_util_input_initialize_generator_with_name(), or efl_util_input_initialize_generator_with_sync(). + * 2. After setting the input device type, to generate key input events call efl_util_input_generate_key(). + * 3. When no longer needed, free the efl_util_inputgen_h structure with efl_util_input_deinitialize_generator(). + * + * @section CAPI_EFL_UTIL_INPUT_MODULE_GENERATING_TOUCH_INPUT Generating Touch Input Events + * To generate touch input events, follow these steps: + * 1. Create the efl_util_inputgen_h structure and initialize the structure members with efl_util_input_initialize_generator (), efl_util_input_initialize_generator_with_name(), or efl_util_input_initialize_generator_with_sync(). + * 2. After setting the input device type, to generate touch input events call efl_util_input_generate_touch() or efl_util_input_generate_touch_axis(). + * 3. When no longer needed, free the efl_util_inputgen_h structure with efl_util_input_deinitialize_generator(). + * + * @section CAPI_EFL_UTIL_INPUT_MODULE_GENERATING_POINTER_INPUT Generating Point Input Events + * To generate point input events, follow these steps: + * 1. Create the efl_util_inputgen_h structure and initialize the structure members with efl_util_input_initialize_generator(), efl_util_input_initialize_generator_with_name(), or efl_util_input_initialize_generator_with_sync(). + * 2. After setting the input device type, to generate point input events call efl_util_input_generate_pointer(). + * 3. When no longer needed, free the efl_util_inputgen_h structure with efl_util_input_deinitialize_generator(). */ #endif /* __TIZEN_UI_EFL_UTIL_INPUT_DOC_H__ */