From 5cff1a01ee9946c4b12cad9ff1634e887749fe43 Mon Sep 17 00:00:00 2001 From: Inkyun Kil Date: Fri, 16 Dec 2016 17:12:26 +0900 Subject: [PATCH] Fix API description modify API description and remove appfw_alarm_doc.h Change-Id: I721fc98d4f8083d6987c6f21185025c3c02f256c Signed-off-by: Inkyun Kil --- doc/appfw_alarm_doc.h | 66 ----------- doc/appfw_app_common_doc.h | 13 +-- doc/appfw_app_control_doc.h | 2 - doc/appfw_app_doc.h | 101 ++++++++--------- doc/appfw_event_doc.h | 75 ++++++------- doc/appfw_i18n_doc.h | 4 - doc/appfw_preference_doc.h | 13 +-- doc/appfw_resource_manager_doc.h | 20 ++-- include/app.h | 47 +++----- include/app_common.h | 235 +++++++++++++++------------------------ include/app_control.h | 71 +++++++----- include/app_event.h | 156 +++++++++++++++++++++++--- include/app_i18n.h | 7 +- include/app_preference.h | 110 ++++++++---------- include/app_resource_manager.h | 14 ++- include/app_types.h | 2 +- 16 files changed, 445 insertions(+), 491 deletions(-) delete mode 100755 doc/appfw_alarm_doc.h diff --git a/doc/appfw_alarm_doc.h b/doc/appfw_alarm_doc.h deleted file mode 100755 index 61115fe..0000000 --- a/doc/appfw_alarm_doc.h +++ /dev/null @@ -1,66 +0,0 @@ -/* - * Copyright (c) 2011 - 2016 Samsung Electronics Co., Ltd All Rights Reserved - * - * Licensed under the Apache License, Version 2.0 (the License); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an AS IS BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - - -#ifndef __TIZEN_APPFW_ALARM_DOC_H__ -#define __TIZEN_APPFW_ALARM_DOC_H__ - - /** - * @ingroup CAPI_APPLICATION_MODULE - * @defgroup CAPI_ALARM_MODULE Alarm - * @brief The @ref CAPI_ALARM_MODULE API allows setting an "alarm clock" for the delivery of a notification at some point in the future. - * - * @section CAPI_ALARM_MODULE_HEADER Required Header - * \#include - * - * @section CAPI_ALARM_MODULE_OVERVIEW Overview - * Mobile devices typically give constant access to information from various sources. Some of this information is best delivered - * through alarms - the most obvious case is a calendar scheduling application which lets you know when a meeting is about to start. - * Alarms are certainly better than actively waiting in a loop. They are also better than putting an interface to sleep because they do not - * block your main UI thread. Use of alarms helps build smooth user experiences and implements unattended data synchronization tasks. - * If an application is installed after setting the alarm, your alarm is cancelled automatically.\n - * When the alarm is expired, Alarm Manager will turn on LCD to prohibit background jobs. - * If you want to use alarm API without turning on LCD, you can use alarm_schedule_after_delay(). - * - * There are 3 ways to set an alarm. - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
FUNCTIONDESCRIPTION
alarm_schedule_once_after_delay()Sets an alarm to be triggered at specific time once
alarm_schedule_once_at_date()Sets an alarm to be triggered after specific delay once
alarm_schedule_with_recurrence_week_flag()Sets an alarm to be triggered at specific time with recurrent days of the week(can repeat on days of the week)
alarm_schedule_after_delay()Sets an alarm to be triggered after specific time(Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, this api does not support exact period and delay for minimizing the wakeups of the device. The system can adjust when the alarm expires.)
- * \n - * - */ - -#endif /* __TIZEN_APPFW_ALARM_DOC_H__ */ - diff --git a/doc/appfw_app_common_doc.h b/doc/appfw_app_common_doc.h index 42ca620..d0ffb9a 100755 --- a/doc/appfw_app_common_doc.h +++ b/doc/appfw_app_common_doc.h @@ -21,16 +21,13 @@ /** * @ingroup CAPI_APPLICATION_MODULE * @defgroup CAPI_APP_COMMON_MODULE App Common - * @brief The @ref CAPI_APP_COMMON_MODULE API provides functions to getting information about the application. - * * @addtogroup CAPI_APP_COMMON_MODULE - * + * @brief The @ref CAPI_APP_COMMON_MODULE API provides functions for getting information about the application. * @section CAPI_APP_COMMON_MODULE_HEADER Required Header * \#include - * + * @section CAPI_APP_COMMON_MODULE_OVERVIEW Overview - * - * The App common API provides common apis that can be used at UI application and Service application. + * The App common API provides common APIs that can be used at UI application and Service application. * This API provides interfaces for getting information about the application. * * @subsection CAPI_APPLICATION_MODULE_PACKAGE Application Package @@ -38,7 +35,6 @@ * When you build the application, the Tizen SDK packages those as an application package for distribution. * * @image html capi_appfw_application_package.png "Application package" - * * * * @@ -75,10 +71,9 @@ * @subsection CAPI_APPLICATION_MODULE_GET_INFORMATION Getting Information About the Application * The API provides functions for obtaining an application's package name and absolute path to specified resources * like Image, Sound, Video, UI layout (EDJ), and so on. - * It also provides functions to : + * It also provides functions to: * - Get the current orientation of the device * - Get the Internal/External root folders which are shared among all applications - * */ #endif /* __TIZEN_APPFW_APP_COMMON_DOC_H__ */ diff --git a/doc/appfw_app_control_doc.h b/doc/appfw_app_control_doc.h index 6f5b199..2241492 100755 --- a/doc/appfw_app_control_doc.h +++ b/doc/appfw_app_control_doc.h @@ -22,13 +22,11 @@ * @ingroup CAPI_APPLICATION_MODULE * @defgroup CAPI_APP_CONTROL_MODULE App Control * @brief The @ref CAPI_APP_CONTROL_MODULE API provides functions to launch other applications. - * * @section CAPI_APP_CONTROL_MODULE_HEADER Required Header * \#include * * @section CAPI_APP_CONTROLMODULE_OVERVIEW Overview * Platform Application Controls - * */ #endif /* __TIZEN_APPFW_APP_CONTROL_DOC_H__ */ diff --git a/doc/appfw_app_doc.h b/doc/appfw_app_doc.h index fe22d84..4026f36 100755 --- a/doc/appfw_app_doc.h +++ b/doc/appfw_app_doc.h @@ -21,25 +21,18 @@ /** * @ingroup CAPI_APPLICATION_FRAMEWORK * @defgroup CAPI_APPLICATION_MODULE Application -* * @addtogroup CAPI_APPLICATION_MODULE -* * @brief The @ref CAPI_APPLICATION_MODULE API provides functions to manage the main event loop, the application's state change events, basic system events, * and get information about the application. -* -* * @section CAPI_APPLICATION_MODULE_HEADER Required Header * \#include * * @section CAPI_APPLICATION_MODULE_OVERVIEW Overview -* * The Application API handles an application state change or system events and provides mechanisms that launch other applications. -* -* The Tizen native application is similar to a conventional Linux application, but has some additional features optimized for mobile -* devices, which may have constraints such as relatively small screen sizes and lack of system resources compared to a larger system. -* For example, for power management reasons, the application may wish to take actions to reduce usage when it finds out that it had its display window +* The Tizen native application is similar to a conventional Linux application, but has some additional features optimized for mobile devices, +* which may have constraints such as relatively small screen sizes and lack of system resources compared to a larger system. +* For example, for power management reasons, the application may wish to take actions to reduce usage when it finds out that it had its display window * covered over by another application's window. State change events are delivered so that this is possible. -* * The Application API provides interfaces for the following three categories: * - Starting or exiting the main event loop (mandatory for every Tizen native application) * - Registering callbacks for application state change events @@ -49,10 +42,10 @@ * For an application to operate successfully, it must receive events from the platform. * For this, it needs to start the main event loop - this is mandatory for all Tizen native applications. * The ui_app_main() function is used to start the event loop. -* Before calling this function, you should set up the #ui_app_lifecycle_callback_s structure which is passed to the function (see the following sections). +* Before calling this function, you should set up the #ui_app_lifecycle_callback_s structure, which is passed to the function (see the following sections). * * @subsection CAPI_APPLICATION_MODULE_STATE_CHANGE_EVENT Registering Callbacks for Application State Change Events -* The application state change events include the following: +* The application state change events include the following: *

*

Directories
* @@ -83,7 +76,7 @@ * * * * @@ -94,12 +87,11 @@ * * *
app_terminate_cb() Hook to take necessary actions when your application is terminating. * Your application should release all resources, especially any -* allocations and shared resources must be freed here so other running applications can fully use these shared resources. +* allocations and shared resources must be freed here, so other running applications can fully use these shared resources. *
-* * For further explanation of application state changes, see the @ref CAPI_APPLICATION_MODULE_STATES_TRANSITIONS section. * * @subsection CAPI_APPLICATION_MODULE_SYSTEM_EVENT Registering Callbacks for System Events -* The system event callbacks can be registered using ui_app_add_event_handler(). Multiple system event callbacks can be registered. -* The basic system event includes the following: +* The system event callbacks can be registered using ui_app_add_event_handler(). Multiple system event callbacks can be registered. +* The basic system event includes the following: *

