2 * @page Examples Examples
4 * Here is a page with Elementary examples.
6 * @ref bg_01_example_page
8 * @ref bg_02_example_page
10 * @ref bg_03_example_page
12 * @ref actionslider_example_page
14 * @ref elm_animator_example_page_01
16 * @ref transit_example_01_explained
18 * @ref transit_example_02_explained
20 * @ref general_functions_example_page
22 * @ref calendar_example_01
24 * @ref calendar_example_02
26 * @ref calendar_example_03
28 * @ref calendar_example_04
30 * @ref calendar_example_05
32 * @ref calendar_example_06
34 * @ref spinner_example
44 * @ref diskselector_example_01
46 * @ref diskselector_example_02
48 * @ref list_example_01
50 * @ref list_example_02
52 * @ref list_example_03
54 * @ref toolbar_example_01
56 * @ref toolbar_example_02
58 * @ref toolbar_example_03
60 * @ref segment_control_example
62 * @ref flipselector_example
64 * @ref fileselector_example
66 * @ref fileselector_button_example
68 * @ref fileselector_entry_example
70 * @ref index_example_01
72 * @ref index_example_02
74 * @ref gengrid_example
76 * @ref genlist_example_01
78 * @ref genlist_example_02
80 * @ref genlist_example_03
82 * @ref genlist_example_04
84 * @ref genlist_example_05
86 * @ref thumb_example_01
88 * @ref progressbar_example
90 * @ref slideshow_example
94 * @page bg_01_example_page elm_bg - Plain color background.
95 * @dontinclude bg_example_01.c
97 * The full code for this example can be found at @ref bg_example_01_c,
98 * in the function @c test_bg_plain. It's part of the @c elementar_test
99 * suite, and thus has the code for the three examples referenced by this
102 * This first example just sets a default background with a plain color. The
103 * first part consists of creating an Elementary window. It's the common
104 * piece of code that you'll see everywhere in Elementary: @skip elm_main
107 * Now we really create our background object, using the window object as
112 * Then we set the size hints of the background object so that it will use
113 * all space available for it, and then add it as a resize object to the
114 * window, making it visible in the end:
116 * @skip size_hint_weight_set
117 * @until resize_object_add
119 * See @ref evas_object_size_hint_weight_set and elm_win_resize_object_add()
120 * for more detailed info about these functions.
122 * The end of the example is quite simple, just setting the minimum and
123 * maximum size of the background, so the Elementary window knows that it
124 * has to have at least the minimum size. The background also won't scale to
125 * a size above its maximum. Then we resize the window and show it in the
128 * @skip set size hints
131 * And here we finish our very simple background object usage example.
135 * @page bg_02_example_page elm_bg - Image background.
136 * @dontinclude bg_example_02.c
138 * The full code for this example can be found at @ref bg_example_02_c,
139 * in the function @c test_bg_image. It's part of the @c elementar_test
140 * suite, and thus has the code for the three examples referenced by this
143 * This is the second example, and shows how to use the Elementary
144 * background object to set an image as background of your application.
146 * We start this example exactly in the same way as the previous one, even
147 * when creating the background object:
152 * Now it's the different part.
154 * Our background will have an image, that will be displayed over the
155 * background color. Before loading the image, we set the load size of the
156 * image. The load size is a hint about the size that we want the image
157 * displayed in the screen. It's not the exact size that the image will have,
158 * but usually a bit bigger. The background object can still be scaled to a
159 * size bigger than the one set here. Setting the image load size to
160 * something smaller than its real size will reduce the memory used to keep
161 * the pixmap representation of the image, and the time to load it. Here we
162 * set the load size to 20x20 pixels, but the image is loaded with a size
163 * bigger than that (since it's just a hint):
165 * @skipline load_size_set
167 * And set our background image to be centered, instead of stretched or
168 * scaled, so the effect of the elm_bg_load_size_set() can be easily
171 * @skipline option_set
173 * We need a filename to set, so we get one from the previous installed
174 * images in the @c PACKAGE_DATA_DIR, and write its full path to a buffer.
175 * Then we use this buffer to set the filename in the background object:
180 * Notice that the third argument of the elm_bg_file_set() function is @c
181 * NULL, since we are setting an image to this background. This function
182 * also supports setting an edje group as background, in which case the @c
183 * group parameter wouldn't be @c NULL, but be the name of the group
186 * Finally, we can set the size hints, add the background as a resize
187 * object, and resize the window, exactly the same thing we do in the @ref
188 * bg_01_example_page example:
193 * And this is the end of this example.
195 * This example will look like this:
197 * @image html screenshots/bg_01.png
198 * @image latex screenshots/bg_01.eps width=\textwidth
202 * @page bg_03_example_page elm_bg - Background properties.
203 * @dontinclude bg_example_03.c
205 * The full code for this example can be found at @ref bg_example_03_c, in the
206 * function @c test_bg_options, with the callbacks @c _cb_overlay_changed, @c
207 * _cb_color_changed and @c _cb_radio_changed defined in the beginning of the
208 * file. It's part of the @c elementar_test suite, and thus has the code for
209 * the three examples referenced by this documentation.
211 * This example will show the properties available for the background object,
212 * and will use of some more widgets to set them.
214 * In order to do this, we will set some callbacks for these widgets. The
215 * first is for the radio buttons that will be used to choose the option
216 * passed as argument to elm_bg_option_set():
218 * @skip _cb_radio_changed
221 * The next callback will be used when setting the overlay (using
222 * elm_bg_overlay_set()):
224 * @skip _cb_overlay_changed
228 * And the last one, used to set the color (with elm_bg_color_set()):
230 * @skip _cb_color_changed
233 * We will get back to what these functions do soon. If you want to know more
234 * about how to set these callbacks and what these widgets are, look for:
235 * @li elm_radio_add()
236 * @li elm_check_add()
237 * @li elm_spinner_add()
239 * Now going to the main function, @c test_bg_options, we have the common
240 * code with the other examples:
245 * We add a plain background to this window, so it will have the default
246 * background color behind everything:
248 * @skip bg = elm_bg_add
249 * @until evas_object_show(bg)
251 * Then we add a vertical box (elm_box_add()) that will hold the background
252 * object that we are going to play with, as well as a horizontal box that
256 * @until evas_object_show
258 * Now we add the background object that is going to be of use for our
259 * example. It is an image background, as used in @ref bg_02_example_page ,
260 * so the code should be familiar:
263 * @until evas_object_show
265 * Notice the call to elm_box_pack_end(): it will pack the background object
266 * in the end of the Elementary box declared above. Just refer to that
267 * documentation for more info.
269 * Since this Elementary background is already an image background, we are
270 * going to play with its other properties. We will change its option
271 * (CENTER, SCALE, STRETCH, TILE), its color (RGB), and add an overlay to it.
272 * For all of these properties, we are going to add widgets that will
275 * First, lets add the horizontal box that will hold these widgets:
279 * For now, just consider this @c hbox as a rectangle that will contain the
280 * widgets, and will distribute them horizontally inside its content. Then we
281 * add radio buttons that will allow us to choose the property to use with
285 * @until evas_object_show
287 * Again, I won't give details about the use of these widgets, just look for
288 * their documentation if necessary. It's enough to know for now that we are
289 * packing them in the @c hbox, setting a label for them, and the most
290 * important parts: setting its value to @c ELM_BG_OPTION_CENTER and its
291 * callback to @c _cb_radio_changed (the function defined in the beginning of
292 * this example). We do this for the next 3 radio buttons added after this
293 * one, each of them with a different value.
295 * Now taking a look at the code of the callback @c _cb_radio_changed again,
296 * it will call elm_bg_option_set() with the value set from the checked radio
297 * button, thus setting the option for this background. The background is
298 * passed as argument to the @p data parameter of this callback, and is
299 * referenced here as @c o_bg.
301 * Later we set the default value for this radio button:
303 * @skipline elm_radio_value_set
305 * Then we add a checkbox for the elm_bg_overlay_set() function:
308 * @until evas_object_show
310 * Now look at the code of the @c _cb_overlay_changed again. If the checkbox
311 * state is checked, an overlay will be added to the background. It's done by
312 * creating an Edje object, and setting it with elm_bg_overlay_set() to the
313 * background object. For information about what are and how to set Edje
314 * object, look at the Edje documentation.
316 * Finally we add a spinner object (elm_spinner_add()) to be used to select
317 * the color of our background. In its callback it's possible to see the call
318 * to elm_bg_color_set(), which will change the color of this background.
319 * This color is used by the background to fill areas where the image doesn't
320 * cover (in this case, where we have an image background). The spinner is
321 * also packed into the @c hbox :
323 * @skip elm_spinner_add
324 * @until evas_object_show
326 * Then we just have to pack the @c hbox inside the @c box, set some size
327 * hints, and show our window:
332 * Now to see this code in action, open elementary_test, and go to the "Bg
333 * Options" test. It should demonstrate what was implemented here.
337 * @page actionslider_example_page Actionslider usage
338 * @dontinclude actionslider_example_01.c
340 * For this example we are going to assume knowledge of evas smart callbacks
341 * and some basic evas object functions. Elementary is not meant to be used
342 * without evas, if you're not yet familiar with evas it probably is worth
345 * And now to the example, when using Elementary we start by including
349 * Next we define some callbacks, they all share the same signature because
350 * they are all to be used with evas_object_smart_callback_add().
351 * The first one just prints the selected label(in two different ways):
354 * This next callback is a little more interesting, it makes the selected
355 * label magnetic(except if it's the center label):
358 * This callback enables or disables the magnetic propertty of the center
362 * And finally a callback to stop the main loop when the window is closed:
365 * To be able to create our actionsliders we need to do some setup, but this
366 * isn't really relevant here, so if you want to know about that go @ref
369 * With all that boring stuff out of the way we can proceed to creating some
371 * All actionsliders are created the same way:
372 * @skipline actionslider_add
373 * Next we must choose where the indicator starts, and for this one we choose
374 * the right, and set the right as magnetic:
375 * @skipline indicator_pos_set
376 * @until magnet_pos_set
378 * We then set the labels for the left and right, passing NULL as an argument
379 * to any of the labels makes that position have no label.
382 * Furthermore we mark both left and right as enabled positions, if we didn't
383 * do this all three positions would be enabled:
386 * Having the the enabled positions we now add a smart callback to change
387 * which position is magnetic, so that only the last selected position is
391 * And finally we set our printing callback and show the actionslider:
395 * For our next actionslider we are going to do much as we did for the
396 * previous except we are going to have the center as the magnet(and not
398 * @skipline actionslider_add
399 * @skipline indicator_pos_set
402 * And another actionslider, in this one the indicator starts on the left.
403 * It has labels only in the center and right, and both bositions are
404 * magnetic. Because the left doesn't have a label and is not magnetic once
405 * the indicator leaves it can't return:
406 * @skipline actionslider_add
407 * @skipline indicator_pos_set
409 * @note The greyed out area is a @ref Styles "style".
411 * And now an actionslider with a label in the indicator, and whose magnet
412 * properties change based on what was last selected:
413 * @skipline actionslider_add
414 * @skipline indicator_pos_set
416 * @note The greyed out area is a @ref Styles "style".
418 * We are almost done, this next one is just an actionslider with all
419 * positions magnetized and having every possible label:
420 * @skipline actionslider_add
421 * @skipline indicator_pos_set
424 * And for our last actionslider we have one that turns the magnetic property
426 * @skipline actionslider_add
427 * @skipline indicator_pos_set
430 * The example will look like this:
432 * @image html screenshots/actionslider_01.png
433 * @image latex screenshots/actionslider_01.eps width=\textwidth
435 * See the full source code @ref actionslider_example_01 "here"
439 * @page elm_animator_example_page_01 Animator usage
440 * @dontinclude animator_example_01.c
442 * For this example we will be using a bit of evas, you could animate a
443 * elementary widget in much the same way, but to keep things simple we use
444 * an evas_object_rectangle.
446 * As every other example we start with our include and a simple callback to
447 * exit the app when the window is closed:
451 * This next callback is the one that actually creates our animation, it
452 * changes the size, position and color of a rectangle given to it in @a
456 * Next we have a callback that prints a string, nothing special:
459 * This next callback is a little more interesting, it has a state variable
460 * to know if the animation is currently paused or running, and it toogles
461 * the state of the animation accordingly:
466 * Finally we have a callback to stop the animation:
469 * As with every example we need to do a bit of setup before we can actually
470 * use an animation, but for the purposes of this example that's not relevant
471 * so let's just skip to the good stuff, creating an animator:
472 * @skipline animator_add
473 * @note Since elm_animator is not a widget we can give it a NULL parent.
475 * Now that we have an elm_animator we set it's duration to 1 second:
478 * We would also like our animation to be reversible, so:
481 * We also set our animation to repeat as many times as possible, which will
482 * mean that _end_cb will only be called after UINT_MAX * 2 seconds(UINT_MAX
483 * for the animation running forward and UNIT_MAX for the animation running
487 * To add some fun to our animation we will use the IN_OUT curve style:
490 * To actually animate anything we need an operation callback:
491 * @line operation_callback
493 * Even though we set our animation to repeat for a very long time we are
494 * going to set a end callback to it:
495 * @line completion_callback
496 * @note Notice that stoping the animation with the stop button will not make
499 * Now that we have fully set up our animator we can tell it to start
503 * There's a bit more of code that doesn't really matter to use so we skip
504 * right down to our last interesting point:
505 * @skipline animator_del
506 * @note Because we created our animator with no parent we need to delete it
509 * The example should look like this:
511 * @image html screenshots/animator_example_01.png
512 * @image latex screenshots/animator_example_01.eps width=\textwidth
514 * @image html screenshots/animator_example_02.png
515 * @image latex screenshots/animator_example_02.eps width=\textwidth
517 * @image html screenshots/animator_example_03.png
518 * @image latex screenshots/animator_example_03.eps width=\textwidth
520 * The full source code for this example can be found @ref
521 * animator_example_01_c "here"
525 * @page transit_example_03_c elm_transit - Combined effects and options.
527 * This example shows how to apply the following transition effects:
535 * It allows you to apply more than one effect at once, and also allows to
536 * set properties like event_enabled, auto_reverse, repeat_times and
539 * @include transit_example_03.c
543 * @page transit_example_04_c elm_transit - Combined effects over two objects.
545 * This example shows how to apply the transition effects:
550 * over two objects. This kind of transition effect is used to make one
551 * object disappear and another one appear on its place.
553 * You can mix more than one effect of this type on the same objects, and the
554 * transition will apply both.
556 * @include transit_example_04.c
560 * @page transit_example_01_explained elm_transit - Basic transit usage.
561 * @dontinclude transit_example_01.c
563 * The full code for this example can be found at @ref transit_example_01_c.
565 * This example shows the simplest way of creating a transition and applying
566 * it to an object. Similarly to every other elementary example, we create a
567 * window, set its title, size, autodel property, and setup a callback to
568 * exit the program when finished:
571 * @until evas_object_resize
573 * We also add a resizeable white background to use behind our animation:
576 * @until evas_object_show
578 * And then we add a button that we will use to demonstrate the effects of
582 * @until evas_object_show(win)
584 * Notice that we are not adding the button with elm_win_resize_object_add()
585 * because we don't want the window to control the size of the button. We
586 * will use the transition to change the button size, so it could conflict
587 * with something else trying to control that size.
589 * Now, the simplest code possible to create the resize animation:
594 * As you can see, this code is very easy to understand. First, we create the
595 * transition itself with elm_transit_add(). Then we add the button to this
596 * transition with elm_transit_object_add(), which means that the transition
597 * will operate over this button. The effect that we want now is changing the
598 * object size from 100x50 to 300x150, and can be achieved by adding the
599 * resize effect with elm_transit_effect_resizing_add().
601 * Finally, we set the transition time to 5 seconds and start the transition
602 * with elm_transit_go(). If we wanted more effects applied to this
603 * button, we could add them to the same transition. See the
604 * @ref transit_example_03_c to watch many transitions being applied to an
609 * @page transit_example_02_explained elm_transit - Chained transitions.
610 * @dontinclude transit_example_02.c
612 * The full code for this example can be found at @ref transit_example_02_c.
614 * This example shows how to implement a chain of transitions. This chain is
615 * used to start a transition just after another transition ended. Similarly
616 * to every other elementary example, we create a window, set its title,
617 * size, autodel property, and setup a callback to exit the program when
621 * @until evas_object_resize
623 * We also add a resizeable white background to use behind our animation:
626 * @until evas_object_show
628 * This example will have a chain of 4 transitions, each of them applied to
629 * one button. Thus we create 4 different buttons:
632 * @until evas_object_show(bt4)
634 * Now we create a simple translation transition that will be started as soon
635 * as the program loads. It will be our first transition, and the other
636 * transitions will be started just after this transition ends:
641 * The code displayed until now has nothing different from what you have
642 * already seen in @ref transit_example_01_explained, but now comes the new
643 * part: instead of creating a second transition that will start later using
644 * a timer, we create the it normally, and use
645 * elm_transit_chain_transit_add() instead of elm_transit_go. Since we are
646 * adding it in a chain after the first transition, it will start as soon as
647 * the first transition ends:
650 * @until transit_chain_transit_add
652 * Finally we add the 2 other transitions to the chain, and run our program.
653 * It will make one transition start after the other finish, and there is the
658 * @page general_functions_example_page General (top-level) functions example
659 * @dontinclude general_funcs_example.c
661 * As told in their documentation blocks, the
662 * elm_app_compile_*_dir_set() family of functions have to be called
663 * before elm_app_info_set():
664 * @skip tell elm about
665 * @until elm_app_info_set
667 * We are here setting the fallback paths to the compiling time target
668 * paths, naturally. If you're building the example out of the
669 * project's build system, we're assuming they are the canonical ones.
671 * After the program starts, elm_app_info_set() will actually run and
672 * then you'll see an intrincasy: Elementary does the prefix lookup @b
673 * twice. This is so because of the quicklaunch infrastructure in
674 * Elementary (@ref Start), which will register a predefined prefix
675 * for possible users of the launch schema. We're not hooking into a
676 * quick launch, so this first call can't be avoided.
678 * If you ran this example from your "bindir" installation
679 * directiory, no output will emerge from these both attempts -- it
680 * will find the "magic" file there registered and set the prefixes
681 * silently. Otherwise, you could get something like:
683 WARNING: Could not determine its installed prefix for 'ELM'
684 so am falling back on the compiled in default:
686 implied by the following:
689 datadir = usr/share/elementary
690 localedir = usr/share/locale
691 Try setting the following environment variables:
692 ELM_PREFIX - points to the base prefix of install
693 or the next 4 variables
694 ELM_BIN_DIR - provide a specific binary directory
695 ELM_LIB_DIR - provide a specific library directory
696 ELM_DATA_DIR - provide a specific data directory
697 ELM_LOCALE_DIR - provide a specific locale directory
699 * if you also didn't change those environment variables (remember
700 * they are also a valid way of communicating your prefix to the
701 * binary) - this is the scenario where it fallbacks to the paths set
704 * Then, you can check the prefixes set on the standard output:
705 * @skip prefix was set to
706 * @until locale directory is
709 * @skip by using this policy
710 * @until elm_win_autodel_set
711 * we demonstrate the use of Elementary policies. The policy defining
712 * under which circunstances our application should quit automatically
713 * is set to when its last window is closed (this one has just one
714 * window, though). This will save us from having to set a callback
715 * ourselves on the window, like done in @ref bg_example_01_c "this"
716 * example. Note that we need to tell the window to delete itself's
717 * object on a request to destroy the canvas coming, with
718 * elm_win_autodel_set().
720 * What follows is some boilerplate code, creating a frame with a @b
721 * button, our object of interest, and, below, widgets to change the
722 * button's behavior and exemplify the group of functions in question.
724 * @dontinclude general_funcs_example.c
725 * We enabled the focus highlight object for this window, so that you
726 * can keep track of the current focused object better:
727 * @skip elm_win_focus_highlight_enabled_set
728 * @until evas_object_show
729 * Use the tab key to navigate through the focus chain.
731 * @dontinclude general_funcs_example.c
732 * While creating the button, we exemplify how to use Elementary's
733 * finger size information to scale our UI:
734 * @skip fprintf(stdout, "Elementary
735 * @until evas_object_show
737 * @dontinclude general_funcs_example.c
738 * The first checkbox's callback is:
741 * When unsetting the checkbox, we disable the button, which will get a new
742 * decoration (greyed out) and stop receiving events. The focus chain
743 * will also ignore it.
745 * Following, there are 2 more buttons whose actions are focus/unfocus
746 * the top button, respectively:
747 * @skip focus callback
750 * @skip unfocus callback
752 * Note the situations in which they won't take effect:
753 * - the button is not allowed to get focus or
754 * - the button is disabled
756 * The first restriction above you'll get by a second checkbox, whose
758 * @skip focus allow callback
760 * Note that the button will still get mouse events, though.
762 * Next, there's a slider controlling the button's scale:
763 * @skip scaling callback
766 * Experiment with it, so you understand the effect better. If you
767 * change its value, it will mess with the button's original size,
770 * The full code for this example can be found
771 * @ref general_functions_example_c "here".
775 * @page theme_example_01 Theme - Using extensions
777 * @dontinclude theme_example_01.c
779 * Using extensions is extremely easy, discarding the part where you have to
780 * write the theme for them.
782 * In the following example we'll be creating two buttons, one to load or
783 * unload our extension theme and one to cycle around three possible styles,
784 * one of which we created.
786 * After including our one and only header we'll jump to the callback for
787 * the buttons. First one takes care of loading or unloading our extension
788 * file, relative to the default theme set (thus the @c NULL in the
789 * functions first parameter).
790 * @skipline Elementary.h
796 * The second button, as we said before, will just switch around different
797 * styles. In this case we have three of them. The first one is our custom
798 * style, named after something very unlikely to find in the default theme.
799 * The other two styles are the standard and one more, anchor, which exists
800 * in the default and is similar to the default, except the button vanishes
801 * when the mouse is not over it.
806 * So what happens if the style switches to our custom one when the
807 * extension is loaded? Elementary falls back to the default for the
810 * And the main function, simply enough, will create the window, set the
811 * buttons and their callbacks, and just to begin with our button styled
812 * we're also loading our extension at the beginning.
816 * In this case we wanted to easily remove extensions, but all adding an
817 * extension does is tell Elementary where else it should look for themes
818 * when it can't find them in the default theme. Another way to do this
819 * is to set the theme search order using elm_theme_set(), but this requires
820 * that the developer is careful not to override any user configuration.
821 * That can be helped by adding our theme to the end of whatver is already
822 * set, like in the following snippet.
825 * snprintf(buf, sizeof(buf), "%s:./theme_example.edj", elme_theme_get(NULL);
826 * elm_theme_set(NULL, buf);
829 * If we were using overlays instead of extensions, the same thing applies,
830 * but the custom theme must be added to the front of the search path.
832 * In the end, we should be looking at something like this:
834 * @image html screenshots/theme_example_01.png
835 * @image latex screenshots/theme_example_01.eps width=\textwidth
837 * That's all. Boringly simple, and the full code in one piece can be found
838 * @ref theme_example_01.c "here".
840 * And the code for our extension is @ref theme_example.edc "here".
842 * @example theme_example_01.c
843 * @example theme_example.edc
847 * @page theme_example_02 Theme - Using overlays
849 * @dontinclude theme_example_02.c
851 * Overlays are like extensions in that you tell Elementary that some other
852 * theme contains the styles you need for your program. The difference is that
853 * they will be look in first, so they can override the default style of any
856 * There's not much to say about them that hasn't been said in our previous
857 * example about @ref theme_example_01 "extensions", so going quickly through
858 * the code we have a function to load or unload the theme, which will be
859 * called when we click any button.
860 * @skipline Elementary.h
864 * And the main function, creating the window and adding some buttons to it.
865 * We load our theme as an overlay and nothing else. Notice there's no style
866 * set for any button there, which means they should be using the default
871 * That's pretty much it. The full code is @ref theme_example_02.c "here" and
872 * the definition of the theme is the same as before, and can be found in
873 * @ref theme_example.edc "here".
875 * @example theme_example_02.c
879 * @page button_example_01 Button - Complete example
881 * @dontinclude button_example_01.c
883 * A button is simple, you click on it and something happens. That said,
884 * we'll go through an example to show in detail the button API less
887 * In the end, we'll be presented with something that looks like this:
889 * @image html screenshots/button_01.png
890 * @image latex screenshots/button_01.eps width=\textwidth
892 * The full code of the example is @ref button_example_01.c "here" and we
893 * will follow here with a rundown of it.
896 * @until Elementary.h
900 * We have several buttons to set different times for the autorepeat timeouts
901 * of the buttons that use it and a few more that we keep track of in our
902 * data struct. The mid button doesn't do much, just moves around according
903 * to what other buttons the user presses. Then four more buttons to move the
904 * central one, and we're also keeping track of the icon set in the middle
905 * button, since when this one moves, we change the icon, and when movement
906 * is finished (by releasing one of the four arrow buttons), we set back the
911 * Keeping any of those four buttons pressed will trigger their autorepeat
912 * callback, where we move the button doing some size hint magic. To
913 * understand how that works better, refer to the @ref Box documentation.
914 * Also, the first time the function is called, we change the icon in the
915 * middle button, using elm_button_icon_unset() first to keep the reference
916 * to the previous one, so we don't need to recreate it when we are done
920 * @until size_hint_align_set
923 * One more callback for the option buttons, that just sets the timeouts for
924 * the different autorepeat options.
931 * And the main function, which does some setting up of the buttons in boxes
932 * to make things work. Here we'll go through some snippets only.
934 * For the option buttons, it's just the button with its label and callback.
935 * @skip elm_button_add
936 * @until smart_callback_add
938 * For the ones that move the central button, we have no labels. There are
939 * icons instead, and the autorepeat option is toggled.
941 * @skip elm_button_add
942 * @until data.cursors.up
944 * And just to show the mid button, which doesn't have anything special.
945 * @skip data.cursors.left
946 * @skip elm_button_add
951 * @example button_example_01.c
955 * @page bubble_01_example_page elm_bubble - Simple use.
956 * @dontinclude bubble_example_01.c
958 * This example shows a bubble with all fields set(label, info, content and
959 * icon) and the selected corner changing when the bubble is clicked. To be
960 * able use a bubble we need to do some setup and create a window, for this
961 * example we are going to ignore that part of the code since it isn't
962 * relevant to the bubble.
964 * To have the selected corner change in a clockwise motion we are going to
965 * use the following callback:
970 * Here we are creating an elm_label that is going to be used as the content
972 * @skipline elm_label
974 * @note You could use any evas_object for this, we are using an elm_label
977 * Despite it's name the bubble's icon doesn't have to be an icon, it can be
978 * any evas_object. For this example we are going to make the icon a simple
982 * And finally we have the actual bubble creation and the setting of it's
983 * label, info and content:
986 * @note Because we didn't set a corner, the default("top_left") will be
989 * Now that we have our bubble all that is left is connecting the "clicked"
990 * signals to our callback:
991 * @line smart_callback
993 * This last bubble we created was very complete, so it's pertinent to show
994 * that most of that stuff is optional a bubble can be created with nothing
999 * Our example will look like this:
1001 * @image html screenshots/bubble_example_01.png
1002 * @image latex screenshots/bubble_example_01.eps width=\textwidth
1004 * See the full source code @ref bubble_example_01.c here.
1005 * @example bubble_example_01.c
1009 * @page box_example_01 Box - Basic API
1011 * @dontinclude button_example_01.c
1013 * As a special guest tonight, we have the @ref button_example_01 "simple
1014 * button example". There are plenty of boxes in it, and to make the cursor
1015 * buttons that moved a central one around when pressed, we had to use a
1016 * variety of values for their hints.
1018 * To start, let's take a look at the handling of the central button when
1019 * we were moving it around. To achieve this effect without falling back to
1020 * a complete manual positioning of the @c Evas_Object in our canvas, we just
1021 * put it in a box and played with its alignment within it, as seen in the
1022 * following snippet of the callback for the pressed buttons.
1023 * @skip evas_object_size_hint_align_get
1024 * @until evas_object_size_hint_align_set
1026 * Not much to it. We get the current alignment of the object and change it
1027 * by just a little, depending on which button was pressed, then set it
1028 * again, making sure we stay within the 0.0-1.0 range so the button moves
1029 * inside the space it has, instead of disappearing under the other objects.
1031 * But as useful as an example as that may have been, the usual case with boxes
1032 * is to set everything at the moment they are created, like we did for
1033 * everything else in our main function.
1035 * The entire layout of our program is made with boxes. We have one set as the
1036 * resize object for the window, which means it will always be resized with
1037 * the window. The weight hints set to @c EVAS_HINT_EXPAND will tell the
1038 * window that the box can grow past it's minimum size, which allows resizing
1042 * @until evas_object_show
1044 * Two more boxes, set to horizontal, hold the buttons to change the autorepeat
1045 * configuration used by the buttons. We create each to take over all the
1046 * available space horizontally, but we don't want them to grow vertically,
1047 * so we keep that axis of the weight with 0.0. Then it gets packed in the
1050 * @until evas_object_show
1052 * The buttons in each of those boxes have nothing special, they are just packed
1053 * in with their default values and the box will use their minimum size, as set
1054 * by Elementary itself based on the label, icon, finger size and theme.
1056 * But the buttons used to move the central one have a special disposition.
1057 * The top one first, is placed right into the main box like our other smaller
1058 * boxes. Set to expand horizontally and not vertically, and in this case we
1059 * also tell it to fill that space, so it gets resized to take the entire
1060 * width of the window.
1062 * @skip elm_button_add
1063 * @until evas_object_show
1065 * The bottom one will be the same, but for the other two we need to use a
1066 * second box set to take as much space as we have, so we can place our side
1067 * buttons in place and have the big empty space where the central button will
1070 * @until evas_object_show
1072 * Then the buttons will have their hints inverted to the other top and bottom
1073 * ones, to expand and fill vertically and keep their minimum size horizontally.
1074 * @skip elm_button_add
1075 * @until evas_object_show
1077 * The central button takes every thing else. It will ask to be expanded in
1078 * both directions, but without filling its cell. Changing its alignment by
1079 * pressing the buttons will make it move around.
1080 * @skip elm_button_add
1081 * @until evas_object_show
1083 * To end, the rightmost button is packed in the smaller box after the central
1084 * one, and back to the main box we have the bottom button at the end.
1088 * @page box_example_02 Box - Layout transitions
1090 * @dontinclude box_example_02.c
1092 * Setting a customized layout for a box is simple once you have the layout
1093 * function, which is just like the layout function for @c Evas_Box. The new
1094 * and fancier thing we can do with Elementary is animate the transition from
1095 * one layout to the next. We'll see now how to do that through a simple
1096 * example, while also taking a look at some of the API that was left
1097 * untouched in our @ref box_example_01 "previous example".
1099 * @image html screenshots/box_example_02.png
1100 * @image latex screenshots/box_example_02.eps width=\textwidth
1102 * @skipline Elementary.h
1104 * Our application data consists of a list of layout functions, given by
1105 * @c transitions. We'll be animating through them throughout the entire run.
1106 * The box with the stuff to move around and the last layout that was set to
1107 * make things easier in the code.
1109 * @until Transitions_Data
1111 * The box starts with three buttons, clicking on any of them will take it
1112 * out of the box without deleting the object. There are also two more buttons
1113 * outside, one to add an object to the box and the other to clear it.
1114 * This is all to show how you can interact with the items in the box, add
1115 * things and even remove them, while the transitions occur.
1117 * One of the callback we'll be using creates a new button, asks the box for
1118 * the list of its children and if it's not empty, we add the new object after
1119 * the first one, otherwise just place at the end as it will not make any
1125 * The clear button is even simpler. Everything in the box will be deleted,
1126 * leaving it empty and ready to fill it up with more stuff.
1130 * And a little function to remove buttons from the box without deleting them.
1131 * This one is set for the @c clicked callback of the original buttons,
1132 * unpacking them when clicked and placing it somewhere in the screen where
1133 * they will not disturb. Once we do this, the box no longer has any control
1134 * of it, so it will be left untouched until the program ends.
1138 * If we wanted, we could just call @c evas_object_del() on the object to
1139 * destroy it. In this case, no unpack is really necessary, as the box would
1140 * be notified of a child being deleted and adjust its calculations accordingly.
1142 * The core of the program is the following function. It takes whatever
1143 * function is first on our list of layouts and together with the
1144 * @c last_layout, it creates an ::Elm_Box_Transition to use with
1145 * elm_box_layout_transition(). In here, we tell it to start from whatever
1146 * layout we last set, end with the one that was at the top of the list and
1147 * when everything is finished, call us back so we can create another
1148 * transition. Finally, move the new layout to the end of the list so we
1149 * can continue running through them until the program ends.
1153 * The main function doesn't have antyhing special. Creation of box, initial
1154 * buttons and some callback setting. The only part worth mentioning is the
1155 * initialization of our application data.
1157 * @until evas_object_box_layout_stack
1159 * We have a simple static variable, set the box, the first layout we are
1160 * using as last and create the list with the different functions to go
1163 * And in the end, we set the first layout and call the same function we went
1164 * through before to start the run of transitions.
1165 * @until _test_box_transition_change
1167 * For the full code, follow @ref box_example_02.c "here".
1169 * @example box_example_02.c
1173 * @page calendar_example_01 Calendar - Simple creation.
1174 * @dontinclude calendar_example_01.c
1176 * As a first example, let's just display a calendar in our window,
1177 * explaining all steps required to do so.
1179 * First you should declare objects we intend to use:
1180 * @skipline Evas_Object
1182 * Then a window is created, a title is set and its set to be autodeleted.
1183 * More details can be found on windows examples:
1184 * @until elm_win_autodel
1186 * Next a simple background is placed on our windows. More details on
1187 * @ref bg_01_example_page :
1188 * @until evas_object_show(bg)
1190 * Now, the exciting part, let's add the calendar with elm_calendar_add(),
1191 * passing our window object as parent.
1192 * @until evas_object_show(cal);
1194 * To conclude our example, we should show the window and run elm mainloop:
1197 * Our example will look like this:
1199 * @image html screenshots/calendar_example_01.png
1200 * @image latex screenshots/calendar_example_01.eps width=\textwidth
1202 * See the full source code @ref calendar_example_01.c here.
1203 * @example calendar_example_01.c
1207 * @page calendar_example_02 Calendar - Layout strings formatting.
1208 * @dontinclude calendar_example_02.c
1210 * In this simple example, we'll explain how to format the label displaying
1211 * month and year, and also set weekday names.
1213 * To format month and year label, we need to create a callback function
1214 * to create a string given the selected time, declared under a
1215 * <tt> struct tm </tt>.
1217 * <tt> struct tm </tt>, declared on @c time.h, is a structure composed by
1219 * @li tm_sec seconds [0,59]
1220 * @li tm_min minutes [0,59]
1221 * @li tm_hour hour [0,23]
1222 * @li tm_mday day of month [1,31]
1223 * @li tm_mon month of year [0,11]
1224 * @li tm_year years since 1900
1225 * @li tm_wday day of week [0,6] (Sunday = 0)
1226 * @li tm_yday day of year [0,365]
1227 * @li tm_isdst daylight savings flag
1228 * @note glib version has 2 additional fields.
1230 * For our function, only stuff that matters are tm_mon and tm_year.
1231 * But we don't need to access it directly, since there are nice functions
1232 * to format date and time, as @c strftime.
1233 * We will get abbreviated month (%b) and year (%y) (check strftime manpage
1234 * for more) in our example:
1235 * @skipline static char
1238 * We need to alloc the string to be returned, and calendar widget will
1239 * free it when it's not needed, what is done by @c strdup.
1240 * So let's register our callback to calendar object:
1241 * @skipline elm_calendar_format_function_set
1243 * To set weekday names, we should declare them as an array of strings:
1244 * @dontinclude calendar_example_02.c
1245 * @skipline weekdays
1248 * And finally set them to calendar:
1249 * skipline weekdays_names_set
1251 * Our example will look like this:
1253 * @image html screenshots/calendar_example_02.png
1254 * @image latex screenshots/calendar_example_02.eps width=\textwidth
1256 * See the full source code @ref calendar_example_02.c here.
1257 * @example calendar_example_02.c
1261 * @page calendar_example_03 Calendar - Years restrictions.
1262 * @dontinclude calendar_example_03.c
1264 * This example explains how to set max and min year to be displayed
1265 * by a calendar object. This means that user won't be able to
1266 * see or select a date before and after selected years.
1267 * By default, limits are 1902 and maximun value will depends
1268 * on platform architecture (year 2037 for 32 bits); You can
1269 * read more about time functions on @c ctime manpage.
1271 * Straigh to the point, to set it is enough to call
1272 * elm_calendar_min_max_year_set(). First value is minimun year, second
1273 * is maximum. If first value is negative, it won't apply limit for min
1274 * year, if the second one is negative, won't apply for max year.
1275 * Setting both to negative value will clear limits (default state):
1276 * @skipline elm_calendar_min_max_year_set
1278 * Our example will look like this:
1280 * @image html screenshots/calendar_example_03.png
1281 * @image latex screenshots/calendar_example_03.eps width=\textwidth
1283 * See the full source code @ref calendar_example_03.c here.
1284 * @example calendar_example_03.c
1288 * @page calendar_example_04 Calendar - Days selection.
1289 * @dontinclude calendar_example_04.c
1291 * It's possible to disable date selection and to select a date
1292 * from your program, and that's what we'll see on this example.
1294 * If isn't required that users could select a day on calendar,
1295 * only interacting going through months, disabling days selection
1296 * could be a good idea to avoid confusion. For that:
1297 * @skipline elm_calendar_day_selection_enabled_set
1299 * Also, regarding days selection, you could be interested to set a
1300 * date to be highlighted on calendar from your code, maybe when
1301 * a specific event happens, or after calendar creation. Let's select
1302 * two days from current day:
1303 * @dontinclude calendar_example_04.c
1304 * @skipline SECS_DAY
1305 * @skipline current_time
1306 * @until elm_calendar_selected_time_set
1308 * Our example will look like this:
1310 * @image html screenshots/calendar_example_04.png
1311 * @image latex screenshots/calendar_example_04.eps width=\textwidth
1313 * See the full source code @ref calendar_example_04.c here.
1314 * @example calendar_example_04.c
1318 * @page calendar_example_05 Calendar - Signal callback and getters.
1319 * @dontinclude calendar_example_05.c
1321 * Most of setters explained on previous examples have associated getters.
1322 * That's the subject of this example. We'll add a callback to display
1323 * all calendar information every time user interacts with the calendar.
1325 * Let's check our callback function:
1326 * @skipline static void
1327 * @until double interval;
1329 * To get selected day, we need to call elm_calendar_selected_time_get(),
1330 * but to assure nothing wrong happened, we must check for function return.
1331 * It'll return @c EINA_FALSE if fail. Otherwise we can use time set to
1332 * our structure @p stime.
1333 * @skipline elm_calendar_selected_time_get
1336 * Next we'll get information from calendar and place on declared vars:
1337 * @skipline interval
1338 * @until elm_calendar_weekdays_names_get
1340 * The only tricky part is that last line gets an array of strings
1341 * (char arrays), one for each weekday.
1343 * Then we can simple print that to stdin:
1347 * <tt> struct tm </tt> is declared on @c time.h. You can check @c ctime
1348 * manpage to read about it.
1350 * To register this callback, that will be called every time user selects
1351 * a day or goes to next or previous month, just add a callback for signal
1353 * @skipline evas_object_smart_callback_add
1355 * Our example will look like this:
1357 * @image html screenshots/calendar_example_05.png
1358 * @image latex screenshots/calendar_example_05.eps width=\textwidth
1360 * See the full source code @ref calendar_example_05.c here.
1361 * @example calendar_example_05.c
1365 * @page calendar_example_06 Calendar - Calendar marks.
1366 * @dontinclude calendar_example_06.c
1368 * On this example marks management will be explained. Functions
1369 * elm_calendar_mark_add(), elm_calendar_mark_del() and
1370 * elm_calendar_marks_clear() will be covered.
1372 * To add a mark, will be required to choose three things:
1374 * @li mark date, or start date if it will be repeated
1375 * @li mark periodicity
1377 * Style defines the kind of mark will be displayed over marked day,
1378 * on caledar. Default theme supports @b holiday and @b checked.
1379 * If more is required, is possible to set a new theme to calendar
1380 * widget using elm_object_style_set(), and use
1381 * the signal that will be used by such marks.
1383 * Date is a <tt> struct tm </tt>, as defined by @c time.h. More can
1384 * be read on @c ctime manpage.
1385 * If a date relative from current is required, this struct can be set
1387 * @skipline current_time
1388 * @until localtime_r
1390 * Or if it's an absolute date, you can just declare the struct like:
1391 * @dontinclude calendar_example_06.c
1393 * @until christmas.tm_mon
1395 * Periodicity is how frequently the mark will be displayed over the
1396 * calendar. Can be a unique mark (that don't repeat), or it can repeat
1397 * daily, weekly, monthly or annually. It's enumerated by
1398 * @c Elm_Calendar_Mark_Repeat.
1400 * So let's add some marks to our calendar. We will add christmas holiday,
1401 * set Sundays as holidays, and check current day and day after that.
1402 * @dontinclude calendar_example_06.c
1404 * @until christmas.tm_mon
1405 * @skipline current_time
1406 * @until ELM_CALENDAR_WEEKLY
1408 * We kept the return of first mark add, because we don't really won't it
1409 * to be checked, so let's remove it:
1410 * @skipline elm_calendar_mark_del
1412 * After all marks are added and removed, is required to draw them:
1413 * @skipline elm_calendar_marks_draw
1415 * Finally, to clear all marks, let's set a callback for our button:
1416 * @skipline elm_button_add
1417 * @until evas_object_show(bt);
1419 * This callback will receive our calendar object, and should clear it:
1420 * @dontinclude calendar_example_06.c
1423 * @note Remember to draw marks after clear the calendar.
1425 * Our example will look like this:
1427 * @image html screenshots/calendar_example_06.png
1428 * @image latex screenshots/calendar_example_06.eps width=\textwidth
1430 * See the full source code @ref calendar_example_06.c here.
1431 * @example calendar_example_06.c
1435 * @page spinner_example Spinner widget example
1437 * This code places seven Elementary spinner widgets on a window, each of
1438 * them exemplifying a part of the widget's API.
1440 * The first of them is the default spinner:
1441 * @dontinclude spinner_example.c
1442 * @skipline elm_spinner_add
1443 * @until evas_object_show
1444 * As you see, the defaults for a spinner are:
1446 * @li min value set to 0
1447 * @li max value set to 100
1448 * @li step value set to 1
1449 * @li label format set to "%0.f"
1451 * If another format is required, see the second spinner. It will put a text
1452 * before and after the value, and also format value to display two decimals:
1453 * @skipline format_set
1455 * The third one will use a customized step, define new minimum and maximum
1456 * values and enable wrap, so when value reaches minimum it jumps to maximum,
1457 * or jumps to minimum after maximum value is reached. Format is set to display
1459 * @skipline elm_spinner_add
1460 * @until evas_object_show
1462 * The fourth uses @c vertical style, so instead of left and right arrows,
1463 * top and bottom are displayed. Also the change interval is reduced, so
1464 * user can change value faster.
1466 * @skipline interval
1468 * In the fifth the user won't be allowed to set value directly, i.e., will
1469 * be obligate change value only using arrows:
1470 * @skipline editable
1472 * The sixth widget will receive a lot of special values, so
1473 * instead of reading numeric values, user will see labels for each one.
1474 * Also direct edition is disabled, otherwise users would see the numeric
1475 * value on edition mode. User will be able to select a month in this widget:
1476 * @skipline elm_spinner_add
1477 * @until evas_object_show
1479 * Finally the last widget will exemplify how to listen to widget's signals,
1480 * <tt> changed </tt> and <tt> delay,changed </tt>. First we need to
1481 * implement callback functions that will simply print spinner's value:
1482 * @dontinclude spinner_example.c
1489 * The first callback function should be called everytime value changes,
1490 * the second one only after user stops to increment or decrement. Try
1491 * to keep arrows pressed and check the difference.
1492 * @skip smart_callback
1493 * @skipline smart_callback
1494 * @skipline smart_callback
1496 * See the full @ref spinner_example.c "example", whose window should
1497 * look like this picture:
1499 * @image html screenshots/spinner_example.png
1500 * @image latex screenshots/spinner_example.eps width=\textwidth
1502 * See the full @ref spinner_example.c "source code" for this example.
1504 * @example spinner_example.c
1508 * @page slider_example Slider widget example
1510 * This code places seven Elementary slider widgets on a window, each of
1511 * them exemplifying a part of the widget's API.
1513 * The first of them is the default slider:
1514 * @dontinclude slider_example.c
1515 * @skipline elm_slider_add
1516 * @until evas_object_show
1518 * As you see, the defaults for a slider are:
1521 * @li no values (on indicator or unit labels)
1523 * Actually it's pretty useless this way. So let's learn how to improve it.
1525 * If some decoration is required, a label can be set, and icon before and
1526 * after the bar as well. On the second slider will add a @c home icon
1527 * and a @c folder icon at @c end.
1528 * @skipline text_set
1531 * If the bar size need to be changed, it can be done with span set function,
1532 * that doesn't accounts other widget's parts size. Also the bar can starts
1533 * with a not default value (0.0), as we done on third slider:
1534 * @skipline value_set
1535 * @skipline span_size_set
1537 * So far, users won't be able to see the slider value. If it's required,
1538 * it can be displayed in two different areas, units label or above
1541 * Let's place a units label on our widget, and also let's set minimum and
1542 * maximum value (uses 0.0 and 1.0 by default):
1543 * @skipline unit_format_set
1544 * @skipline min_max_set
1546 * If above the indicator is the place to display the value, just set it.
1547 * Also, is possible to invert a bar, as you can see:
1548 * @skipline indicator_format_set
1549 * @skipline inverted_set
1551 * But if you require to use a function a bit more customized to show the value,
1552 * is possible to registry a callback function that will be called
1553 * to display unit or indicator label. Only the value will be passed to this
1554 * function, that should return a string.
1555 * In this case, a function to free this string will be required.
1557 * Let's exemplify with indicator label on our sixth slider:
1558 * @dontinclude slider_example.c
1569 * Setting callback functions:
1570 * @skipline indicator_format_function_set
1571 * @skipline _indicator_free
1573 * Also, a slider can be displayed vertically:
1574 * @dontinclude slider_example.c
1575 * @skipline elm_slider_horizontal_set
1577 * Finally the last widget will exemplify how to listen to widget's signals,
1578 * <tt> changed </tt> and <tt> delay,changed </tt>. First we need to
1579 * implement callback functions that will simply print slider's value:
1580 * @dontinclude slider_example.c
1587 * The first callback function should be called everytime value changes,
1588 * the second one only after user stops to increment or decrement. Try
1589 * to keep arrows pressed and check the difference.
1590 * @skip smart_callback
1591 * @skipline smart_callback
1592 * @skipline smart_callback
1594 * See the full @ref slider_example.c "example", whose window should
1595 * look like this picture:
1597 * @image html screenshots/slider_example.png
1598 * @image latex screenshots/slider_example.eps width=\textwidth
1600 * See the full @ref slider_example.c "source code" for this example.
1602 * @example slider_example.c
1606 * @page panes_example Panes widget example
1608 * This code places two Elementary panes widgets on a window, one of them
1609 * displayed vertically and the other horizontally, to exemplify
1610 * a part of the widget's API. Also, all the signals emitted by this
1611 * widget will be covered.
1613 * Let's start adding a panes to our window:
1614 * @dontinclude panes_example.c
1615 * @skipline elm_panes_add
1616 * @until evas_object_show
1618 * Now we will set a content (a simple button) to the left side of our
1620 * @skipline elm_button_add
1621 * @until content_left_set
1623 * The content of the right side will be something a bit more elaborated, we'll
1624 * place another panes, displayed vertically (it's displayed horizontally
1626 * @skipline elm_panes_add
1627 * @until content_right_set
1629 * When populating a panes displayed vertically, remember that left content
1630 * will be placed at top, and right content will place at bottom. Next
1631 * we will add two buttons to exemplify that:
1632 * @skipline elm_button_add
1633 * @until content_right_set
1635 * Panes widgets emits 4 different signals, depending on users interaction
1636 * with the draggable bar. We'll add a callback function for each of them.
1638 * <tt> "clicked" signal </tt>:
1640 * Callback function that just print "Clicked" to stdin:
1641 * @dontinclude panes_example.c
1648 * @skipline static void
1651 * Also, add callback function to the panes:
1652 * @skipline "clicked"
1654 * <tt> "press" signal </tt>:
1656 * Callback function that just print "Pressed" to stdin:
1657 * @dontinclude panes_example.c
1660 * @skipline static void
1663 * Also, add callback function to the panes:
1666 * Now, let's try to make our callback functions a bit more useful:
1668 * <tt> "unpress" signal </tt>:
1670 * Suppose we want to know the size proportion of left content after
1671 * user drags the bar. We need to listen for @c unpress signal, and
1672 * get this size from our panes widget. It's done on the following
1674 * @dontinclude panes_example.c
1679 * @skipline static void
1682 * Adding the callback function to the panes:
1683 * @skipline "unpress"
1685 * <tt> "clicked,double" signal </tt>:
1687 * Now, a interesting feature that could be addded to panes widget.
1688 * Hide a content when user double click the draggable bar. It's done
1689 * using a variable to store size and content left size getter and setter
1690 * on the following function:
1691 * @dontinclude panes_example.c
1692 * @skipline static double
1699 * @skipline static void
1704 * Adding the callback function to the panes:
1705 * @skipline "clicked,double"
1708 * See the full @ref panes_example.c "example", whose window should
1709 * look like this picture:
1711 * @image html screenshots/panes_example.png
1712 * @image latex screenshots/panes_example.eps width=\textwidth
1714 * @example panes_example.c
1718 * @page clock_example Clock widget example
1720 * This code places five Elementary clock widgets on a window, each of
1721 * them exemplifying a part of the widget's API.
1723 * The first of them is the pristine clock:
1724 * @dontinclude clock_example.c
1726 * @until evas_object_show
1727 * As you see, the defaults for a clock are:
1729 * - no seconds shown
1731 * For am/pm time, see the second clock:
1732 * @dontinclude clock_example.c
1734 * @until evas_object_show
1736 * The third one will show the seconds digits, which will flip in
1737 * synchrony with system time. Note, besides, that the time itself is
1738 * @b different from the system's -- it was customly set with
1739 * elm_clock_time_set():
1740 * @dontinclude clock_example.c
1741 * @skip with seconds
1742 * @until evas_object_show
1744 * In both fourth and fifth ones, we turn on the <b>edition
1745 * mode</b>. See how you can change each of the sheets on it, and be
1746 * sure to try holding the mouse pressed over one of the sheet
1747 * arrows. The forth one also starts with a custom time set:
1748 * @dontinclude clock_example.c
1750 * @until evas_object_show
1752 * The fifth, besides editable, has only the time @b units editable,
1753 * for hours, minutes and seconds. This exemplifies
1754 * elm_clock_digit_edit_set():
1755 * @dontinclude clock_example.c
1757 * @until evas_object_show
1759 * See the full @ref clock_example.c "example", whose window should
1760 * look like this picture:
1762 * @image html screenshots/clock_example.png
1763 * @image latex screenshots/clock_example.eps width=\textwidth
1765 * See the full @ref clock_example_c "source code" for this example.
1767 * @example clock_example.c
1771 * @page mapbuf_example Mapbuf Widget Example
1773 * This code places a Elementary mapbuf widget on a window,
1774 * to exemplify part of the widget's API.
1776 * First we'll add an window with a background and a vertical box to
1777 * pack our interface elements:
1778 * @dontinclude mapbuf_example.c
1782 * Next we'll simply add the mapbuf widget to the box:
1783 * @skipline mapbuf_add
1786 * But mapbuf is a container widget, it won't do anything alone. So let's
1787 * create a table full of icons. For that we'll loop to fill each line of each
1788 * column. See @ref tutorial_table_01 "tutorial_table_01"
1789 * if you don't know how to use tables:
1790 * @skipline table_add
1794 * Finally, setting mapbuf content:
1795 * @skipline content_set
1798 * Also, would be good a horizontal box with some controls to change mapbuf
1803 * By default map is disabled. So just setting content isn't enough.
1804 * Alpha and smooth settings will be applied when map is enabled.
1805 * So we'll add a toggle for that. Everytime the map properties
1806 * are changed, map will need to be enabled again. So if you
1807 * want to play a bit with our example, remember to always enable
1808 * map again after concluding your changes.
1809 * @skipline toggle_add
1812 * We have added a callback function to this toggle, so it will enable
1814 * @dontinclude mapbuf_example.c
1820 * Let's add check boxes for alpha blending and smooth rendering:
1821 * @skipline check_add
1825 * By default, mapbuf would enable alpha blending and smooth rendering,
1826 * so we need to check boxes to be consistent with its behavior.
1828 * Callback functions look like the one added to the toggle. This way we
1829 * could enable or disable the both properties:
1830 * @dontinclude mapbuf_example.c
1839 * You'll see that disabling alpha blending will set a black rectangle below
1840 * the icons. That's the reason you only should enable that when you're sure
1841 * the mapbuf content is 100% solid.
1843 * See @ref mapbuf_example.c "mapbuf_example.c", whose window should
1844 * look like this picture:
1846 * @image html screenshots/mapbuf_example.png
1847 * @image latex screenshots/mapbuf_example.eps width=\textwidth
1849 * @example mapbuf_example.c
1853 * @page diskselector_example_01 Diskselector widget example
1855 * This code places 4 Elementary diskselector widgets on a window, each of
1856 * them exemplifying a part of the widget's API.
1858 * All of them will have weekdays as items, since we won't focus
1859 * on items management on this example. For an example about this subject,
1860 * check @ref diskselector_example_02.
1862 * The first of them is a default diskselector.
1863 * @dontinclude diskselector_example_01.c
1866 * @skipline elm_diskselector_add
1867 * @until evas_object_show
1869 * We are just adding the diskselector, so as you can see, defaults for it are:
1870 * @li Only 3 items visible each time.
1871 * @li Only 3 characters are displayed for labels on side positions.
1872 * @li The first added item remains centeres, i.e., it's the selected item.
1874 * To add items, we are just appending it on a loop, using function
1875 * elm_diskselector_item_append(), that will be better exaplained on
1876 * items management example.
1878 * For a circular diskselector, check the second widget. A circular
1879 * diskselector will display first item after last, and last previous to
1880 * the first one. So, as you can see, @b Sa will appears on left side
1881 * of selected @b Sunday. This property is set with
1882 * elm_diskselector_round_set().
1884 * Also, we decide to display only 2 character for side labels, instead of 3.
1885 * For this we call elm_diskselector_side_label_length_set(). As result,
1886 * we'll see @b Mo displayed instead of @b Mon, when @b Monday is on a
1889 * @skipline elm_diskselector_add
1890 * @until evas_object_show
1892 * But so far, we are only displaying 3 items at once. If more are wanted,
1893 * is enough to call elm_diskselector_display_item_num_set(), as you can
1895 * @skipline elm_diskselector_add
1896 * @until evas_object_show
1898 * @note You can't set less than 3 items to be displayed.
1900 * Finally, if a bounce effect is required, or you would like to see
1901 * scrollbars, it is possible. But, for default theme, diskselector
1902 * scrollbars will be invisible anyway.
1903 * @skipline elm_diskselector_add
1904 * @until evas_object_show
1906 * See the full @ref diskselector_example_01.c "diskselector_example_01.c"
1907 * code, whose window should look like this picture:
1909 * @image html screenshots/diskselector_example_01.png
1910 * @image latex screenshots/diskselector_example_01.eps width=\textwidth
1912 * @example diskselector_example_01.c
1916 * @page diskselector_example_02 Diskselector - Items management
1918 * This code places a Elementary diskselector widgets on a window,
1919 * along with some buttons trigerring actions on it (though its API).
1920 * It covers most of Elm_Diskselector_Item functions.
1922 * On our @c main function, we are adding a default diskselector with
1923 * 3 items. We are only setting their labels (second parameter of function
1924 * elm_diskselector_item_append):
1925 * @dontinclude diskselector_example_02.c
1926 * @skipline elm_diskselector_add
1929 * Next we are adding lots of buttons, each one for a callback function
1930 * that will realize a task covering part of diskselector items API.
1931 * Lets check the first one:
1932 * @skipline elm_button_add
1933 * @until evas_object_show
1935 * We are labeling the button with a task description with
1936 * elm_object_text_set() and setting a callback
1937 * function evas_object_smart_callback_add().
1938 * Each callback function will have the signature:
1939 * <tt> static void _task_cb(void *data, Evas_Object *obj,
1940 * void *event_info)</tt> with the function name varying for each task.
1942 * Now let's cover all of them.
1944 * <b> Appending an item: </b>
1945 * @dontinclude diskselector_example_02.c
1949 * All items are included on diskselector after last one. You @b can't
1952 * The first parameter of elm_diskselector_item_append() is the diskselector
1953 * object, that we are receiving as data on our callback function.
1954 * The second one is a label, the string that will be placed in the center
1955 * of our item. As we don't wan't icons or callback functions, we can
1956 * send NULL as third, fourth and fifth parameters.
1958 * <b> Appending an item with icon: </b>
1959 * @dontinclude diskselector_example_02.c
1960 * @skipline _add_ic_cb
1963 * If an icon is required, you can pass it as third paramenter on our
1964 * elm_diskselector_item_append() function. It will be place on the
1965 * left side of item's label, that will be shifted to right a bit.
1967 * For more details about how to create icons, look for elm_icon examples.
1969 * <b> Appending an item with callback function for selected: </b>
1970 * @dontinclude diskselector_example_02.c
1975 * To set a callback function that will be called every time an item is
1976 * selected, i.e., everytime the diskselector stops with this item in
1977 * center position, just pass the function as fourth paramenter.
1979 * <b> Appending an item with callback function for selected with data: </b>
1980 * @dontinclude diskselector_example_02.c
1981 * @skipline _sel_data_cb
1987 * If the callback function request an extra data, it can be attached to our
1988 * item passing a pointer for data as fifth parameter.
1989 * Our function _sel_data_cb will receive it as <tt> void *data </tt>.
1991 * If you want to free this data, or handle that the way you need when the
1992 * item is deleted, set a callback function for that, with
1993 * elm_diskselector_item_del_cb_set().
1995 * As you can see we check if @c it is not @c NULL after appending it.
1996 * If an error happens, we won't try to set a function for it.
1998 * <b> Deleting an item: </b>
1999 * @dontinclude diskselector_example_02.c
2004 * To delete an item we simple need to call elm_diskselector_item_del() with
2005 * a pointer for such item.
2007 * If you need, you can get selected item with
2008 * elm_diskselector_selected_item_get(), that will return a pointer for it.
2010 * <b> Unselecting an item: </b>
2011 * @dontinclude diskselector_example_02.c
2012 * @skipline _unselect_cb
2015 * To select an item, you should call elm_diskselector_item_selected_set()
2016 * passing @c EINA_TRUE, and to unselect it, @c EINA_FALSE.
2018 * If you unselect the selected item, diskselector will automatically select
2021 * <b> Printing all items: </b>
2022 * @dontinclude diskselector_example_02.c
2023 * @skipline _print_cb
2026 * <b> Clearing the diskselector: </b>
2027 * @dontinclude diskselector_example_02.c
2028 * @skipline _clear_cb
2031 * <b> Selecting the first item: </b>
2032 * @dontinclude diskselector_example_02.c
2033 * @skipline _select_first_cb
2036 * <b> Selecting the last item: </b>
2037 * @dontinclude diskselector_example_02.c
2038 * @skipline _select_last_cb
2041 * <b> Selecting the next item: </b>
2042 * @dontinclude diskselector_example_02.c
2043 * @skipline _select_next_cb
2046 * <b> Selecting the previous item: </b>
2047 * @dontinclude diskselector_example_02.c
2048 * @skipline _select_prev_cb
2051 * See the full @ref diskselector_example_02.c "diskselector_example_02.c"
2052 * code, whose window should look like this picture:
2054 * @image html screenshots/diskselector_example_02.png
2055 * @image latex screenshots/diskselector_example_02.eps width=\textwidth
2057 * @example diskselector_example_02.c
2061 * @page list_example_01 List widget example
2063 * This code places a single Elementary list widgets on a window, just
2064 * to exemplify the more simple and common use case: a list will be created
2065 * and populated with a few items.
2067 * To keep it simple, we won't show how to customize the list, for this check
2068 * @ref list_example_02. Also, we won't focus
2069 * on items management on this example. For an example about this subject,
2070 * check @ref list_example_03.
2072 * To add a list widget.
2073 * @dontinclude list_example_01.c
2074 * @skipline elm_list_add
2076 * We are just adding the list, so as you can see, defaults for it are:
2077 * @li Items are displayed vertically.
2078 * @li Only one item can be selected.
2079 * @li The list doesn't bouce.
2081 * To add items, we are just appending it on a loop, using function
2082 * elm_list_item_append(), that will be better exaplained on
2083 * items management example.
2084 * @dontinclude list_example_01.c
2088 * @skipline elm_list_item_append
2090 * After we just want to show the list. But first we need to start the widget.
2091 * It was done this way to improve widget's performance. So, always remember
2093 * @warning Call elm_list_go before showing the object
2094 * @skipline elm_list_go
2097 * See the full @ref list_example_01.c "list_example_01.c"
2098 * code, whose window should look like this picture:
2100 * @image html screenshots/list_example_01.png
2101 * @image latex screenshots/list_example_01.eps width=\textwidth
2103 * @example list_example_01.c
2107 * @page list_example_02 List widget example
2109 * This code places a single Elementary list widgets on a window,
2110 * exemplifying a part of the widget's API.
2112 * First, we will just create a simple list, as done on @ref list_example_01 :
2113 * @dontinclude list_example_02.c
2116 * @skipline elm_list_add
2117 * @until elm_list_item_append
2119 * Now, let's customize this list a bit. First we will display items
2121 * @skipline horizontal_set
2123 * Then we will choose another list mode. There are four of them, and
2124 * the default #Elm_List_Mode is #ELM_LIST_SCROLL. Let's set compress mode:
2125 * @skipline mode_set
2127 * To enable multiple items selection, we need to enable it, since only one
2128 * selected item is allowed by default:
2129 * @skipline elm_list_multi_select_set
2131 * We are not adding items with callback functions here,
2132 * since we'll explain it better on @ref list_example_03. But if the callback
2133 * need to be called everytime user clicks an item, even if already selected,
2134 * it's required to enable this behavior:
2135 * @skipline elm_list_always_select_mode_set
2137 * Finally, if a bounce effect is required, or you would like to see
2138 * scrollbars, it is possible. But, for default theme, list
2139 * scrollbars will be invisible anyway.
2140 * @skipline bounce_set
2141 * @until SCROLLER_POLICY_ON
2143 * See the full @ref list_example_02.c "list_example_02.c"
2144 * code, whose window should look like this picture:
2146 * @image html screenshots/list_example_02.png
2147 * @image latex screenshots/list_example_02.eps width=\textwidth
2149 * @example list_example_02.c
2153 * @page list_example_03 List - Items management
2155 * This code places a Elementary list widgets on a window,
2156 * along with some buttons trigerring actions on it (though its API).
2157 * It covers most of Elm_List_Item functions.
2159 * On our @c main function, we are adding a default list with
2160 * 3 items. We are only setting their labels (second parameter of function
2161 * elm_list_item_append):
2162 * @dontinclude list_example_03.c
2163 * @skipline elm_list_add
2166 * Next we are adding lots of buttons, each one for a callback function
2167 * that will realize a task covering part of list items API.
2168 * Lets check the first one:
2169 * @skipline elm_button_add
2170 * @until evas_object_show
2172 * We are labeling the button with a task description with
2173 * elm_object_text_set() and setting a callback
2174 * function evas_object_smart_callback_add().
2175 * Each callback function will have the signature:
2176 * <tt> static void _task_cb(void *data, Evas_Object *obj,
2177 * void *event_info)</tt> with the function name varying for each task.
2179 * Now let's cover all of them.
2181 * <b> Prepending an item: </b>
2182 * @dontinclude list_example_03.c
2183 * @skipline _prepend_cb
2186 * The item will be placed on the begining of the list,
2187 * i.e. it will be the first one.
2189 * The first parameter of elm_list_item_prepend() is the list
2190 * object, that we are receiving as data on our callback function.
2191 * The second one is a label, the string that will be placed in the center
2192 * of our item. As we don't wan't icons or callback functions, we can
2193 * send NULL as third, fourth, fifth and sixth parameters.
2195 * <b> Appending an item: </b>
2196 * @dontinclude list_example_03.c
2200 * Items included with append will be inserted inserted after the last one.
2202 * <b> Appending an item with icon: </b>
2203 * @dontinclude list_example_03.c
2204 * @skipline _add_ic_cb
2207 * If an icon is required, you can pass it as third paramenter on our
2208 * elm_list_item_append() function. It will be place on the
2209 * left side of item's label. If an icon is wanted on the right side,
2210 * it should be passed as fourth parameter.
2212 * For more details about how to create icons, look for elm_icon examples
2213 * @ref tutorial_icon.
2215 * <b> Appending an item with callback function for selected: </b>
2216 * @dontinclude list_example_03.c
2221 * To set a callback function that will be called every time an item is
2222 * selected, i.e., everytime the list stops with this item in
2223 * center position, just pass the function as fifth paramenter.
2225 * <b> Appending an item with callback function for selected with data: </b>
2226 * @dontinclude list_example_03.c
2227 * @skipline _sel_data_cb
2233 * If the callback function request an extra data, it can be attached to our
2234 * item passing a pointer for data as sixth parameter.
2235 * Our function _sel_data_cb will receive it as <tt> void *data </tt>.
2237 * If you want to free this data, or handle that the way you need when the
2238 * item is deleted, set a callback function for that, with
2239 * elm_list_item_del_cb_set().
2241 * As you can see we check if @c it is not @c NULL after appending it.
2242 * If an error happens, we won't try to set a function for it.
2244 * <b> Deleting an item: </b>
2245 * @dontinclude list_example_03.c
2246 * @skipline _del_cb(
2249 * To delete an item we simple need to call elm_list_item_del() with
2250 * a pointer for such item.
2252 * If you need, you can get selected item with
2253 * elm_list_selected_item_get(), that will return a pointer for it.
2255 * <b> Unselecting an item: </b>
2256 * @dontinclude list_example_03.c
2257 * @skipline _unselect_cb
2260 * To select an item, you should call elm_list_item_selected_set()
2261 * passing @c EINA_TRUE, and to unselect it, @c EINA_FALSE.
2263 * <b> Printing all items: </b>
2264 * @dontinclude list_example_03.c
2265 * @skipline _print_cb
2268 * <b> Clearing the list: </b>
2269 * @dontinclude list_example_03.c
2270 * @skipline _clear_cb
2273 * <b> Selecting the next item: </b>
2274 * @dontinclude list_example_03.c
2275 * @skipline _select_next_cb
2278 * <b> Inserting after an item: </b>
2279 * @dontinclude list_example_03.c
2280 * @skipline _insert_after_cb
2283 * <b> Selecting the previous item: </b>
2284 * @dontinclude list_example_03.c
2285 * @skipline _select_prev_cb
2288 * <b> Inserting before an item: </b>
2289 * @dontinclude list_example_03.c
2290 * @skipline _insert_before_cb
2293 * If a separator is required, just set an item as such:
2294 * @dontinclude list_example_03.c
2295 * @skipline _set_separator_cb
2298 * Also an item can be disabled, and the user won't be allowed to (un)select it:
2299 * @dontinclude list_example_03.c
2300 * @skipline _disable_cb
2303 * See the full @ref list_example_03.c "list_example_03.c"
2304 * code, whose window should look like this picture:
2306 * @image html screenshots/list_example_03.png
2307 * @image latex screenshots/list_example_03.eps width=\textwidth
2309 * @example list_example_03.c
2313 * @page toolbar_example_01 Toolbar Example - Simple Items
2315 * This code places a Elementary toolbar widget on a window,
2316 * to exemplify part of the widget's API.
2318 * Let's start adding a button to our window, that will have its text
2319 * modified depending on which item is selected. It's used just to exemplify
2320 * how to change a window content from the toolbar.
2321 * @dontinclude toolbar_example_01.c
2322 * @skipline elm_button_add
2323 * @until evas_object_show
2325 * Also, we'll need a toolbar widget, obviously:
2326 * @skipline elm_toolbar_add
2327 * @until evas_object_show
2329 * When appending an item is possible to set an icon, label, and a callback
2330 * function that will receive passed data.
2331 * @skipline _item_append
2334 * It's possible to disable items, so the user can't select then. We will
2335 * disable the third item:
2336 * @skipline _item_append
2339 * Our callbacks will just set button's label:
2340 * @dontinclude toolbar_example_01.c
2348 * By default, toolbars would display items homogeneously, so item with
2349 * long labels, like the third, will make all of them occupy a lot of space.
2350 * To avoid that, we can disable it:
2351 * @dontinclude toolbar_example_01.c
2352 * @skipline homogeneous
2354 * Another default behavior, is to add an menu item if we have more items
2355 * that would fit on toolbar size. To simply enable scroll, without menus,
2356 * it's required to change toolbar's shrink mode:
2357 * @dontinclude toolbar_example_01.c
2360 * See @ref toolbar_example_01.c "toolbar_example_01.c", whose window should
2361 * look like this picture:
2363 * @image html screenshots/toolbar_example_01.png
2364 * @image latex screenshots/toolbar_example_01.eps width=\textwidth
2366 * @example toolbar_example_01.c
2370 * @page toolbar_example_02 Toolbar Example - Items with States
2372 * This code places a Elementary toolbar widget on a window,
2373 * to exemplify part of the widget's API.
2375 * Toolbar widgets has support to items with states. Each state
2376 * can have it's own label, icon, and callback function.
2378 * Let's start populating a toolbar with some regular items.
2379 * If you don't know how to do that, see
2380 * @ref toolbar_example_01 "Toolbar Example 1".
2381 * @dontinclude toolbar_example_02.c
2382 * @skipline elm_toolbar_add
2385 * The only difference here is that we set shrink mode to #ELM_SHRINK_MODE_HIDE,
2386 * that won't display items that doesn't fit to the window.
2388 * Now, let's add an item with states. First, add the item just as any other.
2389 * @skipline elm_toolbar_item_append
2390 * @until _item_pressed
2392 * After that states can be added to this item:
2393 * @skipline state_add
2395 * @until _item_pressed
2397 * The both states and the item are using the same callback function,
2398 * that will cycle between states and unselect the item. Unseleting
2399 * is required because it won't call the callback if an user clicks
2400 * over an item already selected:
2401 * @dontinclude toolbar_example_02.c
2407 * On our example, some items are hidden
2408 * because we set the window to be small. But if an item should be displayed
2409 * anyway, is needed to set its priority to be higher than others.
2410 * Any positive value will be enough in our case. Let's force the item
2411 * with multiple states to be displayed.
2412 * @skipline priority
2414 * See @ref toolbar_example_02.c "toolbar_example_02.c", whose window should
2415 * look like this picture:
2417 * @image html screenshots/toolbar_example_02.png
2418 * @image latex screenshots/toolbar_example_02.eps width=\textwidth
2420 * @example toolbar_example_02.c
2424 * @page toolbar_example_03 Toolbar Example - Items with Menus
2426 * Toolbar widgets have support to items with menus. This kind
2427 * of item will display a menu when selected by the user.
2429 * Let's start populating a toolbar with some regular items, the same
2430 * way we started @ref toolbar_example_02 "Toolbar Example 2".
2431 * @dontinclude toolbar_example_03.c
2432 * @skipline elm_toolbar_add
2435 * The only difference is that we'll keep the default shrink mode, that
2436 * adds an item with a menu of hidden items.
2438 * So, a important thing to do is to set a parent for toolbar menus, or they
2439 * will use the toolbar as parent, and its size will be restricted to that.
2440 * @skipline parent_set
2442 * Not only items' menus will respect this parent, but also the own toolbar
2443 * menu, used to show hidden items.
2445 * Next, let's add an item set to display a menu:
2446 * @skipline elm_toolbar_item_append
2449 * Now, to add two options to this item, we can get the menu object and use
2450 * it as a regular elm_menu. See @ref tutorial_menu "Menu example" for more
2451 * about menu widget.
2452 * @skipline _menu_get
2455 * See @ref toolbar_example_03.c "toolbar_example_03.c", whose window should
2456 * look like this picture:
2458 * @image html screenshots/toolbar_example_03.png
2459 * @image latex screenshots/toolbar_example_03.eps width=\textwidth
2461 * @example toolbar_example_03.c
2465 * @page segment_control_example Segment Control Example
2467 * This code places a Elementary segment control widgets on a window,
2468 * to exemplify part of the widget's API.
2470 * Let's start adding a segment control to our window:
2471 * @dontinclude segment_control_example.c
2472 * @skipline elm_segment_control_add
2473 * @until evas_object_show
2475 * Now will add an item only with label:
2476 * @skipline item_add
2478 * Really simple. To add an item with only an icon, the icon needs to be created
2479 * first, them added with this same function:
2480 * @skipline icon_add
2483 * If an item with label and icon is required, it can be done as well. In this
2484 * case, instead of a label (or icon) centered, the item will display an icon
2485 * at left and the label at right:
2486 * @skipline icon_add
2489 * But, if you need to add some items that can have or not a label, but
2490 * want that all of them looks the same way, with icon at left, just add
2491 * an empty string label. It's done on our example to ilustrate that:
2492 * @skipline icon_add
2495 * So far, all the item were added to the last position of the widget,
2496 * but if something different is required, it can be done using another
2497 * insertion function. Let's suppose we want to put an item just before
2502 * There are two ways to delete items. Using the item handle, like:
2503 * @skipline insert_at
2506 * Or using item's index:
2507 * @skipline insert_at
2510 * To set properties of an item already added to the widget, you just need
2511 * to get the item and set icon or label, as the following code shows:
2512 * @skipline item_get
2515 * Finally, it's possible to select an item from the code, and also get
2516 * the selected item. We will select the item at the center of the widget
2517 * and print its position.
2518 * @skipline count_get
2521 * See the full @ref segment_control_example.c "example", whose window should
2522 * look like this picture:
2524 * @image html screenshots/segment_control_example.png
2525 * @image latex screenshots/segment_control_example.eps width=\textwidth
2527 * @example segment_control_example.c
2531 * @page flipselector_example Flip selector widget example
2533 * This code places an Elementary flip selector widget on a window,
2534 * along with two buttons trigerring actions on it (though its API).
2536 * The selector is being populated with the following items:
2537 * @dontinclude flipselector_example.c
2541 * Next, we create it, populating it with those items and registering
2542 * two (smart) callbacks on it:
2543 * @dontinclude flipselector_example.c
2544 * @skip fp = elm_flipselector_add
2545 * @until object_show
2547 * Those two callbacks will take place whenever one of those smart
2548 * events occur, and they will just print something to @c stdout:
2549 * @dontinclude flipselector_example.c
2550 * @skip underflow callback
2551 * @until static void
2552 * Flip the sheets on the widget while looking at the items list, in
2553 * the source code, and you'll get the idea of those events.
2555 * The two buttons below the flip selector will take the actions
2556 * described in their labels:
2557 * @dontinclude flipselector_example.c
2558 * @skip bt = elm_button_add
2559 * @until callback_add(win
2561 * @dontinclude flipselector_example.c
2562 * @skip unselect the item
2565 * Click on them to exercise those flip selector API calls. To
2566 * interact with the other parts of this API, there's a command line
2567 * interface, whose help string can be asked for with the 'h' key:
2568 * @dontinclude flipselector_example.c
2572 * The 'n' and 'p' keys will exemplify elm_flipselector_flip_next()
2573 * and elm_flipselector_flip_prev(), respectively. 'f' and 'l' account
2574 * for elm_flipselector_first_item_get() and
2575 * elm_flipselector_last_item_get(), respectively. Finally, 's' will
2576 * issue elm_flipselector_selected_item_get() on our example flip
2579 * See the full @ref flipselector_example.c "example", whose window should
2580 * look like this picture:
2582 * @image html screenshots/flipselector_example.png
2583 * @image latex screenshots/flipselector_example.eps width=\textwidth
2585 * See the full @ref flipselector_example_c "source code" for this example.
2587 * @example flipselector_example.c
2591 * @page fileselector_example File selector widget example
2593 * This code places two Elementary file selector widgets on a window.
2594 * The one on the left is layouting file system items in a @b list,
2595 * while the the other is layouting them in a @b grid.
2597 * The one having the majority of hooks of interest is on the left,
2598 * which we create as follows:
2599 * @dontinclude fileselector_example.c
2600 * @skip first file selector
2601 * @until object_show
2603 * Note that we enable custom edition of file/directory selection, via
2604 * the text entry it has on its bottom, via
2605 * elm_fileselector_is_save_set(). It starts with the list view, which
2606 * is the default, and we make it not expandable in place
2607 * (elm_fileselector_expandable_set()), so that it replaces its view's
2608 * contents with the current directory's entries each time one
2609 * navigates to a different folder. For both of file selectors we are
2610 * starting to list the contents found in the @c "/tmp" directory
2611 * (elm_fileselector_path_set()).
2613 * Note the code setting it to "grid mode" and observe the differences
2614 * in the file selector's views, in the example. We also hide the
2615 * second file selector's Ok/Cancel buttons -- since it's there just
2616 * to show the grid view (and navigation) -- via
2617 * elm_fileselector_buttons_ok_cancel_set().
2619 * The @c "done" event, which triggers the callback below
2620 * @dontinclude fileselector_example.c
2623 * will be called at the time one clicks the "Ok"/"Cancel" buttons of
2624 * the file selector (on the left). Note that it will print the path
2625 * to the current selection, if any.
2627 * The @c "selected" event, which triggers the callback below
2628 * @dontinclude fileselector_example.c
2629 * @skip bt = 'selected' cb
2631 * takes place when one selects a file (if the file selector is @b not
2632 * under folders-only mode) or when one selects a folder (when in
2633 * folders-only mode). Experiment it by selecting different file
2636 * What comes next is the code creating the three check boxes and two
2637 * buttons below the file selector in the right. They will exercise a
2638 * bunch of functions on the file selector's API, for the instance on
2639 * the left. Experiment with them, specially the buttons, to get the
2640 * difference between elm_fileselector_path_get() and
2641 * elm_fileselector_selected_get().
2643 * Finally, there's the code adding the second file selector, on the
2645 * @dontinclude fileselector_example.c
2646 * @skip second file selector
2647 * @until object_show
2649 * Pay attention to the code setting it to "grid mode" and observe the
2650 * differences in the file selector's views, in the example. We also
2651 * hide the second file selector's Ok/Cancel buttons -- since it's
2652 * there just to show the grid view (and navigation) -- via
2653 * elm_fileselector_buttons_ok_cancel_set().
2655 * See the full @ref fileselector_example.c "example", whose window
2656 * should look like this picture:
2658 * @image html screenshots/fileselector_example.png
2659 * @image latex screenshots/fileselector_example.eps width=\textwidth
2661 * See the full @ref fileselector_example_c "source code" for this example.
2663 * @example fileselector_example.c
2667 * @page fileselector_button_example File selector button widget example
2669 * This code places an Elementary file selector button widget on a
2670 * window, along with some other checkboxes and a text entry. Those
2671 * are there just as knobs on the file selector button's state and to
2672 * display information from it.
2674 * Here's how we instantiate it:
2675 * @dontinclude fileselector_button_example.c
2676 * @skip ic = elm_icon_add
2677 * @until evas_object_show
2679 * Note that we set on it both icon and label decorations. It's set to
2680 * list the contents of the @c "/tmp" directory, too, with
2681 * elm_fileselector_button_path_set(). What follows are checkboxes to
2682 * exercise some of its API funtions:
2683 * @dontinclude fileselector_button_example.c
2684 * @skip ck = elm_check_add
2685 * @until evas_object_show(en)
2687 * The checkboxes will toggle whether the file selector button's
2688 * internal file selector:
2689 * - must have an editable text entry for file names (thus, be in
2690 * "save dialog mode")
2691 * - is to be raised as an "inner window" (note it's the default
2692 * behavior) or as a dedicated window
2693 * - is to populate its view with folders only
2694 * - is to expand its folders, in its view, <b>in place</b>, and not
2695 * repainting it entirely just with the contents of a sole
2698 * The entry labeled @c "Last selection" will exercise the @c
2699 * "file,chosen" smart event coming from the file selector button:
2700 * @dontinclude fileselector_button_example.c
2702 * @until toggle inwin
2704 * Whenever you dismiss or acknowledges the file selector, after it's
2705 * raised, the @c event_info string will contain the last selection on
2706 * it (if any was made).
2708 * This is how the example, just after called, should look like:
2710 * @image html screenshots/fileselector_button_example_00.png
2711 * @image latex screenshots/fileselector_button_example_00.eps width=\textwidth
2713 * Click on the file selector button to raise its internal file
2714 * selector, which will be contained on an <b>"inner window"</b>:
2716 * @image html screenshots/fileselector_button_example_01.png
2717 * @image latex screenshots/fileselector_button_example_01.eps width=\textwidth
2719 * Toggle the "inwin mode" switch off and, if you click on the file
2720 * selector button again, you'll get @b two windows, the original one
2721 * (note the last selection there!)
2723 * @image html screenshots/fileselector_button_example_02.png
2724 * @image latex screenshots/fileselector_button_example_02.eps width=\textwidth
2726 * and the file selector's new one
2728 * @image html screenshots/fileselector_button_example_03.png
2729 * @image latex screenshots/fileselector_button_example_03.eps width=\textwidth
2731 * Play with the checkboxes to get the behavior changes on the file
2732 * selector button. The respective API calls on the widget coming from
2733 * those knobs where shown in the code already.
2735 * See the full @ref fileselector_button_example_c "source code" for
2738 * @example fileselector_button_example.c
2742 * @page fileselector_entry_example File selector entry widget example
2744 * This code places an Elementary file selector entry widget on a
2745 * window, along with some other checkboxes. Those are there just as
2746 * knobs on the file selector entry's state.
2748 * Here's how we instantiate it:
2749 * @dontinclude fileselector_entry_example.c
2750 * @skip ic = elm_icon_add
2751 * @until evas_object_show
2753 * Note that we set on it's button both icon and label
2754 * decorations. It's set to exhibit the path of (and list the contents
2755 * of, when internal file selector is launched) the @c "/tmp"
2756 * directory, also, with elm_fileselector_entry_path_set(). What
2757 * follows are checkboxes to exercise some of its API funtions:
2758 * @dontinclude fileselector_entry_example.c
2759 * @skip ck = elm_check_add
2760 * @until callback_add(fs_entry
2762 * The checkboxes will toggle whether the file selector entry's
2763 * internal file selector:
2764 * - must have an editable text entry for file names (thus, be in
2765 * "save dialog mode")
2766 * - is to be raised as an "inner window" (note it's the default
2767 * behavior) or as a dedicated window
2768 * - is to populate its view with folders only
2769 * - is to expand its folders, in its view, <b>in place</b>, and not
2770 * repainting it entirely just with the contents of a sole
2773 * Observe how the entry's text will match the string coming from the
2774 * @c "file,chosen" smart event:
2775 * @dontinclude fileselector_entry_example.c
2778 * Whenever you dismiss or acknowledges the file selector, after it's
2779 * raised, the @c event_info string will contain the last selection on
2780 * it (if any was made).
2782 * Try, also, to type in a valid system path and, then, open the file
2783 * selector's window: it will start the file browsing there, for you.
2785 * This is how the example, just after called, should look like:
2787 * @image html screenshots/fileselector_entry_example_00.png
2788 * @image latex screenshots/fileselector_entry_example_00.eps width=\textwidth
2790 * Click on the file selector entry to raise its internal file
2791 * selector, which will be contained on an <b>"inner window"</b>:
2793 * @image html screenshots/fileselector_entry_example_01.png
2794 * @image latex screenshots/fileselector_entry_example_01.eps width=\textwidth
2796 * Toggle the "inwin mode" switch off and, if you click on the file
2797 * selector entry again, you'll get @b two windows, the original one
2798 * (note the last selection there!)
2800 * @image html screenshots/fileselector_entry_example_02.png
2801 * @image latex screenshots/fileselector_entry_example_02.eps width=\textwidth
2803 * and the file selector's new one
2805 * @image html screenshots/fileselector_entry_example_03.png
2806 * @image latex screenshots/fileselector_entry_example_03.eps width=\textwidth
2808 * Play with the checkboxes to get the behavior changes on the file
2809 * selector entry. The respective API calls on the widget coming from
2810 * those knobs where shown in the code already.
2812 * See the full @ref fileselector_entry_example_c "source code" for
2815 * @example fileselector_entry_example.c
2819 * @page layout_example_01 Layout - Content, Table and Box
2821 * This example shows how one can use the @ref Layout widget to create a
2822 * customized distribution of widgets on the screen, controled by an Edje theme.
2823 * The full source code for this example can be found at @ref
2824 * layout_example_01_c.
2826 * Our custom layout is defined by a file, @ref layout_example_edc, which is an
2827 * Edje theme file. Look for the Edje documentation to understand it. For now,
2828 * it's enough to know that we describe some specific parts on this layout
2830 * @li a title text field;
2831 * @li a box container;
2832 * @li a table container;
2833 * @li and a content container.
2835 * Going straight to the code, the following snippet instantiates the layout
2838 * @dontinclude layout_example_01.c
2839 * @skip elm_layout_add
2840 * @until evas_object_show(layout)
2842 * As any other widget, we set some properties for the size calculation. But
2843 * notice on this piece of code the call to the function elm_layout_file_set().
2844 * Here is where the theme file is loaded, and particularly the specific group
2845 * from this theme file. Also notice that the theme file here is referenced as
2846 * an .edj, which is a .edc theme file compiled to its binary form. Again, look
2847 * for the Edje documentation for more information about theme files.
2849 * Next, we fetch from our theme a data string referenced by the key "title".
2850 * This data was defined in the theme, and can be used as parameters which the
2851 * program get from the specific theme that it is using. In this case, we store
2852 * the title of this window and program in the theme, as a "data" entry, just
2853 * for demonstration purposes:
2857 * This call elm_layout_data_get() is used to fetch the string based on the key,
2858 * and elm_object_text_part_set() will set the part defined in the theme as
2859 * "example/title" to contain this string. This key "example/title" has nothing
2860 * special. It's just an arbitrary convention that we are using in this example.
2861 * Every string in this example referencing a part of this theme will be of the
2862 * form "example/<something>".
2864 * Now let's start using our layout to distribute things on the window space.
2865 * Since the layout was added as a resize object to the elementary window, it
2866 * will always occupy the entire space available for this window.
2868 * The theme already has a title, and it also defines a table element which is
2869 * positioned approximately between 50% and 70% of the height of this window,
2870 * and has 100% of the width. We create some widgets (two icons, a clock and a
2871 * button) and pack them inside the table, in a distribution similar to a HTML
2874 * @until evas_object_show(bt)
2876 * Notice that we just set size hints for every object, and call the function
2877 * elm_layout_table_pack(), which does all the work. It will place the elements
2878 * in the specified row/column, with row and column span if required, and then
2879 * the object's size and position will be controled by the layout widget. It
2880 * will also respect size hints, alignments and weight properties set to these
2881 * widgets. The resulting distribution on the screen depends on the table
2882 * properties (described in the theme), the size hints set on each widget, and
2883 * on the cells of the table that are being used.
2885 * For instance, we add the two icons and the clock on the first, second and
2886 * third cells of the first row, and add the button the second row, making it
2887 * span for 3 columns (thus having the size of the entire table width). This
2888 * will result in a table that has 2 rows and 3 columns.
2890 * Now let's add some widgets to the box area of our layout. This box is around
2891 * 20% and 50% of the vertical size of the layout, and 100% of its width. The
2892 * theme defines that it will use an "horizontal flow" distribution to its
2893 * elements. Unlike the table, a box will distribute elements without knowing
2894 * about rows and columns, and the distribution function selected will take care
2895 * of putting them in row, column, both, or any other available layout. This is
2896 * also described in the Edje documentation.
2898 * This box area is similar to the @ref Box widget of elementary, with the
2899 * difference that its position and properties are controled by the theme of the
2900 * layout. It also contains more than one API to add items to it, since the
2901 * items position now is defined in terms of a list of items, not a matrix.
2902 * There's the first position (can have items added to it with
2903 * elm_layout_box_prepend()), the last position (elm_layout_box_append()), the
2904 * nth position (elm_layout_box_insert_at()) and the position right before an
2905 * element (elm_layout_box_insert_before()). We use insert_at and prepend
2906 * functions to add the first two buttons to this box, and insert_before on the
2907 * callback of each button. The callback code will be shown later, but it
2908 * basically adds a button just before the clicked button using the
2909 * elm_layout_box_insert_before() function. Here's the code for adding the first
2912 * @until evas_object_show(item)
2913 * @until evas_object_show(item)
2915 * Finally, we have an area in this layout theme, in the bottom part of it,
2916 * reserved for adding an specific widget. Differently from the 2 parts
2917 * described until now, this one can only receive one widget with the call
2918 * elm_layout_content_set(). If there was already an item on this specific part,
2919 * it will be deleted (one can use elm_layout_content_unset() in order to remove
2920 * it without deleting). An example of removing it without deleting, but
2921 * manually deleting this widget just after that, can be seen on the callback
2922 * for this button. Actually, the callback defined for this button will clean
2923 * the two other parts (deleting all of their elements) and then remove and
2924 * delete this button.
2926 * @until _swallow_btn_cb
2928 * Also notice that, for this last added button, we don't have to call
2929 * evas_object_show() on it. This is a particularity of the theme for layouts,
2930 * that will have total control over the properties like size, position,
2931 * visibility and clipping of a widget added with elm_layout_content_set().
2932 * Again, read the Edje documentation to understand this better.
2934 * Now we just put the code for the different callbacks specified for each kind
2935 * of button and make simple comments about them:
2937 * @dontinclude layout_example_01.c
2939 * @until evas_object_del(item)
2942 * The first callback is used for the button in the table, and will just remove
2943 * itself from the table with elm_layout_table_unpack(), which remove items
2944 * without deleting them, and then calling evas_object_del() on itself.
2946 * The second callback is for buttons added to the box. When clicked, these
2947 * buttons will create a new button, and add them to the same box, in the
2948 * position just before the clicked button.
2950 * And the last callback is for the button added to the "content" area. It will
2951 * clear both the table and the box, passing @c EINA_TRUE to their respective @c
2952 * clear parameters, which will imply on the items of these containers being
2955 * A screenshot of this example can be seen on:
2957 * @image html screenshots/layout_example_01.png
2958 * @image latex screenshots/layout_example_01.eps width=\textwidth
2963 * @page layout_example_02 Layout - Predefined Layout
2965 * This example shows how one can use the @ref Layout with a predefined theme
2966 * layout to add a back and next button to a simple window. The full source code
2967 * for this example can be found at @ref layout_example_02_c.
2969 * After setting up the window and background, we add the layout widget to the
2970 * window. But instead of using elm_layout_file_set() to load its theme from a
2971 * custom theme file, we can use elm_layout_theme_set() to load one of the
2972 * predefined layouts that come with elementary. Particularly on this example,
2973 * we load the them of class "layout", group "application" and style
2974 * "content-back-next" (since we want the back and next buttons).
2976 * @dontinclude layout_example_02.c
2977 * @skip elm_layout_add
2978 * @until evas_object_show(layout)
2980 * This default theme contains only a "content" area named
2981 * "elm.swallow.content", where we can add any widget (it can be even a
2982 * container widget, like a box, frame, list, or even another layout). Since we
2983 * just want to show the resulting layout, we add a simple icon to it:
2985 * @until layout_content_set
2987 * This default layout also provides some signals when the next and prev buttons
2988 * are clicked. We can register callbacks to them with the
2989 * elm_object_signal_callback_add() function:
2991 * @until elm,action,next
2993 * In the @ref layout_example_03 you can see how to send signals to the layout with
2994 * elm_object_signal_emit().
2996 * Now our callback just changes the picture being displayed when one of the
2997 * buttons are clicked:
2999 * @dontinclude layout_example_02.c
3001 * @until standard_set
3004 * It's possible to see that it gets the name of the image being shown from the
3005 * array of image names, going forward on this array when "next" is clicked and
3006 * backward when "back" is clicked.
3008 * A screenshot of this example can be seen on:
3010 * @image html screenshots/layout_example_02.png
3011 * @image latex screenshots/layout_example_02.eps width=\textwidth
3015 * @page layout_example_03 Layout - Signals and Size Changed
3017 * This example shows how one can send and receive signals to/from the layout,
3018 * and what to do when the layout theme has its size changed. The full source
3019 * code for this example can be found at @ref layout_example_03_c.
3021 * In this exmaple we will use another group from the same layout theme file
3022 * used in @ref layout_example_01. Its instanciation and loading happens in the
3025 * @dontinclude layout_example_03.c
3026 * @skip elm_layout_add
3027 * @until evas_object_show
3029 * This time we register a callback to be called whenever we receive a signal
3030 * after the end of the animation that happens in this layout:
3032 * @until signal_callback_add
3034 * We also add a button that will send signals to the layout:
3036 * @until callback_add
3038 * The callback for this button will check what type of signal it should send,
3039 * and then emit it. The code for this callback follows:
3041 * @dontinclude layout_example_03.c
3042 * @skip static Eina_Bool
3047 * As we said before, we are receiving a signal whenever the animation started
3048 * by the button click ends. This is the callback for that signal:
3052 * Notice from this callback that the elm_layout_sizing_eval() function must be
3053 * called if we want our widget to update its size after the layout theme having
3054 * changed its minimum size. This happens because the animation specified in the
3055 * theme increases the size of the content area to a value higher than the
3056 * widget size, thus requiring more space. But the elementary layout widget
3057 * has no way to know this, thus needing the elm_layout_sizing_eval() to
3058 * be called on the layout, informing that this size has changed.
3060 * A screenshot of this example can be seen on:
3062 * @image html screenshots/layout_example_03.png
3063 * @image latex screenshots/layout_example_03.eps width=\textwidth
3067 * @page tutorial_hover Hover example
3068 * @dontinclude hover_example_01.c
3070 * On this example we are going to have a button that when clicked will show our
3071 * hover widget, this hover will have content set on it's left, top, right and
3072 * middle positions. In the middle position we are placing a button that when
3073 * clicked will hide the hover. We are also going to use a non-default theme
3074 * for our hover. We won't explain the functioning of button for that see @ref
3077 * We start our example with a couple of callbacks that show and hide the data
3078 * they're given(which we'll see later on is the hover widget):
3083 * In our main function we'll do some initialization and then create 3
3084 * rectangles, one red, one green and one blue to use in our hover. We'll also
3085 * create the 2 buttons that will show and hide the hover:
3088 * With all of that squared away we can now get to the heart of the matter,
3089 * creating our hover widget, which is easy as pie:
3092 * Having created our hover we now need to set the parent and target. Which if
3093 * you recall from the function documentations are going to tell the hover which
3094 * area it should cover and where it should be centered:
3097 * Now we set the theme for our hover. We're using the popout theme which gives
3098 * our contents a white background and causes their appearance to be animated:
3101 * And finally we set the content for our positions:
3104 * So far so good? Great 'cause that's all there is too it, what is left now is
3105 * just connecting our buttons to the callbacks we defined at the beginning of
3106 * the example and run the main loop:
3109 * Our example will initially look like this:
3111 * @image html screenshots/hover_example_01.png
3112 * @image latex screenshots/hover_example_01.eps width=\textwidth
3114 * And after you click the "Show hover" button it will look like this:
3116 * @image html screenshots/hover_example_01_a.png
3117 * @image latex screenshots/hover_example_01_a.eps width=\textwidth
3119 * @example hover_example_01.c
3123 * @page tutorial_flip Flip example
3124 * @dontinclude flip_example_01.c
3126 * This example will show a flip with two rectangles on it(one blue, one
3127 * green). Our example will allow the user to choose the animation the flip
3128 * uses and to interact with it. To allow the user to choose the interaction
3129 * mode we use radio buttons, we will however not explain them, if you would
3130 * like to know more about radio buttons see @ref Radio.
3132 * We start our example with the usual setup and then create the 2 rectangles
3133 * we will use in our flip:
3134 * @until show(rect2)
3136 * The next thing to do is to create our flip and set it's front and back
3140 * The next thing we do is set the interaction mode(which the user can later
3141 * change) to the page animation:
3144 * Setting a interaction mode however is not sufficient, we also need to
3145 * choose which directions we allow interaction from, for this example we
3146 * will use all of them:
3149 * We are also going to set the hitsize to the entire flip(in all directions)
3150 * to make our flip very easy to interact with:
3153 * After that we create our radio buttons and start the main loop:
3156 * When the user clicks a radio button a function that changes the
3157 * interaction mode and animates the flip is called:
3159 * @note The elm_flip_go() call here serves no purpose other than to
3160 * ilustrate that it's possible to animate the flip programmatically.
3162 * Our example will look like this:
3164 * @image html screenshots/flip_example_01.png
3165 * @image latex screenshots/flip_example_01.eps width=\textwidth
3167 * @note Since this is an animated example the screenshot doesn't do it
3168 * justice, it is a good idea to compile it and see the animations.
3170 * @example flip_example_01.c
3174 * @page tutorial_label Label example
3175 * @dontinclude label_example_01.c
3177 * In this example we are going to create 6 labels, set some properties on
3178 * them and see what changes in appearance those properties cause.
3180 * We start with the setup code that by now you should be familiar with:
3183 * For our first label we have a moderately long text(that doesn't fit in the
3184 * label's width) so we will make it a sliding label. Since the text isn't
3185 * too long we don't need the animation to be very long, 3 seconds should
3186 * give us a nice speed:
3189 * For our second label we have the same text, but this time we aren't going
3190 * to have it slide, we're going to ellipsize it. Because we ask our label
3191 * widget to ellipsize the text it will first diminsh the fontsize so that it
3192 * can show as much of the text as possible:
3195 * For the third label we are going to ellipsize the text again, however this
3196 * time to make sure the fontsize isn't diminshed we will set a line wrap.
3197 * The wrap won't actually cause a line break because we set the label to
3201 * For our fourth label we will set line wrapping but won't set ellipsis, so
3202 * that our text will indeed be wrapped instead of ellipsized. For this label
3203 * we choose character wrap:
3206 * Just two more, for our fifth label we do the same as for the fourth
3207 * except we set the wrap to word:
3210 * And last but not least for our sixth label we set the style to "marker" and
3211 * the color to red(the default color is white which would be hard to see on
3212 * our white background):
3215 * Our example will look like this:
3217 * @image html screenshots/label_example_01.png
3218 * @image latex screenshots/label_example_01.eps width=\textwidth
3220 * @example label_example_01.c
3224 * @page tutorial_image Image example
3225 * @dontinclude image_example_01.c
3227 * This example is as simple as possible. An image object will be added to the
3228 * window over a white background, and set to be resizeable together with the
3229 * window. All the options set through the example will affect the behavior of
3232 * We start with the code for creating a window and its background, and also
3233 * add the code to write the path to the image that will be loaded:
3238 * Now we create the image object, and set that file to be loaded:
3242 * We can now go setting our options.
3244 * elm_image_no_scale_set() is used just to set this value to true (we
3245 * don't want to scale our image anyway, just resize it).
3247 * elm_image_scale_set() is used to allow the image to be resized to a size
3248 * smaller than the original one, but not to a size bigger than it.
3250 * elm_elm_image_smooth_set() will disable the smooth scaling, so the scale
3251 * algorithm used to scale the image to the new object size is going to be
3252 * faster, but with a lower quality.
3254 * elm_image_orient_set() is used to flip the image around the (1, 0) (0, 1)
3257 * elm_image_aspect_ratio_retained_set() is used to keep the original aspect
3258 * ratio of the image, even when the window is resized to another aspect ratio.
3260 * elm_image_fill_outside_set() is used to ensure that the image will fill the
3261 * entire area available to it, even if keeping the aspect ratio. The image
3262 * will overflow its width or height (any of them that is necessary) to the
3263 * object area, instead of resizing the image down until it can fit entirely in
3266 * elm_image_editable_set() is used just to cover the API, but won't affect
3267 * this example since we are not using any copy & paste property.
3269 * This is the code for setting these options:
3273 * Now some last touches in our object size hints, window and background, to
3274 * display this image properly:
3278 * This example will look like this:
3280 * @image html screenshots/image_example_01.png
3281 * @image latex screenshots/image_example_01.eps width=\textwidth
3283 * @example image_example_01.c
3287 * @page tutorial_icon Icon example
3288 * @dontinclude icon_example_01.c
3290 * This example is as simple as possible. An icon object will be added to the
3291 * window over a white background, and set to be resizeable together with the
3292 * window. All the options set through the example will affect the behavior of
3295 * We start with the code for creating a window and its background:
3300 * Now we create the icon object, and set lookup order of the icon, and choose
3305 * An intersting thing is that after setting this, it's possible to check where
3306 * in the filesystem is the theme used by this icon, and the name of the group
3311 * We can now go setting our options.
3313 * elm_icon_no_scale_set() is used just to set this value to true (we
3314 * don't want to scale our icon anyway, just resize it).
3316 * elm_icon_scale_set() is used to allow the icon to be resized to a size
3317 * smaller than the original one, but not to a size bigger than it.
3319 * elm_elm_icon_smooth_set() will disable the smooth scaling, so the scale
3320 * algorithm used to scale the icon to the new object size is going to be
3321 * faster, but with a lower quality.
3323 * elm_icon_fill_outside_set() is used to ensure that the icon will fill the
3324 * entire area available to it, even if keeping the aspect ratio. The icon
3325 * will overflow its width or height (any of them that is necessary) to the
3326 * object area, instead of resizing the icon down until it can fit entirely in
3329 * This is the code for setting these options:
3331 * @until fill_outside
3333 * However, if you try this example you may notice that this image is not being
3334 * affected by all of these options. This happens because the used icon will be
3335 * from elementary theme, and thus it has its own set of options like smooth
3336 * scaling and fill_outside options. You can change the "home" icon to use some
3337 * image (from your system) and see that then those options will be respected.
3339 * Now some last touches in our object size hints, window and background, to
3340 * display this icon properly:
3344 * This example will look like this:
3346 * @image html screenshots/icon_example_01.png
3347 * @image latex screenshots/icon_example_01.eps width=\textwidth
3349 * @example icon_example_01.c
3353 * @page tutorial_hoversel Hoversel example
3354 * @dontinclude hoversel_example_01.c
3356 * In this example we will create a hoversel with 3 items, one with a label but
3357 * no icon and two with both a label and an icon. Every item that is clicked
3358 * will be deleted, but everytime the hoversel is activated we will also add an
3359 * item. In addition our first item will print all items when clicked and our
3360 * third item will clear all items in the hoversel.
3362 * We will start with the normal creation of window stuff:
3365 * Next we will create a red rectangle to use as the icon of our hoversel:
3368 * And now we create our hoversel and set some of it's properties. We set @p win
3369 * as its parent, ask it to not be horizontal(be vertical) and give it a label
3373 * Next we will add our three items, setting a callback to be called for the
3377 * We also set a pair of callbacks to be called whenever any item is selected or
3378 * when the hoversel is activated:
3381 * And then ask that our hoversel be shown and run the main loop:
3384 * We now have the callback for our first item which prints all items in the
3388 * Next we have the callback for our third item which removes all items from the
3392 * Next we have the callback that is called whenever an item is clicked and
3393 * deletes that item:
3396 * And the callback that is called when the hoversel is activated and adds an
3397 * item to the hoversel. Note that since we allocate memory for the item we need
3398 * to know when the item dies so we can free that memory:
3401 * And finally the callback that frees the memory we allocated for items created
3402 * in the @p _add_item callback:
3405 * Our example will initially look like this:
3407 * @image html screenshots/hoversel_example_01.png
3408 * @image latex screenshots/hoversel_example_01.eps width=\textwidth
3410 * And when the hoversel is clicked it will look like this:
3412 * @image html screenshots/hoversel_example_01_a.png
3413 * @image latex screenshots/hoversel_example_01_a.eps width=\textwidth
3415 * @example hoversel_example_01.c
3419 * @page conformant_example Conformant Example.
3421 * In this example we'll explain how to create applications to work
3422 * with illume, considering space required for virtual keyboards, indicator
3425 * Illume is a module for Enlightenment that modifies the user interface
3426 * to work cleanly and nicely on a mobile device. It has support for
3427 * virtual keyboard, among other nice features.
3429 * Let's start creating a very simple window with a vertical box
3430 * with multi-line entry between two buttons.
3431 * This entry will expand filling all space on window not used by buttons.
3433 * @dontinclude conformant_example_01.c
3434 * @skipline elm_main
3437 * For information about how to create windows, boxes, buttons or entries,
3438 * look for documentation for these widgets.
3440 * It will looks fine when you don't need a virtual keyboard, as you
3441 * can see on the following image:
3443 * @image html screenshots/conformant_example_01.png
3444 * @image latex screenshots/conformant_example_01.eps width=\textwidth
3446 * But if you call a virtual keyboard, the window will resize, changing
3447 * widgets size and position. All the content will shrink.
3449 * If you don't want such behaviour, you
3450 * will need a conformant to account for space taken up by the indicator,
3451 * virtual keyboard and softkey.
3453 * In this case, using the conformant in a proper way, you will have
3454 * a window like the following:
3456 * @image html screenshots/conformant_example_02.png
3457 * @image latex screenshots/conformant_example_02.eps width=\textwidth
3459 * As you can see, it guess the space that will be required by the keyboard,
3460 * indicator and softkey bars.
3462 * So, let's study each step required to transform our initial example on
3465 * First of all, we need to set the window as an illume conformant window:
3466 * @dontinclude conformant_example_02.c
3467 * @skipline elm_win_conformant_set
3469 * Next, we'll add a conformant widget, and set it to resize with the window,
3470 * instead of the box.
3472 * @until evas_object_show
3474 * Finally, we'll set the box as conformant's content, just like this:
3475 * @skipline elm_conformant_content_set
3477 * Compare both examples code:
3478 * @ref conformant_example_01.c "conformant_example_01.c"
3479 * @ref conformant_example_02.c "conformant_example_02.c"
3481 * @example conformant_example_01.c
3482 * @example conformant_example_02.c
3486 * @page index_example_01 Index widget example 1
3488 * This code places an Elementary index widget on a window, which also
3489 * has a very long list of arbitrary strings on it. The list is
3490 * sorted alphabetically and the index will be used to index the first
3491 * items of each set of strings beginning with an alphabet letter.
3493 * Below the list are some buttons, which are there just to exercise
3494 * some index widget's API.
3496 * Here's how we instantiate it:
3497 * @dontinclude index_example_01.c
3498 * @skip elm_list_add
3499 * @until evas_object_show(d.index)
3500 * where we're showing also the list being created. Note that we issue
3501 * elm_win_resize_object_add() on the index, so that it's set to have
3502 * the whole window as its container. Then, we have to populate both
3503 * list and index widgets:
3504 * @dontinclude index_example_01.c
3505 * @skip for (i = 0; i < (sizeof(dict) / sizeof(dict[0])); i++)
3509 * The strings populating the list come from a file
3510 * @dontinclude index_example_01.c
3511 * @skip static const char *dict
3514 * We use the @c curr char variable to hold the last initial letter
3515 * seen on that ordered list of strings, so that we're able to have an
3516 * index item pointing to each list item starting a new letter
3517 * "section". Note that our index item data pointers will be the list
3518 * item handles. We are also setting a callback function to index
3519 * items deletion events:
3520 * @dontinclude index_example_01.c
3524 * There, we show you that the @c event_info pointer will contain the
3525 * item in question's data, i.e., a given list item's pointer. Because
3526 * item data is also returned in the @c data argument on
3527 * @c Evas_Smart_Cb functions, those two pointers must have the same
3528 * values. On this deletion callback, we're deleting the referred list
3529 * item too, just to exemplify that anything could be done there.
3531 * Next, we hook to two smart events of the index object:
3532 * @dontinclude index_example_01.c
3533 * @skip smart_callback_add(d.index
3534 * @until _index_selected
3535 * @dontinclude index_example_01.c
3536 * @skip "delay,changed" hook
3540 * Check that, whenever one holds the mouse pressed over a given index
3541 * letter for some time, the list beneath it will roll down to the
3542 * item pointed to by that index item. When one releases the mouse
3543 * button, the second callback takes place. There, we check that the
3544 * reported item data, on @c event_info, is the same reported by
3545 * elm_index_item_selected_get(), which gives the last selection's
3546 * data on the index widget.
3548 * The first of the three buttons that follow will call
3549 * elm_index_active_set(), thus showing the index automatically for
3550 * you, if it's not already visible, what is checked with
3551 * elm_index_active_get(). The second button will exercise @b deletion
3552 * of index item objects, by the following code:
3553 * @dontinclude index_example_01.c
3554 * @skip delete an index item
3557 * It will get the last index item selected's data and find the
3558 * respective #Elm_Index_Item handle with elm_index_item_find(). We
3559 * need the latter to query the indexing letter string from, with
3560 * elm_index_item_letter_get(). Next, comes the delition, itself,
3561 * which will also trigger the @c _index_item_del callback function,
3564 * The third button, finally, will exercise elm_index_item_clear(),
3565 * which will delete @b all of the index's items.
3567 * This is how the example program's window looks like with the index
3569 * @image html screenshots/index_example_00.png
3570 * @image latex screenshots/index_example_00.eps
3572 * When it's shown, it's like the following figure:
3573 * @image html screenshots/index_example_01.png
3574 * @image latex screenshots/index_example_01.eps
3576 * See the full @ref index_example_01_c "source code" for
3579 * @example index_example_01.c
3583 * @page index_example_02 Index widget example 2
3585 * This code places an Elementary index widget on a window, indexing
3586 * grid items. The items are placed so that their labels @b don't
3587 * follow any order, but the index itself is ordered (through
3588 * elm_index_item_sorted_insert()). This is a complement to to @ref
3589 * index_example_01 "the first example on indexes".
3591 * Here's the list of item labels to be used on the grid (in that
3593 * @dontinclude index_example_02.c
3594 * @skip static const char *items
3597 * In the interesting part of the code, here, we first instantiate the
3598 * grid (more on grids on their examples) and, after creating our
3599 * index, for each grid item we also create an index one to reference
3601 * @dontinclude index_example_02.c
3602 * @skip grid = elm_gengrid_add
3604 * @until smart_callback_add
3606 * The order in which they'll appear in the index, though, is @b
3607 * alphabetical, becase of elm_index_item_sorted_insert() usage
3608 * together with the comparing function, where we take the letters of
3609 * each index item to base our ordering on. The parameters on
3610 * @c _index_cmp have to be declared as void pointers because of the
3611 * @c Eina_Compare_Cb prototype requisition, but in this case we know
3612 * they'll be #Elm_Index_Item's:
3613 * @dontinclude index_example_02.c
3614 * @skip ordering alphabetically
3617 * The last interesting bit is the callback in the @c "delay,changed"
3618 * smart event, which will bring the given grid item to the grid's
3620 * @dontinclude index_example_02.c
3624 * Note how the grid will move kind of randomly while you move your
3625 * mouse pointer held over the index from top to bottom -- that's
3626 * because of the the random order the items have in the grid itself.
3628 * This is how the example program's window looks like:
3629 * @image html screenshots/index_example_03.png
3630 * @image latex screenshots/index_example_03.eps
3632 * See the full @ref index_example.c "source code" for
3635 * @example index_example_02.c
3639 * @page tutorial_ctxpopup Ctxpopup example
3640 * @dontinclude ctxpopup_example_01.c
3642 * In this example we have a list with two items, when either item is clicked
3643 * a ctxpopup for it will be shown. Our two ctxpopups are quite different, the
3644 * one for the first item is a vertical and it's items contain both labels and
3645 * icons, the one for the second item is horizontal and it's items have icons
3648 * We will begin examining our example code by looking at the callback we'll use
3649 * when items in the ctxpopup are clicked. It's very simple, all it does is
3650 * print the label present in the ctxpopup item:
3653 * Next we examine a function that creates ctxpopup items, it was created to
3654 * avoid repeating the same code whenever we needed to add an item to our
3655 * ctxpopup. Our function creates an icon from the standard set of icons, and
3656 * then creates the item, with the label received as an argument. We also set
3657 * the callback to be called when the item is clicked:
3660 * Finally we have the function that will create the ctxpopup for the first item
3661 * in our list. This one is somewhat more complex though, so let's go through it
3662 * in parts. First we declare our variable and add the ctxpopup:
3663 * @until ctxpopup_add
3665 * Next we create a bunch of items for our ctxpopup, marking two of them as
3666 * disabled just so we can see what that will look like:
3667 * @until disabled_set
3668 * @until disabled_set
3670 * Then we ask evas where the mouse pointer was so that we can have our ctxpopup
3671 * appear in the right place, set a maximum size for the ctxpopup, move it and
3675 * And last we mark the list item as not selected:
3678 * Our next function is the callback that will create the ctxpopup for the
3679 * second list item, it is very similar to the previous function. A couple of
3680 * interesting things to note is that we ask our ctxpopup to be horizontal, and
3681 * that we pass NULL as the label for every item:
3684 * And with all of that in place we can now get to our main function where we
3685 * create the window, the list, the list items and run the main loop:
3688 * The example will initially look like this:
3690 * @image html screenshots/ctxpopup_example_01.png
3691 * @image latex screenshots/ctxpopup_example_01.eps width=\textwidth
3693 * @note This doesn't show the ctxpopup tough, since it will only appear when
3694 * we click one of the list items.
3696 * Here is what our first ctxpopup will look like:
3698 * @image html screenshots/ctxpopup_example_01_a.png
3699 * @image latex screenshots/ctxpopup_example_01_a.eps width=\textwidth
3701 * And here the second ctxpopup:
3703 * @image html screenshots/ctxpopup_example_01_b.png
3704 * @image latex screenshots/ctxpopup_example_01_b.eps width=\textwidth
3706 * @example ctxpopup_example_01.c
3710 * @page tutorial_pager
3711 * @dontinclude pager_example_01.c
3713 * In this example we'll have a pager with 3 rectangles on it, one blue, one
3714 * green and one blue, we'll also have 1 button for each rectangle. Pressing a
3715 * button will bring the associated rectangle to the front of the pager(promote
3718 * We start our example with some run of the mill code that you've seen in other
3722 * And then we get right to creating our pager, setting a style and some basic
3726 * Well a pager without any content is not of much use, so let's create the
3727 * first of our rectangles, add it to the pager and create the button for it:
3728 * @until smart_callback
3729 * @note The only line of above code that directly relates to our pager is the
3730 * call to elm_pager_content_push().
3732 * And now we will do the same thing again twice for our next two rectangles:
3733 * @until smart_callback
3734 * @until smart_callback
3736 * Now that we haver our widgets create we can get to running the main loop:
3739 * We also have the callback that is called when any of the buttons is pressed,
3740 * this callback is receiving the rectangle in it's @p data argument, so we
3741 * check if it's already on top and if not move it there:
3744 * Our example will look like this:
3746 * @image html screenshots/pager_example_01.png
3747 * @image latex screenshots/pager_example_01.eps width=\textwidth
3748 * @note Like all examples that involve animations the screenshot doesn't do it
3749 * justice, seeing it in action is a must.
3751 * @example pager_example_01.c
3755 * @page tutorial_separator Separator example
3756 * @dontinclude separator_example_01.c
3758 * In this example we are going to pack two rectangles in a box, and have a
3759 * separator in the middle.
3761 * So we start we the window, background, box and rectangle creation, all pretty
3765 * Once we have our first rectangle in the box we create and add our separator:
3767 * @note Since our box is in horizontal mode it's a good idea to set the
3768 * separator to be horizontal too.
3770 * And now we add our second rectangle and run the main loop:
3773 * This example will look like this:
3775 * @image html screenshots/separator_example_01.png
3776 * @image latex screenshots/separator_example_01.eps width=\textwidth
3778 * @example separator_example_01.c
3782 * @page tutorial_radio Radio example
3783 * @dontinclude radio_example_01.c
3785 * In this example we will create 4 radio buttons, three of them in a group and
3786 * another one not in the group. We will also have the radios in the group
3787 * change the value of a variable directly and have then print it when the value
3788 * changes. The fourth button is in the example just to make clear that radios
3789 * outside the group don't affect the group.
3791 * We'll start with the usual includes:
3794 * And move right to declaring a static variable(the one whose value the radios
3798 * We now need to have a window and all that good stuff to be able to place our
3802 * And now we create a radio button, since this is the first button in our group
3803 * we set the group to be the radio(so we can set the other radios in the same
3804 * group). We also set the state value of this radio to 1 and the value pointer
3805 * to @p val, since val is @p 1 this has the additional effect of setting the
3806 * radio value to @p 1. For this radio we choose the default home icon:
3809 * To check that our radio buttons are working we'll add a callback to the
3810 * "changed" signal of the radio:
3811 * @until smart_callback
3813 * The creation of our second radio button is almost identical, the 2
3814 * differences worth noting are, the value of this radio 2 and that we add this
3815 * radio to the group of the first radio:
3816 * @until smart_callback
3818 * For our third callback we'll omit the icon and set the value to 3, we'll also
3819 * add it to the group of the first radio:
3820 * @until smart_callback
3822 * Our fourth callback has a value of 4, no icon and most relevantly is not a
3823 * member of the same group as the other radios:
3826 * We finally run the main loop:
3829 * And the last detail in our example is the callback that prints @p val so that
3830 * we can see that the radios are indeed changing its value:
3833 * The example will look like this:
3835 * @image html screenshots/radio_example_01.png
3836 * @image latex screenshots/radio_example_01.eps width=\textwidth
3838 * @example radio_example_01.c
3842 * @page tutorial_toggle Toggle example
3843 * @dontinclude toggle_example_01.c
3845 * In this example we'll create 2 toggle widgets. The first will have an icon
3846 * and the state names will be the default "on"/"off", it will also change the
3847 * value of a variable directly. The second won't have a icon, the state names
3848 * will be "Enabled"/"Disabled", it will start "Enabled" and it won't set the
3849 * value of a variable.
3851 * We start with the usual includes and prototype for callback which will be
3852 * implemented and detailed later on:
3855 * We then declare a static global variable(the one whose value will be changed
3856 * by the first toggle):
3859 * We now have to create our window and all that usual stuff:
3862 * The creation of a toggle is no more complicated than that of any other
3866 * For our first toggle we don't set the states labels so they will stay the
3867 * default, however we do set a label for the toggle, an icon and the variable
3868 * whose value it should change:
3871 * We also set the callback that will be called when the toggles value changes:
3872 * @until smart_callback
3874 * For our second toggle it important to note that we set the states labels,
3875 * don't set an icon or variable, but set the initial state to
3876 * EINA_TRUE("Enabled"):
3879 * For the second toggle we will use a different callback:
3880 * @until smart_callback
3882 * We then ask the main loop to start:
3885 * The callback for our first toggle will look the value of @p val and print it:
3888 * For our second callback we need to do a little bit more, since the second
3889 * toggle doesn't change the value of a variable we have to ask it what its
3893 * This example will look like this:
3895 * @image html screenshots/toggle_example_01.png
3896 * @image latex screenshots/toggle_example_01.eps width=\textwidth
3898 * @example toggle_example_01.c
3902 * @page tutorial_panel Panel example
3903 * @dontinclude panel_example_01.c
3905 * In this example will have 3 panels, one for each possible orientation. Two of
3906 * our panels will start out hidden, the third will start out expanded. For each
3907 * of the panels we will use a label as the content, it's however possible to
3908 * have any widget(including containers) as the content of panels.
3910 * We start by doing some setup, code you should be familiar with from other
3914 * And move right to creating our first panel, for this panel we are going to
3915 * choose the orientation as TOP and toggle it(tell it to hide itself):
3918 * For the second panel we choose the RIGHT orientation and explicitly set the
3922 * For our third and last panel we won't set the orientation(which means it will
3923 * use the default: LEFT):
3926 * All that is left is running the main loop:
3929 * This example will look like this;
3931 * @image html screenshots/panel_example_01.png
3932 * @image latex screenshots/panel_example_01.eps width=\textwidth
3933 * @note The buttons with arrow allow the user to hide/show the panels.
3935 * @example panel_example_01.c
3939 * @page gengrid_example Gengrid widget example
3941 * This application is a thorough exercise on the gengrid widget's
3942 * API. We place an Elementary gengrid widget on a window, with
3943 * various knobs below its viewport, each one acting on it somehow.
3945 * The code's relevant part begins at the grid's creation. After
3946 * instantiating it, we set its items sizes, so that we don't end with
3947 * items one finger size wide, only. We're setting them to fat, 150
3948 * pixel wide ones, for this example. We give it some size hints, not
3949 * to be discussed in this context and, than, we register a callback
3950 * on one of its smart events -- the one coming each time an item gets
3951 * doubly clicked. There, we just print the item handle's value.
3952 * @dontinclude gengrid_example.c
3953 * @skip grid = elm_gengrid_add
3954 * @until evas_object_sho
3955 * @dontinclude gengrid_example.c
3956 * @skip item double click callback
3959 * Before we actually start to deal with the items API, let's show
3960 * some things items will be using throughout all the code. The first
3961 * of them is a struct to be used as item data, for all of them:
3962 * @dontinclude gengrid_example.c
3963 * @skip typedef struct
3966 * That path will be used to index an image, to be swallowed into one
3967 * of the item's icon spots. The imagens themselves are distributed
3969 * @dontinclude gengrid_example.c
3970 * @skip static const char *imgs
3973 * We also have an (unique) gengrid item class we'll be using for
3974 * items in the example:
3975 * @dontinclude gengrid_example.c
3976 * @skip static Elm_Gengrid_Item_Class
3977 * @until static Elm_Gengrid_Item_Class
3978 * @dontinclude gengrid_example.c
3979 * @skip item_style =
3982 * As you see, our items will follow the default theme on gengrid
3983 * items. For the label fetching code, we return a string composed of
3984 * the item's image path:
3985 * @dontinclude gengrid_example.c
3986 * @skip label fetching callback
3989 * For item icons, we'll be populating the item default theme's two
3990 * icon spots, @c "elm.swallow.icon" and @c "elm.swallow.end". The
3991 * former will receive one of the images in our list (in the form of
3992 * a @ref bg_02_example_page "background"), while the latter will be
3993 * a check widget. Note that we prevent the check to propagate click
3994 * events, so that the user can toggle its state without messing with
3995 * the respective item's selection in the grid:
3996 * @dontinclude gengrid_example.c
3997 * @skip icon fetching callback
3998 * @until return NULL
4001 * As the default gengrid item's theme does not have parts
4002 * implementing item states, we'll be just returning false for every
4004 * @dontinclude gengrid_example.c
4005 * @skip state fetching callback
4008 * Finally, the deletion callback on gengrid items takes care of
4009 * freeing the item's label string and its data struct:
4010 * @dontinclude gengrid_example.c
4011 * @skip deletion callback
4014 * Let's move to item insertion/deletion knobs, them. They are four
4015 * buttons, above the grid's viewport, namely
4016 * - "Append" (to append an item to the grid),
4017 * - "Prepend" (to prepend an item to the grid),
4018 * - "Insert before" (to insert an item before the selection, on the
4020 * - "Insert after" (to insert an item after the selection, on the
4022 * - "Clear" (to delete all items in the grid),
4023 * - "Bring in 1st" (to make the 1st item visible, by scrolling),
4024 * - "Show last" (to directly show the last item),
4026 * which are displaced and declared in that order. We're not dealing
4027 * with the buttons' creation code (see @ref button_example_01
4028 * "a button example", for more details on it), but with their @c
4029 * "clicked" registered callbacks. For all of them, the grid's handle
4030 * is passed as @c data. The ones creating new items use a common
4031 * code, which just gives a new @c Example_Item struct, with @c path
4032 * filled with a random image in our images list:
4033 * @dontinclude gengrid_example.c
4034 * @skip new item with random path
4037 * Moreover, that ones will set a common function to be issued on the
4038 * selection of the items. There, we print the item handle's value,
4039 * along with the callback function data. The latter will be @c NULL,
4040 * always, because it's what we pass when adding all icons. By using
4041 * elm_gengrid_item_data_get(), we can have the item data back and,
4042 * with that, we're priting the item's path string. Finally, we
4043 * exemplify elm_gengrid_item_pos_get(), printing the item's position
4045 * @dontinclude gengrid_example.c
4046 * @skip item selection callback
4049 * The appending button will exercise elm_gengrid_item_append(), simply:
4050 * @dontinclude gengrid_example.c
4051 * @skip append an item
4054 * The prepending, naturally, is analogous, but exercising
4055 * elm_gengrid_item_prepend(), on its turn. The "Insert before" one
4056 * will expect an item to be selected in the grid, so that it will
4057 * insert a new item just before it:
4058 * @dontinclude gengrid_example.c
4059 * @skip "insert before" callback
4062 * The "Insert after" is analogous, just using
4063 * elm_gengrid_item_insert_after(), instead. The "Clear" button will,
4064 * as expected, just issue elm_gengrid_clear():
4065 * @dontinclude gengrid_example.c
4066 * @skip delete items
4069 * The "Bring in 1st" button is there exercise two gengrid functions
4070 * -- elm_gengrid_first_item_get() and elm_gengrid_item_bring_in().
4071 * With the former, we get a handle to the first item and, with the
4072 * latter, you'll see that the widget animatedly scrolls its view
4073 * until we can see that item:
4074 * @dontinclude gengrid_example.c
4075 * @skip bring in 1st item
4078 * The "Show last", in its turn, will use elm_gengrid_last_item_get()
4079 * and elm_gengrid_item_show(). The latter differs from
4080 * elm_gengrid_item_bring_in() in that it immediately replaces the
4081 * contents of the grid's viewport with the region containing the item
4083 * @dontinclude gengrid_example.c
4084 * @skip show last item
4087 * To change the grid's cell (items) size, we've placed a spinner,
4088 * which has the following @c "changed" smart callback:
4089 * @dontinclude gengrid_example.c
4090 * @skip change items' size
4093 * Experiment with it and see how the items are affected. The "Disable
4094 * item" button will, as the name says, disable the currently selected
4096 * @dontinclude gengrid_example.c
4097 * @skip disable selected item
4099 * Note that we also make use of elm_gengrid_item_selected_set(),
4100 * there, thus making the item unselected before we actually disable
4103 * To toggle between horizontal and vertical layouting modes on the
4104 * grid, use the "Horizontal mode" check, which will call the
4105 * respective API function on the grid:
4106 * @dontinclude gengrid_example.c
4107 * @skip change layouting mode
4110 * If you toggle the check right after that one, "Always select",
4111 * you'll notice all subsequent clicks on the @b same grid item will
4112 * still issue the selection callback on it, what is different from
4113 * when it's not checked. This is the
4114 * elm_gengrid_always_select_mode_set() behavior:
4115 * @dontinclude gengrid_example.c
4116 * @skip "always select" callback
4119 * One more check follows, "Bouncing", which will turn on/off the
4120 * bouncing animations on the grid, when one scrolls past its
4121 * borders. Experiment with scrolling the grid to get the idea, having
4122 * it turned on and off:
4123 * @dontinclude gengrid_example.c
4124 * @skip "bouncing mode" callback
4127 * The next two checks will affect items selection on the grid. The
4128 * first, "Multi-selection", will make it possible to select more the
4129 * one item on the grid. Because it wouldn't make sense to fetch for
4130 * an unique selected item on this case, we also disable two of the
4131 * buttons, which insert items relatively, if multi-selection is on:
4132 * @dontinclude gengrid_example.c
4133 * @skip multi-selection callback
4136 * Note that we also @b unselect all items in the grid, when returning
4137 * from multi-selection mode, making use of
4138 * elm_gengrid_item_selected_set().
4140 * The second check acting on selection, "No selection", is just what
4141 * its name depicts -- no selection will be allowed anymore, on the
4142 * grid, while it's on. Check it out for yourself, interacting with
4144 * @dontinclude gengrid_example.c
4145 * @skip no selection callback
4148 * We have, finally, one more line of knobs, now sliders, to change
4149 * the grids behavior. The two first will change the horizontal @b
4150 * alignment of the whole actual grid of items within the gengrid's
4152 * @dontinclude gengrid_example.c
4153 * @skip items grid horizontal alignment change
4156 * Naturally, the vertical counterpart just issues
4157 * elm_gengrid_align_set() changing the second alignment component,
4160 * The last slider will change the grid's <b>page size</b>, relative
4161 * to its own one. Try to change those values and, one manner of
4162 * observing the paging behavior, is to scroll softly and release the
4163 * mouse button, with different page sizes, at different grid
4164 * positions, while having lots of items in it -- you'll see it
4165 * snapping to page boundaries differenty, for each configuration:
4166 * @dontinclude gengrid_example.c
4167 * @skip page relative size change
4170 * This is how the example program's window looks like:
4171 * @image html screenshots/gengrid_example.png
4172 * @image latex screenshots/gengrid_example.eps width=\textwidth
4174 * Note that it starts with three items which we included at will:
4175 * @dontinclude gengrid_example.c
4176 * @skip _clicked(grid,
4177 * @until _clicked(grid,
4178 * @until _clicked(grid,
4179 * @until _clicked(grid,
4181 * See the full @ref gengrid_example_c "source code" for
4184 * @example gengrid_example.c
4187 * @page entry_example_01 Entry - Example of simple editing
4189 * As a general overview of @ref Entry we are going to write an, albeit simple,
4190 * functional editor. Although intended to show how elm_entry works, this
4191 * example also makes extensive use of several other widgets. The full code
4192 * can be found in @ref entry_example.c "entry_example.c" and in the following
4193 * lines we'll go through the parts especific to the @ref Entry widget.
4195 * The program itself is a simple editor, with a file already set to it, that
4196 * can be set to autosave or not and allows insertion of emoticons and some
4197 * formatted text. As of this writing, the capabilities of format edition in
4198 * the entry are very limited, so a lot of manual work is required to change
4201 * In any case, the program allows some changes by using the buttons on the
4202 * top of the window and returning focus back to the main entry afterwards.
4204 * @image html screenshots/entry_example.png
4205 * @image latex screenshots/entry_example.eps width=\textwidth
4207 * We'll begin by showing a few structures used throught the program. First,
4208 * the application owns data that holds the main window and the main entry
4209 * where the editting happens. Then, an auxiliar structure we'll use later
4210 * when inserting icons in our text.
4211 * @dontinclude entry_example.c
4213 * @until App_Inwin_Data
4215 * A little convenience function will insert whatever text we need in the
4216 * buffer at the current cursor's position and set focus back to this entry.
4217 * This is done mostly because clicking on any button will make them steal
4218 * focus, which makes writing text more cumbersome.
4222 * One of the buttons on the top will trigger an @ref Inwin to open and show
4223 * us several icons we can insert into the text. We'll jump over most of these
4224 * functions, but when all the options are chosen, we insert the special
4225 * markup text that will show the chosen icon in place.
4226 * @skip edje_file_collection_list_free(emos)
4228 * @until evas_object_del
4231 * As can be seen in that function, the program lets us add icons to our entry
4232 * using all the possible configurations for them. That should help to
4233 * clarify how the different combinations work out by actually seeing them
4236 * The same popup window has a page to set the settings of the chosen icon,
4237 * that is, the size and how the item will be placed within the line.
4239 * The size is done with two entries, limitted to accept numbers and a fixed
4240 * size of characters. Changing the value in this entries will update the icon
4241 * size in our struct as seen in the next two callbacks.
4246 * The rest of the options are handled with radio buttons, since only one type
4247 * of size can be used (@c size, @c absize or @c relsize) and for the vertical
4248 * sizing it needs to choose between @c ascent and @c full. Depending on which
4249 * is chosen, the @c item tag is formed accordingly as seen before.
4250 * @skip static Evas_Object
4251 * @until evas_object_show(rvascent)
4253 * The first of our entries is here. There's something worth mentioning about
4254 * the way we'll create this one. Normally, any entry regardless of whether is
4255 * single line or not, will be set to scrollable, but in this case, since we
4256 * are limitting how many characters can fit in them and we know we don't need
4257 * scrolling, we are not setting this flag. This makes the entry have virtually
4258 * no appearance on screen, other than its text. This is because an entry is
4259 * just that, a box that holds text, and in order to have some frame around it
4260 * or a background color, another widget needs to provide this. When an entry
4261 * is scrollable, the same scroller used internally does this.
4262 * We are using @ref Frame "frames" here to provide some decoration around,
4263 * then creating our entries, set them to single line, add our two filters and
4264 * the callback for when their value change.
4265 * @until _height_changed_cb
4267 * This function ends with the button that will finally call the item
4268 * into our editting string.
4271 * Then we get to the format edition. Here we can add the @c bold and
4272 * @c emphasis tags to parts of our text. There's a lot of manual work to
4273 * know what to do here, since we are not implementing an entire state manager
4274 * and the entry itself doesn't, yet, support all the needed capabilities to
4275 * make this simpler. We begin by getting the format we are using in our
4276 * function from the button pressed.
4277 * @skip aid->pager = pager;
4278 * @until sizeof(fmt_close)
4280 * Next we need to find out if we need to insert an opening or a closing tag.
4281 * For this, we store the current cursor position and create a selection
4282 * from this point until the beginning of our text, and then get the selected
4283 * text to look for any existing format tags in it. This is currently the only
4284 * way in which we can find out what formats is being used in the entry.
4288 * Once we know what tag to insert, we need a second check in the case it was
4289 * a closing tag. This is because any other closing tag that comes after would
4290 * be left dangling alone, so we need to remove it to keep the text consistent.
4293 * Finally, we clear our fake selections and return the cursor back to the
4294 * position it had at first, since there is where we want to insert our format.
4295 * @until cursor_pos_set
4297 * And finish by calling our convenience function from before, to insert the
4298 * text at the current cursor and give focus back to the entry.
4301 * A checkbox on the top of our program tells us if the text we are editing
4302 * will autosave or not. In it's @c "changed" callback we get the value from
4303 * the checkbox and call the elm_entry_autosave_set() function with it. If
4304 * autosave is set, we also call elm_entry_file_save(). This is so the internal
4305 * timer used to periodically store to disk our changes is started.
4309 * Two more functions to show some cursor playing. Whenever we double click
4310 * anywhere on our entry, we'll find what word is the cursor placed at and
4311 * select it. Likewise, for triple clicking, we select the entire line.
4313 * @until _edit_tplclick_cb
4316 * And finally, the main window of the program contains the entry where we
4317 * do all the edition and some helping widgets to change format, add icons
4318 * or change the autosave flag.
4321 * @until _image_insert_cb
4323 * And the main entry of the program. Set to scroll, by default we disable
4324 * autosave and we'll begin with a file set to it because no file selector
4325 * is being used here. The file is loaded with #ELM_TEXT_FORMAT_MARKUP_UTF8
4326 * so that any format contained in it is interpreted, otherwise the entry
4327 * would load it as just text, escaping any tags found and no format or icons
4328 * would be shown. Then we connect to the double and triple click signals
4329 * and set focus on the entry so we can start typing right away.
4332 * @example entry_example.c
4336 * @page genlist_example_01 Genlist - basic usage
4338 * This example creates a simple genlist with a small number of items and
4339 * a callback that is called whenever an item is selected. All the properties of
4340 * this genlist are the default ones. The full code for this example can be seen
4341 * at @ref genlist_example_01_c.
4343 * For the simplest list that you plan to create, it's necessary to define some
4344 * of the basic functions that are used for creating each list item, and
4345 * associating them with the "item class" for that list. The item class is just
4346 * an struct that contains pointers to the specific list item functions that are
4347 * common to all the items of the list.
4349 * Let's show it by example. Our item class is declared globally and static as
4350 * it will be the only item class that we need (we are just creating one list):
4352 * @dontinclude genlist_example_01.c
4353 * @skip static Elm_Genlist
4354 * @until static Elm_Genlist
4356 * This item class will be used for every item that we create. The only
4357 * functions that we are going to set are @c label_get and @c icon_get. As the
4358 * name suggests, they are used by the genlist to generate the label for the
4359 * respective item, and to generate icon(s) to it too. Both the label and icon
4360 * get functions can be called more than once for each item, with different @c
4361 * part parameters, which represent where in the theme of the item that label or
4362 * icon is going to be set.
4364 * The default theme for the genlist contains only one area for label, and two
4365 * areas for icon ("elm.swallow.icon" and "elm.swallow.end"). Since we just want
4366 * to set the first icon (that will be at the left side of the label), we
4367 * compare the part name given with "elm.swallow.icon". Notice that the
4368 * @c label_get function must return a strduped string, that will be freed later
4369 * automatically by the list. Here's the code for @c label_get and @c icon_get:
4371 * @until static void
4373 * We will also provide a function that will be called whenever an item is
4374 * selected in the genlist. However, this function is not part of the item
4375 * class, it will be passed for each item being added to the genlist explicitly.
4376 * Notice the similarity of the function signature with those used by @c
4377 * evas_object_smart_callback_add:
4381 * Now let's show the code used for really creating the list. Skipping
4382 * boilerplate code used for creating a window and background, the first piece
4383 * of code specific to our genlist example is setting the pointer functions of
4384 * the item class to our above defined functions:
4389 * Notice that we also choose to use the "default" style for our genlist items.
4390 * Another interesting point is that @c state_get and @c del are set to @c NULL,
4391 * since we don't need these functions now. @c del doesn't need to be used
4392 * because we don't add any data that must be freed to our items, and @c
4393 * state_get is also not used since all of our items are the same and don't need
4394 * to have different states to be used for each item. Finally we create our
4397 * @until genlist_add
4399 * Now we append several items to the list, and for all of them we need to give
4400 * the list pointer, a pointer to the item class, the data that will be used
4401 * with that item, a pointer to the parent of this item if it is in a group type
4402 * list (this is not the case so we pass @c NULL), possible flags for this item,
4403 * the callback for when the item is selected, and the data pointer that will be
4404 * given to the selected callback.
4408 * The rest of the code is also common to all the other examples, so it will be
4409 * omitted here (look at the full source code link above if you need it).
4411 * You can try to play with this example, and see the selected callback being
4412 * called whenever an item is clicked. It also already has some features enabled
4413 * by default, like vertical bounce animation when reaching the end of the list,
4414 * automatically visible/invisible scrollbar, etc. Look at the @ref
4415 * genlist_example_02 to see an example of setting these properties to the list.
4417 * The current example will look like this when running:
4419 * @image html screenshots/genlist_example_01.png
4420 * @image latex screenshots/genlist_example_01.eps width=\textwidth
4424 * @page genlist_example_02 Genlist - list setup functions
4426 * This example is very similar to the @ref genlist_example_01, but it fetch
4427 * most of the properties of the genlist and displays them on startup (thus
4428 * getting the default value for them) and then set them to some other values,
4429 * to show how to use that API. The full source code is at @ref
4430 * genlist_example_02_c.
4432 * Considering that the base code for instantiating a genlist was already
4433 * described in the previous example, we are going to focus on the new code.
4435 * Just a small difference for the @c _item_label_get function, we are going to
4436 * store the time that this function was called. This is the "realized" time,
4437 * the time when the visual representation of this item was created. This is the
4438 * code for the @c label_get function:
4440 * @dontinclude genlist_example_02.c
4442 * @until return strdup
4444 * Now let's go to the list creation and setup. First, just after creating the
4445 * list, we get most of the default properties from it, and print them on the
4449 * @until printf("\n")
4451 * We are going to change some of the properties of our list.
4453 * There's no need to call the selected callback at every click, just when the
4454 * selected item changes, thus we call elm_genlist_always_select_mode_set() with
4457 * For this list we don't want bounce animations at all, so we set both the
4458 * horizontal bounce and the vertical bounce to false with
4459 * elm_genlist_bounce_set().
4461 * We also want our list to compress items if they are wider than the list
4462 * width (thus we call elm_genlist_compress_mode_set().
4464 * The items have different width, so they are not homogeneous:
4465 * elm_genlist_homogeneous_set() is set to false.
4467 * Since the compress mode is active, the call to
4468 * elm_genlist_horizontal_mode_set() doesn't make difference, but the current
4469 * option would make the list to have at least the width of the largest item.
4471 * This list will support multiple selection, so we call
4472 * elm_genlist_multi_select_set() on it.
4474 * The option elm_genlist_height_for_width_mode_set() would allow text block to
4475 * wrap lines if the Edje part is configured with "text.min: 0 1", for example.
4476 * But since we are compressing the elements to the width of the list, this
4477 * option wouldn't take any effect.
4479 * We want the vertical scrollbar to be always displayed, and the orizontal one
4480 * to never be displayed, and set this with elm_genlist_scroller_policy_set().
4482 * The timeout to consider a longpress is set to half of a second with
4483 * elm_genlist_longpress_timeout_set().
4485 * We also change the block count to a smaller value, but that should have not
4486 * impact on performance since the number of visible items is too small. We just
4487 * increase the granularity of the block count (setting it to have at most 4
4490 * @until block_count_set
4492 * Now let's add elements to the list:
4494 * @until item_append
4497 * It's exactly the same as the previous example. The difference is on the
4498 * behavior of the list, if you try to scroll, select items and so.
4500 * In this example we also need two buttons. One of them, when clicked, will
4501 * display several status info about the current selection, the "realized"
4502 * items, the item in the middle of the screen, and the current mode and active
4503 * item of that mode for the genlist.
4505 * The other button will ask the genlist to "realize" again the items already
4506 * "realized", so their respective label_get and icon_get functions will be
4509 * These are the callbacks for both of these buttons:
4511 * @dontinclude genlist_example_02.c
4517 * Try to scroll, select some items and click on the "Show status" button.
4518 * You'll notice that not all items of the list are "realized", thus consuming
4519 * just a small amount of memory. The selected items are listed in the order
4520 * that they were selected, and the current selected item printed using
4521 * elm_genlist_selected_item_get() is the first selected item of the multiple
4524 * Now resize the window so that you can see the "realized time" of some items.
4525 * This is the time of when the label_get function was called. If you click on
4526 * the "Realize" button, all the already realized items will be rebuilt, so the
4527 * time will be updated for all of them.
4529 * The current example will look like this when running:
4531 * @image html screenshots/genlist_example_02.png
4532 * @image latex screenshots/genlist_example_02.eps width=\textwidth
4536 * @page genlist_example_03 Genlist - different width options
4538 * This example doesn't present any other feature that is not already present in
4539 * the other examples, but visually shows the difference between using the
4540 * default list options (first list of the example), setting the horizontal mode
4541 * to #ELM_LIST_LIMIT (second list), enabling compress mode (third list) and
4542 * using height_for_width option (fourth list).
4544 * The full code for this example is listed below:
4546 * @include genlist_example_03.c
4548 * And the screenshot of the running example:
4550 * @image html screenshots/genlist_example_03.png
4551 * @image latex screenshots/genlist_example_03.eps width=\textwidth
4553 * @example genlist_example_03.c
4557 * @page genlist_example_04 Genlist - items manipulation
4559 * This example is also similar ot the @ref genlist_example_01, but it
4560 * demonstrates most of the item manipulation functions. See the full source
4561 * code at @ref genlist_example_04_c.
4563 * In this example, we also will use the concept of creating groups of items in
4564 * the genlist. Each group of items is composed by a parent item (which will be
4565 * the index of the group) and several children of this item. Thus, for the
4566 * children, we declare a normal item class. But we also are going to declare a
4567 * different item class for the group index (which in practice is another type
4568 * of item in the genlist):
4570 * @dontinclude genlist_example_04.c
4571 * @skip _item_sel_cb
4576 * We will add buttons to the window, where each button provides one
4577 * functionality of the genlist item API. Each button will have a callback
4578 * attached, that will really execute this functionality. An example of these
4579 * callbacks is the next one, for the elm_genlist_item_insert_after() function:
4581 * @skip insert_before_cb
4585 * If you want ot see the other button functions, look at the full source code
4588 * Each button will be created with a function that already creates the button,
4589 * add it to an elementary box, and attach the specified callback. This is the
4590 * function that does it:
4592 * @skip genlist_item_update
4596 * In our @c elm_main function, besides the code for setting up the window, box
4597 * and background, we also initialize our two item classes:
4599 * @skip _itc.item_style
4600 * @until _itc_group.func.del
4602 * This example uses a different style for the items, the @a double_label, which
4603 * provides a text field for the item text, and another text field for a subtext.
4605 * For the group index we use the @a group_index style, which provides a
4606 * different appearance, helping to identify the end of a group and beginning of
4609 * Now, after the code for creating the list, setting up the box and other
4610 * stuff, let's add the buttons with their respective callbacks:
4613 * @until bt_top_show
4615 * The main code for adding items to the list is a bit more complex than the one
4616 * from the previous examples. We check if each item is multiple of 7, and if
4617 * so, they are group indexes (thus each group has 6 elements by default, in
4624 * Then we also check for specific items, and add callbacks to them on the
4625 * respective buttons, so we can show, bring in, etc.:
4630 * Once you understand the code from the @ref genlist_example_01, it should be
4631 * easy to understand this one too. Look at the full code, and also try to play
4632 * a bit with the buttons, adding items, bringing them to the viewport, and so.
4634 * The example will look like this when running:
4636 * @image html screenshots/genlist_example_04.png
4637 * @image latex screenshots/genlist_example_04.eps width=\textwidth
4641 * @page genlist_example_05 Genlist - working with subitems
4643 * This is probably the most complex example of elementary @ref Genlist. We
4644 * create a tree of items, using the subitems properties of the items, and keep
4645 * it in memory to be able to expand/hide subitems of an item. The full source
4646 * code can be found at @ref genlist_example_05_c
4648 * The main point is the way that Genlist manages subitems. Clicking on an
4649 * item's button to expand it won't really show its children. It will only
4650 * generate the "expand,request" signal, and the expansion must be done
4653 * In this example we want to be able to add items as subitems of another item.
4654 * If an item has any child, it must be displayed using a parent class,
4655 * otherwise it will use the normal item class.
4657 * It will be possible to delete items too. Once a tree is constructed (with
4658 * subitems of subitems), and the user clicks on the first parent (root of the
4659 * tree), the entire subtree must be hidden. However, just calling
4660 * elm_genlist_item_expanded_set(item, EINA_FALSE) won't hide them. The only
4661 * thing that happens is that the parent item will change its appearance to
4662 * represent that it's contracted. And the signal "contracted" will be emitted
4663 * from the genlist. Thus, we must call elm_genlist_item_subitems_clear() to
4664 * delete all its subitems, but still keep a way to recreate them when expanding
4665 * the parent again. That's why we are going to keep a node struct for each
4666 * item, that will be the data of the item, with the following information:
4668 * @dontinclude genlist_example_05.c
4672 * This @c Node_Data contains the value for the item, a number indicating its
4673 * level under the tree, a list of children (to be able to expand it later) and
4674 * a boolean indicating if it's a favorite item or not.
4676 * We use 3 different item classes in this example:
4678 * One for items that don't have children:
4685 * One for items that have children:
4692 * And one for items that were favorited:
4698 * The favorite item class is there just to demonstrate the
4699 * elm_genlist_item_item_class_update() function in action. It would be much
4700 * simpler to implement the favorite behavior by just changing the icon inside
4701 * the icon_get functions when the @c favorite boolean is activated.
4703 * Now we are going to declare the callbacks for the buttons that add, delete
4706 * First, a button for appending items to the list:
4708 * @until item_append
4711 * If an item is selected, a new item will be appended to the same level of that
4712 * item, but using the selected item's parent as its parent too. If no item is
4713 * selected, the new item will be appended to the root of the tree.
4715 * Then the callback for marking an item as favorite:
4717 * @until elm_genlist_item_update
4720 * This callback is very simple, it just changes the item class of the selected
4721 * item for the "favorite" one, or go back to the "item" or "parent" class
4722 * depending on that item having children or not.
4724 * Now, the most complex operation (adding a child to an item):
4726 * @until elm_genlist_item_update
4729 * This function gets the data of the selected item, create a new data (for the
4730 * item being added), and appends it to the children list of the selected item.
4732 * Then we must check if the selected item (let's call it @c item1 now) to which
4733 * the new item (called @c item2 from now on) was already a parent item too
4734 * (using the parent item class) or just a normal item (using the default item
4735 * class). In the first case, we just have to append the item to the end of the
4736 * @c item1 children list.
4738 * However, if the @c item1 didn't have any child previously, we have to change
4739 * it to a parent item now. It would be easy to just change its item class to
4740 * the parent type, but there's no way to change the item flags and make it be
4741 * of the type #ELM_GENLIST_ITEM_SUBITEMS. Thus, we have to delete it and create
4742 * a new item, and add this new item to the same position that the deleted one
4743 * was. That's the reason of the checks inside the bigger @c if.
4745 * After adding the item to the newly converted parent, we set it to not
4746 * expanded (since we don't want to show the added item immediately) and select
4747 * it again, since the original item was deleted and no item is selected at the
4750 * Finally, let's show the callback for deleting items:
4752 * @until elm_genlist_item_update
4755 * Since we have an iternal list representing each element of our tree, once we
4756 * delete an item we have to go deleting each child of that item, in our
4757 * internal list. That's why we have the function @c _clear_list, which
4758 * recursively goes freeing all the item data.
4760 * This is necessary because only when we really want to delete the item is when
4761 * we need to delete the item data. When we are just contracting the item, we
4762 * need to hide the children by deleting them, but keeping the item data.
4764 * Now there are two callbacks that will be called whenever the user clicks on
4765 * the expand/contract icon of the item. They will just request to items to be
4766 * contracted or expanded:
4768 * @until elm_genlist_item_expanded_set(
4769 * @until elm_genlist_item_expanded_set(
4772 * When the elm_genlist_item_expanded_set() function is called with @c
4773 * EINA_TRUE, the @c _expanded_cb will be called. And when this happens, the
4774 * subtree of that item must be recreated again. This is done using the internal
4775 * list stored as item data for each item. The function code follows:
4779 * Each appended item is set to contracted, so we don't have to deal with
4780 * checking if the item was contracted or expanded before its parent being
4781 * contracted. It could be easily implemented, though, by adding a flag expanded
4782 * inside the item data.
4784 * Now, the @c _contracted_cb, which is much simpler:
4788 * We just have to call elm_genlist_item_subitems_clear(), that will take care
4789 * of deleting every item, and keep the item data still stored (since we don't
4790 * have any del function set on any of our item classes).
4792 * Finally, the code inside @c elm_main is very similar to the other examples:
4797 * The example will look like this when running:
4799 * @image html screenshots/genlist_example_05.png
4800 * @image latex screenshots/genlist_example_05.eps width=\textwidth
4804 * @page thumb_example_01 Thumb - generating thumbnails.
4806 * This example shows how to create a simple thumbnail object with Elementary.
4807 * The full source code can be found at @ref thumb_example_01_c
4809 * Everything is very simple. First we need to tell elementary that we need
4810 * Ethumb to generate the thumbnails:
4812 * @dontinclude thumb_example_01.c
4813 * @skipline elm_need_ethumb
4815 * Then, after creating the window and background, we setup our client to
4816 * generate images of 160x160:
4821 * After that, we can start creating thumbnail objects. They are very similar to
4822 * image or icon objects:
4824 * @until thumb_reload
4826 * As you can see, the main different function here is elm_thumb_reload(), which
4827 * will check if the options of the Ethumb client have changed. If so, it will
4828 * re-generate the thumbnail, and show the new one.
4830 * Notice in this example that the thumbnail object is displayed on the size of
4831 * the window (320x320 pixels), but the thumbnail generated and stored has size
4832 * 160x160 pixels. That's why the picture seems upscaled.
4834 * Ideally, you will be generating thumbnails with the size that you will be
4837 * The example will look like this when running:
4839 * @image html screenshots/thumb_example_01.png
4840 * @image latex screenshots/thumb_example_01.eps width=\textwidth
4844 * @page progressbar_example Progress bar widget example
4846 * This application is a thorough example of the progress bar widget,
4847 * consisting of a window with varios progress bars, each with a given
4848 * look/style one can give to those widgets. With two auxiliary
4849 * buttons, one can start or stop a timer which will fill in the bars
4850 * in synchrony, simulating an underlying task being completed.
4852 * We create @b seven progress bars, being three of them horizontal,
4853 * three vertical and a final one under the "wheel" alternate style.
4855 * For the first one, we add a progress bar on total pristine state,
4856 * with no other call than the elm_progressbar_add() one:
4857 * @dontinclude progressbar_example.c
4858 * @skip pb with no label
4860 * See, than, that the defaults of a progress bar are:
4861 * - no primary label shown,
4862 * - unit label set to @c "%.0f %%",
4865 * The second progress bar is given a primary label, <c>"Infinite
4866 * bounce"</c>, and, besides, it's set to @b pulse. See how, after one
4867 * starts the progress timer, with the "Start" button, it animates
4868 * differently than the previous one. It won't account for the
4869 * progress, itself, and just dumbly animate a small bar within its
4871 * @dontinclude progressbar_example.c
4872 * @skip pb with label
4875 * Next, comes a progress bar with an @b icon, a primary label and a
4876 * @b custom unit label set. It's also made to grow its bar in an
4877 * @b inverted manner, so check that out during the timer's progression:
4878 * @dontinclude progressbar_example.c
4881 * Another important thing in this one is the call to
4882 * elm_progressbar_span_size_set() -- this is how we forcefully set a
4883 * minimum horizontal size to our whole window! We're not resizing it
4884 * manually, as you can see in the @ref progressbar_example_c
4887 * The next three progress bars are just variants on the ones already
4888 * shown, but now all being @b vertical. Another time we use one of
4889 * than to give the window a minimum vertical size, with
4890 * elm_progressbar_span_size_set(). To demonstrate this trick once
4891 * more, the fifth one, which is also set to pulse, has a smaller
4892 * hardcoded span size:
4893 * @dontinclude progressbar_example.c
4894 * @skip vertical pb, with pulse
4897 * We end the widget demonstration by showing a progress bar with the
4898 * special @b "wheel" progress bar style. One does @b not need to set
4899 * it to pulse, with elm_progressbar_pulse_set(), explicitly, because
4900 * its theme does not take it in account:
4901 * @dontinclude progressbar_example.c
4905 * The two buttons exercising the bars, the facto, follow:
4906 * @dontinclude progressbar_example.c
4907 * @skip elm_button_add
4908 * @until evas_object_show(bt)
4909 * @until evas_object_show(bt)
4911 * The first of the callbacks will, for the progress bars set to
4912 * pulse, start the pulsing animation at that time. For the others, a
4913 * timer callback will take care of updating the values:
4914 * @dontinclude progressbar_example.c
4915 * @skip static Eina_Bool
4920 * Finally, the callback to stop the progress timer will stop the
4921 * pulsing on the pulsing progress bars and, for the others, to delete
4922 * the timer which was acting on their values:
4923 * @dontinclude progressbar_example.c
4928 * This is how the example program's window looks like:
4929 * @image html screenshots/progressbar_example.png
4930 * @image latex screenshots/progressbar_example.eps width=\textwidth
4932 * See the full @ref progressbar_example_c "source code" for
4935 * @example progressbar_example.c
4939 * @page tutorial_notify Notify example
4940 * @dontinclude notify_example_01.c
4942 * In this example we will have 3 notifys in 3 different positions. The first of
4943 * which will dissapear after 5 seconds or when a click outside it occurs, the
4944 * second and third will not dissapear and differ from each other only in
4947 * We start our example with the usual stuff you've seen in other examples:
4950 * We now create a label to use as the content of our first notify:
4953 * Having the label we move to creating our notify, telling it to block events,
4954 * setting its timeout(to autohide it):
4957 * To have the notify dissapear when a click outside its area occur we have to
4958 * listen to its "block,clicked" signal:
4959 * @until smart_callback
4961 * Our callback will look like this:
4964 * @dontinclude notify_example_01.c
4966 * Next we create another label and another notify. Note, however, that this
4967 * time we don't set a timeout and don't have it block events. What we do is set
4968 * the orient so that this notify will appear in the bottom of its parent:
4969 * @skip smart_callback
4973 * For our third notify the only change is the orient which is now center:
4976 * Now we tell the main loop to run:
4979 * Our example will initially look like this:
4981 * @image html screenshots/notify_example_01.png
4982 * @image latex screenshots/notify_example_01.eps width=\textwidth
4984 * Once the first notify is hidden:
4986 * @image html screenshots/notify_example_01_a.png
4987 * @image latex screenshots/notify_example_01_a.eps width=\textwidth
4989 * @example notify_example_01.c
4993 * @page tutorial_frame Frame example
4994 * @dontinclude frame_example_01.c
4996 * In this example we are going to create 4 Frames with different styles and
4997 * add a rectangle of different color in each.
4999 * We start we the usual setup code:
5002 * And then create one rectangle:
5005 * To add it in our first frame, which since it doesn't have it's style
5006 * specifically set uses the default style:
5009 * And then create another rectangle:
5012 * To add it in our second frame, which uses the "pad_small" style, note that
5013 * even tough we are setting a text for this frame it won't be show, only the
5014 * default style shows the Frame's title:
5016 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
5017 * very similar, their only difference is the size of the empty area around
5018 * the content of the frame.
5020 * And then create yet another rectangle:
5023 * To add it in our third frame, which uses the "outdent_top" style, note
5024 * that even tough we are setting a text for this frame it won't be show,
5025 * only the default style shows the Frame's title:
5028 * And then create one last rectangle:
5031 * To add it in our fourth and final frame, which uses the "outdent_bottom"
5032 * style, note that even tough we are setting a text for this frame it won't
5033 * be show, only the default style shows the Frame's title:
5036 * And now we are left with just some more setup code:
5039 * Our example will look like this:
5041 * @image html screenshots/frame_example_01.png
5042 * @image latex screenshots/frame_example_01.eps width=\textwidth
5044 * @example frame_example_01.c
5048 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
5049 * This example will show both Anchorblock and @ref Anchorview,
5050 * since both are very similar and it's easier to show them once and side
5051 * by side, so the difference is more clear.
5053 * We'll show the relevant snippets of the code here, but the full example
5054 * can be found here... sorry, @ref anchorblock_example_01.c "here".
5056 * As for the actual example, it's just a simple window with an anchorblock
5057 * and an anchorview, both containing the same text. After including
5058 * Elementary.h and declaring some functions we'll need, we jump to our
5059 * elm_main (see ELM_MAIN) and create our window.
5060 * @dontinclude anchorblock_example_01.c
5065 * With the needed variables declared, we'll create the window and a box to
5066 * hold our widgets, but we don't need to go through that here.
5068 * In order to make clear where the anchorblock ends and the anchorview
5069 * begins, they'll be each inside a @ref Frame. After creating the frame,
5070 * the anchorblock follows.
5071 * @skip elm_frame_add
5072 * @until elm_frame_content_set
5074 * Nothing out of the ordinary there. What's worth mentioning is the call
5075 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
5076 * when an anchor is clicked, the hover for the popup will cover the entire
5077 * window. This affects the area that will be obscured by the hover and
5078 * where clicking will dismiss it, as well as the calculations it does to
5079 * inform the best locations where to insert the popups content.
5080 * Other than that, the code is pretty standard. We also need to set our
5081 * callback for when an anchor is clicked, since it's our task to populate
5082 * the popup. There's no default for it.
5084 * The anchorview is no different, we only change a few things so it looks
5086 * @until elm_frame_content_set
5088 * Then we run, so stuff works and close our main function in the usual way.
5091 * Now, a little note. Normally you would use either one of anchorblock or
5092 * anchorview, set your one callback to clicks and do your stuff in there.
5093 * In this example, however, there are a few tricks to make it easier to
5094 * show both widgets in one go (and to save me some typing). So we have
5095 * two callbacks, one per widget, that will call a common function to do
5096 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
5097 * anchorview too, since both are equal, and passing a callback to use
5098 * for our buttons to end the hover, because each widget has a different
5100 * @until _anchorview_clicked_cb
5103 * The meat of our popup is in the following function. We check what kind
5104 * of menu we need to show, based on the name set to the anchor in the
5105 * markup text. If there's no type (something went wrong, no valid contact
5106 * in the address list) we are just putting a button that does nothing, but
5107 * it's perfectly reasonable to just end the hover and call it quits.
5109 * Our popup will consist of one main button in the middle of our hover,
5110 * and possibly a secondary button and a list of other options. We'll create
5111 * first our main button and check what kind of popup we need afterwards.
5114 * @until eina_stringshare_add
5117 * Each button has two callbacks, one is our hack to close the hover
5118 * properly based on which widget it belongs to, the other a simple
5119 * printf that will show the action with the anchors own data. This is
5120 * not how you would usually do it. Instead, the common case is to have
5121 * one callback for the button that will know which function to call to end
5122 * things, but since we are doing it this way it's worth noting that
5123 * smart callbacks will be called in reverse in respect to the order they
5124 * were added, and since our @c btn_end_cb will close the hover, and thus
5125 * delete our buttons, the other callback wouldn't be called if we had
5128 * After our telephone popup, there are a few others that are practically
5129 * the same, so they won't be shown here.
5131 * Once we are done with that, it's time to place our actions into our
5132 * hover. Main button goes in the middle without much questioning, and then
5133 * we see if we have a secondary button and a box of extra options.
5134 * Because I said so, secondary button goes on either side and box of
5135 * options either on top or below the main one, but to choose which
5136 * exactly, we use the hints our callback info has, which saves us from
5137 * having to do the math and see which side has more space available, with
5138 * a little special case where we delete our extra stuff if there's nowhere
5142 * @skip evas_object_smart
5143 * @until evas_object_del(box)
5147 * The example will look like this:
5149 * @image html screenshots/anchorblock_01.png
5150 * @image latex screenshots/anchorblock_01.eps width=\textwidth
5152 * @example anchorblock_example_01.c
5156 * @page tutorial_check Check example
5157 * @dontinclude check_example_01.c
5159 * This example will show 2 checkboxes, one with just a label and the second
5160 * one with both a label and an icon. This example also ilustrates how to
5161 * have the checkbox change the value of a variable and how to react to those
5164 * We will start with the usual setup code:
5167 * And now we create our first checkbox, set its label, tell it to change
5168 * the value of @p value when the checkbox stats is changed and ask to be
5169 * notified of state changes:
5172 * For our second checkbox we are going to set an icon so we need to create
5175 * @note For simplicity we are using a rectangle as icon, but any evas object
5178 * And for our second checkbox we set the label, icon and state to true:
5181 * We now do some more setup:
5184 * And finally implement the callback that will be called when the first
5185 * checkbox's state changes. This callback will use @p data to print a
5188 * @note This work because @p data is @p value(from the main function) and @p
5189 * value is changed when the checkbox is changed.
5191 * Our example will look like this:
5193 * @image html screenshots/check_example_01.png
5194 * @image latex screenshots/check_example_01.eps width=\textwidth
5196 * @example check_example_01.c
5200 * @page tutorial_colorselector Color selector example
5201 * @dontinclude colorselector_example_01.c
5203 * This example shows how to change the color of a rectangle using a color
5204 * selector. We aren't going to explain a lot of the code since it's the
5208 * Now that we have a window with background and a rectangle we can create
5209 * our color_selector and set it's initial color to fully opaque blue:
5212 * Next we tell ask to be notified whenever the color changes:
5215 * We follow that we some more run of the mill setup code:
5218 * And now get to the callback that sets the color of the rectangle:
5221 * This example will look like this:
5223 * @image html screenshots/colorselector_example_01.png
5224 * @image latex screenshots/colorselector_example_01.eps width=\textwidth
5226 * @example colorselector_example_01.c
5230 * @page slideshow_example Slideshow widget example
5232 * This application is aimed to exemplify the slideshow widget. It
5233 * consists of a window with a slideshow widget set as "resize
5234 * object", along with a control bar, in the form of a notify. Those
5235 * controls will exercise most of the slideshow's API functions.
5237 * We create the slideshow, itself, first, making it @b loop on its
5238 * image itens, when in slideshow mode:
5239 * @dontinclude slideshow_example.c
5240 * @skip slideshow = elm_slideshow_add
5241 * @until evas_object_show
5243 * Next, we define the <b>item class</b> for our slideshow
5244 * items. Slideshow images are going to be Elementary @ref Photo "photo"
5245 * widgets, here, as pointed by our @c get class
5246 * function. We'll let the Elementary infrastructure to delete those
5247 * objects for us, and, as there's no additional data attached to our
5248 * slideshow items, the @c del class function can be left undefined:
5249 * @dontinclude slideshow_example.c
5252 * @dontinclude slideshow_example.c
5255 * @dontinclude slideshow_example.c
5256 * @skip get our images to make slideshow items
5259 * We now get to populate the slideshow widget with items. Our images
5260 * are going to be some randomly chosen from the Elementary package,
5261 * nine of them. For the first eight, we insert them ordered in the
5262 * widget, by using elm_slideshow_item_sorted_insert(). The comparing
5263 * function will use the image names to sort items. The last item is
5264 * inserted at the end of the slideshow's items list, with
5265 * elm_slideshow_item_add(). We check out how that list ends with
5266 * elm_slideshow_items_get(), than:
5267 * @dontinclude slideshow_example.c
5268 * @skip static const char *img
5270 * @dontinclude slideshow_example.c
5274 * Note that we save the pointers to the first and last items in the
5275 * slideshow, for future use.
5277 * What follows is the code creating a notify, to be shown over the
5278 * slideshow's viewport, with knobs to act on it. We're not showing
5279 * that boilerplate code, but only the callbacks attached to the
5280 * interesting smart events of those knobs. The first four are
5281 * buttons, which will:
5282 * - Select the @b next item in the slideshow
5283 * - Select the @b previous item in the slideshow
5284 * - Select the @b first item in the slideshow
5285 * - Select the @b last item in the slideshow
5287 * Check out the code for those four actions, being the two last @c
5288 * data pointers the same @c first and @c last pointers we save
5289 * before, respectively:
5290 * @dontinclude slideshow_example.c
5291 * @skip jump to next
5297 * What follow are two hoversels, meant for one to change the
5298 * slideshow's @b transition and @b layout styles, respectively. We
5299 * fetch all the available transition and layout names to populate
5300 * those widgets and, when one selects any of them, we apply the
5301 * corresponding setters on the slideshow:
5302 * @dontinclude slideshow_example.c
5303 * @skip hv = elm_hoversel_add
5306 * @dontinclude slideshow_example.c
5307 * @skip transition changed
5311 * For one to change the transition @b time on the slideshow widget,
5312 * we use a spinner widget. We set it to the initial value of 3
5313 * (seconds), which will be probed by the next knob -- a button
5314 * starting the slideshow, de facto. Note that changing the transition
5315 * time while a slideshow is already happening will ajust its
5317 * @dontinclude slideshow_example.c
5318 * @skip spin = elm_spinner_add
5319 * @until evas_object_show
5320 * @dontinclude slideshow_example.c
5321 * @skip slideshow transition time has
5324 * Finally, we have two buttons which will, respectively, start and
5325 * stop the slideshow on our widget. Here are their "clicked"
5327 * @dontinclude slideshow_example.c
5328 * @skip start the show
5332 * This is how the example program's window looks like:
5333 * @image html screenshots/slideshow_example.png
5334 * @image latex screenshots/slideshow_example.eps width=\textwidth
5336 * See the full @ref slideshow_example_c "source code" for
5339 * @example slideshow_example.c
5343 * @page tutorial_photocam Photocam example
5344 * @dontinclude photocam_example_01.c
5346 * In this example we will have a photocam and a couple of buttons and slider to
5347 * control the photocam. To avoid cluttering we'll only show the parts of the
5348 * example that relate to the photocam, the full source code can be seen @ref
5349 * photocam_example_01.c "here".
5351 * Creating a photocam is as easy as creating any other widget:
5352 * @skipline elm_photocam_add
5354 * A photocam is only useful if we have a image on it, so lets set a file for it
5358 * We now set the photocam to not bounce horizontally:
5361 * And we want to know when the photocam has finished loading the image so:
5362 * @until smart_callback
5364 * The reason to know when the image is loaded is so that we can bring the
5365 * center of the image into view:
5369 * As mentioned we have 2 buttons in this example, the "Fit" one will cause
5370 * the photocam to go in to a zoom mode that makes the image fit inside the
5371 * photocam. Tough this has no effect on the image we also print what region was
5372 * being viewed before setting the zoom mode:
5374 * @note When in fit mode our slider(explained below) won't work.
5376 * The second button("Unfit") will bring the photocam back into manual zoom
5380 * Our slider controls the level of zoom of the photocam:
5382 * @note It is important to note that this only works when in manual zoom mode.
5384 * Our example will initially look like this:
5386 * @image html screenshots/photocam_example_01.png
5387 * @image latex screenshots/photocam_example_01.eps width=\textwidth
5389 * @example photocam_example_01.c
5393 * @page inwin_example_01 Inwin - General overview
5395 * Inwin is a very simple widget to show, so this example will be a very simple
5396 * one, just using all of the available API.
5398 * The program is nothing but a window with a lonely button, as shown here.
5400 * @image html screenshots/inwin_example.png
5401 * @image latex screenshots/inwin_example.eps width=\textwidth
5403 * And pressing the button makes an inwin appear.
5405 * @image html screenshots/inwin_example_a.png
5406 * @image latex screenshots/inwin_example_a.eps width=\textwidth
5408 * And the code is just as simple. We being with some global variables to keep
5409 * track of our Inwin.
5410 * @dontinclude inwin_example.c
5412 * @until current_style
5414 * And two callbacks used by the buttons the above screenshot showed. In these,
5415 * we check if @c inwin exists and execute the proper action on it. If it's not
5416 * there anymore, then we were abandoned to our luck, so we disabled ourselves.
5417 * @until _inwin_destroy
5421 * The lonely button from the beginning, when clicked, will call the following
5422 * function, which begins by checking if an inwin exists, and if it's there,
5423 * we bring it back to the front and exit from our function without any further
5427 * But if no inwin is there to show, we need to create one. First we need the
5428 * top-most window for the program, as no inwin can be created using other
5429 * objects as parents. Then we create our popup, set the next style in the list
5431 * @until current_style =
5433 * As for the content of our inwin, it's just a box with a label and some
5435 * @until _inwin_destroy
5438 * Now, all the code above shows how every object must always be set as content
5439 * for some other object, be it by setting the full content, packing it in a
5440 * box or table or working as icon for some other widget. But we didn't do
5441 * anything like that for the inwin, this one is just created and shown and
5442 * everything works. Other widgets can be used this way, but they would need
5443 * to be placed and resized manually or nothing would be shown correctly. The
5444 * inwin, however, sets itself as a children of the top-level window and will
5445 * be resized as the parent window changes too.
5447 * Another characteristic of Inwin is that when it's shown above everyone else,
5448 * it will work kind of like a modal window, blocking any other widget from
5449 * receiving events until the window is manually dismissed by pressing some
5450 * button to close it or having blocking task signalling its completion so
5451 * normal operations can be resumed. This is unlike the @ref Hover widget,
5452 * that would show its content on top of the designated target, but clicking
5453 * anywhere else would dismiss it automatically.
5455 * To illustrate that last point, when we close the main window and an inwin
5456 * is still there, we'll take out the content from the inwin and place it in
5461 * And the rest of the program doesn't have anything else related to inwin,
5462 * so it won't be shown here, but you can find it in
5463 * @ref inwin_example.c "inwin_example.c".
5465 * @example inwin_example.c
5469 * @page tutorial_scroller Scroller example
5470 * @dontinclude scroller_example_01.c
5472 * This example is very short and will illustrate one way to use a scroller.
5473 * We'll omit the declaration of the @p text variable because it's a very long
5474 * @htmlonly<a href="http://lipsum.com/">@endhtmlonly ipsum lorem
5475 * @htmlonly</a>@endhtmlonly. If you really want to see the full code, it's @ref
5476 * scroller_example_01.c "scroller_example_01.c".
5478 * We start our example by creating our window and background:
5482 * Next we create a label and set it's text to @p text(very long ipsum lorem):
5483 * @until show(label)
5485 * We then create our scroller, ask that it have the same size as the window and
5487 * @until content_set
5489 * We are now going to set a number of properties in our scroller:
5490 * @li We make it bounce horizontally but not vertically.
5491 * @li We make both scrollbars always be visible.
5492 * @li We have the events be propagated from the content to the scroller.
5493 * @li We enforce a page policy vertically(having a page be the size of the
5494 * viewport) and leave horizontal scrolling free.
5495 * @li And finally we ask the scroller to show us a region starting at 50,50 and
5496 * having a width and height of 200px.
5497 * @until region_show
5498 * @note Observant reader will note that the elm_scroller_region_show() didn't
5499 * scroll the view vertically, this is because we told the scroller to only
5500 * accept vertical scrolling in pages.
5502 * And now we're done:
5505 * Our example will look like this:
5507 * @image html screenshots/scroller_example_01.png
5508 * @image latex screenshots/scroller_example_01.eps width=\textwidth
5510 * @example scroller_example_01.c
5514 * @page tutorial_table_01
5516 * In this example we add four labels to a homogeneous table that has a padding
5517 * of 5px between cells.
5519 * The interesting bits from this example are:
5520 * @li Where we set the table as homogeneous and the padding:
5521 * @dontinclude table_example_01.c
5523 * @until homogeneous_set
5524 * @li Where we add each label to the table:
5525 * @skipline elm_table_pack
5526 * @skipline elm_table_pack
5527 * @skipline elm_table_pack
5528 * @skipline elm_table_pack
5530 * Here you can see the full source:
5531 * @include table_example_01.c
5533 * Our example will look like this:
5535 * @image html screenshots/table_example_01.png
5536 * @image latex screenshots/table_example_01.eps width=\textwidth
5538 * @example table_example_01.c
5542 * @page tutorial_table_02
5544 * For our second example we'll create a table with 4 rectangles in it. Since
5545 * our rectangles are of different sizes our table won't be homogeneous.
5547 * The interesting bits from this example are:
5548 * @li Where we set the table as not homogeneous:
5549 * @dontinclude table_example_02.c
5550 * @skipline homogeneous_set
5551 * @li Where we add each rectangle to the table:
5552 * @skipline elm_table_pack
5553 * @skipline elm_table_pack
5554 * @skipline elm_table_pack
5555 * @skipline elm_table_pack
5557 * Here you can see the full source:
5558 * @include table_example_02.c
5560 * Our example will look like this:
5562 * @image html screenshots/table_example_02.png
5563 * @image latex screenshots/table_example_02.eps width=\textwidth
5565 * @example table_example_02.c
5569 * @page tutorial_menu Menu Example
5570 * @dontinclude menu_example_01.c
5572 * This example shows how to create a menu with regular items, object items,
5573 * submenus and how to delete items from a menu. The full source for this
5574 * example is @ref menu_example_01.c "menu_example_01.c".
5576 * We'll start looking at the menu creation and how to create a very simple
5581 * For our next item we are going to add an icon:
5584 * Now we are going to add more items, but these icons are going to have a
5585 * parent, which will put them in a sub-menu. First just another item with an
5589 * Next we are going to add a button to our menu(any elm widget can be added to
5593 * We are also going to have the button delete the first item of our
5594 * sub-menu when clicked:
5595 * @until smart_callback
5596 * @dontinclude menu_example_01.c
5600 * We now add a separator and three more regular items:
5605 * We now add another item, however this time it won't go the sub-menu and it'll
5607 * @until disabled_set
5609 * To make sure that our menu is shown whenever the window is clicked(and where
5610 * clicked) we use the following callback:
5611 * @dontinclude menu_example_01.c
5616 * Our example will look like this:
5618 * @image html screenshots/menu_example_01.png
5619 * @image latex screenshots/menu_example_01.eps width=\textwidth
5621 * @example menu_example_01.c
5625 * @page win_example_01 Win - General API overview
5627 * For most users of the Elementary API, the @ref Win widget has a lot more
5628 * functions than what they need.
5630 * In general, a developer will create a window, set some content on it and
5631 * forget about it for the rest of its program's life, letting whatever
5632 * Window Manager is there to handle the window. Here, however, we are going
5633 * to show how to generally manage a window.
5635 * We'll have a bit more than the usual includes here, since part of the
5636 * example requires some low level fiddling.
5637 * @dontinclude win_example.c
5638 * @skip Elementary.h
5641 * The program then, consists of one window with two lists of buttons, each
5642 * of which operates on another two windows. One of them is a normal window,
5643 * the other has the @c override flag set so the Window Manager ignores it.
5645 * Pressing each button will call the corresponding function to act on the
5646 * corresponding window. These are pretty self explanatory, so we'll show
5647 * them in one batch.
5649 * @until elm_win_sticky_set
5652 * Next, we handle the main window closing. We have a @c "delete,request"
5653 * callback set to ask if really want to quit. If so, we end the main loop,
5654 * otherwise just delete the popup message and continue running normally.
5655 * @until _no_quit_cb
5656 * @until _no_quit_cb
5659 * The non-managed window, being completely ignored by the Window Manager,
5660 * is likely to never receive keyboard focus, even if we click on its entry
5661 * to write something. So we have a button on it that will forcefully focus
5662 * it by using some lower level functions to act directly on the X window.
5663 * Then, each time one of the window is focused, we print some message on a
5664 * console to show this more clearly.
5665 * @until _win_focused_cb
5668 * And to finalize, the main function creates a window to hold all the action
5669 * buttons and another two to show how (and what) works on each of them.
5671 * First, the main window will be a normal window, we'll enable the focus
5672 * highlight regardless of how it is configured so it's easier to navigate
5673 * the window with the keyboard. Then we hook our focus and delete callbacks
5674 * and set up the rest of the window's content.
5675 * @until evas_object_show(box)
5677 * The first of our sub-windows is the managed one. We'll create it as a
5678 * dialog, which should make the Window Manager treat it as a non-resizable
5679 * window. We are also setting the window to be auto-deleted when the close
5680 * button in the titlebar is pressed.
5681 * @until evas_object_show(o)
5683 * Now, we added an icon to the window as a resize object. We also set this
5684 * icon to not scale, and no weight size hints have been set for it. This way,
5685 * even if we hadn't created the window as a dialog, it would still not be
5686 * resizable. The window size is defined by its content, so it would never be
5687 * smaller than the smallest of its resize objects, and for it to be resizable,
5688 * all of those objects have to allow it.
5690 * Next, we add the buttons with the actions to perform on this window. Using
5691 * a macro saves us typing and makes the world a happier place.
5692 * @until WIN_ACTION(sticky)
5694 * The maximize one is likely to not work, because the Window Manager will
5695 * probably not enforce it upon a window that states its maximum size, much
5696 * less a dialog. But that can be changed by editting the example to use
5697 * #ELM_WIN_BASIC when creating the window and adding the following line to
5698 * the icon set as content
5700 * evas_object_size_hint_weight_set(o, EVAS_HINT_EXPAND, EVAS_HINT_EXPAND);
5703 * Lastly, the second sub-window will have it's override flag set. In it we
5704 * have a label with some text, and entry and a button. The entry can be
5705 * clicked normally to set focus on it, but whether it actually gets keyboard
5706 * input will also depend on the window getting focus, and since the window
5707 * is an override one, it will probably not gain it by normal means. The
5708 * button is there to force the focus at the X level to go to our window.
5709 * And to finish, another list of buttons with actions to perform on this
5710 * last window. Remember that most of them are requests or hints for the
5711 * Window Manager, so they are likely to do nothing on this window.
5712 * Similarly, there won't be any way to move it or resize it, because we
5713 * haven't implemented that kind of control on this example and that's
5714 * something controlled by Window Managers on windows they are tracking, which
5715 * is not the case with this one.
5718 * The full code listing of this example can be found at
5719 * @ref win_example.c "win_example.c".
5721 * @example win_example.c
5725 * @page bg_example_01_c bg_example_01.c
5726 * @include bg_example_01.c
5727 * @example bg_example_01.c
5731 * @page bg_example_02_c bg_example_02.c
5732 * @include bg_example_02.c
5733 * @example bg_example_02.c
5737 * @page bg_example_03_c bg_example_03.c
5738 * @include bg_example_03.c
5739 * @example bg_example_03.c
5743 * @page actionslider_example_01 Actionslider example
5744 * @include actionslider_example_01.c
5745 * @example actionslider_example_01.c
5749 * @page animator_example_01_c Animator example 01
5750 * @include animator_example_01.c
5751 * @example animator_example_01.c
5755 * @page transit_example_01_c Transit example 1
5756 * @include transit_example_01.c
5757 * @example transit_example_01.c
5761 * @page transit_example_02_c Transit example 2
5762 * @include transit_example_02.c
5763 * @example transit_example_02.c
5767 * @page general_functions_example_c General (top-level) functions example
5768 * @include general_funcs_example.c
5769 * @example general_funcs_example.c
5773 * @page clock_example_c Clock example
5774 * @include clock_example.c
5775 * @example clock_example.c
5779 * @page flipselector_example_c Flipselector example
5780 * @include flipselector_example.c
5781 * @example flipselector_example.c
5785 * @page fileselector_example_c Fileselector example
5786 * @include fileselector_example.c
5787 * @example fileselector_example.c
5791 * @page fileselector_button_example_c Fileselector button example
5792 * @include fileselector_button_example.c
5793 * @example fileselector_button_example.c
5797 * @page fileselector_entry_example_c Fileselector entry example
5798 * @include fileselector_entry_example.c
5799 * @example fileselector_entry_example.c
5803 * @page index_example_01_c Index example
5804 * @include index_example_01.c
5805 * @example index_example_01.c
5809 * @page index_example_02_c Index example
5810 * @include index_example_02.c
5811 * @example index_example_02.c
5815 * @page layout_example_01_c layout_example_01.c
5816 * @include layout_example_01.c
5817 * @example layout_example_01.c
5821 * @page layout_example_02_c layout_example_02.c
5822 * @include layout_example_02.c
5823 * @example layout_example_02.c
5827 * @page layout_example_03_c layout_example_03.c
5828 * @include layout_example_03.c
5829 * @example layout_example_03.c
5833 * @page layout_example_edc An example of layout theme file
5835 * This theme file contains two groups. Each of them is a different theme, and
5836 * can be used by an Elementary Layout widget. A theme can be used more than
5837 * once by many different Elementary Layout widgets too.
5839 * @include layout_example.edc
5840 * @example layout_example.edc
5844 * @page gengrid_example_c Gengrid example
5845 * @include gengrid_example.c
5846 * @example gengrid_example.c
5850 * @page genlist_example_01_c genlist_example_01.c
5851 * @include genlist_example_01.c
5852 * @example genlist_example_01.c
5856 * @page genlist_example_02_c genlist_example_02.c
5857 * @include genlist_example_02.c
5858 * @example genlist_example_02.c
5862 * @page genlist_example_04_c genlist_example_04.c
5863 * @include genlist_example_04.c
5864 * @example genlist_example_04.c
5868 * @page genlist_example_05_c genlist_example_05.c
5869 * @include genlist_example_05.c
5870 * @example genlist_example_05.c
5874 * @page thumb_example_01_c thumb_example_01.c
5875 * @include thumb_example_01.c
5876 * @example thumb_example_01.c
5880 * @page progressbar_example_c Progress bar example
5881 * @include progressbar_example.c
5882 * @example progressbar_example.c
5886 * @page slideshow_example_c Slideshow example
5887 * @include slideshow_example.c
5888 * @example slideshow_example.c