diff options
author | SukhyungKang <shine.kang@samsung.com> | 2024-08-26 11:06:17 +0900 |
---|---|---|
committer | SukhyungKang <shine.kang@samsung.com> | 2024-08-26 11:06:17 +0900 |
commit | caaf00afbb3fb9d6ba7e810ec88065caf1ffdb81 (patch) | |
tree | c304ab738304aaeaacb9a07ee4eb7f567b01d9ea | |
parent | f52be3ff62c55269912c5070ab8a850ee4a90665 (diff) | |
download | widget-service-caaf00afbb3fb9d6ba7e810ec88065caf1ffdb81.tar.gz widget-service-caaf00afbb3fb9d6ba7e810ec88065caf1ffdb81.tar.bz2 widget-service-caaf00afbb3fb9d6ba7e810ec88065caf1ffdb81.zip |
Fix documentation for widget service
Change-Id: I61e2861b3817898bba3deb00992604c9459a659b
Signed-off-by: SukhyungKang <shine.kang@samsung.com>
-rwxr-xr-x | doc/widget_service_doc.h | 151 |
1 files changed, 78 insertions, 73 deletions
diff --git a/doc/widget_service_doc.h b/doc/widget_service_doc.h index 43fe859..6a3fc55 100755 --- a/doc/widget_service_doc.h +++ b/doc/widget_service_doc.h @@ -47,82 +47,87 @@ * @defgroup CAPI_WIDGET_SERVICE_MODULE Widget Service * @brief To get the information of installed widgets. * @section CAPI_WIDGET_SERVICE_MODULE_HEADER Required Header - * \#include <widget_service.h> - * \#include <widget_errno.h> + * \#include <widget_service.h>\n + * \#include <widget_errno.h>\n + * + * @section CAPI_WIDGET_SERVICE_MODULE_OVERVIEW Overview + * <H1>1. widget service API</H1> + * Tizen supports various kinds of APIs set for retrieving information of widgets. + * Every widgets are installed via package manager utilities. + * The information of installed widgets are stored in the system DB. + * In some cases, application developer needs to send update request to some widgets. + * To make it possible, this module provides related API set. + * But the API will only works if the widget and application are packaged in one. + * <H2>1.1 APIs for retrieving information of widgets</H2> + * To get the information for installed widgets. + * <H2>1.2 APIs for communicating with running widget instances</H2> + * To trigger the update event or send the updated content string to the widget. + * <H1>2. Size of widget</H1> + * Widget has predefined size types. + * 1x1 is a square so its pixel size of width and height must has to be same. + * 2x2, 4x4 also square. + * 2x1, 4x1, 4x2, 4x3 is a rectangle. so its pixel size of width & height should not be same. + * pixel size of width should be long than height. + * Pixel size can be differ between different devices. + * It depends on its screen resolution. + * So widget developer should care various kinds of devices (has different screen resolution). + * <TABLE> + * <TR> + * <TD>Size Type</TD><TD>Size in pixels</TD><TD>Supported profile</TD> + * </TR> + * <TR> + * <TD>#WIDGET_SIZE_TYPE_1x1</TD><TD> - (SQUARE, depends on screen resolution) </TD><TD>No profile - This size type is not used. just defined for specifying a default cell size</TD> + * </TR> + * <TR> + * <TD>#WIDGET_SIZE_TYPE_2x1</TD><TD> - (RECTANGLE, depends on screen resolution) </TD><TD>Mobile</TD> + * </TR> + * <TR> + * <TD>#WIDGET_SIZE_TYPE_2x2</TD><TD> - (SQUARE, depends on screen resolution) </TD><TD>Mobile, Wearable (Default size)</TD> + * </TR> + * <TR> + * <TD>#WIDGET_SIZE_TYPE_4x1</TD><TD> - (RECTANGLE, depends on screen resolution) </TD><TD>Mobile</TD> + * </TR> + * <TR> + * <TD>#WIDGET_SIZE_TYPE_4x2</TD><TD> - (RECTANGLE, depends on screen resolution) </TD><TD>Mobile</TD> + * </TR> + * <TR> + * <TD>#WIDGET_SIZE_TYPE_4x3</TD><TD> - (RECTANGLE, depends on screen resolution) </TD><TD>Mobile</TD> + * </TR> + * <TR> + * <TD>#WIDGET_SIZE_TYPE_4x4</TD><TD> - (SQUARE, depends on screen resolution) </TD><TD>Mobile</TD> + * </TR> + * </TABLE> + * Widget also works for Easy Mode. + * For the Easy Mode, there are different size types. + * Called WIDGET_SIZE_TYPE_EASY_NxM + * <TABLE> + * <TR> + * <TD>Size Type</TD><TD>Size in pixels</TD><TD>Supported profile</TD> + * </TR> + * <TR> + * <TD>#WIDGET_SIZE_TYPE_EASY_1x1</TD><TD> - (SQUARE, depends on screen resolution) </TD><TD>Mobile</TD> + * </TR> + * <TR> + * <TD>#WIDGET_SIZE_TYPE_EASY_3x1</TD><TD> - (RECTANGLE, depends on screen resolution) </TD><TD>Mobile</TD> + * </TR> + * <TR> + * <TD>#WIDGET_SIZE_TYPE_EASY_3x3</TD><TD> - (SQUARE - depends on screen resolution) </TD><TD>Mobile</TD> + * </TR> + * </TABLE> + * However the Easy Mode is not a mandatory requirements for viewer application development. + * So you will not be able to create your widgets using Easy Mode size types. + * But if you are developing the homescreen(or application which is related with widgets displaying), + * You should care these types too. * * @section CAPI_WIDGET_SERVICE_MODULE_FEATURE Related Features - * This API is related with the following feature: - * - %http://tizen.org/feature/shell.appwidget + * This function is related with the following feature: + * - %http://tizen.org/feature/shell.appwidget\n * - * @section CAPI_WIDGET_SERVICE_MODULE_OVERVIEW Overview - <H1>1. widget service API</H1> - Tizen supports various kinds of APIs set for retrieving information of widgets. - Every widgets are installed via package manager utilities. - The information of installed widgets are stored in the system DB. - In some cases, application developer needs to send update request to some widgets. - To make it possible, this module provides related API set. - But the API will only works if the widget and application are packaged in one. - <H2>1.1 APIs for retrieving information of widgets</H2> - To get the information for installed widgets. - <H2>1.2 APIs for communicating with running widget instances</H2> - To trigger the update event or send the updated content string to the widget. - <H1>2. Size of widget</H1> - Widget has predefined size types. - 1x1 is a square so its pixel size of width and height must has to be same. - 2x2, 4x4 also square. - 2x1, 4x1, 4x2, 4x3 is a rectangle. so its pixel size of width & height should not be same. - pixel size of width should be long than height. - Pixel size can be differ between different devices. - It depends on its screen resolution. - So widget developer should care various kinds of devices (has different screen resolution). - <TABLE> - <TR> - <TD>Size Type</TD><TD>Size in pixels</TD><TD>Supported profile</TD> - </TR> - <TR> - <TD>#WIDGET_SIZE_TYPE_1x1</TD><TD> - (SQUARE, depends on screen resolution) </TD><TD>No profile - This size type is not used. just defined for specifying a default cell size</TD> - </TR> - <TR> - <TD>#WIDGET_SIZE_TYPE_2x1</TD><TD> - (RECTANGLE, depends on screen resolution) </TD><TD>Mobile</TD> - </TR> - <TR> - <TD>#WIDGET_SIZE_TYPE_2x2</TD><TD> - (SQUARE, depends on screen resolution) </TD><TD>Mobile, Wearable (Default size)</TD> - </TR> - <TR> - <TD>#WIDGET_SIZE_TYPE_4x1</TD><TD> - (RECTANGLE, depends on screen resolution) </TD><TD>Mobile</TD> - </TR> - <TR> - <TD>#WIDGET_SIZE_TYPE_4x2</TD><TD> - (RECTANGLE, depends on screen resolution) </TD><TD>Mobile</TD> - </TR> - <TR> - <TD>#WIDGET_SIZE_TYPE_4x3</TD><TD> - (RECTANGLE, depends on screen resolution) </TD><TD>Mobile</TD> - </TR> - <TR> - <TD>#WIDGET_SIZE_TYPE_4x4</TD><TD> - (SQUARE, depends on screen resolution) </TD><TD>Mobile</TD> - </TR> - </TABLE> - Widget also works for Easy Mode. - For the Easy Mode, there are different size types. - Called WIDGET_SIZE_TYPE_EASY_NxM - <TABLE> - <TR> - <TD>Size Type</TD><TD>Size in pixels</TD><TD>Supported profile</TD> - </TR> - <TR> - <TD>#WIDGET_SIZE_TYPE_EASY_1x1</TD><TD> - (SQUARE, depends on screen resolution) </TD><TD>Mobile</TD> - </TR> - <TR> - <TD>#WIDGET_SIZE_TYPE_EASY_3x1</TD><TD> - (RECTANGLE, depends on screen resolution) </TD><TD>Mobile</TD> - </TR> - <TR> - <TD>#WIDGET_SIZE_TYPE_EASY_3x3</TD><TD> - (SQUARE - depends on screen resolution) </TD><TD>Mobile</TD> - </TR> - </TABLE> - However the Easy Mode is not a mandatory requirements for viewer application development. - So you will not be able to create your widgets using Easy Mode size types. - But if you are developing the homescreen(or application which is related with widgets displaying), - You should care these types too. + * It is recommended to design feature related codes in your application for reliability.\n + * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n + * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n + * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a> */ -#endif +#endif /* __WIDGET_SERVICE_DOC_H__ */ |