From: SukhyungKang Date: Mon, 26 Aug 2024 02:06:17 +0000 (+0900) Subject: Fix documentation for widget service X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fheads%2Ftizen_8.0;p=platform%2Fcore%2Fappfw%2Fwidget-service.git Fix documentation for widget service Change-Id: I61e2861b3817898bba3deb00992604c9459a659b Signed-off-by: SukhyungKang --- 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 - * \#include + * \#include \n + * \#include \n + * + * @section CAPI_WIDGET_SERVICE_MODULE_OVERVIEW Overview + *

1. widget service API

+ * 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. + *

1.1 APIs for retrieving information of widgets

+ * To get the information for installed widgets. + *

1.2 APIs for communicating with running widget instances

+ * To trigger the update event or send the updated content string to the widget. + *

2. Size of widget

+ * 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). + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + *
Size TypeSize in pixelsSupported profile
#WIDGET_SIZE_TYPE_1x1 - (SQUARE, depends on screen resolution) No profile - This size type is not used. just defined for specifying a default cell size
#WIDGET_SIZE_TYPE_2x1 - (RECTANGLE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_2x2 - (SQUARE, depends on screen resolution) Mobile, Wearable (Default size)
#WIDGET_SIZE_TYPE_4x1 - (RECTANGLE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_4x2 - (RECTANGLE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_4x3 - (RECTANGLE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_4x4 - (SQUARE, depends on screen resolution) Mobile
+ * Widget also works for Easy Mode. + * For the Easy Mode, there are different size types. + * Called WIDGET_SIZE_TYPE_EASY_NxM + * + * + * + * + * + * + * + * + * + * + * + * + * + *
Size TypeSize in pixelsSupported profile
#WIDGET_SIZE_TYPE_EASY_1x1 - (SQUARE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_EASY_3x1 - (RECTANGLE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_EASY_3x3 - (SQUARE - depends on screen resolution) Mobile
+ * 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 -

1. widget service API

- 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. -

1.1 APIs for retrieving information of widgets

- To get the information for installed widgets. -

1.2 APIs for communicating with running widget instances

- To trigger the update event or send the updated content string to the widget. -

2. Size of widget

- 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). - - - - - - - - - - - - - - - - - - - - - - - - - -
Size TypeSize in pixelsSupported profile
#WIDGET_SIZE_TYPE_1x1 - (SQUARE, depends on screen resolution) No profile - This size type is not used. just defined for specifying a default cell size
#WIDGET_SIZE_TYPE_2x1 - (RECTANGLE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_2x2 - (SQUARE, depends on screen resolution) Mobile, Wearable (Default size)
#WIDGET_SIZE_TYPE_4x1 - (RECTANGLE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_4x2 - (RECTANGLE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_4x3 - (RECTANGLE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_4x4 - (SQUARE, depends on screen resolution) Mobile
- Widget also works for Easy Mode. - For the Easy Mode, there are different size types. - Called WIDGET_SIZE_TYPE_EASY_NxM - - - - - - - - - - - - - -
Size TypeSize in pixelsSupported profile
#WIDGET_SIZE_TYPE_EASY_1x1 - (SQUARE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_EASY_3x1 - (RECTANGLE, depends on screen resolution) Mobile
#WIDGET_SIZE_TYPE_EASY_3x3 - (SQUARE - depends on screen resolution) Mobile
- 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 Feature Element. */ -#endif +#endif /* __WIDGET_SERVICE_DOC_H__ */