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 elm_animator_example_page_01
16 * @ref transit_example_01_explained
18 * @ref transit_example_02_explained
20 * @ref general_functions_example_page
22 * @ref calendar_example_01
24 * @ref calendar_example_02
26 * @ref calendar_example_03
28 * @ref calendar_example_04
30 * @ref calendar_example_05
32 * @ref calendar_example_06
34 * @ref spinner_example
40 * @ref diskselector_example_01
42 * @ref diskselector_example_02
44 * @ref list_example_01
46 * @ref list_example_02
48 * @ref list_example_03
50 * @ref flipselector_example
52 * @ref fileselector_example
54 * @ref fileselector_button_example
56 * @ref fileselector_entry_example
58 * @ref index_example_01
60 * @ref index_example_02
62 * @ref gengrid_example
64 * @ref genlist_example_01
66 * @ref genlist_example_02
68 * @ref progressbar_example
72 * @page bg_01_example_page elm_bg - Plain color background.
73 * @dontinclude bg_example_01.c
75 * The full code for this example can be found at @ref bg_example_01_c,
76 * in the function @c test_bg_plain. It's part of the @c elementar_test
77 * suite, and thus has the code for the three examples referenced by this
80 * This first example just sets a default background with a plain color. The
81 * first part consists of creating an Elementary window. It's the common
82 * piece of code that you'll see everywhere in Elementary: @skip elm_main
85 * Now we really create our background object, using the window object as
90 * Then we set the size hints of the background object so that it will use
91 * all space available for it, and then add it as a resize object to the
92 * window, making it visible in the end:
94 * @skip size_hint_weight_set
95 * @until resize_object_add
97 * See @ref evas_object_size_hint_weight_set and elm_win_resize_object_add()
98 * for more detailed info about these functions.
100 * The end of the example is quite simple, just setting the minimum and
101 * maximum size of the background, so the Elementary window knows that it
102 * has to have at least the minimum size. The background also won't scale to
103 * a size above its maximum. Then we resize the window and show it in the
106 * @skip set size hints
109 * And here we finish our very simple background object usage example.
113 * @page bg_02_example_page elm_bg - Image background.
114 * @dontinclude bg_example_02.c
116 * The full code for this example can be found at @ref bg_example_02_c,
117 * in the function @c test_bg_image. It's part of the @c elementar_test
118 * suite, and thus has the code for the three examples referenced by this
121 * This is the second example, and shows how to use the Elementary
122 * background object to set an image as background of your application.
124 * We start this example exactly in the same way as the previous one, even
125 * when creating the background object:
130 * Now it's the different part.
132 * Our background will have an image, that will be displayed over the
133 * background color. Before loading the image, we set the load size of the
134 * image. The load size is a hint about the size that we want the image
135 * displayed in the screen. It's not the exact size that the image will have,
136 * but usually a bit bigger. The background object can still be scaled to a
137 * size bigger than the one set here. Setting the image load size to
138 * something smaller than its real size will reduce the memory used to keep
139 * the pixmap representation of the image, and the time to load it. Here we
140 * set the load size to 20x20 pixels, but the image is loaded with a size
141 * bigger than that (since it's just a hint):
143 * @skipline load_size_set
145 * And set our background image to be centered, instead of stretched or
146 * scaled, so the effect of the elm_bg_load_size_set() can be easily
149 * @skipline option_set
151 * We need a filename to set, so we get one from the previous installed
152 * images in the @c PACKAGE_DATA_DIR, and write its full path to a buffer.
153 * Then we use this buffer to set the filename in the background object:
158 * Notice that the third argument of the elm_bg_file_set() function is @c
159 * NULL, since we are setting an image to this background. This function
160 * also supports setting an edje group as background, in which case the @c
161 * group parameter wouldn't be @c NULL, but be the name of the group
164 * Finally, we can set the size hints, add the background as a resize
165 * object, and resize the window, exactly the same thing we do in the @ref
166 * bg_01_example_page example:
171 * And this is the end of this example.
173 * This example will look like this:
175 * @image html screenshots/bg_01.png
176 * @image latex screenshots/bg_01.eps width=\textwidth
180 * @page bg_03_example_page elm_bg - Background properties.
181 * @dontinclude bg_example_03.c
183 * The full code for this example can be found at @ref bg_example_03_c, in the
184 * function @c test_bg_options, with the callbacks @c _cb_overlay_changed, @c
185 * _cb_color_changed and @c _cb_radio_changed defined in the beginning of the
186 * file. It's part of the @c elementar_test suite, and thus has the code for
187 * the three examples referenced by this documentation.
189 * This example will show the properties available for the background object,
190 * and will use of some more widgets to set them.
192 * In order to do this, we will set some callbacks for these widgets. The
193 * first is for the radio buttons that will be used to choose the option
194 * passed as argument to elm_bg_option_set():
196 * @skip _cb_radio_changed
199 * The next callback will be used when setting the overlay (using
200 * elm_bg_overlay_set()):
202 * @skip _cb_overlay_changed
206 * And the last one, used to set the color (with elm_bg_color_set()):
208 * @skip _cb_color_changed
211 * We will get back to what these functions do soon. If you want to know more
212 * about how to set these callbacks and what these widgets are, look for:
213 * @li elm_radio_add()
214 * @li elm_check_add()
215 * @li elm_spinner_add()
217 * Now going to the main function, @c test_bg_options, we have the common
218 * code with the other examples:
223 * We add a plain background to this window, so it will have the default
224 * background color behind everything:
226 * @skip bg = elm_bg_add
227 * @until evas_object_show(bg)
229 * Then we add a vertical box (elm_box_add()) that will hold the background
230 * object that we are going to play with, as well as a horizontal box that
234 * @until evas_object_show
236 * Now we add the background object that is going to be of use for our
237 * example. It is an image background, as used in @ref bg_02_example_page ,
238 * so the code should be familiar:
241 * @until evas_object_show
243 * Notice the call to elm_box_pack_end(): it will pack the background object
244 * in the end of the Elementary box declared above. Just refer to that
245 * documentation for more info.
247 * Since this Elementary background is already an image background, we are
248 * going to play with its other properties. We will change its option
249 * (CENTER, SCALE, STRETCH, TILE), its color (RGB), and add an overlay to it.
250 * For all of these properties, we are going to add widgets that will
253 * First, lets add the horizontal box that will hold these widgets:
257 * For now, just consider this @c hbox as a rectangle that will contain the
258 * widgets, and will distribute them horizontally inside its content. Then we
259 * add radio buttons that will allow us to choose the property to use with
263 * @until evas_object_show
265 * Again, I won't give details about the use of these widgets, just look for
266 * their documentation if necessary. It's enough to know for now that we are
267 * packing them in the @c hbox, setting a label for them, and the most
268 * important parts: setting its value to @c ELM_BG_OPTION_CENTER and its
269 * callback to @c _cb_radio_changed (the function defined in the beginning of
270 * this example). We do this for the next 3 radio buttons added after this
271 * one, each of them with a different value.
273 * Now taking a look at the code of the callback @c _cb_radio_changed again,
274 * it will call elm_bg_option_set() with the value set from the checked radio
275 * button, thus setting the option for this background. The background is
276 * passed as argument to the @p data parameter of this callback, and is
277 * referenced here as @c o_bg.
279 * Later we set the default value for this radio button:
281 * @skipline elm_radio_value_set
283 * Then we add a checkbox for the elm_bg_overlay_set() function:
286 * @until evas_object_show
288 * Now look at the code of the @c _cb_overlay_changed again. If the checkbox
289 * state is checked, an overlay will be added to the background. It's done by
290 * creating an Edje object, and setting it with elm_bg_overlay_set() to the
291 * background object. For information about what are and how to set Edje
292 * object, look at the Edje documentation.
294 * Finally we add a spinner object (elm_spinner_add()) to be used to select
295 * the color of our background. In its callback it's possible to see the call
296 * to elm_bg_color_set(), which will change the color of this background.
297 * This color is used by the background to fill areas where the image doesn't
298 * cover (in this case, where we have an image background). The spinner is
299 * also packed into the @c hbox :
301 * @skip elm_spinner_add
302 * @until evas_object_show
304 * Then we just have to pack the @c hbox inside the @c box, set some size
305 * hints, and show our window:
310 * Now to see this code in action, open elementary_test, and go to the "Bg
311 * Options" test. It should demonstrate what was implemented here.
315 * @page actionslider_example_page Actionslider usage
316 * @dontinclude actionslider_example_01.c
318 * For this example we are going to assume knowledge of evas smart callbacks
319 * and some basic evas object functions. Elementary is not meant to be used
320 * without evas, if you're not yet familiar with evas it probably is worth
323 * And now to the example, when using Elementary we start by including
327 * Next we define some callbacks, they all share the same signature because
328 * they are all to be used with evas_object_smart_callback_add().
329 * The first one just prints the selected label(in two different ways):
332 * This next callback is a little more interesting, it makes the selected
333 * label magnetic(except if it's the center label):
336 * This callback enables or disables the magnetic propertty of the center
340 * And finally a callback to stop the main loop when the window is closed:
343 * To be able to create our actionsliders we need to do some setup, but this
344 * isn't really relevant here, so if you want to know about that go @ref
347 * With all that boring stuff out of the way we can proceed to creating some
349 * All actionsliders are created the same way:
350 * @skipline actionslider_add
351 * Next we must choose where the indicator starts, and for this one we choose
352 * the right, and set the right as magnetic:
353 * @skipline indicator_pos_set
354 * @until magnet_pos_set
356 * We then set the labels for the left and right, passing NULL as an argument
357 * to any of the labels makes that position have no label.
360 * Furthermore we mark both left and right as enabled positions, if we didn't
361 * do this all three positions would be enabled:
364 * Having the the enabled positions we now add a smart callback to change
365 * which position is magnetic, so that only the last selected position is
369 * And finally we set our printing callback and show the actionslider:
373 * For our next actionslider we are going to do much as we did for the
374 * previous except we are going to have the center as the magnet(and not
376 * @skipline actionslider_add
377 * @skipline indicator_pos_set
380 * And another actionslider, in this one the indicator starts on the left.
381 * It has labels only in the center and right, and both bositions are
382 * magnetic. Because the left doesn't have a label and is not magnetic once
383 * the indicator leaves it can't return:
384 * @skipline actionslider_add
385 * @skipline indicator_pos_set
387 * @note The greyed out area is a @ref Styles "style".
389 * And now an actionslider with a label in the indicator, and whose magnet
390 * properties change based on what was last selected:
391 * @skipline actionslider_add
392 * @skipline indicator_pos_set
394 * @note The greyed out area is a @ref Styles "style".
396 * We are almost done, this next one is just an actionslider with all
397 * positions magnetized and having every possible label:
398 * @skipline actionslider_add
399 * @skipline indicator_pos_set
402 * And for our last actionslider we have one that turns the magnetic property
404 * @skipline actionslider_add
405 * @skipline indicator_pos_set
408 * The example will look like this:
410 * @image html screenshots/actionslider_01.png
411 * @image latex screenshots/actionslider_01.eps width=\textwidth
413 * See the full source code @ref actionslider_example_01 "here"
417 * @page elm_animator_example_page_01 Animator usage
418 * @dontinclude animator_example_01.c
420 * For this example we will be using a bit of evas, you could animate a
421 * elementary widget in much the same way, but to keep things simple we use
422 * an evas_object_rectangle.
424 * As every other example we start with our include and a simple callback to
425 * exit the app when the window is closed:
429 * This next callback is the one that actually creates our animation, it
430 * changes the size, position and color of a rectangle given to it in @a
434 * Next we have a callback that prints a string, nothing special:
437 * This next callback is a little more interesting, it has a state variable
438 * to know if the animation is currently paused or running, and it toogles
439 * the state of the animation accordingly:
444 * Finally we have a callback to stop the animation:
447 * As with every example we need to do a bit of setup before we can actually
448 * use an animation, but for the purposes of this example that's not relevant
449 * so let's just skip to the good stuff, creating an animator:
450 * @skipline animator_add
451 * @note Since elm_animator is not a widget we can give it a NULL parent.
453 * Now that we have an elm_animator we set it's duration to 1 second:
456 * We would also like our animation to be reversible, so:
459 * We also set our animation to repeat as many times as possible, which will
460 * mean that _end_cb will only be called after UINT_MAX * 2 seconds(UINT_MAX
461 * for the animation running forward and UNIT_MAX for the animation running
465 * To add some fun to our animation we will use the IN_OUT curve style:
468 * To actually animate anything we need an operation callback:
469 * @line operation_callback
471 * Even though we set our animation to repeat for a very long time we are
472 * going to set a end callback to it:
473 * @line completion_callback
474 * @note Notice that stoping the animation with the stop button will not make
477 * Now that we have fully set up our animator we can tell it to start
481 * There's a bit more of code that doesn't really matter to use so we skip
482 * right down to our last interesting point:
483 * @skipline animator_del
484 * @note Because we created our animator with no parent we need to delete it
487 * The example should look like this:
489 * @image html screenshots/animator_example_01.png
490 * @image latex screenshots/animator_example_01.eps width=\textwidth
492 * @image html screenshots/animator_example_02.png
493 * @image latex screenshots/animator_example_02.eps width=\textwidth
495 * @image html screenshots/animator_example_03.png
496 * @image latex screenshots/animator_example_03.eps width=\textwidth
498 * The full source code for this example can be found @ref
499 * animator_example_01_c "here"
503 * @page transit_example_03_c elm_transit - Combined effects and options.
505 * This example shows how to apply the following transition effects:
513 * It allows you to apply more than one effect at once, and also allows to
514 * set properties like event_enabled, auto_reverse, repeat_times and
517 * @include transit_example_03.c
521 * @page transit_example_04_c elm_transit - Combined effects over two objects.
523 * This example shows how to apply the transition effects:
528 * over two objects. This kind of transition effect is used to make one
529 * object disappear and another one appear on its place.
531 * You can mix more than one effect of this type on the same objects, and the
532 * transition will apply both.
534 * @include transit_example_04.c
538 * @page transit_example_01_explained elm_transit - Basic transit usage.
539 * @dontinclude transit_example_01.c
541 * The full code for this example can be found at @ref transit_example_01_c.
543 * This example shows the simplest way of creating a transition and applying
544 * it to an object. Similarly to every other elementary example, we create a
545 * window, set its title, size, autodel property, and setup a callback to
546 * exit the program when finished:
549 * @until evas_object_resize
551 * We also add a resizeable white background to use behind our animation:
554 * @until evas_object_show
556 * And then we add a button that we will use to demonstrate the effects of
560 * @until evas_object_show(win)
562 * Notice that we are not adding the button with elm_win_resize_object_add()
563 * because we don't want the window to control the size of the button. We
564 * will use the transition to change the button size, so it could conflict
565 * with something else trying to control that size.
567 * Now, the simplest code possible to create the resize animation:
572 * As you can see, this code is very easy to understand. First, we create the
573 * transition itself with elm_transit_add(). Then we add the button to this
574 * transition with elm_transit_object_add(), which means that the transition
575 * will operate over this button. The effect that we want now is changing the
576 * object size from 100x50 to 300x150, and can be achieved by adding the
577 * resize effect with elm_transit_effect_resizing_add().
579 * Finally, we set the transition time to 5 seconds and start the transition
580 * with elm_transit_go(). If we wanted more effects applied to this
581 * button, we could add them to the same transition. See the
582 * @ref transit_example_03_c to watch many transitions being applied to an
587 * @page transit_example_02_explained elm_transit - Chained transitions.
588 * @dontinclude transit_example_02.c
590 * The full code for this example can be found at @ref transit_example_02_c.
592 * This example shows how to implement a chain of transitions. This chain is
593 * used to start a transition just after another transition ended. Similarly
594 * to every other elementary example, we create a window, set its title,
595 * size, autodel property, and setup a callback to exit the program when
599 * @until evas_object_resize
601 * We also add a resizeable white background to use behind our animation:
604 * @until evas_object_show
606 * This example will have a chain of 4 transitions, each of them applied to
607 * one button. Thus we create 4 different buttons:
610 * @until evas_object_show(bt4)
612 * Now we create a simple translation transition that will be started as soon
613 * as the program loads. It will be our first transition, and the other
614 * transitions will be started just after this transition ends:
619 * The code displayed until now has nothing different from what you have
620 * already seen in @ref transit_example_01_explained, but now comes the new
621 * part: instead of creating a second transition that will start later using
622 * a timer, we create the it normally, and use
623 * elm_transit_chain_transit_add() instead of elm_transit_go. Since we are
624 * adding it in a chain after the first transition, it will start as soon as
625 * the first transition ends:
628 * @until transit_chain_transit_add
630 * Finally we add the 2 other transitions to the chain, and run our program.
631 * It will make one transition start after the other finish, and there is the
636 * @page general_functions_example_page General (top-level) functions example
637 * @dontinclude general_funcs_example.c
639 * As told in their documentation blocks, the
640 * elm_app_compile_*_dir_set() family of functions have to be called
641 * before elm_app_info_set():
642 * @skip tell elm about
643 * @until elm_app_info_set
645 * We are here setting the fallback paths to the compiling time target
646 * paths, naturally. If you're building the example out of the
647 * project's build system, we're assuming they are the canonical ones.
649 * After the program starts, elm_app_info_set() will actually run and
650 * then you'll see an intrincasy: Elementary does the prefix lookup @b
651 * twice. This is so because of the quicklaunch infrastructure in
652 * Elementary (@ref Start), which will register a predefined prefix
653 * for possible users of the launch schema. We're not hooking into a
654 * quick launch, so this first call can't be avoided.
656 * If you ran this example from your "bindir" installation
657 * directiory, no output will emerge from these both attempts -- it
658 * will find the "magic" file there registered and set the prefixes
659 * silently. Otherwise, you could get something like:
661 WARNING: Could not determine its installed prefix for 'ELM'
662 so am falling back on the compiled in default:
664 implied by the following:
667 datadir = usr/share/elementary
668 localedir = usr/share/locale
669 Try setting the following environment variables:
670 ELM_PREFIX - points to the base prefix of install
671 or the next 4 variables
672 ELM_BIN_DIR - provide a specific binary directory
673 ELM_LIB_DIR - provide a specific library directory
674 ELM_DATA_DIR - provide a specific data directory
675 ELM_LOCALE_DIR - provide a specific locale directory
677 * if you also didn't change those environment variables (remember
678 * they are also a valid way of communicating your prefix to the
679 * binary) - this is the scenario where it fallbacks to the paths set
682 * Then, you can check the prefixes set on the standard output:
683 * @skip prefix was set to
684 * @until locale directory is
687 * @skip by using this policy
688 * @until elm_win_autodel_set
689 * we demonstrate the use of Elementary policies. The policy defining
690 * under which circunstances our application should quit automatically
691 * is set to when its last window is closed (this one has just one
692 * window, though). This will save us from having to set a callback
693 * ourselves on the window, like done in @ref bg_example_01_c "this"
694 * example. Note that we need to tell the window to delete itself's
695 * object on a request to destroy the canvas coming, with
696 * elm_win_autodel_set().
698 * What follows is some boilerplate code, creating a frame with a @b
699 * button, our object of interest, and, below, widgets to change the
700 * button's behavior and exemplify the group of functions in question.
702 * @dontinclude general_funcs_example.c
703 * We enabled the focus highlight object for this window, so that you
704 * can keep track of the current focused object better:
705 * @skip elm_win_focus_highlight_enabled_set
706 * @until evas_object_show
707 * Use the tab key to navigate through the focus chain.
709 * @dontinclude general_funcs_example.c
710 * While creating the button, we exemplify how to use Elementary's
711 * finger size information to scale our UI:
712 * @skip fprintf(stdout, "Elementary
713 * @until evas_object_show
715 * @dontinclude general_funcs_example.c
716 * The first checkbox's callback is:
719 * When unsetting the checkbox, we disable the button, which will get a new
720 * decoration (greyed out) and stop receiving events. The focus chain
721 * will also ignore it.
723 * Following, there are 2 more buttons whose actions are focus/unfocus
724 * the top button, respectively:
725 * @skip focus callback
728 * @skip unfocus callback
730 * Note the situations in which they won't take effect:
731 * - the button is not allowed to get focus or
732 * - the button is disabled
734 * The first restriction above you'll get by a second checkbox, whose
736 * @skip focus allow callback
738 * Note that the button will still get mouse events, though.
740 * Next, there's a slider controlling the button's scale:
741 * @skip scaling callback
744 * Experiment with it, so you understand the effect better. If you
745 * change its value, it will mess with the button's original size,
748 * The full code for this example can be found
749 * @ref general_functions_example_c "here".
753 * @page theme_example_01 Theme - Using extensions
755 * @dontinclude theme_example_01.c
757 * Using extensions is extremely easy, discarding the part where you have to
758 * write the theme for them.
760 * In the following example we'll be creating two buttons, one to load or
761 * unload our extension theme and one to cycle around three possible styles,
762 * one of which we created.
764 * After including our one and only header we'll jump to the callback for
765 * the buttons. First one takes care of loading or unloading our extension
766 * file, relative to the default theme set (thus the @c NULL in the
767 * functions first parameter).
768 * @skipline Elementary.h
774 * The second button, as we said before, will just switch around different
775 * styles. In this case we have three of them. The first one is our custom
776 * style, named after something very unlikely to find in the default theme.
777 * The other two styles are the standard and one more, anchor, which exists
778 * in the default and is similar to the default, except the button vanishes
779 * when the mouse is not over it.
784 * So what happens if the style switches to our custom one when the
785 * extension is loaded? Elementary falls back to the default for the
788 * And the main function, simply enough, will create the window, set the
789 * buttons and their callbacks, and just to begin with our button styled
790 * we're also loading our extension at the beginning.
794 * In this case we wanted to easily remove extensions, but all adding an
795 * extension does is tell Elementary where else it should look for themes
796 * when it can't find them in the default theme. Another way to do this
797 * is to set the theme search order using elm_theme_set(), but this requires
798 * that the developer is careful not to override any user configuration.
799 * That can be helped by adding our theme to the end of whatver is already
800 * set, like in the following snippet.
803 * snprintf(buf, sizeof(buf), "%s:./theme_example.edj", elme_theme_get(NULL);
804 * elm_theme_set(NULL, buf);
807 * If we were using overlays instead of extensions, the same thing applies,
808 * but the custom theme must be added to the front of the search path.
810 * In the end, we should be looking at something like this:
812 * @image html screenshots/theme_example_01.png
813 * @image latex screenshots/theme_example_01.eps width=\textwidth
815 * That's all. Boringly simple, and the full code in one piece can be found
816 * @ref theme_example_01.c "here".
818 * And the code for our extension is @ref theme_example.edc "here".
820 * @example theme_example_01.c
821 * @example theme_example.edc
825 * @page theme_example_02 Theme - Using overlays
827 * @dontinclude theme_example_02.c
829 * Overlays are like extensions in that you tell Elementary that some other
830 * theme contains the styles you need for your program. The difference is that
831 * they will be look in first, so they can override the default style of any
834 * There's not much to say about them that hasn't been said in our previous
835 * example about @ref theme_example_01 "extensions", so going quickly through
836 * the code we have a function to load or unload the theme, which will be
837 * called when we click any button.
838 * @skipline Elementary.h
842 * And the main function, creating the window and adding some buttons to it.
843 * We load our theme as an overlay and nothing else. Notice there's no style
844 * set for any button there, which means they should be using the default
849 * That's pretty much it. The full code is @ref theme_example_02.c "here" and
850 * the definition of the theme is the same as before, and can be found in
851 * @ref theme_example.edc "here".
853 * @example theme_example_02.c
857 * @page button_example_01 Button - Complete example
859 * @dontinclude button_example_01.c
861 * A button is simple, you click on it and something happens. That said,
862 * we'll go through an example to show in detail the button API less
865 * In the end, we'll be presented with something that looks like this:
867 * @image html screenshots/button_01.png
868 * @image latex screenshots/button_01.eps width=\textwidth
870 * The full code of the example is @ref button_example_01.c "here" and we
871 * will follow here with a rundown of it.
874 * @until Elementary.h
878 * We have several buttons to set different times for the autorepeat timeouts
879 * of the buttons that use it and a few more that we keep track of in our
880 * data struct. The mid button doesn't do much, just moves around according
881 * to what other buttons the user presses. Then four more buttons to move the
882 * central one, and we're also keeping track of the icon set in the middle
883 * button, since when this one moves, we change the icon, and when movement
884 * is finished (by releasing one of the four arrow buttons), we set back the
889 * Keeping any of those four buttons pressed will trigger their autorepeat
890 * callback, where we move the button doing some size hint magic. To
891 * understand how that works better, refer to the @ref Box documentation.
892 * Also, the first time the function is called, we change the icon in the
893 * middle button, using elm_button_icon_unset() first to keep the reference
894 * to the previous one, so we don't need to recreate it when we are done
898 * @until size_hint_align_set
901 * One more callback for the option buttons, that just sets the timeouts for
902 * the different autorepeat options.
909 * And the main function, which does some setting up of the buttons in boxes
910 * to make things work. Here we'll go through some snippets only.
912 * For the option buttons, it's just the button with its label and callback.
913 * @skip elm_button_add
914 * @until smart_callback_add
916 * For the ones that move the central button, we have no labels. There are
917 * icons instead, and the autorepeat option is toggled.
919 * @skip elm_button_add
920 * @until data.cursors.up
922 * And just to show the mid button, which doesn't have anything special.
923 * @skip data.cursors.left
924 * @skip elm_button_add
929 * @example button_example_01.c
933 * @page bubble_01_example_page elm_bubble - Simple use.
934 * @dontinclude bubble_example_01.c
936 * This example shows a bubble with all fields set(label, info, content and
937 * icon) and the selected corner changing when the bubble is clicked. To be
938 * able use a bubble we need to do some setup and create a window, for this
939 * example we are going to ignore that part of the code since it isn't
940 * relevant to the bubble.
942 * To have the selected corner change in a clockwise motion we are going to
943 * use the following callback:
948 * Here we are creating an elm_label that is going to be used as the content
950 * @skipline elm_label
952 * @note You could use any evas_object for this, we are using an elm_label
955 * Despite it's name the bubble's icon doesn't have to be an icon, it can be
956 * any evas_object. For this example we are going to make the icon a simple
960 * And finally we have the actual bubble creation and the setting of it's
961 * label, info and content:
964 * @note Because we didn't set a corner, the default("top_left") will be
967 * Now that we have our bubble all that is left is connecting the "clicked"
968 * signals to our callback:
969 * @line smart_callback
971 * This last bubble we created was very complete, so it's pertinent to show
972 * that most of that stuff is optional a bubble can be created with nothing
977 * Our example will look like this:
979 * @image html screenshots/bubble_example_01.png
980 * @image latex screenshots/bubble_example_01.eps width=\textwidth
982 * See the full source code @ref bubble_example_01.c here.
983 * @example bubble_example_01.c
987 * @page box_example_01 Box - Basic API
989 * @dontinclude button_example_01.c
991 * As a special guest tonight, we have the @ref button_example_01 "simple
992 * button example". There are plenty of boxes in it, and to make the cursor
993 * buttons that moved a central one around when pressed, we had to use a
994 * variety of values for their hints.
996 * To start, let's take a look at the handling of the central button when
997 * we were moving it around. To achieve this effect without falling back to
998 * a complete manual positioning of the @c Evas_Object in our canvas, we just
999 * put it in a box and played with its alignment within it, as seen in the
1000 * following snippet of the callback for the pressed buttons.
1001 * @skip evas_object_size_hint_align_get
1002 * @until evas_object_size_hint_align_set
1004 * Not much to it. We get the current alignment of the object and change it
1005 * by just a little, depending on which button was pressed, then set it
1006 * again, making sure we stay within the 0.0-1.0 range so the button moves
1007 * inside the space it has, instead of disappearing under the other objects.
1009 * But as useful as an example as that may have been, the usual case with boxes
1010 * is to set everything at the moment they are created, like we did for
1011 * everything else in our main function.
1013 * The entire layout of our program is made with boxes. We have one set as the
1014 * resize object for the window, which means it will always be resized with
1015 * the window. The weight hints set to @c EVAS_HINT_EXPAND will tell the
1016 * window that the box can grow past it's minimum size, which allows resizing
1020 * @until evas_object_show
1022 * Two more boxes, set to horizontal, hold the buttons to change the autorepeat
1023 * configuration used by the buttons. We create each to take over all the
1024 * available space horizontally, but we don't want them to grow vertically,
1025 * so we keep that axis of the weight with 0.0. Then it gets packed in the
1028 * @until evas_object_show
1030 * The buttons in each of those boxes have nothing special, they are just packed
1031 * in with their default values and the box will use their minimum size, as set
1032 * by Elementary itself based on the label, icon, finger size and theme.
1034 * But the buttons used to move the central one have a special disposition.
1035 * The top one first, is placed right into the main box like our other smaller
1036 * boxes. Set to expand horizontally and not vertically, and in this case we
1037 * also tell it to fill that space, so it gets resized to take the entire
1038 * width of the window.
1040 * @skip elm_button_add
1041 * @until evas_object_show
1043 * The bottom one will be the same, but for the other two we need to use a
1044 * second box set to take as much space as we have, so we can place our side
1045 * buttons in place and have the big empty space where the central button will
1048 * @until evas_object_show
1050 * Then the buttons will have their hints inverted to the other top and bottom
1051 * ones, to expand and fill vertically and keep their minimum size horizontally.
1052 * @skip elm_button_add
1053 * @until evas_object_show
1055 * The central button takes every thing else. It will ask to be expanded in
1056 * both directions, but without filling its cell. Changing its alignment by
1057 * pressing the buttons will make it move around.
1058 * @skip elm_button_add
1059 * @until evas_object_show
1061 * To end, the rightmost button is packed in the smaller box after the central
1062 * one, and back to the main box we have the bottom button at the end.
1066 * @page box_example_02 Box - Layout transitions
1068 * @dontinclude box_example_02.c
1070 * Setting a customized layout for a box is simple once you have the layout
1071 * function, which is just like the layout function for @c Evas_Box. The new
1072 * and fancier thing we can do with Elementary is animate the transition from
1073 * one layout to the next. We'll see now how to do that through a simple
1074 * example, while also taking a look at some of the API that was left
1075 * untouched in our @ref box_example_01 "previous example".
1077 * @image html screenshots/box_example_02.png
1078 * @image latex screenshots/box_example_02.eps width=\textwidth
1080 * @skipline Elementary.h
1082 * Our application data consists of a list of layout functions, given by
1083 * @c transitions. We'll be animating through them throughout the entire run.
1084 * The box with the stuff to move around and the last layout that was set to
1085 * make things easier in the code.
1087 * @until Transitions_Data
1089 * The box starts with three buttons, clicking on any of them will take it
1090 * out of the box without deleting the object. There are also two more buttons
1091 * outside, one to add an object to the box and the other to clear it.
1092 * This is all to show how you can interact with the items in the box, add
1093 * things and even remove them, while the transitions occur.
1095 * One of the callback we'll be using creates a new button, asks the box for
1096 * the list of its children and if it's not empty, we add the new object after
1097 * the first one, otherwise just place at the end as it will not make any
1103 * The clear button is even simpler. Everything in the box will be deleted,
1104 * leaving it empty and ready to fill it up with more stuff.
1108 * And a little function to remove buttons from the box without deleting them.
1109 * This one is set for the @c clicked callback of the original buttons,
1110 * unpacking them when clicked and placing it somewhere in the screen where
1111 * they will not disturb. Once we do this, the box no longer has any control
1112 * of it, so it will be left untouched until the program ends.
1116 * If we wanted, we could just call @c evas_object_del() on the object to
1117 * destroy it. In this case, no unpack is really necessary, as the box would
1118 * be notified of a child being deleted and adjust its calculations accordingly.
1120 * The core of the program is the following function. It takes whatever
1121 * function is first on our list of layouts and together with the
1122 * @c last_layout, it creates an ::Elm_Box_Transition to use with
1123 * elm_box_layout_transition(). In here, we tell it to start from whatever
1124 * layout we last set, end with the one that was at the top of the list and
1125 * when everything is finished, call us back so we can create another
1126 * transition. Finally, move the new layout to the end of the list so we
1127 * can continue running through them until the program ends.
1131 * The main function doesn't have antyhing special. Creation of box, initial
1132 * buttons and some callback setting. The only part worth mentioning is the
1133 * initialization of our application data.
1135 * @until evas_object_box_layout_stack
1137 * We have a simple static variable, set the box, the first layout we are
1138 * using as last and create the list with the different functions to go
1141 * And in the end, we set the first layout and call the same function we went
1142 * through before to start the run of transitions.
1143 * @until _test_box_transition_change
1145 * For the full code, follow @ref box_example_02.c "here".
1147 * @example box_example_02.c
1151 * @page calendar_example_01 Calendar - Simple creation.
1152 * @dontinclude calendar_example_01.c
1154 * As a first example, let's just display a calendar in our window,
1155 * explaining all steps required to do so.
1157 * First you should declare objects we intend to use:
1158 * @skipline Evas_Object
1160 * Then a window is created, a title is set and its set to be autodeleted.
1161 * More details can be found on windows examples:
1162 * @until elm_win_autodel
1164 * Next a simple background is placed on our windows. More details on
1165 * @ref bg_01_example_page:
1166 * @until evas_object_show(bg)
1168 * Now, the exciting part, let's add the calendar with elm_calendar_add(),
1169 * passing our window object as parent.
1170 * @until evas_object_show(cal);
1172 * To conclude our example, we should show the window and run elm mainloop:
1175 * Our example will look like this:
1177 * @image html screenshots/calendar_example_01.png
1178 * @image latex screenshots/calendar_example_01.eps width=\textwidth
1180 * See the full source code @ref calendar_example_01.c here.
1181 * @example calendar_example_01.c
1185 * @page calendar_example_02 Calendar - Layout strings formatting.
1186 * @dontinclude calendar_example_02.c
1188 * In this simple example, we'll explain how to format the label displaying
1189 * month and year, and also set weekday names.
1191 * To format month and year label, we need to create a callback function
1192 * to create a string given the selected time, declared under a
1193 * <tt> struct tm </tt>.
1195 * <tt> struct tm </tt>, declared on @c time.h, is a structure composed by
1197 * @li tm_sec seconds [0,59]
1198 * @li tm_min minutes [0,59]
1199 * @li tm_hour hour [0,23]
1200 * @li tm_mday day of month [1,31]
1201 * @li tm_mon month of year [0,11]
1202 * @li tm_year years since 1900
1203 * @li tm_wday day of week [0,6] (Sunday = 0)
1204 * @li tm_yday day of year [0,365]
1205 * @li tm_isdst daylight savings flag
1206 * @note glib version has 2 additional fields.
1208 * For our function, only stuff that matters are tm_mon and tm_year.
1209 * But we don't need to access it directly, since there are nice functions
1210 * to format date and time, as @c strftime.
1211 * We will get abbreviated month (%b) and year (%y) (check strftime manpage
1212 * for more) in our example:
1213 * @skipline static char
1216 * We need to alloc the string to be returned, and calendar widget will
1217 * free it when it's not needed, what is done by @c strdup.
1218 * So let's register our callback to calendar object:
1219 * @skipline elm_calendar_format_function_set
1221 * To set weekday names, we should declare them as an array of strings:
1222 * @dontinclude calendar_example_02.c
1223 * @skipline weekdays
1226 * And finally set them to calendar:
1227 * skipline weekdays_names_set
1229 * Our example will look like this:
1231 * @image html screenshots/calendar_example_02.png
1232 * @image latex screenshots/calendar_example_02.eps width=\textwidth
1234 * See the full source code @ref calendar_example_02.c here.
1235 * @example calendar_example_02.c
1239 * @page calendar_example_03 Calendar - Years restrictions.
1240 * @dontinclude calendar_example_03.c
1242 * This example explains how to set max and min year to be displayed
1243 * by a calendar object. This means that user won't be able to
1244 * see or select a date before and after selected years.
1245 * By default, limits are 1902 and maximun value will depends
1246 * on platform architecture (year 2037 for 32 bits); You can
1247 * read more about time functions on @c ctime manpage.
1249 * Straigh to the point, to set it is enough to call
1250 * elm_calendar_min_max_year_set(). First value is minimun year, second
1251 * is maximum. If first value is negative, it won't apply limit for min
1252 * year, if the second one is negative, won't apply for max year.
1253 * Setting both to negative value will clear limits (default state):
1254 * @skipline elm_calendar_min_max_year_set
1256 * Our example will look like this:
1258 * @image html screenshots/calendar_example_03.png
1259 * @image latex screenshots/calendar_example_03.eps width=\textwidth
1261 * See the full source code @ref calendar_example_03.c here.
1262 * @example calendar_example_03.c
1266 * @page calendar_example_04 Calendar - Days selection.
1267 * @dontinclude calendar_example_04.c
1269 * It's possible to disable date selection and to select a date
1270 * from your program, and that's what we'll see on this example.
1272 * If isn't required that users could select a day on calendar,
1273 * only interacting going through months, disabling days selection
1274 * could be a good idea to avoid confusion. For that:
1275 * @skipline elm_calendar_day_selection_enabled_set
1277 * Also, regarding days selection, you could be interested to set a
1278 * date to be highlighted on calendar from your code, maybe when
1279 * a specific event happens, or after calendar creation. Let's select
1280 * two days from current day:
1281 * @dontinclude calendar_example_04.c
1282 * @skipline SECS_DAY
1283 * @skipline current_time
1284 * @until elm_calendar_selected_time_set
1286 * Our example will look like this:
1288 * @image html screenshots/calendar_example_04.png
1289 * @image latex screenshots/calendar_example_04.eps width=\textwidth
1291 * See the full source code @ref calendar_example_04.c here.
1292 * @example calendar_example_04.c
1296 * @page calendar_example_05 Calendar - Signal callback and getters.
1297 * @dontinclude calendar_example_05.c
1299 * Most of setters explained on previous examples have associated getters.
1300 * That's the subject of this example. We'll add a callback to display
1301 * all calendar information every time user interacts with the calendar.
1303 * Let's check our callback function:
1304 * @skipline static void
1305 * @until double interval;
1307 * To get selected day, we need to call elm_calendar_selected_time_get(),
1308 * but to assure nothing wrong happened, we must check for function return.
1309 * It'll return @c EINA_FALSE if fail. Otherwise we can use time set to
1310 * our structure @p stime.
1311 * @skipline elm_calendar_selected_time_get
1314 * Next we'll get information from calendar and place on declared vars:
1315 * @skipline interval
1316 * @until elm_calendar_weekdays_names_get
1318 * The only tricky part is that last line gets an array of strings
1319 * (char arrays), one for each weekday.
1321 * Then we can simple print that to stdin:
1325 * <tt> struct tm </tt> is declared on @c time.h. You can check @c ctime
1326 * manpage to read about it.
1328 * To register this callback, that will be called every time user selects
1329 * a day or goes to next or previous month, just add a callback for signal
1331 * @skipline evas_object_smart_callback_add
1333 * Our example will look like this:
1335 * @image html screenshots/calendar_example_05.png
1336 * @image latex screenshots/calendar_example_05.eps width=\textwidth
1338 * See the full source code @ref calendar_example_05.c here.
1339 * @example calendar_example_05.c
1343 * @page calendar_example_06 Calendar - Calendar marks.
1344 * @dontinclude calendar_example_06.c
1346 * On this example marks management will be explained. Functions
1347 * elm_calendar_mark_add(), elm_calendar_mark_del() and
1348 * elm_calendar_marks_clear() will be covered.
1350 * To add a mark, will be required to choose three things:
1352 * @li mark date, or start date if it will be repeated
1353 * @li mark periodicity
1355 * Style defines the kind of mark will be displayed over marked day,
1356 * on caledar. Default theme supports @b holiday and @b checked.
1357 * If more is required, is possible to set a new theme to calendar
1358 * widget using elm_object_style_set(), and use
1359 * the signal that will be used by such marks.
1361 * Date is a <tt> struct tm </tt>, as defined by @c time.h. More can
1362 * be read on @c ctime manpage.
1363 * If a date relative from current is required, this struct can be set
1365 * @skipline current_time
1366 * @until localtime_r
1368 * Or if it's an absolute date, you can just declare the struct like:
1369 * @dontinclude calendar_example_06.c
1371 * @until christmas.tm_mon
1373 * Periodicity is how frequently the mark will be displayed over the
1374 * calendar. Can be a unique mark (that don't repeat), or it can repeat
1375 * daily, weekly, monthly or annually. It's enumerated by
1376 * @c Elm_Calendar_Mark_Repeat.
1378 * So let's add some marks to our calendar. We will add christmas holiday,
1379 * set Sundays as holidays, and check current day and day after that.
1380 * @dontinclude calendar_example_06.c
1382 * @until christmas.tm_mon
1383 * @skipline current_time
1384 * @until ELM_CALENDAR_WEEKLY
1386 * We kept the return of first mark add, because we don't really won't it
1387 * to be checked, so let's remove it:
1388 * @skipline elm_calendar_mark_del
1390 * After all marks are added and removed, is required to draw them:
1391 * @skipline elm_calendar_marks_draw
1393 * Finally, to clear all marks, let's set a callback for our button:
1394 * @skipline elm_button_add
1395 * @until evas_object_show(bt);
1397 * This callback will receive our calendar object, and should clear it:
1398 * @dontinclude calendar_example_06.c
1401 * @note Remember to draw marks after clear the calendar.
1403 * Our example will look like this:
1405 * @image html screenshots/calendar_example_06.png
1406 * @image latex screenshots/calendar_example_06.eps width=\textwidth
1408 * See the full source code @ref calendar_example_06.c here.
1409 * @example calendar_example_06.c
1413 * @page spinner_example Spinner widget example
1415 * This code places seven Elementary spinner widgets on a window, each of
1416 * them exemplifying a part of the widget's API.
1418 * The first of them is the default spinner:
1419 * @dontinclude spinner_example.c
1420 * @skipline elm_spinner_add
1421 * @until evas_object_show
1422 * As you see, the defaults for a spinner are:
1424 * @li min value set to 0
1425 * @li max value set to 100
1426 * @li step value set to 1
1427 * @li label format set to "%0.f"
1429 * If another format is required, see the second spinner. It will put a text
1430 * before and after the value, and also format value to display two decimals:
1431 * @skipline format_set
1433 * The third one will use a customized step, define new minimum and maximum
1434 * values and enable wrap, so when value reaches minimum it jumps to maximum,
1435 * or jumps to minimum after maximum value is reached. Format is set to display
1437 * @skipline elm_spinner_add
1438 * @until evas_object_show
1440 * The fourth uses @c vertical style, so instead of left and right arrows,
1441 * top and bottom are displayed. Also the change interval is reduced, so
1442 * user can change value faster.
1444 * @skipline interval
1446 * In the fifth the user won't be allowed to set value directly, i.e., will
1447 * be obligate change value only using arrows:
1448 * @skipline editable
1450 * The sixth widget will receive a lot of special values, so
1451 * instead of reading numeric values, user will see labels for each one.
1452 * Also direct edition is disabled, otherwise users would see the numeric
1453 * value on edition mode. User will be able to select a month in this widget:
1454 * @skipline elm_spinner_add
1455 * @until evas_object_show
1457 * Finally the last widget will exemplify how to listen to widget's signals,
1458 * <tt> changed </tt> and <tt> delay,changed </tt>. First we need to
1459 * implement callback functions that will simply print spinner's value:
1460 * @dontinclude spinner_example.c
1467 * The first callback function should be called everytime value changes,
1468 * the second one only after user stops to increment or decrement. Try
1469 * to keep arrows pressed and check the difference.
1470 * @skip smart_callback
1471 * @skipline smart_callback
1472 * @skipline smart_callback
1474 * See the full @ref spinner_example.c "example", whose window should
1475 * look like this picture:
1477 * @image html screenshots/spinner_example.png
1478 * @image latex screenshots/spinner_example.eps width=\textwidth
1480 * See the full @ref spinner_example_c "source code" for this example.
1482 * @example spinner_example.c
1486 * @page slider_example Slider widget example
1488 * This code places seven Elementary slider widgets on a window, each of
1489 * them exemplifying a part of the widget's API.
1491 * The first of them is the default slider:
1492 * @dontinclude slider_example.c
1493 * @skipline elm_slider_add
1494 * @until evas_object_show
1496 * As you see, the defaults for a slider are:
1499 * @li no values (on indicator or unit labels)
1501 * Actually it's pretty useless this way. So let's learn how to improve it.
1503 * If some decoration is required, a label can be set, and icon before and
1504 * after the bar as well. On the second slider will add a @c home icon
1505 * and a @c folder icon at @c end.
1506 * @skipline text_set
1509 * If the bar size need to be changed, it can be done with span set function,
1510 * that doesn't accounts other widget's parts size. Also the bar can starts
1511 * with a not default value (0.0), as we done on third slider:
1512 * @skipline value_set
1513 * @skipline span_size_set
1515 * So far, users won't be able to see the slider value. If it's required,
1516 * it can be displayed in two different areas, units label or above
1519 * Let's place a units label on our widget, and also let's set minimum and
1520 * maximum value (uses 0.0 and 1.0 by default):
1521 * @skipline unit_format_set
1522 * @skipline min_max_set
1524 * If above the indicator is the place to display the value, just set it.
1525 * Also, is possible to invert a bar, as you can see:
1526 * @skipline indicator_format_set
1527 * @skipline inverted_set
1529 * But if you require to use a function a bit more customized to show the value,
1530 * is possible to registry a callback function that will be called
1531 * to display unit or indicator label. Only the value will be passed to this
1532 * function, that should return a string.
1533 * In this case, a function to free this string will be required.
1535 * Let's exemplify with indicator label on our sixth slider:
1536 * @dontinclude slider_example.c
1547 * Setting callback functions:
1548 * @skipline indicator_format_function_set
1549 * @skipline _indicator_free
1551 * Also, a slider can be displayed vertically:
1552 * @dontinclude slider_example.c
1553 * @skipline elm_slider_horizontal_set
1555 * Finally the last widget will exemplify how to listen to widget's signals,
1556 * <tt> changed </tt> and <tt> delay,changed </tt>. First we need to
1557 * implement callback functions that will simply print slider's value:
1558 * @dontinclude slider_example.c
1565 * The first callback function should be called everytime value changes,
1566 * the second one only after user stops to increment or decrement. Try
1567 * to keep arrows pressed and check the difference.
1568 * @skip smart_callback
1569 * @skipline smart_callback
1570 * @skipline smart_callback
1572 * See the full @ref slider_example.c "example", whose window should
1573 * look like this picture:
1575 * @image html screenshots/slider_example.png
1576 * @image latex screenshots/slider_example.eps width=\textwidth
1578 * See the full @ref slider_example_c "source code" for this example.
1580 * @example slider_example.c
1584 * @page clock_example Clock widget example
1586 * This code places five Elementary clock widgets on a window, each of
1587 * them exemplifying a part of the widget's API.
1589 * The first of them is the pristine clock:
1590 * @dontinclude clock_example.c
1592 * @until evas_object_show
1593 * As you see, the defaults for a clock are:
1595 * - no seconds shown
1597 * For am/pm time, see the second clock:
1598 * @dontinclude clock_example.c
1600 * @until evas_object_show
1602 * The third one will show the seconds digits, which will flip in
1603 * synchrony with system time. Note, besides, that the time itself is
1604 * @b different from the system's -- it was customly set with
1605 * elm_clock_time_set():
1606 * @dontinclude clock_example.c
1607 * @skip with seconds
1608 * @until evas_object_show
1610 * In both fourth and fifth ones, we turn on the <b>edition
1611 * mode</b>. See how you can change each of the sheets on it, and be
1612 * sure to try holding the mouse pressed over one of the sheet
1613 * arrows. The forth one also starts with a custom time set:
1614 * @dontinclude clock_example.c
1616 * @until evas_object_show
1618 * The fifth, besides editable, has only the time @b units editable,
1619 * for hours, minutes and seconds. This exemplifies
1620 * elm_clock_digit_edit_set():
1621 * @dontinclude clock_example.c
1623 * @until evas_object_show
1625 * See the full @ref clock_example.c "example", whose window should
1626 * look like this picture:
1628 * @image html screenshots/clock_example.png
1629 * @image latex screenshots/clock_example.eps width=\textwidth
1631 * See the full @ref clock_example_c "source code" for this example.
1633 * @example clock_example.c
1637 * @page diskselector_example_01 Diskselector widget example
1639 * This code places 4 Elementary diskselector widgets on a window, each of
1640 * them exemplifying a part of the widget's API.
1642 * All of them will have weekdays as items, since we won't focus
1643 * on items management on this example. For an example about this subject,
1644 * check @ref diskselector_example_02.
1646 * The first of them is a default diskselector.
1647 * @dontinclude diskselector_example_01.c
1650 * @skipline elm_diskselector_add
1651 * @until evas_object_show
1653 * We are just adding the diskselector, so as you can see, defaults for it are:
1654 * @li Only 3 items visible each time.
1655 * @li Only 3 characters are displayed for labels on side positions.
1656 * @li The first added item remains centeres, i.e., it's the selected item.
1658 * To add items, we are just appending it on a loop, using function
1659 * elm_diskselector_item_append(), that will be better exaplained on
1660 * items management example.
1662 * For a circular diskselector, check the second widget. A circular
1663 * diskselector will display first item after last, and last previous to
1664 * the first one. So, as you can see, @b Sa will appears on left side
1665 * of selected @b Sunday. This property is set with
1666 * elm_diskselector_round_set().
1668 * Also, we decide to display only 2 character for side labels, instead of 3.
1669 * For this we call elm_diskselector_side_label_length_set(). As result,
1670 * we'll see @b Mo displayed instead of @b Mon, when @b Monday is on a
1673 * @skipline elm_diskselector_add
1674 * @until evas_object_show
1676 * But so far, we are only displaying 3 items at once. If more are wanted,
1677 * is enough to call elm_diskselector_display_item_num_set(), as you can
1679 * @skipline elm_diskselector_add
1680 * @until evas_object_show
1682 * @note You can't set less than 3 items to be displayed.
1684 * Finally, if a bounce effect is required, or you would like to see
1685 * scrollbars, it is possible. But, for default theme, diskselector
1686 * scrollbars will be invisible anyway.
1687 * @skipline elm_diskselector_add
1688 * @until evas_object_show
1690 * See the full @ref diskselector_example_01.c "diskselector_example_01.c"
1691 * code, whose window should look like this picture:
1693 * @image html screenshots/diskselector_example_01.png
1694 * @image latex screenshots/diskselector_example_01.eps width=\textwidth
1696 * @example diskselector_example_01.c
1700 * @page diskselector_example_02 Diskselector - Items management
1702 * This code places a Elementary diskselector widgets on a window,
1703 * along with some buttons trigerring actions on it (though its API).
1704 * It covers most of Elm_Diskselector_Item functions.
1706 * On our @c main function, we are adding a default diskselector with
1707 * 3 items. We are only setting their labels (second parameter of function
1708 * elm_diskselector_item_append):
1709 * @dontinclude diskselector_example_02.c
1710 * @skipline elm_diskselector_add
1713 * Next we are adding lots of buttons, each one for a callback function
1714 * that will realize a task covering part of diskselector items API.
1715 * Lets check the first one:
1716 * @skipline elm_button_add
1717 * @until evas_object_show
1719 * We are labeling the button with a task description with
1720 * elm_object_text_set() and setting a callback
1721 * function evas_object_smart_callback_add().
1722 * Each callback function will have the signature:
1723 * <tt> static void _task_cb(void *data, Evas_Object *obj,
1724 * void *event_info)</tt> with the function name varying for each task.
1726 * Now let's cover all of them.
1728 * <b> Appending an item: </b>
1729 * @dontinclude diskselector_example_02.c
1733 * All items are included on diskselector after last one. You @b can't
1736 * The first parameter of elm_diskselector_item_append() is the diskselector
1737 * object, that we are receiving as data on our callback function.
1738 * The second one is a label, the string that will be placed in the center
1739 * of our item. As we don't wan't icons or callback functions, we can
1740 * send NULL as third, fourth and fifth parameters.
1742 * <b> Appending an item with icon: </b>
1743 * @dontinclude diskselector_example_02.c
1744 * @skipline _add_ic_cb
1747 * If an icon is required, you can pass it as third paramenter on our
1748 * elm_diskselector_item_append() function. It will be place on the
1749 * left side of item's label, that will be shifted to right a bit.
1751 * For more details about how to create icons, look for elm_icon examples.
1753 * <b> Appending an item with callback function for selected: </b>
1754 * @dontinclude diskselector_example_02.c
1759 * To set a callback function that will be called every time an item is
1760 * selected, i.e., everytime the diskselector stops with this item in
1761 * center position, just pass the function as fourth paramenter.
1763 * <b> Appending an item with callback function for selected with data: </b>
1764 * @dontinclude diskselector_example_02.c
1765 * @skipline _sel_data_cb
1771 * If the callback function request an extra data, it can be attached to our
1772 * item passing a pointer for data as fifth parameter.
1773 * Our function _sel_data_cb will receive it as <tt> void *data </tt>.
1775 * If you want to free this data, or handle that the way you need when the
1776 * item is deleted, set a callback function for that, with
1777 * elm_diskselector_item_del_cb_set().
1779 * As you can see we check if @c it is not @c NULL after appending it.
1780 * If an error happens, we won't try to set a function for it.
1782 * <b> Deleting an item: </b>
1783 * @dontinclude diskselector_example_02.c
1788 * To delete an item we simple need to call elm_diskselector_item_del() with
1789 * a pointer for such item.
1791 * If you need, you can get selected item with
1792 * elm_diskselector_selected_item_get(), that will return a pointer for it.
1794 * <b> Unselecting an item: </b>
1795 * @dontinclude diskselector_example_02.c
1796 * @skipline _unselect_cb
1799 * To select an item, you should call elm_diskselector_item_selected_set()
1800 * passing @c EINA_TRUE, and to unselect it, @c EINA_FALSE.
1802 * If you unselect the selected item, diskselector will automatically select
1805 * <b> Printing all items: </b>
1806 * @dontinclude diskselector_example_02.c
1807 * @skipline _print_cb
1810 * <b> Clearing the diskselector: </b>
1811 * @dontinclude diskselector_example_02.c
1812 * @skipline _clear_cb
1815 * <b> Selecting the first item: </b>
1816 * @dontinclude diskselector_example_02.c
1817 * @skipline _select_first_cb
1820 * <b> Selecting the last item: </b>
1821 * @dontinclude diskselector_example_02.c
1822 * @skipline _select_last_cb
1825 * <b> Selecting the next item: </b>
1826 * @dontinclude diskselector_example_02.c
1827 * @skipline _select_next_cb
1830 * <b> Selecting the previous item: </b>
1831 * @dontinclude diskselector_example_02.c
1832 * @skipline _select_prev_cb
1835 * See the full @ref diskselector_example_02.c "diskselector_example_02.c"
1836 * code, whose window should look like this picture:
1838 * @image html screenshots/diskselector_example_02.png
1839 * @image latex screenshots/diskselector_example_02.eps width=\textwidth
1841 * @example diskselector_example_02.c
1845 * @page list_example_01 List widget example
1847 * This code places a single Elementary list widgets on a window, just
1848 * to exemplify the more simple and common use case: a list will be created
1849 * and populated with a few items.
1851 * To keep it simple, we won't show how to customize the list, for this check
1852 * @ref list_example_02. Also, we won't focus
1853 * on items management on this example. For an example about this subject,
1854 * check @ref list_example_03.
1856 * To add a list widget.
1857 * @dontinclude list_example_01.c
1858 * @skipline elm_list_add
1860 * We are just adding the list, so as you can see, defaults for it are:
1861 * @li Items are displayed vertically.
1862 * @li Only one item can be selected.
1863 * @li The list doesn't bouce.
1865 * To add items, we are just appending it on a loop, using function
1866 * elm_list_item_append(), that will be better exaplained on
1867 * items management example.
1868 * @dontinclude list_example_01.c
1872 * @skipline elm_list_item_append
1874 * After we just want to show the list. But first we need to start the widget.
1875 * It was done this way to improve widget's performance. So, always remember
1877 * @warning Call elm_list_go before showing the object
1878 * @skipline elm_list_go
1881 * See the full @ref list_example_01.c "list_example_01.c"
1882 * code, whose window should look like this picture:
1884 * @image html screenshots/list_example_01.png
1885 * @image latex screenshots/list_example_01.eps width=\textwidth
1887 * @example list_example_01.c
1891 * @page list_example_02 List widget example
1893 * This code places a single Elementary list widgets on a window,
1894 * exemplifying a part of the widget's API.
1896 * First, we will just create a simple list, as done on @ref list_example_01 :
1897 * @dontinclude list_example_02.c
1900 * @skipline elm_list_add
1901 * @until elm_list_item_append
1903 * Now, let's customize this list a bit. First we will display items
1905 * @skipline horizontal_set
1907 * Then we will choose another list mode. There are four of them, and
1908 * the default #Elm_List_Mode is #ELM_LIST_SCROLL. Let's set compress mode:
1909 * @skipline mode_set
1911 * To enable multiple items selection, we need to enable it, since only one
1912 * selected item is allowed by default:
1913 * @skipline elm_list_multi_select_set
1915 * We are not adding items with callback functions here,
1916 * since we'll explain it better on @ref list_example_03. But if the callback
1917 * need to be called everytime user clicks an item, even if already selected,
1918 * it's required to enable this behavior:
1919 * @skipline elm_list_always_select_mode_set
1921 * Finally, if a bounce effect is required, or you would like to see
1922 * scrollbars, it is possible. But, for default theme, list
1923 * scrollbars will be invisible anyway.
1924 * @skipline bounce_set
1925 * @until SCROLLER_POLICY_ON
1927 * See the full @ref list_example_02.c "list_example_02.c"
1928 * code, whose window should look like this picture:
1930 * @image html screenshots/list_example_02.png
1931 * @image latex screenshots/list_example_02.eps width=\textwidth
1933 * @example list_example_02.c
1937 * @page list_example_03 List - Items management
1939 * This code places a Elementary list widgets on a window,
1940 * along with some buttons trigerring actions on it (though its API).
1941 * It covers most of Elm_List_Item functions.
1943 * On our @c main function, we are adding a default list with
1944 * 3 items. We are only setting their labels (second parameter of function
1945 * elm_list_item_append):
1946 * @dontinclude list_example_03.c
1947 * @skipline elm_list_add
1950 * Next we are adding lots of buttons, each one for a callback function
1951 * that will realize a task covering part of list items API.
1952 * Lets check the first one:
1953 * @skipline elm_button_add
1954 * @until evas_object_show
1956 * We are labeling the button with a task description with
1957 * elm_object_text_set() and setting a callback
1958 * function evas_object_smart_callback_add().
1959 * Each callback function will have the signature:
1960 * <tt> static void _task_cb(void *data, Evas_Object *obj,
1961 * void *event_info)</tt> with the function name varying for each task.
1963 * Now let's cover all of them.
1965 * <b> Prepending an item: </b>
1966 * @dontinclude list_example_03.c
1967 * @skipline _prepend_cb
1970 * The item will be placed on the begining of the list,
1971 * i.e. it will be the first one.
1973 * The first parameter of elm_list_item_prepend() is the list
1974 * object, that we are receiving as data on our callback function.
1975 * The second one is a label, the string that will be placed in the center
1976 * of our item. As we don't wan't icons or callback functions, we can
1977 * send NULL as third, fourth, fifth and sixth parameters.
1979 * <b> Appending an item: </b>
1980 * @dontinclude list_example_03.c
1984 * Items included with append will be inserted inserted after the last one.
1986 * <b> Appending an item with icon: </b>
1987 * @dontinclude list_example_03.c
1988 * @skipline _add_ic_cb
1991 * If an icon is required, you can pass it as third paramenter on our
1992 * elm_list_item_append() function. It will be place on the
1993 * left side of item's label. If an icon is wanted on the right side,
1994 * it should be passed as fourth parameter.
1996 * For more details about how to create icons, look for elm_icon examples
1997 * @ref tutorial_icon.
1999 * <b> Appending an item with callback function for selected: </b>
2000 * @dontinclude list_example_03.c
2005 * To set a callback function that will be called every time an item is
2006 * selected, i.e., everytime the list stops with this item in
2007 * center position, just pass the function as fifth paramenter.
2009 * <b> Appending an item with callback function for selected with data: </b>
2010 * @dontinclude list_example_03.c
2011 * @skipline _sel_data_cb
2017 * If the callback function request an extra data, it can be attached to our
2018 * item passing a pointer for data as sixth parameter.
2019 * Our function _sel_data_cb will receive it as <tt> void *data </tt>.
2021 * If you want to free this data, or handle that the way you need when the
2022 * item is deleted, set a callback function for that, with
2023 * elm_list_item_del_cb_set().
2025 * As you can see we check if @c it is not @c NULL after appending it.
2026 * If an error happens, we won't try to set a function for it.
2028 * <b> Deleting an item: </b>
2029 * @dontinclude list_example_03.c
2030 * @skipline _del_cb(
2033 * To delete an item we simple need to call elm_list_item_del() with
2034 * a pointer for such item.
2036 * If you need, you can get selected item with
2037 * elm_list_selected_item_get(), that will return a pointer for it.
2039 * <b> Unselecting an item: </b>
2040 * @dontinclude list_example_03.c
2041 * @skipline _unselect_cb
2044 * To select an item, you should call elm_list_item_selected_set()
2045 * passing @c EINA_TRUE, and to unselect it, @c EINA_FALSE.
2047 * <b> Printing all items: </b>
2048 * @dontinclude list_example_03.c
2049 * @skipline _print_cb
2052 * <b> Clearing the list: </b>
2053 * @dontinclude list_example_03.c
2054 * @skipline _clear_cb
2057 * <b> Selecting the next item: </b>
2058 * @dontinclude list_example_03.c
2059 * @skipline _select_next_cb
2062 * <b> Inserting after an item: </b>
2063 * @dontinclude list_example_03.c
2064 * @skipline _insert_after_cb
2067 * <b> Selecting the previous item: </b>
2068 * @dontinclude list_example_03.c
2069 * @skipline _select_prev_cb
2072 * <b> Inserting before an item: </b>
2073 * @dontinclude list_example_03.c
2074 * @skipline _insert_before_cb
2077 * If a separator is required, just set an item as such:
2078 * @dontinclude list_example_03.c
2079 * @skipline _set_separator_cb
2082 * Also an item can be disabled, and the user won't be allowed to (un)select it:
2083 * @dontinclude list_example_03.c
2084 * @skipline _disable_cb
2087 * See the full @ref list_example_03.c "list_example_03.c"
2088 * code, whose window should look like this picture:
2090 * @image html screenshots/list_example_03.png
2091 * @image latex screenshots/list_example_03.eps width=\textwidth
2093 * @example list_example_03.c
2097 * @page flipselector_example Flip selector widget example
2099 * This code places an Elementary flip selector widget on a window,
2100 * along with two buttons trigerring actions on it (though its API).
2102 * The selector is being populated with the following items:
2103 * @dontinclude flipselector_example.c
2107 * Next, we create it, populating it with those items and registering
2108 * two (smart) callbacks on it:
2109 * @dontinclude flipselector_example.c
2110 * @skip fp = elm_flipselector_add
2111 * @until object_show
2113 * Those two callbacks will take place whenever one of those smart
2114 * events occur, and they will just print something to @c stdout:
2115 * @dontinclude flipselector_example.c
2116 * @skip underflow callback
2117 * @until static void
2118 * Flip the sheets on the widget while looking at the items list, in
2119 * the source code, and you'll get the idea of those events.
2121 * The two buttons below the flip selector will take the actions
2122 * described in their labels:
2123 * @dontinclude flipselector_example.c
2124 * @skip bt = elm_button_add
2125 * @until callback_add(win
2127 * @dontinclude flipselector_example.c
2128 * @skip unselect the item
2131 * Click on them to exercise those flip selector API calls. To
2132 * interact with the other parts of this API, there's a command line
2133 * interface, whose help string can be asked for with the 'h' key:
2134 * @dontinclude flipselector_example.c
2138 * The 'n' and 'p' keys will exemplify elm_flipselector_flip_next()
2139 * and elm_flipselector_flip_prev(), respectively. 'f' and 'l' account
2140 * for elm_flipselector_first_item_get() and
2141 * elm_flipselector_last_item_get(), respectively. Finally, 's' will
2142 * issue elm_flipselector_selected_item_get() on our example flip
2145 * See the full @ref flipselector_example.c "example", whose window should
2146 * look like this picture:
2148 * @image html screenshots/flipselector_example.png
2149 * @image latex screenshots/flipselector_example.eps width=\textwidth
2151 * See the full @ref flipselector_example_c "source code" for this example.
2153 * @example flipselector_example.c
2157 * @page fileselector_example File selector widget example
2159 * This code places two Elementary file selector widgets on a window.
2160 * The one on the left is layouting file system items in a @b list,
2161 * while the the other is layouting them in a @b grid.
2163 * The one having the majority of hooks of interest is on the left,
2164 * which we create as follows:
2165 * @dontinclude fileselector_example.c
2166 * @skip first file selector
2167 * @until object_show
2169 * Note that we enable custom edition of file/directory selection, via
2170 * the text entry it has on its bottom, via
2171 * elm_fileselector_is_save_set(). It starts with the list view, which
2172 * is the default, and we make it not expandable in place
2173 * (elm_fileselector_expandable_set()), so that it replaces its view's
2174 * contents with the current directory's entries each time one
2175 * navigates to a different folder. For both of file selectors we are
2176 * starting to list the contents found in the @c "/tmp" directory
2177 * (elm_fileselector_path_set()).
2179 * Note the code setting it to "grid mode" and observe the differences
2180 * in the file selector's views, in the example. We also hide the
2181 * second file selector's Ok/Cancel buttons -- since it's there just
2182 * to show the grid view (and navigation) -- via
2183 * elm_fileselector_buttons_ok_cancel_set().
2185 * The @c "done" event, which triggers the callback below
2186 * @dontinclude fileselector_example.c
2189 * will be called at the time one clicks the "Ok"/"Cancel" buttons of
2190 * the file selector (on the left). Note that it will print the path
2191 * to the current selection, if any.
2193 * The @c "selected" event, which triggers the callback below
2194 * @dontinclude fileselector_example.c
2195 * @skip bt = 'selected' cb
2197 * takes place when one selects a file (if the file selector is @b not
2198 * under folders-only mode) or when one selects a folder (when in
2199 * folders-only mode). Experiment it by selecting different file
2202 * What comes next is the code creating the three check boxes and two
2203 * buttons below the file selector in the right. They will exercise a
2204 * bunch of functions on the file selector's API, for the instance on
2205 * the left. Experiment with them, specially the buttons, to get the
2206 * difference between elm_fileselector_path_get() and
2207 * elm_fileselector_selected_get().
2209 * Finally, there's the code adding the second file selector, on the
2211 * @dontinclude fileselector_example.c
2212 * @skip second file selector
2213 * @until object_show
2215 * Pay attention to the code setting it to "grid mode" and observe the
2216 * differences in the file selector's views, in the example. We also
2217 * hide the second file selector's Ok/Cancel buttons -- since it's
2218 * there just to show the grid view (and navigation) -- via
2219 * elm_fileselector_buttons_ok_cancel_set().
2221 * See the full @ref fileselector_example.c "example", whose window
2222 * should look like this picture:
2224 * @image html screenshots/fileselector_example.png
2225 * @image latex screenshots/fileselector_example.eps width=\textwidth
2227 * See the full @ref fileselector_example_c "source code" for this example.
2229 * @example fileselector_example.c
2233 * @page fileselector_button_example File selector button widget example
2235 * This code places an Elementary file selector button widget on a
2236 * window, along with some other checkboxes and a text entry. Those
2237 * are there just as knobs on the file selector button's state and to
2238 * display information from it.
2240 * Here's how we instantiate it:
2241 * @dontinclude fileselector_button_example.c
2242 * @skip ic = elm_icon_add
2243 * @until evas_object_show
2245 * Note that we set on it both icon and label decorations. It's set to
2246 * list the contents of the @c "/tmp" directory, too, with
2247 * elm_fileselector_button_path_set(). What follows are checkboxes to
2248 * exercise some of its API funtions:
2249 * @dontinclude fileselector_button_example.c
2250 * @skip ck = elm_check_add
2251 * @until evas_object_show(en)
2253 * The checkboxes will toggle whether the file selector button's
2254 * internal file selector:
2255 * - must have an editable text entry for file names (thus, be in
2256 * "save dialog mode")
2257 * - is to be raised as an "inner window" (note it's the default
2258 * behavior) or as a dedicated window
2259 * - is to populate its view with folders only
2260 * - is to expand its folders, in its view, <b>in place</b>, and not
2261 * repainting it entirely just with the contents of a sole
2264 * The entry labeled @c "Last selection" will exercise the @c
2265 * "file,chosen" smart event coming from the file selector button:
2266 * @dontinclude fileselector_button_example.c
2268 * @until toggle inwin
2270 * Whenever you dismiss or acknowledges the file selector, after it's
2271 * raised, the @c event_info string will contain the last selection on
2272 * it (if any was made).
2274 * This is how the example, just after called, should look like:
2276 * @image html screenshots/fileselector_button_example_00.png
2277 * @image latex screenshots/fileselector_button_example_00.eps width=\textwidth
2279 * Click on the file selector button to raise its internal file
2280 * selector, which will be contained on an <b>"inner window"</b>:
2282 * @image html screenshots/fileselector_button_example_01.png
2283 * @image latex screenshots/fileselector_button_example_01.eps width=\textwidth
2285 * Toggle the "inwin mode" switch off and, if you click on the file
2286 * selector button again, you'll get @b two windows, the original one
2287 * (note the last selection there!)
2289 * @image html screenshots/fileselector_button_example_02.png
2290 * @image latex screenshots/fileselector_button_example_02.eps width=\textwidth
2292 * and the file selector's new one
2294 * @image html screenshots/fileselector_button_example_03.png
2295 * @image latex screenshots/fileselector_button_example_03.eps width=\textwidth
2297 * Play with the checkboxes to get the behavior changes on the file
2298 * selector button. The respective API calls on the widget coming from
2299 * those knobs where shown in the code already.
2301 * See the full @ref fileselector_button_example_c "source code" for
2304 * @example fileselector_button_example.c
2308 * @page fileselector_entry_example File selector entry widget example
2310 * This code places an Elementary file selector entry widget on a
2311 * window, along with some other checkboxes. Those are there just as
2312 * knobs on the file selector entry's state.
2314 * Here's how we instantiate it:
2315 * @dontinclude fileselector_entry_example.c
2316 * @skip ic = elm_icon_add
2317 * @until evas_object_show
2319 * Note that we set on it's button both icon and label
2320 * decorations. It's set to exhibit the path of (and list the contents
2321 * of, when internal file selector is launched) the @c "/tmp"
2322 * directory, also, with elm_fileselector_entry_path_set(). What
2323 * follows are checkboxes to exercise some of its API funtions:
2324 * @dontinclude fileselector_entry_example.c
2325 * @skip ck = elm_check_add
2326 * @until callback_add(fs_entry
2328 * The checkboxes will toggle whether the file selector entry's
2329 * internal file selector:
2330 * - must have an editable text entry for file names (thus, be in
2331 * "save dialog mode")
2332 * - is to be raised as an "inner window" (note it's the default
2333 * behavior) or as a dedicated window
2334 * - is to populate its view with folders only
2335 * - is to expand its folders, in its view, <b>in place</b>, and not
2336 * repainting it entirely just with the contents of a sole
2339 * Observe how the entry's text will match the string coming from the
2340 * @c "file,chosen" smart event:
2341 * @dontinclude fileselector_entry_example.c
2344 * Whenever you dismiss or acknowledges the file selector, after it's
2345 * raised, the @c event_info string will contain the last selection on
2346 * it (if any was made).
2348 * Try, also, to type in a valid system path and, then, open the file
2349 * selector's window: it will start the file browsing there, for you.
2351 * This is how the example, just after called, should look like:
2353 * @image html screenshots/fileselector_entry_example_00.png
2354 * @image latex screenshots/fileselector_entry_example_00.eps width=\textwidth
2356 * Click on the file selector entry to raise its internal file
2357 * selector, which will be contained on an <b>"inner window"</b>:
2359 * @image html screenshots/fileselector_entry_example_01.png
2360 * @image latex screenshots/fileselector_entry_example_01.eps width=\textwidth
2362 * Toggle the "inwin mode" switch off and, if you click on the file
2363 * selector entry again, you'll get @b two windows, the original one
2364 * (note the last selection there!)
2366 * @image html screenshots/fileselector_entry_example_02.png
2367 * @image latex screenshots/fileselector_entry_example_02.eps width=\textwidth
2369 * and the file selector's new one
2371 * @image html screenshots/fileselector_entry_example_03.png
2372 * @image latex screenshots/fileselector_entry_example_03.eps width=\textwidth
2374 * Play with the checkboxes to get the behavior changes on the file
2375 * selector entry. The respective API calls on the widget coming from
2376 * those knobs where shown in the code already.
2378 * See the full @ref fileselector_entry_example_c "source code" for
2381 * @example fileselector_entry_example.c
2385 * @page layout_example_01 Layout - Content, Table and Box
2387 * This example shows how one can use the @ref Layout widget to create a
2388 * customized distribution of widgets on the screen, controled by an Edje theme.
2389 * The full source code for this example can be found at @ref
2390 * layout_example_01_c.
2392 * Our custom layout is defined by a file, @ref layout_example_edc, which is an
2393 * Edje theme file. Look for the Edje documentation to understand it. For now,
2394 * it's enough to know that we describe some specific parts on this layout
2396 * @li a title text field;
2397 * @li a box container;
2398 * @li a table container;
2399 * @li and a content container.
2401 * Going straight to the code, the following snippet instantiates the layout
2404 * @dontinclude layout_example_01.c
2405 * @skip elm_layout_add
2406 * @until evas_object_show(layout)
2408 * As any other widget, we set some properties for the size calculation. But
2409 * notice on this piece of code the call to the function elm_layout_file_set().
2410 * Here is where the theme file is loaded, and particularly the specific group
2411 * from this theme file. Also notice that the theme file here is referenced as
2412 * an .edj, which is a .edc theme file compiled to its binary form. Again, look
2413 * for the Edje documentation for more information about theme files.
2415 * Next, we fetch from our theme a data string referenced by the key "title".
2416 * This data was defined in the theme, and can be used as parameters which the
2417 * program get from the specific theme that it is using. In this case, we store
2418 * the title of this window and program in the theme, as a "data" entry, just
2419 * for demonstration purposes:
2423 * This call elm_layout_data_get() is used to fetch the string based on the key,
2424 * and elm_object_text_part_set() will set the part defined in the theme as
2425 * "example/title" to contain this string. This key "example/title" has nothing
2426 * special. It's just an arbitrary convention that we are using in this example.
2427 * Every string in this example referencing a part of this theme will be of the
2428 * form "example/<something>".
2430 * Now let's start using our layout to distribute things on the window space.
2431 * Since the layout was added as a resize object to the elementary window, it
2432 * will always occupy the entire space available for this window.
2434 * The theme already has a title, and it also defines a table element which is
2435 * positioned approximately between 50% and 70% of the height of this window,
2436 * and has 100% of the width. We create some widgets (two icons, a clock and a
2437 * button) and pack them inside the table, in a distribution similar to a HTML
2440 * @until evas_object_show(bt)
2442 * Notice that we just set size hints for every object, and call the function
2443 * elm_layout_table_pack(), which does all the work. It will place the elements
2444 * in the specified row/column, with row and column span if required, and then
2445 * the object's size and position will be controled by the layout widget. It
2446 * will also respect size hints, alignments and weight properties set to these
2447 * widgets. The resulting distribution on the screen depends on the table
2448 * properties (described in the theme), the size hints set on each widget, and
2449 * on the cells of the table that are being used.
2451 * For instance, we add the two icons and the clock on the first, second and
2452 * third cells of the first row, and add the button the second row, making it
2453 * span for 3 columns (thus having the size of the entire table width). This
2454 * will result in a table that has 2 rows and 3 columns.
2456 * Now let's add some widgets to the box area of our layout. This box is around
2457 * 20% and 50% of the vertical size of the layout, and 100% of its width. The
2458 * theme defines that it will use an "horizontal flow" distribution to its
2459 * elements. Unlike the table, a box will distribute elements without knowing
2460 * about rows and columns, and the distribution function selected will take care
2461 * of putting them in row, column, both, or any other available layout. This is
2462 * also described in the Edje documentation.
2464 * This box area is similar to the @ref Box widget of elementary, with the
2465 * difference that its position and properties are controled by the theme of the
2466 * layout. It also contains more than one API to add items to it, since the
2467 * items position now is defined in terms of a list of items, not a matrix.
2468 * There's the first position (can have items added to it with
2469 * elm_layout_box_prepend()), the last position (elm_layout_box_append()), the
2470 * nth position (elm_layout_box_insert_at()) and the position right before an
2471 * element (elm_layout_box_insert_before()). We use insert_at and prepend
2472 * functions to add the first two buttons to this box, and insert_before on the
2473 * callback of each button. The callback code will be shown later, but it
2474 * basically adds a button just before the clicked button using the
2475 * elm_layout_box_insert_before() function. Here's the code for adding the first
2478 * @until evas_object_show(item)
2479 * @until evas_object_show(item)
2481 * Finally, we have an area in this layout theme, in the bottom part of it,
2482 * reserved for adding an specific widget. Differently from the 2 parts
2483 * described until now, this one can only receive one widget with the call
2484 * elm_layout_content_set(). If there was already an item on this specific part,
2485 * it will be deleted (one can use elm_layout_content_unset() in order to remove
2486 * it without deleting). An example of removing it without deleting, but
2487 * manually deleting this widget just after that, can be seen on the callback
2488 * for this button. Actually, the callback defined for this button will clean
2489 * the two other parts (deleting all of their elements) and then remove and
2490 * delete this button.
2492 * @until _swallow_btn_cb
2494 * Also notice that, for this last added button, we don't have to call
2495 * evas_object_show() on it. This is a particularity of the theme for layouts,
2496 * that will have total control over the properties like size, position,
2497 * visibility and clipping of a widget added with elm_layout_content_set().
2498 * Again, read the Edje documentation to understand this better.
2500 * Now we just put the code for the different callbacks specified for each kind
2501 * of button and make simple comments about them:
2503 * @dontinclude layout_example_01.c
2505 * @until evas_object_del(item)
2508 * The first callback is used for the button in the table, and will just remove
2509 * itself from the table with elm_layout_table_unpack(), which remove items
2510 * without deleting them, and then calling evas_object_del() on itself.
2512 * The second callback is for buttons added to the box. When clicked, these
2513 * buttons will create a new button, and add them to the same box, in the
2514 * position just before the clicked button.
2516 * And the last callback is for the button added to the "content" area. It will
2517 * clear both the table and the box, passing @c EINA_TRUE to their respective @c
2518 * clear parameters, which will imply on the items of these containers being
2521 * A screenshot of this example can be seen on:
2523 * @image html screenshots/layout_example_01.png
2524 * @image latex screenshots/layout_example_01.eps width=\textwidth
2529 * @page layout_example_02 Layout - Predefined Layout
2531 * This example shows how one can use the @ref Layout with a predefined theme
2532 * layout to add a back and next button to a simple window. The full source code
2533 * for this example can be found at @ref layout_example_02_c.
2535 * After setting up the window and background, we add the layout widget to the
2536 * window. But instead of using elm_layout_file_set() to load its theme from a
2537 * custom theme file, we can use elm_layout_theme_set() to load one of the
2538 * predefined layouts that come with elementary. Particularly on this example,
2539 * we load the them of class "layout", group "application" and style
2540 * "content-back-next" (since we want the back and next buttons).
2542 * @dontinclude layout_example_02.c
2543 * @skip elm_layout_add
2544 * @until evas_object_show(layout)
2546 * This default theme contains only a "content" area named
2547 * "elm.swallow.content", where we can add any widget (it can be even a
2548 * container widget, like a box, frame, list, or even another layout). Since we
2549 * just want to show the resulting layout, we add a simple icon to it:
2551 * @until layout_content_set
2553 * This default layout also provides some signals when the next and prev buttons
2554 * are clicked. We can register callbacks to them with the
2555 * elm_object_signal_callback_add() function:
2557 * @until elm,action,next
2559 * In the @ref layout_example_03 you can see how to send signals to the layout with
2560 * elm_object_signal_emit().
2562 * Now our callback just changes the picture being displayed when one of the
2563 * buttons are clicked:
2565 * @dontinclude layout_example_02.c
2567 * @until standard_set
2570 * It's possible to see that it gets the name of the image being shown from the
2571 * array of image names, going forward on this array when "next" is clicked and
2572 * backward when "back" is clicked.
2574 * A screenshot of this example can be seen on:
2576 * @image html screenshots/layout_example_02.png
2577 * @image latex screenshots/layout_example_02.eps width=\textwidth
2581 * @page layout_example_03 Layout - Signals and Size Changed
2583 * This example shows how one can send and receive signals to/from the layout,
2584 * and what to do when the layout theme has its size changed. The full source
2585 * code for this example can be found at @ref layout_example_03_c.
2587 * In this exmaple we will use another group from the same layout theme file
2588 * used in @ref layout_example_01. Its instanciation and loading happens in the
2591 * @dontinclude layout_example_03.c
2592 * @skip elm_layout_add
2593 * @until evas_object_show
2595 * This time we register a callback to be called whenever we receive a signal
2596 * after the end of the animation that happens in this layout:
2598 * @until signal_callback_add
2600 * We also add a button that will send signals to the layout:
2602 * @until callback_add
2604 * The callback for this button will check what type of signal it should send,
2605 * and then emit it. The code for this callback follows:
2607 * @dontinclude layout_exmaple_03.c
2608 * @skip static Eina_Bool
2613 * As we said before, we are receiving a signal whenever the animation started
2614 * by the button click ends. This is the callback for that signal:
2618 * Notice from this callback that the elm_layout_sizing_eval() function must be
2619 * called if we want our widget to update its size after the layout theme having
2620 * changed its minimum size. This happens because the animation specified in the
2621 * theme increases the size of the content area to a value higher than the
2622 * widget size, thus requiring more space. But the elementary layout widget
2623 * has no way to know this, thus needing the elm_layout_sizing_eval() to
2624 * be called on the layout, informing that this size has changed.
2626 * A screenshot of this example can be seen on:
2628 * @image html screenshots/layout_example_03.png
2629 * @image latex screenshots/layout_example_03.eps width=\textwidth
2633 * @page tutorial_hover Hover example
2634 * @dontinclude hover_example_01.c
2636 * On this example we are going to have a button that when clicked will show our
2637 * hover widget, this hover will have content set on it's left, top, right and
2638 * middle positions. In the middle position we are placing a button that when
2639 * clicked will hide the hover. We are also going to use a non-default theme
2640 * for our hover. We won't explain the functioning of button for that see @ref
2643 * We start our example with a couple of callbacks that show and hide the data
2644 * they're given(which we'll see later on is the hover widget):
2649 * In our main function we'll do some initialization and then create 3
2650 * rectangles, one red, one green and one blue to use in our hover. We'll also
2651 * create the 2 buttons that will show and hide the hover:
2654 * With all of that squared away we can now get to the heart of the matter,
2655 * creating our hover widget, which is easy as pie:
2658 * Having created our hover we now need to set the parent and target. Which if
2659 * you recall from the function documentations are going to tell the hover which
2660 * area it should cover and where it should be centered:
2663 * Now we set the theme for our hover. We're using the popout theme which gives
2664 * our contents a white background and causes their appearance to be animated:
2667 * And finally we set the content for our positions:
2670 * So far so good? Great 'cause that's all there is too it, what is left now is
2671 * just connecting our buttons to the callbacks we defined at the beginning of
2672 * the example and run the main loop:
2675 * Our example will initially look like this:
2677 * @image html screenshots/hover_example_01.png
2678 * @image latex screenshots/hover_example_01.eps width=\textwidth
2680 * And after you click the "Show hover" button it will look like this:
2682 * @image html screenshots/hover_example_01_a.png
2683 * @image latex screenshots/hover_example_01_a.eps width=\textwidth
2685 * @example hover_example_01.c
2689 * @page tutorial_flip Flip example
2690 * @dontinclude flip_example_01.c
2692 * This example will show a flip with two rectangles on it(one blue, one
2693 * green). Our example will allow the user to choose the animation the flip
2694 * uses and to interact with it. To allow the user to choose the interaction
2695 * mode we use radio buttons, we will however not explain them, if you would
2696 * like to know more about radio buttons see @ref radio.
2698 * We start our example with the usual setup and then create the 2 rectangles
2699 * we will use in our flip:
2700 * @until show(rect2)
2702 * The next thing to do is to create our flip and set it's front and back
2706 * The next thing we do is set the interaction mode(which the user can later
2707 * change) to the page animation:
2710 * Setting a interaction mode however is not sufficient, we also need to
2711 * choose which directions we allow interaction from, for this example we
2712 * will use all of them:
2715 * We are also going to set the hitsize to the entire flip(in all directions)
2716 * to make our flip very easy to interact with:
2719 * After that we create our radio buttons and start the main loop:
2722 * When the user clicks a radio button a function that changes the
2723 * interaction mode and animates the flip is called:
2725 * @note The elm_flip_go() call here serves no purpose other than to
2726 * ilustrate that it's possible to animate the flip programmatically.
2728 * Our example will look like this:
2730 * @image html screenshots/flip_example_01.png
2731 * @image latex screenshots/flip_example_01.eps width=\textwidth
2733 * @note Since this is an animated example the screenshot doesn't do it
2734 * justice, it is a good idea to compile it and see the animations.
2736 * @example flip_example_01.c
2740 * @page tutorial_label Label example
2741 * @dontinclude label_example_01.c
2743 * In this example we are going to create 6 labels, set some properties on
2744 * them and see what changes in appearance those properties cause.
2746 * We start with the setup code that by now you should be familiar with:
2749 * For our first label we have a moderately long text(that doesn't fit in the
2750 * label's width) so we will make it a sliding label. Since the text isn't
2751 * too long we don't need the animation to be very long, 3 seconds should
2752 * give us a nice speed:
2755 * For our second label we have the same text, but this time we aren't going
2756 * to have it slide, we're going to ellipsize it. Because we ask our label
2757 * widget to ellipsize the text it will first diminsh the fontsize so that it
2758 * can show as much of the text as possible:
2761 * For the third label we are going to ellipsize the text again, however this
2762 * time to make sure the fontsize isn't diminshed we will set a line wrap.
2763 * The wrap won't actually cause a line break because we set the label to
2767 * For our fourth label we will set line wrapping but won't set ellipsis, so
2768 * that our text will indeed be wrapped instead of ellipsized. For this label
2769 * we choose character wrap:
2772 * Just two more, for our fifth label we do the same as for the fourth
2773 * except we set the wrap to word:
2776 * And last but not least for our sixth label we set the style to "marker" and
2777 * the color to red(the default color is white which would be hard to see on
2778 * our white background):
2781 * Our example will look like this:
2783 * @image html screenshots/label_example_01.png
2784 * @image latex screenshots/label_example_01.eps width=\textwidth
2786 * @example label_example_01.c
2790 * @page tutorial_image Image example
2791 * @dontinclude image_example_01.c
2793 * This example is as simple as possible. An image object will be added to the
2794 * window over a white background, and set to be resizeable together with the
2795 * window. All the options set through the example will affect the behavior of
2798 * We start with the code for creating a window and its background, and also
2799 * add the code to write the path to the image that will be loaded:
2804 * Now we create the image object, and set that file to be loaded:
2808 * We can now go setting our options.
2810 * elm_image_no_scale_set() is used just to set this value to true (we
2811 * don't want to scale our image anyway, just resize it).
2813 * elm_image_scale_set() is used to allow the image to be resized to a size
2814 * smaller than the original one, but not to a size bigger than it.
2816 * elm_elm_image_smooth_set() will disable the smooth scaling, so the scale
2817 * algorithm used to scale the image to the new object size is going to be
2818 * faster, but with a lower quality.
2820 * elm_image_orient_set() is used to flip the image around the (1, 0) (0, 1)
2823 * elm_image_aspect_ratio_retained_set() is used to keep the original aspect
2824 * ratio of the image, even when the window is resized to another aspect ratio.
2826 * elm_image_fill_outside_set() is used to ensure that the image will fill the
2827 * entire area available to it, even if keeping the aspect ratio. The image
2828 * will overflow its width or height (any of them that is necessary) to the
2829 * object area, instead of resizing the image down until it can fit entirely in
2832 * elm_image_editable_set() is used just to cover the API, but won't affect
2833 * this example since we are not using any copy & paste property.
2835 * This is the code for setting these options:
2839 * Now some last touches in our object size hints, window and background, to
2840 * display this image properly:
2844 * This example will look like this:
2846 * @image html screenshots/image_example_01.png
2847 * @image latex screenshots/image_example_01.eps width=\textwidth
2849 * @example image_example_01.c
2853 * @page tutorial_icon Icon example
2854 * @dontinclude icon_example_01.c
2856 * This example is as simple as possible. An icon object will be added to the
2857 * window over a white background, and set to be resizeable together with the
2858 * window. All the options set through the example will affect the behavior of
2861 * We start with the code for creating a window and its background:
2866 * Now we create the icon object, and set lookup order of the icon, and choose
2871 * An intersting thing is that after setting this, it's possible to check where
2872 * in the filesystem is the theme used by this icon, and the name of the group
2877 * We can now go setting our options.
2879 * elm_icon_no_scale_set() is used just to set this value to true (we
2880 * don't want to scale our icon anyway, just resize it).
2882 * elm_icon_scale_set() is used to allow the icon to be resized to a size
2883 * smaller than the original one, but not to a size bigger than it.
2885 * elm_elm_icon_smooth_set() will disable the smooth scaling, so the scale
2886 * algorithm used to scale the icon to the new object size is going to be
2887 * faster, but with a lower quality.
2889 * elm_icon_fill_outside_set() is used to ensure that the icon will fill the
2890 * entire area available to it, even if keeping the aspect ratio. The icon
2891 * will overflow its width or height (any of them that is necessary) to the
2892 * object area, instead of resizing the icon down until it can fit entirely in
2895 * This is the code for setting these options:
2897 * @until fill_outside
2899 * However, if you try this example you may notice that this image is not being
2900 * affected by all of these options. This happens because the used icon will be
2901 * from elementary theme, and thus it has its own set of options like smooth
2902 * scaling and fill_outside options. You can change the "home" icon to use some
2903 * image (from your system) and see that then those options will be respected.
2905 * Now some last touches in our object size hints, window and background, to
2906 * display this icon properly:
2910 * This example will look like this:
2912 * @image html screenshots/icon_example_01.png
2913 * @image latex screenshots/icon_example_01.eps width=\textwidth
2915 * @example icon_example_01.c
2919 * @page tutorial_hoversel Hoversel example
2920 * @dontinclude hoversel_example_01.c
2922 * In this example we will create a hoversel with 3 items, one with a label but
2923 * no icon and two with both a label and an icon. Every item that is clicked
2924 * will be deleted, but everytime the hoversel is activated we will also add an
2925 * item. In addition our first item will print all items when clicked and our
2926 * third item will clear all items in the hoversel.
2928 * We will start with the normal creation of window stuff:
2931 * Next we will create a red rectangle to use as the icon of our hoversel:
2934 * And now we create our hoversel and set some of it's properties. We set @p win
2935 * as its parent, ask it to not be horizontal(be vertical) and give it a label
2939 * Next we will add our three items, setting a callback to be called for the
2943 * We also set a pair of callbacks to be called whenever any item is selected or
2944 * when the hoversel is activated:
2947 * And then ask that our hoversel be shown and run the main loop:
2950 * We now have the callback for our first item which prints all items in the
2954 * Next we have the callback for our third item which removes all items from the
2958 * Next we have the callback that is called whenever an item is clicked and
2959 * deletes that item:
2962 * And the callback that is called when the hoversel is activated and adds an
2963 * item to the hoversel. Note that since we allocate memory for the item we need
2964 * to know when the item dies so we can free that memory:
2967 * And finally the callback that frees the memory we allocated for items created
2968 * in the @p _add_item callback:
2971 * Our example will initially look like this:
2973 * @image html screenshots/hoversel_example_01.png
2974 * @image latex screenshots/hoversel_example_01.eps width=\textwidth
2976 * And when the hoversel is clicked it will look like this:
2978 * @image html screenshots/hoversel_example_01_a.png
2979 * @image latex screenshots/hoversel_example_01_a.eps width=\textwidth
2981 * @example hoversel_example_01.c
2985 * @page conformant_example Conformant Example.
2987 * In this example we'll explain how to create applications to work
2988 * with illume, considering space required for virtual keyboards, indicator
2991 * Illume is a module for Enlightenment that modifies the user interface
2992 * to work cleanly and nicely on a mobile device. It has support for
2993 * virtual keyboard, among other nice features.
2995 * Let's start creating a very simple window with a vertical box
2996 * with multi-line entry between two buttons.
2997 * This entry will expand filling all space on window not used by buttons.
2999 * @dontinclude conformant_example_01.c
3000 * @skipline elm_main
3003 * For information about how to create windows, boxes, buttons or entries,
3004 * look for documentation for these widgets.
3006 * It will looks fine when you don't need a virtual keyboard, as you
3007 * can see on the following image:
3009 * @image html screenshots/conformant_example_01.png
3010 * @image latex screenshots/conformant_example_01.eps width=\textwidth
3012 * But if you call a virtual keyboard, the window will resize, changing
3013 * widgets size and position. All the content will shrink.
3015 * If you don't want such behaviour, you
3016 * will need a conformant to account for space taken up by the indicator,
3017 * virtual keyboard and softkey.
3019 * In this case, using the conformant in a proper way, you will have
3020 * a window like the following:
3022 * @image html screenshots/conformant_example_02.png
3023 * @image latex screenshots/conformant_example_02.eps width=\textwidth
3025 * As you can see, it guess the space that will be required by the keyboard,
3026 * indicator and softkey bars.
3028 * So, let's study each step required to transform our initial example on
3031 * First of all, we need to set the window as an illume conformant window:
3032 * @dontinclude conformant_example_02.c
3033 * @skipline elm_win_conformant_set
3035 * Next, we'll add a conformant widget, and set it to resize with the window,
3036 * instead of the box.
3038 * @until evas_object_show
3040 * Finally, we'll set the box as conformant's content, just like this:
3041 * @skipline elm_conformant_content_set
3043 * Compare both examples code:
3044 * @ref conformant_example_01.c "conformant_example_01.c"
3045 * @ref conformant_example_02.c "conformant_example_02.c"
3047 * @example conformant_example_01.c
3048 * @example conformant_example_02.c
3052 * @page index_example_01 Index widget example 1
3054 * This code places an Elementary index widget on a window, which also
3055 * has a very long list of arbitrary strings on it. The list is
3056 * sorted alphabetically and the index will be used to index the first
3057 * items of each set of strings beginning with an alphabet letter.
3059 * Below the list are some buttons, which are there just to exercise
3060 * some index widget's API.
3062 * Here's how we instantiate it:
3063 * @dontinclude index_example_01.c
3064 * @skip elm_list_add
3065 * @until evas_object_show(d.index)
3066 * where we're showing also the list being created. Note that we issue
3067 * elm_win_resize_object_add() on the index, so that it's set to have
3068 * the whole window as its container. Then, we have to populate both
3069 * list and index widgets:
3070 * @dontinclude index_example_01.c
3071 * @skip for (i = 0; i < (sizeof(dict) / sizeof(dict[0])); i++)
3075 * The strings populating the list come from a file
3076 * @dontinclude index_example_01.c
3077 * @skip static const char *dict
3080 * We use the @c curr char variable to hold the last initial letter
3081 * seen on that ordered list of strings, so that we're able to have an
3082 * index item pointing to each list item starting a new letter
3083 * "section". Note that our index item data pointers will be the list
3084 * item handles. We are also setting a callback function to index
3085 * items deletion events:
3086 * @dontinclude index_example_01.c
3090 * There, we show you that the @c event_info pointer will contain the
3091 * item in question's data, i.e., a given list item's pointer. Because
3092 * item data is also returned in the @c data argument on
3093 * @c Evas_Smart_Cb functions, those two pointers must have the same
3094 * values. On this deletion callback, we're deleting the referred list
3095 * item too, just to exemplify that anything could be done there.
3097 * Next, we hook to two smart events of the index object:
3098 * @dontinclude index_example_01.c
3099 * @skip smart_callback_add(d.index
3100 * @until _index_selected
3101 * @dontinclude index_example_01.c
3102 * @skip "delay,changed" hook
3106 * Check that, whenever one holds the mouse pressed over a given index
3107 * letter for some time, the list beneath it will roll down to the
3108 * item pointed to by that index item. When one releases the mouse
3109 * button, the second callback takes place. There, we check that the
3110 * reported item data, on @c event_info, is the same reported by
3111 * elm_index_item_selected_get(), which gives the last selection's
3112 * data on the index widget.
3114 * The first of the three buttons that follow will call
3115 * elm_index_active_set(), thus showing the index automatically for
3116 * you, if it's not already visible, what is checked with
3117 * elm_index_active_get(). The second button will exercise @b deletion
3118 * of index item objects, by the following code:
3119 * @dontinclude index_example_01.c
3120 * @skip delete an index item
3123 * It will get the last index item selected's data and find the
3124 * respective #Elm_Index_Item handle with elm_index_item_find(). We
3125 * need the latter to query the indexing letter string from, with
3126 * elm_index_item_letter_get(). Next, comes the delition, itself,
3127 * which will also trigger the @c _index_item_del callback function,
3130 * The third button, finally, will exercise elm_index_item_clear(),
3131 * which will delete @b all of the index's items.
3133 * This is how the example program's window looks like with the index
3135 * @image html screenshots/index_example_00.png
3136 * @image latex screenshots/index_example_00.eps
3138 * When it's shown, it's like the following figure:
3139 * @image html screenshots/index_example_01.png
3140 * @image latex screenshots/index_example_01.eps
3142 * See the full @ref index_example_01_c "source code" for
3145 * @example index_example_01.c
3149 * @page index_example_02 Index widget example 2
3151 * This code places an Elementary index widget on a window, indexing
3152 * grid items. The items are placed so that their labels @b don't
3153 * follow any order, but the index itself is ordered (through
3154 * elm_index_item_sorted_insert()). This is a complement to to @ref
3155 * index_example_01 "the first example on indexes".
3157 * Here's the list of item labels to be used on the grid (in that
3159 * @dontinclude index_example_02.c
3160 * @skip static const char *items
3163 * In the interesting part of the code, here, we first instantiate the
3164 * grid (more on grids on their examples) and, after creating our
3165 * index, for each grid item we also create an index one to reference
3167 * @dontinclude index_example_02.c
3168 * @skip grid = elm_gengrid_add
3170 * @until smart_callback_add
3172 * The order in which they'll appear in the index, though, is @b
3173 * alphabetical, becase of elm_index_item_sorted_insert() usage
3174 * together with the comparing function, where we take the letters of
3175 * each index item to base our ordering on. The parameters on
3176 * @c _index_cmp have to be declared as void pointers because of the
3177 * @c Eina_Compare_Cb prototype requisition, but in this case we know
3178 * they'll be #Elm_Index_Item's:
3179 * @dontinclude index_example_02.c
3180 * @skip ordering alphabetically
3183 * The last interesting bit is the callback in the @c "delay,changed"
3184 * smart event, which will bring the given grid item to the grid's
3186 * @dontinclude index_example_02.c
3190 * Note how the grid will move kind of randomly while you move your
3191 * mouse pointer held over the index from top to bottom -- that's
3192 * because of the the random order the items have in the grid itself.
3194 * This is how the example program's window looks like:
3195 * @image html screenshots/index_example_03.png
3196 * @image latex screenshots/index_example_03.eps
3198 * See the full @ref index_example_c "source code" for
3201 * @example index_example_02.c
3205 * @page tutorial_ctxpopup Ctxpopup example
3206 * @dontinclude ctxpopup_example_01.c
3208 * In this example we have a list with two items, when either item is clicked
3209 * a ctxpopup for it will be shown. Our two ctxpopups are quite different, the
3210 * one for the first item is a vertical and it's items contain both labels and
3211 * icons, the one for the second item is horizontal and it's items have icons
3214 * We will begin examining our example code by looking at the callback we'll use
3215 * when items in the ctxpopup are clicked. It's very simple, all it does is
3216 * print the label present in the ctxpopup item:
3219 * Next we examine a function that creates ctxpopup items, it was created to
3220 * avoid repeating the same code whenever we needed to add an item to our
3221 * ctxpopup. Our function creates an icon from the standard set of icons, and
3222 * then creates the item, with the label received as an argument. We also set
3223 * the callback to be called when the item is clicked:
3226 * Finally we have the function that will create the ctxpopup for the first item
3227 * in our list. This one is somewhat more complex though, so let's go through it
3228 * in parts. First we declare our variable and add the ctxpopup:
3229 * @until ctxpopup_add
3231 * Next we create a bunch of items for our ctxpopup, marking two of them as
3232 * disabled just so we can see what that will look like:
3233 * @until disabled_set
3234 * @until disabled_set
3236 * Then we ask evas where the mouse pointer was so that we can have our ctxpopup
3237 * appear in the right place, set a maximum size for the ctxpopup, move it and
3241 * And last we mark the list item as not selected:
3244 * Our next function is the callback that will create the ctxpopup for the
3245 * second list item, it is very similar to the previous function. A couple of
3246 * interesting things to note is that we ask our ctxpopup to be horizontal, and
3247 * that we pass NULL as the label for every item:
3250 * And with all of that in place we can now get to our main function where we
3251 * create the window, the list, the list items and run the main loop:
3254 * The example will initially look like this:
3256 * @image html screenshots/ctxpopup_example_01.png
3257 * @image latex screenshots/ctxpopup_example_01.eps width=\textwidth
3259 * @note This doesn't show the ctxpopup tough, since it will only appear when
3260 * we click one of the list items.
3262 * Here is what our first ctxpopup will look like:
3264 * @image html screenshots/ctxpopup_example_01_a.png
3265 * @image latex screenshots/ctxpopup_example_01_a.eps width=\textwidth
3267 * And here the second ctxpopup:
3269 * @image html screenshots/ctxpopup_example_01_b.png
3270 * @image latex screenshots/ctxpopup_example_01_b.eps width=\textwidth
3272 * @example ctxpopup_example_01.c
3276 * @page tutorial_pager
3277 * @dontinclude pager_example_01.c
3279 * In this example we'll have a pager with 3 rectangles on it, one blue, one
3280 * green and one blue, we'll also have 1 button for each rectangle. Pressing a
3281 * button will bring the associated rectangle to the front of the pager(promote
3284 * We start our example with some run of the mill code that you've seen in other
3288 * And then we get right to creating our pager, setting a style and some basic
3292 * Well a pager without any content is not of much use, so let's create the
3293 * first of our rectangles, add it to the pager and create the button for it:
3294 * @until smart_callback
3295 * @note The only line of above code that directly relates to our pager is the
3296 * call to elm_pager_content_push().
3298 * And now we will do the same thing again twice for our next two rectangles:
3299 * @until smart_callback
3300 * @until smart_callback
3302 * Now that we haver our widgets create we can get to running the main loop:
3305 * We also have the callback that is called when any of the buttons is pressed,
3306 * this callback is receiving the rectangle in it's @p data argument, so we
3307 * check if it's already on top and if not move it there:
3310 * Our example will look like this:
3312 * @image html screenshots/pager_example_01.png
3313 * @image latex screenshots/pager_example_01.eps width=\textwidth
3314 * @note Like all examples that involve animations the screenshot doesn't do it
3315 * justice, seeing it in action is a must.
3317 * @example pager_example_01.c
3321 * @page tutorial_separator Separator example
3322 * @dontinclude separator_example_01.c
3324 * In this example we are going to pack two rectangles in a box, and have a
3325 * separator in the middle.
3327 * So we start we the window, background, box and rectangle creation, all pretty
3331 * Once we have our first rectangle in the box we create and add our separator:
3333 * @note Since our box is in horizontal mode it's a good idea to set the
3334 * separator to be horizontal too.
3336 * And now we add our second rectangle and run the main loop:
3339 * This example will look like this:
3341 * @image html screenshots/separator_example_01.png
3342 * @image eps screenshots/separator_example_01.eps width=\textwidth
3344 * @example separator_example_01.c
3348 * @page tutorial_radio Radio example
3349 * @dontinclude radio_example_01.c
3351 * In this example we will create 4 radio buttons, three of them in a group and
3352 * another one not in the group. We will also have the radios in the group
3353 * change the value of a variable directly and have then print it when the value
3354 * changes. The fourth button is in the example just to make clear that radios
3355 * outside the group don't affect the group.
3357 * We'll start with the usual includes:
3360 * And move right to declaring a static variable(the one whose value the radios
3364 * We now need to have a window and all that good stuff to be able to place our
3368 * And now we create a radio button, since this is the first button in our group
3369 * we set the group to be the radio(so we can set the other radios in the same
3370 * group). We also set the state value of this radio to 1 and the value pointer
3371 * to @p val, since val is @p 1 this has the additional effect of setting the
3372 * radio value to @p 1. For this radio we choose the default home icon:
3375 * To check that our radio buttons are working we'll add a callback to the
3376 * "changed" signal of the radio:
3377 * @until smart_callback
3379 * The creation of our second radio button is almost identical, the 2
3380 * differences worth noting are, the value of this radio 2 and that we add this
3381 * radio to the group of the first radio:
3382 * @until smart_callback
3384 * For our third callback we'll omit the icon and set the value to 3, we'll also
3385 * add it to the group of the first radio:
3386 * @until smart_callback
3388 * Our fourth callback has a value of 4, no icon and most relevantly is not a
3389 * member of the same group as the other radios:
3392 * We finally run the main loop:
3395 * And the last detail in our example is the callback that prints @p val so that
3396 * we can see that the radios are indeed changing its value:
3399 * The example will look like this:
3401 * @image html screenshots/radio_example_01.png
3402 * @image latex screenshots/radio_example_01.epx width=\textwidth
3404 * @example radio_example_01.c
3408 * @page tutorial_toggle Toggle example
3409 * @dontinclude toggle_example_01.c
3411 * In this example we'll create 2 toggle widgets. The first will have an icon
3412 * and the state names will be the default "on"/"off", it will also change the
3413 * value of a variable directly. The second won't have a icon, the state names
3414 * will be "Enabled"/"Disabled", it will start "Enabled" and it won't set the
3415 * value of a variable.
3417 * We start with the usual includes and prototype for callback which will be
3418 * implemented and detailed later on:
3421 * We then declare a static global variable(the one whose value will be changed
3422 * by the first toggle):
3425 * We now have to create our window and all that usual stuff:
3428 * The creation of a toggle is no more complicated than that of any other
3432 * For our first toggle we don't set the states labels so they will stay the
3433 * default, however we do set a label for the toggle, an icon and the variable
3434 * whose value it should change:
3437 * We also set the callback that will be called when the toggles value changes:
3438 * @until smart_callback
3440 * For our second toggle it important to note that we set the states labels,
3441 * don't set an icon or variable, but set the initial state to
3442 * EINA_TRUE("Enabled"):
3445 * For the second toggle we will use a different callback:
3446 * @until smart_callback
3448 * We then ask the main loop to start:
3451 * The callback for our first toggle will look the value of @p val and print it:
3454 * For our second callback we need to do a little bit more, since the second
3455 * toggle doesn't change the value of a variable we have to ask it what its
3459 * This example will look like this:
3461 * @image html screenshots/toggle_example_01.png
3462 * @image latex screenshots/toggle_example_01.eps width=\textwidth
3464 * @example toggle_example_01.c
3468 * @page tutorial_panel Panel example
3469 * @dontinclude panel_example_01.c
3471 * In this example will have 3 panels, one for each possible orientation. Two of
3472 * our panels will start out hidden, the third will start out expanded. For each
3473 * of the panels we will use a label as the content, it's however possible to
3474 * have any widget(including containers) as the content of panels.
3476 * We start by doing some setup, code you should be familiar with from other
3480 * And move right to creating our first panel, for this panel we are going to
3481 * choose the orientation as TOP and toggle it(tell it to hide itself):
3484 * For the second panel we choose the RIGHT orientation and explicitly set the
3488 * For our third and last panel we won't set the orientation(which means it will
3489 * use the default: LEFT):
3492 * All that is left is running the main loop:
3495 * This example will look like this;
3497 * @image html screenshots/panel_example_01.png
3498 * @image latex screenshots/panel_example_01.epx width=\textwidth
3499 * @note The buttons with arrow allow the user to hide/show the panels.
3501 * @example panel_example_01.c
3505 * @page gengrid_example Gengrid widget example
3507 * This application is a thorough exercise on the gengrid widget's
3508 * API. We place an Elementary gengrid widget on a window, with
3509 * various knobs below its viewport, each one acting on it somehow.
3511 * The code's relevant part begins at the grid's creation. After
3512 * instantiating it, we set its items sizes, so that we don't end with
3513 * items one finger size wide, only. We're setting them to fat, 150
3514 * pixel wide ones, for this example. We give it some size hints, not
3515 * to be discussed in this context and, than, we register a callback
3516 * on one of its smart events -- the one coming each time an item gets
3517 * doubly clicked. There, we just print the item handle's value.
3518 * @dontinclude gengrid_example.c
3519 * @skip grid = elm_gengrid_add
3520 * @until evas_object_sho
3521 * @dontinclude gengrid_example.c
3522 * @skip item double click callback
3525 * Before we actually start to deal with the items API, let's show
3526 * some things items will be using throughout all the code. The first
3527 * of them is a struct to be used as item data, for all of them:
3528 * @dontinclude gengrid_example.c
3529 * @skip typedef struct
3532 * That path will be used to index an image, to be swallowed into one
3533 * of the item's icon spots. The imagens themselves are distributed
3535 * @dontinclude gengrid_example.c
3536 * @skip static const char *imgs
3539 * We also have an (unique) gengrid item class we'll be using for
3540 * items in the example:
3541 * @dontinclude gengrid_example.c
3542 * @skip static Elm_Gengrid_Item_Class
3543 * @until static Elm_Gengrid_Item_Class
3544 * @dontinclude gengrid_example.c
3545 * @skip item_style =
3548 * As you see, our items will follow the default theme on gengrid
3549 * items. For the label fetching code, we return a string composed of
3550 * the item's image path:
3551 * @dontinclude gengrid_example.c
3552 * @skip label fetching callback
3555 * For item icons, we'll be populating the item default theme's two
3556 * icon spots, @c "elm.swallow.icon" and @c "elm.swallow.end". The
3557 * former will receive one of the images in our list (in the form of
3558 * a @ref bg_02_example_page "background"), while the latter will be
3559 * a check widget. Note that we prevent the check to propagate click
3560 * events, so that the user can toggle its state without messing with
3561 * the respective item's selection in the grid:
3562 * @dontinclude gengrid_example.c
3563 * @skip icon fetching callback
3564 * @until return NULL
3567 * As the default gengrid item's theme does not have parts
3568 * implementing item states, we'll be just returning false for every
3570 * @dontinclude gengrid_example.c
3571 * @skip state fetching callback
3574 * Finally, the deletion callback on gengrid items takes care of
3575 * freeing the item's label string and its data struct:
3576 * @dontinclude gengrid_example.c
3577 * @skip deletion callback
3580 * Let's move to item insertion/deletion knobs, them. They are four
3581 * buttons, above the grid's viewport, namely
3582 * - "Append" (to append an item to the grid),
3583 * - "Prepend" (to prepend an item to the grid),
3584 * - "Insert before" (to insert an item before the selection, on the
3586 * - "Insert after" (to insert an item after the selection, on the
3588 * - "Clear" (to delete all items in the grid),
3589 * - "Bring in 1st" (to make the 1st item visible, by scrolling),
3590 * - "Show last" (to directly show the last item),
3592 * which are displaced and declared in that order. We're not dealing
3593 * with the buttons' creation code (see @ref button_example_01
3594 * "a button example", for more details on it), but with their @c
3595 * "clicked" registered callbacks. For all of them, the grid's handle
3596 * is passed as @c data. The ones creating new items use a common
3597 * code, which just gives a new @c Example_Item struct, with @c path
3598 * filled with a random image in our images list:
3599 * @dontinclude gengrid_example.c
3600 * @skip new item with random path
3603 * Moreover, that ones will set a common function to be issued on the
3604 * selection of the items. There, we print the item handle's value,
3605 * along with the callback function data. The latter will be @c NULL,
3606 * always, because it's what we pass when adding all icons. By using
3607 * elm_gengrid_item_data_get(), we can have the item data back and,
3608 * with that, we're priting the item's path string. Finally, we
3609 * exemplify elm_gengrid_item_pos_get(), printing the item's position
3611 * @dontinclude gengrid_example.c
3612 * @skip item selection callback
3615 * The appending button will exercise elm_gengrid_item_append(), simply:
3616 * @dontinclude gengrid_example.c
3617 * @skip append an item
3620 * The prepending, naturally, is analogous, but exercising
3621 * elm_gengrid_item_prepend(), on its turn. The "Insert before" one
3622 * will expect an item to be selected in the grid, so that it will
3623 * insert a new item just before it:
3624 * @dontinclude gengrid_example.c
3625 * @skip "insert before" callback
3628 * The "Insert after" is analogous, just using
3629 * elm_gengrid_item_insert_after(), instead. The "Clear" button will,
3630 * as expected, just issue elm_gengrid_clear():
3631 * @dontinclude gengrid_example.c
3632 * @skip delete items
3635 * The "Bring in 1st" button is there exercise two gengrid functions
3636 * -- elm_gengrid_first_item_get() and elm_gengrid_item_bring_in().
3637 * With the former, we get a handle to the first item and, with the
3638 * latter, you'll see that the widget animatedly scrolls its view
3639 * until we can see that item:
3640 * @dontinclude gengrid_example.c
3641 * @skip bring in 1st item
3644 * The "Show last", in its turn, will use elm_gengrid_last_item_get()
3645 * and elm_gengrid_item_show(). The latter differs from
3646 * elm_gengrid_item_bring_in() in that it immediately replaces the
3647 * contents of the grid's viewport with the region containing the item
3649 * @dontinclude gengrid_example.c
3650 * @skip show last item
3653 * To change the grid's cell (items) size, we've placed a spinner,
3654 * which has the following @c "changed" smart callback:
3655 * @dontinclude gengrid_example.c
3656 * @skip change items' size
3659 * Experiment with it and see how the items are affected. The "Disable
3660 * item" button will, as the name says, disable the currently selected
3662 * @dontinclude gengrid_example.c
3663 * @skip disable selected item
3665 * Note that we also make use of elm_gengrid_item_selected_set(),
3666 * there, thus making the item unselected before we actually disable
3669 * To toggle between horizontal and vertical layouting modes on the
3670 * grid, use the "Horizontal mode" check, which will call the
3671 * respective API function on the grid:
3672 * @dontinclude gengrid_example.c
3673 * @skip change layouting mode
3676 * If you toggle the check right after that one, "Always select",
3677 * you'll notice all subsequent clicks on the @b same grid item will
3678 * still issue the selection callback on it, what is different from
3679 * when it's not checked. This is the
3680 * elm_gengrid_always_select_mode_set() behavior:
3681 * @dontinclude gengrid_example.c
3682 * @skip "always select" callback
3685 * One more check follows, "Bouncing", which will turn on/off the
3686 * bouncing animations on the grid, when one scrolls past its
3687 * borders. Experiment with scrolling the grid to get the idea, having
3688 * it turned on and off:
3689 * @dontinclude gengrid_example.c
3690 * @skip "bouncing mode" callback
3693 * The next two checks will affect items selection on the grid. The
3694 * first, "Multi-selection", will make it possible to select more the
3695 * one item on the grid. Because it wouldn't make sense to fetch for
3696 * an unique selected item on this case, we also disable two of the
3697 * buttons, which insert items relatively, if multi-selection is on:
3698 * @dontinclude gengrid_example.c
3699 * @skip multi-selection callback
3702 * Note that we also @b unselect all items in the grid, when returning
3703 * from multi-selection mode, making use of
3704 * elm_gengrid_item_selected_set().
3706 * The second check acting on selection, "No selection", is just what
3707 * its name depicts -- no selection will be allowed anymore, on the
3708 * grid, while it's on. Check it out for yourself, interacting with
3710 * @dontinclude gengrid_example.c
3711 * @skip no selection callback
3714 * We have, finally, one more line of knobs, now sliders, to change
3715 * the grids behavior. The two first will change the horizontal @b
3716 * alignment of the whole actual grid of items within the gengrid's
3718 * @dontinclude gengrid_example.c
3719 * @skip items grid horizontal alignment change
3722 * Naturally, the vertical counterpart just issues
3723 * elm_gengrid_align_set() changing the second alignment component,
3726 * The last slider will change the grid's <b>page size</b>, relative
3727 * to its own one. Try to change those values and, one manner of
3728 * observing the paging behavior, is to scroll softly and release the
3729 * mouse button, with different page sizes, at different grid
3730 * positions, while having lots of items in it -- you'll see it
3731 * snapping to page boundaries differenty, for each configuration:
3732 * @dontinclude gengrid_example.c
3733 * @skip page relative size change
3736 * This is how the example program's window looks like:
3737 * @image html screenshots/gengrid_example.png
3738 * @image latex screenshots/gengrid_example.eps width=\textwidth
3740 * Note that it starts with three items which we included at will:
3741 * @dontinclude gengrid_example.c
3742 * @skip _clicked(grid,
3743 * @until _clicked(grid,
3744 * @until _clicked(grid,
3745 * @until _clicked(grid,
3747 * See the full @ref gengrid_example_c "source code" for
3750 * @example gengrid_example.c
3753 * @page entry_example_01 Entry - Example of simple editing
3755 * As a general overview of @ref Entry we are going to write an, albeit simple,
3756 * functional editor. Although intended to show how elm_entry works, this
3757 * example also makes extensive use of several other widgets. The full code
3758 * can be found in @ref entry_example.c "entry_example.c" and in the following
3759 * lines we'll go through the parts especific to the @ref Entry widget.
3761 * The program itself is a simple editor, with a file already set to it, that
3762 * can be set to autosave or not and allows insertion of emoticons and some
3763 * formatted text. As of this writing, the capabilities of format edition in
3764 * the entry are very limited, so a lot of manual work is required to change
3767 * In any case, the program allows some changes by using the buttons on the
3768 * top of the window and returning focus back to the main entry afterwards.
3770 * @image html screenshots/entry_example.png
3771 * @image latex screenshots/entry_example.eps width=\textwidth
3773 * We'll begin by showing a few structures used throught the program. First,
3774 * the application owns data that holds the main window and the main entry
3775 * where the editting happens. Then, an auxiliar structure we'll use later
3776 * when inserting icons in our text.
3777 * @dontinclude entry_example.c
3779 * @until App_Inwin_Data
3781 * A little convenience function will insert whatever text we need in the
3782 * buffer at the current cursor's position and set focus back to this entry.
3783 * This is done mostly because clicking on any button will make them steal
3784 * focus, which makes writing text more cumbersome.
3788 * One of the buttons on the top will trigger an @ref Inwin to open and show
3789 * us several icons we can insert into the text. We'll jump over most of these
3790 * functions, but when all the options are chosen, we insert the special
3791 * markup text that will show the chosen icon in place.
3792 * @skip edje_file_collection_list_free(emos)
3794 * @until evas_object_del
3797 * As can be seen in that function, the program lets us add icons to our entry
3798 * using all the possible configurations for them. That should help to
3799 * clarify how the different combinations work out by actually seeing them
3802 * The same popup window has a page to set the settings of the chosen icon,
3803 * that is, the size and how the item will be placed within the line.
3805 * The size is done with two entries, limitted to accept numbers and a fixed
3806 * size of characters. Changing the value in this entries will update the icon
3807 * size in our struct as seen in the next two callbacks.
3812 * The rest of the options are handled with radio buttons, since only one type
3813 * of size can be used (@c size, @c absize or @c relsize) and for the vertical
3814 * sizing it needs to choose between @c ascent and @c full. Depending on which
3815 * is chosen, the @c item tag is formed accordingly as seen before.
3816 * @skip static Evas_Object
3817 * @until evas_object_show(rvascent)
3819 * The first of our entries is here. There's something worth mentioning about
3820 * the way we'll create this one. Normally, any entry regardless of whether is
3821 * single line or not, will be set to scrollable, but in this case, since we
3822 * are limitting how many characters can fit in them and we know we don't need
3823 * scrolling, we are not setting this flag. This makes the entry have virtually
3824 * no appearance on screen, other than its text. This is because an entry is
3825 * just that, a box that holds text, and in order to have some frame around it
3826 * or a background color, another widget needs to provide this. When an entry
3827 * is scrollable, the same scroller used internally does this.
3828 * We are using @ref Frame "frames" here to provide some decoration around,
3829 * then creating our entries, set them to single line, add our two filters and
3830 * the callback for when their value change.
3831 * @until _height_changed_cb
3833 * This function ends with the button that will finally call the item
3834 * into our editting string.
3837 * Then we get to the format edition. Here we can add the @c bold and
3838 * @c emphasis tags to parts of our text. There's a lot of manual work to
3839 * know what to do here, since we are not implementing an entire state manager
3840 * and the entry itself doesn't, yet, support all the needed capabilities to
3841 * make this simpler. We begin by getting the format we are using in our
3842 * function from the button pressed.
3843 * @skip aid->pager = pager;
3844 * @until sizeof(fmt_close)
3846 * Next we need to find out if we need to insert an opening or a closing tag.
3847 * For this, we store the current cursor position and create a selection
3848 * from this point until the beginning of our text, and then get the selected
3849 * text to look for any existing format tags in it. This is currently the only
3850 * way in which we can find out what formats is being used in the entry.
3854 * Once we know what tag to insert, we need a second check in the case it was
3855 * a closing tag. This is because any other closing tag that comes after would
3856 * be left dangling alone, so we need to remove it to keep the text consistent.
3859 * Finally, we clear our fake selections and return the cursor back to the
3860 * position it had at first, since there is where we want to insert our format.
3861 * @until cursor_pos_set
3863 * And finish by calling our convenience function from before, to insert the
3864 * text at the current cursor and give focus back to the entry.
3867 * A checkbox on the top of our program tells us if the text we are editing
3868 * will autosave or not. In it's @c "changed" callback we get the value from
3869 * the checkbox and call the elm_entry_autosave_set() function with it. If
3870 * autosave is set, we also call elm_entry_file_save(). This is so the internal
3871 * timer used to periodically store to disk our changes is started.
3875 * Two more functions to show some cursor playing. Whenever we double click
3876 * anywhere on our entry, we'll find what word is the cursor placed at and
3877 * select it. Likewise, for triple clicking, we select the entire line.
3879 * @until _edit_tplclick_cb
3882 * And finally, the main window of the program contains the entry where we
3883 * do all the edition and some helping widgets to change format, add icons
3884 * or change the autosave flag.
3887 * @until _image_insert_cb
3889 * And the main entry of the program. Set to scroll, by default we disable
3890 * autosave and we'll begin with a file set to it because no file selector
3891 * is being used here. The file is loaded with #ELM_TEXT_FORMAT_MARKUP_UTF8
3892 * so that any format contained in it is interpreted, otherwise the entry
3893 * would load it as just text, escaping any tags found and no format or icons
3894 * would be shown. Then we connect to the double and triple click signals
3895 * and set focus on the entry so we can start typing right away.
3898 * @example entry_example.c
3902 * @page genlist_example_01
3904 * This example creates a simple genlist with a small number of items and
3905 * a callback that is called whenever an item is selected. All the properties of
3906 * this genlist are the default ones. The full code for this example can be seen
3907 * at @ref genlist_example_01_c.
3909 * For the simplest list that you plan to create, it's necessary to define some
3910 * of the basic functions that are used for creating each list item, and
3911 * associating them with the "item class" for that list. The item class is just
3912 * an struct that contains pointers to the specific list item functions that are
3913 * common to all the items of the list.
3915 * Let's show it by example. Our item class is declared globally and static as
3916 * it will be the only item class that we need (we are just creating one list):
3918 * @dontinclude genlist_example_01.c
3919 * @skip static Elm_Genlist
3920 * @until static Elm_Genlist
3922 * This item class will be used for every item that we create. The only
3923 * functions that we are going to set are @c label_get and @c icon_get. As the
3924 * name suggests, they are used by the genlist to generate the label for the
3925 * respective item, and to generate icon(s) to it too. Both the label and icon
3926 * get functions can be called more than once for each item, with different @c
3927 * part parameters, which represent where in the theme of the item that label or
3928 * icon is going to be set.
3930 * The default theme for the genlist contains only one area for label, and two
3931 * areas for icon ("elm.swallow.icon" and "elm.swallow.end"). Since we just want
3932 * to set the first icon (that will be at the left side of the label), we
3933 * compare the part name given with "elm.swallow.icon". Notice that the
3934 * @c label_get function must return a strduped string, that will be freed later
3935 * automatically by the list. Here's the code for @c label_get and @c icon_get:
3937 * @until static void
3939 * We will also provide a function that will be called whenever an item is
3940 * selected in the genlist. However, this function is not part of the item
3941 * class, it will be passed for each item being added to the genlist explicitly.
3942 * Notice the similarity of the function signature with those used by @c
3943 * evas_object_smart_callback_add:
3947 * Now let's show the code used for really creating the list. Skipping
3948 * boilerplate code used for creating a window and background, the first piece
3949 * of code specific to our genlist example is setting the pointer functions of
3950 * the item class to our above defined functions:
3955 * Notice that we also choose to use the "default" style for our genlist items.
3956 * Another interesting point is that @c state_get and @c del are set to @c NULL,
3957 * since we don't need these functions now. @c del doesn't need to be used
3958 * because we don't add any data that must be freed to our items, and @c
3959 * state_get is also not used since all of our items are the same and don't need
3960 * to have different states to be used for each item. Finally we create our
3963 * @until genlist_add
3965 * Now we append several items to the list, and for all of them we need to give
3966 * the list pointer, a pointer to the item class, the data that will be used
3967 * with that item, a pointer to the parent of this item if it is in a group type
3968 * list (this is not the case so we pass @c NULL), possible flags for this item,
3969 * the callback for when the item is selected, and the data pointer that will be
3970 * given to the selected callback.
3974 * The rest of the code is also common to all the other examples, so it will be
3975 * omitted here (look at the full source code link above if you need it).
3977 * You can try to play with this example, and see the selected callback being
3978 * called whenever an item is clicked. It also already has some features enabled
3979 * by default, like vertical bounce animation when reaching the end of the list,
3980 * automatically visible/invisible scrollbar, etc. Look at the @ref
3981 * genlist_example_02 to see an example of setting these properties to the list.
3983 * The current example will look like this when running:
3985 * @image html screenshots/genlist_example_01.png
3986 * @image latex screenshots/genlistexample_01.eps width=\textwidth
3990 * @page genlist_example_02
3992 * This example is very similar to the @ref genlist_example_01, but it fetch
3993 * most of the properties of the genlist and displays them on startup (thus
3994 * getting the default value for them) and then set them to some other values,
3995 * to show how to use that API. The full source code is at @ref
3996 * genlist_example_02_c.
3998 * Considering that the base code for instantiating a genlist was already
3999 * described in the previous example, we are going to focus on the new code.
4001 * Just a small difference for the @c _item_label_get function, we are going to
4002 * store the time that this function was called. This is the "realized" time,
4003 * the time when the visual representation of this item was created. This is the
4004 * code for the @c label_get function:
4006 * @dontinclude genlist_example_02.c
4008 * @until return strdup
4010 * Now let's go to the list creation and setup. First, just after creating the
4011 * list, we get most of the default properties from it, and print them on the
4015 * @until printf("\n")
4017 * We are going to change some of the properties of our list.
4019 * There's no need to call the selected callback at every click, just when the
4020 * selected item changes, thus we call elm_genlist_always_select_mode_set() with
4023 * For this list we don't want bounce animations at all, so we set both the
4024 * horizontal bounce and the vertical bounce to false with
4025 * elm_genlist_bounce_set().
4027 * We also want our list to compress items if they are wider than the list
4028 * width (thus we call elm_genlist_compress_mode_set().
4030 * The items have different width, so they are not homogeneous:
4031 * elm_genlist_homogeneous_set() is set to false.
4033 * Since the compress mode is active, the call to
4034 * elm_genlist_horizontal_mode_set() doesn't make difference, but the current
4035 * option would make the list to have at least the width of the largest item.
4037 * This list will support multiple selection, so we call
4038 * elm_genlist_multi_select_set() on it.
4040 * The option elm_genlist_height_for_width_mode_set() would allow text block to
4041 * wrap lines if the Edje part is configured with "text.min: 0 1", for example.
4042 * But since we are compressing the elements to the width of the list, this
4043 * option wouldn't take any effect.
4045 * We want the vertical scrollbar to be always displayed, and the orizontal one
4046 * to never be displayed, and set this with elm_genlist_scroller_policy_set().
4048 * The timeout to consider a longpress is set to half of a second with
4049 * elm_genlist_longpress_timeout_set().
4051 * We also change the block count to a smaller value, but that should have not
4052 * impact on performance since the number of visible items is too small. We just
4053 * increase the granularity of the block count (setting it to have at most 4
4056 * @until block_count_set
4058 * Now let's add elements to the list:
4060 * @until item_append
4063 * It's exactly the same as the previous example. The difference is on the
4064 * behavior of the list, if you try to scroll, select items and so.
4066 * In this example we also need two buttons. One of them, when clicked, will
4067 * display several status info about the current selection, the "realized"
4068 * items, the item in the middle of the screen, and the current mode and active
4069 * item of that mode for the genlist.
4071 * The other button will ask the genlist to "realize" again the items already
4072 * "realized", so their respective label_get and icon_get functions will be
4075 * These are the callbacks for both of these buttons:
4077 * @dontinclude genlist_example_02.c
4083 * Try to scroll, select some items and click on the "Show status" button.
4084 * You'll notice that not all items of the list are "realized", thus consuming
4085 * just a small amount of memory. The selected items are listed in the order
4086 * that they were selected, and the current selected item printed using
4087 * elm_genlist_selected_item_get() is the first selected item of the multiple
4090 * Now resize the window so that you can see the "realized time" of some items.
4091 * This is the time of when the label_get function was called. If you click on
4092 * the "Realize" button, all the already realized items will be rebuilt, so the
4093 * time will be updated for all of them.
4095 * The current example will look like this when running:
4097 * @image html screenshots/genlist_example_02.png
4098 * @image latex screenshots/genlistexample_02.eps width=\textwidth
4102 * @page progressbar_example Progress bar widget example
4104 * This application is a thorough example of the progress bar widget,
4105 * consisting of a window with varios progress bars, each with a given
4106 * look/style one can give to those widgets. With two auxiliary
4107 * buttons, one can start or stop a timer which will fill in the bars
4108 * in synchrony, simulating an underlying task being completed.
4110 * We create @b seven progress bars, being three of them horizontal,
4111 * three vertical and a final one under the "wheel" alternate style.
4113 * For the first one, we add a progress bar on total pristine state,
4114 * with no other call than the elm_progressbar_add() one:
4115 * @dontinclude progressbar_example.c
4116 * @skip pb with no label
4118 * See, than, that the defaults of a progress bar are:
4119 * - no primary label shown,
4120 * - unit label set to @c "%.0f %%",
4123 * The second progress bar is given a primary label, <c>"Infinite
4124 * bounce"</c>, and, besides, it's set to @b pulse. See how, after one
4125 * starts the progress timer, with the "Start" button, it animates
4126 * differently than the previous one. It won't account for the
4127 * progress, itself, and just dumbly animate a small bar within its
4129 * @dontinclude progressbar_example.c
4130 * @skip pb with label
4133 * Next, comes a progress bar with an @b icon, a primary label and a
4134 * @b custom unit label set. It's also made to grow its bar in an
4135 * @b inverted manner, so check that out during the timer's progression:
4136 * @dontinclude progressbar_example.c
4139 * Another important thing in this one is the call to
4140 * elm_progressbar_span_size_set() -- this is how we forcefully set a
4141 * minimum horizontal size to our whole window! We're not resizing it
4142 * manually, as you can see in the @ref progressbar_example_c
4145 * The next three progress bars are just variants on the ones already
4146 * shown, but now all being @b vertical. Another time we use one of
4147 * than to give the window a minimum vertical size, with
4148 * elm_progressbar_span_size_set(). To demonstrate this trick once
4149 * more, the fifth one, which is also set to pulse, has a smaller
4150 * hardcoded span size:
4151 * @dontinclude progressbar_example.c
4152 * @skip vertical pb, with pulse
4155 * We end the widget demonstration by showing a progress bar with the
4156 * special @b "wheel" progress bar style. One does @b not need to set
4157 * it to pulse, with elm_progressbar_pulse_set(), explicitly, because
4158 * its theme does not take it in account:
4159 * @dontinclude progressbar_example.c
4163 * The two buttons exercising the bars, the facto, follow:
4164 * @dontinclude progressbar_example.c
4165 * @skip elm_button_add
4166 * @until evas_object_show(bt)
4167 * @until evas_object_show(bt)
4169 * The first of the callbacks will, for the progress bars set to
4170 * pulse, start the pulsing animation at that time. For the others, a
4171 * timer callback will take care of updating the values:
4172 * @dontinclude progressbar_example.c
4173 * @skip static Eina_Bool
4178 * Finally, the callback to stop the progress timer will stop the
4179 * pulsing on the pulsing progress bars and, for the others, to delete
4180 * the timer which was acting on their values:
4181 * @dontinclude progressbar_example.c
4186 * This is how the example program's window looks like:
4187 * @image html screenshots/progressbar_example.png
4188 * @image latex screenshots/progressbar_example.eps width=\textwidth
4190 * See the full @ref progressbar_example_c "source code" for
4193 * @example progressbar_example.c
4197 * @page bg_example_01_c bg_example_01.c
4198 * @include bg_example_01.c
4199 * @example bg_example_01.c
4203 * @page bg_example_02_c bg_example_02.c
4204 * @include bg_example_02.c
4205 * @example bg_example_02.c
4209 * @page bg_example_03_c bg_example_03.c
4210 * @include bg_example_03.c
4211 * @example bg_example_03.c
4215 * @page actionslider_example_01 Actionslider example
4216 * @include actionslider_example_01.c
4217 * @example actionslider_example_01.c
4221 * @page animator_example_01_c Animator example 01
4222 * @include animator_example_01.c
4223 * @example animator_example_01.c
4227 * @page transit_example_01_c Transit example 1
4228 * @include transit_example_01.c
4229 * @example transit_example_01.c
4233 * @page transit_example_02_c Transit example 2
4234 * @include transit_example_02.c
4235 * @example transit_example_02.c
4239 * @page general_functions_example_c General (top-level) functions example
4240 * @include general_funcs_example.c
4241 * @example general_funcs_example.c
4245 * @page clock_example_c Clock example
4246 * @include clock_example.c
4247 * @example clock_example.c
4251 * @page flipselector_example_c Flipselector example
4252 * @include flipselector_example.c
4253 * @example flipselector_example.c
4257 * @page fileselector_example_c Fileselector example
4258 * @include fileselector_example.c
4259 * @example fileselector_example.c
4263 * @page fileselector_button_example_c Fileselector button example
4264 * @include fileselector_button_example.c
4265 * @example fileselector_button_example.c
4269 * @page fileselector_entry_example_c Fileselector entry example
4270 * @include fileselector_entry_example.c
4271 * @example fileselector_entry_example.c
4275 * @page index_example_01_c Index example
4276 * @include index_example_01.c
4277 * @example index_example_01.c
4281 * @page index_example_02_c Index example
4282 * @include index_example_02.c
4283 * @example index_example_02.c
4287 * @page layout_example_01_c layout_example_01.c
4288 * @include layout_example_01.c
4289 * @example layout_example_01.c
4293 * @page layout_example_02_c layout_example_02.c
4294 * @include layout_example_02.c
4295 * @example layout_example_02.c
4299 * @page layout_example_03_c layout_example_03.c
4300 * @include layout_example_03.c
4301 * @example layout_example_03.c
4305 * @page layout_example_edc An example of layout theme file
4307 * This theme file contains two groups. Each of them is a different theme, and
4308 * can be used by an Elementary Layout widget. A theme can be used more than
4309 * once by many different Elementary Layout widgets too.
4311 * @include layout_example.edc
4312 * @example layout_example.edc
4315 * @page gengrid_example_c Gengrid example
4316 * @include gengrid_example.c
4317 * @example gengrid_example.c
4321 * @page genlist_example_01_c genlist_example_01.c
4322 * @include genlist_example_01.c
4323 * @example genlist_example_01.c
4327 * @page genlist_example_02_c genlist_example_02.c
4328 * @include genlist_example_02.c
4329 * @example genlist_example_02.c
4333 * @page progressbar_example_c Progress bar example
4334 * @include progressbar_example.c
4335 * @example progressbar_example.c