/**
* @defgroup SHORTCUT_MODULE Shortcut
- * @brief To enhance the Add to home feature. Two types of API set are supported.
+ * @brief To enhance the Add to home feature. Two types of API sets are supported.
* - One for the homescreen developers.
- * - The others for the application developers who should implement the Add to home feature.
+ * - The other for the application developers who should implement the Add to home feature.
* @ingroup CAPI_APPLICATION_FRAMEWORK
* @section SHORTCUT_MODULE_HEADER Required Header
* \#include <shortcut.h>
* @section SHORTCUT_MODULE_OVERVIEW Overview
<H1>1. Shortcut</H1>
Tizen is supporting the "add shortcut or add to home" for various applications.
-Developers may use the shortcut library (libshortcut) to implement features sending (applications) and receiving (possibly home screen) shortcuts.
+Developers may use the shortcut library (libshortcut) to implement features like sending (applications) and receiving (possibly home screen) shortcuts.
If home screen implements the shortcut service using the library, the applications are good to go for adding their shortcuts to the home screen(, and vice versa.)
<H1>2. How to add a new shortcut to the home screen</H1>
<H2>2.1 Add to home (From the app to home)</H2>
-The followings are two separate APIs to support "add to home" feature.
+The following are two separate APIs to support the "add to home" feature.
\code
typedef int (*result_cb_t)(int ret, int pid, void *data)
-extern int add_to_home_shortcut(const char *pkgname, const char *name, int type, const char *content_info, const char *icon, result_cb_t result_cb, void *data)
+extern int shortcut_add_shortcut(const char *pkgname, const char *name, int type, const char *content_info, const char *icon, result_cb_t result_cb, void *data)
-extern int add_to_home_dynamicbox(const char *pkgname, const char *name, int type, const char *content, const char *icon, double period, result_cb_t result_cb, void *data)
+extern int shortcut_add_dynamicbox(const char *pkgname, const char *name, int type, const char *content, const char *icon, double period, result_cb_t result_cb, void *data)
\endcode
Currently, our home screen can contain two different types of contents (that are pure shortcuts and dynamicboxes).
-To add a pure shortcut i.e., simply for launching an app, developers can use "add_to_home_shortcut" API to deliver their shortcuts to a home screen.
+To add a pure shortcut i.e., simply for launching an app, developers can use the "shortcut_add_shortcut" API to deliver their shortcuts to a home screen.
-If your application supports our dynamicbox service and implments dynamicbox type shortcut, then you can use "add_to_home_dynamicbox" API to have a home screen add the dynamicbox on its screen.
+If your application supports our dynamicbox service and implements a dynamicbox type shortcut, then you can use the "shortcut_add_dynamicbox" API to have a home screen add the dynamicbox on its screen.
<TABLE>
<TR><TH>Parameters</TH><TH>Comment</TH></TR>
<TR><TD>pkgname</TD><TD>Package name</TD></TR>
-<TR><TD>name</TD><TD>Application name wich will be displayed on the screen</TD></TR>
+<TR><TD>name</TD><TD>Application name which will be displayed on the screen</TD></TR>
<TR><TD>type</TD><TD>Basically it describes launching options whether to use a package name or URI. LAUNCH_BY_PACKAGE or LAUNCH_BY_URI</TD></TR>
<TR><TD>content</TD><TD>
Application data used for creating a pure shortcut or creating a dynamicbox
Shortcut
-1. if the type is Launch by package: None
+1. If the type is Launch by package: None
-2. if the type is Launch by URI: put the URI in the content
+2. If the type is Launch by URI: Put the URI in the content
- Dynamicbox: any data necessary to create a dynamicbox. Basically, it will passed to the dynamicbox plug-in's create function.
+ Dynamicbox: any data necessary to create a dynamicbox. Basically, it will be passed to the dynamicbox plug-in's create function.
</TD></TR>
-<TR><TD>icon</TD><TD>Absolute path to the icon file, If you set this "NULL", the home screen will use the deafult icon file (but it is depends on the homescreen implementations)</TD></TR>
+<TR><TD>icon</TD><TD>Absolute path to the icon file, If you set this to "NULL", the home screen will use the deafult icon file (but it is depends on the homescreen implementations)</TD></TR>
<TR><TD>period</TD><TD><Only for dynamicbox> Update period. The period must be greater than 0.0f</TD></TR>
<TR><TD>result_cb</TD><TD>Result callback. The callback will be called after a shortcut or dynamicbox has been added. Don't forget to check the return value.</TD></TR>
<TR><TD>data</TD><TD>Callback data</TD></TR>
<H3>2.1.1 Supported types</H3>
shortcut.h Enumeration values for type of shortcuts
-<H2>2.2 Add shortcut (Home screen retrieves shortcuts from app)</H2>
+<H2>2.2 Add shortcut (Home screen retrieves shortcuts from the app)</H2>
"Add shortcut " service enables home screen to retrieve all shortcuts that applications promised to support and request an app to send their shortcuts to home directly, as opposed to "add to home".
-It is initiated by home screen as opposed to "add to home" which is initiated by an application."Add shortcut " service enables home screen to retrieve all shortcuts that applications promised to support and request an app to send their shortcuts to home directly, as opposed to "add to home".
+It is initiated by the home screen as opposed to "add to home" which is initiated by an application.The "Add shortcut" service enables the home screen to retrieve all shortcuts that applications promised to support and request an app to send their shortcuts to home directly, as opposed to "add to home".
-It is initiated by home screen as opposed to "add to home" which is initiated by an application.
+It is initiated by the home screen as opposed to "add to home" which is initiated by an application.
<H3>2.2.1 Build the shortcut list DB</H3>
\image html BuildShortcutList.png
-To recognize how many and what kinds of shortcuts have been registerred, each application who wants to support "add shortcut" service needs to install the XML file that defines "shortcut" information.
+To recognize how many and what kinds of shortcuts have been registered, each application who wants to support the "add shortcut" service needs to install the XML file that defines "shortcut" information.
The following table describes the format and information necessary to define the shortcuts application can support.
Then, the information will be shown and used in home screen when a user selects "add shortcut" service.
</TABLE>
Install this XML file to /opt/share/packages/YOUR_PKGNAME.xml (Note: After manifest has been applied to the binary, simply copy the content to your manifest file.)
-Shortcut listing application will list up these items on its screen and each item will be displayed using the string in label field.
+The shortcut listing application will list up these items on its screen and each item will be displayed using the string in the label field.
When selected, it will launch the selected app using app service with "appid" and a bundle holding data in the pair of extra_key and extra-data fields.
Obviously, icon will be used to display visual information for given shortcut type.(that said the icon could be other than the application's default icon)
<H3>2.2.2 Jump to the APP</H3>
\image html JumpToApp.png
-Shortcut listing application will launch your application using app-svc with package name and param attributes.
+The shortcut listing application will launch your application using app-svc with package name and param attributes.
It will use the pkgname and param attrbute to launch your application.
-Shortcut list view will launch your "[App] Shortcut list" using followed code.
+The shortcut list view will launch your "[App] Shortcut list" using the following code.
-When your app is launched, the app should send a selected item as a shortcut or dynamicbox to the home screen using "add_to_home" series functions mentioned above.
+When your app is launched, the app should send a selected item as a shortcut or dynamicbox to the home screen using "shortcut_add" series functions mentioned above.
<H3>2.2.3 What each app has to do</H3>
You can implement your shortcut list view using App or UG.
</LI>
</UL>
-In your shortcut list view, you just call the "add_to_home_shortcut" or "add_to_home_dynamicbox" which are described in the section 2.1
+In your shortcut list view, you just call the "shortcut_add_shortcut" or "shortcut_add_dynamicbox" which are described in the section 2.1
<H4>2.2.3.1 Handled by App</H4>
\image html ShortcutApp.png
When you receive PAUSE event, or need to change to other view (not in the same UG), you should destroy current UG.
If you didn't destroy it, it will be reside on the process list. and it will not be destroyed automatically.
-Currently, UG container process only supporting the multiple instance for a process.
+Currently, the UG container process only supports multiple instance for a process.
So if the user tries to add a new shortcut again from the shortcut list application, your UG will be launched again if you didn't
terminate previous UG process (when you got PAUSE event).
<TR><TD>data</TD><TD>Callback data</TD></TR>
</TABLE>
-<H1>4. To list up shortcuts registred in the device</H1>
+<H1>4. To list up shortcuts registered in the device</H1>
<TABLE>
<TR><TH>shortcut-list viewer will launch your app by this way</TH></TR>
<TR><TD>
</TD></TR>
</TABLE>
-If you specified the "pkgname", this API will only gathering the given Package's shortcut list.
+If you specified the "pkgname", this API will only gather the given Package's shortcut list.
If you set is to NULL, this API will gathering all shortcuts.
Every shortcut item will be passed via "cb" callback function. so it will be invoked N times if the number of registered shortcut item is N.
pkgname and name and param is described in the XML file of each application package.
It will returns the number of shortcut items, or return <0 as an error value.
--EIO : failed to access shortcut list DB
+-EIO : failed to access the shortcut list DB
> 0 : Number of shortcut items (count of callback function calling)
*
*/
/**
* @defgroup SHORTCUT_MODULE Shortcut
- * @brief To enhance the Add to home feature. Two types of API set are supported.
+ * @brief To enhance the Add to home feature. Two types of API sets are supported.
* - One for the homescreen developers.
- * - The others for the application developers who should implement the Add to home feature.
+ * - The other for the application developers who should implement the Add to home feature.
* @ingroup CAPI_APPLICATION_FRAMEWORK
* @section SHORTCUT_MODULE_HEADER Required Header
- * \#include <shortcut_product.h>
+ * \#include <shortcut.h>
* @section SHORTCUT_MODULE_OVERVIEW Overview
<H1>1. Shortcut</H1>
Tizen is supporting the "add shortcut or add to home" for various applications.
-Developers may use the shortcut library (libshortcut) to implement features sending (applications) and receiving (possibly home screen) shortcuts.
+Developers may use the shortcut library (libshortcut) to implement features like sending (applications) and receiving (possibly home screen) shortcuts.
If home screen implements the shortcut service using the library, the applications are good to go for adding their shortcuts to the home screen(, and vice versa.)
<H1>2. How to add a new shortcut to the home screen</H1>
<H2>2.1 Add to home (From the app to home)</H2>
-The followings are two separate APIs to support "add to home" feature.
+The following are two separate APIs to support the "add to home" feature.
\code
typedef int (*result_cb_t)(int ret, int pid, void *data)
-extern int add_to_home_shortcut(const char *pkgname, const char *name, int type, const char *content_info, const char *icon, result_cb_t result_cb, void *data)
+extern int shortcut_add_shortcut(const char *pkgname, const char *name, int type, const char *content_info, const char *icon, result_cb_t result_cb, void *data)
-extern int add_to_home_dynamicbox(const char *pkgname, const char *name, int type, const char *content, const char *icon, double period, result_cb_t result_cb, void *data)
+extern int shortcut_add_dynamicbox(const char *pkgname, const char *name, int type, const char *content, const char *icon, double period, result_cb_t result_cb, void *data)
\endcode
Currently, our home screen can contain two different types of contents (that are pure shortcuts and dynamicboxes).
-To add a pure shortcut i.e., simply for launching an app, developers can use "add_to_home_shortcut" API to deliver their shortcuts to a home screen.
+To add a pure shortcut i.e., simply for launching an app, developers can use the "shortcut_add_shortcut" API to deliver their shortcuts to a home screen.
-If your application supports our dynamicbox service and implments dynamicbox type shortcut, then you can use "add_to_home_dynamicbox" API to have a home screen add the dynamicbox on its screen.
+If your application supports our dynamicbox service and implements a dynamicbox type shortcut, then you can use the "shortcut_add_dynamicbox" API to have a home screen add the dynamicbox on its screen.
<TABLE>
<TR><TH>Parameters</TH><TH>Comment</TH></TR>
<TR><TD>pkgname</TD><TD>Package name</TD></TR>
-<TR><TD>name</TD><TD>Application name wich will be displayed on the screen</TD></TR>
+<TR><TD>name</TD><TD>Application name which will be displayed on the screen</TD></TR>
<TR><TD>type</TD><TD>Basically it describes launching options whether to use a package name or URI. LAUNCH_BY_PACKAGE or LAUNCH_BY_URI</TD></TR>
<TR><TD>content</TD><TD>
Application data used for creating a pure shortcut or creating a dynamicbox
Shortcut
-1. if the type is Launch by package: None
+1. If the type is Launch by package: None
-2. if the type is Launch by URI: put the URI in the content
+2. If the type is Launch by URI: Put the URI in the content
- Dynamicbox: any data necessary to create a dynamicbox. Basically, it will passed to the dynamicbox plug-in's create function.
+ Dynamicbox: any data necessary to create a dynamicbox. Basically, it will be passed to the dynamicbox plug-in's create function.
</TD></TR>
-<TR><TD>icon</TD><TD>Absolute path to the icon file, If you set this "NULL", the home screen will use the deafult icon file (but it is depends on the homescreen implementations)</TD></TR>
+<TR><TD>icon</TD><TD>Absolute path to the icon file, If you set this to "NULL", the home screen will use the deafult icon file (but it is depends on the homescreen implementations)</TD></TR>
<TR><TD>period</TD><TD><Only for dynamicbox> Update period. The period must be greater than 0.0f</TD></TR>
<TR><TD>result_cb</TD><TD>Result callback. The callback will be called after a shortcut or dynamicbox has been added. Don't forget to check the return value.</TD></TR>
<TR><TD>data</TD><TD>Callback data</TD></TR>
<H3>2.1.1 Supported types</H3>
shortcut.h Enumeration values for type of shortcuts
-<H2>2.2 Add shortcut (Home screen retrieves shortcuts from app)</H2>
+<H2>2.2 Add shortcut (Home screen retrieves shortcuts from the app)</H2>
"Add shortcut " service enables home screen to retrieve all shortcuts that applications promised to support and request an app to send their shortcuts to home directly, as opposed to "add to home".
-It is initiated by home screen as opposed to "add to home" which is initiated by an application."Add shortcut " service enables home screen to retrieve all shortcuts that applications promised to support and request an app to send their shortcuts to home directly, as opposed to "add to home".
+It is initiated by the home screen as opposed to "add to home" which is initiated by an application.The "Add shortcut" service enables the home screen to retrieve all shortcuts that applications promised to support and request an app to send their shortcuts to home directly, as opposed to "add to home".
-It is initiated by home screen as opposed to "add to home" which is initiated by an application.
+It is initiated by the home screen as opposed to "add to home" which is initiated by an application.
<H3>2.2.1 Build the shortcut list DB</H3>
\image html BuildShortcutList.png
-To recognize how many and what kinds of shortcuts have been registerred, each application who wants to support "add shortcut" service needs to install the XML file that defines "shortcut" information.
+To recognize how many and what kinds of shortcuts have been registered, each application who wants to support the "add shortcut" service needs to install the XML file that defines "shortcut" information.
The following table describes the format and information necessary to define the shortcuts application can support.
Then, the information will be shown and used in home screen when a user selects "add shortcut" service.
</TABLE>
Install this XML file to /opt/share/packages/YOUR_PKGNAME.xml (Note: After manifest has been applied to the binary, simply copy the content to your manifest file.)
-Shortcut listing application will list up these items on its screen and each item will be displayed using the string in label field.
+The shortcut listing application will list up these items on its screen and each item will be displayed using the string in the label field.
When selected, it will launch the selected app using app service with "appid" and a bundle holding data in the pair of extra_key and extra-data fields.
Obviously, icon will be used to display visual information for given shortcut type.(that said the icon could be other than the application's default icon)
<H3>2.2.2 Jump to the APP</H3>
\image html JumpToApp.png
-Shortcut listing application will launch your application using app-svc with package name and param attributes.
+The shortcut listing application will launch your application using app-svc with package name and param attributes.
It will use the pkgname and param attrbute to launch your application.
-Shortcut list view will launch your "[App] Shortcut list" using followed code.
+The shortcut list view will launch your "[App] Shortcut list" using the following code.
-When your app is launched, the app should send a selected item as a shortcut or dynamicbox to the home screen using "add_to_home" series functions mentioned above.
+When your app is launched, the app should send a selected item as a shortcut or dynamicbox to the home screen using "shortcut_add" series functions mentioned above.
<H3>2.2.3 What each app has to do</H3>
You can implement your shortcut list view using App or UG.
</LI>
</UL>
-In your shortcut list view, you just call the "add_to_home_shortcut" or "add_to_home_dynamicbox" which are described in the section 2.1
+In your shortcut list view, you just call the "shortcut_add_shortcut" or "shortcut_add_dynamicbox" which are described in the section 2.1
<H4>2.2.3.1 Handled by App</H4>
\image html ShortcutApp.png
When you receive PAUSE event, or need to change to other view (not in the same UG), you should destroy current UG.
If you didn't destroy it, it will be reside on the process list. and it will not be destroyed automatically.
-Currently, UG container process only supporting the multiple instance for a process.
+Currently, the UG container process only supports multiple instance for a process.
So if the user tries to add a new shortcut again from the shortcut list application, your UG will be launched again if you didn't
terminate previous UG process (when you got PAUSE event).
<TR><TD>data</TD><TD>Callback data</TD></TR>
</TABLE>
-<H1>4. To list up shortcuts registred in the device</H1>
+<H1>4. To list up shortcuts registered in the device</H1>
<TABLE>
<TR><TH>shortcut-list viewer will launch your app by this way</TH></TR>
<TR><TD>
</TD></TR>
</TABLE>
-If you specified the "pkgname", this API will only gathering the given Package's shortcut list.
+If you specified the "pkgname", this API will only gather the given Package's shortcut list.
If you set is to NULL, this API will gathering all shortcuts.
Every shortcut item will be passed via "cb" callback function. so it will be invoked N times if the number of registered shortcut item is N.
pkgname and name and param is described in the XML file of each application package.
It will returns the number of shortcut items, or return <0 as an error value.
--EIO : failed to access shortcut list DB
+-EIO : failed to access the shortcut list DB
> 0 : Number of shortcut items (count of callback function calling)
*
*/
/**
* @file shortcut.h
- * @brief This file declares API of libshortcut library
+ * @brief This file declares the API of the libshortcut library.
*/
/**
* @details The homescreen should define a callback as this type and implement the service code
* for adding a new application shortcut.
* @since_tizen 2.3
- * @param[in] appid Shortcut is added for this package
- * @param[in] name Name for created shortcut icon
- * @param[in] type 3 kinds of types are defined
- * @param[in] content_info Specific information for creating a new shortcut
- * @param[in] icon Absolute path of an icon file for this shortcut
- * @param[in] pid Process ID of who request add_to_home
- * @param[in] allow_duplicate 1 if shortcut can be duplicated or a shourtcut should be exists only one
- * @param[in] data Callback data
- * @return Developer should returns the result of handling shortcut creation request\n
- * Returns 0, if succeed to handles the add_to_home request, or returns proper errno
+ * @param[in] appid The shortcut that is added for this package
+ * @param[in] name The name of the created shortcut icon
+ * @param[in] type One of the three defined types
+ * @param[in] content_info The specific information for creating a new shortcut
+ * @param[in] icon The absolute path of an icon file for this shortcut
+ * @param[in] pid The process ID of who request add_to_home
+ * @param[in] allow_duplicate @c 1 if the shortcut can be duplicated,
+ * otherwise a shourtcut should exist only once
+ * @param[in] data The callback data
+ * @return The result of handling a shortcut creation request\n
+ * This returns @c 0 if the add_to_home request is handled successfully,
+ * otherwise it returns a proper errno.
* @see shortcut_set_request_cb()
*/
typedef int (*request_cb_t)(const char *appid, const char *name, int type, const char *content_info, const char *icon, int pid, double period, int allow_duplicate, void *data);
/**
* @brief Called to receive the result of add_to_home_shortcut().
* @since_tizen 2.3
- * @param[in] ret Result value, it could be 0 if succeed to add a shortcut, or errno
- * @param[in] pid Process ID of who handles this add_to_home request
- * @param[in] data Callback data
- * @return int Returns 0, if there is no error or returns errno
+ * @param[in] ret The result value, it could be @c 0 if it succeeds to add a shortcut,
+ * otherwise it returns an errno
+ * @param[in] pid The process ID of who handle this add_to_home request
+ * @param[in] data The callback data
+ * @return int @c 0 if there is no error,
+ otherwise errno
* @see add_to_home_shortcut()
*/
typedef int (*result_cb_t)(int ret, int pid, void *data);
/**
* @brief Enumeration for shortcut types.
- * @details Basically, three types of shortcut is defined.
- * Every homescreen developer should support these types of shortcut.
- * Or return proper errno to figure out why the application failed to add a shortcut.
- * LAUNCH_BY_PACKAGE is used for adding a package itself as a shortcut.
- * LAUNCH_BY_URI is used for adding a shortcut for "uri" data.
+ * @details Basically, three types of shortcuts are defined.
+ * Every homescreen developer should support these types of shortcuts.
+ * Or return a proper errno to figure out why the application failed to add a shortcut.
+ * #LAUNCH_BY_PACKAGE is used for adding a package itself as a shortcut.
+ * #LAUNCH_BY_URI is used for adding a shortcut for "uri" data.
* @since_tizen 2.3
*/
enum shortcut_type {
/**< Deprecated type */
- SHORTCUT_PACKAGE = 0x00000000, /**< Launch the package using given pakcage name. */
- SHORTCUT_DATA = 0x00000001, /**< Launch the related package with given data(content_info). */
- SHORTCUT_FILE = 0x00000002, /**< Launch the related package with given filename(content_info). */
+ SHORTCUT_PACKAGE = 0x00000000, /**< Launch the package using the given package name */
+ SHORTCUT_DATA = 0x00000001, /**< Launch the related package with the given data(content_info) */
+ SHORTCUT_FILE = 0x00000002, /**< Launch the related package with the given filename(content_info) */
/**< Use these */
- LAUNCH_BY_PACKAGE = 0x00000000, /**< Launch the package using given pakcage name. */
- LAUNCH_BY_URI = 0x00000001, /**< Launch the related package with given data(URI). */
+ LAUNCH_BY_PACKAGE = 0x00000000, /**< Launch the package using the given package name */
+ LAUNCH_BY_URI = 0x00000001, /**< Launch the related package with the given data(URI) */
SHORTCUT_REMOVE = 0x40000000, /**< Remove a shortcut */
DYNAMICBOX_REMOVE = 0x80000000, /**< Remove a dynamicbox */
- DYNAMICBOX_TYPE_DEFAULT = 0x10000000, /**< Type mask for default dynamicbox */
- DYNAMICBOX_TYPE_EASY_DEFAULT = 0x30000000, /**< Type mask for easy mode dynamicbox */
+ DYNAMICBOX_TYPE_DEFAULT = 0x10000000, /**< Type mask for the default dynamicbox */
+ DYNAMICBOX_TYPE_EASY_DEFAULT = 0x30000000, /**< Type mask for the easy mode dynamicbox */
DYNAMICBOX_TYPE_1x1 = 0x10010000, /**< 1x1 */
DYNAMICBOX_TYPE_2x1 = 0x10020000, /**< 2x1 */
DYNAMICBOX_TYPE_2x2 = 0x10040000, /**< 2x2 */
};
/**
- * @brief Enumeration for values of type of shortcut response.
+ * @brief Enumeration for values of shortcut response types.
* @since_tizen 2.3
*/
enum shortcut_error_e {
SHORTCUT_ERROR_NONE = 0x00000000, /**< Successfully handled */
- SHORTCUT_ERROR = 0x80000000, /**< MSB(1). Check this using SHORTCUT_STATUS_IS_ERROR macro */
- SHORTCUT_ERROR_NO_SPACE = SHORTCUT_ERROR | 0x0001, /**< There is no space to add new shortcut */
+ SHORTCUT_ERROR = 0x80000000, /**< MSB(1). Check this using the #SHORTCUT_STATUS_IS_ERROR macro */
+ SHORTCUT_ERROR_NO_SPACE = SHORTCUT_ERROR | 0x0001, /**< There is no space to add a new shortcut */
SHORTCUT_ERROR_EXIST = SHORTCUT_ERROR | 0x0002, /**< Shortcut is already added */
SHORTCUT_ERROR_FAULT = SHORTCUT_ERROR | 0x0004, /**< Failed to add a shortcut. Unrecoverable error */
SHORTCUT_ERROR_UNSUPPORTED = SHORTCUT_ERROR | 0x0008, /**< Unsupported shortcut */
SHORTCUT_ERROR_BUSY = SHORTCUT_ERROR | 0x0010, /**< Receiver is busy, try again later */
SHORTCUT_ERROR_INVALID_PARAMETER = SHORTCUT_ERROR | 0x0020, /**< Shortcut request is not valid, invalid parameter or invalid argument value */
- SHORTCUT_ERROR_COMM = SHORTCUT_ERROR | 0x0040, /**< Connection is not estabilished. or there is a problem of communication */
- SHORTCUT_ERROR_OUT_OF_MEMORY = SHORTCUT_ERROR | 0x0080, /**< Memory is not enough to handle new request */
- SHORTCUT_ERROR_IO_ERROR = SHORTCUT_ERROR | 0x0100, /**< Unable to access file or DB. Check your resource files */
+ SHORTCUT_ERROR_COMM = SHORTCUT_ERROR | 0x0040, /**< Connection is not established. or there is a problem in the communication */
+ SHORTCUT_ERROR_OUT_OF_MEMORY = SHORTCUT_ERROR | 0x0080, /**< Memory is not enough to handle a new request */
+ SHORTCUT_ERROR_IO_ERROR = SHORTCUT_ERROR | 0x0100, /**< Unable to access the file or DB. Check your resource files */
SHORTCUT_ERROR_PERMISSION_DENIED = SHORTCUT_ERROR | 0x0200, /**< Has no permission to add a shortcut */
SHORTCUT_ERROR_NOT_SUPPORTED = SHORTCUT_ERROR | 0x0400, /**< Shortcut is not supported */
- SHORTCUT_STATUS_CARED = 0x08000000, /**< Shortcut status is already cared. check this using SHORTCUT_STATUS_IS_CARED macro */
+ SHORTCUT_STATUS_CARED = 0x08000000 /**< Shortcut status is already cared. Check this using the #SHORTCUT_STATUS_IS_CARED macro */
};
/**
- * @brief Definition for a macro to check the type.
+ * @brief Definition for a macro to check type.
* @since_tizen 2.3
- * @param[in] type Type of box
+ * @param[in] type The type of box
* @return bool
* @retval true(1) If it is a dynamicbox
- * @retval false(0) if it is not a dynamicbox
+ * @retval false(0) If it is not a dynamicbox
* @see shortcut_type
*/
#define ADD_TO_HOME_IS_DYNAMICBOX(type) (!!((type) & 0x10000000))
/**
* @brief Definition for a macro to check the request status.
* @since_tizen 2.3
- * @param[in] type Status
+ * @param[in] type The status
* @return bool
* @retval true(1) Error
* @retval false(0) Not an error
/**
* @brief Definition for a macro to check the request status.
* @since_tizen 2.3
- * @param[in] type Status
+ * @param[in] type The status
* @return bool
- * @retval true(1) Shortcut request is already handled by requestee (homescreen, viewer, ...)
- * @retval false(0) Request result should be cared by requestor
+ * @retval true(1) Shortcut request is already handled by the requestee (homescreen, viewer, ...)
+ * @retval false(0) Request result should be cared by the requestor
* @see shortcut_error_e
*/
#define SHORTCUT_STATUS_IS_CARED(type) (!!((type) & SHORTCUT_STATUS_CARED))
/**
- * @brief Definition for filtering the pure error code from given status.
+ * @brief Definition for filtering the pure error code from the given status.
* @since_tizen 2.3
- * @param[in] status status
- * @return status code (error)
+ * @param[in] status The status
+ * @return The status code (error)
* @see shortcut_error_e
*/
#define SHORTCUT_ERROR_CODE(status) ((status) & ~SHORTCUT_STATUS_CARED)
* @privlevel public
* @privilege %http://tizen.org/privilege/shortcut
*
- * @param[in] request_cb Callback function pointer which will be invoked when add_to_home is requested
- * @param[in] data Callback data to deliver to the callback function
+ * @param[in] request_cb The callback function pointer that is invoked when add_to_home is requested
+ * @param[in] data The callback data to deliver to the callback function
*
- * @return Return Type (int)
+ * @return The return type (int)
* @retval 0 Callback function is successfully registered
- * @retval <0 Failed to register the callback function for request
+ * @retval <0 Failed to register the callback function for the request
*
* @pre You have to prepare a callback function.
*
* @privlevel public
* @privilege %http://tizen.org/privilege/shortcut
*
- * @remarks If a homescreen does not support this feature, you will get proper error code.
- * @param[in] appid Package name of owner of this shortcut
- * @param[in] name Name for created shortcut icon
- * @param[in] type Type of shortcuts (dynamicbox or shortcut, and its size if it is for the dynamicbox)
- * @param[in] content_info Specific information for delivering to the viewer for creating a shortcut
- * @param[in] icon Absolute path of an icon file
- * @param[in] allow_duplicate set 1 If accept the duplicated shortcut or 0
- * @param[in] result_cb Address of callback function which will be called when the result comes back from the viewer
- * @param[in] data Callback data which will be used in callback function
- *
- * @return Return Type (int)
- * @retval 0 Succeed to send the request
+ * @remarks If a homescreen does not support this feature, you will get a proper error code.
+ * @param[in] appid The package name of the owner of this shortcut
+ * @param[in] name The name of the created shortcut icon
+ * @param[in] type The type of shortcuts (dynamicbox or shortcut, and its size if it is for the dynamicbox)
+ * @param[in] content_info The specific information for delivering to the viewer for creating a shortcut
+ * @param[in] icon The absolute path of an icon file
+ * @param[in] allow_duplicate @c 1 if it accepts the duplicated shortcut,
+ * otherwise @c 0
+ * @param[in] result_cb The address of the callback function that is called when the result comes back from the viewer
+ * @param[in] data The callback data that is used in the callback function
+ *
+ * @return The return type (int)
+ * @retval 0 Succeeded to send the request
* @retval #SHORTCUT_ERROR_FAULT Unrecoverable error
* @retval #SHORTCUT_ERROR_INVALID_PARAMETER Shortcut request is not valid, invalid parameter or invalid argument value
- * @retval #SHORTCUT_ERROR_COMM Connection is not estabilished. or there is a problem of communication
- * @retval #SHORTCUT_ERROR_OUT_OF_MEMORY Memory is not enough to handle new request
- * @retval #SHORTCUT_ERROR_IO_ERROR Unable to access file or DB. Check your resource files
+ * @retval #SHORTCUT_ERROR_COMM Connection is not estabilished. or there is a problem in the communication
+ * @retval #SHORTCUT_ERROR_OUT_OF_MEMORY Memory is not enough to handle a new request
+ * @retval #SHORTCUT_ERROR_IO_ERROR Unable to access the file or DB. Check your resource files
* @retval #SHORTCUT_ERROR_PERMISSION_DENIED Has no permission to add a shortcut
* @retval #SHORTCUT_ERROR_NOT_SUPPORTED Shortcut is not supported
*
* @pre You have to prepare the callback function.
*
- * @post You have to check the return status from callback function which is passed by argument.
+ * @post You have to check the return status from the callback function which is passed by the argument.
*
* @see result_cb_t
*
* @privlevel public
* @privilege %http://tizen.org/privilege/shortcut
*
- * @remarks If a homescreen does not support this feature, you will get proper error code.
- * @param[in] appid Package name
- * @param[in] cb Callback function to get the shortcut item information
- * @param[in] data Callback data which will be used in callback function
+ * @remarks If a homescreen does not support this feature, you will get a proper error code.
+ * @param[in] appid The package name
+ * @param[in] cb The callback function to get the shortcut item information
+ * @param[in] data The callback data that is used in the callback function
*
- * @return Return Type (int)
- * @retval @c N Number of items (call count of callback function)
+ * @return The return type (int)
+ * @retval @c N Number of items (call count of the callback function)
* @retval #SHORTCUT_ERROR_FAULT Unrecoverable error
- * @retval #SHORTCUT_ERROR_IO_ERROR Unable to access file or DB. Check your resource files
+ * @retval #SHORTCUT_ERROR_IO_ERROR Unable to access the file or DB. Check your resource files
*
* @pre You have to prepare the callback function.
*
- * @post You have to check the return status from callback function which is passed by argument.
+ * @post You have to check the return status from the callback function which is passed by the argument.
*
* @see result_cb_t
*/
* @privlevel public
* @privilege %http://tizen.org/privilege/shortcut
*
- * @remarks If a homescreen does not support this feature, you will get proper error code.
- * @param[in] appid Package name of owner of this shortcut
- * @param[in] name Name for created shortcut icon
- * @param[in] type Type of shortcuts (dynamicbox or shortcut, and its size if it is for the dynamicbox)
- * @param[in] content Specific information for delivering to the viewer for creating a shortcut
- * @param[in] icon Absolute path of an icon file
- * @param[in] period Update period
- * @param[in] allow_duplicate Set 1 If accept the duplicated shortcut or 0
- * @param[in] result_cb Address of callback function which will be called when the result comes back from the viewer
- * @param[in] data Callback data which will be used in callback function
- *
- * @return Return Type (int)
- * @retval 0 Succeed to send the request
+ * @remarks If a homescreen does not support this feature, you will get a proper error code.
+ * @param[in] appid The package name of the owner of this shortcut
+ * @param[in] name The name of the created shortcut icon
+ * @param[in] type The type of shortcuts (dynamicbox or shortcut, and its size if it is for the dynamicbox)
+ * @param[in] content_info The specific information for delivering to the viewer for creating a shortcut
+ * @param[in] icon The absolute path of an icon file
+ * @param[in] period The update period
+ * @param[in] allow_duplicate @c 1 if it accepts the duplicated shortcut,
+ * otherwise @c 0
+ * @param[in] result_cb The address of the callback function that is called when the result comes back from the viewer
+ * @param[in] data The callback data that is used in the callback function
+ *
+ * @return The return type (int)
+ * @retval 0 Succeeded to send the request
* @retval #SHORTCUT_ERROR_FAULT Unrecoverable error
* @retval #SHORTCUT_ERROR_INVALID_PARAMETER Shortcut request is not valid, invalid parameter or invalid argument value
- * @retval #SHORTCUT_ERROR_COMM Connection is not estabilished or there is a problem of communication
- * @retval #SHORTCUT_ERROR_OUT_OF_MEMORY Memory is not enough to handle new request
- * @retval #SHORTCUT_ERROR_IO_ERROR Unable to access file or DB Check your resource files
+ * @retval #SHORTCUT_ERROR_COMM Connection is not established or there is a problem in the communication
+ * @retval #SHORTCUT_ERROR_OUT_OF_MEMORY Memory is not enough to handle a new request
+ * @retval #SHORTCUT_ERROR_IO_ERROR Unable to access the file or DB Check your resource files
* @retval #SHORTCUT_ERROR_PERMISSION_DENIED Has no permission to add a shortcut
* @retval #SHORTCUT_ERROR_NOT_SUPPORTED Shortcut is not supported
*
* @pre You have to prepare the callback function.
*
- * @post You have to check the return status from callback function which is passed by argument.
+ * @post You have to check the return status from the callback function which is passed by the argument.
*
* @see result_cb_t
*
projects / platform / core / appfw / shortcut.git / commitdiff