4 * Copyright (c) 2000 - 2012 Samsung Electronics Co., Ltd. All rights reserved.
6 * Contact: Jayoun Lee <airjany@samsung.com>, Jinwoo Nam <jwoo.nam@samsung.com>
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
25 * @defgroup SLP_PG_UI_GADGET UI gadget library
28 <h1 class="pg">Introduction</h1>
29 <h2 class="pg">Purpose of this document</h2>
30 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.
31 <h2 class="pg">Scope</h2>
32 The scope of this document is limited to UI gadget component interface and API usage.
34 <h1 class="pg">UI gadget architecture</h1>
35 <h2 class="pg">UI gadget</h2>
36 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.
37 \image html SLP_UI_Gadget_PG_image00.png "Picture 1. UI gadget architecture diagram"
39 <h2 class="pg">UI gadget features</h2>
40 UI Gadget Library has the following features:
41 - It provides component interfaces for UI Gadget
42 - It manages UI gadget instances in an application according to their lifecycle
44 <h2 class="pg">Lifecycle</h2>
45 Essentially, an UI gadget has following five states (See Picture 2)
46 - The initial state is \b Ready
47 - If an UI gadget has been created, it is \b Created
48 - If an UI gadget has been started, it is \b Running
49 - If the application that is using an UI gadget is put into background, it is \b Stopped
50 - If an UI gadget has been destroyed, it is \b Destroyed
52 An UI gadget has five callback methods that you can implement to perform operations when the UI gadget moves between states
53 - When an UI gadget is created, \b create() is invoked
54 - When an UI gadget is started, \b start() is invoked
55 - When the application that is using an UI gadget is put into background, \b pause() is invoked
56 - When the application that is using an UI gadget is brought to the foreground, \b resume() is invoked.
57 - When an UI gadget is destroyed, \b destroy() is invoked
59 In addition, an UI gadget has callback methods for system events and message:
60 - When an system event is generated, event() is invoked
61 - When an UI gadget receives message from the caller, message() is invoked
63 \image html SLP_UI_Gadget_PG_image01.png "Picture 2. UI gadget state diagram"
65 <h2 class="pg">Management</h2>
66 UI gadgets in an application are managed as a TREE structure (See Picture 3.) The features for the tree are:
67 - Root of the tree is the UI gadget manager
68 - UI gadget caller is parent of callees
69 - Parents arrange the layout of their children
71 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>.
73 \image html SLP_UI_Gadget_PG_image02.png "Picture 3. UI gadget management policy"
75 <h1 class="pg">Getting started</h1>
76 <h2 class="pg">Overview</h2>
77 For using UI gadget, you need to know the working procedure between caller and UI gadget module.<br><br>
78 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>
79 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.
80 <h2 class="pg">How to make UI gadget</h2>
81 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.
83 \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/."
86 <h3 class="pg">UI gadget template</h3>
87 To create an UI gadget, start by generating boilerplate code using UI gadget template as follow:
89 # ug-gen.sh helloUG-efl helloUG-efl EFL
92 \note <b>How to install UI gadget template:</b>
94 # unrpm ui-gadget-template-xxx.rpm
96 # rpm -Uvh ui-gadget-templat-xxx.rpm
99 \note <b>How to use UI gadget template:</b>
101 # ug-gen.sh [destination] [name] [UI library]
103 - destination: destination directory
104 - name: UI gadget name
105 - UI library: UI library to use. Only EFL is available for now
107 After you generate code, you get following files:
108 - <i>helloUG-efl.c</i> (Source)
109 - <i>helloUG-efl.h</i> (Private header)
110 - <i>CMakeList.txt</i> (Build script)
111 - <i>po/*</i> (I18N files)
113 <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>
114 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.)
117 UG_MODULE_API int UG_MODULE_INIT(struct ug_module_ops *ops)
119 struct ug_data *ugd; // User defined private data
124 ugd = calloc(1, sizeof(struct ug_data));
129 ops->create = on_create;
131 ops->start = on_start;
133 ops->pause = on_pause;
135 ops->resume = on_resume;
137 ops->destroy = on_destroy;
139 ops-> message = on_message;
141 ops->event = on_event;
145 ops->opt = UG_OPT_INDICATOR_ENABLE;
150 UG_MODULE_API void UG_MODULE_EXIT(struct ug_module_ops *ops)
159 free(ugd); // clear private data
164 \note <b>struct ug_module_ops</b> is a data structure describing operations, private data, and the option of UI gadget:
166 struct ug_module_ops {
167 void *(*create)(ui_gadget_h ug, enum ug_mode mode, service_h service, void *priv);
168 void (*start)(ui_gadget_h ug, service_h service, void *priv);
169 void (*pause)(ui_gadget_h ug, service_h service, void *priv);
170 void (*resume)(ui_gadget_h ug, service_h service, void *priv);
171 void (*destroy)(ui_gadget_h ug, service_h service, void *priv);
172 void (*message)(ui_gadget_h ug, service_h *msg, service_h service, void *priv);
173 void (*event)(ui_gadget_h ug, enum ug_event event, service_h service, void *priv);
180 \note <b>enum ug_option</b> is UI gadget options, available options are:
183 UG_OPT_INDICATOR_ENABLE
184 // Enable indicator with portrait window
185 UG_OPT_INDICATOR_PORTRAIT_ONLY
186 // Enable indicator with landscape window
187 UG_OPT_INDICATOR_LANDSCAPE_ONLY
189 UG_OPT_INDICATOR_DISABLE
192 \note <b>struct ug_data</b> is a user defined private data structure describing base layout, own UI gadget handler, and whatever you need:
198 // PUT WHATEVER YOU NEED
203 <h3 class="pg">Operations</h3>
204 There are five state operations, a message operation, and an event operation: <i>create, start, pause, resume, destroy, message, and event.</i>
206 When "helloUG-efl" is created, the create operation is invoked (See Picture 2-1).<br><br>
208 \image html SLP_UI_Gadget_PG_image2-1.png "Picture 2-1. Create operation of UI gadget module"
210 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>.
212 \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.
216 static void *on_create(ui_gadget_h ug, enum ug_mode mode, service_h service, void *priv)
219 Evas_Object *content;
228 parent = ug_get_parent_layout(ug);
232 if (mode == UG_MODE_FULLVIEW)
233 ugd->base = create_fullview(parent, ugd);
235 ugd->base = create_frameview(parent, ugd);
238 content = create_content(parent, ugd);
239 elm_layout_content_set(ugd->base, "elm.swallow.content", content);
244 static Evas_Object *create_fullview(Evas_Object *parent, struct ug_data *ugd)
248 base = elm_layout_add(parent);
251 elm_layout_theme_set(base, "layout", "application", "default");
252 // In case of fullview, show indicator area
253 edje_object_signal_emit(_EDJ(base), "elm,state,show,indicator", "elm");
254 edje_object_signal_emit(_EDJ(base), "elm,state,show,content", "elm");
259 static Evas_Object *create_frameview(Evas_Object *parent, struct ug_data *ugd)
263 base = elm_layout_add(parent);
267 elm_layout_theme_set(base, "layout", "application", "default");
268 // In case of frameview, do not show indicator area
269 edje_object_signal_emit(_EDJ(base), "elm,state,show,content", "elm");
274 static Evas_Object *create_content(Evas_Object *parent, struct ug_data *ugd)
276 Evas_Object *bx, *eo;
279 bx = elm_box_add(parent);
281 // add label and pack it in the box
282 eo = elm_label_add(parent);
283 elm_object_text_set(eo, _("Hello UI Gadget"));
284 evas_object_size_hint_align_set(eo, 0.5, EVAS_HINT_FILL);
285 evas_object_size_hint_weight_set(eo, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
286 evas_object_show(eo);
287 elm_box_pack_end(bx, eo);
289 // add buttons and pack it in the box
290 eo = elm_button_add(parent);
291 elm_object_text_set(eo, _("Send result"));
292 evas_object_size_hint_align_set(eo, EVAS_HINT_FILL, EVAS_HINT_FILL);
293 evas_object_smart_callback_add(eo, "clicked", result_cb, ugd);
294 elm_object_style_set(eo, "bottom_btn");
296 evas_object_show(eo);
297 elm_box_pack_end(bx, eo);
299 eo = elm_button_add(parent);
300 elm_object_text_set(eo, _("Back"));
301 evas_object_size_hint_align_set(eo, EVAS_HINT_FILL, EVAS_HINT_FILL);
302 evas_object_smart_callback_add(eo, "clicked", back_cb, ugd);
303 elm_object_style_set(eo, "bottom_btn");
305 evas_object_show(eo);
306 elm_box_pack_end(bx, eo);
312 When "helloUG-efl" starts, the start operation is invoked (See Picture 2-2).<br><br>
314 \image html SLP_UI_Gadget_PG_image2-2.png "Picture 2-2. Start operation of UI gadget module"
316 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.
320 static void on_start(ui_gadget_h ug, service_h service, void *priv)
326 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>
328 \image html SLP_UI_Gadget_PG_image2-3.png "Picture 2-3. Destroy operation of UI gadget module"
330 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:
334 static void on_destroy(ui_gadget_h ug, service_h service, void *priv)
343 evas_object_del(ugd->base);
348 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>
350 \image html SLP_UI_Gadget_PG_image2-4.png "Picture 2-4. Pause operation of UI gadget module"
352 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>
354 \image html SLP_UI_Gadget_PG_image2-5.png "Picture 2-5. Resume operation of UI gadget module"
356 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>
358 \image html SLP_UI_Gadget_PG_image2-6.png "Picture 2-6. Send message to UI gadget module"
360 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>
362 \image html SLP_UI_Gadget_PG_image2-7.png "Picture 2-7. Send system event to UI gadget module"
364 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.
368 static void on_pause(ui_gadget_h ug, service_h service, void *priv)
370 // Do what you need to do when paused.
372 static void on_resume(ui_gadget_h ug, service_h service, void *priv)
374 // Do what you need to do when paused.
377 static void on_message(ui_gadget_h ug, service msg, service_h service, void *priv)
379 // Do what you need to do when paused.
382 static void on_event(ui_gadget_h ug, enum ug_event event, service_h service, void *priv)
385 case UG_EVENT_LOW_MEMORY:
387 case UG_EVENT_LOW_BATTERY:
389 case UG_EVENT_LANG_CHANGE:
391 case UG_EVENT_ROTATE_PORTRAIT:
393 case UG_EVENT_ROTATE_PORTRAIT_UPSIDEDOWN:
395 case UG_EVENT_ROTATE_LANDSCAPE:
397 case UG_EVENT_ROTATE_LANDSCAPE_UPSIDEDOWN:
399 case UG_EVENT_REGION_CHANGE:
407 \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")
410 <h3 class="pg">Send results and destroy request</h3>
411 Usually, an UI gadget needs to send results or destroy request to the UI gadget caller.<br><br>
412 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>
414 \image html SLP_UI_Gadget_PG_image2-8.png "Picture 2-8. Send result"
416 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>
418 \image html SLP_UI_Gadget_PG_image2-9.png "Picture 2-9. UI gadget destroy request"
420 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".
422 \warning After send your result data, you have to release it using <b>service_destroy()</b> API.
424 In our "helloUG-efl", we made two buttons for sending results and destroy request as below:
428 //Include to use service APIs
431 static void result_cb(void *data, Evas_Object *obj, void *event_info)
442 ret = service_create(&result);
444 service_add_extra_data(result, "name", "hello-UG");
445 service_add_extra_data(result, "description", "sample UI gadget");
447 ug_send_result(ugd->ug, result);
450 service_destroy(result);
453 static void back_cb(void *data, Evas_Object *obj, void *event_info)
463 //Send destroy request
464 ug_destroy_me(ugd->ug);
468 \note <b>To use service</b>
469 - Install capi-appfw-application-dev package (add in your RPM spec file)
470 - Modify CMakeFile.txt to use capi package as follow:
473 pkg_check_modules(pkgs REQUIRED elementary ui-gadget-1 capi-appfw-application)
478 <h3 class="pg">Internationalization</h3>
479 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.
482 #define PKGNAME "ug-helloUG-efl"
483 #define _(s) dgettext(PKGNAME, s)
484 #define dgettext_noop(s) (s)
485 #define N_(s) dgettext_noop(s)
488 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:
490 static const char *message[] = {
491 N_("translatable string"),
495 For more information, please see <a href="http://www.gnu.org/software/gettext/manual/gettext.html">GNU gettext utilities</a>.
497 \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")'.
500 <h3 class="pg">Rotation and indicator</h3>
501 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.
502 Available options are as following:
503 - UG_OPT_INDICATOR_ENABLE (default)
504 - UG_OPT_INDICATOR_POTRAIT_ONLY
505 - UG_OPT_LANDSCAPE_ONLY
506 - UG_OPT_INDICATOR_DISABLE
508 And we used UG_OPT_INDICATOR_POTRAIT_ONLY in "helloUG-efl"
511 <h3 class="pg">Build and test</h3>
512 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:
518 IF NOT, please remove the following line in your CMakeList.txt
523 To build "helloUG-efl", follow these steps:
527 # cmake -DCMAKE_INSTALL_PREFIX=/usr ..
531 make home project for your UI gadget in obs.
532 you can find RPM spec file in packaging directory by template.
535 \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>
536 \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
538 Finally, we made our first UI gadget, "helloUG-efl." Let's test it using <i>ug-launcher</i> which is simple UI gadget launcher.
541 # ug-launcher -n helloUG-efl
545 # ELM_THEME=beat ug-launcher -n helloUG-efl -f
548 \note <b>How to use UG launcher</b>
550 # ug-launcher [-F] [-f] -n <UG_NAME> [-d <Argument>]
552 - -d: argument, key, value pair.
553 - -F: Fullview mode (default)
555 \note <b> Example: </b>
557 # ug-launcher -F -n helloUG-efl -d "name,John doe" -d "age,30"
561 <h2 class="pg">How to use UI gadget</h2>
562 Now, we are going to use "helloUG-efl" of previous section.
565 <h3 class="pg">Initialize</h3>
567 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.
568 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>.)
570 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>
572 \note <b>Prototype of ug_init() (See API Reference guide):</b>
574 int ug_init (Display *disp, Window xid, void *win, enum ug_option opt);
576 \note <b>Macros for convenience (see 3 API reference quide):</b>
578 UG_INIT_EFL(win, opt);
582 <h3 class="pg">Create UI gadget instance</h3>
584 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>
586 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.
588 Second, the <i>name</i> is the UI gadget's name (ex. "helloUG-efl")
590 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.
592 Fourth, the <i>service</i> is arguments for the UI gadget which is service type (see \ref service_PG "Tizen Managed API Reference Guide")
594 \warning After create UI gadget, you have to release the argument using <b>service_destroy()</b> API.
596 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.
598 \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")
600 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>
602 \image html SLP_UI_Gadget_PG_image2-11.png "Picture 2-11. Create UI gadget"
604 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>
605 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>
607 \image html SLP_UI_Gadget_PG_image2-12.png "Picture 2-12. Send result"
609 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>
611 \image html SLP_UI_Gadget_PG_image2-13.png "Picture 2-13. Destroy request"
613 \note <b>Prototype of ug_create() (See API reference guide):</b>
615 ui_gadget_h ug_create (ui_gadget_h parent,
621 \note <b>struct ug_cbs</b> is describing some callbacks and private data:
624 void (*layout_cb)(ui_gadget_h ug, enum ug_mode mode, void *priv);
625 void (*result_cb)(ui_gadget_h ug, service result, void *priv);
626 void (*destroy_cb)(ui_gadget_h ug, void *priv);
631 Here are some examples:
639 static void layout_cb(ui_gadget_h ug, enum ug_mode mode, void *priv)
641 Evas_Object *base, *win;
646 base = ug_get_layout(ug);
651 case UG_MODE_FULLVIEW:
652 win = ug_get_window();
655 evas_object_size_hint_weight_set(base, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
656 elm_win_resize_object_add(win, base);
657 ug_disable_effect(ug);
658 evas_object_show(base);
665 static void result_cb(ui_gadget_h ug, service result, void *priv)
667 struct my_data *mydata;
675 service_get_extra_data(result, "name", val);
677 fprintf(stderr, "The name of UI gadget that sends result is %s\n", val);
684 static void destroy_cb(ui_gadget_h ug, void *priv)
686 struct my_data *mydata;
697 ui_gadget_h create_ug(struct my_data *data)
700 struct ug_cbs cbs = {0, };
702 cbs.layout_cb = layout_cb;
703 cbs.result_cb = result_cb;
704 cbs.destroy_cb = destroy_cb;
705 cbs.priv = (void *)data;
707 ug = ug_create(NULL, "helloUG-efl", UG_MODE_FULLVIEW, NULL, &cbs);
717 Evas_Object *main_layout;
720 static void layout_cb(ui_gadget_h ug, enum ug_mode mode, void *priv)
722 Evas_Object *base, *win;
723 struct my_data *mydata;
730 base = ug_get_layout(ug);
735 case UG_MODE_FRAMEVIEW:
736 elm_layout_content_set(mydata->main_layout, "content", base);
743 static void result_cb(ui_gadget_h ug, service result, void *priv)
745 struct my_data *mydata;
754 service_get_extra_data(result, "name", val);
756 fprintf(stderr, "The name of UI gadget that sends result is %s\n", val);
764 static void destroy_cb(ui_gadget_h ug, void *priv)
766 struct my_data *mydata;
777 ui_gadget_h create_ug(struct my_data *data)
780 struct ug_cbs cbs = {0, };
782 cbs.layout_cb = layout_cb;
783 cbs.result_cb = result_cb;
784 cbs.destroy_cb = destroy_cb;
785 cbs.priv = (void *)data;
787 ug = ug_create(NULL, "helloUG-efl", UG_MODE_FRAMEVIEW, NULL, &cbs);
794 <h2 class="pg">Send message</h2>
796 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)
798 \note <b>Prototype of ug_send_message() (See API reference guide):</b>
800 int ug_send_message (ui_gadget_h ug, service msg);
803 \image html SLP_UI_Gadget_PG_image2-14.png "Picture 2-14. Send message"
805 \warning After send your message, you have to release it using <b>service_destroy()</b> API.
810 ret = service_create(&msg);
812 service_add_extra_data(msg, "name", "hello-UG");
813 service_add_extra_data(msg, "description", "sample UI gadget");
816 ug_send_message(ug, msg);
819 service_destroy(msg);
823 <h2 class="pg">Event propagation</h2>
825 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.
827 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>
829 \note <b>Prototype of ug_pause(), ug_resume(), and ug_send_event() (See API reference guide):</b>
832 int ug_resume (void);
833 int ug_send_event (enum ug_event event);
836 \image html SLP_UI_Gadget_PG_image2-15.png "Picture 2-15. Pause event propagation"
837 \image html SLP_UI_Gadget_PG_image2-16.png "Picture 2-16. Resume event propagation"
838 \image html SLP_UI_Gadget_PG_image2-17.png "Picture 2-17. System event propagation"
841 <h2 class="pg">Destroy all UI gadgets</h2>
843 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.
845 When you terminate your application, destroy all UI gadgets using <b>ug_destroy_all()</b>.
847 \note <b>Prototype of ug_destroy_all(See API reference guide): </b>
849 int ug_destroy_all (void);
853 <h2 class="pg">Disable UI gadget effect</h2>
855 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.
857 \note <b>Prototype of ug_disable_effect(See API reference guide): </b>
859 int ug_disable_effect (void);
862 Here are some examples:
865 To disable transition effect :
867 static void layout_cb(struct ui_gadget *ug, enum ug_mode mode, void *priv)
869 Evas_Object *base, *win;
872 base = ug_get_layout(ug);
876 win = ug_get_window();
878 case UG_MODE_FULLVIEW:
879 evas_object_size_hint_weight_set(base, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
880 elm_win_resize_object_add(win, base);
882 ug_disable_effect(ug);
883 evas_object_show(base);