X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fappcore-widget_doc.h;h=0dbc9a90143fdb79d01dd5dd39139a99829d679d;hb=9d143f53708c28c91fe9a308306164b1c961cf19;hp=e9fe5a577e8a5ad5ac6353cbcc4636a2718cea39;hpb=863cdffd0fc19c18462df7a2bfa218cb11887c19;p=platform%2Fcore%2Fappfw%2Fappcore-widget.git diff --git a/doc/appcore-widget_doc.h b/doc/appcore-widget_doc.h index e9fe5a5..0dbc9a9 100755 --- a/doc/appcore-widget_doc.h +++ b/doc/appcore-widget_doc.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. All rights reserved. + * Copyright (c) 2015 - 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. @@ -14,28 +14,26 @@ * limitations under the License. */ + /** - * * @ingroup CAPI_WIDGET_FRAMEWORK * @defgroup CAPI_WIDGET_APP_MODULE Widget Application - * @brief Widget application API - * + * @brief Widget application API. * @section CAPI_WIDGET_APP_MODULE_HEADER Required Header - * \#include - * \#include + * \#include + * \#include + * * @section CAPI_WIDGET_APP_MODULE_OVERVIEW Overview * The @ref CAPI_WIDGET_APP_MODULE API provides functions for handling Tizen widget application state changes or system events. Tizen widget application can be shown in the home screen. - * This APIs support making multiple widget instances per an application. - * + * This API supports making multiple widget instances per an application. * This API provides interfaces for the following categories: - * - Starting or exiting the main event loop - * - Registering callbacks for application state change events - * - Registering callbacks for basic system events - * - Registering callbacks for instance state change events + * - Starting or exiting the main event loop. + * - Registering callbacks for application state change events. + * - Registering callbacks for basic system events. + * - Registering callbacks for instance state change events. * * @subsection CAPI_WIDGET_APP_MODULE_STATE_CHANGE_EVENT Registering Callbacks for Application State Change Events - * As for Tizen widget application states, it is very simple and somewhat similer to Tizen service application states. - * + * As for Tizen widget application states, it is very simple and somewhat similar to Tizen service application states. *

* * @@ -46,7 +44,7 @@ * * * @@ -54,24 +52,23 @@ * * * *
widget_app_create_cb()Hook to take necessary actions before the main event loop starts. * Your UI generation code should be placed here so that you do not miss any events from your application UI. - * Please make sure that you should make a class handle and return it. It will be used when the event for creating widget instance is received. + * Please make sure that you make a class handle and return it. It will be used when the event for creating widget instance is received. * You can initialize shared resources for widget instances in this callback function as well. *
widget_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 that other running applications can fully use these shared resources. *
*

- * * Please refer to the following state diagram to see the possible transitions and callbacks that are called while transition. + * * @image html widget_app_lifecycle.png "Widget Application States" * * @subsection CAPI_WIDGET_APP_MODULE_SYSTEM_EVENT Registering Callbacks for System Events - * Tizen widget applications can receive system events with widget_app_add_event_handler() api. + * Tizen widget applications can receive system events with widget_app_add_event_handler() API. * The type of system events that can be received are same as Tizen UI applications except for APP_EVENT_DEVICE_ORIENTATION_CHANGED. * See @ref CAPI_APPLICATION_MODULE. * The event for APP_EVENT_DEVICE_ORIENTATION_CHANGED is not supported in this module. - * + * @subsection CAPI_WIDGET_APP_INSTNACE_STATE_CHANGE_EVENT Registering callbacks for instance state change events - * As for Tizen widget instance states, it is somewhat similer to Tizen application states. - * + * As for Tizen widget instance states, it is somewhat similar to Tizen application states. *

* * @@ -82,7 +79,7 @@ * * * * @@ -117,13 +114,11 @@ * *
widget_instance_create_cb() Called after widget instance is created. * In this callback, you can initialize resources for this instance. - * If parameter 'content' is not NULL, You should restore the pervious status. + * If parameter 'content' is not NULL, you should restore the previous status. *
*

- * * Please refer to the following state diagram to see the possible transitions and callbacks that are called while transition. + * * @image html widget_obj_lifecycle.png "Widget Instance States" * * @section CAPI_WIDGET_APP_MODULE_RELATED_FEATURES Related Features * This API is related with the following feature: * - http://tizen.org/feature/shell.appwidget - * - * */