EFL Deprecate 61/321661/1
authorsungwook79.park <sungwook79.park@samsung.com>
Wed, 26 Mar 2025 07:43:07 +0000 (16:43 +0900)
committersungwook79.park <sungwook79.park@samsung.com>
Wed, 26 Mar 2025 07:43:07 +0000 (16:43 +0900)
Change-Id: I48207b3c16e97b764c25e76b4fe425426c93ce5c
Signed-off-by: sungwook79.park <sungwook79.park@samsung.com>
doc/uix_voice_control_elm_doc.h
doc/voice-control-elm-doc.dox
include/voice_control_elm.h
include/voice_control_elm_private.h

index d7da12c13724ad55fb5863b2b7b053bcb8f4f16c..63f12ff8ed54011939ab2325e07bdcef3dad1cba 100644 (file)
@@ -17,7 +17,7 @@
 
 /**
  * @ingroup CAPI_UIX_FRAMEWORK
- * @defgroup VOICE_CONTROL_ELEMENTARY_MODULE Voice control elementary
+ * @defgroup VOICE_CONTROL_ELEMENTARY_MODULE Voice control elementary (Deprecated)
  * @brief The @ref VOICE_CONTROL_ELEMENTARY_MODULE API provides functions to control widget by voice commands.
  * @section VOICE_CONTROL_ELEMENTARY_MODULE_HEADER Required Header
  * \#include <voice_control_elm.h>
index cf2318b39febb064c782f4cdd7fcb0f1783614e1..8eb8d8b5d976c5b2a0c49060c8ff1d6d5ec294a7 100644 (file)
@@ -1,7 +1,7 @@
 /**
 
 
-* @defgroup voice-control-elm-devguide voice-control-elm Developer Guide
+* @defgroup voice-control-elm-devguide voice-control-elm Developer Guide (Deprecated)
 *
 *
 * @addtogroup voice-control-elm-devguide
index f8c2d227e4944f08ed15556964e11c48d344fc89..afb8931e7808d564e9b8f6eac26143ccbed0ee66 100644 (file)
@@ -42,6 +42,7 @@ extern "C" {
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Enumeration for status of voice control elementary after API call.
 * @since_tizen 2.4
 */