* * @@ -109,11 +101,11 @@ * * * * * @@ -127,7 +119,7 @@ * * * * * @@ -139,13 +131,13 @@ * * * * * * * * *
APP_EVENT_LOW_MEMORY The system memory is running low. -* Recommended actions are as follows: -* - Action 1. Save data in main memory to persistent memory/storage -* to avoid data loss in case the Tizen platform Low Memory Killer kills your application to get more free memory. -* The explanation of how Low Memory Killer behaves is here(link), but basically if the low memory notice does not lead to enough -* memory being freed, something will be killed. Release cached data in main memory to secure more free memory. +* Recommended actions are as follows: +* - Action 1. Save data in main memory to persistent memory/storage +* to avoid data loss in case the Tizen platform Low Memory Killer kills your application to get more free memory. +* The explanation of how Low Memory Killer behaves is here(link), but basically if the low memory notice does not lead to enough +* memory being freed, something will be killed. Release cached data in main memory to secure more free memory. *
APP_EVENT_DEVICE_ORIENT The orientation of device is changed. -* Recommended action is as follows: change display orientation to match display orientation +* Recommended action is as follows: change display orientation to match the display orientation *
APP_EVENT_REGION_FORMAT_CHANGED The region format setting changed. -* Region change means a different time zone; the application UI may need to update the time to reflect the time zone change. +* Region change means a different time zone; the application UI may need to update the time to reflect the time zone change. *
APP_EVENT_SUSPENDED_STATE_CHANGED The suspended state is changed. -* The application will enter to the suspended state, or exited from the state. Do the necessary action before or after the suspended; the application shall not respond to requests of the other modules. +* The application will enter the suspended state, or exit from the state. Do the necessary action before or after suspended; the application shall not respond to requests of the other modules. *
@@ -153,31 +145,29 @@ * @subsection CAPI_APPLICATION_MODULE_STATES_TRANSITIONS The Application States and Transitions * The Tizen native application can be in one of the several different states. Typically, the application is launched by the user from the Launcher, or by * another application. As the application is starting, app_create_cb() is executed, and then the main event loop starts. After executing event loop, app_control_cb() and app_resume_cb() will be invoked. -* The application now normally becomes the front-most window, with focus. When the application loses the front-most/focus status, the app_pause_cb() callback is invoked. There -* are many scenarios for your application to go into the pause state, which means your application is not terminated, but is running in the background: +* The application now normally becomes the front-most window with focus. When the application loses the front-most/focus status, the app_pause_cb() callback is invoked. +* There are many scenarios for your application to go into the pause state, which means your application is not terminated, but is running in the background: * - A new application is launched from the request of your application * - The user requests to go to the home screen * - A system event occurs and it causes a resident application with higher priority (e.g. a phone call is received) to become active, and hides * your application temporarily * - An alarm went off for another application so it now becomes the top-most window and hides your application * -* Since Tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, the application on the background goes in to a suspended state. In the suspended state, the application process is executed with limited CPU resources. In other words, the platform does -* not allow the running of the background applications. -* +* Since Tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, the application on the background goes in to a suspended state. In the suspended state, the application process is executed with limited CPU resources. +* In other words, the platform does not allow the running of the background applications. * When your application becomes visible again, the app_resume_cb() callback is invoked. Some possible scenarios for your application to become visible are: * - Another application requests your application to run (perhaps the Task Navigator which shows all running applications and lets * the user select any app to run) * - All applications on top of your application in the window stack finish * - An alarm is going off for your application so it becomes the top-most window and hides other applications -* -* When your application starts exiting, the app_pause_cb() callback is invoked if the application is visible, and then the app_terminate_cb() callback is invoked. Possible scenarios to start termination of your application are: +* When your application starts exiting, the app_pause_cb() callback is invoked if the application is visible, and then the app_terminate_cb() callback is invoked. +* Possible scenarios to start termination of your application are: * - Your application itself requests to exit by calling ui_app_exit() to terminate the event loop * - The Low Memory Killer is killing your application in a low memory situation. -* * Note that a service application doesn't have UI, so the service application doesn't have Paused state. -* * Application state changes are managed by the underlying framework. * Refer to the following state diagram to see the possible transitions: +* * @image html capi_appfw_application_states.png "Application states" *

