Deprecate eom 48/294248/2
authorJunkyeong Kim <jk0430.kim@samsung.com>
Thu, 15 Jun 2023 04:25:37 +0000 (13:25 +0900)
committerJunkyeong Kim <jk0430.kim@samsung.com>
Thu, 15 Jun 2023 07:47:21 +0000 (16:47 +0900)
Change-Id: I837a21e6294425d4fa1eec1754968269baa9800f
Signed-off-by: Junkyeong Kim <jk0430.kim@samsung.com>
doc/ui_eom_doc.h
include/eom-connect.h
include/eom.h

index 0691bfa8fb49aec85d62892346a2434ee69ffd3a..3db46d0bb1d9794c524b7ccda6c2dcf6b385a478 100644 (file)
@@ -38,7 +38,7 @@ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 /**
   * @ingroup CAPI_UI_FRAMEWORK
-  * @defgroup CAPI_UI_EOM_MODULE External Output Manager
+  * @defgroup CAPI_UI_EOM_MODULE External Output Manager (Deprecated)
   * @brief The External Output Manager provides APIs for external outputs.
   *
   * @section CAPI_UI_EOM_MODULE_HEADER Required Header
index c0f4c8e8dd788636a7b6313d99692aa6839d6b23..196261209bb363f744fc2a469022f4b8f54509e8 100644 (file)
@@ -52,6 +52,7 @@ extern "C" {
  */
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Set mode to external output.
  * @param[in] output : The pointer of external output instance
  * @param[in] output_id : eom output id