@@ -60,6 +61,7 @@ typedef enum {
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Enumeration for directions of the widget hints.
 * @since_tizen 2.4
 * @see vc_elm_set_command_hint_direction()
@@ -79,6 +81,7 @@ typedef enum {
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief The voice control elementary for object or item object handle.
 * @since_tizen 2.4
 */
@@ -86,6 +89,7 @@ typedef struct vc_elm_s* vc_elm_h;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Called to retrieve supported language.
 * @since_tizen 2.4
 * @param[in] language A language is specified as an ISO 3166 alpha-2 two letter country-code
@@ -97,10 +101,11 @@ typedef struct vc_elm_s* vc_elm_h;
 * @pre The function will invoke this callback.
 * @see vc_elm_foreach_supported_languages()
 */
-typedef bool (*vc_elm_supported_language_cb)(const char* language, void* user_data);
+typedef bool (*vc_elm_supported_language_cb)(const char* language, void* user_data) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Called when default language is changed.
 * @since_tizen 2.4
 * @param[in] previous Previous language
@@ -109,10 +114,11 @@ typedef bool (*vc_elm_supported_language_cb)(const char* language, void* user_da
 * @pre An application registers this callback to detect changing language.
 * @see vc_elm_set_current_language_changed_cb()
 */
-typedef void (*vc_elm_current_language_changed_cb)(const char* previous, const char* current, void* user_data);
+typedef void (*vc_elm_current_language_changed_cb)(const char* previous, const char* current, void* user_data) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Called to retrieve supported widget.
 * @since_tizen 2.4
 * @param[in] widget Widget name
@@ -122,10 +128,11 @@ typedef void (*vc_elm_current_language_changed_cb)(const char* previous, const c
 * @pre The function will invoke this callback.
 * @see vc_elm_foreach_supported_widgets()
 */
-typedef bool (*vc_elm_widget_cb)(const char* widget, void* user_data);
+typedef bool (*vc_elm_widget_cb)(const char* widget, void* user_data) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Called to retrieve supported action.
 * @since_tizen 2.4
 * @param[in] action Action name
@@ -135,10 +142,11 @@ typedef bool (*vc_elm_widget_cb)(const char* widget, void* user_data);
 * @pre The function will invoke this callback.
 * @see vc_elm_foreach_supported_actions()
 */
-typedef bool (*vc_elm_action_cb)(const char* action, void* user_data);
+typedef bool (*vc_elm_action_cb)(const char* action, void* user_data) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Initializes voice control elementary module.
 * @since_tizen 2.4
 * @remarks If the function succeeds, the voice control elementary must be released with vc_elm_deinitialize().
@@ -151,10 +159,11 @@ typedef bool (*vc_elm_action_cb)(const char* action, void* user_data);
 * @retval #VC_ELM_ERROR_NOT_SUPPORTED Not supported
 * @see vc_elm_deinitialize()
 */
-int vc_elm_initialize(void);
+int vc_elm_initialize(void) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Deinitializes voice control elementary module.
 * @since_tizen 2.4
 * @return @c 0 on success, 
@@ -167,10 +176,11 @@ int vc_elm_initialize(void);
 * @pre vc_elm_initialize() should be successful.
 * @see vc_elm_initialize()
 */
-int vc_elm_deinitialize(void);
+int vc_elm_deinitialize(void) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Retrieves all supported languages using callback function.
 * @since_tizen 2.4
 * @privlevel public
@@ -190,10 +200,11 @@ int vc_elm_deinitialize(void);
 * @see vc_elm_supported_language_cb()
 * @see vc_elm_get_current_language()
 */
-int vc_elm_foreach_supported_languages(vc_elm_supported_language_cb callback, void* user_data);
+int vc_elm_foreach_supported_languages(vc_elm_supported_language_cb callback, void* user_data) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Gets current language.
 * @since_tizen 2.4
 * @privlevel public
@@ -213,10 +224,11 @@ int vc_elm_foreach_supported_languages(vc_elm_supported_language_cb callback, vo
 * @retval #VC_ELM_ERROR_NOT_SUPPORTED Not supported
 * @pre vc_elm_initialize() should be successful.
 */
-int vc_elm_get_current_language(char** language);
+int vc_elm_get_current_language(char** language) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Retrieves all supported widget using callback function.
 * @since_tizen 2.4
 * @privlevel public
@@ -236,10 +248,11 @@ int vc_elm_get_current_language(char** language);
 * @see vc_elm_widget_cb()
 * @see vc_elm_foreach_supported_actions()
 */
-int vc_elm_foreach_supported_widgets(vc_elm_widget_cb callback, void* user_data);
+int vc_elm_foreach_supported_widgets(vc_elm_widget_cb callback, void* user_data) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Retrieves all supported actions of widget using callback function.
 * @since_tizen 2.4
 * @privlevel public
@@ -260,10 +273,11 @@ int vc_elm_foreach_supported_widgets(vc_elm_widget_cb callback, void* user_data)
 * @see vc_elm_action_cb()
 * @see vc_elm_foreach_supported_widgets()
 */
-int vc_elm_foreach_supported_actions(const char* widget, vc_elm_action_cb callback, void* user_data);
+int vc_elm_foreach_supported_actions(const char* widget, vc_elm_action_cb callback, void* user_data) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Gets action command of action.
 * @since_tizen 2.4
 * @privlevel public
@@ -283,10 +297,11 @@ int vc_elm_foreach_supported_actions(const char* widget, vc_elm_action_cb callba
 * @retval #VC_ELM_ERROR_NOT_SUPPORTED Not supported
 * @pre vc_elm_initialize() should be successful.
 */
-int vc_elm_get_action_command(const char* action, char** command);
+int vc_elm_get_action_command(const char* action, char** command) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Creates vc elm handle for Evas object.
 * @since_tizen 2.4
 * @privlevel public
@@ -306,10 +321,11 @@ int vc_elm_get_action_command(const char* action, char** command);
 * @pre vc_elm_initialize() should be successful.
 * @see vc_elm_destroy()
 */
-int vc_elm_create_object(Evas_Object* object, vc_elm_h* vc_elm);
+int vc_elm_create_object(Evas_Object* object, vc_elm_h* vc_elm) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Creates vc elm handle for elm object item.
 * @since_tizen 2.4
 * @privlevel public
@@ -328,10 +344,11 @@ int vc_elm_create_object(Evas_Object* object, vc_elm_h* vc_elm);
 * @pre vc_elm_initialize() should be successful.
 * @see vc_elm_destroy()
 */
-int vc_elm_create_item(Elm_Object_Item* item, vc_elm_h* vc_elm);
+int vc_elm_create_item(Elm_Object_Item* item, vc_elm_h* vc_elm) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Destroys the handle.
 * @since_tizen 2.4
 * @privlevel public
@@ -348,10 +365,11 @@ int vc_elm_create_item(Elm_Object_Item* item, vc_elm_h* vc_elm);
 * @see vc_elm_create_object()
 * @see vc_elm_create_item()
 */
-int vc_elm_destroy(vc_elm_h vc_elm);
+int vc_elm_destroy(vc_elm_h vc_elm) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Sets command to the handle.
 * @since_tizen 2.4
 * @privlevel public
@@ -369,10 +387,11 @@ int vc_elm_destroy(vc_elm_h vc_elm);
 * @pre The vc_elm handle should be valid with vc_elm_create_object() or vc_elm_create_item().
 * @see vc_elm_unset_command()
 */
-int vc_elm_set_command(vc_elm_h vc_elm, const char* command);
+int vc_elm_set_command(vc_elm_h vc_elm, const char* command) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Unsets command from the handle.
 * @since_tizen 2.4
 * @privlevel public
@@ -389,10 +408,11 @@ int vc_elm_set_command(vc_elm_h vc_elm, const char* command);
 * @pre The vc_elm handle should be valid with vc_elm_create_object() or vc_elm_create_item().
 * @see vc_elm_set_command()
 */
-int vc_elm_unset_command(vc_elm_h vc_elm);
+int vc_elm_unset_command(vc_elm_h vc_elm) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Sets command hint for the handle.
 * @since_tizen 2.4
 * @privlevel public
@@ -410,10 +430,11 @@ int vc_elm_unset_command(vc_elm_h vc_elm);
 * @pre The vc_elm handle should be valid with vc_elm_create_object() or vc_elm_create_item().
 * @see vc_elm_unset_command_hint()
 */
-int vc_elm_set_command_hint(vc_elm_h vc_elm, const char* hint);
+int vc_elm_set_command_hint(vc_elm_h vc_elm, const char* hint) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Unsets command hint for the handle.
 * @since_tizen 2.4
 * @privlevel public
@@ -430,10 +451,11 @@ int vc_elm_set_command_hint(vc_elm_h vc_elm, const char* hint);
 * @pre The vc_elm handle should be valid with vc_elm_create_object() or vc_elm_create_item().
 * @see vc_elm_set_command_hint()
 */
-int vc_elm_unset_command_hint(vc_elm_h vc_elm);
+int vc_elm_unset_command_hint(vc_elm_h vc_elm) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Sets the direction of hint to the handle.
 * @since_tizen 2.4
 * @privlevel public
@@ -453,10 +475,11 @@ int vc_elm_unset_command_hint(vc_elm_h vc_elm);
 * @see vc_elm_set_command_hint()
 * @see vc_elm_get_command_hint_direction()
 */
-int vc_elm_set_command_hint_direction(vc_elm_h vc_elm, vc_elm_direction_e direction);
+int vc_elm_set_command_hint_direction(vc_elm_h vc_elm, vc_elm_direction_e direction) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Unsets the direction of hint from the handle.
 * @since_tizen 2.4
 * @privlevel public
@@ -474,10 +497,11 @@ int vc_elm_set_command_hint_direction(vc_elm_h vc_elm, vc_elm_direction_e direct
 * @pre The vc_elm handle should be valid with vc_elm_create_object() or vc_elm_create_item().
 * @see vc_elm_set_command_hint_direction()
 */
-int vc_elm_get_command_hint_direction(vc_elm_h vc_elm, vc_elm_direction_e* direction);
+int vc_elm_get_command_hint_direction(vc_elm_h vc_elm, vc_elm_direction_e* direction) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Sets command hint's x,y position to the handle.
 * @since_tizen 2.4
 * @privlevel public
@@ -497,10 +521,11 @@ int vc_elm_get_command_hint_direction(vc_elm_h vc_elm, vc_elm_direction_e* direc
 * @see vc_elm_set_command_hint()
 * @see vc_elm_get_command_hint_offset()
 */
-int vc_elm_set_command_hint_offset(vc_elm_h vc_elm, int pos_x, int pos_y);
+int vc_elm_set_command_hint_offset(vc_elm_h vc_elm, int pos_x, int pos_y) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Gets command hint's x,y position from the handle.
 * @since_tizen 2.4
 * @privlevel public
@@ -519,10 +544,11 @@ int vc_elm_set_command_hint_offset(vc_elm_h vc_elm, int pos_x, int pos_y);
 * @pre The vc_elm handle should be valid with vc_elm_create_object() or vc_elm_create_item().
 * @see vc_elm_set_command_hint_offset()
 */
-int vc_elm_get_command_hint_offset(vc_elm_h vc_elm, int* pos_x, int* pos_y);
+int vc_elm_get_command_hint_offset(vc_elm_h vc_elm, int* pos_x, int* pos_y) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Registers a callback function to be called when current language is changed.
 * @since_tizen 2.4
 * @privlevel public
@@ -539,10 +565,11 @@ int vc_elm_get_command_hint_offset(vc_elm_h vc_elm, int* pos_x, int* pos_y);
 * @pre vc_elm_initialize() should be successful.
 * @see vc_elm_unset_current_language_changed_cb()
 */
-int vc_elm_set_current_language_changed_cb(vc_elm_current_language_changed_cb callback, void* user_data);
+int vc_elm_set_current_language_changed_cb(vc_elm_current_language_changed_cb callback, void* user_data) TIZEN_DEPRECATED_API;
 
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Unregisters the callback function.
 * @since_tizen 2.4
 * @privlevel public
@@ -556,7 +583,7 @@ int vc_elm_set_current_language_changed_cb(vc_elm_current_language_changed_cb ca
 * @pre vc_elm_initialize() should be successful.
 * @see vc_elm_set_current_language_changed_cb()
 */
-int vc_elm_unset_current_language_changed_cb(void);
+int vc_elm_unset_current_language_changed_cb(void) TIZEN_DEPRECATED_API;
 
 
 #ifdef __cplusplus
index 09516e2554a703709ee46233df5bda7de87c9709..c90bd67ea0fcb19faab1e49f848435ece7dd7e01 100644 (file)
@@ -19,6 +19,7 @@
 #define VOICE_CONTROL_ELEMENTARY_PRIVATE_H_
 
 #include <stdbool.h>
+#include <tizen.h>
 
 /**
 * @internal
@@ -31,6 +32,7 @@ extern "C" {
 #endif
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Set auto command-register mode and click method for recognized object.
 * @since_tizen 3.0
 *
@@ -47,9 +49,10 @@ extern "C" {
 *
 * @see vc_elm_get_auto_register_mode()
 */
-int vc_elm_set_auto_register_mode(int mode, int click_method);
+int vc_elm_set_auto_register_mode(int mode, int click_method) TIZEN_DEPRECATED_API;
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Get auto command-register mode and click method for recognized object.
 * @since_tizen 3.0
 *
@@ -66,9 +69,10 @@ int vc_elm_set_auto_register_mode(int mode, int click_method);
 *
 * @see vc_elm_set_auto_register_mode()
 */
-int vc_elm_get_auto_register_mode(int* mode, int* click_method);
+int vc_elm_get_auto_register_mode(int* mode, int* click_method) TIZEN_DEPRECATED_API;
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Add allowed text part for auto command register.
 * @since_tizen 3.0
 *
@@ -85,9 +89,10 @@ int vc_elm_get_auto_register_mode(int* mode, int* click_method);
 *
 * @see vc_elm_remove_allowed_text_part()
 */
-int vc_elm_add_allowed_text_part(const char* text_part);
+int vc_elm_add_allowed_text_part(const char* text_part) TIZEN_DEPRECATED_API;
 
 /**
+* @deprecated Deprecated since 10.0
 * @brief Remove the list of additional allowed text part for auto command register.
 * @since_tizen 3.0
 *
@@ -102,21 +107,22 @@ int vc_elm_add_allowed_text_part(const char* text_part);
 *
 * @see vc_elm_add_allowed_text_part()
 */
-int vc_elm_remove_allowed_text_part(void);
+int vc_elm_remove_allowed_text_part(void) TIZEN_DEPRECATED_API;
 
-int vc_elm_set_geometry_info(int x, int y, int w, int h);
+int vc_elm_set_geometry_info(int x, int y, int w, int h) TIZEN_DEPRECATED_API;
 
-int vc_elm_unset_geometry_info();
+int vc_elm_unset_geometry_info() TIZEN_DEPRECATED_API;
 
-int vc_elm_set_click_time(float time);
+int vc_elm_set_click_time(float time) TIZEN_DEPRECATED_API;
 
-int vc_elm_unset_click_time();
+int vc_elm_unset_click_time() TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 10.0
  * @brief Function that check whether voice touch is set as auto mode or not
  * @param[out] is_vt_automode a parameter for checking whether voice touch is set as auto mode or not
  */
-int vc_elm_is_supported_vt_auto(int* is_vt_automode);
+int vc_elm_is_supported_vt_auto(int* is_vt_automode) TIZEN_DEPRECATED_API;
 
 #ifdef __cplusplus
 }