diff options
Diffstat (limited to 'include/app_event.h')
| -rw-r--r-- | include/app_event.h | 156 |
1 files changed, 140 insertions, 16 deletions
diff --git a/include/app_event.h b/include/app_event.h index a2a2ae0..5d5ef83 100644 --- a/include/app_event.h +++ b/include/app_event.h @@ -40,6 +40,7 @@ extern "C" { */ typedef struct event_handler *event_handler_h; + /** * @brief Event callback. * @@ -51,6 +52,7 @@ typedef struct event_handler *event_handler_h; */ typedef void (*event_cb)(const char *event_name, bundle *event_data, void *user_data); + /** * @brief Enumeration for Event Error. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -64,6 +66,7 @@ typedef enum { EVENT_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED /**< Permisiion denied */ } event_error_e; + /** * @brief Definition for system-event of battery : charger status. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -72,6 +75,7 @@ typedef enum { */ #define SYSTEM_EVENT_BATTERY_CHARGER_STATUS "tizen.system.event.battery_charger_status" + /** * @brief Definition for key of SYSTEM_EVENT_BATTERY_CHARGER_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -82,6 +86,7 @@ typedef enum { */ #define EVENT_KEY_BATTERY_CHARGER_STATUS "battery_charger_status" + /** * @brief Definition for value of EVENT_KEY_BATTERY_CHARGER_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -89,6 +94,7 @@ typedef enum { */ #define EVENT_VAL_BATTERY_CHARGER_DISCONNECTED "disconnected" + /** * @brief Definition for value of EVENT_KEY_BATTERY_CHARGER_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -96,6 +102,7 @@ typedef enum { */ #define EVENT_VAL_BATTERY_CHARGER_CONNECTED "connected" + /** * @brief Definition for value of EVENT_KEY_BATTERY_CHARGER_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -103,6 +110,7 @@ typedef enum { */ #define EVENT_VAL_BATTERY_CHARGER_CHARGING "charging" + /** * @brief Definition for value of EVENT_KEY_BATTERY_CHARGER_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -110,6 +118,7 @@ typedef enum { */ #define EVENT_VAL_BATTERY_CHARGER_DISCHARGING "discharging" + /** * @brief Definition for system-event of battery : level status. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -117,6 +126,7 @@ typedef enum { */ #define SYSTEM_EVENT_BATTERY_LEVEL_STATUS "tizen.system.event.battery_level_status" + /** * @brief Definition for key of SYSTEM_EVENT_BATTERY_LEVEL_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -128,36 +138,42 @@ typedef enum { */ #define EVENT_KEY_BATTERY_LEVEL_STATUS "battery_level_status" + /** * @brief Definition for value of EVENT_KEY_BATTERY_LEVEL_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_BATTERY_LEVEL_EMPTY "empty" + /** * @brief Definition for value of EVENT_KEY_BATTERY_LEVEL_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_BATTERY_LEVEL_CRITICAL "critical" + /** * @brief Definition for value of EVENT_KEY_BATTERY_LEVEL_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_BATTERY_LEVEL_LOW "low" + /** * @brief Definition for value of EVENT_KEY_BATTERY_LEVEL_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_BATTERY_LEVEL_HIGH "high" + /** * @brief Definition for value of EVENT_KEY_BATTERY_LEVEL_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_BATTERY_LEVEL_FULL "full" + /** * @brief Definition for system-event of usb : status of usb connection. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -165,6 +181,7 @@ typedef enum { */ #define SYSTEM_EVENT_USB_STATUS "tizen.system.event.usb_status" + /** * @brief Definition for key of SYSTEM_EVENT_USB_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -174,12 +191,14 @@ typedef enum { */ #define EVENT_KEY_USB_STATUS "usb_status" + /** * @brief Definition for value of EVENT_KEY_USB_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_USB_DISCONNECTED "disconnected" + /** * @brief Definition for value of EVENT_KEY_USB_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -187,12 +206,14 @@ typedef enum { */ #define EVENT_VAL_USB_CONNECTED "connected" + /** * @brief Definition for value of EVENT_KEY_USB_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_USB_AVAILABLE "available" + /** * @brief Definition for system-event of ear-jack : status of ear-jack connection. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -200,6 +221,7 @@ typedef enum { */ #define SYSTEM_EVENT_EARJACK_STATUS "tizen.system.event.earjack_status" + /** * @brief Definition for key of SYSTEM_EVENT_EARJACK_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -208,18 +230,21 @@ typedef enum { */ #define EVENT_KEY_EARJACK_STATUS "earjack_status" + /** * @brief Definition for value of EVENT_KEY_EARJACK_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_EARJACK_DISCONNECTED "disconnected" + /** * @brief Definition for value of EVENT_KEY_EARJACK_STATUS. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_EARJACK_CONNECTED "connected" + /** * @brief Definition for system-event of display : state of display. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -229,6 +254,7 @@ typedef enum { */ #define SYSTEM_EVENT_DISPLAY_STATE "tizen.system.event.display_state" + /** * @brief Definition for key of SYSTEM_EVENT_DISPLAY_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -238,24 +264,28 @@ typedef enum { */ #define EVENT_KEY_DISPLAY_STATE "display_state" + /** * @brief Definition for value of EVENT_KEY_DISPLAY_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_DISPLAY_NORMAL "normal" + /** * @brief Definition for value of EVENT_KEY_DISPLAY_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_DISPLAY_DIM "dim" + /** * @brief Definition for value of EVENT_KEY_DISPLAY_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_DISPLAY_OFF "off" + /** * @brief Definition for system-event of system : boot completion. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -265,6 +295,7 @@ typedef enum { */ #define SYSTEM_EVENT_BOOT_COMPLETED "tizen.system.event.boot_completed" + /** * @brief Definition for system-event of system : shutdown. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -274,6 +305,7 @@ typedef enum { */ #define SYSTEM_EVENT_SYSTEM_SHUTDOWN "tizen.system.event.system_shutdown" + /** * @brief Definition for system-event of system : low memory. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -281,6 +313,7 @@ typedef enum { */ #define SYSTEM_EVENT_LOW_MEMORY "tizen.system.event.low_memory" + /** * @brief Definition for key of SYSTEM_EVENT_LOW_MEMORY. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -291,24 +324,28 @@ typedef enum { */ #define EVENT_KEY_LOW_MEMORY "low_memory" + /** * @brief Definition for value of EVENT_KEY_LOW_MEMORY. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_MEMORY_NORMAL "normal" + /** * @brief Definition for value of EVENT_KEY_LOW_MEMORY. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_MEMORY_SOFT_WARNING "soft_warning" + /** * @brief Definition for value of EVENT_KEY_LOW_MEMORY. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_MEMORY_HARD_WARNING "hard_warning" + /** * @brief Definition for system-event of wifi : state of wifi. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -318,6 +355,7 @@ typedef enum { */ #define SYSTEM_EVENT_WIFI_STATE "tizen.system.event.wifi_state" + /** * @brief Definition for key of SYSTEM_EVENT_WIFI_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -327,24 +365,28 @@ typedef enum { */ #define EVENT_KEY_WIFI_STATE "wifi_state" + /** * @brief Definition for value of EVENT_KEY_WIFI_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_WIFI_OFF "off" + /** * @brief Definition for value of EVENT_KEY_WIFI_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_WIFI_ON "on" + /** * @brief Definition for value of EVENT_KEY_WIFI_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_WIFI_CONNECTED "connected" + /** * @brief Definition for system-event of bluetooth : status of bluetooth. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -354,6 +396,7 @@ typedef enum { */ #define SYSTEM_EVENT_BT_STATE "tizen.system.event.bt_state" + /** * @brief Definition for key of SYSTEM_EVENT_BT_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -362,18 +405,21 @@ typedef enum { */ #define EVENT_KEY_BT_STATE "bt_state" + /** * @brief Definition for value of EVENT_KEY_BT_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_BT_OFF "off" + /** * @brief Definition for value of EVENT_KEY_BT_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_BT_ON "on" + /** * @brief Definition for key of SYSTEM_EVENT_BT_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -382,18 +428,21 @@ typedef enum { */ #define EVENT_KEY_BT_LE_STATE "bt_le_state" + /** * @brief Definition for value of EVENT_KEY_BT_LE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_BT_LE_OFF "off" + /** * @brief Definition for value of EVENT_KEY_BT_LE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_BT_LE_ON "on" + /** * @brief Definition for key of SYSTEM_EVENT_BT_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -403,18 +452,21 @@ typedef enum { */ #define EVENT_KEY_BT_TRANSFERING_STATE "bt_transfering_state" + /** * @brief Definition for value of EVENT_KEY_BT_TRANSFERING_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_BT_NON_TRANSFERING "non_transfering" + /** * @brief Definition for value of EVENT_KEY_BT_TRANSFERING_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_BT_TRANSFERING "transfering" + /** * @brief Definition for system-event of location : enable state of location. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -422,6 +474,7 @@ typedef enum { */ #define SYSTEM_EVENT_LOCATION_ENABLE_STATE "tizen.system.event.location_enable_state" + /** * @brief Definition for key of SYSTEM_EVENT_LOCATION_ENABLE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -430,18 +483,21 @@ typedef enum { */ #define EVENT_KEY_LOCATION_ENABLE_STATE "location_enable_state" + /** * @brief Definition for value of EVENT_KEY_LOCATION_ENABLE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_LOCATION_DISABLED "disabled" + /** * @brief Definition for value of EVENT_KEY_LOCATION_ENABLE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_LOCATION_ENABLED "enabled" + /** * @brief Definition for system-event of location : enable state of gps. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -449,6 +505,7 @@ typedef enum { */ #define SYSTEM_EVENT_GPS_ENABLE_STATE "tizen.system.event.gps_enable_state" + /** * @brief Definition for key of SYSTEM_EVENT_GPS_ENABLE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -457,18 +514,21 @@ typedef enum { */ #define EVENT_KEY_GPS_ENABLE_STATE "gps_enable_state" + /** * @brief Definition for value of EVENT_KEY_GPS_ENABLE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_GPS_DISABLED "disabled" + /** * @brief Definition for value of EVENT_KEY_GPS_ENABLE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_GPS_ENABLED "enabled" + /** * @brief Definition for system-event of location : enable state of nps. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -476,6 +536,7 @@ typedef enum { */ #define SYSTEM_EVENT_NPS_ENABLE_STATE "tizen.system.event.nps_enable_state" + /** * @brief Definition for key of SYSTEM_EVENT_NPS_ENABLE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -484,18 +545,21 @@ typedef enum { */ #define EVENT_KEY_NPS_ENABLE_STATE "nps_enable_state" + /** * @brief Definition for value of EVENT_KEY_NPS_ENABLE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_NPS_DISABLED "disabled" + /** * @brief Definition for value of EVENT_KEY_NPS_ENABLE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_NPS_ENABLED "enabled" + /** * @brief Definition for system-event of message : incoming msg. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -506,6 +570,7 @@ typedef enum { */ #define SYSTEM_EVENT_INCOMING_MSG "tizen.system.event.incoming_msg" + /** * @brief Definition for key of SYSTEM_EVENT_INCOMING_MSG. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -515,30 +580,35 @@ typedef enum { */ #define EVENT_KEY_MSG_TYPE "msg_type" + /** * @brief Definition for value of EVENT_KEY_MSG_TYPE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_SMS "sms" + /** * @brief Definition for value of EVENT_KEY_MSG_TYPE. * @since_tizen 3.0 */ #define EVENT_VAL_MMS "mms" + /** * @brief Definition for value of EVENT_KEY_MSG_TYPE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_PUSH "push" + /** * @brief Definition for value of EVENT_KEY_MSG_TYPE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_CB "cb" + /** * @brief Definition for key of SYSTEM_EVENT_INCOMING_MSG. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -546,6 +616,7 @@ typedef enum { */ #define EVENT_KEY_MSG_ID "msg_id" + /** * @brief Definition for system-event of message : outgoing msg. * @since_tizen 3.0 @@ -556,6 +627,7 @@ typedef enum { */ #define SYSTEM_EVENT_OUTGOING_MSG "tizen.system.event.outgoing_msg" + /** * @brief Definition for key of SYSTEM_EVENT_OUTGOING_MSG. * @since_tizen 3.0 @@ -564,18 +636,21 @@ typedef enum { */ #define EVENT_KEY_OUT_MSG_TYPE "msg_type" + /** * @brief Definition for value of EVENT_KEY_OUT_MSG_TYPE. * @since_tizen 3.0 */ #define EVENT_VAL_SMS "sms" + /** * @brief Definition for value of EVENT_KEY_OUT_MSG_TYPE. * @since_tizen 3.0 */ #define EVENT_VAL_MMS "mms" + /** * @brief Definition for key of SYSTEM_EVENT_OUTGOING_MSG. * @since_tizen 3.0 @@ -583,6 +658,7 @@ typedef enum { */ #define EVENT_KEY_OUT_MSG_ID "msg_id" + /** * @brief Definition for system-event of setting : time changed. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -591,6 +667,7 @@ typedef enum { */ #define SYSTEM_EVENT_TIME_CHANGED "tizen.system.event.time_changed" + /** * @brief Definition for system-event of setting : timezone setting. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -598,15 +675,15 @@ typedef enum { */ #define SYSTEM_EVENT_TIME_ZONE "tizen.system.event.time_zone" + /** * @brief Definition for key of SYSTEM_EVENT_TIME_ZONE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif - * @remarks The value of this key is timezone value of tz database, - * for example, "Asia/Seoul", "America/New_York", - * refer to the Time Zone Database of IANA. + * @remarks The value of this key is timezone value of tz database, for example, "Asia/Seoul", "America/New_York", refer to the Time Zone Database of IANA. */ #define EVENT_KEY_TIME_ZONE "time_zone" + /** * @brief Definition for system-event of setting : hour format. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -614,6 +691,7 @@ typedef enum { */ #define SYSTEM_EVENT_HOUR_FORMAT "tizen.system.event.hour_format" + /** * @brief Definition for key of SYSTEM_EVENT_HOUR_FORMAT. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -622,18 +700,21 @@ typedef enum { */ #define EVENT_KEY_HOUR_FORMAT "hour_format" + /** * @brief Definition for value of EVENT_KEY_HOUR_FORMAT. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_HOURFORMAT_12 "12" + /** * @brief Definition for value of EVENT_KEY_HOUR_FORMAT. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_HOURFORMAT_24 "24" + /** * @brief Definition for system-event of setting : language setting. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -641,16 +722,18 @@ typedef enum { */ #define SYSTEM_EVENT_LANGUAGE_SET "tizen.system.event.language_set" + /** * @brief Definition for key of SYSTEM_EVENT_LANGUAGE_SET. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @remarks The value of this key is full name of locale, for example, - * "ko_KR.UTF8" : in case of Korean language - * "en_US.UTF8" : in case of USA language, - * refer to linux locale info. + * "ko_KR.UTF8" : in case of Korean language + * "en_US.UTF8" : in case of USA language, + * refer to linux locale info. */ #define EVENT_KEY_LANGUAGE_SET "language_set" + /** * @brief Definition for system-event of setting : region format. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -658,16 +741,18 @@ typedef enum { */ #define SYSTEM_EVENT_REGION_FORMAT "tizen.system.event.region_format" + /** * @brief Definition for key of SYSTEM_EVENT_REGION_FORMAT. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @remarks The value of this key is full name of locale, for example, - * "ko_KR.UTF8" : in case of Korean region format - * "en_US.UTF8" : in case of USA region format, - * refer to linux locale info. + * "ko_KR.UTF8" : in case of Korean region format + * "en_US.UTF8" : in case of USA region format, + * refer to linux locale info. */ #define EVENT_KEY_REGION_FORMAT "region_format" + /** * @brief Definition for system-event of setting : silent_mode. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -675,6 +760,7 @@ typedef enum { */ #define SYSTEM_EVENT_SILENT_MODE "tizen.system.event.silent_mode" + /** * @brief Definition for key of SYSTEM_EVENT_SILENT_MODE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -683,18 +769,21 @@ typedef enum { */ #define EVENT_KEY_SILENT_MODE "silent_mode" + /** * @brief Definition for value of EVENT_KEY_SILENT_MODE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_SILENTMODE_ON "on" + /** * @brief Definition for value of EVENT_KEY_SILENT_MODE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_SILENTMODE_OFF "off" + /** * @brief Definition for system-event of setting : state of vibration. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -702,6 +791,7 @@ typedef enum { */ #define SYSTEM_EVENT_VIBRATION_STATE "tizen.system.event.vibration_state" + /** * @brief Definition for key of SYSTEM_EVENT_VIBRATION_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -710,18 +800,21 @@ typedef enum { */ #define EVENT_KEY_VIBRATION_STATE "vibration_state" + /** * @brief Definition for value of EVENT_KEY_VIBRATION_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_VIBRATION_ON "on" + /** * @brief Definition for value of EVENT_KEY_VIBRATION_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_VIBRATION_OFF "off" + /** * @brief Definition for system-event of setting : state of screen's auto-rotation. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -729,6 +822,7 @@ typedef enum { */ #define SYSTEM_EVENT_SCREEN_AUTOROTATE_STATE "tizen.system.event.screen_autorotate_state" + /** * @brief Definition for key of SYSTEM_EVENT_SCREEN_AUTOROTATE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -737,18 +831,21 @@ typedef enum { */ #define EVENT_KEY_SCREEN_AUTOROTATE_STATE "screen_autorotate_state" + /** * @brief Definition for value of EVENT_KEY_SCREEN_AUTOROTATE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_SCREEN_AUTOROTATE_ON "on" + /** * @brief Definition for value of EVENT_KEY_SCREEN_AUTOROTATE_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_SCREEN_AUTOROTATE_OFF "off" + /** * @brief Definition for system-event of setting : state of mobile data. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -756,6 +853,7 @@ typedef enum { */ #define SYSTEM_EVENT_MOBILE_DATA_STATE "tizen.system.event.mobile_data_state" + /** * @brief Definition for key of SYSTEM_EVENT_MOBILE_DATA_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -764,18 +862,21 @@ typedef enum { */ #define EVENT_KEY_MOBILE_DATA_STATE "mobile_data_state" + /** * @brief Definition for value of EVENT_KEY_MOBILE_DATA_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_MOBILE_DATA_OFF "off" + /** * @brief Definition for value of EVENT_KEY_MOBILE_DATA_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_MOBILE_DATA_ON "on" + /** * @brief Definition for system-event of setting : state of data roaming. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -783,6 +884,7 @@ typedef enum { */ #define SYSTEM_EVENT_DATA_ROAMING_STATE "tizen.system.event.data_roaming_state" + /** * @brief Definition for key of SYSTEM_EVENT_DATA_ROAMING_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -791,18 +893,21 @@ typedef enum { */ #define EVENT_KEY_DATA_ROAMING_STATE "data_roaming_state" + /** * @brief Definition for value of EVENT_KEY_DATA_ROAMING_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_DATA_ROAMING_OFF "off" + /** * @brief Definition for value of EVENT_KEY_DATA_ROAMING_STATE. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define EVENT_VAL_DATA_ROAMING_ON "on" + /** * @brief Definition for system-event of setting : font setting. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -810,6 +915,7 @@ typedef enum { */ #define SYSTEM_EVENT_FONT_SET "tizen.system.event.font_set" + /** * @brief Definition for key of SYSTEM_EVENT_FONT_SET. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -817,6 +923,7 @@ typedef enum { */ #define EVENT_KEY_FONT_SET "font_set" + /** * @brief Definition for system-event of network : status of network. * @since_tizen 3.0 @@ -824,6 +931,7 @@ typedef enum { */ #define SYSTEM_EVENT_NETWORK_STATUS "tizen.system.event.network_status" + /** * @brief Definition for key of SYSTEM_EVENT_NETWORK_STATUS. * @since_tizen 3.0 @@ -837,42 +945,49 @@ typedef enum { */ #define EVENT_KEY_NETWORK_STATUS "network_status" + /** * @brief Definition for value of EVENT_KEY_NETWORK_STATUS. * @since_tizen 3.0 */ #define EVENT_VAL_NETWORK_DISCONNECTED "disconnected" + /** * @brief Definition for value of EVENT_KEY_NETWORK_STATUS. * @since_tizen 3.0 */ #define EVENT_VAL_NETWORK_WIFI "wifi" + /** * @brief Definition for value of EVENT_KEY_NETWORK_STATUS. * @since_tizen 3.0 */ #define EVENT_VAL_NETWORK_CELLULAR "cellular" + /** * @brief Definition for value of EVENT_KEY_NETWORK_STATUS. * @since_tizen 3.0 */ #define EVENT_VAL_NETWORK_ETHERNET "ethernet" + /** * @brief Definition for value of EVENT_KEY_NETWORK_STATUS. * @since_tizen 3.0 */ #define EVENT_VAL_NETWORK_BT "bt" + /** * @brief Definition for value of EVENT_KEY_NETWORK_STATUS. * @since_tizen 3.0 */ #define EVENT_VAL_NETWORK_NET_PROXY "net_proxy" + /** * @brief Adds the event handler for receiving event-data of interested events. * @@ -882,27 +997,30 @@ typedef enum { * @param[in] callback The event callback called when the event occurs * @param[in] user_data The user data for passing to callback * @param[out] event_handler The event handler - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #EVENT_ERROR_NONE Successful * @retval #EVENT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #EVENT_ERROR_PERMISSION_DENIED Permission denied * @retval #EVENT_ERROR_IO_ERROR Adding handler failed * @retval #EVENT_ERROR_OUT_OF_MEMORY Out of memory */ -int event_add_event_handler(const char *event_name, event_cb callback, void *user_data, - event_handler_h *event_handler); +int event_add_event_handler(const char *event_name, event_cb callback, void *user_data, event_handler_h *event_handler); + /** * @brief Removes the registered event handler. * * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @param[in] event_handler The event handler - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #EVENT_ERROR_NONE Successful * @retval #EVENT_ERROR_INVALID_PARAMETER Invalid parameter */ int event_remove_event_handler(event_handler_h event_handler); + /** * @brief Sends the User-Event to receiver applications. * @@ -910,13 +1028,15 @@ int event_remove_event_handler(event_handler_h event_handler); * @remarks The format of User-Event's name MUST be "event.{sender's appid}.{user-defined name}", refer to 'The name-format of User-Event' section, If the event_name is invalid, the function returns #EVENT_ERROR_IO_ERROR. * @param[in] event_name The event's name to send * @param[in] event_data The event's data to send - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #EVENT_ERROR_NONE Successful * @retval #EVENT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #EVENT_ERROR_IO_ERROR Sending operation failed */ int event_publish_app_event(const char *event_name, bundle *event_data); + /** * @brief Sends the User-Event to trusted receiver-applications. * @@ -925,13 +1045,15 @@ int event_publish_app_event(const char *event_name, bundle *event_data); * @remarks The format of User-Event's name MUST be "event.{sender's appid}.{user-defined name}", refer to 'The name-format of User-Event' section, If the event_name is invalid, the function returns #EVENT_ERROR_IO_ERROR. * @param[in] event_name The event's name to send * @param[in] event_data The event's data to send - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #EVENT_ERROR_NONE Successful * @retval #EVENT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #EVENT_ERROR_IO_ERROR Sending operation failed */ int event_publish_trusted_app_event(const char *event_name, bundle *event_data); + /** * @brief Keeps last User-Event data for receiver applications. * @@ -940,7 +1062,8 @@ int event_publish_trusted_app_event(const char *event_name, bundle *event_data); * @remarks If a sender application sends same event via trusted API and non-trusted API, then a trusted receiver will get latest data regardless of trusted or non-trusted, but non-trusted receiver will get the last data only from non-trusted API. * @remarks The effect of this API continues during runtime. That means when the sender application process restarts, the sender application needs to call this api again to make the event to keep the last event. * @param[in] event_name The event's name to keep last event data - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #EVENT_ERROR_NONE Successful * @retval #EVENT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #EVENT_ERROR_IO_ERROR Sending operation failed @@ -948,6 +1071,7 @@ int event_publish_trusted_app_event(const char *event_name, bundle *event_data); */ int event_keep_last_event_data(const char *event_name); + /** * @} */ |