elm gengrid: Added "scroll,edge,top/bottom/left/right" smart callbacks.
[framework/uifw/elementary.git] / src / lib / Elementary.h.in
1 /*
2  *
3  * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
4  */
5
6 /**
7 @file Elementary.h.in
8 @brief Elementary Widget Library
9 */
10
11 /**
12 @mainpage Elementary
13 @image html  elementary.png
14 @version 0.7.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers in which the widgets will be
33                           layouted.
34
35 @section license License
36
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
39
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
45 */
46
47
48 /**
49  * @defgroup Start Getting Started
50  *
51  * To write an Elementary app, you can get started with the following:
52  *
53 @code
54 #include <Elementary.h>
55 EAPI_MAIN int
56 elm_main(int argc, char **argv)
57 {
58    // create window(s) here and do any application init
59    elm_run(); // run main loop
60    elm_shutdown(); // after mainloop finishes running, shutdown
61    return 0; // exit 0 for exit code
62 }
63 ELM_MAIN()
64 @endcode
65  *
66  * To use autotools (which helps in many ways in the long run, like being able
67  * to immediately create releases of your software directly from your tree
68  * and ensure everything needed to build it is there) you will need a
69  * configure.ac, Makefile.am and autogen.sh file.
70  *
71  * configure.ac:
72  *
73 @verbatim
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_PREREQ(2.52)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
78 AC_PROG_CC
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
81 AC_OUTPUT(Makefile)
82 @endverbatim
83  *
84  * Makefile.am:
85  *
86 @verbatim
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89
90 INCLUDES = -I$(top_srcdir)
91
92 bin_PROGRAMS = myapp
93
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
97 @endverbatim
98  *
99  * autogen.sh:
100  *
101 @verbatim
102 #!/bin/sh
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
107 ./configure "$@"
108 @endverbatim
109  *
110  * To generate all the things needed to bootstrap just run:
111  *
112 @verbatim
113 ./autogen.sh
114 @endverbatim
115  *
116  * This will generate Makefile.in's, the confgure script and everything else.
117  * After this it works like all normal autotools projects:
118 @verbatim
119 ./configure
120 make
121 sudo make install
122 @endverbatim
123  *
124  * Note sudo was assumed to get root permissions, as this would install in
125  * /usr/local which is system-owned. Use any way you like to gain root, or
126  * specify a different prefix with configure:
127  *
128 @verbatim
129 ./confiugre --prefix=$HOME/mysoftware
130 @endverbatim
131  *
132  * Also remember that autotools buys you some useful commands like:
133 @verbatim
134 make uninstall
135 @endverbatim
136  *
137  * This uninstalls the software after it was installed with "make install".
138  * It is very useful to clear up what you built if you wish to clean the
139  * system.
140  *
141 @verbatim
142 make distcheck
143 @endverbatim
144  *
145  * This firstly checks if your build tree is "clean" and ready for
146  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147  * ready to upload and distribute to the world, that contains the generated
148  * Makefile.in's and configure script. The users do not need to run
149  * autogen.sh - just configure and on. They don't need autotools installed.
150  * This tarball also builds cleanly, has all the sources it needs to build
151  * included (that is sources for your application, not libraries it depends
152  * on like Elementary). It builds cleanly in a buildroot and does not
153  * contain any files that are temporarily generated like binaries and other
154  * build-generated files, so the tarball is clean, and no need to worry
155  * about cleaning up your tree before packaging.
156  *
157 @verbatim
158 make clean
159 @endverbatim
160  *
161  * This cleans up all build files (binaries, objects etc.) from the tree.
162  *
163 @verbatim
164 make distclean
165 @endverbatim
166  *
167  * This cleans out all files from the build and from configure's output too.
168  *
169 @verbatim
170 make maintainer-clean
171 @endverbatim
172  *
173  * This deletes all the files autogen.sh will produce so the tree is clean
174  * to be put into a revision-control system (like CVS, SVN or GIT for example).
175  *
176  * There is a more advanced way of making use of the quicklaunch infrastructure
177  * in Elementary (which will not be covered here due to its more advanced
178  * nature).
179  *
180  * Now let's actually create an interactive "Hello World" gui that you can
181  * click the ok button to exit. It's more code because this now does something
182  * much more significant, but it's still very simple:
183  *
184 @code
185 #include <Elementary.h>
186
187 static void
188 on_done(void *data, Evas_Object *obj, void *event_info)
189 {
190    // quit the mainloop (elm_run function will return)
191    elm_exit();
192 }
193
194 EAPI_MAIN int
195 elm_main(int argc, char **argv)
196 {
197    Evas_Object *win, *bg, *box, *lab, *btn;
198
199    // new window - do the usual and give it a name, title and delete handler
200    win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201    elm_win_title_set(win, "Hello");
202    // when the user clicks "close" on a window there is a request to delete
203    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
204
205    // add a standard bg
206    bg = elm_bg_add(win);
207    // add object as a resize object for the window (controls window minimum
208    // size as well as gets resized if window is resized)
209    elm_win_resize_object_add(win, bg);
210    evas_object_show(bg);
211
212    // add a box object - default is vertical. a box holds children in a row,
213    // either horizontally or vertically. nothing more.
214    box = elm_box_add(win);
215    // make the box hotizontal
216    elm_box_horizontal_set(box, EINA_TRUE);
217    // add object as a resize object for the window (controls window minimum
218    // size as well as gets resized if window is resized)
219    elm_win_resize_object_add(win, box);
220    evas_object_show(box);
221
222    // add a label widget, set the text and put it in the pad frame
223    lab = elm_label_add(win);
224    // set default text of the label
225    elm_object_text_set(lab, "Hello out there world!");
226    // pack the label at the end of the box
227    elm_box_pack_end(box, lab);
228    evas_object_show(lab);
229
230    // add an ok button
231    btn = elm_button_add(win);
232    // set default text of button to "OK"
233    elm_object_text_set(btn, "OK");
234    // pack the button at the end of the box
235    elm_box_pack_end(box, btn);
236    evas_object_show(btn);
237    // call on_done when button is clicked
238    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
239
240    // now we are done, show the window
241    evas_object_show(win);
242
243    // run the mainloop and process events and callbacks
244    elm_run();
245    return 0;
246 }
247 ELM_MAIN()
248 @endcode
249    *
250    */
251
252 /**
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
300
301 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
302 contact with the developers and maintainers.
303  */
304
305 #ifndef ELEMENTARY_H
306 #define ELEMENTARY_H
307
308 /**
309  * @file Elementary.h
310  * @brief Elementary's API
311  *
312  * Elementary API.
313  */
314
315 @ELM_UNIX_DEF@ ELM_UNIX
316 @ELM_WIN32_DEF@ ELM_WIN32
317 @ELM_WINCE_DEF@ ELM_WINCE
318 @ELM_EDBUS_DEF@ ELM_EDBUS
319 @ELM_EFREET_DEF@ ELM_EFREET
320 @ELM_ETHUMB_DEF@ ELM_ETHUMB
321 @ELM_EMAP_DEF@ ELM_EMAP
322 @ELM_DEBUG_DEF@ ELM_DEBUG
323 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
324 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
325
326 /* Standard headers for standard system calls etc. */
327 #include <stdio.h>
328 #include <stdlib.h>
329 #include <unistd.h>
330 #include <string.h>
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
335 #include <dlfcn.h>
336 #include <math.h>
337 #include <fnmatch.h>
338 #include <limits.h>
339 #include <ctype.h>
340 #include <time.h>
341 #include <dirent.h>
342 #include <pwd.h>
343 #include <errno.h>
344
345 #ifdef ELM_UNIX
346 # include <locale.h>
347 # ifdef ELM_LIBINTL_H
348 #  include <libintl.h>
349 # endif
350 # include <signal.h>
351 # include <grp.h>
352 # include <glob.h>
353 #endif
354
355 #ifdef ELM_ALLOCA_H
356 # include <alloca.h>
357 #endif
358
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
360 # include <malloc.h>
361 # ifndef alloca
362 #  define alloca _alloca
363 # endif
364 #endif
365
366
367 /* EFL headers */
368 #include <Eina.h>
369 #include <Eet.h>
370 #include <Evas.h>
371 #include <Evas_GL.h>
372 #include <Ecore.h>
373 #include <Ecore_Evas.h>
374 #include <Ecore_File.h>
375 #include <Ecore_IMF.h>
376 #include <Ecore_Con.h>
377 #include <Edje.h>
378
379 #ifdef ELM_EDBUS
380 # include <E_DBus.h>
381 #endif
382
383 #ifdef ELM_EFREET
384 # include <Efreet.h>
385 # include <Efreet_Mime.h>
386 # include <Efreet_Trash.h>
387 #endif
388
389 #ifdef ELM_ETHUMB
390 # include <Ethumb_Client.h>
391 #endif
392
393 #ifdef ELM_EMAP
394 # include <EMap.h>
395 #endif
396
397 #ifdef EAPI
398 # undef EAPI
399 #endif
400
401 #ifdef _WIN32
402 # ifdef ELEMENTARY_BUILD
403 #  ifdef DLL_EXPORT
404 #   define EAPI __declspec(dllexport)
405 #  else
406 #   define EAPI
407 #  endif /* ! DLL_EXPORT */
408 # else
409 #  define EAPI __declspec(dllimport)
410 # endif /* ! EFL_EVAS_BUILD */
411 #else
412 # ifdef __GNUC__
413 #  if __GNUC__ >= 4
414 #   define EAPI __attribute__ ((visibility("default")))
415 #  else
416 #   define EAPI
417 #  endif
418 # else
419 #  define EAPI
420 # endif
421 #endif /* ! _WIN32 */
422
423 #ifdef _WIN32
424 # define EAPI_MAIN
425 #else
426 # define EAPI_MAIN EAPI
427 #endif
428
429 /* allow usage from c++ */
430 #ifdef __cplusplus
431 extern "C" {
432 #endif
433
434 #define ELM_VERSION_MAJOR @VMAJ@
435 #define ELM_VERSION_MINOR @VMIN@
436
437    typedef struct _Elm_Version
438      {
439         int major;
440         int minor;
441         int micro;
442         int revision;
443      } Elm_Version;
444
445    EAPI extern Elm_Version *elm_version;
446
447 /* handy macros */
448 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
449 #define ELM_PI 3.14159265358979323846
450
451    /**
452     * @defgroup General General
453     *
454     * @brief General Elementary API. Functions that don't relate to
455     * Elementary objects specifically.
456     *
457     * Here are documented functions which init/shutdown the library,
458     * that apply to generic Elementary objects, that deal with
459     * configuration, et cetera.
460     *
461     * @ref general_functions_example_page "This" example contemplates
462     * some of these functions.
463     */
464
465    /**
466     * @addtogroup General
467     * @{
468     */
469
470   /**
471    * Defines couple of standard Evas_Object layers to be used
472    * with evas_object_layer_set().
473    *
474    * @note whenever extending with new values, try to keep some padding
475    *       to siblings so there is room for further extensions.
476    */
477   typedef enum _Elm_Object_Layer
478     {
479        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
480        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
481        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
482        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
483        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
484        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
485     } Elm_Object_Layer;
486
487 /**************************************************************************/
488    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
489
490    /**
491     * Emitted when any Elementary's policy value is changed.
492     */
493    EAPI extern int ELM_EVENT_POLICY_CHANGED;
494
495    /**
496     * @typedef Elm_Event_Policy_Changed
497     *
498     * Data on the event when an Elementary policy has changed
499     */
500     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
501
502    /**
503     * @struct _Elm_Event_Policy_Changed
504     *
505     * Data on the event when an Elementary policy has changed
506     */
507     struct _Elm_Event_Policy_Changed
508      {
509         unsigned int policy; /**< the policy identifier */
510         int          new_value; /**< value the policy had before the change */
511         int          old_value; /**< new value the policy got */
512     };
513
514    /**
515     * Policy identifiers.
516     */
517     typedef enum _Elm_Policy
518     {
519         ELM_POLICY_QUIT, /**< under which circumstances the application
520                           * should quit automatically. @see
521                           * Elm_Policy_Quit.
522                           */
523         ELM_POLICY_LAST
524     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
525  */
526
527    typedef enum _Elm_Policy_Quit
528      {
529         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
530                                    * automatically */
531         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
532                                             * application's last
533                                             * window is closed */
534      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
535
536    typedef enum _Elm_Focus_Direction
537      {
538         ELM_FOCUS_PREVIOUS,
539         ELM_FOCUS_NEXT
540      } Elm_Focus_Direction;
541
542    typedef enum _Elm_Text_Format
543      {
544         ELM_TEXT_FORMAT_PLAIN_UTF8,
545         ELM_TEXT_FORMAT_MARKUP_UTF8
546      } Elm_Text_Format;
547
548    /**
549     * Line wrapping types.
550     */
551    typedef enum _Elm_Wrap_Type
552      {
553         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
554         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
555         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
556         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
557         ELM_WRAP_LAST
558      } Elm_Wrap_Type;
559
560    typedef enum
561      {
562         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
563         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
564         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
565         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
566         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
567         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
568         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
569         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
570         ELM_INPUT_PANEL_LAYOUT_INVALID
571      } Elm_Input_Panel_Layout;
572
573    /**
574     * @typedef Elm_Object_Item
575     * An Elementary Object item handle.
576     * @ingroup General
577     */
578    typedef struct _Elm_Object_Item Elm_Object_Item;
579
580
581    /**
582     * Called back when a widget's tooltip is activated and needs content.
583     * @param data user-data given to elm_object_tooltip_content_cb_set()
584     * @param obj owner widget.
585     * @param tooltip The tooltip object (affix content to this!)
586     */
587    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
588
589    /**
590     * Called back when a widget's item tooltip is activated and needs content.
591     * @param data user-data given to elm_object_tooltip_content_cb_set()
592     * @param obj owner widget.
593     * @param tooltip The tooltip object (affix content to this!)
594     * @param item context dependent item. As an example, if tooltip was
595     *        set on Elm_List_Item, then it is of this type.
596     */
597    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
598
599    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
600
601 #ifndef ELM_LIB_QUICKLAUNCH
602 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
603 #else
604 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
605 #endif
606
607 /**************************************************************************/
608    /* General calls */
609
610    /**
611     * Initialize Elementary
612     *
613     * @param[in] argc System's argument count value
614     * @param[in] argv System's pointer to array of argument strings
615     * @return The init counter value.
616     *
617     * This function initializes Elementary and increments a counter of
618     * the number of calls to it. It returns the new counter's value.
619     *
620     * @warning This call is exported only for use by the @c ELM_MAIN()
621     * macro. There is no need to use this if you use this macro (which
622     * is highly advisable). An elm_main() should contain the entry
623     * point code for your application, having the same prototype as
624     * elm_init(), and @b not being static (putting the @c EAPI symbol
625     * in front of its type declaration is advisable). The @c
626     * ELM_MAIN() call should be placed just after it.
627     *
628     * Example:
629     * @dontinclude bg_example_01.c
630     * @skip static void
631     * @until ELM_MAIN
632     *
633     * See the full @ref bg_example_01_c "example".
634     *
635     * @see elm_shutdown().
636     * @ingroup General
637     */
638    EAPI int          elm_init(int argc, char **argv);
639
640    /**
641     * Shut down Elementary
642     *
643     * @return The init counter value.
644     *
645     * This should be called at the end of your application, just
646     * before it ceases to do any more processing. This will clean up
647     * any permanent resources your application may have allocated via
648     * Elementary that would otherwise persist.
649     *
650     * @see elm_init() for an example
651     *
652     * @ingroup General
653     */
654    EAPI int          elm_shutdown(void);
655
656    /**
657     * Run Elementary's main loop
658     *
659     * This call should be issued just after all initialization is
660     * completed. This function will not return until elm_exit() is
661     * called. It will keep looping, running the main
662     * (event/processing) loop for Elementary.
663     *
664     * @see elm_init() for an example
665     *
666     * @ingroup General
667     */
668    EAPI void         elm_run(void);
669
670    /**
671     * Exit Elementary's main loop
672     *
673     * If this call is issued, it will flag the main loop to cease
674     * processing and return back to its parent function (usually your
675     * elm_main() function).
676     *
677     * @see elm_init() for an example. There, just after a request to
678     * close the window comes, the main loop will be left.
679     *
680     * @note By using the #ELM_POLICY_QUIT on your Elementary
681     * applications, you'll this function called automatically for you.
682     *
683     * @ingroup General
684     */
685    EAPI void         elm_exit(void);
686
687    /**
688     * Provide information in order to make Elementary determine the @b
689     * run time location of the software in question, so other data files
690     * such as images, sound files, executable utilities, libraries,
691     * modules and locale files can be found.
692     *
693     * @param mainfunc This is your application's main function name,
694     *        whose binary's location is to be found. Providing @c NULL
695     *        will make Elementary not to use it
696     * @param dom This will be used as the application's "domain", in the
697     *        form of a prefix to any environment variables that may
698     *        override prefix detection and the directory name, inside the
699     *        standard share or data directories, where the software's
700     *        data files will be looked for.
701     * @param checkfile This is an (optional) magic file's path to check
702     *        for existence (and it must be located in the data directory,
703     *        under the share directory provided above). Its presence will
704     *        help determine the prefix found was correct. Pass @c NULL if
705     *        the check is not to be done.
706     *
707     * This function allows one to re-locate the application somewhere
708     * else after compilation, if the developer wishes for easier
709     * distribution of pre-compiled binaries.
710     *
711     * The prefix system is designed to locate where the given software is
712     * installed (under a common path prefix) at run time and then report
713     * specific locations of this prefix and common directories inside
714     * this prefix like the binary, library, data and locale directories,
715     * through the @c elm_app_*_get() family of functions.
716     *
717     * Call elm_app_info_set() early on before you change working
718     * directory or anything about @c argv[0], so it gets accurate
719     * information.
720     *
721     * It will then try and trace back which file @p mainfunc comes from,
722     * if provided, to determine the application's prefix directory.
723     *
724     * The @p dom parameter provides a string prefix to prepend before
725     * environment variables, allowing a fallback to @b specific
726     * environment variables to locate the software. You would most
727     * probably provide a lowercase string there, because it will also
728     * serve as directory domain, explained next. For environment
729     * variables purposes, this string is made uppercase. For example if
730     * @c "myapp" is provided as the prefix, then the program would expect
731     * @c "MYAPP_PREFIX" as a master environment variable to specify the
732     * exact install prefix for the software, or more specific environment
733     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
734     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
735     * the user or scripts before launching. If not provided (@c NULL),
736     * environment variables will not be used to override compiled-in
737     * defaults or auto detections.
738     *
739     * The @p dom string also provides a subdirectory inside the system
740     * shared data directory for data files. For example, if the system
741     * directory is @c /usr/local/share, then this directory name is
742     * appended, creating @c /usr/local/share/myapp, if it @p was @c
743     * "myapp". It is expected the application installs data files in
744     * this directory.
745     *
746     * The @p checkfile is a file name or path of something inside the
747     * share or data directory to be used to test that the prefix
748     * detection worked. For example, your app will install a wallpaper
749     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
750     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
751     * checkfile string.
752     *
753     * @see elm_app_compile_bin_dir_set()
754     * @see elm_app_compile_lib_dir_set()
755     * @see elm_app_compile_data_dir_set()
756     * @see elm_app_compile_locale_set()
757     * @see elm_app_prefix_dir_get()
758     * @see elm_app_bin_dir_get()
759     * @see elm_app_lib_dir_get()
760     * @see elm_app_data_dir_get()
761     * @see elm_app_locale_dir_get()
762     */
763    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
764
765    /**
766     * Provide information on the @b fallback application's binaries
767     * directory, on scenarios where they get overriden by
768     * elm_app_info_set().
769     *
770     * @param dir The path to the default binaries directory (compile time
771     * one)
772     *
773     * @note Elementary will as well use this path to determine actual
774     * names of binaries' directory paths, maybe changing it to be @c
775     * something/local/bin instead of @c something/bin, only, for
776     * example.
777     *
778     * @warning You should call this function @b before
779     * elm_app_info_set().
780     */
781    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
782
783    /**
784     * Provide information on the @b fallback application's libraries
785     * directory, on scenarios where they get overriden by
786     * elm_app_info_set().
787     *
788     * @param dir The path to the default libraries directory (compile
789     * time one)
790     *
791     * @note Elementary will as well use this path to determine actual
792     * names of libraries' directory paths, maybe changing it to be @c
793     * something/lib32 or @c something/lib64 instead of @c something/lib,
794     * only, for example.
795     *
796     * @warning You should call this function @b before
797     * elm_app_info_set().
798     */
799    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
800
801    /**
802     * Provide information on the @b fallback application's data
803     * directory, on scenarios where they get overriden by
804     * elm_app_info_set().
805     *
806     * @param dir The path to the default data directory (compile time
807     * one)
808     *
809     * @note Elementary will as well use this path to determine actual
810     * names of data directory paths, maybe changing it to be @c
811     * something/local/share instead of @c something/share, only, for
812     * example.
813     *
814     * @warning You should call this function @b before
815     * elm_app_info_set().
816     */
817    EAPI void         elm_app_compile_data_dir_set(const char *dir);
818
819    /**
820     * Provide information on the @b fallback application's locale
821     * directory, on scenarios where they get overriden by
822     * elm_app_info_set().
823     *
824     * @param dir The path to the default locale directory (compile time
825     * one)
826     *
827     * @warning You should call this function @b before
828     * elm_app_info_set().
829     */
830    EAPI void         elm_app_compile_locale_set(const char *dir);
831
832    /**
833     * Retrieve the application's run time prefix directory, as set by
834     * elm_app_info_set() and the way (environment) the application was
835     * run from.
836     *
837     * @return The directory prefix the application is actually using
838     */
839    EAPI const char  *elm_app_prefix_dir_get(void);
840
841    /**
842     * Retrieve the application's run time binaries prefix directory, as
843     * set by elm_app_info_set() and the way (environment) the application
844     * was run from.
845     *
846     * @return The binaries directory prefix the application is actually
847     * using
848     */
849    EAPI const char  *elm_app_bin_dir_get(void);
850
851    /**
852     * Retrieve the application's run time libraries prefix directory, as
853     * set by elm_app_info_set() and the way (environment) the application
854     * was run from.
855     *
856     * @return The libraries directory prefix the application is actually
857     * using
858     */
859    EAPI const char  *elm_app_lib_dir_get(void);
860
861    /**
862     * Retrieve the application's run time data prefix directory, as
863     * set by elm_app_info_set() and the way (environment) the application
864     * was run from.
865     *
866     * @return The data directory prefix the application is actually
867     * using
868     */
869    EAPI const char  *elm_app_data_dir_get(void);
870
871    /**
872     * Retrieve the application's run time locale prefix directory, as
873     * set by elm_app_info_set() and the way (environment) the application
874     * was run from.
875     *
876     * @return The locale directory prefix the application is actually
877     * using
878     */
879    EAPI const char  *elm_app_locale_dir_get(void);
880
881    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
882    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
883    EAPI int          elm_quicklaunch_init(int argc, char **argv);
884    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
885    EAPI int          elm_quicklaunch_sub_shutdown(void);
886    EAPI int          elm_quicklaunch_shutdown(void);
887    EAPI void         elm_quicklaunch_seed(void);
888    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
889    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
890    EAPI void         elm_quicklaunch_cleanup(void);
891    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
892    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
893
894    EAPI Eina_Bool    elm_need_efreet(void);
895    EAPI Eina_Bool    elm_need_e_dbus(void);
896
897    /**
898     * This must be called before any other function that handle with
899     * elm_thumb objects or ethumb_client instances.
900     *
901     * @ingroup Thumb
902     */
903    EAPI Eina_Bool    elm_need_ethumb(void);
904
905    /**
906     * Set a new policy's value (for a given policy group/identifier).
907     *
908     * @param policy policy identifier, as in @ref Elm_Policy.
909     * @param value policy value, which depends on the identifier
910     *
911     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
912     *
913     * Elementary policies define applications' behavior,
914     * somehow. These behaviors are divided in policy groups (see
915     * #Elm_Policy enumeration). This call will emit the Ecore event
916     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
917     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
918     * then.
919     *
920     * @note Currently, we have only one policy identifier/group
921     * (#ELM_POLICY_QUIT), which has two possible values.
922     *
923     * @ingroup General
924     */
925    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
926
927    /**
928     * Gets the policy value set for given policy identifier.
929     *
930     * @param policy policy identifier, as in #Elm_Policy.
931     * @return The currently set policy value, for that
932     * identifier. Will be @c 0 if @p policy passed is invalid.
933     *
934     * @ingroup General
935     */
936    EAPI int          elm_policy_get(unsigned int policy);
937
938    /**
939     * Set a label of an object
940     *
941     * @param obj The Elementary object
942     * @param part The text part name to set (NULL for the default label)
943     * @param label The new text of the label
944     *
945     * @note Elementary objects may have many labels (e.g. Action Slider)
946     *
947     * @ingroup General
948     */
949    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
950
951 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
952
953    /**
954     * Get a label of an object
955     *
956     * @param obj The Elementary object
957     * @param part The text part name to get (NULL for the default label)
958     * @return text of the label or NULL for any error
959     *
960     * @note Elementary objects may have many labels (e.g. Action Slider)
961     *
962     * @ingroup General
963     */
964    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
965
966 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
967
968    /**
969     * Set a content of an object
970     *
971     * @param obj The Elementary object
972     * @param part The content part name to set (NULL for the default content)
973     * @param content The new content of the object
974     *
975     * @note Elementary objects may have many contents
976     *
977     * @ingroup General
978     */
979    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
980
981 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
982
983    /**
984     * Get a content of an object
985     *
986     * @param obj The Elementary object
987     * @param item The content part name to get (NULL for the default content)
988     * @return content of the object or NULL for any error
989     *
990     * @note Elementary objects may have many contents
991     *
992     * @ingroup General
993     */
994    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
995
996 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
997
998    /**
999     * Unset a content of an object
1000     *
1001     * @param obj The Elementary object
1002     * @param item The content part name to unset (NULL for the default content)
1003     *
1004     * @note Elementary objects may have many contents
1005     *
1006     * @ingroup General
1007     */
1008    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1009
1010 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1011
1012    /**
1013     * Set a content of an object item
1014     *
1015     * @param it The Elementary object item
1016     * @param part The content part name to set (NULL for the default content)
1017     * @param content The new content of the object item
1018     *
1019     * @note Elementary object items may have many contents
1020     *
1021     * @ingroup General
1022     */
1023    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1024
1025 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1026
1027    /**
1028     * Get a content of an object item
1029     *
1030     * @param it The Elementary object item
1031     * @param part The content part name to unset (NULL for the default content)
1032     * @return content of the object item or NULL for any error
1033     *
1034     * @note Elementary object items may have many contents
1035     *
1036     * @ingroup General
1037     */
1038    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1039
1040 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1041
1042    /**
1043     * Unset a content of an object item
1044     *
1045     * @param it The Elementary object item
1046     * @param part The content part name to unset (NULL for the default content)
1047     *
1048     * @note Elementary object items may have many contents
1049     *
1050     * @ingroup General
1051     */
1052    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1053
1054 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1055
1056    /**
1057     * Set a label of an objec itemt
1058     *
1059     * @param it The Elementary object item
1060     * @param part The text part name to set (NULL for the default label)
1061     * @param label The new text of the label
1062     *
1063     * @note Elementary object items may have many labels
1064     *
1065     * @ingroup General
1066     */
1067    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1068
1069 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1070
1071    /**
1072     * Get a label of an object
1073     *
1074     * @param it The Elementary object item
1075     * @param part The text part name to get (NULL for the default label)
1076     * @return text of the label or NULL for any error
1077     *
1078     * @note Elementary object items may have many labels
1079     *
1080     * @ingroup General
1081     */
1082    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1083
1084    /**
1085     * Set the text to read out when in accessibility mode
1086     *
1087     * @param obj The object which is to be described
1088     * @param txt The text that describes the widget to people with poor or no vision
1089     *
1090     * @ingroup General
1091     */
1092    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1093
1094    /**
1095     * Set the text to read out when in accessibility mode
1096     *
1097     * @param it The object item which is to be described
1098     * @param txt The text that describes the widget to people with poor or no vision
1099     *
1100     * @ingroup General
1101     */
1102    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1103
1104
1105 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1106
1107    /**
1108     * Get the data associated with an object item
1109     * @param it The object item
1110     * @return The data associated with @p it
1111     *
1112     * @ingroup General
1113     */
1114    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1115
1116    /**
1117     * Set the data associated with an object item
1118     * @param it The object item
1119     * @param data The data to be associated with @p it
1120     *
1121     * @ingroup General
1122     */
1123    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1124
1125    /**
1126     * Send a signal to the edje object of the widget item.
1127     *
1128     * This function sends a signal to the edje object of the obj item. An
1129     * edje program can respond to a signal by specifying matching
1130     * 'signal' and 'source' fields.
1131     *
1132     * @param it The Elementary object item
1133     * @param emission The signal's name.
1134     * @param source The signal's source.
1135     * @ingroup General
1136     */
1137    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1138
1139    /**
1140     * @}
1141     */
1142
1143    /**
1144     * @defgroup Caches Caches
1145     *
1146     * These are functions which let one fine-tune some cache values for
1147     * Elementary applications, thus allowing for performance adjustments.
1148     *
1149     * @{
1150     */
1151
1152    /**
1153     * @brief Flush all caches.
1154     *
1155     * Frees all data that was in cache and is not currently being used to reduce
1156     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1157     * to calling all of the following functions:
1158     * @li edje_file_cache_flush()
1159     * @li edje_collection_cache_flush()
1160     * @li eet_clearcache()
1161     * @li evas_image_cache_flush()
1162     * @li evas_font_cache_flush()
1163     * @li evas_render_dump()
1164     * @note Evas caches are flushed for every canvas associated with a window.
1165     *
1166     * @ingroup Caches
1167     */
1168    EAPI void         elm_all_flush(void);
1169
1170    /**
1171     * Get the configured cache flush interval time
1172     *
1173     * This gets the globally configured cache flush interval time, in
1174     * ticks
1175     *
1176     * @return The cache flush interval time
1177     * @ingroup Caches
1178     *
1179     * @see elm_all_flush()
1180     */
1181    EAPI int          elm_cache_flush_interval_get(void);
1182
1183    /**
1184     * Set the configured cache flush interval time
1185     *
1186     * This sets the globally configured cache flush interval time, in ticks
1187     *
1188     * @param size The cache flush interval time
1189     * @ingroup Caches
1190     *
1191     * @see elm_all_flush()
1192     */
1193    EAPI void         elm_cache_flush_interval_set(int size);
1194
1195    /**
1196     * Set the configured cache flush interval time for all applications on the
1197     * display
1198     *
1199     * This sets the globally configured cache flush interval time -- in ticks
1200     * -- for all applications on the display.
1201     *
1202     * @param size The cache flush interval time
1203     * @ingroup Caches
1204     */
1205    EAPI void         elm_cache_flush_interval_all_set(int size);
1206
1207    /**
1208     * Get the configured cache flush enabled state
1209     *
1210     * This gets the globally configured cache flush state - if it is enabled
1211     * or not. When cache flushing is enabled, elementary will regularly
1212     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1213     * memory and allow usage to re-seed caches and data in memory where it
1214     * can do so. An idle application will thus minimise its memory usage as
1215     * data will be freed from memory and not be re-loaded as it is idle and
1216     * not rendering or doing anything graphically right now.
1217     *
1218     * @return The cache flush state
1219     * @ingroup Caches
1220     *
1221     * @see elm_all_flush()
1222     */
1223    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1224
1225    /**
1226     * Set the configured cache flush enabled state
1227     *
1228     * This sets the globally configured cache flush enabled state
1229     *
1230     * @param size The cache flush enabled state
1231     * @ingroup Caches
1232     *
1233     * @see elm_all_flush()
1234     */
1235    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1236
1237    /**
1238     * Set the configured cache flush enabled state for all applications on the
1239     * display
1240     *
1241     * This sets the globally configured cache flush enabled state for all
1242     * applications on the display.
1243     *
1244     * @param size The cache flush enabled state
1245     * @ingroup Caches
1246     */
1247    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1248
1249    /**
1250     * Get the configured font cache size
1251     *
1252     * This gets the globally configured font cache size, in bytes
1253     *
1254     * @return The font cache size
1255     * @ingroup Caches
1256     */
1257    EAPI int          elm_font_cache_get(void);
1258
1259    /**
1260     * Set the configured font cache size
1261     *
1262     * This sets the globally configured font cache size, in bytes
1263     *
1264     * @param size The font cache size
1265     * @ingroup Caches
1266     */
1267    EAPI void         elm_font_cache_set(int size);
1268
1269    /**
1270     * Set the configured font cache size for all applications on the
1271     * display
1272     *
1273     * This sets the globally configured font cache size -- in bytes
1274     * -- for all applications on the display.
1275     *
1276     * @param size The font cache size
1277     * @ingroup Caches
1278     */
1279    EAPI void         elm_font_cache_all_set(int size);
1280
1281    /**
1282     * Get the configured image cache size
1283     *
1284     * This gets the globally configured image cache size, in bytes
1285     *
1286     * @return The image cache size
1287     * @ingroup Caches
1288     */
1289    EAPI int          elm_image_cache_get(void);
1290
1291    /**
1292     * Set the configured image cache size
1293     *
1294     * This sets the globally configured image cache size, in bytes
1295     *
1296     * @param size The image cache size
1297     * @ingroup Caches
1298     */
1299    EAPI void         elm_image_cache_set(int size);
1300
1301    /**
1302     * Set the configured image cache size for all applications on the
1303     * display
1304     *
1305     * This sets the globally configured image cache size -- in bytes
1306     * -- for all applications on the display.
1307     *
1308     * @param size The image cache size
1309     * @ingroup Caches
1310     */
1311    EAPI void         elm_image_cache_all_set(int size);
1312
1313    /**
1314     * Get the configured edje file cache size.
1315     *
1316     * This gets the globally configured edje file cache size, in number
1317     * of files.
1318     *
1319     * @return The edje file cache size
1320     * @ingroup Caches
1321     */
1322    EAPI int          elm_edje_file_cache_get(void);
1323
1324    /**
1325     * Set the configured edje file cache size
1326     *
1327     * This sets the globally configured edje file cache size, in number
1328     * of files.
1329     *
1330     * @param size The edje file cache size
1331     * @ingroup Caches
1332     */
1333    EAPI void         elm_edje_file_cache_set(int size);
1334
1335    /**
1336     * Set the configured edje file cache size for all applications on the
1337     * display
1338     *
1339     * This sets the globally configured edje file cache size -- in number
1340     * of files -- for all applications on the display.
1341     *
1342     * @param size The edje file cache size
1343     * @ingroup Caches
1344     */
1345    EAPI void         elm_edje_file_cache_all_set(int size);
1346
1347    /**
1348     * Get the configured edje collections (groups) cache size.
1349     *
1350     * This gets the globally configured edje collections cache size, in
1351     * number of collections.
1352     *
1353     * @return The edje collections cache size
1354     * @ingroup Caches
1355     */
1356    EAPI int          elm_edje_collection_cache_get(void);
1357
1358    /**
1359     * Set the configured edje collections (groups) cache size
1360     *
1361     * This sets the globally configured edje collections cache size, in
1362     * number of collections.
1363     *
1364     * @param size The edje collections cache size
1365     * @ingroup Caches
1366     */
1367    EAPI void         elm_edje_collection_cache_set(int size);
1368
1369    /**
1370     * Set the configured edje collections (groups) cache size for all
1371     * applications on the display
1372     *
1373     * This sets the globally configured edje collections cache size -- in
1374     * number of collections -- for all applications on the display.
1375     *
1376     * @param size The edje collections cache size
1377     * @ingroup Caches
1378     */
1379    EAPI void         elm_edje_collection_cache_all_set(int size);
1380
1381    /**
1382     * @}
1383     */
1384
1385    /**
1386     * @defgroup Scaling Widget Scaling
1387     *
1388     * Different widgets can be scaled independently. These functions
1389     * allow you to manipulate this scaling on a per-widget basis. The
1390     * object and all its children get their scaling factors multiplied
1391     * by the scale factor set. This is multiplicative, in that if a
1392     * child also has a scale size set it is in turn multiplied by its
1393     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1394     * double size, @c 0.5 is half, etc.
1395     *
1396     * @ref general_functions_example_page "This" example contemplates
1397     * some of these functions.
1398     */
1399
1400    /**
1401     * Get the global scaling factor
1402     *
1403     * This gets the globally configured scaling factor that is applied to all
1404     * objects.
1405     *
1406     * @return The scaling factor
1407     * @ingroup Scaling
1408     */
1409    EAPI double       elm_scale_get(void);
1410
1411    /**
1412     * Set the global scaling factor
1413     *
1414     * This sets the globally configured scaling factor that is applied to all
1415     * objects.
1416     *
1417     * @param scale The scaling factor to set
1418     * @ingroup Scaling
1419     */
1420    EAPI void         elm_scale_set(double scale);
1421
1422    /**
1423     * Set the global scaling factor for all applications on the display
1424     *
1425     * This sets the globally configured scaling factor that is applied to all
1426     * objects for all applications.
1427     * @param scale The scaling factor to set
1428     * @ingroup Scaling
1429     */
1430    EAPI void         elm_scale_all_set(double scale);
1431
1432    /**
1433     * Set the scaling factor for a given Elementary object
1434     *
1435     * @param obj The Elementary to operate on
1436     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1437     * no scaling)
1438     *
1439     * @ingroup Scaling
1440     */
1441    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1442
1443    /**
1444     * Get the scaling factor for a given Elementary object
1445     *
1446     * @param obj The object
1447     * @return The scaling factor set by elm_object_scale_set()
1448     *
1449     * @ingroup Scaling
1450     */
1451    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1452
1453    /**
1454     * @defgroup Password_last_show Password last input show
1455     *
1456     * Last show feature of password mode enables user to view
1457     * the last input entered for few seconds before masking it.
1458     * These functions allow to set this feature in password mode
1459     * of entry widget and also allow to manipulate the duration
1460     * for which the input has to be visible.
1461     *
1462     * @{
1463     */
1464
1465    /**
1466     * Get show last setting of password mode.
1467     *
1468     * This gets the show last input setting of password mode which might be
1469     * enabled or disabled.
1470     *
1471     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1472     *            if it's disabled.
1473     * @ingroup Password_last_show
1474     */
1475    EAPI Eina_Bool elm_password_show_last_get(void);
1476
1477    /**
1478     * Set show last setting in password mode.
1479     *
1480     * This enables or disables show last setting of password mode.
1481     *
1482     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1483     * @see elm_password_show_last_timeout_set()
1484     * @ingroup Password_last_show
1485     */
1486    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1487
1488    /**
1489     * Get's the timeout value in last show password mode.
1490     *
1491     * This gets the time out value for which the last input entered in password
1492     * mode will be visible.
1493     *
1494     * @return The timeout value of last show password mode.
1495     * @ingroup Password_last_show
1496     */
1497    EAPI double elm_password_show_last_timeout_get(void);
1498
1499    /**
1500     * Set's the timeout value in last show password mode.
1501     *
1502     * This sets the time out value for which the last input entered in password
1503     * mode will be visible.
1504     *
1505     * @param password_show_last_timeout The timeout value.
1506     * @see elm_password_show_last_set()
1507     * @ingroup Password_last_show
1508     */
1509    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1510
1511    /**
1512     * @}
1513     */
1514
1515    /**
1516     * @defgroup UI-Mirroring Selective Widget mirroring
1517     *
1518     * These functions allow you to set ui-mirroring on specific
1519     * widgets or the whole interface. Widgets can be in one of two
1520     * modes, automatic and manual.  Automatic means they'll be changed
1521     * according to the system mirroring mode and manual means only
1522     * explicit changes will matter. You are not supposed to change
1523     * mirroring state of a widget set to automatic, will mostly work,
1524     * but the behavior is not really defined.
1525     *
1526     * @{
1527     */
1528
1529    EAPI Eina_Bool    elm_mirrored_get(void);
1530    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1531
1532    /**
1533     * Get the system mirrored mode. This determines the default mirrored mode
1534     * of widgets.
1535     *
1536     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1537     */
1538    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1539
1540    /**
1541     * Set the system mirrored mode. This determines the default mirrored mode
1542     * of widgets.
1543     *
1544     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1545     */
1546    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1547
1548    /**
1549     * Returns the widget's mirrored mode setting.
1550     *
1551     * @param obj The widget.
1552     * @return mirrored mode setting of the object.
1553     *
1554     **/
1555    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1556
1557    /**
1558     * Sets the widget's mirrored mode setting.
1559     * When widget in automatic mode, it follows the system mirrored mode set by
1560     * elm_mirrored_set().
1561     * @param obj The widget.
1562     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1563     */
1564    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1565
1566    /**
1567     * @}
1568     */
1569
1570    /**
1571     * Set the style to use by a widget
1572     *
1573     * Sets the style name that will define the appearance of a widget. Styles
1574     * vary from widget to widget and may also be defined by other themes
1575     * by means of extensions and overlays.
1576     *
1577     * @param obj The Elementary widget to style
1578     * @param style The style name to use
1579     *
1580     * @see elm_theme_extension_add()
1581     * @see elm_theme_extension_del()
1582     * @see elm_theme_overlay_add()
1583     * @see elm_theme_overlay_del()
1584     *
1585     * @ingroup Styles
1586     */
1587    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1588    /**
1589     * Get the style used by the widget
1590     *
1591     * This gets the style being used for that widget. Note that the string
1592     * pointer is only valid as longas the object is valid and the style doesn't
1593     * change.
1594     *
1595     * @param obj The Elementary widget to query for its style
1596     * @return The style name used
1597     *
1598     * @see elm_object_style_set()
1599     *
1600     * @ingroup Styles
1601     */
1602    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1603
1604    /**
1605     * @defgroup Styles Styles
1606     *
1607     * Widgets can have different styles of look. These generic API's
1608     * set styles of widgets, if they support them (and if the theme(s)
1609     * do).
1610     *
1611     * @ref general_functions_example_page "This" example contemplates
1612     * some of these functions.
1613     */
1614
1615    /**
1616     * Set the disabled state of an Elementary object.
1617     *
1618     * @param obj The Elementary object to operate on
1619     * @param disabled The state to put in in: @c EINA_TRUE for
1620     *        disabled, @c EINA_FALSE for enabled
1621     *
1622     * Elementary objects can be @b disabled, in which state they won't
1623     * receive input and, in general, will be themed differently from
1624     * their normal state, usually greyed out. Useful for contexts
1625     * where you don't want your users to interact with some of the
1626     * parts of you interface.
1627     *
1628     * This sets the state for the widget, either disabling it or
1629     * enabling it back.
1630     *
1631     * @ingroup Styles
1632     */
1633    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1634
1635    /**
1636     * Get the disabled state of an Elementary object.
1637     *
1638     * @param obj The Elementary object to operate on
1639     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1640     *            if it's enabled (or on errors)
1641     *
1642     * This gets the state of the widget, which might be enabled or disabled.
1643     *
1644     * @ingroup Styles
1645     */
1646    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1647
1648    /**
1649     * @defgroup WidgetNavigation Widget Tree Navigation.
1650     *
1651     * How to check if an Evas Object is an Elementary widget? How to
1652     * get the first elementary widget that is parent of the given
1653     * object?  These are all covered in widget tree navigation.
1654     *
1655     * @ref general_functions_example_page "This" example contemplates
1656     * some of these functions.
1657     */
1658
1659    /**
1660     * Check if the given Evas Object is an Elementary widget.
1661     *
1662     * @param obj the object to query.
1663     * @return @c EINA_TRUE if it is an elementary widget variant,
1664     *         @c EINA_FALSE otherwise
1665     * @ingroup WidgetNavigation
1666     */
1667    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1668
1669    /**
1670     * Get the first parent of the given object that is an Elementary
1671     * widget.
1672     *
1673     * @param obj the Elementary object to query parent from.
1674     * @return the parent object that is an Elementary widget, or @c
1675     *         NULL, if it was not found.
1676     *
1677     * Use this to query for an object's parent widget.
1678     *
1679     * @note Most of Elementary users wouldn't be mixing non-Elementary
1680     * smart objects in the objects tree of an application, as this is
1681     * an advanced usage of Elementary with Evas. So, except for the
1682     * application's window, which is the root of that tree, all other
1683     * objects would have valid Elementary widget parents.
1684     *
1685     * @ingroup WidgetNavigation
1686     */
1687    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1688
1689    /**
1690     * Get the top level parent of an Elementary widget.
1691     *
1692     * @param obj The object to query.
1693     * @return The top level Elementary widget, or @c NULL if parent cannot be
1694     * found.
1695     * @ingroup WidgetNavigation
1696     */
1697    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1698
1699    /**
1700     * Get the string that represents this Elementary widget.
1701     *
1702     * @note Elementary is weird and exposes itself as a single
1703     *       Evas_Object_Smart_Class of type "elm_widget", so
1704     *       evas_object_type_get() always return that, making debug and
1705     *       language bindings hard. This function tries to mitigate this
1706     *       problem, but the solution is to change Elementary to use
1707     *       proper inheritance.
1708     *
1709     * @param obj the object to query.
1710     * @return Elementary widget name, or @c NULL if not a valid widget.
1711     * @ingroup WidgetNavigation
1712     */
1713    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1714
1715    /**
1716     * @defgroup Config Elementary Config
1717     *
1718     * Elementary configuration is formed by a set options bounded to a
1719     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1720     * "finger size", etc. These are functions with which one syncronizes
1721     * changes made to those values to the configuration storing files, de
1722     * facto. You most probably don't want to use the functions in this
1723     * group unlees you're writing an elementary configuration manager.
1724     *
1725     * @{
1726     */
1727
1728    /**
1729     * Save back Elementary's configuration, so that it will persist on
1730     * future sessions.
1731     *
1732     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1733     * @ingroup Config
1734     *
1735     * This function will take effect -- thus, do I/O -- immediately. Use
1736     * it when you want to apply all configuration changes at once. The
1737     * current configuration set will get saved onto the current profile
1738     * configuration file.
1739     *
1740     */
1741    EAPI Eina_Bool    elm_config_save(void);
1742
1743    /**
1744     * Reload Elementary's configuration, bounded to current selected
1745     * profile.
1746     *
1747     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1748     * @ingroup Config
1749     *
1750     * Useful when you want to force reloading of configuration values for
1751     * a profile. If one removes user custom configuration directories,
1752     * for example, it will force a reload with system values insted.
1753     *
1754     */
1755    EAPI void         elm_config_reload(void);
1756
1757    /**
1758     * @}
1759     */
1760
1761    /**
1762     * @defgroup Profile Elementary Profile
1763     *
1764     * Profiles are pre-set options that affect the whole look-and-feel of
1765     * Elementary-based applications. There are, for example, profiles
1766     * aimed at desktop computer applications and others aimed at mobile,
1767     * touchscreen-based ones. You most probably don't want to use the
1768     * functions in this group unlees you're writing an elementary
1769     * configuration manager.
1770     *
1771     * @{
1772     */
1773
1774    /**
1775     * Get Elementary's profile in use.
1776     *
1777     * This gets the global profile that is applied to all Elementary
1778     * applications.
1779     *
1780     * @return The profile's name
1781     * @ingroup Profile
1782     */
1783    EAPI const char  *elm_profile_current_get(void);
1784
1785    /**
1786     * Get an Elementary's profile directory path in the filesystem. One
1787     * may want to fetch a system profile's dir or an user one (fetched
1788     * inside $HOME).
1789     *
1790     * @param profile The profile's name
1791     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1792     *                or a system one (@c EINA_FALSE)
1793     * @return The profile's directory path.
1794     * @ingroup Profile
1795     *
1796     * @note You must free it with elm_profile_dir_free().
1797     */
1798    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1799
1800    /**
1801     * Free an Elementary's profile directory path, as returned by
1802     * elm_profile_dir_get().
1803     *
1804     * @param p_dir The profile's path
1805     * @ingroup Profile
1806     *
1807     */
1808    EAPI void         elm_profile_dir_free(const char *p_dir);
1809
1810    /**
1811     * Get Elementary's list of available profiles.
1812     *
1813     * @return The profiles list. List node data are the profile name
1814     *         strings.
1815     * @ingroup Profile
1816     *
1817     * @note One must free this list, after usage, with the function
1818     *       elm_profile_list_free().
1819     */
1820    EAPI Eina_List   *elm_profile_list_get(void);
1821
1822    /**
1823     * Free Elementary's list of available profiles.
1824     *
1825     * @param l The profiles list, as returned by elm_profile_list_get().
1826     * @ingroup Profile
1827     *
1828     */
1829    EAPI void         elm_profile_list_free(Eina_List *l);
1830
1831    /**
1832     * Set Elementary's profile.
1833     *
1834     * This sets the global profile that is applied to Elementary
1835     * applications. Just the process the call comes from will be
1836     * affected.
1837     *
1838     * @param profile The profile's name
1839     * @ingroup Profile
1840     *
1841     */
1842    EAPI void         elm_profile_set(const char *profile);
1843
1844    /**
1845     * Set Elementary's profile.
1846     *
1847     * This sets the global profile that is applied to all Elementary
1848     * applications. All running Elementary windows will be affected.
1849     *
1850     * @param profile The profile's name
1851     * @ingroup Profile
1852     *
1853     */
1854    EAPI void         elm_profile_all_set(const char *profile);
1855
1856    /**
1857     * @}
1858     */
1859
1860    /**
1861     * @defgroup Engine Elementary Engine
1862     *
1863     * These are functions setting and querying which rendering engine
1864     * Elementary will use for drawing its windows' pixels.
1865     *
1866     * The following are the available engines:
1867     * @li "software_x11"
1868     * @li "fb"
1869     * @li "directfb"
1870     * @li "software_16_x11"
1871     * @li "software_8_x11"
1872     * @li "xrender_x11"
1873     * @li "opengl_x11"
1874     * @li "software_gdi"
1875     * @li "software_16_wince_gdi"
1876     * @li "sdl"
1877     * @li "software_16_sdl"
1878     * @li "opengl_sdl"
1879     * @li "buffer"
1880     *
1881     * @{
1882     */
1883
1884    /**
1885     * @brief Get Elementary's rendering engine in use.
1886     *
1887     * @return The rendering engine's name
1888     * @note there's no need to free the returned string, here.
1889     *
1890     * This gets the global rendering engine that is applied to all Elementary
1891     * applications.
1892     *
1893     * @see elm_engine_set()
1894     */
1895    EAPI const char  *elm_engine_current_get(void);
1896
1897    /**
1898     * @brief Set Elementary's rendering engine for use.
1899     *
1900     * @param engine The rendering engine's name
1901     *
1902     * This sets global rendering engine that is applied to all Elementary
1903     * applications. Note that it will take effect only to Elementary windows
1904     * created after this is called.
1905     *
1906     * @see elm_win_add()
1907     */
1908    EAPI void         elm_engine_set(const char *engine);
1909
1910    /**
1911     * @}
1912     */
1913
1914    /**
1915     * @defgroup Fonts Elementary Fonts
1916     *
1917     * These are functions dealing with font rendering, selection and the
1918     * like for Elementary applications. One might fetch which system
1919     * fonts are there to use and set custom fonts for individual classes
1920     * of UI items containing text (text classes).
1921     *
1922     * @{
1923     */
1924
1925   typedef struct _Elm_Text_Class
1926     {
1927        const char *name;
1928        const char *desc;
1929     } Elm_Text_Class;
1930
1931   typedef struct _Elm_Font_Overlay
1932     {
1933        const char     *text_class;
1934        const char     *font;
1935        Evas_Font_Size  size;
1936     } Elm_Font_Overlay;
1937
1938   typedef struct _Elm_Font_Properties
1939     {
1940        const char *name;
1941        Eina_List  *styles;
1942     } Elm_Font_Properties;
1943
1944    /**
1945     * Get Elementary's list of supported text classes.
1946     *
1947     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1948     * @ingroup Fonts
1949     *
1950     * Release the list with elm_text_classes_list_free().
1951     */
1952    EAPI const Eina_List     *elm_text_classes_list_get(void);
1953
1954    /**
1955     * Free Elementary's list of supported text classes.
1956     *
1957     * @ingroup Fonts
1958     *
1959     * @see elm_text_classes_list_get().
1960     */
1961    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1962
1963    /**
1964     * Get Elementary's list of font overlays, set with
1965     * elm_font_overlay_set().
1966     *
1967     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1968     * data.
1969     *
1970     * @ingroup Fonts
1971     *
1972     * For each text class, one can set a <b>font overlay</b> for it,
1973     * overriding the default font properties for that class coming from
1974     * the theme in use. There is no need to free this list.
1975     *
1976     * @see elm_font_overlay_set() and elm_font_overlay_unset().
1977     */
1978    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1979
1980    /**
1981     * Set a font overlay for a given Elementary text class.
1982     *
1983     * @param text_class Text class name
1984     * @param font Font name and style string
1985     * @param size Font size
1986     *
1987     * @ingroup Fonts
1988     *
1989     * @p font has to be in the format returned by
1990     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1991     * and elm_font_overlay_unset().
1992     */
1993    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1994
1995    /**
1996     * Unset a font overlay for a given Elementary text class.
1997     *
1998     * @param text_class Text class name
1999     *
2000     * @ingroup Fonts
2001     *
2002     * This will bring back text elements belonging to text class
2003     * @p text_class back to their default font settings.
2004     */
2005    EAPI void                 elm_font_overlay_unset(const char *text_class);
2006
2007    /**
2008     * Apply the changes made with elm_font_overlay_set() and
2009     * elm_font_overlay_unset() on the current Elementary window.
2010     *
2011     * @ingroup Fonts
2012     *
2013     * This applies all font overlays set to all objects in the UI.
2014     */
2015    EAPI void                 elm_font_overlay_apply(void);
2016
2017    /**
2018     * Apply the changes made with elm_font_overlay_set() and
2019     * elm_font_overlay_unset() on all Elementary application windows.
2020     *
2021     * @ingroup Fonts
2022     *
2023     * This applies all font overlays set to all objects in the UI.
2024     */
2025    EAPI void                 elm_font_overlay_all_apply(void);
2026
2027    /**
2028     * Translate a font (family) name string in fontconfig's font names
2029     * syntax into an @c Elm_Font_Properties struct.
2030     *
2031     * @param font The font name and styles string
2032     * @return the font properties struct
2033     *
2034     * @ingroup Fonts
2035     *
2036     * @note The reverse translation can be achived with
2037     * elm_font_fontconfig_name_get(), for one style only (single font
2038     * instance, not family).
2039     */
2040    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2041
2042    /**
2043     * Free font properties return by elm_font_properties_get().
2044     *
2045     * @param efp the font properties struct
2046     *
2047     * @ingroup Fonts
2048     */
2049    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2050
2051    /**
2052     * Translate a font name, bound to a style, into fontconfig's font names
2053     * syntax.
2054     *
2055     * @param name The font (family) name
2056     * @param style The given style (may be @c NULL)
2057     *
2058     * @return the font name and style string
2059     *
2060     * @ingroup Fonts
2061     *
2062     * @note The reverse translation can be achived with
2063     * elm_font_properties_get(), for one style only (single font
2064     * instance, not family).
2065     */
2066    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2067
2068    /**
2069     * Free the font string return by elm_font_fontconfig_name_get().
2070     *
2071     * @param efp the font properties struct
2072     *
2073     * @ingroup Fonts
2074     */
2075    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2076
2077    /**
2078     * Create a font hash table of available system fonts.
2079     *
2080     * One must call it with @p list being the return value of
2081     * evas_font_available_list(). The hash will be indexed by font
2082     * (family) names, being its values @c Elm_Font_Properties blobs.
2083     *
2084     * @param list The list of available system fonts, as returned by
2085     * evas_font_available_list().
2086     * @return the font hash.
2087     *
2088     * @ingroup Fonts
2089     *
2090     * @note The user is supposed to get it populated at least with 3
2091     * default font families (Sans, Serif, Monospace), which should be
2092     * present on most systems.
2093     */
2094    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2095
2096    /**
2097     * Free the hash return by elm_font_available_hash_add().
2098     *
2099     * @param hash the hash to be freed.
2100     *
2101     * @ingroup Fonts
2102     */
2103    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2104
2105    /**
2106     * @}
2107     */
2108
2109    /**
2110     * @defgroup Fingers Fingers
2111     *
2112     * Elementary is designed to be finger-friendly for touchscreens,
2113     * and so in addition to scaling for display resolution, it can
2114     * also scale based on finger "resolution" (or size). You can then
2115     * customize the granularity of the areas meant to receive clicks
2116     * on touchscreens.
2117     *
2118     * Different profiles may have pre-set values for finger sizes.
2119     *
2120     * @ref general_functions_example_page "This" example contemplates
2121     * some of these functions.
2122     *
2123     * @{
2124     */
2125
2126    /**
2127     * Get the configured "finger size"
2128     *
2129     * @return The finger size
2130     *
2131     * This gets the globally configured finger size, <b>in pixels</b>
2132     *
2133     * @ingroup Fingers
2134     */
2135    EAPI Evas_Coord       elm_finger_size_get(void);
2136
2137    /**
2138     * Set the configured finger size
2139     *
2140     * This sets the globally configured finger size in pixels
2141     *
2142     * @param size The finger size
2143     * @ingroup Fingers
2144     */
2145    EAPI void             elm_finger_size_set(Evas_Coord size);
2146
2147    /**
2148     * Set the configured finger size for all applications on the display
2149     *
2150     * This sets the globally configured finger size in pixels for all
2151     * applications on the display
2152     *
2153     * @param size The finger size
2154     * @ingroup Fingers
2155     */
2156    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2157
2158    /**
2159     * @}
2160     */
2161
2162    /**
2163     * @defgroup Focus Focus
2164     *
2165     * An Elementary application has, at all times, one (and only one)
2166     * @b focused object. This is what determines where the input
2167     * events go to within the application's window. Also, focused
2168     * objects can be decorated differently, in order to signal to the
2169     * user where the input is, at a given moment.
2170     *
2171     * Elementary applications also have the concept of <b>focus
2172     * chain</b>: one can cycle through all the windows' focusable
2173     * objects by input (tab key) or programmatically. The default
2174     * focus chain for an application is the one define by the order in
2175     * which the widgets where added in code. One will cycle through
2176     * top level widgets, and, for each one containg sub-objects, cycle
2177     * through them all, before returning to the level
2178     * above. Elementary also allows one to set @b custom focus chains
2179     * for their applications.
2180     *
2181     * Besides the focused decoration a widget may exhibit, when it
2182     * gets focus, Elementary has a @b global focus highlight object
2183     * that can be enabled for a window. If one chooses to do so, this
2184     * extra highlight effect will surround the current focused object,
2185     * too.
2186     *
2187     * @note Some Elementary widgets are @b unfocusable, after
2188     * creation, by their very nature: they are not meant to be
2189     * interacted with input events, but are there just for visual
2190     * purposes.
2191     *
2192     * @ref general_functions_example_page "This" example contemplates
2193     * some of these functions.
2194     */
2195
2196    /**
2197     * Get the enable status of the focus highlight
2198     *
2199     * This gets whether the highlight on focused objects is enabled or not
2200     * @ingroup Focus
2201     */
2202    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2203
2204    /**
2205     * Set the enable status of the focus highlight
2206     *
2207     * Set whether to show or not the highlight on focused objects
2208     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2209     * @ingroup Focus
2210     */
2211    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2212
2213    /**
2214     * Get the enable status of the highlight animation
2215     *
2216     * Get whether the focus highlight, if enabled, will animate its switch from
2217     * one object to the next
2218     * @ingroup Focus
2219     */
2220    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2221
2222    /**
2223     * Set the enable status of the highlight animation
2224     *
2225     * Set whether the focus highlight, if enabled, will animate its switch from
2226     * one object to the next
2227     * @param animate Enable animation if EINA_TRUE, disable otherwise
2228     * @ingroup Focus
2229     */
2230    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2231
2232    /**
2233     * Get the whether an Elementary object has the focus or not.
2234     *
2235     * @param obj The Elementary object to get the information from
2236     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2237     *            not (and on errors).
2238     *
2239     * @see elm_object_focus_set()
2240     *
2241     * @ingroup Focus
2242     */
2243    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2244
2245    /**
2246     * Set/unset focus to a given Elementary object.
2247     *
2248     * @param obj The Elementary object to operate on.
2249     * @param enable @c EINA_TRUE Set focus to a given object,
2250     *               @c EINA_FALSE Unset focus to a given object.
2251     *
2252     * @note When you set focus to this object, if it can handle focus, will
2253     * take the focus away from the one who had it previously and will, for
2254     * now on, be the one receiving input events. Unsetting focus will remove
2255     * the focus from @p obj, passing it back to the previous element in the
2256     * focus chain list.
2257     *
2258     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2259     *
2260     * @ingroup Focus
2261     */
2262    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2263
2264    /**
2265     * Make a given Elementary object the focused one.
2266     *
2267     * @param obj The Elementary object to make focused.
2268     *
2269     * @note This object, if it can handle focus, will take the focus
2270     * away from the one who had it previously and will, for now on, be
2271     * the one receiving input events.
2272     *
2273     * @see elm_object_focus_get()
2274     * @deprecated use elm_object_focus_set() instead.
2275     *
2276     * @ingroup Focus
2277     */
2278    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2279
2280    /**
2281     * Remove the focus from an Elementary object
2282     *
2283     * @param obj The Elementary to take focus from
2284     *
2285     * This removes the focus from @p obj, passing it back to the
2286     * previous element in the focus chain list.
2287     *
2288     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2289     * @deprecated use elm_object_focus_set() instead.
2290     *
2291     * @ingroup Focus
2292     */
2293    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2294
2295    /**
2296     * Set the ability for an Element object to be focused
2297     *
2298     * @param obj The Elementary object to operate on
2299     * @param enable @c EINA_TRUE if the object can be focused, @c
2300     *        EINA_FALSE if not (and on errors)
2301     *
2302     * This sets whether the object @p obj is able to take focus or
2303     * not. Unfocusable objects do nothing when programmatically
2304     * focused, being the nearest focusable parent object the one
2305     * really getting focus. Also, when they receive mouse input, they
2306     * will get the event, but not take away the focus from where it
2307     * was previously.
2308     *
2309     * @ingroup Focus
2310     */
2311    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2312
2313    /**
2314     * Get whether an Elementary object is focusable or not
2315     *
2316     * @param obj The Elementary object to operate on
2317     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2318     *             EINA_FALSE if not (and on errors)
2319     *
2320     * @note Objects which are meant to be interacted with by input
2321     * events are created able to be focused, by default. All the
2322     * others are not.
2323     *
2324     * @ingroup Focus
2325     */
2326    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2327
2328    /**
2329     * Set custom focus chain.
2330     *
2331     * This function overwrites any previous custom focus chain within
2332     * the list of objects. The previous list will be deleted and this list
2333     * will be managed by elementary. After it is set, don't modify it.
2334     *
2335     * @note On focus cycle, only will be evaluated children of this container.
2336     *
2337     * @param obj The container object
2338     * @param objs Chain of objects to pass focus
2339     * @ingroup Focus
2340     */
2341    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2342
2343    /**
2344     * Unset a custom focus chain on a given Elementary widget
2345     *
2346     * @param obj The container object to remove focus chain from
2347     *
2348     * Any focus chain previously set on @p obj (for its child objects)
2349     * is removed entirely after this call.
2350     *
2351     * @ingroup Focus
2352     */
2353    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2354
2355    /**
2356     * Get custom focus chain
2357     *
2358     * @param obj The container object
2359     * @ingroup Focus
2360     */
2361    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2362
2363    /**
2364     * Append object to custom focus chain.
2365     *
2366     * @note If relative_child equal to NULL or not in custom chain, the object
2367     * will be added in end.
2368     *
2369     * @note On focus cycle, only will be evaluated children of this container.
2370     *
2371     * @param obj The container object
2372     * @param child The child to be added in custom chain
2373     * @param relative_child The relative object to position the child
2374     * @ingroup Focus
2375     */
2376    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2377
2378    /**
2379     * Prepend object to custom focus chain.
2380     *
2381     * @note If relative_child equal to NULL or not in custom chain, the object
2382     * will be added in begin.
2383     *
2384     * @note On focus cycle, only will be evaluated children of this container.
2385     *
2386     * @param obj The container object
2387     * @param child The child to be added in custom chain
2388     * @param relative_child The relative object to position the child
2389     * @ingroup Focus
2390     */
2391    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2392
2393    /**
2394     * Give focus to next object in object tree.
2395     *
2396     * Give focus to next object in focus chain of one object sub-tree.
2397     * If the last object of chain already have focus, the focus will go to the
2398     * first object of chain.
2399     *
2400     * @param obj The object root of sub-tree
2401     * @param dir Direction to cycle the focus
2402     *
2403     * @ingroup Focus
2404     */
2405    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2406
2407    /**
2408     * Give focus to near object in one direction.
2409     *
2410     * Give focus to near object in direction of one object.
2411     * If none focusable object in given direction, the focus will not change.
2412     *
2413     * @param obj The reference object
2414     * @param x Horizontal component of direction to focus
2415     * @param y Vertical component of direction to focus
2416     *
2417     * @ingroup Focus
2418     */
2419    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2420
2421    /**
2422     * Make the elementary object and its children to be unfocusable
2423     * (or focusable).
2424     *
2425     * @param obj The Elementary object to operate on
2426     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2427     *        @c EINA_FALSE for focusable.
2428     *
2429     * This sets whether the object @p obj and its children objects
2430     * are able to take focus or not. If the tree is set as unfocusable,
2431     * newest focused object which is not in this tree will get focus.
2432     * This API can be helpful for an object to be deleted.
2433     * When an object will be deleted soon, it and its children may not
2434     * want to get focus (by focus reverting or by other focus controls).
2435     * Then, just use this API before deleting.
2436     *
2437     * @see elm_object_tree_unfocusable_get()
2438     *
2439     * @ingroup Focus
2440     */
2441    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2442
2443    /**
2444     * Get whether an Elementary object and its children are unfocusable or not.
2445     *
2446     * @param obj The Elementary object to get the information from
2447     * @return @c EINA_TRUE, if the tree is unfocussable,
2448     *         @c EINA_FALSE if not (and on errors).
2449     *
2450     * @see elm_object_tree_unfocusable_set()
2451     *
2452     * @ingroup Focus
2453     */
2454    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2455
2456    /**
2457     * @defgroup Scrolling Scrolling
2458     *
2459     * These are functions setting how scrollable views in Elementary
2460     * widgets should behave on user interaction.
2461     *
2462     * @{
2463     */
2464
2465    /**
2466     * Get whether scrollers should bounce when they reach their
2467     * viewport's edge during a scroll.
2468     *
2469     * @return the thumb scroll bouncing state
2470     *
2471     * This is the default behavior for touch screens, in general.
2472     * @ingroup Scrolling
2473     */
2474    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2475
2476    /**
2477     * Set whether scrollers should bounce when they reach their
2478     * viewport's edge during a scroll.
2479     *
2480     * @param enabled the thumb scroll bouncing state
2481     *
2482     * @see elm_thumbscroll_bounce_enabled_get()
2483     * @ingroup Scrolling
2484     */
2485    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2486
2487    /**
2488     * Set whether scrollers should bounce when they reach their
2489     * viewport's edge during a scroll, for all Elementary application
2490     * windows.
2491     *
2492     * @param enabled the thumb scroll bouncing state
2493     *
2494     * @see elm_thumbscroll_bounce_enabled_get()
2495     * @ingroup Scrolling
2496     */
2497    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2498
2499    /**
2500     * Get the amount of inertia a scroller will impose at bounce
2501     * animations.
2502     *
2503     * @return the thumb scroll bounce friction
2504     *
2505     * @ingroup Scrolling
2506     */
2507    EAPI double           elm_scroll_bounce_friction_get(void);
2508
2509    /**
2510     * Set the amount of inertia a scroller will impose at bounce
2511     * animations.
2512     *
2513     * @param friction the thumb scroll bounce friction
2514     *
2515     * @see elm_thumbscroll_bounce_friction_get()
2516     * @ingroup Scrolling
2517     */
2518    EAPI void             elm_scroll_bounce_friction_set(double friction);
2519
2520    /**
2521     * Set the amount of inertia a scroller will impose at bounce
2522     * animations, for all Elementary application windows.
2523     *
2524     * @param friction the thumb scroll bounce friction
2525     *
2526     * @see elm_thumbscroll_bounce_friction_get()
2527     * @ingroup Scrolling
2528     */
2529    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2530
2531    /**
2532     * Get the amount of inertia a <b>paged</b> scroller will impose at
2533     * page fitting animations.
2534     *
2535     * @return the page scroll friction
2536     *
2537     * @ingroup Scrolling
2538     */
2539    EAPI double           elm_scroll_page_scroll_friction_get(void);
2540
2541    /**
2542     * Set the amount of inertia a <b>paged</b> scroller will impose at
2543     * page fitting animations.
2544     *
2545     * @param friction the page scroll friction
2546     *
2547     * @see elm_thumbscroll_page_scroll_friction_get()
2548     * @ingroup Scrolling
2549     */
2550    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2551
2552    /**
2553     * Set the amount of inertia a <b>paged</b> scroller will impose at
2554     * page fitting animations, for all Elementary application windows.
2555     *
2556     * @param friction the page scroll friction
2557     *
2558     * @see elm_thumbscroll_page_scroll_friction_get()
2559     * @ingroup Scrolling
2560     */
2561    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2562
2563    /**
2564     * Get the amount of inertia a scroller will impose at region bring
2565     * animations.
2566     *
2567     * @return the bring in scroll friction
2568     *
2569     * @ingroup Scrolling
2570     */
2571    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2572
2573    /**
2574     * Set the amount of inertia a scroller will impose at region bring
2575     * animations.
2576     *
2577     * @param friction the bring in scroll friction
2578     *
2579     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2580     * @ingroup Scrolling
2581     */
2582    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2583
2584    /**
2585     * Set the amount of inertia a scroller will impose at region bring
2586     * animations, for all Elementary application windows.
2587     *
2588     * @param friction the bring in scroll friction
2589     *
2590     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2591     * @ingroup Scrolling
2592     */
2593    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2594
2595    /**
2596     * Get the amount of inertia scrollers will impose at animations
2597     * triggered by Elementary widgets' zooming API.
2598     *
2599     * @return the zoom friction
2600     *
2601     * @ingroup Scrolling
2602     */
2603    EAPI double           elm_scroll_zoom_friction_get(void);
2604
2605    /**
2606     * Set the amount of inertia scrollers will impose at animations
2607     * triggered by Elementary widgets' zooming API.
2608     *
2609     * @param friction the zoom friction
2610     *
2611     * @see elm_thumbscroll_zoom_friction_get()
2612     * @ingroup Scrolling
2613     */
2614    EAPI void             elm_scroll_zoom_friction_set(double friction);
2615
2616    /**
2617     * Set the amount of inertia scrollers will impose at animations
2618     * triggered by Elementary widgets' zooming API, for all Elementary
2619     * application windows.
2620     *
2621     * @param friction the zoom friction
2622     *
2623     * @see elm_thumbscroll_zoom_friction_get()
2624     * @ingroup Scrolling
2625     */
2626    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2627
2628    /**
2629     * Get whether scrollers should be draggable from any point in their
2630     * views.
2631     *
2632     * @return the thumb scroll state
2633     *
2634     * @note This is the default behavior for touch screens, in general.
2635     * @note All other functions namespaced with "thumbscroll" will only
2636     *       have effect if this mode is enabled.
2637     *
2638     * @ingroup Scrolling
2639     */
2640    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2641
2642    /**
2643     * Set whether scrollers should be draggable from any point in their
2644     * views.
2645     *
2646     * @param enabled the thumb scroll state
2647     *
2648     * @see elm_thumbscroll_enabled_get()
2649     * @ingroup Scrolling
2650     */
2651    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2652
2653    /**
2654     * Set whether scrollers should be draggable from any point in their
2655     * views, for all Elementary application windows.
2656     *
2657     * @param enabled the thumb scroll state
2658     *
2659     * @see elm_thumbscroll_enabled_get()
2660     * @ingroup Scrolling
2661     */
2662    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2663
2664    /**
2665     * Get the number of pixels one should travel while dragging a
2666     * scroller's view to actually trigger scrolling.
2667     *
2668     * @return the thumb scroll threshould
2669     *
2670     * One would use higher values for touch screens, in general, because
2671     * of their inherent imprecision.
2672     * @ingroup Scrolling
2673     */
2674    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2675
2676    /**
2677     * Set the number of pixels one should travel while dragging a
2678     * scroller's view to actually trigger scrolling.
2679     *
2680     * @param threshold the thumb scroll threshould
2681     *
2682     * @see elm_thumbscroll_threshould_get()
2683     * @ingroup Scrolling
2684     */
2685    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2686
2687    /**
2688     * Set the number of pixels one should travel while dragging a
2689     * scroller's view to actually trigger scrolling, for all Elementary
2690     * application windows.
2691     *
2692     * @param threshold the thumb scroll threshould
2693     *
2694     * @see elm_thumbscroll_threshould_get()
2695     * @ingroup Scrolling
2696     */
2697    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2698
2699    /**
2700     * Get the minimum speed of mouse cursor movement which will trigger
2701     * list self scrolling animation after a mouse up event
2702     * (pixels/second).
2703     *
2704     * @return the thumb scroll momentum threshould
2705     *
2706     * @ingroup Scrolling
2707     */
2708    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2709
2710    /**
2711     * Set the minimum speed of mouse cursor movement which will trigger
2712     * list self scrolling animation after a mouse up event
2713     * (pixels/second).
2714     *
2715     * @param threshold the thumb scroll momentum threshould
2716     *
2717     * @see elm_thumbscroll_momentum_threshould_get()
2718     * @ingroup Scrolling
2719     */
2720    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2721
2722    /**
2723     * Set the minimum speed of mouse cursor movement which will trigger
2724     * list self scrolling animation after a mouse up event
2725     * (pixels/second), for all Elementary application windows.
2726     *
2727     * @param threshold the thumb scroll momentum threshould
2728     *
2729     * @see elm_thumbscroll_momentum_threshould_get()
2730     * @ingroup Scrolling
2731     */
2732    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2733
2734    /**
2735     * Get the amount of inertia a scroller will impose at self scrolling
2736     * animations.
2737     *
2738     * @return the thumb scroll friction
2739     *
2740     * @ingroup Scrolling
2741     */
2742    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2743
2744    /**
2745     * Set the amount of inertia a scroller will impose at self scrolling
2746     * animations.
2747     *
2748     * @param friction the thumb scroll friction
2749     *
2750     * @see elm_thumbscroll_friction_get()
2751     * @ingroup Scrolling
2752     */
2753    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2754
2755    /**
2756     * Set the amount of inertia a scroller will impose at self scrolling
2757     * animations, for all Elementary application windows.
2758     *
2759     * @param friction the thumb scroll friction
2760     *
2761     * @see elm_thumbscroll_friction_get()
2762     * @ingroup Scrolling
2763     */
2764    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2765
2766    /**
2767     * Get the amount of lag between your actual mouse cursor dragging
2768     * movement and a scroller's view movement itself, while pushing it
2769     * into bounce state manually.
2770     *
2771     * @return the thumb scroll border friction
2772     *
2773     * @ingroup Scrolling
2774     */
2775    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2776
2777    /**
2778     * Set the amount of lag between your actual mouse cursor dragging
2779     * movement and a scroller's view movement itself, while pushing it
2780     * into bounce state manually.
2781     *
2782     * @param friction the thumb scroll border friction. @c 0.0 for
2783     *        perfect synchrony between two movements, @c 1.0 for maximum
2784     *        lag.
2785     *
2786     * @see elm_thumbscroll_border_friction_get()
2787     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2788     *
2789     * @ingroup Scrolling
2790     */
2791    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2792
2793    /**
2794     * Set the amount of lag between your actual mouse cursor dragging
2795     * movement and a scroller's view movement itself, while pushing it
2796     * into bounce state manually, for all Elementary application windows.
2797     *
2798     * @param friction the thumb scroll border friction. @c 0.0 for
2799     *        perfect synchrony between two movements, @c 1.0 for maximum
2800     *        lag.
2801     *
2802     * @see elm_thumbscroll_border_friction_get()
2803     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2804     *
2805     * @ingroup Scrolling
2806     */
2807    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2808
2809    /**
2810     * @}
2811     */
2812
2813    /**
2814     * @defgroup Scrollhints Scrollhints
2815     *
2816     * Objects when inside a scroller can scroll, but this may not always be
2817     * desirable in certain situations. This allows an object to hint to itself
2818     * and parents to "not scroll" in one of 2 ways. If any child object of a
2819     * scroller has pushed a scroll freeze or hold then it affects all parent
2820     * scrollers until all children have released them.
2821     *
2822     * 1. To hold on scrolling. This means just flicking and dragging may no
2823     * longer scroll, but pressing/dragging near an edge of the scroller will
2824     * still scroll. This is automatically used by the entry object when
2825     * selecting text.
2826     *
2827     * 2. To totally freeze scrolling. This means it stops. until
2828     * popped/released.
2829     *
2830     * @{
2831     */
2832
2833    /**
2834     * Push the scroll hold by 1
2835     *
2836     * This increments the scroll hold count by one. If it is more than 0 it will
2837     * take effect on the parents of the indicated object.
2838     *
2839     * @param obj The object
2840     * @ingroup Scrollhints
2841     */
2842    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2843
2844    /**
2845     * Pop the scroll hold by 1
2846     *
2847     * This decrements the scroll hold count by one. If it is more than 0 it will
2848     * take effect on the parents of the indicated object.
2849     *
2850     * @param obj The object
2851     * @ingroup Scrollhints
2852     */
2853    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2854
2855    /**
2856     * Push the scroll freeze by 1
2857     *
2858     * This increments the scroll freeze count by one. If it is more
2859     * than 0 it will take effect on the parents of the indicated
2860     * object.
2861     *
2862     * @param obj The object
2863     * @ingroup Scrollhints
2864     */
2865    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2866
2867    /**
2868     * Pop the scroll freeze by 1
2869     *
2870     * This decrements the scroll freeze count by one. If it is more
2871     * than 0 it will take effect on the parents of the indicated
2872     * object.
2873     *
2874     * @param obj The object
2875     * @ingroup Scrollhints
2876     */
2877    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2878
2879    /**
2880     * Lock the scrolling of the given widget (and thus all parents)
2881     *
2882     * This locks the given object from scrolling in the X axis (and implicitly
2883     * also locks all parent scrollers too from doing the same).
2884     *
2885     * @param obj The object
2886     * @param lock The lock state (1 == locked, 0 == unlocked)
2887     * @ingroup Scrollhints
2888     */
2889    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2890
2891    /**
2892     * Lock the scrolling of the given widget (and thus all parents)
2893     *
2894     * This locks the given object from scrolling in the Y axis (and implicitly
2895     * also locks all parent scrollers too from doing the same).
2896     *
2897     * @param obj The object
2898     * @param lock The lock state (1 == locked, 0 == unlocked)
2899     * @ingroup Scrollhints
2900     */
2901    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2902
2903    /**
2904     * Get the scrolling lock of the given widget
2905     *
2906     * This gets the lock for X axis scrolling.
2907     *
2908     * @param obj The object
2909     * @ingroup Scrollhints
2910     */
2911    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2912
2913    /**
2914     * Get the scrolling lock of the given widget
2915     *
2916     * This gets the lock for X axis scrolling.
2917     *
2918     * @param obj The object
2919     * @ingroup Scrollhints
2920     */
2921    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2922
2923    /**
2924     * @}
2925     */
2926
2927    /**
2928     * Send a signal to the widget edje object.
2929     *
2930     * This function sends a signal to the edje object of the obj. An
2931     * edje program can respond to a signal by specifying matching
2932     * 'signal' and 'source' fields.
2933     *
2934     * @param obj The object
2935     * @param emission The signal's name.
2936     * @param source The signal's source.
2937     * @ingroup General
2938     */
2939    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2940
2941    /**
2942     * Add a callback for a signal emitted by widget edje object.
2943     *
2944     * This function connects a callback function to a signal emitted by the
2945     * edje object of the obj.
2946     * Globs can occur in either the emission or source name.
2947     *
2948     * @param obj The object
2949     * @param emission The signal's name.
2950     * @param source The signal's source.
2951     * @param func The callback function to be executed when the signal is
2952     * emitted.
2953     * @param data A pointer to data to pass in to the callback function.
2954     * @ingroup General
2955     */
2956    EAPI void             elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
2957
2958    /**
2959     * Remove a signal-triggered callback from a widget edje object.
2960     *
2961     * This function removes a callback, previoulsy attached to a
2962     * signal emitted by the edje object of the obj.  The parameters
2963     * emission, source and func must match exactly those passed to a
2964     * previous call to elm_object_signal_callback_add(). The data
2965     * pointer that was passed to this call will be returned.
2966     *
2967     * @param obj The object
2968     * @param emission The signal's name.
2969     * @param source The signal's source.
2970     * @param func The callback function to be executed when the signal is
2971     * emitted.
2972     * @return The data pointer
2973     * @ingroup General
2974     */
2975    EAPI void            *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
2976
2977    /**
2978     * Add a callback for input events (key up, key down, mouse wheel)
2979     * on a given Elementary widget
2980     *
2981     * @param obj The widget to add an event callback on
2982     * @param func The callback function to be executed when the event
2983     * happens
2984     * @param data Data to pass in to @p func
2985     *
2986     * Every widget in an Elementary interface set to receive focus,
2987     * with elm_object_focus_allow_set(), will propagate @b all of its
2988     * key up, key down and mouse wheel input events up to its parent
2989     * object, and so on. All of the focusable ones in this chain which
2990     * had an event callback set, with this call, will be able to treat
2991     * those events. There are two ways of making the propagation of
2992     * these event upwards in the tree of widgets to @b cease:
2993     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2994     *   the event was @b not processed, so the propagation will go on.
2995     * - The @c event_info pointer passed to @p func will contain the
2996     *   event's structure and, if you OR its @c event_flags inner
2997     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2998     *   one has already handled it, thus killing the event's
2999     *   propagation, too.
3000     *
3001     * @note Your event callback will be issued on those events taking
3002     * place only if no other child widget of @obj has consumed the
3003     * event already.
3004     *
3005     * @note Not to be confused with @c
3006     * evas_object_event_callback_add(), which will add event callbacks
3007     * per type on general Evas objects (no event propagation
3008     * infrastructure taken in account).
3009     *
3010     * @note Not to be confused with @c
3011     * elm_object_signal_callback_add(), which will add callbacks to @b
3012     * signals coming from a widget's theme, not input events.
3013     *
3014     * @note Not to be confused with @c
3015     * edje_object_signal_callback_add(), which does the same as
3016     * elm_object_signal_callback_add(), but directly on an Edje
3017     * object.
3018     *
3019     * @note Not to be confused with @c
3020     * evas_object_smart_callback_add(), which adds callbacks to smart
3021     * objects' <b>smart events</b>, and not input events.
3022     *
3023     * @see elm_object_event_callback_del()
3024     *
3025     * @ingroup General
3026     */
3027    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3028
3029    /**
3030     * Remove an event callback from a widget.
3031     *
3032     * This function removes a callback, previoulsy attached to event emission
3033     * by the @p obj.
3034     * The parameters func and data must match exactly those passed to
3035     * a previous call to elm_object_event_callback_add(). The data pointer that
3036     * was passed to this call will be returned.
3037     *
3038     * @param obj The object
3039     * @param func The callback function to be executed when the event is
3040     * emitted.
3041     * @param data Data to pass in to the callback function.
3042     * @return The data pointer
3043     * @ingroup General
3044     */
3045    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3046
3047    /**
3048     * Adjust size of an element for finger usage.
3049     *
3050     * @param times_w How many fingers should fit horizontally
3051     * @param w Pointer to the width size to adjust
3052     * @param times_h How many fingers should fit vertically
3053     * @param h Pointer to the height size to adjust
3054     *
3055     * This takes width and height sizes (in pixels) as input and a
3056     * size multiple (which is how many fingers you want to place
3057     * within the area, being "finger" the size set by
3058     * elm_finger_size_set()), and adjusts the size to be large enough
3059     * to accommodate the resulting size -- if it doesn't already
3060     * accommodate it. On return the @p w and @p h sizes pointed to by
3061     * these parameters will be modified, on those conditions.
3062     *
3063     * @note This is kind of a low level Elementary call, most useful
3064     * on size evaluation times for widgets. An external user wouldn't
3065     * be calling, most of the time.
3066     *
3067     * @ingroup Fingers
3068     */
3069    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3070
3071    /**
3072     * Get the duration for occuring long press event.
3073     *
3074     * @return Timeout for long press event
3075     * @ingroup Longpress
3076     */
3077    EAPI double           elm_longpress_timeout_get(void);
3078
3079    /**
3080     * Set the duration for occuring long press event.
3081     *
3082     * @param lonpress_timeout Timeout for long press event
3083     * @ingroup Longpress
3084     */
3085    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3086
3087    /**
3088     * @defgroup Debug Debug
3089     * don't use it unless you are sure
3090     *
3091     * @{
3092     */
3093
3094    /**
3095     * Print Tree object hierarchy in stdout
3096     *
3097     * @param obj The root object
3098     * @ingroup Debug
3099     */
3100    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3101
3102    /**
3103     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3104     *
3105     * @param obj The root object
3106     * @param file The path of output file
3107     * @ingroup Debug
3108     */
3109    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3110
3111    /**
3112     * @}
3113     */
3114
3115    /**
3116     * @defgroup Theme Theme
3117     *
3118     * Elementary uses Edje to theme its widgets, naturally. But for the most
3119     * part this is hidden behind a simpler interface that lets the user set
3120     * extensions and choose the style of widgets in a much easier way.
3121     *
3122     * Instead of thinking in terms of paths to Edje files and their groups
3123     * each time you want to change the appearance of a widget, Elementary
3124     * works so you can add any theme file with extensions or replace the
3125     * main theme at one point in the application, and then just set the style
3126     * of widgets with elm_object_style_set() and related functions. Elementary
3127     * will then look in its list of themes for a matching group and apply it,
3128     * and when the theme changes midway through the application, all widgets
3129     * will be updated accordingly.
3130     *
3131     * There are three concepts you need to know to understand how Elementary
3132     * theming works: default theme, extensions and overlays.
3133     *
3134     * Default theme, obviously enough, is the one that provides the default
3135     * look of all widgets. End users can change the theme used by Elementary
3136     * by setting the @c ELM_THEME environment variable before running an
3137     * application, or globally for all programs using the @c elementary_config
3138     * utility. Applications can change the default theme using elm_theme_set(),
3139     * but this can go against the user wishes, so it's not an adviced practice.
3140     *
3141     * Ideally, applications should find everything they need in the already
3142     * provided theme, but there may be occasions when that's not enough and
3143     * custom styles are required to correctly express the idea. For this
3144     * cases, Elementary has extensions.
3145     *
3146     * Extensions allow the application developer to write styles of its own
3147     * to apply to some widgets. This requires knowledge of how each widget
3148     * is themed, as extensions will always replace the entire group used by
3149     * the widget, so important signals and parts need to be there for the
3150     * object to behave properly (see documentation of Edje for details).
3151     * Once the theme for the extension is done, the application needs to add
3152     * it to the list of themes Elementary will look into, using
3153     * elm_theme_extension_add(), and set the style of the desired widgets as
3154     * he would normally with elm_object_style_set().
3155     *
3156     * Overlays, on the other hand, can replace the look of all widgets by
3157     * overriding the default style. Like extensions, it's up to the application
3158     * developer to write the theme for the widgets it wants, the difference
3159     * being that when looking for the theme, Elementary will check first the
3160     * list of overlays, then the set theme and lastly the list of extensions,
3161     * so with overlays it's possible to replace the default view and every
3162     * widget will be affected. This is very much alike to setting the whole
3163     * theme for the application and will probably clash with the end user
3164     * options, not to mention the risk of ending up with not matching styles
3165     * across the program. Unless there's a very special reason to use them,
3166     * overlays should be avoided for the resons exposed before.
3167     *
3168     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3169     * keeps one default internally and every function that receives one of
3170     * these can be called with NULL to refer to this default (except for
3171     * elm_theme_free()). It's possible to create a new instance of a
3172     * ::Elm_Theme to set other theme for a specific widget (and all of its
3173     * children), but this is as discouraged, if not even more so, than using
3174     * overlays. Don't use this unless you really know what you are doing.
3175     *
3176     * But to be less negative about things, you can look at the following
3177     * examples:
3178     * @li @ref theme_example_01 "Using extensions"
3179     * @li @ref theme_example_02 "Using overlays"
3180     *
3181     * @{
3182     */
3183    /**
3184     * @typedef Elm_Theme
3185     *
3186     * Opaque handler for the list of themes Elementary looks for when
3187     * rendering widgets.
3188     *
3189     * Stay out of this unless you really know what you are doing. For most
3190     * cases, sticking to the default is all a developer needs.
3191     */
3192    typedef struct _Elm_Theme Elm_Theme;
3193
3194    /**
3195     * Create a new specific theme
3196     *
3197     * This creates an empty specific theme that only uses the default theme. A
3198     * specific theme has its own private set of extensions and overlays too
3199     * (which are empty by default). Specific themes do not fall back to themes
3200     * of parent objects. They are not intended for this use. Use styles, overlays
3201     * and extensions when needed, but avoid specific themes unless there is no
3202     * other way (example: you want to have a preview of a new theme you are
3203     * selecting in a "theme selector" window. The preview is inside a scroller
3204     * and should display what the theme you selected will look like, but not
3205     * actually apply it yet. The child of the scroller will have a specific
3206     * theme set to show this preview before the user decides to apply it to all
3207     * applications).
3208     */
3209    EAPI Elm_Theme       *elm_theme_new(void);
3210    /**
3211     * Free a specific theme
3212     *
3213     * @param th The theme to free
3214     *
3215     * This frees a theme created with elm_theme_new().
3216     */
3217    EAPI void             elm_theme_free(Elm_Theme *th);
3218    /**
3219     * Copy the theme fom the source to the destination theme
3220     *
3221     * @param th The source theme to copy from
3222     * @param thdst The destination theme to copy data to
3223     *
3224     * This makes a one-time static copy of all the theme config, extensions
3225     * and overlays from @p th to @p thdst. If @p th references a theme, then
3226     * @p thdst is also set to reference it, with all the theme settings,
3227     * overlays and extensions that @p th had.
3228     */
3229    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3230    /**
3231     * Tell the source theme to reference the ref theme
3232     *
3233     * @param th The theme that will do the referencing
3234     * @param thref The theme that is the reference source
3235     *
3236     * This clears @p th to be empty and then sets it to refer to @p thref
3237     * so @p th acts as an override to @p thref, but where its overrides
3238     * don't apply, it will fall through to @p thref for configuration.
3239     */
3240    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3241    /**
3242     * Return the theme referred to
3243     *
3244     * @param th The theme to get the reference from
3245     * @return The referenced theme handle
3246     *
3247     * This gets the theme set as the reference theme by elm_theme_ref_set().
3248     * If no theme is set as a reference, NULL is returned.
3249     */
3250    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3251    /**
3252     * Return the default theme
3253     *
3254     * @return The default theme handle
3255     *
3256     * This returns the internal default theme setup handle that all widgets
3257     * use implicitly unless a specific theme is set. This is also often use
3258     * as a shorthand of NULL.
3259     */
3260    EAPI Elm_Theme       *elm_theme_default_get(void);
3261    /**
3262     * Prepends a theme overlay to the list of overlays
3263     *
3264     * @param th The theme to add to, or if NULL, the default theme
3265     * @param item The Edje file path to be used
3266     *
3267     * Use this if your application needs to provide some custom overlay theme
3268     * (An Edje file that replaces some default styles of widgets) where adding
3269     * new styles, or changing system theme configuration is not possible. Do
3270     * NOT use this instead of a proper system theme configuration. Use proper
3271     * configuration files, profiles, environment variables etc. to set a theme
3272     * so that the theme can be altered by simple confiugration by a user. Using
3273     * this call to achieve that effect is abusing the API and will create lots
3274     * of trouble.
3275     *
3276     * @see elm_theme_extension_add()
3277     */
3278    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3279    /**
3280     * Delete a theme overlay from the list of overlays
3281     *
3282     * @param th The theme to delete from, or if NULL, the default theme
3283     * @param item The name of the theme overlay
3284     *
3285     * @see elm_theme_overlay_add()
3286     */
3287    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3288    /**
3289     * Appends a theme extension to the list of extensions.
3290     *
3291     * @param th The theme to add to, or if NULL, the default theme
3292     * @param item The Edje file path to be used
3293     *
3294     * This is intended when an application needs more styles of widgets or new
3295     * widget themes that the default does not provide (or may not provide). The
3296     * application has "extended" usage by coming up with new custom style names
3297     * for widgets for specific uses, but as these are not "standard", they are
3298     * not guaranteed to be provided by a default theme. This means the
3299     * application is required to provide these extra elements itself in specific
3300     * Edje files. This call adds one of those Edje files to the theme search
3301     * path to be search after the default theme. The use of this call is
3302     * encouraged when default styles do not meet the needs of the application.
3303     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3304     *
3305     * @see elm_object_style_set()
3306     */
3307    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3308    /**
3309     * Deletes a theme extension from the list of extensions.
3310     *
3311     * @param th The theme to delete from, or if NULL, the default theme
3312     * @param item The name of the theme extension
3313     *
3314     * @see elm_theme_extension_add()
3315     */
3316    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3317    /**
3318     * Set the theme search order for the given theme
3319     *
3320     * @param th The theme to set the search order, or if NULL, the default theme
3321     * @param theme Theme search string
3322     *
3323     * This sets the search string for the theme in path-notation from first
3324     * theme to search, to last, delimited by the : character. Example:
3325     *
3326     * "shiny:/path/to/file.edj:default"
3327     *
3328     * See the ELM_THEME environment variable for more information.
3329     *
3330     * @see elm_theme_get()
3331     * @see elm_theme_list_get()
3332     */
3333    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3334    /**
3335     * Return the theme search order
3336     *
3337     * @param th The theme to get the search order, or if NULL, the default theme
3338     * @return The internal search order path
3339     *
3340     * This function returns a colon separated string of theme elements as
3341     * returned by elm_theme_list_get().
3342     *
3343     * @see elm_theme_set()
3344     * @see elm_theme_list_get()
3345     */
3346    EAPI const char      *elm_theme_get(Elm_Theme *th);
3347    /**
3348     * Return a list of theme elements to be used in a theme.
3349     *
3350     * @param th Theme to get the list of theme elements from.
3351     * @return The internal list of theme elements
3352     *
3353     * This returns the internal list of theme elements (will only be valid as
3354     * long as the theme is not modified by elm_theme_set() or theme is not
3355     * freed by elm_theme_free(). This is a list of strings which must not be
3356     * altered as they are also internal. If @p th is NULL, then the default
3357     * theme element list is returned.
3358     *
3359     * A theme element can consist of a full or relative path to a .edj file,
3360     * or a name, without extension, for a theme to be searched in the known
3361     * theme paths for Elemementary.
3362     *
3363     * @see elm_theme_set()
3364     * @see elm_theme_get()
3365     */
3366    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3367    /**
3368     * Return the full patrh for a theme element
3369     *
3370     * @param f The theme element name
3371     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3372     * @return The full path to the file found.
3373     *
3374     * This returns a string you should free with free() on success, NULL on
3375     * failure. This will search for the given theme element, and if it is a
3376     * full or relative path element or a simple searchable name. The returned
3377     * path is the full path to the file, if searched, and the file exists, or it
3378     * is simply the full path given in the element or a resolved path if
3379     * relative to home. The @p in_search_path boolean pointed to is set to
3380     * EINA_TRUE if the file was a searchable file andis in the search path,
3381     * and EINA_FALSE otherwise.
3382     */
3383    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3384    /**
3385     * Flush the current theme.
3386     *
3387     * @param th Theme to flush
3388     *
3389     * This flushes caches that let elementary know where to find theme elements
3390     * in the given theme. If @p th is NULL, then the default theme is flushed.
3391     * Call this function if source theme data has changed in such a way as to
3392     * make any caches Elementary kept invalid.
3393     */
3394    EAPI void             elm_theme_flush(Elm_Theme *th);
3395    /**
3396     * This flushes all themes (default and specific ones).
3397     *
3398     * This will flush all themes in the current application context, by calling
3399     * elm_theme_flush() on each of them.
3400     */
3401    EAPI void             elm_theme_full_flush(void);
3402    /**
3403     * Set the theme for all elementary using applications on the current display
3404     *
3405     * @param theme The name of the theme to use. Format same as the ELM_THEME
3406     * environment variable.
3407     */
3408    EAPI void             elm_theme_all_set(const char *theme);
3409    /**
3410     * Return a list of theme elements in the theme search path
3411     *
3412     * @return A list of strings that are the theme element names.
3413     *
3414     * This lists all available theme files in the standard Elementary search path
3415     * for theme elements, and returns them in alphabetical order as theme
3416     * element names in a list of strings. Free this with
3417     * elm_theme_name_available_list_free() when you are done with the list.
3418     */
3419    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3420    /**
3421     * Free the list returned by elm_theme_name_available_list_new()
3422     *
3423     * This frees the list of themes returned by
3424     * elm_theme_name_available_list_new(). Once freed the list should no longer
3425     * be used. a new list mys be created.
3426     */
3427    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3428    /**
3429     * Set a specific theme to be used for this object and its children
3430     *
3431     * @param obj The object to set the theme on
3432     * @param th The theme to set
3433     *
3434     * This sets a specific theme that will be used for the given object and any
3435     * child objects it has. If @p th is NULL then the theme to be used is
3436     * cleared and the object will inherit its theme from its parent (which
3437     * ultimately will use the default theme if no specific themes are set).
3438     *
3439     * Use special themes with great care as this will annoy users and make
3440     * configuration difficult. Avoid any custom themes at all if it can be
3441     * helped.
3442     */
3443    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3444    /**
3445     * Get the specific theme to be used
3446     *
3447     * @param obj The object to get the specific theme from
3448     * @return The specifc theme set.
3449     *
3450     * This will return a specific theme set, or NULL if no specific theme is
3451     * set on that object. It will not return inherited themes from parents, only
3452     * the specific theme set for that specific object. See elm_object_theme_set()
3453     * for more information.
3454     */
3455    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3456
3457    /**
3458     * Get a data item from a theme
3459     *
3460     * @param th The theme, or NULL for default theme
3461     * @param key The data key to search with
3462     * @return The data value, or NULL on failure
3463     *
3464     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3465     * It works the same way as edje_file_data_get() except that the return is stringshared.
3466     */
3467    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3468    /**
3469     * @}
3470     */
3471
3472    /* win */
3473    /** @defgroup Win Win
3474     *
3475     * @image html img/widget/win/preview-00.png
3476     * @image latex img/widget/win/preview-00.eps
3477     *
3478     * The window class of Elementary.  Contains functions to manipulate
3479     * windows. The Evas engine used to render the window contents is specified
3480     * in the system or user elementary config files (whichever is found last),
3481     * and can be overridden with the ELM_ENGINE environment variable for
3482     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3483     * compilation setup and modules actually installed at runtime) are (listed
3484     * in order of best supported and most likely to be complete and work to
3485     * lowest quality).
3486     *
3487     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3488     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3489     * rendering in X11)
3490     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3491     * exits)
3492     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3493     * rendering)
3494     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3495     * buffer)
3496     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3497     * rendering using SDL as the buffer)
3498     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3499     * GDI with software)
3500     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3501     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3502     * grayscale using dedicated 8bit software engine in X11)
3503     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3504     * X11 using 16bit software engine)
3505     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3506     * (Windows CE rendering via GDI with 16bit software renderer)
3507     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3508     * buffer with 16bit software renderer)
3509     *
3510     * All engines use a simple string to select the engine to render, EXCEPT
3511     * the "shot" engine. This actually encodes the output of the virtual
3512     * screenshot and how long to delay in the engine string. The engine string
3513     * is encoded in the following way:
3514     *
3515     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3516     *
3517     * Where options are separated by a ":" char if more than one option is
3518     * given, with delay, if provided being the first option and file the last
3519     * (order is important). The delay specifies how long to wait after the
3520     * window is shown before doing the virtual "in memory" rendering and then
3521     * save the output to the file specified by the file option (and then exit).
3522     * If no delay is given, the default is 0.5 seconds. If no file is given the
3523     * default output file is "out.png". Repeat option is for continous
3524     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3525     * fixed to "out001.png" Some examples of using the shot engine:
3526     *
3527     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3528     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3529     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3530     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3531     *   ELM_ENGINE="shot:" elementary_test
3532     *
3533     * Signals that you can add callbacks for are:
3534     *
3535     * @li "delete,request": the user requested to close the window. See
3536     * elm_win_autodel_set().
3537     * @li "focus,in": window got focus
3538     * @li "focus,out": window lost focus
3539     * @li "moved": window that holds the canvas was moved
3540     *
3541     * Examples:
3542     * @li @ref win_example_01
3543     *
3544     * @{
3545     */
3546    /**
3547     * Defines the types of window that can be created
3548     *
3549     * These are hints set on the window so that a running Window Manager knows
3550     * how the window should be handled and/or what kind of decorations it
3551     * should have.
3552     *
3553     * Currently, only the X11 backed engines use them.
3554     */
3555    typedef enum _Elm_Win_Type
3556      {
3557         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3558                          window. Almost every window will be created with this
3559                          type. */
3560         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3561         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3562                            window holding desktop icons. */
3563         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3564                         be kept on top of any other window by the Window
3565                         Manager. */
3566         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3567                            similar. */
3568         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3569         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3570                            pallete. */
3571         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3572         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3573                                  entry in a menubar is clicked. Typically used
3574                                  with elm_win_override_set(). This hint exists
3575                                  for completion only, as the EFL way of
3576                                  implementing a menu would not normally use a
3577                                  separate window for its contents. */
3578         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3579                               triggered by right-clicking an object. */
3580         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3581                            explanatory text that typically appear after the
3582                            mouse cursor hovers over an object for a while.
3583                            Typically used with elm_win_override_set() and also
3584                            not very commonly used in the EFL. */
3585         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3586                                 battery life or a new E-Mail received. */
3587         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3588                          usually used in the EFL. */
3589         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3590                        object being dragged across different windows, or even
3591                        applications. Typically used with
3592                        elm_win_override_set(). */
3593         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3594                                  buffer. No actual window is created for this
3595                                  type, instead the window and all of its
3596                                  contents will be rendered to an image buffer.
3597                                  This allows to have children window inside a
3598                                  parent one just like any other object would
3599                                  be, and do other things like applying @c
3600                                  Evas_Map effects to it. This is the only type
3601                                  of window that requires the @c parent
3602                                  parameter of elm_win_add() to be a valid @c
3603                                  Evas_Object. */
3604      } Elm_Win_Type;
3605
3606    /**
3607     * The differents layouts that can be requested for the virtual keyboard.
3608     *
3609     * When the application window is being managed by Illume, it may request
3610     * any of the following layouts for the virtual keyboard.
3611     */
3612    typedef enum _Elm_Win_Keyboard_Mode
3613      {
3614         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3615         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3616         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3617         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3618         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3619         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3620         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3621         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3622         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3623         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3624         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3625         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3626         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3627         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3628         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3629         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3630      } Elm_Win_Keyboard_Mode;
3631
3632    /**
3633     * Available commands that can be sent to the Illume manager.
3634     *
3635     * When running under an Illume session, a window may send commands to the
3636     * Illume manager to perform different actions.
3637     */
3638    typedef enum _Elm_Illume_Command
3639      {
3640         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3641                                          window */
3642         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3643                                             in the list */
3644         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3645                                          screen */
3646         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3647      } Elm_Illume_Command;
3648
3649    /**
3650     * Adds a window object. If this is the first window created, pass NULL as
3651     * @p parent.
3652     *
3653     * @param parent Parent object to add the window to, or NULL
3654     * @param name The name of the window
3655     * @param type The window type, one of #Elm_Win_Type.
3656     *
3657     * The @p parent paramter can be @c NULL for every window @p type except
3658     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3659     * which the image object will be created.
3660     *
3661     * @return The created object, or NULL on failure
3662     */
3663    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3664    /**
3665     * Add @p subobj as a resize object of window @p obj.
3666     *
3667     *
3668     * Setting an object as a resize object of the window means that the
3669     * @p subobj child's size and position will be controlled by the window
3670     * directly. That is, the object will be resized to match the window size
3671     * and should never be moved or resized manually by the developer.
3672     *
3673     * In addition, resize objects of the window control what the minimum size
3674     * of it will be, as well as whether it can or not be resized by the user.
3675     *
3676     * For the end user to be able to resize a window by dragging the handles
3677     * or borders provided by the Window Manager, or using any other similar
3678     * mechanism, all of the resize objects in the window should have their
3679     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3680     *
3681     * @param obj The window object
3682     * @param subobj The resize object to add
3683     */
3684    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3685    /**
3686     * Delete @p subobj as a resize object of window @p obj.
3687     *
3688     * This function removes the object @p subobj from the resize objects of
3689     * the window @p obj. It will not delete the object itself, which will be
3690     * left unmanaged and should be deleted by the developer, manually handled
3691     * or set as child of some other container.
3692     *
3693     * @param obj The window object
3694     * @param subobj The resize object to add
3695     */
3696    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3697    /**
3698     * Set the title of the window
3699     *
3700     * @param obj The window object
3701     * @param title The title to set
3702     */
3703    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3704    /**
3705     * Get the title of the window
3706     *
3707     * The returned string is an internal one and should not be freed or
3708     * modified. It will also be rendered invalid if a new title is set or if
3709     * the window is destroyed.
3710     *
3711     * @param obj The window object
3712     * @return The title
3713     */
3714    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3715    /**
3716     * Set the window's autodel state.
3717     *
3718     * When closing the window in any way outside of the program control, like
3719     * pressing the X button in the titlebar or using a command from the
3720     * Window Manager, a "delete,request" signal is emitted to indicate that
3721     * this event occurred and the developer can take any action, which may
3722     * include, or not, destroying the window object.
3723     *
3724     * When the @p autodel parameter is set, the window will be automatically
3725     * destroyed when this event occurs, after the signal is emitted.
3726     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3727     * and is up to the program to do so when it's required.
3728     *
3729     * @param obj The window object
3730     * @param autodel If true, the window will automatically delete itself when
3731     * closed
3732     */
3733    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3734    /**
3735     * Get the window's autodel state.
3736     *
3737     * @param obj The window object
3738     * @return If the window will automatically delete itself when closed
3739     *
3740     * @see elm_win_autodel_set()
3741     */
3742    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3743    /**
3744     * Activate a window object.
3745     *
3746     * This function sends a request to the Window Manager to activate the
3747     * window pointed by @p obj. If honored by the WM, the window will receive
3748     * the keyboard focus.
3749     *
3750     * @note This is just a request that a Window Manager may ignore, so calling
3751     * this function does not ensure in any way that the window will be the
3752     * active one after it.
3753     *
3754     * @param obj The window object
3755     */
3756    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3757    /**
3758     * Lower a window object.
3759     *
3760     * Places the window pointed by @p obj at the bottom of the stack, so that
3761     * no other window is covered by it.
3762     *
3763     * If elm_win_override_set() is not set, the Window Manager may ignore this
3764     * request.
3765     *
3766     * @param obj The window object
3767     */
3768    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3769    /**
3770     * Raise a window object.
3771     *
3772     * Places the window pointed by @p obj at the top of the stack, so that it's
3773     * not covered by any other window.
3774     *
3775     * If elm_win_override_set() is not set, the Window Manager may ignore this
3776     * request.
3777     *
3778     * @param obj The window object
3779     */
3780    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3781    /**
3782     * Set the borderless state of a window.
3783     *
3784     * This function requests the Window Manager to not draw any decoration
3785     * around the window.
3786     *
3787     * @param obj The window object
3788     * @param borderless If true, the window is borderless
3789     */
3790    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3791    /**
3792     * Get the borderless state of a window.
3793     *
3794     * @param obj The window object
3795     * @return If true, the window is borderless
3796     */
3797    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3798    /**
3799     * Set the shaped state of a window.
3800     *
3801     * Shaped windows, when supported, will render the parts of the window that
3802     * has no content, transparent.
3803     *
3804     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3805     * background object or cover the entire window in any other way, or the
3806     * parts of the canvas that have no data will show framebuffer artifacts.
3807     *
3808     * @param obj The window object
3809     * @param shaped If true, the window is shaped
3810     *
3811     * @see elm_win_alpha_set()
3812     */
3813    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3814    /**
3815     * Get the shaped state of a window.
3816     *
3817     * @param obj The window object
3818     * @return If true, the window is shaped
3819     *
3820     * @see elm_win_shaped_set()
3821     */
3822    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3823    /**
3824     * Set the alpha channel state of a window.
3825     *
3826     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3827     * possibly making parts of the window completely or partially transparent.
3828     * This is also subject to the underlying system supporting it, like for
3829     * example, running under a compositing manager. If no compositing is
3830     * available, enabling this option will instead fallback to using shaped
3831     * windows, with elm_win_shaped_set().
3832     *
3833     * @param obj The window object
3834     * @param alpha If true, the window has an alpha channel
3835     *
3836     * @see elm_win_alpha_set()
3837     */
3838    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3839    /**
3840     * Get the transparency state of a window.
3841     *
3842     * @param obj The window object
3843     * @return If true, the window is transparent
3844     *
3845     * @see elm_win_transparent_set()
3846     */
3847    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3848    /**
3849     * Set the transparency state of a window.
3850     *
3851     * Use elm_win_alpha_set() instead.
3852     *
3853     * @param obj The window object
3854     * @param transparent If true, the window is transparent
3855     *
3856     * @see elm_win_alpha_set()
3857     */
3858    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3859    /**
3860     * Get the alpha channel state of a window.
3861     *
3862     * @param obj The window object
3863     * @return If true, the window has an alpha channel
3864     */
3865    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3866    /**
3867     * Set the override state of a window.
3868     *
3869     * A window with @p override set to EINA_TRUE will not be managed by the
3870     * Window Manager. This means that no decorations of any kind will be shown
3871     * for it, moving and resizing must be handled by the application, as well
3872     * as the window visibility.
3873     *
3874     * This should not be used for normal windows, and even for not so normal
3875     * ones, it should only be used when there's a good reason and with a lot
3876     * of care. Mishandling override windows may result situations that
3877     * disrupt the normal workflow of the end user.
3878     *
3879     * @param obj The window object
3880     * @param override If true, the window is overridden
3881     */
3882    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3883    /**
3884     * Get the override state of a window.
3885     *
3886     * @param obj The window object
3887     * @return If true, the window is overridden
3888     *
3889     * @see elm_win_override_set()
3890     */
3891    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3892    /**
3893     * Set the fullscreen state of a window.
3894     *
3895     * @param obj The window object
3896     * @param fullscreen If true, the window is fullscreen
3897     */
3898    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3899    /**
3900     * Get the fullscreen state of a window.
3901     *
3902     * @param obj The window object
3903     * @return If true, the window is fullscreen
3904     */
3905    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3906    /**
3907     * Set the maximized state of a window.
3908     *
3909     * @param obj The window object
3910     * @param maximized If true, the window is maximized
3911     */
3912    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3913    /**
3914     * Get the maximized state of a window.
3915     *
3916     * @param obj The window object
3917     * @return If true, the window is maximized
3918     */
3919    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3920    /**
3921     * Set the iconified state of a window.
3922     *
3923     * @param obj The window object
3924     * @param iconified If true, the window is iconified
3925     */
3926    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3927    /**
3928     * Get the iconified state of a window.
3929     *
3930     * @param obj The window object
3931     * @return If true, the window is iconified
3932     */
3933    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3934    /**
3935     * Set the layer of the window.
3936     *
3937     * What this means exactly will depend on the underlying engine used.
3938     *
3939     * In the case of X11 backed engines, the value in @p layer has the
3940     * following meanings:
3941     * @li < 3: The window will be placed below all others.
3942     * @li > 5: The window will be placed above all others.
3943     * @li other: The window will be placed in the default layer.
3944     *
3945     * @param obj The window object
3946     * @param layer The layer of the window
3947     */
3948    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3949    /**
3950     * Get the layer of the window.
3951     *
3952     * @param obj The window object
3953     * @return The layer of the window
3954     *
3955     * @see elm_win_layer_set()
3956     */
3957    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3958    /**
3959     * Set the rotation of the window.
3960     *
3961     * Most engines only work with multiples of 90.
3962     *
3963     * This function is used to set the orientation of the window @p obj to
3964     * match that of the screen. The window itself will be resized to adjust
3965     * to the new geometry of its contents. If you want to keep the window size,
3966     * see elm_win_rotation_with_resize_set().
3967     *
3968     * @param obj The window object
3969     * @param rotation The rotation of the window, in degrees (0-360),
3970     * counter-clockwise.
3971     */
3972    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3973    /**
3974     * Rotates the window and resizes it.
3975     *
3976     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3977     * that they fit inside the current window geometry.
3978     *
3979     * @param obj The window object
3980     * @param layer The rotation of the window in degrees (0-360),
3981     * counter-clockwise.
3982     */
3983    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3984    /**
3985     * Get the rotation of the window.
3986     *
3987     * @param obj The window object
3988     * @return The rotation of the window in degrees (0-360)
3989     *
3990     * @see elm_win_rotation_set()
3991     * @see elm_win_rotation_with_resize_set()
3992     */
3993    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3994    /**
3995     * Set the sticky state of the window.
3996     *
3997     * Hints the Window Manager that the window in @p obj should be left fixed
3998     * at its position even when the virtual desktop it's on moves or changes.
3999     *
4000     * @param obj The window object
4001     * @param sticky If true, the window's sticky state is enabled
4002     */
4003    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4004    /**
4005     * Get the sticky state of the window.
4006     *
4007     * @param obj The window object
4008     * @return If true, the window's sticky state is enabled
4009     *
4010     * @see elm_win_sticky_set()
4011     */
4012    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4013    /**
4014     * Set if this window is an illume conformant window
4015     *
4016     * @param obj The window object
4017     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4018     */
4019    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4020    /**
4021     * Get if this window is an illume conformant window
4022     *
4023     * @param obj The window object
4024     * @return A boolean if this window is illume conformant or not
4025     */
4026    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4027    /**
4028     * Set a window to be an illume quickpanel window
4029     *
4030     * By default window objects are not quickpanel windows.
4031     *
4032     * @param obj The window object
4033     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4034     */
4035    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4036    /**
4037     * Get if this window is a quickpanel or not
4038     *
4039     * @param obj The window object
4040     * @return A boolean if this window is a quickpanel or not
4041     */
4042    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4043    /**
4044     * Set the major priority of a quickpanel window
4045     *
4046     * @param obj The window object
4047     * @param priority The major priority for this quickpanel
4048     */
4049    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4050    /**
4051     * Get the major priority of a quickpanel window
4052     *
4053     * @param obj The window object
4054     * @return The major priority of this quickpanel
4055     */
4056    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4057    /**
4058     * Set the minor priority of a quickpanel window
4059     *
4060     * @param obj The window object
4061     * @param priority The minor priority for this quickpanel
4062     */
4063    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4064    /**
4065     * Get the minor priority of a quickpanel window
4066     *
4067     * @param obj The window object
4068     * @return The minor priority of this quickpanel
4069     */
4070    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4071    /**
4072     * Set which zone this quickpanel should appear in
4073     *
4074     * @param obj The window object
4075     * @param zone The requested zone for this quickpanel
4076     */
4077    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4078    /**
4079     * Get which zone this quickpanel should appear in
4080     *
4081     * @param obj The window object
4082     * @return The requested zone for this quickpanel
4083     */
4084    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4085    /**
4086     * Set the window to be skipped by keyboard focus
4087     *
4088     * This sets the window to be skipped by normal keyboard input. This means
4089     * a window manager will be asked to not focus this window as well as omit
4090     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4091     *
4092     * Call this and enable it on a window BEFORE you show it for the first time,
4093     * otherwise it may have no effect.
4094     *
4095     * Use this for windows that have only output information or might only be
4096     * interacted with by the mouse or fingers, and never for typing input.
4097     * Be careful that this may have side-effects like making the window
4098     * non-accessible in some cases unless the window is specially handled. Use
4099     * this with care.
4100     *
4101     * @param obj The window object
4102     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4103     */
4104    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4105    /**
4106     * Send a command to the windowing environment
4107     *
4108     * This is intended to work in touchscreen or small screen device
4109     * environments where there is a more simplistic window management policy in
4110     * place. This uses the window object indicated to select which part of the
4111     * environment to control (the part that this window lives in), and provides
4112     * a command and an optional parameter structure (use NULL for this if not
4113     * needed).
4114     *
4115     * @param obj The window object that lives in the environment to control
4116     * @param command The command to send
4117     * @param params Optional parameters for the command
4118     */
4119    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4120    /**
4121     * Get the inlined image object handle
4122     *
4123     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4124     * then the window is in fact an evas image object inlined in the parent
4125     * canvas. You can get this object (be careful to not manipulate it as it
4126     * is under control of elementary), and use it to do things like get pixel
4127     * data, save the image to a file, etc.
4128     *
4129     * @param obj The window object to get the inlined image from
4130     * @return The inlined image object, or NULL if none exists
4131     */
4132    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4133    /**
4134     * Set the enabled status for the focus highlight in a window
4135     *
4136     * This function will enable or disable the focus highlight only for the
4137     * given window, regardless of the global setting for it
4138     *
4139     * @param obj The window where to enable the highlight
4140     * @param enabled The enabled value for the highlight
4141     */
4142    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4143    /**
4144     * Get the enabled value of the focus highlight for this window
4145     *
4146     * @param obj The window in which to check if the focus highlight is enabled
4147     *
4148     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4149     */
4150    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4151    /**
4152     * Set the style for the focus highlight on this window
4153     *
4154     * Sets the style to use for theming the highlight of focused objects on
4155     * the given window. If @p style is NULL, the default will be used.
4156     *
4157     * @param obj The window where to set the style
4158     * @param style The style to set
4159     */
4160    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4161    /**
4162     * Get the style set for the focus highlight object
4163     *
4164     * Gets the style set for this windows highilght object, or NULL if none
4165     * is set.
4166     *
4167     * @param obj The window to retrieve the highlights style from
4168     *
4169     * @return The style set or NULL if none was. Default is used in that case.
4170     */
4171    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4172    /*...
4173     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4174     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4175     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4176     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4177     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4178     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4179     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4180     *
4181     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4182     * (blank mouse, private mouse obj, defaultmouse)
4183     *
4184     */
4185    /**
4186     * Sets the keyboard mode of the window.
4187     *
4188     * @param obj The window object
4189     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4190     */
4191    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4192    /**
4193     * Gets the keyboard mode of the window.
4194     *
4195     * @param obj The window object
4196     * @return The mode, one of #Elm_Win_Keyboard_Mode
4197     */
4198    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4199    /**
4200     * Sets whether the window is a keyboard.
4201     *
4202     * @param obj The window object
4203     * @param is_keyboard If true, the window is a virtual keyboard
4204     */
4205    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4206    /**
4207     * Gets whether the window is a keyboard.
4208     *
4209     * @param obj The window object
4210     * @return If the window is a virtual keyboard
4211     */
4212    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4213
4214    /**
4215     * Get the screen position of a window.
4216     *
4217     * @param obj The window object
4218     * @param x The int to store the x coordinate to
4219     * @param y The int to store the y coordinate to
4220     */
4221    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4222    /**
4223     * @}
4224     */
4225
4226    /**
4227     * @defgroup Inwin Inwin
4228     *
4229     * @image html img/widget/inwin/preview-00.png
4230     * @image latex img/widget/inwin/preview-00.eps
4231     * @image html img/widget/inwin/preview-01.png
4232     * @image latex img/widget/inwin/preview-01.eps
4233     * @image html img/widget/inwin/preview-02.png
4234     * @image latex img/widget/inwin/preview-02.eps
4235     *
4236     * An inwin is a window inside a window that is useful for a quick popup.
4237     * It does not hover.
4238     *
4239     * It works by creating an object that will occupy the entire window, so it
4240     * must be created using an @ref Win "elm_win" as parent only. The inwin
4241     * object can be hidden or restacked below every other object if it's
4242     * needed to show what's behind it without destroying it. If this is done,
4243     * the elm_win_inwin_activate() function can be used to bring it back to
4244     * full visibility again.
4245     *
4246     * There are three styles available in the default theme. These are:
4247     * @li default: The inwin is sized to take over most of the window it's
4248     * placed in.
4249     * @li minimal: The size of the inwin will be the minimum necessary to show
4250     * its contents.
4251     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4252     * possible, but it's sized vertically the most it needs to fit its\
4253     * contents.
4254     *
4255     * Some examples of Inwin can be found in the following:
4256     * @li @ref inwin_example_01
4257     *
4258     * @{
4259     */
4260    /**
4261     * Adds an inwin to the current window
4262     *
4263     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4264     * Never call this function with anything other than the top-most window
4265     * as its parameter, unless you are fond of undefined behavior.
4266     *
4267     * After creating the object, the widget will set itself as resize object
4268     * for the window with elm_win_resize_object_add(), so when shown it will
4269     * appear to cover almost the entire window (how much of it depends on its
4270     * content and the style used). It must not be added into other container
4271     * objects and it needs not be moved or resized manually.
4272     *
4273     * @param parent The parent object
4274     * @return The new object or NULL if it cannot be created
4275     */
4276    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4277    /**
4278     * Activates an inwin object, ensuring its visibility
4279     *
4280     * This function will make sure that the inwin @p obj is completely visible
4281     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4282     * to the front. It also sets the keyboard focus to it, which will be passed
4283     * onto its content.
4284     *
4285     * The object's theme will also receive the signal "elm,action,show" with
4286     * source "elm".
4287     *
4288     * @param obj The inwin to activate
4289     */
4290    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4291    /**
4292     * Set the content of an inwin object.
4293     *
4294     * Once the content object is set, a previously set one will be deleted.
4295     * If you want to keep that old content object, use the
4296     * elm_win_inwin_content_unset() function.
4297     *
4298     * @param obj The inwin object
4299     * @param content The object to set as content
4300     */
4301    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4302    /**
4303     * Get the content of an inwin object.
4304     *
4305     * Return the content object which is set for this widget.
4306     *
4307     * The returned object is valid as long as the inwin is still alive and no
4308     * other content is set on it. Deleting the object will notify the inwin
4309     * about it and this one will be left empty.
4310     *
4311     * If you need to remove an inwin's content to be reused somewhere else,
4312     * see elm_win_inwin_content_unset().
4313     *
4314     * @param obj The inwin object
4315     * @return The content that is being used
4316     */
4317    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4318    /**
4319     * Unset the content of an inwin object.
4320     *
4321     * Unparent and return the content object which was set for this widget.
4322     *
4323     * @param obj The inwin object
4324     * @return The content that was being used
4325     */
4326    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4327    /**
4328     * @}
4329     */
4330    /* X specific calls - won't work on non-x engines (return 0) */
4331
4332    /**
4333     * Get the Ecore_X_Window of an Evas_Object
4334     *
4335     * @param obj The object
4336     *
4337     * @return The Ecore_X_Window of @p obj
4338     *
4339     * @ingroup Win
4340     */
4341    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4342
4343    /* smart callbacks called:
4344     * "delete,request" - the user requested to delete the window
4345     * "focus,in" - window got focus
4346     * "focus,out" - window lost focus
4347     * "moved" - window that holds the canvas was moved
4348     */
4349
4350    /**
4351     * @defgroup Bg Bg
4352     *
4353     * @image html img/widget/bg/preview-00.png
4354     * @image latex img/widget/bg/preview-00.eps
4355     *
4356     * @brief Background object, used for setting a solid color, image or Edje
4357     * group as background to a window or any container object.
4358     *
4359     * The bg object is used for setting a solid background to a window or
4360     * packing into any container object. It works just like an image, but has
4361     * some properties useful to a background, like setting it to tiled,
4362     * centered, scaled or stretched.
4363     *
4364     * Here is some sample code using it:
4365     * @li @ref bg_01_example_page
4366     * @li @ref bg_02_example_page
4367     * @li @ref bg_03_example_page
4368     */
4369
4370    /* bg */
4371    typedef enum _Elm_Bg_Option
4372      {
4373         ELM_BG_OPTION_CENTER,  /**< center the background */
4374         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4375         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4376         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4377      } Elm_Bg_Option;
4378
4379    /**
4380     * Add a new background to the parent
4381     *
4382     * @param parent The parent object
4383     * @return The new object or NULL if it cannot be created
4384     *
4385     * @ingroup Bg
4386     */
4387    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4388
4389    /**
4390     * Set the file (image or edje) used for the background
4391     *
4392     * @param obj The bg object
4393     * @param file The file path
4394     * @param group Optional key (group in Edje) within the file
4395     *
4396     * This sets the image file used in the background object. The image (or edje)
4397     * will be stretched (retaining aspect if its an image file) to completely fill
4398     * the bg object. This may mean some parts are not visible.
4399     *
4400     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4401     * even if @p file is NULL.
4402     *
4403     * @ingroup Bg
4404     */
4405    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4406
4407    /**
4408     * Get the file (image or edje) used for the background
4409     *
4410     * @param obj The bg object
4411     * @param file The file path
4412     * @param group Optional key (group in Edje) within the file
4413     *
4414     * @ingroup Bg
4415     */
4416    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4417
4418    /**
4419     * Set the option used for the background image
4420     *
4421     * @param obj The bg object
4422     * @param option The desired background option (TILE, SCALE)
4423     *
4424     * This sets the option used for manipulating the display of the background
4425     * image. The image can be tiled or scaled.
4426     *
4427     * @ingroup Bg
4428     */
4429    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4430
4431    /**
4432     * Get the option used for the background image
4433     *
4434     * @param obj The bg object
4435     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4436     *
4437     * @ingroup Bg
4438     */
4439    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4440    /**
4441     * Set the option used for the background color
4442     *
4443     * @param obj The bg object
4444     * @param r
4445     * @param g
4446     * @param b
4447     *
4448     * This sets the color used for the background rectangle. Its range goes
4449     * from 0 to 255.
4450     *
4451     * @ingroup Bg
4452     */
4453    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4454    /**
4455     * Get the option used for the background color
4456     *
4457     * @param obj The bg object
4458     * @param r
4459     * @param g
4460     * @param b
4461     *
4462     * @ingroup Bg
4463     */
4464    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4465
4466    /**
4467     * Set the overlay object used for the background object.
4468     *
4469     * @param obj The bg object
4470     * @param overlay The overlay object
4471     *
4472     * This provides a way for elm_bg to have an 'overlay' that will be on top
4473     * of the bg. Once the over object is set, a previously set one will be
4474     * deleted, even if you set the new one to NULL. If you want to keep that
4475     * old content object, use the elm_bg_overlay_unset() function.
4476     *
4477     * @ingroup Bg
4478     */
4479
4480    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4481
4482    /**
4483     * Get the overlay object used for the background object.
4484     *
4485     * @param obj The bg object
4486     * @return The content that is being used
4487     *
4488     * Return the content object which is set for this widget
4489     *
4490     * @ingroup Bg
4491     */
4492    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4493
4494    /**
4495     * Get the overlay object used for the background object.
4496     *
4497     * @param obj The bg object
4498     * @return The content that was being used
4499     *
4500     * Unparent and return the overlay object which was set for this widget
4501     *
4502     * @ingroup Bg
4503     */
4504    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4505
4506    /**
4507     * Set the size of the pixmap representation of the image.
4508     *
4509     * This option just makes sense if an image is going to be set in the bg.
4510     *
4511     * @param obj The bg object
4512     * @param w The new width of the image pixmap representation.
4513     * @param h The new height of the image pixmap representation.
4514     *
4515     * This function sets a new size for pixmap representation of the given bg
4516     * image. It allows the image to be loaded already in the specified size,
4517     * reducing the memory usage and load time when loading a big image with load
4518     * size set to a smaller size.
4519     *
4520     * NOTE: this is just a hint, the real size of the pixmap may differ
4521     * depending on the type of image being loaded, being bigger than requested.
4522     *
4523     * @ingroup Bg
4524     */
4525    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4526    /* smart callbacks called:
4527     */
4528
4529    /**
4530     * @defgroup Icon Icon
4531     *
4532     * @image html img/widget/icon/preview-00.png
4533     * @image latex img/widget/icon/preview-00.eps
4534     *
4535     * An object that provides standard icon images (delete, edit, arrows, etc.)
4536     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4537     *
4538     * The icon image requested can be in the elementary theme, or in the
4539     * freedesktop.org paths. It's possible to set the order of preference from
4540     * where the image will be used.
4541     *
4542     * This API is very similar to @ref Image, but with ready to use images.
4543     *
4544     * Default images provided by the theme are described below.
4545     *
4546     * The first list contains icons that were first intended to be used in
4547     * toolbars, but can be used in many other places too:
4548     * @li home
4549     * @li close
4550     * @li apps
4551     * @li arrow_up
4552     * @li arrow_down
4553     * @li arrow_left
4554     * @li arrow_right
4555     * @li chat
4556     * @li clock
4557     * @li delete
4558     * @li edit
4559     * @li refresh
4560     * @li folder
4561     * @li file
4562     *
4563     * Now some icons that were designed to be used in menus (but again, you can
4564     * use them anywhere else):
4565     * @li menu/home
4566     * @li menu/close
4567     * @li menu/apps
4568     * @li menu/arrow_up
4569     * @li menu/arrow_down
4570     * @li menu/arrow_left
4571     * @li menu/arrow_right
4572     * @li menu/chat
4573     * @li menu/clock
4574     * @li menu/delete
4575     * @li menu/edit
4576     * @li menu/refresh
4577     * @li menu/folder
4578     * @li menu/file
4579     *
4580     * And here we have some media player specific icons:
4581     * @li media_player/forward
4582     * @li media_player/info
4583     * @li media_player/next
4584     * @li media_player/pause
4585     * @li media_player/play
4586     * @li media_player/prev
4587     * @li media_player/rewind
4588     * @li media_player/stop
4589     *
4590     * Signals that you can add callbacks for are:
4591     *
4592     * "clicked" - This is called when a user has clicked the icon
4593     *
4594     * An example of usage for this API follows:
4595     * @li @ref tutorial_icon
4596     */
4597
4598    /**
4599     * @addtogroup Icon
4600     * @{
4601     */
4602
4603    typedef enum _Elm_Icon_Type
4604      {
4605         ELM_ICON_NONE,
4606         ELM_ICON_FILE,
4607         ELM_ICON_STANDARD
4608      } Elm_Icon_Type;
4609    /**
4610     * @enum _Elm_Icon_Lookup_Order
4611     * @typedef Elm_Icon_Lookup_Order
4612     *
4613     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4614     * theme, FDO paths, or both?
4615     *
4616     * @ingroup Icon
4617     */
4618    typedef enum _Elm_Icon_Lookup_Order
4619      {
4620         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4621         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4622         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4623         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4624      } Elm_Icon_Lookup_Order;
4625
4626    /**
4627     * Add a new icon object to the parent.
4628     *
4629     * @param parent The parent object
4630     * @return The new object or NULL if it cannot be created
4631     *
4632     * @see elm_icon_file_set()
4633     *
4634     * @ingroup Icon
4635     */
4636    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4637    /**
4638     * Set the file that will be used as icon.
4639     *
4640     * @param obj The icon object
4641     * @param file The path to file that will be used as icon image
4642     * @param group The group that the icon belongs to in edje file
4643     *
4644     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4645     *
4646     * @note The icon image set by this function can be changed by
4647     * elm_icon_standard_set().
4648     *
4649     * @see elm_icon_file_get()
4650     *
4651     * @ingroup Icon
4652     */
4653    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4654    /**
4655     * Set a location in memory to be used as an icon
4656     *
4657     * @param obj The icon object
4658     * @param img The binary data that will be used as an image
4659     * @param size The size of binary data @p img
4660     * @param format Optional format of @p img to pass to the image loader
4661     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4662     *
4663     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4664     *
4665     * @note The icon image set by this function can be changed by
4666     * elm_icon_standard_set().
4667     *
4668     * @ingroup Icon
4669     */
4670    EAPI Eina_Bool             elm_icon_memfile_set(Evas_Object *obj, const void *img, size_t size, const char *format, const char *key);  EINA_ARG_NONNULL(1, 2);
4671    /**
4672     * Get the file that will be used as icon.
4673     *
4674     * @param obj The icon object
4675     * @param file The path to file that will be used as icon icon image
4676     * @param group The group that the icon belongs to in edje file
4677     *
4678     * @see elm_icon_file_set()
4679     *
4680     * @ingroup Icon
4681     */
4682    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4683    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4684    /**
4685     * Set the icon by icon standards names.
4686     *
4687     * @param obj The icon object
4688     * @param name The icon name
4689     *
4690     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4691     *
4692     * For example, freedesktop.org defines standard icon names such as "home",
4693     * "network", etc. There can be different icon sets to match those icon
4694     * keys. The @p name given as parameter is one of these "keys", and will be
4695     * used to look in the freedesktop.org paths and elementary theme. One can
4696     * change the lookup order with elm_icon_order_lookup_set().
4697     *
4698     * If name is not found in any of the expected locations and it is the
4699     * absolute path of an image file, this image will be used.
4700     *
4701     * @note The icon image set by this function can be changed by
4702     * elm_icon_file_set().
4703     *
4704     * @see elm_icon_standard_get()
4705     * @see elm_icon_file_set()
4706     *
4707     * @ingroup Icon
4708     */
4709    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4710    /**
4711     * Get the icon name set by icon standard names.
4712     *
4713     * @param obj The icon object
4714     * @return The icon name
4715     *
4716     * If the icon image was set using elm_icon_file_set() instead of
4717     * elm_icon_standard_set(), then this function will return @c NULL.
4718     *
4719     * @see elm_icon_standard_set()
4720     *
4721     * @ingroup Icon
4722     */
4723    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4724    /**
4725     * Set the smooth effect for an icon object.
4726     *
4727     * @param obj The icon object
4728     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4729     * otherwise. Default is @c EINA_TRUE.
4730     *
4731     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4732     * scaling provides a better resulting image, but is slower.
4733     *
4734     * The smooth scaling should be disabled when making animations that change
4735     * the icon size, since they will be faster. Animations that don't require
4736     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4737     * is already scaled, since the scaled icon image will be cached).
4738     *
4739     * @see elm_icon_smooth_get()
4740     *
4741     * @ingroup Icon
4742     */
4743    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4744    /**
4745     * Get the smooth effect for an icon object.
4746     *
4747     * @param obj The icon object
4748     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4749     *
4750     * @see elm_icon_smooth_set()
4751     *
4752     * @ingroup Icon
4753     */
4754    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4755    /**
4756     * Disable scaling of this object.
4757     *
4758     * @param obj The icon object.
4759     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4760     * otherwise. Default is @c EINA_FALSE.
4761     *
4762     * This function disables scaling of the icon object through the function
4763     * elm_object_scale_set(). However, this does not affect the object
4764     * size/resize in any way. For that effect, take a look at
4765     * elm_icon_scale_set().
4766     *
4767     * @see elm_icon_no_scale_get()
4768     * @see elm_icon_scale_set()
4769     * @see elm_object_scale_set()
4770     *
4771     * @ingroup Icon
4772     */
4773    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4774    /**
4775     * Get whether scaling is disabled on the object.
4776     *
4777     * @param obj The icon object
4778     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4779     *
4780     * @see elm_icon_no_scale_set()
4781     *
4782     * @ingroup Icon
4783     */
4784    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4785    /**
4786     * Set if the object is (up/down) resizable.
4787     *
4788     * @param obj The icon object
4789     * @param scale_up A bool to set if the object is resizable up. Default is
4790     * @c EINA_TRUE.
4791     * @param scale_down A bool to set if the object is resizable down. Default
4792     * is @c EINA_TRUE.
4793     *
4794     * This function limits the icon object resize ability. If @p scale_up is set to
4795     * @c EINA_FALSE, the object can't have its height or width resized to a value
4796     * higher than the original icon size. Same is valid for @p scale_down.
4797     *
4798     * @see elm_icon_scale_get()
4799     *
4800     * @ingroup Icon
4801     */
4802    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4803    /**
4804     * Get if the object is (up/down) resizable.
4805     *
4806     * @param obj The icon object
4807     * @param scale_up A bool to set if the object is resizable up
4808     * @param scale_down A bool to set if the object is resizable down
4809     *
4810     * @see elm_icon_scale_set()
4811     *
4812     * @ingroup Icon
4813     */
4814    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4815    /**
4816     * Get the object's image size
4817     *
4818     * @param obj The icon object
4819     * @param w A pointer to store the width in
4820     * @param h A pointer to store the height in
4821     *
4822     * @ingroup Icon
4823     */
4824    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4825    /**
4826     * Set if the icon fill the entire object area.
4827     *
4828     * @param obj The icon object
4829     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4830     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4831     *
4832     * When the icon object is resized to a different aspect ratio from the
4833     * original icon image, the icon image will still keep its aspect. This flag
4834     * tells how the image should fill the object's area. They are: keep the
4835     * entire icon inside the limits of height and width of the object (@p
4836     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4837     * of the object, and the icon will fill the entire object (@p fill_outside
4838     * is @c EINA_TRUE).
4839     *
4840     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4841     * retain property to false. Thus, the icon image will always keep its
4842     * original aspect ratio.
4843     *
4844     * @see elm_icon_fill_outside_get()
4845     * @see elm_image_fill_outside_set()
4846     *
4847     * @ingroup Icon
4848     */
4849    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4850    /**
4851     * Get if the object is filled outside.
4852     *
4853     * @param obj The icon object
4854     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4855     *
4856     * @see elm_icon_fill_outside_set()
4857     *
4858     * @ingroup Icon
4859     */
4860    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4861    /**
4862     * Set the prescale size for the icon.
4863     *
4864     * @param obj The icon object
4865     * @param size The prescale size. This value is used for both width and
4866     * height.
4867     *
4868     * This function sets a new size for pixmap representation of the given
4869     * icon. It allows the icon to be loaded already in the specified size,
4870     * reducing the memory usage and load time when loading a big icon with load
4871     * size set to a smaller size.
4872     *
4873     * It's equivalent to the elm_bg_load_size_set() function for bg.
4874     *
4875     * @note this is just a hint, the real size of the pixmap may differ
4876     * depending on the type of icon being loaded, being bigger than requested.
4877     *
4878     * @see elm_icon_prescale_get()
4879     * @see elm_bg_load_size_set()
4880     *
4881     * @ingroup Icon
4882     */
4883    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4884    /**
4885     * Get the prescale size for the icon.
4886     *
4887     * @param obj The icon object
4888     * @return The prescale size
4889     *
4890     * @see elm_icon_prescale_set()
4891     *
4892     * @ingroup Icon
4893     */
4894    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4895    /**
4896     * Sets the icon lookup order used by elm_icon_standard_set().
4897     *
4898     * @param obj The icon object
4899     * @param order The icon lookup order (can be one of
4900     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4901     * or ELM_ICON_LOOKUP_THEME)
4902     *
4903     * @see elm_icon_order_lookup_get()
4904     * @see Elm_Icon_Lookup_Order
4905     *
4906     * @ingroup Icon
4907     */
4908    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4909    /**
4910     * Gets the icon lookup order.
4911     *
4912     * @param obj The icon object
4913     * @return The icon lookup order
4914     *
4915     * @see elm_icon_order_lookup_set()
4916     * @see Elm_Icon_Lookup_Order
4917     *
4918     * @ingroup Icon
4919     */
4920    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4921    /**
4922     * Get if the icon supports animation or not.
4923     *
4924     * @param obj The icon object
4925     * @return @c EINA_TRUE if the icon supports animation,
4926     *         @c EINA_FALSE otherwise.
4927     *
4928     * Return if this elm icon's image can be animated. Currently Evas only
4929     * supports gif animation. If the return value is EINA_FALSE, other
4930     * elm_icon_animated_XXX APIs won't work.
4931     * @ingroup Icon
4932     */
4933    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4934    /**
4935     * Set animation mode of the icon.
4936     *
4937     * @param obj The icon object
4938     * @param anim @c EINA_TRUE if the object do animation job,
4939     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4940     *
4941     * Even though elm icon's file can be animated,
4942     * sometimes appication developer want to just first page of image.
4943     * In that time, don't call this function, because default value is EINA_FALSE
4944     * Only when you want icon support anition,
4945     * use this function and set animated to EINA_TURE
4946     * @ingroup Icon
4947     */
4948    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4949    /**
4950     * Get animation mode of the icon.
4951     *
4952     * @param obj The icon object
4953     * @return The animation mode of the icon object
4954     * @see elm_icon_animated_set
4955     * @ingroup Icon
4956     */
4957    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4958    /**
4959     * Set animation play mode of the icon.
4960     *
4961     * @param obj The icon object
4962     * @param play @c EINA_TRUE the object play animation images,
4963     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4964     *
4965     * If you want to play elm icon's animation, you set play to EINA_TURE.
4966     * For example, you make gif player using this set/get API and click event.
4967     *
4968     * 1. Click event occurs
4969     * 2. Check play flag using elm_icon_animaged_play_get
4970     * 3. If elm icon was playing, set play to EINA_FALSE.
4971     *    Then animation will be stopped and vice versa
4972     * @ingroup Icon
4973     */
4974    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4975    /**
4976     * Get animation play mode of the icon.
4977     *
4978     * @param obj The icon object
4979     * @return The play mode of the icon object
4980     *
4981     * @see elm_icon_animated_lay_get
4982     * @ingroup Icon
4983     */
4984    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4985
4986    /**
4987     * @}
4988     */
4989
4990    /**
4991     * @defgroup Image Image
4992     *
4993     * @image html img/widget/image/preview-00.png
4994     * @image latex img/widget/image/preview-00.eps
4995
4996     *
4997     * An object that allows one to load an image file to it. It can be used
4998     * anywhere like any other elementary widget.
4999     *
5000     * This widget provides most of the functionality provided from @ref Bg or @ref
5001     * Icon, but with a slightly different API (use the one that fits better your
5002     * needs).
5003     *
5004     * The features not provided by those two other image widgets are:
5005     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5006     * @li change the object orientation with elm_image_orient_set();
5007     * @li and turning the image editable with elm_image_editable_set().
5008     *
5009     * Signals that you can add callbacks for are:
5010     *
5011     * @li @c "clicked" - This is called when a user has clicked the image
5012     *
5013     * An example of usage for this API follows:
5014     * @li @ref tutorial_image
5015     */
5016
5017    /**
5018     * @addtogroup Image
5019     * @{
5020     */
5021
5022    /**
5023     * @enum _Elm_Image_Orient
5024     * @typedef Elm_Image_Orient
5025     *
5026     * Possible orientation options for elm_image_orient_set().
5027     *
5028     * @image html elm_image_orient_set.png
5029     * @image latex elm_image_orient_set.eps width=\textwidth
5030     *
5031     * @ingroup Image
5032     */
5033    typedef enum _Elm_Image_Orient
5034      {
5035         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5036         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5037         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5038         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5039         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5040         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5041         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5042         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5043      } Elm_Image_Orient;
5044
5045    /**
5046     * Add a new image to the parent.
5047     *
5048     * @param parent The parent object
5049     * @return The new object or NULL if it cannot be created
5050     *
5051     * @see elm_image_file_set()
5052     *
5053     * @ingroup Image
5054     */
5055    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5056    /**
5057     * Set the file that will be used as image.
5058     *
5059     * @param obj The image object
5060     * @param file The path to file that will be used as image
5061     * @param group The group that the image belongs in edje file (if it's an
5062     * edje image)
5063     *
5064     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5065     *
5066     * @see elm_image_file_get()
5067     *
5068     * @ingroup Image
5069     */
5070    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5071    /**
5072     * Get the file that will be used as image.
5073     *
5074     * @param obj The image object
5075     * @param file The path to file
5076     * @param group The group that the image belongs in edje file
5077     *
5078     * @see elm_image_file_set()
5079     *
5080     * @ingroup Image
5081     */
5082    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5083    /**
5084     * Set the smooth effect for an image.
5085     *
5086     * @param obj The image object
5087     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5088     * otherwise. Default is @c EINA_TRUE.
5089     *
5090     * Set the scaling algorithm to be used when scaling the image. Smooth
5091     * scaling provides a better resulting image, but is slower.
5092     *
5093     * The smooth scaling should be disabled when making animations that change
5094     * the image size, since it will be faster. Animations that don't require
5095     * resizing of the image can keep the smooth scaling enabled (even if the
5096     * image is already scaled, since the scaled image will be cached).
5097     *
5098     * @see elm_image_smooth_get()
5099     *
5100     * @ingroup Image
5101     */
5102    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5103    /**
5104     * Get the smooth effect for an image.
5105     *
5106     * @param obj The image object
5107     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5108     *
5109     * @see elm_image_smooth_get()
5110     *
5111     * @ingroup Image
5112     */
5113    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5114    /**
5115     * Gets the current size of the image.
5116     *
5117     * @param obj The image object.
5118     * @param w Pointer to store width, or NULL.
5119     * @param h Pointer to store height, or NULL.
5120     *
5121     * This is the real size of the image, not the size of the object.
5122     *
5123     * On error, neither w or h will be written.
5124     *
5125     * @ingroup Image
5126     */
5127    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5128    /**
5129     * Disable scaling of this object.
5130     *
5131     * @param obj The image object.
5132     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5133     * otherwise. Default is @c EINA_FALSE.
5134     *
5135     * This function disables scaling of the elm_image widget through the
5136     * function elm_object_scale_set(). However, this does not affect the widget
5137     * size/resize in any way. For that effect, take a look at
5138     * elm_image_scale_set().
5139     *
5140     * @see elm_image_no_scale_get()
5141     * @see elm_image_scale_set()
5142     * @see elm_object_scale_set()
5143     *
5144     * @ingroup Image
5145     */
5146    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5147    /**
5148     * Get whether scaling is disabled on the object.
5149     *
5150     * @param obj The image object
5151     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5152     *
5153     * @see elm_image_no_scale_set()
5154     *
5155     * @ingroup Image
5156     */
5157    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5158    /**
5159     * Set if the object is (up/down) resizable.
5160     *
5161     * @param obj The image object
5162     * @param scale_up A bool to set if the object is resizable up. Default is
5163     * @c EINA_TRUE.
5164     * @param scale_down A bool to set if the object is resizable down. Default
5165     * is @c EINA_TRUE.
5166     *
5167     * This function limits the image resize ability. If @p scale_up is set to
5168     * @c EINA_FALSE, the object can't have its height or width resized to a value
5169     * higher than the original image size. Same is valid for @p scale_down.
5170     *
5171     * @see elm_image_scale_get()
5172     *
5173     * @ingroup Image
5174     */
5175    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5176    /**
5177     * Get if the object is (up/down) resizable.
5178     *
5179     * @param obj The image object
5180     * @param scale_up A bool to set if the object is resizable up
5181     * @param scale_down A bool to set if the object is resizable down
5182     *
5183     * @see elm_image_scale_set()
5184     *
5185     * @ingroup Image
5186     */
5187    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5188    /**
5189     * Set if the image fill the entire object area when keeping the aspect ratio.
5190     *
5191     * @param obj The image object
5192     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5193     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5194     *
5195     * When the image should keep its aspect ratio even if resized to another
5196     * aspect ratio, there are two possibilities to resize it: keep the entire
5197     * image inside the limits of height and width of the object (@p fill_outside
5198     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5199     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5200     *
5201     * @note This option will have no effect if
5202     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5203     *
5204     * @see elm_image_fill_outside_get()
5205     * @see elm_image_aspect_ratio_retained_set()
5206     *
5207     * @ingroup Image
5208     */
5209    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5210    /**
5211     * Get if the object is filled outside
5212     *
5213     * @param obj The image object
5214     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5215     *
5216     * @see elm_image_fill_outside_set()
5217     *
5218     * @ingroup Image
5219     */
5220    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5221    /**
5222     * Set the prescale size for the image
5223     *
5224     * @param obj The image object
5225     * @param size The prescale size. This value is used for both width and
5226     * height.
5227     *
5228     * This function sets a new size for pixmap representation of the given
5229     * image. It allows the image to be loaded already in the specified size,
5230     * reducing the memory usage and load time when loading a big image with load
5231     * size set to a smaller size.
5232     *
5233     * It's equivalent to the elm_bg_load_size_set() function for bg.
5234     *
5235     * @note this is just a hint, the real size of the pixmap may differ
5236     * depending on the type of image being loaded, being bigger than requested.
5237     *
5238     * @see elm_image_prescale_get()
5239     * @see elm_bg_load_size_set()
5240     *
5241     * @ingroup Image
5242     */
5243    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5244    /**
5245     * Get the prescale size for the image
5246     *
5247     * @param obj The image object
5248     * @return The prescale size
5249     *
5250     * @see elm_image_prescale_set()
5251     *
5252     * @ingroup Image
5253     */
5254    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5255    /**
5256     * Set the image orientation.
5257     *
5258     * @param obj The image object
5259     * @param orient The image orientation
5260     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5261     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5262     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5263     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5264     *  Default is #ELM_IMAGE_ORIENT_NONE.
5265     *
5266     * This function allows to rotate or flip the given image.
5267     *
5268     * @see elm_image_orient_get()
5269     * @see @ref Elm_Image_Orient
5270     *
5271     * @ingroup Image
5272     */
5273    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5274    /**
5275     * Get the image orientation.
5276     *
5277     * @param obj The image object
5278     * @return The image orientation
5279     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5280     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5281     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5282     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5283     *
5284     * @see elm_image_orient_set()
5285     * @see @ref Elm_Image_Orient
5286     *
5287     * @ingroup Image
5288     */
5289    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5290    /**
5291     * Make the image 'editable'.
5292     *
5293     * @param obj Image object.
5294     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5295     *
5296     * This means the image is a valid drag target for drag and drop, and can be
5297     * cut or pasted too.
5298     *
5299     * @ingroup Image
5300     */
5301    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5302    /**
5303     * Make the image 'editable'.
5304     *
5305     * @param obj Image object.
5306     * @return Editability.
5307     *
5308     * This means the image is a valid drag target for drag and drop, and can be
5309     * cut or pasted too.
5310     *
5311     * @ingroup Image
5312     */
5313    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5314    /**
5315     * Get the basic Evas_Image object from this object (widget).
5316     *
5317     * @param obj The image object to get the inlined image from
5318     * @return The inlined image object, or NULL if none exists
5319     *
5320     * This function allows one to get the underlying @c Evas_Object of type
5321     * Image from this elementary widget. It can be useful to do things like get
5322     * the pixel data, save the image to a file, etc.
5323     *
5324     * @note Be careful to not manipulate it, as it is under control of
5325     * elementary.
5326     *
5327     * @ingroup Image
5328     */
5329    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5330    /**
5331     * Set whether the original aspect ratio of the image should be kept on resize.
5332     *
5333     * @param obj The image object.
5334     * @param retained @c EINA_TRUE if the image should retain the aspect,
5335     * @c EINA_FALSE otherwise.
5336     *
5337     * The original aspect ratio (width / height) of the image is usually
5338     * distorted to match the object's size. Enabling this option will retain
5339     * this original aspect, and the way that the image is fit into the object's
5340     * area depends on the option set by elm_image_fill_outside_set().
5341     *
5342     * @see elm_image_aspect_ratio_retained_get()
5343     * @see elm_image_fill_outside_set()
5344     *
5345     * @ingroup Image
5346     */
5347    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5348    /**
5349     * Get if the object retains the original aspect ratio.
5350     *
5351     * @param obj The image object.
5352     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5353     * otherwise.
5354     *
5355     * @ingroup Image
5356     */
5357    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5358
5359    /**
5360     * @}
5361     */
5362
5363    /* glview */
5364    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5365
5366    typedef enum _Elm_GLView_Mode
5367      {
5368         ELM_GLVIEW_ALPHA   = 1,
5369         ELM_GLVIEW_DEPTH   = 2,
5370         ELM_GLVIEW_STENCIL = 4
5371      } Elm_GLView_Mode;
5372
5373    /**
5374     * Defines a policy for the glview resizing.
5375     *
5376     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5377     */
5378    typedef enum _Elm_GLView_Resize_Policy
5379      {
5380         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5381         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5382      } Elm_GLView_Resize_Policy;
5383
5384    typedef enum _Elm_GLView_Render_Policy
5385      {
5386         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5387         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5388      } Elm_GLView_Render_Policy;
5389
5390    /**
5391     * @defgroup GLView
5392     *
5393     * A simple GLView widget that allows GL rendering.
5394     *
5395     * Signals that you can add callbacks for are:
5396     *
5397     * @{
5398     */
5399
5400    /**
5401     * Add a new glview to the parent
5402     *
5403     * @param parent The parent object
5404     * @return The new object or NULL if it cannot be created
5405     *
5406     * @ingroup GLView
5407     */
5408    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5409
5410    /**
5411     * Sets the size of the glview
5412     *
5413     * @param obj The glview object
5414     * @param width width of the glview object
5415     * @param height height of the glview object
5416     *
5417     * @ingroup GLView
5418     */
5419    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5420
5421    /**
5422     * Gets the size of the glview.
5423     *
5424     * @param obj The glview object
5425     * @param width width of the glview object
5426     * @param height height of the glview object
5427     *
5428     * Note that this function returns the actual image size of the
5429     * glview.  This means that when the scale policy is set to
5430     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5431     * size.
5432     *
5433     * @ingroup GLView
5434     */
5435    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5436
5437    /**
5438     * Gets the gl api struct for gl rendering
5439     *
5440     * @param obj The glview object
5441     * @return The api object or NULL if it cannot be created
5442     *
5443     * @ingroup GLView
5444     */
5445    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5446
5447    /**
5448     * Set the mode of the GLView. Supports Three simple modes.
5449     *
5450     * @param obj The glview object
5451     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5452     * @return True if set properly.
5453     *
5454     * @ingroup GLView
5455     */
5456    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5457
5458    /**
5459     * Set the resize policy for the glview object.
5460     *
5461     * @param obj The glview object.
5462     * @param policy The scaling policy.
5463     *
5464     * By default, the resize policy is set to
5465     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5466     * destroys the previous surface and recreates the newly specified
5467     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5468     * however, glview only scales the image object and not the underlying
5469     * GL Surface.
5470     *
5471     * @ingroup GLView
5472     */
5473    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5474
5475    /**
5476     * Set the render policy for the glview object.
5477     *
5478     * @param obj The glview object.
5479     * @param policy The render policy.
5480     *
5481     * By default, the render policy is set to
5482     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5483     * that during the render loop, glview is only redrawn if it needs
5484     * to be redrawn. (i.e. When it is visible) If the policy is set to
5485     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5486     * whether it is visible/need redrawing or not.
5487     *
5488     * @ingroup GLView
5489     */
5490    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5491
5492    /**
5493     * Set the init function that runs once in the main loop.
5494     *
5495     * @param obj The glview object.
5496     * @param func The init function to be registered.
5497     *
5498     * The registered init function gets called once during the render loop.
5499     *
5500     * @ingroup GLView
5501     */
5502    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5503
5504    /**
5505     * Set the render function that runs in the main loop.
5506     *
5507     * @param obj The glview object.
5508     * @param func The delete function to be registered.
5509     *
5510     * The registered del function gets called when GLView object is deleted.
5511     *
5512     * @ingroup GLView
5513     */
5514    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5515
5516    /**
5517     * Set the resize function that gets called when resize happens.
5518     *
5519     * @param obj The glview object.
5520     * @param func The resize function to be registered.
5521     *
5522     * @ingroup GLView
5523     */
5524    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5525
5526    /**
5527     * Set the render function that runs in the main loop.
5528     *
5529     * @param obj The glview object.
5530     * @param func The render function to be registered.
5531     *
5532     * @ingroup GLView
5533     */
5534    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5535
5536    /**
5537     * Notifies that there has been changes in the GLView.
5538     *
5539     * @param obj The glview object.
5540     *
5541     * @ingroup GLView
5542     */
5543    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5544
5545    /**
5546     * @}
5547     */
5548
5549    /* box */
5550    /**
5551     * @defgroup Box Box
5552     *
5553     * @image html img/widget/box/preview-00.png
5554     * @image latex img/widget/box/preview-00.eps width=\textwidth
5555     *
5556     * @image html img/box.png
5557     * @image latex img/box.eps width=\textwidth
5558     *
5559     * A box arranges objects in a linear fashion, governed by a layout function
5560     * that defines the details of this arrangement.
5561     *
5562     * By default, the box will use an internal function to set the layout to
5563     * a single row, either vertical or horizontal. This layout is affected
5564     * by a number of parameters, such as the homogeneous flag set by
5565     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5566     * elm_box_align_set() and the hints set to each object in the box.
5567     *
5568     * For this default layout, it's possible to change the orientation with
5569     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5570     * placing its elements ordered from top to bottom. When horizontal is set,
5571     * the order will go from left to right. If the box is set to be
5572     * homogeneous, every object in it will be assigned the same space, that
5573     * of the largest object. Padding can be used to set some spacing between
5574     * the cell given to each object. The alignment of the box, set with
5575     * elm_box_align_set(), determines how the bounding box of all the elements
5576     * will be placed within the space given to the box widget itself.
5577     *
5578     * The size hints of each object also affect how they are placed and sized
5579     * within the box. evas_object_size_hint_min_set() will give the minimum
5580     * size the object can have, and the box will use it as the basis for all
5581     * latter calculations. Elementary widgets set their own minimum size as
5582     * needed, so there's rarely any need to use it manually.
5583     *
5584     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5585     * used to tell whether the object will be allocated the minimum size it
5586     * needs or if the space given to it should be expanded. It's important
5587     * to realize that expanding the size given to the object is not the same
5588     * thing as resizing the object. It could very well end being a small
5589     * widget floating in a much larger empty space. If not set, the weight
5590     * for objects will normally be 0.0 for both axis, meaning the widget will
5591     * not be expanded. To take as much space possible, set the weight to
5592     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5593     *
5594     * Besides how much space each object is allocated, it's possible to control
5595     * how the widget will be placed within that space using
5596     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5597     * for both axis, meaning the object will be centered, but any value from
5598     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5599     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5600     * is -1.0, means the object will be resized to fill the entire space it
5601     * was allocated.
5602     *
5603     * In addition, customized functions to define the layout can be set, which
5604     * allow the application developer to organize the objects within the box
5605     * in any number of ways.
5606     *
5607     * The special elm_box_layout_transition() function can be used
5608     * to switch from one layout to another, animating the motion of the
5609     * children of the box.
5610     *
5611     * @note Objects should not be added to box objects using _add() calls.
5612     *
5613     * Some examples on how to use boxes follow:
5614     * @li @ref box_example_01
5615     * @li @ref box_example_02
5616     *
5617     * @{
5618     */
5619    /**
5620     * @typedef Elm_Box_Transition
5621     *
5622     * Opaque handler containing the parameters to perform an animated
5623     * transition of the layout the box uses.
5624     *
5625     * @see elm_box_transition_new()
5626     * @see elm_box_layout_set()
5627     * @see elm_box_layout_transition()
5628     */
5629    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5630
5631    /**
5632     * Add a new box to the parent
5633     *
5634     * By default, the box will be in vertical mode and non-homogeneous.
5635     *
5636     * @param parent The parent object
5637     * @return The new object or NULL if it cannot be created
5638     */
5639    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5640    /**
5641     * Set the horizontal orientation
5642     *
5643     * By default, box object arranges their contents vertically from top to
5644     * bottom.
5645     * By calling this function with @p horizontal as EINA_TRUE, the box will
5646     * become horizontal, arranging contents from left to right.
5647     *
5648     * @note This flag is ignored if a custom layout function is set.
5649     *
5650     * @param obj The box object
5651     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5652     * EINA_FALSE = vertical)
5653     */
5654    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5655    /**
5656     * Get the horizontal orientation
5657     *
5658     * @param obj The box object
5659     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5660     */
5661    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5662    /**
5663     * Set the box to arrange its children homogeneously
5664     *
5665     * If enabled, homogeneous layout makes all items the same size, according
5666     * to the size of the largest of its children.
5667     *
5668     * @note This flag is ignored if a custom layout function is set.
5669     *
5670     * @param obj The box object
5671     * @param homogeneous The homogeneous flag
5672     */
5673    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5674    /**
5675     * Get whether the box is using homogeneous mode or not
5676     *
5677     * @param obj The box object
5678     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5679     */
5680    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5681    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5682    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5683    /**
5684     * Add an object to the beginning of the pack list
5685     *
5686     * Pack @p subobj into the box @p obj, placing it first in the list of
5687     * children objects. The actual position the object will get on screen
5688     * depends on the layout used. If no custom layout is set, it will be at
5689     * the top or left, depending if the box is vertical or horizontal,
5690     * respectively.
5691     *
5692     * @param obj The box object
5693     * @param subobj The object to add to the box
5694     *
5695     * @see elm_box_pack_end()
5696     * @see elm_box_pack_before()
5697     * @see elm_box_pack_after()
5698     * @see elm_box_unpack()
5699     * @see elm_box_unpack_all()
5700     * @see elm_box_clear()
5701     */
5702    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5703    /**
5704     * Add an object at the end of the pack list
5705     *
5706     * Pack @p subobj into the box @p obj, placing it last in the list of
5707     * children objects. The actual position the object will get on screen
5708     * depends on the layout used. If no custom layout is set, it will be at
5709     * the bottom or right, depending if the box is vertical or horizontal,
5710     * respectively.
5711     *
5712     * @param obj The box object
5713     * @param subobj The object to add to the box
5714     *
5715     * @see elm_box_pack_start()
5716     * @see elm_box_pack_before()
5717     * @see elm_box_pack_after()
5718     * @see elm_box_unpack()
5719     * @see elm_box_unpack_all()
5720     * @see elm_box_clear()
5721     */
5722    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5723    /**
5724     * Adds an object to the box before the indicated object
5725     *
5726     * This will add the @p subobj to the box indicated before the object
5727     * indicated with @p before. If @p before is not already in the box, results
5728     * are undefined. Before means either to the left of the indicated object or
5729     * above it depending on orientation.
5730     *
5731     * @param obj The box object
5732     * @param subobj The object to add to the box
5733     * @param before The object before which to add it
5734     *
5735     * @see elm_box_pack_start()
5736     * @see elm_box_pack_end()
5737     * @see elm_box_pack_after()
5738     * @see elm_box_unpack()
5739     * @see elm_box_unpack_all()
5740     * @see elm_box_clear()
5741     */
5742    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5743    /**
5744     * Adds an object to the box after the indicated object
5745     *
5746     * This will add the @p subobj to the box indicated after the object
5747     * indicated with @p after. If @p after is not already in the box, results
5748     * are undefined. After means either to the right of the indicated object or
5749     * below it depending on orientation.
5750     *
5751     * @param obj The box object
5752     * @param subobj The object to add to the box
5753     * @param after The object after which to add it
5754     *
5755     * @see elm_box_pack_start()
5756     * @see elm_box_pack_end()
5757     * @see elm_box_pack_before()
5758     * @see elm_box_unpack()
5759     * @see elm_box_unpack_all()
5760     * @see elm_box_clear()
5761     */
5762    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5763    /**
5764     * Clear the box of all children
5765     *
5766     * Remove all the elements contained by the box, deleting the respective
5767     * objects.
5768     *
5769     * @param obj The box object
5770     *
5771     * @see elm_box_unpack()
5772     * @see elm_box_unpack_all()
5773     */
5774    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5775    /**
5776     * Unpack a box item
5777     *
5778     * Remove the object given by @p subobj from the box @p obj without
5779     * deleting it.
5780     *
5781     * @param obj The box object
5782     *
5783     * @see elm_box_unpack_all()
5784     * @see elm_box_clear()
5785     */
5786    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5787    /**
5788     * Remove all items from the box, without deleting them
5789     *
5790     * Clear the box from all children, but don't delete the respective objects.
5791     * If no other references of the box children exist, the objects will never
5792     * be deleted, and thus the application will leak the memory. Make sure
5793     * when using this function that you hold a reference to all the objects
5794     * in the box @p obj.
5795     *
5796     * @param obj The box object
5797     *
5798     * @see elm_box_clear()
5799     * @see elm_box_unpack()
5800     */
5801    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5802    /**
5803     * Retrieve a list of the objects packed into the box
5804     *
5805     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5806     * The order of the list corresponds to the packing order the box uses.
5807     *
5808     * You must free this list with eina_list_free() once you are done with it.
5809     *
5810     * @param obj The box object
5811     */
5812    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5813    /**
5814     * Set the space (padding) between the box's elements.
5815     *
5816     * Extra space in pixels that will be added between a box child and its
5817     * neighbors after its containing cell has been calculated. This padding
5818     * is set for all elements in the box, besides any possible padding that
5819     * individual elements may have through their size hints.
5820     *
5821     * @param obj The box object
5822     * @param horizontal The horizontal space between elements
5823     * @param vertical The vertical space between elements
5824     */
5825    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5826    /**
5827     * Get the space (padding) between the box's elements.
5828     *
5829     * @param obj The box object
5830     * @param horizontal The horizontal space between elements
5831     * @param vertical The vertical space between elements
5832     *
5833     * @see elm_box_padding_set()
5834     */
5835    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5836    /**
5837     * Set the alignment of the whole bouding box of contents.
5838     *
5839     * Sets how the bounding box containing all the elements of the box, after
5840     * their sizes and position has been calculated, will be aligned within
5841     * the space given for the whole box widget.
5842     *
5843     * @param obj The box object
5844     * @param horizontal The horizontal alignment of elements
5845     * @param vertical The vertical alignment of elements
5846     */
5847    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5848    /**
5849     * Get the alignment of the whole bouding box of contents.
5850     *
5851     * @param obj The box object
5852     * @param horizontal The horizontal alignment of elements
5853     * @param vertical The vertical alignment of elements
5854     *
5855     * @see elm_box_align_set()
5856     */
5857    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5858
5859    /**
5860     * Set the layout defining function to be used by the box
5861     *
5862     * Whenever anything changes that requires the box in @p obj to recalculate
5863     * the size and position of its elements, the function @p cb will be called
5864     * to determine what the layout of the children will be.
5865     *
5866     * Once a custom function is set, everything about the children layout
5867     * is defined by it. The flags set by elm_box_horizontal_set() and
5868     * elm_box_homogeneous_set() no longer have any meaning, and the values
5869     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5870     * layout function to decide if they are used and how. These last two
5871     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5872     * passed to @p cb. The @c Evas_Object the function receives is not the
5873     * Elementary widget, but the internal Evas Box it uses, so none of the
5874     * functions described here can be used on it.
5875     *
5876     * Any of the layout functions in @c Evas can be used here, as well as the
5877     * special elm_box_layout_transition().
5878     *
5879     * The final @p data argument received by @p cb is the same @p data passed
5880     * here, and the @p free_data function will be called to free it
5881     * whenever the box is destroyed or another layout function is set.
5882     *
5883     * Setting @p cb to NULL will revert back to the default layout function.
5884     *
5885     * @param obj The box object
5886     * @param cb The callback function used for layout
5887     * @param data Data that will be passed to layout function
5888     * @param free_data Function called to free @p data
5889     *
5890     * @see elm_box_layout_transition()
5891     */
5892    EAPI void                elm_box_layout_set(Evas_Object *obj, Evas_Object_Box_Layout cb, const void *data, void (*free_data)(void *data)) EINA_ARG_NONNULL(1);
5893    /**
5894     * Special layout function that animates the transition from one layout to another
5895     *
5896     * Normally, when switching the layout function for a box, this will be
5897     * reflected immediately on screen on the next render, but it's also
5898     * possible to do this through an animated transition.
5899     *
5900     * This is done by creating an ::Elm_Box_Transition and setting the box
5901     * layout to this function.
5902     *
5903     * For example:
5904     * @code
5905     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5906     *                            evas_object_box_layout_vertical, // start
5907     *                            NULL, // data for initial layout
5908     *                            NULL, // free function for initial data
5909     *                            evas_object_box_layout_horizontal, // end
5910     *                            NULL, // data for final layout
5911     *                            NULL, // free function for final data
5912     *                            anim_end, // will be called when animation ends
5913     *                            NULL); // data for anim_end function\
5914     * elm_box_layout_set(box, elm_box_layout_transition, t,
5915     *                    elm_box_transition_free);
5916     * @endcode
5917     *
5918     * @note This function can only be used with elm_box_layout_set(). Calling
5919     * it directly will not have the expected results.
5920     *
5921     * @see elm_box_transition_new
5922     * @see elm_box_transition_free
5923     * @see elm_box_layout_set
5924     */
5925    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5926    /**
5927     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5928     *
5929     * If you want to animate the change from one layout to another, you need
5930     * to set the layout function of the box to elm_box_layout_transition(),
5931     * passing as user data to it an instance of ::Elm_Box_Transition with the
5932     * necessary information to perform this animation. The free function to
5933     * set for the layout is elm_box_transition_free().
5934     *
5935     * The parameters to create an ::Elm_Box_Transition sum up to how long
5936     * will it be, in seconds, a layout function to describe the initial point,
5937     * another for the final position of the children and one function to be
5938     * called when the whole animation ends. This last function is useful to
5939     * set the definitive layout for the box, usually the same as the end
5940     * layout for the animation, but could be used to start another transition.
5941     *
5942     * @param start_layout The layout function that will be used to start the animation
5943     * @param start_layout_data The data to be passed the @p start_layout function
5944     * @param start_layout_free_data Function to free @p start_layout_data
5945     * @param end_layout The layout function that will be used to end the animation
5946     * @param end_layout_free_data The data to be passed the @p end_layout function
5947     * @param end_layout_free_data Function to free @p end_layout_data
5948     * @param transition_end_cb Callback function called when animation ends
5949     * @param transition_end_data Data to be passed to @p transition_end_cb
5950     * @return An instance of ::Elm_Box_Transition
5951     *
5952     * @see elm_box_transition_new
5953     * @see elm_box_layout_transition
5954     */
5955    EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, void(*start_layout_free_data)(void *data), Evas_Object_Box_Layout end_layout, void *end_layout_data, void(*end_layout_free_data)(void *data), void(*transition_end_cb)(void *data), void *transition_end_data) EINA_ARG_NONNULL(2, 5);
5956    /**
5957     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5958     *
5959     * This function is mostly useful as the @c free_data parameter in
5960     * elm_box_layout_set() when elm_box_layout_transition().
5961     *
5962     * @param data The Elm_Box_Transition instance to be freed.
5963     *
5964     * @see elm_box_transition_new
5965     * @see elm_box_layout_transition
5966     */
5967    EAPI void                elm_box_transition_free(void *data);
5968    /**
5969     * @}
5970     */
5971
5972    /* button */
5973    /**
5974     * @defgroup Button Button
5975     *
5976     * @image html img/widget/button/preview-00.png
5977     * @image latex img/widget/button/preview-00.eps
5978     * @image html img/widget/button/preview-01.png
5979     * @image latex img/widget/button/preview-01.eps
5980     * @image html img/widget/button/preview-02.png
5981     * @image latex img/widget/button/preview-02.eps
5982     *
5983     * This is a push-button. Press it and run some function. It can contain
5984     * a simple label and icon object and it also has an autorepeat feature.
5985     *
5986     * This widgets emits the following signals:
5987     * @li "clicked": the user clicked the button (press/release).
5988     * @li "repeated": the user pressed the button without releasing it.
5989     * @li "pressed": button was pressed.
5990     * @li "unpressed": button was released after being pressed.
5991     * In all three cases, the @c event parameter of the callback will be
5992     * @c NULL.
5993     *
5994     * Also, defined in the default theme, the button has the following styles
5995     * available:
5996     * @li default: a normal button.
5997     * @li anchor: Like default, but the button fades away when the mouse is not
5998     * over it, leaving only the text or icon.
5999     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6000     * continuous look across its options.
6001     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6002     *
6003     * Follow through a complete example @ref button_example_01 "here".
6004     * @{
6005     */
6006    /**
6007     * Add a new button to the parent's canvas
6008     *
6009     * @param parent The parent object
6010     * @return The new object or NULL if it cannot be created
6011     */
6012    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6013    /**
6014     * Set the label used in the button
6015     *
6016     * The passed @p label can be NULL to clean any existing text in it and
6017     * leave the button as an icon only object.
6018     *
6019     * @param obj The button object
6020     * @param label The text will be written on the button
6021     * @deprecated use elm_object_text_set() instead.
6022     */
6023    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6024    /**
6025     * Get the label set for the button
6026     *
6027     * The string returned is an internal pointer and should not be freed or
6028     * altered. It will also become invalid when the button is destroyed.
6029     * The string returned, if not NULL, is a stringshare, so if you need to
6030     * keep it around even after the button is destroyed, you can use
6031     * eina_stringshare_ref().
6032     *
6033     * @param obj The button object
6034     * @return The text set to the label, or NULL if nothing is set
6035     * @deprecated use elm_object_text_set() instead.
6036     */
6037    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6038    /**
6039     * Set the icon used for the button
6040     *
6041     * Setting a new icon will delete any other that was previously set, making
6042     * any reference to them invalid. If you need to maintain the previous
6043     * object alive, unset it first with elm_button_icon_unset().
6044     *
6045     * @param obj The button object
6046     * @param icon The icon object for the button
6047     */
6048    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6049    /**
6050     * Get the icon used for the button
6051     *
6052     * Return the icon object which is set for this widget. If the button is
6053     * destroyed or another icon is set, the returned object will be deleted
6054     * and any reference to it will be invalid.
6055     *
6056     * @param obj The button object
6057     * @return The icon object that is being used
6058     *
6059     * @see elm_button_icon_unset()
6060     */
6061    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6062    /**
6063     * Remove the icon set without deleting it and return the object
6064     *
6065     * This function drops the reference the button holds of the icon object
6066     * and returns this last object. It is used in case you want to remove any
6067     * icon, or set another one, without deleting the actual object. The button
6068     * will be left without an icon set.
6069     *
6070     * @param obj The button object
6071     * @return The icon object that was being used
6072     */
6073    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6074    /**
6075     * Turn on/off the autorepeat event generated when the button is kept pressed
6076     *
6077     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6078     * signal when they are clicked.
6079     *
6080     * When on, keeping a button pressed will continuously emit a @c repeated
6081     * signal until the button is released. The time it takes until it starts
6082     * emitting the signal is given by
6083     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6084     * new emission by elm_button_autorepeat_gap_timeout_set().
6085     *
6086     * @param obj The button object
6087     * @param on  A bool to turn on/off the event
6088     */
6089    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6090    /**
6091     * Get whether the autorepeat feature is enabled
6092     *
6093     * @param obj The button object
6094     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6095     *
6096     * @see elm_button_autorepeat_set()
6097     */
6098    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6099    /**
6100     * Set the initial timeout before the autorepeat event is generated
6101     *
6102     * Sets the timeout, in seconds, since the button is pressed until the
6103     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6104     * won't be any delay and the even will be fired the moment the button is
6105     * pressed.
6106     *
6107     * @param obj The button object
6108     * @param t   Timeout in seconds
6109     *
6110     * @see elm_button_autorepeat_set()
6111     * @see elm_button_autorepeat_gap_timeout_set()
6112     */
6113    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6114    /**
6115     * Get the initial timeout before the autorepeat event is generated
6116     *
6117     * @param obj The button object
6118     * @return Timeout in seconds
6119     *
6120     * @see elm_button_autorepeat_initial_timeout_set()
6121     */
6122    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6123    /**
6124     * Set the interval between each generated autorepeat event
6125     *
6126     * After the first @c repeated event is fired, all subsequent ones will
6127     * follow after a delay of @p t seconds for each.
6128     *
6129     * @param obj The button object
6130     * @param t   Interval in seconds
6131     *
6132     * @see elm_button_autorepeat_initial_timeout_set()
6133     */
6134    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6135    /**
6136     * Get the interval between each generated autorepeat event
6137     *
6138     * @param obj The button object
6139     * @return Interval in seconds
6140     */
6141    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6142    /**
6143     * @}
6144     */
6145
6146    /**
6147     * @defgroup File_Selector_Button File Selector Button
6148     *
6149     * @image html img/widget/fileselector_button/preview-00.png
6150     * @image latex img/widget/fileselector_button/preview-00.eps
6151     * @image html img/widget/fileselector_button/preview-01.png
6152     * @image latex img/widget/fileselector_button/preview-01.eps
6153     * @image html img/widget/fileselector_button/preview-02.png
6154     * @image latex img/widget/fileselector_button/preview-02.eps
6155     *
6156     * This is a button that, when clicked, creates an Elementary
6157     * window (or inner window) <b> with a @ref Fileselector "file
6158     * selector widget" within</b>. When a file is chosen, the (inner)
6159     * window is closed and the button emits a signal having the
6160     * selected file as it's @c event_info.
6161     *
6162     * This widget encapsulates operations on its internal file
6163     * selector on its own API. There is less control over its file
6164     * selector than that one would have instatiating one directly.
6165     *
6166     * The following styles are available for this button:
6167     * @li @c "default"
6168     * @li @c "anchor"
6169     * @li @c "hoversel_vertical"
6170     * @li @c "hoversel_vertical_entry"
6171     *
6172     * Smart callbacks one can register to:
6173     * - @c "file,chosen" - the user has selected a path, whose string
6174     *   pointer comes as the @c event_info data (a stringshared
6175     *   string)
6176     *
6177     * Here is an example on its usage:
6178     * @li @ref fileselector_button_example
6179     *
6180     * @see @ref File_Selector_Entry for a similar widget.
6181     * @{
6182     */
6183
6184    /**
6185     * Add a new file selector button widget to the given parent
6186     * Elementary (container) object
6187     *
6188     * @param parent The parent object
6189     * @return a new file selector button widget handle or @c NULL, on
6190     * errors
6191     */
6192    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6193
6194    /**
6195     * Set the label for a given file selector button widget
6196     *
6197     * @param obj The file selector button widget
6198     * @param label The text label to be displayed on @p obj
6199     *
6200     * @deprecated use elm_object_text_set() instead.
6201     */
6202    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6203
6204    /**
6205     * Get the label set for a given file selector button widget
6206     *
6207     * @param obj The file selector button widget
6208     * @return The button label
6209     *
6210     * @deprecated use elm_object_text_set() instead.
6211     */
6212    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6213
6214    /**
6215     * Set the icon on a given file selector button widget
6216     *
6217     * @param obj The file selector button widget
6218     * @param icon The icon object for the button
6219     *
6220     * Once the icon object is set, a previously set one will be
6221     * deleted. If you want to keep the latter, use the
6222     * elm_fileselector_button_icon_unset() function.
6223     *
6224     * @see elm_fileselector_button_icon_get()
6225     */
6226    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6227
6228    /**
6229     * Get the icon set for a given file selector button widget
6230     *
6231     * @param obj The file selector button widget
6232     * @return The icon object currently set on @p obj or @c NULL, if
6233     * none is
6234     *
6235     * @see elm_fileselector_button_icon_set()
6236     */
6237    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6238
6239    /**
6240     * Unset the icon used in a given file selector button widget
6241     *
6242     * @param obj The file selector button widget
6243     * @return The icon object that was being used on @p obj or @c
6244     * NULL, on errors
6245     *
6246     * Unparent and return the icon object which was set for this
6247     * widget.
6248     *
6249     * @see elm_fileselector_button_icon_set()
6250     */
6251    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6252
6253    /**
6254     * Set the title for a given file selector button widget's window
6255     *
6256     * @param obj The file selector button widget
6257     * @param title The title string
6258     *
6259     * This will change the window's title, when the file selector pops
6260     * out after a click on the button. Those windows have the default
6261     * (unlocalized) value of @c "Select a file" as titles.
6262     *
6263     * @note It will only take any effect if the file selector
6264     * button widget is @b not under "inwin mode".
6265     *
6266     * @see elm_fileselector_button_window_title_get()
6267     */
6268    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6269
6270    /**
6271     * Get the title set for a given file selector button widget's
6272     * window
6273     *
6274     * @param obj The file selector button widget
6275     * @return Title of the file selector button's window
6276     *
6277     * @see elm_fileselector_button_window_title_get() for more details
6278     */
6279    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6280
6281    /**
6282     * Set the size of a given file selector button widget's window,
6283     * holding the file selector itself.
6284     *
6285     * @param obj The file selector button widget
6286     * @param width The window's width
6287     * @param height The window's height
6288     *
6289     * @note it will only take any effect if the file selector button
6290     * widget is @b not under "inwin mode". The default size for the
6291     * window (when applicable) is 400x400 pixels.
6292     *
6293     * @see elm_fileselector_button_window_size_get()
6294     */
6295    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6296
6297    /**
6298     * Get the size of a given file selector button widget's window,
6299     * holding the file selector itself.
6300     *
6301     * @param obj The file selector button widget
6302     * @param width Pointer into which to store the width value
6303     * @param height Pointer into which to store the height value
6304     *
6305     * @note Use @c NULL pointers on the size values you're not
6306     * interested in: they'll be ignored by the function.
6307     *
6308     * @see elm_fileselector_button_window_size_set(), for more details
6309     */
6310    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6311
6312    /**
6313     * Set the initial file system path for a given file selector
6314     * button widget
6315     *
6316     * @param obj The file selector button widget
6317     * @param path The path string
6318     *
6319     * It must be a <b>directory</b> path, which will have the contents
6320     * displayed initially in the file selector's view, when invoked
6321     * from @p obj. The default initial path is the @c "HOME"
6322     * environment variable's value.
6323     *
6324     * @see elm_fileselector_button_path_get()
6325     */
6326    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6327
6328    /**
6329     * Get the initial file system path set for a given file selector
6330     * button widget
6331     *
6332     * @param obj The file selector button widget
6333     * @return path The path string
6334     *
6335     * @see elm_fileselector_button_path_set() for more details
6336     */
6337    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6338
6339    /**
6340     * Enable/disable a tree view in the given file selector button
6341     * widget's internal file selector
6342     *
6343     * @param obj The file selector button widget
6344     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6345     * disable
6346     *
6347     * This has the same effect as elm_fileselector_expandable_set(),
6348     * but now applied to a file selector button's internal file
6349     * selector.
6350     *
6351     * @note There's no way to put a file selector button's internal
6352     * file selector in "grid mode", as one may do with "pure" file
6353     * selectors.
6354     *
6355     * @see elm_fileselector_expandable_get()
6356     */
6357    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6358
6359    /**
6360     * Get whether tree view is enabled for the given file selector
6361     * button widget's internal file selector
6362     *
6363     * @param obj The file selector button widget
6364     * @return @c EINA_TRUE if @p obj widget's internal file selector
6365     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6366     *
6367     * @see elm_fileselector_expandable_set() for more details
6368     */
6369    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6370
6371    /**
6372     * Set whether a given file selector button widget's internal file
6373     * selector is to display folders only or the directory contents,
6374     * as well.
6375     *
6376     * @param obj The file selector button widget
6377     * @param only @c EINA_TRUE to make @p obj widget's internal file
6378     * selector only display directories, @c EINA_FALSE to make files
6379     * to be displayed in it too
6380     *
6381     * This has the same effect as elm_fileselector_folder_only_set(),
6382     * but now applied to a file selector button's internal file
6383     * selector.
6384     *
6385     * @see elm_fileselector_folder_only_get()
6386     */
6387    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6388
6389    /**
6390     * Get whether a given file selector button widget's internal file
6391     * selector is displaying folders only or the directory contents,
6392     * as well.
6393     *
6394     * @param obj The file selector button widget
6395     * @return @c EINA_TRUE if @p obj widget's internal file
6396     * selector is only displaying directories, @c EINA_FALSE if files
6397     * are being displayed in it too (and on errors)
6398     *
6399     * @see elm_fileselector_button_folder_only_set() for more details
6400     */
6401    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6402
6403    /**
6404     * Enable/disable the file name entry box where the user can type
6405     * in a name for a file, in a given file selector button widget's
6406     * internal file selector.
6407     *
6408     * @param obj The file selector button widget
6409     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6410     * file selector a "saving dialog", @c EINA_FALSE otherwise
6411     *
6412     * This has the same effect as elm_fileselector_is_save_set(),
6413     * but now applied to a file selector button's internal file
6414     * selector.
6415     *
6416     * @see elm_fileselector_is_save_get()
6417     */
6418    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6419
6420    /**
6421     * Get whether the given file selector button widget's internal
6422     * file selector is in "saving dialog" mode
6423     *
6424     * @param obj The file selector button widget
6425     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6426     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6427     * errors)
6428     *
6429     * @see elm_fileselector_button_is_save_set() for more details
6430     */
6431    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6432
6433    /**
6434     * Set whether a given file selector button widget's internal file
6435     * selector will raise an Elementary "inner window", instead of a
6436     * dedicated Elementary window. By default, it won't.
6437     *
6438     * @param obj The file selector button widget
6439     * @param value @c EINA_TRUE to make it use an inner window, @c
6440     * EINA_TRUE to make it use a dedicated window
6441     *
6442     * @see elm_win_inwin_add() for more information on inner windows
6443     * @see elm_fileselector_button_inwin_mode_get()
6444     */
6445    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6446
6447    /**
6448     * Get whether a given file selector button widget's internal file
6449     * selector will raise an Elementary "inner window", instead of a
6450     * dedicated Elementary window.
6451     *
6452     * @param obj The file selector button widget
6453     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6454     * if it will use a dedicated window
6455     *
6456     * @see elm_fileselector_button_inwin_mode_set() for more details
6457     */
6458    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6459
6460    /**
6461     * @}
6462     */
6463
6464     /**
6465     * @defgroup File_Selector_Entry File Selector Entry
6466     *
6467     * @image html img/widget/fileselector_entry/preview-00.png
6468     * @image latex img/widget/fileselector_entry/preview-00.eps
6469     *
6470     * This is an entry made to be filled with or display a <b>file
6471     * system path string</b>. Besides the entry itself, the widget has
6472     * a @ref File_Selector_Button "file selector button" on its side,
6473     * which will raise an internal @ref Fileselector "file selector widget",
6474     * when clicked, for path selection aided by file system
6475     * navigation.
6476     *
6477     * This file selector may appear in an Elementary window or in an
6478     * inner window. When a file is chosen from it, the (inner) window
6479     * is closed and the selected file's path string is exposed both as
6480     * an smart event and as the new text on the entry.
6481     *
6482     * This widget encapsulates operations on its internal file
6483     * selector on its own API. There is less control over its file
6484     * selector than that one would have instatiating one directly.
6485     *
6486     * Smart callbacks one can register to:
6487     * - @c "changed" - The text within the entry was changed
6488     * - @c "activated" - The entry has had editing finished and
6489     *   changes are to be "committed"
6490     * - @c "press" - The entry has been clicked
6491     * - @c "longpressed" - The entry has been clicked (and held) for a
6492     *   couple seconds
6493     * - @c "clicked" - The entry has been clicked
6494     * - @c "clicked,double" - The entry has been double clicked
6495     * - @c "focused" - The entry has received focus
6496     * - @c "unfocused" - The entry has lost focus
6497     * - @c "selection,paste" - A paste action has occurred on the
6498     *   entry
6499     * - @c "selection,copy" - A copy action has occurred on the entry
6500     * - @c "selection,cut" - A cut action has occurred on the entry
6501     * - @c "unpressed" - The file selector entry's button was released
6502     *   after being pressed.
6503     * - @c "file,chosen" - The user has selected a path via the file
6504     *   selector entry's internal file selector, whose string pointer
6505     *   comes as the @c event_info data (a stringshared string)
6506     *
6507     * Here is an example on its usage:
6508     * @li @ref fileselector_entry_example
6509     *
6510     * @see @ref File_Selector_Button for a similar widget.
6511     * @{
6512     */
6513
6514    /**
6515     * Add a new file selector entry widget to the given parent
6516     * Elementary (container) object
6517     *
6518     * @param parent The parent object
6519     * @return a new file selector entry widget handle or @c NULL, on
6520     * errors
6521     */
6522    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6523
6524    /**
6525     * Set the label for a given file selector entry widget's button
6526     *
6527     * @param obj The file selector entry widget
6528     * @param label The text label to be displayed on @p obj widget's
6529     * button
6530     *
6531     * @deprecated use elm_object_text_set() instead.
6532     */
6533    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6534
6535    /**
6536     * Get the label set for a given file selector entry widget's button
6537     *
6538     * @param obj The file selector entry widget
6539     * @return The widget button's label
6540     *
6541     * @deprecated use elm_object_text_set() instead.
6542     */
6543    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6544
6545    /**
6546     * Set the icon on a given file selector entry widget's button
6547     *
6548     * @param obj The file selector entry widget
6549     * @param icon The icon object for the entry's button
6550     *
6551     * Once the icon object is set, a previously set one will be
6552     * deleted. If you want to keep the latter, use the
6553     * elm_fileselector_entry_button_icon_unset() function.
6554     *
6555     * @see elm_fileselector_entry_button_icon_get()
6556     */
6557    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6558
6559    /**
6560     * Get the icon set for a given file selector entry widget's button
6561     *
6562     * @param obj The file selector entry widget
6563     * @return The icon object currently set on @p obj widget's button
6564     * or @c NULL, if none is
6565     *
6566     * @see elm_fileselector_entry_button_icon_set()
6567     */
6568    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6569
6570    /**
6571     * Unset the icon used in a given file selector entry widget's
6572     * button
6573     *
6574     * @param obj The file selector entry widget
6575     * @return The icon object that was being used on @p obj widget's
6576     * button or @c NULL, on errors
6577     *
6578     * Unparent and return the icon object which was set for this
6579     * widget's button.
6580     *
6581     * @see elm_fileselector_entry_button_icon_set()
6582     */
6583    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6584
6585    /**
6586     * Set the title for a given file selector entry widget's window
6587     *
6588     * @param obj The file selector entry widget
6589     * @param title The title string
6590     *
6591     * This will change the window's title, when the file selector pops
6592     * out after a click on the entry's button. Those windows have the
6593     * default (unlocalized) value of @c "Select a file" as titles.
6594     *
6595     * @note It will only take any effect if the file selector
6596     * entry widget is @b not under "inwin mode".
6597     *
6598     * @see elm_fileselector_entry_window_title_get()
6599     */
6600    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6601
6602    /**
6603     * Get the title set for a given file selector entry widget's
6604     * window
6605     *
6606     * @param obj The file selector entry widget
6607     * @return Title of the file selector entry's window
6608     *
6609     * @see elm_fileselector_entry_window_title_get() for more details
6610     */
6611    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6612
6613    /**
6614     * Set the size of a given file selector entry widget's window,
6615     * holding the file selector itself.
6616     *
6617     * @param obj The file selector entry widget
6618     * @param width The window's width
6619     * @param height The window's height
6620     *
6621     * @note it will only take any effect if the file selector entry
6622     * widget is @b not under "inwin mode". The default size for the
6623     * window (when applicable) is 400x400 pixels.
6624     *
6625     * @see elm_fileselector_entry_window_size_get()
6626     */
6627    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6628
6629    /**
6630     * Get the size of a given file selector entry widget's window,
6631     * holding the file selector itself.
6632     *
6633     * @param obj The file selector entry widget
6634     * @param width Pointer into which to store the width value
6635     * @param height Pointer into which to store the height value
6636     *
6637     * @note Use @c NULL pointers on the size values you're not
6638     * interested in: they'll be ignored by the function.
6639     *
6640     * @see elm_fileselector_entry_window_size_set(), for more details
6641     */
6642    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6643
6644    /**
6645     * Set the initial file system path and the entry's path string for
6646     * a given file selector entry widget
6647     *
6648     * @param obj The file selector entry widget
6649     * @param path The path string
6650     *
6651     * It must be a <b>directory</b> path, which will have the contents
6652     * displayed initially in the file selector's view, when invoked
6653     * from @p obj. The default initial path is the @c "HOME"
6654     * environment variable's value.
6655     *
6656     * @see elm_fileselector_entry_path_get()
6657     */
6658    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6659
6660    /**
6661     * Get the entry's path string for a given file selector entry
6662     * widget
6663     *
6664     * @param obj The file selector entry widget
6665     * @return path The path string
6666     *
6667     * @see elm_fileselector_entry_path_set() for more details
6668     */
6669    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6670
6671    /**
6672     * Enable/disable a tree view in the given file selector entry
6673     * widget's internal file selector
6674     *
6675     * @param obj The file selector entry widget
6676     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6677     * disable
6678     *
6679     * This has the same effect as elm_fileselector_expandable_set(),
6680     * but now applied to a file selector entry's internal file
6681     * selector.
6682     *
6683     * @note There's no way to put a file selector entry's internal
6684     * file selector in "grid mode", as one may do with "pure" file
6685     * selectors.
6686     *
6687     * @see elm_fileselector_expandable_get()
6688     */
6689    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6690
6691    /**
6692     * Get whether tree view is enabled for the given file selector
6693     * entry widget's internal file selector
6694     *
6695     * @param obj The file selector entry widget
6696     * @return @c EINA_TRUE if @p obj widget's internal file selector
6697     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6698     *
6699     * @see elm_fileselector_expandable_set() for more details
6700     */
6701    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6702
6703    /**
6704     * Set whether a given file selector entry widget's internal file
6705     * selector is to display folders only or the directory contents,
6706     * as well.
6707     *
6708     * @param obj The file selector entry widget
6709     * @param only @c EINA_TRUE to make @p obj widget's internal file
6710     * selector only display directories, @c EINA_FALSE to make files
6711     * to be displayed in it too
6712     *
6713     * This has the same effect as elm_fileselector_folder_only_set(),
6714     * but now applied to a file selector entry's internal file
6715     * selector.
6716     *
6717     * @see elm_fileselector_folder_only_get()
6718     */
6719    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6720
6721    /**
6722     * Get whether a given file selector entry widget's internal file
6723     * selector is displaying folders only or the directory contents,
6724     * as well.
6725     *
6726     * @param obj The file selector entry widget
6727     * @return @c EINA_TRUE if @p obj widget's internal file
6728     * selector is only displaying directories, @c EINA_FALSE if files
6729     * are being displayed in it too (and on errors)
6730     *
6731     * @see elm_fileselector_entry_folder_only_set() for more details
6732     */
6733    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6734
6735    /**
6736     * Enable/disable the file name entry box where the user can type
6737     * in a name for a file, in a given file selector entry widget's
6738     * internal file selector.
6739     *
6740     * @param obj The file selector entry widget
6741     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6742     * file selector a "saving dialog", @c EINA_FALSE otherwise
6743     *
6744     * This has the same effect as elm_fileselector_is_save_set(),
6745     * but now applied to a file selector entry's internal file
6746     * selector.
6747     *
6748     * @see elm_fileselector_is_save_get()
6749     */
6750    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6751
6752    /**
6753     * Get whether the given file selector entry widget's internal
6754     * file selector is in "saving dialog" mode
6755     *
6756     * @param obj The file selector entry widget
6757     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6758     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6759     * errors)
6760     *
6761     * @see elm_fileselector_entry_is_save_set() for more details
6762     */
6763    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6764
6765    /**
6766     * Set whether a given file selector entry widget's internal file
6767     * selector will raise an Elementary "inner window", instead of a
6768     * dedicated Elementary window. By default, it won't.
6769     *
6770     * @param obj The file selector entry widget
6771     * @param value @c EINA_TRUE to make it use an inner window, @c
6772     * EINA_TRUE to make it use a dedicated window
6773     *
6774     * @see elm_win_inwin_add() for more information on inner windows
6775     * @see elm_fileselector_entry_inwin_mode_get()
6776     */
6777    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6778
6779    /**
6780     * Get whether a given file selector entry widget's internal file
6781     * selector will raise an Elementary "inner window", instead of a
6782     * dedicated Elementary window.
6783     *
6784     * @param obj The file selector entry widget
6785     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6786     * if it will use a dedicated window
6787     *
6788     * @see elm_fileselector_entry_inwin_mode_set() for more details
6789     */
6790    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6791
6792    /**
6793     * Set the initial file system path for a given file selector entry
6794     * widget
6795     *
6796     * @param obj The file selector entry widget
6797     * @param path The path string
6798     *
6799     * It must be a <b>directory</b> path, which will have the contents
6800     * displayed initially in the file selector's view, when invoked
6801     * from @p obj. The default initial path is the @c "HOME"
6802     * environment variable's value.
6803     *
6804     * @see elm_fileselector_entry_path_get()
6805     */
6806    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6807
6808    /**
6809     * Get the parent directory's path to the latest file selection on
6810     * a given filer selector entry widget
6811     *
6812     * @param obj The file selector object
6813     * @return The (full) path of the directory of the last selection
6814     * on @p obj widget, a @b stringshared string
6815     *
6816     * @see elm_fileselector_entry_path_set()
6817     */
6818    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6819
6820    /**
6821     * @}
6822     */
6823
6824    /**
6825     * @defgroup Scroller Scroller
6826     *
6827     * A scroller holds a single object and "scrolls it around". This means that
6828     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6829     * region around, allowing to move through a much larger object that is
6830     * contained in the scroller. The scroiller will always have a small minimum
6831     * size by default as it won't be limited by the contents of the scroller.
6832     *
6833     * Signals that you can add callbacks for are:
6834     * @li "edge,left" - the left edge of the content has been reached
6835     * @li "edge,right" - the right edge of the content has been reached
6836     * @li "edge,top" - the top edge of the content has been reached
6837     * @li "edge,bottom" - the bottom edge of the content has been reached
6838     * @li "scroll" - the content has been scrolled (moved)
6839     * @li "scroll,anim,start" - scrolling animation has started
6840     * @li "scroll,anim,stop" - scrolling animation has stopped
6841     * @li "scroll,drag,start" - dragging the contents around has started
6842     * @li "scroll,drag,stop" - dragging the contents around has stopped
6843     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6844     * user intervetion.
6845     *
6846     * @note When Elemementary is in embedded mode the scrollbars will not be
6847     * dragable, they appear merely as indicators of how much has been scrolled.
6848     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6849     * fingerscroll) won't work.
6850     *
6851     * In @ref tutorial_scroller you'll find an example of how to use most of
6852     * this API.
6853     * @{
6854     */
6855    /**
6856     * @brief Type that controls when scrollbars should appear.
6857     *
6858     * @see elm_scroller_policy_set()
6859     */
6860    typedef enum _Elm_Scroller_Policy
6861      {
6862         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6863         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6864         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6865         ELM_SCROLLER_POLICY_LAST
6866      } Elm_Scroller_Policy;
6867    /**
6868     * @brief Add a new scroller to the parent
6869     *
6870     * @param parent The parent object
6871     * @return The new object or NULL if it cannot be created
6872     */
6873    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6874    /**
6875     * @brief Set the content of the scroller widget (the object to be scrolled around).
6876     *
6877     * @param obj The scroller object
6878     * @param content The new content object
6879     *
6880     * Once the content object is set, a previously set one will be deleted.
6881     * If you want to keep that old content object, use the
6882     * elm_scroller_content_unset() function.
6883     */
6884    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6885    /**
6886     * @brief Get the content of the scroller widget
6887     *
6888     * @param obj The slider object
6889     * @return The content that is being used
6890     *
6891     * Return the content object which is set for this widget
6892     *
6893     * @see elm_scroller_content_set()
6894     */
6895    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6896    /**
6897     * @brief Unset the content of the scroller widget
6898     *
6899     * @param obj The slider object
6900     * @return The content that was being used
6901     *
6902     * Unparent and return the content object which was set for this widget
6903     *
6904     * @see elm_scroller_content_set()
6905     */
6906    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6907    /**
6908     * @brief Set custom theme elements for the scroller
6909     *
6910     * @param obj The scroller object
6911     * @param widget The widget name to use (default is "scroller")
6912     * @param base The base name to use (default is "base")
6913     */
6914    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6915    /**
6916     * @brief Make the scroller minimum size limited to the minimum size of the content
6917     *
6918     * @param obj The scroller object
6919     * @param w Enable limiting minimum size horizontally
6920     * @param h Enable limiting minimum size vertically
6921     *
6922     * By default the scroller will be as small as its design allows,
6923     * irrespective of its content. This will make the scroller minimum size the
6924     * right size horizontally and/or vertically to perfectly fit its content in
6925     * that direction.
6926     */
6927    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6928    /**
6929     * @brief Show a specific virtual region within the scroller content object
6930     *
6931     * @param obj The scroller object
6932     * @param x X coordinate of the region
6933     * @param y Y coordinate of the region
6934     * @param w Width of the region
6935     * @param h Height of the region
6936     *
6937     * This will ensure all (or part if it does not fit) of the designated
6938     * region in the virtual content object (0, 0 starting at the top-left of the
6939     * virtual content object) is shown within the scroller.
6940     */
6941    EAPI void         elm_scroller_region_show(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
6942    /**
6943     * @brief Set the scrollbar visibility policy
6944     *
6945     * @param obj The scroller object
6946     * @param policy_h Horizontal scrollbar policy
6947     * @param policy_v Vertical scrollbar policy
6948     *
6949     * This sets the scrollbar visibility policy for the given scroller.
6950     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
6951     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6952     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6953     * respectively for the horizontal and vertical scrollbars.
6954     */
6955    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6956    /**
6957     * @brief Gets scrollbar visibility policy
6958     *
6959     * @param obj The scroller object
6960     * @param policy_h Horizontal scrollbar policy
6961     * @param policy_v Vertical scrollbar policy
6962     *
6963     * @see elm_scroller_policy_set()
6964     */
6965    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6966    /**
6967     * @brief Get the currently visible content region
6968     *
6969     * @param obj The scroller object
6970     * @param x X coordinate of the region
6971     * @param y Y coordinate of the region
6972     * @param w Width of the region
6973     * @param h Height of the region
6974     *
6975     * This gets the current region in the content object that is visible through
6976     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6977     * w, @p h values pointed to.
6978     *
6979     * @note All coordinates are relative to the content.
6980     *
6981     * @see elm_scroller_region_show()
6982     */
6983    EAPI void         elm_scroller_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6984    /**
6985     * @brief Get the size of the content object
6986     *
6987     * @param obj The scroller object
6988     * @param w Width return
6989     * @param h Height return
6990     *
6991     * This gets the size of the content object of the scroller.
6992     */
6993    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6994    /**
6995     * @brief Set bouncing behavior
6996     *
6997     * @param obj The scroller object
6998     * @param h_bounce Will the scroller bounce horizontally or not
6999     * @param v_bounce Will the scroller bounce vertically or not
7000     *
7001     * When scrolling, the scroller may "bounce" when reaching an edge of the
7002     * content object. This is a visual way to indicate the end has been reached.
7003     * This is enabled by default for both axis. This will set if it is enabled
7004     * for that axis with the boolean parameters for each axis.
7005     */
7006    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7007    /**
7008     * @brief Get the bounce mode
7009     *
7010     * @param obj The Scroller object
7011     * @param h_bounce Allow bounce horizontally
7012     * @param v_bounce Allow bounce vertically
7013     *
7014     * @see elm_scroller_bounce_set()
7015     */
7016    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7017    /**
7018     * @brief Set scroll page size relative to viewport size.
7019     *
7020     * @param obj The scroller object
7021     * @param h_pagerel The horizontal page relative size
7022     * @param v_pagerel The vertical page relative size
7023     *
7024     * The scroller is capable of limiting scrolling by the user to "pages". That
7025     * is to jump by and only show a "whole page" at a time as if the continuous
7026     * area of the scroller content is split into page sized pieces. This sets
7027     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7028     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7029     * axis. This is mutually exclusive with page size
7030     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7031     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
7032     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7033     * the other axis.
7034     */
7035    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7036    /**
7037     * @brief Set scroll page size.
7038     *
7039     * @param obj The scroller object
7040     * @param h_pagesize The horizontal page size
7041     * @param v_pagesize The vertical page size
7042     *
7043     * This sets the page size to an absolute fixed value, with 0 turning it off
7044     * for that axis.
7045     *
7046     * @see elm_scroller_page_relative_set()
7047     */
7048    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7049    /**
7050     * @brief Get scroll current page number.
7051     *
7052     * @param obj The scroller object
7053     * @param h_pagenumber The horizontal page number
7054     * @param v_pagenumber The vertical page number
7055     *
7056     * The page number starts from 0. 0 is the first page.
7057     * Current page means the page which meet the top-left of the viewport.
7058     * If there are two or more pages in the viewport, it returns the number of page
7059     * which meet the top-left of the viewport.
7060     *
7061     * @see elm_scroller_last_page_get()
7062     * @see elm_scroller_page_show()
7063     * @see elm_scroller_page_brint_in()
7064     */
7065    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7066    /**
7067     * @brief Get scroll last page number.
7068     *
7069     * @param obj The scroller object
7070     * @param h_pagenumber The horizontal page number
7071     * @param v_pagenumber The vertical page number
7072     *
7073     * The page number starts from 0. 0 is the first page.
7074     * This returns the last page number among the pages.
7075     *
7076     * @see elm_scroller_current_page_get()
7077     * @see elm_scroller_page_show()
7078     * @see elm_scroller_page_brint_in()
7079     */
7080    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7081    /**
7082     * Show a specific virtual region within the scroller content object by page number.
7083     *
7084     * @param obj The scroller object
7085     * @param h_pagenumber The horizontal page number
7086     * @param v_pagenumber The vertical page number
7087     *
7088     * 0, 0 of the indicated page is located at the top-left of the viewport.
7089     * This will jump to the page directly without animation.
7090     *
7091     * Example of usage:
7092     *
7093     * @code
7094     * sc = elm_scroller_add(win);
7095     * elm_scroller_content_set(sc, content);
7096     * elm_scroller_page_relative_set(sc, 1, 0);
7097     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7098     * elm_scroller_page_show(sc, h_page + 1, v_page);
7099     * @endcode
7100     *
7101     * @see elm_scroller_page_bring_in()
7102     */
7103    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7104    /**
7105     * Show a specific virtual region within the scroller content object by page number.
7106     *
7107     * @param obj The scroller object
7108     * @param h_pagenumber The horizontal page number
7109     * @param v_pagenumber The vertical page number
7110     *
7111     * 0, 0 of the indicated page is located at the top-left of the viewport.
7112     * This will slide to the page with animation.
7113     *
7114     * Example of usage:
7115     *
7116     * @code
7117     * sc = elm_scroller_add(win);
7118     * elm_scroller_content_set(sc, content);
7119     * elm_scroller_page_relative_set(sc, 1, 0);
7120     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7121     * elm_scroller_page_bring_in(sc, h_page, v_page);
7122     * @endcode
7123     *
7124     * @see elm_scroller_page_show()
7125     */
7126    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7127    /**
7128     * @brief Show a specific virtual region within the scroller content object.
7129     *
7130     * @param obj The scroller object
7131     * @param x X coordinate of the region
7132     * @param y Y coordinate of the region
7133     * @param w Width of the region
7134     * @param h Height of the region
7135     *
7136     * This will ensure all (or part if it does not fit) of the designated
7137     * region in the virtual content object (0, 0 starting at the top-left of the
7138     * virtual content object) is shown within the scroller. Unlike
7139     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7140     * to this location (if configuration in general calls for transitions). It
7141     * may not jump immediately to the new location and make take a while and
7142     * show other content along the way.
7143     *
7144     * @see elm_scroller_region_show()
7145     */
7146    EAPI void         elm_scroller_region_bring_in(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7147    /**
7148     * @brief Set event propagation on a scroller
7149     *
7150     * @param obj The scroller object
7151     * @param propagation If propagation is enabled or not
7152     *
7153     * This enables or disabled event propagation from the scroller content to
7154     * the scroller and its parent. By default event propagation is disabled.
7155     */
7156    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7157    /**
7158     * @brief Get event propagation for a scroller
7159     *
7160     * @param obj The scroller object
7161     * @return The propagation state
7162     *
7163     * This gets the event propagation for a scroller.
7164     *
7165     * @see elm_scroller_propagate_events_set()
7166     */
7167    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
7168    /**
7169     * @}
7170     */
7171
7172    /**
7173     * @defgroup Label Label
7174     *
7175     * @image html img/widget/label/preview-00.png
7176     * @image latex img/widget/label/preview-00.eps
7177     *
7178     * @brief Widget to display text, with simple html-like markup.
7179     *
7180     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7181     * text doesn't fit the geometry of the label it will be ellipsized or be
7182     * cut. Elementary provides several themes for this widget:
7183     * @li default - No animation
7184     * @li marker - Centers the text in the label and make it bold by default
7185     * @li slide_long - The entire text appears from the right of the screen and
7186     * slides until it disappears in the left of the screen(reappering on the
7187     * right again).
7188     * @li slide_short - The text appears in the left of the label and slides to
7189     * the right to show the overflow. When all of the text has been shown the
7190     * position is reset.
7191     * @li slide_bounce - The text appears in the left of the label and slides to
7192     * the right to show the overflow. When all of the text has been shown the
7193     * animation reverses, moving the text to the left.
7194     *
7195     * Custom themes can of course invent new markup tags and style them any way
7196     * they like.
7197     *
7198     * See @ref tutorial_label for a demonstration of how to use a label widget.
7199     * @{
7200     */
7201    /**
7202     * @brief Add a new label to the parent
7203     *
7204     * @param parent The parent object
7205     * @return The new object or NULL if it cannot be created
7206     */
7207    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7208    /**
7209     * @brief Set the label on the label object
7210     *
7211     * @param obj The label object
7212     * @param label The label will be used on the label object
7213     * @deprecated See elm_object_text_set()
7214     */
7215    EINA_DEPRECATED EAPI void elm_label_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_set instead */
7216    /**
7217     * @brief Get the label used on the label object
7218     *
7219     * @param obj The label object
7220     * @return The string inside the label
7221     * @deprecated See elm_object_text_get()
7222     */
7223    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7224    /**
7225     * @brief Set the wrapping behavior of the label
7226     *
7227     * @param obj The label object
7228     * @param wrap To wrap text or not
7229     *
7230     * By default no wrapping is done. Possible values for @p wrap are:
7231     * @li ELM_WRAP_NONE - No wrapping
7232     * @li ELM_WRAP_CHAR - wrap between characters
7233     * @li ELM_WRAP_WORD - wrap between words
7234     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7235     */
7236    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7237    /**
7238     * @brief Get the wrapping behavior of the label
7239     *
7240     * @param obj The label object
7241     * @return Wrap type
7242     *
7243     * @see elm_label_line_wrap_set()
7244     */
7245    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7246    /**
7247     * @brief Set wrap width of the label
7248     *
7249     * @param obj The label object
7250     * @param w The wrap width in pixels at a minimum where words need to wrap
7251     *
7252     * This function sets the maximum width size hint of the label.
7253     *
7254     * @warning This is only relevant if the label is inside a container.
7255     */
7256    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7257    /**
7258     * @brief Get wrap width of the label
7259     *
7260     * @param obj The label object
7261     * @return The wrap width in pixels at a minimum where words need to wrap
7262     *
7263     * @see elm_label_wrap_width_set()
7264     */
7265    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7266    /**
7267     * @brief Set wrap height of the label
7268     *
7269     * @param obj The label object
7270     * @param h The wrap height in pixels at a minimum where words need to wrap
7271     *
7272     * This function sets the maximum height size hint of the label.
7273     *
7274     * @warning This is only relevant if the label is inside a container.
7275     */
7276    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7277    /**
7278     * @brief get wrap width of the label
7279     *
7280     * @param obj The label object
7281     * @return The wrap height in pixels at a minimum where words need to wrap
7282     */
7283    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7284    /**
7285     * @brief Set the font size on the label object.
7286     *
7287     * @param obj The label object
7288     * @param size font size
7289     *
7290     * @warning NEVER use this. It is for hyper-special cases only. use styles
7291     * instead. e.g. "big", "medium", "small" - or better name them by use:
7292     * "title", "footnote", "quote" etc.
7293     */
7294    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7295    /**
7296     * @brief Set the text color on the label object
7297     *
7298     * @param obj The label object
7299     * @param r Red property background color of The label object
7300     * @param g Green property background color of The label object
7301     * @param b Blue property background color of The label object
7302     * @param a Alpha property background color of The label object
7303     *
7304     * @warning NEVER use this. It is for hyper-special cases only. use styles
7305     * instead. e.g. "big", "medium", "small" - or better name them by use:
7306     * "title", "footnote", "quote" etc.
7307     */
7308    EAPI void         elm_label_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
7309    /**
7310     * @brief Set the text align on the label object
7311     *
7312     * @param obj The label object
7313     * @param align align mode ("left", "center", "right")
7314     *
7315     * @warning NEVER use this. It is for hyper-special cases only. use styles
7316     * instead. e.g. "big", "medium", "small" - or better name them by use:
7317     * "title", "footnote", "quote" etc.
7318     */
7319    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7320    /**
7321     * @brief Set background color of the label
7322     *
7323     * @param obj The label object
7324     * @param r Red property background color of The label object
7325     * @param g Green property background color of The label object
7326     * @param b Blue property background color of The label object
7327     * @param a Alpha property background alpha of The label object
7328     *
7329     * @warning NEVER use this. It is for hyper-special cases only. use styles
7330     * instead. e.g. "big", "medium", "small" - or better name them by use:
7331     * "title", "footnote", "quote" etc.
7332     */
7333    EAPI void         elm_label_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a) EINA_ARG_NONNULL(1);
7334    /**
7335     * @brief Set the ellipsis behavior of the label
7336     *
7337     * @param obj The label object
7338     * @param ellipsis To ellipsis text or not
7339     *
7340     * If set to true and the text doesn't fit in the label an ellipsis("...")
7341     * will be shown at the end of the widget.
7342     *
7343     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7344     * choosen wrap method was ELM_WRAP_WORD.
7345     */
7346    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7347    /**
7348     * @brief Set the text slide of the label
7349     *
7350     * @param obj The label object
7351     * @param slide To start slide or stop
7352     *
7353     * If set to true the text of the label will slide throught the length of
7354     * label.
7355     *
7356     * @warning This only work with the themes "slide_short", "slide_long" and
7357     * "slide_bounce".
7358     */
7359    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7360    /**
7361     * @brief Get the text slide mode of the label
7362     *
7363     * @param obj The label object
7364     * @return slide slide mode value
7365     *
7366     * @see elm_label_slide_set()
7367     */
7368    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7369    /**
7370     * @brief Set the slide duration(speed) of the label
7371     *
7372     * @param obj The label object
7373     * @return The duration in seconds in moving text from slide begin position
7374     * to slide end position
7375     */
7376    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7377    /**
7378     * @brief Get the slide duration(speed) of the label
7379     *
7380     * @param obj The label object
7381     * @return The duration time in moving text from slide begin position to slide end position
7382     *
7383     * @see elm_label_slide_duration_set()
7384     */
7385    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7386    /**
7387     * @}
7388     */
7389
7390    /**
7391     * @defgroup Toggle Toggle
7392     *
7393     * @image html img/widget/toggle/preview-00.png
7394     * @image latex img/widget/toggle/preview-00.eps
7395     *
7396     * @brief A toggle is a slider which can be used to toggle between
7397     * two values.  It has two states: on and off.
7398     *
7399     * Signals that you can add callbacks for are:
7400     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7401     *                 until the toggle is released by the cursor (assuming it
7402     *                 has been triggered by the cursor in the first place).
7403     *
7404     * @ref tutorial_toggle show how to use a toggle.
7405     * @{
7406     */
7407    /**
7408     * @brief Add a toggle to @p parent.
7409     *
7410     * @param parent The parent object
7411     *
7412     * @return The toggle object
7413     */
7414    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7415    /**
7416     * @brief Sets the label to be displayed with the toggle.
7417     *
7418     * @param obj The toggle object
7419     * @param label The label to be displayed
7420     *
7421     * @deprecated use elm_object_text_set() instead.
7422     */
7423    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7424    /**
7425     * @brief Gets the label of the toggle
7426     *
7427     * @param obj  toggle object
7428     * @return The label of the toggle
7429     *
7430     * @deprecated use elm_object_text_get() instead.
7431     */
7432    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7433    /**
7434     * @brief Set the icon used for the toggle
7435     *
7436     * @param obj The toggle object
7437     * @param icon The icon object for the button
7438     *
7439     * Once the icon object is set, a previously set one will be deleted
7440     * If you want to keep that old content object, use the
7441     * elm_toggle_icon_unset() function.
7442     */
7443    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7444    /**
7445     * @brief Get the icon used for the toggle
7446     *
7447     * @param obj The toggle object
7448     * @return The icon object that is being used
7449     *
7450     * Return the icon object which is set for this widget.
7451     *
7452     * @see elm_toggle_icon_set()
7453     */
7454    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7455    /**
7456     * @brief Unset the icon used for the toggle
7457     *
7458     * @param obj The toggle object
7459     * @return The icon object that was being used
7460     *
7461     * Unparent and return the icon object which was set for this widget.
7462     *
7463     * @see elm_toggle_icon_set()
7464     */
7465    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7466    /**
7467     * @brief Sets the labels to be associated with the on and off states of the toggle.
7468     *
7469     * @param obj The toggle object
7470     * @param onlabel The label displayed when the toggle is in the "on" state
7471     * @param offlabel The label displayed when the toggle is in the "off" state
7472     */
7473    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7474    /**
7475     * @brief Gets the labels associated with the on and off states of the toggle.
7476     *
7477     * @param obj The toggle object
7478     * @param onlabel A char** to place the onlabel of @p obj into
7479     * @param offlabel A char** to place the offlabel of @p obj into
7480     */
7481    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7482    /**
7483     * @brief Sets the state of the toggle to @p state.
7484     *
7485     * @param obj The toggle object
7486     * @param state The state of @p obj
7487     */
7488    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7489    /**
7490     * @brief Gets the state of the toggle to @p state.
7491     *
7492     * @param obj The toggle object
7493     * @return The state of @p obj
7494     */
7495    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7496    /**
7497     * @brief Sets the state pointer of the toggle to @p statep.
7498     *
7499     * @param obj The toggle object
7500     * @param statep The state pointer of @p obj
7501     */
7502    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7503    /**
7504     * @}
7505     */
7506
7507    /**
7508     * @defgroup Frame Frame
7509     *
7510     * @image html img/widget/frame/preview-00.png
7511     * @image latex img/widget/frame/preview-00.eps
7512     *
7513     * @brief Frame is a widget that holds some content and has a title.
7514     *
7515     * The default look is a frame with a title, but Frame supports multple
7516     * styles:
7517     * @li default
7518     * @li pad_small
7519     * @li pad_medium
7520     * @li pad_large
7521     * @li pad_huge
7522     * @li outdent_top
7523     * @li outdent_bottom
7524     *
7525     * Of all this styles only default shows the title. Frame emits no signals.
7526     *
7527     * For a detailed example see the @ref tutorial_frame.
7528     *
7529     * @{
7530     */
7531    /**
7532     * @brief Add a new frame to the parent
7533     *
7534     * @param parent The parent object
7535     * @return The new object or NULL if it cannot be created
7536     */
7537    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7538    /**
7539     * @brief Set the frame label
7540     *
7541     * @param obj The frame object
7542     * @param label The label of this frame object
7543     *
7544     * @deprecated use elm_object_text_set() instead.
7545     */
7546    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7547    /**
7548     * @brief Get the frame label
7549     *
7550     * @param obj The frame object
7551     *
7552     * @return The label of this frame objet or NULL if unable to get frame
7553     *
7554     * @deprecated use elm_object_text_get() instead.
7555     */
7556    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7557    /**
7558     * @brief Set the content of the frame widget
7559     *
7560     * Once the content object is set, a previously set one will be deleted.
7561     * If you want to keep that old content object, use the
7562     * elm_frame_content_unset() function.
7563     *
7564     * @param obj The frame object
7565     * @param content The content will be filled in this frame object
7566     */
7567    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7568    /**
7569     * @brief Get the content of the frame widget
7570     *
7571     * Return the content object which is set for this widget
7572     *
7573     * @param obj The frame object
7574     * @return The content that is being used
7575     */
7576    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7577    /**
7578     * @brief Unset the content of the frame widget
7579     *
7580     * Unparent and return the content object which was set for this widget
7581     *
7582     * @param obj The frame object
7583     * @return The content that was being used
7584     */
7585    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7586    /**
7587     * @}
7588     */
7589
7590    /**
7591     * @defgroup Table Table
7592     *
7593     * A container widget to arrange other widgets in a table where items can
7594     * also span multiple columns or rows - even overlap (and then be raised or
7595     * lowered accordingly to adjust stacking if they do overlap).
7596     *
7597     * The followin are examples of how to use a table:
7598     * @li @ref tutorial_table_01
7599     * @li @ref tutorial_table_02
7600     *
7601     * @{
7602     */
7603    /**
7604     * @brief Add a new table to the parent
7605     *
7606     * @param parent The parent object
7607     * @return The new object or NULL if it cannot be created
7608     */
7609    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7610    /**
7611     * @brief Set the homogeneous layout in the table
7612     *
7613     * @param obj The layout object
7614     * @param homogeneous A boolean to set if the layout is homogeneous in the
7615     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7616     */
7617    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7618    /**
7619     * @brief Get the current table homogeneous mode.
7620     *
7621     * @param obj The table object
7622     * @return A boolean to indicating if the layout is homogeneous in the table
7623     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7624     */
7625    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7626    /**
7627     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7628     */
7629    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7630    /**
7631     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7632     */
7633    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7634    /**
7635     * @brief Set padding between cells.
7636     *
7637     * @param obj The layout object.
7638     * @param horizontal set the horizontal padding.
7639     * @param vertical set the vertical padding.
7640     *
7641     * Default value is 0.
7642     */
7643    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7644    /**
7645     * @brief Get padding between cells.
7646     *
7647     * @param obj The layout object.
7648     * @param horizontal set the horizontal padding.
7649     * @param vertical set the vertical padding.
7650     */
7651    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7652    /**
7653     * @brief Add a subobject on the table with the coordinates passed
7654     *
7655     * @param obj The table object
7656     * @param subobj The subobject to be added to the table
7657     * @param x Row number
7658     * @param y Column number
7659     * @param w rowspan
7660     * @param h colspan
7661     *
7662     * @note All positioning inside the table is relative to rows and columns, so
7663     * a value of 0 for x and y, means the top left cell of the table, and a
7664     * value of 1 for w and h means @p subobj only takes that 1 cell.
7665     */
7666    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7667    /**
7668     * @brief Remove child from table.
7669     *
7670     * @param obj The table object
7671     * @param subobj The subobject
7672     */
7673    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7674    /**
7675     * @brief Faster way to remove all child objects from a table object.
7676     *
7677     * @param obj The table object
7678     * @param clear If true, will delete children, else just remove from table.
7679     */
7680    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7681    /**
7682     * @brief Set the packing location of an existing child of the table
7683     *
7684     * @param subobj The subobject to be modified in the table
7685     * @param x Row number
7686     * @param y Column number
7687     * @param w rowspan
7688     * @param h colspan
7689     *
7690     * Modifies the position of an object already in the table.
7691     *
7692     * @note All positioning inside the table is relative to rows and columns, so
7693     * a value of 0 for x and y, means the top left cell of the table, and a
7694     * value of 1 for w and h means @p subobj only takes that 1 cell.
7695     */
7696    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7697    /**
7698     * @brief Get the packing location of an existing child of the table
7699     *
7700     * @param subobj The subobject to be modified in the table
7701     * @param x Row number
7702     * @param y Column number
7703     * @param w rowspan
7704     * @param h colspan
7705     *
7706     * @see elm_table_pack_set()
7707     */
7708    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7709    /**
7710     * @}
7711     */
7712
7713    /**
7714     * @defgroup Gengrid Gengrid (Generic grid)
7715     *
7716     * This widget aims to position objects in a grid layout while
7717     * actually creating and rendering only the visible ones, using the
7718     * same idea as the @ref Genlist "genlist": the user defines a @b
7719     * class for each item, specifying functions that will be called at
7720     * object creation, deletion, etc. When those items are selected by
7721     * the user, a callback function is issued. Users may interact with
7722     * a gengrid via the mouse (by clicking on items to select them and
7723     * clicking on the grid's viewport and swiping to pan the whole
7724     * view) or via the keyboard, navigating through item with the
7725     * arrow keys.
7726     *
7727     * @section Gengrid_Layouts Gengrid layouts
7728     *
7729     * Gengrids may layout its items in one of two possible layouts:
7730     * - horizontal or
7731     * - vertical.
7732     *
7733     * When in "horizontal mode", items will be placed in @b columns,
7734     * from top to bottom and, when the space for a column is filled,
7735     * another one is started on the right, thus expanding the grid
7736     * horizontally, making for horizontal scrolling. When in "vertical
7737     * mode" , though, items will be placed in @b rows, from left to
7738     * right and, when the space for a row is filled, another one is
7739     * started below, thus expanding the grid vertically (and making
7740     * for vertical scrolling).
7741     *
7742     * @section Gengrid_Items Gengrid items
7743     *
7744     * An item in a gengrid can have 0 or more text labels (they can be
7745     * regular text or textblock Evas objects - that's up to the style
7746     * to determine), 0 or more icons (which are simply objects
7747     * swallowed into the gengrid item's theming Edje object) and 0 or
7748     * more <b>boolean states</b>, which have the behavior left to the
7749     * user to define. The Edje part names for each of these properties
7750     * will be looked up, in the theme file for the gengrid, under the
7751     * Edje (string) data items named @c "labels", @c "icons" and @c
7752     * "states", respectively. For each of those properties, if more
7753     * than one part is provided, they must have names listed separated
7754     * by spaces in the data fields. For the default gengrid item
7755     * theme, we have @b one label part (@c "elm.text"), @b two icon
7756     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7757     * no state parts.
7758     *
7759     * A gengrid item may be at one of several styles. Elementary
7760     * provides one by default - "default", but this can be extended by
7761     * system or application custom themes/overlays/extensions (see
7762     * @ref Theme "themes" for more details).
7763     *
7764     * @section Gengrid_Item_Class Gengrid item classes
7765     *
7766     * In order to have the ability to add and delete items on the fly,
7767     * gengrid implements a class (callback) system where the
7768     * application provides a structure with information about that
7769     * type of item (gengrid may contain multiple different items with
7770     * different classes, states and styles). Gengrid will call the
7771     * functions in this struct (methods) when an item is "realized"
7772     * (i.e., created dynamically, while the user is scrolling the
7773     * grid). All objects will simply be deleted when no longer needed
7774     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7775     * contains the following members:
7776     * - @c item_style - This is a constant string and simply defines
7777     * the name of the item style. It @b must be specified and the
7778     * default should be @c "default".
7779     * - @c func.label_get - This function is called when an item
7780     * object is actually created. The @c data parameter will point to
7781     * the same data passed to elm_gengrid_item_append() and related
7782     * item creation functions. The @c obj parameter is the gengrid
7783     * object itself, while the @c part one is the name string of one
7784     * of the existing text parts in the Edje group implementing the
7785     * item's theme. This function @b must return a strdup'()ed string,
7786     * as the caller will free() it when done. See
7787     * #Elm_Gengrid_Item_Label_Get_Cb.
7788     * - @c func.icon_get - This function is called when an item object
7789     * is actually created. The @c data parameter will point to the
7790     * same data passed to elm_gengrid_item_append() and related item
7791     * creation functions. The @c obj parameter is the gengrid object
7792     * itself, while the @c part one is the name string of one of the
7793     * existing (icon) swallow parts in the Edje group implementing the
7794     * item's theme. It must return @c NULL, when no icon is desired,
7795     * or a valid object handle, otherwise. The object will be deleted
7796     * by the gengrid on its deletion or when the item is "unrealized".
7797     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7798     * - @c func.state_get - This function is called when an item
7799     * object is actually created. The @c data parameter will point to
7800     * the same data passed to elm_gengrid_item_append() and related
7801     * item creation functions. The @c obj parameter is the gengrid
7802     * object itself, while the @c part one is the name string of one
7803     * of the state parts in the Edje group implementing the item's
7804     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7805     * true/on. Gengrids will emit a signal to its theming Edje object
7806     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7807     * "source" arguments, respectively, when the state is true (the
7808     * default is false), where @c XXX is the name of the (state) part.
7809     * See #Elm_Gengrid_Item_State_Get_Cb.
7810     * - @c func.del - This is called when elm_gengrid_item_del() is
7811     * called on an item or elm_gengrid_clear() is called on the
7812     * gengrid. This is intended for use when gengrid items are
7813     * deleted, so any data attached to the item (e.g. its data
7814     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7815     *
7816     * @section Gengrid_Usage_Hints Usage hints
7817     *
7818     * If the user wants to have multiple items selected at the same
7819     * time, elm_gengrid_multi_select_set() will permit it. If the
7820     * gengrid is single-selection only (the default), then
7821     * elm_gengrid_select_item_get() will return the selected item or
7822     * @c NULL, if none is selected. If the gengrid is under
7823     * multi-selection, then elm_gengrid_selected_items_get() will
7824     * return a list (that is only valid as long as no items are
7825     * modified (added, deleted, selected or unselected) of child items
7826     * on a gengrid.
7827     *
7828     * If an item changes (internal (boolean) state, label or icon
7829     * changes), then use elm_gengrid_item_update() to have gengrid
7830     * update the item with the new state. A gengrid will re-"realize"
7831     * the item, thus calling the functions in the
7832     * #Elm_Gengrid_Item_Class set for that item.
7833     *
7834     * To programmatically (un)select an item, use
7835     * elm_gengrid_item_selected_set(). To get its selected state use
7836     * elm_gengrid_item_selected_get(). To make an item disabled
7837     * (unable to be selected and appear differently) use
7838     * elm_gengrid_item_disabled_set() to set this and
7839     * elm_gengrid_item_disabled_get() to get the disabled state.
7840     *
7841     * Grid cells will only have their selection smart callbacks called
7842     * when firstly getting selected. Any further clicks will do
7843     * nothing, unless you enable the "always select mode", with
7844     * elm_gengrid_always_select_mode_set(), thus making every click to
7845     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7846     * turn off the ability to select items entirely in the widget and
7847     * they will neither appear selected nor call the selection smart
7848     * callbacks.
7849     *
7850     * Remember that you can create new styles and add your own theme
7851     * augmentation per application with elm_theme_extension_add(). If
7852     * you absolutely must have a specific style that overrides any
7853     * theme the user or system sets up you can use
7854     * elm_theme_overlay_add() to add such a file.
7855     *
7856     * @section Gengrid_Smart_Events Gengrid smart events
7857     *
7858     * Smart events that you can add callbacks for are:
7859     * - @c "activated" - The user has double-clicked or pressed
7860     *   (enter|return|spacebar) on an item. The @c event_info parameter
7861     *   is the gengrid item that was activated.
7862     * - @c "clicked,double" - The user has double-clicked an item.
7863     *   The @c event_info parameter is the gengrid item that was double-clicked.
7864     * - @c "longpressed" - This is called when the item is pressed for a certain
7865     *   amount of time. By default it's 1 second.
7866     * - @c "selected" - The user has made an item selected. The
7867     *   @c event_info parameter is the gengrid item that was selected.
7868     * - @c "unselected" - The user has made an item unselected. The
7869     *   @c event_info parameter is the gengrid item that was unselected.
7870     * - @c "realized" - This is called when the item in the gengrid
7871     *   has its implementing Evas object instantiated, de facto. @c
7872     *   event_info is the gengrid item that was created. The object
7873     *   may be deleted at any time, so it is highly advised to the
7874     *   caller @b not to use the object pointer returned from
7875     *   elm_gengrid_item_object_get(), because it may point to freed
7876     *   objects.
7877     * - @c "unrealized" - This is called when the implementing Evas
7878     *   object for this item is deleted. @c event_info is the gengrid
7879     *   item that was deleted.
7880     * - @c "changed" - Called when an item is added, removed, resized
7881     *   or moved and when the gengrid is resized or gets "horizontal"
7882     *   property changes.
7883     * - @c "scroll,anim,start" - This is called when scrolling animation has
7884     *   started.
7885     * - @c "scroll,anim,stop" - This is called when scrolling animation has
7886     *   stopped.
7887     * - @c "drag,start,up" - Called when the item in the gengrid has
7888     *   been dragged (not scrolled) up.
7889     * - @c "drag,start,down" - Called when the item in the gengrid has
7890     *   been dragged (not scrolled) down.
7891     * - @c "drag,start,left" - Called when the item in the gengrid has
7892     *   been dragged (not scrolled) left.
7893     * - @c "drag,start,right" - Called when the item in the gengrid has
7894     *   been dragged (not scrolled) right.
7895     * - @c "drag,stop" - Called when the item in the gengrid has
7896     *   stopped being dragged.
7897     * - @c "drag" - Called when the item in the gengrid is being
7898     *   dragged.
7899     * - @c "scroll" - called when the content has been scrolled
7900     *   (moved).
7901     * - @c "scroll,drag,start" - called when dragging the content has
7902     *   started.
7903     * - @c "scroll,drag,stop" - called when dragging the content has
7904     *   stopped.
7905     * - @c "scroll,edge,top" - This is called when the gengrid is scrolled until
7906     *   the top edge.
7907     * - @c "scroll,edge,bottom" - This is called when the gengrid is scrolled
7908     *   until the bottom edge.
7909     * - @c "scroll,edge,left" - This is called when the gengrid is scrolled
7910     *   until the left edge.
7911     * - @c "scroll,edge,right" - This is called when the gengrid is scrolled
7912     *   until the right edge.
7913     *
7914     * List of gengrid examples:
7915     * @li @ref gengrid_example
7916     */
7917
7918    /**
7919     * @addtogroup Gengrid
7920     * @{
7921     */
7922
7923    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7924    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7925    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7926    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7927    typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
7928    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gengrid item classes. */
7929    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7930
7931    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7932    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7933    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7934    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7935
7936    /**
7937     * @struct _Elm_Gengrid_Item_Class
7938     *
7939     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7940     * field details.
7941     */
7942    struct _Elm_Gengrid_Item_Class
7943      {
7944         const char             *item_style;
7945         struct _Elm_Gengrid_Item_Class_Func
7946           {
7947              Elm_Gengrid_Item_Label_Get_Cb label_get;
7948              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7949              Elm_Gengrid_Item_State_Get_Cb state_get;
7950              Elm_Gengrid_Item_Del_Cb       del;
7951           } func;
7952      }; /**< #Elm_Gengrid_Item_Class member definitions */
7953
7954    /**
7955     * Add a new gengrid widget to the given parent Elementary
7956     * (container) object
7957     *
7958     * @param parent The parent object
7959     * @return a new gengrid widget handle or @c NULL, on errors
7960     *
7961     * This function inserts a new gengrid widget on the canvas.
7962     *
7963     * @see elm_gengrid_item_size_set()
7964     * @see elm_gengrid_group_item_size_set()
7965     * @see elm_gengrid_horizontal_set()
7966     * @see elm_gengrid_item_append()
7967     * @see elm_gengrid_item_del()
7968     * @see elm_gengrid_clear()
7969     *
7970     * @ingroup Gengrid
7971     */
7972    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7973
7974    /**
7975     * Set the size for the items of a given gengrid widget
7976     *
7977     * @param obj The gengrid object.
7978     * @param w The items' width.
7979     * @param h The items' height;
7980     *
7981     * A gengrid, after creation, has still no information on the size
7982     * to give to each of its cells. So, you most probably will end up
7983     * with squares one @ref Fingers "finger" wide, the default
7984     * size. Use this function to force a custom size for you items,
7985     * making them as big as you wish.
7986     *
7987     * @see elm_gengrid_item_size_get()
7988     *
7989     * @ingroup Gengrid
7990     */
7991    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7992
7993    /**
7994     * Get the size set for the items of a given gengrid widget
7995     *
7996     * @param obj The gengrid object.
7997     * @param w Pointer to a variable where to store the items' width.
7998     * @param h Pointer to a variable where to store the items' height.
7999     *
8000     * @note Use @c NULL pointers on the size values you're not
8001     * interested in: they'll be ignored by the function.
8002     *
8003     * @see elm_gengrid_item_size_get() for more details
8004     *
8005     * @ingroup Gengrid
8006     */
8007    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8008
8009    /**
8010     * Set the size for the group items of a given gengrid widget
8011     *
8012     * @param obj The gengrid object.
8013     * @param w The group items' width.
8014     * @param h The group items' height;
8015     *
8016     * A gengrid, after creation, has still no information on the size
8017     * to give to each of its cells. So, you most probably will end up
8018     * with squares one @ref Fingers "finger" wide, the default
8019     * size. Use this function to force a custom size for you group items,
8020     * making them as big as you wish.
8021     *
8022     * @see elm_gengrid_group_item_size_get()
8023     *
8024     * @ingroup Gengrid
8025     */
8026    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8027
8028    /**
8029     * Get the size set for the group items of a given gengrid widget
8030     *
8031     * @param obj The gengrid object.
8032     * @param w Pointer to a variable where to store the group items' width.
8033     * @param h Pointer to a variable where to store the group items' height.
8034     *
8035     * @note Use @c NULL pointers on the size values you're not
8036     * interested in: they'll be ignored by the function.
8037     *
8038     * @see elm_gengrid_group_item_size_get() for more details
8039     *
8040     * @ingroup Gengrid
8041     */
8042    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8043
8044    /**
8045     * Set the items grid's alignment within a given gengrid widget
8046     *
8047     * @param obj The gengrid object.
8048     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8049     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8050     *
8051     * This sets the alignment of the whole grid of items of a gengrid
8052     * within its given viewport. By default, those values are both
8053     * 0.5, meaning that the gengrid will have its items grid placed
8054     * exactly in the middle of its viewport.
8055     *
8056     * @note If given alignment values are out of the cited ranges,
8057     * they'll be changed to the nearest boundary values on the valid
8058     * ranges.
8059     *
8060     * @see elm_gengrid_align_get()
8061     *
8062     * @ingroup Gengrid
8063     */
8064    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8065
8066    /**
8067     * Get the items grid's alignment values within a given gengrid
8068     * widget
8069     *
8070     * @param obj The gengrid object.
8071     * @param align_x Pointer to a variable where to store the
8072     * horizontal alignment.
8073     * @param align_y Pointer to a variable where to store the vertical
8074     * alignment.
8075     *
8076     * @note Use @c NULL pointers on the alignment values you're not
8077     * interested in: they'll be ignored by the function.
8078     *
8079     * @see elm_gengrid_align_set() for more details
8080     *
8081     * @ingroup Gengrid
8082     */
8083    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8084
8085    /**
8086     * Set whether a given gengrid widget is or not able have items
8087     * @b reordered
8088     *
8089     * @param obj The gengrid object
8090     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8091     * @c EINA_FALSE to turn it off
8092     *
8093     * If a gengrid is set to allow reordering, a click held for more
8094     * than 0.5 over a given item will highlight it specially,
8095     * signalling the gengrid has entered the reordering state. From
8096     * that time on, the user will be able to, while still holding the
8097     * mouse button down, move the item freely in the gengrid's
8098     * viewport, replacing to said item to the locations it goes to.
8099     * The replacements will be animated and, whenever the user
8100     * releases the mouse button, the item being replaced gets a new
8101     * definitive place in the grid.
8102     *
8103     * @see elm_gengrid_reorder_mode_get()
8104     *
8105     * @ingroup Gengrid
8106     */
8107    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8108
8109    /**
8110     * Get whether a given gengrid widget is or not able have items
8111     * @b reordered
8112     *
8113     * @param obj The gengrid object
8114     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8115     * off
8116     *
8117     * @see elm_gengrid_reorder_mode_set() for more details
8118     *
8119     * @ingroup Gengrid
8120     */
8121    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8122
8123    /**
8124     * Append a new item in a given gengrid widget.
8125     *
8126     * @param obj The gengrid object.
8127     * @param gic The item class for the item.
8128     * @param data The item data.
8129     * @param func Convenience function called when the item is
8130     * selected.
8131     * @param func_data Data to be passed to @p func.
8132     * @return A handle to the item added or @c NULL, on errors.
8133     *
8134     * This adds an item to the beginning of the gengrid.
8135     *
8136     * @see elm_gengrid_item_prepend()
8137     * @see elm_gengrid_item_insert_before()
8138     * @see elm_gengrid_item_insert_after()
8139     * @see elm_gengrid_item_del()
8140     *
8141     * @ingroup Gengrid
8142     */
8143    EAPI Elm_Gengrid_Item  *elm_gengrid_item_append(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
8144
8145    /**
8146     * Prepend a new item in a given gengrid widget.
8147     *
8148     * @param obj The gengrid object.
8149     * @param gic The item class for the item.
8150     * @param data The item data.
8151     * @param func Convenience function called when the item is
8152     * selected.
8153     * @param func_data Data to be passed to @p func.
8154     * @return A handle to the item added or @c NULL, on errors.
8155     *
8156     * This adds an item to the end of the gengrid.
8157     *
8158     * @see elm_gengrid_item_append()
8159     * @see elm_gengrid_item_insert_before()
8160     * @see elm_gengrid_item_insert_after()
8161     * @see elm_gengrid_item_del()
8162     *
8163     * @ingroup Gengrid
8164     */
8165    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prepend(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
8166
8167    /**
8168     * Insert an item before another in a gengrid widget
8169     *
8170     * @param obj The gengrid object.
8171     * @param gic The item class for the item.
8172     * @param data The item data.
8173     * @param relative The item to place this new one before.
8174     * @param func Convenience function called when the item is
8175     * selected.
8176     * @param func_data Data to be passed to @p func.
8177     * @return A handle to the item added or @c NULL, on errors.
8178     *
8179     * This inserts an item before another in the gengrid.
8180     *
8181     * @see elm_gengrid_item_append()
8182     * @see elm_gengrid_item_prepend()
8183     * @see elm_gengrid_item_insert_after()
8184     * @see elm_gengrid_item_del()
8185     *
8186     * @ingroup Gengrid
8187     */
8188    EAPI Elm_Gengrid_Item  *elm_gengrid_item_insert_before(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Elm_Gengrid_Item *relative, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
8189
8190    /**
8191     * Insert an item after another in a gengrid widget
8192     *
8193     * @param obj The gengrid object.
8194     * @param gic The item class for the item.
8195     * @param data The item data.
8196     * @param relative The item to place this new one after.
8197     * @param func Convenience function called when the item is
8198     * selected.
8199     * @param func_data Data to be passed to @p func.
8200     * @return A handle to the item added or @c NULL, on errors.
8201     *
8202     * This inserts an item after another in the gengrid.
8203     *
8204     * @see elm_gengrid_item_append()
8205     * @see elm_gengrid_item_prepend()
8206     * @see elm_gengrid_item_insert_after()
8207     * @see elm_gengrid_item_del()
8208     *
8209     * @ingroup Gengrid
8210     */
8211    EAPI Elm_Gengrid_Item  *elm_gengrid_item_insert_after(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Elm_Gengrid_Item *relative, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
8212
8213    EAPI Elm_Gengrid_Item  *elm_gengrid_item_sorted_insert(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
8214
8215    EAPI Elm_Gengrid_Item  *elm_gengrid_item_direct_sorted_insert(Evas_Object *obj, const Elm_Gengrid_Item_Class *gic, const void *data, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
8216
8217    /**
8218     * Set whether items on a given gengrid widget are to get their
8219     * selection callbacks issued for @b every subsequent selection
8220     * click on them or just for the first click.
8221     *
8222     * @param obj The gengrid object
8223     * @param always_select @c EINA_TRUE to make items "always
8224     * selected", @c EINA_FALSE, otherwise
8225     *
8226     * By default, grid items will only call their selection callback
8227     * function when firstly getting selected, any subsequent further
8228     * clicks will do nothing. With this call, you make those
8229     * subsequent clicks also to issue the selection callbacks.
8230     *
8231     * @note <b>Double clicks</b> will @b always be reported on items.
8232     *
8233     * @see elm_gengrid_always_select_mode_get()
8234     *
8235     * @ingroup Gengrid
8236     */
8237    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8238
8239    /**
8240     * Get whether items on a given gengrid widget have their selection
8241     * callbacks issued for @b every subsequent selection click on them
8242     * or just for the first click.
8243     *
8244     * @param obj The gengrid object.
8245     * @return @c EINA_TRUE if the gengrid items are "always selected",
8246     * @c EINA_FALSE, otherwise
8247     *
8248     * @see elm_gengrid_always_select_mode_set() for more details
8249     *
8250     * @ingroup Gengrid
8251     */
8252    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8253
8254    /**
8255     * Set whether items on a given gengrid widget can be selected or not.
8256     *
8257     * @param obj The gengrid object
8258     * @param no_select @c EINA_TRUE to make items selectable,
8259     * @c EINA_FALSE otherwise
8260     *
8261     * This will make items in @p obj selectable or not. In the latter
8262     * case, any user interaction on the gengrid items will neither make
8263     * them appear selected nor them call their selection callback
8264     * functions.
8265     *
8266     * @see elm_gengrid_no_select_mode_get()
8267     *
8268     * @ingroup Gengrid
8269     */
8270    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8271
8272    /**
8273     * Get whether items on a given gengrid widget can be selected or
8274     * not.
8275     *
8276     * @param obj The gengrid object
8277     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8278     * otherwise
8279     *
8280     * @see elm_gengrid_no_select_mode_set() for more details
8281     *
8282     * @ingroup Gengrid
8283     */
8284    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8285
8286    /**
8287     * Enable or disable multi-selection in a given gengrid widget
8288     *
8289     * @param obj The gengrid object.
8290     * @param multi @c EINA_TRUE, to enable multi-selection,
8291     * @c EINA_FALSE to disable it.
8292     *
8293     * Multi-selection is the ability for one to have @b more than one
8294     * item selected, on a given gengrid, simultaneously. When it is
8295     * enabled, a sequence of clicks on different items will make them
8296     * all selected, progressively. A click on an already selected item
8297     * will unselect it. If interecting via the keyboard,
8298     * multi-selection is enabled while holding the "Shift" key.
8299     *
8300     * @note By default, multi-selection is @b disabled on gengrids
8301     *
8302     * @see elm_gengrid_multi_select_get()
8303     *
8304     * @ingroup Gengrid
8305     */
8306    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8307
8308    /**
8309     * Get whether multi-selection is enabled or disabled for a given
8310     * gengrid widget
8311     *
8312     * @param obj The gengrid object.
8313     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8314     * EINA_FALSE otherwise
8315     *
8316     * @see elm_gengrid_multi_select_set() for more details
8317     *
8318     * @ingroup Gengrid
8319     */
8320    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8321
8322    /**
8323     * Enable or disable bouncing effect for a given gengrid widget
8324     *
8325     * @param obj The gengrid object
8326     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8327     * @c EINA_FALSE to disable it
8328     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8329     * @c EINA_FALSE to disable it
8330     *
8331     * The bouncing effect occurs whenever one reaches the gengrid's
8332     * edge's while panning it -- it will scroll past its limits a
8333     * little bit and return to the edge again, in a animated for,
8334     * automatically.
8335     *
8336     * @note By default, gengrids have bouncing enabled on both axis
8337     *
8338     * @see elm_gengrid_bounce_get()
8339     *
8340     * @ingroup Gengrid
8341     */
8342    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8343
8344    /**
8345     * Get whether bouncing effects are enabled or disabled, for a
8346     * given gengrid widget, on each axis
8347     *
8348     * @param obj The gengrid object
8349     * @param h_bounce Pointer to a variable where to store the
8350     * horizontal bouncing flag.
8351     * @param v_bounce Pointer to a variable where to store the
8352     * vertical bouncing flag.
8353     *
8354     * @see elm_gengrid_bounce_set() for more details
8355     *
8356     * @ingroup Gengrid
8357     */
8358    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8359
8360    /**
8361     * Set a given gengrid widget's scrolling page size, relative to
8362     * its viewport size.
8363     *
8364     * @param obj The gengrid object
8365     * @param h_pagerel The horizontal page (relative) size
8366     * @param v_pagerel The vertical page (relative) size
8367     *
8368     * The gengrid's scroller is capable of binding scrolling by the
8369     * user to "pages". It means that, while scrolling and, specially
8370     * after releasing the mouse button, the grid will @b snap to the
8371     * nearest displaying page's area. When page sizes are set, the
8372     * grid's continuous content area is split into (equal) page sized
8373     * pieces.
8374     *
8375     * This function sets the size of a page <b>relatively to the
8376     * viewport dimensions</b> of the gengrid, for each axis. A value
8377     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8378     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8379     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8380     * 1.0. Values beyond those will make it behave behave
8381     * inconsistently. If you only want one axis to snap to pages, use
8382     * the value @c 0.0 for the other one.
8383     *
8384     * There is a function setting page size values in @b absolute
8385     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8386     * is mutually exclusive to this one.
8387     *
8388     * @see elm_gengrid_page_relative_get()
8389     *
8390     * @ingroup Gengrid
8391     */
8392    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8393
8394    /**
8395     * Get a given gengrid widget's scrolling page size, relative to
8396     * its viewport size.
8397     *
8398     * @param obj The gengrid object
8399     * @param h_pagerel Pointer to a variable where to store the
8400     * horizontal page (relative) size
8401     * @param v_pagerel Pointer to a variable where to store the
8402     * vertical page (relative) size
8403     *
8404     * @see elm_gengrid_page_relative_set() for more details
8405     *
8406     * @ingroup Gengrid
8407     */
8408    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8409
8410    /**
8411     * Set a given gengrid widget's scrolling page size
8412     *
8413     * @param obj The gengrid object
8414     * @param h_pagerel The horizontal page size, in pixels
8415     * @param v_pagerel The vertical page size, in pixels
8416     *
8417     * The gengrid's scroller is capable of binding scrolling by the
8418     * user to "pages". It means that, while scrolling and, specially
8419     * after releasing the mouse button, the grid will @b snap to the
8420     * nearest displaying page's area. When page sizes are set, the
8421     * grid's continuous content area is split into (equal) page sized
8422     * pieces.
8423     *
8424     * This function sets the size of a page of the gengrid, in pixels,
8425     * for each axis. Sane usable values are, between @c 0 and the
8426     * dimensions of @p obj, for each axis. Values beyond those will
8427     * make it behave behave inconsistently. If you only want one axis
8428     * to snap to pages, use the value @c 0 for the other one.
8429     *
8430     * There is a function setting page size values in @b relative
8431     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8432     * use is mutually exclusive to this one.
8433     *
8434     * @ingroup Gengrid
8435     */
8436    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8437
8438    /**
8439     * @brief Get gengrid current page number.
8440     *
8441     * @param obj The gengrid object
8442     * @param h_pagenumber The horizontal page number
8443     * @param v_pagenumber The vertical page number
8444     *
8445     * The page number starts from 0. 0 is the first page.
8446     * Current page means the page which meet the top-left of the viewport.
8447     * If there are two or more pages in the viewport, it returns the number of page
8448     * which meet the top-left of the viewport.
8449     *
8450     * @see elm_gengrid_last_page_get()
8451     * @see elm_gengrid_page_show()
8452     * @see elm_gengrid_page_brint_in()
8453     */
8454    EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8455
8456    /**
8457     * @brief Get scroll last page number.
8458     *
8459     * @param obj The gengrid object
8460     * @param h_pagenumber The horizontal page number
8461     * @param v_pagenumber The vertical page number
8462     *
8463     * The page number starts from 0. 0 is the first page.
8464     * This returns the last page number among the pages.
8465     *
8466     * @see elm_gengrid_current_page_get()
8467     * @see elm_gengrid_page_show()
8468     * @see elm_gengrid_page_brint_in()
8469     */
8470    EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8471
8472    /**
8473     * Show a specific virtual region within the gengrid content object by page number.
8474     *
8475     * @param obj The gengrid object
8476     * @param h_pagenumber The horizontal page number
8477     * @param v_pagenumber The vertical page number
8478     *
8479     * 0, 0 of the indicated page is located at the top-left of the viewport.
8480     * This will jump to the page directly without animation.
8481     *
8482     * Example of usage:
8483     *
8484     * @code
8485     * sc = elm_gengrid_add(win);
8486     * elm_gengrid_content_set(sc, content);
8487     * elm_gengrid_page_relative_set(sc, 1, 0);
8488     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8489     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8490     * @endcode
8491     *
8492     * @see elm_gengrid_page_bring_in()
8493     */
8494    EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8495
8496    /**
8497     * Show a specific virtual region within the gengrid content object by page number.
8498     *
8499     * @param obj The gengrid object
8500     * @param h_pagenumber The horizontal page number
8501     * @param v_pagenumber The vertical page number
8502     *
8503     * 0, 0 of the indicated page is located at the top-left of the viewport.
8504     * This will slide to the page with animation.
8505     *
8506     * Example of usage:
8507     *
8508     * @code
8509     * sc = elm_gengrid_add(win);
8510     * elm_gengrid_content_set(sc, content);
8511     * elm_gengrid_page_relative_set(sc, 1, 0);
8512     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8513     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8514     * @endcode
8515     *
8516     * @see elm_gengrid_page_show()
8517     */
8518     EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8519
8520    /**
8521     * Set for what direction a given gengrid widget will expand while
8522     * placing its items.
8523     *
8524     * @param obj The gengrid object.
8525     * @param setting @c EINA_TRUE to make the gengrid expand
8526     * horizontally, @c EINA_FALSE to expand vertically.
8527     *
8528     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8529     * in @b columns, from top to bottom and, when the space for a
8530     * column is filled, another one is started on the right, thus
8531     * expanding the grid horizontally. When in "vertical mode"
8532     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8533     * to right and, when the space for a row is filled, another one is
8534     * started below, thus expanding the grid vertically.
8535     *
8536     * @see elm_gengrid_horizontal_get()
8537     *
8538     * @ingroup Gengrid
8539     */
8540    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8541
8542    /**
8543     * Get for what direction a given gengrid widget will expand while
8544     * placing its items.
8545     *
8546     * @param obj The gengrid object.
8547     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8548     * @c EINA_FALSE if it's set to expand vertically.
8549     *
8550     * @see elm_gengrid_horizontal_set() for more detais
8551     *
8552     * @ingroup Gengrid
8553     */
8554    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8555
8556    /**
8557     * Get the first item in a given gengrid widget
8558     *
8559     * @param obj The gengrid object
8560     * @return The first item's handle or @c NULL, if there are no
8561     * items in @p obj (and on errors)
8562     *
8563     * This returns the first item in the @p obj's internal list of
8564     * items.
8565     *
8566     * @see elm_gengrid_last_item_get()
8567     *
8568     * @ingroup Gengrid
8569     */
8570    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8571
8572    /**
8573     * Get the last item in a given gengrid widget
8574     *
8575     * @param obj The gengrid object
8576     * @return The last item's handle or @c NULL, if there are no
8577     * items in @p obj (and on errors)
8578     *
8579     * This returns the last item in the @p obj's internal list of
8580     * items.
8581     *
8582     * @see elm_gengrid_first_item_get()
8583     *
8584     * @ingroup Gengrid
8585     */
8586    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8587
8588    /**
8589     * Get the @b next item in a gengrid widget's internal list of items,
8590     * given a handle to one of those items.
8591     *
8592     * @param item The gengrid item to fetch next from
8593     * @return The item after @p item, or @c NULL if there's none (and
8594     * on errors)
8595     *
8596     * This returns the item placed after the @p item, on the container
8597     * gengrid.
8598     *
8599     * @see elm_gengrid_item_prev_get()
8600     *
8601     * @ingroup Gengrid
8602     */
8603    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8604
8605    /**
8606     * Get the @b previous item in a gengrid widget's internal list of items,
8607     * given a handle to one of those items.
8608     *
8609     * @param item The gengrid item to fetch previous from
8610     * @return The item before @p item, or @c NULL if there's none (and
8611     * on errors)
8612     *
8613     * This returns the item placed before the @p item, on the container
8614     * gengrid.
8615     *
8616     * @see elm_gengrid_item_next_get()
8617     *
8618     * @ingroup Gengrid
8619     */
8620    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8621
8622    /**
8623     * Get the gengrid object's handle which contains a given gengrid
8624     * item
8625     *
8626     * @param item The item to fetch the container from
8627     * @return The gengrid (parent) object
8628     *
8629     * This returns the gengrid object itself that an item belongs to.
8630     *
8631     * @ingroup Gengrid
8632     */
8633    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8634
8635    /**
8636     * Remove a gengrid item from the its parent, deleting it.
8637     *
8638     * @param item The item to be removed.
8639     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8640     *
8641     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8642     * once.
8643     *
8644     * @ingroup Gengrid
8645     */
8646    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8647
8648    /**
8649     * Update the contents of a given gengrid item
8650     *
8651     * @param item The gengrid item
8652     *
8653     * This updates an item by calling all the item class functions
8654     * again to get the icons, labels and states. Use this when the
8655     * original item data has changed and you want thta changes to be
8656     * reflected.
8657     *
8658     * @ingroup Gengrid
8659     */
8660    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8661    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8662    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8663
8664    /**
8665     * Return the data associated to a given gengrid item
8666     *
8667     * @param item The gengrid item.
8668     * @return the data associated to this item.
8669     *
8670     * This returns the @c data value passed on the
8671     * elm_gengrid_item_append() and related item addition calls.
8672     *
8673     * @see elm_gengrid_item_append()
8674     * @see elm_gengrid_item_data_set()
8675     *
8676     * @ingroup Gengrid
8677     */
8678    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8679
8680    /**
8681     * Set the data associated to a given gengrid item
8682     *
8683     * @param item The gengrid item
8684     * @param data The new data pointer to set on it
8685     *
8686     * This @b overrides the @c data value passed on the
8687     * elm_gengrid_item_append() and related item addition calls. This
8688     * function @b won't call elm_gengrid_item_update() automatically,
8689     * so you'd issue it afterwards if you want to hove the item
8690     * updated to reflect the that new data.
8691     *
8692     * @see elm_gengrid_item_data_get()
8693     *
8694     * @ingroup Gengrid
8695     */
8696    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8697
8698    /**
8699     * Get a given gengrid item's position, relative to the whole
8700     * gengrid's grid area.
8701     *
8702     * @param item The Gengrid item.
8703     * @param x Pointer to variable where to store the item's <b>row
8704     * number</b>.
8705     * @param y Pointer to variable where to store the item's <b>column
8706     * number</b>.
8707     *
8708     * This returns the "logical" position of the item whithin the
8709     * gengrid. For example, @c (0, 1) would stand for first row,
8710     * second column.
8711     *
8712     * @ingroup Gengrid
8713     */
8714    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8715
8716    /**
8717     * Set whether a given gengrid item is selected or not
8718     *
8719     * @param item The gengrid item
8720     * @param selected Use @c EINA_TRUE, to make it selected, @c
8721     * EINA_FALSE to make it unselected
8722     *
8723     * This sets the selected state of an item. If multi selection is
8724     * not enabled on the containing gengrid and @p selected is @c
8725     * EINA_TRUE, any other previously selected items will get
8726     * unselected in favor of this new one.
8727     *
8728     * @see elm_gengrid_item_selected_get()
8729     *
8730     * @ingroup Gengrid
8731     */
8732    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8733
8734    /**
8735     * Get whether a given gengrid item is selected or not
8736     *
8737     * @param item The gengrid item
8738     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8739     *
8740     * @see elm_gengrid_item_selected_set() for more details
8741     *
8742     * @ingroup Gengrid
8743     */
8744    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8745
8746    /**
8747     * Get the real Evas object created to implement the view of a
8748     * given gengrid item
8749     *
8750     * @param item The gengrid item.
8751     * @return the Evas object implementing this item's view.
8752     *
8753     * This returns the actual Evas object used to implement the
8754     * specified gengrid item's view. This may be @c NULL, as it may
8755     * not have been created or may have been deleted, at any time, by
8756     * the gengrid. <b>Do not modify this object</b> (move, resize,
8757     * show, hide, etc.), as the gengrid is controlling it. This
8758     * function is for querying, emitting custom signals or hooking
8759     * lower level callbacks for events on that object. Do not delete
8760     * this object under any circumstances.
8761     *
8762     * @see elm_gengrid_item_data_get()
8763     *
8764     * @ingroup Gengrid
8765     */
8766    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8767
8768    /**
8769     * Show the portion of a gengrid's internal grid containing a given
8770     * item, @b immediately.
8771     *
8772     * @param item The item to display
8773     *
8774     * This causes gengrid to @b redraw its viewport's contents to the
8775     * region contining the given @p item item, if it is not fully
8776     * visible.
8777     *
8778     * @see elm_gengrid_item_bring_in()
8779     *
8780     * @ingroup Gengrid
8781     */
8782    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8783
8784    /**
8785     * Animatedly bring in, to the visible are of a gengrid, a given
8786     * item on it.
8787     *
8788     * @param item The gengrid item to display
8789     *
8790     * This causes gengrig to jump to the given @p item item and show
8791     * it (by scrolling), if it is not fully visible. This will use
8792     * animation to do so and take a period of time to complete.
8793     *
8794     * @see elm_gengrid_item_show()
8795     *
8796     * @ingroup Gengrid
8797     */
8798    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8799
8800    /**
8801     * Set whether a given gengrid item is disabled or not.
8802     *
8803     * @param item The gengrid item
8804     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8805     * to enable it back.
8806     *
8807     * A disabled item cannot be selected or unselected. It will also
8808     * change its appearance, to signal the user it's disabled.
8809     *
8810     * @see elm_gengrid_item_disabled_get()
8811     *
8812     * @ingroup Gengrid
8813     */
8814    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8815
8816    /**
8817     * Get whether a given gengrid item is disabled or not.
8818     *
8819     * @param item The gengrid item
8820     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8821     * (and on errors).
8822     *
8823     * @see elm_gengrid_item_disabled_set() for more details
8824     *
8825     * @ingroup Gengrid
8826     */
8827    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8828
8829    /**
8830     * Set the text to be shown in a given gengrid item's tooltips.
8831     *
8832     * @param item The gengrid item
8833     * @param text The text to set in the content
8834     *
8835     * This call will setup the text to be used as tooltip to that item
8836     * (analogous to elm_object_tooltip_text_set(), but being item
8837     * tooltips with higher precedence than object tooltips). It can
8838     * have only one tooltip at a time, so any previous tooltip data
8839     * will get removed.
8840     *
8841     * @ingroup Gengrid
8842     */
8843    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8844
8845    /**
8846     * Set the content to be shown in a given gengrid item's tooltips
8847     *
8848     * @param item The gengrid item.
8849     * @param func The function returning the tooltip contents.
8850     * @param data What to provide to @a func as callback data/context.
8851     * @param del_cb Called when data is not needed anymore, either when
8852     *        another callback replaces @p func, the tooltip is unset with
8853     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8854     *        dies. This callback receives as its first parameter the
8855     *        given @p data, being @c event_info the item handle.
8856     *
8857     * This call will setup the tooltip's contents to @p item
8858     * (analogous to elm_object_tooltip_content_cb_set(), but being
8859     * item tooltips with higher precedence than object tooltips). It
8860     * can have only one tooltip at a time, so any previous tooltip
8861     * content will get removed. @p func (with @p data) will be called
8862     * every time Elementary needs to show the tooltip and it should
8863     * return a valid Evas object, which will be fully managed by the
8864     * tooltip system, getting deleted when the tooltip is gone.
8865     *
8866     * @ingroup Gengrid
8867     */
8868    EAPI void               elm_gengrid_item_tooltip_content_cb_set(Elm_Gengrid_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
8869
8870    /**
8871     * Unset a tooltip from a given gengrid item
8872     *
8873     * @param item gengrid item to remove a previously set tooltip from.
8874     *
8875     * This call removes any tooltip set on @p item. The callback
8876     * provided as @c del_cb to
8877     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8878     * notify it is not used anymore (and have resources cleaned, if
8879     * need be).
8880     *
8881     * @see elm_gengrid_item_tooltip_content_cb_set()
8882     *
8883     * @ingroup Gengrid
8884     */
8885    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8886
8887    /**
8888     * Set a different @b style for a given gengrid item's tooltip.
8889     *
8890     * @param item gengrid item with tooltip set
8891     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8892     * "default", @c "transparent", etc)
8893     *
8894     * Tooltips can have <b>alternate styles</b> to be displayed on,
8895     * which are defined by the theme set on Elementary. This function
8896     * works analogously as elm_object_tooltip_style_set(), but here
8897     * applied only to gengrid item objects. The default style for
8898     * tooltips is @c "default".
8899     *
8900     * @note before you set a style you should define a tooltip with
8901     *       elm_gengrid_item_tooltip_content_cb_set() or
8902     *       elm_gengrid_item_tooltip_text_set()
8903     *
8904     * @see elm_gengrid_item_tooltip_style_get()
8905     *
8906     * @ingroup Gengrid
8907     */
8908    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8909
8910    /**
8911     * Get the style set a given gengrid item's tooltip.
8912     *
8913     * @param item gengrid item with tooltip already set on.
8914     * @return style the theme style in use, which defaults to
8915     *         "default". If the object does not have a tooltip set,
8916     *         then @c NULL is returned.
8917     *
8918     * @see elm_gengrid_item_tooltip_style_set() for more details
8919     *
8920     * @ingroup Gengrid
8921     */
8922    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8923    /**
8924     * @brief Disable size restrictions on an object's tooltip
8925     * @param item The tooltip's anchor object
8926     * @param disable If EINA_TRUE, size restrictions are disabled
8927     * @return EINA_FALSE on failure, EINA_TRUE on success
8928     *
8929     * This function allows a tooltip to expand beyond its parant window's canvas.
8930     * It will instead be limited only by the size of the display.
8931     */
8932    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8933    /**
8934     * @brief Retrieve size restriction state of an object's tooltip
8935     * @param item The tooltip's anchor object
8936     * @return If EINA_TRUE, size restrictions are disabled
8937     *
8938     * This function returns whether a tooltip is allowed to expand beyond
8939     * its parant window's canvas.
8940     * It will instead be limited only by the size of the display.
8941     */
8942    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8943    /**
8944     * Set the type of mouse pointer/cursor decoration to be shown,
8945     * when the mouse pointer is over the given gengrid widget item
8946     *
8947     * @param item gengrid item to customize cursor on
8948     * @param cursor the cursor type's name
8949     *
8950     * This function works analogously as elm_object_cursor_set(), but
8951     * here the cursor's changing area is restricted to the item's
8952     * area, and not the whole widget's. Note that that item cursors
8953     * have precedence over widget cursors, so that a mouse over @p
8954     * item will always show cursor @p type.
8955     *
8956     * If this function is called twice for an object, a previously set
8957     * cursor will be unset on the second call.
8958     *
8959     * @see elm_object_cursor_set()
8960     * @see elm_gengrid_item_cursor_get()
8961     * @see elm_gengrid_item_cursor_unset()
8962     *
8963     * @ingroup Gengrid
8964     */
8965    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8966
8967    /**
8968     * Get the type of mouse pointer/cursor decoration set to be shown,
8969     * when the mouse pointer is over the given gengrid widget item
8970     *
8971     * @param item gengrid item with custom cursor set
8972     * @return the cursor type's name or @c NULL, if no custom cursors
8973     * were set to @p item (and on errors)
8974     *
8975     * @see elm_object_cursor_get()
8976     * @see elm_gengrid_item_cursor_set() for more details
8977     * @see elm_gengrid_item_cursor_unset()
8978     *
8979     * @ingroup Gengrid
8980     */
8981    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8982
8983    /**
8984     * Unset any custom mouse pointer/cursor decoration set to be
8985     * shown, when the mouse pointer is over the given gengrid widget
8986     * item, thus making it show the @b default cursor again.
8987     *
8988     * @param item a gengrid item
8989     *
8990     * Use this call to undo any custom settings on this item's cursor
8991     * decoration, bringing it back to defaults (no custom style set).
8992     *
8993     * @see elm_object_cursor_unset()
8994     * @see elm_gengrid_item_cursor_set() for more details
8995     *
8996     * @ingroup Gengrid
8997     */
8998    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8999
9000    /**
9001     * Set a different @b style for a given custom cursor set for a
9002     * gengrid item.
9003     *
9004     * @param item gengrid item with custom cursor set
9005     * @param style the <b>theme style</b> to use (e.g. @c "default",
9006     * @c "transparent", etc)
9007     *
9008     * This function only makes sense when one is using custom mouse
9009     * cursor decorations <b>defined in a theme file</b> , which can
9010     * have, given a cursor name/type, <b>alternate styles</b> on
9011     * it. It works analogously as elm_object_cursor_style_set(), but
9012     * here applied only to gengrid item objects.
9013     *
9014     * @warning Before you set a cursor style you should have defined a
9015     *       custom cursor previously on the item, with
9016     *       elm_gengrid_item_cursor_set()
9017     *
9018     * @see elm_gengrid_item_cursor_engine_only_set()
9019     * @see elm_gengrid_item_cursor_style_get()
9020     *
9021     * @ingroup Gengrid
9022     */
9023    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9024
9025    /**
9026     * Get the current @b style set for a given gengrid item's custom
9027     * cursor
9028     *
9029     * @param item gengrid item with custom cursor set.
9030     * @return style the cursor style in use. If the object does not
9031     *         have a cursor set, then @c NULL is returned.
9032     *
9033     * @see elm_gengrid_item_cursor_style_set() for more details
9034     *
9035     * @ingroup Gengrid
9036     */
9037    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9038
9039    /**
9040     * Set if the (custom) cursor for a given gengrid item should be
9041     * searched in its theme, also, or should only rely on the
9042     * rendering engine.
9043     *
9044     * @param item item with custom (custom) cursor already set on
9045     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9046     * only on those provided by the rendering engine, @c EINA_FALSE to
9047     * have them searched on the widget's theme, as well.
9048     *
9049     * @note This call is of use only if you've set a custom cursor
9050     * for gengrid items, with elm_gengrid_item_cursor_set().
9051     *
9052     * @note By default, cursors will only be looked for between those
9053     * provided by the rendering engine.
9054     *
9055     * @ingroup Gengrid
9056     */
9057    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9058
9059    /**
9060     * Get if the (custom) cursor for a given gengrid item is being
9061     * searched in its theme, also, or is only relying on the rendering
9062     * engine.
9063     *
9064     * @param item a gengrid item
9065     * @return @c EINA_TRUE, if cursors are being looked for only on
9066     * those provided by the rendering engine, @c EINA_FALSE if they
9067     * are being searched on the widget's theme, as well.
9068     *
9069     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9070     *
9071     * @ingroup Gengrid
9072     */
9073    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9074
9075    /**
9076     * Remove all items from a given gengrid widget
9077     *
9078     * @param obj The gengrid object.
9079     *
9080     * This removes (and deletes) all items in @p obj, leaving it
9081     * empty.
9082     *
9083     * @see elm_gengrid_item_del(), to remove just one item.
9084     *
9085     * @ingroup Gengrid
9086     */
9087    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9088
9089    /**
9090     * Get the selected item in a given gengrid widget
9091     *
9092     * @param obj The gengrid object.
9093     * @return The selected item's handleor @c NULL, if none is
9094     * selected at the moment (and on errors)
9095     *
9096     * This returns the selected item in @p obj. If multi selection is
9097     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9098     * the first item in the list is selected, which might not be very
9099     * useful. For that case, see elm_gengrid_selected_items_get().
9100     *
9101     * @ingroup Gengrid
9102     */
9103    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9104
9105    /**
9106     * Get <b>a list</b> of selected items in a given gengrid
9107     *
9108     * @param obj The gengrid object.
9109     * @return The list of selected items or @c NULL, if none is
9110     * selected at the moment (and on errors)
9111     *
9112     * This returns a list of the selected items, in the order that
9113     * they appear in the grid. This list is only valid as long as no
9114     * more items are selected or unselected (or unselected implictly
9115     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9116     * data, naturally.
9117     *
9118     * @see elm_gengrid_selected_item_get()
9119     *
9120     * @ingroup Gengrid
9121     */
9122    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9123
9124    /**
9125     * @}
9126     */
9127
9128    /**
9129     * @defgroup Clock Clock
9130     *
9131     * @image html img/widget/clock/preview-00.png
9132     * @image latex img/widget/clock/preview-00.eps
9133     *
9134     * This is a @b digital clock widget. In its default theme, it has a
9135     * vintage "flipping numbers clock" appearance, which will animate
9136     * sheets of individual algarisms individually as time goes by.
9137     *
9138     * A newly created clock will fetch system's time (already
9139     * considering local time adjustments) to start with, and will tick
9140     * accondingly. It may or may not show seconds.
9141     *
9142     * Clocks have an @b edition mode. When in it, the sheets will
9143     * display extra arrow indications on the top and bottom and the
9144     * user may click on them to raise or lower the time values. After
9145     * it's told to exit edition mode, it will keep ticking with that
9146     * new time set (it keeps the difference from local time).
9147     *
9148     * Also, when under edition mode, user clicks on the cited arrows
9149     * which are @b held for some time will make the clock to flip the
9150     * sheet, thus editing the time, continuosly and automatically for
9151     * the user. The interval between sheet flips will keep growing in
9152     * time, so that it helps the user to reach a time which is distant
9153     * from the one set.
9154     *
9155     * The time display is, by default, in military mode (24h), but an
9156     * am/pm indicator may be optionally shown, too, when it will
9157     * switch to 12h.
9158     *
9159     * Smart callbacks one can register to:
9160     * - "changed" - the clock's user changed the time
9161     *
9162     * Here is an example on its usage:
9163     * @li @ref clock_example
9164     */
9165
9166    /**
9167     * @addtogroup Clock
9168     * @{
9169     */
9170
9171    /**
9172     * Identifiers for which clock digits should be editable, when a
9173     * clock widget is in edition mode. Values may be ORed together to
9174     * make a mask, naturally.
9175     *
9176     * @see elm_clock_edit_set()
9177     * @see elm_clock_digit_edit_set()
9178     */
9179    typedef enum _Elm_Clock_Digedit
9180      {
9181         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9182         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9183         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9184         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9185         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9186         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9187         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9188         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9189      } Elm_Clock_Digedit;
9190
9191    /**
9192     * Add a new clock widget to the given parent Elementary
9193     * (container) object
9194     *
9195     * @param parent The parent object
9196     * @return a new clock widget handle or @c NULL, on errors
9197     *
9198     * This function inserts a new clock widget on the canvas.
9199     *
9200     * @ingroup Clock
9201     */
9202    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9203
9204    /**
9205     * Set a clock widget's time, programmatically
9206     *
9207     * @param obj The clock widget object
9208     * @param hrs The hours to set
9209     * @param min The minutes to set
9210     * @param sec The secondes to set
9211     *
9212     * This function updates the time that is showed by the clock
9213     * widget.
9214     *
9215     *  Values @b must be set within the following ranges:
9216     * - 0 - 23, for hours
9217     * - 0 - 59, for minutes
9218     * - 0 - 59, for seconds,
9219     *
9220     * even if the clock is not in "military" mode.
9221     *
9222     * @warning The behavior for values set out of those ranges is @b
9223     * indefined.
9224     *
9225     * @ingroup Clock
9226     */
9227    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9228
9229    /**
9230     * Get a clock widget's time values
9231     *
9232     * @param obj The clock object
9233     * @param[out] hrs Pointer to the variable to get the hours value
9234     * @param[out] min Pointer to the variable to get the minutes value
9235     * @param[out] sec Pointer to the variable to get the seconds value
9236     *
9237     * This function gets the time set for @p obj, returning
9238     * it on the variables passed as the arguments to function
9239     *
9240     * @note Use @c NULL pointers on the time values you're not
9241     * interested in: they'll be ignored by the function.
9242     *
9243     * @ingroup Clock
9244     */
9245    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9246
9247    /**
9248     * Set whether a given clock widget is under <b>edition mode</b> or
9249     * under (default) displaying-only mode.
9250     *
9251     * @param obj The clock object
9252     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9253     * put it back to "displaying only" mode
9254     *
9255     * This function makes a clock's time to be editable or not <b>by
9256     * user interaction</b>. When in edition mode, clocks @b stop
9257     * ticking, until one brings them back to canonical mode. The
9258     * elm_clock_digit_edit_set() function will influence which digits
9259     * of the clock will be editable. By default, all of them will be
9260     * (#ELM_CLOCK_NONE).
9261     *
9262     * @note am/pm sheets, if being shown, will @b always be editable
9263     * under edition mode.
9264     *
9265     * @see elm_clock_edit_get()
9266     *
9267     * @ingroup Clock
9268     */
9269    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9270
9271    /**
9272     * Retrieve whether a given clock widget is under <b>edition
9273     * mode</b> or under (default) displaying-only mode.
9274     *
9275     * @param obj The clock object
9276     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9277     * otherwise
9278     *
9279     * This function retrieves whether the clock's time can be edited
9280     * or not by user interaction.
9281     *
9282     * @see elm_clock_edit_set() for more details
9283     *
9284     * @ingroup Clock
9285     */
9286    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9287
9288    /**
9289     * Set what digits of the given clock widget should be editable
9290     * when in edition mode.
9291     *
9292     * @param obj The clock object
9293     * @param digedit Bit mask indicating the digits to be editable
9294     * (values in #Elm_Clock_Digedit).
9295     *
9296     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9297     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9298     * EINA_FALSE).
9299     *
9300     * @see elm_clock_digit_edit_get()
9301     *
9302     * @ingroup Clock
9303     */
9304    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9305
9306    /**
9307     * Retrieve what digits of the given clock widget should be
9308     * editable when in edition mode.
9309     *
9310     * @param obj The clock object
9311     * @return Bit mask indicating the digits to be editable
9312     * (values in #Elm_Clock_Digedit).
9313     *
9314     * @see elm_clock_digit_edit_set() for more details
9315     *
9316     * @ingroup Clock
9317     */
9318    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9319
9320    /**
9321     * Set if the given clock widget must show hours in military or
9322     * am/pm mode
9323     *
9324     * @param obj The clock object
9325     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9326     * to military mode
9327     *
9328     * This function sets if the clock must show hours in military or
9329     * am/pm mode. In some countries like Brazil the military mode
9330     * (00-24h-format) is used, in opposition to the USA, where the
9331     * am/pm mode is more commonly used.
9332     *
9333     * @see elm_clock_show_am_pm_get()
9334     *
9335     * @ingroup Clock
9336     */
9337    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9338
9339    /**
9340     * Get if the given clock widget shows hours in military or am/pm
9341     * mode
9342     *
9343     * @param obj The clock object
9344     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9345     * military
9346     *
9347     * This function gets if the clock shows hours in military or am/pm
9348     * mode.
9349     *
9350     * @see elm_clock_show_am_pm_set() for more details
9351     *
9352     * @ingroup Clock
9353     */
9354    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9355
9356    /**
9357     * Set if the given clock widget must show time with seconds or not
9358     *
9359     * @param obj The clock object
9360     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9361     *
9362     * This function sets if the given clock must show or not elapsed
9363     * seconds. By default, they are @b not shown.
9364     *
9365     * @see elm_clock_show_seconds_get()
9366     *
9367     * @ingroup Clock
9368     */
9369    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9370
9371    /**
9372     * Get whether the given clock widget is showing time with seconds
9373     * or not
9374     *
9375     * @param obj The clock object
9376     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9377     *
9378     * This function gets whether @p obj is showing or not the elapsed
9379     * seconds.
9380     *
9381     * @see elm_clock_show_seconds_set()
9382     *
9383     * @ingroup Clock
9384     */
9385    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9386
9387    /**
9388     * Set the interval on time updates for an user mouse button hold
9389     * on clock widgets' time edition.
9390     *
9391     * @param obj The clock object
9392     * @param interval The (first) interval value in seconds
9393     *
9394     * This interval value is @b decreased while the user holds the
9395     * mouse pointer either incrementing or decrementing a given the
9396     * clock digit's value.
9397     *
9398     * This helps the user to get to a given time distant from the
9399     * current one easier/faster, as it will start to flip quicker and
9400     * quicker on mouse button holds.
9401     *
9402     * The calculation for the next flip interval value, starting from
9403     * the one set with this call, is the previous interval divided by
9404     * 1.05, so it decreases a little bit.
9405     *
9406     * The default starting interval value for automatic flips is
9407     * @b 0.85 seconds.
9408     *
9409     * @see elm_clock_interval_get()
9410     *
9411     * @ingroup Clock
9412     */
9413    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9414
9415    /**
9416     * Get the interval on time updates for an user mouse button hold
9417     * on clock widgets' time edition.
9418     *
9419     * @param obj The clock object
9420     * @return The (first) interval value, in seconds, set on it
9421     *
9422     * @see elm_clock_interval_set() for more details
9423     *
9424     * @ingroup Clock
9425     */
9426    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9427
9428    /**
9429     * @}
9430     */
9431
9432    /**
9433     * @defgroup Layout Layout
9434     *
9435     * @image html img/widget/layout/preview-00.png
9436     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9437     *
9438     * @image html img/layout-predefined.png
9439     * @image latex img/layout-predefined.eps width=\textwidth
9440     *
9441     * This is a container widget that takes a standard Edje design file and
9442     * wraps it very thinly in a widget.
9443     *
9444     * An Edje design (theme) file has a very wide range of possibilities to
9445     * describe the behavior of elements added to the Layout. Check out the Edje
9446     * documentation and the EDC reference to get more information about what can
9447     * be done with Edje.
9448     *
9449     * Just like @ref List, @ref Box, and other container widgets, any
9450     * object added to the Layout will become its child, meaning that it will be
9451     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9452     *
9453     * The Layout widget can contain as many Contents, Boxes or Tables as
9454     * described in its theme file. For instance, objects can be added to
9455     * different Tables by specifying the respective Table part names. The same
9456     * is valid for Content and Box.
9457     *
9458     * The objects added as child of the Layout will behave as described in the
9459     * part description where they were added. There are 3 possible types of
9460     * parts where a child can be added:
9461     *
9462     * @section secContent Content (SWALLOW part)
9463     *
9464     * Only one object can be added to the @c SWALLOW part (but you still can
9465     * have many @c SWALLOW parts and one object on each of them). Use the @c
9466     * elm_layout_content_* set of functions to set, retrieve and unset objects
9467     * as content of the @c SWALLOW. After being set to this part, the object
9468     * size, position, visibility, clipping and other description properties
9469     * will be totally controled by the description of the given part (inside
9470     * the Edje theme file).
9471     *
9472     * One can use @c evas_object_size_hint_* functions on the child to have some
9473     * kind of control over its behavior, but the resulting behavior will still
9474     * depend heavily on the @c SWALLOW part description.
9475     *
9476     * The Edje theme also can change the part description, based on signals or
9477     * scripts running inside the theme. This change can also be animated. All of
9478     * this will affect the child object set as content accordingly. The object
9479     * size will be changed if the part size is changed, it will animate move if
9480     * the part is moving, and so on.
9481     *
9482     * The following picture demonstrates a Layout widget with a child object
9483     * added to its @c SWALLOW:
9484     *
9485     * @image html layout_swallow.png
9486     * @image latex layout_swallow.eps width=\textwidth
9487     *
9488     * @section secBox Box (BOX part)
9489     *
9490     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9491     * allows one to add objects to the box and have them distributed along its
9492     * area, accordingly to the specified @a layout property (now by @a layout we
9493     * mean the chosen layouting design of the Box, not the Layout widget
9494     * itself).
9495     *
9496     * A similar effect for having a box with its position, size and other things
9497     * controled by the Layout theme would be to create an Elementary @ref Box
9498     * widget and add it as a Content in the @c SWALLOW part.
9499     *
9500     * The main difference of using the Layout Box is that its behavior, the box
9501     * properties like layouting format, padding, align, etc. will be all
9502     * controled by the theme. This means, for example, that a signal could be
9503     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9504     * handled the signal by changing the box padding, or align, or both. Using
9505     * the Elementary @ref Box widget is not necessarily harder or easier, it
9506     * just depends on the circunstances and requirements.
9507     *
9508     * The Layout Box can be used through the @c elm_layout_box_* set of
9509     * functions.
9510     *
9511     * The following picture demonstrates a Layout widget with many child objects
9512     * added to its @c BOX part:
9513     *
9514     * @image html layout_box.png
9515     * @image latex layout_box.eps width=\textwidth
9516     *
9517     * @section secTable Table (TABLE part)
9518     *
9519     * Just like the @ref secBox, the Layout Table is very similar to the
9520     * Elementary @ref Table widget. It allows one to add objects to the Table
9521     * specifying the row and column where the object should be added, and any
9522     * column or row span if necessary.
9523     *
9524     * Again, we could have this design by adding a @ref Table widget to the @c
9525     * SWALLOW part using elm_layout_content_set(). The same difference happens
9526     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9527     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9528     *
9529     * The Layout Table can be used through the @c elm_layout_table_* set of
9530     * functions.
9531     *
9532     * The following picture demonstrates a Layout widget with many child objects
9533     * added to its @c TABLE part:
9534     *
9535     * @image html layout_table.png
9536     * @image latex layout_table.eps width=\textwidth
9537     *
9538     * @section secPredef Predefined Layouts
9539     *
9540     * Another interesting thing about the Layout widget is that it offers some
9541     * predefined themes that come with the default Elementary theme. These
9542     * themes can be set by the call elm_layout_theme_set(), and provide some
9543     * basic functionality depending on the theme used.
9544     *
9545     * Most of them already send some signals, some already provide a toolbar or
9546     * back and next buttons.
9547     *
9548     * These are available predefined theme layouts. All of them have class = @c
9549     * layout, group = @c application, and style = one of the following options:
9550     *
9551     * @li @c toolbar-content - application with toolbar and main content area
9552     * @li @c toolbar-content-back - application with toolbar and main content
9553     * area with a back button and title area
9554     * @li @c toolbar-content-back-next - application with toolbar and main
9555     * content area with a back and next buttons and title area
9556     * @li @c content-back - application with a main content area with a back
9557     * button and title area
9558     * @li @c content-back-next - application with a main content area with a
9559     * back and next buttons and title area
9560     * @li @c toolbar-vbox - application with toolbar and main content area as a
9561     * vertical box
9562     * @li @c toolbar-table - application with toolbar and main content area as a
9563     * table
9564     *
9565     * @section secExamples Examples
9566     *
9567     * Some examples of the Layout widget can be found here:
9568     * @li @ref layout_example_01
9569     * @li @ref layout_example_02
9570     * @li @ref layout_example_03
9571     * @li @ref layout_example_edc
9572     *
9573     */
9574
9575    /**
9576     * Add a new layout to the parent
9577     *
9578     * @param parent The parent object
9579     * @return The new object or NULL if it cannot be created
9580     *
9581     * @see elm_layout_file_set()
9582     * @see elm_layout_theme_set()
9583     *
9584     * @ingroup Layout
9585     */
9586    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9587    /**
9588     * Set the file that will be used as layout
9589     *
9590     * @param obj The layout object
9591     * @param file The path to file (edj) that will be used as layout
9592     * @param group The group that the layout belongs in edje file
9593     *
9594     * @return (1 = success, 0 = error)
9595     *
9596     * @ingroup Layout
9597     */
9598    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9599    /**
9600     * Set the edje group from the elementary theme that will be used as layout
9601     *
9602     * @param obj The layout object
9603     * @param clas the clas of the group
9604     * @param group the group
9605     * @param style the style to used
9606     *
9607     * @return (1 = success, 0 = error)
9608     *
9609     * @ingroup Layout
9610     */
9611    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9612    /**
9613     * Set the layout content.
9614     *
9615     * @param obj The layout object
9616     * @param swallow The swallow part name in the edje file
9617     * @param content The child that will be added in this layout object
9618     *
9619     * Once the content object is set, a previously set one will be deleted.
9620     * If you want to keep that old content object, use the
9621     * elm_layout_content_unset() function.
9622     *
9623     * @note In an Edje theme, the part used as a content container is called @c
9624     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9625     * expected to be a part name just like the second parameter of
9626     * elm_layout_box_append().
9627     *
9628     * @see elm_layout_box_append()
9629     * @see elm_layout_content_get()
9630     * @see elm_layout_content_unset()
9631     * @see @ref secBox
9632     *
9633     * @ingroup Layout
9634     */
9635    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9636    /**
9637     * Get the child object in the given content part.
9638     *
9639     * @param obj The layout object
9640     * @param swallow The SWALLOW part to get its content
9641     *
9642     * @return The swallowed object or NULL if none or an error occurred
9643     *
9644     * @see elm_layout_content_set()
9645     *
9646     * @ingroup Layout
9647     */
9648    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9649    /**
9650     * Unset the layout content.
9651     *
9652     * @param obj The layout object
9653     * @param swallow The swallow part name in the edje file
9654     * @return The content that was being used
9655     *
9656     * Unparent and return the content object which was set for this part.
9657     *
9658     * @see elm_layout_content_set()
9659     *
9660     * @ingroup Layout
9661     */
9662     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9663    /**
9664     * Set the text of the given part
9665     *
9666     * @param obj The layout object
9667     * @param part The TEXT part where to set the text
9668     * @param text The text to set
9669     *
9670     * @ingroup Layout
9671     * @deprecated use elm_object_text_* instead.
9672     */
9673    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9674    /**
9675     * Get the text set in the given part
9676     *
9677     * @param obj The layout object
9678     * @param part The TEXT part to retrieve the text off
9679     *
9680     * @return The text set in @p part
9681     *
9682     * @ingroup Layout
9683     * @deprecated use elm_object_text_* instead.
9684     */
9685    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9686    /**
9687     * Append child to layout box part.
9688     *
9689     * @param obj the layout object
9690     * @param part the box part to which the object will be appended.
9691     * @param child the child object to append to box.
9692     *
9693     * Once the object is appended, it will become child of the layout. Its
9694     * lifetime will be bound to the layout, whenever the layout dies the child
9695     * will be deleted automatically. One should use elm_layout_box_remove() to
9696     * make this layout forget about the object.
9697     *
9698     * @see elm_layout_box_prepend()
9699     * @see elm_layout_box_insert_before()
9700     * @see elm_layout_box_insert_at()
9701     * @see elm_layout_box_remove()
9702     *
9703     * @ingroup Layout
9704     */
9705    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9706    /**
9707     * Prepend child to layout box part.
9708     *
9709     * @param obj the layout object
9710     * @param part the box part to prepend.
9711     * @param child the child object to prepend to box.
9712     *
9713     * Once the object is prepended, it will become child of the layout. Its
9714     * lifetime will be bound to the layout, whenever the layout dies the child
9715     * will be deleted automatically. One should use elm_layout_box_remove() to
9716     * make this layout forget about the object.
9717     *
9718     * @see elm_layout_box_append()
9719     * @see elm_layout_box_insert_before()
9720     * @see elm_layout_box_insert_at()
9721     * @see elm_layout_box_remove()
9722     *
9723     * @ingroup Layout
9724     */
9725    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9726    /**
9727     * Insert child to layout box part before a reference object.
9728     *
9729     * @param obj the layout object
9730     * @param part the box part to insert.
9731     * @param child the child object to insert into box.
9732     * @param reference another reference object to insert before in box.
9733     *
9734     * Once the object is inserted, it will become child of the layout. Its
9735     * lifetime will be bound to the layout, whenever the layout dies the child
9736     * will be deleted automatically. One should use elm_layout_box_remove() to
9737     * make this layout forget about the object.
9738     *
9739     * @see elm_layout_box_append()
9740     * @see elm_layout_box_prepend()
9741     * @see elm_layout_box_insert_before()
9742     * @see elm_layout_box_remove()
9743     *
9744     * @ingroup Layout
9745     */
9746    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9747    /**
9748     * Insert child to layout box part at a given position.
9749     *
9750     * @param obj the layout object
9751     * @param part the box part to insert.
9752     * @param child the child object to insert into box.
9753     * @param pos the numeric position >=0 to insert the child.
9754     *
9755     * Once the object is inserted, it will become child of the layout. Its
9756     * lifetime will be bound to the layout, whenever the layout dies the child
9757     * will be deleted automatically. One should use elm_layout_box_remove() to
9758     * make this layout forget about the object.
9759     *
9760     * @see elm_layout_box_append()
9761     * @see elm_layout_box_prepend()
9762     * @see elm_layout_box_insert_before()
9763     * @see elm_layout_box_remove()
9764     *
9765     * @ingroup Layout
9766     */
9767    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9768    /**
9769     * Remove a child of the given part box.
9770     *
9771     * @param obj The layout object
9772     * @param part The box part name to remove child.
9773     * @param child The object to remove from box.
9774     * @return The object that was being used, or NULL if not found.
9775     *
9776     * The object will be removed from the box part and its lifetime will
9777     * not be handled by the layout anymore. This is equivalent to
9778     * elm_layout_content_unset() for box.
9779     *
9780     * @see elm_layout_box_append()
9781     * @see elm_layout_box_remove_all()
9782     *
9783     * @ingroup Layout
9784     */
9785    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9786    /**
9787     * Remove all child of the given part box.
9788     *
9789     * @param obj The layout object
9790     * @param part The box part name to remove child.
9791     * @param clear If EINA_TRUE, then all objects will be deleted as
9792     *        well, otherwise they will just be removed and will be
9793     *        dangling on the canvas.
9794     *
9795     * The objects will be removed from the box part and their lifetime will
9796     * not be handled by the layout anymore. This is equivalent to
9797     * elm_layout_box_remove() for all box children.
9798     *
9799     * @see elm_layout_box_append()
9800     * @see elm_layout_box_remove()
9801     *
9802     * @ingroup Layout
9803     */
9804    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9805    /**
9806     * Insert child to layout table part.
9807     *
9808     * @param obj the layout object
9809     * @param part the box part to pack child.
9810     * @param child_obj the child object to pack into table.
9811     * @param col the column to which the child should be added. (>= 0)
9812     * @param row the row to which the child should be added. (>= 0)
9813     * @param colspan how many columns should be used to store this object. (>=
9814     *        1)
9815     * @param rowspan how many rows should be used to store this object. (>= 1)
9816     *
9817     * Once the object is inserted, it will become child of the table. Its
9818     * lifetime will be bound to the layout, and whenever the layout dies the
9819     * child will be deleted automatically. One should use
9820     * elm_layout_table_remove() to make this layout forget about the object.
9821     *
9822     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9823     * more space than a single cell. For instance, the following code:
9824     * @code
9825     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9826     * @endcode
9827     *
9828     * Would result in an object being added like the following picture:
9829     *
9830     * @image html layout_colspan.png
9831     * @image latex layout_colspan.eps width=\textwidth
9832     *
9833     * @see elm_layout_table_unpack()
9834     * @see elm_layout_table_clear()
9835     *
9836     * @ingroup Layout
9837     */
9838    EAPI void               elm_layout_table_pack(Evas_Object *obj, const char *part, Evas_Object *child_obj, unsigned short col, unsigned short row, unsigned short colspan, unsigned short rowspan) EINA_ARG_NONNULL(1);
9839    /**
9840     * Unpack (remove) a child of the given part table.
9841     *
9842     * @param obj The layout object
9843     * @param part The table part name to remove child.
9844     * @param child_obj The object to remove from table.
9845     * @return The object that was being used, or NULL if not found.
9846     *
9847     * The object will be unpacked from the table part and its lifetime
9848     * will not be handled by the layout anymore. This is equivalent to
9849     * elm_layout_content_unset() for table.
9850     *
9851     * @see elm_layout_table_pack()
9852     * @see elm_layout_table_clear()
9853     *
9854     * @ingroup Layout
9855     */
9856    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9857    /**
9858     * Remove all child of the given part table.
9859     *
9860     * @param obj The layout object
9861     * @param part The table part name to remove child.
9862     * @param clear If EINA_TRUE, then all objects will be deleted as
9863     *        well, otherwise they will just be removed and will be
9864     *        dangling on the canvas.
9865     *
9866     * The objects will be removed from the table part and their lifetime will
9867     * not be handled by the layout anymore. This is equivalent to
9868     * elm_layout_table_unpack() for all table children.
9869     *
9870     * @see elm_layout_table_pack()
9871     * @see elm_layout_table_unpack()
9872     *
9873     * @ingroup Layout
9874     */
9875    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9876    /**
9877     * Get the edje layout
9878     *
9879     * @param obj The layout object
9880     *
9881     * @return A Evas_Object with the edje layout settings loaded
9882     * with function elm_layout_file_set
9883     *
9884     * This returns the edje object. It is not expected to be used to then
9885     * swallow objects via edje_object_part_swallow() for example. Use
9886     * elm_layout_content_set() instead so child object handling and sizing is
9887     * done properly.
9888     *
9889     * @note This function should only be used if you really need to call some
9890     * low level Edje function on this edje object. All the common stuff (setting
9891     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9892     * with proper elementary functions.
9893     *
9894     * @see elm_object_signal_callback_add()
9895     * @see elm_object_signal_emit()
9896     * @see elm_object_text_part_set()
9897     * @see elm_layout_content_set()
9898     * @see elm_layout_box_append()
9899     * @see elm_layout_table_pack()
9900     * @see elm_layout_data_get()
9901     *
9902     * @ingroup Layout
9903     */
9904    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9905    /**
9906     * Get the edje data from the given layout
9907     *
9908     * @param obj The layout object
9909     * @param key The data key
9910     *
9911     * @return The edje data string
9912     *
9913     * This function fetches data specified inside the edje theme of this layout.
9914     * This function return NULL if data is not found.
9915     *
9916     * In EDC this comes from a data block within the group block that @p
9917     * obj was loaded from. E.g.
9918     *
9919     * @code
9920     * collections {
9921     *   group {
9922     *     name: "a_group";
9923     *     data {
9924     *       item: "key1" "value1";
9925     *       item: "key2" "value2";
9926     *     }
9927     *   }
9928     * }
9929     * @endcode
9930     *
9931     * @ingroup Layout
9932     */
9933    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9934    /**
9935     * Eval sizing
9936     *
9937     * @param obj The layout object
9938     *
9939     * Manually forces a sizing re-evaluation. This is useful when the minimum
9940     * size required by the edje theme of this layout has changed. The change on
9941     * the minimum size required by the edje theme is not immediately reported to
9942     * the elementary layout, so one needs to call this function in order to tell
9943     * the widget (layout) that it needs to reevaluate its own size.
9944     *
9945     * The minimum size of the theme is calculated based on minimum size of
9946     * parts, the size of elements inside containers like box and table, etc. All
9947     * of this can change due to state changes, and that's when this function
9948     * should be called.
9949     *
9950     * Also note that a standard signal of "size,eval" "elm" emitted from the
9951     * edje object will cause this to happen too.
9952     *
9953     * @ingroup Layout
9954     */
9955    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9956
9957    /**
9958     * Sets a specific cursor for an edje part.
9959     *
9960     * @param obj The layout object.
9961     * @param part_name a part from loaded edje group.
9962     * @param cursor cursor name to use, see Elementary_Cursor.h
9963     *
9964     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9965     *         part not exists or it has "mouse_events: 0".
9966     *
9967     * @ingroup Layout
9968     */
9969    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9970
9971    /**
9972     * Get the cursor to be shown when mouse is over an edje part
9973     *
9974     * @param obj The layout object.
9975     * @param part_name a part from loaded edje group.
9976     * @return the cursor name.
9977     *
9978     * @ingroup Layout
9979     */
9980    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9981
9982    /**
9983     * Unsets a cursor previously set with elm_layout_part_cursor_set().
9984     *
9985     * @param obj The layout object.
9986     * @param part_name a part from loaded edje group, that had a cursor set
9987     *        with elm_layout_part_cursor_set().
9988     *
9989     * @ingroup Layout
9990     */
9991    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9992
9993    /**
9994     * Sets a specific cursor style for an edje part.
9995     *
9996     * @param obj The layout object.
9997     * @param part_name a part from loaded edje group.
9998     * @param style the theme style to use (default, transparent, ...)
9999     *
10000     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10001     *         part not exists or it did not had a cursor set.
10002     *
10003     * @ingroup Layout
10004     */
10005    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10006
10007    /**
10008     * Gets a specific cursor style for an edje part.
10009     *
10010     * @param obj The layout object.
10011     * @param part_name a part from loaded edje group.
10012     *
10013     * @return the theme style in use, defaults to "default". If the
10014     *         object does not have a cursor set, then NULL is returned.
10015     *
10016     * @ingroup Layout
10017     */
10018    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10019
10020    /**
10021     * Sets if the cursor set should be searched on the theme or should use
10022     * the provided by the engine, only.
10023     *
10024     * @note before you set if should look on theme you should define a
10025     * cursor with elm_layout_part_cursor_set(). By default it will only
10026     * look for cursors provided by the engine.
10027     *
10028     * @param obj The layout object.
10029     * @param part_name a part from loaded edje group.
10030     * @param engine_only if cursors should be just provided by the engine
10031     *        or should also search on widget's theme as well
10032     *
10033     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10034     *         part not exists or it did not had a cursor set.
10035     *
10036     * @ingroup Layout
10037     */
10038    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_set(Evas_Object *obj, const char *part_name, Eina_Bool engine_only) EINA_ARG_NONNULL(1, 2);
10039
10040    /**
10041     * Gets a specific cursor engine_only for an edje part.
10042     *
10043     * @param obj The layout object.
10044     * @param part_name a part from loaded edje group.
10045     *
10046     * @return whenever the cursor is just provided by engine or also from theme.
10047     *
10048     * @ingroup Layout
10049     */
10050    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10051
10052 /**
10053  * @def elm_layout_icon_set
10054  * Convienience macro to set the icon object in a layout that follows the
10055  * Elementary naming convention for its parts.
10056  *
10057  * @ingroup Layout
10058  */
10059 #define elm_layout_icon_set(_ly, _obj) \
10060   do { \
10061     const char *sig; \
10062     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10063     if ((_obj)) sig = "elm,state,icon,visible"; \
10064     else sig = "elm,state,icon,hidden"; \
10065     elm_object_signal_emit((_ly), sig, "elm"); \
10066   } while (0)
10067
10068 /**
10069  * @def elm_layout_icon_get
10070  * Convienience macro to get the icon object from a layout that follows the
10071  * Elementary naming convention for its parts.
10072  *
10073  * @ingroup Layout
10074  */
10075 #define elm_layout_icon_get(_ly) \
10076   elm_layout_content_get((_ly), "elm.swallow.icon")
10077
10078 /**
10079  * @def elm_layout_end_set
10080  * Convienience macro to set the end object in a layout that follows the
10081  * Elementary naming convention for its parts.
10082  *
10083  * @ingroup Layout
10084  */
10085 #define elm_layout_end_set(_ly, _obj) \
10086   do { \
10087     const char *sig; \
10088     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10089     if ((_obj)) sig = "elm,state,end,visible"; \
10090     else sig = "elm,state,end,hidden"; \
10091     elm_object_signal_emit((_ly), sig, "elm"); \
10092   } while (0)
10093
10094 /**
10095  * @def elm_layout_end_get
10096  * Convienience macro to get the end object in a layout that follows the
10097  * Elementary naming convention for its parts.
10098  *
10099  * @ingroup Layout
10100  */
10101 #define elm_layout_end_get(_ly) \
10102   elm_layout_content_get((_ly), "elm.swallow.end")
10103
10104 /**
10105  * @def elm_layout_label_set
10106  * Convienience macro to set the label in a layout that follows the
10107  * Elementary naming convention for its parts.
10108  *
10109  * @ingroup Layout
10110  * @deprecated use elm_object_text_* instead.
10111  */
10112 #define elm_layout_label_set(_ly, _txt) \
10113   elm_layout_text_set((_ly), "elm.text", (_txt))
10114
10115 /**
10116  * @def elm_layout_label_get
10117  * Convienience macro to get the label in a layout that follows the
10118  * Elementary naming convention for its parts.
10119  *
10120  * @ingroup Layout
10121  * @deprecated use elm_object_text_* instead.
10122  */
10123 #define elm_layout_label_get(_ly) \
10124   elm_layout_text_get((_ly), "elm.text")
10125
10126    /* smart callbacks called:
10127     * "theme,changed" - when elm theme is changed.
10128     */
10129
10130    /**
10131     * @defgroup Notify Notify
10132     *
10133     * @image html img/widget/notify/preview-00.png
10134     * @image latex img/widget/notify/preview-00.eps
10135     *
10136     * Display a container in a particular region of the parent(top, bottom,
10137     * etc.  A timeout can be set to automatically hide the notify. This is so
10138     * that, after an evas_object_show() on a notify object, if a timeout was set
10139     * on it, it will @b automatically get hidden after that time.
10140     *
10141     * Signals that you can add callbacks for are:
10142     * @li "timeout" - when timeout happens on notify and it's hidden
10143     * @li "block,clicked" - when a click outside of the notify happens
10144     *
10145     * @ref tutorial_notify show usage of the API.
10146     *
10147     * @{
10148     */
10149    /**
10150     * @brief Possible orient values for notify.
10151     *
10152     * This values should be used in conjunction to elm_notify_orient_set() to
10153     * set the position in which the notify should appear(relative to its parent)
10154     * and in conjunction with elm_notify_orient_get() to know where the notify
10155     * is appearing.
10156     */
10157    typedef enum _Elm_Notify_Orient
10158      {
10159         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10160         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10161         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10162         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10163         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10164         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10165         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10166         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10167         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10168         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10169      } Elm_Notify_Orient;
10170    /**
10171     * @brief Add a new notify to the parent
10172     *
10173     * @param parent The parent object
10174     * @return The new object or NULL if it cannot be created
10175     */
10176    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10177    /**
10178     * @brief Set the content of the notify widget
10179     *
10180     * @param obj The notify object
10181     * @param content The content will be filled in this notify object
10182     *
10183     * Once the content object is set, a previously set one will be deleted. If
10184     * you want to keep that old content object, use the
10185     * elm_notify_content_unset() function.
10186     */
10187    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10188    /**
10189     * @brief Unset the content of the notify widget
10190     *
10191     * @param obj The notify object
10192     * @return The content that was being used
10193     *
10194     * Unparent and return the content object which was set for this widget
10195     *
10196     * @see elm_notify_content_set()
10197     */
10198    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10199    /**
10200     * @brief Return the content of the notify widget
10201     *
10202     * @param obj The notify object
10203     * @return The content that is being used
10204     *
10205     * @see elm_notify_content_set()
10206     */
10207    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10208    /**
10209     * @brief Set the notify parent
10210     *
10211     * @param obj The notify object
10212     * @param content The new parent
10213     *
10214     * Once the parent object is set, a previously set one will be disconnected
10215     * and replaced.
10216     */
10217    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10218    /**
10219     * @brief Get the notify parent
10220     *
10221     * @param obj The notify object
10222     * @return The parent
10223     *
10224     * @see elm_notify_parent_set()
10225     */
10226    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10227    /**
10228     * @brief Set the orientation
10229     *
10230     * @param obj The notify object
10231     * @param orient The new orientation
10232     *
10233     * Sets the position in which the notify will appear in its parent.
10234     *
10235     * @see @ref Elm_Notify_Orient for possible values.
10236     */
10237    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10238    /**
10239     * @brief Return the orientation
10240     * @param obj The notify object
10241     * @return The orientation of the notification
10242     *
10243     * @see elm_notify_orient_set()
10244     * @see Elm_Notify_Orient
10245     */
10246    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10247    /**
10248     * @brief Set the time interval after which the notify window is going to be
10249     * hidden.
10250     *
10251     * @param obj The notify object
10252     * @param time The timeout in seconds
10253     *
10254     * This function sets a timeout and starts the timer controlling when the
10255     * notify is hidden. Since calling evas_object_show() on a notify restarts
10256     * the timer controlling when the notify is hidden, setting this before the
10257     * notify is shown will in effect mean starting the timer when the notify is
10258     * shown.
10259     *
10260     * @note Set a value <= 0.0 to disable a running timer.
10261     *
10262     * @note If the value > 0.0 and the notify is previously visible, the
10263     * timer will be started with this value, canceling any running timer.
10264     */
10265    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10266    /**
10267     * @brief Return the timeout value (in seconds)
10268     * @param obj the notify object
10269     *
10270     * @see elm_notify_timeout_set()
10271     */
10272    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10273    /**
10274     * @brief Sets whether events should be passed to by a click outside
10275     * its area.
10276     *
10277     * @param obj The notify object
10278     * @param repeats EINA_TRUE Events are repeats, else no
10279     *
10280     * When true if the user clicks outside the window the events will be caught
10281     * by the others widgets, else the events are blocked.
10282     *
10283     * @note The default value is EINA_TRUE.
10284     */
10285    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10286    /**
10287     * @brief Return true if events are repeat below the notify object
10288     * @param obj the notify object
10289     *
10290     * @see elm_notify_repeat_events_set()
10291     */
10292    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10293    /**
10294     * @}
10295     */
10296
10297    /**
10298     * @defgroup Hover Hover
10299     *
10300     * @image html img/widget/hover/preview-00.png
10301     * @image latex img/widget/hover/preview-00.eps
10302     *
10303     * A Hover object will hover over its @p parent object at the @p target
10304     * location. Anything in the background will be given a darker coloring to
10305     * indicate that the hover object is on top (at the default theme). When the
10306     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10307     * clicked that @b doesn't cause the hover to be dismissed.
10308     *
10309     * @note The hover object will take up the entire space of @p target
10310     * object.
10311     *
10312     * Elementary has the following styles for the hover widget:
10313     * @li default
10314     * @li popout
10315     * @li menu
10316     * @li hoversel_vertical
10317     *
10318     * The following are the available position for content:
10319     * @li left
10320     * @li top-left
10321     * @li top
10322     * @li top-right
10323     * @li right
10324     * @li bottom-right
10325     * @li bottom
10326     * @li bottom-left
10327     * @li middle
10328     * @li smart
10329     *
10330     * Signals that you can add callbacks for are:
10331     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10332     * @li "smart,changed" - a content object placed under the "smart"
10333     *                   policy was replaced to a new slot direction.
10334     *
10335     * See @ref tutorial_hover for more information.
10336     *
10337     * @{
10338     */
10339    typedef enum _Elm_Hover_Axis
10340      {
10341         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10342         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10343         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10344         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10345      } Elm_Hover_Axis;
10346    /**
10347     * @brief Adds a hover object to @p parent
10348     *
10349     * @param parent The parent object
10350     * @return The hover object or NULL if one could not be created
10351     */
10352    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10353    /**
10354     * @brief Sets the target object for the hover.
10355     *
10356     * @param obj The hover object
10357     * @param target The object to center the hover onto. The hover
10358     *
10359     * This function will cause the hover to be centered on the target object.
10360     */
10361    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10362    /**
10363     * @brief Gets the target object for the hover.
10364     *
10365     * @param obj The hover object
10366     * @param parent The object to locate the hover over.
10367     *
10368     * @see elm_hover_target_set()
10369     */
10370    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10371    /**
10372     * @brief Sets the parent object for the hover.
10373     *
10374     * @param obj The hover object
10375     * @param parent The object to locate the hover over.
10376     *
10377     * This function will cause the hover to take up the entire space that the
10378     * parent object fills.
10379     */
10380    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10381    /**
10382     * @brief Gets the parent object for the hover.
10383     *
10384     * @param obj The hover object
10385     * @return The parent object to locate the hover over.
10386     *
10387     * @see elm_hover_parent_set()
10388     */
10389    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10390    /**
10391     * @brief Sets the content of the hover object and the direction in which it
10392     * will pop out.
10393     *
10394     * @param obj The hover object
10395     * @param swallow The direction that the object will be displayed
10396     * at. Accepted values are "left", "top-left", "top", "top-right",
10397     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10398     * "smart".
10399     * @param content The content to place at @p swallow
10400     *
10401     * Once the content object is set for a given direction, a previously
10402     * set one (on the same direction) will be deleted. If you want to
10403     * keep that old content object, use the elm_hover_content_unset()
10404     * function.
10405     *
10406     * All directions may have contents at the same time, except for
10407     * "smart". This is a special placement hint and its use case
10408     * independs of the calculations coming from
10409     * elm_hover_best_content_location_get(). Its use is for cases when
10410     * one desires only one hover content, but with a dinamic special
10411     * placement within the hover area. The content's geometry, whenever
10412     * it changes, will be used to decide on a best location not
10413     * extrapolating the hover's parent object view to show it in (still
10414     * being the hover's target determinant of its medium part -- move and
10415     * resize it to simulate finger sizes, for example). If one of the
10416     * directions other than "smart" are used, a previously content set
10417     * using it will be deleted, and vice-versa.
10418     */
10419    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10420    /**
10421     * @brief Get the content of the hover object, in a given direction.
10422     *
10423     * Return the content object which was set for this widget in the
10424     * @p swallow direction.
10425     *
10426     * @param obj The hover object
10427     * @param swallow The direction that the object was display at.
10428     * @return The content that was being used
10429     *
10430     * @see elm_hover_content_set()
10431     */
10432    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10433    /**
10434     * @brief Unset the content of the hover object, in a given direction.
10435     *
10436     * Unparent and return the content object set at @p swallow direction.
10437     *
10438     * @param obj The hover object
10439     * @param swallow The direction that the object was display at.
10440     * @return The content that was being used.
10441     *
10442     * @see elm_hover_content_set()
10443     */
10444    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10445    /**
10446     * @brief Returns the best swallow location for content in the hover.
10447     *
10448     * @param obj The hover object
10449     * @param pref_axis The preferred orientation axis for the hover object to use
10450     * @return The edje location to place content into the hover or @c
10451     *         NULL, on errors.
10452     *
10453     * Best is defined here as the location at which there is the most available
10454     * space.
10455     *
10456     * @p pref_axis may be one of
10457     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10458     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10459     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10460     * - @c ELM_HOVER_AXIS_BOTH -- both
10461     *
10462     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10463     * nescessarily be along the horizontal axis("left" or "right"). If
10464     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10465     * be along the vertical axis("top" or "bottom"). Chossing
10466     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10467     * returned position may be in either axis.
10468     *
10469     * @see elm_hover_content_set()
10470     */
10471    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10472    /**
10473     * @}
10474     */
10475
10476    /* entry */
10477    /**
10478     * @defgroup Entry Entry
10479     *
10480     * @image html img/widget/entry/preview-00.png
10481     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10482     * @image html img/widget/entry/preview-01.png
10483     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10484     * @image html img/widget/entry/preview-02.png
10485     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10486     * @image html img/widget/entry/preview-03.png
10487     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10488     *
10489     * An entry is a convenience widget which shows a box that the user can
10490     * enter text into. Entries by default don't scroll, so they grow to
10491     * accomodate the entire text, resizing the parent window as needed. This
10492     * can be changed with the elm_entry_scrollable_set() function.
10493     *
10494     * They can also be single line or multi line (the default) and when set
10495     * to multi line mode they support text wrapping in any of the modes
10496     * indicated by #Elm_Wrap_Type.
10497     *
10498     * Other features include password mode, filtering of inserted text with
10499     * elm_entry_text_filter_append() and related functions, inline "items" and
10500     * formatted markup text.
10501     *
10502     * @section entry-markup Formatted text
10503     *
10504     * The markup tags supported by the Entry are defined by the theme, but
10505     * even when writing new themes or extensions it's a good idea to stick to
10506     * a sane default, to maintain coherency and avoid application breakages.
10507     * Currently defined by the default theme are the following tags:
10508     * @li \<br\>: Inserts a line break.
10509     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10510     * breaks.
10511     * @li \<tab\>: Inserts a tab.
10512     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10513     * enclosed text.
10514     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10515     * @li \<link\>...\</link\>: Underlines the enclosed text.
10516     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10517     *
10518     * @section entry-special Special markups
10519     *
10520     * Besides those used to format text, entries support two special markup
10521     * tags used to insert clickable portions of text or items inlined within
10522     * the text.
10523     *
10524     * @subsection entry-anchors Anchors
10525     *
10526     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10527     * \</a\> tags and an event will be generated when this text is clicked,
10528     * like this:
10529     *
10530     * @code
10531     * This text is outside <a href=anc-01>but this one is an anchor</a>
10532     * @endcode
10533     *
10534     * The @c href attribute in the opening tag gives the name that will be
10535     * used to identify the anchor and it can be any valid utf8 string.
10536     *
10537     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10538     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10539     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10540     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10541     * an anchor.
10542     *
10543     * @subsection entry-items Items
10544     *
10545     * Inlined in the text, any other @c Evas_Object can be inserted by using
10546     * \<item\> tags this way:
10547     *
10548     * @code
10549     * <item size=16x16 vsize=full href=emoticon/haha></item>
10550     * @endcode
10551     *
10552     * Just like with anchors, the @c href identifies each item, but these need,
10553     * in addition, to indicate their size, which is done using any one of
10554     * @c size, @c absize or @c relsize attributes. These attributes take their
10555     * value in the WxH format, where W is the width and H the height of the
10556     * item.
10557     *
10558     * @li absize: Absolute pixel size for the item. Whatever value is set will
10559     * be the item's size regardless of any scale value the object may have
10560     * been set to. The final line height will be adjusted to fit larger items.
10561     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10562     * for the object.
10563     * @li relsize: Size is adjusted for the item to fit within the current
10564     * line height.
10565     *
10566     * Besides their size, items are specificed a @c vsize value that affects
10567     * how their final size and position are calculated. The possible values
10568     * are:
10569     * @li ascent: Item will be placed within the line's baseline and its
10570     * ascent. That is, the height between the line where all characters are
10571     * positioned and the highest point in the line. For @c size and @c absize
10572     * items, the descent value will be added to the total line height to make
10573     * them fit. @c relsize items will be adjusted to fit within this space.
10574     * @li full: Items will be placed between the descent and ascent, or the
10575     * lowest point in the line and its highest.
10576     *
10577     * The next image shows different configurations of items and how they
10578     * are the previously mentioned options affect their sizes. In all cases,
10579     * the green line indicates the ascent, blue for the baseline and red for
10580     * the descent.
10581     *
10582     * @image html entry_item.png
10583     * @image latex entry_item.eps width=\textwidth
10584     *
10585     * And another one to show how size differs from absize. In the first one,
10586     * the scale value is set to 1.0, while the second one is using one of 2.0.
10587     *
10588     * @image html entry_item_scale.png
10589     * @image latex entry_item_scale.eps width=\textwidth
10590     *
10591     * After the size for an item is calculated, the entry will request an
10592     * object to place in its space. For this, the functions set with
10593     * elm_entry_item_provider_append() and related functions will be called
10594     * in order until one of them returns a @c non-NULL value. If no providers
10595     * are available, or all of them return @c NULL, then the entry falls back
10596     * to one of the internal defaults, provided the name matches with one of
10597     * them.
10598     *
10599     * All of the following are currently supported:
10600     *
10601     * - emoticon/angry
10602     * - emoticon/angry-shout
10603     * - emoticon/crazy-laugh
10604     * - emoticon/evil-laugh
10605     * - emoticon/evil
10606     * - emoticon/goggle-smile
10607     * - emoticon/grumpy
10608     * - emoticon/grumpy-smile
10609     * - emoticon/guilty
10610     * - emoticon/guilty-smile
10611     * - emoticon/haha
10612     * - emoticon/half-smile
10613     * - emoticon/happy-panting
10614     * - emoticon/happy
10615     * - emoticon/indifferent
10616     * - emoticon/kiss
10617     * - emoticon/knowing-grin
10618     * - emoticon/laugh
10619     * - emoticon/little-bit-sorry
10620     * - emoticon/love-lots
10621     * - emoticon/love
10622     * - emoticon/minimal-smile
10623     * - emoticon/not-happy
10624     * - emoticon/not-impressed
10625     * - emoticon/omg
10626     * - emoticon/opensmile
10627     * - emoticon/smile
10628     * - emoticon/sorry
10629     * - emoticon/squint-laugh
10630     * - emoticon/surprised
10631     * - emoticon/suspicious
10632     * - emoticon/tongue-dangling
10633     * - emoticon/tongue-poke
10634     * - emoticon/uh
10635     * - emoticon/unhappy
10636     * - emoticon/very-sorry
10637     * - emoticon/what
10638     * - emoticon/wink
10639     * - emoticon/worried
10640     * - emoticon/wtf
10641     *
10642     * Alternatively, an item may reference an image by its path, using
10643     * the URI form @c file:///path/to/an/image.png and the entry will then
10644     * use that image for the item.
10645     *
10646     * @section entry-files Loading and saving files
10647     *
10648     * Entries have convinience functions to load text from a file and save
10649     * changes back to it after a short delay. The automatic saving is enabled
10650     * by default, but can be disabled with elm_entry_autosave_set() and files
10651     * can be loaded directly as plain text or have any markup in them
10652     * recognized. See elm_entry_file_set() for more details.
10653     *
10654     * @section entry-signals Emitted signals
10655     *
10656     * This widget emits the following signals:
10657     *
10658     * @li "changed": The text within the entry was changed.
10659     * @li "changed,user": The text within the entry was changed because of user interaction.
10660     * @li "activated": The enter key was pressed on a single line entry.
10661     * @li "press": A mouse button has been pressed on the entry.
10662     * @li "longpressed": A mouse button has been pressed and held for a couple
10663     * seconds.
10664     * @li "clicked": The entry has been clicked (mouse press and release).
10665     * @li "clicked,double": The entry has been double clicked.
10666     * @li "clicked,triple": The entry has been triple clicked.
10667     * @li "focused": The entry has received focus.
10668     * @li "unfocused": The entry has lost focus.
10669     * @li "selection,paste": A paste of the clipboard contents was requested.
10670     * @li "selection,copy": A copy of the selected text into the clipboard was
10671     * requested.
10672     * @li "selection,cut": A cut of the selected text into the clipboard was
10673     * requested.
10674     * @li "selection,start": A selection has begun and no previous selection
10675     * existed.
10676     * @li "selection,changed": The current selection has changed.
10677     * @li "selection,cleared": The current selection has been cleared.
10678     * @li "cursor,changed": The cursor has changed position.
10679     * @li "anchor,clicked": An anchor has been clicked. The event_info
10680     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10681     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10682     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10683     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10684     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10685     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10686     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10687     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10688     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10689     * @li "preedit,changed": The preedit string has changed.
10690     *
10691     * @section entry-examples
10692     *
10693     * An overview of the Entry API can be seen in @ref entry_example_01
10694     *
10695     * @{
10696     */
10697    /**
10698     * @typedef Elm_Entry_Anchor_Info
10699     *
10700     * The info sent in the callback for the "anchor,clicked" signals emitted
10701     * by entries.
10702     */
10703    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10704    /**
10705     * @struct _Elm_Entry_Anchor_Info
10706     *
10707     * The info sent in the callback for the "anchor,clicked" signals emitted
10708     * by entries.
10709     */
10710    struct _Elm_Entry_Anchor_Info
10711      {
10712         const char *name; /**< The name of the anchor, as stated in its href */
10713         int         button; /**< The mouse button used to click on it */
10714         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10715                     y, /**< Anchor geometry, relative to canvas */
10716                     w, /**< Anchor geometry, relative to canvas */
10717                     h; /**< Anchor geometry, relative to canvas */
10718      };
10719    /**
10720     * @typedef Elm_Entry_Filter_Cb
10721     * This callback type is used by entry filters to modify text.
10722     * @param data The data specified as the last param when adding the filter
10723     * @param entry The entry object
10724     * @param text A pointer to the location of the text being filtered. This data can be modified,
10725     * but any additional allocations must be managed by the user.
10726     * @see elm_entry_text_filter_append
10727     * @see elm_entry_text_filter_prepend
10728     */
10729    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10730
10731    /**
10732     * This adds an entry to @p parent object.
10733     *
10734     * By default, entries are:
10735     * @li not scrolled
10736     * @li multi-line
10737     * @li word wrapped
10738     * @li autosave is enabled
10739     *
10740     * @param parent The parent object
10741     * @return The new object or NULL if it cannot be created
10742     */
10743    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10744    /**
10745     * Sets the entry to single line mode.
10746     *
10747     * In single line mode, entries don't ever wrap when the text reaches the
10748     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10749     * key will generate an @c "activate" event instead of adding a new line.
10750     *
10751     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10752     * and pressing enter will break the text into a different line
10753     * without generating any events.
10754     *
10755     * @param obj The entry object
10756     * @param single_line If true, the text in the entry
10757     * will be on a single line.
10758     */
10759    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10760    /**
10761     * Gets whether the entry is set to be single line.
10762     *
10763     * @param obj The entry object
10764     * @return single_line If true, the text in the entry is set to display
10765     * on a single line.
10766     *
10767     * @see elm_entry_single_line_set()
10768     */
10769    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10770    /**
10771     * Sets the entry to password mode.
10772     *
10773     * In password mode, entries are implicitly single line and the display of
10774     * any text in them is replaced with asterisks (*).
10775     *
10776     * @param obj The entry object
10777     * @param password If true, password mode is enabled.
10778     */
10779    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10780    /**
10781     * Gets whether the entry is set to password mode.
10782     *
10783     * @param obj The entry object
10784     * @return If true, the entry is set to display all characters
10785     * as asterisks (*).
10786     *
10787     * @see elm_entry_password_set()
10788     */
10789    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10790    /**
10791     * This sets the text displayed within the entry to @p entry.
10792     *
10793     * @param obj The entry object
10794     * @param entry The text to be displayed
10795     *
10796     * @deprecated Use elm_object_text_set() instead.
10797     */
10798    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10799    /**
10800     * This returns the text currently shown in object @p entry.
10801     * See also elm_entry_entry_set().
10802     *
10803     * @param obj The entry object
10804     * @return The currently displayed text or NULL on failure
10805     *
10806     * @deprecated Use elm_object_text_get() instead.
10807     */
10808    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10809    /**
10810     * Appends @p entry to the text of the entry.
10811     *
10812     * Adds the text in @p entry to the end of any text already present in the
10813     * widget.
10814     *
10815     * The appended text is subject to any filters set for the widget.
10816     *
10817     * @param obj The entry object
10818     * @param entry The text to be displayed
10819     *
10820     * @see elm_entry_text_filter_append()
10821     */
10822    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10823    /**
10824     * Gets whether the entry is empty.
10825     *
10826     * Empty means no text at all. If there are any markup tags, like an item
10827     * tag for which no provider finds anything, and no text is displayed, this
10828     * function still returns EINA_FALSE.
10829     *
10830     * @param obj The entry object
10831     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10832     */
10833    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10834    /**
10835     * Gets any selected text within the entry.
10836     *
10837     * If there's any selected text in the entry, this function returns it as
10838     * a string in markup format. NULL is returned if no selection exists or
10839     * if an error occurred.
10840     *
10841     * The returned value points to an internal string and should not be freed
10842     * or modified in any way. If the @p entry object is deleted or its
10843     * contents are changed, the returned pointer should be considered invalid.
10844     *
10845     * @param obj The entry object
10846     * @return The selected text within the entry or NULL on failure
10847     */
10848    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10849    /**
10850     * Inserts the given text into the entry at the current cursor position.
10851     *
10852     * This inserts text at the cursor position as if it was typed
10853     * by the user (note that this also allows markup which a user
10854     * can't just "type" as it would be converted to escaped text, so this
10855     * call can be used to insert things like emoticon items or bold push/pop
10856     * tags, other font and color change tags etc.)
10857     *
10858     * If any selection exists, it will be replaced by the inserted text.
10859     *
10860     * The inserted text is subject to any filters set for the widget.
10861     *
10862     * @param obj The entry object
10863     * @param entry The text to insert
10864     *
10865     * @see elm_entry_text_filter_append()
10866     */
10867    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10868    /**
10869     * Set the line wrap type to use on multi-line entries.
10870     *
10871     * Sets the wrap type used by the entry to any of the specified in
10872     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10873     * line (without inserting a line break or paragraph separator) when it
10874     * reaches the far edge of the widget.
10875     *
10876     * Note that this only makes sense for multi-line entries. A widget set
10877     * to be single line will never wrap.
10878     *
10879     * @param obj The entry object
10880     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10881     */
10882    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10883    /**
10884     * Gets the wrap mode the entry was set to use.
10885     *
10886     * @param obj The entry object
10887     * @return Wrap type
10888     *
10889     * @see also elm_entry_line_wrap_set()
10890     */
10891    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10892    /**
10893     * Sets if the entry is to be editable or not.
10894     *
10895     * By default, entries are editable and when focused, any text input by the
10896     * user will be inserted at the current cursor position. But calling this
10897     * function with @p editable as EINA_FALSE will prevent the user from
10898     * inputting text into the entry.
10899     *
10900     * The only way to change the text of a non-editable entry is to use
10901     * elm_object_text_set(), elm_entry_entry_insert() and other related
10902     * functions.
10903     *
10904     * @param obj The entry object
10905     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10906     * if not, the entry is read-only and no user input is allowed.
10907     */
10908    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10909    /**
10910     * Gets whether the entry is editable or not.
10911     *
10912     * @param obj The entry object
10913     * @return If true, the entry is editable by the user.
10914     * If false, it is not editable by the user
10915     *
10916     * @see elm_entry_editable_set()
10917     */
10918    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10919    /**
10920     * This drops any existing text selection within the entry.
10921     *
10922     * @param obj The entry object
10923     */
10924    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10925    /**
10926     * This selects all text within the entry.
10927     *
10928     * @param obj The entry object
10929     */
10930    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10931    /**
10932     * This moves the cursor one place to the right within the entry.
10933     *
10934     * @param obj The entry object
10935     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10936     */
10937    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10938    /**
10939     * This moves the cursor one place to the left within the entry.
10940     *
10941     * @param obj The entry object
10942     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10943     */
10944    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10945    /**
10946     * This moves the cursor one line up within the entry.
10947     *
10948     * @param obj The entry object
10949     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10950     */
10951    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10952    /**
10953     * This moves the cursor one line down within the entry.
10954     *
10955     * @param obj The entry object
10956     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10957     */
10958    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10959    /**
10960     * This moves the cursor to the beginning of the entry.
10961     *
10962     * @param obj The entry object
10963     */
10964    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10965    /**
10966     * This moves the cursor to the end of the entry.
10967     *
10968     * @param obj The entry object
10969     */
10970    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10971    /**
10972     * This moves the cursor to the beginning of the current line.
10973     *
10974     * @param obj The entry object
10975     */
10976    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10977    /**
10978     * This moves the cursor to the end of the current line.
10979     *
10980     * @param obj The entry object
10981     */
10982    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10983    /**
10984     * This begins a selection within the entry as though
10985     * the user were holding down the mouse button to make a selection.
10986     *
10987     * @param obj The entry object
10988     */
10989    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10990    /**
10991     * This ends a selection within the entry as though
10992     * the user had just released the mouse button while making a selection.
10993     *
10994     * @param obj The entry object
10995     */
10996    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10997    /**
10998     * Gets whether a format node exists at the current cursor position.
10999     *
11000     * A format node is anything that defines how the text is rendered. It can
11001     * be a visible format node, such as a line break or a paragraph separator,
11002     * or an invisible one, such as bold begin or end tag.
11003     * This function returns whether any format node exists at the current
11004     * cursor position.
11005     *
11006     * @param obj The entry object
11007     * @return EINA_TRUE if the current cursor position contains a format node,
11008     * EINA_FALSE otherwise.
11009     *
11010     * @see elm_entry_cursor_is_visible_format_get()
11011     */
11012    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11013    /**
11014     * Gets if the current cursor position holds a visible format node.
11015     *
11016     * @param obj The entry object
11017     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11018     * if it's an invisible one or no format exists.
11019     *
11020     * @see elm_entry_cursor_is_format_get()
11021     */
11022    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11023    /**
11024     * Gets the character pointed by the cursor at its current position.
11025     *
11026     * This function returns a string with the utf8 character stored at the
11027     * current cursor position.
11028     * Only the text is returned, any format that may exist will not be part
11029     * of the return value.
11030     *
11031     * @param obj The entry object
11032     * @return The text pointed by the cursors.
11033     */
11034    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11035    /**
11036     * This function returns the geometry of the cursor.
11037     *
11038     * It's useful if you want to draw something on the cursor (or where it is),
11039     * or for example in the case of scrolled entry where you want to show the
11040     * cursor.
11041     *
11042     * @param obj The entry object
11043     * @param x returned geometry
11044     * @param y returned geometry
11045     * @param w returned geometry
11046     * @param h returned geometry
11047     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11048     */
11049    EAPI Eina_Bool    elm_entry_cursor_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
11050    /**
11051     * Sets the cursor position in the entry to the given value
11052     *
11053     * The value in @p pos is the index of the character position within the
11054     * contents of the string as returned by elm_entry_cursor_pos_get().
11055     *
11056     * @param obj The entry object
11057     * @param pos The position of the cursor
11058     */
11059    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11060    /**
11061     * Retrieves the current position of the cursor in the entry
11062     *
11063     * @param obj The entry object
11064     * @return The cursor position
11065     */
11066    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11067    /**
11068     * This executes a "cut" action on the selected text in the entry.
11069     *
11070     * @param obj The entry object
11071     */
11072    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11073    /**
11074     * This executes a "copy" action on the selected text in the entry.
11075     *
11076     * @param obj The entry object
11077     */
11078    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11079    /**
11080     * This executes a "paste" action in the entry.
11081     *
11082     * @param obj The entry object
11083     */
11084    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11085    /**
11086     * This clears and frees the items in a entry's contextual (longpress)
11087     * menu.
11088     *
11089     * @param obj The entry object
11090     *
11091     * @see elm_entry_context_menu_item_add()
11092     */
11093    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11094    /**
11095     * This adds an item to the entry's contextual menu.
11096     *
11097     * A longpress on an entry will make the contextual menu show up, if this
11098     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11099     * By default, this menu provides a few options like enabling selection mode,
11100     * which is useful on embedded devices that need to be explicit about it,
11101     * and when a selection exists it also shows the copy and cut actions.
11102     *
11103     * With this function, developers can add other options to this menu to
11104     * perform any action they deem necessary.
11105     *
11106     * @param obj The entry object
11107     * @param label The item's text label
11108     * @param icon_file The item's icon file
11109     * @param icon_type The item's icon type
11110     * @param func The callback to execute when the item is clicked
11111     * @param data The data to associate with the item for related functions
11112     */
11113    EAPI void         elm_entry_context_menu_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
11114    /**
11115     * This disables the entry's contextual (longpress) menu.
11116     *
11117     * @param obj The entry object
11118     * @param disabled If true, the menu is disabled
11119     */
11120    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11121    /**
11122     * This returns whether the entry's contextual (longpress) menu is
11123     * disabled.
11124     *
11125     * @param obj The entry object
11126     * @return If true, the menu is disabled
11127     */
11128    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11129    /**
11130     * This appends a custom item provider to the list for that entry
11131     *
11132     * This appends the given callback. The list is walked from beginning to end
11133     * with each function called given the item href string in the text. If the
11134     * function returns an object handle other than NULL (it should create an
11135     * object to do this), then this object is used to replace that item. If
11136     * not the next provider is called until one provides an item object, or the
11137     * default provider in entry does.
11138     *
11139     * @param obj The entry object
11140     * @param func The function called to provide the item object
11141     * @param data The data passed to @p func
11142     *
11143     * @see @ref entry-items
11144     */
11145    EAPI void         elm_entry_item_provider_append(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
11146    /**
11147     * This prepends a custom item provider to the list for that entry
11148     *
11149     * This prepends the given callback. See elm_entry_item_provider_append() for
11150     * more information
11151     *
11152     * @param obj The entry object
11153     * @param func The function called to provide the item object
11154     * @param data The data passed to @p func
11155     */
11156    EAPI void         elm_entry_item_provider_prepend(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
11157    /**
11158     * This removes a custom item provider to the list for that entry
11159     *
11160     * This removes the given callback. See elm_entry_item_provider_append() for
11161     * more information
11162     *
11163     * @param obj The entry object
11164     * @param func The function called to provide the item object
11165     * @param data The data passed to @p func
11166     */
11167    EAPI void         elm_entry_item_provider_remove(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
11168    /**
11169     * Append a filter function for text inserted in the entry
11170     *
11171     * Append the given callback to the list. This functions will be called
11172     * whenever any text is inserted into the entry, with the text to be inserted
11173     * as a parameter. The callback function is free to alter the text in any way
11174     * it wants, but it must remember to free the given pointer and update it.
11175     * If the new text is to be discarded, the function can free it and set its
11176     * text parameter to NULL. This will also prevent any following filters from
11177     * being called.
11178     *
11179     * @param obj The entry object
11180     * @param func The function to use as text filter
11181     * @param data User data to pass to @p func
11182     */
11183    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11184    /**
11185     * Prepend a filter function for text insdrted in the entry
11186     *
11187     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11188     * for more information
11189     *
11190     * @param obj The entry object
11191     * @param func The function to use as text filter
11192     * @param data User data to pass to @p func
11193     */
11194    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11195    /**
11196     * Remove a filter from the list
11197     *
11198     * Removes the given callback from the filter list. See
11199     * elm_entry_text_filter_append() for more information.
11200     *
11201     * @param obj The entry object
11202     * @param func The filter function to remove
11203     * @param data The user data passed when adding the function
11204     */
11205    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11206    /**
11207     * This converts a markup (HTML-like) string into UTF-8.
11208     *
11209     * The returned string is a malloc'ed buffer and it should be freed when
11210     * not needed anymore.
11211     *
11212     * @param s The string (in markup) to be converted
11213     * @return The converted string (in UTF-8). It should be freed.
11214     */
11215    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11216    /**
11217     * This converts a UTF-8 string into markup (HTML-like).
11218     *
11219     * The returned string is a malloc'ed buffer and it should be freed when
11220     * not needed anymore.
11221     *
11222     * @param s The string (in UTF-8) to be converted
11223     * @return The converted string (in markup). It should be freed.
11224     */
11225    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11226    /**
11227     * This sets the file (and implicitly loads it) for the text to display and
11228     * then edit. All changes are written back to the file after a short delay if
11229     * the entry object is set to autosave (which is the default).
11230     *
11231     * If the entry had any other file set previously, any changes made to it
11232     * will be saved if the autosave feature is enabled, otherwise, the file
11233     * will be silently discarded and any non-saved changes will be lost.
11234     *
11235     * @param obj The entry object
11236     * @param file The path to the file to load and save
11237     * @param format The file format
11238     */
11239    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11240    /**
11241     * Gets the file being edited by the entry.
11242     *
11243     * This function can be used to retrieve any file set on the entry for
11244     * edition, along with the format used to load and save it.
11245     *
11246     * @param obj The entry object
11247     * @param file The path to the file to load and save
11248     * @param format The file format
11249     */
11250    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11251    /**
11252     * This function writes any changes made to the file set with
11253     * elm_entry_file_set()
11254     *
11255     * @param obj The entry object
11256     */
11257    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11258    /**
11259     * This sets the entry object to 'autosave' the loaded text file or not.
11260     *
11261     * @param obj The entry object
11262     * @param autosave Autosave the loaded file or not
11263     *
11264     * @see elm_entry_file_set()
11265     */
11266    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11267    /**
11268     * This gets the entry object's 'autosave' status.
11269     *
11270     * @param obj The entry object
11271     * @return Autosave the loaded file or not
11272     *
11273     * @see elm_entry_file_set()
11274     */
11275    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11276    /**
11277     * Control pasting of text and images for the widget.
11278     *
11279     * Normally the entry allows both text and images to be pasted.  By setting
11280     * textonly to be true, this prevents images from being pasted.
11281     *
11282     * Note this only changes the behaviour of text.
11283     *
11284     * @param obj The entry object
11285     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11286     * text+image+other.
11287     */
11288    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11289    /**
11290     * Getting elm_entry text paste/drop mode.
11291     *
11292     * In textonly mode, only text may be pasted or dropped into the widget.
11293     *
11294     * @param obj The entry object
11295     * @return If the widget only accepts text from pastes.
11296     */
11297    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11298    /**
11299     * Enable or disable scrolling in entry
11300     *
11301     * Normally the entry is not scrollable unless you enable it with this call.
11302     *
11303     * @param obj The entry object
11304     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11305     */
11306    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11307    /**
11308     * Get the scrollable state of the entry
11309     *
11310     * Normally the entry is not scrollable. This gets the scrollable state
11311     * of the entry. See elm_entry_scrollable_set() for more information.
11312     *
11313     * @param obj The entry object
11314     * @return The scrollable state
11315     */
11316    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11317    /**
11318     * This sets a widget to be displayed to the left of a scrolled entry.
11319     *
11320     * @param obj The scrolled entry object
11321     * @param icon The widget to display on the left side of the scrolled
11322     * entry.
11323     *
11324     * @note A previously set widget will be destroyed.
11325     * @note If the object being set does not have minimum size hints set,
11326     * it won't get properly displayed.
11327     *
11328     * @see elm_entry_end_set()
11329     */
11330    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11331    /**
11332     * Gets the leftmost widget of the scrolled entry. This object is
11333     * owned by the scrolled entry and should not be modified.
11334     *
11335     * @param obj The scrolled entry object
11336     * @return the left widget inside the scroller
11337     */
11338    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11339    /**
11340     * Unset the leftmost widget of the scrolled entry, unparenting and
11341     * returning it.
11342     *
11343     * @param obj The scrolled entry object
11344     * @return the previously set icon sub-object of this entry, on
11345     * success.
11346     *
11347     * @see elm_entry_icon_set()
11348     */
11349    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11350    /**
11351     * Sets the visibility of the left-side widget of the scrolled entry,
11352     * set by elm_entry_icon_set().
11353     *
11354     * @param obj The scrolled entry object
11355     * @param setting EINA_TRUE if the object should be displayed,
11356     * EINA_FALSE if not.
11357     */
11358    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11359    /**
11360     * This sets a widget to be displayed to the end of a scrolled entry.
11361     *
11362     * @param obj The scrolled entry object
11363     * @param end The widget to display on the right side of the scrolled
11364     * entry.
11365     *
11366     * @note A previously set widget will be destroyed.
11367     * @note If the object being set does not have minimum size hints set,
11368     * it won't get properly displayed.
11369     *
11370     * @see elm_entry_icon_set
11371     */
11372    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11373    /**
11374     * Gets the endmost widget of the scrolled entry. This object is owned
11375     * by the scrolled entry and should not be modified.
11376     *
11377     * @param obj The scrolled entry object
11378     * @return the right widget inside the scroller
11379     */
11380    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11381    /**
11382     * Unset the endmost widget of the scrolled entry, unparenting and
11383     * returning it.
11384     *
11385     * @param obj The scrolled entry object
11386     * @return the previously set icon sub-object of this entry, on
11387     * success.
11388     *
11389     * @see elm_entry_icon_set()
11390     */
11391    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11392    /**
11393     * Sets the visibility of the end widget of the scrolled entry, set by
11394     * elm_entry_end_set().
11395     *
11396     * @param obj The scrolled entry object
11397     * @param setting EINA_TRUE if the object should be displayed,
11398     * EINA_FALSE if not.
11399     */
11400    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11401    /**
11402     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11403     * them).
11404     *
11405     * Setting an entry to single-line mode with elm_entry_single_line_set()
11406     * will automatically disable the display of scrollbars when the entry
11407     * moves inside its scroller.
11408     *
11409     * @param obj The scrolled entry object
11410     * @param h The horizontal scrollbar policy to apply
11411     * @param v The vertical scrollbar policy to apply
11412     */
11413    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11414    /**
11415     * This enables/disables bouncing within the entry.
11416     *
11417     * This function sets whether the entry will bounce when scrolling reaches
11418     * the end of the contained entry.
11419     *
11420     * @param obj The scrolled entry object
11421     * @param h The horizontal bounce state
11422     * @param v The vertical bounce state
11423     */
11424    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11425    /**
11426     * Get the bounce mode
11427     *
11428     * @param obj The Entry object
11429     * @param h_bounce Allow bounce horizontally
11430     * @param v_bounce Allow bounce vertically
11431     */
11432    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11433
11434    /* pre-made filters for entries */
11435    /**
11436     * @typedef Elm_Entry_Filter_Limit_Size
11437     *
11438     * Data for the elm_entry_filter_limit_size() entry filter.
11439     */
11440    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11441    /**
11442     * @struct _Elm_Entry_Filter_Limit_Size
11443     *
11444     * Data for the elm_entry_filter_limit_size() entry filter.
11445     */
11446    struct _Elm_Entry_Filter_Limit_Size
11447      {
11448         int max_char_count; /**< The maximum number of characters allowed. */
11449         int max_byte_count; /**< The maximum number of bytes allowed*/
11450      };
11451    /**
11452     * Filter inserted text based on user defined character and byte limits
11453     *
11454     * Add this filter to an entry to limit the characters that it will accept
11455     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11456     * The funtion works on the UTF-8 representation of the string, converting
11457     * it from the set markup, thus not accounting for any format in it.
11458     *
11459     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11460     * it as data when setting the filter. In it, it's possible to set limits
11461     * by character count or bytes (any of them is disabled if 0), and both can
11462     * be set at the same time. In that case, it first checks for characters,
11463     * then bytes.
11464     *
11465     * The function will cut the inserted text in order to allow only the first
11466     * number of characters that are still allowed. The cut is made in
11467     * characters, even when limiting by bytes, in order to always contain
11468     * valid ones and avoid half unicode characters making it in.
11469     *
11470     * This filter, like any others, does not apply when setting the entry text
11471     * directly with elm_object_text_set() (or the deprecated
11472     * elm_entry_entry_set()).
11473     */
11474    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11475    /**
11476     * @typedef Elm_Entry_Filter_Accept_Set
11477     *
11478     * Data for the elm_entry_filter_accept_set() entry filter.
11479     */
11480    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11481    /**
11482     * @struct _Elm_Entry_Filter_Accept_Set
11483     *
11484     * Data for the elm_entry_filter_accept_set() entry filter.
11485     */
11486    struct _Elm_Entry_Filter_Accept_Set
11487      {
11488         const char *accepted; /**< Set of characters accepted in the entry. */
11489         const char *rejected; /**< Set of characters rejected from the entry. */
11490      };
11491    /**
11492     * Filter inserted text based on accepted or rejected sets of characters
11493     *
11494     * Add this filter to an entry to restrict the set of accepted characters
11495     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11496     * This structure contains both accepted and rejected sets, but they are
11497     * mutually exclusive.
11498     *
11499     * The @c accepted set takes preference, so if it is set, the filter will
11500     * only work based on the accepted characters, ignoring anything in the
11501     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11502     *
11503     * In both cases, the function filters by matching utf8 characters to the
11504     * raw markup text, so it can be used to remove formatting tags.
11505     *
11506     * This filter, like any others, does not apply when setting the entry text
11507     * directly with elm_object_text_set() (or the deprecated
11508     * elm_entry_entry_set()).
11509     */
11510    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11511    /**
11512     * Set the input panel layout of the entry
11513     *
11514     * @param obj The entry object
11515     * @param layout layout type
11516     */
11517    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11518    /**
11519     * Get the input panel layout of the entry
11520     *
11521     * @param obj The entry object
11522     * @return layout type
11523     *
11524     * @see elm_entry_input_panel_layout_set
11525     */
11526    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11527    /**
11528     * @}
11529     */
11530
11531    /* composite widgets - these basically put together basic widgets above
11532     * in convenient packages that do more than basic stuff */
11533
11534    /* anchorview */
11535    /**
11536     * @defgroup Anchorview Anchorview
11537     *
11538     * @image html img/widget/anchorview/preview-00.png
11539     * @image latex img/widget/anchorview/preview-00.eps
11540     *
11541     * Anchorview is for displaying text that contains markup with anchors
11542     * like <c>\<a href=1234\>something\</\></c> in it.
11543     *
11544     * Besides being styled differently, the anchorview widget provides the
11545     * necessary functionality so that clicking on these anchors brings up a
11546     * popup with user defined content such as "call", "add to contacts" or
11547     * "open web page". This popup is provided using the @ref Hover widget.
11548     *
11549     * This widget is very similar to @ref Anchorblock, so refer to that
11550     * widget for an example. The only difference Anchorview has is that the
11551     * widget is already provided with scrolling functionality, so if the
11552     * text set to it is too large to fit in the given space, it will scroll,
11553     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11554     * text can be displayed.
11555     *
11556     * This widget emits the following signals:
11557     * @li "anchor,clicked": will be called when an anchor is clicked. The
11558     * @p event_info parameter on the callback will be a pointer of type
11559     * ::Elm_Entry_Anchorview_Info.
11560     *
11561     * See @ref Anchorblock for an example on how to use both of them.
11562     *
11563     * @see Anchorblock
11564     * @see Entry
11565     * @see Hover
11566     *
11567     * @{
11568     */
11569    /**
11570     * @typedef Elm_Entry_Anchorview_Info
11571     *
11572     * The info sent in the callback for "anchor,clicked" signals emitted by
11573     * the Anchorview widget.
11574     */
11575    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11576    /**
11577     * @struct _Elm_Entry_Anchorview_Info
11578     *
11579     * The info sent in the callback for "anchor,clicked" signals emitted by
11580     * the Anchorview widget.
11581     */
11582    struct _Elm_Entry_Anchorview_Info
11583      {
11584         const char     *name; /**< Name of the anchor, as indicated in its href
11585                                    attribute */
11586         int             button; /**< The mouse button used to click on it */
11587         Evas_Object    *hover; /**< The hover object to use for the popup */
11588         struct {
11589              Evas_Coord    x, y, w, h;
11590         } anchor, /**< Geometry selection of text used as anchor */
11591           hover_parent; /**< Geometry of the object used as parent by the
11592                              hover */
11593         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11594                                              for content on the left side of
11595                                              the hover. Before calling the
11596                                              callback, the widget will make the
11597                                              necessary calculations to check
11598                                              which sides are fit to be set with
11599                                              content, based on the position the
11600                                              hover is activated and its distance
11601                                              to the edges of its parent object
11602                                              */
11603         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11604                                               the right side of the hover.
11605                                               See @ref hover_left */
11606         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11607                                             of the hover. See @ref hover_left */
11608         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11609                                                below the hover. See @ref
11610                                                hover_left */
11611      };
11612    /**
11613     * Add a new Anchorview object
11614     *
11615     * @param parent The parent object
11616     * @return The new object or NULL if it cannot be created
11617     */
11618    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11619    /**
11620     * Set the text to show in the anchorview
11621     *
11622     * Sets the text of the anchorview to @p text. This text can include markup
11623     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11624     * text that will be specially styled and react to click events, ended with
11625     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11626     * "anchor,clicked" signal that you can attach a callback to with
11627     * evas_object_smart_callback_add(). The name of the anchor given in the
11628     * event info struct will be the one set in the href attribute, in this
11629     * case, anchorname.
11630     *
11631     * Other markup can be used to style the text in different ways, but it's
11632     * up to the style defined in the theme which tags do what.
11633     * @deprecated use elm_object_text_set() instead.
11634     */
11635    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11636    /**
11637     * Get the markup text set for the anchorview
11638     *
11639     * Retrieves the text set on the anchorview, with markup tags included.
11640     *
11641     * @param obj The anchorview object
11642     * @return The markup text set or @c NULL if nothing was set or an error
11643     * occurred
11644     * @deprecated use elm_object_text_set() instead.
11645     */
11646    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11647    /**
11648     * Set the parent of the hover popup
11649     *
11650     * Sets the parent object to use by the hover created by the anchorview
11651     * when an anchor is clicked. See @ref Hover for more details on this.
11652     * If no parent is set, the same anchorview object will be used.
11653     *
11654     * @param obj The anchorview object
11655     * @param parent The object to use as parent for the hover
11656     */
11657    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11658    /**
11659     * Get the parent of the hover popup
11660     *
11661     * Get the object used as parent for the hover created by the anchorview
11662     * widget. See @ref Hover for more details on this.
11663     *
11664     * @param obj The anchorview object
11665     * @return The object used as parent for the hover, NULL if none is set.
11666     */
11667    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11668    /**
11669     * Set the style that the hover should use
11670     *
11671     * When creating the popup hover, anchorview will request that it's
11672     * themed according to @p style.
11673     *
11674     * @param obj The anchorview object
11675     * @param style The style to use for the underlying hover
11676     *
11677     * @see elm_object_style_set()
11678     */
11679    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11680    /**
11681     * Get the style that the hover should use
11682     *
11683     * Get the style the hover created by anchorview will use.
11684     *
11685     * @param obj The anchorview object
11686     * @return The style to use by the hover. NULL means the default is used.
11687     *
11688     * @see elm_object_style_set()
11689     */
11690    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11691    /**
11692     * Ends the hover popup in the anchorview
11693     *
11694     * When an anchor is clicked, the anchorview widget will create a hover
11695     * object to use as a popup with user provided content. This function
11696     * terminates this popup, returning the anchorview to its normal state.
11697     *
11698     * @param obj The anchorview object
11699     */
11700    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11701    /**
11702     * Set bouncing behaviour when the scrolled content reaches an edge
11703     *
11704     * Tell the internal scroller object whether it should bounce or not
11705     * when it reaches the respective edges for each axis.
11706     *
11707     * @param obj The anchorview object
11708     * @param h_bounce Whether to bounce or not in the horizontal axis
11709     * @param v_bounce Whether to bounce or not in the vertical axis
11710     *
11711     * @see elm_scroller_bounce_set()
11712     */
11713    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11714    /**
11715     * Get the set bouncing behaviour of the internal scroller
11716     *
11717     * Get whether the internal scroller should bounce when the edge of each
11718     * axis is reached scrolling.
11719     *
11720     * @param obj The anchorview object
11721     * @param h_bounce Pointer where to store the bounce state of the horizontal
11722     *                 axis
11723     * @param v_bounce Pointer where to store the bounce state of the vertical
11724     *                 axis
11725     *
11726     * @see elm_scroller_bounce_get()
11727     */
11728    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11729    /**
11730     * Appends a custom item provider to the given anchorview
11731     *
11732     * Appends the given function to the list of items providers. This list is
11733     * called, one function at a time, with the given @p data pointer, the
11734     * anchorview object and, in the @p item parameter, the item name as
11735     * referenced in its href string. Following functions in the list will be
11736     * called in order until one of them returns something different to NULL,
11737     * which should be an Evas_Object which will be used in place of the item
11738     * element.
11739     *
11740     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11741     * href=item/name\>\</item\>
11742     *
11743     * @param obj The anchorview object
11744     * @param func The function to add to the list of providers
11745     * @param data User data that will be passed to the callback function
11746     *
11747     * @see elm_entry_item_provider_append()
11748     */
11749    EAPI void         elm_anchorview_item_provider_append(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorview, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
11750    /**
11751     * Prepend a custom item provider to the given anchorview
11752     *
11753     * Like elm_anchorview_item_provider_append(), but it adds the function
11754     * @p func to the beginning of the list, instead of the end.
11755     *
11756     * @param obj The anchorview object
11757     * @param func The function to add to the list of providers
11758     * @param data User data that will be passed to the callback function
11759     */
11760    EAPI void         elm_anchorview_item_provider_prepend(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorview, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
11761    /**
11762     * Remove a custom item provider from the list of the given anchorview
11763     *
11764     * Removes the function and data pairing that matches @p func and @p data.
11765     * That is, unless the same function and same user data are given, the
11766     * function will not be removed from the list. This allows us to add the
11767     * same callback several times, with different @p data pointers and be
11768     * able to remove them later without conflicts.
11769     *
11770     * @param obj The anchorview object
11771     * @param func The function to remove from the list
11772     * @param data The data matching the function to remove from the list
11773     */
11774    EAPI void         elm_anchorview_item_provider_remove(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorview, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
11775    /**
11776     * @}
11777     */
11778
11779    /* anchorblock */
11780    /**
11781     * @defgroup Anchorblock Anchorblock
11782     *
11783     * @image html img/widget/anchorblock/preview-00.png
11784     * @image latex img/widget/anchorblock/preview-00.eps
11785     *
11786     * Anchorblock is for displaying text that contains markup with anchors
11787     * like <c>\<a href=1234\>something\</\></c> in it.
11788     *
11789     * Besides being styled differently, the anchorblock widget provides the
11790     * necessary functionality so that clicking on these anchors brings up a
11791     * popup with user defined content such as "call", "add to contacts" or
11792     * "open web page". This popup is provided using the @ref Hover widget.
11793     *
11794     * This widget emits the following signals:
11795     * @li "anchor,clicked": will be called when an anchor is clicked. The
11796     * @p event_info parameter on the callback will be a pointer of type
11797     * ::Elm_Entry_Anchorblock_Info.
11798     *
11799     * @see Anchorview
11800     * @see Entry
11801     * @see Hover
11802     *
11803     * Since examples are usually better than plain words, we might as well
11804     * try @ref tutorial_anchorblock_example "one".
11805     */
11806    /**
11807     * @addtogroup Anchorblock
11808     * @{
11809     */
11810    /**
11811     * @typedef Elm_Entry_Anchorblock_Info
11812     *
11813     * The info sent in the callback for "anchor,clicked" signals emitted by
11814     * the Anchorblock widget.
11815     */
11816    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11817    /**
11818     * @struct _Elm_Entry_Anchorblock_Info
11819     *
11820     * The info sent in the callback for "anchor,clicked" signals emitted by
11821     * the Anchorblock widget.
11822     */
11823    struct _Elm_Entry_Anchorblock_Info
11824      {
11825         const char     *name; /**< Name of the anchor, as indicated in its href
11826                                    attribute */
11827         int             button; /**< The mouse button used to click on it */
11828         Evas_Object    *hover; /**< The hover object to use for the popup */
11829         struct {
11830              Evas_Coord    x, y, w, h;
11831         } anchor, /**< Geometry selection of text used as anchor */
11832           hover_parent; /**< Geometry of the object used as parent by the
11833                              hover */
11834         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11835                                              for content on the left side of
11836                                              the hover. Before calling the
11837                                              callback, the widget will make the
11838                                              necessary calculations to check
11839                                              which sides are fit to be set with
11840                                              content, based on the position the
11841                                              hover is activated and its distance
11842                                              to the edges of its parent object
11843                                              */
11844         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11845                                               the right side of the hover.
11846                                               See @ref hover_left */
11847         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11848                                             of the hover. See @ref hover_left */
11849         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11850                                                below the hover. See @ref
11851                                                hover_left */
11852      };
11853    /**
11854     * Add a new Anchorblock object
11855     *
11856     * @param parent The parent object
11857     * @return The new object or NULL if it cannot be created
11858     */
11859    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11860    /**
11861     * Set the text to show in the anchorblock
11862     *
11863     * Sets the text of the anchorblock to @p text. This text can include markup
11864     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11865     * of text that will be specially styled and react to click events, ended
11866     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11867     * "anchor,clicked" signal that you can attach a callback to with
11868     * evas_object_smart_callback_add(). The name of the anchor given in the
11869     * event info struct will be the one set in the href attribute, in this
11870     * case, anchorname.
11871     *
11872     * Other markup can be used to style the text in different ways, but it's
11873     * up to the style defined in the theme which tags do what.
11874     * @deprecated use elm_object_text_set() instead.
11875     */
11876    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11877    /**
11878     * Get the markup text set for the anchorblock
11879     *
11880     * Retrieves the text set on the anchorblock, with markup tags included.
11881     *
11882     * @param obj The anchorblock object
11883     * @return The markup text set or @c NULL if nothing was set or an error
11884     * occurred
11885     * @deprecated use elm_object_text_set() instead.
11886     */
11887    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11888    /**
11889     * Set the parent of the hover popup
11890     *
11891     * Sets the parent object to use by the hover created by the anchorblock
11892     * when an anchor is clicked. See @ref Hover for more details on this.
11893     *
11894     * @param obj The anchorblock object
11895     * @param parent The object to use as parent for the hover
11896     */
11897    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11898    /**
11899     * Get the parent of the hover popup
11900     *
11901     * Get the object used as parent for the hover created by the anchorblock
11902     * widget. See @ref Hover for more details on this.
11903     * If no parent is set, the same anchorblock object will be used.
11904     *
11905     * @param obj The anchorblock object
11906     * @return The object used as parent for the hover, NULL if none is set.
11907     */
11908    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11909    /**
11910     * Set the style that the hover should use
11911     *
11912     * When creating the popup hover, anchorblock will request that it's
11913     * themed according to @p style.
11914     *
11915     * @param obj The anchorblock object
11916     * @param style The style to use for the underlying hover
11917     *
11918     * @see elm_object_style_set()
11919     */
11920    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11921    /**
11922     * Get the style that the hover should use
11923     *
11924     * Get the style the hover created by anchorblock will use.
11925     *
11926     * @param obj The anchorblock object
11927     * @return The style to use by the hover. NULL means the default is used.
11928     *
11929     * @see elm_object_style_set()
11930     */
11931    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11932    /**
11933     * Ends the hover popup in the anchorblock
11934     *
11935     * When an anchor is clicked, the anchorblock widget will create a hover
11936     * object to use as a popup with user provided content. This function
11937     * terminates this popup, returning the anchorblock to its normal state.
11938     *
11939     * @param obj The anchorblock object
11940     */
11941    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11942    /**
11943     * Appends a custom item provider to the given anchorblock
11944     *
11945     * Appends the given function to the list of items providers. This list is
11946     * called, one function at a time, with the given @p data pointer, the
11947     * anchorblock object and, in the @p item parameter, the item name as
11948     * referenced in its href string. Following functions in the list will be
11949     * called in order until one of them returns something different to NULL,
11950     * which should be an Evas_Object which will be used in place of the item
11951     * element.
11952     *
11953     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11954     * href=item/name\>\</item\>
11955     *
11956     * @param obj The anchorblock object
11957     * @param func The function to add to the list of providers
11958     * @param data User data that will be passed to the callback function
11959     *
11960     * @see elm_entry_item_provider_append()
11961     */
11962    EAPI void         elm_anchorblock_item_provider_append(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorblock, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
11963    /**
11964     * Prepend a custom item provider to the given anchorblock
11965     *
11966     * Like elm_anchorblock_item_provider_append(), but it adds the function
11967     * @p func to the beginning of the list, instead of the end.
11968     *
11969     * @param obj The anchorblock object
11970     * @param func The function to add to the list of providers
11971     * @param data User data that will be passed to the callback function
11972     */
11973    EAPI void         elm_anchorblock_item_provider_prepend(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorblock, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
11974    /**
11975     * Remove a custom item provider from the list of the given anchorblock
11976     *
11977     * Removes the function and data pairing that matches @p func and @p data.
11978     * That is, unless the same function and same user data are given, the
11979     * function will not be removed from the list. This allows us to add the
11980     * same callback several times, with different @p data pointers and be
11981     * able to remove them later without conflicts.
11982     *
11983     * @param obj The anchorblock object
11984     * @param func The function to remove from the list
11985     * @param data The data matching the function to remove from the list
11986     */
11987    EAPI void         elm_anchorblock_item_provider_remove(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *anchorblock, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
11988    /**
11989     * @}
11990     */
11991
11992    /**
11993     * @defgroup Bubble Bubble
11994     *
11995     * @image html img/widget/bubble/preview-00.png
11996     * @image latex img/widget/bubble/preview-00.eps
11997     * @image html img/widget/bubble/preview-01.png
11998     * @image latex img/widget/bubble/preview-01.eps
11999     * @image html img/widget/bubble/preview-02.png
12000     * @image latex img/widget/bubble/preview-02.eps
12001     *
12002     * @brief The Bubble is a widget to show text similarly to how speech is
12003     * represented in comics.
12004     *
12005     * The bubble widget contains 5 important visual elements:
12006     * @li The frame is a rectangle with rounded rectangles and an "arrow".
12007     * @li The @p icon is an image to which the frame's arrow points to.
12008     * @li The @p label is a text which appears to the right of the icon if the
12009     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12010     * otherwise.
12011     * @li The @p info is a text which appears to the right of the label. Info's
12012     * font is of a ligther color than label.
12013     * @li The @p content is an evas object that is shown inside the frame.
12014     *
12015     * The position of the arrow, icon, label and info depends on which corner is
12016     * selected. The four available corners are:
12017     * @li "top_left" - Default
12018     * @li "top_right"
12019     * @li "bottom_left"
12020     * @li "bottom_right"
12021     *
12022     * Signals that you can add callbacks for are:
12023     * @li "clicked" - This is called when a user has clicked the bubble.
12024     *
12025     * For an example of using a buble see @ref bubble_01_example_page "this".
12026     *
12027     * @{
12028     */
12029    /**
12030     * Add a new bubble to the parent
12031     *
12032     * @param parent The parent object
12033     * @return The new object or NULL if it cannot be created
12034     *
12035     * This function adds a text bubble to the given parent evas object.
12036     */
12037    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12038    /**
12039     * Set the label of the bubble
12040     *
12041     * @param obj The bubble object
12042     * @param label The string to set in the label
12043     *
12044     * This function sets the title of the bubble. Where this appears depends on
12045     * the selected corner.
12046     * @deprecated use elm_object_text_set() instead.
12047     */
12048    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12049    /**
12050     * Get the label of the bubble
12051     *
12052     * @param obj The bubble object
12053     * @return The string of set in the label
12054     *
12055     * This function gets the title of the bubble.
12056     * @deprecated use elm_object_text_get() instead.
12057     */
12058    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12059    /**
12060     * Set the info of the bubble
12061     *
12062     * @param obj The bubble object
12063     * @param info The given info about the bubble
12064     *
12065     * This function sets the info of the bubble. Where this appears depends on
12066     * the selected corner.
12067     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12068     */
12069    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12070    /**
12071     * Get the info of the bubble
12072     *
12073     * @param obj The bubble object
12074     *
12075     * @return The "info" string of the bubble
12076     *
12077     * This function gets the info text.
12078     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12079     */
12080    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12081    /**
12082     * Set the content to be shown in the bubble
12083     *
12084     * Once the content object is set, a previously set one will be deleted.
12085     * If you want to keep the old content object, use the
12086     * elm_bubble_content_unset() function.
12087     *
12088     * @param obj The bubble object
12089     * @param content The given content of the bubble
12090     *
12091     * This function sets the content shown on the middle of the bubble.
12092     */
12093    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12094    /**
12095     * Get the content shown in the bubble
12096     *
12097     * Return the content object which is set for this widget.
12098     *
12099     * @param obj The bubble object
12100     * @return The content that is being used
12101     */
12102    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12103    /**
12104     * Unset the content shown in the bubble
12105     *
12106     * Unparent and return the content object which was set for this widget.
12107     *
12108     * @param obj The bubble object
12109     * @return The content that was being used
12110     */
12111    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12112    /**
12113     * Set the icon of the bubble
12114     *
12115     * Once the icon object is set, a previously set one will be deleted.
12116     * If you want to keep the old content object, use the
12117     * elm_icon_content_unset() function.
12118     *
12119     * @param obj The bubble object
12120     * @param icon The given icon for the bubble
12121     */
12122    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12123    /**
12124     * Get the icon of the bubble
12125     *
12126     * @param obj The bubble object
12127     * @return The icon for the bubble
12128     *
12129     * This function gets the icon shown on the top left of bubble.
12130     */
12131    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12132    /**
12133     * Unset the icon of the bubble
12134     *
12135     * Unparent and return the icon object which was set for this widget.
12136     *
12137     * @param obj The bubble object
12138     * @return The icon that was being used
12139     */
12140    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12141    /**
12142     * Set the corner of the bubble
12143     *
12144     * @param obj The bubble object.
12145     * @param corner The given corner for the bubble.
12146     *
12147     * This function sets the corner of the bubble. The corner will be used to
12148     * determine where the arrow in the frame points to and where label, icon and
12149     * info arre shown.
12150     *
12151     * Possible values for corner are:
12152     * @li "top_left" - Default
12153     * @li "top_right"
12154     * @li "bottom_left"
12155     * @li "bottom_right"
12156     */
12157    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12158    /**
12159     * Get the corner of the bubble
12160     *
12161     * @param obj The bubble object.
12162     * @return The given corner for the bubble.
12163     *
12164     * This function gets the selected corner of the bubble.
12165     */
12166    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12167    /**
12168     * @}
12169     */
12170
12171    /**
12172     * @defgroup Photo Photo
12173     *
12174     * For displaying the photo of a person (contact). Simple yet
12175     * with a very specific purpose.
12176     *
12177     * Signals that you can add callbacks for are:
12178     *
12179     * "clicked" - This is called when a user has clicked the photo
12180     * "drag,start" - Someone started dragging the image out of the object
12181     * "drag,end" - Dragged item was dropped (somewhere)
12182     *
12183     * @{
12184     */
12185
12186    /**
12187     * Add a new photo to the parent
12188     *
12189     * @param parent The parent object
12190     * @return The new object or NULL if it cannot be created
12191     *
12192     * @ingroup Photo
12193     */
12194    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12195
12196    /**
12197     * Set the file that will be used as photo
12198     *
12199     * @param obj The photo object
12200     * @param file The path to file that will be used as photo
12201     *
12202     * @return (1 = success, 0 = error)
12203     *
12204     * @ingroup Photo
12205     */
12206    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12207
12208     /**
12209     * Set the file that will be used as thumbnail in the photo.
12210     *
12211     * @param obj The photo object.
12212     * @param file The path to file that will be used as thumb.
12213     * @param group The key used in case of an EET file.
12214     *
12215     * @ingroup Photo
12216     */
12217    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12218
12219    /**
12220     * Set the size that will be used on the photo
12221     *
12222     * @param obj The photo object
12223     * @param size The size that the photo will be
12224     *
12225     * @ingroup Photo
12226     */
12227    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12228
12229    /**
12230     * Set if the photo should be completely visible or not.
12231     *
12232     * @param obj The photo object
12233     * @param fill if true the photo will be completely visible
12234     *
12235     * @ingroup Photo
12236     */
12237    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12238
12239    /**
12240     * Set editability of the photo.
12241     *
12242     * An editable photo can be dragged to or from, and can be cut or
12243     * pasted too.  Note that pasting an image or dropping an item on
12244     * the image will delete the existing content.
12245     *
12246     * @param obj The photo object.
12247     * @param set To set of clear editablity.
12248     */
12249    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12250
12251    /**
12252     * @}
12253     */
12254
12255    /* gesture layer */
12256    /**
12257     * @defgroup Elm_Gesture_Layer Gesture Layer
12258     * Gesture Layer Usage:
12259     *
12260     * Use Gesture Layer to detect gestures.
12261     * The advantage is that you don't have to implement
12262     * gesture detection, just set callbacks of gesture state.
12263     * By using gesture layer we make standard interface.
12264     *
12265     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12266     * with a parent object parameter.
12267     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12268     * call. Usually with same object as target (2nd parameter).
12269     *
12270     * Now you need to tell gesture layer what gestures you follow.
12271     * This is done with @ref elm_gesture_layer_cb_set call.
12272     * By setting the callback you actually saying to gesture layer:
12273     * I would like to know when the gesture @ref Elm_Gesture_Types
12274     * switches to state @ref Elm_Gesture_State.
12275     *
12276     * Next, you need to implement the actual action that follows the input
12277     * in your callback.
12278     *
12279     * Note that if you like to stop being reported about a gesture, just set
12280     * all callbacks referring this gesture to NULL.
12281     * (again with @ref elm_gesture_layer_cb_set)
12282     *
12283     * The information reported by gesture layer to your callback is depending
12284     * on @ref Elm_Gesture_Types:
12285     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12286     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12287     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12288     *
12289     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12290     * @ref ELM_GESTURE_MOMENTUM.
12291     *
12292     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12293     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12294     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12295     * Note that we consider a flick as a line-gesture that should be completed
12296     * in flick-time-limit as defined in @ref Config.
12297     *
12298     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12299     *
12300     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12301     *
12302     *
12303     * Gesture Layer Tweaks:
12304     *
12305     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12306     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12307     *
12308     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12309     * so gesture starts when user touches (a *DOWN event) touch-surface
12310     * and ends when no fingers touches surface (a *UP event).
12311     */
12312
12313    /**
12314     * @enum _Elm_Gesture_Types
12315     * Enum of supported gesture types.
12316     * @ingroup Elm_Gesture_Layer
12317     */
12318    enum _Elm_Gesture_Types
12319      {
12320         ELM_GESTURE_FIRST = 0,
12321
12322         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12323         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12324         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12325         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12326
12327         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12328
12329         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12330         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12331
12332         ELM_GESTURE_ZOOM, /**< Zoom */
12333         ELM_GESTURE_ROTATE, /**< Rotate */
12334
12335         ELM_GESTURE_LAST
12336      };
12337
12338    /**
12339     * @typedef Elm_Gesture_Types
12340     * gesture types enum
12341     * @ingroup Elm_Gesture_Layer
12342     */
12343    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12344
12345    /**
12346     * @enum _Elm_Gesture_State
12347     * Enum of gesture states.
12348     * @ingroup Elm_Gesture_Layer
12349     */
12350    enum _Elm_Gesture_State
12351      {
12352         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12353         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12354         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12355         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12356         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12357      };
12358
12359    /**
12360     * @typedef Elm_Gesture_State
12361     * gesture states enum
12362     * @ingroup Elm_Gesture_Layer
12363     */
12364    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12365
12366    /**
12367     * @struct _Elm_Gesture_Taps_Info
12368     * Struct holds taps info for user
12369     * @ingroup Elm_Gesture_Layer
12370     */
12371    struct _Elm_Gesture_Taps_Info
12372      {
12373         Evas_Coord x, y;         /**< Holds center point between fingers */
12374         unsigned int n;          /**< Number of fingers tapped           */
12375         unsigned int timestamp;  /**< event timestamp       */
12376      };
12377
12378    /**
12379     * @typedef Elm_Gesture_Taps_Info
12380     * holds taps info for user
12381     * @ingroup Elm_Gesture_Layer
12382     */
12383    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12384
12385    /**
12386     * @struct _Elm_Gesture_Momentum_Info
12387     * Struct holds momentum info for user
12388     * x1 and y1 are not necessarily in sync
12389     * x1 holds x value of x direction starting point
12390     * and same holds for y1.
12391     * This is noticeable when doing V-shape movement
12392     * @ingroup Elm_Gesture_Layer
12393     */
12394    struct _Elm_Gesture_Momentum_Info
12395      {  /* Report line ends, timestamps, and momentum computed        */
12396         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12397         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12398         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12399         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12400
12401         unsigned int tx; /**< Timestamp of start of final x-swipe */
12402         unsigned int ty; /**< Timestamp of start of final y-swipe */
12403
12404         Evas_Coord mx; /**< Momentum on X */
12405         Evas_Coord my; /**< Momentum on Y */
12406      };
12407
12408    /**
12409     * @typedef Elm_Gesture_Momentum_Info
12410     * holds momentum info for user
12411     * @ingroup Elm_Gesture_Layer
12412     */
12413     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12414
12415    /**
12416     * @struct _Elm_Gesture_Line_Info
12417     * Struct holds line info for user
12418     * @ingroup Elm_Gesture_Layer
12419     */
12420    struct _Elm_Gesture_Line_Info
12421      {  /* Report line ends, timestamps, and momentum computed      */
12422         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12423         unsigned int n;            /**< Number of fingers (lines)   */
12424         /* FIXME should be radians, bot degrees */
12425         double angle;              /**< Angle (direction) of lines  */
12426      };
12427
12428    /**
12429     * @typedef Elm_Gesture_Line_Info
12430     * Holds line info for user
12431     * @ingroup Elm_Gesture_Layer
12432     */
12433     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12434
12435    /**
12436     * @struct _Elm_Gesture_Zoom_Info
12437     * Struct holds zoom info for user
12438     * @ingroup Elm_Gesture_Layer
12439     */
12440    struct _Elm_Gesture_Zoom_Info
12441      {
12442         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12443         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12444         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12445         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12446      };
12447
12448    /**
12449     * @typedef Elm_Gesture_Zoom_Info
12450     * Holds zoom info for user
12451     * @ingroup Elm_Gesture_Layer
12452     */
12453    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12454
12455    /**
12456     * @struct _Elm_Gesture_Rotate_Info
12457     * Struct holds rotation info for user
12458     * @ingroup Elm_Gesture_Layer
12459     */
12460    struct _Elm_Gesture_Rotate_Info
12461      {
12462         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12463         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12464         double base_angle; /**< Holds start-angle */
12465         double angle;      /**< Rotation value: 0.0 means no rotation         */
12466         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12467      };
12468
12469    /**
12470     * @typedef Elm_Gesture_Rotate_Info
12471     * Holds rotation info for user
12472     * @ingroup Elm_Gesture_Layer
12473     */
12474    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12475
12476    /**
12477     * @typedef Elm_Gesture_Event_Cb
12478     * User callback used to stream gesture info from gesture layer
12479     * @param data user data
12480     * @param event_info gesture report info
12481     * Returns a flag field to be applied on the causing event.
12482     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12483     * upon the event, in an irreversible way.
12484     *
12485     * @ingroup Elm_Gesture_Layer
12486     */
12487    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12488
12489    /**
12490     * Use function to set callbacks to be notified about
12491     * change of state of gesture.
12492     * When a user registers a callback with this function
12493     * this means this gesture has to be tested.
12494     *
12495     * When ALL callbacks for a gesture are set to NULL
12496     * it means user isn't interested in gesture-state
12497     * and it will not be tested.
12498     *
12499     * @param obj Pointer to gesture-layer.
12500     * @param idx The gesture you would like to track its state.
12501     * @param cb callback function pointer.
12502     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12503     * @param data user info to be sent to callback (usually, Smart Data)
12504     *
12505     * @ingroup Elm_Gesture_Layer
12506     */
12507    EAPI void elm_gesture_layer_cb_set(Evas_Object *obj, Elm_Gesture_Types idx, Elm_Gesture_State cb_type, Elm_Gesture_Event_Cb cb, void *data) EINA_ARG_NONNULL(1);
12508
12509    /**
12510     * Call this function to get repeat-events settings.
12511     *
12512     * @param obj Pointer to gesture-layer.
12513     *
12514     * @return repeat events settings.
12515     * @see elm_gesture_layer_hold_events_set()
12516     * @ingroup Elm_Gesture_Layer
12517     */
12518    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12519
12520    /**
12521     * This function called in order to make gesture-layer repeat events.
12522     * Set this of you like to get the raw events only if gestures were not detected.
12523     * Clear this if you like gesture layer to fwd events as testing gestures.
12524     *
12525     * @param obj Pointer to gesture-layer.
12526     * @param r Repeat: TRUE/FALSE
12527     *
12528     * @ingroup Elm_Gesture_Layer
12529     */
12530    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12531
12532    /**
12533     * This function sets step-value for zoom action.
12534     * Set step to any positive value.
12535     * Cancel step setting by setting to 0.0
12536     *
12537     * @param obj Pointer to gesture-layer.
12538     * @param s new zoom step value.
12539     *
12540     * @ingroup Elm_Gesture_Layer
12541     */
12542    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12543
12544    /**
12545     * This function sets step-value for rotate action.
12546     * Set step to any positive value.
12547     * Cancel step setting by setting to 0.0
12548     *
12549     * @param obj Pointer to gesture-layer.
12550     * @param s new roatate step value.
12551     *
12552     * @ingroup Elm_Gesture_Layer
12553     */
12554    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12555
12556    /**
12557     * This function called to attach gesture-layer to an Evas_Object.
12558     * @param obj Pointer to gesture-layer.
12559     * @param t Pointer to underlying object (AKA Target)
12560     *
12561     * @return TRUE, FALSE on success, failure.
12562     *
12563     * @ingroup Elm_Gesture_Layer
12564     */
12565    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12566
12567    /**
12568     * Call this function to construct a new gesture-layer object.
12569     * This does not activate the gesture layer. You have to
12570     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12571     *
12572     * @param parent the parent object.
12573     *
12574     * @return Pointer to new gesture-layer object.
12575     *
12576     * @ingroup Elm_Gesture_Layer
12577     */
12578    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12579
12580    /**
12581     * @defgroup Thumb Thumb
12582     *
12583     * @image html img/widget/thumb/preview-00.png
12584     * @image latex img/widget/thumb/preview-00.eps
12585     *
12586     * A thumb object is used for displaying the thumbnail of an image or video.
12587     * You must have compiled Elementary with Ethumb_Client support and the DBus
12588     * service must be present and auto-activated in order to have thumbnails to
12589     * be generated.
12590     *
12591     * Once the thumbnail object becomes visible, it will check if there is a
12592     * previously generated thumbnail image for the file set on it. If not, it
12593     * will start generating this thumbnail.
12594     *
12595     * Different config settings will cause different thumbnails to be generated
12596     * even on the same file.
12597     *
12598     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12599     * Ethumb documentation to change this path, and to see other configuration
12600     * options.
12601     *
12602     * Signals that you can add callbacks for are:
12603     *
12604     * - "clicked" - This is called when a user has clicked the thumb without dragging
12605     *             around.
12606     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12607     * - "press" - This is called when a user has pressed down the thumb.
12608     * - "generate,start" - The thumbnail generation started.
12609     * - "generate,stop" - The generation process stopped.
12610     * - "generate,error" - The generation failed.
12611     * - "load,error" - The thumbnail image loading failed.
12612     *
12613     * available styles:
12614     * - default
12615     * - noframe
12616     *
12617     * An example of use of thumbnail:
12618     *
12619     * - @ref thumb_example_01
12620     */
12621
12622    /**
12623     * @addtogroup Thumb
12624     * @{
12625     */
12626
12627    /**
12628     * @enum _Elm_Thumb_Animation_Setting
12629     * @typedef Elm_Thumb_Animation_Setting
12630     *
12631     * Used to set if a video thumbnail is animating or not.
12632     *
12633     * @ingroup Thumb
12634     */
12635    typedef enum _Elm_Thumb_Animation_Setting
12636      {
12637         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12638         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12639         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12640         ELM_THUMB_ANIMATION_LAST
12641      } Elm_Thumb_Animation_Setting;
12642
12643    /**
12644     * Add a new thumb object to the parent.
12645     *
12646     * @param parent The parent object.
12647     * @return The new object or NULL if it cannot be created.
12648     *
12649     * @see elm_thumb_file_set()
12650     * @see elm_thumb_ethumb_client_get()
12651     *
12652     * @ingroup Thumb
12653     */
12654    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12655    /**
12656     * Reload thumbnail if it was generated before.
12657     *
12658     * @param obj The thumb object to reload
12659     *
12660     * This is useful if the ethumb client configuration changed, like its
12661     * size, aspect or any other property one set in the handle returned
12662     * by elm_thumb_ethumb_client_get().
12663     *
12664     * If the options didn't change, the thumbnail won't be generated again, but
12665     * the old one will still be used.
12666     *
12667     * @see elm_thumb_file_set()
12668     *
12669     * @ingroup Thumb
12670     */
12671    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12672    /**
12673     * Set the file that will be used as thumbnail.
12674     *
12675     * @param obj The thumb object.
12676     * @param file The path to file that will be used as thumb.
12677     * @param key The key used in case of an EET file.
12678     *
12679     * The file can be an image or a video (in that case, acceptable extensions are:
12680     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12681     * function elm_thumb_animate().
12682     *
12683     * @see elm_thumb_file_get()
12684     * @see elm_thumb_reload()
12685     * @see elm_thumb_animate()
12686     *
12687     * @ingroup Thumb
12688     */
12689    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12690    /**
12691     * Get the image or video path and key used to generate the thumbnail.
12692     *
12693     * @param obj The thumb object.
12694     * @param file Pointer to filename.
12695     * @param key Pointer to key.
12696     *
12697     * @see elm_thumb_file_set()
12698     * @see elm_thumb_path_get()
12699     *
12700     * @ingroup Thumb
12701     */
12702    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12703    /**
12704     * Get the path and key to the image or video generated by ethumb.
12705     *
12706     * One just need to make sure that the thumbnail was generated before getting
12707     * its path; otherwise, the path will be NULL. One way to do that is by asking
12708     * for the path when/after the "generate,stop" smart callback is called.
12709     *
12710     * @param obj The thumb object.
12711     * @param file Pointer to thumb path.
12712     * @param key Pointer to thumb key.
12713     *
12714     * @see elm_thumb_file_get()
12715     *
12716     * @ingroup Thumb
12717     */
12718    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12719    /**
12720     * Set the animation state for the thumb object. If its content is an animated
12721     * video, you may start/stop the animation or tell it to play continuously and
12722     * looping.
12723     *
12724     * @param obj The thumb object.
12725     * @param setting The animation setting.
12726     *
12727     * @see elm_thumb_file_set()
12728     *
12729     * @ingroup Thumb
12730     */
12731    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12732    /**
12733     * Get the animation state for the thumb object.
12734     *
12735     * @param obj The thumb object.
12736     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12737     * on errors.
12738     *
12739     * @see elm_thumb_animate_set()
12740     *
12741     * @ingroup Thumb
12742     */
12743    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12744    /**
12745     * Get the ethumb_client handle so custom configuration can be made.
12746     *
12747     * @return Ethumb_Client instance or NULL.
12748     *
12749     * This must be called before the objects are created to be sure no object is
12750     * visible and no generation started.
12751     *
12752     * Example of usage:
12753     *
12754     * @code
12755     * #include <Elementary.h>
12756     * #ifndef ELM_LIB_QUICKLAUNCH
12757     * EAPI_MAIN int
12758     * elm_main(int argc, char **argv)
12759     * {
12760     *    Ethumb_Client *client;
12761     *
12762     *    elm_need_ethumb();
12763     *
12764     *    // ... your code
12765     *
12766     *    client = elm_thumb_ethumb_client_get();
12767     *    if (!client)
12768     *      {
12769     *         ERR("could not get ethumb_client");
12770     *         return 1;
12771     *      }
12772     *    ethumb_client_size_set(client, 100, 100);
12773     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12774     *    // ... your code
12775     *
12776     *    // Create elm_thumb objects here
12777     *
12778     *    elm_run();
12779     *    elm_shutdown();
12780     *    return 0;
12781     * }
12782     * #endif
12783     * ELM_MAIN()
12784     * @endcode
12785     *
12786     * @note There's only one client handle for Ethumb, so once a configuration
12787     * change is done to it, any other request for thumbnails (for any thumbnail
12788     * object) will use that configuration. Thus, this configuration is global.
12789     *
12790     * @ingroup Thumb
12791     */
12792    EAPI void                        *elm_thumb_ethumb_client_get(void);
12793    /**
12794     * Get the ethumb_client connection state.
12795     *
12796     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12797     * otherwise.
12798     */
12799    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12800    /**
12801     * Make the thumbnail 'editable'.
12802     *
12803     * @param obj Thumb object.
12804     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12805     *
12806     * This means the thumbnail is a valid drag target for drag and drop, and can be
12807     * cut or pasted too.
12808     *
12809     * @see elm_thumb_editable_get()
12810     *
12811     * @ingroup Thumb
12812     */
12813    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12814    /**
12815     * Make the thumbnail 'editable'.
12816     *
12817     * @param obj Thumb object.
12818     * @return Editability.
12819     *
12820     * This means the thumbnail is a valid drag target for drag and drop, and can be
12821     * cut or pasted too.
12822     *
12823     * @see elm_thumb_editable_set()
12824     *
12825     * @ingroup Thumb
12826     */
12827    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12828
12829    /**
12830     * @}
12831     */
12832
12833    /**
12834     * @defgroup Hoversel Hoversel
12835     *
12836     * @image html img/widget/hoversel/preview-00.png
12837     * @image latex img/widget/hoversel/preview-00.eps
12838     *
12839     * A hoversel is a button that pops up a list of items (automatically
12840     * choosing the direction to display) that have a label and, optionally, an
12841     * icon to select from. It is a convenience widget to avoid the need to do
12842     * all the piecing together yourself. It is intended for a small number of
12843     * items in the hoversel menu (no more than 8), though is capable of many
12844     * more.
12845     *
12846     * Signals that you can add callbacks for are:
12847     * "clicked" - the user clicked the hoversel button and popped up the sel
12848     * "selected" - an item in the hoversel list is selected. event_info is the item
12849     * "dismissed" - the hover is dismissed
12850     *
12851     * See @ref tutorial_hoversel for an example.
12852     * @{
12853     */
12854    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12855    /**
12856     * @brief Add a new Hoversel object
12857     *
12858     * @param parent The parent object
12859     * @return The new object or NULL if it cannot be created
12860     */
12861    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12862    /**
12863     * @brief This sets the hoversel to expand horizontally.
12864     *
12865     * @param obj The hoversel object
12866     * @param horizontal If true, the hover will expand horizontally to the
12867     * right.
12868     *
12869     * @note The initial button will display horizontally regardless of this
12870     * setting.
12871     */
12872    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12873    /**
12874     * @brief This returns whether the hoversel is set to expand horizontally.
12875     *
12876     * @param obj The hoversel object
12877     * @return If true, the hover will expand horizontally to the right.
12878     *
12879     * @see elm_hoversel_horizontal_set()
12880     */
12881    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12882    /**
12883     * @brief Set the Hover parent
12884     *
12885     * @param obj The hoversel object
12886     * @param parent The parent to use
12887     *
12888     * Sets the hover parent object, the area that will be darkened when the
12889     * hoversel is clicked. Should probably be the window that the hoversel is
12890     * in. See @ref Hover objects for more information.
12891     */
12892    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12893    /**
12894     * @brief Get the Hover parent
12895     *
12896     * @param obj The hoversel object
12897     * @return The used parent
12898     *
12899     * Gets the hover parent object.
12900     *
12901     * @see elm_hoversel_hover_parent_set()
12902     */
12903    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12904    /**
12905     * @brief Set the hoversel button label
12906     *
12907     * @param obj The hoversel object
12908     * @param label The label text.
12909     *
12910     * This sets the label of the button that is always visible (before it is
12911     * clicked and expanded).
12912     *
12913     * @deprecated elm_object_text_set()
12914     */
12915    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12916    /**
12917     * @brief Get the hoversel button label
12918     *
12919     * @param obj The hoversel object
12920     * @return The label text.
12921     *
12922     * @deprecated elm_object_text_get()
12923     */
12924    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12925    /**
12926     * @brief Set the icon of the hoversel button
12927     *
12928     * @param obj The hoversel object
12929     * @param icon The icon object
12930     *
12931     * Sets the icon of the button that is always visible (before it is clicked
12932     * and expanded).  Once the icon object is set, a previously set one will be
12933     * deleted, if you want to keep that old content object, use the
12934     * elm_hoversel_icon_unset() function.
12935     *
12936     * @see elm_button_icon_set()
12937     */
12938    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12939    /**
12940     * @brief Get the icon of the hoversel button
12941     *
12942     * @param obj The hoversel object
12943     * @return The icon object
12944     *
12945     * Get the icon of the button that is always visible (before it is clicked
12946     * and expanded). Also see elm_button_icon_get().
12947     *
12948     * @see elm_hoversel_icon_set()
12949     */
12950    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12951    /**
12952     * @brief Get and unparent the icon of the hoversel button
12953     *
12954     * @param obj The hoversel object
12955     * @return The icon object that was being used
12956     *
12957     * Unparent and return the icon of the button that is always visible
12958     * (before it is clicked and expanded).
12959     *
12960     * @see elm_hoversel_icon_set()
12961     * @see elm_button_icon_unset()
12962     */
12963    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12964    /**
12965     * @brief This triggers the hoversel popup from code, the same as if the user
12966     * had clicked the button.
12967     *
12968     * @param obj The hoversel object
12969     */
12970    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12971    /**
12972     * @brief This dismisses the hoversel popup as if the user had clicked
12973     * outside the hover.
12974     *
12975     * @param obj The hoversel object
12976     */
12977    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12978    /**
12979     * @brief Returns whether the hoversel is expanded.
12980     *
12981     * @param obj The hoversel object
12982     * @return  This will return EINA_TRUE if the hoversel is expanded or
12983     * EINA_FALSE if it is not expanded.
12984     */
12985    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12986    /**
12987     * @brief This will remove all the children items from the hoversel.
12988     *
12989     * @param obj The hoversel object
12990     *
12991     * @warning Should @b not be called while the hoversel is active; use
12992     * elm_hoversel_expanded_get() to check first.
12993     *
12994     * @see elm_hoversel_item_del_cb_set()
12995     * @see elm_hoversel_item_del()
12996     */
12997    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12998    /**
12999     * @brief Get the list of items within the given hoversel.
13000     *
13001     * @param obj The hoversel object
13002     * @return Returns a list of Elm_Hoversel_Item*
13003     *
13004     * @see elm_hoversel_item_add()
13005     */
13006    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13007    /**
13008     * @brief Add an item to the hoversel button
13009     *
13010     * @param obj The hoversel object
13011     * @param label The text label to use for the item (NULL if not desired)
13012     * @param icon_file An image file path on disk to use for the icon or standard
13013     * icon name (NULL if not desired)
13014     * @param icon_type The icon type if relevant
13015     * @param func Convenience function to call when this item is selected
13016     * @param data Data to pass to item-related functions
13017     * @return A handle to the item added.
13018     *
13019     * This adds an item to the hoversel to show when it is clicked. Note: if you
13020     * need to use an icon from an edje file then use
13021     * elm_hoversel_item_icon_set() right after the this function, and set
13022     * icon_file to NULL here.
13023     *
13024     * For more information on what @p icon_file and @p icon_type are see the
13025     * @ref Icon "icon documentation".
13026     */
13027    EAPI Elm_Hoversel_Item *elm_hoversel_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13028    /**
13029     * @brief Delete an item from the hoversel
13030     *
13031     * @param item The item to delete
13032     *
13033     * This deletes the item from the hoversel (should not be called while the
13034     * hoversel is active; use elm_hoversel_expanded_get() to check first).
13035     *
13036     * @see elm_hoversel_item_add()
13037     * @see elm_hoversel_item_del_cb_set()
13038     */
13039    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
13040    /**
13041     * @brief Set the function to be called when an item from the hoversel is
13042     * freed.
13043     *
13044     * @param item The item to set the callback on
13045     * @param func The function called
13046     *
13047     * That function will receive these parameters:
13048     * @li void *item_data
13049     * @li Evas_Object *the_item_object
13050     * @li Elm_Hoversel_Item *the_object_struct
13051     *
13052     * @see elm_hoversel_item_add()
13053     */
13054    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13055    /**
13056     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
13057     * that will be passed to associated function callbacks.
13058     *
13059     * @param item The item to get the data from
13060     * @return The data pointer set with elm_hoversel_item_add()
13061     *
13062     * @see elm_hoversel_item_add()
13063     */
13064    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13065    /**
13066     * @brief This returns the label text of the given hoversel item.
13067     *
13068     * @param item The item to get the label
13069     * @return The label text of the hoversel item
13070     *
13071     * @see elm_hoversel_item_add()
13072     */
13073    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
13074    /**
13075     * @brief This sets the icon for the given hoversel item.
13076     *
13077     * @param item The item to set the icon
13078     * @param icon_file An image file path on disk to use for the icon or standard
13079     * icon name
13080     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
13081     * to NULL if the icon is not an edje file
13082     * @param icon_type The icon type
13083     *
13084     * The icon can be loaded from the standard set, from an image file, or from
13085     * an edje file.
13086     *
13087     * @see elm_hoversel_item_add()
13088     */
13089    EAPI void               elm_hoversel_item_icon_set(Elm_Hoversel_Item *it, const char *icon_file, const char *icon_group, Elm_Icon_Type icon_type) EINA_ARG_NONNULL(1);
13090    /**
13091     * @brief Get the icon object of the hoversel item
13092     *
13093     * @param item The item to get the icon from
13094     * @param icon_file The image file path on disk used for the icon or standard
13095     * icon name
13096     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
13097     * if the icon is not an edje file
13098     * @param icon_type The icon type
13099     *
13100     * @see elm_hoversel_item_icon_set()
13101     * @see elm_hoversel_item_add()
13102     */
13103    EAPI void               elm_hoversel_item_icon_get(const Elm_Hoversel_Item *it, const char **icon_file, const char **icon_group, Elm_Icon_Type *icon_type) EINA_ARG_NONNULL(1);
13104    /**
13105     * @}
13106     */
13107
13108    /**
13109     * @defgroup Toolbar Toolbar
13110     * @ingroup Elementary
13111     *
13112     * @image html img/widget/toolbar/preview-00.png
13113     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
13114     *
13115     * @image html img/toolbar.png
13116     * @image latex img/toolbar.eps width=\textwidth
13117     *
13118     * A toolbar is a widget that displays a list of items inside
13119     * a box. It can be scrollable, show a menu with items that don't fit
13120     * to toolbar size or even crop them.
13121     *
13122     * Only one item can be selected at a time.
13123     *
13124     * Items can have multiple states, or show menus when selected by the user.
13125     *
13126     * Smart callbacks one can listen to:
13127     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
13128     *
13129     * Available styles for it:
13130     * - @c "default"
13131     * - @c "transparent" - no background or shadow, just show the content
13132     *
13133     * List of examples:
13134     * @li @ref toolbar_example_01
13135     * @li @ref toolbar_example_02
13136     * @li @ref toolbar_example_03
13137     */
13138
13139    /**
13140     * @addtogroup Toolbar
13141     * @{
13142     */
13143
13144    /**
13145     * @enum _Elm_Toolbar_Shrink_Mode
13146     * @typedef Elm_Toolbar_Shrink_Mode
13147     *
13148     * Set toolbar's items display behavior, it can be scrollabel,
13149     * show a menu with exceeding items, or simply hide them.
13150     *
13151     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
13152     * from elm config.
13153     *
13154     * Values <b> don't </b> work as bitmask, only one can be choosen.
13155     *
13156     * @see elm_toolbar_mode_shrink_set()
13157     * @see elm_toolbar_mode_shrink_get()
13158     *
13159     * @ingroup Toolbar
13160     */
13161    typedef enum _Elm_Toolbar_Shrink_Mode
13162      {
13163         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
13164         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
13165         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
13166         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
13167      } Elm_Toolbar_Shrink_Mode;
13168
13169    typedef struct _Elm_Toolbar_Item Elm_Toolbar_Item; /**< Item of Elm_Toolbar. Sub-type of Elm_Widget_Item. Can be created with elm_toolbar_item_append(), elm_toolbar_item_prepend() and functions to add items in relative positions, like elm_toolbar_item_insert_before(), and deleted with elm_toolbar_item_del(). */
13170
13171    typedef struct _Elm_Toolbar_Item_State Elm_Toolbar_Item_State; /**< State of a Elm_Toolbar_Item. Can be created with elm_toolbar_item_state_add() and removed with elm_toolbar_item_state_del(). */
13172
13173    /**
13174     * Add a new toolbar widget to the given parent Elementary
13175     * (container) object.
13176     *
13177     * @param parent The parent object.
13178     * @return a new toolbar widget handle or @c NULL, on errors.
13179     *
13180     * This function inserts a new toolbar widget on the canvas.
13181     *
13182     * @ingroup Toolbar
13183     */
13184    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13185
13186    /**
13187     * Set the icon size, in pixels, to be used by toolbar items.
13188     *
13189     * @param obj The toolbar object
13190     * @param icon_size The icon size in pixels
13191     *
13192     * @note Default value is @c 32. It reads value from elm config.
13193     *
13194     * @see elm_toolbar_icon_size_get()
13195     *
13196     * @ingroup Toolbar
13197     */
13198    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
13199
13200    /**
13201     * Get the icon size, in pixels, to be used by toolbar items.
13202     *
13203     * @param obj The toolbar object.
13204     * @return The icon size in pixels.
13205     *
13206     * @see elm_toolbar_icon_size_set() for details.
13207     *
13208     * @ingroup Toolbar
13209     */
13210    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13211
13212    /**
13213     * Sets icon lookup order, for toolbar items' icons.
13214     *
13215     * @param obj The toolbar object.
13216     * @param order The icon lookup order.
13217     *
13218     * Icons added before calling this function will not be affected.
13219     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
13220     *
13221     * @see elm_toolbar_icon_order_lookup_get()
13222     *
13223     * @ingroup Toolbar
13224     */
13225    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
13226
13227    /**
13228     * Gets the icon lookup order.
13229     *
13230     * @param obj The toolbar object.
13231     * @return The icon lookup order.
13232     *
13233     * @see elm_toolbar_icon_order_lookup_set() for details.
13234     *
13235     * @ingroup Toolbar
13236     */
13237    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13238
13239    /**
13240     * Set whether the toolbar items' should be selected by the user or not.
13241     *
13242     * @param obj The toolbar object.
13243     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13244     * enable it.
13245     *
13246     * This will turn off the ability to select items entirely and they will
13247     * neither appear selected nor emit selected signals. The clicked
13248     * callback function will still be called.
13249     *
13250     * Selection is enabled by default.
13251     *
13252     * @see elm_toolbar_no_select_mode_get().
13253     *
13254     * @ingroup Toolbar
13255     */
13256    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13257
13258    /**
13259     * Set whether the toolbar items' should be selected by the user or not.
13260     *
13261     * @param obj The toolbar object.
13262     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13263     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13264     *
13265     * @see elm_toolbar_no_select_mode_set() for details.
13266     *
13267     * @ingroup Toolbar
13268     */
13269    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13270
13271    /**
13272     * Append item to the toolbar.
13273     *
13274     * @param obj The toolbar object.
13275     * @param icon A string with icon name or the absolute path of an image file.
13276     * @param label The label of the item.
13277     * @param func The function to call when the item is clicked.
13278     * @param data The data to associate with the item for related callbacks.
13279     * @return The created item or @c NULL upon failure.
13280     *
13281     * A new item will be created and appended to the toolbar, i.e., will
13282     * be set as @b last item.
13283     *
13284     * Items created with this method can be deleted with
13285     * elm_toolbar_item_del().
13286     *
13287     * Associated @p data can be properly freed when item is deleted if a
13288     * callback function is set with elm_toolbar_item_del_cb_set().
13289     *
13290     * If a function is passed as argument, it will be called everytime this item
13291     * is selected, i.e., the user clicks over an unselected item.
13292     * If such function isn't needed, just passing
13293     * @c NULL as @p func is enough. The same should be done for @p data.
13294     *
13295     * Toolbar will load icon image from fdo or current theme.
13296     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13297     * If an absolute path is provided it will load it direct from a file.
13298     *
13299     * @see elm_toolbar_item_icon_set()
13300     * @see elm_toolbar_item_del()
13301     * @see elm_toolbar_item_del_cb_set()
13302     *
13303     * @ingroup Toolbar
13304     */
13305    EAPI Elm_Toolbar_Item       *elm_toolbar_item_append(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13306
13307    /**
13308     * Prepend item to the toolbar.
13309     *
13310     * @param obj The toolbar object.
13311     * @param icon A string with icon name or the absolute path of an image file.
13312     * @param label The label of the item.
13313     * @param func The function to call when the item is clicked.
13314     * @param data The data to associate with the item for related callbacks.
13315     * @return The created item or @c NULL upon failure.
13316     *
13317     * A new item will be created and prepended to the toolbar, i.e., will
13318     * be set as @b first item.
13319     *
13320     * Items created with this method can be deleted with
13321     * elm_toolbar_item_del().
13322     *
13323     * Associated @p data can be properly freed when item is deleted if a
13324     * callback function is set with elm_toolbar_item_del_cb_set().
13325     *
13326     * If a function is passed as argument, it will be called everytime this item
13327     * is selected, i.e., the user clicks over an unselected item.
13328     * If such function isn't needed, just passing
13329     * @c NULL as @p func is enough. The same should be done for @p data.
13330     *
13331     * Toolbar will load icon image from fdo or current theme.
13332     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13333     * If an absolute path is provided it will load it direct from a file.
13334     *
13335     * @see elm_toolbar_item_icon_set()
13336     * @see elm_toolbar_item_del()
13337     * @see elm_toolbar_item_del_cb_set()
13338     *
13339     * @ingroup Toolbar
13340     */
13341    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prepend(Evas_Object *obj, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13342
13343    /**
13344     * Insert a new item into the toolbar object before item @p before.
13345     *
13346     * @param obj The toolbar object.
13347     * @param before The toolbar item to insert before.
13348     * @param icon A string with icon name or the absolute path of an image file.
13349     * @param label The label of the item.
13350     * @param func The function to call when the item is clicked.
13351     * @param data The data to associate with the item for related callbacks.
13352     * @return The created item or @c NULL upon failure.
13353     *
13354     * A new item will be created and added to the toolbar. Its position in
13355     * this toolbar will be just before item @p before.
13356     *
13357     * Items created with this method can be deleted with
13358     * elm_toolbar_item_del().
13359     *
13360     * Associated @p data can be properly freed when item is deleted if a
13361     * callback function is set with elm_toolbar_item_del_cb_set().
13362     *
13363     * If a function is passed as argument, it will be called everytime this item
13364     * is selected, i.e., the user clicks over an unselected item.
13365     * If such function isn't needed, just passing
13366     * @c NULL as @p func is enough. The same should be done for @p data.
13367     *
13368     * Toolbar will load icon image from fdo or current theme.
13369     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13370     * If an absolute path is provided it will load it direct from a file.
13371     *
13372     * @see elm_toolbar_item_icon_set()
13373     * @see elm_toolbar_item_del()
13374     * @see elm_toolbar_item_del_cb_set()
13375     *
13376     * @ingroup Toolbar
13377     */
13378    EAPI Elm_Toolbar_Item       *elm_toolbar_item_insert_before(Evas_Object *obj, Elm_Toolbar_Item *before, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13379
13380    /**
13381     * Insert a new item into the toolbar object after item @p after.
13382     *
13383     * @param obj The toolbar object.
13384     * @param before The toolbar item to insert before.
13385     * @param icon A string with icon name or the absolute path of an image file.
13386     * @param label The label of the item.
13387     * @param func The function to call when the item is clicked.
13388     * @param data The data to associate with the item for related callbacks.
13389     * @return The created item or @c NULL upon failure.
13390     *
13391     * A new item will be created and added to the toolbar. Its position in
13392     * this toolbar will be just after item @p after.
13393     *
13394     * Items created with this method can be deleted with
13395     * elm_toolbar_item_del().
13396     *
13397     * Associated @p data can be properly freed when item is deleted if a
13398     * callback function is set with elm_toolbar_item_del_cb_set().
13399     *
13400     * If a function is passed as argument, it will be called everytime this item
13401     * is selected, i.e., the user clicks over an unselected item.
13402     * If such function isn't needed, just passing
13403     * @c NULL as @p func is enough. The same should be done for @p data.
13404     *
13405     * Toolbar will load icon image from fdo or current theme.
13406     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13407     * If an absolute path is provided it will load it direct from a file.
13408     *
13409     * @see elm_toolbar_item_icon_set()
13410     * @see elm_toolbar_item_del()
13411     * @see elm_toolbar_item_del_cb_set()
13412     *
13413     * @ingroup Toolbar
13414     */
13415    EAPI Elm_Toolbar_Item       *elm_toolbar_item_insert_after(Evas_Object *obj, Elm_Toolbar_Item *after, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13416
13417    /**
13418     * Get the first item in the given toolbar widget's list of
13419     * items.
13420     *
13421     * @param obj The toolbar object
13422     * @return The first item or @c NULL, if it has no items (and on
13423     * errors)
13424     *
13425     * @see elm_toolbar_item_append()
13426     * @see elm_toolbar_last_item_get()
13427     *
13428     * @ingroup Toolbar
13429     */
13430    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13431
13432    /**
13433     * Get the last item in the given toolbar widget's list of
13434     * items.
13435     *
13436     * @param obj The toolbar object
13437     * @return The last item or @c NULL, if it has no items (and on
13438     * errors)
13439     *
13440     * @see elm_toolbar_item_prepend()
13441     * @see elm_toolbar_first_item_get()
13442     *
13443     * @ingroup Toolbar
13444     */
13445    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13446
13447    /**
13448     * Get the item after @p item in toolbar.
13449     *
13450     * @param item The toolbar item.
13451     * @return The item after @p item, or @c NULL if none or on failure.
13452     *
13453     * @note If it is the last item, @c NULL will be returned.
13454     *
13455     * @see elm_toolbar_item_append()
13456     *
13457     * @ingroup Toolbar
13458     */
13459    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13460
13461    /**
13462     * Get the item before @p item in toolbar.
13463     *
13464     * @param item The toolbar item.
13465     * @return The item before @p item, or @c NULL if none or on failure.
13466     *
13467     * @note If it is the first item, @c NULL will be returned.
13468     *
13469     * @see elm_toolbar_item_prepend()
13470     *
13471     * @ingroup Toolbar
13472     */
13473    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13474
13475    /**
13476     * Get the toolbar object from an item.
13477     *
13478     * @param item The item.
13479     * @return The toolbar object.
13480     *
13481     * This returns the toolbar object itself that an item belongs to.
13482     *
13483     * @ingroup Toolbar
13484     */
13485    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13486
13487    /**
13488     * Set the priority of a toolbar item.
13489     *
13490     * @param item The toolbar item.
13491     * @param priority The item priority. The default is zero.
13492     *
13493     * This is used only when the toolbar shrink mode is set to
13494     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13495     * When space is less than required, items with low priority
13496     * will be removed from the toolbar and added to a dynamically-created menu,
13497     * while items with higher priority will remain on the toolbar,
13498     * with the same order they were added.
13499     *
13500     * @see elm_toolbar_item_priority_get()
13501     *
13502     * @ingroup Toolbar
13503     */
13504    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13505
13506    /**
13507     * Get the priority of a toolbar item.
13508     *
13509     * @param item The toolbar item.
13510     * @return The @p item priority, or @c 0 on failure.
13511     *
13512     * @see elm_toolbar_item_priority_set() for details.
13513     *
13514     * @ingroup Toolbar
13515     */
13516    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13517
13518    /**
13519     * Get the label of item.
13520     *
13521     * @param item The item of toolbar.
13522     * @return The label of item.
13523     *
13524     * The return value is a pointer to the label associated to @p item when
13525     * it was created, with function elm_toolbar_item_append() or similar,
13526     * or later,
13527     * with function elm_toolbar_item_label_set. If no label
13528     * was passed as argument, it will return @c NULL.
13529     *
13530     * @see elm_toolbar_item_label_set() for more details.
13531     * @see elm_toolbar_item_append()
13532     *
13533     * @ingroup Toolbar
13534     */
13535    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13536
13537    /**
13538     * Set the label of item.
13539     *
13540     * @param item The item of toolbar.
13541     * @param text The label of item.
13542     *
13543     * The label to be displayed by the item.
13544     * Label will be placed at icons bottom (if set).
13545     *
13546     * If a label was passed as argument on item creation, with function
13547     * elm_toolbar_item_append() or similar, it will be already
13548     * displayed by the item.
13549     *
13550     * @see elm_toolbar_item_label_get()
13551     * @see elm_toolbar_item_append()
13552     *
13553     * @ingroup Toolbar
13554     */
13555    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13556
13557    /**
13558     * Return the data associated with a given toolbar widget item.
13559     *
13560     * @param item The toolbar widget item handle.
13561     * @return The data associated with @p item.
13562     *
13563     * @see elm_toolbar_item_data_set()
13564     *
13565     * @ingroup Toolbar
13566     */
13567    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13568
13569    /**
13570     * Set the data associated with a given toolbar widget item.
13571     *
13572     * @param item The toolbar widget item handle.
13573     * @param data The new data pointer to set to @p item.
13574     *
13575     * This sets new item data on @p item.
13576     *
13577     * @warning The old data pointer won't be touched by this function, so
13578     * the user had better to free that old data himself/herself.
13579     *
13580     * @ingroup Toolbar
13581     */
13582    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13583
13584    /**
13585     * Returns a pointer to a toolbar item by its label.
13586     *
13587     * @param obj The toolbar object.
13588     * @param label The label of the item to find.
13589     *
13590     * @return The pointer to the toolbar item matching @p label or @c NULL
13591     * on failure.
13592     *
13593     * @ingroup Toolbar
13594     */
13595    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13596
13597    /*
13598     * Get whether the @p item is selected or not.
13599     *
13600     * @param item The toolbar item.
13601     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13602     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13603     *
13604     * @see elm_toolbar_selected_item_set() for details.
13605     * @see elm_toolbar_item_selected_get()
13606     *
13607     * @ingroup Toolbar
13608     */
13609    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13610
13611    /**
13612     * Set the selected state of an item.
13613     *
13614     * @param item The toolbar item
13615     * @param selected The selected state
13616     *
13617     * This sets the selected state of the given item @p it.
13618     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13619     *
13620     * If a new item is selected the previosly selected will be unselected.
13621     * Previoulsy selected item can be get with function
13622     * elm_toolbar_selected_item_get().
13623     *
13624     * Selected items will be highlighted.
13625     *
13626     * @see elm_toolbar_item_selected_get()
13627     * @see elm_toolbar_selected_item_get()
13628     *
13629     * @ingroup Toolbar
13630     */
13631    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13632
13633    /**
13634     * Get the selected item.
13635     *
13636     * @param obj The toolbar object.
13637     * @return The selected toolbar item.
13638     *
13639     * The selected item can be unselected with function
13640     * elm_toolbar_item_selected_set().
13641     *
13642     * The selected item always will be highlighted on toolbar.
13643     *
13644     * @see elm_toolbar_selected_items_get()
13645     *
13646     * @ingroup Toolbar
13647     */
13648    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13649
13650    /**
13651     * Set the icon associated with @p item.
13652     *
13653     * @param obj The parent of this item.
13654     * @param item The toolbar item.
13655     * @param icon A string with icon name or the absolute path of an image file.
13656     *
13657     * Toolbar will load icon image from fdo or current theme.
13658     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13659     * If an absolute path is provided it will load it direct from a file.
13660     *
13661     * @see elm_toolbar_icon_order_lookup_set()
13662     * @see elm_toolbar_icon_order_lookup_get()
13663     *
13664     * @ingroup Toolbar
13665     */
13666    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13667
13668    /**
13669     * Get the string used to set the icon of @p item.
13670     *
13671     * @param item The toolbar item.
13672     * @return The string associated with the icon object.
13673     *
13674     * @see elm_toolbar_item_icon_set() for details.
13675     *
13676     * @ingroup Toolbar
13677     */
13678    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13679
13680    /**
13681     * Delete them item from the toolbar.
13682     *
13683     * @param item The item of toolbar to be deleted.
13684     *
13685     * @see elm_toolbar_item_append()
13686     * @see elm_toolbar_item_del_cb_set()
13687     *
13688     * @ingroup Toolbar
13689     */
13690    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13691
13692    /**
13693     * Set the function called when a toolbar item is freed.
13694     *
13695     * @param item The item to set the callback on.
13696     * @param func The function called.
13697     *
13698     * If there is a @p func, then it will be called prior item's memory release.
13699     * That will be called with the following arguments:
13700     * @li item's data;
13701     * @li item's Evas object;
13702     * @li item itself;
13703     *
13704     * This way, a data associated to a toolbar item could be properly freed.
13705     *
13706     * @ingroup Toolbar
13707     */
13708    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13709
13710    /**
13711     * Get a value whether toolbar item is disabled or not.
13712     *
13713     * @param item The item.
13714     * @return The disabled state.
13715     *
13716     * @see elm_toolbar_item_disabled_set() for more details.
13717     *
13718     * @ingroup Toolbar
13719     */
13720    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13721
13722    /**
13723     * Sets the disabled/enabled state of a toolbar item.
13724     *
13725     * @param item The item.
13726     * @param disabled The disabled state.
13727     *
13728     * A disabled item cannot be selected or unselected. It will also
13729     * change its appearance (generally greyed out). This sets the
13730     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13731     * enabled).
13732     *
13733     * @ingroup Toolbar
13734     */
13735    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13736
13737    /**
13738     * Set or unset item as a separator.
13739     *
13740     * @param item The toolbar item.
13741     * @param setting @c EINA_TRUE to set item @p item as separator or
13742     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13743     *
13744     * Items aren't set as separator by default.
13745     *
13746     * If set as separator it will display separator theme, so won't display
13747     * icons or label.
13748     *
13749     * @see elm_toolbar_item_separator_get()
13750     *
13751     * @ingroup Toolbar
13752     */
13753    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13754
13755    /**
13756     * Get a value whether item is a separator or not.
13757     *
13758     * @param item The toolbar item.
13759     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13760     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13761     *
13762     * @see elm_toolbar_item_separator_set() for details.
13763     *
13764     * @ingroup Toolbar
13765     */
13766    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13767
13768    /**
13769     * Set the shrink state of toolbar @p obj.
13770     *
13771     * @param obj The toolbar object.
13772     * @param shrink_mode Toolbar's items display behavior.
13773     *
13774     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13775     * but will enforce a minimun size so all the items will fit, won't scroll
13776     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13777     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13778     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13779     *
13780     * @ingroup Toolbar
13781     */
13782    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13783
13784    /**
13785     * Get the shrink mode of toolbar @p obj.
13786     *
13787     * @param obj The toolbar object.
13788     * @return Toolbar's items display behavior.
13789     *
13790     * @see elm_toolbar_mode_shrink_set() for details.
13791     *
13792     * @ingroup Toolbar
13793     */
13794    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13795
13796    /**
13797     * Enable/disable homogenous mode.
13798     *
13799     * @param obj The toolbar object
13800     * @param homogeneous Assume the items within the toolbar are of the
13801     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13802     *
13803     * This will enable the homogeneous mode where items are of the same size.
13804     * @see elm_toolbar_homogeneous_get()
13805     *
13806     * @ingroup Toolbar
13807     */
13808    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13809
13810    /**
13811     * Get whether the homogenous mode is enabled.
13812     *
13813     * @param obj The toolbar object.
13814     * @return Assume the items within the toolbar are of the same height
13815     * and width (EINA_TRUE = on, EINA_FALSE = off).
13816     *
13817     * @see elm_toolbar_homogeneous_set()
13818     *
13819     * @ingroup Toolbar
13820     */
13821    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13822
13823    /**
13824     * Enable/disable homogenous mode.
13825     *
13826     * @param obj The toolbar object
13827     * @param homogeneous Assume the items within the toolbar are of the
13828     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13829     *
13830     * This will enable the homogeneous mode where items are of the same size.
13831     * @see elm_toolbar_homogeneous_get()
13832     *
13833     * @deprecated use elm_toolbar_homogeneous_set() instead.
13834     *
13835     * @ingroup Toolbar
13836     */
13837    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13838
13839    /**
13840     * Get whether the homogenous mode is enabled.
13841     *
13842     * @param obj The toolbar object.
13843     * @return Assume the items within the toolbar are of the same height
13844     * and width (EINA_TRUE = on, EINA_FALSE = off).
13845     *
13846     * @see elm_toolbar_homogeneous_set()
13847     * @deprecated use elm_toolbar_homogeneous_get() instead.
13848     *
13849     * @ingroup Toolbar
13850     */
13851    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13852
13853    /**
13854     * Set the parent object of the toolbar items' menus.
13855     *
13856     * @param obj The toolbar object.
13857     * @param parent The parent of the menu objects.
13858     *
13859     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13860     *
13861     * For more details about setting the parent for toolbar menus, see
13862     * elm_menu_parent_set().
13863     *
13864     * @see elm_menu_parent_set() for details.
13865     * @see elm_toolbar_item_menu_set() for details.
13866     *
13867     * @ingroup Toolbar
13868     */
13869    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13870
13871    /**
13872     * Get the parent object of the toolbar items' menus.
13873     *
13874     * @param obj The toolbar object.
13875     * @return The parent of the menu objects.
13876     *
13877     * @see elm_toolbar_menu_parent_set() for details.
13878     *
13879     * @ingroup Toolbar
13880     */
13881    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13882
13883    /**
13884     * Set the alignment of the items.
13885     *
13886     * @param obj The toolbar object.
13887     * @param align The new alignment, a float between <tt> 0.0 </tt>
13888     * and <tt> 1.0 </tt>.
13889     *
13890     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13891     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13892     * items.
13893     *
13894     * Centered items by default.
13895     *
13896     * @see elm_toolbar_align_get()
13897     *
13898     * @ingroup Toolbar
13899     */
13900    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13901
13902    /**
13903     * Get the alignment of the items.
13904     *
13905     * @param obj The toolbar object.
13906     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13907     * <tt> 1.0 </tt>.
13908     *
13909     * @see elm_toolbar_align_set() for details.
13910     *
13911     * @ingroup Toolbar
13912     */
13913    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13914
13915    /**
13916     * Set whether the toolbar item opens a menu.
13917     *
13918     * @param item The toolbar item.
13919     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13920     *
13921     * A toolbar item can be set to be a menu, using this function.
13922     *
13923     * Once it is set to be a menu, it can be manipulated through the
13924     * menu-like function elm_toolbar_menu_parent_set() and the other
13925     * elm_menu functions, using the Evas_Object @c menu returned by
13926     * elm_toolbar_item_menu_get().
13927     *
13928     * So, items to be displayed in this item's menu should be added with
13929     * elm_menu_item_add().
13930     *
13931     * The following code exemplifies the most basic usage:
13932     * @code
13933     * tb = elm_toolbar_add(win)
13934     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13935     * elm_toolbar_item_menu_set(item, EINA_TRUE);
13936     * elm_toolbar_menu_parent_set(tb, win);
13937     * menu = elm_toolbar_item_menu_get(item);
13938     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13939     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13940     * NULL);
13941     * @endcode
13942     *
13943     * @see elm_toolbar_item_menu_get()
13944     *
13945     * @ingroup Toolbar
13946     */
13947    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13948
13949    /**
13950     * Get toolbar item's menu.
13951     *
13952     * @param item The toolbar item.
13953     * @return Item's menu object or @c NULL on failure.
13954     *
13955     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13956     * this function will set it.
13957     *
13958     * @see elm_toolbar_item_menu_set() for details.
13959     *
13960     * @ingroup Toolbar
13961     */
13962    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13963
13964    /**
13965     * Add a new state to @p item.
13966     *
13967     * @param item The item.
13968     * @param icon A string with icon name or the absolute path of an image file.
13969     * @param label The label of the new state.
13970     * @param func The function to call when the item is clicked when this
13971     * state is selected.
13972     * @param data The data to associate with the state.
13973     * @return The toolbar item state, or @c NULL upon failure.
13974     *
13975     * Toolbar will load icon image from fdo or current theme.
13976     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13977     * If an absolute path is provided it will load it direct from a file.
13978     *
13979     * States created with this function can be removed with
13980     * elm_toolbar_item_state_del().
13981     *
13982     * @see elm_toolbar_item_state_del()
13983     * @see elm_toolbar_item_state_sel()
13984     * @see elm_toolbar_item_state_get()
13985     *
13986     * @ingroup Toolbar
13987     */
13988    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_add(Elm_Toolbar_Item *item, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
13989
13990    /**
13991     * Delete a previoulsy added state to @p item.
13992     *
13993     * @param item The toolbar item.
13994     * @param state The state to be deleted.
13995     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13996     *
13997     * @see elm_toolbar_item_state_add()
13998     */
13999    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14000
14001    /**
14002     * Set @p state as the current state of @p it.
14003     *
14004     * @param it The item.
14005     * @param state The state to use.
14006     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
14007     *
14008     * If @p state is @c NULL, it won't select any state and the default item's
14009     * icon and label will be used. It's the same behaviour than
14010     * elm_toolbar_item_state_unser().
14011     *
14012     * @see elm_toolbar_item_state_unset()
14013     *
14014     * @ingroup Toolbar
14015     */
14016    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
14017
14018    /**
14019     * Unset the state of @p it.
14020     *
14021     * @param it The item.
14022     *
14023     * The default icon and label from this item will be displayed.
14024     *
14025     * @see elm_toolbar_item_state_set() for more details.
14026     *
14027     * @ingroup Toolbar
14028     */
14029    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14030
14031    /**
14032     * Get the current state of @p it.
14033     *
14034     * @param item The item.
14035     * @return The selected state or @c NULL if none is selected or on failure.
14036     *
14037     * @see elm_toolbar_item_state_set() for details.
14038     * @see elm_toolbar_item_state_unset()
14039     * @see elm_toolbar_item_state_add()
14040     *
14041     * @ingroup Toolbar
14042     */
14043    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14044
14045    /**
14046     * Get the state after selected state in toolbar's @p item.
14047     *
14048     * @param it The toolbar item to change state.
14049     * @return The state after current state, or @c NULL on failure.
14050     *
14051     * If last state is selected, this function will return first state.
14052     *
14053     * @see elm_toolbar_item_state_set()
14054     * @see elm_toolbar_item_state_add()
14055     *
14056     * @ingroup Toolbar
14057     */
14058    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14059
14060    /**
14061     * Get the state before selected state in toolbar's @p item.
14062     *
14063     * @param it The toolbar item to change state.
14064     * @return The state before current state, or @c NULL on failure.
14065     *
14066     * If first state is selected, this function will return last state.
14067     *
14068     * @see elm_toolbar_item_state_set()
14069     * @see elm_toolbar_item_state_add()
14070     *
14071     * @ingroup Toolbar
14072     */
14073    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
14074
14075    /**
14076     * Set the text to be shown in a given toolbar item's tooltips.
14077     *
14078     * @param item Target item.
14079     * @param text The text to set in the content.
14080     *
14081     * Setup the text as tooltip to object. The item can have only one tooltip,
14082     * so any previous tooltip data - set with this function or
14083     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
14084     *
14085     * @see elm_object_tooltip_text_set() for more details.
14086     *
14087     * @ingroup Toolbar
14088     */
14089    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
14090
14091    /**
14092     * Set the content to be shown in the tooltip item.
14093     *
14094     * Setup the tooltip to item. The item can have only one tooltip,
14095     * so any previous tooltip data is removed. @p func(with @p data) will
14096     * be called every time that need show the tooltip and it should
14097     * return a valid Evas_Object. This object is then managed fully by
14098     * tooltip system and is deleted when the tooltip is gone.
14099     *
14100     * @param item the toolbar item being attached a tooltip.
14101     * @param func the function used to create the tooltip contents.
14102     * @param data what to provide to @a func as callback data/context.
14103     * @param del_cb called when data is not needed anymore, either when
14104     *        another callback replaces @a func, the tooltip is unset with
14105     *        elm_toolbar_item_tooltip_unset() or the owner @a item
14106     *        dies. This callback receives as the first parameter the
14107     *        given @a data, and @c event_info is the item.
14108     *
14109     * @see elm_object_tooltip_content_cb_set() for more details.
14110     *
14111     * @ingroup Toolbar
14112     */
14113    EAPI void             elm_toolbar_item_tooltip_content_cb_set(Elm_Toolbar_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
14114
14115    /**
14116     * Unset tooltip from item.
14117     *
14118     * @param item toolbar item to remove previously set tooltip.
14119     *
14120     * Remove tooltip from item. The callback provided as del_cb to
14121     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
14122     * it is not used anymore.
14123     *
14124     * @see elm_object_tooltip_unset() for more details.
14125     * @see elm_toolbar_item_tooltip_content_cb_set()
14126     *
14127     * @ingroup Toolbar
14128     */
14129    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14130
14131    /**
14132     * Sets a different style for this item tooltip.
14133     *
14134     * @note before you set a style you should define a tooltip with
14135     *       elm_toolbar_item_tooltip_content_cb_set() or
14136     *       elm_toolbar_item_tooltip_text_set()
14137     *
14138     * @param item toolbar item with tooltip already set.
14139     * @param style the theme style to use (default, transparent, ...)
14140     *
14141     * @see elm_object_tooltip_style_set() for more details.
14142     *
14143     * @ingroup Toolbar
14144     */
14145    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14146
14147    /**
14148     * Get the style for this item tooltip.
14149     *
14150     * @param item toolbar item with tooltip already set.
14151     * @return style the theme style in use, defaults to "default". If the
14152     *         object does not have a tooltip set, then NULL is returned.
14153     *
14154     * @see elm_object_tooltip_style_get() for more details.
14155     * @see elm_toolbar_item_tooltip_style_set()
14156     *
14157     * @ingroup Toolbar
14158     */
14159    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14160
14161    /**
14162     * Set the type of mouse pointer/cursor decoration to be shown,
14163     * when the mouse pointer is over the given toolbar widget item
14164     *
14165     * @param item toolbar item to customize cursor on
14166     * @param cursor the cursor type's name
14167     *
14168     * This function works analogously as elm_object_cursor_set(), but
14169     * here the cursor's changing area is restricted to the item's
14170     * area, and not the whole widget's. Note that that item cursors
14171     * have precedence over widget cursors, so that a mouse over an
14172     * item with custom cursor set will always show @b that cursor.
14173     *
14174     * If this function is called twice for an object, a previously set
14175     * cursor will be unset on the second call.
14176     *
14177     * @see elm_object_cursor_set()
14178     * @see elm_toolbar_item_cursor_get()
14179     * @see elm_toolbar_item_cursor_unset()
14180     *
14181     * @ingroup Toolbar
14182     */
14183    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
14184
14185    /*
14186     * Get the type of mouse pointer/cursor decoration set to be shown,
14187     * when the mouse pointer is over the given toolbar widget item
14188     *
14189     * @param item toolbar item with custom cursor set
14190     * @return the cursor type's name or @c NULL, if no custom cursors
14191     * were set to @p item (and on errors)
14192     *
14193     * @see elm_object_cursor_get()
14194     * @see elm_toolbar_item_cursor_set()
14195     * @see elm_toolbar_item_cursor_unset()
14196     *
14197     * @ingroup Toolbar
14198     */
14199    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14200
14201    /**
14202     * Unset any custom mouse pointer/cursor decoration set to be
14203     * shown, when the mouse pointer is over the given toolbar widget
14204     * item, thus making it show the @b default cursor again.
14205     *
14206     * @param item a toolbar item
14207     *
14208     * Use this call to undo any custom settings on this item's cursor
14209     * decoration, bringing it back to defaults (no custom style set).
14210     *
14211     * @see elm_object_cursor_unset()
14212     * @see elm_toolbar_item_cursor_set()
14213     *
14214     * @ingroup Toolbar
14215     */
14216    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14217
14218    /**
14219     * Set a different @b style for a given custom cursor set for a
14220     * toolbar item.
14221     *
14222     * @param item toolbar item with custom cursor set
14223     * @param style the <b>theme style</b> to use (e.g. @c "default",
14224     * @c "transparent", etc)
14225     *
14226     * This function only makes sense when one is using custom mouse
14227     * cursor decorations <b>defined in a theme file</b>, which can have,
14228     * given a cursor name/type, <b>alternate styles</b> on it. It
14229     * works analogously as elm_object_cursor_style_set(), but here
14230     * applyed only to toolbar item objects.
14231     *
14232     * @warning Before you set a cursor style you should have definen a
14233     *       custom cursor previously on the item, with
14234     *       elm_toolbar_item_cursor_set()
14235     *
14236     * @see elm_toolbar_item_cursor_engine_only_set()
14237     * @see elm_toolbar_item_cursor_style_get()
14238     *
14239     * @ingroup Toolbar
14240     */
14241    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14242
14243    /**
14244     * Get the current @b style set for a given toolbar item's custom
14245     * cursor
14246     *
14247     * @param item toolbar item with custom cursor set.
14248     * @return style the cursor style in use. If the object does not
14249     *         have a cursor set, then @c NULL is returned.
14250     *
14251     * @see elm_toolbar_item_cursor_style_set() for more details
14252     *
14253     * @ingroup Toolbar
14254     */
14255    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14256
14257    /**
14258     * Set if the (custom)cursor for a given toolbar item should be
14259     * searched in its theme, also, or should only rely on the
14260     * rendering engine.
14261     *
14262     * @param item item with custom (custom) cursor already set on
14263     * @param engine_only Use @c EINA_TRUE to have cursors looked for
14264     * only on those provided by the rendering engine, @c EINA_FALSE to
14265     * have them searched on the widget's theme, as well.
14266     *
14267     * @note This call is of use only if you've set a custom cursor
14268     * for toolbar items, with elm_toolbar_item_cursor_set().
14269     *
14270     * @note By default, cursors will only be looked for between those
14271     * provided by the rendering engine.
14272     *
14273     * @ingroup Toolbar
14274     */
14275    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14276
14277    /**
14278     * Get if the (custom) cursor for a given toolbar item is being
14279     * searched in its theme, also, or is only relying on the rendering
14280     * engine.
14281     *
14282     * @param item a toolbar item
14283     * @return @c EINA_TRUE, if cursors are being looked for only on
14284     * those provided by the rendering engine, @c EINA_FALSE if they
14285     * are being searched on the widget's theme, as well.
14286     *
14287     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14288     *
14289     * @ingroup Toolbar
14290     */
14291    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14292
14293    /**
14294     * Change a toolbar's orientation
14295     * @param obj The toolbar object
14296     * @param vertical If @c EINA_TRUE, the toolbar is vertical
14297     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14298     * @ingroup Toolbar
14299     */
14300    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14301
14302    /**
14303     * Get a toolbar's orientation
14304     * @param obj The toolbar object
14305     * @return If @c EINA_TRUE, the toolbar is vertical
14306     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14307     * @ingroup Toolbar
14308     */
14309    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14310
14311    /**
14312     * @}
14313     */
14314
14315    /**
14316     * @defgroup Tooltips Tooltips
14317     *
14318     * The Tooltip is an (internal, for now) smart object used to show a
14319     * content in a frame on mouse hover of objects(or widgets), with
14320     * tips/information about them.
14321     *
14322     * @{
14323     */
14324
14325    EAPI double       elm_tooltip_delay_get(void);
14326    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
14327    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14328    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14329    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14330    EAPI void         elm_object_tooltip_content_cb_set(Evas_Object *obj, Elm_Tooltip_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
14331    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14332    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14333    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14334    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14335    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14336
14337    /**
14338     * @}
14339     */
14340
14341    /**
14342     * @defgroup Cursors Cursors
14343     *
14344     * The Elementary cursor is an internal smart object used to
14345     * customize the mouse cursor displayed over objects (or
14346     * widgets). In the most common scenario, the cursor decoration
14347     * comes from the graphical @b engine Elementary is running
14348     * on. Those engines may provide different decorations for cursors,
14349     * and Elementary provides functions to choose them (think of X11
14350     * cursors, as an example).
14351     *
14352     * There's also the possibility of, besides using engine provided
14353     * cursors, also use ones coming from Edje theming files. Both
14354     * globally and per widget, Elementary makes it possible for one to
14355     * make the cursors lookup to be held on engines only or on
14356     * Elementary's theme file, too.
14357     *
14358     * @{
14359     */
14360
14361    /**
14362     * Set the cursor to be shown when mouse is over the object
14363     *
14364     * Set the cursor that will be displayed when mouse is over the
14365     * object. The object can have only one cursor set to it, so if
14366     * this function is called twice for an object, the previous set
14367     * will be unset.
14368     * If using X cursors, a definition of all the valid cursor names
14369     * is listed on Elementary_Cursors.h. If an invalid name is set
14370     * the default cursor will be used.
14371     *
14372     * @param obj the object being set a cursor.
14373     * @param cursor the cursor name to be used.
14374     *
14375     * @ingroup Cursors
14376     */
14377    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14378
14379    /**
14380     * Get the cursor to be shown when mouse is over the object
14381     *
14382     * @param obj an object with cursor already set.
14383     * @return the cursor name.
14384     *
14385     * @ingroup Cursors
14386     */
14387    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14388
14389    /**
14390     * Unset cursor for object
14391     *
14392     * Unset cursor for object, and set the cursor to default if the mouse
14393     * was over this object.
14394     *
14395     * @param obj Target object
14396     * @see elm_object_cursor_set()
14397     *
14398     * @ingroup Cursors
14399     */
14400    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14401
14402    /**
14403     * Sets a different style for this object cursor.
14404     *
14405     * @note before you set a style you should define a cursor with
14406     *       elm_object_cursor_set()
14407     *
14408     * @param obj an object with cursor already set.
14409     * @param style the theme style to use (default, transparent, ...)
14410     *
14411     * @ingroup Cursors
14412     */
14413    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14414
14415    /**
14416     * Get the style for this object cursor.
14417     *
14418     * @param obj an object with cursor already set.
14419     * @return style the theme style in use, defaults to "default". If the
14420     *         object does not have a cursor set, then NULL is returned.
14421     *
14422     * @ingroup Cursors
14423     */
14424    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14425
14426    /**
14427     * Set if the cursor set should be searched on the theme or should use
14428     * the provided by the engine, only.
14429     *
14430     * @note before you set if should look on theme you should define a cursor
14431     * with elm_object_cursor_set(). By default it will only look for cursors
14432     * provided by the engine.
14433     *
14434     * @param obj an object with cursor already set.
14435     * @param engine_only boolean to define it cursors should be looked only
14436     * between the provided by the engine or searched on widget's theme as well.
14437     *
14438     * @ingroup Cursors
14439     */
14440    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14441
14442    /**
14443     * Get the cursor engine only usage for this object cursor.
14444     *
14445     * @param obj an object with cursor already set.
14446     * @return engine_only boolean to define it cursors should be
14447     * looked only between the provided by the engine or searched on
14448     * widget's theme as well. If the object does not have a cursor
14449     * set, then EINA_FALSE is returned.
14450     *
14451     * @ingroup Cursors
14452     */
14453    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14454
14455    /**
14456     * Get the configured cursor engine only usage
14457     *
14458     * This gets the globally configured exclusive usage of engine cursors.
14459     *
14460     * @return 1 if only engine cursors should be used
14461     * @ingroup Cursors
14462     */
14463    EAPI int          elm_cursor_engine_only_get(void);
14464
14465    /**
14466     * Set the configured cursor engine only usage
14467     *
14468     * This sets the globally configured exclusive usage of engine cursors.
14469     * It won't affect cursors set before changing this value.
14470     *
14471     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14472     * look for them on theme before.
14473     * @return EINA_TRUE if value is valid and setted (0 or 1)
14474     * @ingroup Cursors
14475     */
14476    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
14477
14478    /**
14479     * @}
14480     */
14481
14482    /**
14483     * @defgroup Menu Menu
14484     *
14485     * @image html img/widget/menu/preview-00.png
14486     * @image latex img/widget/menu/preview-00.eps
14487     *
14488     * A menu is a list of items displayed above its parent. When the menu is
14489     * showing its parent is darkened. Each item can have a sub-menu. The menu
14490     * object can be used to display a menu on a right click event, in a toolbar,
14491     * anywhere.
14492     *
14493     * Signals that you can add callbacks for are:
14494     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14495     *             event_info is NULL.
14496     *
14497     * @see @ref tutorial_menu
14498     * @{
14499     */
14500    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14501    /**
14502     * @brief Add a new menu to the parent
14503     *
14504     * @param parent The parent object.
14505     * @return The new object or NULL if it cannot be created.
14506     */
14507    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14508    /**
14509     * @brief Set the parent for the given menu widget
14510     *
14511     * @param obj The menu object.
14512     * @param parent The new parent.
14513     */
14514    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14515    /**
14516     * @brief Get the parent for the given menu widget
14517     *
14518     * @param obj The menu object.
14519     * @return The parent.
14520     *
14521     * @see elm_menu_parent_set()
14522     */
14523    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14524    /**
14525     * @brief Move the menu to a new position
14526     *
14527     * @param obj The menu object.
14528     * @param x The new position.
14529     * @param y The new position.
14530     *
14531     * Sets the top-left position of the menu to (@p x,@p y).
14532     *
14533     * @note @p x and @p y coordinates are relative to parent.
14534     */
14535    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14536    /**
14537     * @brief Close a opened menu
14538     *
14539     * @param obj the menu object
14540     * @return void
14541     *
14542     * Hides the menu and all it's sub-menus.
14543     */
14544    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14545    /**
14546     * @brief Returns a list of @p item's items.
14547     *
14548     * @param obj The menu object
14549     * @return An Eina_List* of @p item's items
14550     */
14551    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14552    /**
14553     * @brief Get the Evas_Object of an Elm_Menu_Item
14554     *
14555     * @param item The menu item object.
14556     * @return The edje object containing the swallowed content
14557     *
14558     * @warning Don't manipulate this object!
14559     */
14560    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14561    /**
14562     * @brief Add an item at the end of the given menu widget
14563     *
14564     * @param obj The menu object.
14565     * @param parent The parent menu item (optional)
14566     * @param icon A icon display on the item. The icon will be destryed by the menu.
14567     * @param label The label of the item.
14568     * @param func Function called when the user select the item.
14569     * @param data Data sent by the callback.
14570     * @return Returns the new item.
14571     */
14572    EAPI Elm_Menu_Item     *elm_menu_item_add(Evas_Object *obj, Elm_Menu_Item *parent, const char *icon, const char *label, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14573    /**
14574     * @brief Add an object swallowed in an item at the end of the given menu
14575     * widget
14576     *
14577     * @param obj The menu object.
14578     * @param parent The parent menu item (optional)
14579     * @param subobj The object to swallow
14580     * @param func Function called when the user select the item.
14581     * @param data Data sent by the callback.
14582     * @return Returns the new item.
14583     *
14584     * Add an evas object as an item to the menu.
14585     */
14586    EAPI Elm_Menu_Item     *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14587    /**
14588     * @brief Set the label of a menu item
14589     *
14590     * @param item The menu item object.
14591     * @param label The label to set for @p item
14592     *
14593     * @warning Don't use this funcion on items created with
14594     * elm_menu_item_add_object() or elm_menu_item_separator_add().
14595     */
14596    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14597    /**
14598     * @brief Get the label of a menu item
14599     *
14600     * @param item The menu item object.
14601     * @return The label of @p item
14602     */
14603    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14604    /**
14605     * @brief Set the icon of a menu item to the standard icon with name @p icon
14606     *
14607     * @param item The menu item object.
14608     * @param icon The icon object to set for the content of @p item
14609     *
14610     * Once this icon is set, any previously set icon will be deleted.
14611     */
14612    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14613    /**
14614     * @brief Get the string representation from the icon of a menu item
14615     *
14616     * @param item The menu item object.
14617     * @return The string representation of @p item's icon or NULL
14618     *
14619     * @see elm_menu_item_object_icon_name_set()
14620     */
14621    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14622    /**
14623     * @brief Set the content object of a menu item
14624     *
14625     * @param item The menu item object
14626     * @param The content object or NULL
14627     * @return EINA_TRUE on success, else EINA_FALSE
14628     *
14629     * Use this function to change the object swallowed by a menu item, deleting
14630     * any previously swallowed object.
14631     */
14632    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14633    /**
14634     * @brief Get the content object of a menu item
14635     *
14636     * @param item The menu item object
14637     * @return The content object or NULL
14638     * @note If @p item was added with elm_menu_item_add_object, this
14639     * function will return the object passed, else it will return the
14640     * icon object.
14641     *
14642     * @see elm_menu_item_object_content_set()
14643     */
14644    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14645    /**
14646     * @brief Set the selected state of @p item.
14647     *
14648     * @param item The menu item object.
14649     * @param selected The selected/unselected state of the item
14650     */
14651    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14652    /**
14653     * @brief Get the selected state of @p item.
14654     *
14655     * @param item The menu item object.
14656     * @return The selected/unselected state of the item
14657     *
14658     * @see elm_menu_item_selected_set()
14659     */
14660    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14661    /**
14662     * @brief Set the disabled state of @p item.
14663     *
14664     * @param item The menu item object.
14665     * @param disabled The enabled/disabled state of the item
14666     */
14667    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14668    /**
14669     * @brief Get the disabled state of @p item.
14670     *
14671     * @param item The menu item object.
14672     * @return The enabled/disabled state of the item
14673     *
14674     * @see elm_menu_item_disabled_set()
14675     */
14676    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14677    /**
14678     * @brief Add a separator item to menu @p obj under @p parent.
14679     *
14680     * @param obj The menu object
14681     * @param parent The item to add the separator under
14682     * @return The created item or NULL on failure
14683     *
14684     * This is item is a @ref Separator.
14685     */
14686    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14687    /**
14688     * @brief Returns whether @p item is a separator.
14689     *
14690     * @param item The item to check
14691     * @return If true, @p item is a separator
14692     *
14693     * @see elm_menu_item_separator_add()
14694     */
14695    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14696    /**
14697     * @brief Deletes an item from the menu.
14698     *
14699     * @param item The item to delete.
14700     *
14701     * @see elm_menu_item_add()
14702     */
14703    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14704    /**
14705     * @brief Set the function called when a menu item is deleted.
14706     *
14707     * @param item The item to set the callback on
14708     * @param func The function called
14709     *
14710     * @see elm_menu_item_add()
14711     * @see elm_menu_item_del()
14712     */
14713    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14714    /**
14715     * @brief Returns the data associated with menu item @p item.
14716     *
14717     * @param item The item
14718     * @return The data associated with @p item or NULL if none was set.
14719     *
14720     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14721     */
14722    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14723    /**
14724     * @brief Sets the data to be associated with menu item @p item.
14725     *
14726     * @param item The item
14727     * @param data The data to be associated with @p item
14728     */
14729    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14730    /**
14731     * @brief Returns a list of @p item's subitems.
14732     *
14733     * @param item The item
14734     * @return An Eina_List* of @p item's subitems
14735     *
14736     * @see elm_menu_add()
14737     */
14738    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14739    /**
14740     * @brief Get the position of a menu item
14741     *
14742     * @param item The menu item
14743     * @return The item's index
14744     *
14745     * This function returns the index position of a menu item in a menu.
14746     * For a sub-menu, this number is relative to the first item in the sub-menu.
14747     *
14748     * @note Index values begin with 0
14749     */
14750    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14751    /**
14752     * @brief @brief Return a menu item's owner menu
14753     *
14754     * @param item The menu item
14755     * @return The menu object owning @p item, or NULL on failure
14756     *
14757     * Use this function to get the menu object owning an item.
14758     */
14759    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14760    /**
14761     * @brief Get the selected item in the menu
14762     *
14763     * @param obj The menu object
14764     * @return The selected item, or NULL if none
14765     *
14766     * @see elm_menu_item_selected_get()
14767     * @see elm_menu_item_selected_set()
14768     */
14769    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14770    /**
14771     * @brief Get the last item in the menu
14772     *
14773     * @param obj The menu object
14774     * @return The last item, or NULL if none
14775     */
14776    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14777    /**
14778     * @brief Get the first item in the menu
14779     *
14780     * @param obj The menu object
14781     * @return The first item, or NULL if none
14782     */
14783    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14784    /**
14785     * @brief Get the next item in the menu.
14786     *
14787     * @param item The menu item object.
14788     * @return The item after it, or NULL if none
14789     */
14790    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14791    /**
14792     * @brief Get the previous item in the menu.
14793     *
14794     * @param item The menu item object.
14795     * @return The item before it, or NULL if none
14796     */
14797    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14798    /**
14799     * @}
14800     */
14801
14802    /**
14803     * @defgroup List List
14804     * @ingroup Elementary
14805     *
14806     * @image html img/widget/list/preview-00.png
14807     * @image latex img/widget/list/preview-00.eps width=\textwidth
14808     *
14809     * @image html img/list.png
14810     * @image latex img/list.eps width=\textwidth
14811     *
14812     * A list widget is a container whose children are displayed vertically or
14813     * horizontally, in order, and can be selected.
14814     * The list can accept only one or multiple items selection. Also has many
14815     * modes of items displaying.
14816     *
14817     * A list is a very simple type of list widget.  For more robust
14818     * lists, @ref Genlist should probably be used.
14819     *
14820     * Smart callbacks one can listen to:
14821     * - @c "activated" - The user has double-clicked or pressed
14822     *   (enter|return|spacebar) on an item. The @c event_info parameter
14823     *   is the item that was activated.
14824     * - @c "clicked,double" - The user has double-clicked an item.
14825     *   The @c event_info parameter is the item that was double-clicked.
14826     * - "selected" - when the user selected an item
14827     * - "unselected" - when the user unselected an item
14828     * - "longpressed" - an item in the list is long-pressed
14829     * - "scroll,edge,top" - the list is scrolled until the top edge
14830     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14831     * - "scroll,edge,left" - the list is scrolled until the left edge
14832     * - "scroll,edge,right" - the list is scrolled until the right edge
14833     *
14834     * Available styles for it:
14835     * - @c "default"
14836     *
14837     * List of examples:
14838     * @li @ref list_example_01
14839     * @li @ref list_example_02
14840     * @li @ref list_example_03
14841     */
14842
14843    /**
14844     * @addtogroup List
14845     * @{
14846     */
14847
14848    /**
14849     * @enum _Elm_List_Mode
14850     * @typedef Elm_List_Mode
14851     *
14852     * Set list's resize behavior, transverse axis scroll and
14853     * items cropping. See each mode's description for more details.
14854     *
14855     * @note Default value is #ELM_LIST_SCROLL.
14856     *
14857     * Values <b> don't </b> work as bitmask, only one can be choosen.
14858     *
14859     * @see elm_list_mode_set()
14860     * @see elm_list_mode_get()
14861     *
14862     * @ingroup List
14863     */
14864    typedef enum _Elm_List_Mode
14865      {
14866         ELM_LIST_COMPRESS = 0, /**< Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. */
14867         ELM_LIST_SCROLL, /**< Default value. Won't set any of its size hints to inform how a possible container should resize it. Then, if it's not created as a "resize object", it might end with zero dimensions. The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction (large items will get cropped). */
14868         ELM_LIST_LIMIT, /**< Set a minimun size hint on the list object, so that containers may respect it (and resize itself to fit the child properly). More specifically, a minimum size hint will be set for its transverse axis, so that the @b largest item in that direction fits well. Can have effects bounded by setting the list object's maximum size hints. */
14869         ELM_LIST_EXPAND, /**< Besides setting a minimum size on the transverse axis, just like the previous mode, will set a minimum size on the longitudinal axis too, trying to reserve space to all its children to be visible at a time. Can have effects bounded by setting the list object's maximum size hints. */
14870         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14871      } Elm_List_Mode;
14872
14873    typedef struct _Elm_List_Item Elm_List_Item; /**< Item of Elm_List. Sub-type of Elm_Widget_Item. Can be created with elm_list_item_append(), elm_list_item_prepend() and functions to add items in relative positions, like elm_list_item_insert_before(), and deleted with elm_list_item_del().  */
14874
14875    /**
14876     * Add a new list widget to the given parent Elementary
14877     * (container) object.
14878     *
14879     * @param parent The parent object.
14880     * @return a new list widget handle or @c NULL, on errors.
14881     *
14882     * This function inserts a new list widget on the canvas.
14883     *
14884     * @ingroup List
14885     */
14886    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14887
14888    /**
14889     * Starts the list.
14890     *
14891     * @param obj The list object
14892     *
14893     * @note Call before running show() on the list object.
14894     * @warning If not called, it won't display the list properly.
14895     *
14896     * @code
14897     * li = elm_list_add(win);
14898     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14899     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14900     * elm_list_go(li);
14901     * evas_object_show(li);
14902     * @endcode
14903     *
14904     * @ingroup List
14905     */
14906    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14907
14908    /**
14909     * Enable or disable multiple items selection on the list object.
14910     *
14911     * @param obj The list object
14912     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14913     * disable it.
14914     *
14915     * Disabled by default. If disabled, the user can select a single item of
14916     * the list each time. Selected items are highlighted on list.
14917     * If enabled, many items can be selected.
14918     *
14919     * If a selected item is selected again, it will be unselected.
14920     *
14921     * @see elm_list_multi_select_get()
14922     *
14923     * @ingroup List
14924     */
14925    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14926
14927    /**
14928     * Get a value whether multiple items selection is enabled or not.
14929     *
14930     * @see elm_list_multi_select_set() for details.
14931     *
14932     * @param obj The list object.
14933     * @return @c EINA_TRUE means multiple items selection is enabled.
14934     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14935     * @c EINA_FALSE is returned.
14936     *
14937     * @ingroup List
14938     */
14939    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14940
14941    /**
14942     * Set which mode to use for the list object.
14943     *
14944     * @param obj The list object
14945     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14946     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14947     *
14948     * Set list's resize behavior, transverse axis scroll and
14949     * items cropping. See each mode's description for more details.
14950     *
14951     * @note Default value is #ELM_LIST_SCROLL.
14952     *
14953     * Only one can be set, if a previous one was set, it will be changed
14954     * by the new mode set. Bitmask won't work as well.
14955     *
14956     * @see elm_list_mode_get()
14957     *
14958     * @ingroup List
14959     */
14960    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14961
14962    /**
14963     * Get the mode the list is at.
14964     *
14965     * @param obj The list object
14966     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14967     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14968     *
14969     * @note see elm_list_mode_set() for more information.
14970     *
14971     * @ingroup List
14972     */
14973    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14974
14975    /**
14976     * Enable or disable horizontal mode on the list object.
14977     *
14978     * @param obj The list object.
14979     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14980     * disable it, i.e., to enable vertical mode.
14981     *
14982     * @note Vertical mode is set by default.
14983     *
14984     * On horizontal mode items are displayed on list from left to right,
14985     * instead of from top to bottom. Also, the list will scroll horizontally.
14986     * Each item will presents left icon on top and right icon, or end, at
14987     * the bottom.
14988     *
14989     * @see elm_list_horizontal_get()
14990     *
14991     * @ingroup List
14992     */
14993    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14994
14995    /**
14996     * Get a value whether horizontal mode is enabled or not.
14997     *
14998     * @param obj The list object.
14999     * @return @c EINA_TRUE means horizontal mode selection is enabled.
15000     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15001     * @c EINA_FALSE is returned.
15002     *
15003     * @see elm_list_horizontal_set() for details.
15004     *
15005     * @ingroup List
15006     */
15007    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15008
15009    /**
15010     * Enable or disable always select mode on the list object.
15011     *
15012     * @param obj The list object
15013     * @param always_select @c EINA_TRUE to enable always select mode or
15014     * @c EINA_FALSE to disable it.
15015     *
15016     * @note Always select mode is disabled by default.
15017     *
15018     * Default behavior of list items is to only call its callback function
15019     * the first time it's pressed, i.e., when it is selected. If a selected
15020     * item is pressed again, and multi-select is disabled, it won't call
15021     * this function (if multi-select is enabled it will unselect the item).
15022     *
15023     * If always select is enabled, it will call the callback function
15024     * everytime a item is pressed, so it will call when the item is selected,
15025     * and again when a selected item is pressed.
15026     *
15027     * @see elm_list_always_select_mode_get()
15028     * @see elm_list_multi_select_set()
15029     *
15030     * @ingroup List
15031     */
15032    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15033
15034    /**
15035     * Get a value whether always select mode is enabled or not, meaning that
15036     * an item will always call its callback function, even if already selected.
15037     *
15038     * @param obj The list object
15039     * @return @c EINA_TRUE means horizontal mode selection is enabled.
15040     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15041     * @c EINA_FALSE is returned.
15042     *
15043     * @see elm_list_always_select_mode_set() for details.
15044     *
15045     * @ingroup List
15046     */
15047    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15048
15049    /**
15050     * Set bouncing behaviour when the scrolled content reaches an edge.
15051     *
15052     * Tell the internal scroller object whether it should bounce or not
15053     * when it reaches the respective edges for each axis.
15054     *
15055     * @param obj The list object
15056     * @param h_bounce Whether to bounce or not in the horizontal axis.
15057     * @param v_bounce Whether to bounce or not in the vertical axis.
15058     *
15059     * @see elm_scroller_bounce_set()
15060     *
15061     * @ingroup List
15062     */
15063    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
15064
15065    /**
15066     * Get the bouncing behaviour of the internal scroller.
15067     *
15068     * Get whether the internal scroller should bounce when the edge of each
15069     * axis is reached scrolling.
15070     *
15071     * @param obj The list object.
15072     * @param h_bounce Pointer where to store the bounce state of the horizontal
15073     * axis.
15074     * @param v_bounce Pointer where to store the bounce state of the vertical
15075     * axis.
15076     *
15077     * @see elm_scroller_bounce_get()
15078     * @see elm_list_bounce_set()
15079     *
15080     * @ingroup List
15081     */
15082    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
15083
15084    /**
15085     * Set the scrollbar policy.
15086     *
15087     * @param obj The list object
15088     * @param policy_h Horizontal scrollbar policy.
15089     * @param policy_v Vertical scrollbar policy.
15090     *
15091     * This sets the scrollbar visibility policy for the given scroller.
15092     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
15093     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
15094     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
15095     * This applies respectively for the horizontal and vertical scrollbars.
15096     *
15097     * The both are disabled by default, i.e., are set to
15098     * #ELM_SCROLLER_POLICY_OFF.
15099     *
15100     * @ingroup List
15101     */
15102    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
15103
15104    /**
15105     * Get the scrollbar policy.
15106     *
15107     * @see elm_list_scroller_policy_get() for details.
15108     *
15109     * @param obj The list object.
15110     * @param policy_h Pointer where to store horizontal scrollbar policy.
15111     * @param policy_v Pointer where to store vertical scrollbar policy.
15112     *
15113     * @ingroup List
15114     */
15115    EAPI void             elm_list_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
15116
15117    /**
15118     * Append a new item to the list object.
15119     *
15120     * @param obj The list object.
15121     * @param label The label of the list item.
15122     * @param icon The icon object to use for the left side of the item. An
15123     * icon can be any Evas object, but usually it is an icon created
15124     * with elm_icon_add().
15125     * @param end The icon object to use for the right side of the item. An
15126     * icon can be any Evas object.
15127     * @param func The function to call when the item is clicked.
15128     * @param data The data to associate with the item for related callbacks.
15129     *
15130     * @return The created item or @c NULL upon failure.
15131     *
15132     * A new item will be created and appended to the list, i.e., will
15133     * be set as @b last item.
15134     *
15135     * Items created with this method can be deleted with
15136     * elm_list_item_del().
15137     *
15138     * Associated @p data can be properly freed when item is deleted if a
15139     * callback function is set with elm_list_item_del_cb_set().
15140     *
15141     * If a function is passed as argument, it will be called everytime this item
15142     * is selected, i.e., the user clicks over an unselected item.
15143     * If always select is enabled it will call this function every time
15144     * user clicks over an item (already selected or not).
15145     * If such function isn't needed, just passing
15146     * @c NULL as @p func is enough. The same should be done for @p data.
15147     *
15148     * Simple example (with no function callback or data associated):
15149     * @code
15150     * li = elm_list_add(win);
15151     * ic = elm_icon_add(win);
15152     * elm_icon_file_set(ic, "path/to/image", NULL);
15153     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
15154     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
15155     * elm_list_go(li);
15156     * evas_object_show(li);
15157     * @endcode
15158     *
15159     * @see elm_list_always_select_mode_set()
15160     * @see elm_list_item_del()
15161     * @see elm_list_item_del_cb_set()
15162     * @see elm_list_clear()
15163     * @see elm_icon_add()
15164     *
15165     * @ingroup List
15166     */
15167    EAPI Elm_List_Item   *elm_list_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15168
15169    /**
15170     * Prepend a new item to the list object.
15171     *
15172     * @param obj The list object.
15173     * @param label The label of the list item.
15174     * @param icon The icon object to use for the left side of the item. An
15175     * icon can be any Evas object, but usually it is an icon created
15176     * with elm_icon_add().
15177     * @param end The icon object to use for the right side of the item. An
15178     * icon can be any Evas object.
15179     * @param func The function to call when the item is clicked.
15180     * @param data The data to associate with the item for related callbacks.
15181     *
15182     * @return The created item or @c NULL upon failure.
15183     *
15184     * A new item will be created and prepended to the list, i.e., will
15185     * be set as @b first item.
15186     *
15187     * Items created with this method can be deleted with
15188     * elm_list_item_del().
15189     *
15190     * Associated @p data can be properly freed when item is deleted if a
15191     * callback function is set with elm_list_item_del_cb_set().
15192     *
15193     * If a function is passed as argument, it will be called everytime this item
15194     * is selected, i.e., the user clicks over an unselected item.
15195     * If always select is enabled it will call this function every time
15196     * user clicks over an item (already selected or not).
15197     * If such function isn't needed, just passing
15198     * @c NULL as @p func is enough. The same should be done for @p data.
15199     *
15200     * @see elm_list_item_append() for a simple code example.
15201     * @see elm_list_always_select_mode_set()
15202     * @see elm_list_item_del()
15203     * @see elm_list_item_del_cb_set()
15204     * @see elm_list_clear()
15205     * @see elm_icon_add()
15206     *
15207     * @ingroup List
15208     */
15209    EAPI Elm_List_Item   *elm_list_item_prepend(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
15210
15211    /**
15212     * Insert a new item into the list object before item @p before.
15213     *
15214     * @param obj The list object.
15215     * @param before The list item to insert before.
15216     * @param label The label of the list item.
15217     * @param icon The icon object to use for the left side of the item. An
15218     * icon can be any Evas object, but usually it is an icon created
15219     * with elm_icon_add().
15220     * @param end The icon object to use for the right side of the item. An
15221     * icon can be any Evas object.
15222     * @param func The function to call when the item is clicked.
15223     * @param data The data to associate with the item for related callbacks.
15224     *
15225     * @return The created item or @c NULL upon failure.
15226     *
15227     * A new item will be created and added to the list. Its position in
15228     * this list will be just before item @p before.
15229     *
15230     * Items created with this method can be deleted with
15231     * elm_list_item_del().
15232     *
15233     * Associated @p data can be properly freed when item is deleted if a
15234     * callback function is set with elm_list_item_del_cb_set().
15235     *
15236     * If a function is passed as argument, it will be called everytime this item
15237     * is selected, i.e., the user clicks over an unselected item.
15238     * If always select is enabled it will call this function every time
15239     * user clicks over an item (already selected or not).
15240     * If such function isn't needed, just passing
15241     * @c NULL as @p func is enough. The same should be done for @p data.
15242     *
15243     * @see elm_list_item_append() for a simple code example.
15244     * @see elm_list_always_select_mode_set()
15245     * @see elm_list_item_del()
15246     * @see elm_list_item_del_cb_set()
15247     * @see elm_list_clear()
15248     * @see elm_icon_add()
15249     *
15250     * @ingroup List
15251     */
15252    EAPI Elm_List_Item   *elm_list_item_insert_before(Evas_Object *obj, Elm_List_Item *before, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
15253
15254    /**
15255     * Insert a new item into the list object after item @p after.
15256     *
15257     * @param obj The list object.
15258     * @param after The list item to insert after.
15259     * @param label The label of the list item.
15260     * @param icon The icon object to use for the left side of the item. An
15261     * icon can be any Evas object, but usually it is an icon created
15262     * with elm_icon_add().
15263     * @param end The icon object to use for the right side of the item. An
15264     * icon can be any Evas object.
15265     * @param func The function to call when the item is clicked.
15266     * @param data The data to associate with the item for related callbacks.
15267     *
15268     * @return The created item or @c NULL upon failure.
15269     *
15270     * A new item will be created and added to the list. Its position in
15271     * this list will be just after item @p after.
15272     *
15273     * Items created with this method can be deleted with
15274     * elm_list_item_del().
15275     *
15276     * Associated @p data can be properly freed when item is deleted if a
15277     * callback function is set with elm_list_item_del_cb_set().
15278     *
15279     * If a function is passed as argument, it will be called everytime this item
15280     * is selected, i.e., the user clicks over an unselected item.
15281     * If always select is enabled it will call this function every time
15282     * user clicks over an item (already selected or not).
15283     * If such function isn't needed, just passing
15284     * @c NULL as @p func is enough. The same should be done for @p data.
15285     *
15286     * @see elm_list_item_append() for a simple code example.
15287     * @see elm_list_always_select_mode_set()
15288     * @see elm_list_item_del()
15289     * @see elm_list_item_del_cb_set()
15290     * @see elm_list_clear()
15291     * @see elm_icon_add()
15292     *
15293     * @ingroup List
15294     */
15295    EAPI Elm_List_Item   *elm_list_item_insert_after(Evas_Object *obj, Elm_List_Item *after, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
15296
15297    /**
15298     * Insert a new item into the sorted list object.
15299     *
15300     * @param obj The list object.
15301     * @param label The label of the list item.
15302     * @param icon The icon object to use for the left side of the item. An
15303     * icon can be any Evas object, but usually it is an icon created
15304     * with elm_icon_add().
15305     * @param end The icon object to use for the right side of the item. An
15306     * icon can be any Evas object.
15307     * @param func The function to call when the item is clicked.
15308     * @param data The data to associate with the item for related callbacks.
15309     * @param cmp_func The comparing function to be used to sort list
15310     * items <b>by #Elm_List_Item item handles</b>. This function will
15311     * receive two items and compare them, returning a non-negative integer
15312     * if the second item should be place after the first, or negative value
15313     * if should be placed before.
15314     *
15315     * @return The created item or @c NULL upon failure.
15316     *
15317     * @note This function inserts values into a list object assuming it was
15318     * sorted and the result will be sorted.
15319     *
15320     * A new item will be created and added to the list. Its position in
15321     * this list will be found comparing the new item with previously inserted
15322     * items using function @p cmp_func.
15323     *
15324     * Items created with this method can be deleted with
15325     * elm_list_item_del().
15326     *
15327     * Associated @p data can be properly freed when item is deleted if a
15328     * callback function is set with elm_list_item_del_cb_set().
15329     *
15330     * If a function is passed as argument, it will be called everytime this item
15331     * is selected, i.e., the user clicks over an unselected item.
15332     * If always select is enabled it will call this function every time
15333     * user clicks over an item (already selected or not).
15334     * If such function isn't needed, just passing
15335     * @c NULL as @p func is enough. The same should be done for @p data.
15336     *
15337     * @see elm_list_item_append() for a simple code example.
15338     * @see elm_list_always_select_mode_set()
15339     * @see elm_list_item_del()
15340     * @see elm_list_item_del_cb_set()
15341     * @see elm_list_clear()
15342     * @see elm_icon_add()
15343     *
15344     * @ingroup List
15345     */
15346    EAPI Elm_List_Item   *elm_list_item_sorted_insert(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Object *end, Evas_Smart_Cb func, const void *data, Eina_Compare_Cb cmp_func) EINA_ARG_NONNULL(1);
15347
15348    /**
15349     * Remove all list's items.
15350     *
15351     * @param obj The list object
15352     *
15353     * @see elm_list_item_del()
15354     * @see elm_list_item_append()
15355     *
15356     * @ingroup List
15357     */
15358    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15359
15360    /**
15361     * Get a list of all the list items.
15362     *
15363     * @param obj The list object
15364     * @return An @c Eina_List of list items, #Elm_List_Item,
15365     * or @c NULL on failure.
15366     *
15367     * @see elm_list_item_append()
15368     * @see elm_list_item_del()
15369     * @see elm_list_clear()
15370     *
15371     * @ingroup List
15372     */
15373    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15374
15375    /**
15376     * Get the selected item.
15377     *
15378     * @param obj The list object.
15379     * @return The selected list item.
15380     *
15381     * The selected item can be unselected with function
15382     * elm_list_item_selected_set().
15383     *
15384     * The selected item always will be highlighted on list.
15385     *
15386     * @see elm_list_selected_items_get()
15387     *
15388     * @ingroup List
15389     */
15390    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15391
15392    /**
15393     * Return a list of the currently selected list items.
15394     *
15395     * @param obj The list object.
15396     * @return An @c Eina_List of list items, #Elm_List_Item,
15397     * or @c NULL on failure.
15398     *
15399     * Multiple items can be selected if multi select is enabled. It can be
15400     * done with elm_list_multi_select_set().
15401     *
15402     * @see elm_list_selected_item_get()
15403     * @see elm_list_multi_select_set()
15404     *
15405     * @ingroup List
15406     */
15407    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15408
15409    /**
15410     * Set the selected state of an item.
15411     *
15412     * @param item The list item
15413     * @param selected The selected state
15414     *
15415     * This sets the selected state of the given item @p it.
15416     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15417     *
15418     * If a new item is selected the previosly selected will be unselected,
15419     * unless multiple selection is enabled with elm_list_multi_select_set().
15420     * Previoulsy selected item can be get with function
15421     * elm_list_selected_item_get().
15422     *
15423     * Selected items will be highlighted.
15424     *
15425     * @see elm_list_item_selected_get()
15426     * @see elm_list_selected_item_get()
15427     * @see elm_list_multi_select_set()
15428     *
15429     * @ingroup List
15430     */
15431    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15432
15433    /*
15434     * Get whether the @p item is selected or not.
15435     *
15436     * @param item The list item.
15437     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15438     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15439     *
15440     * @see elm_list_selected_item_set() for details.
15441     * @see elm_list_item_selected_get()
15442     *
15443     * @ingroup List
15444     */
15445    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15446
15447    /**
15448     * Set or unset item as a separator.
15449     *
15450     * @param it The list item.
15451     * @param setting @c EINA_TRUE to set item @p it as separator or
15452     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15453     *
15454     * Items aren't set as separator by default.
15455     *
15456     * If set as separator it will display separator theme, so won't display
15457     * icons or label.
15458     *
15459     * @see elm_list_item_separator_get()
15460     *
15461     * @ingroup List
15462     */
15463    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15464
15465    /**
15466     * Get a value whether item is a separator or not.
15467     *
15468     * @see elm_list_item_separator_set() for details.
15469     *
15470     * @param it The list item.
15471     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15472     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15473     *
15474     * @ingroup List
15475     */
15476    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15477
15478    /**
15479     * Show @p item in the list view.
15480     *
15481     * @param item The list item to be shown.
15482     *
15483     * It won't animate list until item is visible. If such behavior is wanted,
15484     * use elm_list_bring_in() intead.
15485     *
15486     * @ingroup List
15487     */
15488    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15489
15490    /**
15491     * Bring in the given item to list view.
15492     *
15493     * @param item The item.
15494     *
15495     * This causes list to jump to the given item @p item and show it
15496     * (by scrolling), if it is not fully visible.
15497     *
15498     * This may use animation to do so and take a period of time.
15499     *
15500     * If animation isn't wanted, elm_list_item_show() can be used.
15501     *
15502     * @ingroup List
15503     */
15504    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15505
15506    /**
15507     * Delete them item from the list.
15508     *
15509     * @param item The item of list to be deleted.
15510     *
15511     * If deleting all list items is required, elm_list_clear()
15512     * should be used instead of getting items list and deleting each one.
15513     *
15514     * @see elm_list_clear()
15515     * @see elm_list_item_append()
15516     * @see elm_list_item_del_cb_set()
15517     *
15518     * @ingroup List
15519     */
15520    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15521
15522    /**
15523     * Set the function called when a list item is freed.
15524     *
15525     * @param item The item to set the callback on
15526     * @param func The function called
15527     *
15528     * If there is a @p func, then it will be called prior item's memory release.
15529     * That will be called with the following arguments:
15530     * @li item's data;
15531     * @li item's Evas object;
15532     * @li item itself;
15533     *
15534     * This way, a data associated to a list item could be properly freed.
15535     *
15536     * @ingroup List
15537     */
15538    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15539
15540    /**
15541     * Get the data associated to the item.
15542     *
15543     * @param item The list item
15544     * @return The data associated to @p item
15545     *
15546     * The return value is a pointer to data associated to @p item when it was
15547     * created, with function elm_list_item_append() or similar. If no data
15548     * was passed as argument, it will return @c NULL.
15549     *
15550     * @see elm_list_item_append()
15551     *
15552     * @ingroup List
15553     */
15554    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15555
15556    /**
15557     * Get the left side icon associated to the item.
15558     *
15559     * @param item The list item
15560     * @return The left side icon associated to @p item
15561     *
15562     * The return value is a pointer to the icon associated to @p item when
15563     * it was
15564     * created, with function elm_list_item_append() or similar, or later
15565     * with function elm_list_item_icon_set(). If no icon
15566     * was passed as argument, it will return @c NULL.
15567     *
15568     * @see elm_list_item_append()
15569     * @see elm_list_item_icon_set()
15570     *
15571     * @ingroup List
15572     */
15573    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15574
15575    /**
15576     * Set the left side icon associated to the item.
15577     *
15578     * @param item The list item
15579     * @param icon The left side icon object to associate with @p item
15580     *
15581     * The icon object to use at left side of the item. An
15582     * icon can be any Evas object, but usually it is an icon created
15583     * with elm_icon_add().
15584     *
15585     * Once the icon object is set, a previously set one will be deleted.
15586     * @warning Setting the same icon for two items will cause the icon to
15587     * dissapear from the first item.
15588     *
15589     * If an icon was passed as argument on item creation, with function
15590     * elm_list_item_append() or similar, it will be already
15591     * associated to the item.
15592     *
15593     * @see elm_list_item_append()
15594     * @see elm_list_item_icon_get()
15595     *
15596     * @ingroup List
15597     */
15598    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15599
15600    /**
15601     * Get the right side icon associated to the item.
15602     *
15603     * @param item The list item
15604     * @return The right side icon associated to @p item
15605     *
15606     * The return value is a pointer to the icon associated to @p item when
15607     * it was
15608     * created, with function elm_list_item_append() or similar, or later
15609     * with function elm_list_item_icon_set(). If no icon
15610     * was passed as argument, it will return @c NULL.
15611     *
15612     * @see elm_list_item_append()
15613     * @see elm_list_item_icon_set()
15614     *
15615     * @ingroup List
15616     */
15617    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15618
15619    /**
15620     * Set the right side icon associated to the item.
15621     *
15622     * @param item The list item
15623     * @param end The right side icon object to associate with @p item
15624     *
15625     * The icon object to use at right side of the item. An
15626     * icon can be any Evas object, but usually it is an icon created
15627     * with elm_icon_add().
15628     *
15629     * Once the icon object is set, a previously set one will be deleted.
15630     * @warning Setting the same icon for two items will cause the icon to
15631     * dissapear from the first item.
15632     *
15633     * If an icon was passed as argument on item creation, with function
15634     * elm_list_item_append() or similar, it will be already
15635     * associated to the item.
15636     *
15637     * @see elm_list_item_append()
15638     * @see elm_list_item_end_get()
15639     *
15640     * @ingroup List
15641     */
15642    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15643
15644    /**
15645     * Gets the base object of the item.
15646     *
15647     * @param item The list item
15648     * @return The base object associated with @p item
15649     *
15650     * Base object is the @c Evas_Object that represents that item.
15651     *
15652     * @ingroup List
15653     */
15654    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15655    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15656
15657    /**
15658     * Get the label of item.
15659     *
15660     * @param item The item of list.
15661     * @return The label of item.
15662     *
15663     * The return value is a pointer to the label associated to @p item when
15664     * it was created, with function elm_list_item_append(), or later
15665     * with function elm_list_item_label_set. If no label
15666     * was passed as argument, it will return @c NULL.
15667     *
15668     * @see elm_list_item_label_set() for more details.
15669     * @see elm_list_item_append()
15670     *
15671     * @ingroup List
15672     */
15673    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15674
15675    /**
15676     * Set the label of item.
15677     *
15678     * @param item The item of list.
15679     * @param text The label of item.
15680     *
15681     * The label to be displayed by the item.
15682     * Label will be placed between left and right side icons (if set).
15683     *
15684     * If a label was passed as argument on item creation, with function
15685     * elm_list_item_append() or similar, it will be already
15686     * displayed by the item.
15687     *
15688     * @see elm_list_item_label_get()
15689     * @see elm_list_item_append()
15690     *
15691     * @ingroup List
15692     */
15693    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15694
15695
15696    /**
15697     * Get the item before @p it in list.
15698     *
15699     * @param it The list item.
15700     * @return The item before @p it, or @c NULL if none or on failure.
15701     *
15702     * @note If it is the first item, @c NULL will be returned.
15703     *
15704     * @see elm_list_item_append()
15705     * @see elm_list_items_get()
15706     *
15707     * @ingroup List
15708     */
15709    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15710
15711    /**
15712     * Get the item after @p it in list.
15713     *
15714     * @param it The list item.
15715     * @return The item after @p it, or @c NULL if none or on failure.
15716     *
15717     * @note If it is the last item, @c NULL will be returned.
15718     *
15719     * @see elm_list_item_append()
15720     * @see elm_list_items_get()
15721     *
15722     * @ingroup List
15723     */
15724    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15725
15726    /**
15727     * Sets the disabled/enabled state of a list item.
15728     *
15729     * @param it The item.
15730     * @param disabled The disabled state.
15731     *
15732     * A disabled item cannot be selected or unselected. It will also
15733     * change its appearance (generally greyed out). This sets the
15734     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15735     * enabled).
15736     *
15737     * @ingroup List
15738     */
15739    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15740
15741    /**
15742     * Get a value whether list item is disabled or not.
15743     *
15744     * @param it The item.
15745     * @return The disabled state.
15746     *
15747     * @see elm_list_item_disabled_set() for more details.
15748     *
15749     * @ingroup List
15750     */
15751    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15752
15753    /**
15754     * Set the text to be shown in a given list item's tooltips.
15755     *
15756     * @param item Target item.
15757     * @param text The text to set in the content.
15758     *
15759     * Setup the text as tooltip to object. The item can have only one tooltip,
15760     * so any previous tooltip data - set with this function or
15761     * elm_list_item_tooltip_content_cb_set() - is removed.
15762     *
15763     * @see elm_object_tooltip_text_set() for more details.
15764     *
15765     * @ingroup List
15766     */
15767    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15768
15769
15770    /**
15771     * @brief Disable size restrictions on an object's tooltip
15772     * @param item The tooltip's anchor object
15773     * @param disable If EINA_TRUE, size restrictions are disabled
15774     * @return EINA_FALSE on failure, EINA_TRUE on success
15775     *
15776     * This function allows a tooltip to expand beyond its parant window's canvas.
15777     * It will instead be limited only by the size of the display.
15778     */
15779    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15780    /**
15781     * @brief Retrieve size restriction state of an object's tooltip
15782     * @param obj The tooltip's anchor object
15783     * @return If EINA_TRUE, size restrictions are disabled
15784     *
15785     * This function returns whether a tooltip is allowed to expand beyond
15786     * its parant window's canvas.
15787     * It will instead be limited only by the size of the display.
15788     */
15789    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15790
15791    /**
15792     * Set the content to be shown in the tooltip item.
15793     *
15794     * Setup the tooltip to item. The item can have only one tooltip,
15795     * so any previous tooltip data is removed. @p func(with @p data) will
15796     * be called every time that need show the tooltip and it should
15797     * return a valid Evas_Object. This object is then managed fully by
15798     * tooltip system and is deleted when the tooltip is gone.
15799     *
15800     * @param item the list item being attached a tooltip.
15801     * @param func the function used to create the tooltip contents.
15802     * @param data what to provide to @a func as callback data/context.
15803     * @param del_cb called when data is not needed anymore, either when
15804     *        another callback replaces @a func, the tooltip is unset with
15805     *        elm_list_item_tooltip_unset() or the owner @a item
15806     *        dies. This callback receives as the first parameter the
15807     *        given @a data, and @c event_info is the item.
15808     *
15809     * @see elm_object_tooltip_content_cb_set() for more details.
15810     *
15811     * @ingroup List
15812     */
15813    EAPI void             elm_list_item_tooltip_content_cb_set(Elm_List_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
15814
15815    /**
15816     * Unset tooltip from item.
15817     *
15818     * @param item list item to remove previously set tooltip.
15819     *
15820     * Remove tooltip from item. The callback provided as del_cb to
15821     * elm_list_item_tooltip_content_cb_set() will be called to notify
15822     * it is not used anymore.
15823     *
15824     * @see elm_object_tooltip_unset() for more details.
15825     * @see elm_list_item_tooltip_content_cb_set()
15826     *
15827     * @ingroup List
15828     */
15829    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15830
15831    /**
15832     * Sets a different style for this item tooltip.
15833     *
15834     * @note before you set a style you should define a tooltip with
15835     *       elm_list_item_tooltip_content_cb_set() or
15836     *       elm_list_item_tooltip_text_set()
15837     *
15838     * @param item list item with tooltip already set.
15839     * @param style the theme style to use (default, transparent, ...)
15840     *
15841     * @see elm_object_tooltip_style_set() for more details.
15842     *
15843     * @ingroup List
15844     */
15845    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15846
15847    /**
15848     * Get the style for this item tooltip.
15849     *
15850     * @param item list item with tooltip already set.
15851     * @return style the theme style in use, defaults to "default". If the
15852     *         object does not have a tooltip set, then NULL is returned.
15853     *
15854     * @see elm_object_tooltip_style_get() for more details.
15855     * @see elm_list_item_tooltip_style_set()
15856     *
15857     * @ingroup List
15858     */
15859    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15860
15861    /**
15862     * Set the type of mouse pointer/cursor decoration to be shown,
15863     * when the mouse pointer is over the given list widget item
15864     *
15865     * @param item list item to customize cursor on
15866     * @param cursor the cursor type's name
15867     *
15868     * This function works analogously as elm_object_cursor_set(), but
15869     * here the cursor's changing area is restricted to the item's
15870     * area, and not the whole widget's. Note that that item cursors
15871     * have precedence over widget cursors, so that a mouse over an
15872     * item with custom cursor set will always show @b that cursor.
15873     *
15874     * If this function is called twice for an object, a previously set
15875     * cursor will be unset on the second call.
15876     *
15877     * @see elm_object_cursor_set()
15878     * @see elm_list_item_cursor_get()
15879     * @see elm_list_item_cursor_unset()
15880     *
15881     * @ingroup List
15882     */
15883    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15884
15885    /*
15886     * Get the type of mouse pointer/cursor decoration set to be shown,
15887     * when the mouse pointer is over the given list widget item
15888     *
15889     * @param item list item with custom cursor set
15890     * @return the cursor type's name or @c NULL, if no custom cursors
15891     * were set to @p item (and on errors)
15892     *
15893     * @see elm_object_cursor_get()
15894     * @see elm_list_item_cursor_set()
15895     * @see elm_list_item_cursor_unset()
15896     *
15897     * @ingroup List
15898     */
15899    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15900
15901    /**
15902     * Unset any custom mouse pointer/cursor decoration set to be
15903     * shown, when the mouse pointer is over the given list widget
15904     * item, thus making it show the @b default cursor again.
15905     *
15906     * @param item a list item
15907     *
15908     * Use this call to undo any custom settings on this item's cursor
15909     * decoration, bringing it back to defaults (no custom style set).
15910     *
15911     * @see elm_object_cursor_unset()
15912     * @see elm_list_item_cursor_set()
15913     *
15914     * @ingroup List
15915     */
15916    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15917
15918    /**
15919     * Set a different @b style for a given custom cursor set for a
15920     * list item.
15921     *
15922     * @param item list item with custom cursor set
15923     * @param style the <b>theme style</b> to use (e.g. @c "default",
15924     * @c "transparent", etc)
15925     *
15926     * This function only makes sense when one is using custom mouse
15927     * cursor decorations <b>defined in a theme file</b>, which can have,
15928     * given a cursor name/type, <b>alternate styles</b> on it. It
15929     * works analogously as elm_object_cursor_style_set(), but here
15930     * applyed only to list item objects.
15931     *
15932     * @warning Before you set a cursor style you should have definen a
15933     *       custom cursor previously on the item, with
15934     *       elm_list_item_cursor_set()
15935     *
15936     * @see elm_list_item_cursor_engine_only_set()
15937     * @see elm_list_item_cursor_style_get()
15938     *
15939     * @ingroup List
15940     */
15941    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15942
15943    /**
15944     * Get the current @b style set for a given list item's custom
15945     * cursor
15946     *
15947     * @param item list item with custom cursor set.
15948     * @return style the cursor style in use. If the object does not
15949     *         have a cursor set, then @c NULL is returned.
15950     *
15951     * @see elm_list_item_cursor_style_set() for more details
15952     *
15953     * @ingroup List
15954     */
15955    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15956
15957    /**
15958     * Set if the (custom)cursor for a given list item should be
15959     * searched in its theme, also, or should only rely on the
15960     * rendering engine.
15961     *
15962     * @param item item with custom (custom) cursor already set on
15963     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15964     * only on those provided by the rendering engine, @c EINA_FALSE to
15965     * have them searched on the widget's theme, as well.
15966     *
15967     * @note This call is of use only if you've set a custom cursor
15968     * for list items, with elm_list_item_cursor_set().
15969     *
15970     * @note By default, cursors will only be looked for between those
15971     * provided by the rendering engine.
15972     *
15973     * @ingroup List
15974     */
15975    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15976
15977    /**
15978     * Get if the (custom) cursor for a given list item is being
15979     * searched in its theme, also, or is only relying on the rendering
15980     * engine.
15981     *
15982     * @param item a list item
15983     * @return @c EINA_TRUE, if cursors are being looked for only on
15984     * those provided by the rendering engine, @c EINA_FALSE if they
15985     * are being searched on the widget's theme, as well.
15986     *
15987     * @see elm_list_item_cursor_engine_only_set(), for more details
15988     *
15989     * @ingroup List
15990     */
15991    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15992
15993    /**
15994     * @}
15995     */
15996
15997    /**
15998     * @defgroup Slider Slider
15999     * @ingroup Elementary
16000     *
16001     * @image html img/widget/slider/preview-00.png
16002     * @image latex img/widget/slider/preview-00.eps width=\textwidth
16003     *
16004     * The slider adds a dragable “slider” widget for selecting the value of
16005     * something within a range.
16006     *
16007     * A slider can be horizontal or vertical. It can contain an Icon and has a
16008     * primary label as well as a units label (that is formatted with floating
16009     * point values and thus accepts a printf-style format string, like
16010     * “%1.2f units”. There is also an indicator string that may be somewhere
16011     * else (like on the slider itself) that also accepts a format string like
16012     * units. Label, Icon Unit and Indicator strings/objects are optional.
16013     *
16014     * A slider may be inverted which means values invert, with high vales being
16015     * on the left or top and low values on the right or bottom (as opposed to
16016     * normally being low on the left or top and high on the bottom and right).
16017     *
16018     * The slider should have its minimum and maximum values set by the
16019     * application with  elm_slider_min_max_set() and value should also be set by
16020     * the application before use with  elm_slider_value_set(). The span of the
16021     * slider is its length (horizontally or vertically). This will be scaled by
16022     * the object or applications scaling factor. At any point code can query the
16023     * slider for its value with elm_slider_value_get().
16024     *
16025     * Smart callbacks one can listen to:
16026     * - "changed" - Whenever the slider value is changed by the user.
16027     * - "slider,drag,start" - dragging the slider indicator around has started.
16028     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16029     * - "delay,changed" - A short time after the value is changed by the user.
16030     * This will be called only when the user stops dragging for
16031     * a very short period or when they release their
16032     * finger/mouse, so it avoids possibly expensive reactions to
16033     * the value change.
16034     *
16035     * Available styles for it:
16036     * - @c "default"
16037     *
16038     * Here is an example on its usage:
16039     * @li @ref slider_example
16040     */
16041
16042    /**
16043     * @addtogroup Slider
16044     * @{
16045     */
16046
16047    /**
16048     * Add a new slider widget to the given parent Elementary
16049     * (container) object.
16050     *
16051     * @param parent The parent object.
16052     * @return a new slider widget handle or @c NULL, on errors.
16053     *
16054     * This function inserts a new slider widget on the canvas.
16055     *
16056     * @ingroup Slider
16057     */
16058    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16059
16060    /**
16061     * Set the label of a given slider widget
16062     *
16063     * @param obj The progress bar object
16064     * @param label The text label string, in UTF-8
16065     *
16066     * @ingroup Slider
16067     * @deprecated use elm_object_text_set() instead.
16068     */
16069    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16070
16071    /**
16072     * Get the label of a given slider widget
16073     *
16074     * @param obj The progressbar object
16075     * @return The text label string, in UTF-8
16076     *
16077     * @ingroup Slider
16078     * @deprecated use elm_object_text_get() instead.
16079     */
16080    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16081
16082    /**
16083     * Set the icon object of the slider object.
16084     *
16085     * @param obj The slider object.
16086     * @param icon The icon object.
16087     *
16088     * On horizontal mode, icon is placed at left, and on vertical mode,
16089     * placed at top.
16090     *
16091     * @note Once the icon object is set, a previously set one will be deleted.
16092     * If you want to keep that old content object, use the
16093     * elm_slider_icon_unset() function.
16094     *
16095     * @warning If the object being set does not have minimum size hints set,
16096     * it won't get properly displayed.
16097     *
16098     * @ingroup Slider
16099     */
16100    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
16101
16102    /**
16103     * Unset an icon set on a given slider widget.
16104     *
16105     * @param obj The slider object.
16106     * @return The icon object that was being used, if any was set, or
16107     * @c NULL, otherwise (and on errors).
16108     *
16109     * On horizontal mode, icon is placed at left, and on vertical mode,
16110     * placed at top.
16111     *
16112     * This call will unparent and return the icon object which was set
16113     * for this widget, previously, on success.
16114     *
16115     * @see elm_slider_icon_set() for more details
16116     * @see elm_slider_icon_get()
16117     *
16118     * @ingroup Slider
16119     */
16120    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16121
16122    /**
16123     * Retrieve the icon object set for a given slider widget.
16124     *
16125     * @param obj The slider object.
16126     * @return The icon object's handle, if @p obj had one set, or @c NULL,
16127     * otherwise (and on errors).
16128     *
16129     * On horizontal mode, icon is placed at left, and on vertical mode,
16130     * placed at top.
16131     *
16132     * @see elm_slider_icon_set() for more details
16133     * @see elm_slider_icon_unset()
16134     *
16135     * @ingroup Slider
16136     */
16137    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16138
16139    /**
16140     * Set the end object of the slider object.
16141     *
16142     * @param obj The slider object.
16143     * @param end The end object.
16144     *
16145     * On horizontal mode, end is placed at left, and on vertical mode,
16146     * placed at bottom.
16147     *
16148     * @note Once the icon object is set, a previously set one will be deleted.
16149     * If you want to keep that old content object, use the
16150     * elm_slider_end_unset() function.
16151     *
16152     * @warning If the object being set does not have minimum size hints set,
16153     * it won't get properly displayed.
16154     *
16155     * @ingroup Slider
16156     */
16157    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
16158
16159    /**
16160     * Unset an end object set on a given slider widget.
16161     *
16162     * @param obj The slider object.
16163     * @return The end object that was being used, if any was set, or
16164     * @c NULL, otherwise (and on errors).
16165     *
16166     * On horizontal mode, end is placed at left, and on vertical mode,
16167     * placed at bottom.
16168     *
16169     * This call will unparent and return the icon object which was set
16170     * for this widget, previously, on success.
16171     *
16172     * @see elm_slider_end_set() for more details.
16173     * @see elm_slider_end_get()
16174     *
16175     * @ingroup Slider
16176     */
16177    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
16178
16179    /**
16180     * Retrieve the end object set for a given slider widget.
16181     *
16182     * @param obj The slider object.
16183     * @return The end object's handle, if @p obj had one set, or @c NULL,
16184     * otherwise (and on errors).
16185     *
16186     * On horizontal mode, icon is placed at right, and on vertical mode,
16187     * placed at bottom.
16188     *
16189     * @see elm_slider_end_set() for more details.
16190     * @see elm_slider_end_unset()
16191     *
16192     * @ingroup Slider
16193     */
16194    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16195
16196    /**
16197     * Set the (exact) length of the bar region of a given slider widget.
16198     *
16199     * @param obj The slider object.
16200     * @param size The length of the slider's bar region.
16201     *
16202     * This sets the minimum width (when in horizontal mode) or height
16203     * (when in vertical mode) of the actual bar area of the slider
16204     * @p obj. This in turn affects the object's minimum size. Use
16205     * this when you're not setting other size hints expanding on the
16206     * given direction (like weight and alignment hints) and you would
16207     * like it to have a specific size.
16208     *
16209     * @note Icon, end, label, indicator and unit text around @p obj
16210     * will require their
16211     * own space, which will make @p obj to require more the @p size,
16212     * actually.
16213     *
16214     * @see elm_slider_span_size_get()
16215     *
16216     * @ingroup Slider
16217     */
16218    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
16219
16220    /**
16221     * Get the length set for the bar region of a given slider widget
16222     *
16223     * @param obj The slider object.
16224     * @return The length of the slider's bar region.
16225     *
16226     * If that size was not set previously, with
16227     * elm_slider_span_size_set(), this call will return @c 0.
16228     *
16229     * @ingroup Slider
16230     */
16231    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16232
16233    /**
16234     * Set the format string for the unit label.
16235     *
16236     * @param obj The slider object.
16237     * @param format The format string for the unit display.
16238     *
16239     * Unit label is displayed all the time, if set, after slider's bar.
16240     * In horizontal mode, at right and in vertical mode, at bottom.
16241     *
16242     * If @c NULL, unit label won't be visible. If not it sets the format
16243     * string for the label text. To the label text is provided a floating point
16244     * value, so the label text can display up to 1 floating point value.
16245     * Note that this is optional.
16246     *
16247     * Use a format string such as "%1.2f meters" for example, and it will
16248     * display values like: "3.14 meters" for a value equal to 3.14159.
16249     *
16250     * Default is unit label disabled.
16251     *
16252     * @see elm_slider_indicator_format_get()
16253     *
16254     * @ingroup Slider
16255     */
16256    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16257
16258    /**
16259     * Get the unit label format of the slider.
16260     *
16261     * @param obj The slider object.
16262     * @return The unit label format string in UTF-8.
16263     *
16264     * Unit label is displayed all the time, if set, after slider's bar.
16265     * In horizontal mode, at right and in vertical mode, at bottom.
16266     *
16267     * @see elm_slider_unit_format_set() for more
16268     * information on how this works.
16269     *
16270     * @ingroup Slider
16271     */
16272    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16273
16274    /**
16275     * Set the format string for the indicator label.
16276     *
16277     * @param obj The slider object.
16278     * @param indicator The format string for the indicator display.
16279     *
16280     * The slider may display its value somewhere else then unit label,
16281     * for example, above the slider knob that is dragged around. This function
16282     * sets the format string used for this.
16283     *
16284     * If @c NULL, indicator label won't be visible. If not it sets the format
16285     * string for the label text. To the label text is provided a floating point
16286     * value, so the label text can display up to 1 floating point value.
16287     * Note that this is optional.
16288     *
16289     * Use a format string such as "%1.2f meters" for example, and it will
16290     * display values like: "3.14 meters" for a value equal to 3.14159.
16291     *
16292     * Default is indicator label disabled.
16293     *
16294     * @see elm_slider_indicator_format_get()
16295     *
16296     * @ingroup Slider
16297     */
16298    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16299
16300    /**
16301     * Get the indicator label format of the slider.
16302     *
16303     * @param obj The slider object.
16304     * @return The indicator label format string in UTF-8.
16305     *
16306     * The slider may display its value somewhere else then unit label,
16307     * for example, above the slider knob that is dragged around. This function
16308     * gets the format string used for this.
16309     *
16310     * @see elm_slider_indicator_format_set() for more
16311     * information on how this works.
16312     *
16313     * @ingroup Slider
16314     */
16315    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16316
16317    /**
16318     * Set the format function pointer for the indicator label
16319     *
16320     * @param obj The slider object.
16321     * @param func The indicator format function.
16322     * @param free_func The freeing function for the format string.
16323     *
16324     * Set the callback function to format the indicator string.
16325     *
16326     * @see elm_slider_indicator_format_set() for more info on how this works.
16327     *
16328     * @ingroup Slider
16329     */
16330   EAPI void                elm_slider_indicator_format_function_set(Evas_Object *obj, const char *(*func)(double val), void (*free_func)(const char *str)) EINA_ARG_NONNULL(1);
16331
16332   /**
16333    * Set the format function pointer for the units label
16334    *
16335    * @param obj The slider object.
16336    * @param func The units format function.
16337    * @param free_func The freeing function for the format string.
16338    *
16339    * Set the callback function to format the indicator string.
16340    *
16341    * @see elm_slider_units_format_set() for more info on how this works.
16342    *
16343    * @ingroup Slider
16344    */
16345   EAPI void                elm_slider_units_format_function_set(Evas_Object *obj, const char *(*func)(double val), void (*free_func)(const char *str)) EINA_ARG_NONNULL(1);
16346
16347   /**
16348    * Set the orientation of a given slider widget.
16349    *
16350    * @param obj The slider object.
16351    * @param horizontal Use @c EINA_TRUE to make @p obj to be
16352    * @b horizontal, @c EINA_FALSE to make it @b vertical.
16353    *
16354    * Use this function to change how your slider is to be
16355    * disposed: vertically or horizontally.
16356    *
16357    * By default it's displayed horizontally.
16358    *
16359    * @see elm_slider_horizontal_get()
16360    *
16361    * @ingroup Slider
16362    */
16363    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16364
16365    /**
16366     * Retrieve the orientation of a given slider widget
16367     *
16368     * @param obj The slider object.
16369     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16370     * @c EINA_FALSE if it's @b vertical (and on errors).
16371     *
16372     * @see elm_slider_horizontal_set() for more details.
16373     *
16374     * @ingroup Slider
16375     */
16376    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16377
16378    /**
16379     * Set the minimum and maximum values for the slider.
16380     *
16381     * @param obj The slider object.
16382     * @param min The minimum value.
16383     * @param max The maximum value.
16384     *
16385     * Define the allowed range of values to be selected by the user.
16386     *
16387     * If actual value is less than @p min, it will be updated to @p min. If it
16388     * is bigger then @p max, will be updated to @p max. Actual value can be
16389     * get with elm_slider_value_get().
16390     *
16391     * By default, min is equal to 0.0, and max is equal to 1.0.
16392     *
16393     * @warning Maximum must be greater than minimum, otherwise behavior
16394     * is undefined.
16395     *
16396     * @see elm_slider_min_max_get()
16397     *
16398     * @ingroup Slider
16399     */
16400    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16401
16402    /**
16403     * Get the minimum and maximum values of the slider.
16404     *
16405     * @param obj The slider object.
16406     * @param min Pointer where to store the minimum value.
16407     * @param max Pointer where to store the maximum value.
16408     *
16409     * @note If only one value is needed, the other pointer can be passed
16410     * as @c NULL.
16411     *
16412     * @see elm_slider_min_max_set() for details.
16413     *
16414     * @ingroup Slider
16415     */
16416    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16417
16418    /**
16419     * Set the value the slider displays.
16420     *
16421     * @param obj The slider object.
16422     * @param val The value to be displayed.
16423     *
16424     * Value will be presented on the unit label following format specified with
16425     * elm_slider_unit_format_set() and on indicator with
16426     * elm_slider_indicator_format_set().
16427     *
16428     * @warning The value must to be between min and max values. This values
16429     * are set by elm_slider_min_max_set().
16430     *
16431     * @see elm_slider_value_get()
16432     * @see elm_slider_unit_format_set()
16433     * @see elm_slider_indicator_format_set()
16434     * @see elm_slider_min_max_set()
16435     *
16436     * @ingroup Slider
16437     */
16438    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16439
16440    /**
16441     * Get the value displayed by the spinner.
16442     *
16443     * @param obj The spinner object.
16444     * @return The value displayed.
16445     *
16446     * @see elm_spinner_value_set() for details.
16447     *
16448     * @ingroup Slider
16449     */
16450    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16451
16452    /**
16453     * Invert a given slider widget's displaying values order
16454     *
16455     * @param obj The slider object.
16456     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16457     * @c EINA_FALSE to bring it back to default, non-inverted values.
16458     *
16459     * A slider may be @b inverted, in which state it gets its
16460     * values inverted, with high vales being on the left or top and
16461     * low values on the right or bottom, as opposed to normally have
16462     * the low values on the former and high values on the latter,
16463     * respectively, for horizontal and vertical modes.
16464     *
16465     * @see elm_slider_inverted_get()
16466     *
16467     * @ingroup Slider
16468     */
16469    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16470
16471    /**
16472     * Get whether a given slider widget's displaying values are
16473     * inverted or not.
16474     *
16475     * @param obj The slider object.
16476     * @return @c EINA_TRUE, if @p obj has inverted values,
16477     * @c EINA_FALSE otherwise (and on errors).
16478     *
16479     * @see elm_slider_inverted_set() for more details.
16480     *
16481     * @ingroup Slider
16482     */
16483    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16484
16485    /**
16486     * Set whether to enlarge slider indicator (augmented knob) or not.
16487     *
16488     * @param obj The slider object.
16489     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16490     * let the knob always at default size.
16491     *
16492     * By default, indicator will be bigger while dragged by the user.
16493     *
16494     * @warning It won't display values set with
16495     * elm_slider_indicator_format_set() if you disable indicator.
16496     *
16497     * @ingroup Slider
16498     */
16499    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16500
16501    /**
16502     * Get whether a given slider widget's enlarging indicator or not.
16503     *
16504     * @param obj The slider object.
16505     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16506     * @c EINA_FALSE otherwise (and on errors).
16507     *
16508     * @see elm_slider_indicator_show_set() for details.
16509     *
16510     * @ingroup Slider
16511     */
16512    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16513
16514    /**
16515     * @}
16516     */
16517
16518    /**
16519     * @addtogroup Actionslider Actionslider
16520     *
16521     * @image html img/widget/actionslider/preview-00.png
16522     * @image latex img/widget/actionslider/preview-00.eps
16523     *
16524     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16525     * properties. The indicator is the element the user drags to choose a label.
16526     * When the position is set with magnet, when released the indicator will be
16527     * moved to it if it's nearest the magnetized position.
16528     *
16529     * @note By default all positions are set as enabled.
16530     *
16531     * Signals that you can add callbacks for are:
16532     *
16533     * "selected" - when user selects an enabled position (the label is passed
16534     *              as event info)".
16535     * @n
16536     * "pos_changed" - when the indicator reaches any of the positions("left",
16537     *                 "right" or "center").
16538     *
16539     * See an example of actionslider usage @ref actionslider_example_page "here"
16540     * @{
16541     */
16542    typedef enum _Elm_Actionslider_Pos
16543      {
16544         ELM_ACTIONSLIDER_NONE = 0,
16545         ELM_ACTIONSLIDER_LEFT = 1 << 0,
16546         ELM_ACTIONSLIDER_CENTER = 1 << 1,
16547         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16548         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16549      } Elm_Actionslider_Pos;
16550
16551    /**
16552     * Add a new actionslider to the parent.
16553     *
16554     * @param parent The parent object
16555     * @return The new actionslider object or NULL if it cannot be created
16556     */
16557    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16558    /**
16559     * Set actionslider labels.
16560     *
16561     * @param obj The actionslider object
16562     * @param left_label The label to be set on the left.
16563     * @param center_label The label to be set on the center.
16564     * @param right_label The label to be set on the right.
16565     * @deprecated use elm_object_text_set() instead.
16566     */
16567    EINA_DEPRECATED EAPI void                  elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
16568    /**
16569     * Get actionslider labels.
16570     *
16571     * @param obj The actionslider object
16572     * @param left_label A char** to place the left_label of @p obj into.
16573     * @param center_label A char** to place the center_label of @p obj into.
16574     * @param right_label A char** to place the right_label of @p obj into.
16575     * @deprecated use elm_object_text_set() instead.
16576     */
16577    EINA_DEPRECATED EAPI void                  elm_actionslider_labels_get(const Evas_Object *obj, const char **left_label, const char **center_label, const char **right_label) EINA_ARG_NONNULL(1);
16578    /**
16579     * Get actionslider selected label.
16580     *
16581     * @param obj The actionslider object
16582     * @return The selected label
16583     */
16584    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16585    /**
16586     * Set actionslider indicator position.
16587     *
16588     * @param obj The actionslider object.
16589     * @param pos The position of the indicator.
16590     */
16591    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16592    /**
16593     * Get actionslider indicator position.
16594     *
16595     * @param obj The actionslider object.
16596     * @return The position of the indicator.
16597     */
16598    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16599    /**
16600     * Set actionslider magnet position. To make multiple positions magnets @c or
16601     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16602     *
16603     * @param obj The actionslider object.
16604     * @param pos Bit mask indicating the magnet positions.
16605     */
16606    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16607    /**
16608     * Get actionslider magnet position.
16609     *
16610     * @param obj The actionslider object.
16611     * @return The positions with magnet property.
16612     */
16613    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16614    /**
16615     * Set actionslider enabled position. To set multiple positions as enabled @c or
16616     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16617     *
16618     * @note All the positions are enabled by default.
16619     *
16620     * @param obj The actionslider object.
16621     * @param pos Bit mask indicating the enabled positions.
16622     */
16623    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16624    /**
16625     * Get actionslider enabled position.
16626     *
16627     * @param obj The actionslider object.
16628     * @return The enabled positions.
16629     */
16630    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16631    /**
16632     * Set the label used on the indicator.
16633     *
16634     * @param obj The actionslider object
16635     * @param label The label to be set on the indicator.
16636     * @deprecated use elm_object_text_set() instead.
16637     */
16638    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16639    /**
16640     * Get the label used on the indicator object.
16641     *
16642     * @param obj The actionslider object
16643     * @return The indicator label
16644     * @deprecated use elm_object_text_get() instead.
16645     */
16646    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16647    /**
16648     * @}
16649     */
16650
16651    /**
16652     * @defgroup Genlist Genlist
16653     *
16654     * @image html img/widget/genlist/preview-00.png
16655     * @image latex img/widget/genlist/preview-00.eps
16656     * @image html img/genlist.png
16657     * @image latex img/genlist.eps
16658     *
16659     * This widget aims to have more expansive list than the simple list in
16660     * Elementary that could have more flexible items and allow many more entries
16661     * while still being fast and low on memory usage. At the same time it was
16662     * also made to be able to do tree structures. But the price to pay is more
16663     * complexity when it comes to usage. If all you want is a simple list with
16664     * icons and a single label, use the normal @ref List object.
16665     *
16666     * Genlist has a fairly large API, mostly because it's relatively complex,
16667     * trying to be both expansive, powerful and efficient. First we will begin
16668     * an overview on the theory behind genlist.
16669     *
16670     * @section Genlist_Item_Class Genlist item classes - creating items
16671     *
16672     * In order to have the ability to add and delete items on the fly, genlist
16673     * implements a class (callback) system where the application provides a
16674     * structure with information about that type of item (genlist may contain
16675     * multiple different items with different classes, states and styles).
16676     * Genlist will call the functions in this struct (methods) when an item is
16677     * "realized" (i.e., created dynamically, while the user is scrolling the
16678     * grid). All objects will simply be deleted when no longer needed with
16679     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16680     * following members:
16681     * - @c item_style - This is a constant string and simply defines the name
16682     *   of the item style. It @b must be specified and the default should be @c
16683     *   "default".
16684     * - @c mode_item_style - This is a constant string and simply defines the
16685     *   name of the style that will be used for mode animations. It can be left
16686     *   as @c NULL if you don't plan to use Genlist mode. See
16687     *   elm_genlist_item_mode_set() for more info.
16688     *
16689     * - @c func - A struct with pointers to functions that will be called when
16690     *   an item is going to be actually created. All of them receive a @c data
16691     *   parameter that will point to the same data passed to
16692     *   elm_genlist_item_append() and related item creation functions, and a @c
16693     *   obj parameter that points to the genlist object itself.
16694     *
16695     * The function pointers inside @c func are @c label_get, @c icon_get, @c
16696     * state_get and @c del. The 3 first functions also receive a @c part
16697     * parameter described below. A brief description of these functions follows:
16698     *
16699     * - @c label_get - The @c part parameter is the name string of one of the
16700     *   existing text parts in the Edje group implementing the item's theme.
16701     *   This function @b must return a strdup'()ed string, as the caller will
16702     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16703     * - @c icon_get - The @c part parameter is the name string of one of the
16704     *   existing (icon) swallow parts in the Edje group implementing the item's
16705     *   theme. It must return @c NULL, when no icon is desired, or a valid
16706     *   object handle, otherwise.  The object will be deleted by the genlist on
16707     *   its deletion or when the item is "unrealized".  See
16708     *   #Elm_Genlist_Item_Icon_Get_Cb.
16709     * - @c func.state_get - The @c part parameter is the name string of one of
16710     *   the state parts in the Edje group implementing the item's theme. Return
16711     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16712     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16713     *   and @c "elm" as "emission" and "source" arguments, respectively, when
16714     *   the state is true (the default is false), where @c XXX is the name of
16715     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
16716     * - @c func.del - This is intended for use when genlist items are deleted,
16717     *   so any data attached to the item (e.g. its data parameter on creation)
16718     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
16719     *
16720     * available item styles:
16721     * - default
16722     * - default_style - The text part is a textblock
16723     *
16724     * @image html img/widget/genlist/preview-04.png
16725     * @image latex img/widget/genlist/preview-04.eps
16726     *
16727     * - double_label
16728     *
16729     * @image html img/widget/genlist/preview-01.png
16730     * @image latex img/widget/genlist/preview-01.eps
16731     *
16732     * - icon_top_text_bottom
16733     *
16734     * @image html img/widget/genlist/preview-02.png
16735     * @image latex img/widget/genlist/preview-02.eps
16736     *
16737     * - group_index
16738     *
16739     * @image html img/widget/genlist/preview-03.png
16740     * @image latex img/widget/genlist/preview-03.eps
16741     *
16742     * @section Genlist_Items Structure of items
16743     *
16744     * An item in a genlist can have 0 or more text labels (they can be regular
16745     * text or textblock Evas objects - that's up to the style to determine), 0
16746     * or more icons (which are simply objects swallowed into the genlist item's
16747     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16748     * behavior left to the user to define. The Edje part names for each of
16749     * these properties will be looked up, in the theme file for the genlist,
16750     * under the Edje (string) data items named @c "labels", @c "icons" and @c
16751     * "states", respectively. For each of those properties, if more than one
16752     * part is provided, they must have names listed separated by spaces in the
16753     * data fields. For the default genlist item theme, we have @b one label
16754     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16755     * "elm.swallow.end") and @b no state parts.
16756     *
16757     * A genlist item may be at one of several styles. Elementary provides one
16758     * by default - "default", but this can be extended by system or application
16759     * custom themes/overlays/extensions (see @ref Theme "themes" for more
16760     * details).
16761     *
16762     * @section Genlist_Manipulation Editing and Navigating
16763     *
16764     * Items can be added by several calls. All of them return a @ref
16765     * Elm_Genlist_Item handle that is an internal member inside the genlist.
16766     * They all take a data parameter that is meant to be used for a handle to
16767     * the applications internal data (eg the struct with the original item
16768     * data). The parent parameter is the parent genlist item this belongs to if
16769     * it is a tree or an indexed group, and NULL if there is no parent. The
16770     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16771     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16772     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16773     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
16774     * is set then this item is group index item that is displayed at the top
16775     * until the next group comes. The func parameter is a convenience callback
16776     * that is called when the item is selected and the data parameter will be
16777     * the func_data parameter, obj be the genlist object and event_info will be
16778     * the genlist item.
16779     *
16780     * elm_genlist_item_append() adds an item to the end of the list, or if
16781     * there is a parent, to the end of all the child items of the parent.
16782     * elm_genlist_item_prepend() is the same but adds to the beginning of
16783     * the list or children list. elm_genlist_item_insert_before() inserts at
16784     * item before another item and elm_genlist_item_insert_after() inserts after
16785     * the indicated item.
16786     *
16787     * The application can clear the list with elm_genlist_clear() which deletes
16788     * all the items in the list and elm_genlist_item_del() will delete a specific
16789     * item. elm_genlist_item_subitems_clear() will clear all items that are
16790     * children of the indicated parent item.
16791     *
16792     * To help inspect list items you can jump to the item at the top of the list
16793     * with elm_genlist_first_item_get() which will return the item pointer, and
16794     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16795     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16796     * and previous items respectively relative to the indicated item. Using
16797     * these calls you can walk the entire item list/tree. Note that as a tree
16798     * the items are flattened in the list, so elm_genlist_item_parent_get() will
16799     * let you know which item is the parent (and thus know how to skip them if
16800     * wanted).
16801     *
16802     * @section Genlist_Muti_Selection Multi-selection
16803     *
16804     * If the application wants multiple items to be able to be selected,
16805     * elm_genlist_multi_select_set() can enable this. If the list is
16806     * single-selection only (the default), then elm_genlist_selected_item_get()
16807     * will return the selected item, if any, or NULL I none is selected. If the
16808     * list is multi-select then elm_genlist_selected_items_get() will return a
16809     * list (that is only valid as long as no items are modified (added, deleted,
16810     * selected or unselected)).
16811     *
16812     * @section Genlist_Usage_Hints Usage hints
16813     *
16814     * There are also convenience functions. elm_genlist_item_genlist_get() will
16815     * return the genlist object the item belongs to. elm_genlist_item_show()
16816     * will make the scroller scroll to show that specific item so its visible.
16817     * elm_genlist_item_data_get() returns the data pointer set by the item
16818     * creation functions.
16819     *
16820     * If an item changes (state of boolean changes, label or icons change),
16821     * then use elm_genlist_item_update() to have genlist update the item with
16822     * the new state. Genlist will re-realize the item thus call the functions
16823     * in the _Elm_Genlist_Item_Class for that item.
16824     *
16825     * To programmatically (un)select an item use elm_genlist_item_selected_set().
16826     * To get its selected state use elm_genlist_item_selected_get(). Similarly
16827     * to expand/contract an item and get its expanded state, use
16828     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16829     * again to make an item disabled (unable to be selected and appear
16830     * differently) use elm_genlist_item_disabled_set() to set this and
16831     * elm_genlist_item_disabled_get() to get the disabled state.
16832     *
16833     * In general to indicate how the genlist should expand items horizontally to
16834     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16835     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
16836     * mode means that if items are too wide to fit, the scroller will scroll
16837     * horizontally. Otherwise items are expanded to fill the width of the
16838     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16839     * to the viewport width and limited to that size. This can be combined with
16840     * a different style that uses edjes' ellipsis feature (cutting text off like
16841     * this: "tex...").
16842     *
16843     * Items will only call their selection func and callback when first becoming
16844     * selected. Any further clicks will do nothing, unless you enable always
16845     * select with elm_genlist_always_select_mode_set(). This means even if
16846     * selected, every click will make the selected callbacks be called.
16847     * elm_genlist_no_select_mode_set() will turn off the ability to select
16848     * items entirely and they will neither appear selected nor call selected
16849     * callback functions.
16850     *
16851     * Remember that you can create new styles and add your own theme augmentation
16852     * per application with elm_theme_extension_add(). If you absolutely must
16853     * have a specific style that overrides any theme the user or system sets up
16854     * you can use elm_theme_overlay_add() to add such a file.
16855     *
16856     * @section Genlist_Implementation Implementation
16857     *
16858     * Evas tracks every object you create. Every time it processes an event
16859     * (mouse move, down, up etc.) it needs to walk through objects and find out
16860     * what event that affects. Even worse every time it renders display updates,
16861     * in order to just calculate what to re-draw, it needs to walk through many
16862     * many many objects. Thus, the more objects you keep active, the more
16863     * overhead Evas has in just doing its work. It is advisable to keep your
16864     * active objects to the minimum working set you need. Also remember that
16865     * object creation and deletion carries an overhead, so there is a
16866     * middle-ground, which is not easily determined. But don't keep massive lists
16867     * of objects you can't see or use. Genlist does this with list objects. It
16868     * creates and destroys them dynamically as you scroll around. It groups them
16869     * into blocks so it can determine the visibility etc. of a whole block at
16870     * once as opposed to having to walk the whole list. This 2-level list allows
16871     * for very large numbers of items to be in the list (tests have used up to
16872     * 2,000,000 items). Also genlist employs a queue for adding items. As items
16873     * may be different sizes, every item added needs to be calculated as to its
16874     * size and thus this presents a lot of overhead on populating the list, this
16875     * genlist employs a queue. Any item added is queued and spooled off over
16876     * time, actually appearing some time later, so if your list has many members
16877     * you may find it takes a while for them to all appear, with your process
16878     * consuming a lot of CPU while it is busy spooling.
16879     *
16880     * Genlist also implements a tree structure, but it does so with callbacks to
16881     * the application, with the application filling in tree structures when
16882     * requested (allowing for efficient building of a very deep tree that could
16883     * even be used for file-management). See the above smart signal callbacks for
16884     * details.
16885     *
16886     * @section Genlist_Smart_Events Genlist smart events
16887     *
16888     * Signals that you can add callbacks for are:
16889     * - @c "activated" - The user has double-clicked or pressed
16890     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
16891     *   item that was activated.
16892     * - @c "clicked,double" - The user has double-clicked an item.  The @c
16893     *   event_info parameter is the item that was double-clicked.
16894     * - @c "selected" - This is called when a user has made an item selected.
16895     *   The event_info parameter is the genlist item that was selected.
16896     * - @c "unselected" - This is called when a user has made an item
16897     *   unselected. The event_info parameter is the genlist item that was
16898     *   unselected.
16899     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16900     *   called and the item is now meant to be expanded. The event_info
16901     *   parameter is the genlist item that was indicated to expand.  It is the
16902     *   job of this callback to then fill in the child items.
16903     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16904     *   called and the item is now meant to be contracted. The event_info
16905     *   parameter is the genlist item that was indicated to contract. It is the
16906     *   job of this callback to then delete the child items.
16907     * - @c "expand,request" - This is called when a user has indicated they want
16908     *   to expand a tree branch item. The callback should decide if the item can
16909     *   expand (has any children) and then call elm_genlist_item_expanded_set()
16910     *   appropriately to set the state. The event_info parameter is the genlist
16911     *   item that was indicated to expand.
16912     * - @c "contract,request" - This is called when a user has indicated they
16913     *   want to contract a tree branch item. The callback should decide if the
16914     *   item can contract (has any children) and then call
16915     *   elm_genlist_item_expanded_set() appropriately to set the state. The
16916     *   event_info parameter is the genlist item that was indicated to contract.
16917     * - @c "realized" - This is called when the item in the list is created as a
16918     *   real evas object. event_info parameter is the genlist item that was
16919     *   created. The object may be deleted at any time, so it is up to the
16920     *   caller to not use the object pointer from elm_genlist_item_object_get()
16921     *   in a way where it may point to freed objects.
16922     * - @c "unrealized" - This is called just before an item is unrealized.
16923     *   After this call icon objects provided will be deleted and the item
16924     *   object itself delete or be put into a floating cache.
16925     * - @c "drag,start,up" - This is called when the item in the list has been
16926     *   dragged (not scrolled) up.
16927     * - @c "drag,start,down" - This is called when the item in the list has been
16928     *   dragged (not scrolled) down.
16929     * - @c "drag,start,left" - This is called when the item in the list has been
16930     *   dragged (not scrolled) left.
16931     * - @c "drag,start,right" - This is called when the item in the list has
16932     *   been dragged (not scrolled) right.
16933     * - @c "drag,stop" - This is called when the item in the list has stopped
16934     *   being dragged.
16935     * - @c "drag" - This is called when the item in the list is being dragged.
16936     * - @c "longpressed" - This is called when the item is pressed for a certain
16937     *   amount of time. By default it's 1 second.
16938     * - @c "scroll,anim,start" - This is called when scrolling animation has
16939     *   started.
16940     * - @c "scroll,anim,stop" - This is called when scrolling animation has
16941     *   stopped.
16942     * - @c "scroll,drag,start" - This is called when dragging the content has
16943     *   started.
16944     * - @c "scroll,drag,stop" - This is called when dragging the content has
16945     *   stopped.
16946     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16947     *   the top edge.
16948     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16949     *   until the bottom edge.
16950     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16951     *   until the left edge.
16952     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16953     *   until the right edge.
16954     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16955     *   swiped left.
16956     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16957     *   swiped right.
16958     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16959     *   swiped up.
16960     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16961     *   swiped down.
16962     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16963     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
16964     *   multi-touch pinched in.
16965     * - @c "swipe" - This is called when the genlist is swiped.
16966     *
16967     * @section Genlist_Examples Examples
16968     *
16969     * Here is a list of examples that use the genlist, trying to show some of
16970     * its capabilities:
16971     * - @ref genlist_example_01
16972     * - @ref genlist_example_02
16973     * - @ref genlist_example_03
16974     * - @ref genlist_example_04
16975     * - @ref genlist_example_05
16976     */
16977
16978    /**
16979     * @addtogroup Genlist
16980     * @{
16981     */
16982
16983    /**
16984     * @enum _Elm_Genlist_Item_Flags
16985     * @typedef Elm_Genlist_Item_Flags
16986     *
16987     * Defines if the item is of any special type (has subitems or it's the
16988     * index of a group), or is just a simple item.
16989     *
16990     * @ingroup Genlist
16991     */
16992    typedef enum _Elm_Genlist_Item_Flags
16993      {
16994         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16995         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16996         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16997      } Elm_Genlist_Item_Flags;
16998    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
16999    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
17000    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
17001    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
17002    typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
17003    typedef Eina_Bool    (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
17004    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
17005    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
17006
17007    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
17008    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
17009    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
17010    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
17011
17012    /**
17013     * @struct _Elm_Genlist_Item_Class
17014     *
17015     * Genlist item class definition structs.
17016     *
17017     * This struct contains the style and fetching functions that will define the
17018     * contents of each item.
17019     *
17020     * @see @ref Genlist_Item_Class
17021     */
17022    struct _Elm_Genlist_Item_Class
17023      {
17024         const char                *item_style; /**< style of this class. */
17025         struct
17026           {
17027              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
17028              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
17029              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
17030              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
17031              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
17032           } func;
17033         const char                *mode_item_style;
17034      };
17035
17036    /**
17037     * Add a new genlist widget to the given parent Elementary
17038     * (container) object
17039     *
17040     * @param parent The parent object
17041     * @return a new genlist widget handle or @c NULL, on errors
17042     *
17043     * This function inserts a new genlist widget on the canvas.
17044     *
17045     * @see elm_genlist_item_append()
17046     * @see elm_genlist_item_del()
17047     * @see elm_genlist_clear()
17048     *
17049     * @ingroup Genlist
17050     */
17051    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17052    /**
17053     * Remove all items from a given genlist widget.
17054     *
17055     * @param obj The genlist object
17056     *
17057     * This removes (and deletes) all items in @p obj, leaving it empty.
17058     *
17059     * @see elm_genlist_item_del(), to remove just one item.
17060     *
17061     * @ingroup Genlist
17062     */
17063    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
17064    /**
17065     * Enable or disable multi-selection in the genlist
17066     *
17067     * @param obj The genlist object
17068     * @param multi Multi-select enable/disable. Default is disabled.
17069     *
17070     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
17071     * the list. This allows more than 1 item to be selected. To retrieve the list
17072     * of selected items, use elm_genlist_selected_items_get().
17073     *
17074     * @see elm_genlist_selected_items_get()
17075     * @see elm_genlist_multi_select_get()
17076     *
17077     * @ingroup Genlist
17078     */
17079    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
17080    /**
17081     * Gets if multi-selection in genlist is enabled or disabled.
17082     *
17083     * @param obj The genlist object
17084     * @return Multi-select enabled/disabled
17085     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
17086     *
17087     * @see elm_genlist_multi_select_set()
17088     *
17089     * @ingroup Genlist
17090     */
17091    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17092    /**
17093     * This sets the horizontal stretching mode.
17094     *
17095     * @param obj The genlist object
17096     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
17097     *
17098     * This sets the mode used for sizing items horizontally. Valid modes
17099     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
17100     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
17101     * the scroller will scroll horizontally. Otherwise items are expanded
17102     * to fill the width of the viewport of the scroller. If it is
17103     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
17104     * limited to that size.
17105     *
17106     * @see elm_genlist_horizontal_get()
17107     *
17108     * @ingroup Genlist
17109     */
17110    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17111    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
17112    /**
17113     * Gets the horizontal stretching mode.
17114     *
17115     * @param obj The genlist object
17116     * @return The mode to use
17117     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
17118     *
17119     * @see elm_genlist_horizontal_set()
17120     *
17121     * @ingroup Genlist
17122     */
17123    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17124    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17125    /**
17126     * Set the always select mode.
17127     *
17128     * @param obj The genlist object
17129     * @param always_select The always select mode (@c EINA_TRUE = on, @c
17130     * EINA_FALSE = off). Default is @c EINA_FALSE.
17131     *
17132     * Items will only call their selection func and callback when first
17133     * becoming selected. Any further clicks will do nothing, unless you
17134     * enable always select with elm_genlist_always_select_mode_set().
17135     * This means that, even if selected, every click will make the selected
17136     * callbacks be called.
17137     *
17138     * @see elm_genlist_always_select_mode_get()
17139     *
17140     * @ingroup Genlist
17141     */
17142    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
17143    /**
17144     * Get the always select mode.
17145     *
17146     * @param obj The genlist object
17147     * @return The always select mode
17148     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17149     *
17150     * @see elm_genlist_always_select_mode_set()
17151     *
17152     * @ingroup Genlist
17153     */
17154    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17155    /**
17156     * Enable/disable the no select mode.
17157     *
17158     * @param obj The genlist object
17159     * @param no_select The no select mode
17160     * (EINA_TRUE = on, EINA_FALSE = off)
17161     *
17162     * This will turn off the ability to select items entirely and they
17163     * will neither appear selected nor call selected callback functions.
17164     *
17165     * @see elm_genlist_no_select_mode_get()
17166     *
17167     * @ingroup Genlist
17168     */
17169    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
17170    /**
17171     * Gets whether the no select mode is enabled.
17172     *
17173     * @param obj The genlist object
17174     * @return The no select mode
17175     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17176     *
17177     * @see elm_genlist_no_select_mode_set()
17178     *
17179     * @ingroup Genlist
17180     */
17181    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17182    /**
17183     * Enable/disable compress mode.
17184     *
17185     * @param obj The genlist object
17186     * @param compress The compress mode
17187     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
17188     *
17189     * This will enable the compress mode where items are "compressed"
17190     * horizontally to fit the genlist scrollable viewport width. This is
17191     * special for genlist.  Do not rely on
17192     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
17193     * work as genlist needs to handle it specially.
17194     *
17195     * @see elm_genlist_compress_mode_get()
17196     *
17197     * @ingroup Genlist
17198     */
17199    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
17200    /**
17201     * Get whether the compress mode is enabled.
17202     *
17203     * @param obj The genlist object
17204     * @return The compress mode
17205     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
17206     *
17207     * @see elm_genlist_compress_mode_set()
17208     *
17209     * @ingroup Genlist
17210     */
17211    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17212    /**
17213     * Enable/disable height-for-width mode.
17214     *
17215     * @param obj The genlist object
17216     * @param setting The height-for-width mode (@c EINA_TRUE = on,
17217     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
17218     *
17219     * With height-for-width mode the item width will be fixed (restricted
17220     * to a minimum of) to the list width when calculating its size in
17221     * order to allow the height to be calculated based on it. This allows,
17222     * for instance, text block to wrap lines if the Edje part is
17223     * configured with "text.min: 0 1".
17224     *
17225     * @note This mode will make list resize slower as it will have to
17226     *       recalculate every item height again whenever the list width
17227     *       changes!
17228     *
17229     * @note When height-for-width mode is enabled, it also enables
17230     *       compress mode (see elm_genlist_compress_mode_set()) and
17231     *       disables homogeneous (see elm_genlist_homogeneous_set()).
17232     *
17233     * @ingroup Genlist
17234     */
17235    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17236    /**
17237     * Get whether the height-for-width mode is enabled.
17238     *
17239     * @param obj The genlist object
17240     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17241     * off)
17242     *
17243     * @ingroup Genlist
17244     */
17245    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17246    /**
17247     * Enable/disable horizontal and vertical bouncing effect.
17248     *
17249     * @param obj The genlist object
17250     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17251     * EINA_FALSE = off). Default is @c EINA_FALSE.
17252     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17253     * EINA_FALSE = off). Default is @c EINA_TRUE.
17254     *
17255     * This will enable or disable the scroller bouncing effect for the
17256     * genlist. See elm_scroller_bounce_set() for details.
17257     *
17258     * @see elm_scroller_bounce_set()
17259     * @see elm_genlist_bounce_get()
17260     *
17261     * @ingroup Genlist
17262     */
17263    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17264    /**
17265     * Get whether the horizontal and vertical bouncing effect is enabled.
17266     *
17267     * @param obj The genlist object
17268     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17269     * option is set.
17270     * @param v_bounce Pointer to a bool to receive if the bounce vertically
17271     * option is set.
17272     *
17273     * @see elm_genlist_bounce_set()
17274     *
17275     * @ingroup Genlist
17276     */
17277    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17278    /**
17279     * Enable/disable homogenous mode.
17280     *
17281     * @param obj The genlist object
17282     * @param homogeneous Assume the items within the genlist are of the
17283     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17284     * EINA_FALSE.
17285     *
17286     * This will enable the homogeneous mode where items are of the same
17287     * height and width so that genlist may do the lazy-loading at its
17288     * maximum (which increases the performance for scrolling the list). This
17289     * implies 'compressed' mode.
17290     *
17291     * @see elm_genlist_compress_mode_set()
17292     * @see elm_genlist_homogeneous_get()
17293     *
17294     * @ingroup Genlist
17295     */
17296    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17297    /**
17298     * Get whether the homogenous mode is enabled.
17299     *
17300     * @param obj The genlist object
17301     * @return Assume the items within the genlist are of the same height
17302     * and width (EINA_TRUE = on, EINA_FALSE = off)
17303     *
17304     * @see elm_genlist_homogeneous_set()
17305     *
17306     * @ingroup Genlist
17307     */
17308    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17309    /**
17310     * Set the maximum number of items within an item block
17311     *
17312     * @param obj The genlist object
17313     * @param n   Maximum number of items within an item block. Default is 32.
17314     *
17315     * This will configure the block count to tune to the target with
17316     * particular performance matrix.
17317     *
17318     * A block of objects will be used to reduce the number of operations due to
17319     * many objects in the screen. It can determine the visibility, or if the
17320     * object has changed, it theme needs to be updated, etc. doing this kind of
17321     * calculation to the entire block, instead of per object.
17322     *
17323     * The default value for the block count is enough for most lists, so unless
17324     * you know you will have a lot of objects visible in the screen at the same
17325     * time, don't try to change this.
17326     *
17327     * @see elm_genlist_block_count_get()
17328     * @see @ref Genlist_Implementation
17329     *
17330     * @ingroup Genlist
17331     */
17332    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17333    /**
17334     * Get the maximum number of items within an item block
17335     *
17336     * @param obj The genlist object
17337     * @return Maximum number of items within an item block
17338     *
17339     * @see elm_genlist_block_count_set()
17340     *
17341     * @ingroup Genlist
17342     */
17343    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17344    /**
17345     * Set the timeout in seconds for the longpress event.
17346     *
17347     * @param obj The genlist object
17348     * @param timeout timeout in seconds. Default is 1.
17349     *
17350     * This option will change how long it takes to send an event "longpressed"
17351     * after the mouse down signal is sent to the list. If this event occurs, no
17352     * "clicked" event will be sent.
17353     *
17354     * @see elm_genlist_longpress_timeout_set()
17355     *
17356     * @ingroup Genlist
17357     */
17358    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17359    /**
17360     * Get the timeout in seconds for the longpress event.
17361     *
17362     * @param obj The genlist object
17363     * @return timeout in seconds
17364     *
17365     * @see elm_genlist_longpress_timeout_get()
17366     *
17367     * @ingroup Genlist
17368     */
17369    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17370    /**
17371     * Append a new item in a given genlist widget.
17372     *
17373     * @param obj The genlist object
17374     * @param itc The item class for the item
17375     * @param data The item data
17376     * @param parent The parent item, or NULL if none
17377     * @param flags Item flags
17378     * @param func Convenience function called when the item is selected
17379     * @param func_data Data passed to @p func above.
17380     * @return A handle to the item added or @c NULL if not possible
17381     *
17382     * This adds the given item to the end of the list or the end of
17383     * the children list if the @p parent is given.
17384     *
17385     * @see elm_genlist_item_prepend()
17386     * @see elm_genlist_item_insert_before()
17387     * @see elm_genlist_item_insert_after()
17388     * @see elm_genlist_item_del()
17389     *
17390     * @ingroup Genlist
17391     */
17392    EAPI Elm_Genlist_Item *elm_genlist_item_append(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
17393    /**
17394     * Prepend a new item in a given genlist widget.
17395     *
17396     * @param obj The genlist object
17397     * @param itc The item class for the item
17398     * @param data The item data
17399     * @param parent The parent item, or NULL if none
17400     * @param flags Item flags
17401     * @param func Convenience function called when the item is selected
17402     * @param func_data Data passed to @p func above.
17403     * @return A handle to the item added or NULL if not possible
17404     *
17405     * This adds an item to the beginning of the list or beginning of the
17406     * children of the parent if given.
17407     *
17408     * @see elm_genlist_item_append()
17409     * @see elm_genlist_item_insert_before()
17410     * @see elm_genlist_item_insert_after()
17411     * @see elm_genlist_item_del()
17412     *
17413     * @ingroup Genlist
17414     */
17415    EAPI Elm_Genlist_Item *elm_genlist_item_prepend(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1);
17416    /**
17417     * Insert an item before another in a genlist widget
17418     *
17419     * @param obj The genlist object
17420     * @param itc The item class for the item
17421     * @param data The item data
17422     * @param before The item to place this new one before.
17423     * @param flags Item flags
17424     * @param func Convenience function called when the item is selected
17425     * @param func_data Data passed to @p func above.
17426     * @return A handle to the item added or @c NULL if not possible
17427     *
17428     * This inserts an item before another in the list. It will be in the
17429     * same tree level or group as the item it is inserted before.
17430     *
17431     * @see elm_genlist_item_append()
17432     * @see elm_genlist_item_prepend()
17433     * @see elm_genlist_item_insert_after()
17434     * @see elm_genlist_item_del()
17435     *
17436     * @ingroup Genlist
17437     */
17438    EAPI Elm_Genlist_Item *elm_genlist_item_insert_before(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item *before, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1, 5);
17439    /**
17440     * Insert an item after another in a genlist widget
17441     *
17442     * @param obj The genlist object
17443     * @param itc The item class for the item
17444     * @param data The item data
17445     * @param after The item to place this new one after.
17446     * @param flags Item flags
17447     * @param func Convenience function called when the item is selected
17448     * @param func_data Data passed to @p func above.
17449     * @return A handle to the item added or @c NULL if not possible
17450     *
17451     * This inserts an item after another in the list. It will be in the
17452     * same tree level or group as the item it is inserted after.
17453     *
17454     * @see elm_genlist_item_append()
17455     * @see elm_genlist_item_prepend()
17456     * @see elm_genlist_item_insert_before()
17457     * @see elm_genlist_item_del()
17458     *
17459     * @ingroup Genlist
17460     */
17461    EAPI Elm_Genlist_Item *elm_genlist_item_insert_after(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item *after, Elm_Genlist_Item_Flags flags, Evas_Smart_Cb func, const void *func_data) EINA_ARG_NONNULL(1, 5);
17462    /**
17463     * Insert a new item into the sorted genlist object
17464     *
17465     * @param obj The genlist object
17466     * @param itc The item class for the item
17467     * @param data The item data
17468     * @param parent The parent item, or NULL if none
17469     * @param flags Item flags
17470     * @param comp The function called for the sort
17471     * @param func Convenience function called when item selected
17472     * @param func_data Data passed to @p func above.
17473     * @return A handle to the item added or NULL if not possible
17474     *
17475     * @ingroup Genlist
17476     */
17477    EAPI Elm_Genlist_Item *elm_genlist_item_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func,const void *func_data);
17478    EAPI Elm_Genlist_Item *elm_genlist_item_direct_sorted_insert(Evas_Object *obj, const Elm_Genlist_Item_Class *itc, const void *data, Elm_Genlist_Item *parent, Elm_Genlist_Item_Flags flags, Eina_Compare_Cb comp, Evas_Smart_Cb func, const void *func_data);
17479    /* operations to retrieve existing items */
17480    /**
17481     * Get the selectd item in the genlist.
17482     *
17483     * @param obj The genlist object
17484     * @return The selected item, or NULL if none is selected.
17485     *
17486     * This gets the selected item in the list (if multi-selection is enabled, only
17487     * the item that was first selected in the list is returned - which is not very
17488     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17489     * used).
17490     *
17491     * If no item is selected, NULL is returned.
17492     *
17493     * @see elm_genlist_selected_items_get()
17494     *
17495     * @ingroup Genlist
17496     */
17497    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17498    /**
17499     * Get a list of selected items in the genlist.
17500     *
17501     * @param obj The genlist object
17502     * @return The list of selected items, or NULL if none are selected.
17503     *
17504     * It returns a list of the selected items. This list pointer is only valid so
17505     * long as the selection doesn't change (no items are selected or unselected, or
17506     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17507     * pointers. The order of the items in this list is the order which they were
17508     * selected, i.e. the first item in this list is the first item that was
17509     * selected, and so on.
17510     *
17511     * @note If not in multi-select mode, consider using function
17512     * elm_genlist_selected_item_get() instead.
17513     *
17514     * @see elm_genlist_multi_select_set()
17515     * @see elm_genlist_selected_item_get()
17516     *
17517     * @ingroup Genlist
17518     */
17519    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17520    /**
17521     * Get a list of realized items in genlist
17522     *
17523     * @param obj The genlist object
17524     * @return The list of realized items, nor NULL if none are realized.
17525     *
17526     * This returns a list of the realized items in the genlist. The list
17527     * contains Elm_Genlist_Item pointers. The list must be freed by the
17528     * caller when done with eina_list_free(). The item pointers in the
17529     * list are only valid so long as those items are not deleted or the
17530     * genlist is not deleted.
17531     *
17532     * @see elm_genlist_realized_items_update()
17533     *
17534     * @ingroup Genlist
17535     */
17536    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17537    /**
17538     * Get the item that is at the x, y canvas coords.
17539     *
17540     * @param obj The gelinst object.
17541     * @param x The input x coordinate
17542     * @param y The input y coordinate
17543     * @param posret The position relative to the item returned here
17544     * @return The item at the coordinates or NULL if none
17545     *
17546     * This returns the item at the given coordinates (which are canvas
17547     * relative, not object-relative). If an item is at that coordinate,
17548     * that item handle is returned, and if @p posret is not NULL, the
17549     * integer pointed to is set to a value of -1, 0 or 1, depending if
17550     * the coordinate is on the upper portion of that item (-1), on the
17551     * middle section (0) or on the lower part (1). If NULL is returned as
17552     * an item (no item found there), then posret may indicate -1 or 1
17553     * based if the coordinate is above or below all items respectively in
17554     * the genlist.
17555     *
17556     * @ingroup Genlist
17557     */
17558    EAPI Elm_Genlist_Item *elm_genlist_at_xy_item_get(const Evas_Object *obj, Evas_Coord x, Evas_Coord y, int *posret) EINA_ARG_NONNULL(1);
17559    /**
17560     * Get the first item in the genlist
17561     *
17562     * This returns the first item in the list.
17563     *
17564     * @param obj The genlist object
17565     * @return The first item, or NULL if none
17566     *
17567     * @ingroup Genlist
17568     */
17569    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17570    /**
17571     * Get the last item in the genlist
17572     *
17573     * This returns the last item in the list.
17574     *
17575     * @return The last item, or NULL if none
17576     *
17577     * @ingroup Genlist
17578     */
17579    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17580    /**
17581     * Set the scrollbar policy
17582     *
17583     * @param obj The genlist object
17584     * @param policy_h Horizontal scrollbar policy.
17585     * @param policy_v Vertical scrollbar policy.
17586     *
17587     * This sets the scrollbar visibility policy for the given genlist
17588     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17589     * made visible if it is needed, and otherwise kept hidden.
17590     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17591     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17592     * respectively for the horizontal and vertical scrollbars. Default is
17593     * #ELM_SMART_SCROLLER_POLICY_AUTO
17594     *
17595     * @see elm_genlist_scroller_policy_get()
17596     *
17597     * @ingroup Genlist
17598     */
17599    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17600    /**
17601     * Get the scrollbar policy
17602     *
17603     * @param obj The genlist object
17604     * @param policy_h Pointer to store the horizontal scrollbar policy.
17605     * @param policy_v Pointer to store the vertical scrollbar policy.
17606     *
17607     * @see elm_genlist_scroller_policy_set()
17608     *
17609     * @ingroup Genlist
17610     */
17611    EAPI void              elm_genlist_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
17612    /**
17613     * Get the @b next item in a genlist widget's internal list of items,
17614     * given a handle to one of those items.
17615     *
17616     * @param item The genlist item to fetch next from
17617     * @return The item after @p item, or @c NULL if there's none (and
17618     * on errors)
17619     *
17620     * This returns the item placed after the @p item, on the container
17621     * genlist.
17622     *
17623     * @see elm_genlist_item_prev_get()
17624     *
17625     * @ingroup Genlist
17626     */
17627    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17628    /**
17629     * Get the @b previous item in a genlist widget's internal list of items,
17630     * given a handle to one of those items.
17631     *
17632     * @param item The genlist item to fetch previous from
17633     * @return The item before @p item, or @c NULL if there's none (and
17634     * on errors)
17635     *
17636     * This returns the item placed before the @p item, on the container
17637     * genlist.
17638     *
17639     * @see elm_genlist_item_next_get()
17640     *
17641     * @ingroup Genlist
17642     */
17643    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17644    /**
17645     * Get the genlist object's handle which contains a given genlist
17646     * item
17647     *
17648     * @param item The item to fetch the container from
17649     * @return The genlist (parent) object
17650     *
17651     * This returns the genlist object itself that an item belongs to.
17652     *
17653     * @ingroup Genlist
17654     */
17655    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17656    /**
17657     * Get the parent item of the given item
17658     *
17659     * @param it The item
17660     * @return The parent of the item or @c NULL if it has no parent.
17661     *
17662     * This returns the item that was specified as parent of the item @p it on
17663     * elm_genlist_item_append() and insertion related functions.
17664     *
17665     * @ingroup Genlist
17666     */
17667    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17668    /**
17669     * Remove all sub-items (children) of the given item
17670     *
17671     * @param it The item
17672     *
17673     * This removes all items that are children (and their descendants) of the
17674     * given item @p it.
17675     *
17676     * @see elm_genlist_clear()
17677     * @see elm_genlist_item_del()
17678     *
17679     * @ingroup Genlist
17680     */
17681    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17682    /**
17683     * Set whether a given genlist item is selected or not
17684     *
17685     * @param it The item
17686     * @param selected Use @c EINA_TRUE, to make it selected, @c
17687     * EINA_FALSE to make it unselected
17688     *
17689     * This sets the selected state of an item. If multi selection is
17690     * not enabled on the containing genlist and @p selected is @c
17691     * EINA_TRUE, any other previously selected items will get
17692     * unselected in favor of this new one.
17693     *
17694     * @see elm_genlist_item_selected_get()
17695     *
17696     * @ingroup Genlist
17697     */
17698    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17699    /**
17700     * Get whether a given genlist item is selected or not
17701     *
17702     * @param it The item
17703     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17704     *
17705     * @see elm_genlist_item_selected_set() for more details
17706     *
17707     * @ingroup Genlist
17708     */
17709    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17710    /**
17711     * Sets the expanded state of an item.
17712     *
17713     * @param it The item
17714     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17715     *
17716     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17717     * expanded or not.
17718     *
17719     * The theme will respond to this change visually, and a signal "expanded" or
17720     * "contracted" will be sent from the genlist with a pointer to the item that
17721     * has been expanded/contracted.
17722     *
17723     * Calling this function won't show or hide any child of this item (if it is
17724     * a parent). You must manually delete and create them on the callbacks fo
17725     * the "expanded" or "contracted" signals.
17726     *
17727     * @see elm_genlist_item_expanded_get()
17728     *
17729     * @ingroup Genlist
17730     */
17731    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17732    /**
17733     * Get the expanded state of an item
17734     *
17735     * @param it The item
17736     * @return The expanded state
17737     *
17738     * This gets the expanded state of an item.
17739     *
17740     * @see elm_genlist_item_expanded_set()
17741     *
17742     * @ingroup Genlist
17743     */
17744    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17745    /**
17746     * Get the depth of expanded item
17747     *
17748     * @param it The genlist item object
17749     * @return The depth of expanded item
17750     *
17751     * @ingroup Genlist
17752     */
17753    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17754    /**
17755     * Set whether a given genlist item is disabled or not.
17756     *
17757     * @param it The item
17758     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17759     * to enable it back.
17760     *
17761     * A disabled item cannot be selected or unselected. It will also
17762     * change its appearance, to signal the user it's disabled.
17763     *
17764     * @see elm_genlist_item_disabled_get()
17765     *
17766     * @ingroup Genlist
17767     */
17768    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17769    /**
17770     * Get whether a given genlist item is disabled or not.
17771     *
17772     * @param it The item
17773     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17774     * (and on errors).
17775     *
17776     * @see elm_genlist_item_disabled_set() for more details
17777     *
17778     * @ingroup Genlist
17779     */
17780    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17781    /**
17782     * Sets the display only state of an item.
17783     *
17784     * @param it The item
17785     * @param display_only @c EINA_TRUE if the item is display only, @c
17786     * EINA_FALSE otherwise.
17787     *
17788     * A display only item cannot be selected or unselected. It is for
17789     * display only and not selecting or otherwise clicking, dragging
17790     * etc. by the user, thus finger size rules will not be applied to
17791     * this item.
17792     *
17793     * It's good to set group index items to display only state.
17794     *
17795     * @see elm_genlist_item_display_only_get()
17796     *
17797     * @ingroup Genlist
17798     */
17799    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17800    /**
17801     * Get the display only state of an item
17802     *
17803     * @param it The item
17804     * @return @c EINA_TRUE if the item is display only, @c
17805     * EINA_FALSE otherwise.
17806     *
17807     * @see elm_genlist_item_display_only_set()
17808     *
17809     * @ingroup Genlist
17810     */
17811    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17812    /**
17813     * Show the portion of a genlist's internal list containing a given
17814     * item, immediately.
17815     *
17816     * @param it The item to display
17817     *
17818     * This causes genlist to jump to the given item @p it and show it (by
17819     * immediately scrolling to that position), if it is not fully visible.
17820     *
17821     * @see elm_genlist_item_bring_in()
17822     * @see elm_genlist_item_top_show()
17823     * @see elm_genlist_item_middle_show()
17824     *
17825     * @ingroup Genlist
17826     */
17827    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17828    /**
17829     * Animatedly bring in, to the visible are of a genlist, a given
17830     * item on it.
17831     *
17832     * @param it The item to display
17833     *
17834     * This causes genlist to jump to the given item @p it and show it (by
17835     * animatedly scrolling), if it is not fully visible. This may use animation
17836     * to do so and take a period of time
17837     *
17838     * @see elm_genlist_item_show()
17839     * @see elm_genlist_item_top_bring_in()
17840     * @see elm_genlist_item_middle_bring_in()
17841     *
17842     * @ingroup Genlist
17843     */
17844    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17845    /**
17846     * Show the portion of a genlist's internal list containing a given
17847     * item, immediately.
17848     *
17849     * @param it The item to display
17850     *
17851     * This causes genlist to jump to the given item @p it and show it (by
17852     * immediately scrolling to that position), if it is not fully visible.
17853     *
17854     * The item will be positioned at the top of the genlist viewport.
17855     *
17856     * @see elm_genlist_item_show()
17857     * @see elm_genlist_item_top_bring_in()
17858     *
17859     * @ingroup Genlist
17860     */
17861    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17862    /**
17863     * Animatedly bring in, to the visible are of a genlist, a given
17864     * item on it.
17865     *
17866     * @param it The item
17867     *
17868     * This causes genlist to jump to the given item @p it and show it (by
17869     * animatedly scrolling), if it is not fully visible. This may use animation
17870     * to do so and take a period of time
17871     *
17872     * The item will be positioned at the top of the genlist viewport.
17873     *
17874     * @see elm_genlist_item_bring_in()
17875     * @see elm_genlist_item_top_show()
17876     *
17877     * @ingroup Genlist
17878     */
17879    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17880    /**
17881     * Show the portion of a genlist's internal list containing a given
17882     * item, immediately.
17883     *
17884     * @param it The item to display
17885     *
17886     * This causes genlist to jump to the given item @p it and show it (by
17887     * immediately scrolling to that position), if it is not fully visible.
17888     *
17889     * The item will be positioned at the middle of the genlist viewport.
17890     *
17891     * @see elm_genlist_item_show()
17892     * @see elm_genlist_item_middle_bring_in()
17893     *
17894     * @ingroup Genlist
17895     */
17896    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17897    /**
17898     * Animatedly bring in, to the visible are of a genlist, a given
17899     * item on it.
17900     *
17901     * @param it The item
17902     *
17903     * This causes genlist to jump to the given item @p it and show it (by
17904     * animatedly scrolling), if it is not fully visible. This may use animation
17905     * to do so and take a period of time
17906     *
17907     * The item will be positioned at the middle of the genlist viewport.
17908     *
17909     * @see elm_genlist_item_bring_in()
17910     * @see elm_genlist_item_middle_show()
17911     *
17912     * @ingroup Genlist
17913     */
17914    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17915    /**
17916     * Remove a genlist item from the its parent, deleting it.
17917     *
17918     * @param item The item to be removed.
17919     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17920     *
17921     * @see elm_genlist_clear(), to remove all items in a genlist at
17922     * once.
17923     *
17924     * @ingroup Genlist
17925     */
17926    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17927    /**
17928     * Return the data associated to a given genlist item
17929     *
17930     * @param item The genlist item.
17931     * @return the data associated to this item.
17932     *
17933     * This returns the @c data value passed on the
17934     * elm_genlist_item_append() and related item addition calls.
17935     *
17936     * @see elm_genlist_item_append()
17937     * @see elm_genlist_item_data_set()
17938     *
17939     * @ingroup Genlist
17940     */
17941    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17942    /**
17943     * Set the data associated to a given genlist item
17944     *
17945     * @param item The genlist item
17946     * @param data The new data pointer to set on it
17947     *
17948     * This @b overrides the @c data value passed on the
17949     * elm_genlist_item_append() and related item addition calls. This
17950     * function @b won't call elm_genlist_item_update() automatically,
17951     * so you'd issue it afterwards if you want to hove the item
17952     * updated to reflect the that new data.
17953     *
17954     * @see elm_genlist_item_data_get()
17955     *
17956     * @ingroup Genlist
17957     */
17958    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17959    /**
17960     * Tells genlist to "orphan" icons fetchs by the item class
17961     *
17962     * @param it The item
17963     *
17964     * This instructs genlist to release references to icons in the item,
17965     * meaning that they will no longer be managed by genlist and are
17966     * floating "orphans" that can be re-used elsewhere if the user wants
17967     * to.
17968     *
17969     * @ingroup Genlist
17970     */
17971    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17972    /**
17973     * Get the real Evas object created to implement the view of a
17974     * given genlist item
17975     *
17976     * @param item The genlist item.
17977     * @return the Evas object implementing this item's view.
17978     *
17979     * This returns the actual Evas object used to implement the
17980     * specified genlist item's view. This may be @c NULL, as it may
17981     * not have been created or may have been deleted, at any time, by
17982     * the genlist. <b>Do not modify this object</b> (move, resize,
17983     * show, hide, etc.), as the genlist is controlling it. This
17984     * function is for querying, emitting custom signals or hooking
17985     * lower level callbacks for events on that object. Do not delete
17986     * this object under any circumstances.
17987     *
17988     * @see elm_genlist_item_data_get()
17989     *
17990     * @ingroup Genlist
17991     */
17992    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17993    /**
17994     * Update the contents of an item
17995     *
17996     * @param it The item
17997     *
17998     * This updates an item by calling all the item class functions again
17999     * to get the icons, labels and states. Use this when the original
18000     * item data has changed and the changes are desired to be reflected.
18001     *
18002     * Use elm_genlist_realized_items_update() to update all already realized
18003     * items.
18004     *
18005     * @see elm_genlist_realized_items_update()
18006     *
18007     * @ingroup Genlist
18008     */
18009    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18010    /**
18011     * Update the item class of an item
18012     *
18013     * @param it The item
18014     * @param itc The item class for the item
18015     *
18016     * This sets another class fo the item, changing the way that it is
18017     * displayed. After changing the item class, elm_genlist_item_update() is
18018     * called on the item @p it.
18019     *
18020     * @ingroup Genlist
18021     */
18022    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
18023    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18024    /**
18025     * Set the text to be shown in a given genlist item's tooltips.
18026     *
18027     * @param item The genlist item
18028     * @param text The text to set in the content
18029     *
18030     * This call will setup the text to be used as tooltip to that item
18031     * (analogous to elm_object_tooltip_text_set(), but being item
18032     * tooltips with higher precedence than object tooltips). It can
18033     * have only one tooltip at a time, so any previous tooltip data
18034     * will get removed.
18035     *
18036     * In order to set an icon or something else as a tooltip, look at
18037     * elm_genlist_item_tooltip_content_cb_set().
18038     *
18039     * @ingroup Genlist
18040     */
18041    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
18042    /**
18043     * Set the content to be shown in a given genlist item's tooltips
18044     *
18045     * @param item The genlist item.
18046     * @param func The function returning the tooltip contents.
18047     * @param data What to provide to @a func as callback data/context.
18048     * @param del_cb Called when data is not needed anymore, either when
18049     *        another callback replaces @p func, the tooltip is unset with
18050     *        elm_genlist_item_tooltip_unset() or the owner @p item
18051     *        dies. This callback receives as its first parameter the
18052     *        given @p data, being @c event_info the item handle.
18053     *
18054     * This call will setup the tooltip's contents to @p item
18055     * (analogous to elm_object_tooltip_content_cb_set(), but being
18056     * item tooltips with higher precedence than object tooltips). It
18057     * can have only one tooltip at a time, so any previous tooltip
18058     * content will get removed. @p func (with @p data) will be called
18059     * every time Elementary needs to show the tooltip and it should
18060     * return a valid Evas object, which will be fully managed by the
18061     * tooltip system, getting deleted when the tooltip is gone.
18062     *
18063     * In order to set just a text as a tooltip, look at
18064     * elm_genlist_item_tooltip_text_set().
18065     *
18066     * @ingroup Genlist
18067     */
18068    EAPI void               elm_genlist_item_tooltip_content_cb_set(Elm_Genlist_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
18069    /**
18070     * Unset a tooltip from a given genlist item
18071     *
18072     * @param item genlist item to remove a previously set tooltip from.
18073     *
18074     * This call removes any tooltip set on @p item. The callback
18075     * provided as @c del_cb to
18076     * elm_genlist_item_tooltip_content_cb_set() will be called to
18077     * notify it is not used anymore (and have resources cleaned, if
18078     * need be).
18079     *
18080     * @see elm_genlist_item_tooltip_content_cb_set()
18081     *
18082     * @ingroup Genlist
18083     */
18084    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18085    /**
18086     * Set a different @b style for a given genlist item's tooltip.
18087     *
18088     * @param item genlist item with tooltip set
18089     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
18090     * "default", @c "transparent", etc)
18091     *
18092     * Tooltips can have <b>alternate styles</b> to be displayed on,
18093     * which are defined by the theme set on Elementary. This function
18094     * works analogously as elm_object_tooltip_style_set(), but here
18095     * applied only to genlist item objects. The default style for
18096     * tooltips is @c "default".
18097     *
18098     * @note before you set a style you should define a tooltip with
18099     *       elm_genlist_item_tooltip_content_cb_set() or
18100     *       elm_genlist_item_tooltip_text_set()
18101     *
18102     * @see elm_genlist_item_tooltip_style_get()
18103     *
18104     * @ingroup Genlist
18105     */
18106    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18107    /**
18108     * Get the style set a given genlist item's tooltip.
18109     *
18110     * @param item genlist item with tooltip already set on.
18111     * @return style the theme style in use, which defaults to
18112     *         "default". If the object does not have a tooltip set,
18113     *         then @c NULL is returned.
18114     *
18115     * @see elm_genlist_item_tooltip_style_set() for more details
18116     *
18117     * @ingroup Genlist
18118     */
18119    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18120    /**
18121     * @brief Disable size restrictions on an object's tooltip
18122     * @param item The tooltip's anchor object
18123     * @param disable If EINA_TRUE, size restrictions are disabled
18124     * @return EINA_FALSE on failure, EINA_TRUE on success
18125     *
18126     * This function allows a tooltip to expand beyond its parant window's canvas.
18127     * It will instead be limited only by the size of the display.
18128     */
18129    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
18130    /**
18131     * @brief Retrieve size restriction state of an object's tooltip
18132     * @param item The tooltip's anchor object
18133     * @return If EINA_TRUE, size restrictions are disabled
18134     *
18135     * This function returns whether a tooltip is allowed to expand beyond
18136     * its parant window's canvas.
18137     * It will instead be limited only by the size of the display.
18138     */
18139    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
18140    /**
18141     * Set the type of mouse pointer/cursor decoration to be shown,
18142     * when the mouse pointer is over the given genlist widget item
18143     *
18144     * @param item genlist item to customize cursor on
18145     * @param cursor the cursor type's name
18146     *
18147     * This function works analogously as elm_object_cursor_set(), but
18148     * here the cursor's changing area is restricted to the item's
18149     * area, and not the whole widget's. Note that that item cursors
18150     * have precedence over widget cursors, so that a mouse over @p
18151     * item will always show cursor @p type.
18152     *
18153     * If this function is called twice for an object, a previously set
18154     * cursor will be unset on the second call.
18155     *
18156     * @see elm_object_cursor_set()
18157     * @see elm_genlist_item_cursor_get()
18158     * @see elm_genlist_item_cursor_unset()
18159     *
18160     * @ingroup Genlist
18161     */
18162    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
18163    /**
18164     * Get the type of mouse pointer/cursor decoration set to be shown,
18165     * when the mouse pointer is over the given genlist widget item
18166     *
18167     * @param item genlist item with custom cursor set
18168     * @return the cursor type's name or @c NULL, if no custom cursors
18169     * were set to @p item (and on errors)
18170     *
18171     * @see elm_object_cursor_get()
18172     * @see elm_genlist_item_cursor_set() for more details
18173     * @see elm_genlist_item_cursor_unset()
18174     *
18175     * @ingroup Genlist
18176     */
18177    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18178    /**
18179     * Unset any custom mouse pointer/cursor decoration set to be
18180     * shown, when the mouse pointer is over the given genlist widget
18181     * item, thus making it show the @b default cursor again.
18182     *
18183     * @param item a genlist item
18184     *
18185     * Use this call to undo any custom settings on this item's cursor
18186     * decoration, bringing it back to defaults (no custom style set).
18187     *
18188     * @see elm_object_cursor_unset()
18189     * @see elm_genlist_item_cursor_set() for more details
18190     *
18191     * @ingroup Genlist
18192     */
18193    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18194    /**
18195     * Set a different @b style for a given custom cursor set for a
18196     * genlist item.
18197     *
18198     * @param item genlist item with custom cursor set
18199     * @param style the <b>theme style</b> to use (e.g. @c "default",
18200     * @c "transparent", etc)
18201     *
18202     * This function only makes sense when one is using custom mouse
18203     * cursor decorations <b>defined in a theme file</b> , which can
18204     * have, given a cursor name/type, <b>alternate styles</b> on
18205     * it. It works analogously as elm_object_cursor_style_set(), but
18206     * here applied only to genlist item objects.
18207     *
18208     * @warning Before you set a cursor style you should have defined a
18209     *       custom cursor previously on the item, with
18210     *       elm_genlist_item_cursor_set()
18211     *
18212     * @see elm_genlist_item_cursor_engine_only_set()
18213     * @see elm_genlist_item_cursor_style_get()
18214     *
18215     * @ingroup Genlist
18216     */
18217    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
18218    /**
18219     * Get the current @b style set for a given genlist item's custom
18220     * cursor
18221     *
18222     * @param item genlist item with custom cursor set.
18223     * @return style the cursor style in use. If the object does not
18224     *         have a cursor set, then @c NULL is returned.
18225     *
18226     * @see elm_genlist_item_cursor_style_set() for more details
18227     *
18228     * @ingroup Genlist
18229     */
18230    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18231    /**
18232     * Set if the (custom) cursor for a given genlist item should be
18233     * searched in its theme, also, or should only rely on the
18234     * rendering engine.
18235     *
18236     * @param item item with custom (custom) cursor already set on
18237     * @param engine_only Use @c EINA_TRUE to have cursors looked for
18238     * only on those provided by the rendering engine, @c EINA_FALSE to
18239     * have them searched on the widget's theme, as well.
18240     *
18241     * @note This call is of use only if you've set a custom cursor
18242     * for genlist items, with elm_genlist_item_cursor_set().
18243     *
18244     * @note By default, cursors will only be looked for between those
18245     * provided by the rendering engine.
18246     *
18247     * @ingroup Genlist
18248     */
18249    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18250    /**
18251     * Get if the (custom) cursor for a given genlist item is being
18252     * searched in its theme, also, or is only relying on the rendering
18253     * engine.
18254     *
18255     * @param item a genlist item
18256     * @return @c EINA_TRUE, if cursors are being looked for only on
18257     * those provided by the rendering engine, @c EINA_FALSE if they
18258     * are being searched on the widget's theme, as well.
18259     *
18260     * @see elm_genlist_item_cursor_engine_only_set(), for more details
18261     *
18262     * @ingroup Genlist
18263     */
18264    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18265    /**
18266     * Update the contents of all realized items.
18267     *
18268     * @param obj The genlist object.
18269     *
18270     * This updates all realized items by calling all the item class functions again
18271     * to get the icons, labels and states. Use this when the original
18272     * item data has changed and the changes are desired to be reflected.
18273     *
18274     * To update just one item, use elm_genlist_item_update().
18275     *
18276     * @see elm_genlist_realized_items_get()
18277     * @see elm_genlist_item_update()
18278     *
18279     * @ingroup Genlist
18280     */
18281    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18282    /**
18283     * Activate a genlist mode on an item
18284     *
18285     * @param item The genlist item
18286     * @param mode Mode name
18287     * @param mode_set Boolean to define set or unset mode.
18288     *
18289     * A genlist mode is a different way of selecting an item. Once a mode is
18290     * activated on an item, any other selected item is immediately unselected.
18291     * This feature provides an easy way of implementing a new kind of animation
18292     * for selecting an item, without having to entirely rewrite the item style
18293     * theme. However, the elm_genlist_selected_* API can't be used to get what
18294     * item is activate for a mode.
18295     *
18296     * The current item style will still be used, but applying a genlist mode to
18297     * an item will select it using a different kind of animation.
18298     *
18299     * The current active item for a mode can be found by
18300     * elm_genlist_mode_item_get().
18301     *
18302     * The characteristics of genlist mode are:
18303     * - Only one mode can be active at any time, and for only one item.
18304     * - Genlist handles deactivating other items when one item is activated.
18305     * - A mode is defined in the genlist theme (edc), and more modes can easily
18306     *   be added.
18307     * - A mode style and the genlist item style are different things. They
18308     *   can be combined to provide a default style to the item, with some kind
18309     *   of animation for that item when the mode is activated.
18310     *
18311     * When a mode is activated on an item, a new view for that item is created.
18312     * The theme of this mode defines the animation that will be used to transit
18313     * the item from the old view to the new view. This second (new) view will be
18314     * active for that item while the mode is active on the item, and will be
18315     * destroyed after the mode is totally deactivated from that item.
18316     *
18317     * @see elm_genlist_mode_get()
18318     * @see elm_genlist_mode_item_get()
18319     *
18320     * @ingroup Genlist
18321     */
18322    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18323    /**
18324     * Get the last (or current) genlist mode used.
18325     *
18326     * @param obj The genlist object
18327     *
18328     * This function just returns the name of the last used genlist mode. It will
18329     * be the current mode if it's still active.
18330     *
18331     * @see elm_genlist_item_mode_set()
18332     * @see elm_genlist_mode_item_get()
18333     *
18334     * @ingroup Genlist
18335     */
18336    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18337    /**
18338     * Get active genlist mode item
18339     *
18340     * @param obj The genlist object
18341     * @return The active item for that current mode. Or @c NULL if no item is
18342     * activated with any mode.
18343     *
18344     * This function returns the item that was activated with a mode, by the
18345     * function elm_genlist_item_mode_set().
18346     *
18347     * @see elm_genlist_item_mode_set()
18348     * @see elm_genlist_mode_get()
18349     *
18350     * @ingroup Genlist
18351     */
18352    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18353
18354    /**
18355     * Set reorder mode
18356     *
18357     * @param obj The genlist object
18358     * @param reorder_mode The reorder mode
18359     * (EINA_TRUE = on, EINA_FALSE = off)
18360     *
18361     * @ingroup Genlist
18362     */
18363    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18364
18365    /**
18366     * Get the reorder mode
18367     *
18368     * @param obj The genlist object
18369     * @return The reorder mode
18370     * (EINA_TRUE = on, EINA_FALSE = off)
18371     *
18372     * @ingroup Genlist
18373     */
18374    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18375
18376    /**
18377     * @}
18378     */
18379
18380    /**
18381     * @defgroup Check Check
18382     *
18383     * @image html img/widget/check/preview-00.png
18384     * @image latex img/widget/check/preview-00.eps
18385     * @image html img/widget/check/preview-01.png
18386     * @image latex img/widget/check/preview-01.eps
18387     * @image html img/widget/check/preview-02.png
18388     * @image latex img/widget/check/preview-02.eps
18389     *
18390     * @brief The check widget allows for toggling a value between true and
18391     * false.
18392     *
18393     * Check objects are a lot like radio objects in layout and functionality
18394     * except they do not work as a group, but independently and only toggle the
18395     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18396     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18397     * returns the current state. For convenience, like the radio objects, you
18398     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18399     * for it to modify.
18400     *
18401     * Signals that you can add callbacks for are:
18402     * "changed" - This is called whenever the user changes the state of one of
18403     *             the check object(event_info is NULL).
18404     *
18405     * @ref tutorial_check should give you a firm grasp of how to use this widget.
18406     * @{
18407     */
18408    /**
18409     * @brief Add a new Check object
18410     *
18411     * @param parent The parent object
18412     * @return The new object or NULL if it cannot be created
18413     */
18414    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18415    /**
18416     * @brief Set the text label of the check object
18417     *
18418     * @param obj The check object
18419     * @param label The text label string in UTF-8
18420     *
18421     * @deprecated use elm_object_text_set() instead.
18422     */
18423    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18424    /**
18425     * @brief Get the text label of the check object
18426     *
18427     * @param obj The check object
18428     * @return The text label string in UTF-8
18429     *
18430     * @deprecated use elm_object_text_get() instead.
18431     */
18432    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18433    /**
18434     * @brief Set the icon object of the check object
18435     *
18436     * @param obj The check object
18437     * @param icon The icon object
18438     *
18439     * Once the icon object is set, a previously set one will be deleted.
18440     * If you want to keep that old content object, use the
18441     * elm_check_icon_unset() function.
18442     */
18443    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18444    /**
18445     * @brief Get the icon object of the check object
18446     *
18447     * @param obj The check object
18448     * @return The icon object
18449     */
18450    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18451    /**
18452     * @brief Unset the icon used for the check object
18453     *
18454     * @param obj The check object
18455     * @return The icon object that was being used
18456     *
18457     * Unparent and return the icon object which was set for this widget.
18458     */
18459    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18460    /**
18461     * @brief Set the on/off state of the check object
18462     *
18463     * @param obj The check object
18464     * @param state The state to use (1 == on, 0 == off)
18465     *
18466     * This sets the state of the check. If set
18467     * with elm_check_state_pointer_set() the state of that variable is also
18468     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18469     */
18470    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18471    /**
18472     * @brief Get the state of the check object
18473     *
18474     * @param obj The check object
18475     * @return The boolean state
18476     */
18477    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18478    /**
18479     * @brief Set a convenience pointer to a boolean to change
18480     *
18481     * @param obj The check object
18482     * @param statep Pointer to the boolean to modify
18483     *
18484     * This sets a pointer to a boolean, that, in addition to the check objects
18485     * state will also be modified directly. To stop setting the object pointed
18486     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18487     * then when this is called, the check objects state will also be modified to
18488     * reflect the value of the boolean @p statep points to, just like calling
18489     * elm_check_state_set().
18490     */
18491    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18492    /**
18493     * @}
18494     */
18495
18496    /**
18497     * @defgroup Radio Radio
18498     *
18499     * @image html img/widget/radio/preview-00.png
18500     * @image latex img/widget/radio/preview-00.eps
18501     *
18502     * @brief Radio is a widget that allows for 1 or more options to be displayed
18503     * and have the user choose only 1 of them.
18504     *
18505     * A radio object contains an indicator, an optional Label and an optional
18506     * icon object. While it's possible to have a group of only one radio they,
18507     * are normally used in groups of 2 or more. To add a radio to a group use
18508     * elm_radio_group_add(). The radio object(s) will select from one of a set
18509     * of integer values, so any value they are configuring needs to be mapped to
18510     * a set of integers. To configure what value that radio object represents,
18511     * use  elm_radio_state_value_set() to set the integer it represents. To set
18512     * the value the whole group(which one is currently selected) is to indicate
18513     * use elm_radio_value_set() on any group member, and to get the groups value
18514     * use elm_radio_value_get(). For convenience the radio objects are also able
18515     * to directly set an integer(int) to the value that is selected. To specify
18516     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18517     * The radio objects will modify this directly. That implies the pointer must
18518     * point to valid memory for as long as the radio objects exist.
18519     *
18520     * Signals that you can add callbacks for are:
18521     * @li changed - This is called whenever the user changes the state of one of
18522     * the radio objects within the group of radio objects that work together.
18523     *
18524     * @ref tutorial_radio show most of this API in action.
18525     * @{
18526     */
18527    /**
18528     * @brief Add a new radio to the parent
18529     *
18530     * @param parent The parent object
18531     * @return The new object or NULL if it cannot be created
18532     */
18533    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18534    /**
18535     * @brief Set the text label of the radio object
18536     *
18537     * @param obj The radio object
18538     * @param label The text label string in UTF-8
18539     *
18540     * @deprecated use elm_object_text_set() instead.
18541     */
18542    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18543    /**
18544     * @brief Get the text label of the radio object
18545     *
18546     * @param obj The radio object
18547     * @return The text label string in UTF-8
18548     *
18549     * @deprecated use elm_object_text_set() instead.
18550     */
18551    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18552    /**
18553     * @brief Set the icon object of the radio object
18554     *
18555     * @param obj The radio object
18556     * @param icon The icon object
18557     *
18558     * Once the icon object is set, a previously set one will be deleted. If you
18559     * want to keep that old content object, use the elm_radio_icon_unset()
18560     * function.
18561     */
18562    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18563    /**
18564     * @brief Get the icon object of the radio object
18565     *
18566     * @param obj The radio object
18567     * @return The icon object
18568     *
18569     * @see elm_radio_icon_set()
18570     */
18571    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18572    /**
18573     * @brief Unset the icon used for the radio object
18574     *
18575     * @param obj The radio object
18576     * @return The icon object that was being used
18577     *
18578     * Unparent and return the icon object which was set for this widget.
18579     *
18580     * @see elm_radio_icon_set()
18581     */
18582    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18583    /**
18584     * @brief Add this radio to a group of other radio objects
18585     *
18586     * @param obj The radio object
18587     * @param group Any object whose group the @p obj is to join.
18588     *
18589     * Radio objects work in groups. Each member should have a different integer
18590     * value assigned. In order to have them work as a group, they need to know
18591     * about each other. This adds the given radio object to the group of which
18592     * the group object indicated is a member.
18593     */
18594    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18595    /**
18596     * @brief Set the integer value that this radio object represents
18597     *
18598     * @param obj The radio object
18599     * @param value The value to use if this radio object is selected
18600     *
18601     * This sets the value of the radio.
18602     */
18603    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18604    /**
18605     * @brief Get the integer value that this radio object represents
18606     *
18607     * @param obj The radio object
18608     * @return The value used if this radio object is selected
18609     *
18610     * This gets the value of the radio.
18611     *
18612     * @see elm_radio_value_set()
18613     */
18614    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18615    /**
18616     * @brief Set the value of the radio.
18617     *
18618     * @param obj The radio object
18619     * @param value The value to use for the group
18620     *
18621     * This sets the value of the radio group and will also set the value if
18622     * pointed to, to the value supplied, but will not call any callbacks.
18623     */
18624    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18625    /**
18626     * @brief Get the state of the radio object
18627     *
18628     * @param obj The radio object
18629     * @return The integer state
18630     */
18631    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18632    /**
18633     * @brief Set a convenience pointer to a integer to change
18634     *
18635     * @param obj The radio object
18636     * @param valuep Pointer to the integer to modify
18637     *
18638     * This sets a pointer to a integer, that, in addition to the radio objects
18639     * state will also be modified directly. To stop setting the object pointed
18640     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18641     * when this is called, the radio objects state will also be modified to
18642     * reflect the value of the integer valuep points to, just like calling
18643     * elm_radio_value_set().
18644     */
18645    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18646    /**
18647     * @}
18648     */
18649
18650    /**
18651     * @defgroup Pager Pager
18652     *
18653     * @image html img/widget/pager/preview-00.png
18654     * @image latex img/widget/pager/preview-00.eps
18655     *
18656     * @brief Widget that allows flipping between 1 or more “pages” of objects.
18657     *
18658     * The flipping between “pages” of objects is animated. All content in pager
18659     * is kept in a stack, the last content to be added will be on the top of the
18660     * stack(be visible).
18661     *
18662     * Objects can be pushed or popped from the stack or deleted as normal.
18663     * Pushes and pops will animate (and a pop will delete the object once the
18664     * animation is finished). Any object already in the pager can be promoted to
18665     * the top(from its current stacking position) through the use of
18666     * elm_pager_content_promote(). Objects are pushed to the top with
18667     * elm_pager_content_push() and when the top item is no longer wanted, simply
18668     * pop it with elm_pager_content_pop() and it will also be deleted. If an
18669     * object is no longer needed and is not the top item, just delete it as
18670     * normal. You can query which objects are the top and bottom with
18671     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18672     *
18673     * Signals that you can add callbacks for are:
18674     * "hide,finished" - when the previous page is hided
18675     *
18676     * This widget has the following styles available:
18677     * @li default
18678     * @li fade
18679     * @li fade_translucide
18680     * @li fade_invisible
18681     * @note This styles affect only the flipping animations, the appearance when
18682     * not animating is unaffected by styles.
18683     *
18684     * @ref tutorial_pager gives a good overview of the usage of the API.
18685     * @{
18686     */
18687    /**
18688     * Add a new pager to the parent
18689     *
18690     * @param parent The parent object
18691     * @return The new object or NULL if it cannot be created
18692     *
18693     * @ingroup Pager
18694     */
18695    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18696    /**
18697     * @brief Push an object to the top of the pager stack (and show it).
18698     *
18699     * @param obj The pager object
18700     * @param content The object to push
18701     *
18702     * The object pushed becomes a child of the pager, it will be controlled and
18703     * deleted when the pager is deleted.
18704     *
18705     * @note If the content is already in the stack use
18706     * elm_pager_content_promote().
18707     * @warning Using this function on @p content already in the stack results in
18708     * undefined behavior.
18709     */
18710    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18711    /**
18712     * @brief Pop the object that is on top of the stack
18713     *
18714     * @param obj The pager object
18715     *
18716     * This pops the object that is on the top(visible) of the pager, makes it
18717     * disappear, then deletes the object. The object that was underneath it on
18718     * the stack will become visible.
18719     */
18720    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18721    /**
18722     * @brief Moves an object already in the pager stack to the top of the stack.
18723     *
18724     * @param obj The pager object
18725     * @param content The object to promote
18726     *
18727     * This will take the @p content and move it to the top of the stack as
18728     * if it had been pushed there.
18729     *
18730     * @note If the content isn't already in the stack use
18731     * elm_pager_content_push().
18732     * @warning Using this function on @p content not already in the stack
18733     * results in undefined behavior.
18734     */
18735    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18736    /**
18737     * @brief Return the object at the bottom of the pager stack
18738     *
18739     * @param obj The pager object
18740     * @return The bottom object or NULL if none
18741     */
18742    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18743    /**
18744     * @brief  Return the object at the top of the pager stack
18745     *
18746     * @param obj The pager object
18747     * @return The top object or NULL if none
18748     */
18749    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18750    /**
18751     * @}
18752     */
18753
18754    /**
18755     * @defgroup Slideshow Slideshow
18756     *
18757     * @image html img/widget/slideshow/preview-00.png
18758     * @image latex img/widget/slideshow/preview-00.eps
18759     *
18760     * This widget, as the name indicates, is a pre-made image
18761     * slideshow panel, with API functions acting on (child) image
18762     * items presentation. Between those actions, are:
18763     * - advance to next/previous image
18764     * - select the style of image transition animation
18765     * - set the exhibition time for each image
18766     * - start/stop the slideshow
18767     *
18768     * The transition animations are defined in the widget's theme,
18769     * consequently new animations can be added without having to
18770     * update the widget's code.
18771     *
18772     * @section Slideshow_Items Slideshow items
18773     *
18774     * For slideshow items, just like for @ref Genlist "genlist" ones,
18775     * the user defines a @b classes, specifying functions that will be
18776     * called on the item's creation and deletion times.
18777     *
18778     * The #Elm_Slideshow_Item_Class structure contains the following
18779     * members:
18780     *
18781     * - @c func.get - When an item is displayed, this function is
18782     *   called, and it's where one should create the item object, de
18783     *   facto. For example, the object can be a pure Evas image object
18784     *   or an Elementary @ref Photocam "photocam" widget. See
18785     *   #SlideshowItemGetFunc.
18786     * - @c func.del - When an item is no more displayed, this function
18787     *   is called, where the user must delete any data associated to
18788     *   the item. See #SlideshowItemDelFunc.
18789     *
18790     * @section Slideshow_Caching Slideshow caching
18791     *
18792     * The slideshow provides facilities to have items adjacent to the
18793     * one being displayed <b>already "realized"</b> (i.e. loaded) for
18794     * you, so that the system does not have to decode image data
18795     * anymore at the time it has to actually switch images on its
18796     * viewport. The user is able to set the numbers of items to be
18797     * cached @b before and @b after the current item, in the widget's
18798     * item list.
18799     *
18800     * Smart events one can add callbacks for are:
18801     *
18802     * - @c "changed" - when the slideshow switches its view to a new
18803     *   item
18804     *
18805     * List of examples for the slideshow widget:
18806     * @li @ref slideshow_example
18807     */
18808
18809    /**
18810     * @addtogroup Slideshow
18811     * @{
18812     */
18813
18814    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18815    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18816    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
18817    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18818    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18819
18820    /**
18821     * @struct _Elm_Slideshow_Item_Class
18822     *
18823     * Slideshow item class definition. See @ref Slideshow_Items for
18824     * field details.
18825     */
18826    struct _Elm_Slideshow_Item_Class
18827      {
18828         struct _Elm_Slideshow_Item_Class_Func
18829           {
18830              SlideshowItemGetFunc get;
18831              SlideshowItemDelFunc del;
18832           } func;
18833      }; /**< #Elm_Slideshow_Item_Class member definitions */
18834
18835    /**
18836     * Add a new slideshow widget to the given parent Elementary
18837     * (container) object
18838     *
18839     * @param parent The parent object
18840     * @return A new slideshow widget handle or @c NULL, on errors
18841     *
18842     * This function inserts a new slideshow widget on the canvas.
18843     *
18844     * @ingroup Slideshow
18845     */
18846    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18847
18848    /**
18849     * Add (append) a new item in a given slideshow widget.
18850     *
18851     * @param obj The slideshow object
18852     * @param itc The item class for the item
18853     * @param data The item's data
18854     * @return A handle to the item added or @c NULL, on errors
18855     *
18856     * Add a new item to @p obj's internal list of items, appending it.
18857     * The item's class must contain the function really fetching the
18858     * image object to show for this item, which could be an Evas image
18859     * object or an Elementary photo, for example. The @p data
18860     * parameter is going to be passed to both class functions of the
18861     * item.
18862     *
18863     * @see #Elm_Slideshow_Item_Class
18864     * @see elm_slideshow_item_sorted_insert()
18865     *
18866     * @ingroup Slideshow
18867     */
18868    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18869
18870    /**
18871     * Insert a new item into the given slideshow widget, using the @p func
18872     * function to sort items (by item handles).
18873     *
18874     * @param obj The slideshow object
18875     * @param itc The item class for the item
18876     * @param data The item's data
18877     * @param func The comparing function to be used to sort slideshow
18878     * items <b>by #Elm_Slideshow_Item item handles</b>
18879     * @return Returns The slideshow item handle, on success, or
18880     * @c NULL, on errors
18881     *
18882     * Add a new item to @p obj's internal list of items, in a position
18883     * determined by the @p func comparing function. The item's class
18884     * must contain the function really fetching the image object to
18885     * show for this item, which could be an Evas image object or an
18886     * Elementary photo, for example. The @p data parameter is going to
18887     * be passed to both class functions of the item.
18888     *
18889     * @see #Elm_Slideshow_Item_Class
18890     * @see elm_slideshow_item_add()
18891     *
18892     * @ingroup Slideshow
18893     */
18894    EAPI Elm_Slideshow_Item *elm_slideshow_item_sorted_insert(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data, Eina_Compare_Cb func) EINA_ARG_NONNULL(1);
18895
18896    /**
18897     * Display a given slideshow widget's item, programmatically.
18898     *
18899     * @param obj The slideshow object
18900     * @param item The item to display on @p obj's viewport
18901     *
18902     * The change between the current item and @p item will use the
18903     * transition @p obj is set to use (@see
18904     * elm_slideshow_transition_set()).
18905     *
18906     * @ingroup Slideshow
18907     */
18908    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18909
18910    /**
18911     * Slide to the @b next item, in a given slideshow widget
18912     *
18913     * @param obj The slideshow object
18914     *
18915     * The sliding animation @p obj is set to use will be the
18916     * transition effect used, after this call is issued.
18917     *
18918     * @note If the end of the slideshow's internal list of items is
18919     * reached, it'll wrap around to the list's beginning, again.
18920     *
18921     * @ingroup Slideshow
18922     */
18923    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18924
18925    /**
18926     * Slide to the @b previous item, in a given slideshow widget
18927     *
18928     * @param obj The slideshow object
18929     *
18930     * The sliding animation @p obj is set to use will be the
18931     * transition effect used, after this call is issued.
18932     *
18933     * @note If the beginning of the slideshow's internal list of items
18934     * is reached, it'll wrap around to the list's end, again.
18935     *
18936     * @ingroup Slideshow
18937     */
18938    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18939
18940    /**
18941     * Returns the list of sliding transition/effect names available, for a
18942     * given slideshow widget.
18943     *
18944     * @param obj The slideshow object
18945     * @return The list of transitions (list of @b stringshared strings
18946     * as data)
18947     *
18948     * The transitions, which come from @p obj's theme, must be an EDC
18949     * data item named @c "transitions" on the theme file, with (prefix)
18950     * names of EDC programs actually implementing them.
18951     *
18952     * The available transitions for slideshows on the default theme are:
18953     * - @c "fade" - the current item fades out, while the new one
18954     *   fades in to the slideshow's viewport.
18955     * - @c "black_fade" - the current item fades to black, and just
18956     *   then, the new item will fade in.
18957     * - @c "horizontal" - the current item slides horizontally, until
18958     *   it gets out of the slideshow's viewport, while the new item
18959     *   comes from the left to take its place.
18960     * - @c "vertical" - the current item slides vertically, until it
18961     *   gets out of the slideshow's viewport, while the new item comes
18962     *   from the bottom to take its place.
18963     * - @c "square" - the new item starts to appear from the middle of
18964     *   the current one, but with a tiny size, growing until its
18965     *   target (full) size and covering the old one.
18966     *
18967     * @warning The stringshared strings get no new references
18968     * exclusive to the user grabbing the list, here, so if you'd like
18969     * to use them out of this call's context, you'd better @c
18970     * eina_stringshare_ref() them.
18971     *
18972     * @see elm_slideshow_transition_set()
18973     *
18974     * @ingroup Slideshow
18975     */
18976    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18977
18978    /**
18979     * Set the current slide transition/effect in use for a given
18980     * slideshow widget
18981     *
18982     * @param obj The slideshow object
18983     * @param transition The new transition's name string
18984     *
18985     * If @p transition is implemented in @p obj's theme (i.e., is
18986     * contained in the list returned by
18987     * elm_slideshow_transitions_get()), this new sliding effect will
18988     * be used on the widget.
18989     *
18990     * @see elm_slideshow_transitions_get() for more details
18991     *
18992     * @ingroup Slideshow
18993     */
18994    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18995
18996    /**
18997     * Get the current slide transition/effect in use for a given
18998     * slideshow widget
18999     *
19000     * @param obj The slideshow object
19001     * @return The current transition's name
19002     *
19003     * @see elm_slideshow_transition_set() for more details
19004     *
19005     * @ingroup Slideshow
19006     */
19007    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19008
19009    /**
19010     * Set the interval between each image transition on a given
19011     * slideshow widget, <b>and start the slideshow, itself</b>
19012     *
19013     * @param obj The slideshow object
19014     * @param timeout The new displaying timeout for images
19015     *
19016     * After this call, the slideshow widget will start cycling its
19017     * view, sequentially and automatically, with the images of the
19018     * items it has. The time between each new image displayed is going
19019     * to be @p timeout, in @b seconds. If a different timeout was set
19020     * previously and an slideshow was in progress, it will continue
19021     * with the new time between transitions, after this call.
19022     *
19023     * @note A value less than or equal to 0 on @p timeout will disable
19024     * the widget's internal timer, thus halting any slideshow which
19025     * could be happening on @p obj.
19026     *
19027     * @see elm_slideshow_timeout_get()
19028     *
19029     * @ingroup Slideshow
19030     */
19031    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
19032
19033    /**
19034     * Get the interval set for image transitions on a given slideshow
19035     * widget.
19036     *
19037     * @param obj The slideshow object
19038     * @return Returns the timeout set on it
19039     *
19040     * @see elm_slideshow_timeout_set() for more details
19041     *
19042     * @ingroup Slideshow
19043     */
19044    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19045
19046    /**
19047     * Set if, after a slideshow is started, for a given slideshow
19048     * widget, its items should be displayed cyclically or not.
19049     *
19050     * @param obj The slideshow object
19051     * @param loop Use @c EINA_TRUE to make it cycle through items or
19052     * @c EINA_FALSE for it to stop at the end of @p obj's internal
19053     * list of items
19054     *
19055     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
19056     * ignore what is set by this functions, i.e., they'll @b always
19057     * cycle through items. This affects only the "automatic"
19058     * slideshow, as set by elm_slideshow_timeout_set().
19059     *
19060     * @see elm_slideshow_loop_get()
19061     *
19062     * @ingroup Slideshow
19063     */
19064    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
19065
19066    /**
19067     * Get if, after a slideshow is started, for a given slideshow
19068     * widget, its items are to be displayed cyclically or not.
19069     *
19070     * @param obj The slideshow object
19071     * @return @c EINA_TRUE, if the items in @p obj will be cycled
19072     * through or @c EINA_FALSE, otherwise
19073     *
19074     * @see elm_slideshow_loop_set() for more details
19075     *
19076     * @ingroup Slideshow
19077     */
19078    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19079
19080    /**
19081     * Remove all items from a given slideshow widget
19082     *
19083     * @param obj The slideshow object
19084     *
19085     * This removes (and deletes) all items in @p obj, leaving it
19086     * empty.
19087     *
19088     * @see elm_slideshow_item_del(), to remove just one item.
19089     *
19090     * @ingroup Slideshow
19091     */
19092    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
19093
19094    /**
19095     * Get the internal list of items in a given slideshow widget.
19096     *
19097     * @param obj The slideshow object
19098     * @return The list of items (#Elm_Slideshow_Item as data) or
19099     * @c NULL on errors.
19100     *
19101     * This list is @b not to be modified in any way and must not be
19102     * freed. Use the list members with functions like
19103     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
19104     *
19105     * @warning This list is only valid until @p obj object's internal
19106     * items list is changed. It should be fetched again with another
19107     * call to this function when changes happen.
19108     *
19109     * @ingroup Slideshow
19110     */
19111    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19112
19113    /**
19114     * Delete a given item from a slideshow widget.
19115     *
19116     * @param item The slideshow item
19117     *
19118     * @ingroup Slideshow
19119     */
19120    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19121
19122    /**
19123     * Return the data associated with a given slideshow item
19124     *
19125     * @param item The slideshow item
19126     * @return Returns the data associated to this item
19127     *
19128     * @ingroup Slideshow
19129     */
19130    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19131
19132    /**
19133     * Returns the currently displayed item, in a given slideshow widget
19134     *
19135     * @param obj The slideshow object
19136     * @return A handle to the item being displayed in @p obj or
19137     * @c NULL, if none is (and on errors)
19138     *
19139     * @ingroup Slideshow
19140     */
19141    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19142
19143    /**
19144     * Get the real Evas object created to implement the view of a
19145     * given slideshow item
19146     *
19147     * @param item The slideshow item.
19148     * @return the Evas object implementing this item's view.
19149     *
19150     * This returns the actual Evas object used to implement the
19151     * specified slideshow item's view. This may be @c NULL, as it may
19152     * not have been created or may have been deleted, at any time, by
19153     * the slideshow. <b>Do not modify this object</b> (move, resize,
19154     * show, hide, etc.), as the slideshow is controlling it. This
19155     * function is for querying, emitting custom signals or hooking
19156     * lower level callbacks for events on that object. Do not delete
19157     * this object under any circumstances.
19158     *
19159     * @see elm_slideshow_item_data_get()
19160     *
19161     * @ingroup Slideshow
19162     */
19163    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
19164
19165    /**
19166     * Get the the item, in a given slideshow widget, placed at
19167     * position @p nth, in its internal items list
19168     *
19169     * @param obj The slideshow object
19170     * @param nth The number of the item to grab a handle to (0 being
19171     * the first)
19172     * @return The item stored in @p obj at position @p nth or @c NULL,
19173     * if there's no item with that index (and on errors)
19174     *
19175     * @ingroup Slideshow
19176     */
19177    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
19178
19179    /**
19180     * Set the current slide layout in use for a given slideshow widget
19181     *
19182     * @param obj The slideshow object
19183     * @param layout The new layout's name string
19184     *
19185     * If @p layout is implemented in @p obj's theme (i.e., is contained
19186     * in the list returned by elm_slideshow_layouts_get()), this new
19187     * images layout will be used on the widget.
19188     *
19189     * @see elm_slideshow_layouts_get() for more details
19190     *
19191     * @ingroup Slideshow
19192     */
19193    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
19194
19195    /**
19196     * Get the current slide layout in use for a given slideshow widget
19197     *
19198     * @param obj The slideshow object
19199     * @return The current layout's name
19200     *
19201     * @see elm_slideshow_layout_set() for more details
19202     *
19203     * @ingroup Slideshow
19204     */
19205    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19206
19207    /**
19208     * Returns the list of @b layout names available, for a given
19209     * slideshow widget.
19210     *
19211     * @param obj The slideshow object
19212     * @return The list of layouts (list of @b stringshared strings
19213     * as data)
19214     *
19215     * Slideshow layouts will change how the widget is to dispose each
19216     * image item in its viewport, with regard to cropping, scaling,
19217     * etc.
19218     *
19219     * The layouts, which come from @p obj's theme, must be an EDC
19220     * data item name @c "layouts" on the theme file, with (prefix)
19221     * names of EDC programs actually implementing them.
19222     *
19223     * The available layouts for slideshows on the default theme are:
19224     * - @c "fullscreen" - item images with original aspect, scaled to
19225     *   touch top and down slideshow borders or, if the image's heigh
19226     *   is not enough, left and right slideshow borders.
19227     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19228     *   one, but always leaving 10% of the slideshow's dimensions of
19229     *   distance between the item image's borders and the slideshow
19230     *   borders, for each axis.
19231     *
19232     * @warning The stringshared strings get no new references
19233     * exclusive to the user grabbing the list, here, so if you'd like
19234     * to use them out of this call's context, you'd better @c
19235     * eina_stringshare_ref() them.
19236     *
19237     * @see elm_slideshow_layout_set()
19238     *
19239     * @ingroup Slideshow
19240     */
19241    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19242
19243    /**
19244     * Set the number of items to cache, on a given slideshow widget,
19245     * <b>before the current item</b>
19246     *
19247     * @param obj The slideshow object
19248     * @param count Number of items to cache before the current one
19249     *
19250     * The default value for this property is @c 2. See
19251     * @ref Slideshow_Caching "slideshow caching" for more details.
19252     *
19253     * @see elm_slideshow_cache_before_get()
19254     *
19255     * @ingroup Slideshow
19256     */
19257    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19258
19259    /**
19260     * Retrieve the number of items to cache, on a given slideshow widget,
19261     * <b>before the current item</b>
19262     *
19263     * @param obj The slideshow object
19264     * @return The number of items set to be cached before the current one
19265     *
19266     * @see elm_slideshow_cache_before_set() for more details
19267     *
19268     * @ingroup Slideshow
19269     */
19270    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19271
19272    /**
19273     * Set the number of items to cache, on a given slideshow widget,
19274     * <b>after the current item</b>
19275     *
19276     * @param obj The slideshow object
19277     * @param count Number of items to cache after the current one
19278     *
19279     * The default value for this property is @c 2. See
19280     * @ref Slideshow_Caching "slideshow caching" for more details.
19281     *
19282     * @see elm_slideshow_cache_after_get()
19283     *
19284     * @ingroup Slideshow
19285     */
19286    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19287
19288    /**
19289     * Retrieve the number of items to cache, on a given slideshow widget,
19290     * <b>after the current item</b>
19291     *
19292     * @param obj The slideshow object
19293     * @return The number of items set to be cached after the current one
19294     *
19295     * @see elm_slideshow_cache_after_set() for more details
19296     *
19297     * @ingroup Slideshow
19298     */
19299    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19300
19301    /**
19302     * Get the number of items stored in a given slideshow widget
19303     *
19304     * @param obj The slideshow object
19305     * @return The number of items on @p obj, at the moment of this call
19306     *
19307     * @ingroup Slideshow
19308     */
19309    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19310
19311    /**
19312     * @}
19313     */
19314
19315    /**
19316     * @defgroup Fileselector File Selector
19317     *
19318     * @image html img/widget/fileselector/preview-00.png
19319     * @image latex img/widget/fileselector/preview-00.eps
19320     *
19321     * A file selector is a widget that allows a user to navigate
19322     * through a file system, reporting file selections back via its
19323     * API.
19324     *
19325     * It contains shortcut buttons for home directory (@c ~) and to
19326     * jump one directory upwards (..), as well as cancel/ok buttons to
19327     * confirm/cancel a given selection. After either one of those two
19328     * former actions, the file selector will issue its @c "done" smart
19329     * callback.
19330     *
19331     * There's a text entry on it, too, showing the name of the current
19332     * selection. There's the possibility of making it editable, so it
19333     * is useful on file saving dialogs on applications, where one
19334     * gives a file name to save contents to, in a given directory in
19335     * the system. This custom file name will be reported on the @c
19336     * "done" smart callback (explained in sequence).
19337     *
19338     * Finally, it has a view to display file system items into in two
19339     * possible forms:
19340     * - list
19341     * - grid
19342     *
19343     * If Elementary is built with support of the Ethumb thumbnailing
19344     * library, the second form of view will display preview thumbnails
19345     * of files which it supports.
19346     *
19347     * Smart callbacks one can register to:
19348     *
19349     * - @c "selected" - the user has clicked on a file (when not in
19350     *      folders-only mode) or directory (when in folders-only mode)
19351     * - @c "directory,open" - the list has been populated with new
19352     *      content (@c event_info is a pointer to the directory's
19353     *      path, a @b stringshared string)
19354     * - @c "done" - the user has clicked on the "ok" or "cancel"
19355     *      buttons (@c event_info is a pointer to the selection's
19356     *      path, a @b stringshared string)
19357     *
19358     * Here is an example on its usage:
19359     * @li @ref fileselector_example
19360     */
19361
19362    /**
19363     * @addtogroup Fileselector
19364     * @{
19365     */
19366
19367    /**
19368     * Defines how a file selector widget is to layout its contents
19369     * (file system entries).
19370     */
19371    typedef enum _Elm_Fileselector_Mode
19372      {
19373         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19374         ELM_FILESELECTOR_GRID, /**< layout as a grid */
19375         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19376      } Elm_Fileselector_Mode;
19377
19378    /**
19379     * Add a new file selector widget to the given parent Elementary
19380     * (container) object
19381     *
19382     * @param parent The parent object
19383     * @return a new file selector widget handle or @c NULL, on errors
19384     *
19385     * This function inserts a new file selector widget on the canvas.
19386     *
19387     * @ingroup Fileselector
19388     */
19389    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19390
19391    /**
19392     * Enable/disable the file name entry box where the user can type
19393     * in a name for a file, in a given file selector widget
19394     *
19395     * @param obj The file selector object
19396     * @param is_save @c EINA_TRUE to make the file selector a "saving
19397     * dialog", @c EINA_FALSE otherwise
19398     *
19399     * Having the entry editable is useful on file saving dialogs on
19400     * applications, where one gives a file name to save contents to,
19401     * in a given directory in the system. This custom file name will
19402     * be reported on the @c "done" smart callback.
19403     *
19404     * @see elm_fileselector_is_save_get()
19405     *
19406     * @ingroup Fileselector
19407     */
19408    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19409
19410    /**
19411     * Get whether the given file selector is in "saving dialog" mode
19412     *
19413     * @param obj The file selector object
19414     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19415     * mode, @c EINA_FALSE otherwise (and on errors)
19416     *
19417     * @see elm_fileselector_is_save_set() for more details
19418     *
19419     * @ingroup Fileselector
19420     */
19421    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19422
19423    /**
19424     * Enable/disable folder-only view for a given file selector widget
19425     *
19426     * @param obj The file selector object
19427     * @param only @c EINA_TRUE to make @p obj only display
19428     * directories, @c EINA_FALSE to make files to be displayed in it
19429     * too
19430     *
19431     * If enabled, the widget's view will only display folder items,
19432     * naturally.
19433     *
19434     * @see elm_fileselector_folder_only_get()
19435     *
19436     * @ingroup Fileselector
19437     */
19438    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19439
19440    /**
19441     * Get whether folder-only view is set for a given file selector
19442     * widget
19443     *
19444     * @param obj The file selector object
19445     * @return only @c EINA_TRUE if @p obj is only displaying
19446     * directories, @c EINA_FALSE if files are being displayed in it
19447     * too (and on errors)
19448     *
19449     * @see elm_fileselector_folder_only_get()
19450     *
19451     * @ingroup Fileselector
19452     */
19453    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19454
19455    /**
19456     * Enable/disable the "ok" and "cancel" buttons on a given file
19457     * selector widget
19458     *
19459     * @param obj The file selector object
19460     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19461     *
19462     * @note A file selector without those buttons will never emit the
19463     * @c "done" smart event, and is only usable if one is just hooking
19464     * to the other two events.
19465     *
19466     * @see elm_fileselector_buttons_ok_cancel_get()
19467     *
19468     * @ingroup Fileselector
19469     */
19470    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19471
19472    /**
19473     * Get whether the "ok" and "cancel" buttons on a given file
19474     * selector widget are being shown.
19475     *
19476     * @param obj The file selector object
19477     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19478     * otherwise (and on errors)
19479     *
19480     * @see elm_fileselector_buttons_ok_cancel_set() for more details
19481     *
19482     * @ingroup Fileselector
19483     */
19484    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19485
19486    /**
19487     * Enable/disable a tree view in the given file selector widget,
19488     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19489     *
19490     * @param obj The file selector object
19491     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19492     * disable
19493     *
19494     * In a tree view, arrows are created on the sides of directories,
19495     * allowing them to expand in place.
19496     *
19497     * @note If it's in other mode, the changes made by this function
19498     * will only be visible when one switches back to "list" mode.
19499     *
19500     * @see elm_fileselector_expandable_get()
19501     *
19502     * @ingroup Fileselector
19503     */
19504    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19505
19506    /**
19507     * Get whether tree view is enabled for the given file selector
19508     * widget
19509     *
19510     * @param obj The file selector object
19511     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19512     * otherwise (and or errors)
19513     *
19514     * @see elm_fileselector_expandable_set() for more details
19515     *
19516     * @ingroup Fileselector
19517     */
19518    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19519
19520    /**
19521     * Set, programmatically, the @b directory that a given file
19522     * selector widget will display contents from
19523     *
19524     * @param obj The file selector object
19525     * @param path The path to display in @p obj
19526     *
19527     * This will change the @b directory that @p obj is displaying. It
19528     * will also clear the text entry area on the @p obj object, which
19529     * displays select files' names.
19530     *
19531     * @see elm_fileselector_path_get()
19532     *
19533     * @ingroup Fileselector
19534     */
19535    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19536
19537    /**
19538     * Get the parent directory's path that a given file selector
19539     * widget is displaying
19540     *
19541     * @param obj The file selector object
19542     * @return The (full) path of the directory the file selector is
19543     * displaying, a @b stringshared string
19544     *
19545     * @see elm_fileselector_path_set()
19546     *
19547     * @ingroup Fileselector
19548     */
19549    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19550
19551    /**
19552     * Set, programmatically, the currently selected file/directory in
19553     * the given file selector widget
19554     *
19555     * @param obj The file selector object
19556     * @param path The (full) path to a file or directory
19557     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19558     * latter case occurs if the directory or file pointed to do not
19559     * exist.
19560     *
19561     * @see elm_fileselector_selected_get()
19562     *
19563     * @ingroup Fileselector
19564     */
19565    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19566
19567    /**
19568     * Get the currently selected item's (full) path, in the given file
19569     * selector widget
19570     *
19571     * @param obj The file selector object
19572     * @return The absolute path of the selected item, a @b
19573     * stringshared string
19574     *
19575     * @note Custom editions on @p obj object's text entry, if made,
19576     * will appear on the return string of this function, naturally.
19577     *
19578     * @see elm_fileselector_selected_set() for more details
19579     *
19580     * @ingroup Fileselector
19581     */
19582    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19583
19584    /**
19585     * Set the mode in which a given file selector widget will display
19586     * (layout) file system entries in its view
19587     *
19588     * @param obj The file selector object
19589     * @param mode The mode of the fileselector, being it one of
19590     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19591     * first one, naturally, will display the files in a list. The
19592     * latter will make the widget to display its entries in a grid
19593     * form.
19594     *
19595     * @note By using elm_fileselector_expandable_set(), the user may
19596     * trigger a tree view for that list.
19597     *
19598     * @note If Elementary is built with support of the Ethumb
19599     * thumbnailing library, the second form of view will display
19600     * preview thumbnails of files which it supports. You must have
19601     * elm_need_ethumb() called in your Elementary for thumbnailing to
19602     * work, though.
19603     *
19604     * @see elm_fileselector_expandable_set().
19605     * @see elm_fileselector_mode_get().
19606     *
19607     * @ingroup Fileselector
19608     */
19609    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19610
19611    /**
19612     * Get the mode in which a given file selector widget is displaying
19613     * (layouting) file system entries in its view
19614     *
19615     * @param obj The fileselector object
19616     * @return The mode in which the fileselector is at
19617     *
19618     * @see elm_fileselector_mode_set() for more details
19619     *
19620     * @ingroup Fileselector
19621     */
19622    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19623
19624    /**
19625     * @}
19626     */
19627
19628    /**
19629     * @defgroup Progressbar Progress bar
19630     *
19631     * The progress bar is a widget for visually representing the
19632     * progress status of a given job/task.
19633     *
19634     * A progress bar may be horizontal or vertical. It may display an
19635     * icon besides it, as well as primary and @b units labels. The
19636     * former is meant to label the widget as a whole, while the
19637     * latter, which is formatted with floating point values (and thus
19638     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19639     * units"</c>), is meant to label the widget's <b>progress
19640     * value</b>. Label, icon and unit strings/objects are @b optional
19641     * for progress bars.
19642     *
19643     * A progress bar may be @b inverted, in which state it gets its
19644     * values inverted, with high values being on the left or top and
19645     * low values on the right or bottom, as opposed to normally have
19646     * the low values on the former and high values on the latter,
19647     * respectively, for horizontal and vertical modes.
19648     *
19649     * The @b span of the progress, as set by
19650     * elm_progressbar_span_size_set(), is its length (horizontally or
19651     * vertically), unless one puts size hints on the widget to expand
19652     * on desired directions, by any container. That length will be
19653     * scaled by the object or applications scaling factor. At any
19654     * point code can query the progress bar for its value with
19655     * elm_progressbar_value_get().
19656     *
19657     * Available widget styles for progress bars:
19658     * - @c "default"
19659     * - @c "wheel" (simple style, no text, no progression, only
19660     *      "pulse" effect is available)
19661     *
19662     * Here is an example on its usage:
19663     * @li @ref progressbar_example
19664     */
19665
19666    /**
19667     * Add a new progress bar widget to the given parent Elementary
19668     * (container) object
19669     *
19670     * @param parent The parent object
19671     * @return a new progress bar widget handle or @c NULL, on errors
19672     *
19673     * This function inserts a new progress bar widget on the canvas.
19674     *
19675     * @ingroup Progressbar
19676     */
19677    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19678
19679    /**
19680     * Set whether a given progress bar widget is at "pulsing mode" or
19681     * not.
19682     *
19683     * @param obj The progress bar object
19684     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19685     * @c EINA_FALSE to put it back to its default one
19686     *
19687     * By default, progress bars will display values from the low to
19688     * high value boundaries. There are, though, contexts in which the
19689     * state of progression of a given task is @b unknown.  For those,
19690     * one can set a progress bar widget to a "pulsing state", to give
19691     * the user an idea that some computation is being held, but
19692     * without exact progress values. In the default theme it will
19693     * animate its bar with the contents filling in constantly and back
19694     * to non-filled, in a loop. To start and stop this pulsing
19695     * animation, one has to explicitly call elm_progressbar_pulse().
19696     *
19697     * @see elm_progressbar_pulse_get()
19698     * @see elm_progressbar_pulse()
19699     *
19700     * @ingroup Progressbar
19701     */
19702    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19703
19704    /**
19705     * Get whether a given progress bar widget is at "pulsing mode" or
19706     * not.
19707     *
19708     * @param obj The progress bar object
19709     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19710     * if it's in the default one (and on errors)
19711     *
19712     * @ingroup Progressbar
19713     */
19714    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19715
19716    /**
19717     * Start/stop a given progress bar "pulsing" animation, if its
19718     * under that mode
19719     *
19720     * @param obj The progress bar object
19721     * @param state @c EINA_TRUE, to @b start the pulsing animation,
19722     * @c EINA_FALSE to @b stop it
19723     *
19724     * @note This call won't do anything if @p obj is not under "pulsing mode".
19725     *
19726     * @see elm_progressbar_pulse_set() for more details.
19727     *
19728     * @ingroup Progressbar
19729     */
19730    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19731
19732    /**
19733     * Set the progress value (in percentage) on a given progress bar
19734     * widget
19735     *
19736     * @param obj The progress bar object
19737     * @param val The progress value (@b must be between @c 0.0 and @c
19738     * 1.0)
19739     *
19740     * Use this call to set progress bar levels.
19741     *
19742     * @note If you passes a value out of the specified range for @p
19743     * val, it will be interpreted as the @b closest of the @b boundary
19744     * values in the range.
19745     *
19746     * @ingroup Progressbar
19747     */
19748    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19749
19750    /**
19751     * Get the progress value (in percentage) on a given progress bar
19752     * widget
19753     *
19754     * @param obj The progress bar object
19755     * @return The value of the progressbar
19756     *
19757     * @see elm_progressbar_value_set() for more details
19758     *
19759     * @ingroup Progressbar
19760     */
19761    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19762
19763    /**
19764     * Set the label of a given progress bar widget
19765     *
19766     * @param obj The progress bar object
19767     * @param label The text label string, in UTF-8
19768     *
19769     * @ingroup Progressbar
19770     * @deprecated use elm_object_text_set() instead.
19771     */
19772    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19773
19774    /**
19775     * Get the label of a given progress bar widget
19776     *
19777     * @param obj The progressbar object
19778     * @return The text label string, in UTF-8
19779     *
19780     * @ingroup Progressbar
19781     * @deprecated use elm_object_text_set() instead.
19782     */
19783    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19784
19785    /**
19786     * Set the icon object of a given progress bar widget
19787     *
19788     * @param obj The progress bar object
19789     * @param icon The icon object
19790     *
19791     * Use this call to decorate @p obj with an icon next to it.
19792     *
19793     * @note Once the icon object is set, a previously set one will be
19794     * deleted. If you want to keep that old content object, use the
19795     * elm_progressbar_icon_unset() function.
19796     *
19797     * @see elm_progressbar_icon_get()
19798     *
19799     * @ingroup Progressbar
19800     */
19801    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19802
19803    /**
19804     * Retrieve the icon object set for a given progress bar widget
19805     *
19806     * @param obj The progress bar object
19807     * @return The icon object's handle, if @p obj had one set, or @c NULL,
19808     * otherwise (and on errors)
19809     *
19810     * @see elm_progressbar_icon_set() for more details
19811     *
19812     * @ingroup Progressbar
19813     */
19814    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19815
19816    /**
19817     * Unset an icon set on a given progress bar widget
19818     *
19819     * @param obj The progress bar object
19820     * @return The icon object that was being used, if any was set, or
19821     * @c NULL, otherwise (and on errors)
19822     *
19823     * This call will unparent and return the icon object which was set
19824     * for this widget, previously, on success.
19825     *
19826     * @see elm_progressbar_icon_set() for more details
19827     *
19828     * @ingroup Progressbar
19829     */
19830    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19831
19832    /**
19833     * Set the (exact) length of the bar region of a given progress bar
19834     * widget
19835     *
19836     * @param obj The progress bar object
19837     * @param size The length of the progress bar's bar region
19838     *
19839     * This sets the minimum width (when in horizontal mode) or height
19840     * (when in vertical mode) of the actual bar area of the progress
19841     * bar @p obj. This in turn affects the object's minimum size. Use
19842     * this when you're not setting other size hints expanding on the
19843     * given direction (like weight and alignment hints) and you would
19844     * like it to have a specific size.
19845     *
19846     * @note Icon, label and unit text around @p obj will require their
19847     * own space, which will make @p obj to require more the @p size,
19848     * actually.
19849     *
19850     * @see elm_progressbar_span_size_get()
19851     *
19852     * @ingroup Progressbar
19853     */
19854    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19855
19856    /**
19857     * Get the length set for the bar region of a given progress bar
19858     * widget
19859     *
19860     * @param obj The progress bar object
19861     * @return The length of the progress bar's bar region
19862     *
19863     * If that size was not set previously, with
19864     * elm_progressbar_span_size_set(), this call will return @c 0.
19865     *
19866     * @ingroup Progressbar
19867     */
19868    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19869
19870    /**
19871     * Set the format string for a given progress bar widget's units
19872     * label
19873     *
19874     * @param obj The progress bar object
19875     * @param format The format string for @p obj's units label
19876     *
19877     * If @c NULL is passed on @p format, it will make @p obj's units
19878     * area to be hidden completely. If not, it'll set the <b>format
19879     * string</b> for the units label's @b text. The units label is
19880     * provided a floating point value, so the units text is up display
19881     * at most one floating point falue. Note that the units label is
19882     * optional. Use a format string such as "%1.2f meters" for
19883     * example.
19884     *
19885     * @note The default format string for a progress bar is an integer
19886     * percentage, as in @c "%.0f %%".
19887     *
19888     * @see elm_progressbar_unit_format_get()
19889     *
19890     * @ingroup Progressbar
19891     */
19892    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19893
19894    /**
19895     * Retrieve the format string set for a given progress bar widget's
19896     * units label
19897     *
19898     * @param obj The progress bar object
19899     * @return The format set string for @p obj's units label or
19900     * @c NULL, if none was set (and on errors)
19901     *
19902     * @see elm_progressbar_unit_format_set() for more details
19903     *
19904     * @ingroup Progressbar
19905     */
19906    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19907
19908    /**
19909     * Set the orientation of a given progress bar widget
19910     *
19911     * @param obj The progress bar object
19912     * @param horizontal Use @c EINA_TRUE to make @p obj to be
19913     * @b horizontal, @c EINA_FALSE to make it @b vertical
19914     *
19915     * Use this function to change how your progress bar is to be
19916     * disposed: vertically or horizontally.
19917     *
19918     * @see elm_progressbar_horizontal_get()
19919     *
19920     * @ingroup Progressbar
19921     */
19922    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19923
19924    /**
19925     * Retrieve the orientation of a given progress bar widget
19926     *
19927     * @param obj The progress bar object
19928     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19929     * @c EINA_FALSE if it's @b vertical (and on errors)
19930     *
19931     * @see elm_progressbar_horizontal_set() for more details
19932     *
19933     * @ingroup Progressbar
19934     */
19935    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19936
19937    /**
19938     * Invert a given progress bar widget's displaying values order
19939     *
19940     * @param obj The progress bar object
19941     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19942     * @c EINA_FALSE to bring it back to default, non-inverted values.
19943     *
19944     * A progress bar may be @b inverted, in which state it gets its
19945     * values inverted, with high values being on the left or top and
19946     * low values on the right or bottom, as opposed to normally have
19947     * the low values on the former and high values on the latter,
19948     * respectively, for horizontal and vertical modes.
19949     *
19950     * @see elm_progressbar_inverted_get()
19951     *
19952     * @ingroup Progressbar
19953     */
19954    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19955
19956    /**
19957     * Get whether a given progress bar widget's displaying values are
19958     * inverted or not
19959     *
19960     * @param obj The progress bar object
19961     * @return @c EINA_TRUE, if @p obj has inverted values,
19962     * @c EINA_FALSE otherwise (and on errors)
19963     *
19964     * @see elm_progressbar_inverted_set() for more details
19965     *
19966     * @ingroup Progressbar
19967     */
19968    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19969
19970    /**
19971     * @defgroup Separator Separator
19972     *
19973     * @brief Separator is a very thin object used to separate other objects.
19974     *
19975     * A separator can be vertical or horizontal.
19976     *
19977     * @ref tutorial_separator is a good example of how to use a separator.
19978     * @{
19979     */
19980    /**
19981     * @brief Add a separator object to @p parent
19982     *
19983     * @param parent The parent object
19984     *
19985     * @return The separator object, or NULL upon failure
19986     */
19987    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19988    /**
19989     * @brief Set the horizontal mode of a separator object
19990     *
19991     * @param obj The separator object
19992     * @param horizontal If true, the separator is horizontal
19993     */
19994    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19995    /**
19996     * @brief Get the horizontal mode of a separator object
19997     *
19998     * @param obj The separator object
19999     * @return If true, the separator is horizontal
20000     *
20001     * @see elm_separator_horizontal_set()
20002     */
20003    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20004    /**
20005     * @}
20006     */
20007
20008    /**
20009     * @defgroup Spinner Spinner
20010     * @ingroup Elementary
20011     *
20012     * @image html img/widget/spinner/preview-00.png
20013     * @image latex img/widget/spinner/preview-00.eps
20014     *
20015     * A spinner is a widget which allows the user to increase or decrease
20016     * numeric values using arrow buttons, or edit values directly, clicking
20017     * over it and typing the new value.
20018     *
20019     * By default the spinner will not wrap and has a label
20020     * of "%.0f" (just showing the integer value of the double).
20021     *
20022     * A spinner has a label that is formatted with floating
20023     * point values and thus accepts a printf-style format string, like
20024     * “%1.2f units”.
20025     *
20026     * It also allows specific values to be replaced by pre-defined labels.
20027     *
20028     * Smart callbacks one can register to:
20029     *
20030     * - "changed" - Whenever the spinner value is changed.
20031     * - "delay,changed" - A short time after the value is changed by the user.
20032     *    This will be called only when the user stops dragging for a very short
20033     *    period or when they release their finger/mouse, so it avoids possibly
20034     *    expensive reactions to the value change.
20035     *
20036     * Available styles for it:
20037     * - @c "default";
20038     * - @c "vertical": up/down buttons at the right side and text left aligned.
20039     *
20040     * Here is an example on its usage:
20041     * @ref spinner_example
20042     */
20043
20044    /**
20045     * @addtogroup Spinner
20046     * @{
20047     */
20048
20049    /**
20050     * Add a new spinner widget to the given parent Elementary
20051     * (container) object.
20052     *
20053     * @param parent The parent object.
20054     * @return a new spinner widget handle or @c NULL, on errors.
20055     *
20056     * This function inserts a new spinner widget on the canvas.
20057     *
20058     * @ingroup Spinner
20059     *
20060     */
20061    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20062
20063    /**
20064     * Set the format string of the displayed label.
20065     *
20066     * @param obj The spinner object.
20067     * @param fmt The format string for the label display.
20068     *
20069     * If @c NULL, this sets the format to "%.0f". If not it sets the format
20070     * string for the label text. The label text is provided a floating point
20071     * value, so the label text can display up to 1 floating point value.
20072     * Note that this is optional.
20073     *
20074     * Use a format string such as "%1.2f meters" for example, and it will
20075     * display values like: "3.14 meters" for a value equal to 3.14159.
20076     *
20077     * Default is "%0.f".
20078     *
20079     * @see elm_spinner_label_format_get()
20080     *
20081     * @ingroup Spinner
20082     */
20083    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
20084
20085    /**
20086     * Get the label format of the spinner.
20087     *
20088     * @param obj The spinner object.
20089     * @return The text label format string in UTF-8.
20090     *
20091     * @see elm_spinner_label_format_set() for details.
20092     *
20093     * @ingroup Spinner
20094     */
20095    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20096
20097    /**
20098     * Set the minimum and maximum values for the spinner.
20099     *
20100     * @param obj The spinner object.
20101     * @param min The minimum value.
20102     * @param max The maximum value.
20103     *
20104     * Define the allowed range of values to be selected by the user.
20105     *
20106     * If actual value is less than @p min, it will be updated to @p min. If it
20107     * is bigger then @p max, will be updated to @p max. Actual value can be
20108     * get with elm_spinner_value_get().
20109     *
20110     * By default, min is equal to 0, and max is equal to 100.
20111     *
20112     * @warning Maximum must be greater than minimum.
20113     *
20114     * @see elm_spinner_min_max_get()
20115     *
20116     * @ingroup Spinner
20117     */
20118    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
20119
20120    /**
20121     * Get the minimum and maximum values of the spinner.
20122     *
20123     * @param obj The spinner object.
20124     * @param min Pointer where to store the minimum value.
20125     * @param max Pointer where to store the maximum value.
20126     *
20127     * @note If only one value is needed, the other pointer can be passed
20128     * as @c NULL.
20129     *
20130     * @see elm_spinner_min_max_set() for details.
20131     *
20132     * @ingroup Spinner
20133     */
20134    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
20135
20136    /**
20137     * Set the step used to increment or decrement the spinner value.
20138     *
20139     * @param obj The spinner object.
20140     * @param step The step value.
20141     *
20142     * This value will be incremented or decremented to the displayed value.
20143     * It will be incremented while the user keep right or top arrow pressed,
20144     * and will be decremented while the user keep left or bottom arrow pressed.
20145     *
20146     * The interval to increment / decrement can be set with
20147     * elm_spinner_interval_set().
20148     *
20149     * By default step value is equal to 1.
20150     *
20151     * @see elm_spinner_step_get()
20152     *
20153     * @ingroup Spinner
20154     */
20155    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
20156
20157    /**
20158     * Get the step used to increment or decrement the spinner value.
20159     *
20160     * @param obj The spinner object.
20161     * @return The step value.
20162     *
20163     * @see elm_spinner_step_get() for more details.
20164     *
20165     * @ingroup Spinner
20166     */
20167    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20168
20169    /**
20170     * Set the value the spinner displays.
20171     *
20172     * @param obj The spinner object.
20173     * @param val The value to be displayed.
20174     *
20175     * Value will be presented on the label following format specified with
20176     * elm_spinner_format_set().
20177     *
20178     * @warning The value must to be between min and max values. This values
20179     * are set by elm_spinner_min_max_set().
20180     *
20181     * @see elm_spinner_value_get().
20182     * @see elm_spinner_format_set().
20183     * @see elm_spinner_min_max_set().
20184     *
20185     * @ingroup Spinner
20186     */
20187    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20188
20189    /**
20190     * Get the value displayed by the spinner.
20191     *
20192     * @param obj The spinner object.
20193     * @return The value displayed.
20194     *
20195     * @see elm_spinner_value_set() for details.
20196     *
20197     * @ingroup Spinner
20198     */
20199    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20200
20201    /**
20202     * Set whether the spinner should wrap when it reaches its
20203     * minimum or maximum value.
20204     *
20205     * @param obj The spinner object.
20206     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
20207     * disable it.
20208     *
20209     * Disabled by default. If disabled, when the user tries to increment the
20210     * value,
20211     * but displayed value plus step value is bigger than maximum value,
20212     * the spinner
20213     * won't allow it. The same happens when the user tries to decrement it,
20214     * but the value less step is less than minimum value.
20215     *
20216     * When wrap is enabled, in such situations it will allow these changes,
20217     * but will get the value that would be less than minimum and subtracts
20218     * from maximum. Or add the value that would be more than maximum to
20219     * the minimum.
20220     *
20221     * E.g.:
20222     * @li min value = 10
20223     * @li max value = 50
20224     * @li step value = 20
20225     * @li displayed value = 20
20226     *
20227     * When the user decrement value (using left or bottom arrow), it will
20228     * displays @c 40, because max - (min - (displayed - step)) is
20229     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20230     *
20231     * @see elm_spinner_wrap_get().
20232     *
20233     * @ingroup Spinner
20234     */
20235    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20236
20237    /**
20238     * Get whether the spinner should wrap when it reaches its
20239     * minimum or maximum value.
20240     *
20241     * @param obj The spinner object
20242     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20243     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20244     *
20245     * @see elm_spinner_wrap_set() for details.
20246     *
20247     * @ingroup Spinner
20248     */
20249    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20250
20251    /**
20252     * Set whether the spinner can be directly edited by the user or not.
20253     *
20254     * @param obj The spinner object.
20255     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20256     * don't allow users to edit it directly.
20257     *
20258     * Spinner objects can have edition @b disabled, in which state they will
20259     * be changed only by arrows.
20260     * Useful for contexts
20261     * where you don't want your users to interact with it writting the value.
20262     * Specially
20263     * when using special values, the user can see real value instead
20264     * of special label on edition.
20265     *
20266     * It's enabled by default.
20267     *
20268     * @see elm_spinner_editable_get()
20269     *
20270     * @ingroup Spinner
20271     */
20272    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20273
20274    /**
20275     * Get whether the spinner can be directly edited by the user or not.
20276     *
20277     * @param obj The spinner object.
20278     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20279     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20280     *
20281     * @see elm_spinner_editable_set() for details.
20282     *
20283     * @ingroup Spinner
20284     */
20285    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20286
20287    /**
20288     * Set a special string to display in the place of the numerical value.
20289     *
20290     * @param obj The spinner object.
20291     * @param value The value to be replaced.
20292     * @param label The label to be used.
20293     *
20294     * It's useful for cases when a user should select an item that is
20295     * better indicated by a label than a value. For example, weekdays or months.
20296     *
20297     * E.g.:
20298     * @code
20299     * sp = elm_spinner_add(win);
20300     * elm_spinner_min_max_set(sp, 1, 3);
20301     * elm_spinner_special_value_add(sp, 1, "January");
20302     * elm_spinner_special_value_add(sp, 2, "February");
20303     * elm_spinner_special_value_add(sp, 3, "March");
20304     * evas_object_show(sp);
20305     * @endcode
20306     *
20307     * @ingroup Spinner
20308     */
20309    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20310
20311    /**
20312     * Set the interval on time updates for an user mouse button hold
20313     * on spinner widgets' arrows.
20314     *
20315     * @param obj The spinner object.
20316     * @param interval The (first) interval value in seconds.
20317     *
20318     * This interval value is @b decreased while the user holds the
20319     * mouse pointer either incrementing or decrementing spinner's value.
20320     *
20321     * This helps the user to get to a given value distant from the
20322     * current one easier/faster, as it will start to change quicker and
20323     * quicker on mouse button holds.
20324     *
20325     * The calculation for the next change interval value, starting from
20326     * the one set with this call, is the previous interval divided by
20327     * @c 1.05, so it decreases a little bit.
20328     *
20329     * The default starting interval value for automatic changes is
20330     * @c 0.85 seconds.
20331     *
20332     * @see elm_spinner_interval_get()
20333     *
20334     * @ingroup Spinner
20335     */
20336    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20337
20338    /**
20339     * Get the interval on time updates for an user mouse button hold
20340     * on spinner widgets' arrows.
20341     *
20342     * @param obj The spinner object.
20343     * @return The (first) interval value, in seconds, set on it.
20344     *
20345     * @see elm_spinner_interval_set() for more details.
20346     *
20347     * @ingroup Spinner
20348     */
20349    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20350
20351    /**
20352     * @}
20353     */
20354
20355    /**
20356     * @defgroup Index Index
20357     *
20358     * @image html img/widget/index/preview-00.png
20359     * @image latex img/widget/index/preview-00.eps
20360     *
20361     * An index widget gives you an index for fast access to whichever
20362     * group of other UI items one might have. It's a list of text
20363     * items (usually letters, for alphabetically ordered access).
20364     *
20365     * Index widgets are by default hidden and just appear when the
20366     * user clicks over it's reserved area in the canvas. In its
20367     * default theme, it's an area one @ref Fingers "finger" wide on
20368     * the right side of the index widget's container.
20369     *
20370     * When items on the index are selected, smart callbacks get
20371     * called, so that its user can make other container objects to
20372     * show a given area or child object depending on the index item
20373     * selected. You'd probably be using an index together with @ref
20374     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20375     * "general grids".
20376     *
20377     * Smart events one  can add callbacks for are:
20378     * - @c "changed" - When the selected index item changes. @c
20379     *      event_info is the selected item's data pointer.
20380     * - @c "delay,changed" - When the selected index item changes, but
20381     *      after a small idling period. @c event_info is the selected
20382     *      item's data pointer.
20383     * - @c "selected" - When the user releases a mouse button and
20384     *      selects an item. @c event_info is the selected item's data
20385     *      pointer.
20386     * - @c "level,up" - when the user moves a finger from the first
20387     *      level to the second level
20388     * - @c "level,down" - when the user moves a finger from the second
20389     *      level to the first level
20390     *
20391     * The @c "delay,changed" event is so that it'll wait a small time
20392     * before actually reporting those events and, moreover, just the
20393     * last event happening on those time frames will actually be
20394     * reported.
20395     *
20396     * Here are some examples on its usage:
20397     * @li @ref index_example_01
20398     * @li @ref index_example_02
20399     */
20400
20401    /**
20402     * @addtogroup Index
20403     * @{
20404     */
20405
20406    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20407
20408    /**
20409     * Add a new index widget to the given parent Elementary
20410     * (container) object
20411     *
20412     * @param parent The parent object
20413     * @return a new index widget handle or @c NULL, on errors
20414     *
20415     * This function inserts a new index widget on the canvas.
20416     *
20417     * @ingroup Index
20418     */
20419    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20420
20421    /**
20422     * Set whether a given index widget is or not visible,
20423     * programatically.
20424     *
20425     * @param obj The index object
20426     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20427     *
20428     * Not to be confused with visible as in @c evas_object_show() --
20429     * visible with regard to the widget's auto hiding feature.
20430     *
20431     * @see elm_index_active_get()
20432     *
20433     * @ingroup Index
20434     */
20435    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20436
20437    /**
20438     * Get whether a given index widget is currently visible or not.
20439     *
20440     * @param obj The index object
20441     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20442     *
20443     * @see elm_index_active_set() for more details
20444     *
20445     * @ingroup Index
20446     */
20447    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20448
20449    /**
20450     * Set the items level for a given index widget.
20451     *
20452     * @param obj The index object.
20453     * @param level @c 0 or @c 1, the currently implemented levels.
20454     *
20455     * @see elm_index_item_level_get()
20456     *
20457     * @ingroup Index
20458     */
20459    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20460
20461    /**
20462     * Get the items level set for a given index widget.
20463     *
20464     * @param obj The index object.
20465     * @return @c 0 or @c 1, which are the levels @p obj might be at.
20466     *
20467     * @see elm_index_item_level_set() for more information
20468     *
20469     * @ingroup Index
20470     */
20471    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20472
20473    /**
20474     * Returns the last selected item's data, for a given index widget.
20475     *
20476     * @param obj The index object.
20477     * @return The item @b data associated to the last selected item on
20478     * @p obj (or @c NULL, on errors).
20479     *
20480     * @warning The returned value is @b not an #Elm_Index_Item item
20481     * handle, but the data associated to it (see the @c item parameter
20482     * in elm_index_item_append(), as an example).
20483     *
20484     * @ingroup Index
20485     */
20486    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20487
20488    /**
20489     * Append a new item on a given index widget.
20490     *
20491     * @param obj The index object.
20492     * @param letter Letter under which the item should be indexed
20493     * @param item The item data to set for the index's item
20494     *
20495     * Despite the most common usage of the @p letter argument is for
20496     * single char strings, one could use arbitrary strings as index
20497     * entries.
20498     *
20499     * @c item will be the pointer returned back on @c "changed", @c
20500     * "delay,changed" and @c "selected" smart events.
20501     *
20502     * @ingroup Index
20503     */
20504    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20505
20506    /**
20507     * Prepend a new item on a given index widget.
20508     *
20509     * @param obj The index object.
20510     * @param letter Letter under which the item should be indexed
20511     * @param item The item data to set for the index's item
20512     *
20513     * Despite the most common usage of the @p letter argument is for
20514     * single char strings, one could use arbitrary strings as index
20515     * entries.
20516     *
20517     * @c item will be the pointer returned back on @c "changed", @c
20518     * "delay,changed" and @c "selected" smart events.
20519     *
20520     * @ingroup Index
20521     */
20522    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20523
20524    /**
20525     * Append a new item, on a given index widget, <b>after the item
20526     * having @p relative as data</b>.
20527     *
20528     * @param obj The index object.
20529     * @param letter Letter under which the item should be indexed
20530     * @param item The item data to set for the index's item
20531     * @param relative The item data of the index item to be the
20532     * predecessor of this new one
20533     *
20534     * Despite the most common usage of the @p letter argument is for
20535     * single char strings, one could use arbitrary strings as index
20536     * entries.
20537     *
20538     * @c item will be the pointer returned back on @c "changed", @c
20539     * "delay,changed" and @c "selected" smart events.
20540     *
20541     * @note If @p relative is @c NULL or if it's not found to be data
20542     * set on any previous item on @p obj, this function will behave as
20543     * elm_index_item_append().
20544     *
20545     * @ingroup Index
20546     */
20547    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20548
20549    /**
20550     * Prepend a new item, on a given index widget, <b>after the item
20551     * having @p relative as data</b>.
20552     *
20553     * @param obj The index object.
20554     * @param letter Letter under which the item should be indexed
20555     * @param item The item data to set for the index's item
20556     * @param relative The item data of the index item to be the
20557     * successor of this new one
20558     *
20559     * Despite the most common usage of the @p letter argument is for
20560     * single char strings, one could use arbitrary strings as index
20561     * entries.
20562     *
20563     * @c item will be the pointer returned back on @c "changed", @c
20564     * "delay,changed" and @c "selected" smart events.
20565     *
20566     * @note If @p relative is @c NULL or if it's not found to be data
20567     * set on any previous item on @p obj, this function will behave as
20568     * elm_index_item_prepend().
20569     *
20570     * @ingroup Index
20571     */
20572    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20573
20574    /**
20575     * Insert a new item into the given index widget, using @p cmp_func
20576     * function to sort items (by item handles).
20577     *
20578     * @param obj The index object.
20579     * @param letter Letter under which the item should be indexed
20580     * @param item The item data to set for the index's item
20581     * @param cmp_func The comparing function to be used to sort index
20582     * items <b>by #Elm_Index_Item item handles</b>
20583     * @param cmp_data_func A @b fallback function to be called for the
20584     * sorting of index items <b>by item data</b>). It will be used
20585     * when @p cmp_func returns @c 0 (equality), which means an index
20586     * item with provided item data already exists. To decide which
20587     * data item should be pointed to by the index item in question, @p
20588     * cmp_data_func will be used. If @p cmp_data_func returns a
20589     * non-negative value, the previous index item data will be
20590     * replaced by the given @p item pointer. If the previous data need
20591     * to be freed, it should be done by the @p cmp_data_func function,
20592     * because all references to it will be lost. If this function is
20593     * not provided (@c NULL is given), index items will be @b
20594     * duplicated, if @p cmp_func returns @c 0.
20595     *
20596     * Despite the most common usage of the @p letter argument is for
20597     * single char strings, one could use arbitrary strings as index
20598     * entries.
20599     *
20600     * @c item will be the pointer returned back on @c "changed", @c
20601     * "delay,changed" and @c "selected" smart events.
20602     *
20603     * @ingroup Index
20604     */
20605    EAPI void            elm_index_item_sorted_insert(Evas_Object *obj, const char *letter, const void *item, Eina_Compare_Cb cmp_func, Eina_Compare_Cb cmp_data_func) EINA_ARG_NONNULL(1);
20606
20607    /**
20608     * Remove an item from a given index widget, <b>to be referenced by
20609     * it's data value</b>.
20610     *
20611     * @param obj The index object
20612     * @param item The item's data pointer for the item to be removed
20613     * from @p obj
20614     *
20615     * If a deletion callback is set, via elm_index_item_del_cb_set(),
20616     * that callback function will be called by this one.
20617     *
20618     * @warning The item to be removed from @p obj will be found via
20619     * its item data pointer, and not by an #Elm_Index_Item handle.
20620     *
20621     * @ingroup Index
20622     */
20623    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20624
20625    /**
20626     * Find a given index widget's item, <b>using item data</b>.
20627     *
20628     * @param obj The index object
20629     * @param item The item data pointed to by the desired index item
20630     * @return The index item handle, if found, or @c NULL otherwise
20631     *
20632     * @ingroup Index
20633     */
20634    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20635
20636    /**
20637     * Removes @b all items from a given index widget.
20638     *
20639     * @param obj The index object.
20640     *
20641     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20642     * that callback function will be called for each item in @p obj.
20643     *
20644     * @ingroup Index
20645     */
20646    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20647
20648    /**
20649     * Go to a given items level on a index widget
20650     *
20651     * @param obj The index object
20652     * @param level The index level (one of @c 0 or @c 1)
20653     *
20654     * @ingroup Index
20655     */
20656    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20657
20658    /**
20659     * Return the data associated with a given index widget item
20660     *
20661     * @param it The index widget item handle
20662     * @return The data associated with @p it
20663     *
20664     * @see elm_index_item_data_set()
20665     *
20666     * @ingroup Index
20667     */
20668    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20669
20670    /**
20671     * Set the data associated with a given index widget item
20672     *
20673     * @param it The index widget item handle
20674     * @param data The new data pointer to set to @p it
20675     *
20676     * This sets new item data on @p it.
20677     *
20678     * @warning The old data pointer won't be touched by this function, so
20679     * the user had better to free that old data himself/herself.
20680     *
20681     * @ingroup Index
20682     */
20683    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20684
20685    /**
20686     * Set the function to be called when a given index widget item is freed.
20687     *
20688     * @param it The item to set the callback on
20689     * @param func The function to call on the item's deletion
20690     *
20691     * When called, @p func will have both @c data and @c event_info
20692     * arguments with the @p it item's data value and, naturally, the
20693     * @c obj argument with a handle to the parent index widget.
20694     *
20695     * @ingroup Index
20696     */
20697    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20698
20699    /**
20700     * Get the letter (string) set on a given index widget item.
20701     *
20702     * @param it The index item handle
20703     * @return The letter string set on @p it
20704     *
20705     * @ingroup Index
20706     */
20707    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20708
20709    /**
20710     * @}
20711     */
20712
20713    /**
20714     * @defgroup Photocam Photocam
20715     *
20716     * @image html img/widget/photocam/preview-00.png
20717     * @image latex img/widget/photocam/preview-00.eps
20718     *
20719     * This is a widget specifically for displaying high-resolution digital
20720     * camera photos giving speedy feedback (fast load), low memory footprint
20721     * and zooming and panning as well as fitting logic. It is entirely focused
20722     * on jpeg images, and takes advantage of properties of the jpeg format (via
20723     * evas loader features in the jpeg loader).
20724     *
20725     * Signals that you can add callbacks for are:
20726     * @li "clicked" - This is called when a user has clicked the photo without
20727     *                 dragging around.
20728     * @li "press" - This is called when a user has pressed down on the photo.
20729     * @li "longpressed" - This is called when a user has pressed down on the
20730     *                     photo for a long time without dragging around.
20731     * @li "clicked,double" - This is called when a user has double-clicked the
20732     *                        photo.
20733     * @li "load" - Photo load begins.
20734     * @li "loaded" - This is called when the image file load is complete for the
20735     *                first view (low resolution blurry version).
20736     * @li "load,detail" - Photo detailed data load begins.
20737     * @li "loaded,detail" - This is called when the image file load is complete
20738     *                      for the detailed image data (full resolution needed).
20739     * @li "zoom,start" - Zoom animation started.
20740     * @li "zoom,stop" - Zoom animation stopped.
20741     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20742     * @li "scroll" - the content has been scrolled (moved)
20743     * @li "scroll,anim,start" - scrolling animation has started
20744     * @li "scroll,anim,stop" - scrolling animation has stopped
20745     * @li "scroll,drag,start" - dragging the contents around has started
20746     * @li "scroll,drag,stop" - dragging the contents around has stopped
20747     *
20748     * @ref tutorial_photocam shows the API in action.
20749     * @{
20750     */
20751    /**
20752     * @brief Types of zoom available.
20753     */
20754    typedef enum _Elm_Photocam_Zoom_Mode
20755      {
20756         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20757         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20758         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20759         ELM_PHOTOCAM_ZOOM_MODE_LAST
20760      } Elm_Photocam_Zoom_Mode;
20761    /**
20762     * @brief Add a new Photocam object
20763     *
20764     * @param parent The parent object
20765     * @return The new object or NULL if it cannot be created
20766     */
20767    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20768    /**
20769     * @brief Set the photo file to be shown
20770     *
20771     * @param obj The photocam object
20772     * @param file The photo file
20773     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20774     *
20775     * This sets (and shows) the specified file (with a relative or absolute
20776     * path) and will return a load error (same error that
20777     * evas_object_image_load_error_get() will return). The image will change and
20778     * adjust its size at this point and begin a background load process for this
20779     * photo that at some time in the future will be displayed at the full
20780     * quality needed.
20781     */
20782    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20783    /**
20784     * @brief Returns the path of the current image file
20785     *
20786     * @param obj The photocam object
20787     * @return Returns the path
20788     *
20789     * @see elm_photocam_file_set()
20790     */
20791    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20792    /**
20793     * @brief Set the zoom level of the photo
20794     *
20795     * @param obj The photocam object
20796     * @param zoom The zoom level to set
20797     *
20798     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20799     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20800     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20801     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20802     * 16, 32, etc.).
20803     */
20804    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20805    /**
20806     * @brief Get the zoom level of the photo
20807     *
20808     * @param obj The photocam object
20809     * @return The current zoom level
20810     *
20811     * This returns the current zoom level of the photocam object. Note that if
20812     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20813     * (which is the default), the zoom level may be changed at any time by the
20814     * photocam object itself to account for photo size and photocam viewpoer
20815     * size.
20816     *
20817     * @see elm_photocam_zoom_set()
20818     * @see elm_photocam_zoom_mode_set()
20819     */
20820    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20821    /**
20822     * @brief Set the zoom mode
20823     *
20824     * @param obj The photocam object
20825     * @param mode The desired mode
20826     *
20827     * This sets the zoom mode to manual or one of several automatic levels.
20828     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20829     * elm_photocam_zoom_set() and will stay at that level until changed by code
20830     * or until zoom mode is changed. This is the default mode. The Automatic
20831     * modes will allow the photocam object to automatically adjust zoom mode
20832     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20833     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20834     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20835     * pixels within the frame are left unfilled.
20836     */
20837    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20838    /**
20839     * @brief Get the zoom mode
20840     *
20841     * @param obj The photocam object
20842     * @return The current zoom mode
20843     *
20844     * This gets the current zoom mode of the photocam object.
20845     *
20846     * @see elm_photocam_zoom_mode_set()
20847     */
20848    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20849    /**
20850     * @brief Get the current image pixel width and height
20851     *
20852     * @param obj The photocam object
20853     * @param w A pointer to the width return
20854     * @param h A pointer to the height return
20855     *
20856     * This gets the current photo pixel width and height (for the original).
20857     * The size will be returned in the integers @p w and @p h that are pointed
20858     * to.
20859     */
20860    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20861    /**
20862     * @brief Get the area of the image that is currently shown
20863     *
20864     * @param obj
20865     * @param x A pointer to the X-coordinate of region
20866     * @param y A pointer to the Y-coordinate of region
20867     * @param w A pointer to the width
20868     * @param h A pointer to the height
20869     *
20870     * @see elm_photocam_image_region_show()
20871     * @see elm_photocam_image_region_bring_in()
20872     */
20873    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20874    /**
20875     * @brief Set the viewed portion of the image
20876     *
20877     * @param obj The photocam object
20878     * @param x X-coordinate of region in image original pixels
20879     * @param y Y-coordinate of region in image original pixels
20880     * @param w Width of region in image original pixels
20881     * @param h Height of region in image original pixels
20882     *
20883     * This shows the region of the image without using animation.
20884     */
20885    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20886    /**
20887     * @brief Bring in the viewed portion of the image
20888     *
20889     * @param obj The photocam object
20890     * @param x X-coordinate of region in image original pixels
20891     * @param y Y-coordinate of region in image original pixels
20892     * @param w Width of region in image original pixels
20893     * @param h Height of region in image original pixels
20894     *
20895     * This shows the region of the image using animation.
20896     */
20897    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20898    /**
20899     * @brief Set the paused state for photocam
20900     *
20901     * @param obj The photocam object
20902     * @param paused The pause state to set
20903     *
20904     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20905     * photocam. The default is off. This will stop zooming using animation on
20906     * zoom levels changes and change instantly. This will stop any existing
20907     * animations that are running.
20908     */
20909    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20910    /**
20911     * @brief Get the paused state for photocam
20912     *
20913     * @param obj The photocam object
20914     * @return The current paused state
20915     *
20916     * This gets the current paused state for the photocam object.
20917     *
20918     * @see elm_photocam_paused_set()
20919     */
20920    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20921    /**
20922     * @brief Get the internal low-res image used for photocam
20923     *
20924     * @param obj The photocam object
20925     * @return The internal image object handle, or NULL if none exists
20926     *
20927     * This gets the internal image object inside photocam. Do not modify it. It
20928     * is for inspection only, and hooking callbacks to. Nothing else. It may be
20929     * deleted at any time as well.
20930     */
20931    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20932    /**
20933     * @brief Set the photocam scrolling bouncing.
20934     *
20935     * @param obj The photocam object
20936     * @param h_bounce bouncing for horizontal
20937     * @param v_bounce bouncing for vertical
20938     */
20939    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20940    /**
20941     * @brief Get the photocam scrolling bouncing.
20942     *
20943     * @param obj The photocam object
20944     * @param h_bounce bouncing for horizontal
20945     * @param v_bounce bouncing for vertical
20946     *
20947     * @see elm_photocam_bounce_set()
20948     */
20949    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20950    /**
20951     * @}
20952     */
20953
20954    /**
20955     * @defgroup Map Map
20956     * @ingroup Elementary
20957     *
20958     * @image html img/widget/map/preview-00.png
20959     * @image latex img/widget/map/preview-00.eps
20960     *
20961     * This is a widget specifically for displaying a map. It uses basically
20962     * OpenStreetMap provider http://www.openstreetmap.org/,
20963     * but custom providers can be added.
20964     *
20965     * It supports some basic but yet nice features:
20966     * @li zoom and scroll
20967     * @li markers with content to be displayed when user clicks over it
20968     * @li group of markers
20969     * @li routes
20970     *
20971     * Smart callbacks one can listen to:
20972     *
20973     * - "clicked" - This is called when a user has clicked the map without
20974     *   dragging around.
20975     * - "press" - This is called when a user has pressed down on the map.
20976     * - "longpressed" - This is called when a user has pressed down on the map
20977     *   for a long time without dragging around.
20978     * - "clicked,double" - This is called when a user has double-clicked
20979     *   the map.
20980     * - "load,detail" - Map detailed data load begins.
20981     * - "loaded,detail" - This is called when all currently visible parts of
20982     *   the map are loaded.
20983     * - "zoom,start" - Zoom animation started.
20984     * - "zoom,stop" - Zoom animation stopped.
20985     * - "zoom,change" - Zoom changed when using an auto zoom mode.
20986     * - "scroll" - the content has been scrolled (moved).
20987     * - "scroll,anim,start" - scrolling animation has started.
20988     * - "scroll,anim,stop" - scrolling animation has stopped.
20989     * - "scroll,drag,start" - dragging the contents around has started.
20990     * - "scroll,drag,stop" - dragging the contents around has stopped.
20991     * - "downloaded" - This is called when all currently required map images
20992     *   are downloaded.
20993     * - "route,load" - This is called when route request begins.
20994     * - "route,loaded" - This is called when route request ends.
20995     * - "name,load" - This is called when name request begins.
20996     * - "name,loaded- This is called when name request ends.
20997     *
20998     * Available style for map widget:
20999     * - @c "default"
21000     *
21001     * Available style for markers:
21002     * - @c "radio"
21003     * - @c "radio2"
21004     * - @c "empty"
21005     *
21006     * Available style for marker bubble:
21007     * - @c "default"
21008     *
21009     * List of examples:
21010     * @li @ref map_example_01
21011     * @li @ref map_example_02
21012     * @li @ref map_example_03
21013     */
21014
21015    /**
21016     * @addtogroup Map
21017     * @{
21018     */
21019
21020    /**
21021     * @enum _Elm_Map_Zoom_Mode
21022     * @typedef Elm_Map_Zoom_Mode
21023     *
21024     * Set map's zoom behavior. It can be set to manual or automatic.
21025     *
21026     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
21027     *
21028     * Values <b> don't </b> work as bitmask, only one can be choosen.
21029     *
21030     * @note Valid sizes are 2^zoom, consequently the map may be smaller
21031     * than the scroller view.
21032     *
21033     * @see elm_map_zoom_mode_set()
21034     * @see elm_map_zoom_mode_get()
21035     *
21036     * @ingroup Map
21037     */
21038    typedef enum _Elm_Map_Zoom_Mode
21039      {
21040         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
21041         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
21042         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
21043         ELM_MAP_ZOOM_MODE_LAST
21044      } Elm_Map_Zoom_Mode;
21045
21046    /**
21047     * @enum _Elm_Map_Route_Sources
21048     * @typedef Elm_Map_Route_Sources
21049     *
21050     * Set route service to be used. By default used source is
21051     * #ELM_MAP_ROUTE_SOURCE_YOURS.
21052     *
21053     * @see elm_map_route_source_set()
21054     * @see elm_map_route_source_get()
21055     *
21056     * @ingroup Map
21057     */
21058    typedef enum _Elm_Map_Route_Sources
21059      {
21060         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
21061         ELM_MAP_ROUTE_SOURCE_MONAV, /**< MoNav offers exact routing without heuristic assumptions. Its routing core is based on Contraction Hierarchies. It's not working with Map yet. */
21062         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
21063         ELM_MAP_ROUTE_SOURCE_LAST
21064      } Elm_Map_Route_Sources;
21065
21066    typedef enum _Elm_Map_Name_Sources
21067      {
21068         ELM_MAP_NAME_SOURCE_NOMINATIM,
21069         ELM_MAP_NAME_SOURCE_LAST
21070      } Elm_Map_Name_Sources;
21071
21072    /**
21073     * @enum _Elm_Map_Route_Type
21074     * @typedef Elm_Map_Route_Type
21075     *
21076     * Set type of transport used on route.
21077     *
21078     * @see elm_map_route_add()
21079     *
21080     * @ingroup Map
21081     */
21082    typedef enum _Elm_Map_Route_Type
21083      {
21084         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
21085         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
21086         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
21087         ELM_MAP_ROUTE_TYPE_LAST
21088      } Elm_Map_Route_Type;
21089
21090    /**
21091     * @enum _Elm_Map_Route_Method
21092     * @typedef Elm_Map_Route_Method
21093     *
21094     * Set the routing method, what should be priorized, time or distance.
21095     *
21096     * @see elm_map_route_add()
21097     *
21098     * @ingroup Map
21099     */
21100    typedef enum _Elm_Map_Route_Method
21101      {
21102         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
21103         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
21104         ELM_MAP_ROUTE_METHOD_LAST
21105      } Elm_Map_Route_Method;
21106
21107    typedef enum _Elm_Map_Name_Method
21108      {
21109         ELM_MAP_NAME_METHOD_SEARCH,
21110         ELM_MAP_NAME_METHOD_REVERSE,
21111         ELM_MAP_NAME_METHOD_LAST
21112      } Elm_Map_Name_Method;
21113
21114    typedef struct _Elm_Map_Marker          Elm_Map_Marker; /**< A marker to be shown in a specific point of the map. Can be created with elm_map_marker_add() and deleted with elm_map_marker_remove(). */
21115    typedef struct _Elm_Map_Marker_Class    Elm_Map_Marker_Class; /**< Each marker must be associated to a class. It's required to add a mark. The class defines the style of the marker when a marker is displayed alone (not grouped). A new class can be created with elm_map_marker_class_new(). */
21116    typedef struct _Elm_Map_Group_Class     Elm_Map_Group_Class; /**< Each marker must be associated to a group class. It's required to add a mark. The group class defines the style of the marker when a marker is grouped to other markers. Markers with the same group are grouped if they are close. A new group class can be created with elm_map_marker_group_class_new(). */
21117    typedef struct _Elm_Map_Route           Elm_Map_Route; /**< A route to be shown in the map. Can be created with elm_map_route_add() and deleted with elm_map_route_remove(). */
21118    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
21119    typedef struct _Elm_Map_Track           Elm_Map_Track;
21120
21121    typedef Evas_Object *(*ElmMapMarkerGetFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Bubble content fetching class function for marker classes. When the user click on a marker, a bubble is displayed with a content. */
21122    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
21123    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
21124    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
21125
21126    typedef char        *(*ElmMapModuleSourceFunc) (void);
21127    typedef int          (*ElmMapModuleZoomMinFunc) (void);
21128    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
21129    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
21130    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
21131    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
21132    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
21133    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
21134    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
21135
21136    /**
21137     * Add a new map widget to the given parent Elementary (container) object.
21138     *
21139     * @param parent The parent object.
21140     * @return a new map widget handle or @c NULL, on errors.
21141     *
21142     * This function inserts a new map widget on the canvas.
21143     *
21144     * @ingroup Map
21145     */
21146    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21147
21148    /**
21149     * Set the zoom level of the map.
21150     *
21151     * @param obj The map object.
21152     * @param zoom The zoom level to set.
21153     *
21154     * This sets the zoom level.
21155     *
21156     * It will respect limits defined by elm_map_source_zoom_min_set() and
21157     * elm_map_source_zoom_max_set().
21158     *
21159     * By default these values are 0 (world map) and 18 (maximum zoom).
21160     *
21161     * This function should be used when zoom mode is set to
21162     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
21163     * with elm_map_zoom_mode_set().
21164     *
21165     * @see elm_map_zoom_mode_set().
21166     * @see elm_map_zoom_get().
21167     *
21168     * @ingroup Map
21169     */
21170    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21171
21172    /**
21173     * Get the zoom level of the map.
21174     *
21175     * @param obj The map object.
21176     * @return The current zoom level.
21177     *
21178     * This returns the current zoom level of the map object.
21179     *
21180     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
21181     * (which is the default), the zoom level may be changed at any time by the
21182     * map object itself to account for map size and map viewport size.
21183     *
21184     * @see elm_map_zoom_set() for details.
21185     *
21186     * @ingroup Map
21187     */
21188    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21189
21190    /**
21191     * Set the zoom mode used by the map object.
21192     *
21193     * @param obj The map object.
21194     * @param mode The zoom mode of the map, being it one of
21195     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21196     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21197     *
21198     * This sets the zoom mode to manual or one of the automatic levels.
21199     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
21200     * elm_map_zoom_set() and will stay at that level until changed by code
21201     * or until zoom mode is changed. This is the default mode.
21202     *
21203     * The Automatic modes will allow the map object to automatically
21204     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
21205     * adjust zoom so the map fits inside the scroll frame with no pixels
21206     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
21207     * ensure no pixels within the frame are left unfilled. Do not forget that
21208     * the valid sizes are 2^zoom, consequently the map may be smaller than
21209     * the scroller view.
21210     *
21211     * @see elm_map_zoom_set()
21212     *
21213     * @ingroup Map
21214     */
21215    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21216
21217    /**
21218     * Get the zoom mode used by the map object.
21219     *
21220     * @param obj The map object.
21221     * @return The zoom mode of the map, being it one of
21222     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
21223     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
21224     *
21225     * This function returns the current zoom mode used by the map object.
21226     *
21227     * @see elm_map_zoom_mode_set() for more details.
21228     *
21229     * @ingroup Map
21230     */
21231    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21232
21233    /**
21234     * Get the current coordinates of the map.
21235     *
21236     * @param obj The map object.
21237     * @param lon Pointer where to store longitude.
21238     * @param lat Pointer where to store latitude.
21239     *
21240     * This gets the current center coordinates of the map object. It can be
21241     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21242     *
21243     * @see elm_map_geo_region_bring_in()
21244     * @see elm_map_geo_region_show()
21245     *
21246     * @ingroup Map
21247     */
21248    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21249
21250    /**
21251     * Animatedly bring in given coordinates to the center of the map.
21252     *
21253     * @param obj The map object.
21254     * @param lon Longitude to center at.
21255     * @param lat Latitude to center at.
21256     *
21257     * This causes map to jump to the given @p lat and @p lon coordinates
21258     * and show it (by scrolling) in the center of the viewport, if it is not
21259     * already centered. This will use animation to do so and take a period
21260     * of time to complete.
21261     *
21262     * @see elm_map_geo_region_show() for a function to avoid animation.
21263     * @see elm_map_geo_region_get()
21264     *
21265     * @ingroup Map
21266     */
21267    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21268
21269    /**
21270     * Show the given coordinates at the center of the map, @b immediately.
21271     *
21272     * @param obj The map object.
21273     * @param lon Longitude to center at.
21274     * @param lat Latitude to center at.
21275     *
21276     * This causes map to @b redraw its viewport's contents to the
21277     * region contining the given @p lat and @p lon, that will be moved to the
21278     * center of the map.
21279     *
21280     * @see elm_map_geo_region_bring_in() for a function to move with animation.
21281     * @see elm_map_geo_region_get()
21282     *
21283     * @ingroup Map
21284     */
21285    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21286
21287    /**
21288     * Pause or unpause the map.
21289     *
21290     * @param obj The map object.
21291     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21292     * to unpause it.
21293     *
21294     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21295     * for map.
21296     *
21297     * The default is off.
21298     *
21299     * This will stop zooming using animation, changing zoom levels will
21300     * change instantly. This will stop any existing animations that are running.
21301     *
21302     * @see elm_map_paused_get()
21303     *
21304     * @ingroup Map
21305     */
21306    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21307
21308    /**
21309     * Get a value whether map is paused or not.
21310     *
21311     * @param obj The map object.
21312     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21313     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21314     *
21315     * This gets the current paused state for the map object.
21316     *
21317     * @see elm_map_paused_set() for details.
21318     *
21319     * @ingroup Map
21320     */
21321    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21322
21323    /**
21324     * Set to show markers during zoom level changes or not.
21325     *
21326     * @param obj The map object.
21327     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21328     * to show them.
21329     *
21330     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21331     * for map.
21332     *
21333     * The default is off.
21334     *
21335     * This will stop zooming using animation, changing zoom levels will
21336     * change instantly. This will stop any existing animations that are running.
21337     *
21338     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21339     * for the markers.
21340     *
21341     * The default  is off.
21342     *
21343     * Enabling it will force the map to stop displaying the markers during
21344     * zoom level changes. Set to on if you have a large number of markers.
21345     *
21346     * @see elm_map_paused_markers_get()
21347     *
21348     * @ingroup Map
21349     */
21350    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21351
21352    /**
21353     * Get a value whether markers will be displayed on zoom level changes or not
21354     *
21355     * @param obj The map object.
21356     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21357     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21358     *
21359     * This gets the current markers paused state for the map object.
21360     *
21361     * @see elm_map_paused_markers_set() for details.
21362     *
21363     * @ingroup Map
21364     */
21365    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21366
21367    /**
21368     * Get the information of downloading status.
21369     *
21370     * @param obj The map object.
21371     * @param try_num Pointer where to store number of tiles being downloaded.
21372     * @param finish_num Pointer where to store number of tiles successfully
21373     * downloaded.
21374     *
21375     * This gets the current downloading status for the map object, the number
21376     * of tiles being downloaded and the number of tiles already downloaded.
21377     *
21378     * @ingroup Map
21379     */
21380    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21381
21382    /**
21383     * Convert a pixel coordinate (x,y) into a geographic coordinate
21384     * (longitude, latitude).
21385     *
21386     * @param obj The map object.
21387     * @param x the coordinate.
21388     * @param y the coordinate.
21389     * @param size the size in pixels of the map.
21390     * The map is a square and generally his size is : pow(2.0, zoom)*256.
21391     * @param lon Pointer where to store the longitude that correspond to x.
21392     * @param lat Pointer where to store the latitude that correspond to y.
21393     *
21394     * @note Origin pixel point is the top left corner of the viewport.
21395     * Map zoom and size are taken on account.
21396     *
21397     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21398     *
21399     * @ingroup Map
21400     */
21401    EAPI void                  elm_map_utils_convert_coord_into_geo(const Evas_Object *obj, int x, int y, int size, double *lon, double *lat) EINA_ARG_NONNULL(1, 5, 6);
21402
21403    /**
21404     * Convert a geographic coordinate (longitude, latitude) into a pixel
21405     * coordinate (x, y).
21406     *
21407     * @param obj The map object.
21408     * @param lon the longitude.
21409     * @param lat the latitude.
21410     * @param size the size in pixels of the map. The map is a square
21411     * and generally his size is : pow(2.0, zoom)*256.
21412     * @param x Pointer where to store the horizontal pixel coordinate that
21413     * correspond to the longitude.
21414     * @param y Pointer where to store the vertical pixel coordinate that
21415     * correspond to the latitude.
21416     *
21417     * @note Origin pixel point is the top left corner of the viewport.
21418     * Map zoom and size are taken on account.
21419     *
21420     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21421     *
21422     * @ingroup Map
21423     */
21424    EAPI void                  elm_map_utils_convert_geo_into_coord(const Evas_Object *obj, double lon, double lat, int size, int *x, int *y) EINA_ARG_NONNULL(1, 5, 6);
21425
21426    /**
21427     * Convert a geographic coordinate (longitude, latitude) into a name
21428     * (address).
21429     *
21430     * @param obj The map object.
21431     * @param lon the longitude.
21432     * @param lat the latitude.
21433     * @return name A #Elm_Map_Name handle for this coordinate.
21434     *
21435     * To get the string for this address, elm_map_name_address_get()
21436     * should be used.
21437     *
21438     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21439     *
21440     * @ingroup Map
21441     */
21442    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21443
21444    /**
21445     * Convert a name (address) into a geographic coordinate
21446     * (longitude, latitude).
21447     *
21448     * @param obj The map object.
21449     * @param name The address.
21450     * @return name A #Elm_Map_Name handle for this address.
21451     *
21452     * To get the longitude and latitude, elm_map_name_region_get()
21453     * should be used.
21454     *
21455     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21456     *
21457     * @ingroup Map
21458     */
21459    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21460
21461    /**
21462     * Convert a pixel coordinate into a rotated pixel coordinate.
21463     *
21464     * @param obj The map object.
21465     * @param x horizontal coordinate of the point to rotate.
21466     * @param y vertical coordinate of the point to rotate.
21467     * @param cx rotation's center horizontal position.
21468     * @param cy rotation's center vertical position.
21469     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21470     * @param xx Pointer where to store rotated x.
21471     * @param yy Pointer where to store rotated y.
21472     *
21473     * @ingroup Map
21474     */
21475    EAPI void                  elm_map_utils_rotate_coord(const Evas_Object *obj, const Evas_Coord x, const Evas_Coord y, const Evas_Coord cx, const Evas_Coord cy, const double degree, Evas_Coord *xx, Evas_Coord *yy) EINA_ARG_NONNULL(1);
21476
21477    /**
21478     * Add a new marker to the map object.
21479     *
21480     * @param obj The map object.
21481     * @param lon The longitude of the marker.
21482     * @param lat The latitude of the marker.
21483     * @param clas The class, to use when marker @b isn't grouped to others.
21484     * @param clas_group The class group, to use when marker is grouped to others
21485     * @param data The data passed to the callbacks.
21486     *
21487     * @return The created marker or @c NULL upon failure.
21488     *
21489     * A marker will be created and shown in a specific point of the map, defined
21490     * by @p lon and @p lat.
21491     *
21492     * It will be displayed using style defined by @p class when this marker
21493     * is displayed alone (not grouped). A new class can be created with
21494     * elm_map_marker_class_new().
21495     *
21496     * If the marker is grouped to other markers, it will be displayed with
21497     * style defined by @p class_group. Markers with the same group are grouped
21498     * if they are close. A new group class can be created with
21499     * elm_map_marker_group_class_new().
21500     *
21501     * Markers created with this method can be deleted with
21502     * elm_map_marker_remove().
21503     *
21504     * A marker can have associated content to be displayed by a bubble,
21505     * when a user click over it, as well as an icon. These objects will
21506     * be fetch using class' callback functions.
21507     *
21508     * @see elm_map_marker_class_new()
21509     * @see elm_map_marker_group_class_new()
21510     * @see elm_map_marker_remove()
21511     *
21512     * @ingroup Map
21513     */
21514    EAPI Elm_Map_Marker       *elm_map_marker_add(Evas_Object *obj, double lon, double lat, Elm_Map_Marker_Class *clas, Elm_Map_Group_Class *clas_group, void *data) EINA_ARG_NONNULL(1, 4, 5);
21515
21516    /**
21517     * Set the maximum numbers of markers' content to be displayed in a group.
21518     *
21519     * @param obj The map object.
21520     * @param max The maximum numbers of items displayed in a bubble.
21521     *
21522     * A bubble will be displayed when the user clicks over the group,
21523     * and will place the content of markers that belong to this group
21524     * inside it.
21525     *
21526     * A group can have a long list of markers, consequently the creation
21527     * of the content of the bubble can be very slow.
21528     *
21529     * In order to avoid this, a maximum number of items is displayed
21530     * in a bubble.
21531     *
21532     * By default this number is 30.
21533     *
21534     * Marker with the same group class are grouped if they are close.
21535     *
21536     * @see elm_map_marker_add()
21537     *
21538     * @ingroup Map
21539     */
21540    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21541
21542    /**
21543     * Remove a marker from the map.
21544     *
21545     * @param marker The marker to remove.
21546     *
21547     * @see elm_map_marker_add()
21548     *
21549     * @ingroup Map
21550     */
21551    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21552
21553    /**
21554     * Get the current coordinates of the marker.
21555     *
21556     * @param marker marker.
21557     * @param lat Pointer where to store the marker's latitude.
21558     * @param lon Pointer where to store the marker's longitude.
21559     *
21560     * These values are set when adding markers, with function
21561     * elm_map_marker_add().
21562     *
21563     * @see elm_map_marker_add()
21564     *
21565     * @ingroup Map
21566     */
21567    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21568
21569    /**
21570     * Animatedly bring in given marker to the center of the map.
21571     *
21572     * @param marker The marker to center at.
21573     *
21574     * This causes map to jump to the given @p marker's coordinates
21575     * and show it (by scrolling) in the center of the viewport, if it is not
21576     * already centered. This will use animation to do so and take a period
21577     * of time to complete.
21578     *
21579     * @see elm_map_marker_show() for a function to avoid animation.
21580     * @see elm_map_marker_region_get()
21581     *
21582     * @ingroup Map
21583     */
21584    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21585
21586    /**
21587     * Show the given marker at the center of the map, @b immediately.
21588     *
21589     * @param marker The marker to center at.
21590     *
21591     * This causes map to @b redraw its viewport's contents to the
21592     * region contining the given @p marker's coordinates, that will be
21593     * moved to the center of the map.
21594     *
21595     * @see elm_map_marker_bring_in() for a function to move with animation.
21596     * @see elm_map_markers_list_show() if more than one marker need to be
21597     * displayed.
21598     * @see elm_map_marker_region_get()
21599     *
21600     * @ingroup Map
21601     */
21602    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21603
21604    /**
21605     * Move and zoom the map to display a list of markers.
21606     *
21607     * @param markers A list of #Elm_Map_Marker handles.
21608     *
21609     * The map will be centered on the center point of the markers in the list.
21610     * Then the map will be zoomed in order to fit the markers using the maximum
21611     * zoom which allows display of all the markers.
21612     *
21613     * @warning All the markers should belong to the same map object.
21614     *
21615     * @see elm_map_marker_show() to show a single marker.
21616     * @see elm_map_marker_bring_in()
21617     *
21618     * @ingroup Map
21619     */
21620    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21621
21622    /**
21623     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21624     *
21625     * @param marker The marker wich content should be returned.
21626     * @return Return the evas object if it exists, else @c NULL.
21627     *
21628     * To set callback function #ElmMapMarkerGetFunc for the marker class,
21629     * elm_map_marker_class_get_cb_set() should be used.
21630     *
21631     * This content is what will be inside the bubble that will be displayed
21632     * when an user clicks over the marker.
21633     *
21634     * This returns the actual Evas object used to be placed inside
21635     * the bubble. This may be @c NULL, as it may
21636     * not have been created or may have been deleted, at any time, by
21637     * the map. <b>Do not modify this object</b> (move, resize,
21638     * show, hide, etc.), as the map is controlling it. This
21639     * function is for querying, emitting custom signals or hooking
21640     * lower level callbacks for events on that object. Do not delete
21641     * this object under any circumstances.
21642     *
21643     * @ingroup Map
21644     */
21645    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21646
21647    /**
21648     * Update the marker
21649     *
21650     * @param marker The marker to be updated.
21651     *
21652     * If a content is set to this marker, it will call function to delete it,
21653     * #ElmMapMarkerDelFunc, and then will fetch the content again with
21654     * #ElmMapMarkerGetFunc.
21655     *
21656     * These functions are set for the marker class with
21657     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21658     *
21659     * @ingroup Map
21660     */
21661    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21662
21663    /**
21664     * Close all the bubbles opened by the user.
21665     *
21666     * @param obj The map object.
21667     *
21668     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21669     * when the user clicks on a marker.
21670     *
21671     * This functions is set for the marker class with
21672     * elm_map_marker_class_get_cb_set().
21673     *
21674     * @ingroup Map
21675     */
21676    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21677
21678    /**
21679     * Create a new group class.
21680     *
21681     * @param obj The map object.
21682     * @return Returns the new group class.
21683     *
21684     * Each marker must be associated to a group class. Markers in the same
21685     * group are grouped if they are close.
21686     *
21687     * The group class defines the style of the marker when a marker is grouped
21688     * to others markers. When it is alone, another class will be used.
21689     *
21690     * A group class will need to be provided when creating a marker with
21691     * elm_map_marker_add().
21692     *
21693     * Some properties and functions can be set by class, as:
21694     * - style, with elm_map_group_class_style_set()
21695     * - data - to be associated to the group class. It can be set using
21696     *   elm_map_group_class_data_set().
21697     * - min zoom to display markers, set with
21698     *   elm_map_group_class_zoom_displayed_set().
21699     * - max zoom to group markers, set using
21700     *   elm_map_group_class_zoom_grouped_set().
21701     * - visibility - set if markers will be visible or not, set with
21702     *   elm_map_group_class_hide_set().
21703     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21704     *   It can be set using elm_map_group_class_icon_cb_set().
21705     *
21706     * @see elm_map_marker_add()
21707     * @see elm_map_group_class_style_set()
21708     * @see elm_map_group_class_data_set()
21709     * @see elm_map_group_class_zoom_displayed_set()
21710     * @see elm_map_group_class_zoom_grouped_set()
21711     * @see elm_map_group_class_hide_set()
21712     * @see elm_map_group_class_icon_cb_set()
21713     *
21714     * @ingroup Map
21715     */
21716    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21717
21718    /**
21719     * Set the marker's style of a group class.
21720     *
21721     * @param clas The group class.
21722     * @param style The style to be used by markers.
21723     *
21724     * Each marker must be associated to a group class, and will use the style
21725     * defined by such class when grouped to other markers.
21726     *
21727     * The following styles are provided by default theme:
21728     * @li @c radio - blue circle
21729     * @li @c radio2 - green circle
21730     * @li @c empty
21731     *
21732     * @see elm_map_group_class_new() for more details.
21733     * @see elm_map_marker_add()
21734     *
21735     * @ingroup Map
21736     */
21737    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21738
21739    /**
21740     * Set the icon callback function of a group class.
21741     *
21742     * @param clas The group class.
21743     * @param icon_get The callback function that will return the icon.
21744     *
21745     * Each marker must be associated to a group class, and it can display a
21746     * custom icon. The function @p icon_get must return this icon.
21747     *
21748     * @see elm_map_group_class_new() for more details.
21749     * @see elm_map_marker_add()
21750     *
21751     * @ingroup Map
21752     */
21753    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21754
21755    /**
21756     * Set the data associated to the group class.
21757     *
21758     * @param clas The group class.
21759     * @param data The new user data.
21760     *
21761     * This data will be passed for callback functions, like icon get callback,
21762     * that can be set with elm_map_group_class_icon_cb_set().
21763     *
21764     * If a data was previously set, the object will lose the pointer for it,
21765     * so if needs to be freed, you must do it yourself.
21766     *
21767     * @see elm_map_group_class_new() for more details.
21768     * @see elm_map_group_class_icon_cb_set()
21769     * @see elm_map_marker_add()
21770     *
21771     * @ingroup Map
21772     */
21773    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21774
21775    /**
21776     * Set the minimum zoom from where the markers are displayed.
21777     *
21778     * @param clas The group class.
21779     * @param zoom The minimum zoom.
21780     *
21781     * Markers only will be displayed when the map is displayed at @p zoom
21782     * or bigger.
21783     *
21784     * @see elm_map_group_class_new() for more details.
21785     * @see elm_map_marker_add()
21786     *
21787     * @ingroup Map
21788     */
21789    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21790
21791    /**
21792     * Set the zoom from where the markers are no more grouped.
21793     *
21794     * @param clas The group class.
21795     * @param zoom The maximum zoom.
21796     *
21797     * Markers only will be grouped when the map is displayed at
21798     * less than @p zoom.
21799     *
21800     * @see elm_map_group_class_new() for more details.
21801     * @see elm_map_marker_add()
21802     *
21803     * @ingroup Map
21804     */
21805    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21806
21807    /**
21808     * Set if the markers associated to the group class @clas are hidden or not.
21809     *
21810     * @param clas The group class.
21811     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21812     * to show them.
21813     *
21814     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21815     * is to show them.
21816     *
21817     * @ingroup Map
21818     */
21819    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21820
21821    /**
21822     * Create a new marker class.
21823     *
21824     * @param obj The map object.
21825     * @return Returns the new group class.
21826     *
21827     * Each marker must be associated to a class.
21828     *
21829     * The marker class defines the style of the marker when a marker is
21830     * displayed alone, i.e., not grouped to to others markers. When grouped
21831     * it will use group class style.
21832     *
21833     * A marker class will need to be provided when creating a marker with
21834     * elm_map_marker_add().
21835     *
21836     * Some properties and functions can be set by class, as:
21837     * - style, with elm_map_marker_class_style_set()
21838     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21839     *   It can be set using elm_map_marker_class_icon_cb_set().
21840     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21841     *   Set using elm_map_marker_class_get_cb_set().
21842     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21843     *   Set using elm_map_marker_class_del_cb_set().
21844     *
21845     * @see elm_map_marker_add()
21846     * @see elm_map_marker_class_style_set()
21847     * @see elm_map_marker_class_icon_cb_set()
21848     * @see elm_map_marker_class_get_cb_set()
21849     * @see elm_map_marker_class_del_cb_set()
21850     *
21851     * @ingroup Map
21852     */
21853    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21854
21855    /**
21856     * Set the marker's style of a marker class.
21857     *
21858     * @param clas The marker class.
21859     * @param style The style to be used by markers.
21860     *
21861     * Each marker must be associated to a marker class, and will use the style
21862     * defined by such class when alone, i.e., @b not grouped to other markers.
21863     *
21864     * The following styles are provided by default theme:
21865     * @li @c radio
21866     * @li @c radio2
21867     * @li @c empty
21868     *
21869     * @see elm_map_marker_class_new() for more details.
21870     * @see elm_map_marker_add()
21871     *
21872     * @ingroup Map
21873     */
21874    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21875
21876    /**
21877     * Set the icon callback function of a marker class.
21878     *
21879     * @param clas The marker class.
21880     * @param icon_get The callback function that will return the icon.
21881     *
21882     * Each marker must be associated to a marker class, and it can display a
21883     * custom icon. The function @p icon_get must return this icon.
21884     *
21885     * @see elm_map_marker_class_new() for more details.
21886     * @see elm_map_marker_add()
21887     *
21888     * @ingroup Map
21889     */
21890    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21891
21892    /**
21893     * Set the bubble content callback function of a marker class.
21894     *
21895     * @param clas The marker class.
21896     * @param get The callback function that will return the content.
21897     *
21898     * Each marker must be associated to a marker class, and it can display a
21899     * a content on a bubble that opens when the user click over the marker.
21900     * The function @p get must return this content object.
21901     *
21902     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21903     * can be used.
21904     *
21905     * @see elm_map_marker_class_new() for more details.
21906     * @see elm_map_marker_class_del_cb_set()
21907     * @see elm_map_marker_add()
21908     *
21909     * @ingroup Map
21910     */
21911    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21912
21913    /**
21914     * Set the callback function used to delete bubble content of a marker class.
21915     *
21916     * @param clas The marker class.
21917     * @param del The callback function that will delete the content.
21918     *
21919     * Each marker must be associated to a marker class, and it can display a
21920     * a content on a bubble that opens when the user click over the marker.
21921     * The function to return such content can be set with
21922     * elm_map_marker_class_get_cb_set().
21923     *
21924     * If this content must be freed, a callback function need to be
21925     * set for that task with this function.
21926     *
21927     * If this callback is defined it will have to delete (or not) the
21928     * object inside, but if the callback is not defined the object will be
21929     * destroyed with evas_object_del().
21930     *
21931     * @see elm_map_marker_class_new() for more details.
21932     * @see elm_map_marker_class_get_cb_set()
21933     * @see elm_map_marker_add()
21934     *
21935     * @ingroup Map
21936     */
21937    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21938
21939    /**
21940     * Get the list of available sources.
21941     *
21942     * @param obj The map object.
21943     * @return The source names list.
21944     *
21945     * It will provide a list with all available sources, that can be set as
21946     * current source with elm_map_source_name_set(), or get with
21947     * elm_map_source_name_get().
21948     *
21949     * Available sources:
21950     * @li "Mapnik"
21951     * @li "Osmarender"
21952     * @li "CycleMap"
21953     * @li "Maplint"
21954     *
21955     * @see elm_map_source_name_set() for more details.
21956     * @see elm_map_source_name_get()
21957     *
21958     * @ingroup Map
21959     */
21960    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21961
21962    /**
21963     * Set the source of the map.
21964     *
21965     * @param obj The map object.
21966     * @param source The source to be used.
21967     *
21968     * Map widget retrieves images that composes the map from a web service.
21969     * This web service can be set with this method.
21970     *
21971     * A different service can return a different maps with different
21972     * information and it can use different zoom values.
21973     *
21974     * The @p source_name need to match one of the names provided by
21975     * elm_map_source_names_get().
21976     *
21977     * The current source can be get using elm_map_source_name_get().
21978     *
21979     * @see elm_map_source_names_get()
21980     * @see elm_map_source_name_get()
21981     *
21982     *
21983     * @ingroup Map
21984     */
21985    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21986
21987    /**
21988     * Get the name of currently used source.
21989     *
21990     * @param obj The map object.
21991     * @return Returns the name of the source in use.
21992     *
21993     * @see elm_map_source_name_set() for more details.
21994     *
21995     * @ingroup Map
21996     */
21997    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21998
21999    /**
22000     * Set the source of the route service to be used by the map.
22001     *
22002     * @param obj The map object.
22003     * @param source The route service to be used, being it one of
22004     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
22005     * and #ELM_MAP_ROUTE_SOURCE_ORS.
22006     *
22007     * Each one has its own algorithm, so the route retrieved may
22008     * differ depending on the source route. Now, only the default is working.
22009     *
22010     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
22011     * http://www.yournavigation.org/.
22012     *
22013     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
22014     * assumptions. Its routing core is based on Contraction Hierarchies.
22015     *
22016     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
22017     *
22018     * @see elm_map_route_source_get().
22019     *
22020     * @ingroup Map
22021     */
22022    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
22023
22024    /**
22025     * Get the current route source.
22026     *
22027     * @param obj The map object.
22028     * @return The source of the route service used by the map.
22029     *
22030     * @see elm_map_route_source_set() for details.
22031     *
22032     * @ingroup Map
22033     */
22034    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22035
22036    /**
22037     * Set the minimum zoom of the source.
22038     *
22039     * @param obj The map object.
22040     * @param zoom New minimum zoom value to be used.
22041     *
22042     * By default, it's 0.
22043     *
22044     * @ingroup Map
22045     */
22046    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22047
22048    /**
22049     * Get the minimum zoom of the source.
22050     *
22051     * @param obj The map object.
22052     * @return Returns the minimum zoom of the source.
22053     *
22054     * @see elm_map_source_zoom_min_set() for details.
22055     *
22056     * @ingroup Map
22057     */
22058    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22059
22060    /**
22061     * Set the maximum zoom of the source.
22062     *
22063     * @param obj The map object.
22064     * @param zoom New maximum zoom value to be used.
22065     *
22066     * By default, it's 18.
22067     *
22068     * @ingroup Map
22069     */
22070    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22071
22072    /**
22073     * Get the maximum zoom of the source.
22074     *
22075     * @param obj The map object.
22076     * @return Returns the maximum zoom of the source.
22077     *
22078     * @see elm_map_source_zoom_min_set() for details.
22079     *
22080     * @ingroup Map
22081     */
22082    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22083
22084    /**
22085     * Set the user agent used by the map object to access routing services.
22086     *
22087     * @param obj The map object.
22088     * @param user_agent The user agent to be used by the map.
22089     *
22090     * User agent is a client application implementing a network protocol used
22091     * in communications within a client–server distributed computing system
22092     *
22093     * The @p user_agent identification string will transmitted in a header
22094     * field @c User-Agent.
22095     *
22096     * @see elm_map_user_agent_get()
22097     *
22098     * @ingroup Map
22099     */
22100    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
22101
22102    /**
22103     * Get the user agent used by the map object.
22104     *
22105     * @param obj The map object.
22106     * @return The user agent identification string used by the map.
22107     *
22108     * @see elm_map_user_agent_set() for details.
22109     *
22110     * @ingroup Map
22111     */
22112    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22113
22114    /**
22115     * Add a new route to the map object.
22116     *
22117     * @param obj The map object.
22118     * @param type The type of transport to be considered when tracing a route.
22119     * @param method The routing method, what should be priorized.
22120     * @param flon The start longitude.
22121     * @param flat The start latitude.
22122     * @param tlon The destination longitude.
22123     * @param tlat The destination latitude.
22124     *
22125     * @return The created route or @c NULL upon failure.
22126     *
22127     * A route will be traced by point on coordinates (@p flat, @p flon)
22128     * to point on coordinates (@p tlat, @p tlon), using the route service
22129     * set with elm_map_route_source_set().
22130     *
22131     * It will take @p type on consideration to define the route,
22132     * depending if the user will be walking or driving, the route may vary.
22133     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
22134     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
22135     *
22136     * Another parameter is what the route should priorize, the minor distance
22137     * or the less time to be spend on the route. So @p method should be one
22138     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
22139     *
22140     * Routes created with this method can be deleted with
22141     * elm_map_route_remove(), colored with elm_map_route_color_set(),
22142     * and distance can be get with elm_map_route_distance_get().
22143     *
22144     * @see elm_map_route_remove()
22145     * @see elm_map_route_color_set()
22146     * @see elm_map_route_distance_get()
22147     * @see elm_map_route_source_set()
22148     *
22149     * @ingroup Map
22150     */
22151    EAPI Elm_Map_Route        *elm_map_route_add(Evas_Object *obj, Elm_Map_Route_Type type, Elm_Map_Route_Method method, double flon, double flat, double tlon, double tlat) EINA_ARG_NONNULL(1);
22152
22153    /**
22154     * Remove a route from the map.
22155     *
22156     * @param route The route to remove.
22157     *
22158     * @see elm_map_route_add()
22159     *
22160     * @ingroup Map
22161     */
22162    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22163
22164    /**
22165     * Set the route color.
22166     *
22167     * @param route The route object.
22168     * @param r Red channel value, from 0 to 255.
22169     * @param g Green channel value, from 0 to 255.
22170     * @param b Blue channel value, from 0 to 255.
22171     * @param a Alpha channel value, from 0 to 255.
22172     *
22173     * It uses an additive color model, so each color channel represents
22174     * how much of each primary colors must to be used. 0 represents
22175     * ausence of this color, so if all of the three are set to 0,
22176     * the color will be black.
22177     *
22178     * These component values should be integers in the range 0 to 255,
22179     * (single 8-bit byte).
22180     *
22181     * This sets the color used for the route. By default, it is set to
22182     * solid red (r = 255, g = 0, b = 0, a = 255).
22183     *
22184     * For alpha channel, 0 represents completely transparent, and 255, opaque.
22185     *
22186     * @see elm_map_route_color_get()
22187     *
22188     * @ingroup Map
22189     */
22190    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
22191
22192    /**
22193     * Get the route color.
22194     *
22195     * @param route The route object.
22196     * @param r Pointer where to store the red channel value.
22197     * @param g Pointer where to store the green channel value.
22198     * @param b Pointer where to store the blue channel value.
22199     * @param a Pointer where to store the alpha channel value.
22200     *
22201     * @see elm_map_route_color_set() for details.
22202     *
22203     * @ingroup Map
22204     */
22205    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
22206
22207    /**
22208     * Get the route distance in kilometers.
22209     *
22210     * @param route The route object.
22211     * @return The distance of route (unit : km).
22212     *
22213     * @ingroup Map
22214     */
22215    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22216
22217    /**
22218     * Get the information of route nodes.
22219     *
22220     * @param route The route object.
22221     * @return Returns a string with the nodes of route.
22222     *
22223     * @ingroup Map
22224     */
22225    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22226
22227    /**
22228     * Get the information of route waypoint.
22229     *
22230     * @param route the route object.
22231     * @return Returns a string with information about waypoint of route.
22232     *
22233     * @ingroup Map
22234     */
22235    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22236
22237    /**
22238     * Get the address of the name.
22239     *
22240     * @param name The name handle.
22241     * @return Returns the address string of @p name.
22242     *
22243     * This gets the coordinates of the @p name, created with one of the
22244     * conversion functions.
22245     *
22246     * @see elm_map_utils_convert_name_into_coord()
22247     * @see elm_map_utils_convert_coord_into_name()
22248     *
22249     * @ingroup Map
22250     */
22251    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22252
22253    /**
22254     * Get the current coordinates of the name.
22255     *
22256     * @param name The name handle.
22257     * @param lat Pointer where to store the latitude.
22258     * @param lon Pointer where to store The longitude.
22259     *
22260     * This gets the coordinates of the @p name, created with one of the
22261     * conversion functions.
22262     *
22263     * @see elm_map_utils_convert_name_into_coord()
22264     * @see elm_map_utils_convert_coord_into_name()
22265     *
22266     * @ingroup Map
22267     */
22268    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22269
22270    /**
22271     * Remove a name from the map.
22272     *
22273     * @param name The name to remove.
22274     *
22275     * Basically the struct handled by @p name will be freed, so convertions
22276     * between address and coordinates will be lost.
22277     *
22278     * @see elm_map_utils_convert_name_into_coord()
22279     * @see elm_map_utils_convert_coord_into_name()
22280     *
22281     * @ingroup Map
22282     */
22283    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22284
22285    /**
22286     * Rotate the map.
22287     *
22288     * @param obj The map object.
22289     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22290     * @param cx Rotation's center horizontal position.
22291     * @param cy Rotation's center vertical position.
22292     *
22293     * @see elm_map_rotate_get()
22294     *
22295     * @ingroup Map
22296     */
22297    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22298
22299    /**
22300     * Get the rotate degree of the map
22301     *
22302     * @param obj The map object
22303     * @param degree Pointer where to store degrees from 0.0 to 360.0
22304     * to rotate arount Z axis.
22305     * @param cx Pointer where to store rotation's center horizontal position.
22306     * @param cy Pointer where to store rotation's center vertical position.
22307     *
22308     * @see elm_map_rotate_set() to set map rotation.
22309     *
22310     * @ingroup Map
22311     */
22312    EAPI void                  elm_map_rotate_get(const Evas_Object *obj, double *degree, Evas_Coord *cx, Evas_Coord *cy) EINA_ARG_NONNULL(1, 2, 3, 4);
22313
22314    /**
22315     * Enable or disable mouse wheel to be used to zoom in / out the map.
22316     *
22317     * @param obj The map object.
22318     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22319     * to enable it.
22320     *
22321     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22322     *
22323     * It's disabled by default.
22324     *
22325     * @see elm_map_wheel_disabled_get()
22326     *
22327     * @ingroup Map
22328     */
22329    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22330
22331    /**
22332     * Get a value whether mouse wheel is enabled or not.
22333     *
22334     * @param obj The map object.
22335     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22336     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22337     *
22338     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22339     *
22340     * @see elm_map_wheel_disabled_set() for details.
22341     *
22342     * @ingroup Map
22343     */
22344    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22345
22346 #ifdef ELM_EMAP
22347    /**
22348     * Add a track on the map
22349     *
22350     * @param obj The map object.
22351     * @param emap The emap route object.
22352     * @return The route object. This is an elm object of type Route.
22353     *
22354     * @see elm_route_add() for details.
22355     *
22356     * @ingroup Map
22357     */
22358    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22359 #endif
22360
22361    /**
22362     * Remove a track from the map
22363     *
22364     * @param obj The map object.
22365     * @param route The track to remove.
22366     *
22367     * @ingroup Map
22368     */
22369    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22370
22371    /**
22372     * @}
22373     */
22374
22375    /* Route */
22376    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22377 #ifdef ELM_EMAP
22378    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22379 #endif
22380    EAPI double elm_route_lon_min_get(Evas_Object *obj);
22381    EAPI double elm_route_lat_min_get(Evas_Object *obj);
22382    EAPI double elm_route_lon_max_get(Evas_Object *obj);
22383    EAPI double elm_route_lat_max_get(Evas_Object *obj);
22384
22385
22386    /**
22387     * @defgroup Panel Panel
22388     *
22389     * @image html img/widget/panel/preview-00.png
22390     * @image latex img/widget/panel/preview-00.eps
22391     *
22392     * @brief A panel is a type of animated container that contains subobjects.
22393     * It can be expanded or contracted by clicking the button on it's edge.
22394     *
22395     * Orientations are as follows:
22396     * @li ELM_PANEL_ORIENT_TOP
22397     * @li ELM_PANEL_ORIENT_LEFT
22398     * @li ELM_PANEL_ORIENT_RIGHT
22399     *
22400     * @ref tutorial_panel shows one way to use this widget.
22401     * @{
22402     */
22403    typedef enum _Elm_Panel_Orient
22404      {
22405         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22406         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22407         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22408         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22409      } Elm_Panel_Orient;
22410    /**
22411     * @brief Adds a panel object
22412     *
22413     * @param parent The parent object
22414     *
22415     * @return The panel object, or NULL on failure
22416     */
22417    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22418    /**
22419     * @brief Sets the orientation of the panel
22420     *
22421     * @param parent The parent object
22422     * @param orient The panel orientation. Can be one of the following:
22423     * @li ELM_PANEL_ORIENT_TOP
22424     * @li ELM_PANEL_ORIENT_LEFT
22425     * @li ELM_PANEL_ORIENT_RIGHT
22426     *
22427     * Sets from where the panel will (dis)appear.
22428     */
22429    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22430    /**
22431     * @brief Get the orientation of the panel.
22432     *
22433     * @param obj The panel object
22434     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22435     */
22436    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22437    /**
22438     * @brief Set the content of the panel.
22439     *
22440     * @param obj The panel object
22441     * @param content The panel content
22442     *
22443     * Once the content object is set, a previously set one will be deleted.
22444     * If you want to keep that old content object, use the
22445     * elm_panel_content_unset() function.
22446     */
22447    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22448    /**
22449     * @brief Get the content of the panel.
22450     *
22451     * @param obj The panel object
22452     * @return The content that is being used
22453     *
22454     * Return the content object which is set for this widget.
22455     *
22456     * @see elm_panel_content_set()
22457     */
22458    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22459    /**
22460     * @brief Unset the content of the panel.
22461     *
22462     * @param obj The panel object
22463     * @return The content that was being used
22464     *
22465     * Unparent and return the content object which was set for this widget.
22466     *
22467     * @see elm_panel_content_set()
22468     */
22469    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22470    /**
22471     * @brief Set the state of the panel.
22472     *
22473     * @param obj The panel object
22474     * @param hidden If true, the panel will run the animation to contract
22475     */
22476    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22477    /**
22478     * @brief Get the state of the panel.
22479     *
22480     * @param obj The panel object
22481     * @param hidden If true, the panel is in the "hide" state
22482     */
22483    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22484    /**
22485     * @brief Toggle the hidden state of the panel from code
22486     *
22487     * @param obj The panel object
22488     */
22489    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22490    /**
22491     * @}
22492     */
22493
22494    /**
22495     * @defgroup Panes Panes
22496     * @ingroup Elementary
22497     *
22498     * @image html img/widget/panes/preview-00.png
22499     * @image latex img/widget/panes/preview-00.eps width=\textwidth
22500     *
22501     * @image html img/panes.png
22502     * @image latex img/panes.eps width=\textwidth
22503     *
22504     * The panes adds a dragable bar between two contents. When dragged
22505     * this bar will resize contents size.
22506     *
22507     * Panes can be displayed vertically or horizontally, and contents
22508     * size proportion can be customized (homogeneous by default).
22509     *
22510     * Smart callbacks one can listen to:
22511     * - "press" - The panes has been pressed (button wasn't released yet).
22512     * - "unpressed" - The panes was released after being pressed.
22513     * - "clicked" - The panes has been clicked>
22514     * - "clicked,double" - The panes has been double clicked
22515     *
22516     * Available styles for it:
22517     * - @c "default"
22518     *
22519     * Here is an example on its usage:
22520     * @li @ref panes_example
22521     */
22522
22523    /**
22524     * @addtogroup Panes
22525     * @{
22526     */
22527
22528    /**
22529     * Add a new panes widget to the given parent Elementary
22530     * (container) object.
22531     *
22532     * @param parent The parent object.
22533     * @return a new panes widget handle or @c NULL, on errors.
22534     *
22535     * This function inserts a new panes widget on the canvas.
22536     *
22537     * @ingroup Panes
22538     */
22539    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22540
22541    /**
22542     * Set the left content of the panes widget.
22543     *
22544     * @param obj The panes object.
22545     * @param content The new left content object.
22546     *
22547     * Once the content object is set, a previously set one will be deleted.
22548     * If you want to keep that old content object, use the
22549     * elm_panes_content_left_unset() function.
22550     *
22551     * If panes is displayed vertically, left content will be displayed at
22552     * top.
22553     *
22554     * @see elm_panes_content_left_get()
22555     * @see elm_panes_content_right_set() to set content on the other side.
22556     *
22557     * @ingroup Panes
22558     */
22559    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22560
22561    /**
22562     * Set the right content of the panes widget.
22563     *
22564     * @param obj The panes object.
22565     * @param content The new right content object.
22566     *
22567     * Once the content object is set, a previously set one will be deleted.
22568     * If you want to keep that old content object, use the
22569     * elm_panes_content_right_unset() function.
22570     *
22571     * If panes is displayed vertically, left content will be displayed at
22572     * bottom.
22573     *
22574     * @see elm_panes_content_right_get()
22575     * @see elm_panes_content_left_set() to set content on the other side.
22576     *
22577     * @ingroup Panes
22578     */
22579    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22580
22581    /**
22582     * Get the left content of the panes.
22583     *
22584     * @param obj The panes object.
22585     * @return The left content object that is being used.
22586     *
22587     * Return the left content object which is set for this widget.
22588     *
22589     * @see elm_panes_content_left_set() for details.
22590     *
22591     * @ingroup Panes
22592     */
22593    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22594
22595    /**
22596     * Get the right content of the panes.
22597     *
22598     * @param obj The panes object
22599     * @return The right content object that is being used
22600     *
22601     * Return the right content object which is set for this widget.
22602     *
22603     * @see elm_panes_content_right_set() for details.
22604     *
22605     * @ingroup Panes
22606     */
22607    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22608
22609    /**
22610     * Unset the left content used for the panes.
22611     *
22612     * @param obj The panes object.
22613     * @return The left content object that was being used.
22614     *
22615     * Unparent and return the left content object which was set for this widget.
22616     *
22617     * @see elm_panes_content_left_set() for details.
22618     * @see elm_panes_content_left_get().
22619     *
22620     * @ingroup Panes
22621     */
22622    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22623
22624    /**
22625     * Unset the right content used for the panes.
22626     *
22627     * @param obj The panes object.
22628     * @return The right content object that was being used.
22629     *
22630     * Unparent and return the right content object which was set for this
22631     * widget.
22632     *
22633     * @see elm_panes_content_right_set() for details.
22634     * @see elm_panes_content_right_get().
22635     *
22636     * @ingroup Panes
22637     */
22638    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22639
22640    /**
22641     * Get the size proportion of panes widget's left side.
22642     *
22643     * @param obj The panes object.
22644     * @return float value between 0.0 and 1.0 representing size proportion
22645     * of left side.
22646     *
22647     * @see elm_panes_content_left_size_set() for more details.
22648     *
22649     * @ingroup Panes
22650     */
22651    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22652
22653    /**
22654     * Set the size proportion of panes widget's left side.
22655     *
22656     * @param obj The panes object.
22657     * @param size Value between 0.0 and 1.0 representing size proportion
22658     * of left side.
22659     *
22660     * By default it's homogeneous, i.e., both sides have the same size.
22661     *
22662     * If something different is required, it can be set with this function.
22663     * For example, if the left content should be displayed over
22664     * 75% of the panes size, @p size should be passed as @c 0.75.
22665     * This way, right content will be resized to 25% of panes size.
22666     *
22667     * If displayed vertically, left content is displayed at top, and
22668     * right content at bottom.
22669     *
22670     * @note This proportion will change when user drags the panes bar.
22671     *
22672     * @see elm_panes_content_left_size_get()
22673     *
22674     * @ingroup Panes
22675     */
22676    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22677
22678   /**
22679    * Set the orientation of a given panes widget.
22680    *
22681    * @param obj The panes object.
22682    * @param horizontal Use @c EINA_TRUE to make @p obj to be
22683    * @b horizontal, @c EINA_FALSE to make it @b vertical.
22684    *
22685    * Use this function to change how your panes is to be
22686    * disposed: vertically or horizontally.
22687    *
22688    * By default it's displayed horizontally.
22689    *
22690    * @see elm_panes_horizontal_get()
22691    *
22692    * @ingroup Panes
22693    */
22694    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22695
22696    /**
22697     * Retrieve the orientation of a given panes widget.
22698     *
22699     * @param obj The panes object.
22700     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22701     * @c EINA_FALSE if it's @b vertical (and on errors).
22702     *
22703     * @see elm_panes_horizontal_set() for more details.
22704     *
22705     * @ingroup Panes
22706     */
22707    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22708
22709    /**
22710     * @}
22711     */
22712
22713    /**
22714     * @defgroup Flip Flip
22715     *
22716     * @image html img/widget/flip/preview-00.png
22717     * @image latex img/widget/flip/preview-00.eps
22718     *
22719     * This widget holds 2 content objects(Evas_Object): one on the front and one
22720     * on the back. It allows you to flip from front to back and vice-versa using
22721     * various animations.
22722     *
22723     * If either the front or back contents are not set the flip will treat that
22724     * as transparent. So if you wore to set the front content but not the back,
22725     * and then call elm_flip_go() you would see whatever is below the flip.
22726     *
22727     * For a list of supported animations see elm_flip_go().
22728     *
22729     * Signals that you can add callbacks for are:
22730     * "animate,begin" - when a flip animation was started
22731     * "animate,done" - when a flip animation is finished
22732     *
22733     * @ref tutorial_flip show how to use most of the API.
22734     *
22735     * @{
22736     */
22737    typedef enum _Elm_Flip_Mode
22738      {
22739         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22740         ELM_FLIP_ROTATE_X_CENTER_AXIS,
22741         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22742         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22743         ELM_FLIP_CUBE_LEFT,
22744         ELM_FLIP_CUBE_RIGHT,
22745         ELM_FLIP_CUBE_UP,
22746         ELM_FLIP_CUBE_DOWN,
22747         ELM_FLIP_PAGE_LEFT,
22748         ELM_FLIP_PAGE_RIGHT,
22749         ELM_FLIP_PAGE_UP,
22750         ELM_FLIP_PAGE_DOWN
22751      } Elm_Flip_Mode;
22752    typedef enum _Elm_Flip_Interaction
22753      {
22754         ELM_FLIP_INTERACTION_NONE,
22755         ELM_FLIP_INTERACTION_ROTATE,
22756         ELM_FLIP_INTERACTION_CUBE,
22757         ELM_FLIP_INTERACTION_PAGE
22758      } Elm_Flip_Interaction;
22759    typedef enum _Elm_Flip_Direction
22760      {
22761         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22762         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22763         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22764         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22765      } Elm_Flip_Direction;
22766    /**
22767     * @brief Add a new flip to the parent
22768     *
22769     * @param parent The parent object
22770     * @return The new object or NULL if it cannot be created
22771     */
22772    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22773    /**
22774     * @brief Set the front content of the flip widget.
22775     *
22776     * @param obj The flip object
22777     * @param content The new front content object
22778     *
22779     * Once the content object is set, a previously set one will be deleted.
22780     * If you want to keep that old content object, use the
22781     * elm_flip_content_front_unset() function.
22782     */
22783    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22784    /**
22785     * @brief Set the back content of the flip widget.
22786     *
22787     * @param obj The flip object
22788     * @param content The new back content object
22789     *
22790     * Once the content object is set, a previously set one will be deleted.
22791     * If you want to keep that old content object, use the
22792     * elm_flip_content_back_unset() function.
22793     */
22794    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22795    /**
22796     * @brief Get the front content used for the flip
22797     *
22798     * @param obj The flip object
22799     * @return The front content object that is being used
22800     *
22801     * Return the front content object which is set for this widget.
22802     */
22803    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22804    /**
22805     * @brief Get the back content used for the flip
22806     *
22807     * @param obj The flip object
22808     * @return The back content object that is being used
22809     *
22810     * Return the back content object which is set for this widget.
22811     */
22812    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22813    /**
22814     * @brief Unset the front content used for the flip
22815     *
22816     * @param obj The flip object
22817     * @return The front content object that was being used
22818     *
22819     * Unparent and return the front content object which was set for this widget.
22820     */
22821    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22822    /**
22823     * @brief Unset the back content used for the flip
22824     *
22825     * @param obj The flip object
22826     * @return The back content object that was being used
22827     *
22828     * Unparent and return the back content object which was set for this widget.
22829     */
22830    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22831    /**
22832     * @brief Get flip front visibility state
22833     *
22834     * @param obj The flip objct
22835     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22836     * showing.
22837     */
22838    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22839    /**
22840     * @brief Set flip perspective
22841     *
22842     * @param obj The flip object
22843     * @param foc The coordinate to set the focus on
22844     * @param x The X coordinate
22845     * @param y The Y coordinate
22846     *
22847     * @warning This function currently does nothing.
22848     */
22849    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22850    /**
22851     * @brief Runs the flip animation
22852     *
22853     * @param obj The flip object
22854     * @param mode The mode type
22855     *
22856     * Flips the front and back contents using the @p mode animation. This
22857     * efectively hides the currently visible content and shows the hidden one.
22858     *
22859     * There a number of possible animations to use for the flipping:
22860     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22861     * around a horizontal axis in the middle of its height, the other content
22862     * is shown as the other side of the flip.
22863     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22864     * around a vertical axis in the middle of its width, the other content is
22865     * shown as the other side of the flip.
22866     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22867     * around a diagonal axis in the middle of its width, the other content is
22868     * shown as the other side of the flip.
22869     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22870     * around a diagonal axis in the middle of its height, the other content is
22871     * shown as the other side of the flip.
22872     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22873     * as if the flip was a cube, the other content is show as the right face of
22874     * the cube.
22875     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22876     * right as if the flip was a cube, the other content is show as the left
22877     * face of the cube.
22878     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22879     * flip was a cube, the other content is show as the bottom face of the cube.
22880     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22881     * the flip was a cube, the other content is show as the upper face of the
22882     * cube.
22883     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22884     * if the flip was a book, the other content is shown as the page below that.
22885     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22886     * as if the flip was a book, the other content is shown as the page below
22887     * that.
22888     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22889     * flip was a book, the other content is shown as the page below that.
22890     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22891     * flip was a book, the other content is shown as the page below that.
22892     *
22893     * @image html elm_flip.png
22894     * @image latex elm_flip.eps width=\textwidth
22895     */
22896    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22897    /**
22898     * @brief Set the interactive flip mode
22899     *
22900     * @param obj The flip object
22901     * @param mode The interactive flip mode to use
22902     *
22903     * This sets if the flip should be interactive (allow user to click and
22904     * drag a side of the flip to reveal the back page and cause it to flip).
22905     * By default a flip is not interactive. You may also need to set which
22906     * sides of the flip are "active" for flipping and how much space they use
22907     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22908     * and elm_flip_interacton_direction_hitsize_set()
22909     *
22910     * The four avilable mode of interaction are:
22911     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22912     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22913     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22914     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22915     *
22916     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22917     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22918     * happen, those can only be acheived with elm_flip_go();
22919     */
22920    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22921    /**
22922     * @brief Get the interactive flip mode
22923     *
22924     * @param obj The flip object
22925     * @return The interactive flip mode
22926     *
22927     * Returns the interactive flip mode set by elm_flip_interaction_set()
22928     */
22929    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22930    /**
22931     * @brief Set which directions of the flip respond to interactive flip
22932     *
22933     * @param obj The flip object
22934     * @param dir The direction to change
22935     * @param enabled If that direction is enabled or not
22936     *
22937     * By default all directions are disabled, so you may want to enable the
22938     * desired directions for flipping if you need interactive flipping. You must
22939     * call this function once for each direction that should be enabled.
22940     *
22941     * @see elm_flip_interaction_set()
22942     */
22943    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22944    /**
22945     * @brief Get the enabled state of that flip direction
22946     *
22947     * @param obj The flip object
22948     * @param dir The direction to check
22949     * @return If that direction is enabled or not
22950     *
22951     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22952     *
22953     * @see elm_flip_interaction_set()
22954     */
22955    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22956    /**
22957     * @brief Set the amount of the flip that is sensitive to interactive flip
22958     *
22959     * @param obj The flip object
22960     * @param dir The direction to modify
22961     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22962     *
22963     * Set the amount of the flip that is sensitive to interactive flip, with 0
22964     * representing no area in the flip and 1 representing the entire flip. There
22965     * is however a consideration to be made in that the area will never be
22966     * smaller than the finger size set(as set in your Elementary configuration).
22967     *
22968     * @see elm_flip_interaction_set()
22969     */
22970    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22971    /**
22972     * @brief Get the amount of the flip that is sensitive to interactive flip
22973     *
22974     * @param obj The flip object
22975     * @param dir The direction to check
22976     * @return The size set for that direction
22977     *
22978     * Returns the amount os sensitive area set by
22979     * elm_flip_interacton_direction_hitsize_set().
22980     */
22981    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22982    /**
22983     * @}
22984     */
22985
22986    /* scrolledentry */
22987    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22988    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22989    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22990    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22991    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22992    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22993    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22994    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22995    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22996    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22997    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22998    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22999    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
23000    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23001    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
23002    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
23003    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23004    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23005    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
23006    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
23007    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23008    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23009    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23010    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
23011    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
23012    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
23013    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23014    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23015    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23016    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23017    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23018    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
23019    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
23020    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
23021    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23022    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_item_add(Evas_Object *obj, const char *label, const char *icon_file, Elm_Icon_Type icon_type, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
23023    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23024    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23025    EINA_DEPRECATED EAPI void         elm_scrolled_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v) EINA_ARG_NONNULL(1);
23026    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23027    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23028    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
23029    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23030    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23031    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23032    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
23033    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23034    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23035    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
23036    EINA_DEPRECATED EAPI void         elm_scrolled_entry_item_provider_append(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
23037    EINA_DEPRECATED EAPI void         elm_scrolled_entry_item_provider_prepend(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
23038    EINA_DEPRECATED EAPI void         elm_scrolled_entry_item_provider_remove(Evas_Object *obj, Evas_Object *(*func) (void *data, Evas_Object *entry, const char *item), void *data) EINA_ARG_NONNULL(1, 2);
23039    EINA_DEPRECATED EAPI void         elm_scrolled_entry_text_filter_append(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
23040    EINA_DEPRECATED EAPI void         elm_scrolled_entry_text_filter_prepend(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
23041    EINA_DEPRECATED EAPI void         elm_scrolled_entry_text_filter_remove(Evas_Object *obj, void (*func) (void *data, Evas_Object *entry, char **text), void *data) EINA_ARG_NONNULL(1, 2);
23042    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
23043    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
23044    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
23045    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
23046    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23047    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
23048    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
23049
23050    /**
23051     * @defgroup Conformant Conformant
23052     * @ingroup Elementary
23053     *
23054     * @image html img/widget/conformant/preview-00.png
23055     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
23056     *
23057     * @image html img/conformant.png
23058     * @image latex img/conformant.eps width=\textwidth
23059     *
23060     * The aim is to provide a widget that can be used in elementary apps to
23061     * account for space taken up by the indicator, virtual keypad & softkey
23062     * windows when running the illume2 module of E17.
23063     *
23064     * So conformant content will be sized and positioned considering the
23065     * space required for such stuff, and when they popup, as a keyboard
23066     * shows when an entry is selected, conformant content won't change.
23067     *
23068     * Available styles for it:
23069     * - @c "default"
23070     *
23071     * See how to use this widget in this example:
23072     * @ref conformant_example
23073     */
23074
23075    /**
23076     * @addtogroup Conformant
23077     * @{
23078     */
23079
23080    /**
23081     * Add a new conformant widget to the given parent Elementary
23082     * (container) object.
23083     *
23084     * @param parent The parent object.
23085     * @return A new conformant widget handle or @c NULL, on errors.
23086     *
23087     * This function inserts a new conformant widget on the canvas.
23088     *
23089     * @ingroup Conformant
23090     */
23091    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23092
23093    /**
23094     * Set the content of the conformant widget.
23095     *
23096     * @param obj The conformant object.
23097     * @param content The content to be displayed by the conformant.
23098     *
23099     * Content will be sized and positioned considering the space required
23100     * to display a virtual keyboard. So it won't fill all the conformant
23101     * size. This way is possible to be sure that content won't resize
23102     * or be re-positioned after the keyboard is displayed.
23103     *
23104     * Once the content object is set, a previously set one will be deleted.
23105     * If you want to keep that old content object, use the
23106     * elm_conformat_content_unset() function.
23107     *
23108     * @see elm_conformant_content_unset()
23109     * @see elm_conformant_content_get()
23110     *
23111     * @ingroup Conformant
23112     */
23113    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23114
23115    /**
23116     * Get the content of the conformant widget.
23117     *
23118     * @param obj The conformant object.
23119     * @return The content that is being used.
23120     *
23121     * Return the content object which is set for this widget.
23122     * It won't be unparent from conformant. For that, use
23123     * elm_conformant_content_unset().
23124     *
23125     * @see elm_conformant_content_set() for more details.
23126     * @see elm_conformant_content_unset()
23127     *
23128     * @ingroup Conformant
23129     */
23130    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23131
23132    /**
23133     * Unset the content of the conformant widget.
23134     *
23135     * @param obj The conformant object.
23136     * @return The content that was being used.
23137     *
23138     * Unparent and return the content object which was set for this widget.
23139     *
23140     * @see elm_conformant_content_set() for more details.
23141     *
23142     * @ingroup Conformant
23143     */
23144    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23145
23146    /**
23147     * Returns the Evas_Object that represents the content area.
23148     *
23149     * @param obj The conformant object.
23150     * @return The content area of the widget.
23151     *
23152     * @ingroup Conformant
23153     */
23154    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23155
23156    /**
23157     * @}
23158     */
23159
23160    /**
23161     * @defgroup Mapbuf Mapbuf
23162     * @ingroup Elementary
23163     *
23164     * @image html img/widget/mapbuf/preview-00.png
23165     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
23166     *
23167     * This holds one content object and uses an Evas Map of transformation
23168     * points to be later used with this content. So the content will be
23169     * moved, resized, etc as a single image. So it will improve performance
23170     * when you have a complex interafce, with a lot of elements, and will
23171     * need to resize or move it frequently (the content object and its
23172     * children).
23173     *
23174     * See how to use this widget in this example:
23175     * @ref mapbuf_example
23176     */
23177
23178    /**
23179     * @addtogroup Mapbuf
23180     * @{
23181     */
23182
23183    /**
23184     * Add a new mapbuf widget to the given parent Elementary
23185     * (container) object.
23186     *
23187     * @param parent The parent object.
23188     * @return A new mapbuf widget handle or @c NULL, on errors.
23189     *
23190     * This function inserts a new mapbuf widget on the canvas.
23191     *
23192     * @ingroup Mapbuf
23193     */
23194    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23195
23196    /**
23197     * Set the content of the mapbuf.
23198     *
23199     * @param obj The mapbuf object.
23200     * @param content The content that will be filled in this mapbuf object.
23201     *
23202     * Once the content object is set, a previously set one will be deleted.
23203     * If you want to keep that old content object, use the
23204     * elm_mapbuf_content_unset() function.
23205     *
23206     * To enable map, elm_mapbuf_enabled_set() should be used.
23207     *
23208     * @ingroup Mapbuf
23209     */
23210    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23211
23212    /**
23213     * Get the content of the mapbuf.
23214     *
23215     * @param obj The mapbuf object.
23216     * @return The content that is being used.
23217     *
23218     * Return the content object which is set for this widget.
23219     *
23220     * @see elm_mapbuf_content_set() for details.
23221     *
23222     * @ingroup Mapbuf
23223     */
23224    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23225
23226    /**
23227     * Unset the content of the mapbuf.
23228     *
23229     * @param obj The mapbuf object.
23230     * @return The content that was being used.
23231     *
23232     * Unparent and return the content object which was set for this widget.
23233     *
23234     * @see elm_mapbuf_content_set() for details.
23235     *
23236     * @ingroup Mapbuf
23237     */
23238    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23239
23240    /**
23241     * Enable or disable the map.
23242     *
23243     * @param obj The mapbuf object.
23244     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23245     *
23246     * This enables the map that is set or disables it. On enable, the object
23247     * geometry will be saved, and the new geometry will change (position and
23248     * size) to reflect the map geometry set.
23249     *
23250     * Also, when enabled, alpha and smooth states will be used, so if the
23251     * content isn't solid, alpha should be enabled, for example, otherwise
23252     * a black retangle will fill the content.
23253     *
23254     * When disabled, the stored map will be freed and geometry prior to
23255     * enabling the map will be restored.
23256     *
23257     * It's disabled by default.
23258     *
23259     * @see elm_mapbuf_alpha_set()
23260     * @see elm_mapbuf_smooth_set()
23261     *
23262     * @ingroup Mapbuf
23263     */
23264    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23265
23266    /**
23267     * Get a value whether map is enabled or not.
23268     *
23269     * @param obj The mapbuf object.
23270     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23271     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23272     *
23273     * @see elm_mapbuf_enabled_set() for details.
23274     *
23275     * @ingroup Mapbuf
23276     */
23277    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23278
23279    /**
23280     * Enable or disable smooth map rendering.
23281     *
23282     * @param obj The mapbuf object.
23283     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23284     * to disable it.
23285     *
23286     * This sets smoothing for map rendering. If the object is a type that has
23287     * its own smoothing settings, then both the smooth settings for this object
23288     * and the map must be turned off.
23289     *
23290     * By default smooth maps are enabled.
23291     *
23292     * @ingroup Mapbuf
23293     */
23294    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23295
23296    /**
23297     * Get a value whether smooth map rendering is enabled or not.
23298     *
23299     * @param obj The mapbuf object.
23300     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23301     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23302     *
23303     * @see elm_mapbuf_smooth_set() for details.
23304     *
23305     * @ingroup Mapbuf
23306     */
23307    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23308
23309    /**
23310     * Set or unset alpha flag for map rendering.
23311     *
23312     * @param obj The mapbuf object.
23313     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23314     * to disable it.
23315     *
23316     * This sets alpha flag for map rendering. If the object is a type that has
23317     * its own alpha settings, then this will take precedence. Only image objects
23318     * have this currently. It stops alpha blending of the map area, and is
23319     * useful if you know the object and/or all sub-objects is 100% solid.
23320     *
23321     * Alpha is enabled by default.
23322     *
23323     * @ingroup Mapbuf
23324     */
23325    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23326
23327    /**
23328     * Get a value whether alpha blending is enabled or not.
23329     *
23330     * @param obj The mapbuf object.
23331     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23332     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23333     *
23334     * @see elm_mapbuf_alpha_set() for details.
23335     *
23336     * @ingroup Mapbuf
23337     */
23338    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23339
23340    /**
23341     * @}
23342     */
23343
23344    /**
23345     * @defgroup Flipselector Flip Selector
23346     *
23347     * @image html img/widget/flipselector/preview-00.png
23348     * @image latex img/widget/flipselector/preview-00.eps
23349     *
23350     * A flip selector is a widget to show a set of @b text items, one
23351     * at a time, with the same sheet switching style as the @ref Clock
23352     * "clock" widget, when one changes the current displaying sheet
23353     * (thus, the "flip" in the name).
23354     *
23355     * User clicks to flip sheets which are @b held for some time will
23356     * make the flip selector to flip continuosly and automatically for
23357     * the user. The interval between flips will keep growing in time,
23358     * so that it helps the user to reach an item which is distant from
23359     * the current selection.
23360     *
23361     * Smart callbacks one can register to:
23362     * - @c "selected" - when the widget's selected text item is changed
23363     * - @c "overflowed" - when the widget's current selection is changed
23364     *   from the first item in its list to the last
23365     * - @c "underflowed" - when the widget's current selection is changed
23366     *   from the last item in its list to the first
23367     *
23368     * Available styles for it:
23369     * - @c "default"
23370     *
23371     * Here is an example on its usage:
23372     * @li @ref flipselector_example
23373     */
23374
23375    /**
23376     * @addtogroup Flipselector
23377     * @{
23378     */
23379
23380    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23381
23382    /**
23383     * Add a new flip selector widget to the given parent Elementary
23384     * (container) widget
23385     *
23386     * @param parent The parent object
23387     * @return a new flip selector widget handle or @c NULL, on errors
23388     *
23389     * This function inserts a new flip selector widget on the canvas.
23390     *
23391     * @ingroup Flipselector
23392     */
23393    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23394
23395    /**
23396     * Programmatically select the next item of a flip selector widget
23397     *
23398     * @param obj The flipselector object
23399     *
23400     * @note The selection will be animated. Also, if it reaches the
23401     * end of its list of member items, it will continue with the first
23402     * one onwards.
23403     *
23404     * @ingroup Flipselector
23405     */
23406    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23407
23408    /**
23409     * Programmatically select the previous item of a flip selector
23410     * widget
23411     *
23412     * @param obj The flipselector object
23413     *
23414     * @note The selection will be animated.  Also, if it reaches the
23415     * beginning of its list of member items, it will continue with the
23416     * last one backwards.
23417     *
23418     * @ingroup Flipselector
23419     */
23420    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23421
23422    /**
23423     * Append a (text) item to a flip selector widget
23424     *
23425     * @param obj The flipselector object
23426     * @param label The (text) label of the new item
23427     * @param func Convenience callback function to take place when
23428     * item is selected
23429     * @param data Data passed to @p func, above
23430     * @return A handle to the item added or @c NULL, on errors
23431     *
23432     * The widget's list of labels to show will be appended with the
23433     * given value. If the user wishes so, a callback function pointer
23434     * can be passed, which will get called when this same item is
23435     * selected.
23436     *
23437     * @note The current selection @b won't be modified by appending an
23438     * element to the list.
23439     *
23440     * @note The maximum length of the text label is going to be
23441     * determined <b>by the widget's theme</b>. Strings larger than
23442     * that value are going to be @b truncated.
23443     *
23444     * @ingroup Flipselector
23445     */
23446    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23447
23448    /**
23449     * Prepend a (text) item to a flip selector widget
23450     *
23451     * @param obj The flipselector object
23452     * @param label The (text) label of the new item
23453     * @param func Convenience callback function to take place when
23454     * item is selected
23455     * @param data Data passed to @p func, above
23456     * @return A handle to the item added or @c NULL, on errors
23457     *
23458     * The widget's list of labels to show will be prepended with the
23459     * given value. If the user wishes so, a callback function pointer
23460     * can be passed, which will get called when this same item is
23461     * selected.
23462     *
23463     * @note The current selection @b won't be modified by prepending
23464     * an element to the list.
23465     *
23466     * @note The maximum length of the text label is going to be
23467     * determined <b>by the widget's theme</b>. Strings larger than
23468     * that value are going to be @b truncated.
23469     *
23470     * @ingroup Flipselector
23471     */
23472    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23473
23474    /**
23475     * Get the internal list of items in a given flip selector widget.
23476     *
23477     * @param obj The flipselector object
23478     * @return The list of items (#Elm_Flipselector_Item as data) or
23479     * @c NULL on errors.
23480     *
23481     * This list is @b not to be modified in any way and must not be
23482     * freed. Use the list members with functions like
23483     * elm_flipselector_item_label_set(),
23484     * elm_flipselector_item_label_get(),
23485     * elm_flipselector_item_del(),
23486     * elm_flipselector_item_selected_get(),
23487     * elm_flipselector_item_selected_set().
23488     *
23489     * @warning This list is only valid until @p obj object's internal
23490     * items list is changed. It should be fetched again with another
23491     * call to this function when changes happen.
23492     *
23493     * @ingroup Flipselector
23494     */
23495    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23496
23497    /**
23498     * Get the first item in the given flip selector widget's list of
23499     * items.
23500     *
23501     * @param obj The flipselector object
23502     * @return The first item or @c NULL, if it has no items (and on
23503     * errors)
23504     *
23505     * @see elm_flipselector_item_append()
23506     * @see elm_flipselector_last_item_get()
23507     *
23508     * @ingroup Flipselector
23509     */
23510    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23511
23512    /**
23513     * Get the last item in the given flip selector widget's list of
23514     * items.
23515     *
23516     * @param obj The flipselector object
23517     * @return The last item or @c NULL, if it has no items (and on
23518     * errors)
23519     *
23520     * @see elm_flipselector_item_prepend()
23521     * @see elm_flipselector_first_item_get()
23522     *
23523     * @ingroup Flipselector
23524     */
23525    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23526
23527    /**
23528     * Get the currently selected item in a flip selector widget.
23529     *
23530     * @param obj The flipselector object
23531     * @return The selected item or @c NULL, if the widget has no items
23532     * (and on erros)
23533     *
23534     * @ingroup Flipselector
23535     */
23536    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23537
23538    /**
23539     * Set whether a given flip selector widget's item should be the
23540     * currently selected one.
23541     *
23542     * @param item The flip selector item
23543     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23544     *
23545     * This sets whether @p item is or not the selected (thus, under
23546     * display) one. If @p item is different than one under display,
23547     * the latter will be unselected. If the @p item is set to be
23548     * unselected, on the other hand, the @b first item in the widget's
23549     * internal members list will be the new selected one.
23550     *
23551     * @see elm_flipselector_item_selected_get()
23552     *
23553     * @ingroup Flipselector
23554     */
23555    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23556
23557    /**
23558     * Get whether a given flip selector widget's item is the currently
23559     * selected one.
23560     *
23561     * @param item The flip selector item
23562     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23563     * (or on errors).
23564     *
23565     * @see elm_flipselector_item_selected_set()
23566     *
23567     * @ingroup Flipselector
23568     */
23569    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23570
23571    /**
23572     * Delete a given item from a flip selector widget.
23573     *
23574     * @param item The item to delete
23575     *
23576     * @ingroup Flipselector
23577     */
23578    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23579
23580    /**
23581     * Get the label of a given flip selector widget's item.
23582     *
23583     * @param item The item to get label from
23584     * @return The text label of @p item or @c NULL, on errors
23585     *
23586     * @see elm_flipselector_item_label_set()
23587     *
23588     * @ingroup Flipselector
23589     */
23590    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23591
23592    /**
23593     * Set the label of a given flip selector widget's item.
23594     *
23595     * @param item The item to set label on
23596     * @param label The text label string, in UTF-8 encoding
23597     *
23598     * @see elm_flipselector_item_label_get()
23599     *
23600     * @ingroup Flipselector
23601     */
23602    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23603
23604    /**
23605     * Gets the item before @p item in a flip selector widget's
23606     * internal list of items.
23607     *
23608     * @param item The item to fetch previous from
23609     * @return The item before the @p item, in its parent's list. If
23610     *         there is no previous item for @p item or there's an
23611     *         error, @c NULL is returned.
23612     *
23613     * @see elm_flipselector_item_next_get()
23614     *
23615     * @ingroup Flipselector
23616     */
23617    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23618
23619    /**
23620     * Gets the item after @p item in a flip selector widget's
23621     * internal list of items.
23622     *
23623     * @param item The item to fetch next from
23624     * @return The item after the @p item, in its parent's list. If
23625     *         there is no next item for @p item or there's an
23626     *         error, @c NULL is returned.
23627     *
23628     * @see elm_flipselector_item_next_get()
23629     *
23630     * @ingroup Flipselector
23631     */
23632    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23633
23634    /**
23635     * Set the interval on time updates for an user mouse button hold
23636     * on a flip selector widget.
23637     *
23638     * @param obj The flip selector object
23639     * @param interval The (first) interval value in seconds
23640     *
23641     * This interval value is @b decreased while the user holds the
23642     * mouse pointer either flipping up or flipping doww a given flip
23643     * selector.
23644     *
23645     * This helps the user to get to a given item distant from the
23646     * current one easier/faster, as it will start to flip quicker and
23647     * quicker on mouse button holds.
23648     *
23649     * The calculation for the next flip interval value, starting from
23650     * the one set with this call, is the previous interval divided by
23651     * 1.05, so it decreases a little bit.
23652     *
23653     * The default starting interval value for automatic flips is
23654     * @b 0.85 seconds.
23655     *
23656     * @see elm_flipselector_interval_get()
23657     *
23658     * @ingroup Flipselector
23659     */
23660    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23661
23662    /**
23663     * Get the interval on time updates for an user mouse button hold
23664     * on a flip selector widget.
23665     *
23666     * @param obj The flip selector object
23667     * @return The (first) interval value, in seconds, set on it
23668     *
23669     * @see elm_flipselector_interval_set() for more details
23670     *
23671     * @ingroup Flipselector
23672     */
23673    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23674    /**
23675     * @}
23676     */
23677
23678    /**
23679     * @addtogroup Calendar
23680     * @{
23681     */
23682
23683    /**
23684     * @enum _Elm_Calendar_Mark_Repeat
23685     * @typedef Elm_Calendar_Mark_Repeat
23686     *
23687     * Event periodicity, used to define if a mark should be repeated
23688     * @b beyond event's day. It's set when a mark is added.
23689     *
23690     * So, for a mark added to 13th May with periodicity set to WEEKLY,
23691     * there will be marks every week after this date. Marks will be displayed
23692     * at 13th, 20th, 27th, 3rd June ...
23693     *
23694     * Values don't work as bitmask, only one can be choosen.
23695     *
23696     * @see elm_calendar_mark_add()
23697     *
23698     * @ingroup Calendar
23699     */
23700    typedef enum _Elm_Calendar_Mark_Repeat
23701      {
23702         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23703         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23704         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23705         ELM_CALENDAR_MONTHLY, /**< Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar*/
23706         ELM_CALENDAR_ANNUALLY /**< Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. */
23707      } Elm_Calendar_Mark_Repeat;
23708
23709    typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark; /**< Item handle for a calendar mark. Created with elm_calendar_mark_add() and deleted with elm_calendar_mark_del(). */
23710
23711    /**
23712     * Add a new calendar widget to the given parent Elementary
23713     * (container) object.
23714     *
23715     * @param parent The parent object.
23716     * @return a new calendar widget handle or @c NULL, on errors.
23717     *
23718     * This function inserts a new calendar widget on the canvas.
23719     *
23720     * @ref calendar_example_01
23721     *
23722     * @ingroup Calendar
23723     */
23724    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23725
23726    /**
23727     * Get weekdays names displayed by the calendar.
23728     *
23729     * @param obj The calendar object.
23730     * @return Array of seven strings to be used as weekday names.
23731     *
23732     * By default, weekdays abbreviations get from system are displayed:
23733     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23734     * The first string is related to Sunday, the second to Monday...
23735     *
23736     * @see elm_calendar_weekdays_name_set()
23737     *
23738     * @ref calendar_example_05
23739     *
23740     * @ingroup Calendar
23741     */
23742    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23743
23744    /**
23745     * Set weekdays names to be displayed by the calendar.
23746     *
23747     * @param obj The calendar object.
23748     * @param weekdays Array of seven strings to be used as weekday names.
23749     * @warning It must have 7 elements, or it will access invalid memory.
23750     * @warning The strings must be NULL terminated ('@\0').
23751     *
23752     * By default, weekdays abbreviations get from system are displayed:
23753     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23754     *
23755     * The first string should be related to Sunday, the second to Monday...
23756     *
23757     * The usage should be like this:
23758     * @code
23759     *   const char *weekdays[] =
23760     *   {
23761     *      "Sunday", "Monday", "Tuesday", "Wednesday",
23762     *      "Thursday", "Friday", "Saturday"
23763     *   };
23764     *   elm_calendar_weekdays_names_set(calendar, weekdays);
23765     * @endcode
23766     *
23767     * @see elm_calendar_weekdays_name_get()
23768     *
23769     * @ref calendar_example_02
23770     *
23771     * @ingroup Calendar
23772     */
23773    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23774
23775    /**
23776     * Set the minimum and maximum values for the year
23777     *
23778     * @param obj The calendar object
23779     * @param min The minimum year, greater than 1901;
23780     * @param max The maximum year;
23781     *
23782     * Maximum must be greater than minimum, except if you don't wan't to set
23783     * maximum year.
23784     * Default values are 1902 and -1.
23785     *
23786     * If the maximum year is a negative value, it will be limited depending
23787     * on the platform architecture (year 2037 for 32 bits);
23788     *
23789     * @see elm_calendar_min_max_year_get()
23790     *
23791     * @ref calendar_example_03
23792     *
23793     * @ingroup Calendar
23794     */
23795    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23796
23797    /**
23798     * Get the minimum and maximum values for the year
23799     *
23800     * @param obj The calendar object.
23801     * @param min The minimum year.
23802     * @param max The maximum year.
23803     *
23804     * Default values are 1902 and -1.
23805     *
23806     * @see elm_calendar_min_max_year_get() for more details.
23807     *
23808     * @ref calendar_example_05
23809     *
23810     * @ingroup Calendar
23811     */
23812    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23813
23814    /**
23815     * Enable or disable day selection
23816     *
23817     * @param obj The calendar object.
23818     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23819     * disable it.
23820     *
23821     * Enabled by default. If disabled, the user still can select months,
23822     * but not days. Selected days are highlighted on calendar.
23823     * It should be used if you won't need such selection for the widget usage.
23824     *
23825     * When a day is selected, or month is changed, smart callbacks for
23826     * signal "changed" will be called.
23827     *
23828     * @see elm_calendar_day_selection_enable_get()
23829     *
23830     * @ref calendar_example_04
23831     *
23832     * @ingroup Calendar
23833     */
23834    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23835
23836    /**
23837     * Get a value whether day selection is enabled or not.
23838     *
23839     * @see elm_calendar_day_selection_enable_set() for details.
23840     *
23841     * @param obj The calendar object.
23842     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23843     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23844     *
23845     * @ref calendar_example_05
23846     *
23847     * @ingroup Calendar
23848     */
23849    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23850
23851
23852    /**
23853     * Set selected date to be highlighted on calendar.
23854     *
23855     * @param obj The calendar object.
23856     * @param selected_time A @b tm struct to represent the selected date.
23857     *
23858     * Set the selected date, changing the displayed month if needed.
23859     * Selected date changes when the user goes to next/previous month or
23860     * select a day pressing over it on calendar.
23861     *
23862     * @see elm_calendar_selected_time_get()
23863     *
23864     * @ref calendar_example_04
23865     *
23866     * @ingroup Calendar
23867     */
23868    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23869
23870    /**
23871     * Get selected date.
23872     *
23873     * @param obj The calendar object
23874     * @param selected_time A @b tm struct to point to selected date
23875     * @return EINA_FALSE means an error ocurred and returned time shouldn't
23876     * be considered.
23877     *
23878     * Get date selected by the user or set by function
23879     * elm_calendar_selected_time_set().
23880     * Selected date changes when the user goes to next/previous month or
23881     * select a day pressing over it on calendar.
23882     *
23883     * @see elm_calendar_selected_time_get()
23884     *
23885     * @ref calendar_example_05
23886     *
23887     * @ingroup Calendar
23888     */
23889    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23890
23891    /**
23892     * Set a function to format the string that will be used to display
23893     * month and year;
23894     *
23895     * @param obj The calendar object
23896     * @param format_function Function to set the month-year string given
23897     * the selected date
23898     *
23899     * By default it uses strftime with "%B %Y" format string.
23900     * It should allocate the memory that will be used by the string,
23901     * that will be freed by the widget after usage.
23902     * A pointer to the string and a pointer to the time struct will be provided.
23903     *
23904     * Example:
23905     * @code
23906     * static char *
23907     * _format_month_year(struct tm *selected_time)
23908     * {
23909     *    char buf[32];
23910     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23911     *    return strdup(buf);
23912     * }
23913     *
23914     * elm_calendar_format_function_set(calendar, _format_month_year);
23915     * @endcode
23916     *
23917     * @ref calendar_example_02
23918     *
23919     * @ingroup Calendar
23920     */
23921    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23922
23923    /**
23924     * Add a new mark to the calendar
23925     *
23926     * @param obj The calendar object
23927     * @param mark_type A string used to define the type of mark. It will be
23928     * emitted to the theme, that should display a related modification on these
23929     * days representation.
23930     * @param mark_time A time struct to represent the date of inclusion of the
23931     * mark. For marks that repeats it will just be displayed after the inclusion
23932     * date in the calendar.
23933     * @param repeat Repeat the event following this periodicity. Can be a unique
23934     * mark (that don't repeat), daily, weekly, monthly or annually.
23935     * @return The created mark or @p NULL upon failure.
23936     *
23937     * Add a mark that will be drawn in the calendar respecting the insertion
23938     * time and periodicity. It will emit the type as signal to the widget theme.
23939     * Default theme supports "holiday" and "checked", but it can be extended.
23940     *
23941     * It won't immediately update the calendar, drawing the marks.
23942     * For this, call elm_calendar_marks_draw(). However, when user selects
23943     * next or previous month calendar forces marks drawn.
23944     *
23945     * Marks created with this method can be deleted with
23946     * elm_calendar_mark_del().
23947     *
23948     * Example
23949     * @code
23950     * struct tm selected_time;
23951     * time_t current_time;
23952     *
23953     * current_time = time(NULL) + 5 * 84600;
23954     * localtime_r(&current_time, &selected_time);
23955     * elm_calendar_mark_add(cal, "holiday", selected_time,
23956     *     ELM_CALENDAR_ANNUALLY);
23957     *
23958     * current_time = time(NULL) + 1 * 84600;
23959     * localtime_r(&current_time, &selected_time);
23960     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23961     *
23962     * elm_calendar_marks_draw(cal);
23963     * @endcode
23964     *
23965     * @see elm_calendar_marks_draw()
23966     * @see elm_calendar_mark_del()
23967     *
23968     * @ref calendar_example_06
23969     *
23970     * @ingroup Calendar
23971     */
23972    EAPI Elm_Calendar_Mark *elm_calendar_mark_add(Evas_Object *obj, const char *mark_type, struct tm *mark_time, Elm_Calendar_Mark_Repeat repeat) EINA_ARG_NONNULL(1);
23973
23974    /**
23975     * Delete mark from the calendar.
23976     *
23977     * @param mark The mark to be deleted.
23978     *
23979     * If deleting all calendar marks is required, elm_calendar_marks_clear()
23980     * should be used instead of getting marks list and deleting each one.
23981     *
23982     * @see elm_calendar_mark_add()
23983     *
23984     * @ref calendar_example_06
23985     *
23986     * @ingroup Calendar
23987     */
23988    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23989
23990    /**
23991     * Remove all calendar's marks
23992     *
23993     * @param obj The calendar object.
23994     *
23995     * @see elm_calendar_mark_add()
23996     * @see elm_calendar_mark_del()
23997     *
23998     * @ingroup Calendar
23999     */
24000    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24001
24002
24003    /**
24004     * Get a list of all the calendar marks.
24005     *
24006     * @param obj The calendar object.
24007     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
24008     *
24009     * @see elm_calendar_mark_add()
24010     * @see elm_calendar_mark_del()
24011     * @see elm_calendar_marks_clear()
24012     *
24013     * @ingroup Calendar
24014     */
24015    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24016
24017    /**
24018     * Draw calendar marks.
24019     *
24020     * @param obj The calendar object.
24021     *
24022     * Should be used after adding, removing or clearing marks.
24023     * It will go through the entire marks list updating the calendar.
24024     * If lots of marks will be added, add all the marks and then call
24025     * this function.
24026     *
24027     * When the month is changed, i.e. user selects next or previous month,
24028     * marks will be drawed.
24029     *
24030     * @see elm_calendar_mark_add()
24031     * @see elm_calendar_mark_del()
24032     * @see elm_calendar_marks_clear()
24033     *
24034     * @ref calendar_example_06
24035     *
24036     * @ingroup Calendar
24037     */
24038    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
24039
24040    /**
24041     * Set a day text color to the same that represents Saturdays.
24042     *
24043     * @param obj The calendar object.
24044     * @param pos The text position. Position is the cell counter, from left
24045     * to right, up to down. It starts on 0 and ends on 41.
24046     *
24047     * @deprecated use elm_calendar_mark_add() instead like:
24048     *
24049     * @code
24050     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
24051     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24052     * @endcode
24053     *
24054     * @see elm_calendar_mark_add()
24055     *
24056     * @ingroup Calendar
24057     */
24058    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24059
24060    /**
24061     * Set a day text color to the same that represents Sundays.
24062     *
24063     * @param obj The calendar object.
24064     * @param pos The text position. Position is the cell counter, from left
24065     * to right, up to down. It starts on 0 and ends on 41.
24066
24067     * @deprecated use elm_calendar_mark_add() instead like:
24068     *
24069     * @code
24070     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
24071     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
24072     * @endcode
24073     *
24074     * @see elm_calendar_mark_add()
24075     *
24076     * @ingroup Calendar
24077     */
24078    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24079
24080    /**
24081     * Set a day text color to the same that represents Weekdays.
24082     *
24083     * @param obj The calendar object
24084     * @param pos The text position. Position is the cell counter, from left
24085     * to right, up to down. It starts on 0 and ends on 41.
24086     *
24087     * @deprecated use elm_calendar_mark_add() instead like:
24088     *
24089     * @code
24090     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
24091     *
24092     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
24093     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24094     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
24095     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24096     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
24097     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24098     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
24099     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
24100     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
24101     * @endcode
24102     *
24103     * @see elm_calendar_mark_add()
24104     *
24105     * @ingroup Calendar
24106     */
24107    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24108
24109    /**
24110     * Set the interval on time updates for an user mouse button hold
24111     * on calendar widgets' month selection.
24112     *
24113     * @param obj The calendar object
24114     * @param interval The (first) interval value in seconds
24115     *
24116     * This interval value is @b decreased while the user holds the
24117     * mouse pointer either selecting next or previous month.
24118     *
24119     * This helps the user to get to a given month distant from the
24120     * current one easier/faster, as it will start to change quicker and
24121     * quicker on mouse button holds.
24122     *
24123     * The calculation for the next change interval value, starting from
24124     * the one set with this call, is the previous interval divided by
24125     * 1.05, so it decreases a little bit.
24126     *
24127     * The default starting interval value for automatic changes is
24128     * @b 0.85 seconds.
24129     *
24130     * @see elm_calendar_interval_get()
24131     *
24132     * @ingroup Calendar
24133     */
24134    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24135
24136    /**
24137     * Get the interval on time updates for an user mouse button hold
24138     * on calendar widgets' month selection.
24139     *
24140     * @param obj The calendar object
24141     * @return The (first) interval value, in seconds, set on it
24142     *
24143     * @see elm_calendar_interval_set() for more details
24144     *
24145     * @ingroup Calendar
24146     */
24147    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24148
24149    /**
24150     * @}
24151     */
24152
24153    /**
24154     * @defgroup Diskselector Diskselector
24155     * @ingroup Elementary
24156     *
24157     * @image html img/widget/diskselector/preview-00.png
24158     * @image latex img/widget/diskselector/preview-00.eps
24159     *
24160     * A diskselector is a kind of list widget. It scrolls horizontally,
24161     * and can contain label and icon objects. Three items are displayed
24162     * with the selected one in the middle.
24163     *
24164     * It can act like a circular list with round mode and labels can be
24165     * reduced for a defined length for side items.
24166     *
24167     * Smart callbacks one can listen to:
24168     * - "selected" - when item is selected, i.e. scroller stops.
24169     *
24170     * Available styles for it:
24171     * - @c "default"
24172     *
24173     * List of examples:
24174     * @li @ref diskselector_example_01
24175     * @li @ref diskselector_example_02
24176     */
24177
24178    /**
24179     * @addtogroup Diskselector
24180     * @{
24181     */
24182
24183    typedef struct _Elm_Diskselector_Item Elm_Diskselector_Item; /**< Item handle for a diskselector item. Created with elm_diskselector_item_append() and deleted with elm_diskselector_item_del(). */
24184
24185    /**
24186     * Add a new diskselector widget to the given parent Elementary
24187     * (container) object.
24188     *
24189     * @param parent The parent object.
24190     * @return a new diskselector widget handle or @c NULL, on errors.
24191     *
24192     * This function inserts a new diskselector widget on the canvas.
24193     *
24194     * @ingroup Diskselector
24195     */
24196    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24197
24198    /**
24199     * Enable or disable round mode.
24200     *
24201     * @param obj The diskselector object.
24202     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
24203     * disable it.
24204     *
24205     * Disabled by default. If round mode is enabled the items list will
24206     * work like a circle list, so when the user reaches the last item,
24207     * the first one will popup.
24208     *
24209     * @see elm_diskselector_round_get()
24210     *
24211     * @ingroup Diskselector
24212     */
24213    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
24214
24215    /**
24216     * Get a value whether round mode is enabled or not.
24217     *
24218     * @see elm_diskselector_round_set() for details.
24219     *
24220     * @param obj The diskselector object.
24221     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
24222     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24223     *
24224     * @ingroup Diskselector
24225     */
24226    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24227
24228    /**
24229     * Get the side labels max length.
24230     *
24231     * @deprecated use elm_diskselector_side_label_length_get() instead:
24232     *
24233     * @param obj The diskselector object.
24234     * @return The max length defined for side labels, or 0 if not a valid
24235     * diskselector.
24236     *
24237     * @ingroup Diskselector
24238     */
24239    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24240
24241    /**
24242     * Set the side labels max length.
24243     *
24244     * @deprecated use elm_diskselector_side_label_length_set() instead:
24245     *
24246     * @param obj The diskselector object.
24247     * @param len The max length defined for side labels.
24248     *
24249     * @ingroup Diskselector
24250     */
24251    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24252
24253    /**
24254     * Get the side labels max length.
24255     *
24256     * @see elm_diskselector_side_label_length_set() for details.
24257     *
24258     * @param obj The diskselector object.
24259     * @return The max length defined for side labels, or 0 if not a valid
24260     * diskselector.
24261     *
24262     * @ingroup Diskselector
24263     */
24264    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24265
24266    /**
24267     * Set the side labels max length.
24268     *
24269     * @param obj The diskselector object.
24270     * @param len The max length defined for side labels.
24271     *
24272     * Length is the number of characters of items' label that will be
24273     * visible when it's set on side positions. It will just crop
24274     * the string after defined size. E.g.:
24275     *
24276     * An item with label "January" would be displayed on side position as
24277     * "Jan" if max length is set to 3, or "Janu", if this property
24278     * is set to 4.
24279     *
24280     * When it's selected, the entire label will be displayed, except for
24281     * width restrictions. In this case label will be cropped and "..."
24282     * will be concatenated.
24283     *
24284     * Default side label max length is 3.
24285     *
24286     * This property will be applyed over all items, included before or
24287     * later this function call.
24288     *
24289     * @ingroup Diskselector
24290     */
24291    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24292
24293    /**
24294     * Set the number of items to be displayed.
24295     *
24296     * @param obj The diskselector object.
24297     * @param num The number of items the diskselector will display.
24298     *
24299     * Default value is 3, and also it's the minimun. If @p num is less
24300     * than 3, it will be set to 3.
24301     *
24302     * Also, it can be set on theme, using data item @c display_item_num
24303     * on group "elm/diskselector/item/X", where X is style set.
24304     * E.g.:
24305     *
24306     * group { name: "elm/diskselector/item/X";
24307     * data {
24308     *     item: "display_item_num" "5";
24309     *     }
24310     *
24311     * @ingroup Diskselector
24312     */
24313    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24314
24315    /**
24316     * Get the number of items in the diskselector object.
24317     *
24318     * @param obj The diskselector object.
24319     *
24320     * @ingroup Diskselector
24321     */
24322    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24323
24324    /**
24325     * Set bouncing behaviour when the scrolled content reaches an edge.
24326     *
24327     * Tell the internal scroller object whether it should bounce or not
24328     * when it reaches the respective edges for each axis.
24329     *
24330     * @param obj The diskselector object.
24331     * @param h_bounce Whether to bounce or not in the horizontal axis.
24332     * @param v_bounce Whether to bounce or not in the vertical axis.
24333     *
24334     * @see elm_scroller_bounce_set()
24335     *
24336     * @ingroup Diskselector
24337     */
24338    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24339
24340    /**
24341     * Get the bouncing behaviour of the internal scroller.
24342     *
24343     * Get whether the internal scroller should bounce when the edge of each
24344     * axis is reached scrolling.
24345     *
24346     * @param obj The diskselector object.
24347     * @param h_bounce Pointer where to store the bounce state of the horizontal
24348     * axis.
24349     * @param v_bounce Pointer where to store the bounce state of the vertical
24350     * axis.
24351     *
24352     * @see elm_scroller_bounce_get()
24353     * @see elm_diskselector_bounce_set()
24354     *
24355     * @ingroup Diskselector
24356     */
24357    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24358
24359    /**
24360     * Get the scrollbar policy.
24361     *
24362     * @see elm_diskselector_scroller_policy_get() for details.
24363     *
24364     * @param obj The diskselector object.
24365     * @param policy_h Pointer where to store horizontal scrollbar policy.
24366     * @param policy_v Pointer where to store vertical scrollbar policy.
24367     *
24368     * @ingroup Diskselector
24369     */
24370    EAPI void                   elm_diskselector_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
24371
24372    /**
24373     * Set the scrollbar policy.
24374     *
24375     * @param obj The diskselector object.
24376     * @param policy_h Horizontal scrollbar policy.
24377     * @param policy_v Vertical scrollbar policy.
24378     *
24379     * This sets the scrollbar visibility policy for the given scroller.
24380     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
24381     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24382     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24383     * This applies respectively for the horizontal and vertical scrollbars.
24384     *
24385     * The both are disabled by default, i.e., are set to
24386     * #ELM_SCROLLER_POLICY_OFF.
24387     *
24388     * @ingroup Diskselector
24389     */
24390    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24391
24392    /**
24393     * Remove all diskselector's items.
24394     *
24395     * @param obj The diskselector object.
24396     *
24397     * @see elm_diskselector_item_del()
24398     * @see elm_diskselector_item_append()
24399     *
24400     * @ingroup Diskselector
24401     */
24402    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24403
24404    /**
24405     * Get a list of all the diskselector items.
24406     *
24407     * @param obj The diskselector object.
24408     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24409     * or @c NULL on failure.
24410     *
24411     * @see elm_diskselector_item_append()
24412     * @see elm_diskselector_item_del()
24413     * @see elm_diskselector_clear()
24414     *
24415     * @ingroup Diskselector
24416     */
24417    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24418
24419    /**
24420     * Appends a new item to the diskselector object.
24421     *
24422     * @param obj The diskselector object.
24423     * @param label The label of the diskselector item.
24424     * @param icon The icon object to use at left side of the item. An
24425     * icon can be any Evas object, but usually it is an icon created
24426     * with elm_icon_add().
24427     * @param func The function to call when the item is selected.
24428     * @param data The data to associate with the item for related callbacks.
24429     *
24430     * @return The created item or @c NULL upon failure.
24431     *
24432     * A new item will be created and appended to the diskselector, i.e., will
24433     * be set as last item. Also, if there is no selected item, it will
24434     * be selected. This will always happens for the first appended item.
24435     *
24436     * If no icon is set, label will be centered on item position, otherwise
24437     * the icon will be placed at left of the label, that will be shifted
24438     * to the right.
24439     *
24440     * Items created with this method can be deleted with
24441     * elm_diskselector_item_del().
24442     *
24443     * Associated @p data can be properly freed when item is deleted if a
24444     * callback function is set with elm_diskselector_item_del_cb_set().
24445     *
24446     * If a function is passed as argument, it will be called everytime this item
24447     * is selected, i.e., the user stops the diskselector with this
24448     * item on center position. If such function isn't needed, just passing
24449     * @c NULL as @p func is enough. The same should be done for @p data.
24450     *
24451     * Simple example (with no function callback or data associated):
24452     * @code
24453     * disk = elm_diskselector_add(win);
24454     * ic = elm_icon_add(win);
24455     * elm_icon_file_set(ic, "path/to/image", NULL);
24456     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24457     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24458     * @endcode
24459     *
24460     * @see elm_diskselector_item_del()
24461     * @see elm_diskselector_item_del_cb_set()
24462     * @see elm_diskselector_clear()
24463     * @see elm_icon_add()
24464     *
24465     * @ingroup Diskselector
24466     */
24467    EAPI Elm_Diskselector_Item *elm_diskselector_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
24468
24469
24470    /**
24471     * Delete them item from the diskselector.
24472     *
24473     * @param it The item of diskselector to be deleted.
24474     *
24475     * If deleting all diskselector items is required, elm_diskselector_clear()
24476     * should be used instead of getting items list and deleting each one.
24477     *
24478     * @see elm_diskselector_clear()
24479     * @see elm_diskselector_item_append()
24480     * @see elm_diskselector_item_del_cb_set()
24481     *
24482     * @ingroup Diskselector
24483     */
24484    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24485
24486    /**
24487     * Set the function called when a diskselector item is freed.
24488     *
24489     * @param it The item to set the callback on
24490     * @param func The function called
24491     *
24492     * If there is a @p func, then it will be called prior item's memory release.
24493     * That will be called with the following arguments:
24494     * @li item's data;
24495     * @li item's Evas object;
24496     * @li item itself;
24497     *
24498     * This way, a data associated to a diskselector item could be properly
24499     * freed.
24500     *
24501     * @ingroup Diskselector
24502     */
24503    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24504
24505    /**
24506     * Get the data associated to the item.
24507     *
24508     * @param it The diskselector item
24509     * @return The data associated to @p it
24510     *
24511     * The return value is a pointer to data associated to @p item when it was
24512     * created, with function elm_diskselector_item_append(). If no data
24513     * was passed as argument, it will return @c NULL.
24514     *
24515     * @see elm_diskselector_item_append()
24516     *
24517     * @ingroup Diskselector
24518     */
24519    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24520
24521    /**
24522     * Set the icon associated to the item.
24523     *
24524     * @param it The diskselector item
24525     * @param icon The icon object to associate with @p it
24526     *
24527     * The icon object to use at left side of the item. An
24528     * icon can be any Evas object, but usually it is an icon created
24529     * with elm_icon_add().
24530     *
24531     * Once the icon object is set, a previously set one will be deleted.
24532     * @warning Setting the same icon for two items will cause the icon to
24533     * dissapear from the first item.
24534     *
24535     * If an icon was passed as argument on item creation, with function
24536     * elm_diskselector_item_append(), it will be already
24537     * associated to the item.
24538     *
24539     * @see elm_diskselector_item_append()
24540     * @see elm_diskselector_item_icon_get()
24541     *
24542     * @ingroup Diskselector
24543     */
24544    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24545
24546    /**
24547     * Get the icon associated to the item.
24548     *
24549     * @param it The diskselector item
24550     * @return The icon associated to @p it
24551     *
24552     * The return value is a pointer to the icon associated to @p item when it was
24553     * created, with function elm_diskselector_item_append(), or later
24554     * with function elm_diskselector_item_icon_set. If no icon
24555     * was passed as argument, it will return @c NULL.
24556     *
24557     * @see elm_diskselector_item_append()
24558     * @see elm_diskselector_item_icon_set()
24559     *
24560     * @ingroup Diskselector
24561     */
24562    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24563
24564    /**
24565     * Set the label of item.
24566     *
24567     * @param it The item of diskselector.
24568     * @param label The label of item.
24569     *
24570     * The label to be displayed by the item.
24571     *
24572     * If no icon is set, label will be centered on item position, otherwise
24573     * the icon will be placed at left of the label, that will be shifted
24574     * to the right.
24575     *
24576     * An item with label "January" would be displayed on side position as
24577     * "Jan" if max length is set to 3 with function
24578     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24579     * is set to 4.
24580     *
24581     * When this @p item is selected, the entire label will be displayed,
24582     * except for width restrictions.
24583     * In this case label will be cropped and "..." will be concatenated,
24584     * but only for display purposes. It will keep the entire string, so
24585     * if diskselector is resized the remaining characters will be displayed.
24586     *
24587     * If a label was passed as argument on item creation, with function
24588     * elm_diskselector_item_append(), it will be already
24589     * displayed by the item.
24590     *
24591     * @see elm_diskselector_side_label_lenght_set()
24592     * @see elm_diskselector_item_label_get()
24593     * @see elm_diskselector_item_append()
24594     *
24595     * @ingroup Diskselector
24596     */
24597    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24598
24599    /**
24600     * Get the label of item.
24601     *
24602     * @param it The item of diskselector.
24603     * @return The label of item.
24604     *
24605     * The return value is a pointer to the label associated to @p item when it was
24606     * created, with function elm_diskselector_item_append(), or later
24607     * with function elm_diskselector_item_label_set. If no label
24608     * was passed as argument, it will return @c NULL.
24609     *
24610     * @see elm_diskselector_item_label_set() for more details.
24611     * @see elm_diskselector_item_append()
24612     *
24613     * @ingroup Diskselector
24614     */
24615    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24616
24617    /**
24618     * Get the selected item.
24619     *
24620     * @param obj The diskselector object.
24621     * @return The selected diskselector item.
24622     *
24623     * The selected item can be unselected with function
24624     * elm_diskselector_item_selected_set(), and the first item of
24625     * diskselector will be selected.
24626     *
24627     * The selected item always will be centered on diskselector, with
24628     * full label displayed, i.e., max lenght set to side labels won't
24629     * apply on the selected item. More details on
24630     * elm_diskselector_side_label_length_set().
24631     *
24632     * @ingroup Diskselector
24633     */
24634    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24635
24636    /**
24637     * Set the selected state of an item.
24638     *
24639     * @param it The diskselector item
24640     * @param selected The selected state
24641     *
24642     * This sets the selected state of the given item @p it.
24643     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24644     *
24645     * If a new item is selected the previosly selected will be unselected.
24646     * Previoulsy selected item can be get with function
24647     * elm_diskselector_selected_item_get().
24648     *
24649     * If the item @p it is unselected, the first item of diskselector will
24650     * be selected.
24651     *
24652     * Selected items will be visible on center position of diskselector.
24653     * So if it was on another position before selected, or was invisible,
24654     * diskselector will animate items until the selected item reaches center
24655     * position.
24656     *
24657     * @see elm_diskselector_item_selected_get()
24658     * @see elm_diskselector_selected_item_get()
24659     *
24660     * @ingroup Diskselector
24661     */
24662    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24663
24664    /*
24665     * Get whether the @p item is selected or not.
24666     *
24667     * @param it The diskselector item.
24668     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24669     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24670     *
24671     * @see elm_diskselector_selected_item_set() for details.
24672     * @see elm_diskselector_item_selected_get()
24673     *
24674     * @ingroup Diskselector
24675     */
24676    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24677
24678    /**
24679     * Get the first item of the diskselector.
24680     *
24681     * @param obj The diskselector object.
24682     * @return The first item, or @c NULL if none.
24683     *
24684     * The list of items follows append order. So it will return the first
24685     * item appended to the widget that wasn't deleted.
24686     *
24687     * @see elm_diskselector_item_append()
24688     * @see elm_diskselector_items_get()
24689     *
24690     * @ingroup Diskselector
24691     */
24692    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24693
24694    /**
24695     * Get the last item of the diskselector.
24696     *
24697     * @param obj The diskselector object.
24698     * @return The last item, or @c NULL if none.
24699     *
24700     * The list of items follows append order. So it will return last first
24701     * item appended to the widget that wasn't deleted.
24702     *
24703     * @see elm_diskselector_item_append()
24704     * @see elm_diskselector_items_get()
24705     *
24706     * @ingroup Diskselector
24707     */
24708    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24709
24710    /**
24711     * Get the item before @p item in diskselector.
24712     *
24713     * @param it The diskselector item.
24714     * @return The item before @p item, or @c NULL if none or on failure.
24715     *
24716     * The list of items follows append order. So it will return item appended
24717     * just before @p item and that wasn't deleted.
24718     *
24719     * If it is the first item, @c NULL will be returned.
24720     * First item can be get by elm_diskselector_first_item_get().
24721     *
24722     * @see elm_diskselector_item_append()
24723     * @see elm_diskselector_items_get()
24724     *
24725     * @ingroup Diskselector
24726     */
24727    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24728
24729    /**
24730     * Get the item after @p item in diskselector.
24731     *
24732     * @param it The diskselector item.
24733     * @return The item after @p item, or @c NULL if none or on failure.
24734     *
24735     * The list of items follows append order. So it will return item appended
24736     * just after @p item and that wasn't deleted.
24737     *
24738     * If it is the last item, @c NULL will be returned.
24739     * Last item can be get by elm_diskselector_last_item_get().
24740     *
24741     * @see elm_diskselector_item_append()
24742     * @see elm_diskselector_items_get()
24743     *
24744     * @ingroup Diskselector
24745     */
24746    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24747
24748    /**
24749     * Set the text to be shown in the diskselector item.
24750     *
24751     * @param item Target item
24752     * @param text The text to set in the content
24753     *
24754     * Setup the text as tooltip to object. The item can have only one tooltip,
24755     * so any previous tooltip data is removed.
24756     *
24757     * @see elm_object_tooltip_text_set() for more details.
24758     *
24759     * @ingroup Diskselector
24760     */
24761    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24762
24763    /**
24764     * Set the content to be shown in the tooltip item.
24765     *
24766     * Setup the tooltip to item. The item can have only one tooltip,
24767     * so any previous tooltip data is removed. @p func(with @p data) will
24768     * be called every time that need show the tooltip and it should
24769     * return a valid Evas_Object. This object is then managed fully by
24770     * tooltip system and is deleted when the tooltip is gone.
24771     *
24772     * @param item the diskselector item being attached a tooltip.
24773     * @param func the function used to create the tooltip contents.
24774     * @param data what to provide to @a func as callback data/context.
24775     * @param del_cb called when data is not needed anymore, either when
24776     *        another callback replaces @p func, the tooltip is unset with
24777     *        elm_diskselector_item_tooltip_unset() or the owner @a item
24778     *        dies. This callback receives as the first parameter the
24779     *        given @a data, and @c event_info is the item.
24780     *
24781     * @see elm_object_tooltip_content_cb_set() for more details.
24782     *
24783     * @ingroup Diskselector
24784     */
24785    EAPI void                   elm_diskselector_item_tooltip_content_cb_set(Elm_Diskselector_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb) EINA_ARG_NONNULL(1);
24786
24787    /**
24788     * Unset tooltip from item.
24789     *
24790     * @param item diskselector item to remove previously set tooltip.
24791     *
24792     * Remove tooltip from item. The callback provided as del_cb to
24793     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24794     * it is not used anymore.
24795     *
24796     * @see elm_object_tooltip_unset() for more details.
24797     * @see elm_diskselector_item_tooltip_content_cb_set()
24798     *
24799     * @ingroup Diskselector
24800     */
24801    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24802
24803
24804    /**
24805     * Sets a different style for this item tooltip.
24806     *
24807     * @note before you set a style you should define a tooltip with
24808     *       elm_diskselector_item_tooltip_content_cb_set() or
24809     *       elm_diskselector_item_tooltip_text_set()
24810     *
24811     * @param item diskselector item with tooltip already set.
24812     * @param style the theme style to use (default, transparent, ...)
24813     *
24814     * @see elm_object_tooltip_style_set() for more details.
24815     *
24816     * @ingroup Diskselector
24817     */
24818    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24819
24820    /**
24821     * Get the style for this item tooltip.
24822     *
24823     * @param item diskselector item with tooltip already set.
24824     * @return style the theme style in use, defaults to "default". If the
24825     *         object does not have a tooltip set, then NULL is returned.
24826     *
24827     * @see elm_object_tooltip_style_get() for more details.
24828     * @see elm_diskselector_item_tooltip_style_set()
24829     *
24830     * @ingroup Diskselector
24831     */
24832    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24833
24834    /**
24835     * Set the cursor to be shown when mouse is over the diskselector item
24836     *
24837     * @param item Target item
24838     * @param cursor the cursor name to be used.
24839     *
24840     * @see elm_object_cursor_set() for more details.
24841     *
24842     * @ingroup Diskselector
24843     */
24844    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24845
24846    /**
24847     * Get the cursor to be shown when mouse is over the diskselector item
24848     *
24849     * @param item diskselector item with cursor already set.
24850     * @return the cursor name.
24851     *
24852     * @see elm_object_cursor_get() for more details.
24853     * @see elm_diskselector_cursor_set()
24854     *
24855     * @ingroup Diskselector
24856     */
24857    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24858
24859
24860    /**
24861     * Unset the cursor to be shown when mouse is over the diskselector item
24862     *
24863     * @param item Target item
24864     *
24865     * @see elm_object_cursor_unset() for more details.
24866     * @see elm_diskselector_cursor_set()
24867     *
24868     * @ingroup Diskselector
24869     */
24870    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24871
24872    /**
24873     * Sets a different style for this item cursor.
24874     *
24875     * @note before you set a style you should define a cursor with
24876     *       elm_diskselector_item_cursor_set()
24877     *
24878     * @param item diskselector item with cursor already set.
24879     * @param style the theme style to use (default, transparent, ...)
24880     *
24881     * @see elm_object_cursor_style_set() for more details.
24882     *
24883     * @ingroup Diskselector
24884     */
24885    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24886
24887
24888    /**
24889     * Get the style for this item cursor.
24890     *
24891     * @param item diskselector item with cursor already set.
24892     * @return style the theme style in use, defaults to "default". If the
24893     *         object does not have a cursor set, then @c NULL is returned.
24894     *
24895     * @see elm_object_cursor_style_get() for more details.
24896     * @see elm_diskselector_item_cursor_style_set()
24897     *
24898     * @ingroup Diskselector
24899     */
24900    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24901
24902
24903    /**
24904     * Set if the cursor set should be searched on the theme or should use
24905     * the provided by the engine, only.
24906     *
24907     * @note before you set if should look on theme you should define a cursor
24908     * with elm_diskselector_item_cursor_set().
24909     * By default it will only look for cursors provided by the engine.
24910     *
24911     * @param item widget item with cursor already set.
24912     * @param engine_only boolean to define if cursors set with
24913     * elm_diskselector_item_cursor_set() should be searched only
24914     * between cursors provided by the engine or searched on widget's
24915     * theme as well.
24916     *
24917     * @see elm_object_cursor_engine_only_set() for more details.
24918     *
24919     * @ingroup Diskselector
24920     */
24921    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24922
24923    /**
24924     * Get the cursor engine only usage for this item cursor.
24925     *
24926     * @param item widget item with cursor already set.
24927     * @return engine_only boolean to define it cursors should be looked only
24928     * between the provided by the engine or searched on widget's theme as well.
24929     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24930     *
24931     * @see elm_object_cursor_engine_only_get() for more details.
24932     * @see elm_diskselector_item_cursor_engine_only_set()
24933     *
24934     * @ingroup Diskselector
24935     */
24936    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24937
24938    /**
24939     * @}
24940     */
24941
24942    /**
24943     * @defgroup Colorselector Colorselector
24944     *
24945     * @{
24946     *
24947     * @image html img/widget/colorselector/preview-00.png
24948     * @image latex img/widget/colorselector/preview-00.eps
24949     *
24950     * @brief Widget for user to select a color.
24951     *
24952     * Signals that you can add callbacks for are:
24953     * "changed" - When the color value changes(event_info is NULL).
24954     *
24955     * See @ref tutorial_colorselector.
24956     */
24957    /**
24958     * @brief Add a new colorselector to the parent
24959     *
24960     * @param parent The parent object
24961     * @return The new object or NULL if it cannot be created
24962     *
24963     * @ingroup Colorselector
24964     */
24965    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24966    /**
24967     * Set a color for the colorselector
24968     *
24969     * @param obj   Colorselector object
24970     * @param r     r-value of color
24971     * @param g     g-value of color
24972     * @param b     b-value of color
24973     * @param a     a-value of color
24974     *
24975     * @ingroup Colorselector
24976     */
24977    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24978    /**
24979     * Get a color from the colorselector
24980     *
24981     * @param obj   Colorselector object
24982     * @param r     integer pointer for r-value of color
24983     * @param g     integer pointer for g-value of color
24984     * @param b     integer pointer for b-value of color
24985     * @param a     integer pointer for a-value of color
24986     *
24987     * @ingroup Colorselector
24988     */
24989    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24990    /**
24991     * @}
24992     */
24993
24994    /**
24995     * @defgroup Ctxpopup Ctxpopup
24996     *
24997     * @image html img/widget/ctxpopup/preview-00.png
24998     * @image latex img/widget/ctxpopup/preview-00.eps
24999     *
25000     * @brief Context popup widet.
25001     *
25002     * A ctxpopup is a widget that, when shown, pops up a list of items.
25003     * It automatically chooses an area inside its parent object's view
25004     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
25005     * optimally fit into it. In the default theme, it will also point an
25006     * arrow to it's top left position at the time one shows it. Ctxpopup
25007     * items have a label and/or an icon. It is intended for a small
25008     * number of items (hence the use of list, not genlist).
25009     *
25010     * @note Ctxpopup is a especialization of @ref Hover.
25011     *
25012     * Signals that you can add callbacks for are:
25013     * "dismissed" - the ctxpopup was dismissed
25014     *
25015     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
25016     * @{
25017     */
25018    typedef enum _Elm_Ctxpopup_Direction
25019      {
25020         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
25021                                           area */
25022         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
25023                                            the clicked area */
25024         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
25025                                           the clicked area */
25026         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
25027                                         area */
25028         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
25029      } Elm_Ctxpopup_Direction;
25030
25031    /**
25032     * @brief Add a new Ctxpopup object to the parent.
25033     *
25034     * @param parent Parent object
25035     * @return New object or @c NULL, if it cannot be created
25036     */
25037    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25038    /**
25039     * @brief Set the Ctxpopup's parent
25040     *
25041     * @param obj The ctxpopup object
25042     * @param area The parent to use
25043     *
25044     * Set the parent object.
25045     *
25046     * @note elm_ctxpopup_add() will automatically call this function
25047     * with its @c parent argument.
25048     *
25049     * @see elm_ctxpopup_add()
25050     * @see elm_hover_parent_set()
25051     */
25052    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
25053    /**
25054     * @brief Get the Ctxpopup's parent
25055     *
25056     * @param obj The ctxpopup object
25057     *
25058     * @see elm_ctxpopup_hover_parent_set() for more information
25059     */
25060    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25061    /**
25062     * @brief Clear all items in the given ctxpopup object.
25063     *
25064     * @param obj Ctxpopup object
25065     */
25066    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25067    /**
25068     * @brief Change the ctxpopup's orientation to horizontal or vertical.
25069     *
25070     * @param obj Ctxpopup object
25071     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
25072     */
25073    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
25074    /**
25075     * @brief Get the value of current ctxpopup object's orientation.
25076     *
25077     * @param obj Ctxpopup object
25078     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
25079     *
25080     * @see elm_ctxpopup_horizontal_set()
25081     */
25082    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25083    /**
25084     * @brief Add a new item to a ctxpopup object.
25085     *
25086     * @param obj Ctxpopup object
25087     * @param icon Icon to be set on new item
25088     * @param label The Label of the new item
25089     * @param func Convenience function called when item selected
25090     * @param data Data passed to @p func
25091     * @return A handle to the item added or @c NULL, on errors
25092     *
25093     * @warning Ctxpopup can't hold both an item list and a content at the same
25094     * time. When an item is added, any previous content will be removed.
25095     *
25096     * @see elm_ctxpopup_content_set()
25097     */
25098    Elm_Object_Item *elm_ctxpopup_item_append(Evas_Object *obj, const char *label, Evas_Object *icon, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
25099    /**
25100     * @brief Delete the given item in a ctxpopup object.
25101     *
25102     * @param it Ctxpopup item to be deleted
25103     *
25104     * @see elm_ctxpopup_item_append()
25105     */
25106    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25107    /**
25108     * @brief Set the ctxpopup item's state as disabled or enabled.
25109     *
25110     * @param it Ctxpopup item to be enabled/disabled
25111     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
25112     *
25113     * When disabled the item is greyed out to indicate it's state.
25114     */
25115    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
25116    /**
25117     * @brief Get the ctxpopup item's disabled/enabled state.
25118     *
25119     * @param it Ctxpopup item to be enabled/disabled
25120     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
25121     *
25122     * @see elm_ctxpopup_item_disabled_set()
25123     */
25124    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25125    /**
25126     * @brief Get the icon object for the given ctxpopup item.
25127     *
25128     * @param it Ctxpopup item
25129     * @return icon object or @c NULL, if the item does not have icon or an error
25130     * occurred
25131     *
25132     * @see elm_ctxpopup_item_append()
25133     * @see elm_ctxpopup_item_icon_set()
25134     */
25135    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25136    /**
25137     * @brief Sets the side icon associated with the ctxpopup item
25138     *
25139     * @param it Ctxpopup item
25140     * @param icon Icon object to be set
25141     *
25142     * Once the icon object is set, a previously set one will be deleted.
25143     * @warning Setting the same icon for two items will cause the icon to
25144     * dissapear from the first item.
25145     *
25146     * @see elm_ctxpopup_item_append()
25147     */
25148    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25149    /**
25150     * @brief Get the label for the given ctxpopup item.
25151     *
25152     * @param it Ctxpopup item
25153     * @return label string or @c NULL, if the item does not have label or an
25154     * error occured
25155     *
25156     * @see elm_ctxpopup_item_append()
25157     * @see elm_ctxpopup_item_label_set()
25158     */
25159    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25160    /**
25161     * @brief (Re)set the label on the given ctxpopup item.
25162     *
25163     * @param it Ctxpopup item
25164     * @param label String to set as label
25165     */
25166    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25167    /**
25168     * @brief Set an elm widget as the content of the ctxpopup.
25169     *
25170     * @param obj Ctxpopup object
25171     * @param content Content to be swallowed
25172     *
25173     * If the content object is already set, a previous one will bedeleted. If
25174     * you want to keep that old content object, use the
25175     * elm_ctxpopup_content_unset() function.
25176     *
25177     * @deprecated use elm_object_content_set()
25178     *
25179     * @warning Ctxpopup can't hold both a item list and a content at the same
25180     * time. When a content is set, any previous items will be removed.
25181     */
25182    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
25183    /**
25184     * @brief Unset the ctxpopup content
25185     *
25186     * @param obj Ctxpopup object
25187     * @return The content that was being used
25188     *
25189     * Unparent and return the content object which was set for this widget.
25190     *
25191     * @deprecated use elm_object_content_unset()
25192     *
25193     * @see elm_ctxpopup_content_set()
25194     */
25195    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
25196    /**
25197     * @brief Set the direction priority of a ctxpopup.
25198     *
25199     * @param obj Ctxpopup object
25200     * @param first 1st priority of direction
25201     * @param second 2nd priority of direction
25202     * @param third 3th priority of direction
25203     * @param fourth 4th priority of direction
25204     *
25205     * This functions gives a chance to user to set the priority of ctxpopup
25206     * showing direction. This doesn't guarantee the ctxpopup will appear in the
25207     * requested direction.
25208     *
25209     * @see Elm_Ctxpopup_Direction
25210     */
25211    EAPI void          elm_ctxpopup_direction_priority_set(Evas_Object *obj, Elm_Ctxpopup_Direction first, Elm_Ctxpopup_Direction second, Elm_Ctxpopup_Direction third, Elm_Ctxpopup_Direction fourth) EINA_ARG_NONNULL(1);
25212    /**
25213     * @brief Get the direction priority of a ctxpopup.
25214     *
25215     * @param obj Ctxpopup object
25216     * @param first 1st priority of direction to be returned
25217     * @param second 2nd priority of direction to be returned
25218     * @param third 3th priority of direction to be returned
25219     * @param fourth 4th priority of direction to be returned
25220     *
25221     * @see elm_ctxpopup_direction_priority_set() for more information.
25222     */
25223    EAPI void          elm_ctxpopup_direction_priority_get(Evas_Object *obj, Elm_Ctxpopup_Direction *first, Elm_Ctxpopup_Direction *second, Elm_Ctxpopup_Direction *third, Elm_Ctxpopup_Direction *fourth) EINA_ARG_NONNULL(1);
25224
25225    /**
25226     * @brief Get the current direction of a ctxpopup.
25227     *
25228     * @param obj Ctxpopup object
25229     * @return current direction of a ctxpopup
25230     *
25231     * @warning Once the ctxpopup showed up, the direction would be determined
25232     */
25233    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25234
25235    /**
25236     * @}
25237     */
25238
25239    /* transit */
25240    /**
25241     *
25242     * @defgroup Transit Transit
25243     * @ingroup Elementary
25244     *
25245     * Transit is designed to apply various animated transition effects to @c
25246     * Evas_Object, such like translation, rotation, etc. For using these
25247     * effects, create an @ref Elm_Transit and add the desired transition effects.
25248     *
25249     * Once the effects are added into transit, they will be automatically
25250     * managed (their callback will be called until the duration is ended, and
25251     * they will be deleted on completion).
25252     *
25253     * Example:
25254     * @code
25255     * Elm_Transit *trans = elm_transit_add();
25256     * elm_transit_object_add(trans, obj);
25257     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25258     * elm_transit_duration_set(transit, 1);
25259     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25260     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25261     * elm_transit_repeat_times_set(transit, 3);
25262     * @endcode
25263     *
25264     * Some transition effects are used to change the properties of objects. They
25265     * are:
25266     * @li @ref elm_transit_effect_translation_add
25267     * @li @ref elm_transit_effect_color_add
25268     * @li @ref elm_transit_effect_rotation_add
25269     * @li @ref elm_transit_effect_wipe_add
25270     * @li @ref elm_transit_effect_zoom_add
25271     * @li @ref elm_transit_effect_resizing_add
25272     *
25273     * Other transition effects are used to make one object disappear and another
25274     * object appear on its old place. These effects are:
25275     *
25276     * @li @ref elm_transit_effect_flip_add
25277     * @li @ref elm_transit_effect_resizable_flip_add
25278     * @li @ref elm_transit_effect_fade_add
25279     * @li @ref elm_transit_effect_blend_add
25280     *
25281     * It's also possible to make a transition chain with @ref
25282     * elm_transit_chain_transit_add.
25283     *
25284     * @warning We strongly recommend to use elm_transit just when edje can not do
25285     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25286     * animations can be manipulated inside the theme.
25287     *
25288     * List of examples:
25289     * @li @ref transit_example_01_explained
25290     * @li @ref transit_example_02_explained
25291     * @li @ref transit_example_03_c
25292     * @li @ref transit_example_04_c
25293     *
25294     * @{
25295     */
25296
25297    /**
25298     * @enum Elm_Transit_Tween_Mode
25299     *
25300     * The type of acceleration used in the transition.
25301     */
25302    typedef enum
25303      {
25304         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25305         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25306                                              over time, then decrease again
25307                                              and stop slowly */
25308         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25309                                              speed over time */
25310         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25311                                             over time */
25312      } Elm_Transit_Tween_Mode;
25313
25314    /**
25315     * @enum Elm_Transit_Effect_Flip_Axis
25316     *
25317     * The axis where flip effect should be applied.
25318     */
25319    typedef enum
25320      {
25321         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25322         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25323      } Elm_Transit_Effect_Flip_Axis;
25324    /**
25325     * @enum Elm_Transit_Effect_Wipe_Dir
25326     *
25327     * The direction where the wipe effect should occur.
25328     */
25329    typedef enum
25330      {
25331         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25332         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25333         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25334         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25335      } Elm_Transit_Effect_Wipe_Dir;
25336    /** @enum Elm_Transit_Effect_Wipe_Type
25337     *
25338     * Whether the wipe effect should show or hide the object.
25339     */
25340    typedef enum
25341      {
25342         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25343                                              animation */
25344         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25345                                             animation */
25346      } Elm_Transit_Effect_Wipe_Type;
25347
25348    /**
25349     * @typedef Elm_Transit
25350     *
25351     * The Transit created with elm_transit_add(). This type has the information
25352     * about the objects which the transition will be applied, and the
25353     * transition effects that will be used. It also contains info about
25354     * duration, number of repetitions, auto-reverse, etc.
25355     */
25356    typedef struct _Elm_Transit Elm_Transit;
25357    typedef void Elm_Transit_Effect;
25358    /**
25359     * @typedef Elm_Transit_Effect_Transition_Cb
25360     *
25361     * Transition callback called for this effect on each transition iteration.
25362     */
25363    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25364    /**
25365     * Elm_Transit_Effect_End_Cb
25366     *
25367     * Transition callback called for this effect when the transition is over.
25368     */
25369    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25370
25371    /**
25372     * Elm_Transit_Del_Cb
25373     *
25374     * A callback called when the transit is deleted.
25375     */
25376    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25377
25378    /**
25379     * Add new transit.
25380     *
25381     * @note Is not necessary to delete the transit object, it will be deleted at
25382     * the end of its operation.
25383     * @note The transit will start playing when the program enter in the main loop, is not
25384     * necessary to give a start to the transit.
25385     *
25386     * @return The transit object.
25387     *
25388     * @ingroup Transit
25389     */
25390    EAPI Elm_Transit                *elm_transit_add(void);
25391
25392    /**
25393     * Stops the animation and delete the @p transit object.
25394     *
25395     * Call this function if you wants to stop the animation before the duration
25396     * time. Make sure the @p transit object is still alive with
25397     * elm_transit_del_cb_set() function.
25398     * All added effects will be deleted, calling its repective data_free_cb
25399     * functions. The function setted by elm_transit_del_cb_set() will be called.
25400     *
25401     * @see elm_transit_del_cb_set()
25402     *
25403     * @param transit The transit object to be deleted.
25404     *
25405     * @ingroup Transit
25406     * @warning Just call this function if you are sure the transit is alive.
25407     */
25408    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25409
25410    /**
25411     * Add a new effect to the transit.
25412     *
25413     * @note The cb function and the data are the key to the effect. If you try to
25414     * add an already added effect, nothing is done.
25415     * @note After the first addition of an effect in @p transit, if its
25416     * effect list become empty again, the @p transit will be killed by
25417     * elm_transit_del(transit) function.
25418     *
25419     * Exemple:
25420     * @code
25421     * Elm_Transit *transit = elm_transit_add();
25422     * elm_transit_effect_add(transit,
25423     *                        elm_transit_effect_blend_op,
25424     *                        elm_transit_effect_blend_context_new(),
25425     *                        elm_transit_effect_blend_context_free);
25426     * @endcode
25427     *
25428     * @param transit The transit object.
25429     * @param transition_cb The operation function. It is called when the
25430     * animation begins, it is the function that actually performs the animation.
25431     * It is called with the @p data, @p transit and the time progression of the
25432     * animation (a double value between 0.0 and 1.0).
25433     * @param effect The context data of the effect.
25434     * @param end_cb The function to free the context data, it will be called
25435     * at the end of the effect, it must finalize the animation and free the
25436     * @p data.
25437     *
25438     * @ingroup Transit
25439     * @warning The transit free the context data at the and of the transition with
25440     * the data_free_cb function, do not use the context data in another transit.
25441     */
25442    EAPI void                        elm_transit_effect_add(Elm_Transit *transit, Elm_Transit_Effect_Transition_Cb transition_cb, Elm_Transit_Effect *effect, Elm_Transit_Effect_End_Cb end_cb) EINA_ARG_NONNULL(1, 2);
25443
25444    /**
25445     * Delete an added effect.
25446     *
25447     * This function will remove the effect from the @p transit, calling the
25448     * data_free_cb to free the @p data.
25449     *
25450     * @see elm_transit_effect_add()
25451     *
25452     * @note If the effect is not found, nothing is done.
25453     * @note If the effect list become empty, this function will call
25454     * elm_transit_del(transit), that is, it will kill the @p transit.
25455     *
25456     * @param transit The transit object.
25457     * @param transition_cb The operation function.
25458     * @param effect The context data of the effect.
25459     *
25460     * @ingroup Transit
25461     */
25462    EAPI void                        elm_transit_effect_del(Elm_Transit *transit, Elm_Transit_Effect_Transition_Cb transition_cb, Elm_Transit_Effect *effect) EINA_ARG_NONNULL(1, 2);
25463
25464    /**
25465     * Add new object to apply the effects.
25466     *
25467     * @note After the first addition of an object in @p transit, if its
25468     * object list become empty again, the @p transit will be killed by
25469     * elm_transit_del(transit) function.
25470     * @note If the @p obj belongs to another transit, the @p obj will be
25471     * removed from it and it will only belong to the @p transit. If the old
25472     * transit stays without objects, it will die.
25473     * @note When you add an object into the @p transit, its state from
25474     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25475     * transit ends, if you change this state whith evas_object_pass_events_set()
25476     * after add the object, this state will change again when @p transit stops to
25477     * run.
25478     *
25479     * @param transit The transit object.
25480     * @param obj Object to be animated.
25481     *
25482     * @ingroup Transit
25483     * @warning It is not allowed to add a new object after transit begins to go.
25484     */
25485    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25486
25487    /**
25488     * Removes an added object from the transit.
25489     *
25490     * @note If the @p obj is not in the @p transit, nothing is done.
25491     * @note If the list become empty, this function will call
25492     * elm_transit_del(transit), that is, it will kill the @p transit.
25493     *
25494     * @param transit The transit object.
25495     * @param obj Object to be removed from @p transit.
25496     *
25497     * @ingroup Transit
25498     * @warning It is not allowed to remove objects after transit begins to go.
25499     */
25500    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25501
25502    /**
25503     * Get the objects of the transit.
25504     *
25505     * @param transit The transit object.
25506     * @return a Eina_List with the objects from the transit.
25507     *
25508     * @ingroup Transit
25509     */
25510    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25511
25512    /**
25513     * Enable/disable keeping up the objects states.
25514     * If it is not kept, the objects states will be reset when transition ends.
25515     *
25516     * @note @p transit can not be NULL.
25517     * @note One state includes geometry, color, map data.
25518     *
25519     * @param transit The transit object.
25520     * @param state_keep Keeping or Non Keeping.
25521     *
25522     * @ingroup Transit
25523     */
25524    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25525
25526    /**
25527     * Get a value whether the objects states will be reset or not.
25528     *
25529     * @note @p transit can not be NULL
25530     *
25531     * @see elm_transit_objects_final_state_keep_set()
25532     *
25533     * @param transit The transit object.
25534     * @return EINA_TRUE means the states of the objects will be reset.
25535     * If @p transit is NULL, EINA_FALSE is returned
25536     *
25537     * @ingroup Transit
25538     */
25539    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25540
25541    /**
25542     * Set the event enabled when transit is operating.
25543     *
25544     * If @p enabled is EINA_TRUE, the objects of the transit will receives
25545     * events from mouse and keyboard during the animation.
25546     * @note When you add an object with elm_transit_object_add(), its state from
25547     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25548     * transit ends, if you change this state with evas_object_pass_events_set()
25549     * after adding the object, this state will change again when @p transit stops
25550     * to run.
25551     *
25552     * @param transit The transit object.
25553     * @param enabled Events are received when enabled is @c EINA_TRUE, and
25554     * ignored otherwise.
25555     *
25556     * @ingroup Transit
25557     */
25558    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25559
25560    /**
25561     * Get the value of event enabled status.
25562     *
25563     * @see elm_transit_event_enabled_set()
25564     *
25565     * @param transit The Transit object
25566     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25567     * EINA_FALSE is returned
25568     *
25569     * @ingroup Transit
25570     */
25571    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25572
25573    /**
25574     * Set the user-callback function when the transit is deleted.
25575     *
25576     * @note Using this function twice will overwrite the first function setted.
25577     * @note the @p transit object will be deleted after call @p cb function.
25578     *
25579     * @param transit The transit object.
25580     * @param cb Callback function pointer. This function will be called before
25581     * the deletion of the transit.
25582     * @param data Callback funtion user data. It is the @p op parameter.
25583     *
25584     * @ingroup Transit
25585     */
25586    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25587
25588    /**
25589     * Set reverse effect automatically.
25590     *
25591     * If auto reverse is setted, after running the effects with the progress
25592     * parameter from 0 to 1, it will call the effecs again with the progress
25593     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25594     * where the duration was setted with the function elm_transit_add and
25595     * the repeat with the function elm_transit_repeat_times_set().
25596     *
25597     * @param transit The transit object.
25598     * @param reverse EINA_TRUE means the auto_reverse is on.
25599     *
25600     * @ingroup Transit
25601     */
25602    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25603
25604    /**
25605     * Get if the auto reverse is on.
25606     *
25607     * @see elm_transit_auto_reverse_set()
25608     *
25609     * @param transit The transit object.
25610     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25611     * EINA_FALSE is returned
25612     *
25613     * @ingroup Transit
25614     */
25615    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25616
25617    /**
25618     * Set the transit repeat count. Effect will be repeated by repeat count.
25619     *
25620     * This function sets the number of repetition the transit will run after
25621     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25622     * If the @p repeat is a negative number, it will repeat infinite times.
25623     *
25624     * @note If this function is called during the transit execution, the transit
25625     * will run @p repeat times, ignoring the times it already performed.
25626     *
25627     * @param transit The transit object
25628     * @param repeat Repeat count
25629     *
25630     * @ingroup Transit
25631     */
25632    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25633
25634    /**
25635     * Get the transit repeat count.
25636     *
25637     * @see elm_transit_repeat_times_set()
25638     *
25639     * @param transit The Transit object.
25640     * @return The repeat count. If @p transit is NULL
25641     * 0 is returned
25642     *
25643     * @ingroup Transit
25644     */
25645    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25646
25647    /**
25648     * Set the transit animation acceleration type.
25649     *
25650     * This function sets the tween mode of the transit that can be:
25651     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25652     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25653     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25654     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25655     *
25656     * @param transit The transit object.
25657     * @param tween_mode The tween type.
25658     *
25659     * @ingroup Transit
25660     */
25661    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25662
25663    /**
25664     * Get the transit animation acceleration type.
25665     *
25666     * @note @p transit can not be NULL
25667     *
25668     * @param transit The transit object.
25669     * @return The tween type. If @p transit is NULL
25670     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25671     *
25672     * @ingroup Transit
25673     */
25674    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25675
25676    /**
25677     * Set the transit animation time
25678     *
25679     * @note @p transit can not be NULL
25680     *
25681     * @param transit The transit object.
25682     * @param duration The animation time.
25683     *
25684     * @ingroup Transit
25685     */
25686    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25687
25688    /**
25689     * Get the transit animation time
25690     *
25691     * @note @p transit can not be NULL
25692     *
25693     * @param transit The transit object.
25694     *
25695     * @return The transit animation time.
25696     *
25697     * @ingroup Transit
25698     */
25699    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25700
25701    /**
25702     * Starts the transition.
25703     * Once this API is called, the transit begins to measure the time.
25704     *
25705     * @note @p transit can not be NULL
25706     *
25707     * @param transit The transit object.
25708     *
25709     * @ingroup Transit
25710     */
25711    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25712
25713    /**
25714     * Pause/Resume the transition.
25715     *
25716     * If you call elm_transit_go again, the transit will be started from the
25717     * beginning, and will be unpaused.
25718     *
25719     * @note @p transit can not be NULL
25720     *
25721     * @param transit The transit object.
25722     * @param paused Whether the transition should be paused or not.
25723     *
25724     * @ingroup Transit
25725     */
25726    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25727
25728    /**
25729     * Get the value of paused status.
25730     *
25731     * @see elm_transit_paused_set()
25732     *
25733     * @note @p transit can not be NULL
25734     *
25735     * @param transit The transit object.
25736     * @return EINA_TRUE means transition is paused. If @p transit is NULL
25737     * EINA_FALSE is returned
25738     *
25739     * @ingroup Transit
25740     */
25741    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25742
25743    /**
25744     * Get the time progression of the animation (a double value between 0.0 and 1.0).
25745     *
25746     * The value returned is a fraction (current time / total time). It
25747     * represents the progression position relative to the total.
25748     *
25749     * @note @p transit can not be NULL
25750     *
25751     * @param transit The transit object.
25752     *
25753     * @return The time progression value. If @p transit is NULL
25754     * 0 is returned
25755     *
25756     * @ingroup Transit
25757     */
25758    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25759
25760    /**
25761     * Makes the chain relationship between two transits.
25762     *
25763     * @note @p transit can not be NULL. Transit would have multiple chain transits.
25764     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25765     *
25766     * @param transit The transit object.
25767     * @param chain_transit The chain transit object. This transit will be operated
25768     *        after transit is done.
25769     *
25770     * This function adds @p chain_transit transition to a chain after the @p
25771     * transit, and will be started as soon as @p transit ends. See @ref
25772     * transit_example_02_explained for a full example.
25773     *
25774     * @ingroup Transit
25775     */
25776    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25777
25778    /**
25779     * Cut off the chain relationship between two transits.
25780     *
25781     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25782     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25783     *
25784     * @param transit The transit object.
25785     * @param chain_transit The chain transit object.
25786     *
25787     * This function remove the @p chain_transit transition from the @p transit.
25788     *
25789     * @ingroup Transit
25790     */
25791    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25792
25793    /**
25794     * Get the current chain transit list.
25795     *
25796     * @note @p transit can not be NULL.
25797     *
25798     * @param transit The transit object.
25799     * @return chain transit list.
25800     *
25801     * @ingroup Transit
25802     */
25803    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
25804
25805    /**
25806     * Add the Resizing Effect to Elm_Transit.
25807     *
25808     * @note This API is one of the facades. It creates resizing effect context
25809     * and add it's required APIs to elm_transit_effect_add.
25810     *
25811     * @see elm_transit_effect_add()
25812     *
25813     * @param transit Transit object.
25814     * @param from_w Object width size when effect begins.
25815     * @param from_h Object height size when effect begins.
25816     * @param to_w Object width size when effect ends.
25817     * @param to_h Object height size when effect ends.
25818     * @return Resizing effect context data.
25819     *
25820     * @ingroup Transit
25821     */
25822    EAPI Elm_Transit_Effect *elm_transit_effect_resizing_add(Elm_Transit* transit, Evas_Coord from_w, Evas_Coord from_h, Evas_Coord to_w, Evas_Coord to_h);
25823
25824    /**
25825     * Add the Translation Effect to Elm_Transit.
25826     *
25827     * @note This API is one of the facades. It creates translation effect context
25828     * and add it's required APIs to elm_transit_effect_add.
25829     *
25830     * @see elm_transit_effect_add()
25831     *
25832     * @param transit Transit object.
25833     * @param from_dx X Position variation when effect begins.
25834     * @param from_dy Y Position variation when effect begins.
25835     * @param to_dx X Position variation when effect ends.
25836     * @param to_dy Y Position variation when effect ends.
25837     * @return Translation effect context data.
25838     *
25839     * @ingroup Transit
25840     * @warning It is highly recommended just create a transit with this effect when
25841     * the window that the objects of the transit belongs has already been created.
25842     * This is because this effect needs the geometry information about the objects,
25843     * and if the window was not created yet, it can get a wrong information.
25844     */
25845    EAPI Elm_Transit_Effect *elm_transit_effect_translation_add(Elm_Transit* transit, Evas_Coord from_dx, Evas_Coord from_dy, Evas_Coord to_dx, Evas_Coord to_dy);
25846
25847    /**
25848     * Add the Zoom Effect to Elm_Transit.
25849     *
25850     * @note This API is one of the facades. It creates zoom effect context
25851     * and add it's required APIs to elm_transit_effect_add.
25852     *
25853     * @see elm_transit_effect_add()
25854     *
25855     * @param transit Transit object.
25856     * @param from_rate Scale rate when effect begins (1 is current rate).
25857     * @param to_rate Scale rate when effect ends.
25858     * @return Zoom effect context data.
25859     *
25860     * @ingroup Transit
25861     * @warning It is highly recommended just create a transit with this effect when
25862     * the window that the objects of the transit belongs has already been created.
25863     * This is because this effect needs the geometry information about the objects,
25864     * and if the window was not created yet, it can get a wrong information.
25865     */
25866    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25867
25868    /**
25869     * Add the Flip Effect to Elm_Transit.
25870     *
25871     * @note This API is one of the facades. It creates flip effect context
25872     * and add it's required APIs to elm_transit_effect_add.
25873     * @note This effect is applied to each pair of objects in the order they are listed
25874     * in the transit list of objects. The first object in the pair will be the
25875     * "front" object and the second will be the "back" object.
25876     *
25877     * @see elm_transit_effect_add()
25878     *
25879     * @param transit Transit object.
25880     * @param axis Flipping Axis(X or Y).
25881     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25882     * @return Flip effect context data.
25883     *
25884     * @ingroup Transit
25885     * @warning It is highly recommended just create a transit with this effect when
25886     * the window that the objects of the transit belongs has already been created.
25887     * This is because this effect needs the geometry information about the objects,
25888     * and if the window was not created yet, it can get a wrong information.
25889     */
25890    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25891
25892    /**
25893     * Add the Resizable Flip Effect to Elm_Transit.
25894     *
25895     * @note This API is one of the facades. It creates resizable flip effect context
25896     * and add it's required APIs to elm_transit_effect_add.
25897     * @note This effect is applied to each pair of objects in the order they are listed
25898     * in the transit list of objects. The first object in the pair will be the
25899     * "front" object and the second will be the "back" object.
25900     *
25901     * @see elm_transit_effect_add()
25902     *
25903     * @param transit Transit object.
25904     * @param axis Flipping Axis(X or Y).
25905     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25906     * @return Resizable flip effect context data.
25907     *
25908     * @ingroup Transit
25909     * @warning It is highly recommended just create a transit with this effect when
25910     * the window that the objects of the transit belongs has already been created.
25911     * This is because this effect needs the geometry information about the objects,
25912     * and if the window was not created yet, it can get a wrong information.
25913     */
25914    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25915
25916    /**
25917     * Add the Wipe Effect to Elm_Transit.
25918     *
25919     * @note This API is one of the facades. It creates wipe effect context
25920     * and add it's required APIs to elm_transit_effect_add.
25921     *
25922     * @see elm_transit_effect_add()
25923     *
25924     * @param transit Transit object.
25925     * @param type Wipe type. Hide or show.
25926     * @param dir Wipe Direction.
25927     * @return Wipe effect context data.
25928     *
25929     * @ingroup Transit
25930     * @warning It is highly recommended just create a transit with this effect when
25931     * the window that the objects of the transit belongs has already been created.
25932     * This is because this effect needs the geometry information about the objects,
25933     * and if the window was not created yet, it can get a wrong information.
25934     */
25935    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25936
25937    /**
25938     * Add the Color Effect to Elm_Transit.
25939     *
25940     * @note This API is one of the facades. It creates color effect context
25941     * and add it's required APIs to elm_transit_effect_add.
25942     *
25943     * @see elm_transit_effect_add()
25944     *
25945     * @param transit        Transit object.
25946     * @param  from_r        RGB R when effect begins.
25947     * @param  from_g        RGB G when effect begins.
25948     * @param  from_b        RGB B when effect begins.
25949     * @param  from_a        RGB A when effect begins.
25950     * @param  to_r          RGB R when effect ends.
25951     * @param  to_g          RGB G when effect ends.
25952     * @param  to_b          RGB B when effect ends.
25953     * @param  to_a          RGB A when effect ends.
25954     * @return               Color effect context data.
25955     *
25956     * @ingroup Transit
25957     */
25958    EAPI Elm_Transit_Effect *elm_transit_effect_color_add(Elm_Transit *transit, unsigned int from_r, unsigned int from_g, unsigned int from_b, unsigned int from_a, unsigned int to_r, unsigned int to_g, unsigned int to_b, unsigned int to_a);
25959
25960    /**
25961     * Add the Fade Effect to Elm_Transit.
25962     *
25963     * @note This API is one of the facades. It creates fade effect context
25964     * and add it's required APIs to elm_transit_effect_add.
25965     * @note This effect is applied to each pair of objects in the order they are listed
25966     * in the transit list of objects. The first object in the pair will be the
25967     * "before" object and the second will be the "after" object.
25968     *
25969     * @see elm_transit_effect_add()
25970     *
25971     * @param transit Transit object.
25972     * @return Fade effect context data.
25973     *
25974     * @ingroup Transit
25975     * @warning It is highly recommended just create a transit with this effect when
25976     * the window that the objects of the transit belongs has already been created.
25977     * This is because this effect needs the color information about the objects,
25978     * and if the window was not created yet, it can get a wrong information.
25979     */
25980    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25981
25982    /**
25983     * Add the Blend Effect to Elm_Transit.
25984     *
25985     * @note This API is one of the facades. It creates blend effect context
25986     * and add it's required APIs to elm_transit_effect_add.
25987     * @note This effect is applied to each pair of objects in the order they are listed
25988     * in the transit list of objects. The first object in the pair will be the
25989     * "before" object and the second will be the "after" object.
25990     *
25991     * @see elm_transit_effect_add()
25992     *
25993     * @param transit Transit object.
25994     * @return Blend effect context data.
25995     *
25996     * @ingroup Transit
25997     * @warning It is highly recommended just create a transit with this effect when
25998     * the window that the objects of the transit belongs has already been created.
25999     * This is because this effect needs the color information about the objects,
26000     * and if the window was not created yet, it can get a wrong information.
26001     */
26002    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
26003
26004    /**
26005     * Add the Rotation Effect to Elm_Transit.
26006     *
26007     * @note This API is one of the facades. It creates rotation effect context
26008     * and add it's required APIs to elm_transit_effect_add.
26009     *
26010     * @see elm_transit_effect_add()
26011     *
26012     * @param transit Transit object.
26013     * @param from_degree Degree when effect begins.
26014     * @param to_degree Degree when effect is ends.
26015     * @return Rotation effect context data.
26016     *
26017     * @ingroup Transit
26018     * @warning It is highly recommended just create a transit with this effect when
26019     * the window that the objects of the transit belongs has already been created.
26020     * This is because this effect needs the geometry information about the objects,
26021     * and if the window was not created yet, it can get a wrong information.
26022     */
26023    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
26024
26025    /**
26026     * Add the ImageAnimation Effect to Elm_Transit.
26027     *
26028     * @note This API is one of the facades. It creates image animation effect context
26029     * and add it's required APIs to elm_transit_effect_add.
26030     * The @p images parameter is a list images paths. This list and
26031     * its contents will be deleted at the end of the effect by
26032     * elm_transit_effect_image_animation_context_free() function.
26033     *
26034     * Example:
26035     * @code
26036     * char buf[PATH_MAX];
26037     * Eina_List *images = NULL;
26038     * Elm_Transit *transi = elm_transit_add();
26039     *
26040     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
26041     * images = eina_list_append(images, eina_stringshare_add(buf));
26042     *
26043     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
26044     * images = eina_list_append(images, eina_stringshare_add(buf));
26045     * elm_transit_effect_image_animation_add(transi, images);
26046     *
26047     * @endcode
26048     *
26049     * @see elm_transit_effect_add()
26050     *
26051     * @param transit Transit object.
26052     * @param images Eina_List of images file paths. This list and
26053     * its contents will be deleted at the end of the effect by
26054     * elm_transit_effect_image_animation_context_free() function.
26055     * @return Image Animation effect context data.
26056     *
26057     * @ingroup Transit
26058     */
26059    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
26060    /**
26061     * @}
26062     */
26063
26064   typedef struct _Elm_Store                      Elm_Store;
26065   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
26066   typedef struct _Elm_Store_Item                 Elm_Store_Item;
26067   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
26068   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
26069   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
26070   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
26071   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
26072   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
26073   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
26074   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
26075
26076   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
26077   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
26078   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
26079   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
26080
26081   typedef enum
26082     {
26083        ELM_STORE_ITEM_MAPPING_NONE = 0,
26084        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
26085        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
26086        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
26087        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
26088        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
26089        // can add more here as needed by common apps
26090        ELM_STORE_ITEM_MAPPING_LAST
26091     } Elm_Store_Item_Mapping_Type;
26092
26093   struct _Elm_Store_Item_Mapping_Icon
26094     {
26095        // FIXME: allow edje file icons
26096        int                   w, h;
26097        Elm_Icon_Lookup_Order lookup_order;
26098        Eina_Bool             standard_name : 1;
26099        Eina_Bool             no_scale : 1;
26100        Eina_Bool             smooth : 1;
26101        Eina_Bool             scale_up : 1;
26102        Eina_Bool             scale_down : 1;
26103     };
26104
26105   struct _Elm_Store_Item_Mapping_Empty
26106     {
26107        Eina_Bool             dummy;
26108     };
26109
26110   struct _Elm_Store_Item_Mapping_Photo
26111     {
26112        int                   size;
26113     };
26114
26115   struct _Elm_Store_Item_Mapping_Custom
26116     {
26117        Elm_Store_Item_Mapping_Cb func;
26118     };
26119
26120   struct _Elm_Store_Item_Mapping
26121     {
26122        Elm_Store_Item_Mapping_Type     type;
26123        const char                     *part;
26124        int                             offset;
26125        union
26126          {
26127             Elm_Store_Item_Mapping_Empty  empty;
26128             Elm_Store_Item_Mapping_Icon   icon;
26129             Elm_Store_Item_Mapping_Photo  photo;
26130             Elm_Store_Item_Mapping_Custom custom;
26131             // add more types here
26132          } details;
26133     };
26134
26135   struct _Elm_Store_Item_Info
26136     {
26137       Elm_Genlist_Item_Class       *item_class;
26138       const Elm_Store_Item_Mapping *mapping;
26139       void                         *data;
26140       char                         *sort_id;
26141     };
26142
26143   struct _Elm_Store_Item_Info_Filesystem
26144     {
26145       Elm_Store_Item_Info  base;
26146       char                *path;
26147     };
26148
26149 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
26150 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
26151
26152   EAPI void                    elm_store_free(Elm_Store *st);
26153
26154   EAPI Elm_Store              *elm_store_filesystem_new(void);
26155   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
26156   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26157   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26158
26159   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
26160
26161   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
26162   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26163   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26164   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26165   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
26166   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26167
26168   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
26169   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
26170   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
26171   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
26172   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26173   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26174   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
26175
26176    /**
26177     * @defgroup SegmentControl SegmentControl
26178     * @ingroup Elementary
26179     *
26180     * @image html img/widget/segment_control/preview-00.png
26181     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
26182     *
26183     * @image html img/segment_control.png
26184     * @image latex img/segment_control.eps width=\textwidth
26185     *
26186     * Segment control widget is a horizontal control made of multiple segment
26187     * items, each segment item functioning similar to discrete two state button.
26188     * A segment control groups the items together and provides compact
26189     * single button with multiple equal size segments.
26190     *
26191     * Segment item size is determined by base widget
26192     * size and the number of items added.
26193     * Only one segment item can be at selected state. A segment item can display
26194     * combination of Text and any Evas_Object like Images or other widget.
26195     *
26196     * Smart callbacks one can listen to:
26197     * - "changed" - When the user clicks on a segment item which is not
26198     *   previously selected and get selected. The event_info parameter is the
26199     *   segment item index.
26200     *
26201     * Available styles for it:
26202     * - @c "default"
26203     *
26204     * Here is an example on its usage:
26205     * @li @ref segment_control_example
26206     */
26207
26208    /**
26209     * @addtogroup SegmentControl
26210     * @{
26211     */
26212
26213    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
26214
26215    /**
26216     * Add a new segment control widget to the given parent Elementary
26217     * (container) object.
26218     *
26219     * @param parent The parent object.
26220     * @return a new segment control widget handle or @c NULL, on errors.
26221     *
26222     * This function inserts a new segment control widget on the canvas.
26223     *
26224     * @ingroup SegmentControl
26225     */
26226    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26227
26228    /**
26229     * Append a new item to the segment control object.
26230     *
26231     * @param obj The segment control object.
26232     * @param icon The icon object to use for the left side of the item. An
26233     * icon can be any Evas object, but usually it is an icon created
26234     * with elm_icon_add().
26235     * @param label The label of the item.
26236     *        Note that, NULL is different from empty string "".
26237     * @return The created item or @c NULL upon failure.
26238     *
26239     * A new item will be created and appended to the segment control, i.e., will
26240     * be set as @b last item.
26241     *
26242     * If it should be inserted at another position,
26243     * elm_segment_control_item_insert_at() should be used instead.
26244     *
26245     * Items created with this function can be deleted with function
26246     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26247     *
26248     * @note @p label set to @c NULL is different from empty string "".
26249     * If an item
26250     * only has icon, it will be displayed bigger and centered. If it has
26251     * icon and label, even that an empty string, icon will be smaller and
26252     * positioned at left.
26253     *
26254     * Simple example:
26255     * @code
26256     * sc = elm_segment_control_add(win);
26257     * ic = elm_icon_add(win);
26258     * elm_icon_file_set(ic, "path/to/image", NULL);
26259     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26260     * elm_segment_control_item_add(sc, ic, "label");
26261     * evas_object_show(sc);
26262     * @endcode
26263     *
26264     * @see elm_segment_control_item_insert_at()
26265     * @see elm_segment_control_item_del()
26266     *
26267     * @ingroup SegmentControl
26268     */
26269    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26270
26271    /**
26272     * Insert a new item to the segment control object at specified position.
26273     *
26274     * @param obj The segment control object.
26275     * @param icon The icon object to use for the left side of the item. An
26276     * icon can be any Evas object, but usually it is an icon created
26277     * with elm_icon_add().
26278     * @param label The label of the item.
26279     * @param index Item position. Value should be between 0 and items count.
26280     * @return The created item or @c NULL upon failure.
26281
26282     * Index values must be between @c 0, when item will be prepended to
26283     * segment control, and items count, that can be get with
26284     * elm_segment_control_item_count_get(), case when item will be appended
26285     * to segment control, just like elm_segment_control_item_add().
26286     *
26287     * Items created with this function can be deleted with function
26288     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26289     *
26290     * @note @p label set to @c NULL is different from empty string "".
26291     * If an item
26292     * only has icon, it will be displayed bigger and centered. If it has
26293     * icon and label, even that an empty string, icon will be smaller and
26294     * positioned at left.
26295     *
26296     * @see elm_segment_control_item_add()
26297     * @see elm_segment_control_item_count_get()
26298     * @see elm_segment_control_item_del()
26299     *
26300     * @ingroup SegmentControl
26301     */
26302    EAPI Elm_Segment_Item *elm_segment_control_item_insert_at(Evas_Object *obj, Evas_Object *icon, const char *label, int index) EINA_ARG_NONNULL(1);
26303
26304    /**
26305     * Remove a segment control item from its parent, deleting it.
26306     *
26307     * @param it The item to be removed.
26308     *
26309     * Items can be added with elm_segment_control_item_add() or
26310     * elm_segment_control_item_insert_at().
26311     *
26312     * @ingroup SegmentControl
26313     */
26314    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26315
26316    /**
26317     * Remove a segment control item at given index from its parent,
26318     * deleting it.
26319     *
26320     * @param obj The segment control object.
26321     * @param index The position of the segment control item to be deleted.
26322     *
26323     * Items can be added with elm_segment_control_item_add() or
26324     * elm_segment_control_item_insert_at().
26325     *
26326     * @ingroup SegmentControl
26327     */
26328    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26329
26330    /**
26331     * Get the Segment items count from segment control.
26332     *
26333     * @param obj The segment control object.
26334     * @return Segment items count.
26335     *
26336     * It will just return the number of items added to segment control @p obj.
26337     *
26338     * @ingroup SegmentControl
26339     */
26340    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26341
26342    /**
26343     * Get the item placed at specified index.
26344     *
26345     * @param obj The segment control object.
26346     * @param index The index of the segment item.
26347     * @return The segment control item or @c NULL on failure.
26348     *
26349     * Index is the position of an item in segment control widget. Its
26350     * range is from @c 0 to <tt> count - 1 </tt>.
26351     * Count is the number of items, that can be get with
26352     * elm_segment_control_item_count_get().
26353     *
26354     * @ingroup SegmentControl
26355     */
26356    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26357
26358    /**
26359     * Get the label of item.
26360     *
26361     * @param obj The segment control object.
26362     * @param index The index of the segment item.
26363     * @return The label of the item at @p index.
26364     *
26365     * The return value is a pointer to the label associated to the item when
26366     * it was created, with function elm_segment_control_item_add(), or later
26367     * with function elm_segment_control_item_label_set. If no label
26368     * was passed as argument, it will return @c NULL.
26369     *
26370     * @see elm_segment_control_item_label_set() for more details.
26371     * @see elm_segment_control_item_add()
26372     *
26373     * @ingroup SegmentControl
26374     */
26375    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26376
26377    /**
26378     * Set the label of item.
26379     *
26380     * @param it The item of segment control.
26381     * @param text The label of item.
26382     *
26383     * The label to be displayed by the item.
26384     * Label will be at right of the icon (if set).
26385     *
26386     * If a label was passed as argument on item creation, with function
26387     * elm_control_segment_item_add(), it will be already
26388     * displayed by the item.
26389     *
26390     * @see elm_segment_control_item_label_get()
26391     * @see elm_segment_control_item_add()
26392     *
26393     * @ingroup SegmentControl
26394     */
26395    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26396
26397    /**
26398     * Get the icon associated to the item.
26399     *
26400     * @param obj The segment control object.
26401     * @param index The index of the segment item.
26402     * @return The left side icon associated to the item at @p index.
26403     *
26404     * The return value is a pointer to the icon associated to the item when
26405     * it was created, with function elm_segment_control_item_add(), or later
26406     * with function elm_segment_control_item_icon_set(). If no icon
26407     * was passed as argument, it will return @c NULL.
26408     *
26409     * @see elm_segment_control_item_add()
26410     * @see elm_segment_control_item_icon_set()
26411     *
26412     * @ingroup SegmentControl
26413     */
26414    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26415
26416    /**
26417     * Set the icon associated to the item.
26418     *
26419     * @param it The segment control item.
26420     * @param icon The icon object to associate with @p it.
26421     *
26422     * The icon object to use at left side of the item. An
26423     * icon can be any Evas object, but usually it is an icon created
26424     * with elm_icon_add().
26425     *
26426     * Once the icon object is set, a previously set one will be deleted.
26427     * @warning Setting the same icon for two items will cause the icon to
26428     * dissapear from the first item.
26429     *
26430     * If an icon was passed as argument on item creation, with function
26431     * elm_segment_control_item_add(), it will be already
26432     * associated to the item.
26433     *
26434     * @see elm_segment_control_item_add()
26435     * @see elm_segment_control_item_icon_get()
26436     *
26437     * @ingroup SegmentControl
26438     */
26439    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26440
26441    /**
26442     * Get the index of an item.
26443     *
26444     * @param it The segment control item.
26445     * @return The position of item in segment control widget.
26446     *
26447     * Index is the position of an item in segment control widget. Its
26448     * range is from @c 0 to <tt> count - 1 </tt>.
26449     * Count is the number of items, that can be get with
26450     * elm_segment_control_item_count_get().
26451     *
26452     * @ingroup SegmentControl
26453     */
26454    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26455
26456    /**
26457     * Get the base object of the item.
26458     *
26459     * @param it The segment control item.
26460     * @return The base object associated with @p it.
26461     *
26462     * Base object is the @c Evas_Object that represents that item.
26463     *
26464     * @ingroup SegmentControl
26465     */
26466    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26467
26468    /**
26469     * Get the selected item.
26470     *
26471     * @param obj The segment control object.
26472     * @return The selected item or @c NULL if none of segment items is
26473     * selected.
26474     *
26475     * The selected item can be unselected with function
26476     * elm_segment_control_item_selected_set().
26477     *
26478     * The selected item always will be highlighted on segment control.
26479     *
26480     * @ingroup SegmentControl
26481     */
26482    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26483
26484    /**
26485     * Set the selected state of an item.
26486     *
26487     * @param it The segment control item
26488     * @param select The selected state
26489     *
26490     * This sets the selected state of the given item @p it.
26491     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26492     *
26493     * If a new item is selected the previosly selected will be unselected.
26494     * Previoulsy selected item can be get with function
26495     * elm_segment_control_item_selected_get().
26496     *
26497     * The selected item always will be highlighted on segment control.
26498     *
26499     * @see elm_segment_control_item_selected_get()
26500     *
26501     * @ingroup SegmentControl
26502     */
26503    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26504
26505    /**
26506     * @}
26507     */
26508
26509    /**
26510     * @defgroup Grid Grid
26511     *
26512     * The grid is a grid layout widget that lays out a series of children as a
26513     * fixed "grid" of widgets using a given percentage of the grid width and
26514     * height each using the child object.
26515     *
26516     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26517     * widgets size itself. The default is 100 x 100, so that means the
26518     * position and sizes of children will effectively be percentages (0 to 100)
26519     * of the width or height of the grid widget
26520     *
26521     * @{
26522     */
26523
26524    /**
26525     * Add a new grid to the parent
26526     *
26527     * @param parent The parent object
26528     * @return The new object or NULL if it cannot be created
26529     *
26530     * @ingroup Grid
26531     */
26532    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26533
26534    /**
26535     * Set the virtual size of the grid
26536     *
26537     * @param obj The grid object
26538     * @param w The virtual width of the grid
26539     * @param h The virtual height of the grid
26540     *
26541     * @ingroup Grid
26542     */
26543    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
26544
26545    /**
26546     * Get the virtual size of the grid
26547     *
26548     * @param obj The grid object
26549     * @param w Pointer to integer to store the virtual width of the grid
26550     * @param h Pointer to integer to store the virtual height of the grid
26551     *
26552     * @ingroup Grid
26553     */
26554    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26555
26556    /**
26557     * Pack child at given position and size
26558     *
26559     * @param obj The grid object
26560     * @param subobj The child to pack
26561     * @param x The virtual x coord at which to pack it
26562     * @param y The virtual y coord at which to pack it
26563     * @param w The virtual width at which to pack it
26564     * @param h The virtual height at which to pack it
26565     *
26566     * @ingroup Grid
26567     */
26568    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26569
26570    /**
26571     * Unpack a child from a grid object
26572     *
26573     * @param obj The grid object
26574     * @param subobj The child to unpack
26575     *
26576     * @ingroup Grid
26577     */
26578    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26579
26580    /**
26581     * Faster way to remove all child objects from a grid object.
26582     *
26583     * @param obj The grid object
26584     * @param clear If true, it will delete just removed children
26585     *
26586     * @ingroup Grid
26587     */
26588    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26589
26590    /**
26591     * Set packing of an existing child at to position and size
26592     *
26593     * @param subobj The child to set packing of
26594     * @param x The virtual x coord at which to pack it
26595     * @param y The virtual y coord at which to pack it
26596     * @param w The virtual width at which to pack it
26597     * @param h The virtual height at which to pack it
26598     *
26599     * @ingroup Grid
26600     */
26601    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26602
26603    /**
26604     * get packing of a child
26605     *
26606     * @param subobj The child to query
26607     * @param x Pointer to integer to store the virtual x coord
26608     * @param y Pointer to integer to store the virtual y coord
26609     * @param w Pointer to integer to store the virtual width
26610     * @param h Pointer to integer to store the virtual height
26611     *
26612     * @ingroup Grid
26613     */
26614    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26615
26616    /**
26617     * @}
26618     */
26619
26620    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26621    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26622    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26623    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
26624    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
26625    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
26626
26627    /**
26628     * @defgroup Video Video
26629     *
26630     * This object display an player that let you control an Elm_Video
26631     * object. It take care of updating it's content according to what is
26632     * going on inside the Emotion object. It does activate the remember
26633     * function on the linked Elm_Video object.
26634     *
26635     * Signals that you can add callback for are :
26636     *
26637     * "forward,clicked" - the user clicked the forward button.
26638     * "info,clicked" - the user clicked the info button.
26639     * "next,clicked" - the user clicked the next button.
26640     * "pause,clicked" - the user clicked the pause button.
26641     * "play,clicked" - the user clicked the play button.
26642     * "prev,clicked" - the user clicked the prev button.
26643     * "rewind,clicked" - the user clicked the rewind button.
26644     * "stop,clicked" - the user clicked the stop button.
26645     */
26646    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26647    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26648    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26649    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26650    EAPI void elm_video_play(Evas_Object *video);
26651    EAPI void elm_video_pause(Evas_Object *video);
26652    EAPI void elm_video_stop(Evas_Object *video);
26653    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26654    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26655    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26656    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26657    EAPI double elm_video_audio_level_get(Evas_Object *video);
26658    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26659    EAPI double elm_video_play_position_get(Evas_Object *video);
26660    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26661    EAPI double elm_video_play_length_get(Evas_Object *video);
26662    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26663    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26664    EAPI const char *elm_video_title_get(Evas_Object *video);
26665
26666    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26667    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26668
26669    /**
26670     * @defgroup Naviframe Naviframe
26671     *
26672     * @brief Naviframe is a kind of view manager for the applications.
26673     *
26674     * Naviframe provides functions to switch different pages with stack
26675     * mechanism. It means if one page(item) needs to be changed to the new one,
26676     * then naviframe would push the new page to it's internal stack. Of course,
26677     * it can be back to the previous page by popping the top page. Naviframe
26678     * provides some transition effect while the pages are switching (same as
26679     * pager).
26680     *
26681     * Since each item could keep the different styles, users could keep the
26682     * same look & feel for the pages or different styles for the items in it's
26683     * application.
26684     *
26685     * Signals that you can add callback for are:
26686     *
26687     * @li "transition,finished" - When the transition is finished in changing
26688     *     the item
26689     * @li "title,clicked" - User clicked title area
26690     *
26691     * Default contents parts for the naviframe items that you can use for are:
26692     *
26693     * @li "elm.swallow.content" - The main content of the page
26694     * @li "elm.swallow.prev_btn" - The button to go to the previous page
26695     * @li "elm.swallow.next_btn" - The button to go to the next page
26696     *
26697     * Default text parts of naviframe items that you can be used are:
26698     *
26699     * @li "elm.text.title" - The title label in the title area
26700     *
26701     * @ref tutorial_naviframe gives a good overview of the usage of the API.
26702     * @{
26703     */
26704    /**
26705     * @brief Add a new Naviframe object to the parent.
26706     *
26707     * @param parent Parent object
26708     * @return New object or @c NULL, if it cannot be created
26709     */
26710    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26711    /**
26712     * @brief Push a new item to the top of the naviframe stack (and show it).
26713     *
26714     * @param obj The naviframe object
26715     * @param title_label The label in the title area. The name of the title
26716     *        label part is "elm.text.title"
26717     * @param prev_btn The button to go to the previous item. If it is NULL,
26718     *        then naviframe will create a back button automatically. The name of
26719     *        the prev_btn part is "elm.swallow.prev_btn"
26720     * @param next_btn The button to go to the next item. Or It could be just an
26721     *        extra function button. The name of the next_btn part is
26722     *        "elm.swallow.next_btn"
26723     * @param content The main content object. The name of content part is
26724     *        "elm.swallow.content"
26725     * @param item_style The current item style name. @c NULL would be default.
26726     * @return The created item or @c NULL upon failure.
26727     *
26728     * The item pushed becomes one page of the naviframe, this item will be
26729     * deleted when it is popped.
26730     *
26731     * @see also elm_naviframe_item_style_set()
26732     *
26733     * The following styles are available for this item:
26734     * @li @c "default"
26735     */
26736    EAPI Elm_Object_Item    *elm_naviframe_item_push(Evas_Object *obj, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
26737    /**
26738     * @brief Pop an item that is on top of the stack
26739     *
26740     * @param obj The naviframe object
26741     * @return @c NULL or the content object(if the
26742     *         elm_naviframe_content_preserve_on_pop_get is true).
26743     *
26744     * This pops an item that is on the top(visible) of the naviframe, makes it
26745     * disappear, then deletes the item. The item that was underneath it on the
26746     * stack will become visible.
26747     *
26748     * @see also elm_naviframe_content_preserve_on_pop_get()
26749     */
26750    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26751    /**
26752     * @brief Pop the items between the top and the above one on the given item.
26753     *
26754     * @param it The naviframe item
26755     */
26756    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26757    /**
26758     * @brief preserve the content objects when items are popped.
26759     *
26760     * @param obj The naviframe object
26761     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
26762     *
26763     * @see also elm_naviframe_content_preserve_on_pop_get()
26764     */
26765    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26766    /**
26767     * @brief Get a value whether preserve mode is enabled or not.
26768     *
26769     * @param obj The naviframe object
26770     * @return If @c EINA_TRUE, preserve mode is enabled
26771     *
26772     * @see also elm_naviframe_content_preserve_on_pop_set()
26773     */
26774    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26775    /**
26776     * @brief Get a top item on the naviframe stack
26777     *
26778     * @param obj The naviframe object
26779     * @return The top item on the naviframe stack or @c NULL, if the stack is
26780     *         empty
26781     */
26782    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26783    /**
26784     * @brief Get a bottom item on the naviframe stack
26785     *
26786     * @param obj The naviframe object
26787     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
26788     *         empty
26789     */
26790    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26791    /**
26792     * @brief Set an item style
26793     *
26794     * @param obj The naviframe item
26795     * @param item_style The current item style name. @c NULL would be default
26796     *
26797     * The following styles are available for this item:
26798     * @li @c "default"
26799     *
26800     * @see also elm_naviframe_item_style_get()
26801     */
26802    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26803    /**
26804     * @brief Get an item style
26805     *
26806     * @param obj The naviframe item
26807     * @return The current item style name
26808     *
26809     * @see also elm_naviframe_item_style_set()
26810     */
26811    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26812    /**
26813     * @brief Show/Hide the title area
26814     *
26815     * @param it The naviframe item
26816     * @param visible If @c EINA_TRUE, title area will be visible, hidden
26817     *        otherwise
26818     *
26819     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
26820     *
26821     * @see also elm_naviframe_item_title_visible_get()
26822     */
26823    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26824    /**
26825     * @brief Get a value whether title area is visible or not.
26826     *
26827     * @param it The naviframe item
26828     * @return If @c EINA_TRUE, title area is visible
26829     *
26830     * @see also elm_naviframe_item_title_visible_set()
26831     */
26832    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26833
26834    /**
26835     * @}
26836     */
26837
26838 #ifdef __cplusplus
26839 }
26840 #endif
26841
26842 #endif