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
42 * @ref diskselector_example_01
44 * @ref diskselector_example_02
46 * @ref list_example_01
48 * @ref list_example_02
50 * @ref list_example_03
52 * @ref segment_control_example
54 * @ref flipselector_example
56 * @ref fileselector_example
58 * @ref fileselector_button_example
60 * @ref fileselector_entry_example
62 * @ref index_example_01
64 * @ref index_example_02
66 * @ref gengrid_example
68 * @ref genlist_example_01
70 * @ref genlist_example_02
72 * @ref genlist_example_03
74 * @ref genlist_example_04
76 * @ref genlist_example_05
78 * @ref progressbar_example
80 * @ref slideshow_example
84 * @page bg_01_example_page elm_bg - Plain color background.
85 * @dontinclude bg_example_01.c
87 * The full code for this example can be found at @ref bg_example_01_c,
88 * in the function @c test_bg_plain. It's part of the @c elementar_test
89 * suite, and thus has the code for the three examples referenced by this
92 * This first example just sets a default background with a plain color. The
93 * first part consists of creating an Elementary window. It's the common
94 * piece of code that you'll see everywhere in Elementary: @skip elm_main
97 * Now we really create our background object, using the window object as
102 * Then we set the size hints of the background object so that it will use
103 * all space available for it, and then add it as a resize object to the
104 * window, making it visible in the end:
106 * @skip size_hint_weight_set
107 * @until resize_object_add
109 * See @ref evas_object_size_hint_weight_set and elm_win_resize_object_add()
110 * for more detailed info about these functions.
112 * The end of the example is quite simple, just setting the minimum and
113 * maximum size of the background, so the Elementary window knows that it
114 * has to have at least the minimum size. The background also won't scale to
115 * a size above its maximum. Then we resize the window and show it in the
118 * @skip set size hints
121 * And here we finish our very simple background object usage example.
125 * @page bg_02_example_page elm_bg - Image background.
126 * @dontinclude bg_example_02.c
128 * The full code for this example can be found at @ref bg_example_02_c,
129 * in the function @c test_bg_image. It's part of the @c elementar_test
130 * suite, and thus has the code for the three examples referenced by this
133 * This is the second example, and shows how to use the Elementary
134 * background object to set an image as background of your application.
136 * We start this example exactly in the same way as the previous one, even
137 * when creating the background object:
142 * Now it's the different part.
144 * Our background will have an image, that will be displayed over the
145 * background color. Before loading the image, we set the load size of the
146 * image. The load size is a hint about the size that we want the image
147 * displayed in the screen. It's not the exact size that the image will have,
148 * but usually a bit bigger. The background object can still be scaled to a
149 * size bigger than the one set here. Setting the image load size to
150 * something smaller than its real size will reduce the memory used to keep
151 * the pixmap representation of the image, and the time to load it. Here we
152 * set the load size to 20x20 pixels, but the image is loaded with a size
153 * bigger than that (since it's just a hint):
155 * @skipline load_size_set
157 * And set our background image to be centered, instead of stretched or
158 * scaled, so the effect of the elm_bg_load_size_set() can be easily
161 * @skipline option_set
163 * We need a filename to set, so we get one from the previous installed
164 * images in the @c PACKAGE_DATA_DIR, and write its full path to a buffer.
165 * Then we use this buffer to set the filename in the background object:
170 * Notice that the third argument of the elm_bg_file_set() function is @c
171 * NULL, since we are setting an image to this background. This function
172 * also supports setting an edje group as background, in which case the @c
173 * group parameter wouldn't be @c NULL, but be the name of the group
176 * Finally, we can set the size hints, add the background as a resize
177 * object, and resize the window, exactly the same thing we do in the @ref
178 * bg_01_example_page example:
183 * And this is the end of this example.
185 * This example will look like this:
187 * @image html screenshots/bg_01.png
188 * @image latex screenshots/bg_01.eps width=\textwidth
192 * @page bg_03_example_page elm_bg - Background properties.
193 * @dontinclude bg_example_03.c
195 * The full code for this example can be found at @ref bg_example_03_c, in the
196 * function @c test_bg_options, with the callbacks @c _cb_overlay_changed, @c
197 * _cb_color_changed and @c _cb_radio_changed defined in the beginning of the
198 * file. It's part of the @c elementar_test suite, and thus has the code for
199 * the three examples referenced by this documentation.
201 * This example will show the properties available for the background object,
202 * and will use of some more widgets to set them.
204 * In order to do this, we will set some callbacks for these widgets. The
205 * first is for the radio buttons that will be used to choose the option
206 * passed as argument to elm_bg_option_set():
208 * @skip _cb_radio_changed
211 * The next callback will be used when setting the overlay (using
212 * elm_bg_overlay_set()):
214 * @skip _cb_overlay_changed
218 * And the last one, used to set the color (with elm_bg_color_set()):
220 * @skip _cb_color_changed
223 * We will get back to what these functions do soon. If you want to know more
224 * about how to set these callbacks and what these widgets are, look for:
225 * @li elm_radio_add()
226 * @li elm_check_add()
227 * @li elm_spinner_add()
229 * Now going to the main function, @c test_bg_options, we have the common
230 * code with the other examples:
235 * We add a plain background to this window, so it will have the default
236 * background color behind everything:
238 * @skip bg = elm_bg_add
239 * @until evas_object_show(bg)
241 * Then we add a vertical box (elm_box_add()) that will hold the background
242 * object that we are going to play with, as well as a horizontal box that
246 * @until evas_object_show
248 * Now we add the background object that is going to be of use for our
249 * example. It is an image background, as used in @ref bg_02_example_page ,
250 * so the code should be familiar:
253 * @until evas_object_show
255 * Notice the call to elm_box_pack_end(): it will pack the background object
256 * in the end of the Elementary box declared above. Just refer to that
257 * documentation for more info.
259 * Since this Elementary background is already an image background, we are
260 * going to play with its other properties. We will change its option
261 * (CENTER, SCALE, STRETCH, TILE), its color (RGB), and add an overlay to it.
262 * For all of these properties, we are going to add widgets that will
265 * First, lets add the horizontal box that will hold these widgets:
269 * For now, just consider this @c hbox as a rectangle that will contain the
270 * widgets, and will distribute them horizontally inside its content. Then we
271 * add radio buttons that will allow us to choose the property to use with
275 * @until evas_object_show
277 * Again, I won't give details about the use of these widgets, just look for
278 * their documentation if necessary. It's enough to know for now that we are
279 * packing them in the @c hbox, setting a label for them, and the most
280 * important parts: setting its value to @c ELM_BG_OPTION_CENTER and its
281 * callback to @c _cb_radio_changed (the function defined in the beginning of
282 * this example). We do this for the next 3 radio buttons added after this
283 * one, each of them with a different value.
285 * Now taking a look at the code of the callback @c _cb_radio_changed again,
286 * it will call elm_bg_option_set() with the value set from the checked radio
287 * button, thus setting the option for this background. The background is
288 * passed as argument to the @p data parameter of this callback, and is
289 * referenced here as @c o_bg.
291 * Later we set the default value for this radio button:
293 * @skipline elm_radio_value_set
295 * Then we add a checkbox for the elm_bg_overlay_set() function:
298 * @until evas_object_show
300 * Now look at the code of the @c _cb_overlay_changed again. If the checkbox
301 * state is checked, an overlay will be added to the background. It's done by
302 * creating an Edje object, and setting it with elm_bg_overlay_set() to the
303 * background object. For information about what are and how to set Edje
304 * object, look at the Edje documentation.
306 * Finally we add a spinner object (elm_spinner_add()) to be used to select
307 * the color of our background. In its callback it's possible to see the call
308 * to elm_bg_color_set(), which will change the color of this background.
309 * This color is used by the background to fill areas where the image doesn't
310 * cover (in this case, where we have an image background). The spinner is
311 * also packed into the @c hbox :
313 * @skip elm_spinner_add
314 * @until evas_object_show
316 * Then we just have to pack the @c hbox inside the @c box, set some size
317 * hints, and show our window:
322 * Now to see this code in action, open elementary_test, and go to the "Bg
323 * Options" test. It should demonstrate what was implemented here.
327 * @page actionslider_example_page Actionslider usage
328 * @dontinclude actionslider_example_01.c
330 * For this example we are going to assume knowledge of evas smart callbacks
331 * and some basic evas object functions. Elementary is not meant to be used
332 * without evas, if you're not yet familiar with evas it probably is worth
335 * And now to the example, when using Elementary we start by including
339 * Next we define some callbacks, they all share the same signature because
340 * they are all to be used with evas_object_smart_callback_add().
341 * The first one just prints the selected label(in two different ways):
344 * This next callback is a little more interesting, it makes the selected
345 * label magnetic(except if it's the center label):
348 * This callback enables or disables the magnetic propertty of the center
352 * And finally a callback to stop the main loop when the window is closed:
355 * To be able to create our actionsliders we need to do some setup, but this
356 * isn't really relevant here, so if you want to know about that go @ref
359 * With all that boring stuff out of the way we can proceed to creating some
361 * All actionsliders are created the same way:
362 * @skipline actionslider_add
363 * Next we must choose where the indicator starts, and for this one we choose
364 * the right, and set the right as magnetic:
365 * @skipline indicator_pos_set
366 * @until magnet_pos_set
368 * We then set the labels for the left and right, passing NULL as an argument
369 * to any of the labels makes that position have no label.
372 * Furthermore we mark both left and right as enabled positions, if we didn't
373 * do this all three positions would be enabled:
376 * Having the the enabled positions we now add a smart callback to change
377 * which position is magnetic, so that only the last selected position is
381 * And finally we set our printing callback and show the actionslider:
385 * For our next actionslider we are going to do much as we did for the
386 * previous except we are going to have the center as the magnet(and not
388 * @skipline actionslider_add
389 * @skipline indicator_pos_set
392 * And another actionslider, in this one the indicator starts on the left.
393 * It has labels only in the center and right, and both bositions are
394 * magnetic. Because the left doesn't have a label and is not magnetic once
395 * the indicator leaves it can't return:
396 * @skipline actionslider_add
397 * @skipline indicator_pos_set
399 * @note The greyed out area is a @ref Styles "style".
401 * And now an actionslider with a label in the indicator, and whose magnet
402 * properties change based on what was last selected:
403 * @skipline actionslider_add
404 * @skipline indicator_pos_set
406 * @note The greyed out area is a @ref Styles "style".
408 * We are almost done, this next one is just an actionslider with all
409 * positions magnetized and having every possible label:
410 * @skipline actionslider_add
411 * @skipline indicator_pos_set
414 * And for our last actionslider we have one that turns the magnetic property
416 * @skipline actionslider_add
417 * @skipline indicator_pos_set
420 * The example will look like this:
422 * @image html screenshots/actionslider_01.png
423 * @image latex screenshots/actionslider_01.eps width=\textwidth
425 * See the full source code @ref actionslider_example_01 "here"
429 * @page elm_animator_example_page_01 Animator usage
430 * @dontinclude animator_example_01.c
432 * For this example we will be using a bit of evas, you could animate a
433 * elementary widget in much the same way, but to keep things simple we use
434 * an evas_object_rectangle.
436 * As every other example we start with our include and a simple callback to
437 * exit the app when the window is closed:
441 * This next callback is the one that actually creates our animation, it
442 * changes the size, position and color of a rectangle given to it in @a
446 * Next we have a callback that prints a string, nothing special:
449 * This next callback is a little more interesting, it has a state variable
450 * to know if the animation is currently paused or running, and it toogles
451 * the state of the animation accordingly:
456 * Finally we have a callback to stop the animation:
459 * As with every example we need to do a bit of setup before we can actually
460 * use an animation, but for the purposes of this example that's not relevant
461 * so let's just skip to the good stuff, creating an animator:
462 * @skipline animator_add
463 * @note Since elm_animator is not a widget we can give it a NULL parent.
465 * Now that we have an elm_animator we set it's duration to 1 second:
468 * We would also like our animation to be reversible, so:
471 * We also set our animation to repeat as many times as possible, which will
472 * mean that _end_cb will only be called after UINT_MAX * 2 seconds(UINT_MAX
473 * for the animation running forward and UNIT_MAX for the animation running
477 * To add some fun to our animation we will use the IN_OUT curve style:
480 * To actually animate anything we need an operation callback:
481 * @line operation_callback
483 * Even though we set our animation to repeat for a very long time we are
484 * going to set a end callback to it:
485 * @line completion_callback
486 * @note Notice that stoping the animation with the stop button will not make
489 * Now that we have fully set up our animator we can tell it to start
493 * There's a bit more of code that doesn't really matter to use so we skip
494 * right down to our last interesting point:
495 * @skipline animator_del
496 * @note Because we created our animator with no parent we need to delete it
499 * The example should look like this:
501 * @image html screenshots/animator_example_01.png
502 * @image latex screenshots/animator_example_01.eps width=\textwidth
504 * @image html screenshots/animator_example_02.png
505 * @image latex screenshots/animator_example_02.eps width=\textwidth
507 * @image html screenshots/animator_example_03.png
508 * @image latex screenshots/animator_example_03.eps width=\textwidth
510 * The full source code for this example can be found @ref
511 * animator_example_01_c "here"
515 * @page transit_example_03_c elm_transit - Combined effects and options.
517 * This example shows how to apply the following transition effects:
525 * It allows you to apply more than one effect at once, and also allows to
526 * set properties like event_enabled, auto_reverse, repeat_times and
529 * @include transit_example_03.c
533 * @page transit_example_04_c elm_transit - Combined effects over two objects.
535 * This example shows how to apply the transition effects:
540 * over two objects. This kind of transition effect is used to make one
541 * object disappear and another one appear on its place.
543 * You can mix more than one effect of this type on the same objects, and the
544 * transition will apply both.
546 * @include transit_example_04.c
550 * @page transit_example_01_explained elm_transit - Basic transit usage.
551 * @dontinclude transit_example_01.c
553 * The full code for this example can be found at @ref transit_example_01_c.
555 * This example shows the simplest way of creating a transition and applying
556 * it to an object. Similarly to every other elementary example, we create a
557 * window, set its title, size, autodel property, and setup a callback to
558 * exit the program when finished:
561 * @until evas_object_resize
563 * We also add a resizeable white background to use behind our animation:
566 * @until evas_object_show
568 * And then we add a button that we will use to demonstrate the effects of
572 * @until evas_object_show(win)
574 * Notice that we are not adding the button with elm_win_resize_object_add()
575 * because we don't want the window to control the size of the button. We
576 * will use the transition to change the button size, so it could conflict
577 * with something else trying to control that size.
579 * Now, the simplest code possible to create the resize animation:
584 * As you can see, this code is very easy to understand. First, we create the
585 * transition itself with elm_transit_add(). Then we add the button to this
586 * transition with elm_transit_object_add(), which means that the transition
587 * will operate over this button. The effect that we want now is changing the
588 * object size from 100x50 to 300x150, and can be achieved by adding the
589 * resize effect with elm_transit_effect_resizing_add().
591 * Finally, we set the transition time to 5 seconds and start the transition
592 * with elm_transit_go(). If we wanted more effects applied to this
593 * button, we could add them to the same transition. See the
594 * @ref transit_example_03_c to watch many transitions being applied to an
599 * @page transit_example_02_explained elm_transit - Chained transitions.
600 * @dontinclude transit_example_02.c
602 * The full code for this example can be found at @ref transit_example_02_c.
604 * This example shows how to implement a chain of transitions. This chain is
605 * used to start a transition just after another transition ended. Similarly
606 * to every other elementary example, we create a window, set its title,
607 * size, autodel property, and setup a callback to exit the program when
611 * @until evas_object_resize
613 * We also add a resizeable white background to use behind our animation:
616 * @until evas_object_show
618 * This example will have a chain of 4 transitions, each of them applied to
619 * one button. Thus we create 4 different buttons:
622 * @until evas_object_show(bt4)
624 * Now we create a simple translation transition that will be started as soon
625 * as the program loads. It will be our first transition, and the other
626 * transitions will be started just after this transition ends:
631 * The code displayed until now has nothing different from what you have
632 * already seen in @ref transit_example_01_explained, but now comes the new
633 * part: instead of creating a second transition that will start later using
634 * a timer, we create the it normally, and use
635 * elm_transit_chain_transit_add() instead of elm_transit_go. Since we are
636 * adding it in a chain after the first transition, it will start as soon as
637 * the first transition ends:
640 * @until transit_chain_transit_add
642 * Finally we add the 2 other transitions to the chain, and run our program.
643 * It will make one transition start after the other finish, and there is the
648 * @page general_functions_example_page General (top-level) functions example
649 * @dontinclude general_funcs_example.c
651 * As told in their documentation blocks, the
652 * elm_app_compile_*_dir_set() family of functions have to be called
653 * before elm_app_info_set():
654 * @skip tell elm about
655 * @until elm_app_info_set
657 * We are here setting the fallback paths to the compiling time target
658 * paths, naturally. If you're building the example out of the
659 * project's build system, we're assuming they are the canonical ones.
661 * After the program starts, elm_app_info_set() will actually run and
662 * then you'll see an intrincasy: Elementary does the prefix lookup @b
663 * twice. This is so because of the quicklaunch infrastructure in
664 * Elementary (@ref Start), which will register a predefined prefix
665 * for possible users of the launch schema. We're not hooking into a
666 * quick launch, so this first call can't be avoided.
668 * If you ran this example from your "bindir" installation
669 * directiory, no output will emerge from these both attempts -- it
670 * will find the "magic" file there registered and set the prefixes
671 * silently. Otherwise, you could get something like:
673 WARNING: Could not determine its installed prefix for 'ELM'
674 so am falling back on the compiled in default:
676 implied by the following:
679 datadir = usr/share/elementary
680 localedir = usr/share/locale
681 Try setting the following environment variables:
682 ELM_PREFIX - points to the base prefix of install
683 or the next 4 variables
684 ELM_BIN_DIR - provide a specific binary directory
685 ELM_LIB_DIR - provide a specific library directory
686 ELM_DATA_DIR - provide a specific data directory
687 ELM_LOCALE_DIR - provide a specific locale directory
689 * if you also didn't change those environment variables (remember
690 * they are also a valid way of communicating your prefix to the
691 * binary) - this is the scenario where it fallbacks to the paths set
694 * Then, you can check the prefixes set on the standard output:
695 * @skip prefix was set to
696 * @until locale directory is
699 * @skip by using this policy
700 * @until elm_win_autodel_set
701 * we demonstrate the use of Elementary policies. The policy defining
702 * under which circunstances our application should quit automatically
703 * is set to when its last window is closed (this one has just one
704 * window, though). This will save us from having to set a callback
705 * ourselves on the window, like done in @ref bg_example_01_c "this"
706 * example. Note that we need to tell the window to delete itself's
707 * object on a request to destroy the canvas coming, with
708 * elm_win_autodel_set().
710 * What follows is some boilerplate code, creating a frame with a @b
711 * button, our object of interest, and, below, widgets to change the
712 * button's behavior and exemplify the group of functions in question.
714 * @dontinclude general_funcs_example.c
715 * We enabled the focus highlight object for this window, so that you
716 * can keep track of the current focused object better:
717 * @skip elm_win_focus_highlight_enabled_set
718 * @until evas_object_show
719 * Use the tab key to navigate through the focus chain.
721 * @dontinclude general_funcs_example.c
722 * While creating the button, we exemplify how to use Elementary's
723 * finger size information to scale our UI:
724 * @skip fprintf(stdout, "Elementary
725 * @until evas_object_show
727 * @dontinclude general_funcs_example.c
728 * The first checkbox's callback is:
731 * When unsetting the checkbox, we disable the button, which will get a new
732 * decoration (greyed out) and stop receiving events. The focus chain
733 * will also ignore it.
735 * Following, there are 2 more buttons whose actions are focus/unfocus
736 * the top button, respectively:
737 * @skip focus callback
740 * @skip unfocus callback
742 * Note the situations in which they won't take effect:
743 * - the button is not allowed to get focus or
744 * - the button is disabled
746 * The first restriction above you'll get by a second checkbox, whose
748 * @skip focus allow callback
750 * Note that the button will still get mouse events, though.
752 * Next, there's a slider controlling the button's scale:
753 * @skip scaling callback
756 * Experiment with it, so you understand the effect better. If you
757 * change its value, it will mess with the button's original size,
760 * The full code for this example can be found
761 * @ref general_functions_example_c "here".
765 * @page theme_example_01 Theme - Using extensions
767 * @dontinclude theme_example_01.c
769 * Using extensions is extremely easy, discarding the part where you have to
770 * write the theme for them.
772 * In the following example we'll be creating two buttons, one to load or
773 * unload our extension theme and one to cycle around three possible styles,
774 * one of which we created.
776 * After including our one and only header we'll jump to the callback for
777 * the buttons. First one takes care of loading or unloading our extension
778 * file, relative to the default theme set (thus the @c NULL in the
779 * functions first parameter).
780 * @skipline Elementary.h
786 * The second button, as we said before, will just switch around different
787 * styles. In this case we have three of them. The first one is our custom
788 * style, named after something very unlikely to find in the default theme.
789 * The other two styles are the standard and one more, anchor, which exists
790 * in the default and is similar to the default, except the button vanishes
791 * when the mouse is not over it.
796 * So what happens if the style switches to our custom one when the
797 * extension is loaded? Elementary falls back to the default for the
800 * And the main function, simply enough, will create the window, set the
801 * buttons and their callbacks, and just to begin with our button styled
802 * we're also loading our extension at the beginning.
806 * In this case we wanted to easily remove extensions, but all adding an
807 * extension does is tell Elementary where else it should look for themes
808 * when it can't find them in the default theme. Another way to do this
809 * is to set the theme search order using elm_theme_set(), but this requires
810 * that the developer is careful not to override any user configuration.
811 * That can be helped by adding our theme to the end of whatver is already
812 * set, like in the following snippet.
815 * snprintf(buf, sizeof(buf), "%s:./theme_example.edj", elme_theme_get(NULL);
816 * elm_theme_set(NULL, buf);
819 * If we were using overlays instead of extensions, the same thing applies,
820 * but the custom theme must be added to the front of the search path.
822 * In the end, we should be looking at something like this:
824 * @image html screenshots/theme_example_01.png
825 * @image latex screenshots/theme_example_01.eps width=\textwidth
827 * That's all. Boringly simple, and the full code in one piece can be found
828 * @ref theme_example_01.c "here".
830 * And the code for our extension is @ref theme_example.edc "here".
832 * @example theme_example_01.c
833 * @example theme_example.edc
837 * @page theme_example_02 Theme - Using overlays
839 * @dontinclude theme_example_02.c
841 * Overlays are like extensions in that you tell Elementary that some other
842 * theme contains the styles you need for your program. The difference is that
843 * they will be look in first, so they can override the default style of any
846 * There's not much to say about them that hasn't been said in our previous
847 * example about @ref theme_example_01 "extensions", so going quickly through
848 * the code we have a function to load or unload the theme, which will be
849 * called when we click any button.
850 * @skipline Elementary.h
854 * And the main function, creating the window and adding some buttons to it.
855 * We load our theme as an overlay and nothing else. Notice there's no style
856 * set for any button there, which means they should be using the default
861 * That's pretty much it. The full code is @ref theme_example_02.c "here" and
862 * the definition of the theme is the same as before, and can be found in
863 * @ref theme_example.edc "here".
865 * @example theme_example_02.c
869 * @page button_example_01 Button - Complete example
871 * @dontinclude button_example_01.c
873 * A button is simple, you click on it and something happens. That said,
874 * we'll go through an example to show in detail the button API less
877 * In the end, we'll be presented with something that looks like this:
879 * @image html screenshots/button_01.png
880 * @image latex screenshots/button_01.eps width=\textwidth
882 * The full code of the example is @ref button_example_01.c "here" and we
883 * will follow here with a rundown of it.
886 * @until Elementary.h
890 * We have several buttons to set different times for the autorepeat timeouts
891 * of the buttons that use it and a few more that we keep track of in our
892 * data struct. The mid button doesn't do much, just moves around according
893 * to what other buttons the user presses. Then four more buttons to move the
894 * central one, and we're also keeping track of the icon set in the middle
895 * button, since when this one moves, we change the icon, and when movement
896 * is finished (by releasing one of the four arrow buttons), we set back the
901 * Keeping any of those four buttons pressed will trigger their autorepeat
902 * callback, where we move the button doing some size hint magic. To
903 * understand how that works better, refer to the @ref Box documentation.
904 * Also, the first time the function is called, we change the icon in the
905 * middle button, using elm_button_icon_unset() first to keep the reference
906 * to the previous one, so we don't need to recreate it when we are done
910 * @until size_hint_align_set
913 * One more callback for the option buttons, that just sets the timeouts for
914 * the different autorepeat options.
921 * And the main function, which does some setting up of the buttons in boxes
922 * to make things work. Here we'll go through some snippets only.
924 * For the option buttons, it's just the button with its label and callback.
925 * @skip elm_button_add
926 * @until smart_callback_add
928 * For the ones that move the central button, we have no labels. There are
929 * icons instead, and the autorepeat option is toggled.
931 * @skip elm_button_add
932 * @until data.cursors.up
934 * And just to show the mid button, which doesn't have anything special.
935 * @skip data.cursors.left
936 * @skip elm_button_add
941 * @example button_example_01.c
945 * @page bubble_01_example_page elm_bubble - Simple use.
946 * @dontinclude bubble_example_01.c
948 * This example shows a bubble with all fields set(label, info, content and
949 * icon) and the selected corner changing when the bubble is clicked. To be
950 * able use a bubble we need to do some setup and create a window, for this
951 * example we are going to ignore that part of the code since it isn't
952 * relevant to the bubble.
954 * To have the selected corner change in a clockwise motion we are going to
955 * use the following callback:
960 * Here we are creating an elm_label that is going to be used as the content
962 * @skipline elm_label
964 * @note You could use any evas_object for this, we are using an elm_label
967 * Despite it's name the bubble's icon doesn't have to be an icon, it can be
968 * any evas_object. For this example we are going to make the icon a simple
972 * And finally we have the actual bubble creation and the setting of it's
973 * label, info and content:
976 * @note Because we didn't set a corner, the default("top_left") will be
979 * Now that we have our bubble all that is left is connecting the "clicked"
980 * signals to our callback:
981 * @line smart_callback
983 * This last bubble we created was very complete, so it's pertinent to show
984 * that most of that stuff is optional a bubble can be created with nothing
989 * Our example will look like this:
991 * @image html screenshots/bubble_example_01.png
992 * @image latex screenshots/bubble_example_01.eps width=\textwidth
994 * See the full source code @ref bubble_example_01.c here.
995 * @example bubble_example_01.c
999 * @page box_example_01 Box - Basic API
1001 * @dontinclude button_example_01.c
1003 * As a special guest tonight, we have the @ref button_example_01 "simple
1004 * button example". There are plenty of boxes in it, and to make the cursor
1005 * buttons that moved a central one around when pressed, we had to use a
1006 * variety of values for their hints.
1008 * To start, let's take a look at the handling of the central button when
1009 * we were moving it around. To achieve this effect without falling back to
1010 * a complete manual positioning of the @c Evas_Object in our canvas, we just
1011 * put it in a box and played with its alignment within it, as seen in the
1012 * following snippet of the callback for the pressed buttons.
1013 * @skip evas_object_size_hint_align_get
1014 * @until evas_object_size_hint_align_set
1016 * Not much to it. We get the current alignment of the object and change it
1017 * by just a little, depending on which button was pressed, then set it
1018 * again, making sure we stay within the 0.0-1.0 range so the button moves
1019 * inside the space it has, instead of disappearing under the other objects.
1021 * But as useful as an example as that may have been, the usual case with boxes
1022 * is to set everything at the moment they are created, like we did for
1023 * everything else in our main function.
1025 * The entire layout of our program is made with boxes. We have one set as the
1026 * resize object for the window, which means it will always be resized with
1027 * the window. The weight hints set to @c EVAS_HINT_EXPAND will tell the
1028 * window that the box can grow past it's minimum size, which allows resizing
1032 * @until evas_object_show
1034 * Two more boxes, set to horizontal, hold the buttons to change the autorepeat
1035 * configuration used by the buttons. We create each to take over all the
1036 * available space horizontally, but we don't want them to grow vertically,
1037 * so we keep that axis of the weight with 0.0. Then it gets packed in the
1040 * @until evas_object_show
1042 * The buttons in each of those boxes have nothing special, they are just packed
1043 * in with their default values and the box will use their minimum size, as set
1044 * by Elementary itself based on the label, icon, finger size and theme.
1046 * But the buttons used to move the central one have a special disposition.
1047 * The top one first, is placed right into the main box like our other smaller
1048 * boxes. Set to expand horizontally and not vertically, and in this case we
1049 * also tell it to fill that space, so it gets resized to take the entire
1050 * width of the window.
1052 * @skip elm_button_add
1053 * @until evas_object_show
1055 * The bottom one will be the same, but for the other two we need to use a
1056 * second box set to take as much space as we have, so we can place our side
1057 * buttons in place and have the big empty space where the central button will
1060 * @until evas_object_show
1062 * Then the buttons will have their hints inverted to the other top and bottom
1063 * ones, to expand and fill vertically and keep their minimum size horizontally.
1064 * @skip elm_button_add
1065 * @until evas_object_show
1067 * The central button takes every thing else. It will ask to be expanded in
1068 * both directions, but without filling its cell. Changing its alignment by
1069 * pressing the buttons will make it move around.
1070 * @skip elm_button_add
1071 * @until evas_object_show
1073 * To end, the rightmost button is packed in the smaller box after the central
1074 * one, and back to the main box we have the bottom button at the end.
1078 * @page box_example_02 Box - Layout transitions
1080 * @dontinclude box_example_02.c
1082 * Setting a customized layout for a box is simple once you have the layout
1083 * function, which is just like the layout function for @c Evas_Box. The new
1084 * and fancier thing we can do with Elementary is animate the transition from
1085 * one layout to the next. We'll see now how to do that through a simple
1086 * example, while also taking a look at some of the API that was left
1087 * untouched in our @ref box_example_01 "previous example".
1089 * @image html screenshots/box_example_02.png
1090 * @image latex screenshots/box_example_02.eps width=\textwidth
1092 * @skipline Elementary.h
1094 * Our application data consists of a list of layout functions, given by
1095 * @c transitions. We'll be animating through them throughout the entire run.
1096 * The box with the stuff to move around and the last layout that was set to
1097 * make things easier in the code.
1099 * @until Transitions_Data
1101 * The box starts with three buttons, clicking on any of them will take it
1102 * out of the box without deleting the object. There are also two more buttons
1103 * outside, one to add an object to the box and the other to clear it.
1104 * This is all to show how you can interact with the items in the box, add
1105 * things and even remove them, while the transitions occur.
1107 * One of the callback we'll be using creates a new button, asks the box for
1108 * the list of its children and if it's not empty, we add the new object after
1109 * the first one, otherwise just place at the end as it will not make any
1115 * The clear button is even simpler. Everything in the box will be deleted,
1116 * leaving it empty and ready to fill it up with more stuff.
1120 * And a little function to remove buttons from the box without deleting them.
1121 * This one is set for the @c clicked callback of the original buttons,
1122 * unpacking them when clicked and placing it somewhere in the screen where
1123 * they will not disturb. Once we do this, the box no longer has any control
1124 * of it, so it will be left untouched until the program ends.
1128 * If we wanted, we could just call @c evas_object_del() on the object to
1129 * destroy it. In this case, no unpack is really necessary, as the box would
1130 * be notified of a child being deleted and adjust its calculations accordingly.
1132 * The core of the program is the following function. It takes whatever
1133 * function is first on our list of layouts and together with the
1134 * @c last_layout, it creates an ::Elm_Box_Transition to use with
1135 * elm_box_layout_transition(). In here, we tell it to start from whatever
1136 * layout we last set, end with the one that was at the top of the list and
1137 * when everything is finished, call us back so we can create another
1138 * transition. Finally, move the new layout to the end of the list so we
1139 * can continue running through them until the program ends.
1143 * The main function doesn't have antyhing special. Creation of box, initial
1144 * buttons and some callback setting. The only part worth mentioning is the
1145 * initialization of our application data.
1147 * @until evas_object_box_layout_stack
1149 * We have a simple static variable, set the box, the first layout we are
1150 * using as last and create the list with the different functions to go
1153 * And in the end, we set the first layout and call the same function we went
1154 * through before to start the run of transitions.
1155 * @until _test_box_transition_change
1157 * For the full code, follow @ref box_example_02.c "here".
1159 * @example box_example_02.c
1163 * @page calendar_example_01 Calendar - Simple creation.
1164 * @dontinclude calendar_example_01.c
1166 * As a first example, let's just display a calendar in our window,
1167 * explaining all steps required to do so.
1169 * First you should declare objects we intend to use:
1170 * @skipline Evas_Object
1172 * Then a window is created, a title is set and its set to be autodeleted.
1173 * More details can be found on windows examples:
1174 * @until elm_win_autodel
1176 * Next a simple background is placed on our windows. More details on
1177 * @ref bg_01_example_page:
1178 * @until evas_object_show(bg)
1180 * Now, the exciting part, let's add the calendar with elm_calendar_add(),
1181 * passing our window object as parent.
1182 * @until evas_object_show(cal);
1184 * To conclude our example, we should show the window and run elm mainloop:
1187 * Our example will look like this:
1189 * @image html screenshots/calendar_example_01.png
1190 * @image latex screenshots/calendar_example_01.eps width=\textwidth
1192 * See the full source code @ref calendar_example_01.c here.
1193 * @example calendar_example_01.c
1197 * @page calendar_example_02 Calendar - Layout strings formatting.
1198 * @dontinclude calendar_example_02.c
1200 * In this simple example, we'll explain how to format the label displaying
1201 * month and year, and also set weekday names.
1203 * To format month and year label, we need to create a callback function
1204 * to create a string given the selected time, declared under a
1205 * <tt> struct tm </tt>.
1207 * <tt> struct tm </tt>, declared on @c time.h, is a structure composed by
1209 * @li tm_sec seconds [0,59]
1210 * @li tm_min minutes [0,59]
1211 * @li tm_hour hour [0,23]
1212 * @li tm_mday day of month [1,31]
1213 * @li tm_mon month of year [0,11]
1214 * @li tm_year years since 1900
1215 * @li tm_wday day of week [0,6] (Sunday = 0)
1216 * @li tm_yday day of year [0,365]
1217 * @li tm_isdst daylight savings flag
1218 * @note glib version has 2 additional fields.
1220 * For our function, only stuff that matters are tm_mon and tm_year.
1221 * But we don't need to access it directly, since there are nice functions
1222 * to format date and time, as @c strftime.
1223 * We will get abbreviated month (%b) and year (%y) (check strftime manpage
1224 * for more) in our example:
1225 * @skipline static char
1228 * We need to alloc the string to be returned, and calendar widget will
1229 * free it when it's not needed, what is done by @c strdup.
1230 * So let's register our callback to calendar object:
1231 * @skipline elm_calendar_format_function_set
1233 * To set weekday names, we should declare them as an array of strings:
1234 * @dontinclude calendar_example_02.c
1235 * @skipline weekdays
1238 * And finally set them to calendar:
1239 * skipline weekdays_names_set
1241 * Our example will look like this:
1243 * @image html screenshots/calendar_example_02.png
1244 * @image latex screenshots/calendar_example_02.eps width=\textwidth
1246 * See the full source code @ref calendar_example_02.c here.
1247 * @example calendar_example_02.c
1251 * @page calendar_example_03 Calendar - Years restrictions.
1252 * @dontinclude calendar_example_03.c
1254 * This example explains how to set max and min year to be displayed
1255 * by a calendar object. This means that user won't be able to
1256 * see or select a date before and after selected years.
1257 * By default, limits are 1902 and maximun value will depends
1258 * on platform architecture (year 2037 for 32 bits); You can
1259 * read more about time functions on @c ctime manpage.
1261 * Straigh to the point, to set it is enough to call
1262 * elm_calendar_min_max_year_set(). First value is minimun year, second
1263 * is maximum. If first value is negative, it won't apply limit for min
1264 * year, if the second one is negative, won't apply for max year.
1265 * Setting both to negative value will clear limits (default state):
1266 * @skipline elm_calendar_min_max_year_set
1268 * Our example will look like this:
1270 * @image html screenshots/calendar_example_03.png
1271 * @image latex screenshots/calendar_example_03.eps width=\textwidth
1273 * See the full source code @ref calendar_example_03.c here.
1274 * @example calendar_example_03.c
1278 * @page calendar_example_04 Calendar - Days selection.
1279 * @dontinclude calendar_example_04.c
1281 * It's possible to disable date selection and to select a date
1282 * from your program, and that's what we'll see on this example.
1284 * If isn't required that users could select a day on calendar,
1285 * only interacting going through months, disabling days selection
1286 * could be a good idea to avoid confusion. For that:
1287 * @skipline elm_calendar_day_selection_enabled_set
1289 * Also, regarding days selection, you could be interested to set a
1290 * date to be highlighted on calendar from your code, maybe when
1291 * a specific event happens, or after calendar creation. Let's select
1292 * two days from current day:
1293 * @dontinclude calendar_example_04.c
1294 * @skipline SECS_DAY
1295 * @skipline current_time
1296 * @until elm_calendar_selected_time_set
1298 * Our example will look like this:
1300 * @image html screenshots/calendar_example_04.png
1301 * @image latex screenshots/calendar_example_04.eps width=\textwidth
1303 * See the full source code @ref calendar_example_04.c here.
1304 * @example calendar_example_04.c
1308 * @page calendar_example_05 Calendar - Signal callback and getters.
1309 * @dontinclude calendar_example_05.c
1311 * Most of setters explained on previous examples have associated getters.
1312 * That's the subject of this example. We'll add a callback to display
1313 * all calendar information every time user interacts with the calendar.
1315 * Let's check our callback function:
1316 * @skipline static void
1317 * @until double interval;
1319 * To get selected day, we need to call elm_calendar_selected_time_get(),
1320 * but to assure nothing wrong happened, we must check for function return.
1321 * It'll return @c EINA_FALSE if fail. Otherwise we can use time set to
1322 * our structure @p stime.
1323 * @skipline elm_calendar_selected_time_get
1326 * Next we'll get information from calendar and place on declared vars:
1327 * @skipline interval
1328 * @until elm_calendar_weekdays_names_get
1330 * The only tricky part is that last line gets an array of strings
1331 * (char arrays), one for each weekday.
1333 * Then we can simple print that to stdin:
1337 * <tt> struct tm </tt> is declared on @c time.h. You can check @c ctime
1338 * manpage to read about it.
1340 * To register this callback, that will be called every time user selects
1341 * a day or goes to next or previous month, just add a callback for signal
1343 * @skipline evas_object_smart_callback_add
1345 * Our example will look like this:
1347 * @image html screenshots/calendar_example_05.png
1348 * @image latex screenshots/calendar_example_05.eps width=\textwidth
1350 * See the full source code @ref calendar_example_05.c here.
1351 * @example calendar_example_05.c
1355 * @page calendar_example_06 Calendar - Calendar marks.
1356 * @dontinclude calendar_example_06.c
1358 * On this example marks management will be explained. Functions
1359 * elm_calendar_mark_add(), elm_calendar_mark_del() and
1360 * elm_calendar_marks_clear() will be covered.
1362 * To add a mark, will be required to choose three things:
1364 * @li mark date, or start date if it will be repeated
1365 * @li mark periodicity
1367 * Style defines the kind of mark will be displayed over marked day,
1368 * on caledar. Default theme supports @b holiday and @b checked.
1369 * If more is required, is possible to set a new theme to calendar
1370 * widget using elm_object_style_set(), and use
1371 * the signal that will be used by such marks.
1373 * Date is a <tt> struct tm </tt>, as defined by @c time.h. More can
1374 * be read on @c ctime manpage.
1375 * If a date relative from current is required, this struct can be set
1377 * @skipline current_time
1378 * @until localtime_r
1380 * Or if it's an absolute date, you can just declare the struct like:
1381 * @dontinclude calendar_example_06.c
1383 * @until christmas.tm_mon
1385 * Periodicity is how frequently the mark will be displayed over the
1386 * calendar. Can be a unique mark (that don't repeat), or it can repeat
1387 * daily, weekly, monthly or annually. It's enumerated by
1388 * @c Elm_Calendar_Mark_Repeat.
1390 * So let's add some marks to our calendar. We will add christmas holiday,
1391 * set Sundays as holidays, and check current day and day after that.
1392 * @dontinclude calendar_example_06.c
1394 * @until christmas.tm_mon
1395 * @skipline current_time
1396 * @until ELM_CALENDAR_WEEKLY
1398 * We kept the return of first mark add, because we don't really won't it
1399 * to be checked, so let's remove it:
1400 * @skipline elm_calendar_mark_del
1402 * After all marks are added and removed, is required to draw them:
1403 * @skipline elm_calendar_marks_draw
1405 * Finally, to clear all marks, let's set a callback for our button:
1406 * @skipline elm_button_add
1407 * @until evas_object_show(bt);
1409 * This callback will receive our calendar object, and should clear it:
1410 * @dontinclude calendar_example_06.c
1413 * @note Remember to draw marks after clear the calendar.
1415 * Our example will look like this:
1417 * @image html screenshots/calendar_example_06.png
1418 * @image latex screenshots/calendar_example_06.eps width=\textwidth
1420 * See the full source code @ref calendar_example_06.c here.
1421 * @example calendar_example_06.c
1425 * @page spinner_example Spinner widget example
1427 * This code places seven Elementary spinner widgets on a window, each of
1428 * them exemplifying a part of the widget's API.
1430 * The first of them is the default spinner:
1431 * @dontinclude spinner_example.c
1432 * @skipline elm_spinner_add
1433 * @until evas_object_show
1434 * As you see, the defaults for a spinner are:
1436 * @li min value set to 0
1437 * @li max value set to 100
1438 * @li step value set to 1
1439 * @li label format set to "%0.f"
1441 * If another format is required, see the second spinner. It will put a text
1442 * before and after the value, and also format value to display two decimals:
1443 * @skipline format_set
1445 * The third one will use a customized step, define new minimum and maximum
1446 * values and enable wrap, so when value reaches minimum it jumps to maximum,
1447 * or jumps to minimum after maximum value is reached. Format is set to display
1449 * @skipline elm_spinner_add
1450 * @until evas_object_show
1452 * The fourth uses @c vertical style, so instead of left and right arrows,
1453 * top and bottom are displayed. Also the change interval is reduced, so
1454 * user can change value faster.
1456 * @skipline interval
1458 * In the fifth the user won't be allowed to set value directly, i.e., will
1459 * be obligate change value only using arrows:
1460 * @skipline editable
1462 * The sixth widget will receive a lot of special values, so
1463 * instead of reading numeric values, user will see labels for each one.
1464 * Also direct edition is disabled, otherwise users would see the numeric
1465 * value on edition mode. User will be able to select a month in this widget:
1466 * @skipline elm_spinner_add
1467 * @until evas_object_show
1469 * Finally the last widget will exemplify how to listen to widget's signals,
1470 * <tt> changed </tt> and <tt> delay,changed </tt>. First we need to
1471 * implement callback functions that will simply print spinner's value:
1472 * @dontinclude spinner_example.c
1479 * The first callback function should be called everytime value changes,
1480 * the second one only after user stops to increment or decrement. Try
1481 * to keep arrows pressed and check the difference.
1482 * @skip smart_callback
1483 * @skipline smart_callback
1484 * @skipline smart_callback
1486 * See the full @ref spinner_example.c "example", whose window should
1487 * look like this picture:
1489 * @image html screenshots/spinner_example.png
1490 * @image latex screenshots/spinner_example.eps width=\textwidth
1492 * See the full @ref spinner_example_c "source code" for this example.
1494 * @example spinner_example.c
1498 * @page slider_example Slider widget example
1500 * This code places seven Elementary slider widgets on a window, each of
1501 * them exemplifying a part of the widget's API.
1503 * The first of them is the default slider:
1504 * @dontinclude slider_example.c
1505 * @skipline elm_slider_add
1506 * @until evas_object_show
1508 * As you see, the defaults for a slider are:
1511 * @li no values (on indicator or unit labels)
1513 * Actually it's pretty useless this way. So let's learn how to improve it.
1515 * If some decoration is required, a label can be set, and icon before and
1516 * after the bar as well. On the second slider will add a @c home icon
1517 * and a @c folder icon at @c end.
1518 * @skipline text_set
1521 * If the bar size need to be changed, it can be done with span set function,
1522 * that doesn't accounts other widget's parts size. Also the bar can starts
1523 * with a not default value (0.0), as we done on third slider:
1524 * @skipline value_set
1525 * @skipline span_size_set
1527 * So far, users won't be able to see the slider value. If it's required,
1528 * it can be displayed in two different areas, units label or above
1531 * Let's place a units label on our widget, and also let's set minimum and
1532 * maximum value (uses 0.0 and 1.0 by default):
1533 * @skipline unit_format_set
1534 * @skipline min_max_set
1536 * If above the indicator is the place to display the value, just set it.
1537 * Also, is possible to invert a bar, as you can see:
1538 * @skipline indicator_format_set
1539 * @skipline inverted_set
1541 * But if you require to use a function a bit more customized to show the value,
1542 * is possible to registry a callback function that will be called
1543 * to display unit or indicator label. Only the value will be passed to this
1544 * function, that should return a string.
1545 * In this case, a function to free this string will be required.
1547 * Let's exemplify with indicator label on our sixth slider:
1548 * @dontinclude slider_example.c
1559 * Setting callback functions:
1560 * @skipline indicator_format_function_set
1561 * @skipline _indicator_free
1563 * Also, a slider can be displayed vertically:
1564 * @dontinclude slider_example.c
1565 * @skipline elm_slider_horizontal_set
1567 * Finally the last widget will exemplify how to listen to widget's signals,
1568 * <tt> changed </tt> and <tt> delay,changed </tt>. First we need to
1569 * implement callback functions that will simply print slider's value:
1570 * @dontinclude slider_example.c
1577 * The first callback function should be called everytime value changes,
1578 * the second one only after user stops to increment or decrement. Try
1579 * to keep arrows pressed and check the difference.
1580 * @skip smart_callback
1581 * @skipline smart_callback
1582 * @skipline smart_callback
1584 * See the full @ref slider_example.c "example", whose window should
1585 * look like this picture:
1587 * @image html screenshots/slider_example.png
1588 * @image latex screenshots/slider_example.eps width=\textwidth
1590 * See the full @ref slider_example_c "source code" for this example.
1592 * @example slider_example.c
1596 * @page panes_example Panes widget example
1598 * This code places two Elementary panes widgets on a window, one of them
1599 * displayed vertically and the other horizontally, to exemplify
1600 * a part of the widget's API. Also, all the signals emitted by this
1601 * widget will be covered.
1603 * Let's start adding a panes to our window:
1604 * @dontinclude panes_example.c
1605 * @skipline elm_panes_add
1606 * @until evas_object_show
1608 * Now we will set a content (a simple button) to the left side of our
1610 * @skipline elm_button_add
1611 * @until content_left_set
1613 * The content of the right side will be something a bit more elaborated, we'll
1614 * place another panes, displayed vertically (it's displayed horizontally
1616 * @skipline elm_panes_add
1617 * @until content_right_set
1619 * When populating a panes displayed vertically, remember that left content
1620 * will be placed at top, and right content will place at bottom. Next
1621 * we will add two buttons to exemplify that:
1622 * @skipline elm_button_add
1623 * @until content_right_set
1625 * Panes widgets emits 4 different signals, depending on users interaction
1626 * with the draggable bar. We'll add a callback function for each of them.
1628 * <tt> "clicked" signal </tt>:
1630 * Callback function that just print "Clicked" to stdin:
1631 * @dontinclude panes_example.c
1638 * @skipline static void
1641 * Also, add callback function to the panes:
1642 * @skipline "clicked"
1644 * <tt> "press" signal </tt>:
1646 * Callback function that just print "Pressed" to stdin:
1647 * @dontinclude panes_example.c
1650 * @skipline static void
1653 * Also, add callback function to the panes:
1656 * Now, let's try to make our callback functions a bit more useful:
1658 * <tt> "unpress" signal </tt>:
1660 * Suppose we want to know the size proportion of left content after
1661 * user drags the bar. We need to listen for @c unpress signal, and
1662 * get this size from our panes widget. It's done on the following
1664 * @dontinclude panes_example.c
1669 * @skipline static void
1672 * Adding the callback function to the panes:
1673 * @skipline "unpress"
1675 * <tt> "clicked,double" signal </tt>:
1677 * Now, a interesting feature that could be addded to panes widget.
1678 * Hide a content when user double click the draggable bar. It's done
1679 * using a variable to store size and content left size getter and setter
1680 * on the following function:
1681 * @dontinclude panes_example.c
1682 * @skipline static double
1689 * @skipline static void
1694 * Adding the callback function to the panes:
1695 * @skipline "clicked,double"
1698 * See the full @ref panes_example.c "example", whose window should
1699 * look like this picture:
1701 * @image html screenshots/panes_example.png
1702 * @image latex screenshots/panes_example.eps width=\textwidth
1704 * @example panes_example.c
1708 * @page clock_example Clock widget example
1710 * This code places five Elementary clock widgets on a window, each of
1711 * them exemplifying a part of the widget's API.
1713 * The first of them is the pristine clock:
1714 * @dontinclude clock_example.c
1716 * @until evas_object_show
1717 * As you see, the defaults for a clock are:
1719 * - no seconds shown
1721 * For am/pm time, see the second clock:
1722 * @dontinclude clock_example.c
1724 * @until evas_object_show
1726 * The third one will show the seconds digits, which will flip in
1727 * synchrony with system time. Note, besides, that the time itself is
1728 * @b different from the system's -- it was customly set with
1729 * elm_clock_time_set():
1730 * @dontinclude clock_example.c
1731 * @skip with seconds
1732 * @until evas_object_show
1734 * In both fourth and fifth ones, we turn on the <b>edition
1735 * mode</b>. See how you can change each of the sheets on it, and be
1736 * sure to try holding the mouse pressed over one of the sheet
1737 * arrows. The forth one also starts with a custom time set:
1738 * @dontinclude clock_example.c
1740 * @until evas_object_show
1742 * The fifth, besides editable, has only the time @b units editable,
1743 * for hours, minutes and seconds. This exemplifies
1744 * elm_clock_digit_edit_set():
1745 * @dontinclude clock_example.c
1747 * @until evas_object_show
1749 * See the full @ref clock_example.c "example", whose window should
1750 * look like this picture:
1752 * @image html screenshots/clock_example.png
1753 * @image latex screenshots/clock_example.eps width=\textwidth
1755 * See the full @ref clock_example_c "source code" for this example.
1757 * @example clock_example.c
1761 * @page diskselector_example_01 Diskselector widget example
1763 * This code places 4 Elementary diskselector widgets on a window, each of
1764 * them exemplifying a part of the widget's API.
1766 * All of them will have weekdays as items, since we won't focus
1767 * on items management on this example. For an example about this subject,
1768 * check @ref diskselector_example_02.
1770 * The first of them is a default diskselector.
1771 * @dontinclude diskselector_example_01.c
1774 * @skipline elm_diskselector_add
1775 * @until evas_object_show
1777 * We are just adding the diskselector, so as you can see, defaults for it are:
1778 * @li Only 3 items visible each time.
1779 * @li Only 3 characters are displayed for labels on side positions.
1780 * @li The first added item remains centeres, i.e., it's the selected item.
1782 * To add items, we are just appending it on a loop, using function
1783 * elm_diskselector_item_append(), that will be better exaplained on
1784 * items management example.
1786 * For a circular diskselector, check the second widget. A circular
1787 * diskselector will display first item after last, and last previous to
1788 * the first one. So, as you can see, @b Sa will appears on left side
1789 * of selected @b Sunday. This property is set with
1790 * elm_diskselector_round_set().
1792 * Also, we decide to display only 2 character for side labels, instead of 3.
1793 * For this we call elm_diskselector_side_label_length_set(). As result,
1794 * we'll see @b Mo displayed instead of @b Mon, when @b Monday is on a
1797 * @skipline elm_diskselector_add
1798 * @until evas_object_show
1800 * But so far, we are only displaying 3 items at once. If more are wanted,
1801 * is enough to call elm_diskselector_display_item_num_set(), as you can
1803 * @skipline elm_diskselector_add
1804 * @until evas_object_show
1806 * @note You can't set less than 3 items to be displayed.
1808 * Finally, if a bounce effect is required, or you would like to see
1809 * scrollbars, it is possible. But, for default theme, diskselector
1810 * scrollbars will be invisible anyway.
1811 * @skipline elm_diskselector_add
1812 * @until evas_object_show
1814 * See the full @ref diskselector_example_01.c "diskselector_example_01.c"
1815 * code, whose window should look like this picture:
1817 * @image html screenshots/diskselector_example_01.png
1818 * @image latex screenshots/diskselector_example_01.eps width=\textwidth
1820 * @example diskselector_example_01.c
1824 * @page diskselector_example_02 Diskselector - Items management
1826 * This code places a Elementary diskselector widgets on a window,
1827 * along with some buttons trigerring actions on it (though its API).
1828 * It covers most of Elm_Diskselector_Item functions.
1830 * On our @c main function, we are adding a default diskselector with
1831 * 3 items. We are only setting their labels (second parameter of function
1832 * elm_diskselector_item_append):
1833 * @dontinclude diskselector_example_02.c
1834 * @skipline elm_diskselector_add
1837 * Next we are adding lots of buttons, each one for a callback function
1838 * that will realize a task covering part of diskselector items API.
1839 * Lets check the first one:
1840 * @skipline elm_button_add
1841 * @until evas_object_show
1843 * We are labeling the button with a task description with
1844 * elm_object_text_set() and setting a callback
1845 * function evas_object_smart_callback_add().
1846 * Each callback function will have the signature:
1847 * <tt> static void _task_cb(void *data, Evas_Object *obj,
1848 * void *event_info)</tt> with the function name varying for each task.
1850 * Now let's cover all of them.
1852 * <b> Appending an item: </b>
1853 * @dontinclude diskselector_example_02.c
1857 * All items are included on diskselector after last one. You @b can't
1860 * The first parameter of elm_diskselector_item_append() is the diskselector
1861 * object, that we are receiving as data on our callback function.
1862 * The second one is a label, the string that will be placed in the center
1863 * of our item. As we don't wan't icons or callback functions, we can
1864 * send NULL as third, fourth and fifth parameters.
1866 * <b> Appending an item with icon: </b>
1867 * @dontinclude diskselector_example_02.c
1868 * @skipline _add_ic_cb
1871 * If an icon is required, you can pass it as third paramenter on our
1872 * elm_diskselector_item_append() function. It will be place on the
1873 * left side of item's label, that will be shifted to right a bit.
1875 * For more details about how to create icons, look for elm_icon examples.
1877 * <b> Appending an item with callback function for selected: </b>
1878 * @dontinclude diskselector_example_02.c
1883 * To set a callback function that will be called every time an item is
1884 * selected, i.e., everytime the diskselector stops with this item in
1885 * center position, just pass the function as fourth paramenter.
1887 * <b> Appending an item with callback function for selected with data: </b>
1888 * @dontinclude diskselector_example_02.c
1889 * @skipline _sel_data_cb
1895 * If the callback function request an extra data, it can be attached to our
1896 * item passing a pointer for data as fifth parameter.
1897 * Our function _sel_data_cb will receive it as <tt> void *data </tt>.
1899 * If you want to free this data, or handle that the way you need when the
1900 * item is deleted, set a callback function for that, with
1901 * elm_diskselector_item_del_cb_set().
1903 * As you can see we check if @c it is not @c NULL after appending it.
1904 * If an error happens, we won't try to set a function for it.
1906 * <b> Deleting an item: </b>
1907 * @dontinclude diskselector_example_02.c
1912 * To delete an item we simple need to call elm_diskselector_item_del() with
1913 * a pointer for such item.
1915 * If you need, you can get selected item with
1916 * elm_diskselector_selected_item_get(), that will return a pointer for it.
1918 * <b> Unselecting an item: </b>
1919 * @dontinclude diskselector_example_02.c
1920 * @skipline _unselect_cb
1923 * To select an item, you should call elm_diskselector_item_selected_set()
1924 * passing @c EINA_TRUE, and to unselect it, @c EINA_FALSE.
1926 * If you unselect the selected item, diskselector will automatically select
1929 * <b> Printing all items: </b>
1930 * @dontinclude diskselector_example_02.c
1931 * @skipline _print_cb
1934 * <b> Clearing the diskselector: </b>
1935 * @dontinclude diskselector_example_02.c
1936 * @skipline _clear_cb
1939 * <b> Selecting the first item: </b>
1940 * @dontinclude diskselector_example_02.c
1941 * @skipline _select_first_cb
1944 * <b> Selecting the last item: </b>
1945 * @dontinclude diskselector_example_02.c
1946 * @skipline _select_last_cb
1949 * <b> Selecting the next item: </b>
1950 * @dontinclude diskselector_example_02.c
1951 * @skipline _select_next_cb
1954 * <b> Selecting the previous item: </b>
1955 * @dontinclude diskselector_example_02.c
1956 * @skipline _select_prev_cb
1959 * See the full @ref diskselector_example_02.c "diskselector_example_02.c"
1960 * code, whose window should look like this picture:
1962 * @image html screenshots/diskselector_example_02.png
1963 * @image latex screenshots/diskselector_example_02.eps width=\textwidth
1965 * @example diskselector_example_02.c
1969 * @page list_example_01 List widget example
1971 * This code places a single Elementary list widgets on a window, just
1972 * to exemplify the more simple and common use case: a list will be created
1973 * and populated with a few items.
1975 * To keep it simple, we won't show how to customize the list, for this check
1976 * @ref list_example_02. Also, we won't focus
1977 * on items management on this example. For an example about this subject,
1978 * check @ref list_example_03.
1980 * To add a list widget.
1981 * @dontinclude list_example_01.c
1982 * @skipline elm_list_add
1984 * We are just adding the list, so as you can see, defaults for it are:
1985 * @li Items are displayed vertically.
1986 * @li Only one item can be selected.
1987 * @li The list doesn't bouce.
1989 * To add items, we are just appending it on a loop, using function
1990 * elm_list_item_append(), that will be better exaplained on
1991 * items management example.
1992 * @dontinclude list_example_01.c
1996 * @skipline elm_list_item_append
1998 * After we just want to show the list. But first we need to start the widget.
1999 * It was done this way to improve widget's performance. So, always remember
2001 * @warning Call elm_list_go before showing the object
2002 * @skipline elm_list_go
2005 * See the full @ref list_example_01.c "list_example_01.c"
2006 * code, whose window should look like this picture:
2008 * @image html screenshots/list_example_01.png
2009 * @image latex screenshots/list_example_01.eps width=\textwidth
2011 * @example list_example_01.c
2015 * @page list_example_02 List widget example
2017 * This code places a single Elementary list widgets on a window,
2018 * exemplifying a part of the widget's API.
2020 * First, we will just create a simple list, as done on @ref list_example_01 :
2021 * @dontinclude list_example_02.c
2024 * @skipline elm_list_add
2025 * @until elm_list_item_append
2027 * Now, let's customize this list a bit. First we will display items
2029 * @skipline horizontal_set
2031 * Then we will choose another list mode. There are four of them, and
2032 * the default #Elm_List_Mode is #ELM_LIST_SCROLL. Let's set compress mode:
2033 * @skipline mode_set
2035 * To enable multiple items selection, we need to enable it, since only one
2036 * selected item is allowed by default:
2037 * @skipline elm_list_multi_select_set
2039 * We are not adding items with callback functions here,
2040 * since we'll explain it better on @ref list_example_03. But if the callback
2041 * need to be called everytime user clicks an item, even if already selected,
2042 * it's required to enable this behavior:
2043 * @skipline elm_list_always_select_mode_set
2045 * Finally, if a bounce effect is required, or you would like to see
2046 * scrollbars, it is possible. But, for default theme, list
2047 * scrollbars will be invisible anyway.
2048 * @skipline bounce_set
2049 * @until SCROLLER_POLICY_ON
2051 * See the full @ref list_example_02.c "list_example_02.c"
2052 * code, whose window should look like this picture:
2054 * @image html screenshots/list_example_02.png
2055 * @image latex screenshots/list_example_02.eps width=\textwidth
2057 * @example list_example_02.c
2061 * @page list_example_03 List - Items management
2063 * This code places a Elementary list widgets on a window,
2064 * along with some buttons trigerring actions on it (though its API).
2065 * It covers most of Elm_List_Item functions.
2067 * On our @c main function, we are adding a default list with
2068 * 3 items. We are only setting their labels (second parameter of function
2069 * elm_list_item_append):
2070 * @dontinclude list_example_03.c
2071 * @skipline elm_list_add
2074 * Next we are adding lots of buttons, each one for a callback function
2075 * that will realize a task covering part of list items API.
2076 * Lets check the first one:
2077 * @skipline elm_button_add
2078 * @until evas_object_show
2080 * We are labeling the button with a task description with
2081 * elm_object_text_set() and setting a callback
2082 * function evas_object_smart_callback_add().
2083 * Each callback function will have the signature:
2084 * <tt> static void _task_cb(void *data, Evas_Object *obj,
2085 * void *event_info)</tt> with the function name varying for each task.
2087 * Now let's cover all of them.
2089 * <b> Prepending an item: </b>
2090 * @dontinclude list_example_03.c
2091 * @skipline _prepend_cb
2094 * The item will be placed on the begining of the list,
2095 * i.e. it will be the first one.
2097 * The first parameter of elm_list_item_prepend() is the list
2098 * object, that we are receiving as data on our callback function.
2099 * The second one is a label, the string that will be placed in the center
2100 * of our item. As we don't wan't icons or callback functions, we can
2101 * send NULL as third, fourth, fifth and sixth parameters.
2103 * <b> Appending an item: </b>
2104 * @dontinclude list_example_03.c
2108 * Items included with append will be inserted inserted after the last one.
2110 * <b> Appending an item with icon: </b>
2111 * @dontinclude list_example_03.c
2112 * @skipline _add_ic_cb
2115 * If an icon is required, you can pass it as third paramenter on our
2116 * elm_list_item_append() function. It will be place on the
2117 * left side of item's label. If an icon is wanted on the right side,
2118 * it should be passed as fourth parameter.
2120 * For more details about how to create icons, look for elm_icon examples
2121 * @ref tutorial_icon.
2123 * <b> Appending an item with callback function for selected: </b>
2124 * @dontinclude list_example_03.c
2129 * To set a callback function that will be called every time an item is
2130 * selected, i.e., everytime the list stops with this item in
2131 * center position, just pass the function as fifth paramenter.
2133 * <b> Appending an item with callback function for selected with data: </b>
2134 * @dontinclude list_example_03.c
2135 * @skipline _sel_data_cb
2141 * If the callback function request an extra data, it can be attached to our
2142 * item passing a pointer for data as sixth parameter.
2143 * Our function _sel_data_cb will receive it as <tt> void *data </tt>.
2145 * If you want to free this data, or handle that the way you need when the
2146 * item is deleted, set a callback function for that, with
2147 * elm_list_item_del_cb_set().
2149 * As you can see we check if @c it is not @c NULL after appending it.
2150 * If an error happens, we won't try to set a function for it.
2152 * <b> Deleting an item: </b>
2153 * @dontinclude list_example_03.c
2154 * @skipline _del_cb(
2157 * To delete an item we simple need to call elm_list_item_del() with
2158 * a pointer for such item.
2160 * If you need, you can get selected item with
2161 * elm_list_selected_item_get(), that will return a pointer for it.
2163 * <b> Unselecting an item: </b>
2164 * @dontinclude list_example_03.c
2165 * @skipline _unselect_cb
2168 * To select an item, you should call elm_list_item_selected_set()
2169 * passing @c EINA_TRUE, and to unselect it, @c EINA_FALSE.
2171 * <b> Printing all items: </b>
2172 * @dontinclude list_example_03.c
2173 * @skipline _print_cb
2176 * <b> Clearing the list: </b>
2177 * @dontinclude list_example_03.c
2178 * @skipline _clear_cb
2181 * <b> Selecting the next item: </b>
2182 * @dontinclude list_example_03.c
2183 * @skipline _select_next_cb
2186 * <b> Inserting after an item: </b>
2187 * @dontinclude list_example_03.c
2188 * @skipline _insert_after_cb
2191 * <b> Selecting the previous item: </b>
2192 * @dontinclude list_example_03.c
2193 * @skipline _select_prev_cb
2196 * <b> Inserting before an item: </b>
2197 * @dontinclude list_example_03.c
2198 * @skipline _insert_before_cb
2201 * If a separator is required, just set an item as such:
2202 * @dontinclude list_example_03.c
2203 * @skipline _set_separator_cb
2206 * Also an item can be disabled, and the user won't be allowed to (un)select it:
2207 * @dontinclude list_example_03.c
2208 * @skipline _disable_cb
2211 * See the full @ref list_example_03.c "list_example_03.c"
2212 * code, whose window should look like this picture:
2214 * @image html screenshots/list_example_03.png
2215 * @image latex screenshots/list_example_03.eps width=\textwidth
2217 * @example list_example_03.c
2221 * @page segment_control_example Segment Control Example
2223 * This code places a Elementary segment control widgets on a window,
2224 * to exemplify part of the widget's API.
2226 * Let's start adding a segment control to our window:
2227 * @dontinclude segment_control_example.c
2228 * @skipline elm_segment_control_add
2229 * @until evas_object_show
2231 * Now will add an item only with label:
2232 * @skipline item_add
2234 * Really simple. To add an item with only an icon, the icon needs to be created
2235 * first, them added with this same function:
2236 * @skipline icon_add
2239 * If an item with label and icon is required, it can be done as well. In this
2240 * case, instead of a label (or icon) centered, the item will display an icon
2241 * at left and the label at right:
2242 * @skipline icon_add
2245 * But, if you need to add some items that can have or not a label, but
2246 * want that all of them looks the same way, with icon at left, just add
2247 * an empty string label. It's done on our example to ilustrate that:
2248 * @skipline icon_add
2251 * So far, all the item were added to the last position of the widget,
2252 * but if something different is required, it can be done using another
2253 * insertion function. Let's suppose we want to put an item just before
2258 * There are two ways to delete items. Using the item handle, like:
2259 * @skipline insert_at
2262 * Or using item's index:
2263 * @skipline insert_at
2266 * To set properties of an item already added to the widget, you just need
2267 * to get the item and set icon or label, as the following code shows:
2268 * @skipline item_get
2271 * Finally, it's possible to select an item from the code, and also get
2272 * the selected item. We will select the item at the center of the widget
2273 * and print its position.
2274 * @skipline count_get
2277 * See the full @ref segment_control_example.c "example", whose window should
2278 * look like this picture:
2280 * @image html screenshots/segment_control_example.png
2281 * @image latex screenshots/segment_control_example.eps width=\textwidth
2283 * @example segment_control_example.c
2287 * @page flipselector_example Flip selector widget example
2289 * This code places an Elementary flip selector widget on a window,
2290 * along with two buttons trigerring actions on it (though its API).
2292 * The selector is being populated with the following items:
2293 * @dontinclude flipselector_example.c
2297 * Next, we create it, populating it with those items and registering
2298 * two (smart) callbacks on it:
2299 * @dontinclude flipselector_example.c
2300 * @skip fp = elm_flipselector_add
2301 * @until object_show
2303 * Those two callbacks will take place whenever one of those smart
2304 * events occur, and they will just print something to @c stdout:
2305 * @dontinclude flipselector_example.c
2306 * @skip underflow callback
2307 * @until static void
2308 * Flip the sheets on the widget while looking at the items list, in
2309 * the source code, and you'll get the idea of those events.
2311 * The two buttons below the flip selector will take the actions
2312 * described in their labels:
2313 * @dontinclude flipselector_example.c
2314 * @skip bt = elm_button_add
2315 * @until callback_add(win
2317 * @dontinclude flipselector_example.c
2318 * @skip unselect the item
2321 * Click on them to exercise those flip selector API calls. To
2322 * interact with the other parts of this API, there's a command line
2323 * interface, whose help string can be asked for with the 'h' key:
2324 * @dontinclude flipselector_example.c
2328 * The 'n' and 'p' keys will exemplify elm_flipselector_flip_next()
2329 * and elm_flipselector_flip_prev(), respectively. 'f' and 'l' account
2330 * for elm_flipselector_first_item_get() and
2331 * elm_flipselector_last_item_get(), respectively. Finally, 's' will
2332 * issue elm_flipselector_selected_item_get() on our example flip
2335 * See the full @ref flipselector_example.c "example", whose window should
2336 * look like this picture:
2338 * @image html screenshots/flipselector_example.png
2339 * @image latex screenshots/flipselector_example.eps width=\textwidth
2341 * See the full @ref flipselector_example_c "source code" for this example.
2343 * @example flipselector_example.c
2347 * @page fileselector_example File selector widget example
2349 * This code places two Elementary file selector widgets on a window.
2350 * The one on the left is layouting file system items in a @b list,
2351 * while the the other is layouting them in a @b grid.
2353 * The one having the majority of hooks of interest is on the left,
2354 * which we create as follows:
2355 * @dontinclude fileselector_example.c
2356 * @skip first file selector
2357 * @until object_show
2359 * Note that we enable custom edition of file/directory selection, via
2360 * the text entry it has on its bottom, via
2361 * elm_fileselector_is_save_set(). It starts with the list view, which
2362 * is the default, and we make it not expandable in place
2363 * (elm_fileselector_expandable_set()), so that it replaces its view's
2364 * contents with the current directory's entries each time one
2365 * navigates to a different folder. For both of file selectors we are
2366 * starting to list the contents found in the @c "/tmp" directory
2367 * (elm_fileselector_path_set()).
2369 * Note the code setting it to "grid mode" and observe the differences
2370 * in the file selector's views, in the example. We also hide the
2371 * second file selector's Ok/Cancel buttons -- since it's there just
2372 * to show the grid view (and navigation) -- via
2373 * elm_fileselector_buttons_ok_cancel_set().
2375 * The @c "done" event, which triggers the callback below
2376 * @dontinclude fileselector_example.c
2379 * will be called at the time one clicks the "Ok"/"Cancel" buttons of
2380 * the file selector (on the left). Note that it will print the path
2381 * to the current selection, if any.
2383 * The @c "selected" event, which triggers the callback below
2384 * @dontinclude fileselector_example.c
2385 * @skip bt = 'selected' cb
2387 * takes place when one selects a file (if the file selector is @b not
2388 * under folders-only mode) or when one selects a folder (when in
2389 * folders-only mode). Experiment it by selecting different file
2392 * What comes next is the code creating the three check boxes and two
2393 * buttons below the file selector in the right. They will exercise a
2394 * bunch of functions on the file selector's API, for the instance on
2395 * the left. Experiment with them, specially the buttons, to get the
2396 * difference between elm_fileselector_path_get() and
2397 * elm_fileselector_selected_get().
2399 * Finally, there's the code adding the second file selector, on the
2401 * @dontinclude fileselector_example.c
2402 * @skip second file selector
2403 * @until object_show
2405 * Pay attention to the code setting it to "grid mode" and observe the
2406 * differences in the file selector's views, in the example. We also
2407 * hide the second file selector's Ok/Cancel buttons -- since it's
2408 * there just to show the grid view (and navigation) -- via
2409 * elm_fileselector_buttons_ok_cancel_set().
2411 * See the full @ref fileselector_example.c "example", whose window
2412 * should look like this picture:
2414 * @image html screenshots/fileselector_example.png
2415 * @image latex screenshots/fileselector_example.eps width=\textwidth
2417 * See the full @ref fileselector_example_c "source code" for this example.
2419 * @example fileselector_example.c
2423 * @page fileselector_button_example File selector button widget example
2425 * This code places an Elementary file selector button widget on a
2426 * window, along with some other checkboxes and a text entry. Those
2427 * are there just as knobs on the file selector button's state and to
2428 * display information from it.
2430 * Here's how we instantiate it:
2431 * @dontinclude fileselector_button_example.c
2432 * @skip ic = elm_icon_add
2433 * @until evas_object_show
2435 * Note that we set on it both icon and label decorations. It's set to
2436 * list the contents of the @c "/tmp" directory, too, with
2437 * elm_fileselector_button_path_set(). What follows are checkboxes to
2438 * exercise some of its API funtions:
2439 * @dontinclude fileselector_button_example.c
2440 * @skip ck = elm_check_add
2441 * @until evas_object_show(en)
2443 * The checkboxes will toggle whether the file selector button's
2444 * internal file selector:
2445 * - must have an editable text entry for file names (thus, be in
2446 * "save dialog mode")
2447 * - is to be raised as an "inner window" (note it's the default
2448 * behavior) or as a dedicated window
2449 * - is to populate its view with folders only
2450 * - is to expand its folders, in its view, <b>in place</b>, and not
2451 * repainting it entirely just with the contents of a sole
2454 * The entry labeled @c "Last selection" will exercise the @c
2455 * "file,chosen" smart event coming from the file selector button:
2456 * @dontinclude fileselector_button_example.c
2458 * @until toggle inwin
2460 * Whenever you dismiss or acknowledges the file selector, after it's
2461 * raised, the @c event_info string will contain the last selection on
2462 * it (if any was made).
2464 * This is how the example, just after called, should look like:
2466 * @image html screenshots/fileselector_button_example_00.png
2467 * @image latex screenshots/fileselector_button_example_00.eps width=\textwidth
2469 * Click on the file selector button to raise its internal file
2470 * selector, which will be contained on an <b>"inner window"</b>:
2472 * @image html screenshots/fileselector_button_example_01.png
2473 * @image latex screenshots/fileselector_button_example_01.eps width=\textwidth
2475 * Toggle the "inwin mode" switch off and, if you click on the file
2476 * selector button again, you'll get @b two windows, the original one
2477 * (note the last selection there!)
2479 * @image html screenshots/fileselector_button_example_02.png
2480 * @image latex screenshots/fileselector_button_example_02.eps width=\textwidth
2482 * and the file selector's new one
2484 * @image html screenshots/fileselector_button_example_03.png
2485 * @image latex screenshots/fileselector_button_example_03.eps width=\textwidth
2487 * Play with the checkboxes to get the behavior changes on the file
2488 * selector button. The respective API calls on the widget coming from
2489 * those knobs where shown in the code already.
2491 * See the full @ref fileselector_button_example_c "source code" for
2494 * @example fileselector_button_example.c
2498 * @page fileselector_entry_example File selector entry widget example
2500 * This code places an Elementary file selector entry widget on a
2501 * window, along with some other checkboxes. Those are there just as
2502 * knobs on the file selector entry's state.
2504 * Here's how we instantiate it:
2505 * @dontinclude fileselector_entry_example.c
2506 * @skip ic = elm_icon_add
2507 * @until evas_object_show
2509 * Note that we set on it's button both icon and label
2510 * decorations. It's set to exhibit the path of (and list the contents
2511 * of, when internal file selector is launched) the @c "/tmp"
2512 * directory, also, with elm_fileselector_entry_path_set(). What
2513 * follows are checkboxes to exercise some of its API funtions:
2514 * @dontinclude fileselector_entry_example.c
2515 * @skip ck = elm_check_add
2516 * @until callback_add(fs_entry
2518 * The checkboxes will toggle whether the file selector entry's
2519 * internal file selector:
2520 * - must have an editable text entry for file names (thus, be in
2521 * "save dialog mode")
2522 * - is to be raised as an "inner window" (note it's the default
2523 * behavior) or as a dedicated window
2524 * - is to populate its view with folders only
2525 * - is to expand its folders, in its view, <b>in place</b>, and not
2526 * repainting it entirely just with the contents of a sole
2529 * Observe how the entry's text will match the string coming from the
2530 * @c "file,chosen" smart event:
2531 * @dontinclude fileselector_entry_example.c
2534 * Whenever you dismiss or acknowledges the file selector, after it's
2535 * raised, the @c event_info string will contain the last selection on
2536 * it (if any was made).
2538 * Try, also, to type in a valid system path and, then, open the file
2539 * selector's window: it will start the file browsing there, for you.
2541 * This is how the example, just after called, should look like:
2543 * @image html screenshots/fileselector_entry_example_00.png
2544 * @image latex screenshots/fileselector_entry_example_00.eps width=\textwidth
2546 * Click on the file selector entry to raise its internal file
2547 * selector, which will be contained on an <b>"inner window"</b>:
2549 * @image html screenshots/fileselector_entry_example_01.png
2550 * @image latex screenshots/fileselector_entry_example_01.eps width=\textwidth
2552 * Toggle the "inwin mode" switch off and, if you click on the file
2553 * selector entry again, you'll get @b two windows, the original one
2554 * (note the last selection there!)
2556 * @image html screenshots/fileselector_entry_example_02.png
2557 * @image latex screenshots/fileselector_entry_example_02.eps width=\textwidth
2559 * and the file selector's new one
2561 * @image html screenshots/fileselector_entry_example_03.png
2562 * @image latex screenshots/fileselector_entry_example_03.eps width=\textwidth
2564 * Play with the checkboxes to get the behavior changes on the file
2565 * selector entry. The respective API calls on the widget coming from
2566 * those knobs where shown in the code already.
2568 * See the full @ref fileselector_entry_example_c "source code" for
2571 * @example fileselector_entry_example.c
2575 * @page layout_example_01 Layout - Content, Table and Box
2577 * This example shows how one can use the @ref Layout widget to create a
2578 * customized distribution of widgets on the screen, controled by an Edje theme.
2579 * The full source code for this example can be found at @ref
2580 * layout_example_01_c.
2582 * Our custom layout is defined by a file, @ref layout_example_edc, which is an
2583 * Edje theme file. Look for the Edje documentation to understand it. For now,
2584 * it's enough to know that we describe some specific parts on this layout
2586 * @li a title text field;
2587 * @li a box container;
2588 * @li a table container;
2589 * @li and a content container.
2591 * Going straight to the code, the following snippet instantiates the layout
2594 * @dontinclude layout_example_01.c
2595 * @skip elm_layout_add
2596 * @until evas_object_show(layout)
2598 * As any other widget, we set some properties for the size calculation. But
2599 * notice on this piece of code the call to the function elm_layout_file_set().
2600 * Here is where the theme file is loaded, and particularly the specific group
2601 * from this theme file. Also notice that the theme file here is referenced as
2602 * an .edj, which is a .edc theme file compiled to its binary form. Again, look
2603 * for the Edje documentation for more information about theme files.
2605 * Next, we fetch from our theme a data string referenced by the key "title".
2606 * This data was defined in the theme, and can be used as parameters which the
2607 * program get from the specific theme that it is using. In this case, we store
2608 * the title of this window and program in the theme, as a "data" entry, just
2609 * for demonstration purposes:
2613 * This call elm_layout_data_get() is used to fetch the string based on the key,
2614 * and elm_object_text_part_set() will set the part defined in the theme as
2615 * "example/title" to contain this string. This key "example/title" has nothing
2616 * special. It's just an arbitrary convention that we are using in this example.
2617 * Every string in this example referencing a part of this theme will be of the
2618 * form "example/<something>".
2620 * Now let's start using our layout to distribute things on the window space.
2621 * Since the layout was added as a resize object to the elementary window, it
2622 * will always occupy the entire space available for this window.
2624 * The theme already has a title, and it also defines a table element which is
2625 * positioned approximately between 50% and 70% of the height of this window,
2626 * and has 100% of the width. We create some widgets (two icons, a clock and a
2627 * button) and pack them inside the table, in a distribution similar to a HTML
2630 * @until evas_object_show(bt)
2632 * Notice that we just set size hints for every object, and call the function
2633 * elm_layout_table_pack(), which does all the work. It will place the elements
2634 * in the specified row/column, with row and column span if required, and then
2635 * the object's size and position will be controled by the layout widget. It
2636 * will also respect size hints, alignments and weight properties set to these
2637 * widgets. The resulting distribution on the screen depends on the table
2638 * properties (described in the theme), the size hints set on each widget, and
2639 * on the cells of the table that are being used.
2641 * For instance, we add the two icons and the clock on the first, second and
2642 * third cells of the first row, and add the button the second row, making it
2643 * span for 3 columns (thus having the size of the entire table width). This
2644 * will result in a table that has 2 rows and 3 columns.
2646 * Now let's add some widgets to the box area of our layout. This box is around
2647 * 20% and 50% of the vertical size of the layout, and 100% of its width. The
2648 * theme defines that it will use an "horizontal flow" distribution to its
2649 * elements. Unlike the table, a box will distribute elements without knowing
2650 * about rows and columns, and the distribution function selected will take care
2651 * of putting them in row, column, both, or any other available layout. This is
2652 * also described in the Edje documentation.
2654 * This box area is similar to the @ref Box widget of elementary, with the
2655 * difference that its position and properties are controled by the theme of the
2656 * layout. It also contains more than one API to add items to it, since the
2657 * items position now is defined in terms of a list of items, not a matrix.
2658 * There's the first position (can have items added to it with
2659 * elm_layout_box_prepend()), the last position (elm_layout_box_append()), the
2660 * nth position (elm_layout_box_insert_at()) and the position right before an
2661 * element (elm_layout_box_insert_before()). We use insert_at and prepend
2662 * functions to add the first two buttons to this box, and insert_before on the
2663 * callback of each button. The callback code will be shown later, but it
2664 * basically adds a button just before the clicked button using the
2665 * elm_layout_box_insert_before() function. Here's the code for adding the first
2668 * @until evas_object_show(item)
2669 * @until evas_object_show(item)
2671 * Finally, we have an area in this layout theme, in the bottom part of it,
2672 * reserved for adding an specific widget. Differently from the 2 parts
2673 * described until now, this one can only receive one widget with the call
2674 * elm_layout_content_set(). If there was already an item on this specific part,
2675 * it will be deleted (one can use elm_layout_content_unset() in order to remove
2676 * it without deleting). An example of removing it without deleting, but
2677 * manually deleting this widget just after that, can be seen on the callback
2678 * for this button. Actually, the callback defined for this button will clean
2679 * the two other parts (deleting all of their elements) and then remove and
2680 * delete this button.
2682 * @until _swallow_btn_cb
2684 * Also notice that, for this last added button, we don't have to call
2685 * evas_object_show() on it. This is a particularity of the theme for layouts,
2686 * that will have total control over the properties like size, position,
2687 * visibility and clipping of a widget added with elm_layout_content_set().
2688 * Again, read the Edje documentation to understand this better.
2690 * Now we just put the code for the different callbacks specified for each kind
2691 * of button and make simple comments about them:
2693 * @dontinclude layout_example_01.c
2695 * @until evas_object_del(item)
2698 * The first callback is used for the button in the table, and will just remove
2699 * itself from the table with elm_layout_table_unpack(), which remove items
2700 * without deleting them, and then calling evas_object_del() on itself.
2702 * The second callback is for buttons added to the box. When clicked, these
2703 * buttons will create a new button, and add them to the same box, in the
2704 * position just before the clicked button.
2706 * And the last callback is for the button added to the "content" area. It will
2707 * clear both the table and the box, passing @c EINA_TRUE to their respective @c
2708 * clear parameters, which will imply on the items of these containers being
2711 * A screenshot of this example can be seen on:
2713 * @image html screenshots/layout_example_01.png
2714 * @image latex screenshots/layout_example_01.eps width=\textwidth
2719 * @page layout_example_02 Layout - Predefined Layout
2721 * This example shows how one can use the @ref Layout with a predefined theme
2722 * layout to add a back and next button to a simple window. The full source code
2723 * for this example can be found at @ref layout_example_02_c.
2725 * After setting up the window and background, we add the layout widget to the
2726 * window. But instead of using elm_layout_file_set() to load its theme from a
2727 * custom theme file, we can use elm_layout_theme_set() to load one of the
2728 * predefined layouts that come with elementary. Particularly on this example,
2729 * we load the them of class "layout", group "application" and style
2730 * "content-back-next" (since we want the back and next buttons).
2732 * @dontinclude layout_example_02.c
2733 * @skip elm_layout_add
2734 * @until evas_object_show(layout)
2736 * This default theme contains only a "content" area named
2737 * "elm.swallow.content", where we can add any widget (it can be even a
2738 * container widget, like a box, frame, list, or even another layout). Since we
2739 * just want to show the resulting layout, we add a simple icon to it:
2741 * @until layout_content_set
2743 * This default layout also provides some signals when the next and prev buttons
2744 * are clicked. We can register callbacks to them with the
2745 * elm_object_signal_callback_add() function:
2747 * @until elm,action,next
2749 * In the @ref layout_example_03 you can see how to send signals to the layout with
2750 * elm_object_signal_emit().
2752 * Now our callback just changes the picture being displayed when one of the
2753 * buttons are clicked:
2755 * @dontinclude layout_example_02.c
2757 * @until standard_set
2760 * It's possible to see that it gets the name of the image being shown from the
2761 * array of image names, going forward on this array when "next" is clicked and
2762 * backward when "back" is clicked.
2764 * A screenshot of this example can be seen on:
2766 * @image html screenshots/layout_example_02.png
2767 * @image latex screenshots/layout_example_02.eps width=\textwidth
2771 * @page layout_example_03 Layout - Signals and Size Changed
2773 * This example shows how one can send and receive signals to/from the layout,
2774 * and what to do when the layout theme has its size changed. The full source
2775 * code for this example can be found at @ref layout_example_03_c.
2777 * In this exmaple we will use another group from the same layout theme file
2778 * used in @ref layout_example_01. Its instanciation and loading happens in the
2781 * @dontinclude layout_example_03.c
2782 * @skip elm_layout_add
2783 * @until evas_object_show
2785 * This time we register a callback to be called whenever we receive a signal
2786 * after the end of the animation that happens in this layout:
2788 * @until signal_callback_add
2790 * We also add a button that will send signals to the layout:
2792 * @until callback_add
2794 * The callback for this button will check what type of signal it should send,
2795 * and then emit it. The code for this callback follows:
2797 * @dontinclude layout_exmaple_03.c
2798 * @skip static Eina_Bool
2803 * As we said before, we are receiving a signal whenever the animation started
2804 * by the button click ends. This is the callback for that signal:
2808 * Notice from this callback that the elm_layout_sizing_eval() function must be
2809 * called if we want our widget to update its size after the layout theme having
2810 * changed its minimum size. This happens because the animation specified in the
2811 * theme increases the size of the content area to a value higher than the
2812 * widget size, thus requiring more space. But the elementary layout widget
2813 * has no way to know this, thus needing the elm_layout_sizing_eval() to
2814 * be called on the layout, informing that this size has changed.
2816 * A screenshot of this example can be seen on:
2818 * @image html screenshots/layout_example_03.png
2819 * @image latex screenshots/layout_example_03.eps width=\textwidth
2823 * @page tutorial_hover Hover example
2824 * @dontinclude hover_example_01.c
2826 * On this example we are going to have a button that when clicked will show our
2827 * hover widget, this hover will have content set on it's left, top, right and
2828 * middle positions. In the middle position we are placing a button that when
2829 * clicked will hide the hover. We are also going to use a non-default theme
2830 * for our hover. We won't explain the functioning of button for that see @ref
2833 * We start our example with a couple of callbacks that show and hide the data
2834 * they're given(which we'll see later on is the hover widget):
2839 * In our main function we'll do some initialization and then create 3
2840 * rectangles, one red, one green and one blue to use in our hover. We'll also
2841 * create the 2 buttons that will show and hide the hover:
2844 * With all of that squared away we can now get to the heart of the matter,
2845 * creating our hover widget, which is easy as pie:
2848 * Having created our hover we now need to set the parent and target. Which if
2849 * you recall from the function documentations are going to tell the hover which
2850 * area it should cover and where it should be centered:
2853 * Now we set the theme for our hover. We're using the popout theme which gives
2854 * our contents a white background and causes their appearance to be animated:
2857 * And finally we set the content for our positions:
2860 * So far so good? Great 'cause that's all there is too it, what is left now is
2861 * just connecting our buttons to the callbacks we defined at the beginning of
2862 * the example and run the main loop:
2865 * Our example will initially look like this:
2867 * @image html screenshots/hover_example_01.png
2868 * @image latex screenshots/hover_example_01.eps width=\textwidth
2870 * And after you click the "Show hover" button it will look like this:
2872 * @image html screenshots/hover_example_01_a.png
2873 * @image latex screenshots/hover_example_01_a.eps width=\textwidth
2875 * @example hover_example_01.c
2879 * @page tutorial_flip Flip example
2880 * @dontinclude flip_example_01.c
2882 * This example will show a flip with two rectangles on it(one blue, one
2883 * green). Our example will allow the user to choose the animation the flip
2884 * uses and to interact with it. To allow the user to choose the interaction
2885 * mode we use radio buttons, we will however not explain them, if you would
2886 * like to know more about radio buttons see @ref radio.
2888 * We start our example with the usual setup and then create the 2 rectangles
2889 * we will use in our flip:
2890 * @until show(rect2)
2892 * The next thing to do is to create our flip and set it's front and back
2896 * The next thing we do is set the interaction mode(which the user can later
2897 * change) to the page animation:
2900 * Setting a interaction mode however is not sufficient, we also need to
2901 * choose which directions we allow interaction from, for this example we
2902 * will use all of them:
2905 * We are also going to set the hitsize to the entire flip(in all directions)
2906 * to make our flip very easy to interact with:
2909 * After that we create our radio buttons and start the main loop:
2912 * When the user clicks a radio button a function that changes the
2913 * interaction mode and animates the flip is called:
2915 * @note The elm_flip_go() call here serves no purpose other than to
2916 * ilustrate that it's possible to animate the flip programmatically.
2918 * Our example will look like this:
2920 * @image html screenshots/flip_example_01.png
2921 * @image latex screenshots/flip_example_01.eps width=\textwidth
2923 * @note Since this is an animated example the screenshot doesn't do it
2924 * justice, it is a good idea to compile it and see the animations.
2926 * @example flip_example_01.c
2930 * @page tutorial_label Label example
2931 * @dontinclude label_example_01.c
2933 * In this example we are going to create 6 labels, set some properties on
2934 * them and see what changes in appearance those properties cause.
2936 * We start with the setup code that by now you should be familiar with:
2939 * For our first label we have a moderately long text(that doesn't fit in the
2940 * label's width) so we will make it a sliding label. Since the text isn't
2941 * too long we don't need the animation to be very long, 3 seconds should
2942 * give us a nice speed:
2945 * For our second label we have the same text, but this time we aren't going
2946 * to have it slide, we're going to ellipsize it. Because we ask our label
2947 * widget to ellipsize the text it will first diminsh the fontsize so that it
2948 * can show as much of the text as possible:
2951 * For the third label we are going to ellipsize the text again, however this
2952 * time to make sure the fontsize isn't diminshed we will set a line wrap.
2953 * The wrap won't actually cause a line break because we set the label to
2957 * For our fourth label we will set line wrapping but won't set ellipsis, so
2958 * that our text will indeed be wrapped instead of ellipsized. For this label
2959 * we choose character wrap:
2962 * Just two more, for our fifth label we do the same as for the fourth
2963 * except we set the wrap to word:
2966 * And last but not least for our sixth label we set the style to "marker" and
2967 * the color to red(the default color is white which would be hard to see on
2968 * our white background):
2971 * Our example will look like this:
2973 * @image html screenshots/label_example_01.png
2974 * @image latex screenshots/label_example_01.eps width=\textwidth
2976 * @example label_example_01.c
2980 * @page tutorial_image Image example
2981 * @dontinclude image_example_01.c
2983 * This example is as simple as possible. An image object will be added to the
2984 * window over a white background, and set to be resizeable together with the
2985 * window. All the options set through the example will affect the behavior of
2988 * We start with the code for creating a window and its background, and also
2989 * add the code to write the path to the image that will be loaded:
2994 * Now we create the image object, and set that file to be loaded:
2998 * We can now go setting our options.
3000 * elm_image_no_scale_set() is used just to set this value to true (we
3001 * don't want to scale our image anyway, just resize it).
3003 * elm_image_scale_set() is used to allow the image to be resized to a size
3004 * smaller than the original one, but not to a size bigger than it.
3006 * elm_elm_image_smooth_set() will disable the smooth scaling, so the scale
3007 * algorithm used to scale the image to the new object size is going to be
3008 * faster, but with a lower quality.
3010 * elm_image_orient_set() is used to flip the image around the (1, 0) (0, 1)
3013 * elm_image_aspect_ratio_retained_set() is used to keep the original aspect
3014 * ratio of the image, even when the window is resized to another aspect ratio.
3016 * elm_image_fill_outside_set() is used to ensure that the image will fill the
3017 * entire area available to it, even if keeping the aspect ratio. The image
3018 * will overflow its width or height (any of them that is necessary) to the
3019 * object area, instead of resizing the image down until it can fit entirely in
3022 * elm_image_editable_set() is used just to cover the API, but won't affect
3023 * this example since we are not using any copy & paste property.
3025 * This is the code for setting these options:
3029 * Now some last touches in our object size hints, window and background, to
3030 * display this image properly:
3034 * This example will look like this:
3036 * @image html screenshots/image_example_01.png
3037 * @image latex screenshots/image_example_01.eps width=\textwidth
3039 * @example image_example_01.c
3043 * @page tutorial_icon Icon example
3044 * @dontinclude icon_example_01.c
3046 * This example is as simple as possible. An icon object will be added to the
3047 * window over a white background, and set to be resizeable together with the
3048 * window. All the options set through the example will affect the behavior of
3051 * We start with the code for creating a window and its background:
3056 * Now we create the icon object, and set lookup order of the icon, and choose
3061 * An intersting thing is that after setting this, it's possible to check where
3062 * in the filesystem is the theme used by this icon, and the name of the group
3067 * We can now go setting our options.
3069 * elm_icon_no_scale_set() is used just to set this value to true (we
3070 * don't want to scale our icon anyway, just resize it).
3072 * elm_icon_scale_set() is used to allow the icon to be resized to a size
3073 * smaller than the original one, but not to a size bigger than it.
3075 * elm_elm_icon_smooth_set() will disable the smooth scaling, so the scale
3076 * algorithm used to scale the icon to the new object size is going to be
3077 * faster, but with a lower quality.
3079 * elm_icon_fill_outside_set() is used to ensure that the icon will fill the
3080 * entire area available to it, even if keeping the aspect ratio. The icon
3081 * will overflow its width or height (any of them that is necessary) to the
3082 * object area, instead of resizing the icon down until it can fit entirely in
3085 * This is the code for setting these options:
3087 * @until fill_outside
3089 * However, if you try this example you may notice that this image is not being
3090 * affected by all of these options. This happens because the used icon will be
3091 * from elementary theme, and thus it has its own set of options like smooth
3092 * scaling and fill_outside options. You can change the "home" icon to use some
3093 * image (from your system) and see that then those options will be respected.
3095 * Now some last touches in our object size hints, window and background, to
3096 * display this icon properly:
3100 * This example will look like this:
3102 * @image html screenshots/icon_example_01.png
3103 * @image latex screenshots/icon_example_01.eps width=\textwidth
3105 * @example icon_example_01.c
3109 * @page tutorial_hoversel Hoversel example
3110 * @dontinclude hoversel_example_01.c
3112 * In this example we will create a hoversel with 3 items, one with a label but
3113 * no icon and two with both a label and an icon. Every item that is clicked
3114 * will be deleted, but everytime the hoversel is activated we will also add an
3115 * item. In addition our first item will print all items when clicked and our
3116 * third item will clear all items in the hoversel.
3118 * We will start with the normal creation of window stuff:
3121 * Next we will create a red rectangle to use as the icon of our hoversel:
3124 * And now we create our hoversel and set some of it's properties. We set @p win
3125 * as its parent, ask it to not be horizontal(be vertical) and give it a label
3129 * Next we will add our three items, setting a callback to be called for the
3133 * We also set a pair of callbacks to be called whenever any item is selected or
3134 * when the hoversel is activated:
3137 * And then ask that our hoversel be shown and run the main loop:
3140 * We now have the callback for our first item which prints all items in the
3144 * Next we have the callback for our third item which removes all items from the
3148 * Next we have the callback that is called whenever an item is clicked and
3149 * deletes that item:
3152 * And the callback that is called when the hoversel is activated and adds an
3153 * item to the hoversel. Note that since we allocate memory for the item we need
3154 * to know when the item dies so we can free that memory:
3157 * And finally the callback that frees the memory we allocated for items created
3158 * in the @p _add_item callback:
3161 * Our example will initially look like this:
3163 * @image html screenshots/hoversel_example_01.png
3164 * @image latex screenshots/hoversel_example_01.eps width=\textwidth
3166 * And when the hoversel is clicked it will look like this:
3168 * @image html screenshots/hoversel_example_01_a.png
3169 * @image latex screenshots/hoversel_example_01_a.eps width=\textwidth
3171 * @example hoversel_example_01.c
3175 * @page conformant_example Conformant Example.
3177 * In this example we'll explain how to create applications to work
3178 * with illume, considering space required for virtual keyboards, indicator
3181 * Illume is a module for Enlightenment that modifies the user interface
3182 * to work cleanly and nicely on a mobile device. It has support for
3183 * virtual keyboard, among other nice features.
3185 * Let's start creating a very simple window with a vertical box
3186 * with multi-line entry between two buttons.
3187 * This entry will expand filling all space on window not used by buttons.
3189 * @dontinclude conformant_example_01.c
3190 * @skipline elm_main
3193 * For information about how to create windows, boxes, buttons or entries,
3194 * look for documentation for these widgets.
3196 * It will looks fine when you don't need a virtual keyboard, as you
3197 * can see on the following image:
3199 * @image html screenshots/conformant_example_01.png
3200 * @image latex screenshots/conformant_example_01.eps width=\textwidth
3202 * But if you call a virtual keyboard, the window will resize, changing
3203 * widgets size and position. All the content will shrink.
3205 * If you don't want such behaviour, you
3206 * will need a conformant to account for space taken up by the indicator,
3207 * virtual keyboard and softkey.
3209 * In this case, using the conformant in a proper way, you will have
3210 * a window like the following:
3212 * @image html screenshots/conformant_example_02.png
3213 * @image latex screenshots/conformant_example_02.eps width=\textwidth
3215 * As you can see, it guess the space that will be required by the keyboard,
3216 * indicator and softkey bars.
3218 * So, let's study each step required to transform our initial example on
3221 * First of all, we need to set the window as an illume conformant window:
3222 * @dontinclude conformant_example_02.c
3223 * @skipline elm_win_conformant_set
3225 * Next, we'll add a conformant widget, and set it to resize with the window,
3226 * instead of the box.
3228 * @until evas_object_show
3230 * Finally, we'll set the box as conformant's content, just like this:
3231 * @skipline elm_conformant_content_set
3233 * Compare both examples code:
3234 * @ref conformant_example_01.c "conformant_example_01.c"
3235 * @ref conformant_example_02.c "conformant_example_02.c"
3237 * @example conformant_example_01.c
3238 * @example conformant_example_02.c
3242 * @page index_example_01 Index widget example 1
3244 * This code places an Elementary index widget on a window, which also
3245 * has a very long list of arbitrary strings on it. The list is
3246 * sorted alphabetically and the index will be used to index the first
3247 * items of each set of strings beginning with an alphabet letter.
3249 * Below the list are some buttons, which are there just to exercise
3250 * some index widget's API.
3252 * Here's how we instantiate it:
3253 * @dontinclude index_example_01.c
3254 * @skip elm_list_add
3255 * @until evas_object_show(d.index)
3256 * where we're showing also the list being created. Note that we issue
3257 * elm_win_resize_object_add() on the index, so that it's set to have
3258 * the whole window as its container. Then, we have to populate both
3259 * list and index widgets:
3260 * @dontinclude index_example_01.c
3261 * @skip for (i = 0; i < (sizeof(dict) / sizeof(dict[0])); i++)
3265 * The strings populating the list come from a file
3266 * @dontinclude index_example_01.c
3267 * @skip static const char *dict
3270 * We use the @c curr char variable to hold the last initial letter
3271 * seen on that ordered list of strings, so that we're able to have an
3272 * index item pointing to each list item starting a new letter
3273 * "section". Note that our index item data pointers will be the list
3274 * item handles. We are also setting a callback function to index
3275 * items deletion events:
3276 * @dontinclude index_example_01.c
3280 * There, we show you that the @c event_info pointer will contain the
3281 * item in question's data, i.e., a given list item's pointer. Because
3282 * item data is also returned in the @c data argument on
3283 * @c Evas_Smart_Cb functions, those two pointers must have the same
3284 * values. On this deletion callback, we're deleting the referred list
3285 * item too, just to exemplify that anything could be done there.
3287 * Next, we hook to two smart events of the index object:
3288 * @dontinclude index_example_01.c
3289 * @skip smart_callback_add(d.index
3290 * @until _index_selected
3291 * @dontinclude index_example_01.c
3292 * @skip "delay,changed" hook
3296 * Check that, whenever one holds the mouse pressed over a given index
3297 * letter for some time, the list beneath it will roll down to the
3298 * item pointed to by that index item. When one releases the mouse
3299 * button, the second callback takes place. There, we check that the
3300 * reported item data, on @c event_info, is the same reported by
3301 * elm_index_item_selected_get(), which gives the last selection's
3302 * data on the index widget.
3304 * The first of the three buttons that follow will call
3305 * elm_index_active_set(), thus showing the index automatically for
3306 * you, if it's not already visible, what is checked with
3307 * elm_index_active_get(). The second button will exercise @b deletion
3308 * of index item objects, by the following code:
3309 * @dontinclude index_example_01.c
3310 * @skip delete an index item
3313 * It will get the last index item selected's data and find the
3314 * respective #Elm_Index_Item handle with elm_index_item_find(). We
3315 * need the latter to query the indexing letter string from, with
3316 * elm_index_item_letter_get(). Next, comes the delition, itself,
3317 * which will also trigger the @c _index_item_del callback function,
3320 * The third button, finally, will exercise elm_index_item_clear(),
3321 * which will delete @b all of the index's items.
3323 * This is how the example program's window looks like with the index
3325 * @image html screenshots/index_example_00.png
3326 * @image latex screenshots/index_example_00.eps
3328 * When it's shown, it's like the following figure:
3329 * @image html screenshots/index_example_01.png
3330 * @image latex screenshots/index_example_01.eps
3332 * See the full @ref index_example_01_c "source code" for
3335 * @example index_example_01.c
3339 * @page index_example_02 Index widget example 2
3341 * This code places an Elementary index widget on a window, indexing
3342 * grid items. The items are placed so that their labels @b don't
3343 * follow any order, but the index itself is ordered (through
3344 * elm_index_item_sorted_insert()). This is a complement to to @ref
3345 * index_example_01 "the first example on indexes".
3347 * Here's the list of item labels to be used on the grid (in that
3349 * @dontinclude index_example_02.c
3350 * @skip static const char *items
3353 * In the interesting part of the code, here, we first instantiate the
3354 * grid (more on grids on their examples) and, after creating our
3355 * index, for each grid item we also create an index one to reference
3357 * @dontinclude index_example_02.c
3358 * @skip grid = elm_gengrid_add
3360 * @until smart_callback_add
3362 * The order in which they'll appear in the index, though, is @b
3363 * alphabetical, becase of elm_index_item_sorted_insert() usage
3364 * together with the comparing function, where we take the letters of
3365 * each index item to base our ordering on. The parameters on
3366 * @c _index_cmp have to be declared as void pointers because of the
3367 * @c Eina_Compare_Cb prototype requisition, but in this case we know
3368 * they'll be #Elm_Index_Item's:
3369 * @dontinclude index_example_02.c
3370 * @skip ordering alphabetically
3373 * The last interesting bit is the callback in the @c "delay,changed"
3374 * smart event, which will bring the given grid item to the grid's
3376 * @dontinclude index_example_02.c
3380 * Note how the grid will move kind of randomly while you move your
3381 * mouse pointer held over the index from top to bottom -- that's
3382 * because of the the random order the items have in the grid itself.
3384 * This is how the example program's window looks like:
3385 * @image html screenshots/index_example_03.png
3386 * @image latex screenshots/index_example_03.eps
3388 * See the full @ref index_example_c "source code" for
3391 * @example index_example_02.c
3395 * @page tutorial_ctxpopup Ctxpopup example
3396 * @dontinclude ctxpopup_example_01.c
3398 * In this example we have a list with two items, when either item is clicked
3399 * a ctxpopup for it will be shown. Our two ctxpopups are quite different, the
3400 * one for the first item is a vertical and it's items contain both labels and
3401 * icons, the one for the second item is horizontal and it's items have icons
3404 * We will begin examining our example code by looking at the callback we'll use
3405 * when items in the ctxpopup are clicked. It's very simple, all it does is
3406 * print the label present in the ctxpopup item:
3409 * Next we examine a function that creates ctxpopup items, it was created to
3410 * avoid repeating the same code whenever we needed to add an item to our
3411 * ctxpopup. Our function creates an icon from the standard set of icons, and
3412 * then creates the item, with the label received as an argument. We also set
3413 * the callback to be called when the item is clicked:
3416 * Finally we have the function that will create the ctxpopup for the first item
3417 * in our list. This one is somewhat more complex though, so let's go through it
3418 * in parts. First we declare our variable and add the ctxpopup:
3419 * @until ctxpopup_add
3421 * Next we create a bunch of items for our ctxpopup, marking two of them as
3422 * disabled just so we can see what that will look like:
3423 * @until disabled_set
3424 * @until disabled_set
3426 * Then we ask evas where the mouse pointer was so that we can have our ctxpopup
3427 * appear in the right place, set a maximum size for the ctxpopup, move it and
3431 * And last we mark the list item as not selected:
3434 * Our next function is the callback that will create the ctxpopup for the
3435 * second list item, it is very similar to the previous function. A couple of
3436 * interesting things to note is that we ask our ctxpopup to be horizontal, and
3437 * that we pass NULL as the label for every item:
3440 * And with all of that in place we can now get to our main function where we
3441 * create the window, the list, the list items and run the main loop:
3444 * The example will initially look like this:
3446 * @image html screenshots/ctxpopup_example_01.png
3447 * @image latex screenshots/ctxpopup_example_01.eps width=\textwidth
3449 * @note This doesn't show the ctxpopup tough, since it will only appear when
3450 * we click one of the list items.
3452 * Here is what our first ctxpopup will look like:
3454 * @image html screenshots/ctxpopup_example_01_a.png
3455 * @image latex screenshots/ctxpopup_example_01_a.eps width=\textwidth
3457 * And here the second ctxpopup:
3459 * @image html screenshots/ctxpopup_example_01_b.png
3460 * @image latex screenshots/ctxpopup_example_01_b.eps width=\textwidth
3462 * @example ctxpopup_example_01.c
3466 * @page tutorial_pager
3467 * @dontinclude pager_example_01.c
3469 * In this example we'll have a pager with 3 rectangles on it, one blue, one
3470 * green and one blue, we'll also have 1 button for each rectangle. Pressing a
3471 * button will bring the associated rectangle to the front of the pager(promote
3474 * We start our example with some run of the mill code that you've seen in other
3478 * And then we get right to creating our pager, setting a style and some basic
3482 * Well a pager without any content is not of much use, so let's create the
3483 * first of our rectangles, add it to the pager and create the button for it:
3484 * @until smart_callback
3485 * @note The only line of above code that directly relates to our pager is the
3486 * call to elm_pager_content_push().
3488 * And now we will do the same thing again twice for our next two rectangles:
3489 * @until smart_callback
3490 * @until smart_callback
3492 * Now that we haver our widgets create we can get to running the main loop:
3495 * We also have the callback that is called when any of the buttons is pressed,
3496 * this callback is receiving the rectangle in it's @p data argument, so we
3497 * check if it's already on top and if not move it there:
3500 * Our example will look like this:
3502 * @image html screenshots/pager_example_01.png
3503 * @image latex screenshots/pager_example_01.eps width=\textwidth
3504 * @note Like all examples that involve animations the screenshot doesn't do it
3505 * justice, seeing it in action is a must.
3507 * @example pager_example_01.c
3511 * @page tutorial_separator Separator example
3512 * @dontinclude separator_example_01.c
3514 * In this example we are going to pack two rectangles in a box, and have a
3515 * separator in the middle.
3517 * So we start we the window, background, box and rectangle creation, all pretty
3521 * Once we have our first rectangle in the box we create and add our separator:
3523 * @note Since our box is in horizontal mode it's a good idea to set the
3524 * separator to be horizontal too.
3526 * And now we add our second rectangle and run the main loop:
3529 * This example will look like this:
3531 * @image html screenshots/separator_example_01.png
3532 * @image eps screenshots/separator_example_01.eps width=\textwidth
3534 * @example separator_example_01.c
3538 * @page tutorial_radio Radio example
3539 * @dontinclude radio_example_01.c
3541 * In this example we will create 4 radio buttons, three of them in a group and
3542 * another one not in the group. We will also have the radios in the group
3543 * change the value of a variable directly and have then print it when the value
3544 * changes. The fourth button is in the example just to make clear that radios
3545 * outside the group don't affect the group.
3547 * We'll start with the usual includes:
3550 * And move right to declaring a static variable(the one whose value the radios
3554 * We now need to have a window and all that good stuff to be able to place our
3558 * And now we create a radio button, since this is the first button in our group
3559 * we set the group to be the radio(so we can set the other radios in the same
3560 * group). We also set the state value of this radio to 1 and the value pointer
3561 * to @p val, since val is @p 1 this has the additional effect of setting the
3562 * radio value to @p 1. For this radio we choose the default home icon:
3565 * To check that our radio buttons are working we'll add a callback to the
3566 * "changed" signal of the radio:
3567 * @until smart_callback
3569 * The creation of our second radio button is almost identical, the 2
3570 * differences worth noting are, the value of this radio 2 and that we add this
3571 * radio to the group of the first radio:
3572 * @until smart_callback
3574 * For our third callback we'll omit the icon and set the value to 3, we'll also
3575 * add it to the group of the first radio:
3576 * @until smart_callback
3578 * Our fourth callback has a value of 4, no icon and most relevantly is not a
3579 * member of the same group as the other radios:
3582 * We finally run the main loop:
3585 * And the last detail in our example is the callback that prints @p val so that
3586 * we can see that the radios are indeed changing its value:
3589 * The example will look like this:
3591 * @image html screenshots/radio_example_01.png
3592 * @image latex screenshots/radio_example_01.eps width=\textwidth
3594 * @example radio_example_01.c
3598 * @page tutorial_toggle Toggle example
3599 * @dontinclude toggle_example_01.c
3601 * In this example we'll create 2 toggle widgets. The first will have an icon
3602 * and the state names will be the default "on"/"off", it will also change the
3603 * value of a variable directly. The second won't have a icon, the state names
3604 * will be "Enabled"/"Disabled", it will start "Enabled" and it won't set the
3605 * value of a variable.
3607 * We start with the usual includes and prototype for callback which will be
3608 * implemented and detailed later on:
3611 * We then declare a static global variable(the one whose value will be changed
3612 * by the first toggle):
3615 * We now have to create our window and all that usual stuff:
3618 * The creation of a toggle is no more complicated than that of any other
3622 * For our first toggle we don't set the states labels so they will stay the
3623 * default, however we do set a label for the toggle, an icon and the variable
3624 * whose value it should change:
3627 * We also set the callback that will be called when the toggles value changes:
3628 * @until smart_callback
3630 * For our second toggle it important to note that we set the states labels,
3631 * don't set an icon or variable, but set the initial state to
3632 * EINA_TRUE("Enabled"):
3635 * For the second toggle we will use a different callback:
3636 * @until smart_callback
3638 * We then ask the main loop to start:
3641 * The callback for our first toggle will look the value of @p val and print it:
3644 * For our second callback we need to do a little bit more, since the second
3645 * toggle doesn't change the value of a variable we have to ask it what its
3649 * This example will look like this:
3651 * @image html screenshots/toggle_example_01.png
3652 * @image latex screenshots/toggle_example_01.eps width=\textwidth
3654 * @example toggle_example_01.c
3658 * @page tutorial_panel Panel example
3659 * @dontinclude panel_example_01.c
3661 * In this example will have 3 panels, one for each possible orientation. Two of
3662 * our panels will start out hidden, the third will start out expanded. For each
3663 * of the panels we will use a label as the content, it's however possible to
3664 * have any widget(including containers) as the content of panels.
3666 * We start by doing some setup, code you should be familiar with from other
3670 * And move right to creating our first panel, for this panel we are going to
3671 * choose the orientation as TOP and toggle it(tell it to hide itself):
3674 * For the second panel we choose the RIGHT orientation and explicitly set the
3678 * For our third and last panel we won't set the orientation(which means it will
3679 * use the default: LEFT):
3682 * All that is left is running the main loop:
3685 * This example will look like this;
3687 * @image html screenshots/panel_example_01.png
3688 * @image latex screenshots/panel_example_01.eps width=\textwidth
3689 * @note The buttons with arrow allow the user to hide/show the panels.
3691 * @example panel_example_01.c
3695 * @page gengrid_example Gengrid widget example
3697 * This application is a thorough exercise on the gengrid widget's
3698 * API. We place an Elementary gengrid widget on a window, with
3699 * various knobs below its viewport, each one acting on it somehow.
3701 * The code's relevant part begins at the grid's creation. After
3702 * instantiating it, we set its items sizes, so that we don't end with
3703 * items one finger size wide, only. We're setting them to fat, 150
3704 * pixel wide ones, for this example. We give it some size hints, not
3705 * to be discussed in this context and, than, we register a callback
3706 * on one of its smart events -- the one coming each time an item gets
3707 * doubly clicked. There, we just print the item handle's value.
3708 * @dontinclude gengrid_example.c
3709 * @skip grid = elm_gengrid_add
3710 * @until evas_object_sho
3711 * @dontinclude gengrid_example.c
3712 * @skip item double click callback
3715 * Before we actually start to deal with the items API, let's show
3716 * some things items will be using throughout all the code. The first
3717 * of them is a struct to be used as item data, for all of them:
3718 * @dontinclude gengrid_example.c
3719 * @skip typedef struct
3722 * That path will be used to index an image, to be swallowed into one
3723 * of the item's icon spots. The imagens themselves are distributed
3725 * @dontinclude gengrid_example.c
3726 * @skip static const char *imgs
3729 * We also have an (unique) gengrid item class we'll be using for
3730 * items in the example:
3731 * @dontinclude gengrid_example.c
3732 * @skip static Elm_Gengrid_Item_Class
3733 * @until static Elm_Gengrid_Item_Class
3734 * @dontinclude gengrid_example.c
3735 * @skip item_style =
3738 * As you see, our items will follow the default theme on gengrid
3739 * items. For the label fetching code, we return a string composed of
3740 * the item's image path:
3741 * @dontinclude gengrid_example.c
3742 * @skip label fetching callback
3745 * For item icons, we'll be populating the item default theme's two
3746 * icon spots, @c "elm.swallow.icon" and @c "elm.swallow.end". The
3747 * former will receive one of the images in our list (in the form of
3748 * a @ref bg_02_example_page "background"), while the latter will be
3749 * a check widget. Note that we prevent the check to propagate click
3750 * events, so that the user can toggle its state without messing with
3751 * the respective item's selection in the grid:
3752 * @dontinclude gengrid_example.c
3753 * @skip icon fetching callback
3754 * @until return NULL
3757 * As the default gengrid item's theme does not have parts
3758 * implementing item states, we'll be just returning false for every
3760 * @dontinclude gengrid_example.c
3761 * @skip state fetching callback
3764 * Finally, the deletion callback on gengrid items takes care of
3765 * freeing the item's label string and its data struct:
3766 * @dontinclude gengrid_example.c
3767 * @skip deletion callback
3770 * Let's move to item insertion/deletion knobs, them. They are four
3771 * buttons, above the grid's viewport, namely
3772 * - "Append" (to append an item to the grid),
3773 * - "Prepend" (to prepend an item to the grid),
3774 * - "Insert before" (to insert an item before the selection, on the
3776 * - "Insert after" (to insert an item after the selection, on the
3778 * - "Clear" (to delete all items in the grid),
3779 * - "Bring in 1st" (to make the 1st item visible, by scrolling),
3780 * - "Show last" (to directly show the last item),
3782 * which are displaced and declared in that order. We're not dealing
3783 * with the buttons' creation code (see @ref button_example_01
3784 * "a button example", for more details on it), but with their @c
3785 * "clicked" registered callbacks. For all of them, the grid's handle
3786 * is passed as @c data. The ones creating new items use a common
3787 * code, which just gives a new @c Example_Item struct, with @c path
3788 * filled with a random image in our images list:
3789 * @dontinclude gengrid_example.c
3790 * @skip new item with random path
3793 * Moreover, that ones will set a common function to be issued on the
3794 * selection of the items. There, we print the item handle's value,
3795 * along with the callback function data. The latter will be @c NULL,
3796 * always, because it's what we pass when adding all icons. By using
3797 * elm_gengrid_item_data_get(), we can have the item data back and,
3798 * with that, we're priting the item's path string. Finally, we
3799 * exemplify elm_gengrid_item_pos_get(), printing the item's position
3801 * @dontinclude gengrid_example.c
3802 * @skip item selection callback
3805 * The appending button will exercise elm_gengrid_item_append(), simply:
3806 * @dontinclude gengrid_example.c
3807 * @skip append an item
3810 * The prepending, naturally, is analogous, but exercising
3811 * elm_gengrid_item_prepend(), on its turn. The "Insert before" one
3812 * will expect an item to be selected in the grid, so that it will
3813 * insert a new item just before it:
3814 * @dontinclude gengrid_example.c
3815 * @skip "insert before" callback
3818 * The "Insert after" is analogous, just using
3819 * elm_gengrid_item_insert_after(), instead. The "Clear" button will,
3820 * as expected, just issue elm_gengrid_clear():
3821 * @dontinclude gengrid_example.c
3822 * @skip delete items
3825 * The "Bring in 1st" button is there exercise two gengrid functions
3826 * -- elm_gengrid_first_item_get() and elm_gengrid_item_bring_in().
3827 * With the former, we get a handle to the first item and, with the
3828 * latter, you'll see that the widget animatedly scrolls its view
3829 * until we can see that item:
3830 * @dontinclude gengrid_example.c
3831 * @skip bring in 1st item
3834 * The "Show last", in its turn, will use elm_gengrid_last_item_get()
3835 * and elm_gengrid_item_show(). The latter differs from
3836 * elm_gengrid_item_bring_in() in that it immediately replaces the
3837 * contents of the grid's viewport with the region containing the item
3839 * @dontinclude gengrid_example.c
3840 * @skip show last item
3843 * To change the grid's cell (items) size, we've placed a spinner,
3844 * which has the following @c "changed" smart callback:
3845 * @dontinclude gengrid_example.c
3846 * @skip change items' size
3849 * Experiment with it and see how the items are affected. The "Disable
3850 * item" button will, as the name says, disable the currently selected
3852 * @dontinclude gengrid_example.c
3853 * @skip disable selected item
3855 * Note that we also make use of elm_gengrid_item_selected_set(),
3856 * there, thus making the item unselected before we actually disable
3859 * To toggle between horizontal and vertical layouting modes on the
3860 * grid, use the "Horizontal mode" check, which will call the
3861 * respective API function on the grid:
3862 * @dontinclude gengrid_example.c
3863 * @skip change layouting mode
3866 * If you toggle the check right after that one, "Always select",
3867 * you'll notice all subsequent clicks on the @b same grid item will
3868 * still issue the selection callback on it, what is different from
3869 * when it's not checked. This is the
3870 * elm_gengrid_always_select_mode_set() behavior:
3871 * @dontinclude gengrid_example.c
3872 * @skip "always select" callback
3875 * One more check follows, "Bouncing", which will turn on/off the
3876 * bouncing animations on the grid, when one scrolls past its
3877 * borders. Experiment with scrolling the grid to get the idea, having
3878 * it turned on and off:
3879 * @dontinclude gengrid_example.c
3880 * @skip "bouncing mode" callback
3883 * The next two checks will affect items selection on the grid. The
3884 * first, "Multi-selection", will make it possible to select more the
3885 * one item on the grid. Because it wouldn't make sense to fetch for
3886 * an unique selected item on this case, we also disable two of the
3887 * buttons, which insert items relatively, if multi-selection is on:
3888 * @dontinclude gengrid_example.c
3889 * @skip multi-selection callback
3892 * Note that we also @b unselect all items in the grid, when returning
3893 * from multi-selection mode, making use of
3894 * elm_gengrid_item_selected_set().
3896 * The second check acting on selection, "No selection", is just what
3897 * its name depicts -- no selection will be allowed anymore, on the
3898 * grid, while it's on. Check it out for yourself, interacting with
3900 * @dontinclude gengrid_example.c
3901 * @skip no selection callback
3904 * We have, finally, one more line of knobs, now sliders, to change
3905 * the grids behavior. The two first will change the horizontal @b
3906 * alignment of the whole actual grid of items within the gengrid's
3908 * @dontinclude gengrid_example.c
3909 * @skip items grid horizontal alignment change
3912 * Naturally, the vertical counterpart just issues
3913 * elm_gengrid_align_set() changing the second alignment component,
3916 * The last slider will change the grid's <b>page size</b>, relative
3917 * to its own one. Try to change those values and, one manner of
3918 * observing the paging behavior, is to scroll softly and release the
3919 * mouse button, with different page sizes, at different grid
3920 * positions, while having lots of items in it -- you'll see it
3921 * snapping to page boundaries differenty, for each configuration:
3922 * @dontinclude gengrid_example.c
3923 * @skip page relative size change
3926 * This is how the example program's window looks like:
3927 * @image html screenshots/gengrid_example.png
3928 * @image latex screenshots/gengrid_example.eps width=\textwidth
3930 * Note that it starts with three items which we included at will:
3931 * @dontinclude gengrid_example.c
3932 * @skip _clicked(grid,
3933 * @until _clicked(grid,
3934 * @until _clicked(grid,
3935 * @until _clicked(grid,
3937 * See the full @ref gengrid_example_c "source code" for
3940 * @example gengrid_example.c
3943 * @page entry_example_01 Entry - Example of simple editing
3945 * As a general overview of @ref Entry we are going to write an, albeit simple,
3946 * functional editor. Although intended to show how elm_entry works, this
3947 * example also makes extensive use of several other widgets. The full code
3948 * can be found in @ref entry_example.c "entry_example.c" and in the following
3949 * lines we'll go through the parts especific to the @ref Entry widget.
3951 * The program itself is a simple editor, with a file already set to it, that
3952 * can be set to autosave or not and allows insertion of emoticons and some
3953 * formatted text. As of this writing, the capabilities of format edition in
3954 * the entry are very limited, so a lot of manual work is required to change
3957 * In any case, the program allows some changes by using the buttons on the
3958 * top of the window and returning focus back to the main entry afterwards.
3960 * @image html screenshots/entry_example.png
3961 * @image latex screenshots/entry_example.eps width=\textwidth
3963 * We'll begin by showing a few structures used throught the program. First,
3964 * the application owns data that holds the main window and the main entry
3965 * where the editting happens. Then, an auxiliar structure we'll use later
3966 * when inserting icons in our text.
3967 * @dontinclude entry_example.c
3969 * @until App_Inwin_Data
3971 * A little convenience function will insert whatever text we need in the
3972 * buffer at the current cursor's position and set focus back to this entry.
3973 * This is done mostly because clicking on any button will make them steal
3974 * focus, which makes writing text more cumbersome.
3978 * One of the buttons on the top will trigger an @ref Inwin to open and show
3979 * us several icons we can insert into the text. We'll jump over most of these
3980 * functions, but when all the options are chosen, we insert the special
3981 * markup text that will show the chosen icon in place.
3982 * @skip edje_file_collection_list_free(emos)
3984 * @until evas_object_del
3987 * As can be seen in that function, the program lets us add icons to our entry
3988 * using all the possible configurations for them. That should help to
3989 * clarify how the different combinations work out by actually seeing them
3992 * The same popup window has a page to set the settings of the chosen icon,
3993 * that is, the size and how the item will be placed within the line.
3995 * The size is done with two entries, limitted to accept numbers and a fixed
3996 * size of characters. Changing the value in this entries will update the icon
3997 * size in our struct as seen in the next two callbacks.
4002 * The rest of the options are handled with radio buttons, since only one type
4003 * of size can be used (@c size, @c absize or @c relsize) and for the vertical
4004 * sizing it needs to choose between @c ascent and @c full. Depending on which
4005 * is chosen, the @c item tag is formed accordingly as seen before.
4006 * @skip static Evas_Object
4007 * @until evas_object_show(rvascent)
4009 * The first of our entries is here. There's something worth mentioning about
4010 * the way we'll create this one. Normally, any entry regardless of whether is
4011 * single line or not, will be set to scrollable, but in this case, since we
4012 * are limitting how many characters can fit in them and we know we don't need
4013 * scrolling, we are not setting this flag. This makes the entry have virtually
4014 * no appearance on screen, other than its text. This is because an entry is
4015 * just that, a box that holds text, and in order to have some frame around it
4016 * or a background color, another widget needs to provide this. When an entry
4017 * is scrollable, the same scroller used internally does this.
4018 * We are using @ref Frame "frames" here to provide some decoration around,
4019 * then creating our entries, set them to single line, add our two filters and
4020 * the callback for when their value change.
4021 * @until _height_changed_cb
4023 * This function ends with the button that will finally call the item
4024 * into our editting string.
4027 * Then we get to the format edition. Here we can add the @c bold and
4028 * @c emphasis tags to parts of our text. There's a lot of manual work to
4029 * know what to do here, since we are not implementing an entire state manager
4030 * and the entry itself doesn't, yet, support all the needed capabilities to
4031 * make this simpler. We begin by getting the format we are using in our
4032 * function from the button pressed.
4033 * @skip aid->pager = pager;
4034 * @until sizeof(fmt_close)
4036 * Next we need to find out if we need to insert an opening or a closing tag.
4037 * For this, we store the current cursor position and create a selection
4038 * from this point until the beginning of our text, and then get the selected
4039 * text to look for any existing format tags in it. This is currently the only
4040 * way in which we can find out what formats is being used in the entry.
4044 * Once we know what tag to insert, we need a second check in the case it was
4045 * a closing tag. This is because any other closing tag that comes after would
4046 * be left dangling alone, so we need to remove it to keep the text consistent.
4049 * Finally, we clear our fake selections and return the cursor back to the
4050 * position it had at first, since there is where we want to insert our format.
4051 * @until cursor_pos_set
4053 * And finish by calling our convenience function from before, to insert the
4054 * text at the current cursor and give focus back to the entry.
4057 * A checkbox on the top of our program tells us if the text we are editing
4058 * will autosave or not. In it's @c "changed" callback we get the value from
4059 * the checkbox and call the elm_entry_autosave_set() function with it. If
4060 * autosave is set, we also call elm_entry_file_save(). This is so the internal
4061 * timer used to periodically store to disk our changes is started.
4065 * Two more functions to show some cursor playing. Whenever we double click
4066 * anywhere on our entry, we'll find what word is the cursor placed at and
4067 * select it. Likewise, for triple clicking, we select the entire line.
4069 * @until _edit_tplclick_cb
4072 * And finally, the main window of the program contains the entry where we
4073 * do all the edition and some helping widgets to change format, add icons
4074 * or change the autosave flag.
4077 * @until _image_insert_cb
4079 * And the main entry of the program. Set to scroll, by default we disable
4080 * autosave and we'll begin with a file set to it because no file selector
4081 * is being used here. The file is loaded with #ELM_TEXT_FORMAT_MARKUP_UTF8
4082 * so that any format contained in it is interpreted, otherwise the entry
4083 * would load it as just text, escaping any tags found and no format or icons
4084 * would be shown. Then we connect to the double and triple click signals
4085 * and set focus on the entry so we can start typing right away.
4088 * @example entry_example.c
4092 * @page genlist_example_01 Genlist - basic usage
4094 * This example creates a simple genlist with a small number of items and
4095 * a callback that is called whenever an item is selected. All the properties of
4096 * this genlist are the default ones. The full code for this example can be seen
4097 * at @ref genlist_example_01_c.
4099 * For the simplest list that you plan to create, it's necessary to define some
4100 * of the basic functions that are used for creating each list item, and
4101 * associating them with the "item class" for that list. The item class is just
4102 * an struct that contains pointers to the specific list item functions that are
4103 * common to all the items of the list.
4105 * Let's show it by example. Our item class is declared globally and static as
4106 * it will be the only item class that we need (we are just creating one list):
4108 * @dontinclude genlist_example_01.c
4109 * @skip static Elm_Genlist
4110 * @until static Elm_Genlist
4112 * This item class will be used for every item that we create. The only
4113 * functions that we are going to set are @c label_get and @c icon_get. As the
4114 * name suggests, they are used by the genlist to generate the label for the
4115 * respective item, and to generate icon(s) to it too. Both the label and icon
4116 * get functions can be called more than once for each item, with different @c
4117 * part parameters, which represent where in the theme of the item that label or
4118 * icon is going to be set.
4120 * The default theme for the genlist contains only one area for label, and two
4121 * areas for icon ("elm.swallow.icon" and "elm.swallow.end"). Since we just want
4122 * to set the first icon (that will be at the left side of the label), we
4123 * compare the part name given with "elm.swallow.icon". Notice that the
4124 * @c label_get function must return a strduped string, that will be freed later
4125 * automatically by the list. Here's the code for @c label_get and @c icon_get:
4127 * @until static void
4129 * We will also provide a function that will be called whenever an item is
4130 * selected in the genlist. However, this function is not part of the item
4131 * class, it will be passed for each item being added to the genlist explicitly.
4132 * Notice the similarity of the function signature with those used by @c
4133 * evas_object_smart_callback_add:
4137 * Now let's show the code used for really creating the list. Skipping
4138 * boilerplate code used for creating a window and background, the first piece
4139 * of code specific to our genlist example is setting the pointer functions of
4140 * the item class to our above defined functions:
4145 * Notice that we also choose to use the "default" style for our genlist items.
4146 * Another interesting point is that @c state_get and @c del are set to @c NULL,
4147 * since we don't need these functions now. @c del doesn't need to be used
4148 * because we don't add any data that must be freed to our items, and @c
4149 * state_get is also not used since all of our items are the same and don't need
4150 * to have different states to be used for each item. Finally we create our
4153 * @until genlist_add
4155 * Now we append several items to the list, and for all of them we need to give
4156 * the list pointer, a pointer to the item class, the data that will be used
4157 * with that item, a pointer to the parent of this item if it is in a group type
4158 * list (this is not the case so we pass @c NULL), possible flags for this item,
4159 * the callback for when the item is selected, and the data pointer that will be
4160 * given to the selected callback.
4164 * The rest of the code is also common to all the other examples, so it will be
4165 * omitted here (look at the full source code link above if you need it).
4167 * You can try to play with this example, and see the selected callback being
4168 * called whenever an item is clicked. It also already has some features enabled
4169 * by default, like vertical bounce animation when reaching the end of the list,
4170 * automatically visible/invisible scrollbar, etc. Look at the @ref
4171 * genlist_example_02 to see an example of setting these properties to the list.
4173 * The current example will look like this when running:
4175 * @image html screenshots/genlist_example_01.png
4176 * @image latex screenshots/genlist_example_01.eps width=\textwidth
4180 * @page genlist_example_02 Genlist - list setup functions
4182 * This example is very similar to the @ref genlist_example_01, but it fetch
4183 * most of the properties of the genlist and displays them on startup (thus
4184 * getting the default value for them) and then set them to some other values,
4185 * to show how to use that API. The full source code is at @ref
4186 * genlist_example_02_c.
4188 * Considering that the base code for instantiating a genlist was already
4189 * described in the previous example, we are going to focus on the new code.
4191 * Just a small difference for the @c _item_label_get function, we are going to
4192 * store the time that this function was called. This is the "realized" time,
4193 * the time when the visual representation of this item was created. This is the
4194 * code for the @c label_get function:
4196 * @dontinclude genlist_example_02.c
4198 * @until return strdup
4200 * Now let's go to the list creation and setup. First, just after creating the
4201 * list, we get most of the default properties from it, and print them on the
4205 * @until printf("\n")
4207 * We are going to change some of the properties of our list.
4209 * There's no need to call the selected callback at every click, just when the
4210 * selected item changes, thus we call elm_genlist_always_select_mode_set() with
4213 * For this list we don't want bounce animations at all, so we set both the
4214 * horizontal bounce and the vertical bounce to false with
4215 * elm_genlist_bounce_set().
4217 * We also want our list to compress items if they are wider than the list
4218 * width (thus we call elm_genlist_compress_mode_set().
4220 * The items have different width, so they are not homogeneous:
4221 * elm_genlist_homogeneous_set() is set to false.
4223 * Since the compress mode is active, the call to
4224 * elm_genlist_horizontal_mode_set() doesn't make difference, but the current
4225 * option would make the list to have at least the width of the largest item.
4227 * This list will support multiple selection, so we call
4228 * elm_genlist_multi_select_set() on it.
4230 * The option elm_genlist_height_for_width_mode_set() would allow text block to
4231 * wrap lines if the Edje part is configured with "text.min: 0 1", for example.
4232 * But since we are compressing the elements to the width of the list, this
4233 * option wouldn't take any effect.
4235 * We want the vertical scrollbar to be always displayed, and the orizontal one
4236 * to never be displayed, and set this with elm_genlist_scroller_policy_set().
4238 * The timeout to consider a longpress is set to half of a second with
4239 * elm_genlist_longpress_timeout_set().
4241 * We also change the block count to a smaller value, but that should have not
4242 * impact on performance since the number of visible items is too small. We just
4243 * increase the granularity of the block count (setting it to have at most 4
4246 * @until block_count_set
4248 * Now let's add elements to the list:
4250 * @until item_append
4253 * It's exactly the same as the previous example. The difference is on the
4254 * behavior of the list, if you try to scroll, select items and so.
4256 * In this example we also need two buttons. One of them, when clicked, will
4257 * display several status info about the current selection, the "realized"
4258 * items, the item in the middle of the screen, and the current mode and active
4259 * item of that mode for the genlist.
4261 * The other button will ask the genlist to "realize" again the items already
4262 * "realized", so their respective label_get and icon_get functions will be
4265 * These are the callbacks for both of these buttons:
4267 * @dontinclude genlist_example_02.c
4273 * Try to scroll, select some items and click on the "Show status" button.
4274 * You'll notice that not all items of the list are "realized", thus consuming
4275 * just a small amount of memory. The selected items are listed in the order
4276 * that they were selected, and the current selected item printed using
4277 * elm_genlist_selected_item_get() is the first selected item of the multiple
4280 * Now resize the window so that you can see the "realized time" of some items.
4281 * This is the time of when the label_get function was called. If you click on
4282 * the "Realize" button, all the already realized items will be rebuilt, so the
4283 * time will be updated for all of them.
4285 * The current example will look like this when running:
4287 * @image html screenshots/genlist_example_02.png
4288 * @image latex screenshots/genlist_example_02.eps width=\textwidth
4292 * @page genlist_example_03 Genlist - different width options
4294 * This example doesn't present any other feature that is not already present in
4295 * the other examples, but visually shows the difference between using the
4296 * default list options (first list of the example), setting the horizontal mode
4297 * to #ELM_LIST_LIMIT (second list), enabling compress mode (third list) and
4298 * using height_for_width option (fourth list).
4300 * The full code for this example is listed below:
4302 * @include genlist_example_03.c
4304 * And the screenshot of the running example:
4306 * @image html screenshots/genlist_example_03.png
4307 * @image latex screenshots/genlist_example_03.eps width=\textwidth
4309 * @example genlist_example_03.c
4313 * @page genlist_example_04 Genlist - items manipulation
4315 * This example is also similar ot the @ref genlist_example_01, but it
4316 * demonstrates most of the item manipulation functions. See the full source
4317 * code at @ref genlist_example_04_c.
4319 * In this example, we also will use the concept of creating groups of items in
4320 * the genlist. Each group of items is composed by a parent item (which will be
4321 * the index of the group) and several children of this item. Thus, for the
4322 * children, we declare a normal item class. But we also are going to declare a
4323 * different item class for the group index (which in practice is another type
4324 * of item in the genlist):
4326 * @dontinclude genlist_example_04.c
4327 * @skip _item_sel_cb
4332 * We will add buttons to the window, where each button provides one
4333 * functionality of the genlist item API. Each button will have a callback
4334 * attached, that will really execute this functionality. An example of these
4335 * callbacks is the next one, for the elm_genlist_item_insert_after() function:
4337 * @skip insert_before_cb
4341 * If you want ot see the other button functions, look at the full source code
4344 * Each button will be created with a function that already creates the button,
4345 * add it to an elementary box, and attach the specified callback. This is the
4346 * function that does it:
4348 * @skip genlist_item_update
4352 * In our @c elm_main function, besides the code for setting up the window, box
4353 * and background, we also initialize our two item classes:
4355 * @skip _itc.item_style
4356 * @until _itc_group.func.del
4358 * This example uses a different style for the items, the @a double_label, which
4359 * provides a text field for the item text, and another text field for a subtext.
4361 * For the group index we use the @a group_index style, which provides a
4362 * different appearance, helping to identify the end of a group and beginning of
4365 * Now, after the code for creating the list, setting up the box and other
4366 * stuff, let's add the buttons with their respective callbacks:
4369 * @until bt_top_show
4371 * The main code for adding items to the list is a bit more complex than the one
4372 * from the previous examples. We check if each item is multiple of 7, and if
4373 * so, they are group indexes (thus each group has 6 elements by default, in
4380 * Then we also check for specific items, and add callbacks to them on the
4381 * respective buttons, so we can show, bring in, etc.:
4386 * Once you understand the code from the @ref genlist_example_01, it should be
4387 * easy to understand this one too. Look at the full code, and also try to play
4388 * a bit with the buttons, adding items, bringing them to the viewport, and so.
4390 * The example will look like this when running:
4392 * @image html screenshots/genlist_example_04.png
4393 * @image latex screenshots/genlist_example_04.eps width=\textwidth
4397 * @page genlist_example_05 Genlist - working with subitems
4399 * This is probably the most complex example of elementary @ref Genlist. We
4400 * create a tree of items, using the subitems properties of the items, and keep
4401 * it in memory to be able to expand/hide subitems of an item. The full source
4402 * code can be found at @ref genlist_example_05_c
4404 * The main point is the way that Genlist manages subitems. Clicking on an
4405 * item's button to expand it won't really show its children. It will only
4406 * generate the "expand,request" signal, and the expansion must be done
4409 * In this example we want to be able to add items as subitems of another item.
4410 * If an item has any child, it must be displayed using a parent class,
4411 * otherwise it will use the normal item class.
4413 * It will be possible to delete items too. Once a tree is constructed (with
4414 * subitems of subitems), and the user clicks on the first parent (root of the
4415 * tree), the entire subtree must be hidden. However, just calling
4416 * elm_genlist_item_expanded_set(item, EINA_FALSE) won't hide them. The only
4417 * thing that happens is that the parent item will change its appearance to
4418 * represent that it's contracted. And the signal "contracted" will be emitted
4419 * from the genlist. Thus, we must call elm_genlist_item_subitems_clear() to
4420 * delete all its subitems, but still keep a way to recreate them when expanding
4421 * the parent again. That's why we are going to keep a node struct for each
4422 * item, that will be the data of the item, with the following information:
4424 * @dontinclude genlist_example_05.c
4428 * This @c Node_Data contains the value for the item, a number indicating its
4429 * level under the tree, a list of children (to be able to expand it later) and
4430 * a boolean indicating if it's a favorite item or not.
4432 * We use 3 different item classes in this example:
4434 * One for items that don't have children:
4441 * One for items that have children:
4448 * And one for items that were favorited:
4454 * The favorite item class is there just to demonstrate the
4455 * elm_genlist_item_item_class_update() function in action. It would be much
4456 * simpler to implement the favorite behavior by just changing the icon inside
4457 * the icon_get functions when the @c favorite boolean is activated.
4459 * Now we are going to declare the callbacks for the buttons that add, delete
4462 * First, a button for appending items to the list:
4464 * @until item_append
4467 * If an item is selected, a new item will be appended to the same level of that
4468 * item, but using the selected item's parent as its parent too. If no item is
4469 * selected, the new item will be appended to the root of the tree.
4471 * Then the callback for marking an item as favorite:
4473 * @until elm_genlist_item_update
4476 * This callback is very simple, it just changes the item class of the selected
4477 * item for the "favorite" one, or go back to the "item" or "parent" class
4478 * depending on that item having children or not.
4480 * Now, the most complex operation (adding a child to an item):
4482 * @until elm_genlist_item_update
4485 * This function gets the data of the selected item, create a new data (for the
4486 * item being added), and appends it to the children list of the selected item.
4488 * Then we must check if the selected item (let's call it @c item1 now) to which
4489 * the new item (called @c item2 from now on) was already a parent item too
4490 * (using the parent item class) or just a normal item (using the default item
4491 * class). In the first case, we just have to append the item to the end of the
4492 * @c item1 children list.
4494 * However, if the @c item1 didn't have any child previously, we have to change
4495 * it to a parent item now. It would be easy to just change its item class to
4496 * the parent type, but there's no way to change the item flags and make it be
4497 * of the type #ELM_GENLIST_ITEM_SUBITEMS. Thus, we have to delete it and create
4498 * a new item, and add this new item to the same position that the deleted one
4499 * was. That's the reason of the checks inside the bigger @c if.
4501 * After adding the item to the newly converted parent, we set it to not
4502 * expanded (since we don't want to show the added item immediately) and select
4503 * it again, since the original item was deleted and no item is selected at the
4506 * Finally, let's show the callback for deleting items:
4508 * @until elm_genlist_item_update
4511 * Since we have an iternal list representing each element of our tree, once we
4512 * delete an item we have to go deleting each child of that item, in our
4513 * internal list. That's why we have the function @c _clear_list, which
4514 * recursively goes freeing all the item data.
4516 * This is necessary because only when we really want to delete the item is when
4517 * we need to delete the item data. When we are just contracting the item, we
4518 * need to hide the children by deleting them, but keeping the item data.
4520 * Now there are two callbacks that will be called whenever the user clicks on
4521 * the expand/contract icon of the item. They will just request to items to be
4522 * contracted or expanded:
4524 * @until elm_genlist_item_expanded_set(
4525 * @until elm_genlist_item_expanded_set(
4528 * When the elm_genlist_item_expanded_set() function is called with @c
4529 * EINA_TRUE, the @c _expanded_cb will be called. And when this happens, the
4530 * subtree of that item must be recreated again. This is done using the internal
4531 * list stored as item data for each item. The function code follows:
4535 * Each appended item is set to contracted, so we don't have to deal with
4536 * checking if the item was contracted or expanded before its parent being
4537 * contracted. It could be easily implemented, though, by adding a flag expanded
4538 * inside the item data.
4540 * Now, the @c _contracted_cb, which is much simpler:
4544 * We just have to call elm_genlist_item_subitems_clear(), that will take care
4545 * of deleting every item, and keep the item data still stored (since we don't
4546 * have any del function set on any of our item classes).
4548 * Finally, the code inside @c elm_main is very similar to the other examples:
4553 * The example will look like this when running:
4555 * @image html screenshots/genlist_example_05.png
4556 * @image latex screenshots/genlist_example_05.eps width=\textwidth
4560 * @page progressbar_example Progress bar widget example
4562 * This application is a thorough example of the progress bar widget,
4563 * consisting of a window with varios progress bars, each with a given
4564 * look/style one can give to those widgets. With two auxiliary
4565 * buttons, one can start or stop a timer which will fill in the bars
4566 * in synchrony, simulating an underlying task being completed.
4568 * We create @b seven progress bars, being three of them horizontal,
4569 * three vertical and a final one under the "wheel" alternate style.
4571 * For the first one, we add a progress bar on total pristine state,
4572 * with no other call than the elm_progressbar_add() one:
4573 * @dontinclude progressbar_example.c
4574 * @skip pb with no label
4576 * See, than, that the defaults of a progress bar are:
4577 * - no primary label shown,
4578 * - unit label set to @c "%.0f %%",
4581 * The second progress bar is given a primary label, <c>"Infinite
4582 * bounce"</c>, and, besides, it's set to @b pulse. See how, after one
4583 * starts the progress timer, with the "Start" button, it animates
4584 * differently than the previous one. It won't account for the
4585 * progress, itself, and just dumbly animate a small bar within its
4587 * @dontinclude progressbar_example.c
4588 * @skip pb with label
4591 * Next, comes a progress bar with an @b icon, a primary label and a
4592 * @b custom unit label set. It's also made to grow its bar in an
4593 * @b inverted manner, so check that out during the timer's progression:
4594 * @dontinclude progressbar_example.c
4597 * Another important thing in this one is the call to
4598 * elm_progressbar_span_size_set() -- this is how we forcefully set a
4599 * minimum horizontal size to our whole window! We're not resizing it
4600 * manually, as you can see in the @ref progressbar_example_c
4603 * The next three progress bars are just variants on the ones already
4604 * shown, but now all being @b vertical. Another time we use one of
4605 * than to give the window a minimum vertical size, with
4606 * elm_progressbar_span_size_set(). To demonstrate this trick once
4607 * more, the fifth one, which is also set to pulse, has a smaller
4608 * hardcoded span size:
4609 * @dontinclude progressbar_example.c
4610 * @skip vertical pb, with pulse
4613 * We end the widget demonstration by showing a progress bar with the
4614 * special @b "wheel" progress bar style. One does @b not need to set
4615 * it to pulse, with elm_progressbar_pulse_set(), explicitly, because
4616 * its theme does not take it in account:
4617 * @dontinclude progressbar_example.c
4621 * The two buttons exercising the bars, the facto, follow:
4622 * @dontinclude progressbar_example.c
4623 * @skip elm_button_add
4624 * @until evas_object_show(bt)
4625 * @until evas_object_show(bt)
4627 * The first of the callbacks will, for the progress bars set to
4628 * pulse, start the pulsing animation at that time. For the others, a
4629 * timer callback will take care of updating the values:
4630 * @dontinclude progressbar_example.c
4631 * @skip static Eina_Bool
4636 * Finally, the callback to stop the progress timer will stop the
4637 * pulsing on the pulsing progress bars and, for the others, to delete
4638 * the timer which was acting on their values:
4639 * @dontinclude progressbar_example.c
4644 * This is how the example program's window looks like:
4645 * @image html screenshots/progressbar_example.png
4646 * @image latex screenshots/progressbar_example.eps width=\textwidth
4648 * See the full @ref progressbar_example_c "source code" for
4651 * @example progressbar_example.c
4655 * @page tutorial_notify Notify example
4656 * @dontinclude notify_example_01.c
4658 * In this example we will have 3 notifys in 3 different positions. The first of
4659 * which will dissapear after 5 seconds or when a click outside it occurs, the
4660 * second and third will not dissapear and differ from each other only in
4663 * We start our example with the usual stuff you've seen in other examples:
4666 * We now create a label to use as the content of our first notify:
4669 * Having the label we move to creating our notify, telling it to block events,
4670 * setting its timeout(to autohide it):
4673 * To have the notify dissapear when a click outside its area occur we have to
4674 * listen to its "block,clicked" signal:
4675 * @until smart_callback
4677 * Our callback will look like this:
4680 * @dontinclude notify_example_01.c
4682 * Next we create another label and another notify. Note, however, that this
4683 * time we don't set a timeout and don't have it block events. What we do is set
4684 * the orient so that this notify will appear in the bottom of its parent:
4685 * @skip smart_callback
4689 * For our third notify the only change is the orient which is now center:
4692 * Now we tell the main loop to run:
4695 * Our example will initially look like this:
4697 * @image html screenshots/notify_example_01.png
4698 * @image latex screenshots/notify_example_01.eps width=\textwidth
4700 * Once the first notify is hidden:
4702 * @image html screenshots/notify_example_01_a.png
4703 * @image latex screenshots/notify_example_01_a.eps width=\textwidth
4705 * @example notify_example_01.c
4709 * @page tutorial_frame Frame example
4710 * @dontinclude frame_example_01.c
4712 * In this example we are going to create 4 Frames with different styles and
4713 * add a rectangle of different color in each.
4715 * We start we the usual setup code:
4718 * And then create one rectangle:
4721 * To add it in our first frame, which since it doesn't have it's style
4722 * specifically set uses the default style:
4725 * And then create another rectangle:
4728 * To add it in our second frame, which uses the "pad_small" style, note that
4729 * even tough we are setting a text for this frame it won't be show, only the
4730 * default style shows the Frame's title:
4732 * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
4733 * very similar, their only difference is the size of the empty area around
4734 * the content of the frame.
4736 * And then create yet another rectangle:
4739 * To add it in our third frame, which uses the "outdent_top" style, note
4740 * that even tough we are setting a text for this frame it won't be show,
4741 * only the default style shows the Frame's title:
4744 * And then create one last rectangle:
4747 * To add it in our fourth and final frame, which uses the "outdent_bottom"
4748 * style, note that even tough we are setting a text for this frame it won't
4749 * be show, only the default style shows the Frame's title:
4752 * And now we are left with just some more setup code:
4755 * Our example will look like this:
4757 * @image html screenshots/frame_example_01.png
4758 * @image latex screenshots/frame_example_01.eps width=\textwidth
4760 * @example frame_example_01.c
4764 * @page tutorial_anchorblock_example Anchorblock/Anchorview example
4765 * This example will show both Anchorblock and @ref Anchorview,
4766 * since both are very similar and it's easier to show them once and side
4767 * by side, so the difference is more clear.
4769 * We'll show the relevant snippets of the code here, but the full example
4770 * can be found here... sorry, @ref anchorblock_example_01.c "here".
4772 * As for the actual example, it's just a simple window with an anchorblock
4773 * and an anchorview, both containing the same text. After including
4774 * Elementary.h and declaring some functions we'll need, we jump to our
4775 * elm_main (see ELM_MAIN) and create our window.
4776 * @dontinclude anchorblock_example_01.c
4781 * With the needed variables declared, we'll create the window and a box to
4782 * hold our widgets, but we don't need to go through that here.
4784 * In order to make clear where the anchorblock ends and the anchorview
4785 * begins, they'll be each inside a @ref Frame. After creating the frame,
4786 * the anchorblock follows.
4787 * @skip elm_frame_add
4788 * @until elm_frame_content_set
4790 * Nothing out of the ordinary there. What's worth mentioning is the call
4791 * to elm_anchorblock_hover_parent_set(). We are telling our widget that
4792 * when an anchor is clicked, the hover for the popup will cover the entire
4793 * window. This affects the area that will be obscured by the hover and
4794 * where clicking will dismiss it, as well as the calculations it does to
4795 * inform the best locations where to insert the popups content.
4796 * Other than that, the code is pretty standard. We also need to set our
4797 * callback for when an anchor is clicked, since it's our task to populate
4798 * the popup. There's no default for it.
4800 * The anchorview is no different, we only change a few things so it looks
4802 * @until elm_frame_content_set
4804 * Then we run, so stuff works and close our main function in the usual way.
4807 * Now, a little note. Normally you would use either one of anchorblock or
4808 * anchorview, set your one callback to clicks and do your stuff in there.
4809 * In this example, however, there are a few tricks to make it easier to
4810 * show both widgets in one go (and to save me some typing). So we have
4811 * two callbacks, one per widget, that will call a common function to do
4812 * the rest. The trick is using ::Elm_Entry_Anchorblock_Info for the
4813 * anchorview too, since both are equal, and passing a callback to use
4814 * for our buttons to end the hover, because each widget has a different
4816 * @until _anchorview_clicked_cb
4819 * The meat of our popup is in the following function. We check what kind
4820 * of menu we need to show, based on the name set to the anchor in the
4821 * markup text. If there's no type (something went wrong, no valid contact
4822 * in the address list) we are just putting a button that does nothing, but
4823 * it's perfectly reasonable to just end the hover and call it quits.
4825 * Our popup will consist of one main button in the middle of our hover,
4826 * and possibly a secondary button and a list of other options. We'll create
4827 * first our main button and check what kind of popup we need afterwards.
4830 * @until eina_stringshare_add
4833 * Each button has two callbacks, one is our hack to close the hover
4834 * properly based on which widget it belongs to, the other a simple
4835 * printf that will show the action with the anchors own data. This is
4836 * not how you would usually do it. Instead, the common case is to have
4837 * one callback for the button that will know which function to call to end
4838 * things, but since we are doing it this way it's worth noting that
4839 * smart callbacks will be called in reverse in respect to the order they
4840 * were added, and since our @c btn_end_cb will close the hover, and thus
4841 * delete our buttons, the other callback wouldn't be called if we had
4844 * After our telephone popup, there are a few others that are practically
4845 * the same, so they won't be shown here.
4847 * Once we are done with that, it's time to place our actions into our
4848 * hover. Main button goes in the middle without much questioning, and then
4849 * we see if we have a secondary button and a box of extra options.
4850 * Because I said so, secondary button goes on either side and box of
4851 * options either on top or below the main one, but to choose which
4852 * exactly, we use the hints our callback info has, which saves us from
4853 * having to do the math and see which side has more space available, with
4854 * a little special case where we delete our extra stuff if there's nowhere
4858 * @skip evas_object_smart
4859 * @until evas_object_del(box)
4863 * The example will look like this:
4865 * @image html screenshots/anchorblock_01.png
4866 * @image latex screenshots/anchorblock_01.eps width=\textwidth
4868 * @example anchorblock_example_01.c
4872 * @page tutorial_check Check example
4873 * @dontinclude check_example_01.c
4875 * This example will show 2 checkboxes, one with just a label and the second
4876 * one with both a label and an icon. This example also ilustrates how to
4877 * have the checkbox change the value of a variable and how to react to those
4880 * We will start with the usual setup code:
4883 * And now we create our first checkbox, set its label, tell it to change
4884 * the value of @p value when the checkbox stats is changed and ask to be
4885 * notified of state changes:
4888 * For our second checkbox we are going to set an icon so we need to create
4891 * @note For simplicity we are using a rectangle as icon, but any evas object
4894 * And for our second checkbox we set the label, icon and state to true:
4897 * We now do some more setup:
4900 * And finally implement the callback that will be called when the first
4901 * checkbox's state changes. This callback will use @p data to print a
4904 * @note This work because @p data is @p value(from the main function) and @p
4905 * value is changed when the checkbox is changed.
4907 * Our example will look like this:
4909 * @image html screenshots/check_example_01.png
4910 * @image latex screenshots/check_example_01.eps width=\textwidth
4912 * @example check_example_01.c
4916 * @page tutorial_colorselector Color selector example
4917 * @dontinclude colorselector_example_01.c
4919 * This example shows how to change the color of a rectangle using a color
4920 * selector. We aren't going to explain a lot of the code since it's the
4924 * Now that we have a window with background and a rectangle we can create
4925 * our color_selector and set it's initial color to fully opaque blue:
4928 * Next we tell ask to be notified whenever the color changes:
4931 * We follow that we some more run of the mill setup code:
4934 * And now get to the callback that sets the color of the rectangle:
4937 * This example will look like this:
4939 * @image html screenshots/colorselector_example_01.png
4940 * @image latex screenshots/colorselector_example_01.eps width=\textwidth
4942 * @example colorselector_example_01.c
4946 * @page slideshow_example Slideshow widget example
4948 * This application is aimed to exemplify the slideshow widget. It
4949 * consists of a window with a slideshow widget set as "resize
4950 * object", along with a control bar, in the form of a notify. Those
4951 * controls will exercise most of the slideshow's API functions.
4953 * We create the slideshow, itself, first, making it @b loop on its
4954 * image itens, when in slideshow mode:
4955 * @dontinclude slideshow_example.c
4956 * @skip slideshow = elm_slideshow_add
4957 * @until evas_object_show
4959 * Next, we define the <b>item class</b> for our slideshow
4960 * items. Slideshow images are going to be Elementary @ref Photo "photo"
4961 * widgets, here, as pointed by our @c get class
4962 * function. We'll let the Elementary infrastructure to delete those
4963 * objects for us, and, as there's no additional data attached to our
4964 * slideshow items, the @c del class function can be left undefined:
4965 * @dontinclude slideshow_example.c
4968 * @dontinclude slideshow_example.c
4971 * @dontinclude slideshow_example.c
4972 * @skip get our images to make slideshow items
4975 * We now get to populate the slideshow widget with items. Our images
4976 * are going to be some randomly chosen from the Elementary package,
4977 * nine of them. For the first eight, we insert them ordered in the
4978 * widget, by using elm_slideshow_item_sorted_insert(). The comparing
4979 * function will use the image names to sort items. The last item is
4980 * inserted at the end of the slideshow's items list, with
4981 * elm_slideshow_item_add(). We check out how that list ends with
4982 * elm_slideshow_items_get(), than:
4983 * @dontinclude slideshow_example.c
4984 * @skip static const char *img
4986 * @dontinclude slideshow_example.c
4990 * Note that we save the pointers to the first and last items in the
4991 * slideshow, for future use.
4993 * What follows is the code creating a notify, to be shown over the
4994 * slideshow's viewport, with knobs to act on it. We're not showing
4995 * that boilerplate code, but only the callbacks attached to the
4996 * interesting smart events of those knobs. The first four are
4997 * buttons, which will:
4998 * - Select the @b next item in the slideshow
4999 * - Select the @b previous item in the slideshow
5000 * - Select the @b first item in the slideshow
5001 * - Select the @b last item in the slideshow
5003 * Check out the code for those four actions, being the two last @c
5004 * data pointers the same @c first and @c last pointers we save
5005 * before, respectively:
5006 * @dontinclude slideshow_example.c
5007 * @skip jump to next
5013 * What follow are two hoversels, meant for one to change the
5014 * slideshow's @b transition and @b layout styles, respectively. We
5015 * fetch all the available transition and layout names to populate
5016 * those widgets and, when one selects any of them, we apply the
5017 * corresponding setters on the slideshow:
5018 * @dontinclude slideshow_example.c
5019 * @skip hv = elm_hoversel_add
5022 * @dontinclude slideshow_example.c
5023 * @skip transition changed
5027 * For one to change the transition @b time on the slideshow widget,
5028 * we use a spinner widget. We set it to the initial value of 3
5029 * (seconds), which will be probed by the next knob -- a button
5030 * starting the slideshow, de facto. Note that changing the transition
5031 * time while a slideshow is already happening will ajust its
5033 * @dontinclude slideshow_example.c
5034 * @skip spin = elm_spinner_add
5035 * @until evas_object_show
5036 * @dontinclude slideshow_example.c
5037 * @skip slideshow transition time has
5040 * Finally, we have two buttons which will, respectively, start and
5041 * stop the slideshow on our widget. Here are their "clicked"
5043 * @dontinclude slideshow_example.c
5044 * @skip start the show
5048 * This is how the example program's window looks like:
5049 * @image html screenshots/slideshow_example.png
5050 * @image latex screenshots/slideshow_example.eps width=\textwidth
5052 * See the full @ref slideshow_example_c "source code" for
5055 * @example slideshow_example.c
5059 * @page tutorial_photocam Photocam example
5060 * @dontinclude photocam_example_01.c
5062 * In this example we will have a photocam and a couple of buttons and slider to
5063 * control the photocam. To avoid cluttering we'll only show the parts of the
5064 * example that relate to the photocam, the full source code can be seen @ref
5065 * photocam_example_01.c "here".
5067 * Creating a photocam is as easy as creating any other widget:
5068 * @skipline elm_photocam_add
5070 * A photocam is only useful if we have a image on it, so lets set a file for it
5074 * We now set the photocam to not bounce horizontally:
5077 * And we want to know when the photocam has finished loading the image so:
5078 * @until smart_callback
5080 * The reason to know when the image is loaded is so that we can bring the
5081 * center of the image into view:
5085 * As mentioned we have 2 buttons in this example, the "Fit" one will cause
5086 * the photocam to go in to a zoom mode that makes the image fit inside the
5087 * photocam. Tough this has no effect on the image we also print what region was
5088 * being viewed before setting the zoom mode:
5090 * @note When in fit mode our slider(explained below) won't work.
5092 * The second button("Unfit") will bring the photocam back into manual zoom
5096 * Our slider controls the level of zoom of the photocam:
5098 * @note It is important to note that this only works when in manual zoom mode.
5100 * Our example will initially look like this:
5102 * @image html screenshots/photocam_example_01.png
5103 * @image latex screenshots/photocam_example_01.eps width=\textwidth
5105 * @example photocam_example_01.c
5109 * @page inwin_example_01 Inwin - General overview
5111 * Inwin is a very simple widget to show, so this example will be a very simple
5112 * one, just using all of the available API.
5114 * The program is nothing but a window with a lonely button, as shown here.
5116 * @image html screenshots/inwin_example.png
5117 * @image latex screenshots/inwin_example.eps width=\textwidth
5119 * And pressing the button makes an inwin appear.
5121 * @image html screenshots/inwin_example_a.png
5122 * @image latex screenshots/inwin_example_a.eps width=\textwidth
5124 * And the code is just as simple. We being with some global variables to keep
5125 * track of our Inwin.
5126 * @dontinclude inwin_example.c
5128 * @until current_style
5130 * And two callbacks used by the buttons the above screenshot showed. In these,
5131 * we check if @c inwin exists and execute the proper action on it. If it's not
5132 * there anymore, then we were abandoned to our luck, so we disabled ourselves.
5133 * @until _inwin_destroy
5137 * The lonely button from the beginning, when clicked, will call the following
5138 * function, which begins by checking if an inwin exists, and if it's there,
5139 * we bring it back to the front and exit from our function without any further
5143 * But if no inwin is there to show, we need to create one. First we need the
5144 * top-most window for the program, as no inwin can be created using other
5145 * objects as parents. Then we create our popup, set the next style in the list
5147 * @until current_style =
5149 * As for the content of our inwin, it's just a box with a label and some
5151 * @until _inwin_destroy
5154 * Now, all the code above shows how every object must always be set as content
5155 * for some other object, be it by setting the full content, packing it in a
5156 * box or table or working as icon for some other widget. But we didn't do
5157 * anything like that for the inwin, this one is just created and shown and
5158 * everything works. Other widgets can be used this way, but they would need
5159 * to be placed and resized manually or nothing would be shown correctly. The
5160 * inwin, however, sets itself as a children of the top-level window and will
5161 * be resized as the parent window changes too.
5163 * Another characteristic of Inwin is that when it's shown above everyone else,
5164 * it will work kind of like a modal window, blocking any other widget from
5165 * receiving events until the window is manually dismissed by pressing some
5166 * button to close it or having blocking task signalling its completion so
5167 * normal operations can be resumed. This is unlike the @ref Hover widget,
5168 * that would show its content on top of the designated target, but clicking
5169 * anywhere else would dismiss it automatically.
5171 * To illustrate that last point, when we close the main window and an inwin
5172 * is still there, we'll take out the content from the inwin and place it in
5177 * And the rest of the program doesn't have anything else related to inwin,
5178 * so it won't be shown here, but you can find it in
5179 * @ref inwin_example.c "inwin_example.c".
5181 * @example inwin_example.c
5185 * @page tutorial_scroller Scroller example
5186 * @dontinclude scroller_example_01.c
5188 * This example is very short and will illustrate one way to use a scroller.
5189 * We'll omit the declaration of the @p text variable because it's a very long
5190 * @htmlonly<a href="http://lipsum.com/">@endhtmlonly ipsum lorem
5191 * @htmlonly</a>@endhtmlonly. If you really want to see the full code, it's @ref
5192 * scroller_example_01.c "scroller_example_01.c".
5194 * We start our example by creating our window and background:
5198 * Next we create a label and set it's text to @p text(very long ipsum lorem):
5199 * @until show(label)
5201 * We then create our scroller, ask that it have the same size as the window and
5203 * @until content_set
5205 * We are now going to set a number of properties in our scroller:
5206 * @li We make it bounce horizontally but not vertically.
5207 * @li We make both scrollbars always be visible.
5208 * @li We have the events be propagated from the content to the scroller.
5209 * @li We enforce a page policy vertically(having a page be the size of the
5210 * viewport) and leave horizontal scrolling free.
5211 * @li And finally we ask the scroller to show us a region starting at 50,50 and
5212 * having a width and height of 200px.
5213 * @until region_show
5214 * @note Observant reader will note that the elm_scroller_region_show() didn't
5215 * scroll the view vertically, this is because we told the scroller to only
5216 * accept vertical scrolling in pages.
5218 * And now we're done:
5221 * Our example will look like this:
5223 * @image html screenshots/scroller_example_01.png
5224 * @image latex screenshots/scroller_example_01.eps width=\textwidth
5226 * @example scroller_example_01.c
5230 * @page tutorial_table_01
5232 * In this example we add four labels to a homogeneous table that has a padding
5233 * of 5px between cells.
5235 * The interesting bits from this example are:
5236 * @li Where we set the table as homogeneous and the padding:
5237 * @dontinclude table_example_01.c
5239 * @until homogeneous_set
5240 * @li Where we add each label to the table:
5241 * @skipline elm_table_pack
5242 * @skipline elm_table_pack
5243 * @skipline elm_table_pack
5244 * @skipline elm_table_pack
5246 * Here you can see the full source:
5247 * @include table_example_01.c
5249 * Our example will look like this:
5251 * @image html screenshots/table_example_01.png
5252 * @image latex screenshots/table_example_01.eps width=\textwidth
5254 * @example table_example_01.c
5258 * @page tutorial_table_02
5260 * For our second example we'll create a table with 4 rectangles in it. Since
5261 * our rectangles are of different sizes our table won't be homogeneous.
5263 * The interesting bits from this example are:
5264 * @li Where we set the table as not homogeneous:
5265 * @dontinclude table_example_02.c
5266 * @skipline homogeneous_set
5267 * @li Where we add each rectangle to the table:
5268 * @skipline elm_table_pack
5269 * @skipline elm_table_pack
5270 * @skipline elm_table_pack
5271 * @skipline elm_table_pack
5273 * Here you can see the full source:
5274 * @include table_example_02.c
5276 * Our example will look like this:
5278 * @image html screenshots/table_example_02.png
5279 * @image latex screenshots/table_example_02.eps width=\textwidth
5281 * @example table_example_02.c
5285 * @page tutorial_menu Menu Example
5286 * @dontinclude menu_example_01.c
5288 * This example shows how to create a menu with regular items, object items,
5289 * submenus and how to delete items from a menu. The full source for this
5290 * example is @ref menu_example_01.c "menu_example_01.c".
5292 * We'll start looking at the menu creation and how to create a very simple
5297 * For our next item we are going to add an icon:
5300 * Now we are going to add more items, but these icons are going to have a
5301 * parent, which will put them in a sub-menu. First just another item with an
5305 * Next we are going to add a button to our menu(any elm widget can be added to
5309 * We are also going to have the button delete the first item of our
5310 * sub-menu when clicked:
5311 * @until smart_callback
5312 * @dontinclude menu_example_01.c
5316 * We now add a separator and three more regular items:
5321 * We now add another item, however this time it won't go the sub-menu and it'll
5323 * @until disabled_set
5325 * To make sure that our menu is shown whenever the window is clicked(and where
5326 * clicked) we use the following callback:
5327 * @dontinclude menu_example_01.c
5332 * Our example will look like this:
5334 * @image html screenshots/menu_example_01.png
5335 * @image latex screenshots/menu_example_01.eps width=\textwidth
5337 * @example menu_example_01.c
5341 * @page bg_example_01_c bg_example_01.c
5342 * @include bg_example_01.c
5343 * @example bg_example_01.c
5347 * @page bg_example_02_c bg_example_02.c
5348 * @include bg_example_02.c
5349 * @example bg_example_02.c
5353 * @page bg_example_03_c bg_example_03.c
5354 * @include bg_example_03.c
5355 * @example bg_example_03.c
5359 * @page actionslider_example_01 Actionslider example
5360 * @include actionslider_example_01.c
5361 * @example actionslider_example_01.c
5365 * @page animator_example_01_c Animator example 01
5366 * @include animator_example_01.c
5367 * @example animator_example_01.c
5371 * @page transit_example_01_c Transit example 1
5372 * @include transit_example_01.c
5373 * @example transit_example_01.c
5377 * @page transit_example_02_c Transit example 2
5378 * @include transit_example_02.c
5379 * @example transit_example_02.c
5383 * @page general_functions_example_c General (top-level) functions example
5384 * @include general_funcs_example.c
5385 * @example general_funcs_example.c
5389 * @page clock_example_c Clock example
5390 * @include clock_example.c
5391 * @example clock_example.c
5395 * @page flipselector_example_c Flipselector example
5396 * @include flipselector_example.c
5397 * @example flipselector_example.c
5401 * @page fileselector_example_c Fileselector example
5402 * @include fileselector_example.c
5403 * @example fileselector_example.c
5407 * @page fileselector_button_example_c Fileselector button example
5408 * @include fileselector_button_example.c
5409 * @example fileselector_button_example.c
5413 * @page fileselector_entry_example_c Fileselector entry example
5414 * @include fileselector_entry_example.c
5415 * @example fileselector_entry_example.c
5419 * @page index_example_01_c Index example
5420 * @include index_example_01.c
5421 * @example index_example_01.c
5425 * @page index_example_02_c Index example
5426 * @include index_example_02.c
5427 * @example index_example_02.c
5431 * @page layout_example_01_c layout_example_01.c
5432 * @include layout_example_01.c
5433 * @example layout_example_01.c
5437 * @page layout_example_02_c layout_example_02.c
5438 * @include layout_example_02.c
5439 * @example layout_example_02.c
5443 * @page layout_example_03_c layout_example_03.c
5444 * @include layout_example_03.c
5445 * @example layout_example_03.c
5449 * @page layout_example_edc An example of layout theme file
5451 * This theme file contains two groups. Each of them is a different theme, and
5452 * can be used by an Elementary Layout widget. A theme can be used more than
5453 * once by many different Elementary Layout widgets too.
5455 * @include layout_example.edc
5456 * @example layout_example.edc
5460 * @page gengrid_example_c Gengrid example
5461 * @include gengrid_example.c
5462 * @example gengrid_example.c
5466 * @page genlist_example_01_c genlist_example_01.c
5467 * @include genlist_example_01.c
5468 * @example genlist_example_01.c
5472 * @page genlist_example_02_c genlist_example_02.c
5473 * @include genlist_example_02.c
5474 * @example genlist_example_02.c
5478 * @page genlist_example_04_c genlist_example_04.c
5479 * @include genlist_example_04.c
5480 * @example genlist_example_04.c
5484 * @page genlist_example_05_c genlist_example_05.c
5485 * @include genlist_example_05.c
5486 * @example genlist_example_05.c
5490 * @page progressbar_example_c Progress bar example
5491 * @include progressbar_example.c
5492 * @example progressbar_example.c
5496 * @page slideshow_example_c Slideshow example
5497 * @include slideshow_example.c
5498 * @example slideshow_example.c