summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormk5004.lee <mk5004.lee@samsung.com>2018-09-14 02:35:58 (GMT)
committermk5004.lee <mk5004.lee@samsung.com>2018-09-18 08:30:38 (GMT)
commit5acd6e76e5b46c245e0ff5d31a74cccb181522d2 (patch)
treeab55d4f48c4eaa9b9b1c4812209f88e804e3fd0e
parent668e4afd135da7bdd5fad4a96e36b9d06934a9ef (diff)
downloadminicontrol-5acd6e76e5b46c245e0ff5d31a74cccb181522d2.zip
minicontrol-5acd6e76e5b46c245e0ff5d31a74cccb181522d2.tar.gz
minicontrol-5acd6e76e5b46c245e0ff5d31a74cccb181522d2.tar.bz2
Change-Id: I23140fbd5a4e1d36d405bcb057627c6705fe4363 Signed-off-by: mk5004.lee <mk5004.lee@samsung.com>
-rwxr-xr-xinclude/minicontrol-error.h2
-rwxr-xr-xinclude/minicontrol-internal.h6
-rwxr-xr-xinclude/minicontrol-provider.h14
-rwxr-xr-xinclude/minicontrol-type.h8
-rwxr-xr-xinclude/minicontrol-viewer.h28
5 files changed, 34 insertions, 24 deletions
diff --git a/include/minicontrol-error.h b/include/minicontrol-error.h
index 460c74a..b68771b 100755
--- a/include/minicontrol-error.h
+++ b/include/minicontrol-error.h
@@ -31,7 +31,7 @@
/**
* @brief Enumeration for describing error code of minicontrol library.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
*/
typedef enum _minicontrol_error {
MINICONTROL_ERROR_NONE = TIZEN_ERROR_NONE, /**< MiniControl error none */
diff --git a/include/minicontrol-internal.h b/include/minicontrol-internal.h
index 2cbb87f..244404a 100755
--- a/include/minicontrol-internal.h
+++ b/include/minicontrol-internal.h
@@ -45,7 +45,7 @@ enum _minictrl_PROC_DBUS_TYPE {
/**
* @brief Enumeration for describing type of actions allowed to inhouse apps.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
*/
typedef enum {
MINICONTROL_REQ_NONE = 0,
@@ -58,7 +58,7 @@ typedef enum {
/**
* @brief Enumeration for describing priority of a minicontrol provider.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
*/
typedef enum {
MINICONTROL_PRIORITY_TOP = 1000, /**< Top priority */
@@ -68,7 +68,7 @@ typedef enum {
/**
* @brief Enumeration for describing type of events originated by a minicontrol provider.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
*/
typedef enum _minicontrol_action {
MINICONTROL_ACTION_START = 0, /**< A minicontrol object is created */
diff --git a/include/minicontrol-provider.h b/include/minicontrol-provider.h
index 8481a27..c1721cd 100755
--- a/include/minicontrol-provider.h
+++ b/include/minicontrol-provider.h
@@ -19,8 +19,8 @@
#include <Evas.h>
#include <bundle.h>
-#include "minicontrol-error.h"
-#include "minicontrol-type.h"
+#include <minicontrol-error.h>
+#include <minicontrol-type.h>
#ifdef __cplusplus
extern "C" {
@@ -41,9 +41,11 @@ extern "C" {
/**
* @brief Called when a event comes from viewer.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a event_arg should not be released.
* @param[in] event_type The type of fired event
* @param[in] event_arg Argument of the event
+ * The @a event_arg can be used only in the callback. To use outside, make a copy.
* @pre minicontrol_viewer_register_event_callback() used to register this callback.
* @see #minicontrol_create_window
* @see #minicontrol_viewer_event_e
@@ -52,8 +54,9 @@ typedef void (*minicontrol_event_cb)(minicontrol_viewer_event_e event_type, bund
/**
* @brief Creates a window for minicontrol.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
* @remarks The specific error code can be obtained using the gat_last_result() method. Error codes are described in Exception section.
+ * The returned value should be released using evas_object_del().
* @param[in] name Name of minicontrol socket window
* @param[in] target_viewer Target viewer for minicontrol. You can select multiple viewers by using bitwise OR operator
* @param[in] callback A callback function for events originated by minicontrol viewer
@@ -71,13 +74,14 @@ Evas_Object *minicontrol_create_window(const char *name, minicontrol_target_view
/**
* @brief Sends a event to the viewer.
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
* @remarks When a viewer doesn't handle some events, it can be ignored.
- * @since_tizen 2.4
* @param[in] minicontrol Minicontrol window
* @param[in] event Type of the event
* @param[in] event_arg Bundle argument of the event
* @return #MINICONTROL_ERROR_NONE on success,
* otherwise an error code on failure
+ * @retval #MINICONTROL_ERROR_NONE Success
* @retval #MINICONTROL_ERROR_INVALID_PARAMETER Invalid argument
* @retval #MINICONTROL_ERROR_NOT_SUPPORTED Not supported
* @see #minicontrol_provider_event_e
diff --git a/include/minicontrol-type.h b/include/minicontrol-type.h
index 3119b51..ef29abc 100755
--- a/include/minicontrol-type.h
+++ b/include/minicontrol-type.h
@@ -93,7 +93,7 @@
/**
* @brief Enumeration for describing types of events originated by a minicontrol provider.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
*/
typedef enum {
MINICONTROL_EVENT_START, /**< A minicontrol object is created */
@@ -106,7 +106,7 @@ typedef enum {
/**
* @brief Enumeration for types of events which will be sent by minicontrol_send_event.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
*/
typedef enum {
MINICONTROL_PROVIDER_EVENT_REQUEST_HIDE = MINICONTROL_EVENT_REQUEST_HIDE, /**< Requests that the minicontrol viewer(s) close the provider's minicontrol. Required bundle argument : NULL. */
@@ -115,7 +115,7 @@ typedef enum {
/**
* @brief Enumeration for types of events which will be sent by minicontrol_viewer_send_event.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
*/
typedef enum {
MINICONTROL_VIEWER_EVENT_REPORT_ANGLE = MINICONTROL_EVENT_REPORT_ANGLE, /**< Reports the current angle of the minicontrol viewer. Required argument : Angle of minicontrol viewer, Bundle Key : "angle", Bundle Value Type : string.*/
@@ -125,7 +125,7 @@ typedef enum {
/**
* @brief Enumeration for selecting target viewers.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
*/
typedef enum {
MINICONTROL_TARGET_VIEWER_QUICK_PANEL = 0x0001, /**< Request to place the minicontrol on the quickpanel */
diff --git a/include/minicontrol-viewer.h b/include/minicontrol-viewer.h
index e8d1020..67531b2 100755
--- a/include/minicontrol-viewer.h
+++ b/include/minicontrol-viewer.h
@@ -19,8 +19,8 @@
#include <Evas.h>
#include <bundle.h>
-#include "minicontrol-error.h"
-#include "minicontrol-type.h"
+#include <minicontrol-error.h>
+#include <minicontrol-type.h>
#ifdef __cplusplus
extern "C" {
@@ -40,8 +40,9 @@ extern "C" {
/**
* @brief Adds minicontrol named as "minicontrol_name" to a given parent evas object and returns it.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
* @remarks The specific error code can be obtained using the gat_last_result() method. Error codes are described in Exception section.
+ * The returned value should be released using evas_object_del().
* @param[in] parent Minicontrol object will be added to this parent evas object
* @param[in] minicontrol_name Name of minicontrol
* @return Evas object of minicontrol. NULL on error
@@ -55,12 +56,13 @@ Evas_Object *minicontrol_viewer_add(Evas_Object *parent, const char *minicontrol
/**
* @brief Sends a event to the provider.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
* @param[in] minicontrol_name The name of the minicontrol window
* @param[in] event Type of the event
* @param[in] event_arg A bundle of arguments
* @return #MINICONTROL_ERROR_NONE on success,
* otherwise an error code on failure
+ * @retval #MINICONTROL_ERROR_NONE Success
* @retval #MINICONTROL_ERROR_INVALID_PARAMETER Invalid argument
* @retval #MINICONTROL_ERROR_NOT_SUPPORTED Not supported
* @see #minicontrol_viewer_event_e
@@ -69,22 +71,26 @@ int minicontrol_viewer_send_event(const char *minicontrol_name, minicontrol_view
/**
* @brief Called when a event comes from the provider.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
+ * @remarks The @a event_arg should not be released.
* @param[in] event The type of fired event
* @param[in] minicontrol_name The name of the minicontrol window
+ * The @a minicontrol_name can be used only in the callback. To use outside, make a copy.
* @param[in] event_arg A bundle of arguments
- * @param[in] data User data
+ * The @a event_arg can be used only in the callback. To use outside, make a copy.
+ * @param[in] user_data User data
* @see #minicontrol_viewer_set_event_cb
*/
-typedef void (*minicontrol_viewer_event_cb)(minicontrol_event_e event, const char *minicontrol_name, bundle *event_arg, void *data);
+typedef void (*minicontrol_viewer_event_cb)(minicontrol_event_e event, const char *minicontrol_name, bundle *event_arg, void *user_data);
/**
- * @brief Registers a callback for events originated by minicontrol provider.
- * @since_tizen 2.4
+ * @brief Sets a callback for events originated by minicontrol provider.
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
* @param[in] callback Callback function
* @param[in] user_data User data
* @return #MINICONTROL_ERROR_NONE on success,
* otherwise an error code on failure
+ * @retval #MINICONTROL_ERROR_NONE Success
* @retval #MINICONTROL_ERROR_INVALID_PARAMETER Invalid argument
* @retval #MINICONTROL_ERROR_IPC_FAILURE IPC failure
* @retval #MINICONTROL_ERROR_OUT_OF_MEMORY Out of memory
@@ -95,8 +101,8 @@ typedef void (*minicontrol_viewer_event_cb)(minicontrol_event_e event, const cha
int minicontrol_viewer_set_event_cb(minicontrol_viewer_event_cb callback, void *user_data);
/**
- * @brief Unregisters a callback for events originated by minicontrol provider.
- * @since_tizen 2.4
+ * @brief Unsets a callback for events originated by minicontrol provider.
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 5.0 @endif
* @return #MINICONTROL_ERROR_NONE if success,
* other value if failure
* @retval #MINICONTROL_ERROR_NOT_SUPPORTED Not supported