summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorJinkun Jang <jinkun.jang@samsung.com>2013-03-13 01:46:42 +0900
committerJinkun Jang <jinkun.jang@samsung.com>2013-03-13 01:46:42 +0900
commit7596e199c101a324ac0bbab1be727962fe0ebf07 (patch)
treecc97cc634e3234446670bc6c7d455bd1be5dd806 /include
parentc3875cbe2f8e945b837a76ac5f8e6d57bde940bb (diff)
downloadui-gadget-1-7596e199c101a324ac0bbab1be727962fe0ebf07.tar.gz
ui-gadget-1-7596e199c101a324ac0bbab1be727962fe0ebf07.tar.bz2
ui-gadget-1-7596e199c101a324ac0bbab1be727962fe0ebf07.zip
Tizen 2.1 base
Diffstat (limited to 'include')
-rwxr-xr-xinclude/SLP_UI_Gadget_PG.h895
-rw-r--r--include/ug-dbg.h37
-rw-r--r--include/ug-engine.h36
-rwxr-xr-xinclude/ug-manager.h49
-rw-r--r--include/ug-module.h36
-rwxr-xr-xinclude/ug.h76
-rwxr-xr-xinclude/ui-gadget-engine.h69
-rwxr-xr-xinclude/ui-gadget-module.h169
-rwxr-xr-xinclude/ui-gadget.h750
9 files changed, 2117 insertions, 0 deletions
diff --git a/include/SLP_UI_Gadget_PG.h b/include/SLP_UI_Gadget_PG.h
new file mode 100755
index 0000000..70387f2
--- /dev/null
+++ b/include/SLP_UI_Gadget_PG.h
@@ -0,0 +1,895 @@
+/*
+ * UI Gadget
+ *
+ * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved.
+ *
+ * Contact: Jayoun Lee <airjany@samsung.com>, Jinwoo Nam <jwoo.nam@samsung.com>
+ *
+ * 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.
+ *
+ */
+
+/**
+ *
+ * @ingroup SLP_PG
+ * @defgroup SLP_PG_UI_GADGET UI gadget library
+ * @{
+
+<h1 class="pg">Introduction</h1>
+<h2 class="pg">Purpose of this document</h2>
+The purpose of this document is to describe how to develop/use UI gadget. This document gives programming guidelines to UI gadget devlopers and users.
+<h2 class="pg">Scope</h2>
+The scope of this document is limited to UI gadget component interface and API usage.
+
+<h1 class="pg">UI gadget architecture</h1>
+<h2 class="pg">UI gadget</h2>
+An UI gadget is a visual component providing views (or features) of other applications, e.g., contact, image viewer. Because UI gadgets are supposed to deliver most commonly used features that the platform can natively support, developers can avoid unnecessary massive code writing using UI gadgets. Hence an UI gadget eventually includes logics to handle simple request. UI gadget is able to be managed by UI gadget library.
+\image html SLP_UI_Gadget_PG_image00.png "Picture 1. UI gadget architecture diagram"
+
+<h2 class="pg">UI gadget features</h2>
+UI Gadget Library has the following features:
+- It provides component interfaces for UI Gadget
+- It manages UI gadget instances in an application according to their lifecycle
+
+<h2 class="pg">Lifecycle</h2>
+Essentially, an UI gadget has following five states (See Picture 2)
+- The initial state is \b Ready
+- If an UI gadget has been created, it is \b Created
+- If an UI gadget has been started, it is \b Running
+- If the application that is using an UI gadget is put into background, it is \b Stopped
+- If an UI gadget has been destroyed, it is \b Destroyed
+
+An UI gadget has five callback methods that you can implement to perform operations when the UI gadget moves between states
+- When an UI gadget is created, \b create() is invoked
+- When an UI gadget is started, \b start() is invoked
+- When the application that is using an UI gadget is put into background, \b pause() is invoked
+- When the application that is using an UI gadget is brought to the foreground, \b resume() is invoked.
+- When an UI gadget is destroyed, \b destroy() is invoked
+
+In addition, an UI gadget has callback methods for system events and message:
+- When an system event is generated, event() is invoked
+- When an UI gadget receives message from the caller, message() is invoked
+
+\image html SLP_UI_Gadget_PG_image01.png "Picture 2. UI gadget state diagram"
+
+<h2 class="pg">Management</h2>
+UI gadgets in an application are managed as a TREE structure (See Picture 3.) The features for the tree are:
+- Root of the tree is the UI gadget manager
+- UI gadget caller is parent of callees
+- Parents arrange the layout of their children
+
+Every application which is using UI gadgets has one UI gadget manager as a root of the tree. And the UI gadget manager propagates system events and task management events by post-order traversal. Available system events are <i>low memory, low battery, language changed, region changed and window rotate event</i>. And task management events are <i>pause and resume</i>.
+
+\image html SLP_UI_Gadget_PG_image02.png "Picture 3. UI gadget management policy"
+
+<h1 class="pg">Getting started</h1>
+<h2 class="pg">Overview</h2>
+For using UI gadget, you need to know the working procedure between caller and UI gadget module.<br><br>
+As an UI gadget module developer, the operations of UI gadget module are very important. These operations are called by UI gadget library when the caller requests something to UI gadget module and UI gadget module performs a proper job mainly related with lifecycle. “Section How to make UI gadget” describes detail of each operation.<br><br>
+As an UI gadget caller, you need to know the APIs for using UI gadget module and callback functions for dealing with UI gadget module. The caller can create UI gadget module using ug_create() API and have right to arrange layout of UI gadget module and destroy UI gadget module. These are performed by caller when caller requests something to UI gadget library and related callback functions are called by UI gadget library. “Section How to use UI gadget” describes detail of each APIs and callback functions.
+<h2 class="pg">How to make UI gadget</h2>
+In this section, we are going to write your first UI gadget called "helloUG-efl". Before we get started, make sure you have read the overview, especially, lifecycle section. We will mainly deal with the operations of lifecycle.
+
+\note <b>Sample codes</b> are included in the UI gadget source package. The samples for UI gadget developers are located in "samples/helloUG-efl/", and the samples for UI gadget users are in "samples/ugcaller/."
+
+<br>
+<h3 class="pg">UI gadget template</h3>
+To create an UI gadget, start by generating boilerplate code using UI gadget template as follow:
+@verbatim
+# ug-gen.sh helloUG-efl helloUG-efl EFL
+@endverbatim
+
+\note <b>How to install UI gadget template:</b>
+@verbatim
+# unrpm ui-gadget-template-xxx.rpm
+# or
+# rpm -Uvh ui-gadget-templat-xxx.rpm
+@endverbatim
+
+\note <b>How to use UI gadget template:</b>
+@verbatim
+# ug-gen.sh [destination] [name] [UI library]
+@endverbatim
+- destination: destination directory
+- name: UI gadget name
+- UI library: UI library to use. Only EFL is available for now
+
+After you generate code, you get following files:
+- <i>helloUG-efl.c</i> (Source)
+- <i>helloUG-efl.h</i> (Private header)
+- <i>CMakeList.txt</i> (Build script)
+- <i>po/*</i> (I18N files)
+
+<i>helloUG-efl.c</i> contains base code, and the most important parts are <i>UG_MODULE_INIT</i> and <i>UG_MODULE_EXIT</i> which are symbols to export for dynamic linking. <i>UG_MODULE_INIT</i> is invoked when the UI gadget is loading, and it sets operations, private data, and the option. <i>UG_MODULE_EXIT</i> is invoked when the UI gadget is unloading, and it clears private data.<br><br>
+Even if you don't understand generated code right now, don't worry about it. What you have to do is just implementation of operations according to their role (see next section.)
+@code
+// in helloUG-efl.c
+UG_MODULE_API int UG_MODULE_INIT(struct ug_module_ops *ops)
+{
+ struct ug_data *ugd; // User defined private data
+
+ if (!ops)
+ return -1;
+
+ ugd = calloc(1, sizeof(struct ug_data));
+ if (!ugd)
+ return -1;
+
+ // create operation
+ ops->create = on_create;
+ // start operation
+ ops->start = on_start;
+ // pause operation
+ ops->pause = on_pause;
+ // resume operation
+ ops->resume = on_resume;
+ // destroy operation
+ ops->destroy = on_destroy;
+ // message operation
+ ops-> message = on_message;
+ // event operation
+ ops->event = on_event;
+ // private data
+ ops->priv = ugd;
+ // option
+ ops->opt = UG_OPT_INDICATOR_ENABLE;
+
+ return 0;
+}
+
+UG_MODULE_API void UG_MODULE_EXIT(struct ug_module_ops *ops)
+{
+ struct ug_data *ugd;
+
+ if (!ops)
+ return;
+
+ ugd = ops->priv;
+ if (ugd)
+ free(ugd); // clear private data
+}
+
+@endcode
+
+\note <b>struct ug_module_ops</b> is a data structure describing operations, private data, and the option of UI gadget:
+@code
+struct ug_module_ops {
+ void *(*create)(ui_gadget_h ug, enum ug_mode mode, service_h service, void *priv);
+ void (*start)(ui_gadget_h ug, service_h service, void *priv);
+ void (*pause)(ui_gadget_h ug, service_h service, void *priv);
+ void (*resume)(ui_gadget_h ug, service_h service, void *priv);
+ void (*destroy)(ui_gadget_h ug, service_h service, void *priv);
+ void (*message)(ui_gadget_h ug, service_h *msg, service_h service, void *priv);
+ void (*event)(ui_gadget_h ug, enum ug_event event, service_h service, void *priv);
+ void *reserved[5];
+ void *priv;
+ enum ug_option opt;
+};
+@endcode
+
+\note <b>enum ug_option</b> is UI gadget options, available options are:
+@code
+// Enable indicator
+UG_OPT_INDICATOR_ENABLE
+// Enable indicator with portrait window
+UG_OPT_INDICATOR_PORTRAIT_ONLY
+// Enable indicator with landscape window
+UG_OPT_INDICATOR_LANDSCAPE_ONLY
+// Disable indicator
+UG_OPT_INDICATOR_DISABLE
+// current indicator status will be held
+UG_OPT_INDICATOR_MANUAL
+// Enable indicator overlap
+UG_OPT_OVERLAP_ENABLE
+@endcode
+
+\note <b>struct ug_data</b> is a user defined private data structure describing base layout, own UI gadget handler, and whatever you need:
+@code
+struct ug_data {
+ Evas_Object *base;
+ ui_gadget_h ug;
+
+ // PUT WHATEVER YOU NEED
+}
+@endcode
+
+<br>
+<h3 class="pg">Operations</h3>
+There are five state operations, a message operation, and an event operation: <i>create, start, pause, resume, destroy, message, and event.</i>
+<br><br>
+When "helloUG-efl" is created, the create operation is invoked (See Picture 2-1).<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-1.png "Picture 2-1. Create operation of UI gadget module"
+
+The implementation of create operation is <b>on_create()</b>. Basically, in the operation, we have to make a base layout and return it. Hence, we made base layout using <i>"window layout winset."</i> In case of fullview, we let indicator area be shown, otherwise, we don't (see <i>create_fullview()</i> and <i>create_frameview()</i>.) In addition, in the base layout, we put a box including a label and two buttons (see <i>create_content()</i>.) The label is labeled "Hello UI Gadget." And the first button, labeled "Send result", is for sending result to the "helloUG-efl" caller. The other button, labeled "Back", is for sending destroy request to the caller. For more information about two buttons, please see <i>Send results and request to destroy section</i>.
+
+\note <b>Arguments:</b> All operations receive servive type data which is named <i>service</i> (see \ref service_PG "Tizen Managed APi Reference Guide > Application Framework -> Application") And the argument <i>service</i> is automatically released by UI gadget manager after the UI gadget is destroyed.
+
+@code
+// in helloUG-efl.c
+static void *on_create(ui_gadget_h ug, enum ug_mode mode, service_h service, void *priv)
+{
+ Evas_Object *parent;
+ Evas_Object *content;
+ struct ug_data *ugd;
+
+ if (!ug || !priv)
+ return NULL;
+
+ ugd = priv;
+ ugd->ug = ug;
+
+ parent = ug_get_parent_layout(ug);
+ if (!parent)
+ return NULL;
+
+ if (mode == UG_MODE_FULLVIEW)
+ ugd->base = create_fullview(parent, ugd);
+ else
+ ugd->base = create_frameview(parent, ugd);
+
+ if (ugd->base) {
+ content = create_content(parent, ugd);
+ elm_layout_content_set(ugd->base, "elm.swallow.content", content);
+ }
+ return ugd->base;
+}
+
+static Evas_Object *create_fullview(Evas_Object *parent, struct ug_data *ugd)
+{
+ Evas_Object *base;
+
+ base = elm_layout_add(parent);
+ if (!base)
+ return NULL;
+ elm_layout_theme_set(base, "layout", "application", "default");
+ // In case of fullview, show indicator area
+ edje_object_signal_emit(_EDJ(base), "elm,state,show,indicator", "elm");
+ edje_object_signal_emit(_EDJ(base), "elm,state,show,content", "elm");
+
+ return base;
+}
+
+static Evas_Object *create_frameview(Evas_Object *parent, struct ug_data *ugd)
+{
+ Evas_Object *base;
+
+ base = elm_layout_add(parent);
+ if (!base)
+ return NULL;
+
+ elm_layout_theme_set(base, "layout", "application", "default");
+ // In case of frameview, do not show indicator area
+ edje_object_signal_emit(_EDJ(base), "elm,state,show,content", "elm");
+
+ return base;
+}
+
+static Evas_Object *create_content(Evas_Object *parent, struct ug_data *ugd)
+{
+ Evas_Object *bx, *eo;
+
+ // add box
+ bx = elm_box_add(parent);
+
+ // add label and pack it in the box
+ eo = elm_label_add(parent);
+ elm_object_text_set(eo, _("Hello UI Gadget"));
+ evas_object_size_hint_align_set(eo, 0.5, EVAS_HINT_FILL);
+ evas_object_size_hint_weight_set(eo, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+ evas_object_show(eo);
+ elm_box_pack_end(bx, eo);
+
+ // add buttons and pack it in the box
+ eo = elm_button_add(parent);
+ elm_object_text_set(eo, _("Send result"));
+ evas_object_size_hint_align_set(eo, EVAS_HINT_FILL, EVAS_HINT_FILL);
+ evas_object_smart_callback_add(eo, "clicked", result_cb, ugd);
+ elm_object_style_set(eo, "bottom_btn");
+
+ evas_object_show(eo);
+ elm_box_pack_end(bx, eo);
+
+ eo = elm_button_add(parent);
+ elm_object_text_set(eo, _("Back"));
+ evas_object_size_hint_align_set(eo, EVAS_HINT_FILL, EVAS_HINT_FILL);
+ evas_object_smart_callback_add(eo, "clicked", back_cb, ugd);
+ elm_object_style_set(eo, "bottom_btn");
+
+ evas_object_show(eo);
+ elm_box_pack_end(bx, eo);
+ return bx;
+}
+
+@endcode
+
+When "helloUG-efl" starts, the start operation is invoked (See Picture 2-2).<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-2.png "Picture 2-2. Start operation of UI gadget module"
+
+The implementation of start operation is <b>on_start()</b>. Usually every job would be completed before this operation, so just describe additional job you need to do in this operation.
+
+@code
+// in helloUG-efl.c
+static void on_start(ui_gadget_h ug, service_h service, void *priv)
+{
+
+}
+@endcode
+
+When "helloUG-efl" is destroyed, the destroy operation is invoked(See Picture 2-3). Ui gadget cannot destroy itself, so it moust be destroyed by caller using ug_destroy().<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-3.png "Picture 2-3. Destroy operation of UI gadget module"
+
+The implementation of destroy operation is <b>on_destroy()</b>. We usually release the resources that have been used. In the following method, we delete base layout:
+
+@code
+// in helloUG-efl.c
+static void on_destroy(ui_gadget_h ug, service_h service, void *priv)
+{
+ struct ug_data *ugd;
+
+ if (!ug || !priv)
+ return;
+
+ ugd = priv;
+
+ evas_object_del(ugd->base);
+ ugd->base = NULL;
+}
+@endcode
+
+When the application using "helloUG-efl" is put into background, the pause operation is invoked (See Picture 2-4). But UI gadget could get state only from caller, so pause operation (e.g., on_pause) is called by caller using ug_pause().<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-4.png "Picture 2-4. Pause operation of UI gadget module"
+
+When the application is brought to the foreground, the resume operation is invoked (See Picture 2-5). Resume operation (e.g.,on_resume) is called by caller using ug_resume().<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-5.png "Picture 2-5. Resume operation of UI gadget module"
+
+Besides, when an UI gadget receives message from its caller suing ug_send_message(), the message operation(e.g., on_message) is invoked (See Picture 2-6).<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-6.png "Picture 2-6. Send message to UI gadget module"
+
+And when a system event is generated and UI gadget receives event from caller using ug_send_event(), the event operation(e.g., on_event) is invoked (See Picture 2-7).<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-7.png "Picture 2-7. Send system event to UI gadget module"
+
+The implementation of pause, resume, message, and event operations are on_pause(), on_resume(), on_message(), and on_event(). In on_pause() and on_resume(), you can describe actions performed when a state is changed to pause or resume. For example, music player UI gadget can stop playing music or restart playing music in these operations. In on_message(), you can get service type data from caller and deal with it. In on_event(), you can describe a proper job related to the passed system event.
+
+@code
+// in helloUG-efl.c
+static void on_pause(ui_gadget_h ug, service_h service, void *priv)
+{
+ // Do what you need to do when paused.
+}
+static void on_resume(ui_gadget_h ug, service_h service, void *priv)
+{
+ // Do what you need to do when paused.
+}
+
+static void on_message(ui_gadget_h ug, service msg, service_h service, void *priv)
+{
+ // Do what you need to do when paused.
+}
+
+static void on_event(ui_gadget_h ug, enum ug_event event, service_h service, void *priv)
+{
+ switch (event) {
+ case UG_EVENT_LOW_MEMORY:
+ break;
+ case UG_EVENT_LOW_BATTERY:
+ break;
+ case UG_EVENT_LANG_CHANGE:
+ break;
+ case UG_EVENT_ROTATE_PORTRAIT:
+ break;
+ case UG_EVENT_ROTATE_PORTRAIT_UPSIDEDOWN:
+ break;
+ case UG_EVENT_ROTATE_LANDSCAPE:
+ break;
+ case UG_EVENT_ROTATE_LANDSCAPE_UPSIDEDOWN:
+ break;
+ case UG_EVENT_REGION_CHANGE:
+ break;
+ default:
+ break;
+ }
+}
+@endcode
+
+\warning Message data of message operation is service type data, named <i>msg.</i> <b>Because the message data is released after message operation is finished,</b> if you want to keep using it, please use <b>service_clone()()</b> which duplicates given service data (see \ref service_PG "Tizen Managed API Reference Guide")
+
+<br>
+<h3 class="pg">Send results and destroy request</h3>
+Usually, an UI gadget needs to send results or destroy request to the UI gadget caller.<br><br>
+To send result, use <b>ug_send_result()</b>, then UG library calls result callback function registered by caller (See Picture 2-8)(See <i>API reference guide</i>).<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-8.png "Picture 2-8. Send result"
+
+And to send the destroy request, use <b>ug_destroy_me().</b>(), then UG library calls destroy callback function registered by caller (See Picture 2-9) (See <i>API reference quide</i>).<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-9.png "Picture 2-9. UI gadget destroy request"
+
+We use service library for composing result data. The service provides us a few APIs to make a list of dictionary data that consists of key and value. (ex. {"name" "John Doe"}) To get more information of service, please see \ref service_PG "Tizen Managed API Reference Guide".
+
+\warning After send your result data, you have to release it using <b>service_destroy()</b> API.
+
+In our "helloUG-efl", we made two buttons for sending results and destroy request as below:
+@code
+// in helloUG-efl.c
+
+//Include to use service APIs
+#include <app.h>
+
+static void result_cb(void *data, Evas_Object *obj, void *event_info)
+{
+ service_h result;
+ struct ug_data *ugd;
+ int ret;
+
+ if (!data)
+ return;
+
+ ugd = data;
+
+ ret = service_create(&result);
+
+ service_add_extra_data(result, "name", "hello-UG");
+ service_add_extra_data(result, "description", "sample UI gadget");
+
+ ug_send_result(ugd->ug, result);
+
+ // release service
+ service_destroy(result);
+}
+
+static void back_cb(void *data, Evas_Object *obj, void *event_info)
+{
+ struct ug_data *ugd;
+ int i;
+
+ if (!data)
+ return;
+
+ ugd = data;
+
+ //Send destroy request
+ ug_destroy_me(ugd->ug);
+}
+@endcode
+
+\note <b>To use service</b>
+- Install capi-appfw-application-dev package (add in your RPM spec file)
+- Modify CMakeFile.txt to use capi package as follow:
+@code
+ …
+ pkg_check_modules(pkgs REQUIRED elementary ui-gadget-1 capi-appfw-application)
+ …
+@endcode
+
+<br>
+<h3 class="pg">Internationalization</h3>
+Basically, we use <b><i>dgettext</i></b> for translating a text string into the user's native language because each UI gadget uses different textdomain.
+@code
+// in helloUG-efl.h
+#define PKGNAME "ug-helloUG-efl"
+#define _(s) dgettext(PKGNAME, s)
+#define dgettext_noop(s) (s)
+#define N_(s) dgettext_noop(s)
+@endcode
+
+The PKGNAME is textdomain of "helloUG-efl", and _() is a dgettext wrapper, and N_() is dummy macro. In addition, _() and N_() are additional keywords for marking translatable string for xgettext. Especially, N_() is a dummy keyword for special case as follow:
+@code
+static const char *message[] = {
+ N_("translatable string"),
+};
+@endcode
+
+For more information, please see <a href="http://www.gnu.org/software/gettext/manual/gettext.html">GNU gettext utilities</a>.
+
+\note <b>xgettext</b> extracts gettext strings from given input files. The canonical keyword for marking translatable strings is 'gettext'. For convenience, many packages use '_' as a keyword instead of 'gettext', and write '_("translatable string")' instead of 'gettext("translatable string")'.
+
+<br>
+<h3 class="pg">Rotation and indicator</h3>
+When the UI gadget is created as fullview, we have to consider whether the indicator is shown or not. For instance, "Image viewer" shows the indicator on the portrait mode but not on the landscape mode. Hence, we provided option field named <i>opt</i> of <i>struct ug_module_ops</i> in UG_MODULE_INIT.
+Available options are as following:
+- UG_OPT_INDICATOR_ENABLE (default)
+- UG_OPT_INDICATOR_POTRAIT_ONLY
+- UG_OPT_LANDSCAPE_ONLY
+- UG_OPT_INDICATOR_DISABLE
+- UG_OPT_INDICATOR_MANUAL
+- UG_OPT_OVERLAP_ENABLE
+
+And we used UG_OPT_INDICATOR_POTRAIT_ONLY in "helloUG-efl"
+
+<br>
+<h3 class="pg">Build and test</h3>
+Before you build, you have to make sure whether translatable strings exist or not. IF translatable strings EXIST, please follow these steps before you build:
+@verbatim
+# cd po
+# ./update-po.sh
+# cd ..
+@endverbatim
+IF NOT, please remove the following line in your CMakeList.txt
+@verbatim
+ADD_SUBDIRECTORY(po)
+@endverbatim
+
+To build "helloUG-efl", follow these steps:
+@verbatim
+# mkdir build
+# cd build
+# cmake -DCMAKE_INSTALL_PREFIX=/usr ..
+# make
+# make install
+or
+make home project for your UI gadget in obs.
+you can find RPM spec file in packaging directory by template.
+@endverbatim
+
+\note <b>Naming rule:</b> The output library name is <b>"libug-helloUG-efl.so"</b>, and we use <b>"helloUG-efl"</b> as UI gadget name except prefix <b>"libug-"</b> and postfix ".so" In other word, when you make an UI gadget, the name of library MUST be <b>"libug-XXXXXX.so"</b>
+\note <b>Installation directory:</b> UI gadgets MUST be installed in "/usr/lib/ug/" which is preload Ug and "/opt/lib/ug/" is downloaded UG
+
+Finally, we made our first UI gadget, "helloUG-efl." Let's test it using <i>ug-launcher</i> which is simple UI gadget launcher.
+Fullview test
+@verbatim
+# ug-launcher -n helloUG-efl
+@endverbatim
+Frameview test
+@verbatim
+# ELM_THEME=beat ug-launcher -n helloUG-efl -f
+@endverbatim
+
+\note <b>How to use UG launcher</b>
+@verbatim
+# ug-launcher [-F] [-f] -n <UG_NAME> [-d <Argument>]
+@endverbatim
+- -d: argument, key, value pair.
+- -F: Fullview mode (default)
+- -f: frameview mode
+\note <b> Example: </b>
+@verbatim
+# ug-launcher -F -n helloUG-efl -d "name,John doe" -d "age,30"
+@endverbatim
+
+<br>
+<h2 class="pg">How to use UI gadget</h2>
+Now, we are going to use "helloUG-efl" of previous section.
+
+<br>
+<h3 class="pg">Initialize</h3>
+
+If you are UI gadget developer who is trying to use UI gadgets, please skip this section. This section is for application developers who use UI gadgets.
+You have to initialize UI gadget manager before you use UI gadgets. To initialize, use <b>ug_init()</b> with arguments: <i>disp, xid, win and opt</i>. <i>disp</i> is default display, and <i>xid</i> is X window id of win. <i>win</i> is window evas object for UI gadgets, and it is usually main window. <i>opt</i> is rotation and indicator option for your application (see <i>Rotation and indicator section</i>.)
+
+The <i>disp</i> and <i>xid</i> are used for indicator management. If you don't know how to get display and X window ID, just use following macro: <b>UG_INIT_EFL(win, opt);</b>
+
+\note <b>Prototype of ug_init() (See API Reference guide):</b>
+@code
+int ug_init (Display *disp, Window xid, void *win, enum ug_option opt);
+@endcode
+\note <b>Macros for convenience (see 3 API reference quide):</b>
+@code
+UG_INIT_EFL(win, opt);
+@endcode
+
+<br>
+<h3 class="pg">Create UI gadget instance</h3>
+
+To create UI gadget instance, you have to invoke <b>ug_create()</b> which has five arguments: <i>parent, name, mode, service, and cbs.</i>
+
+First, the <i>parent</i> is provided for specifying parent UI gadget, and it helps UI gadget manager to manage UI gadget tree (see <i>Management section.</i>) For instance, if the UI gadget 'A' uses other UI gadgets, the parent has to be the 'A.' Otherwise, if an application uses UI gadgets, the <i>parent</i> has to be NULL.
+
+Second, the <i>name</i> is the UI gadget's name (ex. "helloUG-efl")
+
+Third, the <i>mode</i> could be UG_MODE_FULLVIEW to show the UI gadget as fullview, or UG_MODE_FRAMEVIEW to show it as frameview.
+
+Fourth, the <i>service</i> is arguments for the UI gadget which is service type (see \ref service_PG "Tizen Managed API Reference Guide")
+
+\warning After create UI gadget, you have to release the argument using <b>service_destroy()</b> API.
+
+Fifth, the <i>cbs</i> is data describing layout callback, result callback, destroy callback, and private data. In detail, layout callback is used for layout arrangement, and it invoked after the UI gadget is created, and result callback is invoked to receive result from the UI gadget. And destroy callback is invoked to deal with destroy request from the UI gadget.
+
+\warning Result data of the result callback is service type data, named <i>result</i>. <b>Because the result data is released after result callback is finished</b>, if you want to keep using it, please use <b>service_clone()</b> which duplicates given service data (see \ref service_PG "Tizen Managed API Reference Guide")
+
+Using ug_create(), you can create UI gadget. After UI Gadget create operation is completed, layout callback function is called with base layout for layout arrangement (See Picture 2-11).<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-11.png "Picture 2-11. Create UI gadget"
+
+The registered callback functions like result_cb or destroy_cb by caller is called when the UI gadget request sending result or destroy operation. <br><br>
+When UI gadget requests to UI gadget library for sending result to caller using ug_send_result(), UI gadget library calls result callback function which is registered by caller(See Picture 2-12).<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-12.png "Picture 2-12. Send result"
+
+And using ug_destroy_me(), UI gadget sends the destroy request to caller (See Picture 2-13). UI gadget cannot destroy itself, so it should request to caller.<br><br>
+
+\image html SLP_UI_Gadget_PG_image2-13.png "Picture 2-13. Destroy request"
+
+\note <b>Prototype of ug_create() (See API reference guide):</b>
+@code
+ui_gadget_h ug_create (ui_gadget_h parent,
+ const char *name,
+ enum ug_mode mode,
+ service_h service,
+ struct ug_cbs *cbs);
+
+\note <b>struct ug_cbs</b> is describing some callbacks and private data:
+@code
+struct ug_cbs {
+ void (*layout_cb)(ui_gadget_h ug, enum ug_mode mode, void *priv);
+ void (*result_cb)(ui_gadget_h ug, service result, void *priv);
+ void (*destroy_cb)(ui_gadget_h ug, void *priv);
+ void *priv;
+};
+@endcode
+
+Here are some examples:
+
+@code
+// FULLVIEW example
+struct my_data {
+ ui_gadget_h ug;
+};
+
+static void layout_cb(ui_gadget_h ug, enum ug_mode mode, void *priv)
+{
+ Evas_Object *base, *win;
+
+ if (!ug || !priv)
+ return;
+
+ base = ug_get_layout(ug);
+ if (!base)
+ return;
+
+ switch (mode) {
+ case UG_MODE_FULLVIEW:
+ win = ug_get_window();
+ if (!win)
+ return;
+ evas_object_size_hint_weight_set(base, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+ ug_disable_effect(ug);
+ evas_object_show(base);
+ break;
+ default:
+ break;
+ }
+}
+
+static void result_cb(ui_gadget_h ug, service result, void *priv)
+{
+ struct my_data *mydata;
+ const char *val;
+
+ if (!ug || !priv)
+ return;
+
+ mydata = priv;
+ if (result) {
+ service_get_extra_data(result, "name", val);
+ if (val)
+ fprintf(stderr, "The name of UI gadget that sends result is %s\n", val);
+ }
+ ug_destroy(ug);
+ mydata->ug = NULL;
+
+}
+
+static void destroy_cb(ui_gadget_h ug, void *priv)
+{
+ struct my_data *mydata;
+
+ if (!ug || !priv)
+ return;
+
+ mydata = priv;
+
+ ug_destroy(ug);
+ mydata->ug = NULL;
+}
+
+ui_gadget_h create_ug(struct my_data *data)
+{
+ ui_gadget_h ug;
+ struct ug_cbs cbs = {0, };
+
+ cbs.layout_cb = layout_cb;
+ cbs.result_cb = result_cb;
+ cbs.destroy_cb = destroy_cb;
+ cbs.priv = (void *)data;
+
+ ug = ug_create(NULL, "helloUG-efl", UG_MODE_FULLVIEW, NULL, &cbs);
+
+ return ug;
+}
+@endcode
+
+@code
+// FRAMEVIEW example
+struct my_data {
+ ui_gadget_h ug;
+ Evas_Object *main_layout;
+};
+
+static void layout_cb(ui_gadget_h ug, enum ug_mode mode, void *priv)
+{
+ Evas_Object *base, *win;
+ struct my_data *mydata;
+
+ if (!ug || !priv)
+ return;
+
+ mydata = priv;
+
+ base = ug_get_layout(ug);
+ if (!base)
+ return;
+
+ switch (mode) {
+ case UG_MODE_FRAMEVIEW:
+ elm_layout_content_set(mydata->main_layout, "content", base);
+ break;
+ default:
+ break;
+ }
+}
+
+static void result_cb(ui_gadget_h ug, service result, void *priv)
+{
+ struct my_data *mydata;
+ const char *val;
+
+ if (!ug || !priv)
+ return;
+
+ mydata = priv;
+
+ if (result) {
+ service_get_extra_data(result, "name", val);
+ if (val)
+ fprintf(stderr, "The name of UI gadget that sends result is %s\n", val);
+ }
+
+ ug_destroy(ug);
+ mydata->ug = NULL;
+
+}
+
+static void destroy_cb(ui_gadget_h ug, void *priv)
+{
+ struct my_data *mydata;
+
+ if (!ug || !priv)
+ return;
+
+ mydata = priv;
+
+ ug_destroy(ug);
+ mydata->ug = NULL;
+}
+
+ui_gadget_h create_ug(struct my_data *data)
+{
+ ui_gadget_h ug;
+ struct ug_cbs cbs = {0, };
+
+ cbs.layout_cb = layout_cb;
+ cbs.result_cb = result_cb;
+ cbs.destroy_cb = destroy_cb;
+ cbs.priv = (void *)data;
+
+ ug = ug_create(NULL, "helloUG-efl", UG_MODE_FRAMEVIEW, NULL, &cbs);
+
+ return ug;
+}
+@endcode
+
+<br>
+<h2 class="pg">Send message</h2>
+
+We provide API for sending message: <b>ug_send_message()</b>. When you send a message, you have to use service type data (see \ref service_PG "Tizen Managed API Reference Guide"). (See Picture 2-14)
+
+\note <b>Prototype of ug_send_message() (See API reference guide):</b>
+@code
+int ug_send_message (ui_gadget_h ug, service msg);
+@endcode
+
+\image html SLP_UI_Gadget_PG_image2-14.png "Picture 2-14. Send message"
+
+\warning After send your message, you have to release it using <b>service_destroy()</b> API.
+@code
+//example
+ service_h msg;
+
+ ret = service_create(&msg);
+
+ service_add_extra_data(msg, "name", "hello-UG");
+ service_add_extra_data(msg, "description", "sample UI gadget");
+
+ //Send message
+ ug_send_message(ug, msg);
+
+ //release service
+ service_destroy(msg);
+@endcode
+
+<br>
+<h2 class="pg">Event propagation</h2>
+
+If you are UI gadget developer who is trying to use UI gadgets, please skip this section. This section is for application developers who use UI gadgets.
+
+We provide some APIs for event propagation: <b>ug_pause(), ug_resume(), and ug_send_event()</b>. <b>ug_pause()</b> and <b>ug_resume()</b> are used for task-managing. If the application is put into background, invoke <b>ug_pause()</b>, otherwise, if the application is brought to the foreground, invoke <b>ug_resume()</b>. <b>ug_send_event()</b> is used for system event: <i>low memory, low battery, language change, region change, rotate portrait, rotate portrait upside-down, rotate landscape, and rotate landscape upside-down.</i>
+
+\note <b>Prototype of ug_pause(), ug_resume(), and ug_send_event() (See API reference guide):</b>
+@code
+int ug_pause (void);
+int ug_resume (void);
+int ug_send_event (enum ug_event event);
+@endcode
+
+\image html SLP_UI_Gadget_PG_image2-15.png "Picture 2-15. Pause event propagation"
+\image html SLP_UI_Gadget_PG_image2-16.png "Picture 2-16. Resume event propagation"
+\image html SLP_UI_Gadget_PG_image2-17.png "Picture 2-17. System event propagation"
+
+<br>
+<h2 class="pg">Destroy all UI gadgets</h2>
+
+If you are UI gadget developer who is trying to use UI gadgets, please skip this section. This section is for application developers who use UI gadgets.
+
+When you terminate your application, destroy all UI gadgets using <b>ug_destroy_all()</b>.
+
+\note <b>Prototype of ug_destroy_all(See API reference guide): </b>
+@code
+int ug_destroy_all (void);
+@endcode
+
+<br>
+<h2 class="pg">Disable UI gadget effect</h2>
+
+We provide API for disabling transition effect: <i>ug_disable_effect</i>. If you want to disable showing/hiding transition effect when create and destroy a UI Gadget, <i>ug_disable_effect</i> should be called before show UI Gadget layout.
+
+\note <b>Prototype of ug_disable_effect(See API reference guide): </b>
+@code
+int ug_disable_effect (void);
+@endcode
+
+Here are some examples:
+
+@code
+To disable transition effect :
+
+ static void layout_cb(struct ui_gadget *ug, enum ug_mode mode, void *priv)
+ {
+ Evas_Object *base, *win;
+ if (!ug || !priv)
+ return;
+ base = ug_get_layout(ug);
+ if (!base)
+ return;
+
+ win = ug_get_window();
+ switch (mode) {
+ case UG_MODE_FULLVIEW:
+ evas_object_size_hint_weight_set(base, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
+ // disable effect
+ ug_disable_effect(ug);
+ evas_object_show(base);
+ break;
+ default:
+ break;
+ }
+@endcode
+
+ * @}
+ */
diff --git a/include/ug-dbg.h b/include/ug-dbg.h
new file mode 100644
index 0000000..00167b0
--- /dev/null
+++ b/include/ug-dbg.h
@@ -0,0 +1,37 @@
+/*
+ * UI Gadget
+ *
+ * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
+ *
+ * Contact: Jayoun Lee <airjany@samsung.com>
+ *
+ * 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 __UG_DBG_H__
+#define __UG_DBG_H__
+
+#include <dlog.h>
+
+#ifdef LOG_TAG
+#undef LOG_TAG
+#endif
+
+#define LOG_TAG "UI_GADGET"
+
+#define _ERR(fmt, arg...) LOGE("\x1b[31m" fmt "\x1b[0m", ##arg)
+#define _DBG(fmt, arg...) LOGD("\x1b[32m" fmt "\x1b[0m", ##arg)
+#define _INFO(fmt, arg...) LOGI("\x1b[33m" fmt "\x1b[0m", ##arg)
+
+#endif /* __UG_DBG_H__ */
diff --git a/include/ug-engine.h b/include/ug-engine.h
new file mode 100644
index 0000000..22914ad
--- /dev/null
+++ b/include/ug-engine.h
@@ -0,0 +1,36 @@
+/*
+ * UI Gadget
+ *
+ * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
+ *
+ * Contact: Jayoun Lee <airjany@samsung.com>
+ *
+ * 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 __UG_ENGINE_H__
+#define __UG_ENGINE_H__
+
+#include "ui-gadget-engine.h"
+
+struct ug_engine {
+ void *handle;
+ struct ug_engine_ops ops;
+};
+
+struct ug_engine *ug_engine_load(void);
+int ug_engine_unload(struct ug_engine *engine);
+
+
+#endif /* __UG_ENGINE_H__ */
diff --git a/include/ug-manager.h b/include/ug-manager.h
new file mode 100755
index 0000000..0589ac8
--- /dev/null
+++ b/include/ug-manager.h
@@ -0,0 +1,49 @@
+/*
+ * UI Gadget
+ *
+ * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
+ *
+ * Contact: Jayoun Lee <airjany@samsung.com>
+ *
+ * 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 __UG_MANAGER_H__
+#define __UG_MANAGER_H__
+
+#include <utilX.h>
+#include "ug.h"
+
+int ugman_ug_add(ui_gadget_h parent, ui_gadget_h ug);
+ui_gadget_h ugman_ug_load(ui_gadget_h parent,
+ const char *name,
+ enum ug_mode mode,
+ service_h service,
+ struct ug_cbs *cbs);
+int ugman_ug_del(ui_gadget_h ug);
+int ugman_ug_del_all(void);
+
+int ugman_init(Display *disp, Window xid, void *win, enum ug_option opt);
+int ugman_resume(void);
+int ugman_pause(void);
+int ugman_send_event(enum ug_event event);
+int ugman_send_key_event(enum ug_key_event event);
+int ugman_send_message(ui_gadget_h ug, service_h msg);
+
+void *ugman_get_window(void);
+void *ugman_get_conformant(void);
+
+int ugman_ug_exist(ui_gadget_h ug);
+
+#endif /* __UG_MANAGER_H__ */
diff --git a/include/ug-module.h b/include/ug-module.h
new file mode 100644
index 0000000..a6fc459
--- /dev/null
+++ b/include/ug-module.h
@@ -0,0 +1,36 @@
+/*
+ * UI Gadget
+ *
+ * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
+ *
+ * Contact: Jayoun Lee <airjany@samsung.com>
+ *
+ * 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 __UG_MODULE_H__
+#define __UG_MODULE_H__
+
+#include "ui-gadget-module.h"
+
+struct ug_module {
+ void *handle;
+ const char *module_name;
+ struct ug_module_ops ops;
+};
+
+struct ug_module *ug_module_load(const char *name);
+int ug_module_unload(struct ug_module *module);
+
+#endif /* __UG_MODULE_H__ */
diff --git a/include/ug.h b/include/ug.h
new file mode 100755
index 0000000..fe3be22
--- /dev/null
+++ b/include/ug.h
@@ -0,0 +1,76 @@
+/*
+ * UI Gadget
+ *
+ * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
+ *
+ * Contact: Jayoun Lee <airjany@samsung.com>
+ *
+ * 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 __UG_H__
+#define __UG_H__
+
+#include <bundle.h>
+#include "ug-module.h"
+#include "ui-gadget.h"
+
+struct ug_child;
+
+enum ug_state {
+ UG_STATE_READY = 0x00,
+ UG_STATE_CREATED,
+ UG_STATE_RUNNING,
+ UG_STATE_STOPPED,
+ UG_STATE_DESTROYING,
+ UG_STATE_DESTROYED,
+ UG_STATE_INVALID,
+ UG_STATE_MAX
+};
+
+enum ug_layout_state {
+ UG_LAYOUT_INIT = 0x00,
+ UG_LAYOUT_SHOW,
+ UG_LAYOUT_SHOWEFFECT,
+ UG_LAYOUT_HIDE,
+ UG_LAYOUT_HIDEEFFECT,
+ UG_LAYOUT_DESTROY,
+ UG_LAYOUT_NOEFFECT,
+ UG_LAYOUT_MAX
+};
+
+struct ui_gadget_s {
+ const char *name;
+ void *layout;
+ enum ug_state state;
+ enum ug_mode mode;
+ enum ug_option opt;
+
+ ui_gadget_h parent;
+ void *children;
+
+ struct ug_module *module;
+ struct ug_cbs cbs;
+
+ service_h service;
+
+ int destroy_me:1;
+ enum ug_layout_state layout_state;
+ void *effect_layout;
+};
+
+ui_gadget_h ug_root_create(void);
+int ug_free(ui_gadget_h ug);
+
+#endif /* __UG_H__ */
diff --git a/include/ui-gadget-engine.h b/include/ui-gadget-engine.h
new file mode 100755
index 0000000..035bf20
--- /dev/null
+++ b/include/ui-gadget-engine.h
@@ -0,0 +1,69 @@
+/*
+ * UI Gadget
+ *
+ * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved.
+ *
+ * Contact: Jayoun Lee <airjany@samsung.com>, Jinwoo Nam <jwoo.nam@samsung.com>
+ *
+ * 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 __UI_GADGET_ENGINE_H__
+#define __UI_GADGET_ENGINE_H__
+
+/**
+ * @defgroup UI_Gadget_For_Developer Developer API Reference Guide
+ * @ingroup UI_Gadget
+ * @brief A engine to develop a UI gadget. Callees (UI gadgets) uses this engines and APIs. (callee -> caller)
+ *
+ * @section Header To Use Them:
+ * @code
+ * #include <ui-gadget-engine.h>
+ * @endcode
+ */
+
+/**
+ * @addtogroup UI_Gadget_For_Developer
+ * @{
+ */
+
+#include <bundle.h>
+#include "ui-gadget.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * UI gadget engine operation type
+ * @see @ref lifecycle_sec
+ */
+struct ug_engine_ops {
+ /** create operation */
+ void *(*create)(void *win, ui_gadget_h ug, void(*show_end_cb)(void *data));
+ /** destroy operation */
+ void (*destroy)(ui_gadget_h ug, ui_gadget_h fv_top, void(*hide_end_cb)(ui_gadget_h ug));
+ /** reserved operations */
+ void *reserved[4];
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+/**
+ * @}
+ */
+
+#endif /* __UI_GADGET_ENGINE_H__ */
diff --git a/include/ui-gadget-module.h b/include/ui-gadget-module.h
new file mode 100755
index 0000000..452827b
--- /dev/null
+++ b/include/ui-gadget-module.h
@@ -0,0 +1,169 @@
+/*
+ * UI Gadget
+ *
+ * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved.
+ *
+ * Contact: Jayoun Lee <airjany@samsung.com>, Jinwoo Nam <jwoo.nam@samsung.com>
+ *
+ * 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 __UI_GADGET_MODULE_H__
+#define __UI_GADGET_MODULE_H__
+
+/**
+ * @defgroup UI_Gadget_For_Developer Developer API Reference Guide
+ * @ingroup UI_Gadget
+ * @brief A module to develop a UI gadget. Callees (UI gadgets) uses this modules and APIs. (callee -> caller)
+ *
+ * @section Header To Use Them:
+ * @code
+ * #include <ui-gadget-module.h>
+ * @endcode
+ */
+
+/**
+ * @addtogroup UI_Gadget_For_Developer
+ * @{
+ */
+
+#include "ui-gadget.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * UI gadget module operation type
+ * @see @ref lifecycle_sec
+ */
+struct ug_module_ops {
+ /** create operation */
+ void *(*create) (ui_gadget_h ug, enum ug_mode mode, service_h service,
+ void *priv);
+ /** start operation */
+ void (*start) (ui_gadget_h ug, service_h service, void *priv);
+ /** pause operation */
+ void (*pause) (ui_gadget_h ug, service_h service, void *priv);
+ /** resume operation */
+ void (*resume) (ui_gadget_h ug, service_h service, void *priv);
+ /** destroy operation */
+ void (*destroy) (ui_gadget_h ug, service_h service, void *priv);
+ /** message operation */
+ void (*message) (ui_gadget_h ug, service_h msg, service_h service, void *priv);
+ /** event operation */
+ void (*event) (ui_gadget_h ug, enum ug_event event, service_h service,
+ void *priv);
+ /** key event operation */
+ void (*key_event) (ui_gadget_h ug, enum ug_key_event event,
+ service_h service, void *priv);
+ /** destroying operation */
+ void (*destroying) (ui_gadget_h ug, service_h service, void *priv);
+ /** reserved operations */
+ void *reserved[3];
+
+ /** private data */
+ void *priv;
+
+ /** option */
+ enum ug_option opt;
+};
+
+/**
+ * \par Description:
+ * This function makes a request that caller of the given UI gadget instance destroys the instance.
+ * It just makes a request, but not destroys UI gadget
+ *
+ * \par Purpose:
+ * This function is used for sending a request that caller of the given UI gadget instance destroys the instance.
+ *
+ * \par Typical use case:
+ * UI gadget developer who want to send a request that caller of the given UI gadget instance destroys the instance could use the function.
+ *
+ * \par Method of function operation:
+ * Destroy callback which is registered by caller with ug_create() is invoked.
+ *
+ * \par Context of function:
+ * This function supposed to be called in the created UI gadget.
+ *
+ * @param[in] ug the UI gadget
+ * @return 0 on success, -1 on error
+ *
+ * \pre None
+ * \post None
+ * \see None
+ * \remarks The API just makes a request, but not destroys UI gadget
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget-module.h>
+ * ...
+ * // send a "destroy me" request
+ * ug_destroy_me(ug);
+ * ...
+ * \endcode
+ */
+int ug_destroy_me(ui_gadget_h ug);
+
+/**
+ * \par Description:
+ * This function sends result to caller of the given UI gadget instance.
+ *
+ * \par Purpose:
+ * This function is used for sending result to caller of the given UI gadget instance. The result have to be composed with service handle.
+ *
+ * \par Typical use case:
+ * UI gadget developer who want to send result to caller of the given UI gadget instance could use the function.
+ *
+ * \par Method of function operation:
+ * Result callback which is registered by caller with ug_create() is invoked.
+ *
+ * \par Context of function:
+ * This function supposed to be called in the created UI gadget.
+ *
+ * @param[in] ug the UI gadget
+ * @param[in] result the result, which is service type (see \ref service_PG "Tizen managed api reference guide")
+ * @return 0 on success, -1 on error
+ *
+ * \pre None
+ * \post None
+ * \see None
+ * \remarks After send your message, you have to release it using service_destroy()
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget-module.h>
+ * ...
+ * // make a result with service
+ * service_h result;
+ * service_create(&result);
+ * service_add_extra_data(result, "Content", "Hello");
+ *
+ * // send the result
+ * ug_send_result(ug, result);
+ *
+ * // release the result
+ * service_destroy(result);
+ * ...
+ * \endcode
+ */
+int ug_send_result(ui_gadget_h ug, service_h result);
+
+#ifdef __cplusplus
+}
+#endif
+/**
+ * @}
+ */
+#endif /* __UI_GADGET_MODULE_H__ */
diff --git a/include/ui-gadget.h b/include/ui-gadget.h
new file mode 100755
index 0000000..0ebcc38
--- /dev/null
+++ b/include/ui-gadget.h
@@ -0,0 +1,750 @@
+/*
+ * UI Gadget
+ *
+ * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved.
+ *
+ * Contact: Jayoun Lee <airjany@samsung.com>, Jinwoo Nam <jwoo.nam@samsung.com>
+ *
+ * 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 __UI_GADGET_H__
+#define __UI_GADGET_H__
+
+/**
+ * @file ui-gadget.h
+ * @version 0.1
+ * @brief This file contains the public API of the UI gadget library
+ */
+
+/**
+ * @addtogroup APPLICATION_FRAMEWORK
+ * @{
+ *
+ * @defgroup UI_Gadget UI gadget library
+ * @version 0.1
+ * @brief A library to develop/use a UI gadget
+ */
+
+/**
+ * @addtogroup UI_Gadget
+ * @{
+ *
+ * @defgroup UI_Gadget_For_User User API Reference Guide
+ * @brief A module to use a UI gadget. Caller uses this module and APIs.
+ *
+ * @section Header To Use Them:
+ * @code
+ * #include <ui-gadget.h>
+ * @endcode
+ */
+
+/**
+ * @addtogroup UI_Gadget_For_User
+ * @{
+ */
+
+#include <X11/Xlib.h>
+#include <app.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * struct ui_gadget is an opaque type representing a UI gadget
+ * @see ug_create(), ug_destroy()
+ * @see ug_get_layout(), ug_get_parent_layout(), ug_get_mode()
+ */
+typedef struct ui_gadget_s *ui_gadget_h;
+
+/**
+ * UI gadget mode
+ * @see ug_create()
+ * @see ug_get_mode()
+ */
+enum ug_mode {
+ UG_MODE_FULLVIEW, /**< Fullview mode */
+ UG_MODE_FRAMEVIEW, /**< Frameview mode */
+ UG_MODE_INVALID, /**< Invalid mode */
+ UG_MODE_MAX
+};
+
+/**
+ * UI gadget event
+ * @see ug_send_event()
+ */
+enum ug_event {
+ UG_EVENT_NONE = 0x00, /**< No event */
+ UG_EVENT_LOW_MEMORY, /**< Low memory event */
+ UG_EVENT_LOW_BATTERY, /**< Low battery event */
+ UG_EVENT_LANG_CHANGE, /**< Language change event */
+ UG_EVENT_ROTATE_PORTRAIT, /**< Rotate event: Portrait */
+ UG_EVENT_ROTATE_PORTRAIT_UPSIDEDOWN, /**< Rotate event: Portrait upsidedown */
+ UG_EVENT_ROTATE_LANDSCAPE, /**< Rotate event: Landscape */
+ UG_EVENT_ROTATE_LANDSCAPE_UPSIDEDOWN,
+ /**< Rotate event: Landscape upsidedown */
+ UG_EVENT_REGION_CHANGE, /**< Region change event */
+ UG_EVENT_MAX
+};
+
+/**
+ * UI gadget key event
+ * @see ug_send_key_event()
+ */
+enum ug_key_event {
+ UG_KEY_EVENT_NONE = 0x00, /**< No event */
+ UG_KEY_EVENT_END, /**< End key event */
+ UG_KEY_EVENT_MAX
+};
+
+/**
+ * UI gadget option
+ *
+ * @see ug_init()
+ */
+enum ug_option {
+ UG_OPT_INDICATOR_ENABLE = 0x00,
+ /**< Indicator option:
+ Enable with both portrait and landscape window */
+ UG_OPT_INDICATOR_PORTRAIT_ONLY = 0x01,
+ /**< Indicator option: Enable with portrait window */
+ UG_OPT_INDICATOR_LANDSCAPE_ONLY = 0x02,
+ /**< Indicator option: Enable with landscape window */
+ UG_OPT_INDICATOR_DISABLE = 0x03,
+ /**< Indicator option:
+ Disable with both portrait and landscape view window */
+ UG_OPT_INDICATOR_MANUAL = 0x04,
+ /**< Indicator option:
+ Indicator will be handled manually */
+ UG_OPT_OVERLAP_ENABLE = 0x08,
+ /**< Overlap option: Enable indicator overlap */
+ UG_OPT_MAX
+};
+
+#define GET_OPT_INDICATOR_VAL(opt) opt % UG_OPT_OVERLAP_ENABLE
+#define GET_OPT_OVERLAP_VAL(opt) opt & UG_OPT_OVERLAP_ENABLE
+
+/**
+ * UI gadget callback type
+ * @see ug_create()
+ */
+struct ug_cbs {
+ /** layout callback */
+ void (*layout_cb) (ui_gadget_h ug, enum ug_mode mode,
+ void *priv);
+ /** result callback */
+ void (*result_cb) (ui_gadget_h ug, service_h result, void *priv);
+ /** destroy callback */
+ void (*destroy_cb) (ui_gadget_h ug, void *priv);
+ /** private data */
+ void *priv;
+};
+
+/**
+ * Easy-to-use macro of ug_init() for EFL
+ * @see ug_init()
+ */
+#define UG_INIT_EFL(win, opt) \
+ ug_init((Display *)ecore_x_display_get(), elm_win_xwindow_get(win), \
+ win, opt)
+
+/**
+ * Easy-to-use macro of ug_init() for GTK
+ * @see ug_init()
+ */
+#define UG_INIT_GTK(win, opt) \
+ win ? ug_init(gdk_display_get_default(), win, \
+ GDK_WINDOW_XWINDOW(GTK_WIDGET(win)->window), win, opt) : -1
+
+/**
+ * \par Description:
+ * This function initializes default window, display, xwindow id, and indicator state.
+ *
+ * \par Purpose:
+ * First of all, to use UI gadgets in an application, default window to draw the UI gadgets has to be registered. Besides, to change indicator state for the full-view UI gadget, display and xwindow id have to be registered, and to restore application's indicator state, default indicator option has to be registered. This function is used for registering them.
+ *
+ * \par Typical use case:
+ * Application developers who want to use UI gadget MUST register display, xwindow id, default window, and option with the function at first.
+ *
+ * \par Method of function operation:
+ * Register display, xwindow id, default window, and option.
+ *
+ * \par Context of function:
+ * None
+ *
+ * \note If you are unfamiliar with display and xwindow id, please use following macros: UG_INIT_EFL, UG_INIT_GTK. The macros kindly generate proper functions to get display and xwindow id.
+ *
+ * @param[in] disp Default display
+ * @param[in] xid Default xwindow id of default window
+ * @param[in] win Default window object, it is void pointer for supporting both GTK (GtkWidget *) and EFL (Evas_Object *)
+ * @param[in] opt Default indicator state to restore application's indicator state
+ * @return 0 on success, -1 on error
+ *
+ * \pre None
+ * \post None
+ * \see UG_INIT_EFL(), UG_INIT_GTK()
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * Evas_Object *win;
+ * ...
+ * // create window
+ * ...
+ * ug_init((Display *)ecore_x_display_get(), elm_win_xwindow_get(win), win, UG_OPT_INDICATOR_ENABLE);
+ * // for convenience you can use following macro: ELM_INIT_EFL(win, UG_OPT_INDICATOR_ENABLE);
+ * ...
+ * \endcode
+ */
+int ug_init(Display *disp, Window xid, void *win, enum ug_option opt);
+
+/**
+ * \par Description:
+ * This function creates a UI gadget
+ *
+ * \par Purpose:
+ * This function is used for creating a UI gadget instance. In addition, following callbacks could be registered with the function: layout callback, result callback, and destroy callback. (see struct ug_cbs)
+ *
+ * \par Typical use case:
+ * Anyone who want to create UI gadget could use the function.
+ *
+ * \par Method of function operation:
+ * First, the UI gadget with given name is dynamically loaded(dlopen). Next, state operations of loaded UI gadget are invoked according to its lifecycle. There are three callbacks which could be registered with the function: layout callback, result callback, and destroy callback. If the state is changed to "Create", the layout callback is invoked for layout arrangement. If ug_send_result() is invoked in the loaded UI gadget , the result callback is invoked. And, if ug_destroy_me() is invoked in the loaded UI gadget , the destroy callback is invoked.
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init()
+ *
+ * @param[in] parent parent's UI gadget. If the UI gadget uses the function, the parent has to be the UI gadget. Otherwise, if an application uses the function, the parent has to be NULL
+ * @param[in] name name of UI gadget
+ * @param[in] mode mode of UI gadget (UG_MODE_FULLVIEW | UG_MODE_FRAMEVIEW)
+ * @param[in] service argument for the UI gadget (see \ref service_PG "Tizen managed api reference guide")
+ * @param[in] cbs callback functions (layout callback, result callback, destroy callback, see struct ug_cbs) and private data.
+ * @return The pointer of UI gadget, NULL on error
+ *
+ * \pre ug_init()
+ * \post None
+ * \see struct ug_cbs, enum ug_mode
+ * \remarks If you passed "service", you MUST release it using service_destroy() after ug_create()
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * service_h service;
+ * ui_gadget_h ug;
+ * struct ug_cbs cbs = {0, };
+ *
+ * // set callbacks: layout callback, result callback, destroy callback
+ * cbs.layout_cb = _layout_cb;
+ * cbs.result_cb = _result_cb;
+ * cbs.destroy_cb = _destroy_cb;
+ * cbs.priv = user_data;
+ *
+ * // create arguments
+ * service_create(&service);
+ * service_add_extra_data(service, "Content", "Hello");
+ *
+ * // create "helloUG-efl" UI gadget instance
+ * ug = ug_create(NULL, "helloUG-efl", UG_MODE_FULLVIEW, service, &cbs);
+ *
+ * // release arguments
+ * service_destroy(b);
+ * ...
+ * \endcode
+ */
+ui_gadget_h ug_create(ui_gadget_h parent, const char *name,
+ enum ug_mode mode, service_h service,
+ struct ug_cbs *cbs);
+
+/**
+ * \par Description:
+ * This function pauses all UI gadgets
+ *
+ * \par Purpose:
+ * This function is used for pausing UI gadgets with "Running" state. Eventually, state of the UI gadgets would be "Stopped."
+ *
+ * \par Typical use case:
+ * Application developers who want to pause loaded UI gadgets could use the function.
+ *
+ * \par Method of function operation:
+ * "Pause" state operations of UI gadgets with "Running" state in the UI gadget tree are invoked by post-order traversal.
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init()
+ *
+ * @return 0 on success, -1 on error
+ *
+ * \pre ug_init()
+ * \post None
+ * \see ug_resume()
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * // pause all UI gadget instances
+ * ug_pause();
+ * ...
+ * \endcode
+ */
+int ug_pause(void);
+
+/**
+ * \par Description:
+ * This function resumes all UI gadgets
+ *
+ * \par Purpose:
+ * This function is used for resuming UI gadgets with "Stopped" state. Eventually, state of all UI gadgets would be "Running."
+ *
+ * \par Typical use case:
+ * Application developers who want to resume loaded UI gadgets could use the function.
+ *
+ * \par Method of function operation:
+ * "Resume" state operations of UI gadgets with "Stopped" state in the UI gadget tree are invoked by post-order traversal.
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init()
+ *
+ * @return 0 on success, -1 on error
+ *
+ * \pre ug_init()
+ * \post None
+ * \see ug_pause()
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * // resume all UI gadget instances
+ * ug_resume();
+ * ...
+ * \endcode
+ */
+int ug_resume(void);
+
+/**
+ * \par Description:
+ * This function destroys the given UI gadget instance
+ *
+ * \par Purpose:
+ * This function is used for destroying given UI gadget instance and its children. Eventually, state of the instance would be "Destroyed."
+ *
+ * \par Typical use case:
+ * Anyone who want to destroy specific UI gadget could use the function.
+ *
+ * \par Method of function operation:
+ * "Destroy" state operations of the given UI gadget instance and its children are invoked.
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init() and creation UI gadget with ug_create()
+ *
+ * @param[in] ug The UI gadget
+ * @return 0 on success, -1 on error
+ *
+ * \pre ug_init(), ug_create()
+ * \post None
+ * \see ug_destroy_all()
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * // destroy UI gadget instance
+ * ug_destroy(ug);
+ * ...
+ * \endcode
+ */
+int ug_destroy(ui_gadget_h ug);
+
+/**
+ * \par Description:
+ * This function destroys all UI gadgets of an application
+ *
+ * \par Purpose:
+ * This function is used for destroying all UI gadgets. Eventually, state of all UI gadgets would be "Destroyed."
+ *
+ * \par Typical use case:
+ * Application developers who want to destroy loaded UI gadgets could use the function.
+ *
+ * \par Method of function operation:
+ * "Destroy" state operations of all UI gadgets in the UI gadget tree are invoked by post-order traversal.
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init()
+ *
+ * @return 0 on success, -1 on error
+ *
+ * \pre ug_init()
+ * \post None
+ * \see ug_destroy()
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * // destroy all UI gadget instances
+ * ug_destroy_all();
+ * ...
+ * \endcode
+ */
+int ug_destroy_all(void);
+
+/**
+ * \par Description:
+ * This function gets base layout of the given UI gadget instance
+ *
+ * \par Purpose:
+ * This function is used for getting base layout pointer of given UI gadget instance.
+ *
+ * \par Typical use case:
+ * Anyone who want to get base layout of UI gadget could use the function.
+ *
+ * \par Method of function operation:
+ * This function returns base layout pointer which is created in "Create" operation of the given UI gadget instance.
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init() and creation UI gadget with ug_create()
+ *
+ * @param[in] ug The UI gadget
+ * @return The pointer of base layout, NULL on error. The result value is void pointer for supporting both GTK (GtkWidget *) and EFL (Evas_Object *)
+ *
+ * \pre ug_init(), ug_create()
+ * \post None
+ * \see ug_get_parent_layout()
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * Evas_Object *ly;
+ * // get a base layout
+ * ly = (Evas_Object *)ug_get_layout(ug);
+ * ...
+ * \endcode
+ */
+void *ug_get_layout(ui_gadget_h ug);
+
+/**
+ * \par Description:
+ * This function gets base layout of parent of the given UI gadget instance
+ *
+ * \par Purpose:
+ * This function is used for getting base layout pointer of parent of the given UI gadget instance.
+ *
+ * \par Typical use case:
+ * Anyone who want to get base layout of UI gadget's parent could use the function.
+ *
+ * \par Method of function operation:
+ * This function returns base layout pointer which is created in "Create" operation of parent of the given UI gadget instance.
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init() and creation UI gadget with ug_create()
+ *
+ * @param[in] ug The UI gadget
+ * @return The pointer of base layout, NULL on error. The result value is void pointer for supporting both GTK (GtkWidget *) and EFL (Evas_Object *)
+ *
+ * \pre ug_init(), ug_create()
+ * \post None
+ * \see ug_get_layout()
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * Evas_Object *ly;
+ * // get a base layout of parent of the given UI gadget instance
+ * ly = (Evas_Object *)ug_get_parent_layout(ug);
+ * ...
+ * \endcode
+ */
+void *ug_get_parent_layout(ui_gadget_h ug);
+
+/**
+ * \par Description:
+ * This function gets default window
+ *
+ * \par Purpose:
+ * This function is used for getting default window which is registered with ug_init()
+ *
+ * \par Typical use case:
+ * Anyone who want to get default window could use the function.
+ *
+ * \par Method of function operation:
+ * This function returns default window pointer which is registered with ug_init()
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init()
+ *
+ * @return The pointer of default window, NULL on error. The result value is void pointer for supporting both GTK (GtkWidget *) and EFL (Evas_Object *)
+ *
+ * \pre ug_init()
+ * \post None
+ * \see None
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * Evas_Object *win;
+ * // get default window
+ * win = (Evas_Object *)ug_get_window();
+ * ...
+ * \endcode
+ */
+void *ug_get_window(void);
+
+/**
+ * \par Description:
+ * This function gets ug conformant
+ *
+ * \par Purpose:
+ * This function is used for getting ug conformant
+ *
+ * \par Typical use case:
+ * Anyone who want to get ug conformant could use the function.
+ *
+ * \par Method of function operation:
+ * This function returns ug conformant pointer
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init()
+ *
+ * @return The pointer of default window, NULL on error. The result value is void pointer for supporting both GTK (GtkWidget *) and EFL (Evas_Object *)
+ *
+ * \pre ug_init()
+ * \post None
+ * \see None
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * Evas_Object *conform;
+ * // get default window
+ * conform = (Evas_Object *)ug_get_conformant();
+ * ...
+ * \endcode
+ */
+void *ug_get_conformant(void);
+
+/**
+ * \par Description:
+ * This function gets mode of the given UI gadget instance
+ *
+ * \par Purpose:
+ * This function is used for getting mode of the given UI gadget instance. Mode could be UG_MODE_FULLVIEW or UG_MODE_FRAMEVIEW.
+ *
+ * \par Typical use case:
+ * Anyone who want to get mode of UI gadget could use the function.
+ *
+ * \par Method of function operation:
+ * This function returns mode which is registered with ug_create()
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init() and creation UI gadget with ug_create()
+ *
+ * @param[in] ug The UI gadget
+ * @return UI gadget mode of the given UI gadget instance (UG_MODE_FULLVIEW | UG_MODE_FRAMEVIEW)
+ *
+ * \pre ug_init(), ug_create()
+ * \post None
+ * \see enum ug_mode
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * enum ug_mode mode;
+ * // get mode (UG_MODE_FULLVIEW | UG_MODE_FRAMEVIEW)
+ * mode = ug_get_mode(ug);
+ * ...
+ * \endcode
+ */
+enum ug_mode ug_get_mode(ui_gadget_h ug);
+
+/**
+ * \par Description:
+ * This function propagates the given system event to all UI gadgets
+ *
+ * \par Purpose:
+ * This function is used for propagating the given system event. Available system events are low memory, low battery, language changed, and window rotate event.
+ *
+ * \par Typical use case:
+ * Application developers who want to propagate system event to all UI gadgets could use the function.
+ *
+ * \par Method of function operation:
+ * Event operations of all UI gadgets in the UI gadget tree are invoked by post-order traversal.
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init()
+ *
+ * @param[in] event UI gadget event. (see enum ug_event)
+ * @return 0 on success, -1 on error
+ *
+ * \pre ug_init()
+ * \post None
+ * \see enum ug_event
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * // propagate low battery event to all UI gadget instances
+ * ug_send_event(UG_EVENT_LOW_BATTERY);
+ * ...
+ * \endcode
+ */
+int ug_send_event(enum ug_event event);
+
+/**
+ * \par Description:
+ * This function send key event to full view top UI gadget
+ *
+ * \par Purpose:
+ * This function is used for sending key event to full view top UI gadget. Available key events are end event.
+ *
+ * \par Typical use case:
+ * Application developers who want to send key event to full view top UI gadget could use the function.
+ *
+ * \par Method of function operation:
+ * Key event operation of full view top UI gadget in the UI gadget tree are invoked.
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init()
+ *
+ * @param[in] event UI gadget key event. (see enum ug_key_event)
+ * @return 0 on success, -1 on error
+ *
+ * \pre ug_init()
+ * \post None
+ * \see enum ug_key_event
+ * \remarks None
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * // send key event callback to full view top UI gadget instances
+ * ug_send_key_event(UG_KEY_EVENT_END);
+ * ...
+ * \endcode
+ */
+int ug_send_key_event(enum ug_key_event event);
+
+/**
+ * \par Description:
+ * This function sends message to the given UI gadget instance
+ *
+ * \par Purpose:
+ * This function is used for sending message to created UI gadget. The message have to be composed with service handle.
+ *
+ * \par Typical use case:
+ * Anyone who want to send message to created UI gadget.
+ *
+ * \par Method of function operation:
+ * Message operation of given UI gadget instance is invoked.
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init() and creation UI gadget with ug_create()
+ *
+ * @param[in] ug The UI gadget
+ * @param[in] msg message to send, which is service type (see \ref service_PG "Tizen managed api reference guide")
+ * @return 0 on success, -1 on error
+ *
+ * \pre ug_init(), ug_create()
+ * \post None
+ * \see None
+ * \remarks After send your message, you have to release it using service_destroy()
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * // make a message with service
+ * service_h msg;
+ * service_create(&msg)
+ * service_add_extra_data(msg, "Content", "Hello");
+ *
+ * // send the message
+ * ug_send_message(ug, msg);
+ *
+ * // release the message
+ * service_destroy(msg);
+ * ...
+ * \endcode
+ */
+int ug_send_message(ui_gadget_h ug, service_h msg);
+
+/**
+ * \par Description:
+ * This function disable transition effect of the given UI gadget instance
+ *
+ * \par Purpose:
+ * This function is used for disabling transition effect of created UI gadget.
+ *
+ * \par Typical use case:
+ * Anyone who want to disable transition effect of created UI gadget.
+ *
+ * \par Method of function operation:
+ * No transition effect of given UI gadget is invoked
+ *
+ * \par Context of function:
+ * This function supposed to be called after successful initialization with ug_init() and creation UI gadget with ug_create()
+ *
+ * @param[in] ug The UI gadget
+ * @return 0 on success, -1 on error
+ *
+ * \pre ug_init(), ug_create()
+ * \post None
+ * \see None
+ * \remarks Before show layout of given UI gadget, ug_disable_effect() should be called.
+ *
+ * \par Sample code:
+ * \code
+ * #include <ui-gadget.h>
+ * ...
+ * static void layout_cb(ui_gadget_h ug, enum ug_mode mode, void *priv)
+ * {
+ * ...
+ * base = ug_get_layout(ug);
+ * switch (mode) {
+ * case UG_MODE_FULLVIEW:
+ * // disable effect
+ * ug_disable_effect(ug);
+ * evas_object_show(base);
+ * ...
+ * \endcode
+ */
+int ug_disable_effect(ui_gadget_h ug);
+
+#ifdef __cplusplus
+}
+#endif
+/**
+ * @} @} @}
+ */
+#endif /* __UI_GADGET_H__ */