2 * @page Examples Examples
4 * Here is a page with Elementary examples.
6 * @ref bg_01_example_page
8 * @ref bg_02_example_page
10 * @ref bg_03_example_page
12 * @ref actionslider_example_page
14 * @ref transit_example_01_explained
16 * @ref transit_example_02_explained
18 * @ref general_functions_example_page
20 * @ref calendar_example_01
22 * @ref calendar_example_02
24 * @ref calendar_example_03
26 * @ref calendar_example_04
28 * @ref calendar_example_05
30 * @ref calendar_example_06
32 * @ref spinner_example
40 * @ref datetime_example
42 * @ref dayselector_example
52 * @ref diskselector_example_01
54 * @ref diskselector_example_02
56 * @ref list_example_01
58 * @ref list_example_02
60 * @ref list_example_03
62 * @ref toolbar_example_01
64 * @ref toolbar_example_02
66 * @ref toolbar_example_03
68 * @ref segment_control_example
70 * @ref flipselector_example
72 * @ref fileselector_example
74 * @ref fileselector_button_example
76 * @ref fileselector_entry_example
78 * @ref index_example_01
80 * @ref index_example_02
82 * @ref gengrid_example
84 * @ref genlist_example_01
86 * @ref genlist_example_02
88 * @ref genlist_example_03
90 * @ref genlist_example_04
92 * @ref genlist_example_05
94 * @ref thumb_example_01
96 * @ref progressbar_example
98 * @ref slideshow_example
114 * @page bg_01_example_page elm_bg - Plain color background.
115 * @dontinclude bg_example_01.c
117 * The full code for this example can be found at @ref bg_example_01_c,
118 * in the function @c test_bg_plain. It's part of the @c elementar_test
119 * suite, and thus has the code for the three examples referenced by this
122 * This first example just sets a default background with a plain color. The
123 * first part consists of creating an Elementary window. It's the common
124 * piece of code that you'll see everywhere in Elementary: @skip elm_main
127 * Now we really create our background object, using the window object as
132 * Then we set the size hints of the background object so that it will use
133 * all space available for it, and then add it as a resize object to the
134 * window, making it visible in the end:
136 * @skip size_hint_weight_set
137 * @until resize_object_add
139 * See @ref evas_object_size_hint_weight_set and elm_win_resize_object_add()
140 * for more detailed info about these functions.
142 * The end of the example is quite simple, just setting the minimum and
143 * maximum size of the background, so the Elementary window knows that it
144 * has to have at least the minimum size. The background also won't scale to
145 * a size above its maximum. Then we resize the window and show it in the
148 * @skip set size hints
151 * And here we finish our very simple background object usage example.
155 * @page bg_02_example_page elm_bg - Image background.
156 * @dontinclude bg_example_02.c
158 * The full code for this example can be found at @ref bg_example_02_c,
159 * in the function @c test_bg_image. It's part of the @c elementar_test
160 * suite, and thus has the code for the three examples referenced by this
163 * This is the second example, and shows how to use the Elementary
164 * background object to set an image as background of your application.
166 * We start this example exactly in the same way as the previous one, even
167 * when creating the background object:
172 * Now it's the different part.
174 * Our background will have an image, that will be displayed over the
175 * background color. Before loading the image, we set the load size of the
176 * image. The load size is a hint about the size that we want the image
177 * displayed in the screen. It's not the exact size that the image will have,
178 * but usually a bit bigger. The background object can still be scaled to a
179 * size bigger than the one set here. Setting the image load size to
180 * something smaller than its real size will reduce the memory used to keep
181 * the pixmap representation of the image, and the time to load it. Here we
182 * set the load size to 20x20 pixels, but the image is loaded with a size
183 * bigger than that (since it's just a hint):
185 * @skipline load_size_set
187 * And set our background image to be centered, instead of stretched or
188 * scaled, so the effect of the elm_bg_load_size_set() can be easily
191 * @skipline option_set
193 * We need a filename to set, so we get one from the previous installed
194 * images in the @c PACKAGE_DATA_DIR, and write its full path to a buffer.
195 * Then we use this buffer to set the filename in the background object:
200 * Notice that the third argument of the elm_bg_file_set() function is @c
201 * NULL, since we are setting an image to this background. This function
202 * also supports setting an edje group as background, in which case the @c
203 * group parameter wouldn't be @c NULL, but be the name of the group
206 * Finally, we can set the size hints, add the background as a resize
207 * object, and resize the window, exactly the same thing we do in the @ref
208 * bg_01_example_page example:
213 * And this is the end of this example.
215 * This example will look like this:
217 * @image html screenshots/bg_01.png
218 * @image latex screenshots/bg_01.eps width=\textwidth
222 * @page bg_03_example_page elm_bg - Background properties.
223 * @dontinclude bg_example_03.c
225 * The full code for this example can be found at @ref bg_example_03_c, in the
226 * function @c test_bg_options, with the callbacks @c _cb_overlay_changed, @c
227 * _cb_color_changed and @c _cb_radio_changed defined in the beginning of the
228 * file. It's part of the @c elementar_test suite, and thus has the code for
229 * the three examples referenced by this documentation.
231 * This example will show the properties available for the background object,
232 * and will use of some more widgets to set them.
234 * In order to do this, we will set some callbacks for these widgets. The
235 * first is for the radio buttons that will be used to choose the option
236 * passed as argument to elm_bg_option_set():
238 * @skip _cb_radio_changed
241 * The next callback will be used when setting the overlay (using
242 * elm_object_content_set()):
244 * @skip _cb_overlay_changed
248 * And the last one, used to set the color (with elm_bg_color_set()):
250 * @skip _cb_color_changed
253 * We will get back to what these functions do soon. If you want to know more
254 * about how to set these callbacks and what these widgets are, look for:
255 * @li elm_radio_add()
256 * @li elm_check_add()
257 * @li elm_spinner_add()
259 * Now going to the main function, @c test_bg_options, we have the common
260 * code with the other examples:
265 * We add a plain background to this window, so it will have the default
266 * background color behind everything:
268 * @skip bg = elm_bg_add
269 * @until evas_object_show(bg)
271 * Then we add a vertical box (elm_box_add()) that will hold the background
272 * object that we are going to play with, as well as a horizontal box that
276 * @until evas_object_show
278 * Now we add the background object that is going to be of use for our
279 * example. It is an image background, as used in @ref bg_02_example_page ,
280 * so the code should be familiar:
283 * @until evas_object_show
285 * Notice the call to elm_box_pack_end(): it will pack the background object
286 * in the end of the Elementary box declared above. Just refer to that
287 * documentation for more info.
289 * Since this Elementary background is already an image background, we are
290 * going to play with its other properties. We will change its option
291 * (CENTER, SCALE, STRETCH, TILE), its color (RGB), and add an overlay to it.
292 * For all of these properties, we are going to add widgets that will
295 * First, lets add the horizontal box that will hold these widgets:
299 * For now, just consider this @c hbox as a rectangle that will contain the
300 * widgets, and will distribute them horizontally inside its content. Then we
301 * add radio buttons that will allow us to choose the property to use with
305 * @until evas_object_show
307 * Again, I won't give details about the use of these widgets, just look for
308 * their documentation if necessary. It's enough to know for now that we are
309 * packing them in the @c hbox, setting a label for them, and the most
310 * important parts: setting its value to @c ELM_BG_OPTION_CENTER and its
311 * callback to @c _cb_radio_changed (the function defined in the beginning of
312 * this example). We do this for the next 3 radio buttons added after this
313 * one, each of them with a different value.
315 * Now taking a look at the code of the callback @c _cb_radio_changed again,
316 * it will call elm_bg_option_set() with the value set from the checked radio
317 * button, thus setting the option for this background. The background is
318 * passed as argument to the @p data parameter of this callback, and is
319 * referenced here as @c o_bg.
321 * Later we set the default value for this radio button:
323 * @skipline elm_radio_value_set
325 * Then we add a checkbox for the elm_object_content_set() function for the bg:
328 * @until evas_object_show
330 * Now look at the code of the @c _cb_overlay_changed again. If the checkbox
331 * state is checked, an overlay will be added to the background. It's done by
332 * creating an Edje object, and setting it with elm_object_content_set() to the
333 * background object. For information about what are and how to set Edje
334 * object, look at the Edje documentation.
336 * Finally we add a spinner object (elm_spinner_add()) to be used to select
337 * the color of our background. In its callback it's possible to see the call
338 * to elm_bg_color_set(), which will change the color of this background.
339 * This color is used by the background to fill areas where the image doesn't
340 * cover (in this case, where we have an image background). The spinner is
341 * also packed into the @c hbox :
343 * @skip elm_spinner_add
344 * @until evas_object_show
346 * Then we just have to pack the @c hbox inside the @c box, set some size
347 * hints, and show our window:
352 * Now to see this code in action, open elementary_test, and go to the "Bg
353 * Options" test. It should demonstrate what was implemented here.
357 * @page actionslider_example_page Actionslider usage
358 * @dontinclude actionslider_example_01.c
360 * For this example we are going to assume knowledge of evas smart callbacks
361 * and some basic evas object functions. Elementary is not meant to be used
362 * without evas, if you're not yet familiar with evas it probably is worth
365 * And now to the example, when using Elementary we start by including
369 * Next we define some callbacks, they all share the same signature because
370 * they are all to be used with evas_object_smart_callback_add().
371 * The first one just prints the selected label(in two different ways):
374 * This next callback is a little more interesting, it makes the selected
375 * label magnetic(except if it's the center label):
378 * This callback enables or disables the magnetic propertty of the center
382 * And finally a callback to stop the main loop when the window is closed:
385 * To be able to create our actionsliders we need to do some setup, but this
386 * isn't really relevant here, so if you want to know about that go @ref
389 * With all that boring stuff out of the way we can proceed to creating some
391 * All actionsliders are created the same way:
392 * @skipline actionslider_add
393 * Next we must choose where the indicator starts, and for this one we choose
394 * the right, and set the right as magnetic:
395 * @skipline indicator_pos_set
396 * @until magnet_pos_set
398 * We then set the labels for the left and right, passing NULL as an argument
399 * to any of the labels makes that position have no label.
402 * Furthermore we mark both left and right as enabled positions, if we didn't
403 * do this all three positions would be enabled:
406 * Having the the enabled positions we now add a smart callback to change
407 * which position is magnetic, so that only the last selected position is
411 * And finally we set our printing callback and show the actionslider:
415 * For our next actionslider we are going to do much as we did for the
416 * previous except we are going to have the center as the magnet(and not
418 * @skipline actionslider_add
419 * @skipline indicator_pos_set
422 * And another actionslider, in this one the indicator starts on the left.
423 * It has labels only in the center and right, and both bositions are
424 * magnetic. Because the left doesn't have a label and is not magnetic once
425 * the indicator leaves it can't return:
426 * @skipline actionslider_add
427 * @skipline indicator_pos_set
429 * @note The greyed out area is a @ref Styles "style".
431 * And now an actionslider with a label in the indicator, and whose magnet
432 * properties change based on what was last selected:
433 * @skipline actionslider_add
434 * @skipline indicator_pos_set
436 * @note The greyed out area is a @ref Styles "style".
438 * We are almost done, this next one is just an actionslider with all
439 * positions magnetized and having every possible label:
440 * @skipline actionslider_add
441 * @skipline indicator_pos_set
444 * And for our last actionslider we have one that turns the magnetic property
446 * @skipline actionslider_add
447 * @skipline indicator_pos_set
450 * The example will look like this:
452 * @image html screenshots/actionslider_01.png
453 * @image latex screenshots/actionslider_01.eps width=\textwidth
455 * See the full source code @ref actionslider_example_01 "here"
459 * @page transit_example_03_c elm_transit - Combined effects and options.
461 * This example shows how to apply the following transition effects:
469 * It allows you to apply more than one effect at once, and also allows to
470 * set properties like event_enabled, auto_reverse, repeat_times and
473 * @include transit_example_03.c
477 * @page transit_example_04_c elm_transit - Combined effects over two objects.
479 * This example shows how to apply the transition effects:
484 * over two objects. This kind of transition effect is used to make one
485 * object disappear and another one appear on its place.
487 * You can mix more than one effect of this type on the same objects, and the
488 * transition will apply both.
490 * @include transit_example_04.c
494 * @page transit_example_01_explained elm_transit - Basic transit usage.
495 * @dontinclude transit_example_01.c
497 * The full code for this example can be found at @ref transit_example_01_c.
499 * This example shows the simplest way of creating a transition and applying
500 * it to an object. Similarly to every other elementary example, we create a
501 * window, set its title, size, autodel property, and setup a callback to
502 * exit the program when finished:
505 * @until evas_object_resize
507 * We also add a resizable white background to use behind our animation:
510 * @until evas_object_show
512 * And then we add a button that we will use to demonstrate the effects of
516 * @until evas_object_show(win)
518 * Notice that we are not adding the button with elm_win_resize_object_add()
519 * because we don't want the window to control the size of the button. We
520 * will use the transition to change the button size, so it could conflict
521 * with something else trying to control that size.
523 * Now, the simplest code possible to create the resize animation:
528 * As you can see, this code is very easy to understand. First, we create the
529 * transition itself with elm_transit_add(). Then we add the button to this
530 * transition with elm_transit_object_add(), which means that the transition
531 * will operate over this button. The effect that we want now is changing the
532 * object size from 100x50 to 300x150, and can be achieved by adding the
533 * resize effect with elm_transit_effect_resizing_add().
535 * Finally, we set the transition time to 5 seconds and start the transition
536 * with elm_transit_go(). If we wanted more effects applied to this
537 * button, we could add them to the same transition. See the
538 * @ref transit_example_03_c to watch many transitions being applied to an
543 * @page transit_example_02_explained elm_transit - Chained transitions.
544 * @dontinclude transit_example_02.c
546 * The full code for this example can be found at @ref transit_example_02_c.
548 * This example shows how to implement a chain of transitions. This chain is
549 * used to start a transition just after another transition ended. Similarly
550 * to every other elementary example, we create a window, set its title,
551 * size, autodel property, and setup a callback to exit the program when
555 * @until evas_object_resize
557 * We also add a resizable white background to use behind our animation:
560 * @until evas_object_show
562 * This example will have a chain of 4 transitions, each of them applied to
563 * one button. Thus we create 4 different buttons:
566 * @until evas_object_show(bt4)
568 * Now we create a simple translation transition that will be started as soon
569 * as the program loads. It will be our first transition, and the other
570 * transitions will be started just after this transition ends:
575 * The code displayed until now has nothing different from what you have
576 * already seen in @ref transit_example_01_explained, but now comes the new
577 * part: instead of creating a second transition that will start later using
578 * a timer, we create the it normally, and use
579 * elm_transit_chain_transit_add() instead of elm_transit_go. Since we are
580 * adding it in a chain after the first transition, it will start as soon as
581 * the first transition ends:
584 * @until transit_chain_transit_add
586 * Finally we add the 2 other transitions to the chain, and run our program.
587 * It will make one transition start after the other finish, and there is the
592 * @page general_functions_example_page General (top-level) functions example
593 * @dontinclude general_funcs_example.c
595 * As told in their documentation blocks, the
596 * elm_app_compile_*_dir_set() family of functions have to be called
597 * before elm_app_info_set():
598 * @skip tell elm about
599 * @until elm_app_info_set
601 * We are here setting the fallback paths to the compiling time target
602 * paths, naturally. If you're building the example out of the
603 * project's build system, we're assuming they are the canonical ones.
605 * After the program starts, elm_app_info_set() will actually run and
606 * then you'll see an intrincasy: Elementary does the prefix lookup @b
607 * twice. This is so because of the quicklaunch infrastructure in
608 * Elementary (@ref Start), which will register a predefined prefix
609 * for possible users of the launch schema. We're not hooking into a
610 * quick launch, so this first call can't be avoided.
612 * If you ran this example from your "bindir" installation
613 * directiory, no output will emerge from these both attempts -- it
614 * will find the "magic" file there registered and set the prefixes
615 * silently. Otherwise, you could get something like:
617 WARNING: Could not determine its installed prefix for 'ELM'
618 so am falling back on the compiled in default:
620 implied by the following:
623 datadir = usr/share/elementary
624 localedir = usr/share/locale
625 Try setting the following environment variables:
626 ELM_PREFIX - points to the base prefix of install
627 or the next 4 variables
628 ELM_BIN_DIR - provide a specific binary directory
629 ELM_LIB_DIR - provide a specific library directory
630 ELM_DATA_DIR - provide a specific data directory
631 ELM_LOCALE_DIR - provide a specific locale directory
633 * if you also didn't change those environment variables (remember
634 * they are also a valid way of communicating your prefix to the
635 * binary) - this is the scenario where it fallbacks to the paths set
638 * Then, you can check the prefixes set on the standard output:
639 * @skip prefix was set to
640 * @until locale directory is
643 * @skip by using this policy
644 * @until elm_win_autodel_set
645 * we demonstrate the use of Elementary policies. The policy defining
646 * under which circunstances our application should quit automatically
647 * is set to when its last window is closed (this one has just one
648 * window, though). This will save us from having to set a callback
649 * ourselves on the window, like done in @ref bg_example_01_c "this"
650 * example. Note that we need to tell the window to delete itself's
651 * object on a request to destroy the canvas coming, with
652 * elm_win_autodel_set().
654 * What follows is some boilerplate code, creating a frame with a @b
655 * button, our object of interest, and, below, widgets to change the
656 * button's behavior and exemplify the group of functions in question.
658 * @dontinclude general_funcs_example.c
659 * We enabled the focus highlight object for this window, so that you
660 * can keep track of the current focused object better:
661 * @skip elm_win_focus_highlight_enabled_set
662 * @until evas_object_show
663 * Use the tab key to navigate through the focus chain.
665 * @dontinclude general_funcs_example.c
666 * While creating the button, we exemplify how to use Elementary's
667 * finger size information to scale our UI:
668 * @skip fprintf(stdout, "Elementary
669 * @until evas_object_show
671 * @dontinclude general_funcs_example.c
672 * The first checkbox's callback is:
675 * When unsetting the checkbox, we disable the button, which will get a new
676 * decoration (greyed out) and stop receiving events. The focus chain
677 * will also ignore it.
679 * Following, there are 2 more buttons whose actions are focus/unfocus
680 * the top button, respectively:
681 * @skip focus callback
684 * @skip unfocus callback
686 * Note the situations in which they won't take effect:
687 * - the button is not allowed to get focus or
688 * - the button is disabled
690 * The first restriction above you'll get by a second checkbox, whose
692 * @skip focus allow callback
694 * Note that the button will still get mouse events, though.
696 * Next, there's a slider controlling the button's scale:
697 * @skip scaling callback
700 * Experiment with it, so you understand the effect better. If you
701 * change its value, it will mess with the button's original size,
704 * The full code for this example can be found
705 * @ref general_functions_example_c "here".
709 * @page theme_example_01 Theme - Using extensions
711 * @dontinclude theme_example_01.c
713 * Using extensions is extremely easy, discarding the part where you have to
714 * write the theme for them.
716 * In the following example we'll be creating two buttons, one to load or
717 * unload our extension theme and one to cycle around three possible styles,
718 * one of which we created.
720 * After including our one and only header we'll jump to the callback for
721 * the buttons. First one takes care of loading or unloading our extension
722 * file, relative to the default theme set (thus the @c NULL in the
723 * functions first parameter).
724 * @skipline Elementary.h
730 * The second button, as we said before, will just switch around different
731 * styles. In this case we have three of them. The first one is our custom
732 * style, named after something very unlikely to find in the default theme.
733 * The other two styles are the standard and one more, anchor, which exists
734 * in the default and is similar to the default, except the button vanishes
735 * when the mouse is not over it.
740 * So what happens if the style switches to our custom one when the
741 * extension is loaded? Elementary falls back to the default for the
744 * And the main function, simply enough, will create the window, set the
745 * buttons and their callbacks, and just to begin with our button styled
746 * we're also loading our extension at the beginning.
750 * In this case we wanted to easily remove extensions, but all adding an
751 * extension does is tell Elementary where else it should look for themes
752 * when it can't find them in the default theme. Another way to do this
753 * is to set the theme search order using elm_theme_set(), but this requires
754 * that the developer is careful not to override any user configuration.
755 * That can be helped by adding our theme to the end of whatver is already
756 * set, like in the following snippet.
759 * snprintf(buf, sizeof(buf), "%s:./theme_example.edj", elme_theme_get(NULL);
760 * elm_theme_set(NULL, buf);
763 * If we were using overlays instead of extensions, the same thing applies,
764 * but the custom theme must be added to the front of the search path.
766 * In the end, we should be looking at something like this:
768 * @image html screenshots/theme_example_01.png
769 * @image latex screenshots/theme_example_01.eps width=\textwidth
771 * That's all. Boringly simple, and the full code in one piece can be found
772 * @ref theme_example_01.c "here".
774 * And the code for our extension is @ref theme_example.edc "here".
776 * @example theme_example_01.c
777 * @example theme_example.edc
781 * @page theme_example_02 Theme - Using overlays
783 * @dontinclude theme_example_02.c
785 * Overlays are like extensions in that you tell Elementary that some other
786 * theme contains the styles you need for your program. The difference is that
787 * they will be look in first, so they can override the default style of any
790 * There's not much to say about them that hasn't been said in our previous
791 * example about @ref theme_example_01 "extensions", so going quickly through
792 * the code we have a function to load or unload the theme, which will be
793 * called when we click any button.
794 * @skipline Elementary.h
798 * And the main function, creating the window and adding some buttons to it.
799 * We load our theme as an overlay and nothing else. Notice there's no style
800 * set for any button there, which means they should be using the default
805 * That's pretty much it. The full code is @ref theme_example_02.c "here" and
806 * the definition of the theme is the same as before, and can be found in
807 * @ref theme_example.edc "here".
809 * @example theme_example_02.c
813 * @page button_example_00 Button - Hello, Button!
815 * @dontinclude button_example_00.c
817 * Keeping the tradition, this is a simple "Hello, World" button example. We
818 * will show how to create a button and associate and action to be performed
819 * when you click on it.
821 * In the end, we'll be presented with something that looks like this:
823 * @image html screenshots/button_00.png
824 * @image latex screenshots/button_00.eps width=\textwidth
826 * The full code of the example is @ref button_example_00.c "here" and we
827 * will follow here with a rundown of it.
830 * There is only one button on the interface which performs a basic action:
831 * close the application. This behavior is described by on_click() function,
832 * that interrupt the program invoking elm_exit().
837 * On the main() function, we set the basic characteristics of the user
838 * interface. First we use the Elementary library to create a window and
839 * set its policies (such as close when the user click on the window close
843 * @until elm_policy_set
845 * In order to turn it visible on the WM (Window Manager), we also have to
846 * associate it to a canvas through Evas library, and set its dimensions.
848 * @skip evas_object_resize
849 * @until evas_object_show(win)
851 * Then we create a background associated to the window, define its dimensions,
852 * and turn it visible on the canvas.
854 * @until evas_object_show(bg)
857 * Finally we use Elementary to create a button and Evas to set its
858 * proprieties. Here we have not only to give the button dimensions, but also
859 * its coordinates and the action to be performed on the click event.
860 * @skip elm_button_add
861 * @until evas_object_show(btn)
866 * @example button_example_00.c
870 * @page button_example_01 Button - Complete example
872 * @dontinclude button_example_01.c
874 * A button is simple, you click on it and something happens. That said,
875 * we'll go through an example to show in detail the button API less
878 * In the end, we'll be presented with something that looks like this:
880 * @image html screenshots/button_01.png
881 * @image latex screenshots/button_01.eps width=\textwidth
883 * The full code of the example is @ref button_example_01.c "here" and we
884 * will follow here with a rundown of it.
887 * @until Elementary.h
891 * We have several buttons to set different times for the autorepeat timeouts
892 * of the buttons that use it and a few more that we keep track of in our
893 * data struct. The mid button doesn't do much, just moves around according
894 * to what other buttons the user presses. Then four more buttons to move the
895 * central one, and we're also keeping track of the icon set in the middle
896 * button, since when this one moves, we change the icon, and when movement
897 * is finished (by releasing one of the four arrow buttons), we set back the
902 * Keeping any of those four buttons pressed will trigger their autorepeat
903 * callback, where we move the button doing some size hint magic. To
904 * understand how that works better, refer to the @ref Box documentation.
905 * Also, the first time the function is called, we change the icon in the
906 * middle button, using elm_object_content_unset() first to keep the reference
907 * to the previous one, so we don't need to recreate it when we are done
911 * @until size_hint_align_set
914 * One more callback for the option buttons, that just sets the timeouts for
915 * the different autorepeat options.
922 * And the main function, which does some setting up of the buttons in boxes
923 * to make things work. Here we'll go through some snippets only.
925 * For the option buttons, it's just the button with its label and callback.
926 * @skip elm_button_add
927 * @until smart_callback_add
929 * For the ones that move the central button, we have no labels. There are
930 * icons instead, and the autorepeat option is toggled.
932 * @skip elm_button_add
933 * @until data.cursors.up
935 * And just to show the mid button, which doesn't have anything special.
936 * @skip data.cursors.left
937 * @skip elm_button_add
942 * @example button_example_01.c
946 * @page bubble_01_example_page elm_bubble - Simple use.
947 * @dontinclude bubble_example_01.c
949 * This example shows a bubble with all fields set(label, info, content and
950 * icon) and the selected corner changing when the bubble is clicked. To be
951 * able use a bubble we need to do some setup and create a window, for this
952 * example we are going to ignore that part of the code since it isn't
953 * relevant to the bubble.
955 * To have the selected corner change in a clockwise motion we are going to
956 * use the following callback:
961 * Here we are creating an elm_label that is going to be used as the content
963 * @skipline elm_label
965 * @note You could use any evas_object for this, we are using an elm_label
968 * Despite it's name the bubble's icon doesn't have to be an icon, it can be
969 * any evas_object. For this example we are going to make the icon a simple
973 * And finally we have the actual bubble creation and the setting of it's
974 * label, info and content:
977 * @note Because we didn't set a corner, the default("top_left") will be
980 * Now that we have our bubble all that is left is connecting the "clicked"
981 * signals to our callback:
982 * @line smart_callback
984 * This last bubble we created was very complete, so it's pertinent to show
985 * that most of that stuff is optional a bubble can be created with nothing
990 * Our example will look like this:
992 * @image html screenshots/bubble_example_01.png
993 * @image latex screenshots/bubble_example_01.eps width=\textwidth
995 * See the full source code @ref bubble_example_01.c here.
996 * @example bubble_example_01.c
1000 * @page box_example_01 Box - Basic API
1002 * @dontinclude button_example_01.c
1004 * As a special guest tonight, we have the @ref button_example_01 "simple
1005 * button example". There are plenty of boxes in it, and to make the cursor
1006 * buttons that moved a central one around when pressed, we had to use a
1007 * variety of values for their hints.
1009 * To start, let's take a look at the handling of the central button when
1010 * we were moving it around. To achieve this effect without falling back to
1011 * a complete manual positioning of the @c Evas_Object in our canvas, we just
1012 * put it in a box and played with its alignment within it, as seen in the
1013 * following snippet of the callback for the pressed buttons.
1014 * @skip evas_object_size_hint_align_get
1015 * @until evas_object_size_hint_align_set
1017 * Not much to it. We get the current alignment of the object and change it
1018 * by just a little, depending on which button was pressed, then set it
1019 * again, making sure we stay within the 0.0-1.0 range so the button moves
1020 * inside the space it has, instead of disappearing under the other objects.
1022 * But as useful as an example as that may have been, the usual case with boxes
1023 * is to set everything at the moment they are created, like we did for
1024 * everything else in our main function.
1026 * The entire layout of our program is made with boxes. We have one set as the
1027 * resize object for the window, which means it will always be resized with
1028 * the window. The weight hints set to @c EVAS_HINT_EXPAND will tell the
1029 * window that the box can grow past it's minimum size, which allows resizing
1033 * @until evas_object_show
1035 * Two more boxes, set to horizontal, hold the buttons to change the autorepeat
1036 * configuration used by the buttons. We create each to take over all the
1037 * available space horizontally, but we don't want them to grow vertically,
1038 * so we keep that axis of the weight with 0.0. Then it gets packed in the
1041 * @until evas_object_show
1043 * The buttons in each of those boxes have nothing special, they are just packed
1044 * in with their default values and the box will use their minimum size, as set
1045 * by Elementary itself based on the label, icon, finger size and theme.
1047 * But the buttons used to move the central one have a special disposition.
1048 * The top one first, is placed right into the main box like our other smaller
1049 * boxes. Set to expand horizontally and not vertically, and in this case we
1050 * also tell it to fill that space, so it gets resized to take the entire
1051 * width of the window.
1053 * @skip elm_button_add
1054 * @until evas_object_show
1056 * The bottom one will be the same, but for the other two we need to use a
1057 * second box set to take as much space as we have, so we can place our side
1058 * buttons in place and have the big empty space where the central button will
1061 * @until evas_object_show
1063 * Then the buttons will have their hints inverted to the other top and bottom
1064 * ones, to expand and fill vertically and keep their minimum size horizontally.
1065 * @skip elm_button_add
1066 * @until evas_object_show
1068 * The central button takes every thing else. It will ask to be expanded in
1069 * both directions, but without filling its cell. Changing its alignment by
1070 * pressing the buttons will make it move around.
1071 * @skip elm_button_add
1072 * @until evas_object_show
1074 * To end, the rightmost button is packed in the smaller box after the central
1075 * one, and back to the main box we have the bottom button at the end.
1079 * @page box_example_02 Box - Layout transitions
1081 * @dontinclude box_example_02.c
1083 * Setting a customized layout for a box is simple once you have the layout
1084 * function, which is just like the layout function for @c Evas_Box. The new
1085 * and fancier thing we can do with Elementary is animate the transition from
1086 * one layout to the next. We'll see now how to do that through a simple
1087 * example, while also taking a look at some of the API that was left
1088 * untouched in our @ref box_example_01 "previous example".
1090 * @image html screenshots/box_example_02.png
1091 * @image latex screenshots/box_example_02.eps width=\textwidth
1093 * @skipline Elementary.h
1095 * Our application data consists of a list of layout functions, given by
1096 * @c transitions. We'll be animating through them throughout the entire run.
1097 * The box with the stuff to move around and the last layout that was set to
1098 * make things easier in the code.
1100 * @until Transitions_Data
1102 * The box starts with three buttons, clicking on any of them will take it
1103 * out of the box without deleting the object. There are also two more buttons
1104 * outside, one to add an object to the box and the other to clear it.
1105 * This is all to show how you can interact with the items in the box, add
1106 * things and even remove them, while the transitions occur.
1108 * One of the callback we'll be using creates a new button, asks the box for
1109 * the list of its children and if it's not empty, we add the new object after
1110 * the first one, otherwise just place at the end as it will not make any
1116 * The clear button is even simpler. Everything in the box will be deleted,
1117 * leaving it empty and ready to fill it up with more stuff.
1121 * And a little function to remove buttons from the box without deleting them.
1122 * This one is set for the @c clicked callback of the original buttons,
1123 * unpacking them when clicked and placing it somewhere in the screen where
1124 * they will not disturb. Once we do this, the box no longer has any control
1125 * of it, so it will be left untouched until the program ends.
1129 * If we wanted, we could just call @c evas_object_del() on the object to
1130 * destroy it. In this case, no unpack is really necessary, as the box would
1131 * be notified of a child being deleted and adjust its calculations accordingly.
1133 * The core of the program is the following function. It takes whatever
1134 * function is first on our list of layouts and together with the
1135 * @c last_layout, it creates an ::Elm_Box_Transition to use with
1136 * elm_box_layout_transition(). In here, we tell it to start from whatever
1137 * layout we last set, end with the one that was at the top of the list and
1138 * when everything is finished, call us back so we can create another
1139 * transition. Finally, move the new layout to the end of the list so we
1140 * can continue running through them until the program ends.
1144 * The main function doesn't have antyhing special. Creation of box, initial
1145 * buttons and some callback setting. The only part worth mentioning is the
1146 * initialization of our application data.
1148 * @until evas_object_box_layout_stack
1150 * We have a simple static variable, set the box, the first layout we are
1151 * using as last and create the list with the different functions to go
1154 * And in the end, we set the first layout and call the same function we went
1155 * through before to start the run of transitions.
1156 * @until _test_box_transition_change
1158 * For the full code, follow @ref box_example_02.c "here".
1160 * @example box_example_02.c
1164 * @page calendar_example_01 Calendar - Simple creation.
1165 * @dontinclude calendar_example_01.c
1167 * As a first example, let's just display a calendar in our window,
1168 * explaining all steps required to do so.
1170 * First you should declare objects we intend to use:
1171 * @skipline Evas_Object
1173 * Then a window is created, a title is set and its set to be autodeleted.
1174 * More details can be found on windows examples:
1175 * @until elm_win_autodel
1177 * Next a simple background is placed on our windows. More details on
1178 * @ref bg_01_example_page :
1179 * @until evas_object_show(bg)
1181 * Now, the exciting part, let's add the calendar with elm_calendar_add(),
1182 * passing our window object as parent.
1183 * @until evas_object_show(cal);
1185 * To conclude our example, we should show the window and run elm mainloop:
1188 * Our example will look like this:
1190 * @image html screenshots/calendar_example_01.png
1191 * @image latex screenshots/calendar_example_01.eps width=\textwidth
1193 * See the full source code @ref calendar_example_01.c here.
1194 * @example calendar_example_01.c
1198 * @page calendar_example_02 Calendar - Layout strings formatting.
1199 * @dontinclude calendar_example_02.c
1201 * In this simple example, we'll explain how to format the label displaying
1202 * month and year, and also set weekday names.
1204 * To format month and year label, we need to create a callback function
1205 * to create a string given the selected time, declared under a
1206 * <tt> struct tm </tt>.
1208 * <tt> struct tm </tt>, declared on @c time.h, is a structure composed by
1210 * @li tm_sec seconds [0,59]
1211 * @li tm_min minutes [0,59]
1212 * @li tm_hour hour [0,23]
1213 * @li tm_mday day of month [1,31]
1214 * @li tm_mon month of year [0,11]
1215 * @li tm_year years since 1900
1216 * @li tm_wday day of week [0,6] (Sunday = 0)
1217 * @li tm_yday day of year [0,365]
1218 * @li tm_isdst daylight savings flag
1219 * @note glib version has 2 additional fields.
1221 * For our function, only stuff that matters are tm_mon and tm_year.
1222 * But we don't need to access it directly, since there are nice functions
1223 * to format date and time, as @c strftime.
1224 * We will get abbreviated month (%b) and year (%y) (check strftime manpage
1225 * for more) in our example:
1226 * @skipline static char
1229 * We need to alloc the string to be returned, and calendar widget will
1230 * free it when it's not needed, what is done by @c strdup.
1231 * So let's register our callback to calendar object:
1232 * @skipline elm_calendar_format_function_set
1234 * To set weekday names, we should declare them as an array of strings:
1235 * @dontinclude calendar_example_02.c
1236 * @skipline weekdays
1239 * And finally set them to calendar:
1240 * skipline weekdays_names_set
1242 * Our example will look like this:
1244 * @image html screenshots/calendar_example_02.png
1245 * @image latex screenshots/calendar_example_02.eps width=\textwidth
1247 * See the full source code @ref calendar_example_02.c here.
1248 * @example calendar_example_02.c
1252 * @page calendar_example_03 Calendar - Years restrictions.
1253 * @dontinclude calendar_example_03.c
1255 * This example explains how to set max and min year to be displayed
1256 * by a calendar object. This means that user won't be able to
1257 * see or select a date before and after selected years.
1258 * By default, limits are 1902 and maximun value will depends
1259 * on platform architecture (year 2037 for 32 bits); You can
1260 * read more about time functions on @c ctime manpage.
1262 * Straigh to the point, to set it is enough to call
1263 * elm_calendar_min_max_year_set(). First value is minimun year, second
1264 * is maximum. If first value is negative, it won't apply limit for min
1265 * year, if the second one is negative, won't apply for max year.
1266 * Setting both to negative value will clear limits (default state):
1267 * @skipline elm_calendar_min_max_year_set
1269 * Our example will look like this:
1271 * @image html screenshots/calendar_example_03.png
1272 * @image latex screenshots/calendar_example_03.eps width=\textwidth
1274 * See the full source code @ref calendar_example_03.c here.
1275 * @example calendar_example_03.c
1279 * @page calendar_example_04 Calendar - Days selection.
1280 * @dontinclude calendar_example_04.c
1282 * It's possible to disable date selection and to select a date
1283 * from your program, and that's what we'll see on this example.
1285 * If isn't required that users could select a day on calendar,
1286 * only interacting going through months, disabling days selection
1287 * could be a good idea to avoid confusion. For that:
1288 * @skipline elm_calendar_day_selection_disabled_set
1290 * Also, regarding days selection, you could be interested to set a
1291 * date to be highlighted on calendar from your code, maybe when
1292 * a specific event happens, or after calendar creation. Let's select
1293 * two days from current day:
1294 * @dontinclude calendar_example_04.c
1295 * @skipline SECS_DAY
1296 * @skipline current_time
1297 * @until elm_calendar_selected_time_set
1299 * Our example will look like this:
1301 * @image html screenshots/calendar_example_04.png
1302 * @image latex screenshots/calendar_example_04.eps width=\textwidth
1304 * See the full source code @ref calendar_example_04.c here.
1305 * @example calendar_example_04.c
1309 * @page calendar_example_05 Calendar - Signal callback and getters.
1310 * @dontinclude calendar_example_05.c
1312 * Most of setters explained on previous examples have associated getters.
1313 * That's the subject of this example. We'll add a callback to display
1314 * all calendar information every time user interacts with the calendar.
1316 * Let's check our callback function:
1317 * @skipline static void
1318 * @until double interval;
1320 * To get selected day, we need to call elm_calendar_selected_time_get(),
1321 * but to assure nothing wrong happened, we must check for function return.
1322 * It'll return @c EINA_FALSE if fail. Otherwise we can use time set to
1323 * our structure @p stime.
1324 * @skipline elm_calendar_selected_time_get
1327 * Next we'll get information from calendar and place on declared vars:
1328 * @skipline interval
1329 * @until elm_calendar_weekdays_names_get
1331 * The only tricky part is that last line gets an array of strings
1332 * (char arrays), one for each weekday.
1334 * Then we can simple print that to stdin:
1338 * <tt> struct tm </tt> is declared on @c time.h. You can check @c ctime
1339 * manpage to read about it.
1341 * To register this callback, that will be called every time user selects
1342 * a day or goes to next or previous month, just add a callback for signal
1344 * @skipline evas_object_smart_callback_add
1346 * Our example will look like this:
1348 * @image html screenshots/calendar_example_05.png
1349 * @image latex screenshots/calendar_example_05.eps width=\textwidth
1351 * See the full source code @ref calendar_example_05.c here.
1352 * @example calendar_example_05.c
1356 * @page calendar_example_06 Calendar - Calendar marks.
1357 * @dontinclude calendar_example_06.c
1359 * On this example marks management will be explained. Functions
1360 * elm_calendar_mark_add(), elm_calendar_mark_del() and
1361 * elm_calendar_marks_clear() will be covered.
1363 * To add a mark, will be required to choose three things:
1365 * @li mark date, or start date if it will be repeated
1366 * @li mark periodicity
1368 * Style defines the kind of mark will be displayed over marked day,
1369 * on caledar. Default theme supports @b holiday and @b checked.
1370 * If more is required, is possible to set a new theme to calendar
1371 * widget using elm_object_style_set(), and use
1372 * the signal that will be used by such marks.
1374 * Date is a <tt> struct tm </tt>, as defined by @c time.h. More can
1375 * be read on @c ctime manpage.
1376 * If a date relative from current is required, this struct can be set
1378 * @skipline current_time
1379 * @until localtime_r
1381 * Or if it's an absolute date, you can just declare the struct like:
1382 * @dontinclude calendar_example_06.c
1384 * @until christmas.tm_mon
1386 * Periodicity is how frequently the mark will be displayed over the
1387 * calendar. Can be a unique mark (that don't repeat), or it can repeat
1388 * daily, weekly, monthly or annually. It's enumerated by
1389 * @c Elm_Calendar_Mark_Repeat_Type.
1391 * So let's add some marks to our calendar. We will add christmas holiday,
1392 * set Sundays as holidays, and check current day and day after that.
1393 * @dontinclude calendar_example_06.c
1395 * @until christmas.tm_mon
1396 * @skipline current_time
1397 * @until ELM_CALENDAR_WEEKLY
1399 * We kept the return of first mark add, because we don't really won't it
1400 * to be checked, so let's remove it:
1401 * @skipline elm_calendar_mark_del
1403 * After all marks are added and removed, is required to draw them:
1404 * @skipline elm_calendar_marks_draw
1406 * Finally, to clear all marks, let's set a callback for our button:
1407 * @skipline elm_button_add
1408 * @until evas_object_show(bt);
1410 * This callback will receive our calendar object, and should clear it:
1411 * @dontinclude calendar_example_06.c
1414 * @note Remember to draw marks after clear the calendar.
1416 * Our example will look like this:
1418 * @image html screenshots/calendar_example_06.png
1419 * @image latex screenshots/calendar_example_06.eps width=\textwidth
1421 * See the full source code @ref calendar_example_06.c here.
1422 * @example calendar_example_06.c
1426 * @page spinner_example Spinner widget example
1428 * This code places seven Elementary spinner widgets on a window, each of
1429 * them exemplifying a part of the widget's API.
1431 * The first of them is the default spinner:
1432 * @dontinclude spinner_example.c
1433 * @skipline elm_spinner_add
1434 * @until evas_object_show
1435 * As you see, the defaults for a spinner are:
1437 * @li min value set to 0
1438 * @li max value set to 100
1439 * @li step value set to 1
1440 * @li label format set to "%0.f"
1442 * If another format is required, see the second spinner. It will put a text
1443 * before and after the value, and also format value to display two decimals:
1444 * @skipline format_set
1446 * The third one will use a customized step, define new minimum and maximum
1447 * values and enable wrap, so when value reaches minimum it jumps to maximum,
1448 * or jumps to minimum after maximum value is reached. Format is set to display
1450 * @skipline elm_spinner_add
1451 * @until evas_object_show
1453 * The fourth uses @c vertical style, so instead of left and right arrows,
1454 * top and bottom are displayed. Also the change interval is reduced, so
1455 * user can change value faster.
1457 * @skipline interval
1459 * In the fifth the user won't be allowed to set value directly, i.e., will
1460 * be obligate change value only using arrows:
1461 * @skipline editable
1463 * The sixth widget will receive a lot of special values, so
1464 * instead of reading numeric values, user will see labels for each one.
1465 * Also direct edition is disabled, otherwise users would see the numeric
1466 * value on edition mode. User will be able to select a month in this widget:
1467 * @skipline elm_spinner_add
1468 * @until evas_object_show
1470 * Finally the last widget will exemplify how to listen to widget's signals,
1471 * <tt> changed </tt> and <tt> delay,changed </tt>. First we need to
1472 * implement callback functions that will simply print spinner's value:
1473 * @dontinclude spinner_example.c
1480 * The first callback function should be called everytime value changes,
1481 * the second one only after user stops to increment or decrement. Try
1482 * to keep arrows pressed and check the difference.
1483 * @skip smart_callback
1484 * @skipline smart_callback
1485 * @skipline smart_callback
1487 * See the full @ref spinner_example.c "example", whose window should
1488 * look like this picture:
1490 * @image html screenshots/spinner_example.png
1491 * @image latex screenshots/spinner_example.eps width=\textwidth
1493 * See the full @ref spinner_example.c "source code" for this example.
1495 * @example spinner_example.c
1499 * @page slider_example Slider widget example
1501 * This code places seven Elementary slider widgets on a window, each of
1502 * them exemplifying a part of the widget's API.
1504 * The first of them is the default slider:
1505 * @dontinclude slider_example.c
1506 * @skipline elm_slider_add
1507 * @until evas_object_show
1509 * As you see, the defaults for a slider are:
1512 * @li no values (on indicator or unit labels)
1514 * Actually it's pretty useless this way. So let's learn how to improve it.
1516 * If some decoration is required, a label can be set, and icon before and
1517 * after the bar as well. On the second slider will add a @c home icon
1518 * and a @c folder icon at @c end.
1519 * @skip elm_object_text_set
1520 * @until elm_object_part_content_set(sl, "end", ic)
1522 * If the bar size need to be changed, it can be done with span set function,
1523 * that doesn't accounts other widget's parts size. Also the bar can starts
1524 * with a not default value (0.0), as we done on third slider:
1525 * @skipline value_set
1526 * @skipline span_size_set
1528 * So far, users won't be able to see the slider value. If it's required,
1529 * it can be displayed in two different areas, units label or above
1532 * Let's place a units label on our widget, and also let's set minimum and
1533 * maximum value (uses 0.0 and 1.0 by default):
1534 * @skipline unit_format_set
1535 * @skipline min_max_set
1537 * If above the indicator is the place to display the value, just set it.
1538 * Also, is possible to invert a bar, as you can see:
1539 * @skipline indicator_format_set
1540 * @skipline inverted_set
1542 * But if you require to use a function a bit more customized to show the value,
1543 * is possible to registry a callback function that will be called
1544 * to display unit or indicator label. Only the value will be passed to this
1545 * function, that should return a string.
1546 * In this case, a function to free this string will be required.
1548 * Let's exemplify with indicator label on our sixth slider:
1549 * @dontinclude slider_example.c
1560 * Setting callback functions:
1561 * @skipline indicator_format_function_set
1562 * @skipline _indicator_free
1564 * Also, a slider can be displayed vertically:
1565 * @dontinclude slider_example.c
1566 * @skipline elm_slider_horizontal_set
1568 * Finally the last widget will exemplify how to listen to widget's signals,
1569 * <tt> changed </tt> and <tt> delay,changed </tt>. First we need to
1570 * implement callback functions that will simply print slider's value:
1571 * @dontinclude slider_example.c
1578 * The first callback function should be called everytime value changes,
1579 * the second one only after user stops to increment or decrement. Try
1580 * to keep arrows pressed and check the difference.
1581 * @skip smart_callback
1582 * @skipline smart_callback
1583 * @skipline smart_callback
1585 * See the full @ref slider_example.c "example", whose window should
1586 * look like this picture:
1588 * @image html screenshots/slider_example.png
1589 * @image latex screenshots/slider_example.eps width=\textwidth
1591 * See the full @ref slider_example.c "source code" for this example.
1593 * @example slider_example.c
1597 * @page panes_example Panes widget example
1599 * This code places two Elementary panes widgets on a window, one of them
1600 * displayed vertically and the other horizontally, to exemplify
1601 * a part of the widget's API. Also, all the signals emitted by this
1602 * widget will be covered.
1604 * Let's start adding a panes to our window:
1605 * @dontinclude panes_example.c
1606 * @skipline elm_panes_add
1607 * @until evas_object_show
1609 * Now we will set a content (a simple button) to the left side of our
1611 * @skipline elm_button_add
1612 * @until content_left_set
1614 * The content of the right side will be something a bit more elaborated, we'll
1615 * place another panes, displayed vertically (it's displayed horizontally
1617 * @skipline elm_panes_add
1618 * @until content_right_set
1620 * When populating a panes displayed vertically, remember that left content
1621 * will be placed at top, and right content will place at bottom. Next
1622 * we will add two buttons to exemplify that:
1623 * @skipline elm_button_add
1624 * @until content_right_set
1626 * Panes widgets emits 4 different signals, depending on users interaction
1627 * with the draggable bar. We'll add a callback function for each of them.
1629 * <tt> "clicked" signal </tt>:
1631 * Callback function that just print "Clicked" to stdin:
1632 * @dontinclude panes_example.c
1639 * @skipline static void
1642 * Also, add callback function to the panes:
1643 * @skipline "clicked"
1645 * <tt> "press" signal </tt>:
1647 * Callback function that just print "Pressed" to stdin:
1648 * @dontinclude panes_example.c
1651 * @skipline static void
1654 * Also, add callback function to the panes:
1657 * Now, let's try to make our callback functions a bit more useful:
1659 * <tt> "unpress" signal </tt>:
1661 * Suppose we want to know the size proportion of left content after
1662 * user drags the bar. We need to listen for @c unpress signal, and
1663 * get this size from our panes widget. It's done on the following
1665 * @dontinclude panes_example.c
1670 * @skipline static void
1673 * Adding the callback function to the panes:
1674 * @skipline "unpress"
1676 * <tt> "clicked,double" signal </tt>:
1678 * Now, a interesting feature that could be addded to panes widget.
1679 * Hide a content when user double click the draggable bar. It's done
1680 * using a variable to store size and content left size getter and setter
1681 * on the following function:
1682 * @dontinclude panes_example.c
1683 * @skipline static double
1690 * @skipline static void
1695 * Adding the callback function to the panes:
1696 * @skipline "clicked,double"
1699 * See the full @ref panes_example.c "example", whose window should
1700 * look like this picture:
1702 * @image html screenshots/panes_example.png
1703 * @image latex screenshots/panes_example.eps width=\textwidth
1705 * @example panes_example.c
1709 * @page clock_example Clock widget example
1711 * This code places five Elementary clock widgets on a window, each of
1712 * them exemplifying a part of the widget's API.
1714 * The first of them is the pristine clock:
1715 * @dontinclude clock_example.c
1717 * @until evas_object_show
1718 * As you see, the defaults for a clock are:
1720 * - no seconds shown
1722 * For am/pm time, see the second clock:
1723 * @dontinclude clock_example.c
1725 * @until evas_object_show
1727 * The third one will show the seconds digits, which will flip in
1728 * synchrony with system time. Note, besides, that the time itself is
1729 * @b different from the system's -- it was customly set with
1730 * elm_clock_time_set():
1731 * @dontinclude clock_example.c
1732 * @skip with seconds
1733 * @until evas_object_show
1735 * In both fourth and fifth ones, we turn on the <b>edition
1736 * mode</b>. See how you can change each of the sheets on it, and be
1737 * sure to try holding the mouse pressed over one of the sheet
1738 * arrows. The forth one also starts with a custom time set:
1739 * @dontinclude clock_example.c
1741 * @until evas_object_show
1743 * The fifth, besides editable, has only the time @b units editable,
1744 * for hours, minutes and seconds. This exemplifies
1745 * elm_clock_edit_mode_set():
1746 * @dontinclude clock_example.c
1748 * @until evas_object_show
1750 * See the full @ref clock_example.c "example", whose window should
1751 * look like this picture:
1753 * @image html screenshots/clock_example.png
1754 * @image latex screenshots/clock_example.eps width=\textwidth
1756 * See the full @ref clock_example_c "source code" for this example.
1758 * @example clock_example.c
1762 * @page datetime_example Datetime widget example
1764 * This code places three Elementary Datetime widgets on a window, each of
1765 * them exemplifying the widget's different usage.
1767 * The first of them is <b>"only Date display"</b>:
1768 * @dontinclude datetime_example.c
1770 * @until evas_object_show
1772 * For <b>"only Time display"</b>, see the second datetime:
1773 * @dontinclude datetime_example.c
1775 * @until evas_object_show
1777 * The third one will display datetime shows both <b>Date and Time</b>, corresponding format will be
1778 * taken from system @b locale. Note, besides, that the strings are different
1779 * for different language settings.
1781 * <b>Datetime format</b> can be programmatically set by using
1782 * elm_datetime_format_set():
1783 * @dontinclude datetime_example.c
1784 * @skip DATE and TIME
1785 * @until evas_object_show
1786 * The default format of any locale consists:
1790 * - Hour Field(12hr/24hr format)
1792 * - AM/PM (if exists).
1794 * This is how the example program's window looks like with the datetime widget
1795 * showing only date, only time and both date & time:
1797 * @image html screenshots/datetime_example.png
1798 * @image latex screenshots/datetime_example.eps width=\textwidth
1800 * See the full @ref datetime_example_c "source code" for
1803 * @example datetime_example.c
1807 * @page dayselector_example Dayselector widget example
1809 * This code places two Elementary dayselector widgets on a window, each of
1810 * them exemplifying the different widget styles.
1812 * The first of them is the dayselector in default style:
1813 * @dontinclude dayselector_example.c
1814 * @skip weekdays starting from Sunday
1815 * @until evas_object_show
1817 * As you see, the default style displays the weekdays starting from Sunday.
1819 * One can select/unselect a day just by clicking on the day object.
1820 * The selection toggles once it is being pressed.
1823 * For showing weekdays starting from Monday, see the second dayselector:
1824 * @dontinclude dayselector_example.c
1825 * @skip weekdays starting from Monday
1826 * @until evas_object_show
1829 * The following code exemplifies the selection APIs of Dayselector:
1830 * @dontinclude dayselector_example.c
1831 * @skip Callback function
1832 * @until End of clicked callback
1835 * See the full @ref dayselector_example.c "example", whose window should
1836 * look like this picture:
1838 * @image html screenshots/dayselector_example.png
1839 * @image latex screenshots/dayselector_example.eps width=\textwidth
1841 * See the full @ref dayselector_example_c "source code" for this example.
1843 * @example dayselector_example.c
1847 * @page mapbuf_example Mapbuf Widget Example
1849 * This code places a Elementary mapbuf widget on a window,
1850 * to exemplify part of the widget's API.
1852 * First we'll add an window with a background and a vertical box to
1853 * pack our interface elements:
1854 * @dontinclude mapbuf_example.c
1858 * Next we'll simply add the mapbuf widget to the box:
1859 * @skipline mapbuf_add
1862 * But mapbuf is a container widget, it won't do anything alone. So let's
1863 * create a table full of icons. For that we'll loop to fill each line of each
1864 * column. See @ref tutorial_table_01 "tutorial_table_01"
1865 * if you don't know how to use tables:
1866 * @skipline table_add
1870 * Finally, setting mapbuf content:
1871 * @skipline content_set
1874 * Also, would be good a horizontal box with some controls to change mapbuf
1879 * By default map is disabled. So just setting content isn't enough.
1880 * Alpha and smooth settings will be applied when map is enabled.
1881 * So we'll add a check for that. Everytime the map properties
1882 * are changed, map will need to be enabled again. So if you
1883 * want to play a bit with our example, remember to always enable
1884 * map again after concluding your changes.
1885 * @skipline check_add
1888 * We have added a callback function to this check, so it will enable
1890 * @dontinclude mapbuf_example.c
1896 * Let's add check boxes for alpha blending and smooth rendering:
1897 * @skipline check_add
1901 * By default, mapbuf would enable alpha blending and smooth rendering,
1902 * so we need to check boxes to be consistent with its behavior.
1904 * Callback functions look like the one added to the check. This way we
1905 * could enable or disable the both properties:
1906 * @dontinclude mapbuf_example.c
1915 * You'll see that disabling alpha blending will set a black rectangle below
1916 * the icons. That's the reason you only should enable that when you're sure
1917 * the mapbuf content is 100% solid.
1919 * See @ref mapbuf_example.c "mapbuf_example.c", whose window should
1920 * look like this picture:
1922 * @image html screenshots/mapbuf_example.png
1923 * @image latex screenshots/mapbuf_example.eps width=\textwidth
1925 * @example mapbuf_example.c
1929 * @page map_example_01 Map Example - Creation and Zoom
1931 * This code places a Elementary map widget on a window,
1932 * to exemplify part of the widget's API.
1934 * Let's start adding a map to our window:
1935 * @dontinclude map_example_01.c
1936 * @skipline elm_map_add
1937 * @until evas_object_show
1939 * It's enough to display a world map inside our window. But usually you'll
1940 * need to let user interact with the map. We need to place some buttons,
1941 * so the user could control the map. It's done on the followin code.
1942 * If you don't know about boxes, or buttons, check their examples,
1943 * @ref box_example_01 "Box Example 1" and
1944 * @ref button_example_01 "Button Example 1".
1945 * @skipline elm_box_add
1946 * @until _bt_zoom_fill
1948 * We are adding callback functions that will be called when the user clicks
1949 * over these buttons. Let's study such functions, starting from the function
1950 * that will zoom in the map:
1951 * @dontinclude map_example_01.c
1952 * @skipline static void
1955 * First thing done is assure zoom mode is set to manual. It's the default
1956 * mode, but the other buttons will change this, so before setting a new
1957 * zoom value, we need to change the zoom mode.
1959 * Then, we get the current zoom value, increment that, and set the new
1960 * value to the map. If it's bigger than max zoom value allowed, it will
1961 * remain on the maximum allowed, nothing bad will happen. This way we
1962 * don't need to check first if it won't be bigger than max.
1964 * Zoom out function is basically the same thing, but zoom will be decremented
1965 * instead of incremented:
1966 * @skipline static void
1969 * The "X" button, when pressed, will call a function that will
1970 * zoom the map until it fits
1971 * inside the scroll frame with no pixels outside this area:
1972 * @skipline static void
1975 * And the "#" button, will call a function that will zoom until map fills
1976 * scroll, ensuring no pixels are left unfilled:
1977 * @skipline static void
1980 * But we can also set map to show something different from default
1981 * world map, changing the zoom level and region shown. Let's pick a
1982 * wonderful city coordinates, one placed at <tt> 43 20 S, 22 90 W </tt>.
1983 * Since map uses double variables to represent latitude and longitude,
1984 * to represent north or east, we should represent it as positive values,
1985 * and south or west as negative. Also, the value will be represented as
1986 * degree.min. So, for example, our longitude <tt> 43 20 S </tt> will
1988 * by the value <tt> -43.20 </tt>. A zoom set to @c 12 should be enough
1990 * @skipline region_show
1993 * See @ref map_example_01.c "map_example_01.c" for full source,
1994 * whose window should
1995 * look like this picture:
1997 * @image html screenshots/map_example_01.png
1998 * @image latex screenshots/map_example_01.eps width=\textwidth
2000 * @example map_example_01.c
2004 * @page map_example_02 Map Example - Overlay Usage
2006 * This code places a Elementary map widget on a window,
2007 * to exemplify part of the widget's API, related to overlays.
2009 * We'll start this example in the same way
2010 * @ref map_example_01 "Map Example 1". Adding a map with buttons to control
2011 * zoom, so if you didn't read it yet, just do it now.
2012 * @dontinclude map_example_02.c
2013 * @skipline elm_map_add
2016 * Overlays can be placed over the map to represent anything we want. Let's
2017 * say we want to represent some countries and cities with overlays.
2019 * Before we create city or country overlays, let's create class overlays.
2021 * @skipline elm_map_overlay_class_add
2022 * @until elm_map_overlay_icon_set
2023 * These lines create a class overlay which represents cities.
2024 * This class overlay will be used for grouping city overlays.
2025 * Later city overlays in the same class are appended to this class overlay.
2026 * if city overlays are near each other, they will be grouped.
2028 * We can set the icon for the class so that the icon will be displayed
2029 * when city overlays are grouped.
2030 * We can set the zoom required to display the overlays that belongs
2031 * to this class, so if the zoom is less than this value, nothing
2034 * Country class can be created in the same way.
2035 * @skipline elm_map_overlay_class_add
2036 * @until elm_map_overlay_icon_set
2038 * Next we'll create some overlays representing cities and coutries.
2039 * We set the data for the overlay so that can be used later when
2040 * clicked callback is called.
2041 * We'll append them into city class to be grouped.
2042 * We'll append them in a list, to close up them later.
2043 * To create a default overlay, we need to pass the coordinates.
2044 * @skipline elm_map_overlay_add
2045 * @until eina_list_append
2047 * We subscribe a smart callback "overlay,clicked" to create bubble on
2048 * the clicked overlay.
2049 * @dontinclude map_example_02.c
2050 * @skipline "overlay,clicked"
2052 * Finally, on our @c main function, we ask the map to show all the overlays
2053 * with the biggest zoom possible, passing the list of overlays added.
2054 * @skipline elm_map_overlays_show
2056 * We have created a specific structure for this example to store the name
2057 * of the place and a path to a image file to represent it.
2058 * @dontinclude map_example_02.c
2060 * @until Overlay_Data;
2062 * We'll create instances for each place:
2063 * @skipline argentina
2066 * To return an icon, all we need to do is to add a elm_icon and return it:
2067 * @dontinclude map_example_02.c
2068 * @skipline _icon_get(
2071 * For the content, let's return something more elaborate. We will return
2072 * a box with an image representing the place, and the name of this place:
2073 * @skipline _box_get(
2076 * See @ref map_example_02.c "map_example_02.c" for full source,
2077 * whose window should
2078 * look like this picture:
2080 * @image html screenshots/map_example_02.png
2081 * @image latex screenshots/map_example_02.eps width=\textwidth
2083 * @example map_example_02.c
2087 * @page map_example_03 Map Example - Route and Name Usage
2089 * This code places a Elementary map widget on a window,
2090 * to exemplify part of the widget's API, related routes and names.
2092 * In this example, we will suppose we need to set a route for the user
2093 * from his current point (a gps could provide us this information)
2094 * to somewhere else. So we would have coordinates of this
2095 * start point, and would like that he enters the address of his
2096 * destination in a entry, and we'll trace a route on the map.
2098 * We'll start this example in the same way
2099 * @ref map_example_01 "Map Example 1". Adding a map with buttons to control
2100 * zoom, so if you didn't read it yet, just do it now. Actually there is
2101 * a change, that we're aligning buttons to the top, since we wan't a
2102 * vertical control box this time.
2103 * @dontinclude map_example_03.c
2104 * @skipline elm_map_add
2108 * Next we set the box to be vertical and change it's size, weight
2109 * and alignment, so it will occupy the top of the window, from left
2111 * @skipline horizontal_set
2114 * We'll add an entry with a preliminar address, that I know will
2115 * find a coordinate, to examplify names work. But you can try
2116 * lots of addresses. From city or country names to pubs, or whatever
2117 * you want. To try is enough to run the example, type the address and
2118 * press "Route" button. This button will call a function that will
2119 * get the typed address and find the route.
2120 * @skipline entry_add
2124 * The button pass an structure
2125 * instance we make for this example, with all the fields we'll need.
2126 * @dontinclude map_example_03.c
2127 * @skipline _Example_Data
2128 * @until example_data;
2130 * Let's initialize it's fields:
2131 * @skipline example_data.map
2132 * @until example_data.start_lat
2134 * @c map and @c entry are our elementary objects, @c route is set to @c NULL,
2135 * since we don't have one yet, and the coordinates of the start point is set
2136 * (longitude and latitude).
2138 * Also, let's show this start point at the center of the map, and set a zoom
2139 * nice enough to close it:
2140 * @skipline region_show
2143 * These lines were already explained on @ref map_example_02 "Map Example 2".
2145 * Now we'll see the "Route" button callback function:
2146 * @dontinclude map_example_03.c
2149 * @skipline static void
2152 * First we get the address string from our entry. Then we use @c name
2154 * util functions, so we could get coordinates for this address. These
2155 * functions return an #Elm_Map_Name handle for us.
2156 * Function elm_map_name_geo_request() will do this job for us,
2157 * but it's an assyncronous function, since it requires this
2158 * information from the server.
2160 * That's the reason we need to wait for
2161 * <tt> "name,loaded" </tt> signal. We add a callback function for this:
2162 * @dontinclude map_example_03.c
2163 * @skipline static void
2166 * This function will check if a previous route was traced, and if it was,
2167 * it will remove it. Next we'll get destination coordinates from our
2168 * @c name, and use them to add a new route.
2170 * To trace a route we need to know how the user will go through the path.
2171 * Let's suppose he'll be walking, but doesn't like to walk, so we
2172 * need to choose the shortest path intead of the route that would
2173 * made him spend less time. Coordinates of the point from where he will
2174 * start and of the destination point need to be passed as well.
2176 * Finally we'll set a color different from solid red (default), to show
2177 * our route. We set it green.
2179 * See @ref map_example_03.c "map_example_03.c" for full source,
2180 * whose window should
2181 * look like this picture:
2183 * @image html screenshots/map_example_03.png
2184 * @image latex screenshots/map_example_03.eps width=\textwidth
2186 * @example map_example_03.c
2190 * @page diskselector_example_01 Diskselector widget example
2192 * This code places 4 Elementary diskselector widgets on a window, each of
2193 * them exemplifying a part of the widget's API.
2195 * All of them will have weekdays as items, since we won't focus
2196 * on items management on this example. For an example about this subject,
2197 * check @ref diskselector_example_02.
2199 * The first of them is a default diskselector.
2200 * @dontinclude diskselector_example_01.c
2203 * @skipline elm_diskselector_add
2204 * @until evas_object_show
2206 * We are just adding the diskselector, so as you can see, defaults for it are:
2207 * @li Only 3 items visible each time.
2208 * @li Only 3 characters are displayed for labels on side positions.
2209 * @li The first added item remains centeres, i.e., it's the selected item.
2211 * To add items, we are just appending it on a loop, using function
2212 * elm_diskselector_item_append(), that will be better exaplained on
2213 * items management example.
2215 * For a circular diskselector, check the second widget. A circular
2216 * diskselector will display first item after last, and last previous to
2217 * the first one. So, as you can see, @b Sa will appears on left side
2218 * of selected @b Sunday. This property is set with
2219 * elm_diskselector_round_enabled_set().
2221 * Also, we decide to display only 2 character for side labels, instead of 3.
2222 * For this we call elm_diskselector_side_text_max_length_set(). As result,
2223 * we'll see @b Mo displayed instead of @b Mon, when @b Monday is on a
2226 * @skipline elm_diskselector_add
2227 * @until evas_object_show
2229 * But so far, we are only displaying 3 items at once. If more are wanted,
2230 * is enough to call elm_diskselector_display_item_num_set(), as you can
2232 * @skipline elm_diskselector_add
2233 * @until evas_object_show
2235 * @note You can't set less than 3 items to be displayed.
2237 * You can get the number of items in the diskselector by calling
2238 * elm_diskselector_display_item_num_get(), as you can see here:
2239 * @skipline elm_diskselector_add
2241 * Finally, if a bounce effect is required, or you would like to see
2242 * scrollbars, it is possible. But, for default theme, diskselector
2243 * scrollbars will be invisible anyway.
2244 * @skipline elm_diskselector_add
2245 * @until evas_object_show
2247 * See the full @ref diskselector_example_01.c "diskselector_example_01.c"
2248 * code, whose window should look like this picture:
2250 * @image html screenshots/diskselector_example_01.png
2251 * @image latex screenshots/diskselector_example_01.eps width=\textwidth
2253 * @example diskselector_example_01.c
2257 * @page diskselector_example_02 Diskselector - Items management
2259 * This code places a Elementary diskselector widgets on a window,
2260 * along with some buttons trigerring actions on it (though its API).
2261 * It covers most of diskselector item functions.
2263 * On our @c main function, we are adding a default diskselector with
2264 * 3 items. We are only setting their labels (second parameter of function
2265 * elm_diskselector_item_append):
2266 * @dontinclude diskselector_example_02.c
2267 * @skipline elm_diskselector_add
2270 * Next we are adding lots of buttons, each one for a callback function
2271 * that will realize a task covering part of diskselector items API.
2272 * Lets check the first one:
2273 * @skipline elm_button_add
2274 * @until evas_object_show
2276 * We are labeling the button with a task description with
2277 * elm_object_text_set() and setting a callback
2278 * function evas_object_smart_callback_add().
2279 * Each callback function will have the signature:
2280 * <tt> static void _task_cb(void *data, Evas_Object *obj,
2281 * void *event_info)</tt> with the function name varying for each task.
2283 * Now let's cover all of them.
2285 * <b> Appending an item: </b>
2286 * @dontinclude diskselector_example_02.c
2290 * All items are included on diskselector after last one. You @b can't
2293 * The first parameter of elm_diskselector_item_append() is the diskselector
2294 * object, that we are receiving as data on our callback function.
2295 * The second one is a label, the string that will be placed in the center
2296 * of our item. As we don't wan't icons or callback functions, we can
2297 * send NULL as third, fourth and fifth parameters.
2299 * <b> Appending an item with icon: </b>
2300 * @dontinclude diskselector_example_02.c
2301 * @skipline _add_ic_cb
2304 * If an icon is required, you can pass it as third paramenter on our
2305 * elm_diskselector_item_append() function. It will be place on the
2306 * left side of item's label, that will be shifted to right a bit.
2308 * For more details about how to create icons, look for elm_icon examples.
2310 * <b> Appending an item with callback function for selected: </b>
2311 * @dontinclude diskselector_example_02.c
2316 * To set a callback function that will be called every time an item is
2317 * selected, i.e., everytime the diskselector stops with this item in
2318 * center position, just pass the function as fourth paramenter.
2320 * <b> Appending an item with callback function for selected with data: </b>
2321 * @dontinclude diskselector_example_02.c
2322 * @skipline _sel_data_cb
2328 * If the callback function request an extra data, it can be attached to our
2329 * item passing a pointer for data as fifth parameter.
2330 * Our function _sel_data_cb will receive it as <tt> void *data </tt>.
2332 * If you want to free this data, or handle that the way you need when the
2333 * item is deleted, set a callback function for that, with
2334 * elm_object_item_del_cb_set().
2336 * As you can see we check if @c it is not @c NULL after appending it.
2337 * If an error happens, we won't try to set a function for it.
2339 * <b> Deleting an item: </b>
2340 * @dontinclude diskselector_example_02.c
2345 * To delete an item we simple need to call elm_object_item_del() with
2346 * a pointer for such item.
2348 * If you need, you can get selected item with
2349 * elm_diskselector_selected_item_get(), that will return a pointer for it.
2351 * <b> Unselecting an item: </b>
2352 * @dontinclude diskselector_example_02.c
2353 * @skipline _unselect_cb
2356 * To select an item, you should call elm_diskselector_item_selected_set()
2357 * passing @c EINA_TRUE, and to unselect it, @c EINA_FALSE.
2359 * If you unselect the selected item, diskselector will automatically select
2362 * <b> Printing all items: </b>
2363 * @dontinclude diskselector_example_02.c
2364 * @skipline _print_cb
2367 * <b> Clearing the diskselector: </b>
2368 * @dontinclude diskselector_example_02.c
2369 * @skipline _clear_cb
2372 * <b> Selecting the first item: </b>
2373 * @dontinclude diskselector_example_02.c
2374 * @skipline _select_first_cb
2377 * <b> Selecting the last item: </b>
2378 * @dontinclude diskselector_example_02.c
2379 * @skipline _select_last_cb
2382 * <b> Selecting the next item: </b>
2383 * @dontinclude diskselector_example_02.c
2384 * @skipline _select_next_cb
2387 * <b> Selecting the previous item: </b>
2388 * @dontinclude diskselector_example_02.c
2389 * @skipline _select_prev_cb
2392 * See the full @ref diskselector_example_02.c "diskselector_example_02.c"
2393 * code, whose window should look like this picture:
2395 * @image html screenshots/diskselector_example_02.png
2396 * @image latex screenshots/diskselector_example_02.eps width=\textwidth
2398 * @example diskselector_example_02.c
2402 * @page list_example_01 List widget example
2404 * This code places a single Elementary list widgets on a window, just
2405 * to exemplify the more simple and common use case: a list will be created
2406 * and populated with a few items.
2408 * To keep it simple, we won't show how to customize the list, for this check
2409 * @ref list_example_02. Also, we won't focus
2410 * on items management on this example. For an example about this subject,
2411 * check @ref list_example_03.
2413 * To add a list widget.
2414 * @dontinclude list_example_01.c
2415 * @skipline elm_list_add
2417 * We are just adding the list, so as you can see, defaults for it are:
2418 * @li Items are displayed vertically.
2419 * @li Only one item can be selected.
2420 * @li The list doesn't bouce.
2422 * To add items, we are just appending it on a loop, using function
2423 * elm_list_item_append(), that will be better exaplained on
2424 * items management example.
2425 * @dontinclude list_example_01.c
2429 * @skipline elm_list_item_append
2431 * After we just want to show the list. But first we need to start the widget.
2432 * It was done this way to improve widget's performance. So, always remember
2434 * @warning Call elm_list_go before showing the object
2435 * @skipline elm_list_go
2438 * See the full @ref list_example_01.c "list_example_01.c"
2439 * code, whose window should look like this picture:
2441 * @image html screenshots/list_example_01.png
2442 * @image latex screenshots/list_example_01.eps width=\textwidth
2444 * @example list_example_01.c
2448 * @page list_example_02 List widget example
2450 * This code places a single Elementary list widgets on a window,
2451 * exemplifying a part of the widget's API.
2453 * First, we will just create a simple list, as done on @ref list_example_01 :
2454 * @dontinclude list_example_02.c
2457 * @skipline elm_list_add
2458 * @until elm_list_item_append
2460 * Now, let's customize this list a bit. First we will display items
2462 * @skipline horizontal_set
2464 * Then we will choose another list mode. There are four of them, and
2465 * the default #Elm_List_Mode is #ELM_LIST_SCROLL. Let's set compress mode:
2466 * @skipline mode_set
2468 * To enable multiple items selection, we need to enable it, since only one
2469 * selected item is allowed by default:
2470 * @skipline elm_list_multi_select_set
2472 * We are not adding items with callback functions here,
2473 * since we'll explain it better on @ref list_example_03. But if the callback
2474 * need to be called everytime user clicks an item, even if already selected,
2475 * it's required to enable this behavior:
2476 * @skipline elm_list_select_mode_set
2478 * Finally, if a bounce effect is required, or you would like to see
2479 * scrollbars, it is possible. But, for default theme, list
2480 * scrollbars will be invisible anyway.
2481 * @skipline bounce_set
2482 * @until SCROLLER_POLICY_ON
2484 * See the full @ref list_example_02.c "list_example_02.c"
2485 * code, whose window should look like this picture:
2487 * @image html screenshots/list_example_02.png
2488 * @image latex screenshots/list_example_02.eps width=\textwidth
2490 * @example list_example_02.c
2494 * @page list_example_03 List - Items management
2496 * This code places a Elementary list widgets on a window,
2497 * along with some buttons trigerring actions on it (though its API).
2498 * It covers most of elm_list_item functions.
2500 * On our @c main function, we are adding a default list with
2501 * 3 items. We are only setting their labels (second parameter of function
2502 * elm_list_item_append):
2503 * @dontinclude list_example_03.c
2504 * @skipline elm_list_add
2507 * Next we are adding lots of buttons, each one for a callback function
2508 * that will realize a task covering part of list items API.
2509 * Lets check the first one:
2510 * @skipline elm_button_add
2511 * @until evas_object_show
2513 * We are labeling the button with a task description with
2514 * elm_object_text_set() and setting a callback
2515 * function evas_object_smart_callback_add().
2516 * Each callback function will have the signature:
2517 * <tt> static void _task_cb(void *data, Evas_Object *obj,
2518 * void *event_info)</tt> with the function name varying for each task.
2520 * Now let's cover all of them.
2522 * <b> Prepending an item: </b>
2523 * @dontinclude list_example_03.c
2524 * @skipline _prepend_cb
2527 * The item will be placed on the begining of the list,
2528 * i.e. it will be the first one.
2530 * The first parameter of elm_list_item_prepend() is the list
2531 * object, that we are receiving as data on our callback function.
2532 * The second one is a label, the string that will be placed in the center
2533 * of our item. As we don't wan't icons or callback functions, we can
2534 * send NULL as third, fourth, fifth and sixth parameters.
2536 * <b> Appending an item: </b>
2537 * @dontinclude list_example_03.c
2541 * Items included with append will be inserted inserted after the last one.
2543 * <b> Appending an item with icon: </b>
2544 * @dontinclude list_example_03.c
2545 * @skipline _add_ic_cb
2548 * If an icon is required, you can pass it as third paramenter on our
2549 * elm_list_item_append() function. It will be place on the
2550 * left side of item's label. If an icon is wanted on the right side,
2551 * it should be passed as fourth parameter.
2553 * For more details about how to create icons, look for elm_icon examples
2554 * @ref tutorial_icon.
2556 * <b> Appending an item with callback function for selected: </b>
2557 * @dontinclude list_example_03.c
2562 * To set a callback function that will be called every time an item is
2563 * selected, i.e., everytime the list stops with this item in
2564 * center position, just pass the function as fifth paramenter.
2566 * <b> Appending an item with callback function for selected with data: </b>
2567 * @dontinclude list_example_03.c
2568 * @skipline _sel_data_cb
2574 * If the callback function request an extra data, it can be attached to our
2575 * item passing a pointer for data as sixth parameter.
2576 * Our function _sel_data_cb will receive it as <tt> void *data </tt>.
2578 * If you want to free this data, or handle that the way you need when the
2579 * item is deleted, set a callback function for that, with
2580 * elm_object_item_del_cb_set().
2582 * As you can see we check if @c it is not @c NULL after appending it.
2583 * If an error happens, we won't try to set a function for it.
2585 * <b> Deleting an item: </b>
2586 * @dontinclude list_example_03.c
2587 * @skipline _del_cb(
2590 * To delete an item we simple need to call elm_object_item_del() with
2591 * a pointer for such item.
2593 * If you need, you can get selected item with
2594 * elm_list_selected_item_get(), that will return a pointer for it.
2596 * <b> Unselecting an item: </b>
2597 * @dontinclude list_example_03.c
2598 * @skipline _unselect_cb
2601 * To select an item, you should call elm_list_item_selected_set()
2602 * passing @c EINA_TRUE, and to unselect it, @c EINA_FALSE.
2604 * <b> Printing all items: </b>
2605 * @dontinclude list_example_03.c
2606 * @skipline _print_cb
2609 * <b> Clearing the list: </b>
2610 * @dontinclude list_example_03.c
2611 * @skipline _clear_cb
2614 * <b> Selecting the next item: </b>
2615 * @dontinclude list_example_03.c
2616 * @skipline _select_next_cb
2619 * <b> Inserting after an item: </b>
2620 * @dontinclude list_example_03.c
2621 * @skipline _insert_after_cb
2624 * <b> Selecting the previous item: </b>
2625 * @dontinclude list_example_03.c
2626 * @skipline _select_prev_cb
2629 * <b> Inserting before an item: </b>
2630 * @dontinclude list_example_03.c
2631 * @skipline _insert_before_cb
2634 * If a separator is required, just set an item as such:
2635 * @dontinclude list_example_03.c
2636 * @skipline _set_separator_cb
2639 * Also an item can be disabled, and the user won't be allowed to (un)select it:
2640 * @dontinclude list_example_03.c
2641 * @skipline _disable_cb
2644 * See the full @ref list_example_03.c "list_example_03.c"
2645 * code, whose window should look like this picture:
2647 * @image html screenshots/list_example_03.png
2648 * @image latex screenshots/list_example_03.eps width=\textwidth
2650 * @example list_example_03.c
2654 * @page toolbar_example_01 Toolbar Example - Simple Items
2656 * This code places a Elementary toolbar widget on a window,
2657 * to exemplify part of the widget's API.
2659 * Let's start adding a button to our window, that will have its text
2660 * modified depending on which item is selected. It's used just to exemplify
2661 * how to change a window content from the toolbar.
2662 * @dontinclude toolbar_example_01.c
2663 * @skipline elm_button_add
2664 * @until evas_object_show
2666 * Also, we'll need a toolbar widget, obviously:
2667 * @skipline elm_toolbar_add
2668 * @until evas_object_show
2670 * When appending an item is possible to set an icon, label, and a callback
2671 * function that will receive passed data.
2672 * @skipline _item_append
2675 * It's possible to disable items, so the user can't select then. We will
2676 * disable the third item:
2677 * @skipline _item_append
2680 * Our callbacks will just set button's label:
2681 * @dontinclude toolbar_example_01.c
2689 * By default, toolbars would display items homogeneously, so item with
2690 * long labels, like the third, will make all of them occupy a lot of space.
2691 * To avoid that, we can disable it:
2692 * @dontinclude toolbar_example_01.c
2693 * @skipline homogeneous
2695 * Another default behavior, is to add an menu item if we have more items
2696 * that would fit on toolbar size. To simply enable scroll, without menus,
2697 * it's required to change toolbar's shrink mode:
2698 * @dontinclude toolbar_example_01.c
2701 * See @ref toolbar_example_01.c "toolbar_example_01.c", whose window should
2702 * look like this picture:
2704 * @image html screenshots/toolbar_example_01.png
2705 * @image latex screenshots/toolbar_example_01.eps width=\textwidth
2707 * @example toolbar_example_01.c
2711 * @page toolbar_example_02 Toolbar Example - Items with States
2713 * This code places a Elementary toolbar widget on a window,
2714 * to exemplify part of the widget's API.
2716 * Toolbar widgets has support to items with states. Each state
2717 * can have it's own label, icon, and callback function.
2719 * Let's start populating a toolbar with some regular items.
2720 * If you don't know how to do that, see
2721 * @ref toolbar_example_01 "Toolbar Example 1".
2722 * @dontinclude toolbar_example_02.c
2723 * @skipline elm_toolbar_add
2726 * The only difference here is that we set shrink mode to #ELM_TOOLBAR_SHRINK_HIDE,
2727 * that won't display items that doesn't fit to the window.
2729 * Now, let's add an item with states. First, add the item just as any other.
2730 * @skipline elm_toolbar_item_append
2731 * @until _item_pressed
2733 * After that states can be added to this item:
2734 * @skipline state_add
2736 * @until _item_pressed
2738 * The both states and the item are using the same callback function,
2739 * that will cycle between states and unselect the item. Unseleting
2740 * is required because it won't call the callback if an user clicks
2741 * over an item already selected:
2742 * @dontinclude toolbar_example_02.c
2748 * On our example, some items are hidden
2749 * because we set the window to be small. But if an item should be displayed
2750 * anyway, is needed to set its priority to be higher than others.
2751 * Any positive value will be enough in our case. Let's force the item
2752 * with multiple states to be displayed.
2753 * @skipline priority
2755 * See @ref toolbar_example_02.c "toolbar_example_02.c", whose window should
2756 * look like this picture:
2758 * @image html screenshots/toolbar_example_02.png
2759 * @image latex screenshots/toolbar_example_02.eps width=\textwidth
2761 * @example toolbar_example_02.c
2765 * @page toolbar_example_03 Toolbar Example - Items with Menus
2767 * Toolbar widgets have support to items with menus. This kind
2768 * of item will display a menu when selected by the user.
2770 * Let's start populating a toolbar with some regular items, the same
2771 * way we started @ref toolbar_example_02 "Toolbar Example 2".
2772 * @dontinclude toolbar_example_03.c
2773 * @skipline elm_toolbar_add
2776 * The only difference is that we'll keep the default shrink mode, that
2777 * adds an item with a menu of hidden items.
2779 * So, a important thing to do is to set a parent for toolbar menus, or they
2780 * will use the toolbar as parent, and its size will be restricted to that.
2781 * @skipline parent_set
2783 * Not only items' menus will respect this parent, but also the own toolbar
2784 * menu, used to show hidden items.
2786 * Next, let's add an item set to display a menu:
2787 * @skipline elm_toolbar_item_append
2790 * Now, to add two options to this item, we can get the menu object and use
2791 * it as a regular elm_menu. See @ref tutorial_menu "Menu example" for more
2792 * about menu widget.
2793 * @skipline _menu_get
2796 * See @ref toolbar_example_03.c "toolbar_example_03.c", whose window should
2797 * look like this picture:
2799 * @image html screenshots/toolbar_example_03.png
2800 * @image latex screenshots/toolbar_example_03.eps width=\textwidth
2802 * @example toolbar_example_03.c
2806 * @page segment_control_example Segment Control Example
2808 * This code places a Elementary segment control widgets on a window,
2809 * to exemplify part of the widget's API.
2811 * Let's start adding a segment control to our window:
2812 * @dontinclude segment_control_example.c
2813 * @skipline elm_segment_control_add
2814 * @until evas_object_show
2816 * Now will add an item only with label:
2817 * @skipline item_add
2819 * Really simple. To add an item with only an icon, the icon needs to be created
2820 * first, them added with this same function:
2821 * @skipline icon_add
2824 * If an item with label and icon is required, it can be done as well. In this
2825 * case, instead of a label (or icon) centered, the item will display an icon
2826 * at left and the label at right:
2827 * @skipline icon_add
2830 * But, if you need to add some items that can have or not a label, but
2831 * want that all of them looks the same way, with icon at left, just add
2832 * an empty string label. It's done on our example to ilustrate that:
2833 * @skipline icon_add
2836 * So far, all the item were added to the last position of the widget,
2837 * but if something different is required, it can be done using another
2838 * insertion function. Let's suppose we want to put an item just before
2843 * There are two ways to delete items. Using the item handle, like:
2844 * @skipline insert_at
2847 * Or using item's index:
2848 * @skipline insert_at
2851 * To set properties of an item already added to the widget, you just need
2852 * to get the item and set icon or label, as the following code shows:
2853 * @skipline item_get
2856 * Finally, it's possible to select an item from the code, and also get
2857 * the selected item. We will select the item at the center of the widget
2858 * and print its position.
2859 * @skipline count_get
2862 * See the full @ref segment_control_example.c "example", whose window should
2863 * look like this picture:
2865 * @image html screenshots/segment_control_example.png
2866 * @image latex screenshots/segment_control_example.eps width=\textwidth
2868 * @example segment_control_example.c
2872 * @page flipselector_example Flip selector widget example
2874 * This code places an Elementary flip selector widget on a window,
2875 * along with two buttons trigerring actions on it (though its API).
2877 * The selector is being populated with the following items:
2878 * @dontinclude flipselector_example.c
2882 * Next, we create it, populating it with those items and registering
2883 * two (smart) callbacks on it:
2884 * @dontinclude flipselector_example.c
2885 * @skip fp = elm_flipselector_add
2886 * @until object_show
2888 * Those two callbacks will take place whenever one of those smart
2889 * events occur, and they will just print something to @c stdout:
2890 * @dontinclude flipselector_example.c
2891 * @skip underflow callback
2892 * @until static void
2893 * Flip the sheets on the widget while looking at the items list, in
2894 * the source code, and you'll get the idea of those events.
2896 * The two buttons below the flip selector will take the actions
2897 * described in their labels:
2898 * @dontinclude flipselector_example.c
2899 * @skip bt = elm_button_add
2900 * @until callback_add(win
2902 * @dontinclude flipselector_example.c
2903 * @skip unselect the item
2906 * Click on them to exercise those flip selector API calls. To
2907 * interact with the other parts of this API, there's a command line
2908 * interface, whose help string can be asked for with the 'h' key:
2909 * @dontinclude flipselector_example.c
2913 * The 'n' and 'p' keys will exemplify elm_flipselector_flip_next()
2914 * and elm_flipselector_flip_prev(), respectively. 'f' and 'l' account
2915 * for elm_flipselector_first_item_get() and
2916 * elm_flipselector_last_item_get(), respectively. Finally, 's' will
2917 * issue elm_flipselector_selected_item_get() on our example flip
2920 * See the full @ref flipselector_example.c "example", whose window should
2921 * look like this picture:
2923 * @image html screenshots/flipselector_example.png
2924 * @image latex screenshots/flipselector_example.eps width=\textwidth
2926 * See the full @ref flipselector_example_c "source code" for this example.
2928 * @example flipselector_example.c
2932 * @page fileselector_example File selector widget example
2934 * This code places two Elementary file selector widgets on a window.
2935 * The one on the left is layouting file system items in a @b list,
2936 * while the the other is layouting them in a @b grid.
2938 * The one having the majority of hooks of interest is on the left,
2939 * which we create as follows:
2940 * @dontinclude fileselector_example.c
2941 * @skip first file selector
2942 * @until object_show
2944 * Note that we enable custom edition of file/directory selection, via
2945 * the text entry it has on its bottom, via
2946 * elm_fileselector_is_save_set(). It starts with the list view, which
2947 * is the default, and we make it not expandable in place
2948 * (elm_fileselector_expandable_set()), so that it replaces its view's
2949 * contents with the current directory's entries each time one
2950 * navigates to a different folder. For both of file selectors we are
2951 * starting to list the contents found in the @c "/tmp" directory
2952 * (elm_fileselector_path_set()).
2954 * Note the code setting it to "grid mode" and observe the differences
2955 * in the file selector's views, in the example. We also hide the
2956 * second file selector's Ok/Cancel buttons -- since it's there just
2957 * to show the grid view (and navigation) -- via
2958 * elm_fileselector_buttons_ok_cancel_set().
2960 * The @c "done" event, which triggers the callback below
2961 * @dontinclude fileselector_example.c
2964 * will be called at the time one clicks the "Ok"/"Cancel" buttons of
2965 * the file selector (on the left). Note that it will print the path
2966 * to the current selection, if any.
2968 * The @c "selected" event, which triggers the callback below
2969 * @dontinclude fileselector_example.c
2970 * @skip bt = 'selected' cb
2972 * takes place when one selects a file (if the file selector is @b not
2973 * under folders-only mode) or when one selects a folder (when in
2974 * folders-only mode). Experiment it by selecting different file
2977 * What comes next is the code creating the three check boxes and two
2978 * buttons below the file selector in the right. They will exercise a
2979 * bunch of functions on the file selector's API, for the instance on
2980 * the left. Experiment with them, specially the buttons, to get the
2981 * difference between elm_fileselector_path_get() and
2982 * elm_fileselector_selected_get().
2984 * Finally, there's the code adding the second file selector, on the
2986 * @dontinclude fileselector_example.c
2987 * @skip second file selector
2988 * @until object_show
2990 * Pay attention to the code setting it to "grid mode" and observe the
2991 * differences in the file selector's views, in the example. We also
2992 * hide the second file selector's Ok/Cancel buttons -- since it's
2993 * there just to show the grid view (and navigation) -- via
2994 * elm_fileselector_buttons_ok_cancel_set().
2996 * See the full @ref fileselector_example.c "example", whose window
2997 * should look like this picture:
2999 * @image html screenshots/fileselector_example.png
3000 * @image latex screenshots/fileselector_example.eps width=\textwidth
3002 * See the full @ref fileselector_example_c "source code" for this example.
3004 * @example fileselector_example.c
3008 * @page fileselector_button_example File selector button widget example
3010 * This code places an Elementary file selector button widget on a
3011 * window, along with some other checkboxes and a text entry. Those
3012 * are there just as knobs on the file selector button's state and to
3013 * display information from it.
3015 * Here's how we instantiate it:
3016 * @dontinclude fileselector_button_example.c
3017 * @skip ic = elm_icon_add
3018 * @until evas_object_show
3020 * Note that we set on it both icon and label decorations. It's set to
3021 * list the contents of the @c "/tmp" directory, too, with
3022 * elm_fileselector_button_path_set(). What follows are checkboxes to
3023 * exercise some of its API funtions:
3024 * @dontinclude fileselector_button_example.c
3025 * @skip ck = elm_check_add
3026 * @until evas_object_show(en)
3028 * The checkboxes will toggle whether the file selector button's
3029 * internal file selector:
3030 * - must have an editable text entry for file names (thus, be in
3031 * "save dialog mode")
3032 * - is to be raised as an "inner window" (note it's the default
3033 * behavior) or as a dedicated window
3034 * - is to populate its view with folders only
3035 * - is to expand its folders, in its view, <b>in place</b>, and not
3036 * repainting it entirely just with the contents of a sole
3039 * The entry labeled @c "Last selection" will exercise the @c
3040 * "file,chosen" smart event coming from the file selector button:
3041 * @dontinclude fileselector_button_example.c
3043 * @until toggle inwin
3045 * Whenever you dismiss or acknowledges the file selector, after it's
3046 * raised, the @c event_info string will contain the last selection on
3047 * it (if any was made).
3049 * This is how the example, just after called, should look like:
3051 * @image html screenshots/fileselector_button_example_00.png
3052 * @image latex screenshots/fileselector_button_example_00.eps width=\textwidth
3054 * Click on the file selector button to raise its internal file
3055 * selector, which will be contained on an <b>"inner window"</b>:
3057 * @image html screenshots/fileselector_button_example_01.png
3058 * @image latex screenshots/fileselector_button_example_01.eps width=\textwidth
3060 * Toggle the "inwin mode" switch off and, if you click on the file
3061 * selector button again, you'll get @b two windows, the original one
3062 * (note the last selection there!)
3064 * @image html screenshots/fileselector_button_example_02.png
3065 * @image latex screenshots/fileselector_button_example_02.eps width=\textwidth
3067 * and the file selector's new one
3069 * @image html screenshots/fileselector_button_example_03.png
3070 * @image latex screenshots/fileselector_button_example_03.eps width=\textwidth
3072 * Play with the checkboxes to get the behavior changes on the file
3073 * selector button. The respective API calls on the widget coming from
3074 * those knobs where shown in the code already.
3076 * See the full @ref fileselector_button_example_c "source code" for
3079 * @example fileselector_button_example.c
3083 * @page fileselector_entry_example File selector entry widget example
3085 * This code places an Elementary file selector entry widget on a
3086 * window, along with some other checkboxes. Those are there just as
3087 * knobs on the file selector entry's state.
3089 * Here's how we instantiate it:
3090 * @dontinclude fileselector_entry_example.c
3091 * @skip ic = elm_icon_add
3092 * @until evas_object_show
3094 * Note that we set on it's button both icon and label
3095 * decorations. It's set to exhibit the path of (and list the contents
3096 * of, when internal file selector is launched) the @c "/tmp"
3097 * directory, also, with elm_fileselector_entry_path_set(). What
3098 * follows are checkboxes to exercise some of its API funtions:
3099 * @dontinclude fileselector_entry_example.c
3100 * @skip ck = elm_check_add
3101 * @until callback_add(fs_entry
3103 * The checkboxes will toggle whether the file selector entry's
3104 * internal file selector:
3105 * - must have an editable text entry for file names (thus, be in
3106 * "save dialog mode")
3107 * - is to be raised as an "inner window" (note it's the default
3108 * behavior) or as a dedicated window
3109 * - is to populate its view with folders only
3110 * - is to expand its folders, in its view, <b>in place</b>, and not
3111 * repainting it entirely just with the contents of a sole
3114 * Observe how the entry's text will match the string coming from the
3115 * @c "file,chosen" smart event:
3116 * @dontinclude fileselector_entry_example.c
3119 * Whenever you dismiss or acknowledges the file selector, after it's
3120 * raised, the @c event_info string will contain the last selection on
3121 * it (if any was made).
3123 * Try, also, to type in a valid system path and, then, open the file
3124 * selector's window: it will start the file browsing there, for you.
3126 * This is how the example, just after called, should look like:
3128 * @image html screenshots/fileselector_entry_example_00.png
3129 * @image latex screenshots/fileselector_entry_example_00.eps width=\textwidth
3131 * Click on the file selector entry to raise its internal file
3132 * selector, which will be contained on an <b>"inner window"</b>:
3134 * @image html screenshots/fileselector_entry_example_01.png
3135 * @image latex screenshots/fileselector_entry_example_01.eps width=\textwidth
3137 * Toggle the "inwin mode" switch off and, if you click on the file
3138 * selector entry again, you'll get @b two windows, the original one
3139 * (note the last selection there!)
3141 * @image html screenshots/fileselector_entry_example_02.png
3142 * @image latex screenshots/fileselector_entry_example_02.eps width=\textwidth
3144 * and the file selector's new one
3146 * @image html screenshots/fileselector_entry_example_03.png
3147 * @image latex screenshots/fileselector_entry_example_03.eps width=\textwidth
3149 * Play with the checkboxes to get the behavior changes on the file
3150 * selector entry. The respective API calls on the widget coming from
3151 * those knobs where shown in the code already.
3153 * See the full @ref fileselector_entry_example_c "source code" for
3156 * @example fileselector_entry_example.c
3160 * @page layout_example_01 Layout - Content, Table and Box
3162 * This example shows how one can use the @ref Layout widget to create a
3163 * customized distribution of widgets on the screen, controled by an Edje theme.
3164 * The full source code for this example can be found at @ref
3165 * layout_example_01_c.
3167 * Our custom layout is defined by a file, @ref layout_example_edc, which is an
3168 * Edje theme file. Look for the Edje documentation to understand it. For now,
3169 * it's enough to know that we describe some specific parts on this layout
3171 * @li a title text field;
3172 * @li a box container;
3173 * @li a table container;
3174 * @li and a content container.
3176 * Going straight to the code, the following snippet instantiates the layout
3179 * @dontinclude layout_example_01.c
3180 * @skip elm_layout_add
3181 * @until evas_object_show(layout)
3183 * As any other widget, we set some properties for the size calculation. But
3184 * notice on this piece of code the call to the function elm_layout_file_set().
3185 * Here is where the theme file is loaded, and particularly the specific group
3186 * from this theme file. Also notice that the theme file here is referenced as
3187 * an .edj, which is a .edc theme file compiled to its binary form. Again, look
3188 * for the Edje documentation for more information about theme files.
3190 * Next, we fetch from our theme a data string referenced by the key "title".
3191 * This data was defined in the theme, and can be used as parameters which the
3192 * program get from the specific theme that it is using. In this case, we store
3193 * the title of this window and program in the theme, as a "data" entry, just
3194 * for demonstration purposes:
3198 * This call elm_layout_data_get() is used to fetch the string based on the key,
3199 * and elm_object_part_text_set() will set the part defined in the theme as
3200 * "example/title" to contain this string. This key "example/title" has nothing
3201 * special. It's just an arbitrary convention that we are using in this example.
3202 * Every string in this example referencing a part of this theme will be of the
3203 * form "example/<something>".
3205 * Now let's start using our layout to distribute things on the window space.
3206 * Since the layout was added as a resize object to the elementary window, it
3207 * will always occupy the entire space available for this window.
3209 * The theme already has a title, and it also defines a table element which is
3210 * positioned approximately between 50% and 70% of the height of this window,
3211 * and has 100% of the width. We create some widgets (two icons, a clock and a
3212 * button) and pack them inside the table, in a distribution similar to a HTML
3215 * @until evas_object_show(bt)
3217 * Notice that we just set size hints for every object, and call the function
3218 * elm_layout_table_pack(), which does all the work. It will place the elements
3219 * in the specified row/column, with row and column span if required, and then
3220 * the object's size and position will be controled by the layout widget. It
3221 * will also respect size hints, alignments and weight properties set to these
3222 * widgets. The resulting distribution on the screen depends on the table
3223 * properties (described in the theme), the size hints set on each widget, and
3224 * on the cells of the table that are being used.
3226 * For instance, we add the two icons and the clock on the first, second and
3227 * third cells of the first row, and add the button the second row, making it
3228 * span for 3 columns (thus having the size of the entire table width). This
3229 * will result in a table that has 2 rows and 3 columns.
3231 * Now let's add some widgets to the box area of our layout. This box is around
3232 * 20% and 50% of the vertical size of the layout, and 100% of its width. The
3233 * theme defines that it will use an "horizontal flow" distribution to its
3234 * elements. Unlike the table, a box will distribute elements without knowing
3235 * about rows and columns, and the distribution function selected will take care
3236 * of putting them in row, column, both, or any other available layout. This is
3237 * also described in the Edje documentation.
3239 * This box area is similar to the @ref Box widget of elementary, with the
3240 * difference that its position and properties are controled by the theme of the
3241 * layout. It also contains more than one API to add items to it, since the
3242 * items position now is defined in terms of a list of items, not a matrix.
3243 * There's the first position (can have items added to it with
3244 * elm_layout_box_prepend()), the last position (elm_layout_box_append()), the
3245 * nth position (elm_layout_box_insert_at()) and the position right before an
3246 * element (elm_layout_box_insert_before()). We use insert_at and prepend
3247 * functions to add the first two buttons to this box, and insert_before on the
3248 * callback of each button. The callback code will be shown later, but it
3249 * basically adds a button just before the clicked button using the
3250 * elm_layout_box_insert_before() function. Here's the code for adding the first
3253 * @until evas_object_show(item)
3254 * @until evas_object_show(item)
3256 * Finally, we have an area in this layout theme, in the bottom part of it,
3257 * reserved for adding an specific widget. Differently from the 2 parts
3258 * described until now, this one can only receive one widget with the call
3259 * elm_object_part_content_set() for the layout. If there was already an item on this specific part,
3260 * it will be deleted (one can use elm_object_part_content_unset() in order to remove
3261 * it without deleting). An example of removing it without deleting, but
3262 * manually deleting this widget just after that, can be seen on the callback
3263 * for this button. Actually, the callback defined for this button will clean
3264 * the two other parts (deleting all of their elements) and then remove and
3265 * delete this button.
3267 * @until _swallow_btn_cb
3269 * Also notice that, for this last added button, we don't have to call
3270 * evas_object_show() on it. This is a particularity of the theme for layouts,
3271 * that will have total control over the properties like size, position,
3272 * visibility and clipping of a widget added with elm_object_part_content_set().
3273 * Again, read the Edje documentation to understand this better.
3275 * Now we just put the code for the different callbacks specified for each kind
3276 * of button and make simple comments about them:
3278 * @dontinclude layout_example_01.c
3280 * @until evas_object_del(item)
3283 * The first callback is used for the button in the table, and will just remove
3284 * itself from the table with elm_layout_table_unpack(), which remove items
3285 * without deleting them, and then calling evas_object_del() on itself.
3287 * The second callback is for buttons added to the box. When clicked, these
3288 * buttons will create a new button, and add them to the same box, in the
3289 * position just before the clicked button.
3291 * And the last callback is for the button added to the "content" area. It will
3292 * clear both the table and the box, passing @c EINA_TRUE to their respective @c
3293 * clear parameters, which will imply on the items of these containers being
3296 * A screenshot of this example can be seen on:
3298 * @image html screenshots/layout_example_01.png
3299 * @image latex screenshots/layout_example_01.eps width=\textwidth
3304 * @page layout_example_02 Layout - Predefined Layout
3306 * This example shows how one can use the @ref Layout with a predefined theme
3307 * layout to add a back and next button to a simple window. The full source code
3308 * for this example can be found at @ref layout_example_02_c.
3310 * After setting up the window and background, we add the layout widget to the
3311 * window. But instead of using elm_layout_file_set() to load its theme from a
3312 * custom theme file, we can use elm_layout_theme_set() to load one of the
3313 * predefined layouts that come with elementary. Particularly on this example,
3314 * we load the them of class "layout", group "application" and style
3315 * "content-back-next" (since we want the back and next buttons).
3317 * @dontinclude layout_example_02.c
3318 * @skip elm_layout_add
3319 * @until evas_object_show(layout)
3321 * This default theme contains only a "content" area named
3322 * "elm.swallow.content", where we can add any widget (it can be even a
3323 * container widget, like a box, frame, list, or even another layout). Since we
3324 * just want to show the resulting layout, we add a simple icon to it:
3326 * @until layout_content_set
3328 * This default layout also provides some signals when the next and prev buttons
3329 * are clicked. We can register callbacks to them with the
3330 * elm_object_signal_callback_add() function:
3332 * @until elm,action,next
3334 * In the @ref layout_example_03 you can see how to send signals to the layout with
3335 * elm_object_signal_emit().
3337 * Now our callback just changes the picture being displayed when one of the
3338 * buttons are clicked:
3340 * @dontinclude layout_example_02.c
3342 * @until standard_set
3345 * It's possible to see that it gets the name of the image being shown from the
3346 * array of image names, going forward on this array when "next" is clicked and
3347 * backward when "back" is clicked.
3349 * A screenshot of this example can be seen on:
3351 * @image html screenshots/layout_example_02.png
3352 * @image latex screenshots/layout_example_02.eps width=\textwidth
3356 * @page layout_example_03 Layout - Signals and Size Changed
3358 * This example shows how one can send and receive signals to/from the layout,
3359 * and what to do when the layout theme has its size changed. The full source
3360 * code for this example can be found at @ref layout_example_03_c.
3362 * In this exmaple we will use another group from the same layout theme file
3363 * used in @ref layout_example_01. Its instanciation and loading happens in the
3366 * @dontinclude layout_example_03.c
3367 * @skip elm_layout_add
3368 * @until evas_object_show
3370 * This time we register a callback to be called whenever we receive a signal
3371 * after the end of the animation that happens in this layout:
3373 * @until signal_callback_add
3375 * We also add a button that will send signals to the layout:
3377 * @until callback_add
3379 * The callback for this button will check what type of signal it should send,
3380 * and then emit it. The code for this callback follows:
3382 * @dontinclude layout_example_03.c
3383 * @skip static Eina_Bool
3388 * As we said before, we are receiving a signal whenever the animation started
3389 * by the button click ends. This is the callback for that signal:
3393 * Notice from this callback that the elm_layout_sizing_eval() function must be
3394 * called if we want our widget to update its size after the layout theme having
3395 * changed its minimum size. This happens because the animation specified in the
3396 * theme increases the size of the content area to a value higher than the
3397 * widget size, thus requiring more space. But the elementary layout widget
3398 * has no way to know this, thus needing the elm_layout_sizing_eval() to
3399 * be called on the layout, informing that this size has changed.
3401 * A screenshot of this example can be seen on:
3403 * @image html screenshots/layout_example_03.png
3404 * @image latex screenshots/layout_example_03.eps width=\textwidth
3408 * @page tutorial_hover Hover example
3409 * @dontinclude hover_example_01.c
3411 * On this example we are going to have a button that when clicked will show our
3412 * hover widget, this hover will have content set on it's left, top, right and
3413 * middle positions. In the middle position we are placing a button that when
3414 * clicked will hide the hover. We are also going to use a non-default theme
3415 * for our hover. We won't explain the functioning of button for that see @ref
3418 * We start our example with a couple of callbacks that show and hide the data
3419 * they're given(which we'll see later on is the hover widget):
3424 * In our main function we'll do some initialization and then create 3
3425 * rectangles, one red, one green and one blue to use in our hover. We'll also
3426 * create the 2 buttons that will show and hide the hover:
3429 * With all of that squared away we can now get to the heart of the matter,
3430 * creating our hover widget, which is easy as pie:
3433 * Having created our hover we now need to set the parent and target. Which if
3434 * you recall from the function documentations are going to tell the hover which
3435 * area it should cover and where it should be centered:
3438 * Now we set the theme for our hover. We're using the popout theme which gives
3439 * our contents a white background and causes their appearance to be animated:
3442 * And finally we set the content for our positions:
3445 * So far so good? Great 'cause that's all there is too it, what is left now is
3446 * just connecting our buttons to the callbacks we defined at the beginning of
3447 * the example and run the main loop:
3450 * Our example will initially look like this:
3452 * @image html screenshots/hover_example_01.png
3453 * @image latex screenshots/hover_example_01.eps width=\textwidth
3455 * And after you click the "Show hover" button it will look like this:
3457 * @image html screenshots/hover_example_01_a.png
3458 * @image latex screenshots/hover_example_01_a.eps width=\textwidth
3460 * @example hover_example_01.c
3464 * @page tutorial_flip Flip example
3465 * @dontinclude flip_example_01.c
3467 * This example will show a flip with two rectangles on it(one blue, one
3468 * green). Our example will allow the user to choose the animation the flip
3469 * uses and to interact with it. To allow the user to choose the interaction
3470 * mode we use radio buttons, we will however not explain them, if you would
3471 * like to know more about radio buttons see @ref Radio.
3473 * We start our example with the usual setup and then create the 2 rectangles
3474 * we will use in our flip:
3475 * @until show(rect2)
3477 * The next thing to do is to create our flip and set it's front and back
3481 * The next thing we do is set the interaction mode(which the user can later
3482 * change) to the page animation:
3485 * Setting a interaction mode however is not sufficient, we also need to
3486 * choose which directions we allow interaction from, for this example we
3487 * will use all of them:
3490 * We are also going to set the hitsize to the entire flip(in all directions)
3491 * to make our flip very easy to interact with:
3494 * After that we create our radio buttons and start the main loop:
3497 * When the user clicks a radio button a function that changes the
3498 * interaction mode and animates the flip is called:
3500 * @note The elm_flip_go() call here serves no purpose other than to
3501 * ilustrate that it's possible to animate the flip programmatically.
3503 * Our example will look like this:
3505 * @image html screenshots/flip_example_01.png
3506 * @image latex screenshots/flip_example_01.eps width=\textwidth
3508 * @note Since this is an animated example the screenshot doesn't do it
3509 * justice, it is a good idea to compile it and see the animations.
3511 * @example flip_example_01.c
3515 * @page tutorial_label Label example
3516 * @dontinclude label_example_01.c
3518 * In this example we are going to create 6 labels, set some properties on
3519 * them and see what changes in appearance those properties cause.
3521 * We start with the setup code that by now you should be familiar with:
3524 * For our first label we have a moderately long text(that doesn't fit in the
3525 * label's width) so we will make it a sliding label. Since the text isn't
3526 * too long we don't need the animation to be very long, 3 seconds should
3527 * give us a nice speed:
3530 * For our second label we have the same text, but this time we aren't going
3531 * to have it slide, we're going to ellipsize it. Because we ask our label
3532 * widget to ellipsize the text it will first diminsh the fontsize so that it
3533 * can show as much of the text as possible:
3536 * For the third label we are going to ellipsize the text again, however this
3537 * time to make sure the fontsize isn't diminshed we will set a line wrap.
3538 * The wrap won't actually cause a line break because we set the label to
3542 * For our fourth label we will set line wrapping but won't set ellipsis, so
3543 * that our text will indeed be wrapped instead of ellipsized. For this label
3544 * we choose character wrap:
3547 * Just two more, for our fifth label we do the same as for the fourth
3548 * except we set the wrap to word:
3551 * And last but not least for our sixth label we set the style to "marker" and
3552 * the color to red(the default color is white which would be hard to see on
3553 * our white background):
3556 * Our example will look like this:
3558 * @image html screenshots/label_example_01.png
3559 * @image latex screenshots/label_example_01.eps width=\textwidth
3561 * @example label_example_01.c
3565 * @page tutorial_image Image example
3566 * @dontinclude image_example_01.c
3568 * This example is as simple as possible. An image object will be added to the
3569 * window over a white background, and set to be resizable together with the
3570 * window. All the options set through the example will affect the behavior of
3573 * We start with the code for creating a window and its background, and also
3574 * add the code to write the path to the image that will be loaded:
3579 * Now we create the image object, and set that file to be loaded:
3583 * We can now go setting our options.
3585 * elm_image_no_scale_set() is used just to set this value to true (we
3586 * don't want to scale our image anyway, just resize it).
3588 * elm_image_resizable_set() is used to allow the image to be resized to a size
3589 * smaller than the original one, but not to a size bigger than it.
3591 * elm_elm_image_smooth_set() will disable the smooth scaling, so the scale
3592 * algorithm used to scale the image to the new object size is going to be
3593 * faster, but with a lower quality.
3595 * elm_image_orient_set() is used to flip the image around the (1, 0) (0, 1)
3598 * elm_image_aspect_fixed_set() is used to keep the original aspect
3599 * ratio of the image, even when the window is resized to another aspect ratio.
3601 * elm_image_fill_outside_set() is used to ensure that the image will fill the
3602 * entire area available to it, even if keeping the aspect ratio. The image
3603 * will overflow its width or height (any of them that is necessary) to the
3604 * object area, instead of resizing the image down until it can fit entirely in
3607 * elm_image_editable_set() is used just to cover the API, but won't affect
3608 * this example since we are not using any copy & paste property.
3610 * This is the code for setting these options:
3614 * Now some last touches in our object size hints, window and background, to
3615 * display this image properly:
3619 * This example will look like this:
3621 * @image html screenshots/image_example_01.png
3622 * @image latex screenshots/image_example_01.eps width=\textwidth
3624 * @example image_example_01.c
3628 * @page tutorial_icon Icon example
3629 * @dontinclude icon_example_01.c
3631 * This example is as simple as possible. An icon object will be added to the
3632 * window over a white background, and set to be resizable together with the
3633 * window. All the options set through the example will affect the behavior of
3636 * We start with the code for creating a window and its background:
3641 * Now we create the icon object, and set lookup order of the icon, and choose
3646 * An intersting thing is that after setting this, it's possible to check where
3647 * in the filesystem is the theme used by this icon, and the name of the group
3652 * We can now go setting our options.
3654 * elm_icon_no_scale_set() is used just to set this value to true (we
3655 * don't want to scale our icon anyway, just resize it).
3657 * elm_icon_resizable_set() is used to allow the icon to be resized to a size
3658 * smaller than the original one, but not to a size bigger than it.
3660 * elm_elm_icon_smooth_set() will disable the smooth scaling, so the scale
3661 * algorithm used to scale the icon to the new object size is going to be
3662 * faster, but with a lower quality.
3664 * elm_icon_fill_outside_set() is used to ensure that the icon will fill the
3665 * entire area available to it, even if keeping the aspect ratio. The icon
3666 * will overflow its width or height (any of them that is necessary) to the
3667 * object area, instead of resizing the icon down until it can fit entirely in
3670 * This is the code for setting these options:
3672 * @until fill_outside
3674 * However, if you try this example you may notice that this image is not being
3675 * affected by all of these options. This happens because the used icon will be
3676 * from elementary theme, and thus it has its own set of options like smooth
3677 * scaling and fill_outside options. You can change the "home" icon to use some
3678 * image (from your system) and see that then those options will be respected.
3680 * Now some last touches in our object size hints, window and background, to
3681 * display this icon properly:
3685 * This example will look like this:
3687 * @image html screenshots/icon_example_01.png
3688 * @image latex screenshots/icon_example_01.eps width=\textwidth
3690 * @example icon_example_01.c
3694 * @page tutorial_hoversel Hoversel example
3695 * @dontinclude hoversel_example_01.c
3697 * In this example we will create a hoversel with 3 items, one with a label but
3698 * no icon and two with both a label and an icon. Every item that is clicked
3699 * will be deleted, but everytime the hoversel is activated we will also add an
3700 * item. In addition our first item will print all items when clicked and our
3701 * third item will clear all items in the hoversel.
3703 * We will start with the normal creation of window stuff:
3706 * Next we will create a red rectangle to use as the icon of our hoversel:
3709 * And now we create our hoversel and set some of it's properties. We set @p win
3710 * as its parent, ask it to not be horizontal(be vertical) and give it a label
3712 * @until "icon", rect)
3714 * Next we will add our three items, setting a callback to be called for the
3718 * We also set a pair of callbacks to be called whenever any item is selected or
3719 * when the hoversel is activated:
3722 * And then ask that our hoversel be shown and run the main loop:
3725 * We now have the callback for our first item which prints all items in the
3729 * Next we have the callback for our third item which removes all items from the
3733 * Next we have the callback that is called whenever an item is clicked and
3734 * deletes that item:
3737 * And the callback that is called when the hoversel is activated and adds an
3738 * item to the hoversel. Note that since we allocate memory for the item we need
3739 * to know when the item dies so we can free that memory:
3742 * And finally the callback that frees the memory we allocated for items created
3743 * in the @p _add_item callback:
3746 * Our example will initially look like this:
3748 * @image html screenshots/hoversel_example_01.png
3749 * @image latex screenshots/hoversel_example_01.eps width=\textwidth
3751 * And when the hoversel is clicked it will look like this:
3753 * @image html screenshots/hoversel_example_01_a.png
3754 * @image latex screenshots/hoversel_example_01_a.eps width=\textwidth
3756 * @example hoversel_example_01.c
3760 * @page conformant_example Conformant Example.
3762 * In this example we'll explain how to create applications to work
3763 * with illume, considering space required for virtual keyboards, indicator
3766 * Illume is a module for Enlightenment that modifies the user interface
3767 * to work cleanly and nicely on a mobile device. It has support for
3768 * virtual keyboard, among other nice features.
3770 * Let's start creating a very simple window with a vertical box
3771 * with multi-line entry between two buttons.
3772 * This entry will expand filling all space on window not used by buttons.
3774 * @dontinclude conformant_example_01.c
3775 * @skipline elm_main
3778 * For information about how to create windows, boxes, buttons or entries,
3779 * look for documentation for these widgets.
3781 * It will looks fine when you don't need a virtual keyboard, as you
3782 * can see on the following image:
3784 * @image html screenshots/conformant_example_01.png
3785 * @image latex screenshots/conformant_example_01.eps width=\textwidth
3787 * But if you call a virtual keyboard, the window will resize, changing
3788 * widgets size and position. All the content will shrink.
3790 * If you don't want such behaviour, you
3791 * will need a conformant to account for space taken up by the indicator,
3792 * virtual keyboard and softkey.
3794 * In this case, using the conformant in a proper way, you will have
3795 * a window like the following:
3797 * @image html screenshots/conformant_example_02.png
3798 * @image latex screenshots/conformant_example_02.eps width=\textwidth
3800 * As you can see, it guess the space that will be required by the keyboard,
3801 * indicator and softkey bars.
3803 * So, let's study each step required to transform our initial example on
3806 * First of all, we need to set the window as an illume conformant window:
3807 * @dontinclude conformant_example_02.c
3808 * @skipline elm_win_conformant_set
3810 * Next, we'll add a conformant widget, and set it to resize with the window,
3811 * instead of the box.
3813 * @until evas_object_show
3815 * Finally, we'll set the box as conformant's content, just like this:
3816 * @skipline elm_object_content_set
3818 * Compare both examples code:
3819 * @ref conformant_example_01.c "conformant_example_01.c"
3820 * @ref conformant_example_02.c "conformant_example_02.c"
3822 * @example conformant_example_01.c
3823 * @example conformant_example_02.c
3827 * @page index_example_01 Index widget example 1
3829 * This code places an Elementary index widget on a window, which also
3830 * has a very long list of arbitrary strings on it. The list is
3831 * sorted alphabetically and the index will be used to index the first
3832 * items of each set of strings beginning with an alphabet letter.
3834 * Below the list are some buttons, which are there just to exercise
3835 * some index widget's API.
3837 * Here's how we instantiate it:
3838 * @dontinclude index_example_01.c
3839 * @skip elm_list_add
3840 * @until evas_object_show(d.index)
3841 * where we're showing also the list being created. Note that we issue
3842 * elm_win_resize_object_add() on the index, so that it's set to have
3843 * the whole window as its container. Then, we have to populate both
3844 * list and index widgets:
3845 * @dontinclude index_example_01.c
3846 * @skip for (i = 0; i < (sizeof(dict) / sizeof(dict[0])); i++)
3850 * The strings populating the list come from a file
3851 * @dontinclude index_example_01.c
3852 * @skip static const char *dict
3855 * We use the @c curr char variable to hold the last initial letter
3856 * seen on that ordered list of strings, so that we're able to have an
3857 * index item pointing to each list item starting a new letter
3858 * "section". Note that our index item data pointers will be the list
3859 * item handles. We are also setting a callback function to index
3860 * items deletion events:
3861 * @dontinclude index_example_01.c
3865 * There, we show you that the @c event_info pointer will contain the
3866 * item in question's data, i.e., a given list item's pointer. Because
3867 * item data is also returned in the @c data argument on
3868 * @c Evas_Smart_Cb functions, those two pointers must have the same
3869 * values. On this deletion callback, we're deleting the referred list
3870 * item too, just to exemplify that anything could be done there.
3872 * Next, we hook to two smart events of the index object:
3873 * @dontinclude index_example_01.c
3874 * @skip smart_callback_add(d.index
3875 * @until _index_selected
3876 * @dontinclude index_example_01.c
3877 * @skip "delay,changed" hook
3881 * Check that, whenever one holds the mouse pressed over a given index
3882 * letter for some time, the list beneath it will roll down to the
3883 * item pointed to by that index item. When one releases the mouse
3884 * button, the second callback takes place. There, we check that the
3885 * reported item data, on @c event_info, is the same reported by
3886 * elm_index_selected_item_get(), which gives the last selection's
3887 * data on the index widget.
3889 * The first of the three buttons that follow will call
3890 * elm_index_autohide_disabled_set(), thus showing the index automatically for
3891 * you, if it's not already visible, what is checked with
3892 * elm_index_autohide_disabled_get(). The second button will exercise @b deletion
3893 * of index item objects, by the following code:
3894 * @dontinclude index_example_01.c
3895 * @skip delete an index item
3898 * It will get the last index item selected's data and find the
3899 * respective index item handle(#Elm_Object_Item) with elm_index_item_find().
3900 * We need the latter to query the indexing letter string from, with
3901 * elm_index_item_letter_get(). Next, comes the delition, itself,
3902 * which will also trigger the @c _index_item_del callback function,
3905 * The third button, finally, will exercise elm_index_item_clear(),
3906 * which will delete @b all of the index's items.
3908 * This is how the example program's window looks like with the index
3910 * @image html screenshots/index_example_00.png
3911 * @image latex screenshots/index_example_00.eps
3913 * When it's shown, it's like the following figure:
3914 * @image html screenshots/index_example_01.png
3915 * @image latex screenshots/index_example_01.eps
3917 * See the full @ref index_example_01_c "source code" for
3920 * @example index_example_01.c
3924 * @page index_example_02 Index widget example 2
3926 * This code places an Elementary index widget on a window, indexing
3927 * grid items. The items are placed so that their labels @b don't
3928 * follow any order, but the index itself is ordered (through
3929 * elm_index_item_sorted_insert()). This is a complement to to @ref
3930 * index_example_01 "the first example on indexes".
3932 * Here's the list of item labels to be used on the grid (in that
3934 * @dontinclude index_example_02.c
3935 * @skip static const char *items
3938 * In the interesting part of the code, here, we first instantiate the
3939 * grid (more on grids on their examples) and, after creating our
3940 * index, for each grid item we also create an index one to reference
3942 * @dontinclude index_example_02.c
3943 * @skip grid = elm_gengrid_add
3945 * @until smart_callback_add
3947 * The order in which they'll appear in the index, though, is @b
3948 * alphabetical, becase of elm_index_item_sorted_insert() usage
3949 * together with the comparing function, where we take the letters of
3950 * each index item to base our ordering on. The parameters on
3951 * @c _index_cmp have to be declared as void pointers because of the
3952 * @c Eina_Compare_Cb prototype requisition, but in this case we know
3953 * they'll be index item(#Elm_Object_Item)'s:
3954 * @dontinclude index_example_02.c
3955 * @skip ordering alphabetically
3958 * The last interesting bit is the callback in the @c "delay,changed"
3959 * smart event, which will bring the given grid item to the grid's
3961 * @dontinclude index_example_02.c
3965 * Note how the grid will move kind of randomly while you move your
3966 * mouse pointer held over the index from top to bottom -- that's
3967 * because of the the random order the items have in the grid itself.
3969 * This is how the example program's window looks like:
3970 * @image html screenshots/index_example_03.png
3971 * @image latex screenshots/index_example_03.eps
3973 * See the full @ref index_example.c "source code" for
3976 * @example index_example_02.c
3980 * @page tutorial_ctxpopup Ctxpopup example
3981 * @dontinclude ctxpopup_example_01.c
3983 * In this example we have a list with two items, when either item is clicked
3984 * a ctxpopup for it will be shown. Our two ctxpopups are quite different, the
3985 * one for the first item is a vertical and it's items contain both labels and
3986 * icons, the one for the second item is horizontal and it's items have icons
3989 * We will begin examining our example code by looking at the callback we'll use
3990 * when items in the ctxpopup are clicked. It's very simple, all it does is
3991 * print the label present in the ctxpopup item:
3994 * Next we examine a function that creates ctxpopup items, it was created to
3995 * avoid repeating the same code whenever we needed to add an item to our
3996 * ctxpopup. Our function creates an icon from the standard set of icons, and
3997 * then creates the item, with the label received as an argument. We also set
3998 * the callback to be called when the item is clicked:
4001 * Finally we have the function that will create the ctxpopup for the first item
4002 * in our list. This one is somewhat more complex though, so let's go through it
4003 * in parts. First we declare our variable and add the ctxpopup:
4004 * @until ctxpopup_add
4006 * Next we create a bunch of items for our ctxpopup, marking two of them as
4007 * disabled just so we can see what that will look like:
4008 * @until disabled_set
4009 * @until disabled_set
4011 * Then we ask evas where the mouse pointer was so that we can have our ctxpopup
4012 * appear in the right place, set a maximum size for the ctxpopup, move it and
4016 * And last we mark the list item as not selected:
4019 * Our next function is the callback that will create the ctxpopup for the
4020 * second list item, it is very similar to the previous function. A couple of
4021 * interesting things to note is that we ask our ctxpopup to be horizontal, and
4022 * that we pass NULL as the label for every item:
4025 * And with all of that in place we can now get to our main function where we
4026 * create the window, the list, the list items and run the main loop:
4029 * The example will initially look like this:
4031 * @image html screenshots/ctxpopup_example_01.png
4032 * @image latex screenshots/ctxpopup_example_01.eps width=\textwidth
4034 * @note This doesn't show the ctxpopup tough, since it will only appear when
4035 * we click one of the list items.
4037 * Here is what our first ctxpopup will look like:
4039 * @image html screenshots/ctxpopup_example_01_a.png
4040 * @image latex screenshots/ctxpopup_example_01_a.eps width=\textwidth
4042 * And here the second ctxpopup:
4044 * @image html screenshots/ctxpopup_example_01_b.png
4045 * @image latex screenshots/ctxpopup_example_01_b.eps width=\textwidth
4047 * @example ctxpopup_example_01.c
4051 * @page tutorial_separator Separator example
4052 * @dontinclude separator_example_01.c
4054 * In this example we are going to pack two rectangles in a box, and have a
4055 * separator in the middle.
4057 * So we start we the window, background, box and rectangle creation, all pretty
4061 * Once we have our first rectangle in the box we create and add our separator:
4063 * @note Since our box is in horizontal mode it's a good idea to set the
4064 * separator to be horizontal too.
4066 * And now we add our second rectangle and run the main loop:
4069 * This example will look like this:
4071 * @image html screenshots/separator_example_01.png
4072 * @image latex screenshots/separator_example_01.eps width=\textwidth
4074 * @example separator_example_01.c
4078 * @page tutorial_radio Radio example
4079 * @dontinclude radio_example_01.c
4081 * In this example we will create 4 radio buttons, three of them in a group and
4082 * another one not in the group. We will also have the radios in the group
4083 * change the value of a variable directly and have then print it when the value
4084 * changes. The fourth button is in the example just to make clear that radios
4085 * outside the group don't affect the group.
4087 * We'll start with the usual includes:
4090 * And move right to declaring a static variable(the one whose value the radios
4094 * We now need to have a window and all that good stuff to be able to place our
4098 * And now we create a radio button, since this is the first button in our group
4099 * we set the group to be the radio(so we can set the other radios in the same
4100 * group). We also set the state value of this radio to 1 and the value pointer
4101 * to @p val, since val is @p 1 this has the additional effect of setting the
4102 * radio value to @p 1. For this radio we choose the default home icon:
4105 * To check that our radio buttons are working we'll add a callback to the
4106 * "changed" signal of the radio:
4107 * @until smart_callback
4109 * The creation of our second radio button is almost identical, the 2
4110 * differences worth noting are, the value of this radio 2 and that we add this
4111 * radio to the group of the first radio:
4112 * @until smart_callback
4114 * For our third callback we'll omit the icon and set the value to 3, we'll also
4115 * add it to the group of the first radio:
4116 * @until smart_callback
4118 * Our fourth callback has a value of 4, no icon and most relevantly is not a
4119 * member of the same group as the other radios:
4122 * We finally run the main loop:
4125 * And the last detail in our example is the callback that prints @p val so that
4126 * we can see that the radios are indeed changing its value:
4129 * The example will look like this:
4131 * @image html screenshots/radio_example_01.png
4132 * @image latex screenshots/radio_example_01.eps width=\textwidth
4134 * @example radio_example_01.c
4138 * @page tutorial_toggle Toggle example
4139 * @dontinclude toggle_example_01.c
4141 * In this example we'll create 2 toggle widgets. The first will have an icon
4142 * and the state names will be the default "on"/"off", it will also change the
4143 * value of a variable directly. The second won't have a icon, the state names
4144 * will be "Enabled"/"Disabled", it will start "Enabled" and it won't set the
4145 * value of a variable.
4147 * We start with the usual includes and prototype for callback which will be
4148 * implemented and detailed later on:
4151 * We then declare a static global variable(the one whose value will be changed
4152 * by the first toggle):
4155 * We now have to create our window and all that usual stuff:
4158 * The creation of a toggle is no more complicated than that of any other
4162 * For our first toggle we don't set the states labels so they will stay the
4163 * default, however we do set a label for the toggle, an icon and the variable
4164 * whose value it should change:
4167 * We also set the callback that will be called when the check value changes:
4168 * @until smart_callback
4170 * For our second toggle it important to note that we set the states labels,
4171 * don't set an icon or variable, but set the initial state to
4172 * EINA_TRUE("Enabled"):
4175 * For the second toggle we will use a different callback:
4176 * @until smart_callback
4178 * We then ask the main loop to start:
4181 * The callback for our first toggle will look the value of @p val and print it:
4184 * For our second callback we need to do a little bit more, since the second
4185 * toggle doesn't change the value of a variable we have to ask it what its
4189 * This example will look like this:
4191 * @image html screenshots/toggle_example_01.png
4192 * @image latex screenshots/toggle_example_01.eps width=\textwidth
4194 * @example toggle_example_01.c
4198 * @page tutorial_panel Panel example
4199 * @dontinclude panel_example_01.c
4201 * In this example will have 3 panels, one for each possible orientation. Two of
4202 * our panels will start out hidden, the third will start out expanded. For each
4203 * of the panels we will use a label as the content, it's however possible to
4204 * have any widget(including containers) as the content of panels.
4206 * We start by doing some setup, code you should be familiar with from other
4210 * And move right to creating our first panel, for this panel we are going to
4211 * choose the orientation as TOP and toggle it(tell it to hide itself):
4214 * For the second panel we choose the RIGHT orientation and explicitly set the
4218 * For our third and last panel we won't set the orientation(which means it will
4219 * use the default: LEFT):
4222 * All that is left is running the main loop:
4225 * This example will look like this;
4227 * @image html screenshots/panel_example_01.png
4228 * @image latex screenshots/panel_example_01.eps width=\textwidth
4229 * @note The buttons with arrow allow the user to hide/show the panels.
4231 * @example panel_example_01.c
4235 * @page gengrid_example Gengrid widget example
4237 * This application is a thorough exercise on the gengrid widget's
4238 * API. We place an Elementary gengrid widget on a window, with
4239 * various knobs below its viewport, each one acting on it somehow.
4241 * The code's relevant part begins at the grid's creation. After
4242 * instantiating it, we set its items sizes, so that we don't end with
4243 * items one finger size wide, only. We're setting them to fat, 150
4244 * pixel wide ones, for this example. We give it some size hints, not
4245 * to be discussed in this context and, than, we register a callback
4246 * on one of its smart events -- the one coming each time an item gets
4247 * doubly clicked. There, we just print the item handle's value.
4248 * @dontinclude gengrid_example.c
4249 * @skip grid = elm_gengrid_add
4250 * @until evas_object_sho
4251 * @dontinclude gengrid_example.c
4252 * @skip item double click callback
4255 * Before we actually start to deal with the items API, let's show
4256 * some things items will be using throughout all the code. The first
4257 * of them is a struct to be used as item data, for all of them:
4258 * @dontinclude gengrid_example.c
4259 * @skip typedef struct
4262 * That path will be used to index an image, to be swallowed into one
4263 * of the item's icon spots. The imagens themselves are distributed
4265 * @dontinclude gengrid_example.c
4266 * @skip static const char *imgs
4269 * We also have an (unique) gengrid item class we'll be using for
4270 * items in the example:
4271 * @dontinclude gengrid_example.c
4272 * @skip static Elm_Gengrid_Item_Class
4273 * @until static Elm_Gengrid_Item_Class
4274 * @dontinclude gengrid_example.c
4275 * @skip item_style =
4278 * As you see, our items will follow the default theme on gengrid
4279 * items. For the label fetching code, we return a string composed of
4280 * the item's image path:
4281 * @dontinclude gengrid_example.c
4282 * @skip label fetching callback
4285 * For item icons, we'll be populating the item default theme's two
4286 * icon spots, @c "elm.swallow.icon" and @c "elm.swallow.end". The
4287 * former will receive one of the images in our list (in the form of
4288 * a @ref bg_02_example_page "background"), while the latter will be
4289 * a check widget. Note that we prevent the check to propagate click
4290 * events, so that the user can toggle its state without messing with
4291 * the respective item's selection in the grid:
4292 * @dontinclude gengrid_example.c
4293 * @skip icon fetching callback
4294 * @until return NULL
4297 * As the default gengrid item's theme does not have parts
4298 * implementing item states, we'll be just returning false for every
4300 * @dontinclude gengrid_example.c
4301 * @skip state fetching callback
4304 * Finally, the deletion callback on gengrid items takes care of
4305 * freeing the item's label string and its data struct:
4306 * @dontinclude gengrid_example.c
4307 * @skip deletion callback
4310 * Let's move to item insertion/deletion knobs, them. They are four
4311 * buttons, above the grid's viewport, namely
4312 * - "Append" (to append an item to the grid),
4313 * - "Prepend" (to prepend an item to the grid),
4314 * - "Insert before" (to insert an item before the selection, on the
4316 * - "Insert after" (to insert an item after the selection, on the
4318 * - "Clear" (to delete all items in the grid),
4319 * - "Bring in 1st" (to make the 1st item visible, by scrolling),
4320 * - "Show last" (to directly show the last item),
4322 * which are displaced and declared in that order. We're not dealing
4323 * with the buttons' creation code (see @ref button_example_01
4324 * "a button example", for more details on it), but with their @c
4325 * "clicked" registered callbacks. For all of them, the grid's handle
4326 * is passed as @c data. The ones creating new items use a common
4327 * code, which just gives a new @c Example_Item struct, with @c path
4328 * filled with a random image in our images list:
4329 * @dontinclude gengrid_example.c
4330 * @skip new item with random path
4333 * Moreover, that ones will set a common function to be issued on the
4334 * selection of the items. There, we print the item handle's value,
4335 * along with the callback function data. The latter will be @c NULL,
4336 * always, because it's what we pass when adding all icons. By using
4337 * elm_object_item_data_get(), we can have the item data back and,
4338 * with that, we're priting the item's path string. Finally, we
4339 * exemplify elm_gengrid_item_pos_get(), printing the item's position
4341 * @dontinclude gengrid_example.c
4342 * @skip item selection callback
4345 * The appending button will exercise elm_gengrid_item_append(), simply:
4346 * @dontinclude gengrid_example.c
4347 * @skip append an item
4350 * The prepending, naturally, is analogous, but exercising
4351 * elm_gengrid_item_prepend(), on its turn. The "Insert before" one
4352 * will expect an item to be selected in the grid, so that it will
4353 * insert a new item just before it:
4354 * @dontinclude gengrid_example.c
4355 * @skip "insert before" callback
4358 * The "Insert after" is analogous, just using
4359 * elm_gengrid_item_insert_after(), instead. The "Clear" button will,
4360 * as expected, just issue elm_gengrid_clear():
4361 * @dontinclude gengrid_example.c
4362 * @skip delete items
4365 * The "Bring in 1st" button is there exercise two gengrid functions
4366 * -- elm_gengrid_first_item_get() and elm_gengrid_item_bring_in().
4367 * With the former, we get a handle to the first item and, with the
4368 * latter, you'll see that the widget animatedly scrolls its view
4369 * until we can see that item:
4370 * @dontinclude gengrid_example.c
4371 * @skip bring in 1st item
4374 * The "Show last", in its turn, will use elm_gengrid_last_item_get()
4375 * and elm_gengrid_item_show(). The latter differs from
4376 * elm_gengrid_item_bring_in() in that it immediately replaces the
4377 * contents of the grid's viewport with the region containing the item
4379 * @dontinclude gengrid_example.c
4380 * @skip show last item
4383 * To change the grid's cell (items) size, we've placed a spinner,
4384 * which has the following @c "changed" smart callback:
4385 * @dontinclude gengrid_example.c
4386 * @skip change items' size
4389 * Experiment with it and see how the items are affected. The "Disable
4390 * item" button will, as the name says, disable the currently selected
4392 * @dontinclude gengrid_example.c
4393 * @skip disable selected item
4395 * Note that we also make use of elm_gengrid_item_selected_set(),
4396 * there, thus making the item unselected before we actually disable
4399 * To toggle between horizontal and vertical layouting modes on the
4400 * grid, use the "Horizontal mode" check, which will call the
4401 * respective API function on the grid:
4402 * @dontinclude gengrid_example.c
4403 * @skip change layouting mode
4406 * If you toggle the check right after that one, "Always select",
4407 * you'll notice all subsequent clicks on the @b same grid item will
4408 * still issue the selection callback on it, what is different from
4409 * when it's not checked. This is the
4410 * elm_gengrid_select_mode_set() behavior:
4411 * @dontinclude gengrid_example.c
4412 * @skip "always select" callback
4415 * One more check follows, "Bouncing", which will turn on/off the
4416 * bouncing animations on the grid, when one scrolls past its
4417 * borders. Experiment with scrolling the grid to get the idea, having
4418 * it turned on and off:
4419 * @dontinclude gengrid_example.c
4420 * @skip "bouncing mode" callback
4423 * The next two checks will affect items selection on the grid. The
4424 * first, "Multi-selection", will make it possible to select more the
4425 * one item on the grid. Because it wouldn't make sense to fetch for
4426 * an unique selected item on this case, we also disable two of the
4427 * buttons, which insert items relatively, if multi-selection is on:
4428 * @dontinclude gengrid_example.c
4429 * @skip multi-selection callback
4432 * Note that we also @b unselect all items in the grid, when returning
4433 * from multi-selection mode, making use of
4434 * elm_gengrid_item_selected_set().
4436 * The second check acting on selection, "No selection", is just what
4437 * its name depicts -- no selection will be allowed anymore, on the
4438 * grid, while it's on. Check it out for yourself, interacting with
4440 * @dontinclude gengrid_example.c
4441 * @skip no selection callback
4444 * We have, finally, one more line of knobs, now sliders, to change
4445 * the grids behavior. The two first will change the horizontal @b
4446 * alignment of the whole actual grid of items within the gengrid's
4448 * @dontinclude gengrid_example.c
4449 * @skip items grid horizontal alignment change
4452 * Naturally, the vertical counterpart just issues
4453 * elm_gengrid_align_set() changing the second alignment component,
4456 * The last slider will change the grid's <b>page size</b>, relative
4457 * to its own one. Try to change those values and, one manner of
4458 * observing the paging behavior, is to scroll softly and release the
4459 * mouse button, with different page sizes, at different grid
4460 * positions, while having lots of items in it -- you'll see it
4461 * snapping to page boundaries differenty, for each configuration:
4462 * @dontinclude gengrid_example.c
4463 * @skip page relative size change
4466 * This is how the example program's window looks like:
4467 * @image html screenshots/gengrid_example.png
4468 * @image latex screenshots/gengrid_example.eps width=\textwidth
4470 * Note that it starts with three items which we included at will:
4471 * @dontinclude gengrid_example.c
4472 * @skip _clicked(grid,
4473 * @until _clicked(grid,
4474 * @until _clicked(grid,
4475 * @until _clicked(grid,
4477 * See the full @ref gengrid_example_c "source code" for
4480 * @example gengrid_example.c
4483 * @page entry_example_01 Entry - Example of simple editing
4485 * As a general overview of @ref Entry we are going to write an, albeit simple,
4486 * functional editor. Although intended to show how elm_entry works, this
4487 * example also makes extensive use of several other widgets. The full code
4488 * can be found in @ref entry_example.c "entry_example.c" and in the following
4489 * lines we'll go through the parts especific to the @ref Entry widget.
4491 * The program itself is a simple editor, with a file already set to it, that
4492 * can be set to autosave or not and allows insertion of emoticons and some
4493 * formatted text. As of this writing, the capabilities of format edition in
4494 * the entry are very limited, so a lot of manual work is required to change
4497 * In any case, the program allows some changes by using the buttons on the
4498 * top of the window and returning focus back to the main entry afterwards.
4500 * @image html screenshots/entry_example.png
4501 * @image latex screenshots/entry_example.eps width=\textwidth
4503 * We'll begin by showing a few structures used throught the program. First,
4504 * the application owns data that holds the main window and the main entry
4505 * where the editting happens. Then, an auxiliar structure we'll use later
4506 * when inserting icons in our text.
4507 * @dontinclude entry_example.c
4509 * @until App_Inwin_Data
4511 * A little convenience function will insert whatever text we need in the
4512 * buffer at the current cursor's position and set focus back to this entry.
4513 * This is done mostly because clicking on any button will make them steal
4514 * focus, which makes writing text more cumbersome.
4518 * One of the buttons on the top will trigger an @ref Inwin to open and show
4519 * us several icons we can insert into the text. We'll jump over most of these
4520 * functions, but when all the options are chosen, we insert the special
4521 * markup text that will show the chosen icon in place.
4522 * @skip edje_file_collection_list_free(emos)
4524 * @until evas_object_del
4527 * As can be seen in that function, the program lets us add icons to our entry
4528 * using all the possible configurations for them. That should help to
4529 * clarify how the different combinations work out by actually seeing them
4532 * The same popup window has a page to set the settings of the chosen icon,
4533 * that is, the size and how the item will be placed within the line.
4535 * The size is done with two entries, limitted to accept numbers and a fixed
4536 * size of characters. Changing the value in this entries will update the icon
4537 * size in our struct as seen in the next two callbacks.
4542 * The rest of the options are handled with radio buttons, since only one type
4543 * of size can be used (@c size, @c absize or @c relsize) and for the vertical
4544 * sizing it needs to choose between @c ascent and @c full. Depending on which
4545 * is chosen, the @c item tag is formed accordingly as seen before.
4546 * @skip static Evas_Object
4547 * @until evas_object_show(rvascent)
4549 * The first of our entries is here. There's something worth mentioning about
4550 * the way we'll create this one. Normally, any entry regardless of whether is
4551 * single line or not, will be set to scrollable, but in this case, since we
4552 * are limitting how many characters can fit in them and we know we don't need
4553 * scrolling, we are not setting this flag. This makes the entry have virtually
4554 * no appearance on screen, other than its text. This is because an entry is
4555 * just that, a box that holds text, and in order to have some frame around it
4556 * or a background color, another widget needs to provide this. When an entry
4557 * is scrollable, the same scroller used internally does this.
4558 * We are using @ref Frame "frames" here to provide some decoration around,
4559 * then creating our entries, set them to single line, add our two filters and
4560 * the callback for when their value change.
4561 * @until _height_changed_cb
4563 * This function ends with the button that will finally call the item
4564 * into our editting string.
4567 * Then we get to the format edition. Here we can add the @c bold and
4568 * @c emphasis tags to parts of our text. There's a lot of manual work to
4569 * know what to do here, since we are not implementing an entire state manager
4570 * and the entry itself doesn't, yet, support all the needed capabilities to
4571 * make this simpler. We begin by getting the format we are using in our
4572 * function from the button pressed.
4573 * @skip aid->naviframe = naviframe;
4574 * @until sizeof(fmt_close)
4576 * Next we need to find out if we need to insert an opening or a closing tag.
4577 * For this, we store the current cursor position and create a selection
4578 * from this point until the beginning of our text, and then get the selected
4579 * text to look for any existing format tags in it. This is currently the only
4580 * way in which we can find out what formats is being used in the entry.
4584 * Once we know what tag to insert, we need a second check in the case it was
4585 * a closing tag. This is because any other closing tag that comes after would
4586 * be left dangling alone, so we need to remove it to keep the text consistent.
4589 * Finally, we clear our fake selections and return the cursor back to the
4590 * position it had at first, since there is where we want to insert our format.
4591 * @until cursor_pos_set
4593 * And finish by calling our convenience function from before, to insert the
4594 * text at the current cursor and give focus back to the entry.
4597 * A checkbox on the top of our program tells us if the text we are editing
4598 * will autosave or not. In it's @c "changed" callback we get the value from
4599 * the checkbox and call the elm_entry_autosave_set() function with it. If
4600 * autosave is set, we also call elm_entry_file_save(). This is so the internal
4601 * timer used to periodically store to disk our changes is started.
4605 * Two more functions to show some cursor playing. Whenever we double click
4606 * anywhere on our entry, we'll find what word is the cursor placed at and
4607 * select it. Likewise, for triple clicking, we select the entire line.
4609 * @until _edit_tplclick_cb
4612 * And finally, the main window of the program contains the entry where we
4613 * do all the edition and some helping widgets to change format, add icons
4614 * or change the autosave flag.
4617 * @until _image_insert_cb
4619 * And the main entry of the program. Set to scroll, by default we disable
4620 * autosave and we'll begin with a file set to it because no file selector
4621 * is being used here. The file is loaded with #ELM_TEXT_FORMAT_MARKUP_UTF8
4622 * so that any format contained in it is interpreted, otherwise the entry
4623 * would load it as just text, escaping any tags found and no format or icons
4624 * would be shown. Then we connect to the double and triple click signals
4625 * and set focus on the entry so we can start typing right away.
4628 * @example entry_example.c
4632 * @page genlist_example_01 Genlist - basic usage
4634 * This example creates a simple genlist with a small number of items and
4635 * a callback that is called whenever an item is selected. All the properties of
4636 * this genlist are the default ones. The full code for this example can be seen
4637 * at @ref genlist_example_01_c.
4639 * For the simplest list that you plan to create, it's necessary to define some
4640 * of the basic functions that are used for creating each list item, and
4641 * associating them with the "item class" for that list. The item class is just
4642 * an struct that contains pointers to the specific list item functions that are
4643 * common to all the items of the list.
4645 * Let's show it by example. Our item class is declared globally and static as
4646 * it will be the only item class that we need (we are just creating one list):
4648 * @dontinclude genlist_example_01.c
4649 * @skip static Elm_Genlist
4650 * @until static Elm_Genlist
4652 * This item class will be used for every item that we create. The only
4653 * functions that we are going to set are @c label_get and @c icon_get. As the
4654 * name suggests, they are used by the genlist to generate the label for the
4655 * respective item, and to generate icon(s) to it too. Both the label and icon
4656 * get functions can be called more than once for each item, with different @c
4657 * part parameters, which represent where in the theme of the item that label or
4658 * icon is going to be set.
4660 * The default theme for the genlist contains only one area for label, and two
4661 * areas for icon ("elm.swallow.icon" and "elm.swallow.end"). Since we just want
4662 * to set the first icon (that will be at the left side of the label), we
4663 * compare the part name given with "elm.swallow.icon". Notice that the
4664 * @c label_get function must return a strduped string, that will be freed later
4665 * automatically by the list. Here's the code for @c label_get and @c icon_get:
4667 * @until static void
4669 * We will also provide a function that will be called whenever an item is
4670 * selected in the genlist. However, this function is not part of the item
4671 * class, it will be passed for each item being added to the genlist explicitly.
4672 * Notice the similarity of the function signature with those used by @c
4673 * evas_object_smart_callback_add:
4677 * Now let's show the code used for really creating the list. Skipping
4678 * boilerplate code used for creating a window and background, the first piece
4679 * of code specific to our genlist example is setting the pointer functions of
4680 * the item class to our above defined functions:
4685 * Notice that we also choose to use the "default" style for our genlist items.
4686 * Another interesting point is that @c state_get and @c del are set to @c NULL,
4687 * since we don't need these functions now. @c del doesn't need to be used
4688 * because we don't add any data that must be freed to our items, and @c
4689 * state_get is also not used since all of our items are the same and don't need
4690 * to have different states to be used for each item. Finally we create our
4693 * @until genlist_add
4695 * Now we append several items to the list, and for all of them we need to give
4696 * the list pointer, a pointer to the item class, the data that will be used
4697 * with that item, a pointer to the parent of this item if it is in a group type
4698 * list (this is not the case so we pass @c NULL), possible flags for this item,
4699 * the callback for when the item is selected, and the data pointer that will be
4700 * given to the selected callback.
4704 * The rest of the code is also common to all the other examples, so it will be
4705 * omitted here (look at the full source code link above if you need it).
4707 * You can try to play with this example, and see the selected callback being
4708 * called whenever an item is clicked. It also already has some features enabled
4709 * by default, like vertical bounce animation when reaching the end of the list,
4710 * automatically visible/invisible scrollbar, etc. Look at the @ref
4711 * genlist_example_02 to see an example of setting these properties to the list.
4713 * The current example will look like this when running:
4715 * @image html screenshots/genlist_example_01.png
4716 * @image latex screenshots/genlist_example_01.eps width=\textwidth
4720 * @page genlist_example_02 Genlist - list setup functions
4722 * This example is very similar to the @ref genlist_example_01, but it fetch
4723 * most of the properties of the genlist and displays them on startup (thus
4724 * getting the default value for them) and then set them to some other values,
4725 * to show how to use that API. The full source code is at @ref
4726 * genlist_example_02_c.
4728 * Considering that the base code for instantiating a genlist was already
4729 * described in the previous example, we are going to focus on the new code.
4731 * Just a small difference for the @c _item_label_get function, we are going to
4732 * store the time that this function was called. This is the "realized" time,
4733 * the time when the visual representation of this item was created. This is the
4734 * code for the @c label_get function:
4736 * @dontinclude genlist_example_02.c
4738 * @until return strdup
4740 * Now let's go to the list creation and setup. First, just after creating the
4741 * list, we get most of the default properties from it, and print them on the
4745 * @until printf("\n")
4747 * We are going to change some of the properties of our list.
4749 * There's no need to call the selected callback at every click, just when the
4750 * selected item changes, thus we call elm_genlist_select_mode_set() with
4751 * ELM_OBJECT_SELECT_MODE_ALWAYS.
4753 * For this list we don't want bounce animations at all, so we set both the
4754 * horizontal bounce and the vertical bounce to false with
4755 * elm_genlist_bounce_set().
4757 * We also want our list to compress items if they are wider than the list
4758 * width (thus we call elm_genlist_mode_set(obj, ELM_LIST_COMPRESS).
4760 * The items have different width, so they are not homogeneous:
4761 * elm_genlist_homogeneous_set() is set to false.
4763 * Since the compress mode is active, the call to
4764 * elm_genlist_mode_set() doesn't make difference, but the current
4765 * option would make the list to have at least the width of the largest item.
4767 * This list will support multiple selection, so we call
4768 * elm_genlist_multi_select_set() on it.
4770 * The option elm_genlist_mode_set() would allow text block to
4771 * wrap lines if the Edje part is configured with "text.min: 0 1", for example.
4772 * But since we are compressing the elements to the width of the list, this
4773 * option wouldn't take any effect.
4775 * We want the vertical scrollbar to be always displayed, and the orizontal one
4776 * to never be displayed, and set this with elm_genlist_scroller_policy_set().
4778 * The timeout to consider a longpress is set to half of a second with
4779 * elm_genlist_longpress_timeout_set().
4781 * We also change the block count to a smaller value, but that should have not
4782 * impact on performance since the number of visible items is too small. We just
4783 * increase the granularity of the block count (setting it to have at most 4
4786 * @until block_count_set
4788 * Now let's add elements to the list:
4790 * @until item_append
4793 * It's exactly the same as the previous example. The difference is on the
4794 * behavior of the list, if you try to scroll, select items and so.
4796 * In this example we also need two buttons. One of them, when clicked, will
4797 * display several status info about the current selection, the "realized"
4798 * items, the item in the middle of the screen, and the current mode and active
4799 * item of that mode for the genlist.
4801 * The other button will ask the genlist to "realize" again the items already
4802 * "realized", so their respective label_get and icon_get functions will be
4805 * These are the callbacks for both of these buttons:
4807 * @dontinclude genlist_example_02.c
4813 * Try to scroll, select some items and click on the "Show status" button.
4814 * You'll notice that not all items of the list are "realized", thus consuming
4815 * just a small amount of memory. The selected items are listed in the order
4816 * that they were selected, and the current selected item printed using
4817 * elm_genlist_selected_item_get() is the first selected item of the multiple
4820 * Now resize the window so that you can see the "realized time" of some items.
4821 * This is the time of when the label_get function was called. If you click on
4822 * the "Realize" button, all the already realized items will be rebuilt, so the
4823 * time will be updated for all of them.
4825 * The current example will look like this when running:
4827 * @image html screenshots/genlist_example_02.png
4828 * @image latex screenshots/genlist_example_02.eps width=\textwidth
4832 * @page genlist_example_03 Genlist - different width options
4834 * This example doesn't present any other feature that is not already present in
4835 * the other examples, but visually shows the difference between using the
4836 * default list options (first list of the example), setting the horizontal mode
4837 * to #ELM_LIST_LIMIT (second list), enabling compress mode (third list) and
4838 * using height_for_width option (fourth list).
4840 * The full code for this example is listed below:
4842 * @include genlist_example_03.c
4844 * And the screenshot of the running example:
4846 * @image html screenshots/genlist_example_03.png
4847 * @image latex screenshots/genlist_example_03.eps width=\textwidth
4849 * @example genlist_example_03.c
4853 * @page genlist_example_04 Genlist - items manipulation
4855 * This example is also similar ot the @ref genlist_example_01, but it
4856 * demonstrates most of the item manipulation functions. See the full source
4857 * code at @ref genlist_example_04_c.
4859 * In this example, we also will use the concept of creating groups of items in
4860 * the genlist. Each group of items is composed by a parent item (which will be
4861 * the index of the group) and several children of this item. Thus, for the
4862 * children, we declare a normal item class. But we also are going to declare a
4863 * different item class for the group index (which in practice is another type
4864 * of item in the genlist):
4866 * @dontinclude genlist_example_04.c
4867 * @skip _item_sel_cb
4872 * We will add buttons to the window, where each button provides one
4873 * functionality of the genlist item API. Each button will have a callback
4874 * attached, that will really execute this functionality. An example of these
4875 * callbacks is the next one, for the elm_genlist_item_insert_after() function:
4877 * @skip insert_before_cb
4881 * If you want ot see the other button functions, look at the full source code
4884 * Each button will be created with a function that already creates the button,
4885 * add it to an elementary box, and attach the specified callback. This is the
4886 * function that does it:
4888 * @skip genlist_item_update
4892 * In our @c elm_main function, besides the code for setting up the window, box
4893 * and background, we also initialize our two item classes:
4895 * @skip _itc.item_style
4896 * @until _itc_group.func.del
4898 * This example uses a different style for the items, the @a double_label, which
4899 * provides a text field for the item text, and another text field for a subtext.
4901 * For the group index we use the @a group_index style, which provides a
4902 * different appearance, helping to identify the end of a group and beginning of
4905 * Now, after the code for creating the list, setting up the box and other
4906 * stuff, let's add the buttons with their respective callbacks:
4909 * @until bt_top_show
4911 * The main code for adding items to the list is a bit more complex than the one
4912 * from the previous examples. We check if each item is multiple of 7, and if
4913 * so, they are group indexes (thus each group has 6 elements by default, in
4920 * Then we also check for specific items, and add callbacks to them on the
4921 * respective buttons, so we can show, bring in, etc.:
4926 * Once you understand the code from the @ref genlist_example_01, it should be
4927 * easy to understand this one too. Look at the full code, and also try to play
4928 * a bit with the buttons, adding items, bringing them to the viewport, and so.
4930 * The example will look like this when running:
4932 * @image html screenshots/genlist_example_04.png
4933 * @image latex screenshots/genlist_example_04.eps width=\textwidth
4937 * @page genlist_example_05 Genlist - working with subitems
4939 * This is probably the most complex example of elementary @ref Genlist. We
4940 * create a tree of items, using the subitems properties of the items, and keep
4941 * it in memory to be able to expand/hide subitems of an item. The full source
4942 * code can be found at @ref genlist_example_05_c
4944 * The main point is the way that Genlist manages subitems. Clicking on an
4945 * item's button to expand it won't really show its children. It will only
4946 * generate the "expand,request" signal, and the expansion must be done
4949 * In this example we want to be able to add items as subitems of another item.
4950 * If an item has any child, it must be displayed using a parent class,
4951 * otherwise it will use the normal item class.
4953 * It will be possible to delete items too. Once a tree is constructed (with
4954 * subitems of subitems), and the user clicks on the first parent (root of the
4955 * tree), the entire subtree must be hidden. However, just calling
4956 * elm_genlist_item_expanded_set(item, EINA_FALSE) won't hide them. The only
4957 * thing that happens is that the parent item will change its appearance to
4958 * represent that it's contracted. And the signal "contracted" will be emitted
4959 * from the genlist. Thus, we must call elm_genlist_item_subitems_clear() to
4960 * delete all its subitems, but still keep a way to recreate them when expanding
4961 * the parent again. That's why we are going to keep a node struct for each
4962 * item, that will be the data of the item, with the following information:
4964 * @dontinclude genlist_example_05.c
4968 * This @c Node_Data contains the value for the item, a number indicating its
4969 * level under the tree, a list of children (to be able to expand it later) and
4970 * a boolean indicating if it's a favorite item or not.
4972 * We use 3 different item classes in this example:
4974 * One for items that don't have children:
4981 * One for items that have children:
4988 * And one for items that were favorited:
4994 * The favorite item class is there just to demonstrate the
4995 * elm_genlist_item_item_class_update() function in action. It would be much
4996 * simpler to implement the favorite behavior by just changing the icon inside
4997 * the icon_get functions when the @c favorite boolean is activated.
4999 * Now we are going to declare the callbacks for the buttons that add, delete
5002 * First, a button for appending items to the list:
5004 * @until item_append
5007 * If an item is selected, a new item will be appended to the same level of that
5008 * item, but using the selected item's parent as its parent too. If no item is
5009 * selected, the new item will be appended to the root of the tree.
5011 * Then the callback for marking an item as favorite:
5013 * @until elm_genlist_item_update
5016 * This callback is very simple, it just changes the item class of the selected
5017 * item for the "favorite" one, or go back to the "item" or "parent" class
5018 * depending on that item having children or not.
5020 * Now, the most complex operation (adding a child to an item):
5022 * @until elm_genlist_item_update
5025 * This function gets the data of the selected item, create a new data (for the
5026 * item being added), and appends it to the children list of the selected item.
5028 * Then we must check if the selected item (let's call it @c item1 now) to which
5029 * the new item (called @c item2 from now on) was already a parent item too
5030 * (using the parent item class) or just a normal item (using the default item
5031 * class). In the first case, we just have to append the item to the end of the
5032 * @c item1 children list.
5034 * However, if the @c item1 didn't have any child previously, we have to change
5035 * it to a parent item now. It would be easy to just change its item class to
5036 * the parent type, but there's no way to change the item flags and make it be
5037 * of the type #ELM_GENLIST_ITEM_TREE. Thus, we have to delete it and create
5038 * a new item, and add this new item to the same position that the deleted one
5039 * was. That's the reason of the checks inside the bigger @c if.
5041 * After adding the item to the newly converted parent, we set it to not
5042 * expanded (since we don't want to show the added item immediately) and select
5043 * it again, since the original item was deleted and no item is selected at the
5046 * Finally, let's show the callback for deleting items:
5048 * @until elm_genlist_item_update
5051 * Since we have an iternal list representing each element of our tree, once we
5052 * delete an item we have to go deleting each child of that item, in our
5053 * internal list. That's why we have the function @c _clear_list, which
5054 * recursively goes freeing all the item data.
5056 * This is necessary because only when we really want to delete the item is when
5057 * we need to delete the item data. When we are just contracting the item, we
5058 * need to hide the children by deleting them, but keeping the item data.
5060 * Now there are two callbacks that will be called whenever the user clicks on
5061 * the expand/contract icon of the item. They will just request to items to be
5062 * contracted or expanded:
5064 * @until elm_genlist_item_expanded_set(
5065 * @until elm_genlist_item_expanded_set(
5068 * When the elm_genlist_item_expanded_set() function is called with @c
5069 * EINA_TRUE, the @c _expanded_cb will be called. And when this happens, the
5070 * subtree of that item must be recreated again. This is done using the internal
5071 * list stored as item data for each item. The function code follows:
5075 * Each appended item is set to contracted, so we don't have to deal with
5076 * checking if the item was contracted or expanded before its parent being
5077 * contracted. It could be easily implemented, though, by adding a flag expanded
5078 * inside the item data.
5080 * Now, the @c _contracted_cb, which is much simpler:
5084 * We just have to call elm_genlist_item_subitems_clear(), that will take care
5085 * of deleting every item, and keep the item data still stored (since we don't
5086 * have any del function set on any of our item classes).
5088 * Finally, the code inside @c elm_main is very similar to the other examples:
5093 * The example will look like this when running:
5095 * @image html screenshots/genlist_example_05.png
5096 * @image latex screenshots/genlist_example_05.eps width=\textwidth
5100 * @page thumb_example_01 Thumb - generating thumbnails.
5102 * This example shows how to create a simple thumbnail object with Elementary.
5103 * The full source code can be found at @ref thumb_example_01_c
5105 * Everything is very simple. First we need to tell elementary that we need
5106 * Ethumb to generate the thumbnails:
5108 * @dontinclude thumb_example_01.c
5109 * @skipline elm_need_ethumb
5111 * Then, after creating the window and background, we setup our client to
5112 * generate images of 160x160:
5117 * After that, we can start creating thumbnail objects. They are very similar to
5118 * image or icon objects:
5120 * @until thumb_reload
5122 * As you can see, the main different function here is elm_thumb_reload(), which
5123 * will check if the options of the Ethumb client have changed. If so, it will
5124 * re-generate the thumbnail, and show the new one.
5126 * Notice in this example that the thumbnail object is displayed on the size of
5127 * the window (320x320 pixels), but the thumbnail generated and stored has size
5128 * 160x160 pixels. That's why the picture seems upscaled.
5130 * Ideally, you will be generating thumbnails with the size that you will be
5133 * The example will look like this when running:
5135 * @image html screenshots/thumb_example_01.png
5136 * @image latex screenshots/thumb_example_01.eps width=\textwidth
5140 * @page progressbar_example Progress bar widget example
5142 * This application is a thorough example of the progress bar widget,
5143 * consisting of a window with varios progress bars, each with a given
5144 * look/style one can give to those widgets. With two auxiliary
5145 * buttons, one can start or stop a timer which will fill in the bars
5146 * in synchrony, simulating an underlying task being completed.
5148 * We create @b seven progress bars, being three of them horizontal,
5149 * three vertical and a final one under the "wheel" alternate style.
5151 * For the first one, we add a progress bar on total pristine state,
5152 * with no other call than the elm_progressbar_add() one:
5153 * @dontinclude progressbar_example.c
5154 * @skip pb with no label
5156 * See, than, that the defaults of a progress bar are:
5157 * - no primary label shown,
5158 * - unit label set to @c "%.0f %%",
5161 * The second progress bar is given a primary label, <c>"Infinite
5162 * bounce"</c>, and, besides, it's set to @b pulse. See how, after one
5163 * starts the progress timer, with the "Start" button, it animates
5164 * differently than the previous one. It won't account for the
5165 * progress, itself, and just dumbly animate a small bar within its
5167 * @dontinclude progressbar_example.c
5168 * @skip pb with label
5171 * Next, comes a progress bar with an @b icon, a primary label and a
5172 * @b custom unit label set. It's also made to grow its bar in an
5173 * @b inverted manner, so check that out during the timer's progression:
5174 * @dontinclude progressbar_example.c
5177 * Another important thing in this one is the call to
5178 * elm_progressbar_span_size_set() -- this is how we forcefully set a
5179 * minimum horizontal size to our whole window! We're not resizing it
5180 * manually, as you can see in the @ref progressbar_example_c
5183 * The next three progress bars are just variants on the ones already
5184 * shown, but now all being @b vertical. Another time we use one of
5185 * than to give the window a minimum vertical size, with
5186 * elm_progressbar_span_size_set(). To demonstrate this trick once
5187 * more, the fifth one, which is also set to pulse, has a smaller
5188 * hardcoded span size:
5189 * @dontinclude progressbar_example.c
5190 * @skip vertical pb, with pulse
5193 * We end the widget demonstration by showing a progress bar with the
5194 * special @b "wheel" progress bar style. One does @b not need to set
5195 * it to pulse, with elm_progressbar_pulse_set(), explicitly, because
5196 * its theme does not take it in account:
5197 * @dontinclude progressbar_example.c
5201 * The two buttons exercising the bars, the facto, follow:
5202 * @dontinclude progressbar_example.c
5203 * @skip elm_button_add
5204 * @until evas_object_show(bt)
5205 * @until evas_object_show(bt)
5207 * The first of the callbacks will, for the progress bars set to
5208 * pulse, start the pulsing animation at that time. For the others, a
5209 * timer callback will take care of updating the values:
5210 * @dontinclude progressbar_example.c
5211 * @skip static Eina_Bool
5216 * Finally, the callback to stop the progress timer will stop the
5217 * pulsing on the pulsing progress bars and, for the others, to delete
5218 * the timer which was acting on their values:
5219 * @dontinclude progressbar_example.c
5224 * This is how the example program's window looks like:
5225 * @image html screenshots/progressbar_example.png
5226 * @image latex screenshots/progressbar_example.eps width=\textwidth
5228 * See the full @ref progressbar_example_c "source code" for
5231 * @example progressbar_example.c
5235 * @page tutorial_notify Notify example
5236 * @dontinclude notify_example_01.c
5238 * In this example we will have 3 notifys in 3 different positions. The first of
5239 * which will dissapear after 5 seconds or when a click outside it occurs, the
5240 * second and third will not dissapear and differ from each other only in
5243 * We start our example with the usual stuff you've seen in other examples:
5246 * We now create a label to use as the content of our first notify:
5249 * Having the label we move to creating our notify, telling it to block events,
5250 * setting its timeout(to autohide it):
5253 * To have the notify dissapear when a click outside its area occur we have to
5254 * listen to its "block,clicked" signal:
5255 * @until smart_callback
5257 * Our callback will look like this:
5260 * @dontinclude notify_example_01.c
5262 * Next we create another label and another notify. Note, however, that this
5263 * time we don't set a timeout and don't have it block events. What we do is set
5264 * the orient so that this notify will appear in the bottom of its parent:
5265 * @skip smart_callback
5269 * For our third notify the only change is the orient which is now center:
5272 * Now we tell the main loop to run:
5275 * Our example will initially look like this:
5277 * @image html screenshots/notify_example_01.png
5278 * @image latex screenshots/notify_example_01.eps width=\textwidth
5280 * Once the first notify is hidden:
5282 * @image html screenshots/notify_example_01_a.png
5283 * @image latex screenshots/notify_example_01_a.eps width=\textwidth
5285 * @example notify_example_01.c
5289 * @page popup_example_01_c popup_example_01.c
5290 * @include popup_example_01.c
5292 * This example will initially look like this:
5294 * @image html screenshots/popup_example_01.png
5295 * @image latex screenshots/popup_example_01.eps width=\textwidth
5297 * Once the popup is hidden after timeout:
5299 * @image html screenshots/popup_example_01_a.png
5300 * @image latex screenshots/popup_example_01_a.eps width=\textwidth
5302 * @example popup_example_01.c
5305 /** @page popup_example_02_c popup_example_02.c
5306 * @include popup_example_02.c
5308 * This example will look like this:
5310 * @image html screenshots/popup_example_02.png
5311 * @image latex screenshots/popup_example_02.eps width=\textwidth
5313 * @example popup_example_02.c
5317 * @page popup_example_03_c popup_example_03.c
5318 * @include popup_example_03.c
5320 * This example will look like this:
5322 * @image html screenshots/popup_example_03.png
5323 * @image latex screenshots/popup_example_03.eps width=\textwidth
5325 * @example popup_example_03.c
5329 * @page tutorial_frame Frame example
5330 * @dontinclude frame_example_01.c
5332 * In this example we are going to create 4 Frames with different styles and
5333 * add a rectangle of different color in each.
5335 * We start we the usual setup code:
5338 * And then create one rectangle:
5341 * To add it in our first frame, which since it doesn't have it's style
5342 * specifically set uses the default style:
5345 * And then create another rectangle:
5348 * To add it in our second frame, which uses the "pad_small" style, note that
5349 * even tough we are setting a text for this frame it won't be show, only the
5350 * default style shows the Frame's title:
5352 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
5353 * very similar, their only difference is the size of the empty area around
5354 * the content of the frame.
5356 * And then create yet another rectangle:
5359 * To add it in our third frame, which uses the "outdent_top" style, note
5360 * that even tough we are setting a text for this frame it won't be show,
5361 * only the default style shows the Frame's title:
5364 * And then create one last rectangle:
5367 * To add it in our fourth and final frame, which uses the "outdent_bottom"
5368 * style, note that even tough we are setting a text for this frame it won't
5369 * be show, only the default style shows the Frame's title:
5372 * And now we are left with just some more setup code:
5375 * Our example will look like this:
5377 * @image html screenshots/frame_example_01.png
5378 * @image latex screenshots/frame_example_01.eps width=\textwidth
5380 * @example frame_example_01.c
5384 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
5385 * This example will show both Anchorblock and @ref Anchorview,
5386 * since both are very similar and it's easier to show them once and side
5387 * by side, so the difference is more clear.
5389 * We'll show the relevant snippets of the code here, but the full example
5390 * can be found here... sorry, @ref anchorblock_example_01.c "here".
5392 * As for the actual example, it's just a simple window with an anchorblock
5393 * and an anchorview, both containing the same text. After including
5394 * Elementary.h and declaring some functions we'll need, we jump to our
5395 * elm_main (see ELM_MAIN) and create our window.
5396 * @dontinclude anchorblock_example_01.c
5401 * With the needed variables declared, we'll create the window and a box to
5402 * hold our widgets, but we don't need to go through that here.
5404 * In order to make clear where the anchorblock ends and the anchorview
5405 * begins, they'll be each inside a @ref Frame. After creating the frame,
5406 * the anchorblock follows.
5407 * @skip elm_frame_add
5408 * @until elm_frame_content_set
5410 * Nothing out of the ordinary there. What's worth mentioning is the call
5411 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
5412 * when an anchor is clicked, the hover for the popup will cover the entire
5413 * window. This affects the area that will be obscured by the hover and
5414 * where clicking will dismiss it, as well as the calculations it does to
5415 * inform the best locations where to insert the popups content.
5416 * Other than that, the code is pretty standard. We also need to set our
5417 * callback for when an anchor is clicked, since it's our task to populate
5418 * the popup. There's no default for it.
5420 * The anchorview is no different, we only change a few things so it looks
5422 * @until elm_frame_content_set
5424 * Then we run, so stuff works and close our main function in the usual way.
5427 * Now, a little note. Normally you would use either one of anchorblock or
5428 * anchorview, set your one callback to clicks and do your stuff in there.
5429 * In this example, however, there are a few tricks to make it easier to
5430 * show both widgets in one go (and to save me some typing). So we have
5431 * two callbacks, one per widget, that will call a common function to do
5432 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
5433 * anchorview too, since both are equal, and passing a callback to use
5434 * for our buttons to end the hover, because each widget has a different
5436 * @until _anchorview_clicked_cb
5439 * The meat of our popup is in the following function. We check what kind
5440 * of menu we need to show, based on the name set to the anchor in the
5441 * markup text. If there's no type (something went wrong, no valid contact
5442 * in the address list) we are just putting a button that does nothing, but
5443 * it's perfectly reasonable to just end the hover and call it quits.
5445 * Our popup will consist of one main button in the middle of our hover,
5446 * and possibly a secondary button and a list of other options. We'll create
5447 * first our main button and check what kind of popup we need afterwards.
5450 * @until eina_stringshare_add
5453 * Each button has two callbacks, one is our hack to close the hover
5454 * properly based on which widget it belongs to, the other a simple
5455 * printf that will show the action with the anchors own data. This is
5456 * not how you would usually do it. Instead, the common case is to have
5457 * one callback for the button that will know which function to call to end
5458 * things, but since we are doing it this way it's worth noting that
5459 * smart callbacks will be called in reverse in respect to the order they
5460 * were added, and since our @c btn_end_cb will close the hover, and thus
5461 * delete our buttons, the other callback wouldn't be called if we had
5464 * After our telephone popup, there are a few others that are practically
5465 * the same, so they won't be shown here.
5467 * Once we are done with that, it's time to place our actions into our
5468 * hover. Main button goes in the middle without much questioning, and then
5469 * we see if we have a secondary button and a box of extra options.
5470 * Because I said so, secondary button goes on either side and box of
5471 * options either on top or below the main one, but to choose which
5472 * exactly, we use the hints our callback info has, which saves us from
5473 * having to do the math and see which side has more space available, with
5474 * a little special case where we delete our extra stuff if there's nowhere
5478 * @skip evas_object_smart
5479 * @until evas_object_del(box)
5483 * The example will look like this:
5485 * @image html screenshots/anchorblock_01.png
5486 * @image latex screenshots/anchorblock_01.eps width=\textwidth
5488 * @example anchorblock_example_01.c
5492 * @page tutorial_check Check example
5493 * @dontinclude check_example_01.c
5495 * This example will show 2 checkboxes, one with just a label and the second
5496 * one with both a label and an icon. This example also ilustrates how to
5497 * have the checkbox change the value of a variable and how to react to those
5500 * We will start with the usual setup code:
5503 * And now we create our first checkbox, set its label, tell it to change
5504 * the value of @p value when the checkbox stats is changed and ask to be
5505 * notified of state changes:
5508 * For our second checkbox we are going to set an icon so we need to create
5511 * @note For simplicity we are using a rectangle as icon, but any evas object
5514 * And for our second checkbox we set the label, icon and state to true:
5517 * We now do some more setup:
5520 * And finally implement the callback that will be called when the first
5521 * checkbox's state changes. This callback will use @p data to print a
5524 * @note This work because @p data is @p value(from the main function) and @p
5525 * value is changed when the checkbox is changed.
5527 * Our example will look like this:
5529 * @image html screenshots/check_example_01.png
5530 * @image latex screenshots/check_example_01.eps width=\textwidth
5532 * @example check_example_01.c
5536 * @page tutorial_colorselector Color selector example
5537 * @dontinclude colorselector_example_01.c
5539 * This example shows how to change the color of a rectangle using a color
5540 * selector. We aren't going to explain a lot of the code since it's the
5544 * Now that we have a window with background and a rectangle we can create
5545 * our color_selector
5546 * @until elm_colorselector_add
5548 * Now colors can be loaded to color selector's palette by setting the palette name
5551 * Next we ask to be notified whenever the color changes on selector:
5554 * Next we ask to be notified whenever the color item is selected and longpressed:
5555 * @until color,item,longpressed
5557 * We add some more code to the usual setup code:
5560 * now get to the "changed" callback that sets the color of the rectangle:
5563 * And now get to the "color,item,selected" callback that sets the color of the rectangle:
5566 * And now get to the "color,item,longpressed" callback that gets and displays
5567 * the color of the rectangle:
5570 * This example will look like this:
5572 * @image html screenshots/colorselector_example_01.png
5573 * @image latex screenshots/colorselector_example_01.eps width=\textwidth
5575 * @example colorselector_example_01.c
5579 * @page slideshow_example Slideshow widget example
5581 * This application is aimed to exemplify the slideshow widget. It
5582 * consists of a window with a slideshow widget set as "resize
5583 * object", along with a control bar, in the form of a notify. Those
5584 * controls will exercise most of the slideshow's API functions.
5586 * We create the slideshow, itself, first, making it @b loop on its
5587 * image itens, when in slideshow mode:
5588 * @dontinclude slideshow_example.c
5589 * @skip slideshow = elm_slideshow_add
5590 * @until evas_object_show
5592 * Next, we define the <b>item class</b> for our slideshow
5593 * items. Slideshow images are going to be Elementary @ref Photo "photo"
5594 * widgets, here, as pointed by our @c get class
5595 * function. We'll let the Elementary infrastructure to delete those
5596 * objects for us, and, as there's no additional data attached to our
5597 * slideshow items, the @c del class function can be left undefined:
5598 * @dontinclude slideshow_example.c
5601 * @dontinclude slideshow_example.c
5604 * @dontinclude slideshow_example.c
5605 * @skip get our images to make slideshow items
5608 * We now get to populate the slideshow widget with items. Our images
5609 * are going to be some randomly chosen from the Elementary package,
5610 * nine of them. For the first eight, we insert them ordered in the
5611 * widget, by using elm_slideshow_item_sorted_insert(). The comparing
5612 * function will use the image names to sort items. The last item is
5613 * inserted at the end of the slideshow's items list, with
5614 * elm_slideshow_item_add(). We check out how that list ends with
5615 * elm_slideshow_items_get(), than:
5616 * @dontinclude slideshow_example.c
5617 * @skip static const char *img
5619 * @dontinclude slideshow_example.c
5623 * Note that we save the pointers to the first and last items in the
5624 * slideshow, for future use.
5626 * What follows is the code creating a notify, to be shown over the
5627 * slideshow's viewport, with knobs to act on it. We're not showing
5628 * that boilerplate code, but only the callbacks attached to the
5629 * interesting smart events of those knobs. The first four are
5630 * buttons, which will:
5631 * - Select the @b next item in the slideshow
5632 * - Select the @b previous item in the slideshow
5633 * - Select the @b first item in the slideshow
5634 * - Select the @b last item in the slideshow
5636 * Check out the code for those four actions, being the two last @c
5637 * data pointers the same @c first and @c last pointers we save
5638 * before, respectively:
5639 * @dontinclude slideshow_example.c
5640 * @skip jump to next
5646 * What follow are two hoversels, meant for one to change the
5647 * slideshow's @b transition and @b layout styles, respectively. We
5648 * fetch all the available transition and layout names to populate
5649 * those widgets and, when one selects any of them, we apply the
5650 * corresponding setters on the slideshow:
5651 * @dontinclude slideshow_example.c
5652 * @skip hv = elm_hoversel_add
5655 * @dontinclude slideshow_example.c
5656 * @skip transition changed
5660 * For one to change the transition @b time on the slideshow widget,
5661 * we use a spinner widget. We set it to the initial value of 3
5662 * (seconds), which will be probed by the next knob -- a button
5663 * starting the slideshow, de facto. Note that changing the transition
5664 * time while a slideshow is already happening will ajust its
5666 * @dontinclude slideshow_example.c
5667 * @skip spin = elm_spinner_add
5668 * @until evas_object_show
5669 * @dontinclude slideshow_example.c
5670 * @skip slideshow transition time has
5673 * Finally, we have two buttons which will, respectively, start and
5674 * stop the slideshow on our widget. Here are their "clicked"
5676 * @dontinclude slideshow_example.c
5677 * @skip start the show
5681 * This is how the example program's window looks like:
5682 * @image html screenshots/slideshow_example.png
5683 * @image latex screenshots/slideshow_example.eps width=\textwidth
5685 * See the full @ref slideshow_example_c "source code" for
5688 * @example slideshow_example.c
5692 * @page tutorial_photocam Photocam example
5693 * @dontinclude photocam_example_01.c
5695 * In this example we will have a photocam and a couple of buttons and slider to
5696 * control the photocam. To avoid cluttering we'll only show the parts of the
5697 * example that relate to the photocam, the full source code can be seen @ref
5698 * photocam_example_01.c "here".
5700 * Creating a photocam is as easy as creating any other widget:
5701 * @skipline elm_photocam_add
5703 * A photocam is only useful if we have a image on it, so lets set a file for it
5707 * We now set the photocam to not bounce horizontally:
5710 * And we want to know when the photocam has finished loading the image so:
5711 * @until smart_callback
5713 * The reason to know when the image is loaded is so that we can bring the
5714 * center of the image into view:
5718 * As mentioned we have 2 buttons in this example, the "Fit" one will cause
5719 * the photocam to go in to a zoom mode that makes the image fit inside the
5720 * photocam. Tough this has no effect on the image we also print what region was
5721 * being viewed before setting the zoom mode:
5723 * @note When in fit mode our slider(explained below) won't work.
5725 * The second button("Unfit") will bring the photocam back into manual zoom
5729 * Our slider controls the level of zoom of the photocam:
5731 * @note It is important to note that this only works when in manual zoom mode.
5733 * Our example will initially look like this:
5735 * @image html screenshots/photocam_example_01.png
5736 * @image latex screenshots/photocam_example_01.eps width=\textwidth
5738 * @example photocam_example_01.c
5742 * @page inwin_example_01 Inwin - General overview
5744 * Inwin is a very simple widget to show, so this example will be a very simple
5745 * one, just using all of the available API.
5747 * The program is nothing but a window with a lonely button, as shown here.
5749 * @image html screenshots/inwin_example.png
5750 * @image latex screenshots/inwin_example.eps width=\textwidth
5752 * And pressing the button makes an inwin appear.
5754 * @image html screenshots/inwin_example_a.png
5755 * @image latex screenshots/inwin_example_a.eps width=\textwidth
5757 * And the code is just as simple. We being with some global variables to keep
5758 * track of our Inwin.
5759 * @dontinclude inwin_example.c
5761 * @until current_style
5763 * And two callbacks used by the buttons the above screenshot showed. In these,
5764 * we check if @c inwin exists and execute the proper action on it. If it's not
5765 * there anymore, then we were abandoned to our luck, so we disabled ourselves.
5766 * @until _inwin_destroy
5770 * The lonely button from the beginning, when clicked, will call the following
5771 * function, which begins by checking if an inwin exists, and if it's there,
5772 * we bring it back to the front and exit from our function without any further
5776 * But if no inwin is there to show, we need to create one. First we need the
5777 * top-most window for the program, as no inwin can be created using other
5778 * objects as parents. Then we create our popup, set the next style in the list
5780 * @until current_style =
5782 * As for the content of our inwin, it's just a box with a label and some
5784 * @until _inwin_destroy
5787 * Now, all the code above shows how every object must always be set as content
5788 * for some other object, be it by setting the full content, packing it in a
5789 * box or table or working as icon for some other widget. But we didn't do
5790 * anything like that for the inwin, this one is just created and shown and
5791 * everything works. Other widgets can be used this way, but they would need
5792 * to be placed and resized manually or nothing would be shown correctly. The
5793 * inwin, however, sets itself as a children of the top-level window and will
5794 * be resized as the parent window changes too.
5796 * Another characteristic of Inwin is that when it's shown above everyone else,
5797 * it will work kind of like a modal window, blocking any other widget from
5798 * receiving events until the window is manually dismissed by pressing some
5799 * button to close it or having blocking task signalling its completion so
5800 * normal operations can be resumed. This is unlike the @ref Hover widget,
5801 * that would show its content on top of the designated target, but clicking
5802 * anywhere else would dismiss it automatically.
5804 * To illustrate that last point, when we close the main window and an inwin
5805 * is still there, we'll take out the content from the inwin and place it in
5810 * And the rest of the program doesn't have anything else related to inwin,
5811 * so it won't be shown here, but you can find it in
5812 * @ref inwin_example.c "inwin_example.c".
5814 * @example inwin_example.c
5818 * @page tutorial_scroller Scroller example
5819 * @dontinclude scroller_example_01.c
5821 * This example is very short and will illustrate one way to use a scroller.
5822 * We'll omit the declaration of the @p text variable because it's a very long
5823 * @htmlonly<a href="http://lipsum.com/">@endhtmlonly ipsum lorem
5824 * @htmlonly</a>@endhtmlonly. If you really want to see the full code, it's @ref
5825 * scroller_example_01.c "scroller_example_01.c".
5827 * We start our example by creating our window and background:
5831 * Next we create a label and set it's text to @p text(very long ipsum lorem):
5832 * @until show(label)
5834 * We then create our scroller, ask that it have the same size as the window and
5836 * @until content_set
5838 * We are now going to set a number of properties in our scroller:
5839 * @li We make it bounce horizontally but not vertically.
5840 * @li We make both scrollbars always be visible.
5841 * @li We have the events be propagated from the content to the scroller.
5842 * @li We enforce a page policy vertically(having a page be the size of the
5843 * viewport) and leave horizontal scrolling free.
5844 * @li And finally we ask the scroller to show us a region starting at 50,50 and
5845 * having a width and height of 200px.
5846 * @until region_show
5847 * @note Observant reader will note that the elm_scroller_region_show() didn't
5848 * scroll the view vertically, this is because we told the scroller to only
5849 * accept vertical scrolling in pages.
5851 * And now we're done:
5854 * Our example will look like this:
5856 * @image html screenshots/scroller_example_01.png
5857 * @image latex screenshots/scroller_example_01.eps width=\textwidth
5859 * @example scroller_example_01.c
5863 * @page tutorial_table_01
5865 * In this example we add four labels to a homogeneous table that has a padding
5866 * of 5px between cells.
5868 * The interesting bits from this example are:
5869 * @li Where we set the table as homogeneous and the padding:
5870 * @dontinclude table_example_01.c
5872 * @until homogeneous_set
5873 * @li Where we add each label to the table:
5874 * @skipline elm_table_pack
5875 * @skipline elm_table_pack
5876 * @skipline elm_table_pack
5877 * @skipline elm_table_pack
5879 * Here you can see the full source:
5880 * @include table_example_01.c
5882 * Our example will look like this:
5884 * @image html screenshots/table_example_01.png
5885 * @image latex screenshots/table_example_01.eps width=\textwidth
5887 * @example table_example_01.c
5891 * @page tutorial_table_02
5893 * For our second example we'll create a table with 4 rectangles in it. Since
5894 * our rectangles are of different sizes our table won't be homogeneous.
5896 * The interesting bits from this example are:
5897 * @li Where we set the table as not homogeneous:
5898 * @dontinclude table_example_02.c
5899 * @skipline homogeneous_set
5900 * @li Where we add each rectangle to the table:
5901 * @skipline elm_table_pack
5902 * @skipline elm_table_pack
5903 * @skipline elm_table_pack
5904 * @skipline elm_table_pack
5906 * Here you can see the full source:
5907 * @include table_example_02.c
5909 * Our example will look like this:
5911 * @image html screenshots/table_example_02.png
5912 * @image latex screenshots/table_example_02.eps width=\textwidth
5914 * @example table_example_02.c
5918 * @page tutorial_menu Menu Example
5919 * @dontinclude menu_example_01.c
5921 * This example shows how to create a menu with regular items, object items,
5922 * submenus and how to delete items from a menu. The full source for this
5923 * example is @ref menu_example_01.c "menu_example_01.c".
5925 * We'll start looking at the menu creation and how to create a very simple
5930 * For our next item we are going to add an icon:
5933 * Now we are going to add more items, but these icons are going to have a
5934 * parent, which will put them in a sub-menu. First just another item with an
5938 * Next we are going to add a button to our menu(any elm widget can be added to
5942 * We are also going to have the button delete the first item of our
5943 * sub-menu when clicked:
5944 * @until smart_callback
5945 * @dontinclude menu_example_01.c
5949 * We now add a separator and three more regular items:
5954 * We now add another item, however this time it won't go the sub-menu and it'll
5956 * @until disabled_set
5958 * To make sure that our menu is shown whenever the window is clicked(and where
5959 * clicked) we use the following callback:
5960 * @dontinclude menu_example_01.c
5965 * Our example will look like this:
5967 * @image html screenshots/menu_example_01.png
5968 * @image latex screenshots/menu_example_01.eps width=\textwidth
5970 * @example menu_example_01.c
5974 * @page win_example_01 Win - General API overview
5976 * For most users of the Elementary API, the @ref Win widget has a lot more
5977 * functions than what they need.
5979 * In general, a developer will create a window, set some content on it and
5980 * forget about it for the rest of its program's life, letting whatever
5981 * Window Manager is there to handle the window. Here, however, we are going
5982 * to show how to generally manage a window.
5984 * We'll have a bit more than the usual includes here, since part of the
5985 * example requires some low level fiddling.
5986 * @dontinclude win_example.c
5987 * @skip Elementary.h
5990 * The program then, consists of one window with two lists of buttons, each
5991 * of which operates on another two windows. One of them is a normal window,
5992 * the other has the @c override flag set so the Window Manager ignores it.
5994 * Pressing each button will call the corresponding function to act on the
5995 * corresponding window. These are pretty self explanatory, so we'll show
5996 * them in one batch.
5998 * @until elm_win_sticky_set
6001 * Next, we handle the main window closing. We have a @c "delete,request"
6002 * callback set to ask if really want to quit. If so, we end the main loop,
6003 * otherwise just delete the popup message and continue running normally.
6004 * @until _no_quit_cb
6005 * @until _no_quit_cb
6008 * The non-managed window, being completely ignored by the Window Manager,
6009 * is likely to never receive keyboard focus, even if we click on its entry
6010 * to write something. So we have a button on it that will forcefully focus
6011 * it by using some lower level functions to act directly on the X window.
6012 * Then, each time one of the window is focused, we print some message on a
6013 * console to show this more clearly.
6014 * @until _win_focused_cb
6017 * And to finalize, the main function creates a window to hold all the action
6018 * buttons and another two to show how (and what) works on each of them.
6020 * First, the main window will be a normal window, we'll enable the focus
6021 * highlight regardless of how it is configured so it's easier to navigate
6022 * the window with the keyboard. Then we hook our focus and delete callbacks
6023 * and set up the rest of the window's content.
6024 * @until evas_object_show(box)
6026 * The first of our sub-windows is the managed one. We'll create it as a
6027 * dialog, which should make the Window Manager treat it as a non-resizable
6028 * window. We are also setting the window to be auto-deleted when the close
6029 * button in the titlebar is pressed.
6030 * @until evas_object_show(o)
6032 * Now, we added an icon to the window as a resize object. We also set this
6033 * icon to not scale, and no weight size hints have been set for it. This way,
6034 * even if we hadn't created the window as a dialog, it would still not be
6035 * resizable. The window size is defined by its content, so it would never be
6036 * smaller than the smallest of its resize objects, and for it to be resizable,
6037 * all of those objects have to allow it.
6039 * Next, we add the buttons with the actions to perform on this window. Using
6040 * a macro saves us typing and makes the world a happier place.
6041 * @until WIN_ACTION(sticky)
6043 * The maximize one is likely to not work, because the Window Manager will
6044 * probably not enforce it upon a window that states its maximum size, much
6045 * less a dialog. But that can be changed by editting the example to use
6046 * #ELM_WIN_BASIC when creating the window and adding the following line to
6047 * the icon set as content
6049 * evas_object_size_hint_weight_set(o, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
6052 * Lastly, the second sub-window will have it's override flag set. In it we
6053 * have a label with some text, and entry and a button. The entry can be
6054 * clicked normally to set focus on it, but whether it actually gets keyboard
6055 * input will also depend on the window getting focus, and since the window
6056 * is an override one, it will probably not gain it by normal means. The
6057 * button is there to force the focus at the X level to go to our window.
6058 * And to finish, another list of buttons with actions to perform on this
6059 * last window. Remember that most of them are requests or hints for the
6060 * Window Manager, so they are likely to do nothing on this window.
6061 * Similarly, there won't be any way to move it or resize it, because we
6062 * haven't implemented that kind of control on this example and that's
6063 * something controlled by Window Managers on windows they are tracking, which
6064 * is not the case with this one.
6067 * The full code listing of this example can be found at
6068 * @ref win_example.c "win_example.c".
6070 * @example win_example.c
6074 * @page web_example_01 Web - Simple example
6076 * WebKit-EFL is independent of any particular toolkit, such as Elementary,
6077 * so using it on applications requires that the programmer writes a lot of
6078 * boiler plate code to manage to manage the web object.
6080 * For a full featured browser this may make sense, as the programmer will
6081 * want to have full control of every aspect of the web object, since it's the
6082 * main component of the application. But other programs with simpler
6083 * requirements, having to write so much code is undesired.
6085 * This is where elm_web comes in. Its purpose is to provide a simple way
6086 * for developers to embed a simple web object in their programs, simplifying
6087 * the common use cases.
6089 * This is not to say that a browser can't be made out of it, as this example
6092 * We'll be making a simple browser, consisting of one window with an URL bar,
6093 * a toolbar to be used for the tabs and a pager to show one page at a time.
6095 * When all tabs are closed, we'll be showing a default view with some custom
6096 * content, for which we need to get the internal @c ewk_view object and use
6097 * some WebKit functions on it, thus we need to include the necessary headers
6100 * @dontinclude web_example.c
6104 * A struct to keep track of the different widgets in use and the currently
6105 * shown tab. There's also an @c exiting flag, used to work around the overly
6106 * simplistic way in which this example is written, just to avoid some
6107 * warnings when closing the program.
6113 * Each tab has its own struct too, but there's not much to it.
6116 * Whenever the currently selected tab changes, we need to update some state
6117 * on the application. The back and forward buttons need to be disabled
6118 * accordingly and the URL bar needs to show the right address.
6121 * @until naviframe_item_simple_promote
6124 * Other updates happen based on events from the web object, like title change
6125 * to update the name shown in the tab, and URL change which will update the
6126 * URL bar if the event came from the currently selected tab.
6128 * @skip tab_current_set
6133 * Adding a new tab is just a matter of creating a new web widget, its data
6134 * and pushing it into the pager. A lot of the things that we should handle
6135 * here, such as how to react to popups and JavaScript dialogs, are done
6136 * already in the @c elm_web widget, so we can rely on their default
6137 * implementations. For the JavaScript dialogs we are going to avoid having
6138 * them open in a new window by setting the @c Inwin mode.
6140 * There is no default implementation, however, for the requests to create a
6141 * new window, so we have to handle them by setting a callback function that
6142 * will ultimately call this very same function to add a new tab.
6147 * Entering an address in the URL bar will check if a tab exists, and if not,
6148 * create one and set the URL for it. The address needs to conform to the URI
6149 * format, so we check that it does and add the protocol if it's missing.
6152 * @until eina_stringshare_del
6155 * The navigation buttons are simple enough. As for the refresh, it normally
6156 * reloads the page using anything that may exist in the caches if applicable,
6157 * but we can press it while holding the @c Shift key to avoid the cache.
6160 * @until web_forward
6163 * The callback set for the new window request creates a new tab and returns
6164 * the web widget associated with it. This is important, this function must
6165 * return a valid web widget returned by elm_web_add().
6167 * @skip static Evas_Object
6170 * Pressing @c Ctrl-F will bring up the search box. Nothing about the box
6171 * itself is worth mentioning here, but it works as you would expect from any
6172 * other browser. While typing on it, it will highlight all occurrences of the
6173 * searched word. Pressing @c Enter will go to the next instance and the two
6174 * buttons next to the entry will move forward and backwards through the found
6177 * @skip win_del_request
6179 * @until win_search_trigger
6182 * Last, create the main window and put all of the things used above in it. It
6183 * contains a default web widget that will be shown when no tabs exist. This
6184 * web object is not browsable per se, so history is disabled in it, and we
6185 * set the same callback to create new windows, on top of setting some custom
6186 * content of our own on it, with some links that will open new tabs to start
6192 * Some parts of the code were left out, as they are not relevant to the
6193 * example, but the full listing can be found at @ref web_example.c
6196 * @example web_example.c
6200 * @page efl_thread_1 EFL Threading example 1
6202 * You can use threads with Elementary (and EFL) but you need to be careful
6203 * to only use eina or eet calls inside a thread. Other libraries are not
6204 * totally threadsafe except for some specific ecore calls designed for
6205 * working from threads like the ecore_pipe_write() and ecore_thread calls.
6207 * Below is an example of how to use EFL calls from a native thread you have
6208 * already created. You have to put the EFL calls inside the critical block
6209 * between ecore_thread_main_loop_begin() and ecore_thread_main_loop_end()
6210 * which ensure you gain a lock on the mainloop. Beware that this requires
6211 * that the thread WAIT to synchronize with the mainloop at the beginning of
6212 * the critical section. It is highly suggested you use as few of these
6213 * in your thread as possible and probably put just a single
6214 * ecore_thread_main_loop_begin() / ecore_thread_main_loop_end() section
6215 * at the end of the threads calculation or work when it is done and
6216 * would otherwise exit to sit idle.
6218 * For a progression of examples that become more complex and show other
6219 * ways to use threading with EFL, please see:
6231 * @include efl_thread_1.c
6235 * @page efl_thread_2 EFL Threading example 2
6237 * You can also use ecore_main_loop_thread_safe_call_sync() to call a
6238 * specific function that needs to do EFL main loop operations. This call
6239 * will block and wait to synchronise to the mainloop just like
6240 * ecore_thread_main_loop_begin() / ecore_thread_main_loop_end() will,
6241 * but instead you simply provide it the function callback to call instead
6242 * of inlining your code.
6252 * @include efl_thread_2.c
6256 * @page efl_thread_3 EFL Threading example 3
6258 * Like with ecore_main_loop_thread_safe_call_sync() you can provide a
6259 * callback to call inline in the mainloop, but this time with
6260 * ecore_main_loop_thread_safe_call_async() the callback is queued and
6261 * called asynchronously, without the thread blocking. The mainloop will
6262 * call this function when it comes around to its synchronisation point. This
6263 * acts as a "fire and forget" way of having the mainloop do some work
6264 * for a thread that has finished processing some data and is read to hand it
6265 * off to the mainloop and the thread wants to march on and do some more work
6266 * while the main loop deals with "displaying" the results of the previous
6275 * @include efl_thread_3.c
6279 * @page efl_thread_4 EFL Threading example 4
6281 * Now when you want to have a thread do some work, send back results to
6282 * the mainloop and continue running but the mainloop controls when the
6283 * thread should stop working, you need some extra flags. This is an example
6284 * of how you might use ecore_main_loop_thread_safe_call_async() and pthreads
6291 * @include efl_thread_4.c
6295 * @page efl_thread_5 EFL Threading example 5
6297 * This is the same as @ref efl_thread_4 but now uses the ecore_thread
6298 * infrastructure to have a running worker thread that feeds results back
6299 * to the mainloop and can easily be cancelled. This saves some code in the
6300 * application and makes for fewer problem spots if you forget a mutex.
6304 * @include efl_thread_5.c
6308 * @page efl_thread_6 EFL Threading example 6
6310 * You can also use the ecore_thread infrastructure for compute tasks that
6311 * don't send feedback as they go - they are one-shot compute jobs and when
6312 * done they will trigger the end callback in the mainloop which is intended
6313 * to pick up the results and "display them".
6315 * @include efl_thread_6.c
6319 * @page bg_example_01_c bg_example_01.c
6320 * @include bg_example_01.c
6321 * @example bg_example_01.c
6325 * @page bg_example_02_c bg_example_02.c
6326 * @include bg_example_02.c
6327 * @example bg_example_02.c
6331 * @page bg_example_03_c bg_example_03.c
6332 * @include bg_example_03.c
6333 * @example bg_example_03.c
6337 * @page actionslider_example_01 Actionslider example
6338 * @include actionslider_example_01.c
6339 * @example actionslider_example_01.c
6343 * @page transit_example_01_c Transit example 1
6344 * @include transit_example_01.c
6345 * @example transit_example_01.c
6349 * @page transit_example_02_c Transit example 2
6350 * @include transit_example_02.c
6351 * @example transit_example_02.c
6355 * @page general_functions_example_c General (top-level) functions example
6356 * @include general_funcs_example.c
6357 * @example general_funcs_example.c
6361 * @page clock_example_c Clock example
6362 * @include clock_example.c
6363 * @example clock_example.c
6367 * @page datetime_example_c Datetime example
6368 * @include datetime_example.c
6369 * @example datetime_example.c
6373 * @page dayselector_example_c Dayselector example
6374 * @include dayselector_example.c
6375 * @example dayselector_example.c
6379 * @page flipselector_example_c Flipselector example
6380 * @include flipselector_example.c
6381 * @example flipselector_example.c
6385 * @page fileselector_example_c Fileselector example
6386 * @include fileselector_example.c
6387 * @example fileselector_example.c
6391 * @page fileselector_button_example_c Fileselector button example
6392 * @include fileselector_button_example.c
6393 * @example fileselector_button_example.c
6397 * @page fileselector_entry_example_c Fileselector entry example
6398 * @include fileselector_entry_example.c
6399 * @example fileselector_entry_example.c
6403 * @page index_example_01_c Index example
6404 * @include index_example_01.c
6405 * @example index_example_01.c
6409 * @page index_example_02_c Index example
6410 * @include index_example_02.c
6411 * @example index_example_02.c
6415 * @page layout_example_01_c layout_example_01.c
6416 * @include layout_example_01.c
6417 * @example layout_example_01.c
6421 * @page layout_example_02_c layout_example_02.c
6422 * @include layout_example_02.c
6423 * @example layout_example_02.c
6427 * @page layout_example_03_c layout_example_03.c
6428 * @include layout_example_03.c
6429 * @example layout_example_03.c
6433 * @page layout_example_edc An example of layout theme file
6435 * This theme file contains two groups. Each of them is a different theme, and
6436 * can be used by an Elementary Layout widget. A theme can be used more than
6437 * once by many different Elementary Layout widgets too.
6439 * @include layout_example.edc
6440 * @example layout_example.edc
6444 * @page gengrid_example_c Gengrid example
6445 * @include gengrid_example.c
6446 * @example gengrid_example.c
6450 * @page genlist_example_01_c genlist_example_01.c
6451 * @include genlist_example_01.c
6452 * @example genlist_example_01.c
6456 * @page genlist_example_02_c genlist_example_02.c
6457 * @include genlist_example_02.c
6458 * @example genlist_example_02.c
6462 * @page genlist_example_04_c genlist_example_04.c
6463 * @include genlist_example_04.c
6464 * @example genlist_example_04.c
6468 * @page genlist_example_05_c genlist_example_05.c
6469 * @include genlist_example_05.c
6470 * @example genlist_example_05.c
6474 * @page thumb_example_01_c thumb_example_01.c
6475 * @include thumb_example_01.c
6476 * @example thumb_example_01.c
6480 * @page progressbar_example_c Progress bar example
6481 * @include progressbar_example.c
6482 * @example progressbar_example.c
6486 * @page slideshow_example_c Slideshow example
6487 * @include slideshow_example.c
6488 * @example slideshow_example.c
6492 * @page efl_thread_1_c EFL Threading example 1
6493 * @include efl_thread_1.c
6494 * @example efl_thread_1.c
6498 * @page efl_thread_2_c EFL Threading example 2
6499 * @include efl_thread_2.c
6500 * @example efl_thread_2.c
6504 * @page efl_thread_3_c EFL Threading example 3
6505 * @include efl_thread_3.c
6506 * @example efl_thread_3.c
6510 * @page efl_thread_4_c EFL Threading example 4
6511 * @include efl_thread_4.c
6512 * @example efl_thread_4.c
6516 * @page efl_thread_5_c EFL Threading example 5
6517 * @include efl_thread_5.c
6518 * @example efl_thread_5.c
6522 * @page efl_thread_6_c EFL Threading example 6
6523 * @include efl_thread_6.c
6524 * @example efl_thread_6.c