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
36 * @ref diskselector_example_01
38 * @ref diskselector_example_02
40 * @ref list_example_01
42 * @ref list_example_02
44 * @ref list_example_03
46 * @ref flipselector_example
48 * @ref fileselector_example
50 * @ref fileselector_button_example
52 * @ref fileselector_entry_example
54 * @ref index_example_01
56 * @ref index_example_02
58 * @ref gengrid_example
62 * @page bg_01_example_page elm_bg - Plain color background.
63 * @dontinclude bg_example_01.c
65 * The full code for this example can be found at @ref bg_example_01_c,
66 * in the function @c test_bg_plain. It's part of the @c elementar_test
67 * suite, and thus has the code for the three examples referenced by this
70 * This first example just sets a default background with a plain color. The
71 * first part consists of creating an Elementary window. It's the common
72 * piece of code that you'll see everywhere in Elementary: @skip elm_main
75 * Now we really create our background object, using the window object as
80 * Then we set the size hints of the background object so that it will use
81 * all space available for it, and then add it as a resize object to the
82 * window, making it visible in the end:
84 * @skip size_hint_weight_set
85 * @until resize_object_add
87 * See @ref evas_object_size_hint_weight_set and elm_win_resize_object_add()
88 * for more detailed info about these functions.
90 * The end of the example is quite simple, just setting the minimum and
91 * maximum size of the background, so the Elementary window knows that it
92 * has to have at least the minimum size. The background also won't scale to
93 * a size above its maximum. Then we resize the window and show it in the
96 * @skip set size hints
99 * And here we finish our very simple background object usage example.
103 * @page bg_02_example_page elm_bg - Image background.
104 * @dontinclude bg_example_02.c
106 * The full code for this example can be found at @ref bg_example_02_c,
107 * in the function @c test_bg_image. It's part of the @c elementar_test
108 * suite, and thus has the code for the three examples referenced by this
111 * This is the second example, and shows how to use the Elementary
112 * background object to set an image as background of your application.
114 * We start this example exactly in the same way as the previous one, even
115 * when creating the background object:
120 * Now it's the different part.
122 * Our background will have an image, that will be displayed over the
123 * background color. Before loading the image, we set the load size of the
124 * image. The load size is a hint about the size that we want the image
125 * displayed in the screen. It's not the exact size that the image will have,
126 * but usually a bit bigger. The background object can still be scaled to a
127 * size bigger than the one set here. Setting the image load size to
128 * something smaller than its real size will reduce the memory used to keep
129 * the pixmap representation of the image, and the time to load it. Here we
130 * set the load size to 20x20 pixels, but the image is loaded with a size
131 * bigger than that (since it's just a hint):
133 * @skipline load_size_set
135 * And set our background image to be centered, instead of stretched or
136 * scaled, so the effect of the elm_bg_load_size_set() can be easily
139 * @skipline option_set
141 * We need a filename to set, so we get one from the previous installed
142 * images in the @c PACKAGE_DATA_DIR, and write its full path to a buffer.
143 * Then we use this buffer to set the filename in the background object:
148 * Notice that the third argument of the elm_bg_file_set() function is @c
149 * NULL, since we are setting an image to this background. This function
150 * also supports setting an edje group as background, in which case the @c
151 * group parameter wouldn't be @c NULL, but be the name of the group
154 * Finally, we can set the size hints, add the background as a resize
155 * object, and resize the window, exactly the same thing we do in the @ref
156 * bg_01_example_page example:
161 * And this is the end of this example.
163 * This example will look like this:
165 * @image html screenshots/bg_01.png
166 * @image latex screenshots/bg_01.eps width=\textwidth
170 * @page bg_03_example_page elm_bg - Background properties.
171 * @dontinclude bg_example_03.c
173 * The full code for this example can be found at @ref bg_example_03_c, in the
174 * function @c test_bg_options, with the callbacks @c _cb_overlay_changed, @c
175 * _cb_color_changed and @c _cb_radio_changed defined in the beginning of the
176 * file. It's part of the @c elementar_test suite, and thus has the code for
177 * the three examples referenced by this documentation.
179 * This example will show the properties available for the background object,
180 * and will use of some more widgets to set them.
182 * In order to do this, we will set some callbacks for these widgets. The
183 * first is for the radio buttons that will be used to choose the option
184 * passed as argument to elm_bg_option_set():
186 * @skip _cb_radio_changed
189 * The next callback will be used when setting the overlay (using
190 * elm_bg_overlay_set()):
192 * @skip _cb_overlay_changed
196 * And the last one, used to set the color (with elm_bg_color_set()):
198 * @skip _cb_color_changed
201 * We will get back to what these functions do soon. If you want to know more
202 * about how to set these callbacks and what these widgets are, look for:
203 * @li elm_radio_add()
204 * @li elm_check_add()
205 * @li elm_spinner_add()
207 * Now going to the main function, @c test_bg_options, we have the common
208 * code with the other examples:
213 * We add a plain background to this window, so it will have the default
214 * background color behind everything:
216 * @skip bg = elm_bg_add
217 * @until evas_object_show(bg)
219 * Then we add a vertical box (elm_box_add()) that will hold the background
220 * object that we are going to play with, as well as a horizontal box that
224 * @until evas_object_show
226 * Now we add the background object that is going to be of use for our
227 * example. It is an image background, as used in @ref bg_02_example_page ,
228 * so the code should be familiar:
231 * @until evas_object_show
233 * Notice the call to elm_box_pack_end(): it will pack the background object
234 * in the end of the Elementary box declared above. Just refer to that
235 * documentation for more info.
237 * Since this Elementary background is already an image background, we are
238 * going to play with its other properties. We will change its option
239 * (CENTER, SCALE, STRETCH, TILE), its color (RGB), and add an overlay to it.
240 * For all of these properties, we are going to add widgets that will
243 * First, lets add the horizontal box that will hold these widgets:
247 * For now, just consider this @c hbox as a rectangle that will contain the
248 * widgets, and will distribute them horizontally inside its content. Then we
249 * add radio buttons that will allow us to choose the property to use with
253 * @until evas_object_show
255 * Again, I won't give details about the use of these widgets, just look for
256 * their documentation if necessary. It's enough to know for now that we are
257 * packing them in the @c hbox, setting a label for them, and the most
258 * important parts: setting its value to @c ELM_BG_OPTION_CENTER and its
259 * callback to @c _cb_radio_changed (the function defined in the beginning of
260 * this example). We do this for the next 3 radio buttons added after this
261 * one, each of them with a different value.
263 * Now taking a look at the code of the callback @c _cb_radio_changed again,
264 * it will call elm_bg_option_set() with the value set from the checked radio
265 * button, thus setting the option for this background. The background is
266 * passed as argument to the @p data parameter of this callback, and is
267 * referenced here as @c o_bg.
269 * Later we set the default value for this radio button:
271 * @skipline elm_radio_value_set
273 * Then we add a checkbox for the elm_bg_overlay_set() function:
276 * @until evas_object_show
278 * Now look at the code of the @c _cb_overlay_changed again. If the checkbox
279 * state is checked, an overlay will be added to the background. It's done by
280 * creating an Edje object, and setting it with elm_bg_overlay_set() to the
281 * background object. For information about what are and how to set Edje
282 * object, look at the Edje documentation.
284 * Finally we add a spinner object (elm_spinner_add()) to be used to select
285 * the color of our background. In its callback it's possible to see the call
286 * to elm_bg_color_set(), which will change the color of this background.
287 * This color is used by the background to fill areas where the image doesn't
288 * cover (in this case, where we have an image background). The spinner is
289 * also packed into the @c hbox :
291 * @skip elm_spinner_add
292 * @until evas_object_show
294 * Then we just have to pack the @c hbox inside the @c box, set some size
295 * hints, and show our window:
300 * Now to see this code in action, open elementary_test, and go to the "Bg
301 * Options" test. It should demonstrate what was implemented here.
305 * @page actionslider_example_page Actionslider usage
306 * @dontinclude actionslider_example_01.c
308 * For this example we are going to assume knowledge of evas smart callbacks
309 * and some basic evas object functions. Elementary is not meant to be used
310 * without evas, if you're not yet familiar with evas it probably is worth
313 * And now to the example, when using Elementary we start by including
317 * Next we define some callbacks, they all share the same signature because
318 * they are all to be used with evas_object_smart_callback_add().
319 * The first one just prints the selected label(in two different ways):
322 * This next callback is a little more interesting, it makes the selected
323 * label magnetic(except if it's the center label):
326 * This callback enables or disables the magnetic propertty of the center
330 * And finally a callback to stop the main loop when the window is closed:
333 * To be able to create our actionsliders we need to do some setup, but this
334 * isn't really relevant here, so if you want to know about that go @ref
337 * With all that boring stuff out of the way we can proceed to creating some
339 * All actionsliders are created the same way:
340 * @skipline actionslider_add
341 * Next we must choose where the indicator starts, and for this one we choose
342 * the right, and set the right as magnetic:
343 * @skipline indicator_pos_set
344 * @until magnet_pos_set
346 * We then set the labels for the left and right, passing NULL as an argument
347 * to any of the labels makes that position have no label.
350 * Furthermore we mark both left and right as enabled positions, if we didn't
351 * do this all three positions would be enabled:
354 * Having the the enabled positions we now add a smart callback to change
355 * which position is magnetic, so that only the last selected position is
359 * And finally we set our printing callback and show the actionslider:
363 * For our next actionslider we are going to do much as we did for the
364 * previous except we are going to have the center as the magnet(and not
366 * @skipline actionslider_add
367 * @skipline indicator_pos_set
370 * And another actionslider, in this one the indicator starts on the left.
371 * It has labels only in the center and right, and both bositions are
372 * magnetic. Because the left doesn't have a label and is not magnetic once
373 * the indicator leaves it can't return:
374 * @skipline actionslider_add
375 * @skipline indicator_pos_set
377 * @note The greyed out area is a @ref Styles "style".
379 * And now an actionslider with a label in the indicator, and whose magnet
380 * properties change based on what was last selected:
381 * @skipline actionslider_add
382 * @skipline indicator_pos_set
384 * @note The greyed out area is a @ref Styles "style".
386 * We are almost done, this next one is just an actionslider with all
387 * positions magnetized and having every possible label:
388 * @skipline actionslider_add
389 * @skipline indicator_pos_set
392 * And for our last actionslider we have one that turns the magnetic property
394 * @skipline actionslider_add
395 * @skipline indicator_pos_set
398 * The example will look like this:
400 * @image html screenshots/actionslider_01.png
401 * @image latex screenshots/actionslider_01.eps width=\textwidth
403 * See the full source code @ref actionslider_example_01 "here"
407 * @page elm_animator_example_page_01 Animator usage
408 * @dontinclude animator_example_01.c
410 * For this example we will be using a bit of evas, you could animate a
411 * elementary widget in much the same way, but to keep things simple we use
412 * an evas_object_rectangle.
414 * As every other example we start with our include and a simple callback to
415 * exit the app when the window is closed:
419 * This next callback is the one that actually creates our animation, it
420 * changes the size, position and color of a rectangle given to it in @a
424 * Next we have a callback that prints a string, nothing special:
427 * This next callback is a little more interesting, it has a state variable
428 * to know if the animation is currently paused or running, and it toogles
429 * the state of the animation accordingly:
434 * Finally we have a callback to stop the animation:
437 * As with every example we need to do a bit of setup before we can actually
438 * use an animation, but for the purposes of this example that's not relevant
439 * so let's just skip to the good stuff, creating an animator:
440 * @skipline animator_add
441 * @note Since elm_animator is not a widget we can give it a NULL parent.
443 * Now that we have an elm_animator we set it's duration to 1 second:
446 * We would also like our animation to be reversible, so:
449 * We also set our animation to repeat as many times as possible, which will
450 * mean that _end_cb will only be called after UINT_MAX * 2 seconds(UINT_MAX
451 * for the animation running forward and UNIT_MAX for the animation running
455 * To add some fun to our animation we will use the IN_OUT curve style:
458 * To actually animate anything we need an operation callback:
459 * @line operation_callback
461 * Even though we set our animation to repeat for a very long time we are
462 * going to set a end callback to it:
463 * @line completion_callback
464 * @note Notice that stoping the animation with the stop button will not make
467 * Now that we have fully set up our animator we can tell it to start
471 * There's a bit more of code that doesn't really matter to use so we skip
472 * right down to our last interesting point:
473 * @skipline animator_del
474 * @note Because we created our animator with no parent we need to delete it
477 * The example should look like this:
479 * @image html screenshots/animator_example_01.png
480 * @image latex screenshots/animator_example_01.eps width=\textwidth
482 * @image html screenshots/animator_example_02.png
483 * @image latex screenshots/animator_example_02.eps width=\textwidth
485 * @image html screenshots/animator_example_03.png
486 * @image latex screenshots/animator_example_03.eps width=\textwidth
488 * The full source code for this example can be found @ref
489 * animator_example_01_c "here"
493 * @page transit_example_03_c elm_transit - Combined effects and options.
495 * This example shows how to apply the following transition effects:
503 * It allows you to apply more than one effect at once, and also allows to
504 * set properties like event_enabled, auto_reverse, repeat_times and
507 * @include transit_example_03.c
511 * @page transit_example_04_c elm_transit - Combined effects over two objects.
513 * This example shows how to apply the transition effects:
518 * over two objects. This kind of transition effect is used to make one
519 * object disappear and another one appear on its place.
521 * You can mix more than one effect of this type on the same objects, and the
522 * transition will apply both.
524 * @include transit_example_04.c
528 * @page transit_example_01_explained elm_transit - Basic transit usage.
529 * @dontinclude transit_example_01.c
531 * The full code for this example can be found at @ref transit_example_01_c.
533 * This example shows the simplest way of creating a transition and applying
534 * it to an object. Similarly to every other elementary example, we create a
535 * window, set its title, size, autodel property, and setup a callback to
536 * exit the program when finished:
539 * @until evas_object_resize
541 * We also add a resizeable white background to use behind our animation:
544 * @until evas_object_show
546 * And then we add a button that we will use to demonstrate the effects of
550 * @until evas_object_show(win)
552 * Notice that we are not adding the button with elm_win_resize_object_add()
553 * because we don't want the window to control the size of the button. We
554 * will use the transition to change the button size, so it could conflict
555 * with something else trying to control that size.
557 * Now, the simplest code possible to create the resize animation:
562 * As you can see, this code is very easy to understand. First, we create the
563 * transition itself with elm_transit_add(). Then we add the button to this
564 * transition with elm_transit_object_add(), which means that the transition
565 * will operate over this button. The effect that we want now is changing the
566 * object size from 100x50 to 300x150, and can be achieved by adding the
567 * resize effect with elm_transit_effect_resizing_add().
569 * Finally, we set the transition time to 5 seconds and start the transition
570 * with elm_transit_go(). If we wanted more effects applied to this
571 * button, we could add them to the same transition. See the
572 * @ref transit_example_03_c to watch many transitions being applied to an
577 * @page transit_example_02_explained elm_transit - Chained transitions.
578 * @dontinclude transit_example_02.c
580 * The full code for this example can be found at @ref transit_example_02_c.
582 * This example shows how to implement a chain of transitions. This chain is
583 * used to start a transition just after another transition ended. Similarly
584 * to every other elementary example, we create a window, set its title,
585 * size, autodel property, and setup a callback to exit the program when
589 * @until evas_object_resize
591 * We also add a resizeable white background to use behind our animation:
594 * @until evas_object_show
596 * This example will have a chain of 4 transitions, each of them applied to
597 * one button. Thus we create 4 different buttons:
600 * @until evas_object_show(bt4)
602 * Now we create a simple translation transition that will be started as soon
603 * as the program loads. It will be our first transition, and the other
604 * transitions will be started just after this transition ends:
609 * The code displayed until now has nothing different from what you have
610 * already seen in @ref transit_example_01_explained, but now comes the new
611 * part: instead of creating a second transition that will start later using
612 * a timer, we create the it normally, and use
613 * elm_transit_chain_transit_add() instead of elm_transit_go. Since we are
614 * adding it in a chain after the first transition, it will start as soon as
615 * the first transition ends:
618 * @until transit_chain_transit_add
620 * Finally we add the 2 other transitions to the chain, and run our program.
621 * It will make one transition start after the other finish, and there is the
626 * @page general_functions_example_page General (top-level) functions example
627 * @dontinclude general_funcs_example.c
629 * As told in their documentation blocks, the
630 * elm_app_compile_*_dir_set() family of functions have to be called
631 * before elm_app_info_set():
632 * @skip tell elm about
633 * @until elm_app_info_set
635 * We are here setting the fallback paths to the compiling time target
636 * paths, naturally. If you're building the example out of the
637 * project's build system, we're assuming they are the canonical ones.
639 * After the program starts, elm_app_info_set() will actually run and
640 * then you'll see an intrincasy: Elementary does the prefix lookup @b
641 * twice. This is so because of the quicklaunch infrastructure in
642 * Elementary (@ref Start), which will register a predefined prefix
643 * for possible users of the launch schema. We're not hooking into a
644 * quick launch, so this first call can't be avoided.
646 * If you ran this example from your "bindir" installation
647 * directiory, no output will emerge from these both attempts -- it
648 * will find the "magic" file there registered and set the prefixes
649 * silently. Otherwise, you could get something like:
651 WARNING: Could not determine its installed prefix for 'ELM'
652 so am falling back on the compiled in default:
654 implied by the following:
657 datadir = usr/share/elementary
658 localedir = usr/share/locale
659 Try setting the following environment variables:
660 ELM_PREFIX - points to the base prefix of install
661 or the next 4 variables
662 ELM_BIN_DIR - provide a specific binary directory
663 ELM_LIB_DIR - provide a specific library directory
664 ELM_DATA_DIR - provide a specific data directory
665 ELM_LOCALE_DIR - provide a specific locale directory
667 * if you also didn't change those environment variables (remember
668 * they are also a valid way of communicating your prefix to the
669 * binary) - this is the scenario where it fallbacks to the paths set
672 * Then, you can check the prefixes set on the standard output:
673 * @skip prefix was set to
674 * @until locale directory is
677 * @skip by using this policy
678 * @until elm_win_autodel_set
679 * we demonstrate the use of Elementary policies. The policy defining
680 * under which circunstances our application should quit automatically
681 * is set to when its last window is closed (this one has just one
682 * window, though). This will save us from having to set a callback
683 * ourselves on the window, like done in @ref bg_example_01_c "this"
684 * example. Note that we need to tell the window to delete itself's
685 * object on a request to destroy the canvas coming, with
686 * elm_win_autodel_set().
688 * What follows is some boilerplate code, creating a frame with a @b
689 * button, our object of interest, and, below, widgets to change the
690 * button's behavior and exemplify the group of functions in question.
692 * @dontinclude general_funcs_example.c
693 * We enabled the focus highlight object for this window, so that you
694 * can keep track of the current focused object better:
695 * @skip elm_win_focus_highlight_enabled_set
696 * @until evas_object_show
697 * Use the tab key to navigate through the focus chain.
699 * @dontinclude general_funcs_example.c
700 * While creating the button, we exemplify how to use Elementary's
701 * finger size information to scale our UI:
702 * @skip fprintf(stdout, "Elementary
703 * @until evas_object_show
705 * @dontinclude general_funcs_example.c
706 * The first checkbox's callback is:
709 * When unsetting the checkbox, we disable the button, which will get a new
710 * decoration (greyed out) and stop receiving events. The focus chain
711 * will also ignore it.
713 * Following, there are 2 more buttons whose actions are focus/unfocus
714 * the top button, respectively:
715 * @skip focus callback
718 * @skip unfocus callback
720 * Note the situations in which they won't take effect:
721 * - the button is not allowed to get focus or
722 * - the button is disabled
724 * The first restriction above you'll get by a second checkbox, whose
726 * @skip focus allow callback
728 * Note that the button will still get mouse events, though.
730 * Next, there's a slider controlling the button's scale:
731 * @skip scaling callback
734 * Experiment with it, so you understand the effect better. If you
735 * change its value, it will mess with the button's original size,
738 * The full code for this example can be found
739 * @ref general_functions_example_c "here".
743 * @page theme_example_01 Theme - Using extensions
745 * @dontinclude theme_example_01.c
747 * Using extensions is extremely easy, discarding the part where you have to
748 * write the theme for them.
750 * In the following example we'll be creating two buttons, one to load or
751 * unload our extension theme and one to cycle around three possible styles,
752 * one of which we created.
754 * After including our one and only header we'll jump to the callback for
755 * the buttons. First one takes care of loading or unloading our extension
756 * file, relative to the default theme set (thus the @c NULL in the
757 * functions first parameter).
758 * @skipline Elementary.h
764 * The second button, as we said before, will just switch around different
765 * styles. In this case we have three of them. The first one is our custom
766 * style, named after something very unlikely to find in the default theme.
767 * The other two styles are the standard and one more, anchor, which exists
768 * in the default and is similar to the default, except the button vanishes
769 * when the mouse is not over it.
774 * So what happens if the style switches to our custom one when the
775 * extension is loaded? Elementary falls back to the default for the
778 * And the main function, simply enough, will create the window, set the
779 * buttons and their callbacks, and just to begin with our button styled
780 * we're also loading our extension at the beginning.
784 * In this case we wanted to easily remove extensions, but all adding an
785 * extension does is tell Elementary where else it should look for themes
786 * when it can't find them in the default theme. Another way to do this
787 * is to set the theme search order using elm_theme_set(), but this requires
788 * that the developer is careful not to override any user configuration.
789 * That can be helped by adding our theme to the end of whatver is already
790 * set, like in the following snippet.
793 * snprintf(buf, sizeof(buf), "%s:./theme_example.edj", elme_theme_get(NULL);
794 * elm_theme_set(NULL, buf);
797 * If we were using overlays instead of extensions, the same thing applies,
798 * but the custom theme must be added to the front of the search path.
800 * In the end, we should be looking at something like this:
802 * @image html screenshots/theme_example_01.png
803 * @image latex screenshots/theme_example_01.eps width=\textwidth
805 * That's all. Boringly simple, and the full code in one piece can be found
806 * @ref theme_example_01.c "here".
808 * And the code for our extension is @ref theme_example.edc "here".
810 * @example theme_example_01.c
811 * @example theme_example.edc
815 * @page theme_example_02 Theme - Using overlays
817 * @dontinclude theme_example_02.c
819 * Overlays are like extensions in that you tell Elementary that some other
820 * theme contains the styles you need for your program. The difference is that
821 * they will be look in first, so they can override the default style of any
824 * There's not much to say about them that hasn't been said in our previous
825 * example about @ref theme_example_01 "extensions", so going quickly through
826 * the code we have a function to load or unload the theme, which will be
827 * called when we click any button.
828 * @skipline Elementary.h
832 * And the main function, creating the window and adding some buttons to it.
833 * We load our theme as an overlay and nothing else. Notice there's no style
834 * set for any button there, which means they should be using the default
839 * That's pretty much it. The full code is @ref theme_example_02.c "here" and
840 * the definition of the theme is the same as before, and can be found in
841 * @ref theme_example.edc "here".
843 * @example theme_example_02.c
847 * @page button_example_01 Button - Complete example
849 * @dontinclude button_example_01.c
851 * A button is simple, you click on it and something happens. That said,
852 * we'll go through an example to show in detail the button API less
855 * In the end, we'll be presented with something that looks like this:
857 * @image html screenshots/button_01.png
858 * @image latex screenshots/button_01.eps width=\textwidth
860 * The full code of the example is @ref button_example_01.c "here" and we
861 * will follow here with a rundown of it.
864 * @until Elementary.h
868 * We have several buttons to set different times for the autorepeat timeouts
869 * of the buttons that use it and a few more that we keep track of in our
870 * data struct. The mid button doesn't do much, just moves around according
871 * to what other buttons the user presses. Then four more buttons to move the
872 * central one, and we're also keeping track of the icon set in the middle
873 * button, since when this one moves, we change the icon, and when movement
874 * is finished (by releasing one of the four arrow buttons), we set back the
879 * Keeping any of those four buttons pressed will trigger their autorepeat
880 * callback, where we move the button doing some size hint magic. To
881 * understand how that works better, refer to the @ref Box documentation.
882 * Also, the first time the function is called, we change the icon in the
883 * middle button, using elm_button_icon_unset() first to keep the reference
884 * to the previous one, so we don't need to recreate it when we are done
888 * @until size_hint_align_set
891 * One more callback for the option buttons, that just sets the timeouts for
892 * the different autorepeat options.
899 * And the main function, which does some setting up of the buttons in boxes
900 * to make things work. Here we'll go through some snippets only.
902 * For the option buttons, it's just the button with its label and callback.
903 * @skip elm_button_add
904 * @until smart_callback_add
906 * For the ones that move the central button, we have no labels. There are
907 * icons instead, and the autorepeat option is toggled.
909 * @skip elm_button_add
910 * @until data.cursors.up
912 * And just to show the mid button, which doesn't have anything special.
913 * @skip data.cursors.left
914 * @skip elm_button_add
919 * @example button_example_01.c
923 * @page bubble_01_example_page elm_bubble - Simple use.
924 * @dontinclude bubble_example_01.c
926 * This example shows a bubble with all fields set(label, info, content and
927 * icon) and the selected corner changing when the bubble is clicked. To be
928 * able use a bubble we need to do some setup and create a window, for this
929 * example we are going to ignore that part of the code since it isn't
930 * relevant to the bubble.
932 * To have the selected corner change in a clockwise motion we are going to
933 * use the following callback:
938 * Here we are creating an elm_label that is going to be used as the content
940 * @skipline elm_label
942 * @note You could use any evas_object for this, we are using an elm_label
945 * Despite it's name the bubble's icon doesn't have to be an icon, it can be
946 * any evas_object. For this example we are going to make the icon a simple
950 * And finally we have the actual bubble creation and the setting of it's
951 * label, info and content:
954 * @note Because we didn't set a corner, the default("top_left") will be
957 * Now that we have our bubble all that is left is connecting the "clicked"
958 * signals to our callback:
959 * @line smart_callback
961 * This last bubble we created was very complete, so it's pertinent to show
962 * that most of that stuff is optional a bubble can be created with nothing
967 * Our example will look like this:
969 * @image html screenshots/bubble_example_01.png
970 * @image latex screenshots/bubble_example_01.eps width=\textwidth
972 * See the full source code @ref bubble_example_01.c here.
973 * @example bubble_example_01.c
977 * @page box_example_01 Box - Basic API
979 * @dontinclude button_example_01.c
981 * As a special guest tonight, we have the @ref button_example_01 "simple
982 * button example". There are plenty of boxes in it, and to make the cursor
983 * buttons that moved a central one around when pressed, we had to use a
984 * variety of values for their hints.
986 * To start, let's take a look at the handling of the central button when
987 * we were moving it around. To achieve this effect without falling back to
988 * a complete manual positioning of the @c Evas_Object in our canvas, we just
989 * put it in a box and played with its alignment within it, as seen in the
990 * following snippet of the callback for the pressed buttons.
991 * @skip evas_object_size_hint_align_get
992 * @until evas_object_size_hint_align_set
994 * Not much to it. We get the current alignment of the object and change it
995 * by just a little, depending on which button was pressed, then set it
996 * again, making sure we stay within the 0.0-1.0 range so the button moves
997 * inside the space it has, instead of disappearing under the other objects.
999 * But as useful as an example as that may have been, the usual case with boxes
1000 * is to set everything at the moment they are created, like we did for
1001 * everything else in our main function.
1003 * The entire layout of our program is made with boxes. We have one set as the
1004 * resize object for the window, which means it will always be resized with
1005 * the window. The weight hints set to @c EVAS_HINT_EXPAND will tell the
1006 * window that the box can grow past it's minimum size, which allows resizing
1010 * @until evas_object_show
1012 * Two more boxes, set to horizontal, hold the buttons to change the autorepeat
1013 * configuration used by the buttons. We create each to take over all the
1014 * available space horizontally, but we don't want them to grow vertically,
1015 * so we keep that axis of the weight with 0.0. Then it gets packed in the
1018 * @until evas_object_show
1020 * The buttons in each of those boxes have nothing special, they are just packed
1021 * in with their default values and the box will use their minimum size, as set
1022 * by Elementary itself based on the label, icon, finger size and theme.
1024 * But the buttons used to move the central one have a special disposition.
1025 * The top one first, is placed right into the main box like our other smaller
1026 * boxes. Set to expand horizontally and not vertically, and in this case we
1027 * also tell it to fill that space, so it gets resized to take the entire
1028 * width of the window.
1030 * @skip elm_button_add
1031 * @until evas_object_show
1033 * The bottom one will be the same, but for the other two we need to use a
1034 * second box set to take as much space as we have, so we can place our side
1035 * buttons in place and have the big empty space where the central button will
1038 * @until evas_object_show
1040 * Then the buttons will have their hints inverted to the other top and bottom
1041 * ones, to expand and fill vertically and keep their minimum size horizontally.
1042 * @skip elm_button_add
1043 * @until evas_object_show
1045 * The central button takes every thing else. It will ask to be expanded in
1046 * both directions, but without filling its cell. Changing its alignment by
1047 * pressing the buttons will make it move around.
1048 * @skip elm_button_add
1049 * @until evas_object_show
1051 * To end, the rightmost button is packed in the smaller box after the central
1052 * one, and back to the main box we have the bottom button at the end.
1056 * @page box_example_02 Box - Layout transitions
1058 * @dontinclude box_example_02.c
1060 * Setting a customized layout for a box is simple once you have the layout
1061 * function, which is just like the layout function for @c Evas_Box. The new
1062 * and fancier thing we can do with Elementary is animate the transition from
1063 * one layout to the next. We'll see now how to do that through a simple
1064 * example, while also taking a look at some of the API that was left
1065 * untouched in our @ref box_example_01 "previous example".
1067 * @image html screenshots/box_example_02.png
1068 * @image latex screenshots/box_example_02.eps width=\textwidth
1070 * @skipline Elementary.h
1072 * Our application data consists of a list of layout functions, given by
1073 * @c transitions. We'll be animating through them throughout the entire run.
1074 * The box with the stuff to move around and the last layout that was set to
1075 * make things easier in the code.
1077 * @until Transitions_Data
1079 * The box starts with three buttons, clicking on any of them will take it
1080 * out of the box without deleting the object. There are also two more buttons
1081 * outside, one to add an object to the box and the other to clear it.
1082 * This is all to show how you can interact with the items in the box, add
1083 * things and even remove them, while the transitions occur.
1085 * One of the callback we'll be using creates a new button, asks the box for
1086 * the list of its children and if it's not empty, we add the new object after
1087 * the first one, otherwise just place at the end as it will not make any
1093 * The clear button is even simpler. Everything in the box will be deleted,
1094 * leaving it empty and ready to fill it up with more stuff.
1098 * And a little function to remove buttons from the box without deleting them.
1099 * This one is set for the @c clicked callback of the original buttons,
1100 * unpacking them when clicked and placing it somewhere in the screen where
1101 * they will not disturb. Once we do this, the box no longer has any control
1102 * of it, so it will be left untouched until the program ends.
1106 * If we wanted, we could just call @c evas_object_del() on the object to
1107 * destroy it. In this case, no unpack is really necessary, as the box would
1108 * be notified of a child being deleted and adjust its calculations accordingly.
1110 * The core of the program is the following function. It takes whatever
1111 * function is first on our list of layouts and together with the
1112 * @c last_layout, it creates an ::Elm_Box_Transition to use with
1113 * elm_box_layout_transition(). In here, we tell it to start from whatever
1114 * layout we last set, end with the one that was at the top of the list and
1115 * when everything is finished, call us back so we can create another
1116 * transition. Finally, move the new layout to the end of the list so we
1117 * can continue running through them until the program ends.
1121 * The main function doesn't have antyhing special. Creation of box, initial
1122 * buttons and some callback setting. The only part worth mentioning is the
1123 * initialization of our application data.
1125 * @until evas_object_box_layout_stack
1127 * We have a simple static variable, set the box, the first layout we are
1128 * using as last and create the list with the different functions to go
1131 * And in the end, we set the first layout and call the same function we went
1132 * through before to start the run of transitions.
1133 * @until _test_box_transition_change
1135 * For the full code, follow @ref box_example_02.c "here".
1137 * @example box_example_02.c
1141 * @page calendar_example_01 Calendar - Simple creation.
1142 * @dontinclude calendar_example_01.c
1144 * As a first example, let's just display a calendar in our window,
1145 * explaining all steps required to do so.
1147 * First you should declare objects we intend to use:
1148 * @skipline Evas_Object
1150 * Then a window is created, a title is set and its set to be autodeleted.
1151 * More details can be found on windows examples:
1152 * @until elm_win_autodel
1154 * Next a simple background is placed on our windows. More details on
1155 * @ref bg_01_example_page:
1156 * @until evas_object_show(bg)
1158 * Now, the exciting part, let's add the calendar with elm_calendar_add(),
1159 * passing our window object as parent.
1160 * @until evas_object_show(cal);
1162 * To conclude our example, we should show the window and run elm mainloop:
1165 * Our example will look like this:
1167 * @image html screenshots/calendar_example_01.png
1168 * @image latex screenshots/calendar_example_01.eps width=\textwidth
1170 * See the full source code @ref calendar_example_01.c here.
1171 * @example calendar_example_01.c
1175 * @page calendar_example_02 Calendar - Layout strings formatting.
1176 * @dontinclude calendar_example_02.c
1178 * In this simple example, we'll explain how to format the label displaying
1179 * month and year, and also set weekday names.
1181 * To format month and year label, we need to create a callback function
1182 * to create a string given the selected time, declared under a
1183 * <tt> struct tm </tt>.
1185 * <tt> struct tm </tt>, declared on @c time.h, is a structure composed by
1187 * @li tm_sec seconds [0,59]
1188 * @li tm_min minutes [0,59]
1189 * @li tm_hour hour [0,23]
1190 * @li tm_mday day of month [1,31]
1191 * @li tm_mon month of year [0,11]
1192 * @li tm_year years since 1900
1193 * @li tm_wday day of week [0,6] (Sunday = 0)
1194 * @li tm_yday day of year [0,365]
1195 * @li tm_isdst daylight savings flag
1196 * @note glib version has 2 additional fields.
1198 * For our function, only stuff that matters are tm_mon and tm_year.
1199 * But we don't need to access it directly, since there are nice functions
1200 * to format date and time, as @c strftime.
1201 * We will get abbreviated month (%b) and year (%y) (check strftime manpage
1202 * for more) in our example:
1203 * @skipline static char
1206 * We need to alloc the string to be returned, and calendar widget will
1207 * free it when it's not needed, what is done by @c strdup.
1208 * So let's register our callback to calendar object:
1209 * @skipline elm_calendar_format_function_set
1211 * To set weekday names, we should declare them as an array of strings:
1212 * @dontinclude calendar_example_02.c
1213 * @skipline weekdays
1216 * And finally set them to calendar:
1217 * skipline weekdays_names_set
1219 * Our example will look like this:
1221 * @image html screenshots/calendar_example_02.png
1222 * @image latex screenshots/calendar_example_02.eps width=\textwidth
1224 * See the full source code @ref calendar_example_02.c here.
1225 * @example calendar_example_02.c
1229 * @page calendar_example_03 Calendar - Years restrictions.
1230 * @dontinclude calendar_example_03.c
1232 * This example explains how to set max and min year to be displayed
1233 * by a calendar object. This means that user won't be able to
1234 * see or select a date before and after selected years.
1235 * By default, limits are 1902 and maximun value will depends
1236 * on platform architecture (year 2037 for 32 bits); You can
1237 * read more about time functions on @c ctime manpage.
1239 * Straigh to the point, to set it is enough to call
1240 * elm_calendar_min_max_year_set(). First value is minimun year, second
1241 * is maximum. If first value is negative, it won't apply limit for min
1242 * year, if the second one is negative, won't apply for max year.
1243 * Setting both to negative value will clear limits (default state):
1244 * @skipline elm_calendar_min_max_year_set
1246 * Our example will look like this:
1248 * @image html screenshots/calendar_example_03.png
1249 * @image latex screenshots/calendar_example_03.eps width=\textwidth
1251 * See the full source code @ref calendar_example_03.c here.
1252 * @example calendar_example_03.c
1256 * @page calendar_example_04 Calendar - Days selection.
1257 * @dontinclude calendar_example_04.c
1259 * It's possible to disable date selection and to select a date
1260 * from your program, and that's what we'll see on this example.
1262 * If isn't required that users could select a day on calendar,
1263 * only interacting going through months, disabling days selection
1264 * could be a good idea to avoid confusion. For that:
1265 * @skipline elm_calendar_day_selection_enabled_set
1267 * Also, regarding days selection, you could be interested to set a
1268 * date to be highlighted on calendar from your code, maybe when
1269 * a specific event happens, or after calendar creation. Let's select
1270 * two days from current day:
1271 * @dontinclude calendar_example_04.c
1272 * @skipline SECS_DAY
1273 * @skipline current_time
1274 * @until elm_calendar_selected_time_set
1276 * Our example will look like this:
1278 * @image html screenshots/calendar_example_04.png
1279 * @image latex screenshots/calendar_example_04.eps width=\textwidth
1281 * See the full source code @ref calendar_example_04.c here.
1282 * @example calendar_example_04.c
1286 * @page calendar_example_05 Calendar - Signal callback and getters.
1287 * @dontinclude calendar_example_05.c
1289 * Most of setters explained on previous examples have associated getters.
1290 * That's the subject of this example. We'll add a callback to display
1291 * all calendar information every time user interacts with the calendar.
1293 * Let's check our callback function:
1294 * @skipline static void
1295 * @until double interval;
1297 * To get selected day, we need to call elm_calendar_selected_time_get(),
1298 * but to assure nothing wrong happened, we must check for function return.
1299 * It'll return @c EINA_FALSE if fail. Otherwise we can use time set to
1300 * our structure @p stime.
1301 * @skipline elm_calendar_selected_time_get
1304 * Next we'll get information from calendar and place on declared vars:
1305 * @skipline interval
1306 * @until elm_calendar_weekdays_names_get
1308 * The only tricky part is that last line gets an array of strings
1309 * (char arrays), one for each weekday.
1311 * Then we can simple print that to stdin:
1315 * <tt> struct tm </tt> is declared on @c time.h. You can check @c ctime
1316 * manpage to read about it.
1318 * To register this callback, that will be called every time user selects
1319 * a day or goes to next or previous month, just add a callback for signal
1321 * @skipline evas_object_smart_callback_add
1323 * Our example will look like this:
1325 * @image html screenshots/calendar_example_05.png
1326 * @image latex screenshots/calendar_example_05.eps width=\textwidth
1328 * See the full source code @ref calendar_example_05.c here.
1329 * @example calendar_example_05.c
1333 * @page calendar_example_06 Calendar - Calendar marks.
1334 * @dontinclude calendar_example_06.c
1336 * On this example marks management will be explained. Functions
1337 * elm_calendar_mark_add(), elm_calendar_mark_del() and
1338 * elm_calendar_marks_clear() will be covered.
1340 * To add a mark, will be required to choose three things:
1342 * @li mark date, or start date if it will be repeated
1343 * @li mark periodicity
1345 * Style defines the kind of mark will be displayed over marked day,
1346 * on caledar. Default theme supports @b holiday and @b checked.
1347 * If more is required, is possible to set a new theme to calendar
1348 * widget using elm_object_style_set(), and use
1349 * the signal that will be used by such marks.
1351 * Date is a <tt> struct tm </tt>, as defined by @c time.h. More can
1352 * be read on @c ctime manpage.
1353 * If a date relative from current is required, this struct can be set
1355 * @skipline current_time
1356 * @until localtime_r
1358 * Or if it's an absolute date, you can just declare the struct like:
1359 * @dontinclude calendar_example_06.c
1361 * @until christmas.tm_mon
1363 * Periodicity is how frequently the mark will be displayed over the
1364 * calendar. Can be a unique mark (that don't repeat), or it can repeat
1365 * daily, weekly, monthly or annually. It's enumerated by
1366 * @c Elm_Calendar_Mark_Repeat.
1368 * So let's add some marks to our calendar. We will add christmas holiday,
1369 * set Sundays as holidays, and check current day and day after that.
1370 * @dontinclude calendar_example_06.c
1372 * @until christmas.tm_mon
1373 * @skipline current_time
1374 * @until ELM_CALENDAR_WEEKLY
1376 * We kept the return of first mark add, because we don't really won't it
1377 * to be checked, so let's remove it:
1378 * @skipline elm_calendar_mark_del
1380 * After all marks are added and removed, is required to draw them:
1381 * @skipline elm_calendar_marks_draw
1383 * Finally, to clear all marks, let's set a callback for our button:
1384 * @skipline elm_button_add
1385 * @until evas_object_show(bt);
1387 * This callback will receive our calendar object, and should clear it:
1388 * @dontinclude calendar_example_06.c
1391 * @note Remember to draw marks after clear the calendar.
1393 * Our example will look like this:
1395 * @image html screenshots/calendar_example_06.png
1396 * @image latex screenshots/calendar_example_06.eps width=\textwidth
1398 * See the full source code @ref calendar_example_06.c here.
1399 * @example calendar_example_06.c
1403 * @page clock_example Clock widget example
1405 * This code places five Elementary clock widgets on a window, each of
1406 * them exemplifying a part of the widget's API.
1408 * The first of them is the pristine clock:
1409 * @dontinclude clock_example.c
1411 * @until evas_object_show
1412 * As you see, the defaults for a clock are:
1414 * - no seconds shown
1416 * For am/pm time, see the second clock:
1417 * @dontinclude clock_example.c
1419 * @until evas_object_show
1421 * The third one will show the seconds digits, which will flip in
1422 * synchrony with system time. Note, besides, that the time itself is
1423 * @b different from the system's -- it was customly set with
1424 * elm_clock_time_set():
1425 * @dontinclude clock_example.c
1426 * @skip with seconds
1427 * @until evas_object_show
1429 * In both fourth and fifth ones, we turn on the <b>edition
1430 * mode</b>. See how you can change each of the sheets on it, and be
1431 * sure to try holding the mouse pressed over one of the sheet
1432 * arrows. The forth one also starts with a custom time set:
1433 * @dontinclude clock_example.c
1435 * @until evas_object_show
1437 * The fifth, besides editable, has only the time @b units editable,
1438 * for hours, minutes and seconds. This exemplifies
1439 * elm_clock_digit_edit_set():
1440 * @dontinclude clock_example.c
1442 * @until evas_object_show
1444 * See the full @ref clock_example.c "example", whose window should
1445 * look like this picture:
1447 * @image html screenshots/clock_example.png
1448 * @image latex screenshots/clock_example.eps width=\textwidth
1450 * See the full @ref clock_example_c "source code" for this example.
1452 * @example clock_example.c
1456 * @page diskselector_example_01 Diskselector widget example
1458 * This code places 4 Elementary diskselector widgets on a window, each of
1459 * them exemplifying a part of the widget's API.
1461 * All of them will have weekdays as items, since we won't focus
1462 * on items management on this example. For an example about this subject,
1463 * check @ref diskselector_example_02.
1465 * The first of them is a default diskselector.
1466 * @dontinclude diskselector_example_01.c
1469 * @skipline elm_diskselector_add
1470 * @until evas_object_show
1472 * We are just adding the diskselector, so as you can see, defaults for it are:
1473 * @li Only 3 items visible each time.
1474 * @li Only 3 characters are displayed for labels on side positions.
1475 * @li The first added item remains centeres, i.e., it's the selected item.
1477 * To add items, we are just appending it on a loop, using function
1478 * elm_diskselector_item_append(), that will be better exaplained on
1479 * items management example.
1481 * For a circular diskselector, check the second widget. A circular
1482 * diskselector will display first item after last, and last previous to
1483 * the first one. So, as you can see, @b Sa will appears on left side
1484 * of selected @b Sunday. This property is set with
1485 * elm_diskselector_round_set().
1487 * Also, we decide to display only 2 character for side labels, instead of 3.
1488 * For this we call elm_diskselector_side_label_length_set(). As result,
1489 * we'll see @b Mo displayed instead of @b Mon, when @b Monday is on a
1492 * @skipline elm_diskselector_add
1493 * @until evas_object_show
1495 * But so far, we are only displaying 3 items at once. If more are wanted,
1496 * is enough to call elm_diskselector_display_item_num_set(), as you can
1498 * @skipline elm_diskselector_add
1499 * @until evas_object_show
1501 * @note You can't set less than 3 items to be displayed.
1503 * Finally, if a bounce effect is required, or you would like to see
1504 * scrollbars, it is possible. But, for default theme, diskselector
1505 * scrollbars will be invisible anyway.
1506 * @skipline elm_diskselector_add
1507 * @until evas_object_show
1509 * See the full @ref diskselector_example_01.c "diskselector_example_01.c"
1510 * code, whose window should look like this picture:
1512 * @image html screenshots/diskselector_example_01.png
1513 * @image latex screenshots/diskselector_example_01.eps width=\textwidth
1515 * @example diskselector_example_01.c
1519 * @page diskselector_example_02 Diskselector - Items management
1521 * This code places a Elementary diskselector widgets on a window,
1522 * along with some buttons trigerring actions on it (though its API).
1523 * It covers most of Elm_Diskselector_Item functions.
1525 * On our @c main function, we are adding a default diskselector with
1526 * 3 items. We are only setting their labels (second parameter of function
1527 * elm_diskselector_item_append):
1528 * @dontinclude diskselector_example_02.c
1529 * @skipline elm_diskselector_add
1532 * Next we are adding lots of buttons, each one for a callback function
1533 * that will realize a task covering part of diskselector items API.
1534 * Lets check the first one:
1535 * @skipline elm_button_add
1536 * @until evas_object_show
1538 * We are labeling the button with a task description with
1539 * elm_object_text_set() and setting a callback
1540 * function evas_object_smart_callback_add().
1541 * Each callback function will have the signature:
1542 * <tt> static void _task_cb(void *data, Evas_Object *obj,
1543 * void *event_info)</tt> with the function name varying for each task.
1545 * Now let's cover all of them.
1547 * <b> Appending an item: </b>
1548 * @dontinclude diskselector_example_02.c
1552 * All items are included on diskselector after last one. You @b can't
1555 * The first parameter of elm_diskselector_item_append() is the diskselector
1556 * object, that we are receiving as data on our callback function.
1557 * The second one is a label, the string that will be placed in the center
1558 * of our item. As we don't wan't icons or callback functions, we can
1559 * send NULL as third, fourth and fifth parameters.
1561 * <b> Appending an item with icon: </b>
1562 * @dontinclude diskselector_example_02.c
1563 * @skipline _add_ic_cb
1566 * If an icon is required, you can pass it as third paramenter on our
1567 * elm_diskselector_item_append() function. It will be place on the
1568 * left side of item's label, that will be shifted to right a bit.
1570 * For more details about how to create icons, look for elm_icon examples.
1572 * <b> Appending an item with callback function for selected: </b>
1573 * @dontinclude diskselector_example_02.c
1578 * To set a callback function that will be called every time an item is
1579 * selected, i.e., everytime the diskselector stops with this item in
1580 * center position, just pass the function as fourth paramenter.
1582 * <b> Appending an item with callback function for selected with data: </b>
1583 * @dontinclude diskselector_example_02.c
1584 * @skipline _sel_data_cb
1590 * If the callback function request an extra data, it can be attached to our
1591 * item passing a pointer for data as fifth parameter.
1592 * Our function _sel_data_cb will receive it as <tt> void *data </tt>.
1594 * If you want to free this data, or handle that the way you need when the
1595 * item is deleted, set a callback function for that, with
1596 * elm_diskselector_item_del_cb_set().
1598 * As you can see we check if @c it is not @c NULL after appending it.
1599 * If an error happens, we won't try to set a function for it.
1601 * <b> Deleting an item: </b>
1602 * @dontinclude diskselector_example_02.c
1607 * To delete an item we simple need to call elm_diskselector_item_del() with
1608 * a pointer for such item.
1610 * If you need, you can get selected item with
1611 * elm_diskselector_selected_item_get(), that will return a pointer for it.
1613 * <b> Unselecting an item: </b>
1614 * @dontinclude diskselector_example_02.c
1615 * @skipline _unselect_cb
1618 * To select an item, you should call elm_diskselector_item_selected_set()
1619 * passing @c EINA_TRUE, and to unselect it, @c EINA_FALSE.
1621 * If you unselect the selected item, diskselector will automatically select
1624 * <b> Printing all items: </b>
1625 * @dontinclude diskselector_example_02.c
1626 * @skipline _print_cb
1629 * <b> Clearing the diskselector: </b>
1630 * @dontinclude diskselector_example_02.c
1631 * @skipline _clear_cb
1634 * <b> Selecting the first item: </b>
1635 * @dontinclude diskselector_example_02.c
1636 * @skipline _select_first_cb
1639 * <b> Selecting the last item: </b>
1640 * @dontinclude diskselector_example_02.c
1641 * @skipline _select_last_cb
1644 * <b> Selecting the next item: </b>
1645 * @dontinclude diskselector_example_02.c
1646 * @skipline _select_next_cb
1649 * <b> Selecting the previous item: </b>
1650 * @dontinclude diskselector_example_02.c
1651 * @skipline _select_prev_cb
1654 * See the full @ref diskselector_example_02.c "diskselector_example_02.c"
1655 * code, whose window should look like this picture:
1657 * @image html screenshots/diskselector_example_02.png
1658 * @image latex screenshots/diskselector_example_02.eps width=\textwidth
1660 * @example diskselector_example_02.c
1664 * @page list_example_01 List widget example
1666 * This code places a single Elementary list widgets on a window, just
1667 * to exemplify the more simple and common use case: a list will be created
1668 * and populated with a few items.
1670 * To keep it simple, we won't show how to customize the list, for this check
1671 * @ref list_example_02. Also, we won't focus
1672 * on items management on this example. For an example about this subject,
1673 * check @ref list_example_03.
1675 * To add a list widget.
1676 * @dontinclude list_example_01.c
1677 * @skipline elm_list_add
1679 * We are just adding the list, so as you can see, defaults for it are:
1680 * @li Items are displayed vertically.
1681 * @li Only one item can be selected.
1682 * @li The list doesn't bouce.
1684 * To add items, we are just appending it on a loop, using function
1685 * elm_list_item_append(), that will be better exaplained on
1686 * items management example.
1687 * @dontinclude list_example_01.c
1691 * @skipline elm_list_item_append
1693 * After we just want to show the list. But first we need to start the widget.
1694 * It was done this way to improve widget's performance. So, always remember
1696 * @warning Call elm_list_go before showing the object
1697 * @skipline elm_list_go
1700 * See the full @ref list_example_01.c "list_example_01.c"
1701 * code, whose window should look like this picture:
1703 * @image html screenshots/list_example_01.png
1704 * @image latex screenshots/list_example_01.eps width=\textwidth
1706 * @example list_example_01.c
1710 * @page list_example_02 List widget example
1712 * This code places a single Elementary list widgets on a window,
1713 * exemplifying a part of the widget's API.
1715 * First, we will just create a simple list, as done on @ref list_example_01 :
1716 * @dontinclude list_example_02.c
1719 * @skipline elm_list_add
1720 * @until elm_list_item_append
1722 * Now, let's customize this list a bit. First we will display items
1724 * @skipline horizontal_set
1726 * Then we will choose another list mode. There are four of them, and
1727 * the default #Elm_List_Mode is #ELM_LIST_SCROLL. Let's set compress mode:
1728 * @skipline mode_set
1730 * To enable multiple items selection, we need to enable it, since only one
1731 * selected item is allowed by default:
1732 * @skipline elm_list_multi_select_set
1734 * We are not adding items with callback functions here,
1735 * since we'll explain it better on @ref list_example_03. But if the callback
1736 * need to be called everytime user clicks an item, even if already selected,
1737 * it's required to enable this behavior:
1738 * @skipline elm_list_always_select_mode_set
1740 * Finally, if a bounce effect is required, or you would like to see
1741 * scrollbars, it is possible. But, for default theme, list
1742 * scrollbars will be invisible anyway.
1743 * @skipline bounce_set
1744 * @until SCROLLER_POLICY_ON
1746 * See the full @ref list_example_02.c "list_example_02.c"
1747 * code, whose window should look like this picture:
1749 * @image html screenshots/list_example_02.png
1750 * @image latex screenshots/list_example_02.eps width=\textwidth
1752 * @example list_example_02.c
1756 * @page list_example_03 List - Items management
1758 * This code places a Elementary list widgets on a window,
1759 * along with some buttons trigerring actions on it (though its API).
1760 * It covers most of Elm_List_Item functions.
1762 * On our @c main function, we are adding a default list with
1763 * 3 items. We are only setting their labels (second parameter of function
1764 * elm_list_item_append):
1765 * @dontinclude list_example_03.c
1766 * @skipline elm_list_add
1769 * Next we are adding lots of buttons, each one for a callback function
1770 * that will realize a task covering part of list items API.
1771 * Lets check the first one:
1772 * @skipline elm_button_add
1773 * @until evas_object_show
1775 * We are labeling the button with a task description with
1776 * elm_object_text_set() and setting a callback
1777 * function evas_object_smart_callback_add().
1778 * Each callback function will have the signature:
1779 * <tt> static void _task_cb(void *data, Evas_Object *obj,
1780 * void *event_info)</tt> with the function name varying for each task.
1782 * Now let's cover all of them.
1784 * <b> Prepending an item: </b>
1785 * @dontinclude list_example_03.c
1786 * @skipline _prepend_cb
1789 * The item will be placed on the begining of the list,
1790 * i.e. it will be the first one.
1792 * The first parameter of elm_list_item_prepend() is the list
1793 * object, that we are receiving as data on our callback function.
1794 * The second one is a label, the string that will be placed in the center
1795 * of our item. As we don't wan't icons or callback functions, we can
1796 * send NULL as third, fourth, fifth and sixth parameters.
1798 * <b> Appending an item: </b>
1799 * @dontinclude list_example_03.c
1803 * Items included with append will be inserted inserted after the last one.
1805 * <b> Appending an item with icon: </b>
1806 * @dontinclude list_example_03.c
1807 * @skipline _add_ic_cb
1810 * If an icon is required, you can pass it as third paramenter on our
1811 * elm_list_item_append() function. It will be place on the
1812 * left side of item's label. If an icon is wanted on the right side,
1813 * it should be passed as fourth parameter.
1815 * For more details about how to create icons, look for elm_icon examples
1816 * @ref tutorial_icon.
1818 * <b> Appending an item with callback function for selected: </b>
1819 * @dontinclude list_example_03.c
1824 * To set a callback function that will be called every time an item is
1825 * selected, i.e., everytime the list stops with this item in
1826 * center position, just pass the function as fifth paramenter.
1828 * <b> Appending an item with callback function for selected with data: </b>
1829 * @dontinclude list_example_03.c
1830 * @skipline _sel_data_cb
1836 * If the callback function request an extra data, it can be attached to our
1837 * item passing a pointer for data as sixth parameter.
1838 * Our function _sel_data_cb will receive it as <tt> void *data </tt>.
1840 * If you want to free this data, or handle that the way you need when the
1841 * item is deleted, set a callback function for that, with
1842 * elm_list_item_del_cb_set().
1844 * As you can see we check if @c it is not @c NULL after appending it.
1845 * If an error happens, we won't try to set a function for it.
1847 * <b> Deleting an item: </b>
1848 * @dontinclude list_example_03.c
1849 * @skipline _del_cb(
1852 * To delete an item we simple need to call elm_list_item_del() with
1853 * a pointer for such item.
1855 * If you need, you can get selected item with
1856 * elm_list_selected_item_get(), that will return a pointer for it.
1858 * <b> Unselecting an item: </b>
1859 * @dontinclude list_example_03.c
1860 * @skipline _unselect_cb
1863 * To select an item, you should call elm_list_item_selected_set()
1864 * passing @c EINA_TRUE, and to unselect it, @c EINA_FALSE.
1866 * <b> Printing all items: </b>
1867 * @dontinclude list_example_03.c
1868 * @skipline _print_cb
1871 * <b> Clearing the list: </b>
1872 * @dontinclude list_example_03.c
1873 * @skipline _clear_cb
1876 * <b> Selecting the next item: </b>
1877 * @dontinclude list_example_03.c
1878 * @skipline _select_next_cb
1881 * <b> Inserting after an item: </b>
1882 * @dontinclude list_example_03.c
1883 * @skipline _insert_after_cb
1886 * <b> Selecting the previous item: </b>
1887 * @dontinclude list_example_03.c
1888 * @skipline _select_prev_cb
1891 * <b> Inserting before an item: </b>
1892 * @dontinclude list_example_03.c
1893 * @skipline _insert_before_cb
1896 * If a separator is required, just set an item as such:
1897 * @dontinclude list_example_03.c
1898 * @skipline _set_separator_cb
1901 * Also an item can be disabled, and the user won't be allowed to (un)select it:
1902 * @dontinclude list_example_03.c
1903 * @skipline _disable_cb
1906 * See the full @ref list_example_03.c "list_example_03.c"
1907 * code, whose window should look like this picture:
1909 * @image html screenshots/list_example_03.png
1910 * @image latex screenshots/list_example_03.eps width=\textwidth
1912 * @example list_example_03.c
1916 * @page flipselector_example Flip selector widget example
1918 * This code places an Elementary flip selector widget on a window,
1919 * along with two buttons trigerring actions on it (though its API).
1921 * The selector is being populated with the following items:
1922 * @dontinclude flipselector_example.c
1926 * Next, we create it, populating it with those items and registering
1927 * two (smart) callbacks on it:
1928 * @dontinclude flipselector_example.c
1929 * @skip fp = elm_flipselector_add
1930 * @until object_show
1932 * Those two callbacks will take place whenever one of those smart
1933 * events occur, and they will just print something to @c stdout:
1934 * @dontinclude flipselector_example.c
1935 * @skip underflow callback
1936 * @until static void
1937 * Flip the sheets on the widget while looking at the items list, in
1938 * the source code, and you'll get the idea of those events.
1940 * The two buttons below the flip selector will take the actions
1941 * described in their labels:
1942 * @dontinclude flipselector_example.c
1943 * @skip bt = elm_button_add
1944 * @until callback_add(win
1946 * @dontinclude flipselector_example.c
1947 * @skip unselect the item
1950 * Click on them to exercise those flip selector API calls. To
1951 * interact with the other parts of this API, there's a command line
1952 * interface, whose help string can be asked for with the 'h' key:
1953 * @dontinclude flipselector_example.c
1957 * The 'n' and 'p' keys will exemplify elm_flipselector_flip_next()
1958 * and elm_flipselector_flip_prev(), respectively. 'f' and 'l' account
1959 * for elm_flipselector_first_item_get() and
1960 * elm_flipselector_last_item_get(), respectively. Finally, 's' will
1961 * issue elm_flipselector_selected_item_get() on our example flip
1964 * See the full @ref flipselector_example.c "example", whose window should
1965 * look like this picture:
1967 * @image html screenshots/flipselector_example.png
1968 * @image latex screenshots/flipselector_example.eps width=\textwidth
1970 * See the full @ref flipselector_example_c "source code" for this example.
1972 * @example flipselector_example.c
1976 * @page fileselector_example File selector widget example
1978 * This code places two Elementary file selector widgets on a window.
1979 * The one on the left is layouting file system items in a @b list,
1980 * while the the other is layouting them in a @b grid.
1982 * The one having the majority of hooks of interest is on the left,
1983 * which we create as follows:
1984 * @dontinclude fileselector_example.c
1985 * @skip first file selector
1986 * @until object_show
1988 * Note that we enable custom edition of file/directory selection, via
1989 * the text entry it has on its bottom, via
1990 * elm_fileselector_is_save_set(). It starts with the list view, which
1991 * is the default, and we make it not expandable in place
1992 * (elm_fileselector_expandable_set()), so that it replaces its view's
1993 * contents with the current directory's entries each time one
1994 * navigates to a different folder. For both of file selectors we are
1995 * starting to list the contents found in the @c "/tmp" directory
1996 * (elm_fileselector_path_set()).
1998 * Note the code setting it to "grid mode" and observe the differences
1999 * in the file selector's views, in the example. We also hide the
2000 * second file selector's Ok/Cancel buttons -- since it's there just
2001 * to show the grid view (and navigation) -- via
2002 * elm_fileselector_buttons_ok_cancel_set().
2004 * The @c "done" event, which triggers the callback below
2005 * @dontinclude fileselector_example.c
2008 * will be called at the time one clicks the "Ok"/"Cancel" buttons of
2009 * the file selector (on the left). Note that it will print the path
2010 * to the current selection, if any.
2012 * The @c "selected" event, which triggers the callback below
2013 * @dontinclude fileselector_example.c
2014 * @skip bt = 'selected' cb
2016 * takes place when one selects a file (if the file selector is @b not
2017 * under folders-only mode) or when one selects a folder (when in
2018 * folders-only mode). Experiment it by selecting different file
2021 * What comes next is the code creating the three check boxes and two
2022 * buttons below the file selector in the right. They will exercise a
2023 * bunch of functions on the file selector's API, for the instance on
2024 * the left. Experiment with them, specially the buttons, to get the
2025 * difference between elm_fileselector_path_get() and
2026 * elm_fileselector_selected_get().
2028 * Finally, there's the code adding the second file selector, on the
2030 * @dontinclude fileselector_example.c
2031 * @skip second file selector
2032 * @until object_show
2034 * Pay attention to the code setting it to "grid mode" and observe the
2035 * differences in the file selector's views, in the example. We also
2036 * hide the second file selector's Ok/Cancel buttons -- since it's
2037 * there just to show the grid view (and navigation) -- via
2038 * elm_fileselector_buttons_ok_cancel_set().
2040 * See the full @ref fileselector_example.c "example", whose window
2041 * should look like this picture:
2043 * @image html screenshots/fileselector_example.png
2044 * @image latex screenshots/fileselector_example.eps width=\textwidth
2046 * See the full @ref fileselector_example_c "source code" for this example.
2048 * @example fileselector_example.c
2052 * @page fileselector_button_example File selector button widget example
2054 * This code places an Elementary file selector button widget on a
2055 * window, along with some other checkboxes and a text entry. Those
2056 * are there just as knobs on the file selector button's state and to
2057 * display information from it.
2059 * Here's how we instantiate it:
2060 * @dontinclude fileselector_button_example.c
2061 * @skip ic = elm_icon_add
2062 * @until evas_object_show
2064 * Note that we set on it both icon and label decorations. It's set to
2065 * list the contents of the @c "/tmp" directory, too, with
2066 * elm_fileselector_button_path_set(). What follows are checkboxes to
2067 * exercise some of its API funtions:
2068 * @dontinclude fileselector_button_example.c
2069 * @skip ck = elm_check_add
2070 * @until evas_object_show(en)
2072 * The checkboxes will toggle whether the file selector button's
2073 * internal file selector:
2074 * - must have an editable text entry for file names (thus, be in
2075 * "save dialog mode")
2076 * - is to be raised as an "inner window" (note it's the default
2077 * behavior) or as a dedicated window
2078 * - is to populate its view with folders only
2079 * - is to expand its folders, in its view, <b>in place</b>, and not
2080 * repainting it entirely just with the contents of a sole
2083 * The entry labeled @c "Last selection" will exercise the @c
2084 * "file,chosen" smart event coming from the file selector button:
2085 * @dontinclude fileselector_button_example.c
2087 * @until toggle inwin
2089 * Whenever you dismiss or acknowledges the file selector, after it's
2090 * raised, the @c event_info string will contain the last selection on
2091 * it (if any was made).
2093 * This is how the example, just after called, should look like:
2095 * @image html screenshots/fileselector_button_example_00.png
2096 * @image latex screenshots/fileselector_button_example_00.eps width=\textwidth
2098 * Click on the file selector button to raise its internal file
2099 * selector, which will be contained on an <b>"inner window"</b>:
2101 * @image html screenshots/fileselector_button_example_01.png
2102 * @image latex screenshots/fileselector_button_example_01.eps width=\textwidth
2104 * Toggle the "inwin mode" switch off and, if you click on the file
2105 * selector button again, you'll get @b two windows, the original one
2106 * (note the last selection there!)
2108 * @image html screenshots/fileselector_button_example_02.png
2109 * @image latex screenshots/fileselector_button_example_02.eps width=\textwidth
2111 * and the file selector's new one
2113 * @image html screenshots/fileselector_button_example_03.png
2114 * @image latex screenshots/fileselector_button_example_03.eps width=\textwidth
2116 * Play with the checkboxes to get the behavior changes on the file
2117 * selector button. The respective API calls on the widget coming from
2118 * those knobs where shown in the code already.
2120 * See the full @ref fileselector_button_example_c "source code" for
2123 * @example fileselector_button_example.c
2127 * @page fileselector_entry_example File selector entry widget example
2129 * This code places an Elementary file selector entry widget on a
2130 * window, along with some other checkboxes. Those are there just as
2131 * knobs on the file selector entry's state.
2133 * Here's how we instantiate it:
2134 * @dontinclude fileselector_entry_example.c
2135 * @skip ic = elm_icon_add
2136 * @until evas_object_show
2138 * Note that we set on it's button both icon and label
2139 * decorations. It's set to exhibit the path of (and list the contents
2140 * of, when internal file selector is launched) the @c "/tmp"
2141 * directory, also, with elm_fileselector_entry_path_set(). What
2142 * follows are checkboxes to exercise some of its API funtions:
2143 * @dontinclude fileselector_entry_example.c
2144 * @skip ck = elm_check_add
2145 * @until callback_add(fs_entry
2147 * The checkboxes will toggle whether the file selector entry's
2148 * internal file selector:
2149 * - must have an editable text entry for file names (thus, be in
2150 * "save dialog mode")
2151 * - is to be raised as an "inner window" (note it's the default
2152 * behavior) or as a dedicated window
2153 * - is to populate its view with folders only
2154 * - is to expand its folders, in its view, <b>in place</b>, and not
2155 * repainting it entirely just with the contents of a sole
2158 * Observe how the entry's text will match the string coming from the
2159 * @c "file,chosen" smart event:
2160 * @dontinclude fileselector_entry_example.c
2163 * Whenever you dismiss or acknowledges the file selector, after it's
2164 * raised, the @c event_info string will contain the last selection on
2165 * it (if any was made).
2167 * Try, also, to type in a valid system path and, then, open the file
2168 * selector's window: it will start the file browsing there, for you.
2170 * This is how the example, just after called, should look like:
2172 * @image html screenshots/fileselector_entry_example_00.png
2173 * @image latex screenshots/fileselector_entry_example_00.eps width=\textwidth
2175 * Click on the file selector entry to raise its internal file
2176 * selector, which will be contained on an <b>"inner window"</b>:
2178 * @image html screenshots/fileselector_entry_example_01.png
2179 * @image latex screenshots/fileselector_entry_example_01.eps width=\textwidth
2181 * Toggle the "inwin mode" switch off and, if you click on the file
2182 * selector entry again, you'll get @b two windows, the original one
2183 * (note the last selection there!)
2185 * @image html screenshots/fileselector_entry_example_02.png
2186 * @image latex screenshots/fileselector_entry_example_02.eps width=\textwidth
2188 * and the file selector's new one
2190 * @image html screenshots/fileselector_entry_example_03.png
2191 * @image latex screenshots/fileselector_entry_example_03.eps width=\textwidth
2193 * Play with the checkboxes to get the behavior changes on the file
2194 * selector entry. The respective API calls on the widget coming from
2195 * those knobs where shown in the code already.
2197 * See the full @ref fileselector_entry_example_c "source code" for
2200 * @example fileselector_entry_example.c
2204 * @page layout_example_01 Layout - Content, Table and Box
2206 * This example shows how one can use the @ref Layout widget to create a
2207 * customized distribution of widgets on the screen, controled by an Edje theme.
2208 * The full source code for this example can be found at @ref
2209 * layout_example_01_c.
2211 * Our custom layout is defined by a file, @ref layout_example_edc, which is an
2212 * Edje theme file. Look for the Edje documentation to understand it. For now,
2213 * it's enough to know that we describe some specific parts on this layout
2215 * @li a title text field;
2216 * @li a box container;
2217 * @li a table container;
2218 * @li and a content container.
2220 * Going straight to the code, the following snippet instantiates the layout
2223 * @dontinclude layout_example_01.c
2224 * @skip elm_layout_add
2225 * @until evas_object_show(layout)
2227 * As any other widget, we set some properties for the size calculation. But
2228 * notice on this piece of code the call to the function elm_layout_file_set().
2229 * Here is where the theme file is loaded, and particularly the specific group
2230 * from this theme file. Also notice that the theme file here is referenced as
2231 * an .edj, which is a .edc theme file compiled to its binary form. Again, look
2232 * for the Edje documentation for more information about theme files.
2234 * Next, we fetch from our theme a data string referenced by the key "title".
2235 * This data was defined in the theme, and can be used as parameters which the
2236 * program get from the specific theme that it is using. In this case, we store
2237 * the title of this window and program in the theme, as a "data" entry, just
2238 * for demonstration purposes:
2242 * This call elm_layout_data_get() is used to fetch the string based on the key,
2243 * and elm_object_text_part_set() will set the part defined in the theme as
2244 * "example/title" to contain this string. This key "example/title" has nothing
2245 * special. It's just an arbitrary convention that we are using in this example.
2246 * Every string in this example referencing a part of this theme will be of the
2247 * form "example/<something>".
2249 * Now let's start using our layout to distribute things on the window space.
2250 * Since the layout was added as a resize object to the elementary window, it
2251 * will always occupy the entire space available for this window.
2253 * The theme already has a title, and it also defines a table element which is
2254 * positioned approximately between 50% and 70% of the height of this window,
2255 * and has 100% of the width. We create some widgets (two icons, a clock and a
2256 * button) and pack them inside the table, in a distribution similar to a HTML
2259 * @until evas_object_show(bt)
2261 * Notice that we just set size hints for every object, and call the function
2262 * elm_layout_table_pack(), which does all the work. It will place the elements
2263 * in the specified row/column, with row and column span if required, and then
2264 * the object's size and position will be controled by the layout widget. It
2265 * will also respect size hints, alignments and weight properties set to these
2266 * widgets. The resulting distribution on the screen depends on the table
2267 * properties (described in the theme), the size hints set on each widget, and
2268 * on the cells of the table that are being used.
2270 * For instance, we add the two icons and the clock on the first, second and
2271 * third cells of the first row, and add the button the second row, making it
2272 * span for 3 columns (thus having the size of the entire table width). This
2273 * will result in a table that has 2 rows and 3 columns.
2275 * Now let's add some widgets to the box area of our layout. This box is around
2276 * 20% and 50% of the vertical size of the layout, and 100% of its width. The
2277 * theme defines that it will use an "horizontal flow" distribution to its
2278 * elements. Unlike the table, a box will distribute elements without knowing
2279 * about rows and columns, and the distribution function selected will take care
2280 * of putting them in row, column, both, or any other available layout. This is
2281 * also described in the Edje documentation.
2283 * This box area is similar to the @ref Box widget of elementary, with the
2284 * difference that its position and properties are controled by the theme of the
2285 * layout. It also contains more than one API to add items to it, since the
2286 * items position now is defined in terms of a list of items, not a matrix.
2287 * There's the first position (can have items added to it with
2288 * elm_layout_box_prepend()), the last position (elm_layout_box_append()), the
2289 * nth position (elm_layout_box_insert_at()) and the position right before an
2290 * element (elm_layout_box_insert_before()). We use insert_at and prepend
2291 * functions to add the first two buttons to this box, and insert_before on the
2292 * callback of each button. The callback code will be shown later, but it
2293 * basically adds a button just before the clicked button using the
2294 * elm_layout_box_insert_before() function. Here's the code for adding the first
2297 * @until evas_object_show(item)
2298 * @until evas_object_show(item)
2300 * Finally, we have an area in this layout theme, in the bottom part of it,
2301 * reserved for adding an specific widget. Differently from the 2 parts
2302 * described until now, this one can only receive one widget with the call
2303 * elm_layout_content_set(). If there was already an item on this specific part,
2304 * it will be deleted (one can use elm_layout_content_unset() in order to remove
2305 * it without deleting). An example of removing it without deleting, but
2306 * manually deleting this widget just after that, can be seen on the callback
2307 * for this button. Actually, the callback defined for this button will clean
2308 * the two other parts (deleting all of their elements) and then remove and
2309 * delete this button.
2311 * @until _swallow_btn_cb
2313 * Also notice that, for this last added button, we don't have to call
2314 * evas_object_show() on it. This is a particularity of the theme for layouts,
2315 * that will have total control over the properties like size, position,
2316 * visibility and clipping of a widget added with elm_layout_content_set().
2317 * Again, read the Edje documentation to understand this better.
2319 * Now we just put the code for the different callbacks specified for each kind
2320 * of button and make simple comments about them:
2322 * @dontinclude layout_example_01.c
2324 * @until evas_object_del(item)
2327 * The first callback is used for the button in the table, and will just remove
2328 * itself from the table with elm_layout_table_unpack(), which remove items
2329 * without deleting them, and then calling evas_object_del() on itself.
2331 * The second callback is for buttons added to the box. When clicked, these
2332 * buttons will create a new button, and add them to the same box, in the
2333 * position just before the clicked button.
2335 * And the last callback is for the button added to the "content" area. It will
2336 * clear both the table and the box, passing @c EINA_TRUE to their respective @c
2337 * clear parameters, which will imply on the items of these containers being
2340 * A screenshot of this example can be seen on:
2342 * @image html screenshots/layout_example_01.png
2343 * @image latex screenshots/layout_example_01.eps width=\textwidth
2348 * @page layout_example_02 Layout - Predefined Layout
2350 * This example shows how one can use the @ref Layout with a predefined theme
2351 * layout to add a back and next button to a simple window. The full source code
2352 * for this example can be found at @ref layout_example_02_c.
2354 * After setting up the window and background, we add the layout widget to the
2355 * window. But instead of using elm_layout_file_set() to load its theme from a
2356 * custom theme file, we can use elm_layout_theme_set() to load one of the
2357 * predefined layouts that come with elementary. Particularly on this example,
2358 * we load the them of class "layout", group "application" and style
2359 * "content-back-next" (since we want the back and next buttons).
2361 * @dontinclude layout_example_02.c
2362 * @skip elm_layout_add
2363 * @until evas_object_show(layout)
2365 * This default theme contains only a "content" area named
2366 * "elm.swallow.content", where we can add any widget (it can be even a
2367 * container widget, like a box, frame, list, or even another layout). Since we
2368 * just want to show the resulting layout, we add a simple icon to it:
2370 * @until layout_content_set
2372 * This default layout also provides some signals when the next and prev buttons
2373 * are clicked. We can register callbacks to them with the
2374 * elm_object_signal_callback_add() function:
2376 * @until elm,action,next
2378 * In the @ref layout_example_03 you can see how to send signals to the layout with
2379 * elm_object_signal_emit().
2381 * Now our callback just changes the picture being displayed when one of the
2382 * buttons are clicked:
2384 * @dontinclude layout_example_02.c
2386 * @until standard_set
2389 * It's possible to see that it gets the name of the image being shown from the
2390 * array of image names, going forward on this array when "next" is clicked and
2391 * backward when "back" is clicked.
2393 * A screenshot of this example can be seen on:
2395 * @image html screenshots/layout_example_02.png
2396 * @image latex screenshots/layout_example_02.eps width=\textwidth
2400 * @page layout_example_03 Layout - Signals and Size Changed
2402 * This example shows how one can send and receive signals to/from the layout,
2403 * and what to do when the layout theme has its size changed. The full source
2404 * code for this example can be found at @ref layout_example_03_c.
2406 * In this exmaple we will use another group from the same layout theme file
2407 * used in @ref layout_example_01. Its instanciation and loading happens in the
2410 * @dontinclude layout_example_03.c
2411 * @skip elm_layout_add
2412 * @until evas_object_show
2414 * This time we register a callback to be called whenever we receive a signal
2415 * after the end of the animation that happens in this layout:
2417 * @until signal_callback_add
2419 * We also add a button that will send signals to the layout:
2421 * @until callback_add
2423 * The callback for this button will check what type of signal it should send,
2424 * and then emit it. The code for this callback follows:
2426 * @dontinclude layout_exmaple_03.c
2427 * @skip static Eina_Bool
2432 * As we said before, we are receiving a signal whenever the animation started
2433 * by the button click ends. This is the callback for that signal:
2437 * Notice from this callback that the elm_layout_sizing_eval() function must be
2438 * called if we want our widget to update its size after the layout theme having
2439 * changed its minimum size. This happens because the animation specified in the
2440 * theme increases the size of the content area to a value higher than the
2441 * widget size, thus requiring more space. But the elementary layout widget
2442 * has no way to know this, thus needing the elm_layout_sizing_eval() to
2443 * be called on the layout, informing that this size has changed.
2445 * A screenshot of this example can be seen on:
2447 * @image html screenshots/layout_example_03.png
2448 * @image latex screenshots/layout_example_03.eps width=\textwidth
2452 * @page tutorial_hover Hover example
2453 * @dontinclude hover_example_01.c
2455 * On this example we are going to have a button that when clicked will show our
2456 * hover widget, this hover will have content set on it's left, top, right and
2457 * middle positions. In the middle position we are placing a button that when
2458 * clicked will hide the hover. We are also going to use a non-default theme
2459 * for our hover. We won't explain the functioning of button for that see @ref
2462 * We start our example with a couple of callbacks that show and hide the data
2463 * they're given(which we'll see later on is the hover widget):
2468 * In our main function we'll do some initialization and then create 3
2469 * rectangles, one red, one green and one blue to use in our hover. We'll also
2470 * create the 2 buttons that will show and hide the hover:
2473 * With all of that squared away we can now get to the heart of the matter,
2474 * creating our hover widget, which is easy as pie:
2477 * Having created our hover we now need to set the parent and target. Which if
2478 * you recall from the function documentations are going to tell the hover which
2479 * area it should cover and where it should be centered:
2482 * Now we set the theme for our hover. We're using the popout theme which gives
2483 * our contents a white background and causes their appearance to be animated:
2486 * And finally we set the content for our positions:
2489 * So far so good? Great 'cause that's all there is too it, what is left now is
2490 * just connecting our buttons to the callbacks we defined at the beginning of
2491 * the example and run the main loop:
2494 * Our example will initially look like this:
2496 * @image html screenshots/hover_example_01.png
2497 * @image latex screenshots/hover_example_01.eps width=\textwidth
2499 * And after you click the "Show hover" button it will look like this:
2501 * @image html screenshots/hover_example_01_a.png
2502 * @image latex screenshots/hover_example_01_a.eps width=\textwidth
2504 * @example hover_example_01.c
2508 * @page tutorial_flip Flip example
2509 * @dontinclude flip_example_01.c
2511 * This example will show a flip with two rectangles on it(one blue, one
2512 * green). Our example will allow the user to choose the animation the flip
2513 * uses and to interact with it. To allow the user to choose the interaction
2514 * mode we use radio buttons, we will however not explain them, if you would
2515 * like to know more about radio buttons see @ref radio.
2517 * We start our example with the usual setup and then create the 2 rectangles
2518 * we will use in our flip:
2519 * @until show(rect2)
2521 * The next thing to do is to create our flip and set it's front and back
2525 * The next thing we do is set the interaction mode(which the user can later
2526 * change) to the page animation:
2529 * Setting a interaction mode however is not sufficient, we also need to
2530 * choose which directions we allow interaction from, for this example we
2531 * will use all of them:
2534 * We are also going to set the hitsize to the entire flip(in all directions)
2535 * to make our flip very easy to interact with:
2538 * After that we create our radio buttons and start the main loop:
2541 * When the user clicks a radio button a function that changes the
2542 * interaction mode and animates the flip is called:
2544 * @note The elm_flip_go() call here serves no purpose other than to
2545 * ilustrate that it's possible to animate the flip programmatically.
2547 * Our example will look like this:
2549 * @image html screenshots/flip_example_01.png
2550 * @image latex screenshots/flip_example_01.eps width=\textwidth
2552 * @note Since this is an animated example the screenshot doesn't do it
2553 * justice, it is a good idea to compile it and see the animations.
2555 * @example flip_example_01.c
2559 * @page tutorial_label Label example
2560 * @dontinclude label_example_01.c
2562 * In this example we are going to create 6 labels, set some properties on
2563 * them and see what changes in appearance those properties cause.
2565 * We start with the setup code that by now you should be familiar with:
2568 * For our first label we have a moderately long text(that doesn't fit in the
2569 * label's width) so we will make it a sliding label. Since the text isn't
2570 * too long we don't need the animation to be very long, 3 seconds should
2571 * give us a nice speed:
2574 * For our second label we have the same text, but this time we aren't going
2575 * to have it slide, we're going to ellipsize it. Because we ask our label
2576 * widget to ellipsize the text it will first diminsh the fontsize so that it
2577 * can show as much of the text as possible:
2580 * For the third label we are going to ellipsize the text again, however this
2581 * time to make sure the fontsize isn't diminshed we will set a line wrap.
2582 * The wrap won't actually cause a line break because we set the label to
2586 * For our fourth label we will set line wrapping but won't set ellipsis, so
2587 * that our text will indeed be wrapped instead of ellipsized. For this label
2588 * we choose character wrap:
2591 * Just two more, for our fifth label we do the same as for the fourth
2592 * except we set the wrap to word:
2595 * And last but not least for our sixth label we set the style to "marker" and
2596 * the color to red(the default color is white which would be hard to see on
2597 * our white background):
2600 * Our example will look like this:
2602 * @image html screenshots/label_example_01.png
2603 * @image latex screenshots/label_example_01.eps width=\textwidth
2605 * @example label_example_01.c
2609 * @page tutorial_image Image example
2610 * @dontinclude image_example_01.c
2612 * This example is as simple as possible. An image object will be added to the
2613 * window over a white background, and set to be resizeable together with the
2614 * window. All the options set through the example will affect the behavior of
2617 * We start with the code for creating a window and its background, and also
2618 * add the code to write the path to the image that will be loaded:
2623 * Now we create the image object, and set that file to be loaded:
2627 * We can now go setting our options.
2629 * elm_image_no_scale_set() is used just to set this value to true (we
2630 * don't want to scale our image anyway, just resize it).
2632 * elm_image_scale_set() is used to allow the image to be resized to a size
2633 * smaller than the original one, but not to a size bigger than it.
2635 * elm_elm_image_smooth_set() will disable the smooth scaling, so the scale
2636 * algorithm used to scale the image to the new object size is going to be
2637 * faster, but with a lower quality.
2639 * elm_image_orient_set() is used to flip the image around the (1, 0) (0, 1)
2642 * elm_image_aspect_ratio_retained_set() is used to keep the original aspect
2643 * ratio of the image, even when the window is resized to another aspect ratio.
2645 * elm_image_fill_outside_set() is used to ensure that the image will fill the
2646 * entire area available to it, even if keeping the aspect ratio. The image
2647 * will overflow its width or height (any of them that is necessary) to the
2648 * object area, instead of resizing the image down until it can fit entirely in
2651 * elm_image_editable_set() is used just to cover the API, but won't affect
2652 * this example since we are not using any copy & paste property.
2654 * This is the code for setting these options:
2658 * Now some last touches in our object size hints, window and background, to
2659 * display this image properly:
2663 * This example will look like this:
2665 * @image html screenshots/image_example_01.png
2666 * @image latex screenshots/image_example_01.eps width=\textwidth
2668 * @example image_example_01.c
2672 * @page tutorial_icon Icon example
2673 * @dontinclude icon_example_01.c
2675 * This example is as simple as possible. An icon object will be added to the
2676 * window over a white background, and set to be resizeable together with the
2677 * window. All the options set through the example will affect the behavior of
2680 * We start with the code for creating a window and its background:
2685 * Now we create the icon object, and set lookup order of the icon, and choose
2690 * An intersting thing is that after setting this, it's possible to check where
2691 * in the filesystem is the theme used by this icon, and the name of the group
2696 * We can now go setting our options.
2698 * elm_icon_no_scale_set() is used just to set this value to true (we
2699 * don't want to scale our icon anyway, just resize it).
2701 * elm_icon_scale_set() is used to allow the icon to be resized to a size
2702 * smaller than the original one, but not to a size bigger than it.
2704 * elm_elm_icon_smooth_set() will disable the smooth scaling, so the scale
2705 * algorithm used to scale the icon to the new object size is going to be
2706 * faster, but with a lower quality.
2708 * elm_icon_fill_outside_set() is used to ensure that the icon will fill the
2709 * entire area available to it, even if keeping the aspect ratio. The icon
2710 * will overflow its width or height (any of them that is necessary) to the
2711 * object area, instead of resizing the icon down until it can fit entirely in
2714 * This is the code for setting these options:
2716 * @until fill_outside
2718 * However, if you try this example you may notice that this image is not being
2719 * affected by all of these options. This happens because the used icon will be
2720 * from elementary theme, and thus it has its own set of options like smooth
2721 * scaling and fill_outside options. You can change the "home" icon to use some
2722 * image (from your system) and see that then those options will be respected.
2724 * Now some last touches in our object size hints, window and background, to
2725 * display this icon properly:
2729 * This example will look like this:
2731 * @image html screenshots/icon_example_01.png
2732 * @image latex screenshots/icon_example_01.eps width=\textwidth
2734 * @example icon_example_01.c
2738 * @page tutorial_hoversel Hoversel example
2739 * @dontinclude hoversel_example_01.c
2741 * In this example we will create a hoversel with 3 items, one with a label but
2742 * no icon and two with both a label and an icon. Every item that is clicked
2743 * will be deleted, but everytime the hoversel is activated we will also add an
2744 * item. In addition our first item will print all items when clicked and our
2745 * third item will clear all items in the hoversel.
2747 * We will start with the normal creation of window stuff:
2750 * Next we will create a red rectangle to use as the icon of our hoversel:
2753 * And now we create our hoversel and set some of it's properties. We set @p win
2754 * as its parent, ask it to not be horizontal(be vertical) and give it a label
2758 * Next we will add our three items, setting a callback to be called for the
2762 * We also set a pair of callbacks to be called whenever any item is selected or
2763 * when the hoversel is activated:
2766 * And then ask that our hoversel be shown and run the main loop:
2769 * We now have the callback for our first item which prints all items in the
2773 * Next we have the callback for our third item which removes all items from the
2777 * Next we have the callback that is called whenever an item is clicked and
2778 * deletes that item:
2781 * And the callback that is called when the hoversel is activated and adds an
2782 * item to the hoversel. Note that since we allocate memory for the item we need
2783 * to know when the item dies so we can free that memory:
2786 * And finally the callback that frees the memory we allocated for items created
2787 * in the @p _add_item callback:
2790 * Our example will initially look like this:
2792 * @image html screenshots/hoversel_example_01.png
2793 * @image latex screenshots/hoversel_example_01.eps width=\textwidth
2795 * And when the hoversel is clicked it will look like this:
2797 * @image html screenshots/hoversel_example_01_a.png
2798 * @image latex screenshots/hoversel_example_01_a.eps width=\textwidth
2800 * @example hoversel_example_01.c
2804 * @page conformant_example Conformant Example.
2806 * In this example we'll explain how to create applications to work
2807 * with illume, considering space required for virtual keyboards, indicator
2810 * Illume is a module for Enlightenment that modifies the user interface
2811 * to work cleanly and nicely on a mobile device. It has support for
2812 * virtual keyboard, among other nice features.
2814 * Let's start creating a very simple window with a vertical box
2815 * with multi-line entry between two buttons.
2816 * This entry will expand filling all space on window not used by buttons.
2818 * @dontinclude conformant_example_01.c
2819 * @skipline elm_main
2822 * For information about how to create windows, boxes, buttons or entries,
2823 * look for documentation for these widgets.
2825 * It will looks fine when you don't need a virtual keyboard, as you
2826 * can see on the following image:
2828 * @image html screenshots/conformant_example_01.png
2829 * @image latex screenshots/conformant_example_01.eps width=\textwidth
2831 * But if you call a virtual keyboard, the window will resize, changing
2832 * widgets size and position. All the content will shrink.
2834 * If you don't want such behaviour, you
2835 * will need a conformant to account for space taken up by the indicator,
2836 * virtual keyboard and softkey.
2838 * In this case, using the conformant in a proper way, you will have
2839 * a window like the following:
2841 * @image html screenshots/conformant_example_02.png
2842 * @image latex screenshots/conformant_example_02.eps width=\textwidth
2844 * As you can see, it guess the space that will be required by the keyboard,
2845 * indicator and softkey bars.
2847 * So, let's study each step required to transform our initial example on
2850 * First of all, we need to set the window as an illume conformant window:
2851 * @dontinclude conformant_example_02.c
2852 * @skipline elm_win_conformant_set
2854 * Next, we'll add a conformant widget, and set it to resize with the window,
2855 * instead of the box.
2857 * @until evas_object_show
2859 * Finally, we'll set the box as conformant's content, just like this:
2860 * @skipline elm_conformant_content_set
2862 * Compare both examples code:
2863 * @ref conformant_example_01.c "conformant_example_01.c"
2864 * @ref conformant_example_02.c "conformant_example_02.c"
2866 * @example conformant_example_01.c
2867 * @example conformant_example_02.c
2871 * @page index_example_01 Index widget example 1
2873 * This code places an Elementary index widget on a window, which also
2874 * has a very long list of arbitrary strings on it. The list is
2875 * sorted alphabetically and the index will be used to index the first
2876 * items of each set of strings beginning with an alphabet letter.
2878 * Below the list are some buttons, which are there just to exercise
2879 * some index widget's API.
2881 * Here's how we instantiate it:
2882 * @dontinclude index_example_01.c
2883 * @skip elm_list_add
2884 * @until evas_object_show(d.index)
2885 * where we're showing also the list being created. Note that we issue
2886 * elm_win_resize_object_add() on the index, so that it's set to have
2887 * the whole window as its container. Then, we have to populate both
2888 * list and index widgets:
2889 * @dontinclude index_example_01.c
2890 * @skip for (i = 0; i < (sizeof(dict) / sizeof(dict[0])); i++)
2894 * The strings populating the list come from a file
2895 * @dontinclude index_example_01.c
2896 * @skip static const char *dict
2899 * We use the @c curr char variable to hold the last initial letter
2900 * seen on that ordered list of strings, so that we're able to have an
2901 * index item pointing to each list item starting a new letter
2902 * "section". Note that our index item data pointers will be the list
2903 * item handles. We are also setting a callback function to index
2904 * items deletion events:
2905 * @dontinclude index_example_01.c
2909 * There, we show you that the @c event_info pointer will contain the
2910 * item in question's data, i.e., a given list item's pointer. Because
2911 * item data is also returned in the @c data argument on
2912 * @c Evas_Smart_Cb functions, those two pointers must have the same
2913 * values. On this deletion callback, we're deleting the referred list
2914 * item too, just to exemplify that anything could be done there.
2916 * Next, we hook to two smart events of the index object:
2917 * @dontinclude index_example_01.c
2918 * @skip smart_callback_add(d.index
2919 * @until _index_selected
2920 * @dontinclude index_example_01.c
2921 * @skip "delay,changed" hook
2925 * Check that, whenever one holds the mouse pressed over a given index
2926 * letter for some time, the list beneath it will roll down to the
2927 * item pointed to by that index item. When one releases the mouse
2928 * button, the second callback takes place. There, we check that the
2929 * reported item data, on @c event_info, is the same reported by
2930 * elm_index_item_selected_get(), which gives the last selection's
2931 * data on the index widget.
2933 * The first of the three buttons that follow will call
2934 * elm_index_active_set(), thus showing the index automatically for
2935 * you, if it's not already visible, what is checked with
2936 * elm_index_active_get(). The second button will exercise @b deletion
2937 * of index item objects, by the following code:
2938 * @dontinclude index_example_01.c
2939 * @skip delete an index item
2942 * It will get the last index item selected's data and find the
2943 * respective #Elm_Index_Item handle with elm_index_item_find(). We
2944 * need the latter to query the indexing letter string from, with
2945 * elm_index_item_letter_get(). Next, comes the delition, itself,
2946 * which will also trigger the @c _index_item_del callback function,
2949 * The third button, finally, will exercise elm_index_item_clear(),
2950 * which will delete @b all of the index's items.
2952 * This is how the example program's window looks like with the index
2954 * @image html screenshots/index_example_00.png
2955 * @image latex screenshots/index_example_00.eps
2957 * When it's shown, it's like the following figure:
2958 * @image html screenshots/index_example_01.png
2959 * @image latex screenshots/index_example_01.eps
2961 * See the full @ref index_example_01_c "source code" for
2964 * @example index_example_01.c
2968 * @page index_example_02 Index widget example 2
2970 * This code places an Elementary index widget on a window, indexing
2971 * grid items. The items are placed so that their labels @b don't
2972 * follow any order, but the index itself is ordered (through
2973 * elm_index_item_sorted_insert()). This is a complement to to @ref
2974 * index_example_01 "the first example on indexes".
2976 * Here's the list of item labels to be used on the grid (in that
2978 * @dontinclude index_example_02.c
2979 * @skip static const char *items
2982 * In the interesting part of the code, here, we first instantiate the
2983 * grid (more on grids on their examples) and, after creating our
2984 * index, for each grid item we also create an index one to reference
2986 * @dontinclude index_example_02.c
2987 * @skip grid = elm_gengrid_add
2989 * @until smart_callback_add
2991 * The order in which they'll appear in the index, though, is @b
2992 * alphabetical, becase of elm_index_item_sorted_insert() usage
2993 * together with the comparing function, where we take the letters of
2994 * each index item to base our ordering on. The parameters on
2995 * @c _index_cmp have to be declared as void pointers because of the
2996 * @c Eina_Compare_Cb prototype requisition, but in this case we know
2997 * they'll be #Elm_Index_Item's:
2998 * @dontinclude index_example_02.c
2999 * @skip ordering alphabetically
3002 * The last interesting bit is the callback in the @c "delay,changed"
3003 * smart event, which will bring the given grid item to the grid's
3005 * @dontinclude index_example_02.c
3009 * Note how the grid will move kind of randomly while you move your
3010 * mouse pointer held over the index from top to bottom -- that's
3011 * because of the the random order the items have in the grid itself.
3013 * This is how the example program's window looks like:
3014 * @image html screenshots/index_example_03.png
3015 * @image latex screenshots/index_example_03.eps
3017 * See the full @ref index_example_c "source code" for
3020 * @example index_example_02.c
3024 * @page tutorial_ctxpopup Ctxpopup example
3025 * @dontinclude ctxpopup_example_01.c
3027 * In this example we have a list with two items, when either item is clicked
3028 * a ctxpopup for it will be shown. Our two ctxpopups are quite different, the
3029 * one for the first item is a vertical and it's items contain both labels and
3030 * icons, the one for the second item is horizontal and it's items have icons
3033 * We will begin examining our example code by looking at the callback we'll use
3034 * when items in the ctxpopup are clicked. It's very simple, all it does is
3035 * print the label present in the ctxpopup item:
3038 * Next we examine a function that creates ctxpopup items, it was created to
3039 * avoid repeating the same code whenever we needed to add an item to our
3040 * ctxpopup. Our function creates an icon from the standard set of icons, and
3041 * then creates the item, with the label received as an argument. We also set
3042 * the callback to be called when the item is clicked:
3045 * Finally we have the function that will create the ctxpopup for the first item
3046 * in our list. This one is somewhat more complex though, so let's go through it
3047 * in parts. First we declare our variable and add the ctxpopup:
3048 * @until ctxpopup_add
3050 * Next we create a bunch of items for our ctxpopup, marking two of them as
3051 * disabled just so we can see what that will look like:
3052 * @until disabled_set
3053 * @until disabled_set
3055 * Then we ask evas where the mouse pointer was so that we can have our ctxpopup
3056 * appear in the right place, set a maximum size for the ctxpopup, move it and
3060 * And last we mark the list item as not selected:
3063 * Our next function is the callback that will create the ctxpopup for the
3064 * second list item, it is very similar to the previous function. A couple of
3065 * interesting things to note is that we ask our ctxpopup to be horizontal, and
3066 * that we pass NULL as the label for every item:
3069 * And with all of that in place we can now get to our main function where we
3070 * create the window, the list, the list items and run the main loop:
3073 * The example will initially look like this:
3075 * @image html screenshots/ctxpopup_example_01.png
3076 * @image latex screenshots/ctxpopup_example_01.eps width=\textwidth
3078 * @note This doesn't show the ctxpopup tough, since it will only appear when
3079 * we click one of the list items.
3081 * Here is what our first ctxpopup will look like:
3083 * @image html screenshots/ctxpopup_example_01_a.png
3084 * @image latex screenshots/ctxpopup_example_01_a.eps width=\textwidth
3086 * And here the second ctxpopup:
3088 * @image html screenshots/ctxpopup_example_01_b.png
3089 * @image latex screenshots/ctxpopup_example_01_b.eps width=\textwidth
3091 * @example ctxpopup_example_01.c
3095 * @page tutorial_pager
3096 * @dontinclude pager_example_01.c
3098 * In this example we'll have a pager with 3 rectangles on it, one blue, one
3099 * green and one blue, we'll also have 1 button for each rectangle. Pressing a
3100 * button will bring the associated rectangle to the front of the pager(promote
3103 * We start our example with some run of the mill code that you've seen in other
3107 * And then we get right to creating our pager, setting a style and some basic
3111 * Well a pager without any content is not of much use, so let's create the
3112 * first of our rectangles, add it to the pager and create the button for it:
3113 * @until smart_callback
3114 * @note The only line of above code that directly relates to our pager is the
3115 * call to elm_pager_content_push().
3117 * And now we will do the same thing again twice for our next two rectangles:
3118 * @until smart_callback
3119 * @until smart_callback
3121 * Now that we haver our widgets create we can get to running the main loop:
3124 * We also have the callback that is called when any of the buttons is pressed,
3125 * this callback is receiving the rectangle in it's @p data argument, so we
3126 * check if it's already on top and if not move it there:
3129 * Our example will look like this:
3131 * @image html screenshots/pager_example_01.png
3132 * @image latex screenshots/pager_example_01.eps width=\textwidth
3133 * @note Like all examples that involve animations the screenshot doesn't do it
3134 * justice, seeing it in action is a must.
3136 * @example pager_example_01.c
3140 * @page tutorial_separator Separator example
3141 * @dontinclude separator_example_01.c
3143 * In this example we are going to pack two rectangles in a box, and have a
3144 * separator in the middle.
3146 * So we start we the window, background, box and rectangle creation, all pretty
3150 * Once we have our first rectangle in the box we create and add our separator:
3152 * @note Since our box is in horizontal mode it's a good idea to set the
3153 * separator to be horizontal too.
3155 * And now we add our second rectangle and run the main loop:
3158 * This example will look like this:
3160 * @image html screenshots/separator_example_01.png
3161 * @image eps screenshots/separator_example_01.eps width=\textwidth
3163 * @example separator_example_01.c
3167 * @page tutorial_radio Radio example
3168 * @dontinclude radio_example_01.c
3170 * In this example we will create 4 radio buttons, three of them in a group and
3171 * another one not in the group. We will also have the radios in the group
3172 * change the value of a variable directly and have then print it when the value
3173 * changes. The fourth button is in the example just to make clear that radios
3174 * outside the group don't affect the group.
3176 * We'll start with the usual includes:
3179 * And move right to declaring a static variable(the one whose value the radios
3183 * We now need to have a window and all that good stuff to be able to place our
3187 * And now we create a radio button, since this is the first button in our group
3188 * we set the group to be the radio(so we can set the other radios in the same
3189 * group). We also set the state value of this radio to 1 and the value pointer
3190 * to @p val, since val is @p 1 this has the additional effect of setting the
3191 * radio value to @p 1. For this radio we choose the default home icon:
3194 * To check that our radio buttons are working we'll add a callback to the
3195 * "changed" signal of the radio:
3196 * @until smart_callback
3198 * The creation of our second radio button is almost identical, the 2
3199 * differences worth noting are, the value of this radio 2 and that we add this
3200 * radio to the group of the first radio:
3201 * @until smart_callback
3203 * For our third callback we'll omit the icon and set the value to 3, we'll also
3204 * add it to the group of the first radio:
3205 * @until smart_callback
3207 * Our fourth callback has a value of 4, no icon and most relevantly is not a
3208 * member of the same group as the other radios:
3211 * We finally run the main loop:
3214 * And the last detail in our example is the callback that prints @p val so that
3215 * we can see that the radios are indeed changing its value:
3218 * The example will look like this:
3220 * @image html screenshots/radio_example_01.png
3221 * @image latex screenshots/radio_example_01.epx width=\textwidth
3223 * @example radio_example_01.c
3227 * @page tutorial_toggle Toggle example
3228 * @dontinclude toggle_example_01.c
3230 * In this example we'll create 2 toggle widgets. The first will have an icon
3231 * and the state names will be the default "on"/"off", it will also change the
3232 * value of a variable directly. The second won't have a icon, the state names
3233 * will be "Enabled"/"Disabled", it will start "Enabled" and it won't set the
3234 * value of a variable.
3236 * We start with the usual includes and prototype for callback which will be
3237 * implemented and detailed later on:
3240 * We then declare a static global variable(the one whose value will be changed
3241 * by the first toggle):
3244 * We now have to create our window and all that usual stuff:
3247 * The creation of a toggle is no more complicated than that of any other
3251 * For our first toggle we don't set the states labels so they will stay the
3252 * default, however we do set a label for the toggle, an icon and the variable
3253 * whose value it should change:
3256 * We also set the callback that will be called when the toggles value changes:
3257 * @until smart_callback
3259 * For our second toggle it important to note that we set the states labels,
3260 * don't set an icon or variable, but set the initial state to
3261 * EINA_TRUE("Enabled"):
3264 * For the second toggle we will use a different callback:
3265 * @until smart_callback
3267 * We then ask the main loop to start:
3270 * The callback for our first toggle will look the value of @p val and print it:
3273 * For our second callback we need to do a little bit more, since the second
3274 * toggle doesn't change the value of a variable we have to ask it what its
3278 * This example will look like this:
3280 * @image html screenshots/toggle_example_01.png
3281 * @image latex screenshots/toggle_example_01.eps width=\textwidth
3283 * @example toggle_example_01.c
3287 * @page tutorial_panel Panel example
3288 * @dontinclude panel_example_01.c
3290 * In this example will have 3 panels, one for each possible orientation. Two of
3291 * our panels will start out hidden, the third will start out expanded. For each
3292 * of the panels we will use a label as the content, it's however possible to
3293 * have any widget(including containers) as the content of panels.
3295 * We start by doing some setup, code you should be familiar with from other
3299 * And move right to creating our first panel, for this panel we are going to
3300 * choose the orientation as TOP and toggle it(tell it to hide itself):
3303 * For the second panel we choose the RIGHT orientation and explicitly set the
3307 * For our third and last panel we won't set the orientation(which means it will
3308 * use the default: LEFT):
3311 * All that is left is running the main loop:
3314 * This example will look like this;
3316 * @image html screenshots/panel_example_01.png
3317 * @image latex screenshots/panel_example_01.epx width=\textwidth
3318 * @note The buttons with arrow allow the user to hide/show the panels.
3320 * @example panel_example_01.c
3324 * @page gengrid_example Gengrid widget example
3326 * This application is a thorough exercise on the gengrid widget's
3327 * API. We place an Elementary gengrid widget on a window, with
3328 * various knobs below its viewport, each one acting on it somehow.
3330 * The code's relevant part begins at the grid's creation. After
3331 * instantiating it, we set its items sizes, so that we don't end with
3332 * items one finger size wide, only. We're setting them to fat, 150
3333 * pixel wide ones, for this example. We give it some size hints, not
3334 * to be discussed in this context and, than, we register a callback
3335 * on one of its smart events -- the one coming each time an item gets
3336 * doubly clicked. There, we just print the item handle's value.
3337 * @dontinclude gengrid_example.c
3338 * @skip grid = elm_gengrid_add
3339 * @until evas_object_sho
3340 * @dontinclude gengrid_example.c
3341 * @skip item double click callback
3344 * Before we actually start to deal with the items API, let's show
3345 * some things items will be using throughout all the code. The first
3346 * of them is a struct to be used as item data, for all of them:
3347 * @dontinclude gengrid_example.c
3348 * @skip typedef struct
3351 * That path will be used to index an image, to be swallowed into one
3352 * of the item's icon spots. The imagens themselves are distributed
3354 * @dontinclude gengrid_example.c
3355 * @skip static const char *imgs
3358 * We also have an (unique) gengrid item class we'll be using for
3359 * items in the example:
3360 * @dontinclude gengrid_example.c
3361 * @skip static Elm_Gengrid_Item_Class
3362 * @until static Elm_Gengrid_Item_Class
3363 * @dontinclude gengrid_example.c
3364 * @skip item_style =
3367 * As you see, our items will follow the default theme on gengrid
3368 * items. For the label fetching code, we return a string composed of
3369 * the item's image path:
3370 * @dontinclude gengrid_example.c
3371 * @skip label fetching callback
3374 * For item icons, we'll be populating the item default theme's two
3375 * icon spots, @c "elm.swallow.icon" and @c "elm.swallow.end". The
3376 * former will receive one of the images in our list (in the form of
3377 * a @ref bg_02_example_page "background"), while the latter will be
3378 * a check widget. Note that we prevent the check to propagate click
3379 * events, so that the user can toggle its state without messing with
3380 * the respective item's selection in the grid:
3381 * @dontinclude gengrid_example.c
3382 * @skip icon fetching callback
3383 * @until return NULL
3386 * As the default gengrid item's theme does not have parts
3387 * implementing item states, we'll be just returning false for every
3389 * @dontinclude gengrid_example.c
3390 * @skip state fetching callback
3393 * Finally, the deletion callback on gengrid items takes care of
3394 * freeing the item's label string and its data struct:
3395 * @dontinclude gengrid_example.c
3396 * @skip deletion callback
3399 * Let's move to item insertion/deletion knobs, them. They are four
3400 * buttons, above the grid's viewport, namely
3401 * - "Append" (to append an item to the grid),
3402 * - "Prepend" (to prepend an item to the grid),
3403 * - "Insert before" (to insert an item before the selection, on the
3405 * - "Insert after" (to insert an item after the selection, on the
3407 * - "Clear" (to delete all items in the grid),
3408 * - "Bring in 1st" (to make the 1st item visible, by scrolling),
3409 * - "Show last" (to directly show the last item),
3411 * which are displaced and declared in that order. We're not dealing
3412 * with the buttons' creation code (see @ref button_example_01
3413 * "a button example", for more details on it), but with their @c
3414 * "clicked" registered callbacks. For all of them, the grid's handle
3415 * is passed as @c data. The ones creating new items use a common
3416 * code, which just gives a new @c Example_Item struct, with @c path
3417 * filled with a random image in our images list:
3418 * @dontinclude gengrid_example.c
3419 * @skip new item with random path
3422 * Moreover, that ones will set a common function to be issued on the
3423 * selection of the items. There, we print the item handle's value,
3424 * along with the callback function data. The latter will be @c NULL,
3425 * always, because it's what we pass when adding all icons. By using
3426 * elm_gengrid_item_data_get(), we can have the item data back and,
3427 * with that, we're priting the item's path string. Finally, we
3428 * exemplify elm_gengrid_item_pos_get(), printing the item's position
3430 * @dontinclude gengrid_example.c
3431 * @skip item selection callback
3434 * The appending button will exercise elm_gengrid_item_append(), simply:
3435 * @dontinclude gengrid_example.c
3436 * @skip append an item
3439 * The prepending, naturally, is analogous, but exercising
3440 * elm_gengrid_item_prepend(), on its turn. The "Insert before" one
3441 * will expect an item to be selected in the grid, so that it will
3442 * insert a new item just before it:
3443 * @dontinclude gengrid_example.c
3444 * @skip "insert before" callback
3447 * The "Insert after" is analogous, just using
3448 * elm_gengrid_item_insert_after(), instead. The "Clear" button will,
3449 * as expected, just issue elm_gengrid_clear():
3450 * @dontinclude gengrid_example.c
3451 * @skip delete items
3454 * The "Bring in 1st" button is there exercise two gengrid functions
3455 * -- elm_gengrid_first_item_get() and elm_gengrid_item_bring_in().
3456 * With the former, we get a handle to the first item and, with the
3457 * latter, you'll see that the widget animatedly scrolls its view
3458 * until we can see that item:
3459 * @dontinclude gengrid_example.c
3460 * @skip bring in 1st item
3463 * The "Show last", in its turn, will use elm_gengrid_last_item_get()
3464 * and elm_gengrid_item_show(). The latter differs from
3465 * elm_gengrid_item_bring_in() in that it immediately replaces the
3466 * contents of the grid's viewport with the region containing the item
3468 * @dontinclude gengrid_example.c
3469 * @skip show last item
3472 * To change the grid's cell (items) size, we've placed a spinner,
3473 * which has the following @c "changed" smart callback:
3474 * @dontinclude gengrid_example.c
3475 * @skip change items' size
3478 * Experiment with it and see how the items are affected. The "Disable
3479 * item" button will, as the name says, disable the currently selected
3481 * @dontinclude gengrid_example.c
3482 * @skip disable selected item
3484 * Note that we also make use of elm_gengrid_item_selected_set(),
3485 * there, thus making the item unselected before we actually disable
3488 * To toggle between horizontal and vertical layouting modes on the
3489 * grid, use the "Horizontal mode" check, which will call the
3490 * respective API function on the grid:
3491 * @dontinclude gengrid_example.c
3492 * @skip change layouting mode
3495 * If you toggle the check right after that one, "Always select",
3496 * you'll notice all subsequent clicks on the @b same grid item will
3497 * still issue the selection callback on it, what is different from
3498 * when it's not checked. This is the
3499 * elm_gengrid_always_select_mode_set() behavior:
3500 * @dontinclude gengrid_example.c
3501 * @skip "always select" callback
3504 * One more check follows, "Bouncing", which will turn on/off the
3505 * bouncing animations on the grid, when one scrolls past its
3506 * borders. Experiment with scrolling the grid to get the idea, having
3507 * it turned on and off:
3508 * @dontinclude gengrid_example.c
3509 * @skip "bouncing mode" callback
3512 * The next two checks will affect items selection on the grid. The
3513 * first, "Multi-selection", will make it possible to select more the
3514 * one item on the grid. Because it wouldn't make sense to fetch for
3515 * an unique selected item on this case, we also disable two of the
3516 * buttons, which insert items relatively, if multi-selection is on:
3517 * @dontinclude gengrid_example.c
3518 * @skip multi-selection callback
3521 * Note that we also @b unselect all items in the grid, when returning
3522 * from multi-selection mode, making use of
3523 * elm_gengrid_item_selected_set().
3525 * The second check acting on selection, "No selection", is just what
3526 * its name depicts -- no selection will be allowed anymore, on the
3527 * grid, while it's on. Check it out for yourself, interacting with
3529 * @dontinclude gengrid_example.c
3530 * @skip no selection callback
3533 * We have, finally, one more line of knobs, now sliders, to change
3534 * the grids behavior. The two first will change the horizontal @b
3535 * alignment of the whole actual grid of items within the gengrid's
3537 * @dontinclude gengrid_example.c
3538 * @skip items grid horizontal alignment change
3541 * Naturally, the vertical counterpart just issues
3542 * elm_gengrid_align_set() changing the second alignment component,
3545 * The last slider will change the grid's <b>page size</b>, relative
3546 * to its own one. Try to change those values and, one manner of
3547 * observing the paging behavior, is to scroll softly and release the
3548 * mouse button, with different page sizes, at different grid
3549 * positions, while having lots of items in it -- you'll see it
3550 * snapping to page boundaries differenty, for each configuration:
3551 * @dontinclude gengrid_example.c
3552 * @skip page relative size change
3555 * This is how the example program's window looks like:
3556 * @image html screenshots/gengrid_example.png
3557 * @image latex screenshots/gengrid_example.eps
3559 * Note that it starts with three items which we included at will:
3560 * @dontinclude gengrid_example.c
3561 * @skip _clicked(grid,
3562 * @until _clicked(grid,
3563 * @until _clicked(grid,
3564 * @until _clicked(grid,
3566 * See the full @ref gengrid_example_c "source code" for
3569 * @example gengrid_example.c
3573 * @page bg_example_01_c bg_example_01.c
3574 * @include bg_example_01.c
3575 * @example bg_example_01.c
3579 * @page bg_example_02_c bg_example_02.c
3580 * @include bg_example_02.c
3581 * @example bg_example_02.c
3585 * @page bg_example_03_c bg_example_03.c
3586 * @include bg_example_03.c
3587 * @example bg_example_03.c
3591 * @page actionslider_example_01 Actionslider example
3592 * @include actionslider_example_01.c
3593 * @example actionslider_example_01.c
3597 * @page animator_example_01_c Animator example 01
3598 * @include animator_example_01.c
3599 * @example animator_example_01.c
3603 * @page transit_example_01_c Transit example 1
3604 * @include transit_example_01.c
3605 * @example transit_example_01.c
3609 * @page transit_example_02_c Transit example 2
3610 * @include transit_example_02.c
3611 * @example transit_example_02.c
3615 * @page general_functions_example_c General (top-level) functions example
3616 * @include general_funcs_example.c
3617 * @example general_funcs_example.c
3621 * @page clock_example_c Clock example
3622 * @include clock_example.c
3623 * @example clock_example.c
3627 * @page flipselector_example_c Flipselector example
3628 * @include flipselector_example.c
3629 * @example flipselector_example.c
3633 * @page fileselector_example_c Fileselector example
3634 * @include fileselector_example.c
3635 * @example fileselector_example.c
3639 * @page fileselector_button_example_c Fileselector button example
3640 * @include fileselector_button_example.c
3641 * @example fileselector_button_example.c
3645 * @page fileselector_entry_example_c Fileselector entry example
3646 * @include fileselector_entry_example.c
3647 * @example fileselector_entry_example.c
3651 * @page index_example_01_c Index example
3652 * @include index_example_01.c
3653 * @example index_example_01.c
3657 * @page index_example_02_c Index example
3658 * @include index_example_02.c
3659 * @example index_example_02.c
3663 * @page layout_example_01_c layout_example_01.c
3664 * @include layout_example_01.c
3665 * @example layout_example_01.c
3669 * @page layout_example_02_c layout_example_02.c
3670 * @include layout_example_02.c
3671 * @example layout_example_02.c
3675 * @page layout_example_03_c layout_example_03.c
3676 * @include layout_example_03.c
3677 * @example layout_example_03.c
3681 * @page layout_example_edc An example of layout theme file
3683 * This theme file contains two groups. Each of them is a different theme, and
3684 * can be used by an Elementary Layout widget. A theme can be used more than
3685 * once by many different Elementary Layout widgets too.
3687 * @include layout_example.edc
3688 * @example layout_example.edc
3691 * @page gengrid_example_c Gengrid example
3692 * @include gengrid_example.c
3693 * @example gengrid_example.c