Merge from kiran SPIN notification

Change-Id: I54a4a05b17e0e5aade10c295ab9c357299e68815
Signed-off-by: hyun lee <hyunn.lee@samsung.com>

1 files changed, 100 insertions, 62 deletions

diff --git a/include/notification_type.h b/include/notification_type.h
index cee8a52..1fcd343 100755
--- a/include/notification_type.h
+++ b/include/notification_type.h
@@ -26,42 +26,63 @@
 extern "C" {
 #endif
 
+#ifndef NOTIFICATION_DEPRECATED_API
+#if 0//__GNUC__
+#define NOTIFICATION_DEPRECATED_API __attribute__((deprecated))
+#else
+#define NOTIFICATION_DEPRECATED_API
+#endif
+#endif
+
 /**
  * @file notification_type.h
- * @brief This file contains defines and enumerations for Notification APIs
+ * @brief This file contains type definitions and enumerations for Notification API.
  */
 
 /**
- * @addtogroup NOTIFICATION_TYPE
+ * @addtogroup NOTIFICATION_MODULE
  * @{
  */
 
 /**
- * @brief Enumeration for notification layout type
+ * @brief Enumeration for notification layout type.
+ * @since_tizen 2.3
  */
 typedef enum _notification_ly_type {
 	NOTIFICATION_LY_NONE = 0,
+		/**< Default */
 	NOTIFICATION_LY_NOTI_EVENT_SINGLE,
-		/**< layout for notification. used to inform single event*/
+        /**< Layout for notification. Used to inform single event*/
 	NOTIFICATION_LY_NOTI_EVENT_MULTIPLE,
-		/**< layout for notification. used to inform multiple event*/
+        /**< Layout for notification. Used to inform multiple event*/
 	NOTIFICATION_LY_NOTI_THUMBNAIL,
-		/**< layout for notification. used to display images*/
+        /**< Layout for notification. Used to display images*/
 	NOTIFICATION_LY_ONGOING_EVENT,
-		/**< layout for ongoing notification. used to display text message*/
+        /**< Layout for ongoing notification. Used to display text message*/
 	NOTIFICATION_LY_ONGOING_PROGRESS,
-		/**< layout for ongoing notification. used to display progress*/
+        /**< Layout for ongoing notification. Used to display progress*/
 	NOTIFICATION_LY_MAX,
+		/**< TBD */
 } notification_ly_type_e;
 
 /**
+ * @brief Enumeration for notification lauch option type.
+ * @since_tizen 2.3
+ */
+typedef enum  _notification_launch_option_type {
+	NOTIFICATION_LAUNCH_OPTION_APP_CONTROL = 1,
+					/**< launching with app control */
+} notification_launch_option_type;
+
+/**
  * @brief Enumeration for notification sound type.
+ * @since_tizen 2.3
  */
 typedef enum _notification_sound_type {
 	NOTIFICATION_SOUND_TYPE_NONE = -1,
 					/**< Default value. no sound */
 	NOTIFICATION_SOUND_TYPE_DEFAULT = 0,
-					/**< default sound */
+					/**< Default sound */
 	NOTIFICATION_SOUND_TYPE_USER_DATA,
 					/**< User sound data */
 	NOTIFICATION_SOUND_TYPE_MAX,
@@ -70,41 +91,45 @@ typedef enum _notification_sound_type {
 
 /**
  * @brief Enumeration for notification vibration type.
+ * @since_tizen 2.3
  */
 typedef enum _notification_vibration_type {
 	NOTIFICATION_VIBRATION_TYPE_NONE = -1,
-					/**< Default value. no vibration */
-	NOTIFICATION_VIBRATION_TYPE_DEFAULT = 0,/**< default vibrate pattern */
+                    /**< Default value. No vibration */
+	NOTIFICATION_VIBRATION_TYPE_DEFAULT = 0,/**< Default vibrate pattern */
 	NOTIFICATION_VIBRATION_TYPE_USER_DATA,
 					/**< User vibration data */
 	NOTIFICATION_VIBRATION_TYPE_MAX,/**< Max flag */
 } notification_vibration_type_e;
 
 /**
- * @brief Enumeration for notification led operation.
+ * @brief Enumeration for notification LED operation.
+ * @since_tizen 2.3
  */
 typedef enum _notification_led_op {
 	NOTIFICATION_LED_OP_OFF = -1,
 					/**< Default value. Disable the LED notification */
-	NOTIFICATION_LED_OP_ON = 0,/**< turn on the LED with default color */
+	NOTIFICATION_LED_OP_ON = 0,/**< Turn on the LED with default color */
 	NOTIFICATION_LED_OP_ON_CUSTOM_COLOR,
-					/**< turn on the LED with custom color */
+					/**< Turn on the LED with custom color */
 	NOTIFICATION_LED_OP_MAX,/**< Max flag */
 } notification_led_op_e;
 
 /**
- * @brief Will be deprecated.
+ * @brief This will be deprecated.
+ * @since_tizen 2.3
  */
 typedef enum _notification_count_display_type {
-	NOTIFICATION_COUNT_DISPLAY_TYPE_NONE = -1,
-	NOTIFICATION_COUNT_DISPLAY_TYPE_LEFT = 0,
-	NOTIFICATION_COUNT_DISPLAY_TYPE_IN,
-	NOTIFICATION_COUNT_DISPLAY_TYPE_RIGHT,
-	NOTIFICATION_COUNT_DISPLAY_TYPE_MAX,
+	NOTIFICATION_COUNT_DISPLAY_TYPE_NONE = -1,	/**< None */
+	NOTIFICATION_COUNT_DISPLAY_TYPE_LEFT = 0,	/**< The number is placed to left */
+	NOTIFICATION_COUNT_DISPLAY_TYPE_IN,	/**< The number is placed to center */
+	NOTIFICATION_COUNT_DISPLAY_TYPE_RIGHT,	/**< The number is placed to right */
+	NOTIFICATION_COUNT_DISPLAY_TYPE_MAX,	/**< Max flag */
 } notification_count_display_type_e;
 
 /**
  * @brief Enumeration for notification text type.
+ * @since_tizen 2.3
  */
 typedef enum _notification_text_type {
 	NOTIFICATION_TEXT_TYPE_NONE = -1,
@@ -116,19 +141,19 @@ typedef enum _notification_text_type {
 	NOTIFICATION_TEXT_TYPE_CONTENT_FOR_DISPLAY_OPTION_IS_OFF,
 								/**< Content for content display option is off of the Settings */
 	NOTIFICATION_TEXT_TYPE_EVENT_COUNT,
-								/**< text to display event count */
+								/**< Text to display event count */
 	NOTIFICATION_TEXT_TYPE_INFO_1,
-								/**< box contents 1 */
+								/**< Box contents 1 */
 	NOTIFICATION_TEXT_TYPE_INFO_SUB_1,
-								/**< box contents 1-1 */
+								/**< Box contents 1-1 */
 	NOTIFICATION_TEXT_TYPE_INFO_2,
-								/**< box contents 2 */
+								/**< Box contents 2 */
 	NOTIFICATION_TEXT_TYPE_INFO_SUB_2,
-								/**< box contents 2-1 */
+								/**< Box contents 2-1 */
 	NOTIFICATION_TEXT_TYPE_INFO_3,
-								/**< box contents 3 */
+								/**< Box contents 3 */
 	NOTIFICATION_TEXT_TYPE_INFO_SUB_3,
-								/**< box contents 3-1 */
+								/**< Box contents 3-1 */
 	NOTIFICATION_TEXT_TYPE_GROUP_TITLE,
 					/**< Group title */
 	NOTIFICATION_TEXT_TYPE_GROUP_CONTENT,
@@ -140,7 +165,8 @@ typedef enum _notification_text_type {
 } notification_text_type_e;
 
 /**
- * @brief Enumeration for image text type.
+ * @brief Enumeration for image type.
+ * @since_tizen 2.3
  */
 typedef enum _notification_image_type {
 	NOTIFICATION_IMAGE_TYPE_NONE = -1,
@@ -160,15 +186,15 @@ typedef enum _notification_image_type {
 	NOTIFICATION_IMAGE_TYPE_BACKGROUND,
 						/**< image displayed on background */
 	NOTIFICATION_IMAGE_TYPE_LIST_1,
-						/**< image for thumbnail list */
+						/**< Image for thumbnail list */
 	NOTIFICATION_IMAGE_TYPE_LIST_2,
-						/**< image for thumbnail list */
+						/**< Image for thumbnail list */
 	NOTIFICATION_IMAGE_TYPE_LIST_3,
-						/**< image for thumbnail list */
+						/**< Image for thumbnail list */
 	NOTIFICATION_IMAGE_TYPE_LIST_4,
-						/**< image for thumbnail list */
+						/**< Image for thumbnail list */
 	NOTIFICATION_IMAGE_TYPE_LIST_5,
-						/**< image for thumbnail list */
+						/**< Image for thumbnail list */
 	NOTIFICATION_IMAGE_TYPE_MAX,
 				/**< Max flag */
 } notification_image_type_e;
@@ -183,6 +209,7 @@ typedef enum _notification_image_type {
 
 /**
  * @brief Enumeration for application execution type.
+ * @since_tizen 2.3
  */
 typedef enum _notification_execute_type {
 	NOTIFICATION_EXECUTE_TYPE_NONE = -1,
@@ -198,6 +225,7 @@ typedef enum _notification_execute_type {
 
 /**
  * @brief Enumeration for notification type.
+ * @since_tizen 2.3
  */
 typedef enum _notification_type {
 	NOTIFICATION_TYPE_NONE = -1,
@@ -212,6 +240,7 @@ typedef enum _notification_type {
 
 /**
  * @brief Enumeration for Group ID.
+ * @since_tizen 2.3
  */
 enum _notification_group_id {
 	NOTIFICATION_GROUP_ID_NONE = -1,/**< Not Grouping */
@@ -221,6 +250,7 @@ enum _notification_group_id {
 
 /**
  * @brief Enumeration for Private ID.
+ * @since_tizen 2.3
  */
 enum _notification_priv_id {
 	NOTIFICATION_PRIV_ID_NONE = -1,
@@ -228,7 +258,8 @@ enum _notification_priv_id {
 };
 
 /**
- * @brief Enumeration for notification property
+ * @brief Enumeration for notification property.
+ * @since_tizen 2.3
  */
 enum _notification_property {
 	NOTIFICATION_PROP_DISPLAY_ONLY_SIMMODE = 0x00000001,
@@ -249,7 +280,8 @@ enum _notification_property {
 };
 
 /**
- * @brief Enumeration for display application list
+ * @brief Enumeration for display application list.
+ * @since_tizen 2.3
  */
 enum _notificaton_display_applist {
 	NOTIFICATION_DISPLAY_APP_NOTIFICATION_TRAY = 0x00000001,/**< Notification Tray(Quickpanel) */
@@ -263,37 +295,36 @@ enum _notificaton_display_applist {
 };
 
 /**
- * @}
- */
-
-/**
- * @brief Enumeration for notification operation code
+ * @brief Enumeration for notification operation code.
+ * @since_tizen 2.3
  */
 typedef enum _notification_op_type {
-	NOTIFICATION_OP_NONE = 0,
-	NOTIFICATION_OP_INSERT = 1,
-	NOTIFICATION_OP_UPDATE,
-	NOTIFICATION_OP_DELETE,
-	NOTIFICATION_OP_DELETE_ALL,
-	NOTIFICATION_OP_REFRESH,
-	NOTIFICATION_OP_SERVICE_READY,
+	NOTIFICATION_OP_NONE = 0,	/**< Default */
+	NOTIFICATION_OP_INSERT = 1,	/**< Notification inserted */
+	NOTIFICATION_OP_UPDATE,	/**< Notification updated */
+	NOTIFICATION_OP_DELETE,	/**< Notification deleted */
+	NOTIFICATION_OP_DELETE_ALL,	/**< Notifications deleted */
+	NOTIFICATION_OP_REFRESH,	/**< Deprecated */
+	NOTIFICATION_OP_SERVICE_READY,	/**< Notification service is ready  */
 } notification_op_type_e;
 
 /**
  * @brief Enumeration for notification operation data code
+ * @since_tizen 2.3
  */
 typedef enum _notification_op_data_type {
-	NOTIFICATION_OP_DATA_MIN = 0,
-	NOTIFICATION_OP_DATA_TYPE,
-	NOTIFICATION_OP_DATA_PRIV_ID,
-	NOTIFICATION_OP_DATA_NOTI,
-	NOTIFICATION_OP_DATA_EXTRA_INFO_1,
-	NOTIFICATION_OP_DATA_EXTRA_INFO_2,
-	NOTIFICATION_OP_DATA_MAX,
+	NOTIFICATION_OP_DATA_MIN = 0,	/**< Default */
+	NOTIFICATION_OP_DATA_TYPE,	/**< Operation type */
+	NOTIFICATION_OP_DATA_PRIV_ID,	/**< Private ID */
+	NOTIFICATION_OP_DATA_NOTI,	/**< Notification handler */
+	NOTIFICATION_OP_DATA_EXTRA_INFO_1,	/**< Reserved */
+	NOTIFICATION_OP_DATA_EXTRA_INFO_2,	/**< Reserved */
+	NOTIFICATION_OP_DATA_MAX,	/**< Max flag */
 } notification_op_data_type_e;
 
 /**
  * @brief Enumeration for notification count position in the text.
+ * @since_tizen 2.3
  */
 typedef enum _notifcation_count_pos_type {
 	NOTIFICATION_COUNT_POS_NONE = -1,
@@ -308,7 +339,8 @@ typedef enum _notifcation_count_pos_type {
 } notification_count_pos_type_e;
 
 /**
- * @brief Enumeration for notification variable parameter type
+ * @brief Enumeration for notification variable parameter type.
+ * @since_tizen 2.3
  */
 typedef enum _notification_variable_type {
 	NOTIFICATION_VARIABLE_TYPE_NONE = -1,
@@ -326,21 +358,27 @@ typedef enum _notification_variable_type {
 } notification_variable_type_e;
 
 /**
- * @brief Notification handle
+ * @brief Notification handle.
+ * @since_tizen 2.3
  */
 typedef struct _notification *notification_h;
 
 /**
- * @brief Notification operation handle
+ * @brief The structure for notification operation.
+ * @since_tizen 2.3
  */
 typedef struct _notification_op {
-	notification_op_type_e type;
-	int priv_id;
-	int extra_info_1;
-	int extra_info_2;
-	notification_h noti;
+	notification_op_type_e type;	/**< Notification operation type */
+	int priv_id;	/**< private ID */
+	int extra_info_1;	/**< Reserved */
+	int extra_info_2;	/**< Reserved */
+	notification_h noti;	/**< Notification handler */
 } notification_op;
 
+/**
+ * @}
+ */
+
 #ifdef __cplusplus
 }
 #endif