@@ -63,7 +64,7 @@ extern "C" {
  * @retval #EOM_ERROR_OPERATE_MESSAGE_FAILE Message operation failure
  * see #eom_output_mode_e
  */
-int eom_output_set_mode(eom_output_id output_id, eom_output_mode_e mode);
+int eom_output_set_mode(eom_output_id output_id, eom_output_mode_e mode) TIZEN_DEPRECATED_API;
 
 
 #ifdef __cplusplus
index 8f90dfb64664b0dbf30de468390c752e5aa83f39..e035a51d5d56b763516c4646fe4c39ad5047e96b 100644 (file)
@@ -52,6 +52,7 @@ extern "C" {
 #include <Evas.h>
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Enumeration of External Output Manager (EOM) error type.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
@@ -66,6 +67,7 @@ typedef enum {
 } eom_error_e;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Enumeration of external output type.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
@@ -91,6 +93,7 @@ typedef enum {
 } eom_output_type_e;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Enumeration of external output mode.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
@@ -102,6 +105,7 @@ typedef enum {
 } eom_output_mode_e;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Enumeration of External Output Manager (EOM) attributes.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
@@ -114,6 +118,7 @@ typedef enum {
 } eom_output_attribute_e;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Enumeration of External Output Manager (EOM) attribute state.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
@@ -126,12 +131,14 @@ typedef enum {
 } eom_output_attribute_state_e;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Definition for external output ID.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef unsigned int eom_output_id;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Called when External Output Manager (EOM) module sends output
  *           connection notification.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -144,6 +151,7 @@ typedef unsigned int eom_output_id;
 typedef void (*eom_output_added_cb)(eom_output_id output_id, void *user_data);
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Called when External Output Manager (EOM) module sends output
  *           disconnection notification.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -156,6 +164,7 @@ typedef void (*eom_output_added_cb)(eom_output_id output_id, void *user_data);
 typedef void (*eom_output_removed_cb)(eom_output_id output_id, void *user_data);
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Called when External Output Manager (EOM) module sends output
  *           mode changing notification.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -168,6 +177,7 @@ typedef void (*eom_output_removed_cb)(eom_output_id output_id, void *user_data);
 typedef void (*eom_mode_changed_cb)(eom_output_id output_id, void *user_data);
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Called when External Output Manager (EOM) module sends output
  *           attribute changing notification.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -180,6 +190,7 @@ typedef void (*eom_mode_changed_cb)(eom_output_id output_id, void *user_data);
 typedef void (*eom_attribute_changed_cb)(eom_output_id output_id, void *user_data);
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Initializes External Output Manager (EOM).
  * @details User should call this function previously for using EOM.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -190,18 +201,20 @@ typedef void (*eom_attribute_changed_cb)(eom_output_id output_id, void *user_dat
  * @see eom_deinit()
  * @see #eom_error_e
  */
-int eom_init(void);
+int eom_init(void) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Finalizes External Output Manager (EOM).
  * @details User should call this function after using EOM to release all
  *              resources of EOM.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @see eom_init()
  */
-void eom_deinit(void);
+void eom_deinit(void) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Registers a callback function to get output connection notification
  *           from External Output Manager (EOM) module.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -218,9 +231,10 @@ void eom_deinit(void);
  * @see eom_unset_output_added_cb()
  * @see #eom_output_added_cb
  */
-int eom_set_output_added_cb(eom_output_added_cb callback, void *user_data);
+int eom_set_output_added_cb(eom_output_added_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Unregisters the callback function.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] callback  The function pointer of eom_output_added_cb() callback
@@ -233,9 +247,10 @@ int eom_set_output_added_cb(eom_output_added_cb callback, void *user_data);
  * @see eom_set_output_added_cb()
  * @see #eom_output_added_cb
  */
-int eom_unset_output_added_cb(eom_output_added_cb callback);
+int eom_unset_output_added_cb(eom_output_added_cb callback) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Registers a callback function to get output disconnection
  *           notification from External Output Manager (EOM) module.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -252,9 +267,10 @@ int eom_unset_output_added_cb(eom_output_added_cb callback);
  * @see eom_unset_output_removed_cb()
  * @see #eom_output_removed_cb
  */
-int eom_set_output_removed_cb(eom_output_removed_cb callback, void *user_data);
+int eom_set_output_removed_cb(eom_output_removed_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Unregisters the callback function.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] callback  The function pointer of eom_output_removed_cb() callback
@@ -267,9 +283,10 @@ int eom_set_output_removed_cb(eom_output_removed_cb callback, void *user_data);
  * @see eom_set_output_removed_cb()
  * @see #eom_output_removed_cb
  */
-int eom_unset_output_removed_cb(eom_output_removed_cb callback);
+int eom_unset_output_removed_cb(eom_output_removed_cb callback) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Registers a callback function to get output mode changing
  *           notification from External Output Manager (EOM) module.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -286,9 +303,10 @@ int eom_unset_output_removed_cb(eom_output_removed_cb callback);
  * @see eom_unset_mode_changed_cb()
  * @see #eom_mode_changed_cb
  */
-int eom_set_mode_changed_cb(eom_mode_changed_cb callback, void *user_data);
+int eom_set_mode_changed_cb(eom_mode_changed_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Unregisters the callback function.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] callback  The function pointer of eom_mode_changed_cb() callback
@@ -301,9 +319,10 @@ int eom_set_mode_changed_cb(eom_mode_changed_cb callback, void *user_data);
  * @see eom_set_mode_changed_cb()
  * @see #eom_mode_changed_cb
  */
-int eom_unset_mode_changed_cb(eom_mode_changed_cb callback);
+int eom_unset_mode_changed_cb(eom_mode_changed_cb callback) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Registers a callback function to get output attribute changing
  *           notification from External Output Manager (EOM) module.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -320,9 +339,10 @@ int eom_unset_mode_changed_cb(eom_mode_changed_cb callback);
  * @see eom_unset_attribute_changed_cb()
  * @see #eom_attribute_changed_cb
  */
-int eom_set_attribute_changed_cb(eom_attribute_changed_cb callback, void *user_data);
+int eom_set_attribute_changed_cb(eom_attribute_changed_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Unregisters the callback function.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] callback  The function pointer of eom_attribute_changed_cb()
@@ -335,9 +355,10 @@ int eom_set_attribute_changed_cb(eom_attribute_changed_cb callback, void *user_d
  * @see eom_set_attribute_changed_cb()
  * @see #eom_attribute_changed_cb
  */
-int eom_unset_attribute_changed_cb(eom_attribute_changed_cb callback);
+int eom_unset_attribute_changed_cb(eom_attribute_changed_cb callback) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets the IDs and count of external output.
  * @details This function returns the IDs of external output which are
  *              available to connect to target device, and the count of them
@@ -358,9 +379,10 @@ int eom_unset_attribute_changed_cb(eom_attribute_changed_cb callback);
  * @see #eom_output_id
  * @see #eom_error_e
  */
-eom_output_id *eom_get_eom_output_ids(int *count);
+eom_output_id *eom_get_eom_output_ids(int *count) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets type of external output.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @remarks The specific error code can be obtained using the get_last_result()
@@ -376,9 +398,10 @@ eom_output_id *eom_get_eom_output_ids(int *count);
  * @see #eom_error_e
  * @see #eom_output_type_e
  */
-int eom_get_output_type(eom_output_id output_id, eom_output_type_e *type);
+int eom_get_output_type(eom_output_id output_id, eom_output_type_e *type) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets mode of external output.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @remarks The specific error code can be obtained using the get_last_result()
@@ -395,9 +418,10 @@ int eom_get_output_type(eom_output_id output_id, eom_output_type_e *type);
  * @see #eom_error_e
  * @see #eom_output_mode_e
  */
-int eom_get_output_mode(eom_output_id output_id, eom_output_mode_e *mode);
+int eom_get_output_mode(eom_output_id output_id, eom_output_mode_e *mode) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets attribute of external output.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @remarks The specific error code can be obtained using the get_last_result()
@@ -414,9 +438,10 @@ int eom_get_output_mode(eom_output_id output_id, eom_output_mode_e *mode);
  * @see #eom_error_e
  * @see #eom_output_attribute_e
  */
-int eom_get_output_attribute(eom_output_id output_id, eom_output_attribute_e *attribute);
+int eom_get_output_attribute(eom_output_id output_id, eom_output_attribute_e *attribute) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets attribute state of external output.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @remarks The specific error code can be obtained using the get_last_result()
@@ -433,9 +458,10 @@ int eom_get_output_attribute(eom_output_id output_id, eom_output_attribute_e *at
  * @see #eom_error_e
  * @see #eom_output_attribute_state_e
  */
-int eom_get_output_attribute_state(eom_output_id output_id, eom_output_attribute_state_e *state);
+int eom_get_output_attribute_state(eom_output_id output_id, eom_output_attribute_state_e *state) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets resolution of external output.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] output_id  The id of external output device
@@ -450,9 +476,10 @@ int eom_get_output_attribute_state(eom_output_id output_id, eom_output_attribute
  * @see #eom_output_id
  * @see #eom_error_e
  */
-int eom_get_output_resolution(eom_output_id output_id, int *width, int *height);
+int eom_get_output_resolution(eom_output_id output_id, int *width, int *height) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets physical width/height (millimeters) of external output.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @param[in] output_id  The id of external output device
@@ -467,9 +494,10 @@ int eom_get_output_resolution(eom_output_id output_id, int *width, int *height);
  * @see #eom_output_id
  * @see #eom_error_e
  */
-int eom_get_output_physical_size(eom_output_id output_id, int *phy_width, int *phy_height);
+int eom_get_output_physical_size(eom_output_id output_id, int *phy_width, int *phy_height) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Sets the attribute of the external output ID.
  * @details The application can set the External Output Manager (EOM) attribute
  *              to the external output ID.
@@ -492,9 +520,10 @@ int eom_get_output_physical_size(eom_output_id output_id, int *phy_width, int *p
  * @see #eom_output_id
  * @see #eom_error_e
  */
-int eom_set_output_attribute(eom_output_id output_id, eom_output_attribute_e attr);
+int eom_set_output_attribute(eom_output_id output_id, eom_output_attribute_e attr) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Sets window to the external output best resolution of external output
  *           device.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -512,7 +541,7 @@ int eom_set_output_attribute(eom_output_id output_id, eom_output_attribute_e att
  * @see #eom_output_id
  * @see #eom_error_e
  */
-int eom_set_output_window(eom_output_id output_id, Evas_Object *win);
+int eom_set_output_window(eom_output_id output_id, Evas_Object *win) TIZEN_DEPRECATED_API;
 
 #ifdef __cplusplus
 }