* @@ -206,7 +196,6 @@ * * *
The application is terminated
-* * The Application API defines five states with their corresponding transition handlers. * The state transition is notified through the state transition callback function, * whether the application is created, is running, is paused, is resumed, or is terminated. @@ -216,12 +205,13 @@ * * @subsection CAPI_APPLICATION_MODULE_HOW_TO_START How to start the Tizen native application * An application can be launched by the user from the Launcher or by another application. -* * Regardless of how an application is launched, the Application Framework starts an application by creating a new process and calls * the entry point of the application. Like a conventional Linux application, the main function of its application is the entry point. * In the Tizen application, the main task is to hand over control to the Application Framework by calling the ui_app_main() function. +* * @code -* bool app_create(void *user_data) +* bool +* app_create(void *user_data) * { * // Hook to take necessary actions before the main event loop starts * // Initialize UI resources and application's data @@ -230,27 +220,32 @@ * return true; * } * -* void app_control(app_control_h app_control, void *user_data) +* void +* app_control(app_control_h app_control, void *user_data) * { * // Handle the launch request * } * -* void app_pause(void *user_data) +* void +* app_pause(void *user_data) * { * // Take necessary actions when the application becomes invisible * } * -* void app_resume(void *user_data) +* void +* app_resume(void *user_data) * { -* // Take necessary actions when the application becomes visible. +* // Take necessary actions when the application becomes visible * } * -* void app_terminate(void *user_data) +* void +* app_terminate(void *user_data) * { * // Release all resources * } * -* int main(int argc, char *argv[]) +* int +* main(int argc, char *argv[]) * { * struct appdata ad; * @@ -269,31 +264,28 @@ * @endcode * * The ui_app_main() function initializes the application and then starts the main loop. -* * The ui_app_main() function takes four parameters and uses them to initialize the application. * The @a argc and @a argv parameters contain the values from the Application Framework, so that you should never have to change the values. * The third parameter is a state transition handler that is responsible for managing the state * transitions that the application goes through while it is running. The fourth parameter is the application data to be passed to each state handler. -* * When ui_app_main() is first invoked, the application moves from the ready state to the created state. * The application has to initialize itself. -* * During this transition, the Application Framework calls the application's app_create_cb() state transition callback function just * before the application enters the main loop. Within the registered app_create_cb() callback function, you should initialize the * application's resources and create the main window. -* * If the app_create_cb() callback function returns @c false, the application moves to the terminated state.\n * If the app_create_cb() callback function returns @c true, the application enters the main loop. * -* @subsection CAPI_APPLICATION_MODULE_LAUNCH_OPTIONS Handling the launch options +* @subsection CAPI_APPLICATION_MODULE_LAUNCH_OPTIONS Handling the launch options * The Application Framework calls the application's app_control_cb() callback function just after the application enters the main loop. * This callback function is passed to the app_control containing the reason due to which the application is launched. * For example, the application might be launched to open a file to handle the request that has been sent by another application. -* In all of these cases, the application is responsible for checking the contents of the app_control and responding appropriately. The contents -* of the app_control can be empty in situations where the application is launched by the user from the Launcher. +* In all of these cases, the application is responsible for checking the contents of the app_control and responding appropriately. +* The contents of the app_control can be empty in situations where the application is launched by the user from the Launcher. * * @code -* static void app_control(app_control_h app_control, void *user_data) +* static void +* app_control(app_control_h app_control, void *user_data) * { * struct appdata *ad = (struct appdata *)user_data; * char *operation; @@ -302,23 +294,18 @@ * * app_control_get_operation(app_control, operation); * -* if (!strcmp(operation, SERVICE_OPERATION_VIEW)) -* { +* if (!strcmp(operation, SERVICE_OPERATION_VIEW)) { * app_control_get_uri(app_control, &uri); * app_control_get_mime(app_control, &mime_type); * * if (uri && !strcmp(mime_type, "image/jpg")) -* { -* display_image_file(ad, uri); // display a specific image file -* } +* display_image_file(ad, uri); // Display a specific image file * } * * if (ad->win) * elm_win_activate(ad->win); -* * } * @endcode -* */ #endif /* __TIZEN_APPFW_APP_DOC_H__ */ diff --git a/doc/appfw_event_doc.h b/doc/appfw_event_doc.h index 126dbcc..018cec2 100755 --- a/doc/appfw_event_doc.h +++ b/doc/appfw_event_doc.h @@ -21,53 +21,50 @@ /** * @ingroup CAPI_APPLICATION_MODULE * @defgroup CAPI_EVENT_MODULE Event - * @brief The @ref CAPI_EVENT_MODULE API provides functions to serve publication and subscription of event. - * + * @brief The @ref CAPI_EVENT_MODULE API provides functions to serve publication and subscription of the event. * @section CAPI_EVENT_MODULE_HEADER Required Header * \#include - * * @section CAPI_EVENT_MODULE_OVERVIEW Overview - * * The @ref CAPI_EVENT_MODULE API provides functions to broadcast user-defined event. - * - event_publish_app_event() - * - event_publish_trusted_app_event() - * If you want to send an event to trusted application, you can use event_publish_trusted_app_event() API. Only applications which have same signature with sender application can receive the event. - * + * - event_publish_app_event() + * - event_publish_trusted_app_event() + * If you want to send an event to trusted application, you can use event_publish_trusted_app_event() API. + * Only applications which have same signature with sender application can receive the event. * The @ref CAPI_EVENT_MODULE API provides functions to add and remove the event handler for event subscription. * The event handler's function will be called when the interested event occurs. * Adding multiple event handlers to one event is possible. - * - * There are two types event. - * - User-Event is user-defined event. - * - System-Event is pre-defined platform event. See definitions for system event. NOTE: You can't receive the system-event which is not supported on the target device, even if you register event handler for that event. Some system-events require the privilege. (Refer to @ref CAPI_EVENT_MODULE_PRIVILEGED_SYSTEM_EVENT) - * + * There are two types of events: + * - User-Event is user-defined event. + * - System-Event is pre-defined platform event. See definitions for system event. + * NOTE: You can't receive the system-event which is not supported on the target device, even if you register event handler for that event. + * Some system-events require the privilege. (Refer to @ref CAPI_EVENT_MODULE_PRIVILEGED_SYSTEM_EVENT) * The type of event data is bundle type. - * - For System-Event, see definitions for key and value of system event. + * - For System-Event, see definitions for key and value of system event. * - * @subsection CAPI_EVENT_MODULE_EVENT_FORMAT The name-format of User-Event. - * The format of User-Event's name MUST be "event.{sender's appid}.{user-defined name}", unless the API calls using event_name will be failed. + * @subsection CAPI_EVENT_MODULE_EVENT_FORMAT The name-format of User-Event + * The format of the User-Event's name MUST be "event.{sender's appid}.{user-defined name}", unless the API calls using event_name will fail. * The {user-defined name} have some restrictions. - * - Must have length of Min 1 byte and Max 127 bytes. - * - Must only contain the characters("[A~Z][a~z][0~9]_") and not begin with a digit. + * - Must have length of Min 1 byte and Max 127 bytes. + * - Must only contain the characters("[A~Z][a~z][0~9]_") and not begin with a digit. * For example, * "event.org.tizen.testapp.user_event_1". * * @subsection CAPI_EVENT_MODULE_LAUNCH_ON_EVENT Launch-On-Event (Service Application only) * Service application can be launched by event triggering. * For Launch-On-Event, - * - The APP_CONTROL_OPERATION_LAUNCH_ON_EVENT must be defined in the manifest file. - * - The uri name represents event name and the format is "event://{event name"}". - * For uri example, + * - The APP_CONTROL_OPERATION_LAUNCH_ON_EVENT must be defined in the manifest file. + * - The URI name represents event name and the format is "event://{event name"}". + * For URI example, * "event://tizen.system.event.battery_charger_status". (System-Event) - * - The APP_CONTROL_OPERATION_LAUNCH_ON_EVENT can not be requested via app_control_send_launch_request(). - * + * - The APP_CONTROL_OPERATION_LAUNCH_ON_EVENT can not be requested via app_control_send_launch_request(). * How to know the triggered event after launch by event triggering. - * - You can get the event name and data in the first called app_control_cb which is called after 'Created' of application states. + * - You can get the event name and data in the first call of app_control_cb, which is called after 'Created' of application states. + * * @code * static void * app_control(app_control_h app_control, void *data) * { - * //check "launch on event" + * // Check "launch on event" * int ret = 0; * const char *event_uri = "event://tizen.system.event.battery_charger_status"; * char *operation = NULL; @@ -76,14 +73,13 @@ * * ret = app_control_get_operation(app_control, &operation); * if (ret == APP_CONTROL_ERROR_NONE && operation && - * strcmp(operation, APP_CONTROL_OPERATION_LAUNCH_ON_EVENT) == 0) { + * strcmp(operation, APP_CONTROL_OPERATION_LAUNCH_ON_EVENT) == 0) { * ret = app_control_get_uri(app_control, &uri); * if (ret == APP_CONTROL_ERROR_NONE && uri) { * if (strncmp(uri, event_uri, strlen(event_uri) + 1) == 0) { * ret = app_control_get_extra_data(app_control, "battery_charger_status", &event_value); - * if (ret == APP_CONTROL_ERROR_NONE && event_value) { + * if (ret == APP_CONTROL_ERROR_NONE && event_value) * free(event_value); - * } * } * free(uri); * } @@ -91,9 +87,8 @@ * } * } * @endcode - * - Use event_add_event_handler() API in the first called app_control_cb for further subscription of that event. - * - * NOTE : Only several of System-Events support Launch-On-Event. + * - Use event_add_event_handler() API in the first called app_control_cb for further subscription of that event. + * NOTE: Only some of System-Events support Launch-On-Event. * The System-Events and their Conditions which support Launch-On-Event are listed in the table below. * * @@ -106,7 +101,7 @@ * * * - * + * * * * @@ -118,14 +113,13 @@ * *
SYSTEM_EVENT_USB_STATUSWhen Usb CONNECTEDWhen USB CONNECTED
SYSTEM_EVENT_EARJACK_STATUS
* - * @subsection CAPI_EVENT_MODULE_PRIVILEGED_SYSTEM_EVENT Privileged System-Events. + * @subsection CAPI_EVENT_MODULE_PRIVILEGED_SYSTEM_EVENT Privileged System-Events * There are some system-events which need the privilege for normal operation. * You can know these privileged system-events from the 'privilege' comment of the definition of each system-event. * If you try to add event handler for these events without privilege, you will get EVENT_ERROR_PERMISSION_DENIED return when you use the API for adding event handler. - * Also, If you declare app_control operation and uri in the manifest file for these events to enable 'Launch On Event' without privilege, there will be no real launch. - * + * Also, if you declare app_control operation and URI in the manifest file for these events to enable 'Launch On Event' without privilege, there will be no real launch. * @subsection CAPI_EVENT_MODULE_SYSTEM_EVENT Supported System-Events. - * The supported system-event's name, keys and values of each event are listed in the table below. + * The supported system-event's name, keys, and values of each event are listed in the table below. * * * @@ -222,7 +216,7 @@ * * * - * + * * * * @@ -232,12 +226,12 @@ * * * - * + * * * * * - * + * * * * @@ -272,10 +266,9 @@ * * * - * + * * *
Name
SYSTEM_EVENT_TIME_ZONEEVENT_KEY_TIME_ZONEThe 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.		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.
SYSTEM_EVENT_HOUR_FORMAT
SYSTEM_EVENT_LANGUAGE_SETEVENT_KEY_LANGUAGE_SETThe 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.		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.
SYSTEM_EVENT_REGION_FORMATEVENT_KEY_REGION_FORMATThe 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.		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.
SYSTEM_EVENT_SILENT_MODE
SYSTEM_EVENT_NETWORK_STATUSEVENT_KEY_NETWORK_STATUSEVENT_VAL_NETWORK_DISCONNECTED
EVENT_VAL_NETWORK_WIFI
EVENT_VAL_NETWORK_CELLULAR
EVENT_VAL_NETWORK_ETHERNET
EVENT_VAL_NETWORK_BT
EVENT_VAL_NETWORK_NET_PROXY		EVENT_VAL_NETWORK_DISCONNECTED
EVENT_VAL_NETWORK_WIFI
EVENT_VAL_NETWORK_CELLULAR
EVENT_VAL_NETWORK_ETHERNET
EVENT_VAL_NETWORK_BT
EVENT_VAL_NETWORK_NET_PROXY
- * */ #endif /* __TIZEN_APPFW_EVENT_DOC_H__ */ diff --git a/doc/appfw_i18n_doc.h b/doc/appfw_i18n_doc.h index cd7bd58..6d1a284 100755 --- a/doc/appfw_i18n_doc.h +++ b/doc/appfw_i18n_doc.h @@ -23,10 +23,8 @@ * @ingroup CAPI_APPLICATION_MODULE * @defgroup CAPI_I18N_MODULE Internationalization * @brief The Internationalization API provides functions to write multilingual applications through GNU gettext. - * * @section CAPI_I18_MODULE_HEADER Required Header * \#include - * * @section CAPI_I18N_MODULE_OVERVIEW Overview * The @ref CAPI_I18N_MODULE API provides functions to write multilingual applications through GNU gettext. *

@@ -41,6 +39,4 @@ */ - #endif /* __TIZEN_APPFW_I18N_DOC_H__ */ - diff --git a/doc/appfw_preference_doc.h b/doc/appfw_preference_doc.h index 3b1042d..4e962a4 100755 --- a/doc/appfw_preference_doc.h +++ b/doc/appfw_preference_doc.h @@ -21,23 +21,18 @@ /** * @ingroup CAPI_APPLICATION_MODULE * @defgroup CAPI_PREFERENCE_MODULE Preference - * @brief The @ref CAPI_PREFERENCE_MODULE API provides functions to store and retrieve small pieces of data, used for application preferences. - * * @addtogroup CAPI_PREFERENCE_MODULE - * + * @brief The @ref CAPI_PREFERENCE_MODULE API provides functions to store and retrieve small pieces of data used for application preferences. * @section CAPI_PREFERENCE_MODULE_HEADER Required Header * \#include - * + * @section CAPI_PREFERENCE_MODULE_OVERVIEW Overview - * * The Preference API provides a mechanism that saves data items in the form of key/value pairs for this application, and later retrieves them. * A typical usecase would be for an application preference screen where the user can pick some values for some options. The Preference API * has pairs of functions, one to set such a pair, another to retrieve the stored value given in the key. Keys are always text strings, but * there are functions for each of the possible value types: integer, double, string, and boolean. There is also a function to clear all of the preferences. - * - * The @ref CAPI_PREFERENCE_MODULE API provides a way to register a callback to get notified when a value for a particular key changes. It is useful to know - * when the display should be updated or some behavior is altered as a result. - * + * The @ref CAPI_PREFERENCE_MODULE API provides a way to register a callback to get notified when a value for a particular key changes. + * It is useful to know when the display should be updated or some behavior is altered as a result. * There is an iterator function which steps through all the data pairs, invoking a callback for each one. */ diff --git a/doc/appfw_resource_manager_doc.h b/doc/appfw_resource_manager_doc.h index 0458c36..5359262 100755 --- a/doc/appfw_resource_manager_doc.h +++ b/doc/appfw_resource_manager_doc.h @@ -21,34 +21,29 @@ * @ingroup CAPI_APPLICATION_MODULE * @defgroup CAPI_RESOURCE_MANAGER_MODULE Resource Manager * @brief The @ref CAPI_RESOURCE_MANAGER_MODULE API provides functions to get/set the common resource for multiple devices. - * * @section CAPI_RESOURCE_MANAGER_MODULE_HEADER Required Header * \#include * * @section CAPI_RESOURCE_MANAGER_MODULE_OVERVIEW Overview - * - * The @ref CAPI_RESOURCE_MANAGER_MODULE API provides functions to use different resources(images, layout, sounds) between each devices have different device specification. - * For example, if you want to change button image of application depends on device's current language setting, put resource files into different folders which are managed by SDK as the same filename. - * Then call app_resource_manager_get() with resource ID described below to get appropriate resource filepath then OS will choose resources for specific device. - * You should get the path of the resource file that is managed by the resource manager with app_resource_manager_get() API. Tizen may remove unnecessary resource files for a certain device, so you may fail to access if you access the resource file with the path that is not gotten with app_resource_manager_get() API. + * The @ref CAPI_RESOURCE_MANAGER_MODULE API provides functions to use different resources(images, layout, sounds) between each device having different device specifications. + * For example, if you want to change button image of the application depending on the device's current language setting, put resource files into different folders which are managed by SDK as the same filename. + * Then call app_resource_manager_get() with resource ID described below to get the appropriate resource filepath, then OS will choose resources for specific devices. + * You should get the path of the resource file that is managed by the resource manager with app_resource_manager_get() API. + * Tizen may remove unnecessary resource files for a certain device, so you may fail to access if you access the resource file with the path that is not recieved with app_resource_manager_get() API. * Make sure app_resource_manager_init() should be called first and app_resource_manager_release should be called after using resource manager. * * @section CAPI_RESOURCE_MANAGER_MODULE_RESOURCE_ID Resource ID - * * Resource ID is an identifier for specific resource. It consists of sub directories and filename including its extension. - * Same resources are located at different location with same filename for supporting multi devices. + * Same resources are located at different locations with same filename for supporting multiple devices. * If you want to get actual filename with given resourceID, refer app_resource_manager_get(). * * @section CAPI_RESOURCE_MANAGER_MODULE_RESOURCE_TYPE Resource Type - * * For now, 4 resource types are supported. - * * Resource which has same resource type are grouped as folder. * Folder name is irrelevant with its actual resource type. * The managed folders for each type will be generated by SDK tools. * In source codes, you can use resource types listed below. * (Types will be added for further needs) - * * * * @@ -68,14 +63,13 @@ * * * - * + * * *
TYPE
RSC_TYPE_BINAll other resources to be needed but not specified above.All other resources to be needed, but not specified above.
* * @subsection CAPI_RESOURCE_MANAGER_MODULE_MATCHING_ALGORITHM Matching Algorithm * * @image html capi_appfw_application_resource.png "Matching Algorithm" - * */ #endif /* __TIZEN_APPFW_APP_RESOURCE_MANAGER_DOC_H__ */ diff --git a/include/app.h b/include/app.h index 10a262b..0794ae2 100644 --- a/include/app.h +++ b/include/app.h @@ -27,6 +27,7 @@ extern "C" { #endif + /** * @addtogroup CAPI_APPLICATION_MODULE * @{ @@ -35,12 +36,10 @@ extern "C" { /** * @brief Called when the application starts. - * * @details The callback function is called before the main loop of the application starts. * In this callback, you can initialize application resources like window creation, data structure, and so on. * After this callback function returns @c true, the main loop starts up and app_control_cb() is subsequently called. * If this callback function returns @c false, the main loop doesn't start and app_terminate_cb() is subsequently called. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] user_data The user data passed from the callback registration function * @return @c true on success, @@ -54,9 +53,7 @@ typedef bool (*app_create_cb) (void *user_data); /** * @brief Called when the application is completely obscured by another application and becomes invisible. - * * @details The application is not terminated and still running in the paused state. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] user_data The user data passed from the callback registration function * @see ui_app_main() @@ -67,9 +64,7 @@ typedef void (*app_pause_cb) (void *user_data); /** * @brief Called when the application becomes visible. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] user_data The user data passed from the callback registration function * @see ui_app_main() * @see #ui_app_lifecycle_callback_s @@ -80,7 +75,6 @@ typedef void (*app_resume_cb) (void *user_data); /** * @brief Called when the application's main loop exits. * @details You should release the application's resources in this function. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] user_data The user data passed from the callback registration function * @see ui_app_main() @@ -91,23 +85,19 @@ typedef void (*app_terminate_cb) (void *user_data); /** * @brief Called when another application sends a launch request to the application. - * * @details When the application is launched, this callback function is called after the main loop of the application starts up. * The passed app_control handle describes the launch request and contains the information about why the application is launched. * If the launch request is sent to the application in the running or pause state, * this callback function can be called again to notify that the application has been asked to launch. - * * The application could be explicitly launched by the user from the application launcher or be launched to perform the specific operation by another application. * The application is responsible for handling each launch request and responding appropriately. * Using the App Control API, the application can get information about what is to be performed. * If the application is launched from the application launcher or explicitly launched by another application, * the passed app_control handle may include only the default operation (#APP_CONTROL_OPERATION_DEFAULT) without any data. * For more information, see The @ref CAPI_APP_CONTROL_MODULE API description. - * + * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks After this callback returns, the handle of the app_control is freed. * Therefore, if you want to use the handle after returning this callback, you MUST copy it by using app_control_clone() API. - * - * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] app_control The handle to the app_control * @param[in] user_data The user data passed from the callback registration function * @see ui_app_main() @@ -119,7 +109,6 @@ typedef void (*app_control_cb) (app_control_h app_control, void *user_data); /** * @brief The structure type containing the set of callback functions for handling application lifecycle events. * @details It is one of the input parameters of the ui_app_main() function. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @see ui_app_main() * @see app_create_cb() @@ -136,35 +125,33 @@ typedef struct { app_control_cb app_control; /**< This callback function is called when another application sends the launch request to the application. */ } ui_app_lifecycle_callback_s; + /** * @brief Gets the current device orientation. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @return The current device orientation */ app_device_orientation_e app_get_device_orientation(void); + /** * @brief Runs the application's main loop until ui_app_exit() is called. - * * @details This function is the main entry point of the Tizen application. * The app_create_cb() callback function is called to initialize the application before the main loop of application starts up. * After the app_create_cb() callback function returns true, the main loop starts up and the app_control_cb() callback function is subsequently called. * If the app_create_cb() callback function returns false, the main loop doesn't start up and app_terminate_cb() callback function is called. * This main loop supports event handling for the Ecore Main Loop. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] argc The argument count * @param[in] argv The argument vector * @param[in] callback The set of callback functions to handle application lifecycle events * @param[in] user_data The user data to be passed to the callback functions - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #APP_ERROR_INVALID_CONTEXT The application is illegally launched, not launched by the launch system - * @retval #APP_ERROR_ALREADY_RUNNING The main loop already starts - * + * @retval #APP_ERROR_INVALID_CONTEXT The application is launched illegally, not launched by the launch system + * @retval #APP_ERROR_ALREADY_RUNNING The main loop already started * @see app_create_cb() * @see app_terminate_cb() * @see app_pause_cb() @@ -178,10 +165,8 @@ int ui_app_main(int argc, char **argv, ui_app_lifecycle_callback_s *callback, vo /** * @brief Exits the main loop of application. - * * @details The main loop of application stops and app_terminate_cb() is invoked. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @see ui_app_main() * @see app_terminate_cb() */ @@ -189,19 +174,17 @@ void ui_app_exit(void); /** - * @brief Adds the system event handler - * + * @brief Adds the system event handler. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[out] event_handler The event handler * @param[in] event_type The system event type * @param[in] callback The callback function * @param[in] user_data The user data to be passed to the callback functions - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter * @retval #APP_ERROR_OUT_OF_MEMORY Out of memory - * * @see app_event_type_e * @see app_event_cb * @see ui_app_remove_event_handler @@ -210,15 +193,13 @@ int ui_app_add_event_handler(app_event_handler_h *event_handler, app_event_type_ /** - * @brief Removes registered event handler - * + * @brief Removes registered event handler. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @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 #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter - * * @see ui_app_add_event_handler */ int ui_app_remove_event_handler(app_event_handler_h event_handler); diff --git a/include/app_common.h b/include/app_common.h index f155725..5f30490 100644 --- a/include/app_common.h +++ b/include/app_common.h @@ -24,6 +24,7 @@ extern "C" { #endif + /** * @file app_common.h */ @@ -35,7 +36,7 @@ extern "C" { /** - * @brief Enumeration for system events + * @brief Enumeration for system events. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { @@ -51,6 +52,7 @@ typedef enum { It is dependent on target devices. */ } app_event_type_e; + /** * @brief Enumeration for device orientation. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif @@ -62,6 +64,7 @@ typedef enum { APP_DEVICE_ORIENTATION_270 = 270, /**< The device's right side is at the top */ } app_device_orientation_e; + /** * @brief Enumeration for low memory status. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif @@ -72,6 +75,7 @@ typedef enum { APP_EVENT_LOW_MEMORY_HARD_WARNING = 0x04, /**< Hard warning status */ } app_event_low_memory_status_e; + /** * @brief Enumeration for battery status. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif @@ -81,8 +85,9 @@ typedef enum { APP_EVENT_LOW_BATTERY_CRITICAL_LOW, /**< The battery status is under 5% */ } app_event_low_battery_status_e; + /** - * @brief Enumeration for suspended state + * @brief Enumeration for suspended state. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ typedef enum { @@ -90,9 +95,9 @@ typedef enum { APP_SUSPENDED_STATE_DID_EXIT, /**< Application did exit from the suspended state */ } app_suspended_state_e; + /** - * @brief The event handler that returned from add event handler function - * + * @brief The event handler that returned from add event handler function to handle. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @see app_event_type_e * @see app_add_event_handler @@ -103,8 +108,7 @@ typedef struct app_event_handler *app_event_handler_h; /** - * @brief The system event information - * + * @brief The system event information handle. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @see app_event_get_low_memory_status * @see app_event_get_low_battery_status @@ -117,36 +121,30 @@ typedef struct app_event_info *app_event_info_h; /** - * @brief The system event callback function - * + * @brief The system event callback function. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] event_info The system event information * @param[in] user_data The user data passed from the add event handler function - * * @see app_add_event_handler * @see app_event_info_h - * * @remarks If the given @a event_info has #APP_SUSPENDED_STATE_WILL_ENTER value, - * the application should not call any asynchronous operations in this callback. - * After the callback returns, process of the application will be changed to suspended - * state immediately. Thus, asynchronous operations may work incorrectly. (since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) - * + * the application should not call any asynchronous operations in this callback. + * After the callback returns, process of the application will be changed to suspended + * state immediately. Thus, asynchronous operations may work incorrectly. (since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */ typedef void (*app_event_cb)(app_event_info_h event_info, void *user_data); /** - * @brief Gets the low memory status from given event info - * + * @brief Gets the low memory status from the given event info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] event_info The system event info * @param[out] status The low memory status - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter * @retval #APP_ERROR_INVALID_CONTEXT Invalid event context - * * @see app_event_info_h * @see app_event_low_memory_status_e */ @@ -154,17 +152,15 @@ int app_event_get_low_memory_status(app_event_info_h event_info, app_event_low_m /** - * @brief Gets the low battery status from given event info - * + * @brief Gets the low battery status from given event info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] event_info The system event info * @param[out] status The low battery status - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter * @retval #APP_ERROR_INVALID_CONTEXT Invalid event context - * * @see app_event_info_h * @see app_event_low_battery_status_e */ @@ -172,53 +168,47 @@ int app_event_get_low_battery_status(app_event_info_h event_info, app_event_low_ /** - * @brief Gets the language from given event info - * + * @brief Gets the language from the given event info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @remarks @a lang must be released using free() + * @remarks @a lang must be released using free(). * @param[in] event_info The system event info * @param[out] lang The language changed - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter * @retval #APP_ERROR_INVALID_CONTEXT Invalid event context - * * @see app_event_info_h */ int app_event_get_language(app_event_info_h event_info, char **lang); /** - * @brief Gets the region format from given event info - * + * @brief Gets the region format from the given event info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * @remarks @a region must be released using free() + * @remarks @a region must be released using free(). * @param[in] event_info The system event info * @param[out] region The region format changed - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter * @retval #APP_ERROR_INVALID_CONTEXT Invalid event context - * * @see app_event_info_h */ int app_event_get_region_format(app_event_info_h event_info, char **region); /** - * @brief Gets the device orientation from given event info - * + * @brief Gets the device orientation from the given event info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] event_info The system event info * @param[out] orientation The device orientation changed - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter * @retval #APP_ERROR_INVALID_CONTEXT Invalid event context - * * @see app_event_info_h * @see app_device_orientation_e */ @@ -226,38 +216,31 @@ int app_event_get_device_orientation(app_event_info_h event_info, app_device_ori /** - * @brief Gets the suspended state of the application from given event info. - * + * @brief Gets the suspended state of the application from the given event info. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif + * @remarks The application should not use any asynchronous operations in #APP_SUSPENDED_STATE_WILL_ENTER event. + * Because applications will be changed to suspended state just after #APP_SUSPENDED_STATE_WILL_ENTER, asynchronous calls are not guaranteed to work properly. * @param[in] event_info The handle for getting the suspended state * @param[out] state The suspended state of the application - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter * @retval #APP_ERROR_INVALID_CONTEXT Invalid event context - * - * @remarks The application should not use any asynchronous operations in #APP_SUSPENDED_STATE_WILL_ENTER event. - * Because applications will be changed to suspended state just after #APP_SUSPENDED_STATE_WILL_ENTER, - * asynchronous calls are not guaranteed to work properly. */ int app_event_get_suspended_state(app_event_info_h event_info, app_suspended_state_e *state); /** * @brief Gets the ID of the application. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks @a id must be released using free(). - * * @param[out] id The ID of the application - * * @return @c 0 on success, - * otherwise a negative error value - * + * otherwise a negative error value * @retval #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #APP_ERROR_INVALID_CONTEXT The application is illegally launched, not launched by the launch system + * @retval #APP_ERROR_INVALID_CONTEXT The application is launched illegally, not launched by the launch system * @retval #APP_ERROR_OUT_OF_MEMORY Out of memory */ int app_get_id(char **id); @@ -265,18 +248,14 @@ int app_get_id(char **id); /** * @brief Gets the localized name of the application. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks @a name must be released using free(). - * * @param[out] name The name of the application - * * @return @c 0 on success, - * otherwise a negative error value - * + * otherwise a negative error value * @retval #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #APP_ERROR_INVALID_CONTEXT The application is illegally launched, not launched by the launch system + * @retval #APP_ERROR_INVALID_CONTEXT The application is launched illegally, not launched by the launch system * @retval #APP_ERROR_OUT_OF_MEMORY Out of memory */ int app_get_name(char **name); @@ -284,69 +263,56 @@ int app_get_name(char **name); /** * @brief Gets the version of the application package. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks @a version must be released using free(). - * * @param[out] version The version of the application - * * @return @c 0 on success, - * otherwise a negative error value - * + * otherwise a negative error value * @retval #APP_ERROR_NONE Successful * @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #APP_ERROR_INVALID_CONTEXT The application is illegally launched, not launched by the launch system + * @retval #APP_ERROR_INVALID_CONTEXT The application is launched illegally, not launched by the launch system * @retval #APP_ERROR_OUT_OF_MEMORY Out of memory */ int app_get_version(char **version); /** - * @brief Gets the absolute path to the application's data directory which is used to store private - * data of the application. + * @brief Gets the absolute path to the application's data directory which is used to store private data of the application. * @details An application can read and write its own files in the application's data directory. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The returned path should be released. - * - * @return The absolute path to the application's data directory, @n - * otherwise a null pointer if the memory is insufficient + * @return The absolute path to the application's data directory, @n + * otherwise a null pointer if the memory is insufficient */ char *app_get_data_path(void); /** - * @brief Gets the absolute path to the application's cache directory which is used to store - * temporary data of the application. + * @brief Gets the absolute path to the application's cache directory which is used to store temporary data of the application. * @details An application can read and write its own files in the application's cache directory. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The returned path should be released. @n - * The files stored in the application's cache directory can be removed by Setting - * application or platform while the application is running. - * - * @return The absolute path to the application's cache directory, @n - * otherwise a null pointer if the memory is insufficient + * The files stored in the application's cache directory can be removed by setting application or platform while the application is running. + * @return The absolute path to the application's cache directory, @n + * otherwise a null pointer if the memory is insufficient */ char *app_get_cache_path(void); /** - * @brief Gets the absolute path to the application resource directory. The resource files - * are delivered with the application package. + * @brief Gets the absolute path to the application resource directory. The resource files are delivered with the application package. * @details An application can only read its own files in the application's resource directory. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The returned path should be released. - * - * @return The absolute path to the application's resource directory, @n - * otherwise a null pointer if the memory is insufficient + * @return The absolute path to the application's resource directory, @n + * otherwise a null pointer if the memory is insufficient */ char *app_get_resource_path(void); /** - * @brief Gets the absolute path to the application's shared data directory which is used to share - * data with other applications. - * @details An application can read and write its own files in the application's shared data - * directory and others can only read the files. + * @brief Gets the absolute path to the application's shared data directory which is used to share data with other applications. + * @details An application can read and write its own files in the application's shared data directory and others can only read the files. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/appdir.shareddata @@ -358,107 +324,90 @@ char *app_get_resource_path(void); * The specific error code can be obtained using the get_last_result(). Error codes are described in Exception section. * * @return The absolute path to the application's shared data directory, @n - * Otherwise a null pointer if the memory is insufficient. Since Tizen 3.0, returns NULL and set #APP_ERROR_PERMISSION_DENIED if the application does not declare the shareddata privilege. - * @exception #APP_ERROR_NONE Success - * @exception #APP_ERROR_OUT_OF_MEMORY Out of memory - * @exception #APP_ERROR_PERMISSION_DENIED Permission denied + * otherwise a null pointer if the memory is insufficient. It will return NULL for applications with api-version 3.0 or later, and set #APP_ERROR_PERMISSION_DENIED if the application does not declare the shareddata privilege. + * @exception APP_ERROR_NONE Success + * @exception APP_ERROR_OUT_OF_MEMORY Out of memory + * @exception APP_ERROR_PERMISSION_DENIED Permission denied */ char *app_get_shared_data_path(void); /** - * @brief Gets the absolute path to the application's shared resource directory which is used to - * share resources with other applications. - * @details An application can read its own files in the application's shared resource directory - * and others can only read the files. + * @brief Gets the absolute path to the application's shared resource directory which is used to share resources with other applications. + * @details An application can read its own files in the application's shared resource directory, and others can only read the files. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The returned path should be released. - * - * @return The absolute path to the application's shared resource directory, @n - * otherwise a null pointer if the memory is insufficient + * @return The absolute path to the application's shared resource directory, @n + * otherwise a null pointer if the memory is insufficient */ char *app_get_shared_resource_path(void); /** - * @brief Gets the absolute path to the application's shared trusted directory which is used to share data - * with a family of trusted applications. + * @brief Gets the absolute path to the application's shared trusted directory which is used to share data with a family of trusted applications. * @details An application can read and write its own files in the application's shared trusted directory - * and the family applications signed with the same certificate can read and write the files in the - * shared trusted directory. + * and the family applications signed with the same certificate can read and write the files in the shared trusted directory. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The returned path should be released. - * - * @return The absolute path to the application's shared trusted directory, @n - * otherwise a null pointer if the memory is insufficient + * @return The absolute path to the application's shared trusted directory, @n + * otherwise a null pointer if the memory is insufficient */ char *app_get_shared_trusted_path(void); /** - * @brief Gets the absolute path to the application's external data directory which is used to - * store data of the application. - * @details An application can read and write its own files in the application's external data - * directory. + * @brief Gets the absolute path to the application's external data directory which is used to store data of the application. + * @details An application can read and write its own files in the application's external data directory. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The returned path should be released. @n - * The important files stored in the application's external data directory should be - * encrypted because they can be exported via the external sdcard. - * @remarks To access the path returned by this function requires the privilege - * that is "http://tizen.org/privilege/externalstorage.appdata". - * - * @return The absolute path to the application's external data directory, @n + * The important files stored in the application's external data directory should be encrypted because they can be exported via the external sdcard. + * To access the path returned by this function requires the privilege + * that is "http://tizen.org/privilege/externalstorage.appdata". + * @return The absolute path to the application's external data directory, @n * otherwise a null pointer if the memory is insufficient */ char *app_get_external_data_path(void); /** - * @brief Gets the absolute path to the application's external cache directory which is used to - * store temporary data of the application. - * @details An application can read and write its own files in the application's external cache - * directory. + * @brief Gets the absolute path to the application's external cache directory which is used to store temporary data of the application. + * @details An application can read and write its own files in the application's external cache directory. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The returned path should be released. @n * The files stored in the application's external cache directory can be removed by - * Setting application while the application is running. @n + * setting application while the application is running. @n * The important files stored in the application's external cache directory should be * encrypted because they can be exported via the external sdcard. - * @remarks To access the path returned by this function requires the privilege - * that is "http://tizen.org/privilege/externalstorage.appdata". - * - * @return The absolute path to the application's external cache directory, @n - * otherwise a null pointer if the memory is insufficient + * To access the path returned by this function requires the privilege + * that is "http://tizen.org/privilege/externalstorage.appdata". + * @return The absolute path to the application's external cache directory, @n + * otherwise a null pointer if the memory is insufficient */ char *app_get_external_cache_path(void); /** * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. - * @brief Gets the absolute path to the application's external shared data directory which is - * used to share data with other applications. - * @details An application can read and write its own files in the application's external shared - * data directory and others can only read the files. + * @brief Gets the absolute path to the application's external shared data directory which is used to share data with other applications. + * @details An application can read and write its own files in the application's external shared data directory, and others can only read the files. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks The specified @a path should be released. - * @remarks To access the path returned by this function requires the privilege - * that is "http://tizen.org/privilege/externalstorage.appdata". - * @remarks The function may not work as intended in certain devices due to some implementation issues. - * - * @return The absolute path to the application's external shared data directory, @n - * otherwise a null pointer if the memory is insufficient + * To access the path returned by this function requires the privilege + * that is "http://tizen.org/privilege/externalstorage.appdata". + * The function may not work as intended in certain devices due to some implementation issues. + * @return The absolute path to the application's external shared data directory, @n + * otherwise a null pointer if the memory is insufficient */ char *app_get_external_shared_data_path(void) TIZEN_DEPRECATED_API; + /** - * @brief Gets the absolute path to the application's TEP(Tizen Expansion Package) directory. - * The resource files are delivered with the expansion package. - * @details An application can only read its own files in the application's TEP(Tizen Expansion Package) directory. + * @brief Gets the absolute path to the application's TEP(Tizen Expansion Package) directory. The resource files are delivered with the expansion package. + * @details An application can only read its own files in the application's TEP(Tizen Expansion Package) directory. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif - * @remarks The returned path should be released. - * - * @return The absolute path to the application's TEP(Tizen Expansion Package) directory, @n - * otherwise a null pointer if the memory is insufficient + * @remarks The returned path should be released. + * @return The absolute path to the application's TEP(Tizen Expansion Package) directory, @n + * otherwise a null pointer if the memory is insufficient **/ char *app_get_tep_resource_path(void); diff --git a/include/app_control.h b/include/app_control.h index 31be55d..5b6443b 100644 --- a/include/app_control.h +++ b/include/app_control.h @@ -66,8 +66,8 @@ typedef enum { /** * @brief Enumeration for App Control Result. - * @see app_control_enable_app_started_result_event() * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif + * @see app_control_enable_app_started_result_event() */ typedef enum { APP_CONTROL_RESULT_APP_STARTED = 1, /**< Callee application launched actually (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */ @@ -76,6 +76,7 @@ typedef enum { APP_CONTROL_RESULT_CANCELED = -2, /**< Operation canceled by the platform */ } app_control_result_e; + /** * @brief Enumeration for App Control Launch Mode. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -85,6 +86,7 @@ typedef enum { APP_CONTROL_LAUNCH_MODE_GROUP, /**< Prefer to launch an application as group mode */ } app_control_launch_mode_e; + /** * @brief Definition for the app_control operation: An explicit launch for a homescreen application. * @details Input: Nothing\n @@ -106,7 +108,7 @@ typedef enum { /** * @brief Definition for the app_control operation: Provides an editable access to the given data. * @details Input: It depends on application scenario/configuration.\n - * Output: It depends on application scenario/configuration.\n + * Output: It depends on application scenario/configuration.\n * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define APP_CONTROL_OPERATION_EDIT "http://tizen.org/appcontrol/operation/edit" @@ -115,16 +117,16 @@ typedef enum { /** * @brief Definition for the app_control operation: Displays the data. * @details Input: URI is usually used to inform the path to show. In some cases, some other data in Extra can be used (e.g., VIEW operation for viewing Contact, Calendar data).\n - * Output: Nothing\n + * Output: Nothing\n * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define APP_CONTROL_OPERATION_VIEW "http://tizen.org/appcontrol/operation/view" /** - * @brief Definition for the app_control operation: Picks items. + * @brief Definition for the app_control operation: Picks item. * @details Input: It depends on application scenario/configuration.\n - * Output: APP_CONTROL_DATA_SELECTED in Extra\n + * Output: APP_CONTROL_DATA_SELECTED in Extra\n * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define APP_CONTROL_OPERATION_PICK "http://tizen.org/appcontrol/operation/pick" @@ -133,7 +135,7 @@ typedef enum { /** * @brief Definition for the app_control operation: Creates contents. * @details Input: It depends on application scenario/configuration.\n - * Output: APP_CONTROL_DATA_SELECTED in Extra\n + * Output: APP_CONTROL_DATA_SELECTED in Extra\n * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define APP_CONTROL_OPERATION_CREATE_CONTENT "http://tizen.org/appcontrol/operation/create_content" @@ -141,7 +143,7 @@ typedef enum { /** * @brief Definition for the app_control operation: Performs a call to someone. - * @details Input: URI is the number to be dialed. This is mandatory field.\n + * @details Input: URI is the number to be dialed. This is a mandatory field.\n * Output: Nothing\n * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public @@ -213,9 +215,9 @@ typedef enum { /** - * @brief Definition for the app_control operation: Downloads items. + * @brief Definition for the app_control operation: Downloads item. * @details Input: It depends on application scenario/configuration.\n - * Output: It depends on application scenario/configuration.\n + * Output: It depends on application scenario/configuration.\n * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/download (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) @@ -225,13 +227,14 @@ typedef enum { /** - * @brief Definition for the app_control operation: Prints contents. + * @brief Definition for the app_control operation: Prints content. * @details Input: It depends on application scenario/configuration.\n - * Output: It depends on application scenario/configuration.\n + * Output: It depends on application scenario/configuration.\n * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define APP_CONTROL_OPERATION_PRINT "http://tizen.org/appcontrol/operation/print" + /** * @brief Definition for the app_control operation: Composes a message. * @details Input: It depends on application scenario/configuration.\n @@ -240,16 +243,18 @@ typedef enum { */ #define APP_CONTROL_OPERATION_COMPOSE "http://tizen.org/appcontrol/operation/compose" + /** * @brief Definition for the app_control operation: Can be launched by interested System-Event. * @details Input : URI and extras data defined in Event module.\n * Output: Nothing\n * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif - * @remarks This operation is for handling event from the platform. This operation can not be requested via app_control_send_launch_request(). + * @remarks This operation is for handling event from the platform. This operation cannot be requested through app_control_send_launch_request(). * @remarks Refer to Launch-On-Event section of Event module. */ #define APP_CONTROL_OPERATION_LAUNCH_ON_EVENT "http://tizen.org/appcontrol/operation/launch_on_event" + /** * @brief Definition for the app_control operation: Adds an item. * @details Input: It depends on application scenario/configuration.\n @@ -258,6 +263,7 @@ typedef enum { */ #define APP_CONTROL_OPERATION_ADD "http://tizen.org/appcontrol/operation/add" + /** * @brief Definition for the app_control operation: Captures images by camera applications. * @details Input: Nothing\n @@ -266,14 +272,16 @@ typedef enum { */ #define APP_CONTROL_OPERATION_IMAGE_CAPTURE "http://tizen.org/appcontrol/operation/image_capture" + /** * @brief Definition for the app_control operation: Captures videos by camera applications. * @details Input: Nothing\n - * Output: APP_CONTROL_DATA_SELECTED in Extra\n + * Output: APP_CONTROL_DATA_SELECTED in Extra\n * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define APP_CONTROL_OPERATION_VIDEO_CAPTURE "http://tizen.org/appcontrol/operation/video_capture" + /** * @brief Definition for the app_control operation: Shows settings to enable Bluetooth. * @details Input: Nothing\n @@ -282,6 +290,7 @@ typedef enum { */ #define APP_CONTROL_OPERATION_SETTING_BT_ENABLE "http://tizen.org/appcontrol/operation/setting/bt_enable" + /** * @brief Definition for the app_control operation: Shows settings to configure Bluetooth visibility. * @details Input: Nothing\n @@ -290,6 +299,7 @@ typedef enum { */ #define APP_CONTROL_OPERATION_SETTING_BT_VISIBILITY "http://tizen.org/appcontrol/operation/setting/bt_visibility" + /** * @brief Definition for the app_control operation: Shows settings to allow configuration of current location sources. * @details Input: Nothing\n @@ -298,6 +308,7 @@ typedef enum { */ #define APP_CONTROL_OPERATION_SETTING_LOCATION "http://tizen.org/appcontrol/operation/setting/location" + /** * @brief Definition for the app_control operation: Shows NFC settings. * @details Input: APP_CONTROL_DATA_TYPE in Extra (Since 3.0).\n @@ -307,6 +318,7 @@ typedef enum { */ #define APP_CONTROL_OPERATION_SETTING_NFC "http://tizen.org/appcontrol/operation/setting/nfc" + /** * @brief Definition for the app_control operation: Shows system settings. * @details Input: Nothing\n @@ -315,6 +327,7 @@ typedef enum { */ #define APP_CONTROL_OPERATION_SETTING "http://tizen.org/appcontrol/operation/setting" + /** * @brief Definition for the app_control operation: Shows settings to allow configuration of Wi-Fi. * @details Input: Nothing\n @@ -323,6 +336,7 @@ typedef enum { */ #define APP_CONTROL_OPERATION_SETTING_WIFI "http://tizen.org/appcontrol/operation/setting/wifi" + /** * @brief Definition for the app control operation: Shows VPN service settings. * @details Input: Nothing\n @@ -331,6 +345,7 @@ typedef enum { */ #define APP_CONTROL_OPERATION_SETTING_VPN "http://tizen.org/appcontrol/operation/setting/vpn" + /** * @brief Definition for the app control operation: Select the type of input method to receive input from user. * @details Input: It depends on application scenario/configuration.\n @@ -339,6 +354,7 @@ typedef enum { */ #define APP_CONTROL_OPERATION_GET_INPUT "http://tizen.org/appcontrol/operation/get_input" + /** * @brief Definition for app_control data: Subject * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif @@ -354,14 +370,14 @@ typedef enum { /** - * @brief Definition for app_control data: E-mail addresses that should be carbon copied + * @brief Definition for app_control data: E-mail addresses that should be carbon copied. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define APP_CONTROL_DATA_CC "http://tizen.org/appcontrol/data/cc" /** - * @brief Definition for app_control data: E-mail addresses that should be blind carbon copied + * @brief Definition for app_control data: E-mail addresses that should be blind carbon copied. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define APP_CONTROL_DATA_BCC "http://tizen.org/appcontrol/data/bcc" @@ -398,7 +414,7 @@ typedef enum { /** - * @brief Definition for app_control data: Selection mode. ("single" or "multiple") + * @brief Definition for app_control data: Selection mode ("single" or "multiple") * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define APP_CONTROL_DATA_SELECTION_MODE "http://tizen.org/appcontrol/data/selection_mode" @@ -473,20 +489,23 @@ typedef enum { */ #define APP_CONTROL_DATA_TOTAL_SIZE "http://tizen.org/appcontrol/data/total_size" + /** * @brief Definition for app_control data: Name * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ #define APP_CONTROL_DATA_NAME "http://tizen.org/appcontrol/data/name" + /** * @brief Definition for app_control data: Location * @since_tizen 3.0 */ #define APP_CONTROL_DATA_LOCATION "http://tizen.org/appcontrol/data/location" + /** - * @brief Definition for app_control data: Select the type of input method + * @brief Definition for app_control data: Select the type of input method. * @details Type: "input_voice" Launch input method with voice type. * "input_emoticon" Launch input method with emoticon type. * "input_keyboard" Launch input method with keyboard type. @@ -494,38 +513,40 @@ typedef enum { */ #define APP_CONTROL_DATA_INPUT_TYPE "http://tizen.org/appcontrol/data/input_type" + /** - * @brief Definition for app_control data: Send the pre inputted text such as "http://" in web + * @brief Definition for app_control data: Send the pre input text such as "http://" in web. * @since_tizen @if WEARABLE 2.3.2 @elseif MOBILE 3.0 @endif */ #define APP_CONTROL_DATA_INPUT_DEFAULT_TEXT "http://tizen.org/appcontrol/data/input_default_text" + /** - * @brief Definition for app_control data: Send guide text to show to user such as "Input user name" + * @brief Definition for app_control data: Send guide text to show the user such as "Input user name". * @since_tizen @if WEARABLE 2.3.2 @elseif MOBILE 3.0 @endif */ #define APP_CONTROL_DATA_INPUT_GUIDE_TEXT "http://tizen.org/appcontrol/data/input_guide_text" + /** - * @brief Definition for app_control data: Send text to receive answer result from smart reply + * @brief Definition for app_control data: Send text to receive the result from smart reply. * @since_tizen @if WEARABLE 2.3.2 @elseif MOBILE 3.0 @endif */ #define APP_CONTROL_DATA_INPUT_PREDICTION_HINT "http://tizen.org/appcontrol/data/input_prediction_hint" + /** * @brief Called when the reply of the launch request is delivered. * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @remarks The @a request and @a reply must not be deallocated by the application. - * * @param[in] request The app_control handle of the launch request that has been sent * @param[in] reply The app_control handle in which the results of the callee are contained * @param[in] result The result code of the launch request * @param[in] user_data The user data passed from the callback registration function * @pre When the callee replies to the launch request, this callback will be invoked. * @pre Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, if #APP_CONTROL_RESULT_APP_STARTED event is enabled, - * this callback also will be invoked when the callee app actually launched. + * this callback will also be invoked when the callee app actually launched. * @see app_control_send_launch_request() * @see app_control_reply_to_launch_request() * @see app_control_enable_app_started_result_event() @@ -538,9 +559,7 @@ typedef void (*app_control_reply_cb) (app_control_h request, app_control_h reply * @brief Called to retrieve the extra data contained in the app_control. * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @remarks The @a key must not be deallocated by the application. - * * @param[in] app_control The app_control handle * @param[in] key The key of the value contained in the app_control * @param[in] user_data The user data passed from the foreach function @@ -1080,7 +1099,6 @@ int app_control_is_reply_requested(app_control_h app_control, bool *requested); * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @param[in] app_control The app_control handle * @param[in] mode The launch mode of app - * * @return 0 on success, otherwise a negative error value * @retval #APP_CONTROL_ERROR_NONE Successful * @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter @@ -1098,7 +1116,6 @@ int app_control_set_launch_mode(app_control_h app_control, * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @param[in] app_control The app_control handle * @param[out] mode The launch mode of app - * * @return 0 on success, otherwise a negative error value * @retval #APP_CONTROL_ERROR_NONE Successful * @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter 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); + /** * @} */ diff --git a/include/app_i18n.h b/include/app_i18n.h index 4dfbf7e..d30a285 100644 --- a/include/app_i18n.h +++ b/include/app_i18n.h @@ -42,6 +42,7 @@ extern "C" #define _(msg) i18n_get_text(msg) #endif + /** * @brief Gets the localized translation for the specified string. * @@ -51,15 +52,17 @@ extern "C" * @remarks Do not free the returned value. * * @param[in] message The string to be translated - * @return The localized translation for the given @a message on success, - * otherwise the given @a message + * @return The localized translation for the given @a message on success, + * otherwise the given @a message */ char *i18n_get_text(const char *message); + /** * @} */ + #ifdef __cplusplus } #endif diff --git a/include/app_preference.h b/include/app_preference.h index 6313ffa..478793a 100644 --- a/include/app_preference.h +++ b/include/app_preference.h @@ -24,6 +24,7 @@ extern "C" { #endif + /** * @file app_preference.h */ @@ -49,9 +50,7 @@ typedef enum { /** * @brief Called when the given key's value in the preference changes. - * * @details When the @a key is added or removed, this callback function is skipped(only update can be handled). - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key in the preference * @param[in] user_data The user data passed from the callback registration function @@ -68,29 +67,26 @@ typedef void (*preference_changed_cb) (const char *key, void *user_data); /** * @brief Called to get key string, once for each key-value pair in the preference. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks You should not free the @a key returned by this function. - * * @param[in] key The key of the value added to the preference * @param[in] value The value associated with the key * @param[in] user_data The user data passed from the foreach function * @return @c true to continue with the next iteration of the loop, * otherwise @c false to break out of the loop - * @pre preference_foreach_item() will invoke this callback function. - * @see preference_foreach_item() + * @pre preference_foreach_item() will invoke this callback function. + * @see preference_foreach_item() */ typedef bool (*preference_item_cb)(const char *key, void *user_data); /** * @brief Sets an integer value in the preference. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key to modify * @param[in] value The new @c int value for the given key * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #PREFERENCE_ERROR_NONE Successful * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory @@ -102,15 +98,14 @@ int preference_set_int(const char *key, int value); /** * @brief Gets an integer value from the preference. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key to retrieve * @param[out] value The @c int value for the given key * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #PREFERENCE_ERROR_NONE Successful - * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_NO_KEY Required key not available * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error * @see preference_set_int() @@ -120,15 +115,14 @@ int preference_get_int(const char *key, int *value); /** * @brief Sets a double value in the preference. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key to modify * @param[in] value The new @c double value associated with the given key * @return @c 0 on success, - * otherwise a negative error value - * @retval #PREFERENCE_ERROR_NONE Successful - * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory + * otherwise a negative error value + * @retval #PREFERENCE_ERROR_NONE Successful + * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error * @see preference_get_double() */ @@ -137,15 +131,14 @@ int preference_set_double(const char *key, double value); /** * @brief Gets a double value from the preference. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key to retrieve - * @param[out] value The @c double value associated with the given key + * @param[out] value The @c double value associated with the given key * @return @c 0 on success, - * otherwise a negative error value - * @retval #PREFERENCE_ERROR_NONE Successful - * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory + * otherwise a negative error value + * @retval #PREFERENCE_ERROR_NONE Successful + * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_NO_KEY Required key not available * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error * @see preference_set_double() @@ -155,17 +148,15 @@ int preference_get_double(const char *key, double *value); /** * @brief Sets a string value in the preference. - * * @details It makes a deep copy of the added string value. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key to modify - * @param[in] value The new @c string value associated with the given key + * @param[in] value The new @c string value associated with the given key * @return @c 0 on success, - * otherwise a negative error value - * @retval #PREFERENCE_ERROR_NONE Successful - * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory + * otherwise a negative error value + * @retval #PREFERENCE_ERROR_NONE Successful + * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error * @see preference_get_string() */ @@ -174,16 +165,15 @@ int preference_set_string(const char *key, const char *value); /** * @brief Gets a string value from the preference. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @remarks @a value must be released using free(). * @param[in] key The name of the key to retrieve * @param[out] value The @c string value associated with the given key * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #PREFERENCE_ERROR_NONE Successful - * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_NO_KEY Required key not available * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error * @see preference_set_string() @@ -193,15 +183,14 @@ int preference_get_string(const char *key, char **value); /** * @brief Sets a boolean value in the preference. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key to modify * @param[in] value The new @c boolean value associated with the given key * @return @c 0 on success, - * otherwise a negative error value - * @retval #PREFERENCE_ERROR_NONE Successful - * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory + * otherwise a negative error value + * @retval #PREFERENCE_ERROR_NONE Successful + * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error * @see preference_get_boolean() */ @@ -210,15 +199,14 @@ int preference_set_boolean(const char *key, bool value); /** * @brief Gets a boolean value from the preference. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key to retrieve - * @param[out] value The @c boolean value associated with the given key + * @param[out] value The @c boolean value associated with the given key * @return @c 0 on success, - * otherwise a negative error value - * @retval #PREFERENCE_ERROR_NONE Successful - * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory + * otherwise a negative error value + * @retval #PREFERENCE_ERROR_NONE Successful + * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_NO_KEY Required key not available * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error * @see preference_set_boolean() @@ -228,14 +216,13 @@ int preference_get_boolean(const char *key, bool *value); /** * @brief Removes any value with the given @a key from the preference. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key to remove * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #PREFERENCE_ERROR_NONE Successful * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_NO_KEY Required key not available * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error */ @@ -244,16 +231,15 @@ int preference_remove(const char *key); /** * @brief Checks whether the given @a key exists in the preference. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key to check - * @param[out] existing If @c true the @a key exists in the preference, - * otherwise @c false + * @param[out] existing If @c true the @a key exists in the preference, + * otherwise @c false * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #PREFERENCE_ERROR_NONE Successful * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error */ int preference_is_existing(const char *key, bool *existing); @@ -261,12 +247,11 @@ int preference_is_existing(const char *key, bool *existing); /** * @brief Removes all key-value pairs from the preference. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #PREFERENCE_ERROR_NONE Successful - * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error * @see preference_remove() */ @@ -275,19 +260,18 @@ int preference_remove_all(void); /** * @brief Registers a callback function to be invoked when value of the given key in the preference changes. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key to monitor * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #PREFERENCE_ERROR_NONE Successful * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_NO_KEY Required key not available * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error - * @post preference_changed_cb() will be invoked. + * @post preference_changed_cb() will be invoked. * @see preference_unset_changed_cb() * @see preference_changed_cb() */ @@ -296,14 +280,13 @@ int preference_set_changed_cb(const char *key, preference_changed_cb callback, v /** * @brief Unregisters the callback function. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] key The name of the key to monitor * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #PREFERENCE_ERROR_NONE Successful * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #PREFERENCE_ERROR_OUT_OF_MEMORY Out of memory * @retval #PREFERENCE_ERROR_NO_KEY Required key not available * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error * @see preference_set_changed_cb() @@ -313,12 +296,11 @@ int preference_unset_changed_cb(const char *key); /** * @brief Retrieves all key-value pairs in the preference by invoking the callback function. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @param[in] callback The callback function to get key value once for each key-value pair in the preference * @param[in] user_data The user data to be passed to the callback function * @return @c 0 on success, - * otherwise a negative error value + * otherwise a negative error value * @retval #PREFERENCE_ERROR_NONE Successful * @retval #PREFERENCE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #PREFERENCE_ERROR_IO_ERROR Internal I/O Error diff --git a/include/app_resource_manager.h b/include/app_resource_manager.h index d282459..927f00b 100644 --- a/include/app_resource_manager.h +++ b/include/app_resource_manager.h @@ -46,6 +46,7 @@ typedef enum { /*add values between APP_RESOURCE_TYPE_MIN and APP_RESOURCE_TYPE_MAX*/ } app_resource_e; + /** * @brief Enumeration for App Resource Manager Error. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -57,11 +58,12 @@ typedef enum { APP_RESOURCE_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< I/O error */ } app_resource_error_e; + /** * @brief Creates resource manager and get from db. * * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif - * @remarks If resource manager is already exist, + * @remarks If resource manager already exists, * It will just return APP_RESOURCE_ERROR_NONE * @return @c 0 on success, * otherwise a negative error value @@ -72,8 +74,9 @@ typedef enum { */ int app_resource_manager_init(void); + /** - * @brief Convert resource ID to path name + * @brief Converts resource ID to path name * * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @remarks If resource manager is not created yet, @@ -92,12 +95,13 @@ int app_resource_manager_init(void); */ int app_resource_manager_get(app_resource_e type, const char *id, char **path); + /** * @brief Destroys resource manager. * * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif - * @remarks Please make sure that the instance of resource manager should be released when the application is closing only. - * It is highly recommended way to improve run-time performance. + * @remarks Please note that the instance of resource manager should only be released when the application is closing. + * It is a highly recommended way to improve run-time performance. * @return @c 0 on success, * otherwise a negative error value * @retval #APP_RESOURCE_ERROR_NONE Successful @@ -105,10 +109,12 @@ int app_resource_manager_get(app_resource_e type, const char *id, char **path); */ int app_resource_manager_release(void); + /** * @} */ + #ifdef __cplusplus } #endif diff --git a/include/app_types.h b/include/app_types.h index d4797db..a939615 100644 --- a/include/app_types.h +++ b/include/app_types.h @@ -33,7 +33,6 @@ * @brief Enumeration for application error. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ - typedef enum { APP_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ APP_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ @@ -44,6 +43,7 @@ typedef enum { APP_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied @if MOBILE (Since 2.3.1) @endif */ } app_error_e; + /** * @} */ -- 2.7.4