and now add a "clicked" say... when u click.
[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 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 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
297 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
298 contact with the developers and maintainers.
299  */
300
301 #ifndef ELEMENTARY_H
302 #define ELEMENTARY_H
303
304 /**
305  * @file Elementary.h
306  * @brief Elementary's API
307  *
308  * Elementary API.
309  */
310
311 @ELM_UNIX_DEF@ ELM_UNIX
312 @ELM_WIN32_DEF@ ELM_WIN32
313 @ELM_WINCE_DEF@ ELM_WINCE
314 @ELM_EDBUS_DEF@ ELM_EDBUS
315 @ELM_EFREET_DEF@ ELM_EFREET
316 @ELM_ETHUMB_DEF@ ELM_ETHUMB
317 @ELM_EMAP_DEF@ ELM_EMAP
318 @ELM_DEBUG_DEF@ ELM_DEBUG
319 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
320 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321
322 /* Standard headers for standard system calls etc. */
323 #include <stdio.h>
324 #include <stdlib.h>
325 #include <unistd.h>
326 #include <string.h>
327 #include <sys/types.h>
328 #include <sys/stat.h>
329 #include <sys/time.h>
330 #include <sys/param.h>
331 #include <dlfcn.h>
332 #include <math.h>
333 #include <fnmatch.h>
334 #include <limits.h>
335 #include <ctype.h>
336 #include <time.h>
337 #include <dirent.h>
338 #include <pwd.h>
339 #include <errno.h>
340
341 #ifdef ELM_UNIX
342 # include <locale.h>
343 # ifdef ELM_LIBINTL_H
344 #  include <libintl.h>
345 # endif
346 # include <signal.h>
347 # include <grp.h>
348 # include <glob.h>
349 #endif
350
351 #ifdef ELM_ALLOCA_H
352 # include <alloca.h>
353 #endif
354
355 #if defined (ELM_WIN32) || defined (ELM_WINCE)
356 # include <malloc.h>
357 # ifndef alloca
358 #  define alloca _alloca
359 # endif
360 #endif
361
362
363 /* EFL headers */
364 #include <Eina.h>
365 #include <Eet.h>
366 #include <Evas.h>
367 #include <Evas_GL.h>
368 #include <Ecore.h>
369 #include <Ecore_Evas.h>
370 #include <Ecore_File.h>
371 #include <Ecore_IMF.h>
372 #include <Ecore_Con.h>
373 #include <Edje.h>
374
375 #ifdef ELM_EDBUS
376 # include <E_DBus.h>
377 #endif
378
379 #ifdef ELM_EFREET
380 # include <Efreet.h>
381 # include <Efreet_Mime.h>
382 # include <Efreet_Trash.h>
383 #endif
384
385 #ifdef ELM_ETHUMB
386 # include <Ethumb_Client.h>
387 #endif
388
389 #ifdef ELM_EMAP
390 # include <EMap.h>
391 #endif
392
393 #ifdef EAPI
394 # undef EAPI
395 #endif
396
397 #ifdef _WIN32
398 # ifdef ELEMENTARY_BUILD
399 #  ifdef DLL_EXPORT
400 #   define EAPI __declspec(dllexport)
401 #  else
402 #   define EAPI
403 #  endif /* ! DLL_EXPORT */
404 # else
405 #  define EAPI __declspec(dllimport)
406 # endif /* ! EFL_EVAS_BUILD */
407 #else
408 # ifdef __GNUC__
409 #  if __GNUC__ >= 4
410 #   define EAPI __attribute__ ((visibility("default")))
411 #  else
412 #   define EAPI
413 #  endif
414 # else
415 #  define EAPI
416 # endif
417 #endif /* ! _WIN32 */
418
419
420 /* allow usage from c++ */
421 #ifdef __cplusplus
422 extern "C" {
423 #endif
424
425 #define ELM_VERSION_MAJOR @VMAJ@
426 #define ELM_VERSION_MINOR @VMIN@
427
428    typedef struct _Elm_Version
429      {
430         int major;
431         int minor;
432         int micro;
433         int revision;
434      } Elm_Version;
435
436    EAPI extern Elm_Version *elm_version;
437
438 /* handy macros */
439 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
440 #define ELM_PI 3.14159265358979323846
441
442    /**
443     * @defgroup General General
444     *
445     * @brief General Elementary API. Functions that don't relate to
446     * Elementary objects specifically.
447     *
448     * Here are documented functions which init/shutdown the library,
449     * that apply to generic Elementary objects, that deal with
450     * configuration, et cetera.
451     *
452     * @ref general_functions_example_page "This" example contemplates
453     * some of these functions.
454     */
455
456    /**
457     * @addtogroup General
458     * @{
459     */
460
461   /**
462    * Defines couple of standard Evas_Object layers to be used
463    * with evas_object_layer_set().
464    *
465    * @note whenever extending with new values, try to keep some padding
466    *       to siblings so there is room for further extensions.
467    */
468   typedef enum _Elm_Object_Layer
469     {
470        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
471        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
472        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
473        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
474        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
475        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
476     } Elm_Object_Layer;
477
478 /**************************************************************************/
479    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
480
481    /**
482     * Emitted when any Elementary's policy value is changed.
483     */
484    EAPI extern int ELM_EVENT_POLICY_CHANGED;
485
486    /**
487     * @typedef Elm_Event_Policy_Changed
488     *
489     * Data on the event when an Elementary policy has changed
490     */
491     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
492
493    /**
494     * @struct _Elm_Event_Policy_Changed
495     *
496     * Data on the event when an Elementary policy has changed
497     */
498     struct _Elm_Event_Policy_Changed
499      {
500         unsigned int policy; /**< the policy identifier */
501         int          new_value; /**< value the policy had before the change */
502         int          old_value; /**< new value the policy got */
503     };
504
505    /**
506     * Policy identifiers.
507     */
508     typedef enum _Elm_Policy
509     {
510         ELM_POLICY_QUIT, /**< under which circumstances the application
511                           * should quit automatically. @see
512                           * Elm_Policy_Quit.
513                           */
514         ELM_POLICY_LAST
515     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
516  */
517
518    typedef enum _Elm_Policy_Quit
519      {
520         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
521                                    * automatically */
522         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
523                                             * application's last
524                                             * window is closed */
525      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
526
527    typedef enum _Elm_Focus_Direction
528      {
529         ELM_FOCUS_PREVIOUS,
530         ELM_FOCUS_NEXT
531      } Elm_Focus_Direction;
532
533    typedef enum _Elm_Text_Format
534      {
535         ELM_TEXT_FORMAT_PLAIN_UTF8,
536         ELM_TEXT_FORMAT_MARKUP_UTF8
537      } Elm_Text_Format;
538
539    /**
540     * Line wrapping types.
541     */
542    typedef enum _Elm_Wrap_Type
543      {
544         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
545         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
546         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
547         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
548         ELM_WRAP_LAST
549      } Elm_Wrap_Type;
550
551    /**
552     * @typedef Elm_Object_Item
553     * An Elementary Object item handle.
554     * @ingroup General
555     */
556    typedef struct _Elm_Object_Item Elm_Object_Item;
557
558
559    /**
560     * Called back when a widget's tooltip is activated and needs content.
561     * @param data user-data given to elm_object_tooltip_content_cb_set()
562     * @param obj owner widget.
563     * @param tooltip The tooltip object (affix content to this!)
564     */
565    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
566
567    /**
568     * Called back when a widget's item tooltip is activated and needs content.
569     * @param data user-data given to elm_object_tooltip_content_cb_set()
570     * @param obj owner widget.
571     * @param tooltip The tooltip object (affix content to this!)
572     * @param item context dependent item. As an example, if tooltip was
573     *        set on Elm_List_Item, then it is of this type.
574     */
575    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
576
577    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. */
578
579 #ifndef ELM_LIB_QUICKLAUNCH
580 #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 */
581 #else
582 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
583 #endif
584
585 /**************************************************************************/
586    /* General calls */
587
588    /**
589     * Initialize Elementary
590     *
591     * @param[in] argc System's argument count value
592     * @param[in] argv System's pointer to array of argument strings
593     * @return The init counter value.
594     *
595     * This function initializes Elementary and increments a counter of
596     * the number of calls to it. It returns the new counter's value.
597     *
598     * @warning This call is exported only for use by the @c ELM_MAIN()
599     * macro. There is no need to use this if you use this macro (which
600     * is highly advisable). An elm_main() should contain the entry
601     * point code for your application, having the same prototype as
602     * elm_init(), and @b not being static (putting the @c EAPI symbol
603     * in front of its type declaration is advisable). The @c
604     * ELM_MAIN() call should be placed just after it.
605     *
606     * Example:
607     * @dontinclude bg_example_01.c
608     * @skip static void
609     * @until ELM_MAIN
610     *
611     * See the full @ref bg_example_01_c "example".
612     *
613     * @see elm_shutdown().
614     * @ingroup General
615     */
616    EAPI int          elm_init(int argc, char **argv);
617
618    /**
619     * Shut down Elementary
620     *
621     * @return The init counter value.
622     *
623     * This should be called at the end of your application, just
624     * before it ceases to do any more processing. This will clean up
625     * any permanent resources your application may have allocated via
626     * Elementary that would otherwise persist.
627     *
628     * @see elm_init() for an example
629     *
630     * @ingroup General
631     */
632    EAPI int          elm_shutdown(void);
633
634    /**
635     * Run Elementary's main loop
636     *
637     * This call should be issued just after all initialization is
638     * completed. This function will not return until elm_exit() is
639     * called. It will keep looping, running the main
640     * (event/processing) loop for Elementary.
641     *
642     * @see elm_init() for an example
643     *
644     * @ingroup General
645     */
646    EAPI void         elm_run(void);
647
648    /**
649     * Exit Elementary's main loop
650     *
651     * If this call is issued, it will flag the main loop to cease
652     * processing and return back to its parent function (usually your
653     * elm_main() function).
654     *
655     * @see elm_init() for an example. There, just after a request to
656     * close the window comes, the main loop will be left.
657     *
658     * @note By using the #ELM_POLICY_QUIT on your Elementary
659     * applications, you'll this function called automatically for you.
660     *
661     * @ingroup General
662     */
663    EAPI void         elm_exit(void);
664
665    /**
666     * Provide information in order to make Elementary determine the @b
667     * run time location of the software in question, so other data files
668     * such as images, sound files, executable utilities, libraries,
669     * modules and locale files can be found.
670     *
671     * @param mainfunc This is your application's main function name,
672     *        whose binary's location is to be found. Providing @c NULL
673     *        will make Elementary not to use it
674     * @param dom This will be used as the application's "domain", in the
675     *        form of a prefix to any environment variables that may
676     *        override prefix detection and the directory name, inside the
677     *        standard share or data directories, where the software's
678     *        data files will be looked for.
679     * @param checkfile This is an (optional) magic file's path to check
680     *        for existence (and it must be located in the data directory,
681     *        under the share directory provided above). Its presence will
682     *        help determine the prefix found was correct. Pass @c NULL if
683     *        the check is not to be done.
684     *
685     * This function allows one to re-locate the application somewhere
686     * else after compilation, if the developer wishes for easier
687     * distribution of pre-compiled binaries.
688     *
689     * The prefix system is designed to locate where the given software is
690     * installed (under a common path prefix) at run time and then report
691     * specific locations of this prefix and common directories inside
692     * this prefix like the binary, library, data and locale directories,
693     * through the @c elm_app_*_get() family of functions.
694     *
695     * Call elm_app_info_set() early on before you change working
696     * directory or anything about @c argv[0], so it gets accurate
697     * information.
698     *
699     * It will then try and trace back which file @p mainfunc comes from,
700     * if provided, to determine the application's prefix directory.
701     *
702     * The @p dom parameter provides a string prefix to prepend before
703     * environment variables, allowing a fallback to @b specific
704     * environment variables to locate the software. You would most
705     * probably provide a lowercase string there, because it will also
706     * serve as directory domain, explained next. For environment
707     * variables purposes, this string is made uppercase. For example if
708     * @c "myapp" is provided as the prefix, then the program would expect
709     * @c "MYAPP_PREFIX" as a master environment variable to specify the
710     * exact install prefix for the software, or more specific environment
711     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
712     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
713     * the user or scripts before launching. If not provided (@c NULL),
714     * environment variables will not be used to override compiled-in
715     * defaults or auto detections.
716     *
717     * The @p dom string also provides a subdirectory inside the system
718     * shared data directory for data files. For example, if the system
719     * directory is @c /usr/local/share, then this directory name is
720     * appended, creating @c /usr/local/share/myapp, if it @p was @c
721     * "myapp". It is expected the application installs data files in
722     * this directory.
723     *
724     * The @p checkfile is a file name or path of something inside the
725     * share or data directory to be used to test that the prefix
726     * detection worked. For example, your app will install a wallpaper
727     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
728     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
729     * checkfile string.
730     *
731     * @see elm_app_compile_bin_dir_set()
732     * @see elm_app_compile_lib_dir_set()
733     * @see elm_app_compile_data_dir_set()
734     * @see elm_app_compile_locale_set()
735     * @see elm_app_prefix_dir_get()
736     * @see elm_app_bin_dir_get()
737     * @see elm_app_lib_dir_get()
738     * @see elm_app_data_dir_get()
739     * @see elm_app_locale_dir_get()
740     */
741    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
742
743    /**
744     * Provide information on the @b fallback application's binaries
745     * directory, on scenarios where they get overriden by
746     * elm_app_info_set().
747     *
748     * @param dir The path to the default binaries directory (compile time
749     * one)
750     *
751     * @note Elementary will as well use this path to determine actual
752     * names of binaries' directory paths, maybe changing it to be @c
753     * something/local/bin instead of @c something/bin, only, for
754     * example.
755     *
756     * @warning You should call this function @b before
757     * elm_app_info_set().
758     */
759    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
760
761    /**
762     * Provide information on the @b fallback application's libraries
763     * directory, on scenarios where they get overriden by
764     * elm_app_info_set().
765     *
766     * @param dir The path to the default libraries directory (compile
767     * time one)
768     *
769     * @note Elementary will as well use this path to determine actual
770     * names of libraries' directory paths, maybe changing it to be @c
771     * something/lib32 or @c something/lib64 instead of @c something/lib,
772     * only, for example.
773     *
774     * @warning You should call this function @b before
775     * elm_app_info_set().
776     */
777    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
778
779    /**
780     * Provide information on the @b fallback application's data
781     * directory, on scenarios where they get overriden by
782     * elm_app_info_set().
783     *
784     * @param dir The path to the default data directory (compile time
785     * one)
786     *
787     * @note Elementary will as well use this path to determine actual
788     * names of data directory paths, maybe changing it to be @c
789     * something/local/share instead of @c something/share, only, for
790     * example.
791     *
792     * @warning You should call this function @b before
793     * elm_app_info_set().
794     */
795    EAPI void         elm_app_compile_data_dir_set(const char *dir);
796
797    /**
798     * Provide information on the @b fallback application's locale
799     * directory, on scenarios where they get overriden by
800     * elm_app_info_set().
801     *
802     * @param dir The path to the default locale directory (compile time
803     * one)
804     *
805     * @warning You should call this function @b before
806     * elm_app_info_set().
807     */
808    EAPI void         elm_app_compile_locale_set(const char *dir);
809
810    /**
811     * Retrieve the application's run time prefix directory, as set by
812     * elm_app_info_set() and the way (environment) the application was
813     * run from.
814     *
815     * @return The directory prefix the application is actually using
816     */
817    EAPI const char  *elm_app_prefix_dir_get(void);
818
819    /**
820     * Retrieve the application's run time binaries prefix directory, as
821     * set by elm_app_info_set() and the way (environment) the application
822     * was run from.
823     *
824     * @return The binaries directory prefix the application is actually
825     * using
826     */
827    EAPI const char  *elm_app_bin_dir_get(void);
828
829    /**
830     * Retrieve the application's run time libraries prefix directory, as
831     * set by elm_app_info_set() and the way (environment) the application
832     * was run from.
833     *
834     * @return The libraries directory prefix the application is actually
835     * using
836     */
837    EAPI const char  *elm_app_lib_dir_get(void);
838
839    /**
840     * Retrieve the application's run time data prefix directory, as
841     * set by elm_app_info_set() and the way (environment) the application
842     * was run from.
843     *
844     * @return The data directory prefix the application is actually
845     * using
846     */
847    EAPI const char  *elm_app_data_dir_get(void);
848
849    /**
850     * Retrieve the application's run time locale prefix directory, as
851     * set by elm_app_info_set() and the way (environment) the application
852     * was run from.
853     *
854     * @return The locale directory prefix the application is actually
855     * using
856     */
857    EAPI const char  *elm_app_locale_dir_get(void);
858
859    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
860    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
861    EAPI int          elm_quicklaunch_init(int argc, char **argv);
862    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
863    EAPI int          elm_quicklaunch_sub_shutdown(void);
864    EAPI int          elm_quicklaunch_shutdown(void);
865    EAPI void         elm_quicklaunch_seed(void);
866    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
867    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
868    EAPI void         elm_quicklaunch_cleanup(void);
869    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
870    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
871
872    EAPI Eina_Bool    elm_need_efreet(void);
873    EAPI Eina_Bool    elm_need_e_dbus(void);
874
875    /**
876     * This must be called before any other function that handle with
877     * elm_thumb objects or ethumb_client instances.
878     *
879     * @ingroup Thumb
880     */
881    EAPI Eina_Bool    elm_need_ethumb(void);
882
883    /**
884     * Set a new policy's value (for a given policy group/identifier).
885     *
886     * @param policy policy identifier, as in @ref Elm_Policy.
887     * @param value policy value, which depends on the identifier
888     *
889     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
890     *
891     * Elementary policies define applications' behavior,
892     * somehow. These behaviors are divided in policy groups (see
893     * #Elm_Policy enumeration). This call will emit the Ecore event
894     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
895     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
896     * then.
897     *
898     * @note Currently, we have only one policy identifier/group
899     * (#ELM_POLICY_QUIT), which has two possible values.
900     *
901     * @ingroup General
902     */
903    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
904
905    /**
906     * Gets the policy value set for given policy identifier.
907     *
908     * @param policy policy identifier, as in #Elm_Policy.
909     * @return The currently set policy value, for that
910     * identifier. Will be @c 0 if @p policy passed is invalid.
911     *
912     * @ingroup General
913     */
914    EAPI int          elm_policy_get(unsigned int policy);
915
916    /**
917     * Set a label of an object
918     *
919     * @param obj The Elementary object
920     * @param part The text part name to set (NULL for the default label)
921     * @param label The new text of the label
922     *
923     * @note Elementary objects may have many labels (e.g. Action Slider)
924     *
925     * @ingroup General
926     */
927    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
928
929 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
930
931    /**
932     * Get a label of an object
933     *
934     * @param obj The Elementary object
935     * @param part The text part name to get (NULL for the default label)
936     * @return text of the label or NULL for any error
937     *
938     * @note Elementary objects may have many labels (e.g. Action Slider)
939     *
940     * @ingroup General
941     */
942    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
943
944 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
945
946    /**
947     * Set a content of an object
948     *
949     * @param obj The Elementary object
950     * @param part The content part name to set (NULL for the default content)
951     * @param content The new content of the object
952     *
953     * @note Elementary objects may have many contents
954     *
955     * @ingroup General
956     */
957    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
958
959 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
960
961    /**
962     * Get a content of an object
963     *
964     * @param obj The Elementary object
965     * @param item The content part name to get (NULL for the default content)
966     * @return content of the object or NULL for any error
967     *
968     * @note Elementary objects may have many contents
969     *
970     * @ingroup General
971     */
972    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
973
974 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
975
976    /**
977     * Unset a content of an object
978     *
979     * @param obj The Elementary object
980     * @param item The content part name to unset (NULL for the default content)
981     *
982     * @note Elementary objects may have many contents
983     *
984     * @ingroup General
985     */
986    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
987
988 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
989
990    /**
991     * Set a content of an object item
992     *
993     * @param it The Elementary object item
994     * @param part The content part name to unset (NULL for the default content)
995     * @param content The new content of the object item
996     *
997     * @note Elementary object items may have many contents
998     *
999     * @ingroup General
1000     */
1001    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1002
1003 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1004
1005    /**
1006     * Get a content of an object item
1007     *
1008     * @param it The Elementary object item
1009     * @param part The content part name to unset (NULL for the default content)
1010     * @return content of the object item or NULL for any error
1011     *
1012     * @note Elementary object items may have many contents
1013     *
1014     * @ingroup General
1015     */
1016    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1017
1018 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1019
1020    /**
1021     * Unset a content of an object item
1022     *
1023     * @param it The Elementary object item
1024     * @param part The content part name to unset (NULL for the default content)
1025     *
1026     * @note Elementary object items may have many contents
1027     *
1028     * @ingroup General
1029     */
1030    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1031
1032 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1033
1034    /**
1035     * Set a label of an objec itemt
1036     *
1037     * @param it The Elementary object item
1038     * @param part The text part name to set (NULL for the default label)
1039     * @param label The new text of the label
1040     *
1041     * @note Elementary object items may have many labels
1042     *
1043     * @ingroup General
1044     */
1045    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1046
1047 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1048
1049    /**
1050     * Get a label of an object
1051     *
1052     * @param it The Elementary object item
1053     * @param part The text part name to get (NULL for the default label)
1054     * @return text of the label or NULL for any error
1055     *
1056     * @note Elementary object items may have many labels
1057     *
1058     * @ingroup General
1059     */
1060    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1061
1062    /**
1063     * Set the text to read out when in accessibility mode
1064     *
1065     * @param obj The object which is described
1066     * @param txt The text that describes the widget to people with poor or no vision
1067     *
1068     * @ingroup General
1069     */
1070    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1071
1072 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1073
1074    /**
1075     * @}
1076     */
1077
1078    /**
1079     * @defgroup Caches Caches
1080     *
1081     * These are functions which let one fine-tune some cache values for
1082     * Elementary applications, thus allowing for performance adjustments.
1083     *
1084     * @{
1085     */
1086
1087    /**
1088     * @brief Flush all caches.
1089     *
1090     * Frees all data that was in cache and is not currently being used to reduce
1091     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1092     * to calling all of the following functions:
1093     * @li edje_file_cache_flush()
1094     * @li edje_collection_cache_flush()
1095     * @li eet_clearcache()
1096     * @li evas_image_cache_flush()
1097     * @li evas_font_cache_flush()
1098     * @li evas_render_dump()
1099     * @note Evas caches are flushed for every canvas associated with a window.
1100     *
1101     * @ingroup Caches
1102     */
1103    EAPI void         elm_all_flush(void);
1104
1105    /**
1106     * Get the configured cache flush interval time
1107     *
1108     * This gets the globally configured cache flush interval time, in
1109     * ticks
1110     *
1111     * @return The cache flush interval time
1112     * @ingroup Caches
1113     *
1114     * @see elm_all_flush()
1115     */
1116    EAPI int          elm_cache_flush_interval_get(void);
1117
1118    /**
1119     * Set the configured cache flush interval time
1120     *
1121     * This sets the globally configured cache flush interval time, in ticks
1122     *
1123     * @param size The cache flush interval time
1124     * @ingroup Caches
1125     *
1126     * @see elm_all_flush()
1127     */
1128    EAPI void         elm_cache_flush_interval_set(int size);
1129
1130    /**
1131     * Set the configured cache flush interval time for all applications on the
1132     * display
1133     *
1134     * This sets the globally configured cache flush interval time -- in ticks
1135     * -- for all applications on the display.
1136     *
1137     * @param size The cache flush interval time
1138     * @ingroup Caches
1139     */
1140    EAPI void         elm_cache_flush_interval_all_set(int size);
1141
1142    /**
1143     * Get the configured cache flush enabled state
1144     *
1145     * This gets the globally configured cache flush state - if it is enabled
1146     * or not. When cache flushing is enabled, elementary will regularly
1147     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1148     * memory and allow usage to re-seed caches and data in memory where it
1149     * can do so. An idle application will thus minimise its memory usage as
1150     * data will be freed from memory and not be re-loaded as it is idle and
1151     * not rendering or doing anything graphically right now.
1152     *
1153     * @return The cache flush state
1154     * @ingroup Caches
1155     *
1156     * @see elm_all_flush()
1157     */
1158    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1159
1160    /**
1161     * Set the configured cache flush enabled state
1162     *
1163     * This sets the globally configured cache flush enabled state
1164     *
1165     * @param size The cache flush enabled state
1166     * @ingroup Caches
1167     *
1168     * @see elm_all_flush()
1169     */
1170    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1171
1172    /**
1173     * Set the configured cache flush enabled state for all applications on the
1174     * display
1175     *
1176     * This sets the globally configured cache flush enabled state for all
1177     * applications on the display.
1178     *
1179     * @param size The cache flush enabled state
1180     * @ingroup Caches
1181     */
1182    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1183
1184    /**
1185     * Get the configured font cache size
1186     *
1187     * This gets the globally configured font cache size, in bytes
1188     *
1189     * @return The font cache size
1190     * @ingroup Caches
1191     */
1192    EAPI int          elm_font_cache_get(void);
1193
1194    /**
1195     * Set the configured font cache size
1196     *
1197     * This sets the globally configured font cache size, in bytes
1198     *
1199     * @param size The font cache size
1200     * @ingroup Caches
1201     */
1202    EAPI void         elm_font_cache_set(int size);
1203
1204    /**
1205     * Set the configured font cache size for all applications on the
1206     * display
1207     *
1208     * This sets the globally configured font cache size -- in bytes
1209     * -- for all applications on the display.
1210     *
1211     * @param size The font cache size
1212     * @ingroup Caches
1213     */
1214    EAPI void         elm_font_cache_all_set(int size);
1215
1216    /**
1217     * Get the configured image cache size
1218     *
1219     * This gets the globally configured image cache size, in bytes
1220     *
1221     * @return The image cache size
1222     * @ingroup Caches
1223     */
1224    EAPI int          elm_image_cache_get(void);
1225
1226    /**
1227     * Set the configured image cache size
1228     *
1229     * This sets the globally configured image cache size, in bytes
1230     *
1231     * @param size The image cache size
1232     * @ingroup Caches
1233     */
1234    EAPI void         elm_image_cache_set(int size);
1235
1236    /**
1237     * Set the configured image cache size for all applications on the
1238     * display
1239     *
1240     * This sets the globally configured image cache size -- in bytes
1241     * -- for all applications on the display.
1242     *
1243     * @param size The image cache size
1244     * @ingroup Caches
1245     */
1246    EAPI void         elm_image_cache_all_set(int size);
1247
1248    /**
1249     * Get the configured edje file cache size.
1250     *
1251     * This gets the globally configured edje file cache size, in number
1252     * of files.
1253     *
1254     * @return The edje file cache size
1255     * @ingroup Caches
1256     */
1257    EAPI int          elm_edje_file_cache_get(void);
1258
1259    /**
1260     * Set the configured edje file cache size
1261     *
1262     * This sets the globally configured edje file cache size, in number
1263     * of files.
1264     *
1265     * @param size The edje file cache size
1266     * @ingroup Caches
1267     */
1268    EAPI void         elm_edje_file_cache_set(int size);
1269
1270    /**
1271     * Set the configured edje file cache size for all applications on the
1272     * display
1273     *
1274     * This sets the globally configured edje file cache size -- in number
1275     * of files -- for all applications on the display.
1276     *
1277     * @param size The edje file cache size
1278     * @ingroup Caches
1279     */
1280    EAPI void         elm_edje_file_cache_all_set(int size);
1281
1282    /**
1283     * Get the configured edje collections (groups) cache size.
1284     *
1285     * This gets the globally configured edje collections cache size, in
1286     * number of collections.
1287     *
1288     * @return The edje collections cache size
1289     * @ingroup Caches
1290     */
1291    EAPI int          elm_edje_collection_cache_get(void);
1292
1293    /**
1294     * Set the configured edje collections (groups) cache size
1295     *
1296     * This sets the globally configured edje collections cache size, in
1297     * number of collections.
1298     *
1299     * @param size The edje collections cache size
1300     * @ingroup Caches
1301     */
1302    EAPI void         elm_edje_collection_cache_set(int size);
1303
1304    /**
1305     * Set the configured edje collections (groups) cache size for all
1306     * applications on the display
1307     *
1308     * This sets the globally configured edje collections cache size -- in
1309     * number of collections -- for all applications on the display.
1310     *
1311     * @param size The edje collections cache size
1312     * @ingroup Caches
1313     */
1314    EAPI void         elm_edje_collection_cache_all_set(int size);
1315
1316    /**
1317     * @}
1318     */
1319
1320    /**
1321     * @defgroup Scaling Widget Scaling
1322     *
1323     * Different widgets can be scaled independently. These functions
1324     * allow you to manipulate this scaling on a per-widget basis. The
1325     * object and all its children get their scaling factors multiplied
1326     * by the scale factor set. This is multiplicative, in that if a
1327     * child also has a scale size set it is in turn multiplied by its
1328     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1329     * double size, @c 0.5 is half, etc.
1330     *
1331     * @ref general_functions_example_page "This" example contemplates
1332     * some of these functions.
1333     */
1334
1335    /**
1336     * Get the global scaling factor
1337     *
1338     * This gets the globally configured scaling factor that is applied to all
1339     * objects.
1340     *
1341     * @return The scaling factor
1342     * @ingroup Scaling
1343     */
1344    EAPI double       elm_scale_get(void);
1345
1346    /**
1347     * Set the global scaling factor
1348     *
1349     * This sets the globally configured scaling factor that is applied to all
1350     * objects.
1351     *
1352     * @param scale The scaling factor to set
1353     * @ingroup Scaling
1354     */
1355    EAPI void         elm_scale_set(double scale);
1356
1357    /**
1358     * Set the global scaling factor for all applications on the display
1359     *
1360     * This sets the globally configured scaling factor that is applied to all
1361     * objects for all applications.
1362     * @param scale The scaling factor to set
1363     * @ingroup Scaling
1364     */
1365    EAPI void         elm_scale_all_set(double scale);
1366
1367    /**
1368     * Set the scaling factor for a given Elementary object
1369     *
1370     * @param obj The Elementary to operate on
1371     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1372     * no scaling)
1373     *
1374     * @ingroup Scaling
1375     */
1376    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1377
1378    /**
1379     * Get the scaling factor for a given Elementary object
1380     *
1381     * @param obj The object
1382     * @return The scaling factor set by elm_object_scale_set()
1383     *
1384     * @ingroup Scaling
1385     */
1386    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1387
1388    /**
1389     * @defgroup UI-Mirroring Selective Widget mirroring
1390     *
1391     * These functions allow you to set ui-mirroring on specific
1392     * widgets or the whole interface. Widgets can be in one of two
1393     * modes, automatic and manual.  Automatic means they'll be changed
1394     * according to the system mirroring mode and manual means only
1395     * explicit changes will matter. You are not supposed to change
1396     * mirroring state of a widget set to automatic, will mostly work,
1397     * but the behavior is not really defined.
1398     *
1399     * @{
1400     */
1401
1402    EAPI Eina_Bool    elm_mirrored_get(void);
1403    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1404
1405    /**
1406     * Get the system mirrored mode. This determines the default mirrored mode
1407     * of widgets.
1408     *
1409     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1410     */
1411    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1412
1413    /**
1414     * Set the system mirrored mode. This determines the default mirrored mode
1415     * of widgets.
1416     *
1417     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1418     */
1419    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1420
1421    /**
1422     * Returns the widget's mirrored mode setting.
1423     *
1424     * @param obj The widget.
1425     * @return mirrored mode setting of the object.
1426     *
1427     **/
1428    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1429
1430    /**
1431     * Sets the widget's mirrored mode setting.
1432     * When widget in automatic mode, it follows the system mirrored mode set by
1433     * elm_mirrored_set().
1434     * @param obj The widget.
1435     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1436     */
1437    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1438
1439    /**
1440     * @}
1441     */
1442
1443    /**
1444     * Set the style to use by a widget
1445     *
1446     * Sets the style name that will define the appearance of a widget. Styles
1447     * vary from widget to widget and may also be defined by other themes
1448     * by means of extensions and overlays.
1449     *
1450     * @param obj The Elementary widget to style
1451     * @param style The style name to use
1452     *
1453     * @see elm_theme_extension_add()
1454     * @see elm_theme_extension_del()
1455     * @see elm_theme_overlay_add()
1456     * @see elm_theme_overlay_del()
1457     *
1458     * @ingroup Styles
1459     */
1460    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1461    /**
1462     * Get the style used by the widget
1463     *
1464     * This gets the style being used for that widget. Note that the string
1465     * pointer is only valid as longas the object is valid and the style doesn't
1466     * change.
1467     *
1468     * @param obj The Elementary widget to query for its style
1469     * @return The style name used
1470     *
1471     * @see elm_object_style_set()
1472     *
1473     * @ingroup Styles
1474     */
1475    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1476
1477    /**
1478     * @defgroup Styles Styles
1479     *
1480     * Widgets can have different styles of look. These generic API's
1481     * set styles of widgets, if they support them (and if the theme(s)
1482     * do).
1483     *
1484     * @ref general_functions_example_page "This" example contemplates
1485     * some of these functions.
1486     */
1487
1488    /**
1489     * Set the disabled state of an Elementary object.
1490     *
1491     * @param obj The Elementary object to operate on
1492     * @param disabled The state to put in in: @c EINA_TRUE for
1493     *        disabled, @c EINA_FALSE for enabled
1494     *
1495     * Elementary objects can be @b disabled, in which state they won't
1496     * receive input and, in general, will be themed differently from
1497     * their normal state, usually greyed out. Useful for contexts
1498     * where you don't want your users to interact with some of the
1499     * parts of you interface.
1500     *
1501     * This sets the state for the widget, either disabling it or
1502     * enabling it back.
1503     *
1504     * @ingroup Styles
1505     */
1506    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1507
1508    /**
1509     * Get the disabled state of an Elementary object.
1510     *
1511     * @param obj The Elementary object to operate on
1512     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1513     *            if it's enabled (or on errors)
1514     *
1515     * This gets the state of the widget, which might be enabled or disabled.
1516     *
1517     * @ingroup Styles
1518     */
1519    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1520
1521    /**
1522     * @defgroup WidgetNavigation Widget Tree Navigation.
1523     *
1524     * How to check if an Evas Object is an Elementary widget? How to
1525     * get the first elementary widget that is parent of the given
1526     * object?  These are all covered in widget tree navigation.
1527     *
1528     * @ref general_functions_example_page "This" example contemplates
1529     * some of these functions.
1530     */
1531
1532    /**
1533     * Check if the given Evas Object is an Elementary widget.
1534     *
1535     * @param obj the object to query.
1536     * @return @c EINA_TRUE if it is an elementary widget variant,
1537     *         @c EINA_FALSE otherwise
1538     * @ingroup WidgetNavigation
1539     */
1540    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1541
1542    /**
1543     * Get the first parent of the given object that is an Elementary
1544     * widget.
1545     *
1546     * @param obj the Elementary object to query parent from.
1547     * @return the parent object that is an Elementary widget, or @c
1548     *         NULL, if it was not found.
1549     *
1550     * Use this to query for an object's parent widget.
1551     *
1552     * @note Most of Elementary users wouldn't be mixing non-Elementary
1553     * smart objects in the objects tree of an application, as this is
1554     * an advanced usage of Elementary with Evas. So, except for the
1555     * application's window, which is the root of that tree, all other
1556     * objects would have valid Elementary widget parents.
1557     *
1558     * @ingroup WidgetNavigation
1559     */
1560    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1561
1562    /**
1563     * Get the top level parent of an Elementary widget.
1564     *
1565     * @param obj The object to query.
1566     * @return The top level Elementary widget, or @c NULL if parent cannot be
1567     * found.
1568     * @ingroup WidgetNavigation
1569     */
1570    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1571
1572    /**
1573     * Get the string that represents this Elementary widget.
1574     *
1575     * @note Elementary is weird and exposes itself as a single
1576     *       Evas_Object_Smart_Class of type "elm_widget", so
1577     *       evas_object_type_get() always return that, making debug and
1578     *       language bindings hard. This function tries to mitigate this
1579     *       problem, but the solution is to change Elementary to use
1580     *       proper inheritance.
1581     *
1582     * @param obj the object to query.
1583     * @return Elementary widget name, or @c NULL if not a valid widget.
1584     * @ingroup WidgetNavigation
1585     */
1586    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1587
1588    /**
1589     * @defgroup Config Elementary Config
1590     *
1591     * Elementary configuration is formed by a set options bounded to a
1592     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1593     * "finger size", etc. These are functions with which one syncronizes
1594     * changes made to those values to the configuration storing files, de
1595     * facto. You most probably don't want to use the functions in this
1596     * group unlees you're writing an elementary configuration manager.
1597     *
1598     * @{
1599     */
1600
1601    /**
1602     * Save back Elementary's configuration, so that it will persist on
1603     * future sessions.
1604     *
1605     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1606     * @ingroup Config
1607     *
1608     * This function will take effect -- thus, do I/O -- immediately. Use
1609     * it when you want to apply all configuration changes at once. The
1610     * current configuration set will get saved onto the current profile
1611     * configuration file.
1612     *
1613     */
1614    EAPI Eina_Bool    elm_config_save(void);
1615
1616    /**
1617     * Reload Elementary's configuration, bounded to current selected
1618     * profile.
1619     *
1620     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1621     * @ingroup Config
1622     *
1623     * Useful when you want to force reloading of configuration values for
1624     * a profile. If one removes user custom configuration directories,
1625     * for example, it will force a reload with system values insted.
1626     *
1627     */
1628    EAPI void         elm_config_reload(void);
1629
1630    /**
1631     * @}
1632     */
1633
1634    /**
1635     * @defgroup Profile Elementary Profile
1636     *
1637     * Profiles are pre-set options that affect the whole look-and-feel of
1638     * Elementary-based applications. There are, for example, profiles
1639     * aimed at desktop computer applications and others aimed at mobile,
1640     * touchscreen-based ones. You most probably don't want to use the
1641     * functions in this group unlees you're writing an elementary
1642     * configuration manager.
1643     *
1644     * @{
1645     */
1646
1647    /**
1648     * Get Elementary's profile in use.
1649     *
1650     * This gets the global profile that is applied to all Elementary
1651     * applications.
1652     *
1653     * @return The profile's name
1654     * @ingroup Profile
1655     */
1656    EAPI const char  *elm_profile_current_get(void);
1657
1658    /**
1659     * Get an Elementary's profile directory path in the filesystem. One
1660     * may want to fetch a system profile's dir or an user one (fetched
1661     * inside $HOME).
1662     *
1663     * @param profile The profile's name
1664     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1665     *                or a system one (@c EINA_FALSE)
1666     * @return The profile's directory path.
1667     * @ingroup Profile
1668     *
1669     * @note You must free it with elm_profile_dir_free().
1670     */
1671    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1672
1673    /**
1674     * Free an Elementary's profile directory path, as returned by
1675     * elm_profile_dir_get().
1676     *
1677     * @param p_dir The profile's path
1678     * @ingroup Profile
1679     *
1680     */
1681    EAPI void         elm_profile_dir_free(const char *p_dir);
1682
1683    /**
1684     * Get Elementary's list of available profiles.
1685     *
1686     * @return The profiles list. List node data are the profile name
1687     *         strings.
1688     * @ingroup Profile
1689     *
1690     * @note One must free this list, after usage, with the function
1691     *       elm_profile_list_free().
1692     */
1693    EAPI Eina_List   *elm_profile_list_get(void);
1694
1695    /**
1696     * Free Elementary's list of available profiles.
1697     *
1698     * @param l The profiles list, as returned by elm_profile_list_get().
1699     * @ingroup Profile
1700     *
1701     */
1702    EAPI void         elm_profile_list_free(Eina_List *l);
1703
1704    /**
1705     * Set Elementary's profile.
1706     *
1707     * This sets the global profile that is applied to Elementary
1708     * applications. Just the process the call comes from will be
1709     * affected.
1710     *
1711     * @param profile The profile's name
1712     * @ingroup Profile
1713     *
1714     */
1715    EAPI void         elm_profile_set(const char *profile);
1716
1717    /**
1718     * Set Elementary's profile.
1719     *
1720     * This sets the global profile that is applied to all Elementary
1721     * applications. All running Elementary windows will be affected.
1722     *
1723     * @param profile The profile's name
1724     * @ingroup Profile
1725     *
1726     */
1727    EAPI void         elm_profile_all_set(const char *profile);
1728
1729    /**
1730     * @}
1731     */
1732
1733    /**
1734     * @defgroup Engine Elementary Engine
1735     *
1736     * These are functions setting and querying which rendering engine
1737     * Elementary will use for drawing its windows' pixels.
1738     *
1739     * The following are the available engines:
1740     * @li "software_x11"
1741     * @li "fb"
1742     * @li "directfb"
1743     * @li "software_16_x11"
1744     * @li "software_8_x11"
1745     * @li "xrender_x11"
1746     * @li "opengl_x11"
1747     * @li "software_gdi"
1748     * @li "software_16_wince_gdi"
1749     * @li "sdl"
1750     * @li "software_16_sdl"
1751     * @li "opengl_sdl"
1752     * @li "buffer"
1753     *
1754     * @{
1755     */
1756
1757    /**
1758     * @brief Get Elementary's rendering engine in use.
1759     *
1760     * @return The rendering engine's name
1761     * @note there's no need to free the returned string, here.
1762     *
1763     * This gets the global rendering engine that is applied to all Elementary
1764     * applications.
1765     *
1766     * @see elm_engine_set()
1767     */
1768    EAPI const char  *elm_engine_current_get(void);
1769
1770    /**
1771     * @brief Set Elementary's rendering engine for use.
1772     *
1773     * @param engine The rendering engine's name
1774     *
1775     * This sets global rendering engine that is applied to all Elementary
1776     * applications. Note that it will take effect only to Elementary windows
1777     * created after this is called.
1778     *
1779     * @see elm_win_add()
1780     */
1781    EAPI void         elm_engine_set(const char *engine);
1782
1783    /**
1784     * @}
1785     */
1786
1787    /**
1788     * @defgroup Fonts Elementary Fonts
1789     *
1790     * These are functions dealing with font rendering, selection and the
1791     * like for Elementary applications. One might fetch which system
1792     * fonts are there to use and set custom fonts for individual classes
1793     * of UI items containing text (text classes).
1794     *
1795     * @{
1796     */
1797
1798   typedef struct _Elm_Text_Class
1799     {
1800        const char *name;
1801        const char *desc;
1802     } Elm_Text_Class;
1803
1804   typedef struct _Elm_Font_Overlay
1805     {
1806        const char     *text_class;
1807        const char     *font;
1808        Evas_Font_Size  size;
1809     } Elm_Font_Overlay;
1810
1811   typedef struct _Elm_Font_Properties
1812     {
1813        const char *name;
1814        Eina_List  *styles;
1815     } Elm_Font_Properties;
1816
1817    /**
1818     * Get Elementary's list of supported text classes.
1819     *
1820     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1821     * @ingroup Fonts
1822     *
1823     * Release the list with elm_text_classes_list_free().
1824     */
1825    EAPI const Eina_List     *elm_text_classes_list_get(void);
1826
1827    /**
1828     * Free Elementary's list of supported text classes.
1829     *
1830     * @ingroup Fonts
1831     *
1832     * @see elm_text_classes_list_get().
1833     */
1834    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1835
1836    /**
1837     * Get Elementary's list of font overlays, set with
1838     * elm_font_overlay_set().
1839     *
1840     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1841     * data.
1842     *
1843     * @ingroup Fonts
1844     *
1845     * For each text class, one can set a <b>font overlay</b> for it,
1846     * overriding the default font properties for that class coming from
1847     * the theme in use. There is no need to free this list.
1848     *
1849     * @see elm_font_overlay_set() and elm_font_overlay_unset().
1850     */
1851    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1852
1853    /**
1854     * Set a font overlay for a given Elementary text class.
1855     *
1856     * @param text_class Text class name
1857     * @param font Font name and style string
1858     * @param size Font size
1859     *
1860     * @ingroup Fonts
1861     *
1862     * @p font has to be in the format returned by
1863     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1864     * and elm_font_overlay_unset().
1865     */
1866    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1867
1868    /**
1869     * Unset a font overlay for a given Elementary text class.
1870     *
1871     * @param text_class Text class name
1872     *
1873     * @ingroup Fonts
1874     *
1875     * This will bring back text elements belonging to text class
1876     * @p text_class back to their default font settings.
1877     */
1878    EAPI void                 elm_font_overlay_unset(const char *text_class);
1879
1880    /**
1881     * Apply the changes made with elm_font_overlay_set() and
1882     * elm_font_overlay_unset() on the current Elementary window.
1883     *
1884     * @ingroup Fonts
1885     *
1886     * This applies all font overlays set to all objects in the UI.
1887     */
1888    EAPI void                 elm_font_overlay_apply(void);
1889
1890    /**
1891     * Apply the changes made with elm_font_overlay_set() and
1892     * elm_font_overlay_unset() on all Elementary application windows.
1893     *
1894     * @ingroup Fonts
1895     *
1896     * This applies all font overlays set to all objects in the UI.
1897     */
1898    EAPI void                 elm_font_overlay_all_apply(void);
1899
1900    /**
1901     * Translate a font (family) name string in fontconfig's font names
1902     * syntax into an @c Elm_Font_Properties struct.
1903     *
1904     * @param font The font name and styles string
1905     * @return the font properties struct
1906     *
1907     * @ingroup Fonts
1908     *
1909     * @note The reverse translation can be achived with
1910     * elm_font_fontconfig_name_get(), for one style only (single font
1911     * instance, not family).
1912     */
1913    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1914
1915    /**
1916     * Free font properties return by elm_font_properties_get().
1917     *
1918     * @param efp the font properties struct
1919     *
1920     * @ingroup Fonts
1921     */
1922    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1923
1924    /**
1925     * Translate a font name, bound to a style, into fontconfig's font names
1926     * syntax.
1927     *
1928     * @param name The font (family) name
1929     * @param style The given style (may be @c NULL)
1930     *
1931     * @return the font name and style string
1932     *
1933     * @ingroup Fonts
1934     *
1935     * @note The reverse translation can be achived with
1936     * elm_font_properties_get(), for one style only (single font
1937     * instance, not family).
1938     */
1939    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1940
1941    /**
1942     * Free the font string return by elm_font_fontconfig_name_get().
1943     *
1944     * @param efp the font properties struct
1945     *
1946     * @ingroup Fonts
1947     */
1948    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1949
1950    /**
1951     * Create a font hash table of available system fonts.
1952     *
1953     * One must call it with @p list being the return value of
1954     * evas_font_available_list(). The hash will be indexed by font
1955     * (family) names, being its values @c Elm_Font_Properties blobs.
1956     *
1957     * @param list The list of available system fonts, as returned by
1958     * evas_font_available_list().
1959     * @return the font hash.
1960     *
1961     * @ingroup Fonts
1962     *
1963     * @note The user is supposed to get it populated at least with 3
1964     * default font families (Sans, Serif, Monospace), which should be
1965     * present on most systems.
1966     */
1967    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
1968
1969    /**
1970     * Free the hash return by elm_font_available_hash_add().
1971     *
1972     * @param hash the hash to be freed.
1973     *
1974     * @ingroup Fonts
1975     */
1976    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
1977
1978    /**
1979     * @}
1980     */
1981
1982    /**
1983     * @defgroup Fingers Fingers
1984     *
1985     * Elementary is designed to be finger-friendly for touchscreens,
1986     * and so in addition to scaling for display resolution, it can
1987     * also scale based on finger "resolution" (or size). You can then
1988     * customize the granularity of the areas meant to receive clicks
1989     * on touchscreens.
1990     *
1991     * Different profiles may have pre-set values for finger sizes.
1992     *
1993     * @ref general_functions_example_page "This" example contemplates
1994     * some of these functions.
1995     *
1996     * @{
1997     */
1998
1999    /**
2000     * Get the configured "finger size"
2001     *
2002     * @return The finger size
2003     *
2004     * This gets the globally configured finger size, <b>in pixels</b>
2005     *
2006     * @ingroup Fingers
2007     */
2008    EAPI Evas_Coord       elm_finger_size_get(void);
2009
2010    /**
2011     * Set the configured finger size
2012     *
2013     * This sets the globally configured finger size in pixels
2014     *
2015     * @param size The finger size
2016     * @ingroup Fingers
2017     */
2018    EAPI void             elm_finger_size_set(Evas_Coord size);
2019
2020    /**
2021     * Set the configured finger size for all applications on the display
2022     *
2023     * This sets the globally configured finger size in pixels for all
2024     * applications on the display
2025     *
2026     * @param size The finger size
2027     * @ingroup Fingers
2028     */
2029    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2030
2031    /**
2032     * @}
2033     */
2034
2035    /**
2036     * @defgroup Focus Focus
2037     *
2038     * An Elementary application has, at all times, one (and only one)
2039     * @b focused object. This is what determines where the input
2040     * events go to within the application's window. Also, focused
2041     * objects can be decorated differently, in order to signal to the
2042     * user where the input is, at a given moment.
2043     *
2044     * Elementary applications also have the concept of <b>focus
2045     * chain</b>: one can cycle through all the windows' focusable
2046     * objects by input (tab key) or programmatically. The default
2047     * focus chain for an application is the one define by the order in
2048     * which the widgets where added in code. One will cycle through
2049     * top level widgets, and, for each one containg sub-objects, cycle
2050     * through them all, before returning to the level
2051     * above. Elementary also allows one to set @b custom focus chains
2052     * for their applications.
2053     *
2054     * Besides the focused decoration a widget may exhibit, when it
2055     * gets focus, Elementary has a @b global focus highlight object
2056     * that can be enabled for a window. If one chooses to do so, this
2057     * extra highlight effect will surround the current focused object,
2058     * too.
2059     *
2060     * @note Some Elementary widgets are @b unfocusable, after
2061     * creation, by their very nature: they are not meant to be
2062     * interacted with input events, but are there just for visual
2063     * purposes.
2064     *
2065     * @ref general_functions_example_page "This" example contemplates
2066     * some of these functions.
2067     */
2068
2069    /**
2070     * Get the enable status of the focus highlight
2071     *
2072     * This gets whether the highlight on focused objects is enabled or not
2073     * @ingroup Focus
2074     */
2075    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2076
2077    /**
2078     * Set the enable status of the focus highlight
2079     *
2080     * Set whether to show or not the highlight on focused objects
2081     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2082     * @ingroup Focus
2083     */
2084    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2085
2086    /**
2087     * Get the enable status of the highlight animation
2088     *
2089     * Get whether the focus highlight, if enabled, will animate its switch from
2090     * one object to the next
2091     * @ingroup Focus
2092     */
2093    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2094
2095    /**
2096     * Set the enable status of the highlight animation
2097     *
2098     * Set whether the focus highlight, if enabled, will animate its switch from
2099     * one object to the next
2100     * @param animate Enable animation if EINA_TRUE, disable otherwise
2101     * @ingroup Focus
2102     */
2103    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2104
2105    /**
2106     * Get the whether an Elementary object has the focus or not.
2107     *
2108     * @param obj The Elementary object to get the information from
2109     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2110     *            not (and on errors).
2111     *
2112     * @see elm_object_focus_set()
2113     *
2114     * @ingroup Focus
2115     */
2116    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2117
2118    /**
2119     * Set/unset focus to a given Elementary object.
2120     *
2121     * @param obj The Elementary object to operate on.
2122     * @param enable @c EINA_TRUE Set focus to a given object,
2123     *               @c EINA_FALSE Unset focus to a given object.
2124     *
2125     * @note When you set focus to this object, if it can handle focus, will
2126     * take the focus away from the one who had it previously and will, for
2127     * now on, be the one receiving input events. Unsetting focus will remove
2128     * the focus from @p obj, passing it back to the previous element in the
2129     * focus chain list.
2130     *
2131     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2132     *
2133     * @ingroup Focus
2134     */
2135    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2136
2137    /**
2138     * Make a given Elementary object the focused one.
2139     *
2140     * @param obj The Elementary object to make focused.
2141     *
2142     * @note This object, if it can handle focus, will take the focus
2143     * away from the one who had it previously and will, for now on, be
2144     * the one receiving input events.
2145     *
2146     * @see elm_object_focus_get()
2147     * @deprecated use elm_object_focus_set() instead.
2148     *
2149     * @ingroup Focus
2150     */
2151    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2152
2153    /**
2154     * Remove the focus from an Elementary object
2155     *
2156     * @param obj The Elementary to take focus from
2157     *
2158     * This removes the focus from @p obj, passing it back to the
2159     * previous element in the focus chain list.
2160     *
2161     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2162     * @deprecated use elm_object_focus_set() instead.
2163     *
2164     * @ingroup Focus
2165     */
2166    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2167
2168    /**
2169     * Set the ability for an Element object to be focused
2170     *
2171     * @param obj The Elementary object to operate on
2172     * @param enable @c EINA_TRUE if the object can be focused, @c
2173     *        EINA_FALSE if not (and on errors)
2174     *
2175     * This sets whether the object @p obj is able to take focus or
2176     * not. Unfocusable objects do nothing when programmatically
2177     * focused, being the nearest focusable parent object the one
2178     * really getting focus. Also, when they receive mouse input, they
2179     * will get the event, but not take away the focus from where it
2180     * was previously.
2181     *
2182     * @ingroup Focus
2183     */
2184    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2185
2186    /**
2187     * Get whether an Elementary object is focusable or not
2188     *
2189     * @param obj The Elementary object to operate on
2190     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2191     *             EINA_FALSE if not (and on errors)
2192     *
2193     * @note Objects which are meant to be interacted with by input
2194     * events are created able to be focused, by default. All the
2195     * others are not.
2196     *
2197     * @ingroup Focus
2198     */
2199    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2200
2201    /**
2202     * Set custom focus chain.
2203     *
2204     * This function overwrites any previous custom focus chain within
2205     * the list of objects. The previous list will be deleted and this list
2206     * will be managed by elementary. After it is set, don't modify it.
2207     *
2208     * @note On focus cycle, only will be evaluated children of this container.
2209     *
2210     * @param obj The container object
2211     * @param objs Chain of objects to pass focus
2212     * @ingroup Focus
2213     */
2214    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2215
2216    /**
2217     * Unset a custom focus chain on a given Elementary widget
2218     *
2219     * @param obj The container object to remove focus chain from
2220     *
2221     * Any focus chain previously set on @p obj (for its child objects)
2222     * is removed entirely after this call.
2223     *
2224     * @ingroup Focus
2225     */
2226    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2227
2228    /**
2229     * Get custom focus chain
2230     *
2231     * @param obj The container object
2232     * @ingroup Focus
2233     */
2234    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2235
2236    /**
2237     * Append object to custom focus chain.
2238     *
2239     * @note If relative_child equal to NULL or not in custom chain, the object
2240     * will be added in end.
2241     *
2242     * @note On focus cycle, only will be evaluated children of this container.
2243     *
2244     * @param obj The container object
2245     * @param child The child to be added in custom chain
2246     * @param relative_child The relative object to position the child
2247     * @ingroup Focus
2248     */
2249    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2250
2251    /**
2252     * Prepend object to custom focus chain.
2253     *
2254     * @note If relative_child equal to NULL or not in custom chain, the object
2255     * will be added in begin.
2256     *
2257     * @note On focus cycle, only will be evaluated children of this container.
2258     *
2259     * @param obj The container object
2260     * @param child The child to be added in custom chain
2261     * @param relative_child The relative object to position the child
2262     * @ingroup Focus
2263     */
2264    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2265
2266    /**
2267     * Give focus to next object in object tree.
2268     *
2269     * Give focus to next object in focus chain of one object sub-tree.
2270     * If the last object of chain already have focus, the focus will go to the
2271     * first object of chain.
2272     *
2273     * @param obj The object root of sub-tree
2274     * @param dir Direction to cycle the focus
2275     *
2276     * @ingroup Focus
2277     */
2278    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2279
2280    /**
2281     * Give focus to near object in one direction.
2282     *
2283     * Give focus to near object in direction of one object.
2284     * If none focusable object in given direction, the focus will not change.
2285     *
2286     * @param obj The reference object
2287     * @param x Horizontal component of direction to focus
2288     * @param y Vertical component of direction to focus
2289     *
2290     * @ingroup Focus
2291     */
2292    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2293
2294    /**
2295     * Make the elementary object and its children to be unfocusable
2296     * (or focusable).
2297     *
2298     * @param obj The Elementary object to operate on
2299     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2300     *        @c EINA_FALSE for focusable.
2301     *
2302     * This sets whether the object @p obj and its children objects
2303     * are able to take focus or not. If the tree is set as unfocusable,
2304     * newest focused object which is not in this tree will get focus.
2305     * This API can be helpful for an object to be deleted.
2306     * When an object will be deleted soon, it and its children may not
2307     * want to get focus (by focus reverting or by other focus controls).
2308     * Then, just use this API before deleting.
2309     *
2310     * @see elm_object_tree_unfocusable_get()
2311     *
2312     * @ingroup Focus
2313     */
2314    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2315
2316    /**
2317     * Get whether an Elementary object and its children are unfocusable or not.
2318     *
2319     * @param obj The Elementary object to get the information from
2320     * @return @c EINA_TRUE, if the tree is unfocussable,
2321     *         @c EINA_FALSE if not (and on errors).
2322     *
2323     * @see elm_object_tree_unfocusable_set()
2324     *
2325     * @ingroup Focus
2326     */
2327    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2328
2329    /**
2330     * @defgroup Scrolling Scrolling
2331     *
2332     * These are functions setting how scrollable views in Elementary
2333     * widgets should behave on user interaction.
2334     *
2335     * @{
2336     */
2337
2338    /**
2339     * Get whether scrollers should bounce when they reach their
2340     * viewport's edge during a scroll.
2341     *
2342     * @return the thumb scroll bouncing state
2343     *
2344     * This is the default behavior for touch screens, in general.
2345     * @ingroup Scrolling
2346     */
2347    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2348
2349    /**
2350     * Set whether scrollers should bounce when they reach their
2351     * viewport's edge during a scroll.
2352     *
2353     * @param enabled the thumb scroll bouncing state
2354     *
2355     * @see elm_thumbscroll_bounce_enabled_get()
2356     * @ingroup Scrolling
2357     */
2358    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2359
2360    /**
2361     * Set whether scrollers should bounce when they reach their
2362     * viewport's edge during a scroll, for all Elementary application
2363     * windows.
2364     *
2365     * @param enabled the thumb scroll bouncing state
2366     *
2367     * @see elm_thumbscroll_bounce_enabled_get()
2368     * @ingroup Scrolling
2369     */
2370    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2371
2372    /**
2373     * Get the amount of inertia a scroller will impose at bounce
2374     * animations.
2375     *
2376     * @return the thumb scroll bounce friction
2377     *
2378     * @ingroup Scrolling
2379     */
2380    EAPI double           elm_scroll_bounce_friction_get(void);
2381
2382    /**
2383     * Set the amount of inertia a scroller will impose at bounce
2384     * animations.
2385     *
2386     * @param friction the thumb scroll bounce friction
2387     *
2388     * @see elm_thumbscroll_bounce_friction_get()
2389     * @ingroup Scrolling
2390     */
2391    EAPI void             elm_scroll_bounce_friction_set(double friction);
2392
2393    /**
2394     * Set the amount of inertia a scroller will impose at bounce
2395     * animations, for all Elementary application windows.
2396     *
2397     * @param friction the thumb scroll bounce friction
2398     *
2399     * @see elm_thumbscroll_bounce_friction_get()
2400     * @ingroup Scrolling
2401     */
2402    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2403
2404    /**
2405     * Get the amount of inertia a <b>paged</b> scroller will impose at
2406     * page fitting animations.
2407     *
2408     * @return the page scroll friction
2409     *
2410     * @ingroup Scrolling
2411     */
2412    EAPI double           elm_scroll_page_scroll_friction_get(void);
2413
2414    /**
2415     * Set the amount of inertia a <b>paged</b> scroller will impose at
2416     * page fitting animations.
2417     *
2418     * @param friction the page scroll friction
2419     *
2420     * @see elm_thumbscroll_page_scroll_friction_get()
2421     * @ingroup Scrolling
2422     */
2423    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2424
2425    /**
2426     * Set the amount of inertia a <b>paged</b> scroller will impose at
2427     * page fitting animations, for all Elementary application windows.
2428     *
2429     * @param friction the page scroll friction
2430     *
2431     * @see elm_thumbscroll_page_scroll_friction_get()
2432     * @ingroup Scrolling
2433     */
2434    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2435
2436    /**
2437     * Get the amount of inertia a scroller will impose at region bring
2438     * animations.
2439     *
2440     * @return the bring in scroll friction
2441     *
2442     * @ingroup Scrolling
2443     */
2444    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2445
2446    /**
2447     * Set the amount of inertia a scroller will impose at region bring
2448     * animations.
2449     *
2450     * @param friction the bring in scroll friction
2451     *
2452     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2453     * @ingroup Scrolling
2454     */
2455    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2456
2457    /**
2458     * Set the amount of inertia a scroller will impose at region bring
2459     * animations, for all Elementary application windows.
2460     *
2461     * @param friction the bring in scroll friction
2462     *
2463     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2464     * @ingroup Scrolling
2465     */
2466    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2467
2468    /**
2469     * Get the amount of inertia scrollers will impose at animations
2470     * triggered by Elementary widgets' zooming API.
2471     *
2472     * @return the zoom friction
2473     *
2474     * @ingroup Scrolling
2475     */
2476    EAPI double           elm_scroll_zoom_friction_get(void);
2477
2478    /**
2479     * Set the amount of inertia scrollers will impose at animations
2480     * triggered by Elementary widgets' zooming API.
2481     *
2482     * @param friction the zoom friction
2483     *
2484     * @see elm_thumbscroll_zoom_friction_get()
2485     * @ingroup Scrolling
2486     */
2487    EAPI void             elm_scroll_zoom_friction_set(double friction);
2488
2489    /**
2490     * Set the amount of inertia scrollers will impose at animations
2491     * triggered by Elementary widgets' zooming API, for all Elementary
2492     * application windows.
2493     *
2494     * @param friction the zoom friction
2495     *
2496     * @see elm_thumbscroll_zoom_friction_get()
2497     * @ingroup Scrolling
2498     */
2499    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2500
2501    /**
2502     * Get whether scrollers should be draggable from any point in their
2503     * views.
2504     *
2505     * @return the thumb scroll state
2506     *
2507     * @note This is the default behavior for touch screens, in general.
2508     * @note All other functions namespaced with "thumbscroll" will only
2509     *       have effect if this mode is enabled.
2510     *
2511     * @ingroup Scrolling
2512     */
2513    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2514
2515    /**
2516     * Set whether scrollers should be draggable from any point in their
2517     * views.
2518     *
2519     * @param enabled the thumb scroll state
2520     *
2521     * @see elm_thumbscroll_enabled_get()
2522     * @ingroup Scrolling
2523     */
2524    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2525
2526    /**
2527     * Set whether scrollers should be draggable from any point in their
2528     * views, for all Elementary application windows.
2529     *
2530     * @param enabled the thumb scroll state
2531     *
2532     * @see elm_thumbscroll_enabled_get()
2533     * @ingroup Scrolling
2534     */
2535    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2536
2537    /**
2538     * Get the number of pixels one should travel while dragging a
2539     * scroller's view to actually trigger scrolling.
2540     *
2541     * @return the thumb scroll threshould
2542     *
2543     * One would use higher values for touch screens, in general, because
2544     * of their inherent imprecision.
2545     * @ingroup Scrolling
2546     */
2547    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2548
2549    /**
2550     * Set the number of pixels one should travel while dragging a
2551     * scroller's view to actually trigger scrolling.
2552     *
2553     * @param threshold the thumb scroll threshould
2554     *
2555     * @see elm_thumbscroll_threshould_get()
2556     * @ingroup Scrolling
2557     */
2558    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2559
2560    /**
2561     * Set the number of pixels one should travel while dragging a
2562     * scroller's view to actually trigger scrolling, for all Elementary
2563     * application windows.
2564     *
2565     * @param threshold the thumb scroll threshould
2566     *
2567     * @see elm_thumbscroll_threshould_get()
2568     * @ingroup Scrolling
2569     */
2570    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2571
2572    /**
2573     * Get the minimum speed of mouse cursor movement which will trigger
2574     * list self scrolling animation after a mouse up event
2575     * (pixels/second).
2576     *
2577     * @return the thumb scroll momentum threshould
2578     *
2579     * @ingroup Scrolling
2580     */
2581    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2582
2583    /**
2584     * Set the minimum speed of mouse cursor movement which will trigger
2585     * list self scrolling animation after a mouse up event
2586     * (pixels/second).
2587     *
2588     * @param threshold the thumb scroll momentum threshould
2589     *
2590     * @see elm_thumbscroll_momentum_threshould_get()
2591     * @ingroup Scrolling
2592     */
2593    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2594
2595    /**
2596     * Set the minimum speed of mouse cursor movement which will trigger
2597     * list self scrolling animation after a mouse up event
2598     * (pixels/second), for all Elementary application windows.
2599     *
2600     * @param threshold the thumb scroll momentum threshould
2601     *
2602     * @see elm_thumbscroll_momentum_threshould_get()
2603     * @ingroup Scrolling
2604     */
2605    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2606
2607    /**
2608     * Get the amount of inertia a scroller will impose at self scrolling
2609     * animations.
2610     *
2611     * @return the thumb scroll friction
2612     *
2613     * @ingroup Scrolling
2614     */
2615    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2616
2617    /**
2618     * Set the amount of inertia a scroller will impose at self scrolling
2619     * animations.
2620     *
2621     * @param friction the thumb scroll friction
2622     *
2623     * @see elm_thumbscroll_friction_get()
2624     * @ingroup Scrolling
2625     */
2626    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2627
2628    /**
2629     * Set the amount of inertia a scroller will impose at self scrolling
2630     * animations, for all Elementary application windows.
2631     *
2632     * @param friction the thumb scroll friction
2633     *
2634     * @see elm_thumbscroll_friction_get()
2635     * @ingroup Scrolling
2636     */
2637    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2638
2639    /**
2640     * Get the amount of lag between your actual mouse cursor dragging
2641     * movement and a scroller's view movement itself, while pushing it
2642     * into bounce state manually.
2643     *
2644     * @return the thumb scroll border friction
2645     *
2646     * @ingroup Scrolling
2647     */
2648    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2649
2650    /**
2651     * Set the amount of lag between your actual mouse cursor dragging
2652     * movement and a scroller's view movement itself, while pushing it
2653     * into bounce state manually.
2654     *
2655     * @param friction the thumb scroll border friction. @c 0.0 for
2656     *        perfect synchrony between two movements, @c 1.0 for maximum
2657     *        lag.
2658     *
2659     * @see elm_thumbscroll_border_friction_get()
2660     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2661     *
2662     * @ingroup Scrolling
2663     */
2664    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2665
2666    /**
2667     * Set the amount of lag between your actual mouse cursor dragging
2668     * movement and a scroller's view movement itself, while pushing it
2669     * into bounce state manually, for all Elementary application windows.
2670     *
2671     * @param friction the thumb scroll border friction. @c 0.0 for
2672     *        perfect synchrony between two movements, @c 1.0 for maximum
2673     *        lag.
2674     *
2675     * @see elm_thumbscroll_border_friction_get()
2676     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2677     *
2678     * @ingroup Scrolling
2679     */
2680    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2681
2682    /**
2683     * @}
2684     */
2685
2686    /**
2687     * @defgroup Scrollhints Scrollhints
2688     *
2689     * Objects when inside a scroller can scroll, but this may not always be
2690     * desirable in certain situations. This allows an object to hint to itself
2691     * and parents to "not scroll" in one of 2 ways. If any child object of a
2692     * scroller has pushed a scroll freeze or hold then it affects all parent
2693     * scrollers until all children have released them.
2694     *
2695     * 1. To hold on scrolling. This means just flicking and dragging may no
2696     * longer scroll, but pressing/dragging near an edge of the scroller will
2697     * still scroll. This is automatically used by the entry object when
2698     * selecting text.
2699     *
2700     * 2. To totally freeze scrolling. This means it stops. until
2701     * popped/released.
2702     *
2703     * @{
2704     */
2705
2706    /**
2707     * Push the scroll hold by 1
2708     *
2709     * This increments the scroll hold count by one. If it is more than 0 it will
2710     * take effect on the parents of the indicated object.
2711     *
2712     * @param obj The object
2713     * @ingroup Scrollhints
2714     */
2715    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2716
2717    /**
2718     * Pop the scroll hold by 1
2719     *
2720     * This decrements the scroll hold count by one. If it is more than 0 it will
2721     * take effect on the parents of the indicated object.
2722     *
2723     * @param obj The object
2724     * @ingroup Scrollhints
2725     */
2726    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2727
2728    /**
2729     * Push the scroll freeze by 1
2730     *
2731     * This increments the scroll freeze count by one. If it is more
2732     * than 0 it will take effect on the parents of the indicated
2733     * object.
2734     *
2735     * @param obj The object
2736     * @ingroup Scrollhints
2737     */
2738    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2739
2740    /**
2741     * Pop the scroll freeze by 1
2742     *
2743     * This decrements the scroll freeze count by one. If it is more
2744     * than 0 it will take effect on the parents of the indicated
2745     * object.
2746     *
2747     * @param obj The object
2748     * @ingroup Scrollhints
2749     */
2750    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2751
2752    /**
2753     * Lock the scrolling of the given widget (and thus all parents)
2754     *
2755     * This locks the given object from scrolling in the X axis (and implicitly
2756     * also locks all parent scrollers too from doing the same).
2757     *
2758     * @param obj The object
2759     * @param lock The lock state (1 == locked, 0 == unlocked)
2760     * @ingroup Scrollhints
2761     */
2762    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2763
2764    /**
2765     * Lock the scrolling of the given widget (and thus all parents)
2766     *
2767     * This locks the given object from scrolling in the Y axis (and implicitly
2768     * also locks all parent scrollers too from doing the same).
2769     *
2770     * @param obj The object
2771     * @param lock The lock state (1 == locked, 0 == unlocked)
2772     * @ingroup Scrollhints
2773     */
2774    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2775
2776    /**
2777     * Get the scrolling lock of the given widget
2778     *
2779     * This gets the lock for X axis scrolling.
2780     *
2781     * @param obj The object
2782     * @ingroup Scrollhints
2783     */
2784    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2785
2786    /**
2787     * Get the scrolling lock of the given widget
2788     *
2789     * This gets the lock for X axis scrolling.
2790     *
2791     * @param obj The object
2792     * @ingroup Scrollhints
2793     */
2794    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2795
2796    /**
2797     * @}
2798     */
2799
2800    /**
2801     * Send a signal to the widget edje object.
2802     *
2803     * This function sends a signal to the edje object of the obj. An
2804     * edje program can respond to a signal by specifying matching
2805     * 'signal' and 'source' fields.
2806     *
2807     * @param obj The object
2808     * @param emission The signal's name.
2809     * @param source The signal's source.
2810     * @ingroup General
2811     */
2812    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2813
2814    /**
2815     * Add a callback for a signal emitted by widget edje object.
2816     *
2817     * This function connects a callback function to a signal emitted by the
2818     * edje object of the obj.
2819     * Globs can occur in either the emission or source name.
2820     *
2821     * @param obj The object
2822     * @param emission The signal's name.
2823     * @param source The signal's source.
2824     * @param func The callback function to be executed when the signal is
2825     * emitted.
2826     * @param data A pointer to data to pass in to the callback function.
2827     * @ingroup General
2828     */
2829    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);
2830
2831    /**
2832     * Remove a signal-triggered callback from a widget edje object.
2833     *
2834     * This function removes a callback, previoulsy attached to a
2835     * signal emitted by the edje object of the obj.  The parameters
2836     * emission, source and func must match exactly those passed to a
2837     * previous call to elm_object_signal_callback_add(). The data
2838     * pointer that was passed to this call will be returned.
2839     *
2840     * @param obj The object
2841     * @param emission The signal's name.
2842     * @param source The signal's source.
2843     * @param func The callback function to be executed when the signal is
2844     * emitted.
2845     * @return The data pointer
2846     * @ingroup General
2847     */
2848    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);
2849
2850    /**
2851     * Add a callback for input events (key up, key down, mouse wheel)
2852     * on a given Elementary widget
2853     *
2854     * @param obj The widget to add an event callback on
2855     * @param func The callback function to be executed when the event
2856     * happens
2857     * @param data Data to pass in to @p func
2858     *
2859     * Every widget in an Elementary interface set to receive focus,
2860     * with elm_object_focus_allow_set(), will propagate @b all of its
2861     * key up, key down and mouse wheel input events up to its parent
2862     * object, and so on. All of the focusable ones in this chain which
2863     * had an event callback set, with this call, will be able to treat
2864     * those events. There are two ways of making the propagation of
2865     * these event upwards in the tree of widgets to @b cease:
2866     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2867     *   the event was @b not processed, so the propagation will go on.
2868     * - The @c event_info pointer passed to @p func will contain the
2869     *   event's structure and, if you OR its @c event_flags inner
2870     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2871     *   one has already handled it, thus killing the event's
2872     *   propagation, too.
2873     *
2874     * @note Your event callback will be issued on those events taking
2875     * place only if no other child widget of @obj has consumed the
2876     * event already.
2877     *
2878     * @note Not to be confused with @c
2879     * evas_object_event_callback_add(), which will add event callbacks
2880     * per type on general Evas objects (no event propagation
2881     * infrastructure taken in account).
2882     *
2883     * @note Not to be confused with @c
2884     * elm_object_signal_callback_add(), which will add callbacks to @b
2885     * signals coming from a widget's theme, not input events.
2886     *
2887     * @note Not to be confused with @c
2888     * edje_object_signal_callback_add(), which does the same as
2889     * elm_object_signal_callback_add(), but directly on an Edje
2890     * object.
2891     *
2892     * @note Not to be confused with @c
2893     * evas_object_smart_callback_add(), which adds callbacks to smart
2894     * objects' <b>smart events</b>, and not input events.
2895     *
2896     * @see elm_object_event_callback_del()
2897     *
2898     * @ingroup General
2899     */
2900    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2901
2902    /**
2903     * Remove an event callback from a widget.
2904     *
2905     * This function removes a callback, previoulsy attached to event emission
2906     * by the @p obj.
2907     * The parameters func and data must match exactly those passed to
2908     * a previous call to elm_object_event_callback_add(). The data pointer that
2909     * was passed to this call will be returned.
2910     *
2911     * @param obj The object
2912     * @param func The callback function to be executed when the event is
2913     * emitted.
2914     * @param data Data to pass in to the callback function.
2915     * @return The data pointer
2916     * @ingroup General
2917     */
2918    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2919
2920    /**
2921     * Adjust size of an element for finger usage.
2922     *
2923     * @param times_w How many fingers should fit horizontally
2924     * @param w Pointer to the width size to adjust
2925     * @param times_h How many fingers should fit vertically
2926     * @param h Pointer to the height size to adjust
2927     *
2928     * This takes width and height sizes (in pixels) as input and a
2929     * size multiple (which is how many fingers you want to place
2930     * within the area, being "finger" the size set by
2931     * elm_finger_size_set()), and adjusts the size to be large enough
2932     * to accommodate the resulting size -- if it doesn't already
2933     * accommodate it. On return the @p w and @p h sizes pointed to by
2934     * these parameters will be modified, on those conditions.
2935     *
2936     * @note This is kind of a low level Elementary call, most useful
2937     * on size evaluation times for widgets. An external user wouldn't
2938     * be calling, most of the time.
2939     *
2940     * @ingroup Fingers
2941     */
2942    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2943
2944    /**
2945     * Get the duration for occuring long press event.
2946     *
2947     * @return Timeout for long press event
2948     * @ingroup Longpress
2949     */
2950    EAPI double           elm_longpress_timeout_get(void);
2951
2952    /**
2953     * Set the duration for occuring long press event.
2954     *
2955     * @param lonpress_timeout Timeout for long press event
2956     * @ingroup Longpress
2957     */
2958    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
2959
2960    /**
2961     * @defgroup Debug Debug
2962     * don't use it unless you are sure
2963     *
2964     * @{
2965     */
2966
2967    /**
2968     * Print Tree object hierarchy in stdout
2969     *
2970     * @param obj The root object
2971     * @ingroup Debug
2972     */
2973    EAPI void             elm_object_tree_dump(const Evas_Object *top);
2974
2975    /**
2976     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
2977     *
2978     * @param obj The root object
2979     * @param file The path of output file
2980     * @ingroup Debug
2981     */
2982    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
2983
2984    /**
2985     * @}
2986     */
2987
2988    /**
2989     * @defgroup Theme Theme
2990     *
2991     * Elementary uses Edje to theme its widgets, naturally. But for the most
2992     * part this is hidden behind a simpler interface that lets the user set
2993     * extensions and choose the style of widgets in a much easier way.
2994     *
2995     * Instead of thinking in terms of paths to Edje files and their groups
2996     * each time you want to change the appearance of a widget, Elementary
2997     * works so you can add any theme file with extensions or replace the
2998     * main theme at one point in the application, and then just set the style
2999     * of widgets with elm_object_style_set() and related functions. Elementary
3000     * will then look in its list of themes for a matching group and apply it,
3001     * and when the theme changes midway through the application, all widgets
3002     * will be updated accordingly.
3003     *
3004     * There are three concepts you need to know to understand how Elementary
3005     * theming works: default theme, extensions and overlays.
3006     *
3007     * Default theme, obviously enough, is the one that provides the default
3008     * look of all widgets. End users can change the theme used by Elementary
3009     * by setting the @c ELM_THEME environment variable before running an
3010     * application, or globally for all programs using the @c elementary_config
3011     * utility. Applications can change the default theme using elm_theme_set(),
3012     * but this can go against the user wishes, so it's not an adviced practice.
3013     *
3014     * Ideally, applications should find everything they need in the already
3015     * provided theme, but there may be occasions when that's not enough and
3016     * custom styles are required to correctly express the idea. For this
3017     * cases, Elementary has extensions.
3018     *
3019     * Extensions allow the application developer to write styles of its own
3020     * to apply to some widgets. This requires knowledge of how each widget
3021     * is themed, as extensions will always replace the entire group used by
3022     * the widget, so important signals and parts need to be there for the
3023     * object to behave properly (see documentation of Edje for details).
3024     * Once the theme for the extension is done, the application needs to add
3025     * it to the list of themes Elementary will look into, using
3026     * elm_theme_extension_add(), and set the style of the desired widgets as
3027     * he would normally with elm_object_style_set().
3028     *
3029     * Overlays, on the other hand, can replace the look of all widgets by
3030     * overriding the default style. Like extensions, it's up to the application
3031     * developer to write the theme for the widgets it wants, the difference
3032     * being that when looking for the theme, Elementary will check first the
3033     * list of overlays, then the set theme and lastly the list of extensions,
3034     * so with overlays it's possible to replace the default view and every
3035     * widget will be affected. This is very much alike to setting the whole
3036     * theme for the application and will probably clash with the end user
3037     * options, not to mention the risk of ending up with not matching styles
3038     * across the program. Unless there's a very special reason to use them,
3039     * overlays should be avoided for the resons exposed before.
3040     *
3041     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3042     * keeps one default internally and every function that receives one of
3043     * these can be called with NULL to refer to this default (except for
3044     * elm_theme_free()). It's possible to create a new instance of a
3045     * ::Elm_Theme to set other theme for a specific widget (and all of its
3046     * children), but this is as discouraged, if not even more so, than using
3047     * overlays. Don't use this unless you really know what you are doing.
3048     *
3049     * But to be less negative about things, you can look at the following
3050     * examples:
3051     * @li @ref theme_example_01 "Using extensions"
3052     * @li @ref theme_example_02 "Using overlays"
3053     *
3054     * @{
3055     */
3056    /**
3057     * @typedef Elm_Theme
3058     *
3059     * Opaque handler for the list of themes Elementary looks for when
3060     * rendering widgets.
3061     *
3062     * Stay out of this unless you really know what you are doing. For most
3063     * cases, sticking to the default is all a developer needs.
3064     */
3065    typedef struct _Elm_Theme Elm_Theme;
3066
3067    /**
3068     * Create a new specific theme
3069     *
3070     * This creates an empty specific theme that only uses the default theme. A
3071     * specific theme has its own private set of extensions and overlays too
3072     * (which are empty by default). Specific themes do not fall back to themes
3073     * of parent objects. They are not intended for this use. Use styles, overlays
3074     * and extensions when needed, but avoid specific themes unless there is no
3075     * other way (example: you want to have a preview of a new theme you are
3076     * selecting in a "theme selector" window. The preview is inside a scroller
3077     * and should display what the theme you selected will look like, but not
3078     * actually apply it yet. The child of the scroller will have a specific
3079     * theme set to show this preview before the user decides to apply it to all
3080     * applications).
3081     */
3082    EAPI Elm_Theme       *elm_theme_new(void);
3083    /**
3084     * Free a specific theme
3085     *
3086     * @param th The theme to free
3087     *
3088     * This frees a theme created with elm_theme_new().
3089     */
3090    EAPI void             elm_theme_free(Elm_Theme *th);
3091    /**
3092     * Copy the theme fom the source to the destination theme
3093     *
3094     * @param th The source theme to copy from
3095     * @param thdst The destination theme to copy data to
3096     *
3097     * This makes a one-time static copy of all the theme config, extensions
3098     * and overlays from @p th to @p thdst. If @p th references a theme, then
3099     * @p thdst is also set to reference it, with all the theme settings,
3100     * overlays and extensions that @p th had.
3101     */
3102    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3103    /**
3104     * Tell the source theme to reference the ref theme
3105     *
3106     * @param th The theme that will do the referencing
3107     * @param thref The theme that is the reference source
3108     *
3109     * This clears @p th to be empty and then sets it to refer to @p thref
3110     * so @p th acts as an override to @p thref, but where its overrides
3111     * don't apply, it will fall through to @p thref for configuration.
3112     */
3113    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3114    /**
3115     * Return the theme referred to
3116     *
3117     * @param th The theme to get the reference from
3118     * @return The referenced theme handle
3119     *
3120     * This gets the theme set as the reference theme by elm_theme_ref_set().
3121     * If no theme is set as a reference, NULL is returned.
3122     */
3123    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3124    /**
3125     * Return the default theme
3126     *
3127     * @return The default theme handle
3128     *
3129     * This returns the internal default theme setup handle that all widgets
3130     * use implicitly unless a specific theme is set. This is also often use
3131     * as a shorthand of NULL.
3132     */
3133    EAPI Elm_Theme       *elm_theme_default_get(void);
3134    /**
3135     * Prepends a theme overlay to the list of overlays
3136     *
3137     * @param th The theme to add to, or if NULL, the default theme
3138     * @param item The Edje file path to be used
3139     *
3140     * Use this if your application needs to provide some custom overlay theme
3141     * (An Edje file that replaces some default styles of widgets) where adding
3142     * new styles, or changing system theme configuration is not possible. Do
3143     * NOT use this instead of a proper system theme configuration. Use proper
3144     * configuration files, profiles, environment variables etc. to set a theme
3145     * so that the theme can be altered by simple confiugration by a user. Using
3146     * this call to achieve that effect is abusing the API and will create lots
3147     * of trouble.
3148     *
3149     * @see elm_theme_extension_add()
3150     */
3151    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3152    /**
3153     * Delete a theme overlay from the list of overlays
3154     *
3155     * @param th The theme to delete from, or if NULL, the default theme
3156     * @param item The name of the theme overlay
3157     *
3158     * @see elm_theme_overlay_add()
3159     */
3160    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3161    /**
3162     * Appends a theme extension to the list of extensions.
3163     *
3164     * @param th The theme to add to, or if NULL, the default theme
3165     * @param item The Edje file path to be used
3166     *
3167     * This is intended when an application needs more styles of widgets or new
3168     * widget themes that the default does not provide (or may not provide). The
3169     * application has "extended" usage by coming up with new custom style names
3170     * for widgets for specific uses, but as these are not "standard", they are
3171     * not guaranteed to be provided by a default theme. This means the
3172     * application is required to provide these extra elements itself in specific
3173     * Edje files. This call adds one of those Edje files to the theme search
3174     * path to be search after the default theme. The use of this call is
3175     * encouraged when default styles do not meet the needs of the application.
3176     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3177     *
3178     * @see elm_object_style_set()
3179     */
3180    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3181    /**
3182     * Deletes a theme extension from the list of extensions.
3183     *
3184     * @param th The theme to delete from, or if NULL, the default theme
3185     * @param item The name of the theme extension
3186     *
3187     * @see elm_theme_extension_add()
3188     */
3189    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3190    /**
3191     * Set the theme search order for the given theme
3192     *
3193     * @param th The theme to set the search order, or if NULL, the default theme
3194     * @param theme Theme search string
3195     *
3196     * This sets the search string for the theme in path-notation from first
3197     * theme to search, to last, delimited by the : character. Example:
3198     *
3199     * "shiny:/path/to/file.edj:default"
3200     *
3201     * See the ELM_THEME environment variable for more information.
3202     *
3203     * @see elm_theme_get()
3204     * @see elm_theme_list_get()
3205     */
3206    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3207    /**
3208     * Return the theme search order
3209     *
3210     * @param th The theme to get the search order, or if NULL, the default theme
3211     * @return The internal search order path
3212     *
3213     * This function returns a colon separated string of theme elements as
3214     * returned by elm_theme_list_get().
3215     *
3216     * @see elm_theme_set()
3217     * @see elm_theme_list_get()
3218     */
3219    EAPI const char      *elm_theme_get(Elm_Theme *th);
3220    /**
3221     * Return a list of theme elements to be used in a theme.
3222     *
3223     * @param th Theme to get the list of theme elements from.
3224     * @return The internal list of theme elements
3225     *
3226     * This returns the internal list of theme elements (will only be valid as
3227     * long as the theme is not modified by elm_theme_set() or theme is not
3228     * freed by elm_theme_free(). This is a list of strings which must not be
3229     * altered as they are also internal. If @p th is NULL, then the default
3230     * theme element list is returned.
3231     *
3232     * A theme element can consist of a full or relative path to a .edj file,
3233     * or a name, without extension, for a theme to be searched in the known
3234     * theme paths for Elemementary.
3235     *
3236     * @see elm_theme_set()
3237     * @see elm_theme_get()
3238     */
3239    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3240    /**
3241     * Return the full patrh for a theme element
3242     *
3243     * @param f The theme element name
3244     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3245     * @return The full path to the file found.
3246     *
3247     * This returns a string you should free with free() on success, NULL on
3248     * failure. This will search for the given theme element, and if it is a
3249     * full or relative path element or a simple searchable name. The returned
3250     * path is the full path to the file, if searched, and the file exists, or it
3251     * is simply the full path given in the element or a resolved path if
3252     * relative to home. The @p in_search_path boolean pointed to is set to
3253     * EINA_TRUE if the file was a searchable file andis in the search path,
3254     * and EINA_FALSE otherwise.
3255     */
3256    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3257    /**
3258     * Flush the current theme.
3259     *
3260     * @param th Theme to flush
3261     *
3262     * This flushes caches that let elementary know where to find theme elements
3263     * in the given theme. If @p th is NULL, then the default theme is flushed.
3264     * Call this function if source theme data has changed in such a way as to
3265     * make any caches Elementary kept invalid.
3266     */
3267    EAPI void             elm_theme_flush(Elm_Theme *th);
3268    /**
3269     * This flushes all themes (default and specific ones).
3270     *
3271     * This will flush all themes in the current application context, by calling
3272     * elm_theme_flush() on each of them.
3273     */
3274    EAPI void             elm_theme_full_flush(void);
3275    /**
3276     * Set the theme for all elementary using applications on the current display
3277     *
3278     * @param theme The name of the theme to use. Format same as the ELM_THEME
3279     * environment variable.
3280     */
3281    EAPI void             elm_theme_all_set(const char *theme);
3282    /**
3283     * Return a list of theme elements in the theme search path
3284     *
3285     * @return A list of strings that are the theme element names.
3286     *
3287     * This lists all available theme files in the standard Elementary search path
3288     * for theme elements, and returns them in alphabetical order as theme
3289     * element names in a list of strings. Free this with
3290     * elm_theme_name_available_list_free() when you are done with the list.
3291     */
3292    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3293    /**
3294     * Free the list returned by elm_theme_name_available_list_new()
3295     *
3296     * This frees the list of themes returned by
3297     * elm_theme_name_available_list_new(). Once freed the list should no longer
3298     * be used. a new list mys be created.
3299     */
3300    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3301    /**
3302     * Set a specific theme to be used for this object and its children
3303     *
3304     * @param obj The object to set the theme on
3305     * @param th The theme to set
3306     *
3307     * This sets a specific theme that will be used for the given object and any
3308     * child objects it has. If @p th is NULL then the theme to be used is
3309     * cleared and the object will inherit its theme from its parent (which
3310     * ultimately will use the default theme if no specific themes are set).
3311     *
3312     * Use special themes with great care as this will annoy users and make
3313     * configuration difficult. Avoid any custom themes at all if it can be
3314     * helped.
3315     */
3316    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3317    /**
3318     * Get the specific theme to be used
3319     *
3320     * @param obj The object to get the specific theme from
3321     * @return The specifc theme set.
3322     *
3323     * This will return a specific theme set, or NULL if no specific theme is
3324     * set on that object. It will not return inherited themes from parents, only
3325     * the specific theme set for that specific object. See elm_object_theme_set()
3326     * for more information.
3327     */
3328    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3329    /**
3330     * @}
3331     */
3332
3333    /* win */
3334    /** @defgroup Win Win
3335     *
3336     * @image html img/widget/win/preview-00.png
3337     * @image latex img/widget/win/preview-00.eps
3338     *
3339     * The window class of Elementary.  Contains functions to manipulate
3340     * windows. The Evas engine used to render the window contents is specified
3341     * in the system or user elementary config files (whichever is found last),
3342     * and can be overridden with the ELM_ENGINE environment variable for
3343     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3344     * compilation setup and modules actually installed at runtime) are (listed
3345     * in order of best supported and most likely to be complete and work to
3346     * lowest quality).
3347     *
3348     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3349     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3350     * rendering in X11)
3351     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3352     * exits)
3353     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3354     * rendering)
3355     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3356     * buffer)
3357     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3358     * rendering using SDL as the buffer)
3359     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3360     * GDI with software)
3361     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3362     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3363     * grayscale using dedicated 8bit software engine in X11)
3364     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3365     * X11 using 16bit software engine)
3366     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3367     * (Windows CE rendering via GDI with 16bit software renderer)
3368     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3369     * buffer with 16bit software renderer)
3370     *
3371     * All engines use a simple string to select the engine to render, EXCEPT
3372     * the "shot" engine. This actually encodes the output of the virtual
3373     * screenshot and how long to delay in the engine string. The engine string
3374     * is encoded in the following way:
3375     *
3376     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3377     *
3378     * Where options are separated by a ":" char if more than one option is
3379     * given, with delay, if provided being the first option and file the last
3380     * (order is important). The delay specifies how long to wait after the
3381     * window is shown before doing the virtual "in memory" rendering and then
3382     * save the output to the file specified by the file option (and then exit).
3383     * If no delay is given, the default is 0.5 seconds. If no file is given the
3384     * default output file is "out.png". Repeat option is for continous
3385     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3386     * fixed to "out001.png" Some examples of using the shot engine:
3387     *
3388     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3389     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3390     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3391     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3392     *   ELM_ENGINE="shot:" elementary_test
3393     *
3394     * Signals that you can add callbacks for are:
3395     *
3396     * @li "delete,request": the user requested to close the window. See
3397     * elm_win_autodel_set().
3398     * @li "focus,in": window got focus
3399     * @li "focus,out": window lost focus
3400     * @li "moved": window that holds the canvas was moved
3401     *
3402     * Examples:
3403     * @li @ref win_example_01
3404     *
3405     * @{
3406     */
3407    /**
3408     * Defines the types of window that can be created
3409     *
3410     * These are hints set on the window so that a running Window Manager knows
3411     * how the window should be handled and/or what kind of decorations it
3412     * should have.
3413     *
3414     * Currently, only the X11 backed engines use them.
3415     */
3416    typedef enum _Elm_Win_Type
3417      {
3418         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3419                          window. Almost every window will be created with this
3420                          type. */
3421         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3422         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3423                            window holding desktop icons. */
3424         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3425                         be kept on top of any other window by the Window
3426                         Manager. */
3427         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3428                            similar. */
3429         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3430         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3431                            pallete. */
3432         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3433         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3434                                  entry in a menubar is clicked. Typically used
3435                                  with elm_win_override_set(). This hint exists
3436                                  for completion only, as the EFL way of
3437                                  implementing a menu would not normally use a
3438                                  separate window for its contents. */
3439         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3440                               triggered by right-clicking an object. */
3441         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3442                            explanatory text that typically appear after the
3443                            mouse cursor hovers over an object for a while.
3444                            Typically used with elm_win_override_set() and also
3445                            not very commonly used in the EFL. */
3446         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3447                                 battery life or a new E-Mail received. */
3448         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3449                          usually used in the EFL. */
3450         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3451                        object being dragged across different windows, or even
3452                        applications. Typically used with
3453                        elm_win_override_set(). */
3454         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3455                                  buffer. No actual window is created for this
3456                                  type, instead the window and all of its
3457                                  contents will be rendered to an image buffer.
3458                                  This allows to have children window inside a
3459                                  parent one just like any other object would
3460                                  be, and do other things like applying @c
3461                                  Evas_Map effects to it. This is the only type
3462                                  of window that requires the @c parent
3463                                  parameter of elm_win_add() to be a valid @c
3464                                  Evas_Object. */
3465      } Elm_Win_Type;
3466
3467    /**
3468     * The differents layouts that can be requested for the virtual keyboard.
3469     *
3470     * When the application window is being managed by Illume, it may request
3471     * any of the following layouts for the virtual keyboard.
3472     */
3473    typedef enum _Elm_Win_Keyboard_Mode
3474      {
3475         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3476         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3477         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3478         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3479         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3480         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3481         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3482         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3483         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3484         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3485         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3486         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3487         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3488         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3489         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3490         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3491      } Elm_Win_Keyboard_Mode;
3492
3493    /**
3494     * Available commands that can be sent to the Illume manager.
3495     *
3496     * When running under an Illume session, a window may send commands to the
3497     * Illume manager to perform different actions.
3498     */
3499    typedef enum _Elm_Illume_Command
3500      {
3501         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3502                                          window */
3503         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3504                                             in the list */
3505         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3506                                          screen */
3507         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3508      } Elm_Illume_Command;
3509
3510    /**
3511     * Adds a window object. If this is the first window created, pass NULL as
3512     * @p parent.
3513     *
3514     * @param parent Parent object to add the window to, or NULL
3515     * @param name The name of the window
3516     * @param type The window type, one of #Elm_Win_Type.
3517     *
3518     * The @p parent paramter can be @c NULL for every window @p type except
3519     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3520     * which the image object will be created.
3521     *
3522     * @return The created object, or NULL on failure
3523     */
3524    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3525    /**
3526     * Add @p subobj as a resize object of window @p obj.
3527     *
3528     *
3529     * Setting an object as a resize object of the window means that the
3530     * @p subobj child's size and position will be controlled by the window
3531     * directly. That is, the object will be resized to match the window size
3532     * and should never be moved or resized manually by the developer.
3533     *
3534     * In addition, resize objects of the window control what the minimum size
3535     * of it will be, as well as whether it can or not be resized by the user.
3536     *
3537     * For the end user to be able to resize a window by dragging the handles
3538     * or borders provided by the Window Manager, or using any other similar
3539     * mechanism, all of the resize objects in the window should have their
3540     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3541     *
3542     * @param obj The window object
3543     * @param subobj The resize object to add
3544     */
3545    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3546    /**
3547     * Delete @p subobj as a resize object of window @p obj.
3548     *
3549     * This function removes the object @p subobj from the resize objects of
3550     * the window @p obj. It will not delete the object itself, which will be
3551     * left unmanaged and should be deleted by the developer, manually handled
3552     * or set as child of some other container.
3553     *
3554     * @param obj The window object
3555     * @param subobj The resize object to add
3556     */
3557    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3558    /**
3559     * Set the title of the window
3560     *
3561     * @param obj The window object
3562     * @param title The title to set
3563     */
3564    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3565    /**
3566     * Get the title of the window
3567     *
3568     * The returned string is an internal one and should not be freed or
3569     * modified. It will also be rendered invalid if a new title is set or if
3570     * the window is destroyed.
3571     *
3572     * @param obj The window object
3573     * @return The title
3574     */
3575    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3576    /**
3577     * Set the window's autodel state.
3578     *
3579     * When closing the window in any way outside of the program control, like
3580     * pressing the X button in the titlebar or using a command from the
3581     * Window Manager, a "delete,request" signal is emitted to indicate that
3582     * this event occurred and the developer can take any action, which may
3583     * include, or not, destroying the window object.
3584     *
3585     * When the @p autodel parameter is set, the window will be automatically
3586     * destroyed when this event occurs, after the signal is emitted.
3587     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3588     * and is up to the program to do so when it's required.
3589     *
3590     * @param obj The window object
3591     * @param autodel If true, the window will automatically delete itself when
3592     * closed
3593     */
3594    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3595    /**
3596     * Get the window's autodel state.
3597     *
3598     * @param obj The window object
3599     * @return If the window will automatically delete itself when closed
3600     *
3601     * @see elm_win_autodel_set()
3602     */
3603    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3604    /**
3605     * Activate a window object.
3606     *
3607     * This function sends a request to the Window Manager to activate the
3608     * window pointed by @p obj. If honored by the WM, the window will receive
3609     * the keyboard focus.
3610     *
3611     * @note This is just a request that a Window Manager may ignore, so calling
3612     * this function does not ensure in any way that the window will be the
3613     * active one after it.
3614     *
3615     * @param obj The window object
3616     */
3617    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3618    /**
3619     * Lower a window object.
3620     *
3621     * Places the window pointed by @p obj at the bottom of the stack, so that
3622     * no other window is covered by it.
3623     *
3624     * If elm_win_override_set() is not set, the Window Manager may ignore this
3625     * request.
3626     *
3627     * @param obj The window object
3628     */
3629    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3630    /**
3631     * Raise a window object.
3632     *
3633     * Places the window pointed by @p obj at the top of the stack, so that it's
3634     * not covered by any other window.
3635     *
3636     * If elm_win_override_set() is not set, the Window Manager may ignore this
3637     * request.
3638     *
3639     * @param obj The window object
3640     */
3641    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3642    /**
3643     * Set the borderless state of a window.
3644     *
3645     * This function requests the Window Manager to not draw any decoration
3646     * around the window.
3647     *
3648     * @param obj The window object
3649     * @param borderless If true, the window is borderless
3650     */
3651    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3652    /**
3653     * Get the borderless state of a window.
3654     *
3655     * @param obj The window object
3656     * @return If true, the window is borderless
3657     */
3658    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3659    /**
3660     * Set the shaped state of a window.
3661     *
3662     * Shaped windows, when supported, will render the parts of the window that
3663     * has no content, transparent.
3664     *
3665     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3666     * background object or cover the entire window in any other way, or the
3667     * parts of the canvas that have no data will show framebuffer artifacts.
3668     *
3669     * @param obj The window object
3670     * @param shaped If true, the window is shaped
3671     *
3672     * @see elm_win_alpha_set()
3673     */
3674    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3675    /**
3676     * Get the shaped state of a window.
3677     *
3678     * @param obj The window object
3679     * @return If true, the window is shaped
3680     *
3681     * @see elm_win_shaped_set()
3682     */
3683    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3684    /**
3685     * Set the alpha channel state of a window.
3686     *
3687     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3688     * possibly making parts of the window completely or partially transparent.
3689     * This is also subject to the underlying system supporting it, like for
3690     * example, running under a compositing manager. If no compositing is
3691     * available, enabling this option will instead fallback to using shaped
3692     * windows, with elm_win_shaped_set().
3693     *
3694     * @param obj The window object
3695     * @param alpha If true, the window has an alpha channel
3696     *
3697     * @see elm_win_alpha_set()
3698     */
3699    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3700    /**
3701     * Get the transparency state of a window.
3702     *
3703     * @param obj The window object
3704     * @return If true, the window is transparent
3705     *
3706     * @see elm_win_transparent_set()
3707     */
3708    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3709    /**
3710     * Set the transparency state of a window.
3711     *
3712     * Use elm_win_alpha_set() instead.
3713     *
3714     * @param obj The window object
3715     * @param transparent If true, the window is transparent
3716     *
3717     * @see elm_win_alpha_set()
3718     */
3719    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3720    /**
3721     * Get the alpha channel state of a window.
3722     *
3723     * @param obj The window object
3724     * @return If true, the window has an alpha channel
3725     */
3726    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3727    /**
3728     * Set the override state of a window.
3729     *
3730     * A window with @p override set to EINA_TRUE will not be managed by the
3731     * Window Manager. This means that no decorations of any kind will be shown
3732     * for it, moving and resizing must be handled by the application, as well
3733     * as the window visibility.
3734     *
3735     * This should not be used for normal windows, and even for not so normal
3736     * ones, it should only be used when there's a good reason and with a lot
3737     * of care. Mishandling override windows may result situations that
3738     * disrupt the normal workflow of the end user.
3739     *
3740     * @param obj The window object
3741     * @param override If true, the window is overridden
3742     */
3743    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3744    /**
3745     * Get the override state of a window.
3746     *
3747     * @param obj The window object
3748     * @return If true, the window is overridden
3749     *
3750     * @see elm_win_override_set()
3751     */
3752    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3753    /**
3754     * Set the fullscreen state of a window.
3755     *
3756     * @param obj The window object
3757     * @param fullscreen If true, the window is fullscreen
3758     */
3759    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3760    /**
3761     * Get the fullscreen state of a window.
3762     *
3763     * @param obj The window object
3764     * @return If true, the window is fullscreen
3765     */
3766    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3767    /**
3768     * Set the maximized state of a window.
3769     *
3770     * @param obj The window object
3771     * @param maximized If true, the window is maximized
3772     */
3773    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3774    /**
3775     * Get the maximized state of a window.
3776     *
3777     * @param obj The window object
3778     * @return If true, the window is maximized
3779     */
3780    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3781    /**
3782     * Set the iconified state of a window.
3783     *
3784     * @param obj The window object
3785     * @param iconified If true, the window is iconified
3786     */
3787    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3788    /**
3789     * Get the iconified state of a window.
3790     *
3791     * @param obj The window object
3792     * @return If true, the window is iconified
3793     */
3794    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3795    /**
3796     * Set the layer of the window.
3797     *
3798     * What this means exactly will depend on the underlying engine used.
3799     *
3800     * In the case of X11 backed engines, the value in @p layer has the
3801     * following meanings:
3802     * @li < 3: The window will be placed below all others.
3803     * @li > 5: The window will be placed above all others.
3804     * @li other: The window will be placed in the default layer.
3805     *
3806     * @param obj The window object
3807     * @param layer The layer of the window
3808     */
3809    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3810    /**
3811     * Get the layer of the window.
3812     *
3813     * @param obj The window object
3814     * @return The layer of the window
3815     *
3816     * @see elm_win_layer_set()
3817     */
3818    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3819    /**
3820     * Set the rotation of the window.
3821     *
3822     * Most engines only work with multiples of 90.
3823     *
3824     * This function is used to set the orientation of the window @p obj to
3825     * match that of the screen. The window itself will be resized to adjust
3826     * to the new geometry of its contents. If you want to keep the window size,
3827     * see elm_win_rotation_with_resize_set().
3828     *
3829     * @param obj The window object
3830     * @param rotation The rotation of the window, in degrees (0-360),
3831     * counter-clockwise.
3832     */
3833    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3834    /**
3835     * Rotates the window and resizes it.
3836     *
3837     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3838     * that they fit inside the current window geometry.
3839     *
3840     * @param obj The window object
3841     * @param layer The rotation of the window in degrees (0-360),
3842     * counter-clockwise.
3843     */
3844    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3845    /**
3846     * Get the rotation of the window.
3847     *
3848     * @param obj The window object
3849     * @return The rotation of the window in degrees (0-360)
3850     *
3851     * @see elm_win_rotation_set()
3852     * @see elm_win_rotation_with_resize_set()
3853     */
3854    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3855    /**
3856     * Set the sticky state of the window.
3857     *
3858     * Hints the Window Manager that the window in @p obj should be left fixed
3859     * at its position even when the virtual desktop it's on moves or changes.
3860     *
3861     * @param obj The window object
3862     * @param sticky If true, the window's sticky state is enabled
3863     */
3864    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3865    /**
3866     * Get the sticky state of the window.
3867     *
3868     * @param obj The window object
3869     * @return If true, the window's sticky state is enabled
3870     *
3871     * @see elm_win_sticky_set()
3872     */
3873    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3874    /**
3875     * Set if this window is an illume conformant window
3876     *
3877     * @param obj The window object
3878     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3879     */
3880    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3881    /**
3882     * Get if this window is an illume conformant window
3883     *
3884     * @param obj The window object
3885     * @return A boolean if this window is illume conformant or not
3886     */
3887    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3888    /**
3889     * Set a window to be an illume quickpanel window
3890     *
3891     * By default window objects are not quickpanel windows.
3892     *
3893     * @param obj The window object
3894     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3895     */
3896    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3897    /**
3898     * Get if this window is a quickpanel or not
3899     *
3900     * @param obj The window object
3901     * @return A boolean if this window is a quickpanel or not
3902     */
3903    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3904    /**
3905     * Set the major priority of a quickpanel window
3906     *
3907     * @param obj The window object
3908     * @param priority The major priority for this quickpanel
3909     */
3910    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3911    /**
3912     * Get the major priority of a quickpanel window
3913     *
3914     * @param obj The window object
3915     * @return The major priority of this quickpanel
3916     */
3917    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3918    /**
3919     * Set the minor priority of a quickpanel window
3920     *
3921     * @param obj The window object
3922     * @param priority The minor priority for this quickpanel
3923     */
3924    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3925    /**
3926     * Get the minor priority of a quickpanel window
3927     *
3928     * @param obj The window object
3929     * @return The minor priority of this quickpanel
3930     */
3931    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3932    /**
3933     * Set which zone this quickpanel should appear in
3934     *
3935     * @param obj The window object
3936     * @param zone The requested zone for this quickpanel
3937     */
3938    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
3939    /**
3940     * Get which zone this quickpanel should appear in
3941     *
3942     * @param obj The window object
3943     * @return The requested zone for this quickpanel
3944     */
3945    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3946    /**
3947     * Set the window to be skipped by keyboard focus
3948     *
3949     * This sets the window to be skipped by normal keyboard input. This means
3950     * a window manager will be asked to not focus this window as well as omit
3951     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
3952     *
3953     * Call this and enable it on a window BEFORE you show it for the first time,
3954     * otherwise it may have no effect.
3955     *
3956     * Use this for windows that have only output information or might only be
3957     * interacted with by the mouse or fingers, and never for typing input.
3958     * Be careful that this may have side-effects like making the window
3959     * non-accessible in some cases unless the window is specially handled. Use
3960     * this with care.
3961     *
3962     * @param obj The window object
3963     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
3964     */
3965    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
3966    /**
3967     * Send a command to the windowing environment
3968     *
3969     * This is intended to work in touchscreen or small screen device
3970     * environments where there is a more simplistic window management policy in
3971     * place. This uses the window object indicated to select which part of the
3972     * environment to control (the part that this window lives in), and provides
3973     * a command and an optional parameter structure (use NULL for this if not
3974     * needed).
3975     *
3976     * @param obj The window object that lives in the environment to control
3977     * @param command The command to send
3978     * @param params Optional parameters for the command
3979     */
3980    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
3981    /**
3982     * Get the inlined image object handle
3983     *
3984     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
3985     * then the window is in fact an evas image object inlined in the parent
3986     * canvas. You can get this object (be careful to not manipulate it as it
3987     * is under control of elementary), and use it to do things like get pixel
3988     * data, save the image to a file, etc.
3989     *
3990     * @param obj The window object to get the inlined image from
3991     * @return The inlined image object, or NULL if none exists
3992     */
3993    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
3994    /**
3995     * Set the enabled status for the focus highlight in a window
3996     *
3997     * This function will enable or disable the focus highlight only for the
3998     * given window, regardless of the global setting for it
3999     *
4000     * @param obj The window where to enable the highlight
4001     * @param enabled The enabled value for the highlight
4002     */
4003    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4004    /**
4005     * Get the enabled value of the focus highlight for this window
4006     *
4007     * @param obj The window in which to check if the focus highlight is enabled
4008     *
4009     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4010     */
4011    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4012    /**
4013     * Set the style for the focus highlight on this window
4014     *
4015     * Sets the style to use for theming the highlight of focused objects on
4016     * the given window. If @p style is NULL, the default will be used.
4017     *
4018     * @param obj The window where to set the style
4019     * @param style The style to set
4020     */
4021    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4022    /**
4023     * Get the style set for the focus highlight object
4024     *
4025     * Gets the style set for this windows highilght object, or NULL if none
4026     * is set.
4027     *
4028     * @param obj The window to retrieve the highlights style from
4029     *
4030     * @return The style set or NULL if none was. Default is used in that case.
4031     */
4032    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4033    /*...
4034     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4035     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4036     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4037     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4038     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4039     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4040     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4041     *
4042     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4043     * (blank mouse, private mouse obj, defaultmouse)
4044     *
4045     */
4046    /**
4047     * Sets the keyboard mode of the window.
4048     *
4049     * @param obj The window object
4050     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4051     */
4052    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4053    /**
4054     * Gets the keyboard mode of the window.
4055     *
4056     * @param obj The window object
4057     * @return The mode, one of #Elm_Win_Keyboard_Mode
4058     */
4059    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4060    /**
4061     * Sets whether the window is a keyboard.
4062     *
4063     * @param obj The window object
4064     * @param is_keyboard If true, the window is a virtual keyboard
4065     */
4066    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4067    /**
4068     * Gets whether the window is a keyboard.
4069     *
4070     * @param obj The window object
4071     * @return If the window is a virtual keyboard
4072     */
4073    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4074
4075    /**
4076     * Get the screen position of a window.
4077     *
4078     * @param obj The window object
4079     * @param x The int to store the x coordinate to
4080     * @param y The int to store the y coordinate to
4081     */
4082    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4083    /**
4084     * @}
4085     */
4086
4087    /**
4088     * @defgroup Inwin Inwin
4089     *
4090     * @image html img/widget/inwin/preview-00.png
4091     * @image latex img/widget/inwin/preview-00.eps
4092     * @image html img/widget/inwin/preview-01.png
4093     * @image latex img/widget/inwin/preview-01.eps
4094     * @image html img/widget/inwin/preview-02.png
4095     * @image latex img/widget/inwin/preview-02.eps
4096     *
4097     * An inwin is a window inside a window that is useful for a quick popup.
4098     * It does not hover.
4099     *
4100     * It works by creating an object that will occupy the entire window, so it
4101     * must be created using an @ref Win "elm_win" as parent only. The inwin
4102     * object can be hidden or restacked below every other object if it's
4103     * needed to show what's behind it without destroying it. If this is done,
4104     * the elm_win_inwin_activate() function can be used to bring it back to
4105     * full visibility again.
4106     *
4107     * There are three styles available in the default theme. These are:
4108     * @li default: The inwin is sized to take over most of the window it's
4109     * placed in.
4110     * @li minimal: The size of the inwin will be the minimum necessary to show
4111     * its contents.
4112     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4113     * possible, but it's sized vertically the most it needs to fit its\
4114     * contents.
4115     *
4116     * Some examples of Inwin can be found in the following:
4117     * @li @ref inwin_example_01
4118     *
4119     * @{
4120     */
4121    /**
4122     * Adds an inwin to the current window
4123     *
4124     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4125     * Never call this function with anything other than the top-most window
4126     * as its parameter, unless you are fond of undefined behavior.
4127     *
4128     * After creating the object, the widget will set itself as resize object
4129     * for the window with elm_win_resize_object_add(), so when shown it will
4130     * appear to cover almost the entire window (how much of it depends on its
4131     * content and the style used). It must not be added into other container
4132     * objects and it needs not be moved or resized manually.
4133     *
4134     * @param parent The parent object
4135     * @return The new object or NULL if it cannot be created
4136     */
4137    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4138    /**
4139     * Activates an inwin object, ensuring its visibility
4140     *
4141     * This function will make sure that the inwin @p obj is completely visible
4142     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4143     * to the front. It also sets the keyboard focus to it, which will be passed
4144     * onto its content.
4145     *
4146     * The object's theme will also receive the signal "elm,action,show" with
4147     * source "elm".
4148     *
4149     * @param obj The inwin to activate
4150     */
4151    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4152    /**
4153     * Set the content of an inwin object.
4154     *
4155     * Once the content object is set, a previously set one will be deleted.
4156     * If you want to keep that old content object, use the
4157     * elm_win_inwin_content_unset() function.
4158     *
4159     * @param obj The inwin object
4160     * @param content The object to set as content
4161     */
4162    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4163    /**
4164     * Get the content of an inwin object.
4165     *
4166     * Return the content object which is set for this widget.
4167     *
4168     * The returned object is valid as long as the inwin is still alive and no
4169     * other content is set on it. Deleting the object will notify the inwin
4170     * about it and this one will be left empty.
4171     *
4172     * If you need to remove an inwin's content to be reused somewhere else,
4173     * see elm_win_inwin_content_unset().
4174     *
4175     * @param obj The inwin object
4176     * @return The content that is being used
4177     */
4178    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4179    /**
4180     * Unset the content of an inwin object.
4181     *
4182     * Unparent and return the content object which was set for this widget.
4183     *
4184     * @param obj The inwin object
4185     * @return The content that was being used
4186     */
4187    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4188    /**
4189     * @}
4190     */
4191    /* X specific calls - won't work on non-x engines (return 0) */
4192
4193    /**
4194     * Get the Ecore_X_Window of an Evas_Object
4195     *
4196     * @param obj The object
4197     *
4198     * @return The Ecore_X_Window of @p obj
4199     *
4200     * @ingroup Win
4201     */
4202    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4203
4204    /* smart callbacks called:
4205     * "delete,request" - the user requested to delete the window
4206     * "focus,in" - window got focus
4207     * "focus,out" - window lost focus
4208     * "moved" - window that holds the canvas was moved
4209     */
4210
4211    /**
4212     * @defgroup Bg Bg
4213     *
4214     * @image html img/widget/bg/preview-00.png
4215     * @image latex img/widget/bg/preview-00.eps
4216     *
4217     * @brief Background object, used for setting a solid color, image or Edje
4218     * group as background to a window or any container object.
4219     *
4220     * The bg object is used for setting a solid background to a window or
4221     * packing into any container object. It works just like an image, but has
4222     * some properties useful to a background, like setting it to tiled,
4223     * centered, scaled or stretched.
4224     *
4225     * Here is some sample code using it:
4226     * @li @ref bg_01_example_page
4227     * @li @ref bg_02_example_page
4228     * @li @ref bg_03_example_page
4229     */
4230
4231    /* bg */
4232    typedef enum _Elm_Bg_Option
4233      {
4234         ELM_BG_OPTION_CENTER,  /**< center the background */
4235         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4236         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4237         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4238      } Elm_Bg_Option;
4239
4240    /**
4241     * Add a new background to the parent
4242     *
4243     * @param parent The parent object
4244     * @return The new object or NULL if it cannot be created
4245     *
4246     * @ingroup Bg
4247     */
4248    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4249
4250    /**
4251     * Set the file (image or edje) used for the background
4252     *
4253     * @param obj The bg object
4254     * @param file The file path
4255     * @param group Optional key (group in Edje) within the file
4256     *
4257     * This sets the image file used in the background object. The image (or edje)
4258     * will be stretched (retaining aspect if its an image file) to completely fill
4259     * the bg object. This may mean some parts are not visible.
4260     *
4261     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4262     * even if @p file is NULL.
4263     *
4264     * @ingroup Bg
4265     */
4266    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4267
4268    /**
4269     * Get the file (image or edje) used for the background
4270     *
4271     * @param obj The bg object
4272     * @param file The file path
4273     * @param group Optional key (group in Edje) within the file
4274     *
4275     * @ingroup Bg
4276     */
4277    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4278
4279    /**
4280     * Set the option used for the background image
4281     *
4282     * @param obj The bg object
4283     * @param option The desired background option (TILE, SCALE)
4284     *
4285     * This sets the option used for manipulating the display of the background
4286     * image. The image can be tiled or scaled.
4287     *
4288     * @ingroup Bg
4289     */
4290    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4291
4292    /**
4293     * Get the option used for the background image
4294     *
4295     * @param obj The bg object
4296     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4297     *
4298     * @ingroup Bg
4299     */
4300    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4301    /**
4302     * Set the option used for the background color
4303     *
4304     * @param obj The bg object
4305     * @param r
4306     * @param g
4307     * @param b
4308     *
4309     * This sets the color used for the background rectangle. Its range goes
4310     * from 0 to 255.
4311     *
4312     * @ingroup Bg
4313     */
4314    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4315    /**
4316     * Get the option used for the background color
4317     *
4318     * @param obj The bg object
4319     * @param r
4320     * @param g
4321     * @param b
4322     *
4323     * @ingroup Bg
4324     */
4325    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4326
4327    /**
4328     * Set the overlay object used for the background object.
4329     *
4330     * @param obj The bg object
4331     * @param overlay The overlay object
4332     *
4333     * This provides a way for elm_bg to have an 'overlay' that will be on top
4334     * of the bg. Once the over object is set, a previously set one will be
4335     * deleted, even if you set the new one to NULL. If you want to keep that
4336     * old content object, use the elm_bg_overlay_unset() function.
4337     *
4338     * @ingroup Bg
4339     */
4340
4341    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4342
4343    /**
4344     * Get the overlay object used for the background object.
4345     *
4346     * @param obj The bg object
4347     * @return The content that is being used
4348     *
4349     * Return the content object which is set for this widget
4350     *
4351     * @ingroup Bg
4352     */
4353    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4354
4355    /**
4356     * Get the overlay object used for the background object.
4357     *
4358     * @param obj The bg object
4359     * @return The content that was being used
4360     *
4361     * Unparent and return the overlay object which was set for this widget
4362     *
4363     * @ingroup Bg
4364     */
4365    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4366
4367    /**
4368     * Set the size of the pixmap representation of the image.
4369     *
4370     * This option just makes sense if an image is going to be set in the bg.
4371     *
4372     * @param obj The bg object
4373     * @param w The new width of the image pixmap representation.
4374     * @param h The new height of the image pixmap representation.
4375     *
4376     * This function sets a new size for pixmap representation of the given bg
4377     * image. It allows the image to be loaded already in the specified size,
4378     * reducing the memory usage and load time when loading a big image with load
4379     * size set to a smaller size.
4380     *
4381     * NOTE: this is just a hint, the real size of the pixmap may differ
4382     * depending on the type of image being loaded, being bigger than requested.
4383     *
4384     * @ingroup Bg
4385     */
4386    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4387    /* smart callbacks called:
4388     */
4389
4390    /**
4391     * @defgroup Icon Icon
4392     *
4393     * @image html img/widget/icon/preview-00.png
4394     * @image latex img/widget/icon/preview-00.eps
4395     *
4396     * An object that provides standard icon images (delete, edit, arrows, etc.)
4397     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4398     *
4399     * The icon image requested can be in the elementary theme, or in the
4400     * freedesktop.org paths. It's possible to set the order of preference from
4401     * where the image will be used.
4402     *
4403     * This API is very similar to @ref Image, but with ready to use images.
4404     *
4405     * Default images provided by the theme are described below.
4406     *
4407     * The first list contains icons that were first intended to be used in
4408     * toolbars, but can be used in many other places too:
4409     * @li home
4410     * @li close
4411     * @li apps
4412     * @li arrow_up
4413     * @li arrow_down
4414     * @li arrow_left
4415     * @li arrow_right
4416     * @li chat
4417     * @li clock
4418     * @li delete
4419     * @li edit
4420     * @li refresh
4421     * @li folder
4422     * @li file
4423     *
4424     * Now some icons that were designed to be used in menus (but again, you can
4425     * use them anywhere else):
4426     * @li menu/home
4427     * @li menu/close
4428     * @li menu/apps
4429     * @li menu/arrow_up
4430     * @li menu/arrow_down
4431     * @li menu/arrow_left
4432     * @li menu/arrow_right
4433     * @li menu/chat
4434     * @li menu/clock
4435     * @li menu/delete
4436     * @li menu/edit
4437     * @li menu/refresh
4438     * @li menu/folder
4439     * @li menu/file
4440     *
4441     * And here we have some media player specific icons:
4442     * @li media_player/forward
4443     * @li media_player/info
4444     * @li media_player/next
4445     * @li media_player/pause
4446     * @li media_player/play
4447     * @li media_player/prev
4448     * @li media_player/rewind
4449     * @li media_player/stop
4450     *
4451     * Signals that you can add callbacks for are:
4452     *
4453     * "clicked" - This is called when a user has clicked the icon
4454     *
4455     * An example of usage for this API follows:
4456     * @li @ref tutorial_icon
4457     */
4458
4459    /**
4460     * @addtogroup Icon
4461     * @{
4462     */
4463
4464    typedef enum _Elm_Icon_Type
4465      {
4466         ELM_ICON_NONE,
4467         ELM_ICON_FILE,
4468         ELM_ICON_STANDARD
4469      } Elm_Icon_Type;
4470    /**
4471     * @enum _Elm_Icon_Lookup_Order
4472     * @typedef Elm_Icon_Lookup_Order
4473     *
4474     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4475     * theme, FDO paths, or both?
4476     *
4477     * @ingroup Icon
4478     */
4479    typedef enum _Elm_Icon_Lookup_Order
4480      {
4481         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4482         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4483         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4484         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4485      } Elm_Icon_Lookup_Order;
4486
4487    /**
4488     * Add a new icon object to the parent.
4489     *
4490     * @param parent The parent object
4491     * @return The new object or NULL if it cannot be created
4492     *
4493     * @see elm_icon_file_set()
4494     *
4495     * @ingroup Icon
4496     */
4497    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4498    /**
4499     * Set the file that will be used as icon.
4500     *
4501     * @param obj The icon object
4502     * @param file The path to file that will be used as icon image
4503     * @param group The group that the icon belongs to in edje file
4504     *
4505     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4506     *
4507     * @note The icon image set by this function can be changed by
4508     * elm_icon_standard_set().
4509     *
4510     * @see elm_icon_file_get()
4511     *
4512     * @ingroup Icon
4513     */
4514    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4515    /**
4516     * Set a location in memory to be used as an icon
4517     *
4518     * @param obj The icon object
4519     * @param img The binary data that will be used as an image
4520     * @param size The size of binary data @p img
4521     * @param format Optional format of @p img to pass to the image loader
4522     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4523     *
4524     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4525     *
4526     * @note The icon image set by this function can be changed by
4527     * elm_icon_standard_set().
4528     *
4529     * @ingroup Icon
4530     */
4531    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);
4532    /**
4533     * Get the file that will be used as icon.
4534     *
4535     * @param obj The icon object
4536     * @param file The path to file that will be used as icon icon image
4537     * @param group The group that the icon belongs to in edje file
4538     *
4539     * @see elm_icon_file_set()
4540     *
4541     * @ingroup Icon
4542     */
4543    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4544    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4545    /**
4546     * Set the icon by icon standards names.
4547     *
4548     * @param obj The icon object
4549     * @param name The icon name
4550     *
4551     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4552     *
4553     * For example, freedesktop.org defines standard icon names such as "home",
4554     * "network", etc. There can be different icon sets to match those icon
4555     * keys. The @p name given as parameter is one of these "keys", and will be
4556     * used to look in the freedesktop.org paths and elementary theme. One can
4557     * change the lookup order with elm_icon_order_lookup_set().
4558     *
4559     * If name is not found in any of the expected locations and it is the
4560     * absolute path of an image file, this image will be used.
4561     *
4562     * @note The icon image set by this function can be changed by
4563     * elm_icon_file_set().
4564     *
4565     * @see elm_icon_standard_get()
4566     * @see elm_icon_file_set()
4567     *
4568     * @ingroup Icon
4569     */
4570    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4571    /**
4572     * Get the icon name set by icon standard names.
4573     *
4574     * @param obj The icon object
4575     * @return The icon name
4576     *
4577     * If the icon image was set using elm_icon_file_set() instead of
4578     * elm_icon_standard_set(), then this function will return @c NULL.
4579     *
4580     * @see elm_icon_standard_set()
4581     *
4582     * @ingroup Icon
4583     */
4584    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4585    /**
4586     * Set the smooth effect for an icon object.
4587     *
4588     * @param obj The icon object
4589     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4590     * otherwise. Default is @c EINA_TRUE.
4591     *
4592     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4593     * scaling provides a better resulting image, but is slower.
4594     *
4595     * The smooth scaling should be disabled when making animations that change
4596     * the icon size, since they will be faster. Animations that don't require
4597     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4598     * is already scaled, since the scaled icon image will be cached).
4599     *
4600     * @see elm_icon_smooth_get()
4601     *
4602     * @ingroup Icon
4603     */
4604    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4605    /**
4606     * Get the smooth effect for an icon object.
4607     *
4608     * @param obj The icon object
4609     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4610     *
4611     * @see elm_icon_smooth_set()
4612     *
4613     * @ingroup Icon
4614     */
4615    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4616    /**
4617     * Disable scaling of this object.
4618     *
4619     * @param obj The icon object.
4620     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4621     * otherwise. Default is @c EINA_FALSE.
4622     *
4623     * This function disables scaling of the icon object through the function
4624     * elm_object_scale_set(). However, this does not affect the object
4625     * size/resize in any way. For that effect, take a look at
4626     * elm_icon_scale_set().
4627     *
4628     * @see elm_icon_no_scale_get()
4629     * @see elm_icon_scale_set()
4630     * @see elm_object_scale_set()
4631     *
4632     * @ingroup Icon
4633     */
4634    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4635    /**
4636     * Get whether scaling is disabled on the object.
4637     *
4638     * @param obj The icon object
4639     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4640     *
4641     * @see elm_icon_no_scale_set()
4642     *
4643     * @ingroup Icon
4644     */
4645    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4646    /**
4647     * Set if the object is (up/down) resizable.
4648     *
4649     * @param obj The icon object
4650     * @param scale_up A bool to set if the object is resizable up. Default is
4651     * @c EINA_TRUE.
4652     * @param scale_down A bool to set if the object is resizable down. Default
4653     * is @c EINA_TRUE.
4654     *
4655     * This function limits the icon object resize ability. If @p scale_up is set to
4656     * @c EINA_FALSE, the object can't have its height or width resized to a value
4657     * higher than the original icon size. Same is valid for @p scale_down.
4658     *
4659     * @see elm_icon_scale_get()
4660     *
4661     * @ingroup Icon
4662     */
4663    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4664    /**
4665     * Get if the object is (up/down) resizable.
4666     *
4667     * @param obj The icon object
4668     * @param scale_up A bool to set if the object is resizable up
4669     * @param scale_down A bool to set if the object is resizable down
4670     *
4671     * @see elm_icon_scale_set()
4672     *
4673     * @ingroup Icon
4674     */
4675    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4676    /**
4677     * Get the object's image size
4678     *
4679     * @param obj The icon object
4680     * @param w A pointer to store the width in
4681     * @param h A pointer to store the height in
4682     *
4683     * @ingroup Icon
4684     */
4685    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4686    /**
4687     * Set if the icon fill the entire object area.
4688     *
4689     * @param obj The icon object
4690     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4691     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4692     *
4693     * When the icon object is resized to a different aspect ratio from the
4694     * original icon image, the icon image will still keep its aspect. This flag
4695     * tells how the image should fill the object's area. They are: keep the
4696     * entire icon inside the limits of height and width of the object (@p
4697     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4698     * of the object, and the icon will fill the entire object (@p fill_outside
4699     * is @c EINA_TRUE).
4700     *
4701     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4702     * retain property to false. Thus, the icon image will always keep its
4703     * original aspect ratio.
4704     *
4705     * @see elm_icon_fill_outside_get()
4706     * @see elm_image_fill_outside_set()
4707     *
4708     * @ingroup Icon
4709     */
4710    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4711    /**
4712     * Get if the object is filled outside.
4713     *
4714     * @param obj The icon object
4715     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4716     *
4717     * @see elm_icon_fill_outside_set()
4718     *
4719     * @ingroup Icon
4720     */
4721    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4722    /**
4723     * Set the prescale size for the icon.
4724     *
4725     * @param obj The icon object
4726     * @param size The prescale size. This value is used for both width and
4727     * height.
4728     *
4729     * This function sets a new size for pixmap representation of the given
4730     * icon. It allows the icon to be loaded already in the specified size,
4731     * reducing the memory usage and load time when loading a big icon with load
4732     * size set to a smaller size.
4733     *
4734     * It's equivalent to the elm_bg_load_size_set() function for bg.
4735     *
4736     * @note this is just a hint, the real size of the pixmap may differ
4737     * depending on the type of icon being loaded, being bigger than requested.
4738     *
4739     * @see elm_icon_prescale_get()
4740     * @see elm_bg_load_size_set()
4741     *
4742     * @ingroup Icon
4743     */
4744    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4745    /**
4746     * Get the prescale size for the icon.
4747     *
4748     * @param obj The icon object
4749     * @return The prescale size
4750     *
4751     * @see elm_icon_prescale_set()
4752     *
4753     * @ingroup Icon
4754     */
4755    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4756    /**
4757     * Sets the icon lookup order used by elm_icon_standard_set().
4758     *
4759     * @param obj The icon object
4760     * @param order The icon lookup order (can be one of
4761     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4762     * or ELM_ICON_LOOKUP_THEME)
4763     *
4764     * @see elm_icon_order_lookup_get()
4765     * @see Elm_Icon_Lookup_Order
4766     *
4767     * @ingroup Icon
4768     */
4769    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4770    /**
4771     * Gets the icon lookup order.
4772     *
4773     * @param obj The icon object
4774     * @return The icon lookup order
4775     *
4776     * @see elm_icon_order_lookup_set()
4777     * @see Elm_Icon_Lookup_Order
4778     *
4779     * @ingroup Icon
4780     */
4781    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4782    /**
4783     * Get if the icon supports animation or not.
4784     *
4785     * @param obj The icon object
4786     * @return @c EINA_TRUE if the icon supports animation,
4787     *         @c EINA_FALSE otherwise.
4788     *
4789     * Return if this elm icon's image can be animated. Currently Evas only
4790     * supports gif animation. If the return value is EINA_FALSE, other
4791     * elm_icon_animated_XXX APIs won't work.
4792     * @ingroup Icon
4793     */
4794    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4795    /**
4796     * Set animation mode of the icon.
4797     *
4798     * @param obj The icon object
4799     * @param anim @c EINA_TRUE if the object do animation job,
4800     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4801     *
4802     * Even though elm icon's file can be animated,
4803     * sometimes appication developer want to just first page of image.
4804     * In that time, don't call this function, because default value is EINA_FALSE
4805     * Only when you want icon support anition,
4806     * use this function and set animated to EINA_TURE
4807     * @ingroup Icon
4808     */
4809    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4810    /**
4811     * Get animation mode of the icon.
4812     *
4813     * @param obj The icon object
4814     * @return The animation mode of the icon object
4815     * @see elm_icon_animated_set
4816     * @ingroup Icon
4817     */
4818    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4819    /**
4820     * Set animation play mode of the icon.
4821     *
4822     * @param obj The icon object
4823     * @param play @c EINA_TRUE the object play animation images,
4824     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4825     *
4826     * If you want to play elm icon's animation, you set play to EINA_TURE.
4827     * For example, you make gif player using this set/get API and click event.
4828     *
4829     * 1. Click event occurs
4830     * 2. Check play flag using elm_icon_animaged_play_get
4831     * 3. If elm icon was playing, set play to EINA_FALSE.
4832     *    Then animation will be stopped and vice versa
4833     * @ingroup Icon
4834     */
4835    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4836    /**
4837     * Get animation play mode of the icon.
4838     *
4839     * @param obj The icon object
4840     * @return The play mode of the icon object
4841     *
4842     * @see elm_icon_animated_lay_get
4843     * @ingroup Icon
4844     */
4845    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4846
4847    /**
4848     * @}
4849     */
4850
4851    /**
4852     * @defgroup Image Image
4853     *
4854     * @image html img/widget/image/preview-00.png
4855     * @image latex img/widget/image/preview-00.eps
4856
4857     *
4858     * An object that allows one to load an image file to it. It can be used
4859     * anywhere like any other elementary widget.
4860     *
4861     * This widget provides most of the functionality provided from @ref Bg or @ref
4862     * Icon, but with a slightly different API (use the one that fits better your
4863     * needs).
4864     *
4865     * The features not provided by those two other image widgets are:
4866     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4867     * @li change the object orientation with elm_image_orient_set();
4868     * @li and turning the image editable with elm_image_editable_set().
4869     *
4870     * Signals that you can add callbacks for are:
4871     *
4872     * @li @c "clicked" - This is called when a user has clicked the image
4873     *
4874     * An example of usage for this API follows:
4875     * @li @ref tutorial_image
4876     */
4877
4878    /**
4879     * @addtogroup Image
4880     * @{
4881     */
4882
4883    /**
4884     * @enum _Elm_Image_Orient
4885     * @typedef Elm_Image_Orient
4886     *
4887     * Possible orientation options for elm_image_orient_set().
4888     *
4889     * @image html elm_image_orient_set.png
4890     * @image latex elm_image_orient_set.eps width=\textwidth
4891     *
4892     * @ingroup Image
4893     */
4894    typedef enum _Elm_Image_Orient
4895      {
4896         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4897         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4898         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4899         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4900         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4901         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4902         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4903         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4904      } Elm_Image_Orient;
4905
4906    /**
4907     * Add a new image to the parent.
4908     *
4909     * @param parent The parent object
4910     * @return The new object or NULL if it cannot be created
4911     *
4912     * @see elm_image_file_set()
4913     *
4914     * @ingroup Image
4915     */
4916    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4917    /**
4918     * Set the file that will be used as image.
4919     *
4920     * @param obj The image object
4921     * @param file The path to file that will be used as image
4922     * @param group The group that the image belongs in edje file (if it's an
4923     * edje image)
4924     *
4925     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4926     *
4927     * @see elm_image_file_get()
4928     *
4929     * @ingroup Image
4930     */
4931    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4932    /**
4933     * Get the file that will be used as image.
4934     *
4935     * @param obj The image object
4936     * @param file The path to file
4937     * @param group The group that the image belongs in edje file
4938     *
4939     * @see elm_image_file_set()
4940     *
4941     * @ingroup Image
4942     */
4943    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4944    /**
4945     * Set the smooth effect for an image.
4946     *
4947     * @param obj The image object
4948     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4949     * otherwise. Default is @c EINA_TRUE.
4950     *
4951     * Set the scaling algorithm to be used when scaling the image. Smooth
4952     * scaling provides a better resulting image, but is slower.
4953     *
4954     * The smooth scaling should be disabled when making animations that change
4955     * the image size, since it will be faster. Animations that don't require
4956     * resizing of the image can keep the smooth scaling enabled (even if the
4957     * image is already scaled, since the scaled image will be cached).
4958     *
4959     * @see elm_image_smooth_get()
4960     *
4961     * @ingroup Image
4962     */
4963    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4964    /**
4965     * Get the smooth effect for an image.
4966     *
4967     * @param obj The image object
4968     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4969     *
4970     * @see elm_image_smooth_get()
4971     *
4972     * @ingroup Image
4973     */
4974    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4975    /**
4976     * Gets the current size of the image.
4977     *
4978     * @param obj The image object.
4979     * @param w Pointer to store width, or NULL.
4980     * @param h Pointer to store height, or NULL.
4981     *
4982     * This is the real size of the image, not the size of the object.
4983     *
4984     * On error, neither w or h will be written.
4985     *
4986     * @ingroup Image
4987     */
4988    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4989    /**
4990     * Disable scaling of this object.
4991     *
4992     * @param obj The image object.
4993     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4994     * otherwise. Default is @c EINA_FALSE.
4995     *
4996     * This function disables scaling of the elm_image widget through the
4997     * function elm_object_scale_set(). However, this does not affect the widget
4998     * size/resize in any way. For that effect, take a look at
4999     * elm_image_scale_set().
5000     *
5001     * @see elm_image_no_scale_get()
5002     * @see elm_image_scale_set()
5003     * @see elm_object_scale_set()
5004     *
5005     * @ingroup Image
5006     */
5007    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5008    /**
5009     * Get whether scaling is disabled on the object.
5010     *
5011     * @param obj The image object
5012     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5013     *
5014     * @see elm_image_no_scale_set()
5015     *
5016     * @ingroup Image
5017     */
5018    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5019    /**
5020     * Set if the object is (up/down) resizable.
5021     *
5022     * @param obj The image object
5023     * @param scale_up A bool to set if the object is resizable up. Default is
5024     * @c EINA_TRUE.
5025     * @param scale_down A bool to set if the object is resizable down. Default
5026     * is @c EINA_TRUE.
5027     *
5028     * This function limits the image resize ability. If @p scale_up is set to
5029     * @c EINA_FALSE, the object can't have its height or width resized to a value
5030     * higher than the original image size. Same is valid for @p scale_down.
5031     *
5032     * @see elm_image_scale_get()
5033     *
5034     * @ingroup Image
5035     */
5036    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5037    /**
5038     * Get if the object is (up/down) resizable.
5039     *
5040     * @param obj The image object
5041     * @param scale_up A bool to set if the object is resizable up
5042     * @param scale_down A bool to set if the object is resizable down
5043     *
5044     * @see elm_image_scale_set()
5045     *
5046     * @ingroup Image
5047     */
5048    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5049    /**
5050     * Set if the image fill the entire object area when keeping the aspect ratio.
5051     *
5052     * @param obj The image object
5053     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5054     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5055     *
5056     * When the image should keep its aspect ratio even if resized to another
5057     * aspect ratio, there are two possibilities to resize it: keep the entire
5058     * image inside the limits of height and width of the object (@p fill_outside
5059     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5060     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5061     *
5062     * @note This option will have no effect if
5063     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5064     *
5065     * @see elm_image_fill_outside_get()
5066     * @see elm_image_aspect_ratio_retained_set()
5067     *
5068     * @ingroup Image
5069     */
5070    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5071    /**
5072     * Get if the object is filled outside
5073     *
5074     * @param obj The image object
5075     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5076     *
5077     * @see elm_image_fill_outside_set()
5078     *
5079     * @ingroup Image
5080     */
5081    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5082    /**
5083     * Set the prescale size for the image
5084     *
5085     * @param obj The image object
5086     * @param size The prescale size. This value is used for both width and
5087     * height.
5088     *
5089     * This function sets a new size for pixmap representation of the given
5090     * image. It allows the image to be loaded already in the specified size,
5091     * reducing the memory usage and load time when loading a big image with load
5092     * size set to a smaller size.
5093     *
5094     * It's equivalent to the elm_bg_load_size_set() function for bg.
5095     *
5096     * @note this is just a hint, the real size of the pixmap may differ
5097     * depending on the type of image being loaded, being bigger than requested.
5098     *
5099     * @see elm_image_prescale_get()
5100     * @see elm_bg_load_size_set()
5101     *
5102     * @ingroup Image
5103     */
5104    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5105    /**
5106     * Get the prescale size for the image
5107     *
5108     * @param obj The image object
5109     * @return The prescale size
5110     *
5111     * @see elm_image_prescale_set()
5112     *
5113     * @ingroup Image
5114     */
5115    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5116    /**
5117     * Set the image orientation.
5118     *
5119     * @param obj The image object
5120     * @param orient The image orientation
5121     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5122     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5123     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5124     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5125     *  Default is #ELM_IMAGE_ORIENT_NONE.
5126     *
5127     * This function allows to rotate or flip the given image.
5128     *
5129     * @see elm_image_orient_get()
5130     * @see @ref Elm_Image_Orient
5131     *
5132     * @ingroup Image
5133     */
5134    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5135    /**
5136     * Get the image orientation.
5137     *
5138     * @param obj The image object
5139     * @return The image orientation
5140     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5141     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5142     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5143     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5144     *
5145     * @see elm_image_orient_set()
5146     * @see @ref Elm_Image_Orient
5147     *
5148     * @ingroup Image
5149     */
5150    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5151    /**
5152     * Make the image 'editable'.
5153     *
5154     * @param obj Image object.
5155     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5156     *
5157     * This means the image is a valid drag target for drag and drop, and can be
5158     * cut or pasted too.
5159     *
5160     * @ingroup Image
5161     */
5162    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5163    /**
5164     * Make the image 'editable'.
5165     *
5166     * @param obj Image object.
5167     * @return Editability.
5168     *
5169     * This means the image is a valid drag target for drag and drop, and can be
5170     * cut or pasted too.
5171     *
5172     * @ingroup Image
5173     */
5174    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5175    /**
5176     * Get the basic Evas_Image object from this object (widget).
5177     *
5178     * @param obj The image object to get the inlined image from
5179     * @return The inlined image object, or NULL if none exists
5180     *
5181     * This function allows one to get the underlying @c Evas_Object of type
5182     * Image from this elementary widget. It can be useful to do things like get
5183     * the pixel data, save the image to a file, etc.
5184     *
5185     * @note Be careful to not manipulate it, as it is under control of
5186     * elementary.
5187     *
5188     * @ingroup Image
5189     */
5190    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5191    /**
5192     * Set whether the original aspect ratio of the image should be kept on resize.
5193     *
5194     * @param obj The image object.
5195     * @param retained @c EINA_TRUE if the image should retain the aspect,
5196     * @c EINA_FALSE otherwise.
5197     *
5198     * The original aspect ratio (width / height) of the image is usually
5199     * distorted to match the object's size. Enabling this option will retain
5200     * this original aspect, and the way that the image is fit into the object's
5201     * area depends on the option set by elm_image_fill_outside_set().
5202     *
5203     * @see elm_image_aspect_ratio_retained_get()
5204     * @see elm_image_fill_outside_set()
5205     *
5206     * @ingroup Image
5207     */
5208    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5209    /**
5210     * Get if the object retains the original aspect ratio.
5211     *
5212     * @param obj The image object.
5213     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5214     * otherwise.
5215     *
5216     * @ingroup Image
5217     */
5218    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5219
5220    /* smart callbacks called:
5221     * "clicked" - the user clicked the image
5222     */
5223
5224    /**
5225     * @}
5226     */
5227
5228    /* glview */
5229    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5230
5231    typedef enum _Elm_GLView_Mode
5232      {
5233         ELM_GLVIEW_ALPHA   = 1,
5234         ELM_GLVIEW_DEPTH   = 2,
5235         ELM_GLVIEW_STENCIL = 4
5236      } Elm_GLView_Mode;
5237
5238    /**
5239     * Defines a policy for the glview resizing.
5240     *
5241     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5242     */
5243    typedef enum _Elm_GLView_Resize_Policy
5244      {
5245         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5246         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5247      } Elm_GLView_Resize_Policy;
5248
5249    typedef enum _Elm_GLView_Render_Policy
5250      {
5251         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5252         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5253      } Elm_GLView_Render_Policy;
5254
5255    /**
5256     * @defgroup GLView
5257     *
5258     * A simple GLView widget that allows GL rendering.
5259     *
5260     * Signals that you can add callbacks for are:
5261     *
5262     * @{
5263     */
5264
5265    /**
5266     * Add a new glview to the parent
5267     *
5268     * @param parent The parent object
5269     * @return The new object or NULL if it cannot be created
5270     *
5271     * @ingroup GLView
5272     */
5273    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5274
5275    /**
5276     * Sets the size of the glview
5277     *
5278     * @param obj The glview object
5279     * @param width width of the glview object
5280     * @param height height of the glview object
5281     *
5282     * @ingroup GLView
5283     */
5284    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5285
5286    /**
5287     * Gets the size of the glview.
5288     *
5289     * @param obj The glview object
5290     * @param width width of the glview object
5291     * @param height height of the glview object
5292     *
5293     * Note that this function returns the actual image size of the
5294     * glview.  This means that when the scale policy is set to
5295     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5296     * size.
5297     *
5298     * @ingroup GLView
5299     */
5300    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5301
5302    /**
5303     * Gets the gl api struct for gl rendering
5304     *
5305     * @param obj The glview object
5306     * @return The api object or NULL if it cannot be created
5307     *
5308     * @ingroup GLView
5309     */
5310    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5311
5312    /**
5313     * Set the mode of the GLView. Supports Three simple modes.
5314     *
5315     * @param obj The glview object
5316     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5317     * @return True if set properly.
5318     *
5319     * @ingroup GLView
5320     */
5321    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5322
5323    /**
5324     * Set the resize policy for the glview object.
5325     *
5326     * @param obj The glview object.
5327     * @param policy The scaling policy.
5328     *
5329     * By default, the resize policy is set to
5330     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5331     * destroys the previous surface and recreates the newly specified
5332     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5333     * however, glview only scales the image object and not the underlying
5334     * GL Surface.
5335     *
5336     * @ingroup GLView
5337     */
5338    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5339
5340    /**
5341     * Set the render policy for the glview object.
5342     *
5343     * @param obj The glview object.
5344     * @param policy The render policy.
5345     *
5346     * By default, the render policy is set to
5347     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5348     * that during the render loop, glview is only redrawn if it needs
5349     * to be redrawn. (i.e. When it is visible) If the policy is set to
5350     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5351     * whether it is visible/need redrawing or not.
5352     *
5353     * @ingroup GLView
5354     */
5355    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5356
5357    /**
5358     * Set the init function that runs once in the main loop.
5359     *
5360     * @param obj The glview object.
5361     * @param func The init function to be registered.
5362     *
5363     * The registered init function gets called once during the render loop.
5364     *
5365     * @ingroup GLView
5366     */
5367    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5368
5369    /**
5370     * Set the render function that runs in the main loop.
5371     *
5372     * @param obj The glview object.
5373     * @param func The delete function to be registered.
5374     *
5375     * The registered del function gets called when GLView object is deleted.
5376     *
5377     * @ingroup GLView
5378     */
5379    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5380
5381    /**
5382     * Set the resize function that gets called when resize happens.
5383     *
5384     * @param obj The glview object.
5385     * @param func The resize function to be registered.
5386     *
5387     * @ingroup GLView
5388     */
5389    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5390
5391    /**
5392     * Set the render function that runs in the main loop.
5393     *
5394     * @param obj The glview object.
5395     * @param func The render function to be registered.
5396     *
5397     * @ingroup GLView
5398     */
5399    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5400
5401    /**
5402     * Notifies that there has been changes in the GLView.
5403     *
5404     * @param obj The glview object.
5405     *
5406     * @ingroup GLView
5407     */
5408    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5409
5410    /**
5411     * @}
5412     */
5413
5414    /* box */
5415    /**
5416     * @defgroup Box Box
5417     *
5418     * @image html img/widget/box/preview-00.png
5419     * @image latex img/widget/box/preview-00.eps width=\textwidth
5420     *
5421     * @image html img/box.png
5422     * @image latex img/box.eps width=\textwidth
5423     *
5424     * A box arranges objects in a linear fashion, governed by a layout function
5425     * that defines the details of this arrangement.
5426     *
5427     * By default, the box will use an internal function to set the layout to
5428     * a single row, either vertical or horizontal. This layout is affected
5429     * by a number of parameters, such as the homogeneous flag set by
5430     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5431     * elm_box_align_set() and the hints set to each object in the box.
5432     *
5433     * For this default layout, it's possible to change the orientation with
5434     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5435     * placing its elements ordered from top to bottom. When horizontal is set,
5436     * the order will go from left to right. If the box is set to be
5437     * homogeneous, every object in it will be assigned the same space, that
5438     * of the largest object. Padding can be used to set some spacing between
5439     * the cell given to each object. The alignment of the box, set with
5440     * elm_box_align_set(), determines how the bounding box of all the elements
5441     * will be placed within the space given to the box widget itself.
5442     *
5443     * The size hints of each object also affect how they are placed and sized
5444     * within the box. evas_object_size_hint_min_set() will give the minimum
5445     * size the object can have, and the box will use it as the basis for all
5446     * latter calculations. Elementary widgets set their own minimum size as
5447     * needed, so there's rarely any need to use it manually.
5448     *
5449     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5450     * used to tell whether the object will be allocated the minimum size it
5451     * needs or if the space given to it should be expanded. It's important
5452     * to realize that expanding the size given to the object is not the same
5453     * thing as resizing the object. It could very well end being a small
5454     * widget floating in a much larger empty space. If not set, the weight
5455     * for objects will normally be 0.0 for both axis, meaning the widget will
5456     * not be expanded. To take as much space possible, set the weight to
5457     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5458     *
5459     * Besides how much space each object is allocated, it's possible to control
5460     * how the widget will be placed within that space using
5461     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5462     * for both axis, meaning the object will be centered, but any value from
5463     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5464     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5465     * is -1.0, means the object will be resized to fill the entire space it
5466     * was allocated.
5467     *
5468     * In addition, customized functions to define the layout can be set, which
5469     * allow the application developer to organize the objects within the box
5470     * in any number of ways.
5471     *
5472     * The special elm_box_layout_transition() function can be used
5473     * to switch from one layout to another, animating the motion of the
5474     * children of the box.
5475     *
5476     * @note Objects should not be added to box objects using _add() calls.
5477     *
5478     * Some examples on how to use boxes follow:
5479     * @li @ref box_example_01
5480     * @li @ref box_example_02
5481     *
5482     * @{
5483     */
5484    /**
5485     * @typedef Elm_Box_Transition
5486     *
5487     * Opaque handler containing the parameters to perform an animated
5488     * transition of the layout the box uses.
5489     *
5490     * @see elm_box_transition_new()
5491     * @see elm_box_layout_set()
5492     * @see elm_box_layout_transition()
5493     */
5494    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5495
5496    /**
5497     * Add a new box to the parent
5498     *
5499     * By default, the box will be in vertical mode and non-homogeneous.
5500     *
5501     * @param parent The parent object
5502     * @return The new object or NULL if it cannot be created
5503     */
5504    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5505    /**
5506     * Set the horizontal orientation
5507     *
5508     * By default, box object arranges their contents vertically from top to
5509     * bottom.
5510     * By calling this function with @p horizontal as EINA_TRUE, the box will
5511     * become horizontal, arranging contents from left to right.
5512     *
5513     * @note This flag is ignored if a custom layout function is set.
5514     *
5515     * @param obj The box object
5516     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5517     * EINA_FALSE = vertical)
5518     */
5519    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5520    /**
5521     * Get the horizontal orientation
5522     *
5523     * @param obj The box object
5524     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5525     */
5526    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5527    /**
5528     * Set the box to arrange its children homogeneously
5529     *
5530     * If enabled, homogeneous layout makes all items the same size, according
5531     * to the size of the largest of its children.
5532     *
5533     * @note This flag is ignored if a custom layout function is set.
5534     *
5535     * @param obj The box object
5536     * @param homogeneous The homogeneous flag
5537     */
5538    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5539    /**
5540     * Get whether the box is using homogeneous mode or not
5541     *
5542     * @param obj The box object
5543     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5544     */
5545    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5546    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5547    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5548    /**
5549     * Add an object to the beginning of the pack list
5550     *
5551     * Pack @p subobj into the box @p obj, placing it first in the list of
5552     * children objects. The actual position the object will get on screen
5553     * depends on the layout used. If no custom layout is set, it will be at
5554     * the top or left, depending if the box is vertical or horizontal,
5555     * respectively.
5556     *
5557     * @param obj The box object
5558     * @param subobj The object to add to the box
5559     *
5560     * @see elm_box_pack_end()
5561     * @see elm_box_pack_before()
5562     * @see elm_box_pack_after()
5563     * @see elm_box_unpack()
5564     * @see elm_box_unpack_all()
5565     * @see elm_box_clear()
5566     */
5567    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5568    /**
5569     * Add an object at the end of the pack list
5570     *
5571     * Pack @p subobj into the box @p obj, placing it last in the list of
5572     * children objects. The actual position the object will get on screen
5573     * depends on the layout used. If no custom layout is set, it will be at
5574     * the bottom or right, depending if the box is vertical or horizontal,
5575     * respectively.
5576     *
5577     * @param obj The box object
5578     * @param subobj The object to add to the box
5579     *
5580     * @see elm_box_pack_start()
5581     * @see elm_box_pack_before()
5582     * @see elm_box_pack_after()
5583     * @see elm_box_unpack()
5584     * @see elm_box_unpack_all()
5585     * @see elm_box_clear()
5586     */
5587    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5588    /**
5589     * Adds an object to the box before the indicated object
5590     *
5591     * This will add the @p subobj to the box indicated before the object
5592     * indicated with @p before. If @p before is not already in the box, results
5593     * are undefined. Before means either to the left of the indicated object or
5594     * above it depending on orientation.
5595     *
5596     * @param obj The box object
5597     * @param subobj The object to add to the box
5598     * @param before The object before which to add it
5599     *
5600     * @see elm_box_pack_start()
5601     * @see elm_box_pack_end()
5602     * @see elm_box_pack_after()
5603     * @see elm_box_unpack()
5604     * @see elm_box_unpack_all()
5605     * @see elm_box_clear()
5606     */
5607    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5608    /**
5609     * Adds an object to the box after the indicated object
5610     *
5611     * This will add the @p subobj to the box indicated after the object
5612     * indicated with @p after. If @p after is not already in the box, results
5613     * are undefined. After means either to the right of the indicated object or
5614     * below it depending on orientation.
5615     *
5616     * @param obj The box object
5617     * @param subobj The object to add to the box
5618     * @param after The object after which to add it
5619     *
5620     * @see elm_box_pack_start()
5621     * @see elm_box_pack_end()
5622     * @see elm_box_pack_before()
5623     * @see elm_box_unpack()
5624     * @see elm_box_unpack_all()
5625     * @see elm_box_clear()
5626     */
5627    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5628    /**
5629     * Clear the box of all children
5630     *
5631     * Remove all the elements contained by the box, deleting the respective
5632     * objects.
5633     *
5634     * @param obj The box object
5635     *
5636     * @see elm_box_unpack()
5637     * @see elm_box_unpack_all()
5638     */
5639    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5640    /**
5641     * Unpack a box item
5642     *
5643     * Remove the object given by @p subobj from the box @p obj without
5644     * deleting it.
5645     *
5646     * @param obj The box object
5647     *
5648     * @see elm_box_unpack_all()
5649     * @see elm_box_clear()
5650     */
5651    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5652    /**
5653     * Remove all items from the box, without deleting them
5654     *
5655     * Clear the box from all children, but don't delete the respective objects.
5656     * If no other references of the box children exist, the objects will never
5657     * be deleted, and thus the application will leak the memory. Make sure
5658     * when using this function that you hold a reference to all the objects
5659     * in the box @p obj.
5660     *
5661     * @param obj The box object
5662     *
5663     * @see elm_box_clear()
5664     * @see elm_box_unpack()
5665     */
5666    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5667    /**
5668     * Retrieve a list of the objects packed into the box
5669     *
5670     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5671     * The order of the list corresponds to the packing order the box uses.
5672     *
5673     * You must free this list with eina_list_free() once you are done with it.
5674     *
5675     * @param obj The box object
5676     */
5677    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5678    /**
5679     * Set the space (padding) between the box's elements.
5680     *
5681     * Extra space in pixels that will be added between a box child and its
5682     * neighbors after its containing cell has been calculated. This padding
5683     * is set for all elements in the box, besides any possible padding that
5684     * individual elements may have through their size hints.
5685     *
5686     * @param obj The box object
5687     * @param horizontal The horizontal space between elements
5688     * @param vertical The vertical space between elements
5689     */
5690    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5691    /**
5692     * Get the space (padding) between the box's elements.
5693     *
5694     * @param obj The box object
5695     * @param horizontal The horizontal space between elements
5696     * @param vertical The vertical space between elements
5697     *
5698     * @see elm_box_padding_set()
5699     */
5700    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5701    /**
5702     * Set the alignment of the whole bouding box of contents.
5703     *
5704     * Sets how the bounding box containing all the elements of the box, after
5705     * their sizes and position has been calculated, will be aligned within
5706     * the space given for the whole box widget.
5707     *
5708     * @param obj The box object
5709     * @param horizontal The horizontal alignment of elements
5710     * @param vertical The vertical alignment of elements
5711     */
5712    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5713    /**
5714     * Get the alignment of the whole bouding box of contents.
5715     *
5716     * @param obj The box object
5717     * @param horizontal The horizontal alignment of elements
5718     * @param vertical The vertical alignment of elements
5719     *
5720     * @see elm_box_align_set()
5721     */
5722    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5723
5724    /**
5725     * Set the layout defining function to be used by the box
5726     *
5727     * Whenever anything changes that requires the box in @p obj to recalculate
5728     * the size and position of its elements, the function @p cb will be called
5729     * to determine what the layout of the children will be.
5730     *
5731     * Once a custom function is set, everything about the children layout
5732     * is defined by it. The flags set by elm_box_horizontal_set() and
5733     * elm_box_homogeneous_set() no longer have any meaning, and the values
5734     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5735     * layout function to decide if they are used and how. These last two
5736     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5737     * passed to @p cb. The @c Evas_Object the function receives is not the
5738     * Elementary widget, but the internal Evas Box it uses, so none of the
5739     * functions described here can be used on it.
5740     *
5741     * Any of the layout functions in @c Evas can be used here, as well as the
5742     * special elm_box_layout_transition().
5743     *
5744     * The final @p data argument received by @p cb is the same @p data passed
5745     * here, and the @p free_data function will be called to free it
5746     * whenever the box is destroyed or another layout function is set.
5747     *
5748     * Setting @p cb to NULL will revert back to the default layout function.
5749     *
5750     * @param obj The box object
5751     * @param cb The callback function used for layout
5752     * @param data Data that will be passed to layout function
5753     * @param free_data Function called to free @p data
5754     *
5755     * @see elm_box_layout_transition()
5756     */
5757    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);
5758    /**
5759     * Special layout function that animates the transition from one layout to another
5760     *
5761     * Normally, when switching the layout function for a box, this will be
5762     * reflected immediately on screen on the next render, but it's also
5763     * possible to do this through an animated transition.
5764     *
5765     * This is done by creating an ::Elm_Box_Transition and setting the box
5766     * layout to this function.
5767     *
5768     * For example:
5769     * @code
5770     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5771     *                            evas_object_box_layout_vertical, // start
5772     *                            NULL, // data for initial layout
5773     *                            NULL, // free function for initial data
5774     *                            evas_object_box_layout_horizontal, // end
5775     *                            NULL, // data for final layout
5776     *                            NULL, // free function for final data
5777     *                            anim_end, // will be called when animation ends
5778     *                            NULL); // data for anim_end function\
5779     * elm_box_layout_set(box, elm_box_layout_transition, t,
5780     *                    elm_box_transition_free);
5781     * @endcode
5782     *
5783     * @note This function can only be used with elm_box_layout_set(). Calling
5784     * it directly will not have the expected results.
5785     *
5786     * @see elm_box_transition_new
5787     * @see elm_box_transition_free
5788     * @see elm_box_layout_set
5789     */
5790    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5791    /**
5792     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5793     *
5794     * If you want to animate the change from one layout to another, you need
5795     * to set the layout function of the box to elm_box_layout_transition(),
5796     * passing as user data to it an instance of ::Elm_Box_Transition with the
5797     * necessary information to perform this animation. The free function to
5798     * set for the layout is elm_box_transition_free().
5799     *
5800     * The parameters to create an ::Elm_Box_Transition sum up to how long
5801     * will it be, in seconds, a layout function to describe the initial point,
5802     * another for the final position of the children and one function to be
5803     * called when the whole animation ends. This last function is useful to
5804     * set the definitive layout for the box, usually the same as the end
5805     * layout for the animation, but could be used to start another transition.
5806     *
5807     * @param start_layout The layout function that will be used to start the animation
5808     * @param start_layout_data The data to be passed the @p start_layout function
5809     * @param start_layout_free_data Function to free @p start_layout_data
5810     * @param end_layout The layout function that will be used to end the animation
5811     * @param end_layout_free_data The data to be passed the @p end_layout function
5812     * @param end_layout_free_data Function to free @p end_layout_data
5813     * @param transition_end_cb Callback function called when animation ends
5814     * @param transition_end_data Data to be passed to @p transition_end_cb
5815     * @return An instance of ::Elm_Box_Transition
5816     *
5817     * @see elm_box_transition_new
5818     * @see elm_box_layout_transition
5819     */
5820    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);
5821    /**
5822     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5823     *
5824     * This function is mostly useful as the @c free_data parameter in
5825     * elm_box_layout_set() when elm_box_layout_transition().
5826     *
5827     * @param data The Elm_Box_Transition instance to be freed.
5828     *
5829     * @see elm_box_transition_new
5830     * @see elm_box_layout_transition
5831     */
5832    EAPI void                elm_box_transition_free(void *data);
5833    /**
5834     * @}
5835     */
5836
5837    /* button */
5838    /**
5839     * @defgroup Button Button
5840     *
5841     * @image html img/widget/button/preview-00.png
5842     * @image latex img/widget/button/preview-00.eps
5843     * @image html img/widget/button/preview-01.png
5844     * @image latex img/widget/button/preview-01.eps
5845     * @image html img/widget/button/preview-02.png
5846     * @image latex img/widget/button/preview-02.eps
5847     *
5848     * This is a push-button. Press it and run some function. It can contain
5849     * a simple label and icon object and it also has an autorepeat feature.
5850     *
5851     * This widgets emits the following signals:
5852     * @li "clicked": the user clicked the button (press/release).
5853     * @li "repeated": the user pressed the button without releasing it.
5854     * @li "pressed": button was pressed.
5855     * @li "unpressed": button was released after being pressed.
5856     * In all three cases, the @c event parameter of the callback will be
5857     * @c NULL.
5858     *
5859     * Also, defined in the default theme, the button has the following styles
5860     * available:
5861     * @li default: a normal button.
5862     * @li anchor: Like default, but the button fades away when the mouse is not
5863     * over it, leaving only the text or icon.
5864     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5865     * continuous look across its options.
5866     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5867     *
5868     * Follow through a complete example @ref button_example_01 "here".
5869     * @{
5870     */
5871    /**
5872     * Add a new button to the parent's canvas
5873     *
5874     * @param parent The parent object
5875     * @return The new object or NULL if it cannot be created
5876     */
5877    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5878    /**
5879     * Set the label used in the button
5880     *
5881     * The passed @p label can be NULL to clean any existing text in it and
5882     * leave the button as an icon only object.
5883     *
5884     * @param obj The button object
5885     * @param label The text will be written on the button
5886     * @deprecated use elm_object_text_set() instead.
5887     */
5888    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5889    /**
5890     * Get the label set for the button
5891     *
5892     * The string returned is an internal pointer and should not be freed or
5893     * altered. It will also become invalid when the button is destroyed.
5894     * The string returned, if not NULL, is a stringshare, so if you need to
5895     * keep it around even after the button is destroyed, you can use
5896     * eina_stringshare_ref().
5897     *
5898     * @param obj The button object
5899     * @return The text set to the label, or NULL if nothing is set
5900     * @deprecated use elm_object_text_set() instead.
5901     */
5902    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5903    /**
5904     * Set the icon used for the button
5905     *
5906     * Setting a new icon will delete any other that was previously set, making
5907     * any reference to them invalid. If you need to maintain the previous
5908     * object alive, unset it first with elm_button_icon_unset().
5909     *
5910     * @param obj The button object
5911     * @param icon The icon object for the button
5912     */
5913    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5914    /**
5915     * Get the icon used for the button
5916     *
5917     * Return the icon object which is set for this widget. If the button is
5918     * destroyed or another icon is set, the returned object will be deleted
5919     * and any reference to it will be invalid.
5920     *
5921     * @param obj The button object
5922     * @return The icon object that is being used
5923     *
5924     * @see elm_button_icon_unset()
5925     */
5926    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5927    /**
5928     * Remove the icon set without deleting it and return the object
5929     *
5930     * This function drops the reference the button holds of the icon object
5931     * and returns this last object. It is used in case you want to remove any
5932     * icon, or set another one, without deleting the actual object. The button
5933     * will be left without an icon set.
5934     *
5935     * @param obj The button object
5936     * @return The icon object that was being used
5937     */
5938    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5939    /**
5940     * Turn on/off the autorepeat event generated when the button is kept pressed
5941     *
5942     * When off, no autorepeat is performed and buttons emit a normal @c clicked
5943     * signal when they are clicked.
5944     *
5945     * When on, keeping a button pressed will continuously emit a @c repeated
5946     * signal until the button is released. The time it takes until it starts
5947     * emitting the signal is given by
5948     * elm_button_autorepeat_initial_timeout_set(), and the time between each
5949     * new emission by elm_button_autorepeat_gap_timeout_set().
5950     *
5951     * @param obj The button object
5952     * @param on  A bool to turn on/off the event
5953     */
5954    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5955    /**
5956     * Get whether the autorepeat feature is enabled
5957     *
5958     * @param obj The button object
5959     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5960     *
5961     * @see elm_button_autorepeat_set()
5962     */
5963    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5964    /**
5965     * Set the initial timeout before the autorepeat event is generated
5966     *
5967     * Sets the timeout, in seconds, since the button is pressed until the
5968     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5969     * won't be any delay and the even will be fired the moment the button is
5970     * pressed.
5971     *
5972     * @param obj The button object
5973     * @param t   Timeout in seconds
5974     *
5975     * @see elm_button_autorepeat_set()
5976     * @see elm_button_autorepeat_gap_timeout_set()
5977     */
5978    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5979    /**
5980     * Get the initial timeout before the autorepeat event is generated
5981     *
5982     * @param obj The button object
5983     * @return Timeout in seconds
5984     *
5985     * @see elm_button_autorepeat_initial_timeout_set()
5986     */
5987    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5988    /**
5989     * Set the interval between each generated autorepeat event
5990     *
5991     * After the first @c repeated event is fired, all subsequent ones will
5992     * follow after a delay of @p t seconds for each.
5993     *
5994     * @param obj The button object
5995     * @param t   Interval in seconds
5996     *
5997     * @see elm_button_autorepeat_initial_timeout_set()
5998     */
5999    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6000    /**
6001     * Get the interval between each generated autorepeat event
6002     *
6003     * @param obj The button object
6004     * @return Interval in seconds
6005     */
6006    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6007    /**
6008     * @}
6009     */
6010
6011    /**
6012     * @defgroup File_Selector_Button File Selector Button
6013     *
6014     * @image html img/widget/fileselector_button/preview-00.png
6015     * @image latex img/widget/fileselector_button/preview-00.eps
6016     * @image html img/widget/fileselector_button/preview-01.png
6017     * @image latex img/widget/fileselector_button/preview-01.eps
6018     * @image html img/widget/fileselector_button/preview-02.png
6019     * @image latex img/widget/fileselector_button/preview-02.eps
6020     *
6021     * This is a button that, when clicked, creates an Elementary
6022     * window (or inner window) <b> with a @ref Fileselector "file
6023     * selector widget" within</b>. When a file is chosen, the (inner)
6024     * window is closed and the button emits a signal having the
6025     * selected file as it's @c event_info.
6026     *
6027     * This widget encapsulates operations on its internal file
6028     * selector on its own API. There is less control over its file
6029     * selector than that one would have instatiating one directly.
6030     *
6031     * The following styles are available for this button:
6032     * @li @c "default"
6033     * @li @c "anchor"
6034     * @li @c "hoversel_vertical"
6035     * @li @c "hoversel_vertical_entry"
6036     *
6037     * Smart callbacks one can register to:
6038     * - @c "file,chosen" - the user has selected a path, whose string
6039     *   pointer comes as the @c event_info data (a stringshared
6040     *   string)
6041     *
6042     * Here is an example on its usage:
6043     * @li @ref fileselector_button_example
6044     *
6045     * @see @ref File_Selector_Entry for a similar widget.
6046     * @{
6047     */
6048
6049    /**
6050     * Add a new file selector button widget to the given parent
6051     * Elementary (container) object
6052     *
6053     * @param parent The parent object
6054     * @return a new file selector button widget handle or @c NULL, on
6055     * errors
6056     */
6057    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6058
6059    /**
6060     * Set the label for a given file selector button widget
6061     *
6062     * @param obj The file selector button widget
6063     * @param label The text label to be displayed on @p obj
6064     *
6065     * @deprecated use elm_object_text_set() instead.
6066     */
6067    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6068
6069    /**
6070     * Get the label set for a given file selector button widget
6071     *
6072     * @param obj The file selector button widget
6073     * @return The button label
6074     *
6075     * @deprecated use elm_object_text_set() instead.
6076     */
6077    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6078
6079    /**
6080     * Set the icon on a given file selector button widget
6081     *
6082     * @param obj The file selector button widget
6083     * @param icon The icon object for the button
6084     *
6085     * Once the icon object is set, a previously set one will be
6086     * deleted. If you want to keep the latter, use the
6087     * elm_fileselector_button_icon_unset() function.
6088     *
6089     * @see elm_fileselector_button_icon_get()
6090     */
6091    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6092
6093    /**
6094     * Get the icon set for a given file selector button widget
6095     *
6096     * @param obj The file selector button widget
6097     * @return The icon object currently set on @p obj or @c NULL, if
6098     * none is
6099     *
6100     * @see elm_fileselector_button_icon_set()
6101     */
6102    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6103
6104    /**
6105     * Unset the icon used in a given file selector button widget
6106     *
6107     * @param obj The file selector button widget
6108     * @return The icon object that was being used on @p obj or @c
6109     * NULL, on errors
6110     *
6111     * Unparent and return the icon object which was set for this
6112     * widget.
6113     *
6114     * @see elm_fileselector_button_icon_set()
6115     */
6116    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6117
6118    /**
6119     * Set the title for a given file selector button widget's window
6120     *
6121     * @param obj The file selector button widget
6122     * @param title The title string
6123     *
6124     * This will change the window's title, when the file selector pops
6125     * out after a click on the button. Those windows have the default
6126     * (unlocalized) value of @c "Select a file" as titles.
6127     *
6128     * @note It will only take any effect if the file selector
6129     * button widget is @b not under "inwin mode".
6130     *
6131     * @see elm_fileselector_button_window_title_get()
6132     */
6133    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6134
6135    /**
6136     * Get the title set for a given file selector button widget's
6137     * window
6138     *
6139     * @param obj The file selector button widget
6140     * @return Title of the file selector button's window
6141     *
6142     * @see elm_fileselector_button_window_title_get() for more details
6143     */
6144    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6145
6146    /**
6147     * Set the size of a given file selector button widget's window,
6148     * holding the file selector itself.
6149     *
6150     * @param obj The file selector button widget
6151     * @param width The window's width
6152     * @param height The window's height
6153     *
6154     * @note it will only take any effect if the file selector button
6155     * widget is @b not under "inwin mode". The default size for the
6156     * window (when applicable) is 400x400 pixels.
6157     *
6158     * @see elm_fileselector_button_window_size_get()
6159     */
6160    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6161
6162    /**
6163     * Get the size of a given file selector button widget's window,
6164     * holding the file selector itself.
6165     *
6166     * @param obj The file selector button widget
6167     * @param width Pointer into which to store the width value
6168     * @param height Pointer into which to store the height value
6169     *
6170     * @note Use @c NULL pointers on the size values you're not
6171     * interested in: they'll be ignored by the function.
6172     *
6173     * @see elm_fileselector_button_window_size_set(), for more details
6174     */
6175    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6176
6177    /**
6178     * Set the initial file system path for a given file selector
6179     * button widget
6180     *
6181     * @param obj The file selector button widget
6182     * @param path The path string
6183     *
6184     * It must be a <b>directory</b> path, which will have the contents
6185     * displayed initially in the file selector's view, when invoked
6186     * from @p obj. The default initial path is the @c "HOME"
6187     * environment variable's value.
6188     *
6189     * @see elm_fileselector_button_path_get()
6190     */
6191    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6192
6193    /**
6194     * Get the initial file system path set for a given file selector
6195     * button widget
6196     *
6197     * @param obj The file selector button widget
6198     * @return path The path string
6199     *
6200     * @see elm_fileselector_button_path_set() for more details
6201     */
6202    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6203
6204    /**
6205     * Enable/disable a tree view in the given file selector button
6206     * widget's internal file selector
6207     *
6208     * @param obj The file selector button widget
6209     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6210     * disable
6211     *
6212     * This has the same effect as elm_fileselector_expandable_set(),
6213     * but now applied to a file selector button's internal file
6214     * selector.
6215     *
6216     * @note There's no way to put a file selector button's internal
6217     * file selector in "grid mode", as one may do with "pure" file
6218     * selectors.
6219     *
6220     * @see elm_fileselector_expandable_get()
6221     */
6222    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6223
6224    /**
6225     * Get whether tree view is enabled for the given file selector
6226     * button widget's internal file selector
6227     *
6228     * @param obj The file selector button widget
6229     * @return @c EINA_TRUE if @p obj widget's internal file selector
6230     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6231     *
6232     * @see elm_fileselector_expandable_set() for more details
6233     */
6234    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6235
6236    /**
6237     * Set whether a given file selector button widget's internal file
6238     * selector is to display folders only or the directory contents,
6239     * as well.
6240     *
6241     * @param obj The file selector button widget
6242     * @param only @c EINA_TRUE to make @p obj widget's internal file
6243     * selector only display directories, @c EINA_FALSE to make files
6244     * to be displayed in it too
6245     *
6246     * This has the same effect as elm_fileselector_folder_only_set(),
6247     * but now applied to a file selector button's internal file
6248     * selector.
6249     *
6250     * @see elm_fileselector_folder_only_get()
6251     */
6252    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6253
6254    /**
6255     * Get whether a given file selector button widget's internal file
6256     * selector is displaying folders only or the directory contents,
6257     * as well.
6258     *
6259     * @param obj The file selector button widget
6260     * @return @c EINA_TRUE if @p obj widget's internal file
6261     * selector is only displaying directories, @c EINA_FALSE if files
6262     * are being displayed in it too (and on errors)
6263     *
6264     * @see elm_fileselector_button_folder_only_set() for more details
6265     */
6266    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6267
6268    /**
6269     * Enable/disable the file name entry box where the user can type
6270     * in a name for a file, in a given file selector button widget's
6271     * internal file selector.
6272     *
6273     * @param obj The file selector button widget
6274     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6275     * file selector a "saving dialog", @c EINA_FALSE otherwise
6276     *
6277     * This has the same effect as elm_fileselector_is_save_set(),
6278     * but now applied to a file selector button's internal file
6279     * selector.
6280     *
6281     * @see elm_fileselector_is_save_get()
6282     */
6283    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6284
6285    /**
6286     * Get whether the given file selector button widget's internal
6287     * file selector is in "saving dialog" mode
6288     *
6289     * @param obj The file selector button widget
6290     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6291     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6292     * errors)
6293     *
6294     * @see elm_fileselector_button_is_save_set() for more details
6295     */
6296    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6297
6298    /**
6299     * Set whether a given file selector button widget's internal file
6300     * selector will raise an Elementary "inner window", instead of a
6301     * dedicated Elementary window. By default, it won't.
6302     *
6303     * @param obj The file selector button widget
6304     * @param value @c EINA_TRUE to make it use an inner window, @c
6305     * EINA_TRUE to make it use a dedicated window
6306     *
6307     * @see elm_win_inwin_add() for more information on inner windows
6308     * @see elm_fileselector_button_inwin_mode_get()
6309     */
6310    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6311
6312    /**
6313     * Get whether a given file selector button widget's internal file
6314     * selector will raise an Elementary "inner window", instead of a
6315     * dedicated Elementary window.
6316     *
6317     * @param obj The file selector button widget
6318     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6319     * if it will use a dedicated window
6320     *
6321     * @see elm_fileselector_button_inwin_mode_set() for more details
6322     */
6323    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6324
6325    /**
6326     * @}
6327     */
6328
6329     /**
6330     * @defgroup File_Selector_Entry File Selector Entry
6331     *
6332     * @image html img/widget/fileselector_entry/preview-00.png
6333     * @image latex img/widget/fileselector_entry/preview-00.eps
6334     *
6335     * This is an entry made to be filled with or display a <b>file
6336     * system path string</b>. Besides the entry itself, the widget has
6337     * a @ref File_Selector_Button "file selector button" on its side,
6338     * which will raise an internal @ref Fileselector "file selector widget",
6339     * when clicked, for path selection aided by file system
6340     * navigation.
6341     *
6342     * This file selector may appear in an Elementary window or in an
6343     * inner window. When a file is chosen from it, the (inner) window
6344     * is closed and the selected file's path string is exposed both as
6345     * an smart event and as the new text on the entry.
6346     *
6347     * This widget encapsulates operations on its internal file
6348     * selector on its own API. There is less control over its file
6349     * selector than that one would have instatiating one directly.
6350     *
6351     * Smart callbacks one can register to:
6352     * - @c "changed" - The text within the entry was changed
6353     * - @c "activated" - The entry has had editing finished and
6354     *   changes are to be "committed"
6355     * - @c "press" - The entry has been clicked
6356     * - @c "longpressed" - The entry has been clicked (and held) for a
6357     *   couple seconds
6358     * - @c "clicked" - The entry has been clicked
6359     * - @c "clicked,double" - The entry has been double clicked
6360     * - @c "focused" - The entry has received focus
6361     * - @c "unfocused" - The entry has lost focus
6362     * - @c "selection,paste" - A paste action has occurred on the
6363     *   entry
6364     * - @c "selection,copy" - A copy action has occurred on the entry
6365     * - @c "selection,cut" - A cut action has occurred on the entry
6366     * - @c "unpressed" - The file selector entry's button was released
6367     *   after being pressed.
6368     * - @c "file,chosen" - The user has selected a path via the file
6369     *   selector entry's internal file selector, whose string pointer
6370     *   comes as the @c event_info data (a stringshared string)
6371     *
6372     * Here is an example on its usage:
6373     * @li @ref fileselector_entry_example
6374     *
6375     * @see @ref File_Selector_Button for a similar widget.
6376     * @{
6377     */
6378
6379    /**
6380     * Add a new file selector entry widget to the given parent
6381     * Elementary (container) object
6382     *
6383     * @param parent The parent object
6384     * @return a new file selector entry widget handle or @c NULL, on
6385     * errors
6386     */
6387    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6388
6389    /**
6390     * Set the label for a given file selector entry widget's button
6391     *
6392     * @param obj The file selector entry widget
6393     * @param label The text label to be displayed on @p obj widget's
6394     * button
6395     *
6396     * @deprecated use elm_object_text_set() instead.
6397     */
6398    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6399
6400    /**
6401     * Get the label set for a given file selector entry widget's button
6402     *
6403     * @param obj The file selector entry widget
6404     * @return The widget button's label
6405     *
6406     * @deprecated use elm_object_text_set() instead.
6407     */
6408    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6409
6410    /**
6411     * Set the icon on a given file selector entry widget's button
6412     *
6413     * @param obj The file selector entry widget
6414     * @param icon The icon object for the entry's button
6415     *
6416     * Once the icon object is set, a previously set one will be
6417     * deleted. If you want to keep the latter, use the
6418     * elm_fileselector_entry_button_icon_unset() function.
6419     *
6420     * @see elm_fileselector_entry_button_icon_get()
6421     */
6422    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6423
6424    /**
6425     * Get the icon set for a given file selector entry widget's button
6426     *
6427     * @param obj The file selector entry widget
6428     * @return The icon object currently set on @p obj widget's button
6429     * or @c NULL, if none is
6430     *
6431     * @see elm_fileselector_entry_button_icon_set()
6432     */
6433    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6434
6435    /**
6436     * Unset the icon used in a given file selector entry widget's
6437     * button
6438     *
6439     * @param obj The file selector entry widget
6440     * @return The icon object that was being used on @p obj widget's
6441     * button or @c NULL, on errors
6442     *
6443     * Unparent and return the icon object which was set for this
6444     * widget's button.
6445     *
6446     * @see elm_fileselector_entry_button_icon_set()
6447     */
6448    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6449
6450    /**
6451     * Set the title for a given file selector entry widget's window
6452     *
6453     * @param obj The file selector entry widget
6454     * @param title The title string
6455     *
6456     * This will change the window's title, when the file selector pops
6457     * out after a click on the entry's button. Those windows have the
6458     * default (unlocalized) value of @c "Select a file" as titles.
6459     *
6460     * @note It will only take any effect if the file selector
6461     * entry widget is @b not under "inwin mode".
6462     *
6463     * @see elm_fileselector_entry_window_title_get()
6464     */
6465    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6466
6467    /**
6468     * Get the title set for a given file selector entry widget's
6469     * window
6470     *
6471     * @param obj The file selector entry widget
6472     * @return Title of the file selector entry's window
6473     *
6474     * @see elm_fileselector_entry_window_title_get() for more details
6475     */
6476    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6477
6478    /**
6479     * Set the size of a given file selector entry widget's window,
6480     * holding the file selector itself.
6481     *
6482     * @param obj The file selector entry widget
6483     * @param width The window's width
6484     * @param height The window's height
6485     *
6486     * @note it will only take any effect if the file selector entry
6487     * widget is @b not under "inwin mode". The default size for the
6488     * window (when applicable) is 400x400 pixels.
6489     *
6490     * @see elm_fileselector_entry_window_size_get()
6491     */
6492    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6493
6494    /**
6495     * Get the size of a given file selector entry widget's window,
6496     * holding the file selector itself.
6497     *
6498     * @param obj The file selector entry widget
6499     * @param width Pointer into which to store the width value
6500     * @param height Pointer into which to store the height value
6501     *
6502     * @note Use @c NULL pointers on the size values you're not
6503     * interested in: they'll be ignored by the function.
6504     *
6505     * @see elm_fileselector_entry_window_size_set(), for more details
6506     */
6507    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6508
6509    /**
6510     * Set the initial file system path and the entry's path string for
6511     * a given file selector entry widget
6512     *
6513     * @param obj The file selector entry widget
6514     * @param path The path string
6515     *
6516     * It must be a <b>directory</b> path, which will have the contents
6517     * displayed initially in the file selector's view, when invoked
6518     * from @p obj. The default initial path is the @c "HOME"
6519     * environment variable's value.
6520     *
6521     * @see elm_fileselector_entry_path_get()
6522     */
6523    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6524
6525    /**
6526     * Get the entry's path string for a given file selector entry
6527     * widget
6528     *
6529     * @param obj The file selector entry widget
6530     * @return path The path string
6531     *
6532     * @see elm_fileselector_entry_path_set() for more details
6533     */
6534    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6535
6536    /**
6537     * Enable/disable a tree view in the given file selector entry
6538     * widget's internal file selector
6539     *
6540     * @param obj The file selector entry widget
6541     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6542     * disable
6543     *
6544     * This has the same effect as elm_fileselector_expandable_set(),
6545     * but now applied to a file selector entry's internal file
6546     * selector.
6547     *
6548     * @note There's no way to put a file selector entry's internal
6549     * file selector in "grid mode", as one may do with "pure" file
6550     * selectors.
6551     *
6552     * @see elm_fileselector_expandable_get()
6553     */
6554    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6555
6556    /**
6557     * Get whether tree view is enabled for the given file selector
6558     * entry widget's internal file selector
6559     *
6560     * @param obj The file selector entry widget
6561     * @return @c EINA_TRUE if @p obj widget's internal file selector
6562     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6563     *
6564     * @see elm_fileselector_expandable_set() for more details
6565     */
6566    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6567
6568    /**
6569     * Set whether a given file selector entry widget's internal file
6570     * selector is to display folders only or the directory contents,
6571     * as well.
6572     *
6573     * @param obj The file selector entry widget
6574     * @param only @c EINA_TRUE to make @p obj widget's internal file
6575     * selector only display directories, @c EINA_FALSE to make files
6576     * to be displayed in it too
6577     *
6578     * This has the same effect as elm_fileselector_folder_only_set(),
6579     * but now applied to a file selector entry's internal file
6580     * selector.
6581     *
6582     * @see elm_fileselector_folder_only_get()
6583     */
6584    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6585
6586    /**
6587     * Get whether a given file selector entry widget's internal file
6588     * selector is displaying folders only or the directory contents,
6589     * as well.
6590     *
6591     * @param obj The file selector entry widget
6592     * @return @c EINA_TRUE if @p obj widget's internal file
6593     * selector is only displaying directories, @c EINA_FALSE if files
6594     * are being displayed in it too (and on errors)
6595     *
6596     * @see elm_fileselector_entry_folder_only_set() for more details
6597     */
6598    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6599
6600    /**
6601     * Enable/disable the file name entry box where the user can type
6602     * in a name for a file, in a given file selector entry widget's
6603     * internal file selector.
6604     *
6605     * @param obj The file selector entry widget
6606     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6607     * file selector a "saving dialog", @c EINA_FALSE otherwise
6608     *
6609     * This has the same effect as elm_fileselector_is_save_set(),
6610     * but now applied to a file selector entry's internal file
6611     * selector.
6612     *
6613     * @see elm_fileselector_is_save_get()
6614     */
6615    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6616
6617    /**
6618     * Get whether the given file selector entry widget's internal
6619     * file selector is in "saving dialog" mode
6620     *
6621     * @param obj The file selector entry widget
6622     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6623     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6624     * errors)
6625     *
6626     * @see elm_fileselector_entry_is_save_set() for more details
6627     */
6628    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6629
6630    /**
6631     * Set whether a given file selector entry widget's internal file
6632     * selector will raise an Elementary "inner window", instead of a
6633     * dedicated Elementary window. By default, it won't.
6634     *
6635     * @param obj The file selector entry widget
6636     * @param value @c EINA_TRUE to make it use an inner window, @c
6637     * EINA_TRUE to make it use a dedicated window
6638     *
6639     * @see elm_win_inwin_add() for more information on inner windows
6640     * @see elm_fileselector_entry_inwin_mode_get()
6641     */
6642    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6643
6644    /**
6645     * Get whether a given file selector entry widget's internal file
6646     * selector will raise an Elementary "inner window", instead of a
6647     * dedicated Elementary window.
6648     *
6649     * @param obj The file selector entry widget
6650     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6651     * if it will use a dedicated window
6652     *
6653     * @see elm_fileselector_entry_inwin_mode_set() for more details
6654     */
6655    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6656
6657    /**
6658     * Set the initial file system path for a given file selector entry
6659     * widget
6660     *
6661     * @param obj The file selector entry widget
6662     * @param path The path string
6663     *
6664     * It must be a <b>directory</b> path, which will have the contents
6665     * displayed initially in the file selector's view, when invoked
6666     * from @p obj. The default initial path is the @c "HOME"
6667     * environment variable's value.
6668     *
6669     * @see elm_fileselector_entry_path_get()
6670     */
6671    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6672
6673    /**
6674     * Get the parent directory's path to the latest file selection on
6675     * a given filer selector entry widget
6676     *
6677     * @param obj The file selector object
6678     * @return The (full) path of the directory of the last selection
6679     * on @p obj widget, a @b stringshared string
6680     *
6681     * @see elm_fileselector_entry_path_set()
6682     */
6683    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6684
6685    /**
6686     * @}
6687     */
6688
6689    /**
6690     * @defgroup Scroller Scroller
6691     *
6692     * A scroller holds a single object and "scrolls it around". This means that
6693     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6694     * region around, allowing to move through a much larger object that is
6695     * contained in the scroller. The scroiller will always have a small minimum
6696     * size by default as it won't be limited by the contents of the scroller.
6697     *
6698     * Signals that you can add callbacks for are:
6699     * @li "edge,left" - the left edge of the content has been reached
6700     * @li "edge,right" - the right edge of the content has been reached
6701     * @li "edge,top" - the top edge of the content has been reached
6702     * @li "edge,bottom" - the bottom edge of the content has been reached
6703     * @li "scroll" - the content has been scrolled (moved)
6704     * @li "scroll,anim,start" - scrolling animation has started
6705     * @li "scroll,anim,stop" - scrolling animation has stopped
6706     * @li "scroll,drag,start" - dragging the contents around has started
6707     * @li "scroll,drag,stop" - dragging the contents around has stopped
6708     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6709     * user intervetion.
6710     *
6711     * @note When Elemementary is in embedded mode the scrollbars will not be
6712     * dragable, they appear merely as indicators of how much has been scrolled.
6713     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6714     * fingerscroll) won't work.
6715     *
6716     * In @ref tutorial_scroller you'll find an example of how to use most of
6717     * this API.
6718     * @{
6719     */
6720    /**
6721     * @brief Type that controls when scrollbars should appear.
6722     *
6723     * @see elm_scroller_policy_set()
6724     */
6725    typedef enum _Elm_Scroller_Policy
6726      {
6727         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6728         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6729         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6730         ELM_SCROLLER_POLICY_LAST
6731      } Elm_Scroller_Policy;
6732    /**
6733     * @brief Add a new scroller to the parent
6734     *
6735     * @param parent The parent object
6736     * @return The new object or NULL if it cannot be created
6737     */
6738    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6739    /**
6740     * @brief Set the content of the scroller widget (the object to be scrolled around).
6741     *
6742     * @param obj The scroller object
6743     * @param content The new content object
6744     *
6745     * Once the content object is set, a previously set one will be deleted.
6746     * If you want to keep that old content object, use the
6747     * elm_scroller_content_unset() function.
6748     */
6749    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6750    /**
6751     * @brief Get the content of the scroller widget
6752     *
6753     * @param obj The slider object
6754     * @return The content that is being used
6755     *
6756     * Return the content object which is set for this widget
6757     *
6758     * @see elm_scroller_content_set()
6759     */
6760    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6761    /**
6762     * @brief Unset the content of the scroller widget
6763     *
6764     * @param obj The slider object
6765     * @return The content that was being used
6766     *
6767     * Unparent and return the content object which was set for this widget
6768     *
6769     * @see elm_scroller_content_set()
6770     */
6771    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6772    /**
6773     * @brief Set custom theme elements for the scroller
6774     *
6775     * @param obj The scroller object
6776     * @param widget The widget name to use (default is "scroller")
6777     * @param base The base name to use (default is "base")
6778     */
6779    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6780    /**
6781     * @brief Make the scroller minimum size limited to the minimum size of the content
6782     *
6783     * @param obj The scroller object
6784     * @param w Enable limiting minimum size horizontally
6785     * @param h Enable limiting minimum size vertically
6786     *
6787     * By default the scroller will be as small as its design allows,
6788     * irrespective of its content. This will make the scroller minimum size the
6789     * right size horizontally and/or vertically to perfectly fit its content in
6790     * that direction.
6791     */
6792    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6793    /**
6794     * @brief Show a specific virtual region within the scroller content object
6795     *
6796     * @param obj The scroller object
6797     * @param x X coordinate of the region
6798     * @param y Y coordinate of the region
6799     * @param w Width of the region
6800     * @param h Height of the region
6801     *
6802     * This will ensure all (or part if it does not fit) of the designated
6803     * region in the virtual content object (0, 0 starting at the top-left of the
6804     * virtual content object) is shown within the scroller.
6805     */
6806    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);
6807    /**
6808     * @brief Set the scrollbar visibility policy
6809     *
6810     * @param obj The scroller object
6811     * @param policy_h Horizontal scrollbar policy
6812     * @param policy_v Vertical scrollbar policy
6813     *
6814     * This sets the scrollbar visibility policy for the given scroller.
6815     * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6816     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6817     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6818     * respectively for the horizontal and vertical scrollbars.
6819     */
6820    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6821    /**
6822     * @brief Gets scrollbar visibility policy
6823     *
6824     * @param obj The scroller object
6825     * @param policy_h Horizontal scrollbar policy
6826     * @param policy_v Vertical scrollbar policy
6827     *
6828     * @see elm_scroller_policy_set()
6829     */
6830    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6831    /**
6832     * @brief Get the currently visible content region
6833     *
6834     * @param obj The scroller object
6835     * @param x X coordinate of the region
6836     * @param y Y coordinate of the region
6837     * @param w Width of the region
6838     * @param h Height of the region
6839     *
6840     * This gets the current region in the content object that is visible through
6841     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6842     * w, @p h values pointed to.
6843     *
6844     * @note All coordinates are relative to the content.
6845     *
6846     * @see elm_scroller_region_show()
6847     */
6848    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);
6849    /**
6850     * @brief Get the size of the content object
6851     *
6852     * @param obj The scroller object
6853     * @param w Width return
6854     * @param h Height return
6855     *
6856     * This gets the size of the content object of the scroller.
6857     */
6858    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6859    /**
6860     * @brief Set bouncing behavior
6861     *
6862     * @param obj The scroller object
6863     * @param h_bounce Will the scroller bounce horizontally or not
6864     * @param v_bounce Will the scroller bounce vertically or not
6865     *
6866     * When scrolling, the scroller may "bounce" when reaching an edge of the
6867     * content object. This is a visual way to indicate the end has been reached.
6868     * This is enabled by default for both axis. This will set if it is enabled
6869     * for that axis with the boolean parameters for each axis.
6870     */
6871    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6872    /**
6873     * @brief Get the bounce mode
6874     *
6875     * @param obj The Scroller object
6876     * @param h_bounce Allow bounce horizontally
6877     * @param v_bounce Allow bounce vertically
6878     *
6879     * @see elm_scroller_bounce_set()
6880     */
6881    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6882    /**
6883     * @brief Set scroll page size relative to viewport size.
6884     *
6885     * @param obj The scroller object
6886     * @param h_pagerel The horizontal page relative size
6887     * @param v_pagerel The vertical page relative size
6888     *
6889     * The scroller is capable of limiting scrolling by the user to "pages". That
6890     * is to jump by and only show a "whole page" at a time as if the continuous
6891     * area of the scroller content is split into page sized pieces. This sets
6892     * the size of a page relative to the viewport of the scroller. 1.0 is "1
6893     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6894     * axis. This is mutually exclusive with page size
6895     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
6896     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6897     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6898     * the other axis.
6899     */
6900    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6901    /**
6902     * @brief Set scroll page size.
6903     *
6904     * @param obj The scroller object
6905     * @param h_pagesize The horizontal page size
6906     * @param v_pagesize The vertical page size
6907     *
6908     * This sets the page size to an absolute fixed value, with 0 turning it off
6909     * for that axis.
6910     *
6911     * @see elm_scroller_page_relative_set()
6912     */
6913    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6914    /**
6915     * @brief Get scroll current page number.
6916     *
6917     * @param obj The scroller object
6918     * @param h_pagenumber The horizoptal page number
6919     * @param v_pagenumber The vertical page number
6920     *
6921     * The page number starts from 0. 0 is the first page.
6922     * Current page means the page which meet the top-left of the viewport.
6923     * If there are two or more pages in the viewport, it returns the number of page
6924     * which meet the top-left of the viewport.
6925     * 
6926     * @see elm_scroller_last_page_get() 
6927     * @see elm_scroller_page_show() 
6928     * @see elm_scroller_page_brint_in() 
6929     */
6930    EAPI void         elm_scroller_current_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
6931    /**
6932     * @brief Get scroll last page number.
6933     *
6934     * @param obj The scroller object
6935     * @param h_pagenumber The horizoptal page number
6936     * @param v_pagenumber The vertical page number
6937     *
6938     * The page number starts from 0. 0 is the first page.
6939     * This returns the last page number among the pages.
6940     *
6941     * @see elm_scroller_current_page_get() 
6942     * @see elm_scroller_page_show() 
6943     * @see elm_scroller_page_brint_in() 
6944     */
6945    EAPI void         elm_scroller_last_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
6946    /**
6947     * Show a specific virtual region within the scroller content object by page number.
6948     *
6949     * @param obj The scroller object
6950     * @param h_pagenumber The horizoptal page number
6951     * @param v_pagenumber The vertical page number
6952     *
6953     * 0, 0 of the indicated page is located at the top-left of the viewport.
6954     * This will jump to the page directly without animation.
6955     *
6956     * Example of usage:
6957     *
6958     * @code
6959     * sc = elm_scroller_add(win);
6960     * elm_scroller_content_set(sc, content);
6961     * elm_scroller_page_relative_set(sc, 1, 0);
6962     * elm_scroller_current_page_get(sc, &h_page, &v_page);
6963     * elm_scroller_page_show(sc, h_page + 1, v_page);
6964     * @endcode
6965     *
6966     * @see elm_scroller_page_bring_in()
6967     */
6968    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
6969    /**
6970     * Show a specific virtual region within the scroller content object by page number.
6971     *
6972     * @param obj The scroller object
6973     * @param h_pagenumber The horizoptal page number
6974     * @param v_pagenumber The vertical page number
6975     *
6976     * 0, 0 of the indicated page is located at the top-left of the viewport.
6977     * This will slide to the page with animation.
6978     *
6979     * Example of usage:
6980     *
6981     * @code
6982     * sc = elm_scroller_add(win);
6983     * elm_scroller_content_set(sc, content);
6984     * elm_scroller_page_relative_set(sc, 1, 0);
6985     * elm_scroller_last_page_get(sc, &h_page, &v_page);
6986     * elm_scroller_page_bring_in(sc, h_page, v_page);
6987     * @endcode
6988     *
6989     * @see elm_scroller_page_show()
6990     */
6991    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
6992    /**
6993     * @brief Show a specific virtual region within the scroller content object.
6994     *
6995     * @param obj The scroller object
6996     * @param x X coordinate of the region
6997     * @param y Y coordinate of the region
6998     * @param w Width of the region
6999     * @param h Height of the region
7000     *
7001     * This will ensure all (or part if it does not fit) of the designated
7002     * region in the virtual content object (0, 0 starting at the top-left of the
7003     * virtual content object) is shown within the scroller. Unlike
7004     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7005     * to this location (if configuration in general calls for transitions). It
7006     * may not jump immediately to the new location and make take a while and
7007     * show other content along the way.
7008     *
7009     * @see elm_scroller_region_show()
7010     */
7011    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);
7012    /**
7013     * @brief Set event propagation on a scroller
7014     *
7015     * @param obj The scroller object
7016     * @param propagation If propagation is enabled or not
7017     *
7018     * This enables or disabled event propagation from the scroller content to
7019     * the scroller and its parent. By default event propagation is disabled.
7020     */
7021    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7022    /**
7023     * @brief Get event propagation for a scroller
7024     *
7025     * @param obj The scroller object
7026     * @return The propagation state
7027     *
7028     * This gets the event propagation for a scroller.
7029     *
7030     * @see elm_scroller_propagate_events_set()
7031     */
7032    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
7033    /**
7034     * @}
7035     */
7036
7037    /**
7038     * @defgroup Label Label
7039     *
7040     * @image html img/widget/label/preview-00.png
7041     * @image latex img/widget/label/preview-00.eps
7042     *
7043     * @brief Widget to display text, with simple html-like markup.
7044     *
7045     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7046     * text doesn't fit the geometry of the label it will be ellipsized or be
7047     * cut. Elementary provides several themes for this widget:
7048     * @li default - No animation
7049     * @li marker - Centers the text in the label and make it bold by default
7050     * @li slide_long - The entire text appears from the right of the screen and
7051     * slides until it disappears in the left of the screen(reappering on the
7052     * right again).
7053     * @li slide_short - The text appears in the left of the label and slides to
7054     * the right to show the overflow. When all of the text has been shown the
7055     * position is reset.
7056     * @li slide_bounce - The text appears in the left of the label and slides to
7057     * the right to show the overflow. When all of the text has been shown the
7058     * animation reverses, moving the text to the left.
7059     *
7060     * Custom themes can of course invent new markup tags and style them any way
7061     * they like.
7062     *
7063     * See @ref tutorial_label for a demonstration of how to use a label widget.
7064     * @{
7065     */
7066    /**
7067     * @brief Add a new label to the parent
7068     *
7069     * @param parent The parent object
7070     * @return The new object or NULL if it cannot be created
7071     */
7072    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7073    /**
7074     * @brief Set the label on the label object
7075     *
7076     * @param obj The label object
7077     * @param label The label will be used on the label object
7078     * @deprecated See elm_object_text_set()
7079     */
7080    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 */
7081    /**
7082     * @brief Get the label used on the label object
7083     *
7084     * @param obj The label object
7085     * @return The string inside the label
7086     * @deprecated See elm_object_text_get()
7087     */
7088    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7089    /**
7090     * @brief Set the wrapping behavior of the label
7091     *
7092     * @param obj The label object
7093     * @param wrap To wrap text or not
7094     *
7095     * By default no wrapping is done. Possible values for @p wrap are:
7096     * @li ELM_WRAP_NONE - No wrapping
7097     * @li ELM_WRAP_CHAR - wrap between characters
7098     * @li ELM_WRAP_WORD - wrap between words
7099     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7100     */
7101    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7102    /**
7103     * @brief Get the wrapping behavior of the label
7104     *
7105     * @param obj The label object
7106     * @return Wrap type
7107     *
7108     * @see elm_label_line_wrap_set()
7109     */
7110    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7111    /**
7112     * @brief Set wrap width of the label
7113     *
7114     * @param obj The label object
7115     * @param w The wrap width in pixels at a minimum where words need to wrap
7116     *
7117     * This function sets the maximum width size hint of the label.
7118     *
7119     * @warning This is only relevant if the label is inside a container.
7120     */
7121    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7122    /**
7123     * @brief Get wrap width of the label
7124     *
7125     * @param obj The label object
7126     * @return The wrap width in pixels at a minimum where words need to wrap
7127     *
7128     * @see elm_label_wrap_width_set()
7129     */
7130    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7131    /**
7132     * @brief Set wrap height of the label
7133     *
7134     * @param obj The label object
7135     * @param h The wrap height in pixels at a minimum where words need to wrap
7136     *
7137     * This function sets the maximum height size hint of the label.
7138     *
7139     * @warning This is only relevant if the label is inside a container.
7140     */
7141    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7142    /**
7143     * @brief get wrap width of the label
7144     *
7145     * @param obj The label object
7146     * @return The wrap height in pixels at a minimum where words need to wrap
7147     */
7148    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7149    /**
7150     * @brief Set the font size on the label object.
7151     *
7152     * @param obj The label object
7153     * @param size font size
7154     *
7155     * @warning NEVER use this. It is for hyper-special cases only. use styles
7156     * instead. e.g. "big", "medium", "small" - or better name them by use:
7157     * "title", "footnote", "quote" etc.
7158     */
7159    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7160    /**
7161     * @brief Set the text color on the label object
7162     *
7163     * @param obj The label object
7164     * @param r Red property background color of The label object
7165     * @param g Green property background color of The label object
7166     * @param b Blue property background color of The label object
7167     * @param a Alpha property background color of The label object
7168     *
7169     * @warning NEVER use this. It is for hyper-special cases only. use styles
7170     * instead. e.g. "big", "medium", "small" - or better name them by use:
7171     * "title", "footnote", "quote" etc.
7172     */
7173    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);
7174    /**
7175     * @brief Set the text align on the label object
7176     *
7177     * @param obj The label object
7178     * @param align align mode ("left", "center", "right")
7179     *
7180     * @warning NEVER use this. It is for hyper-special cases only. use styles
7181     * instead. e.g. "big", "medium", "small" - or better name them by use:
7182     * "title", "footnote", "quote" etc.
7183     */
7184    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7185    /**
7186     * @brief Set background color of the label
7187     *
7188     * @param obj The label object
7189     * @param r Red property background color of The label object
7190     * @param g Green property background color of The label object
7191     * @param b Blue property background color of The label object
7192     * @param a Alpha property background alpha of The label object
7193     *
7194     * @warning NEVER use this. It is for hyper-special cases only. use styles
7195     * instead. e.g. "big", "medium", "small" - or better name them by use:
7196     * "title", "footnote", "quote" etc.
7197     */
7198    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);
7199    /**
7200     * @brief Set the ellipsis behavior of the label
7201     *
7202     * @param obj The label object
7203     * @param ellipsis To ellipsis text or not
7204     *
7205     * If set to true and the text doesn't fit in the label an ellipsis("...")
7206     * will be shown at the end of the widget.
7207     *
7208     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7209     * choosen wrap method was ELM_WRAP_WORD.
7210     */
7211    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7212    /**
7213     * @brief Set the text slide of the label
7214     *
7215     * @param obj The label object
7216     * @param slide To start slide or stop
7217     *
7218     * If set to true the text of the label will slide throught the length of
7219     * label.
7220     *
7221     * @warning This only work with the themes "slide_short", "slide_long" and
7222     * "slide_bounce".
7223     */
7224    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7225    /**
7226     * @brief Get the text slide mode of the label
7227     *
7228     * @param obj The label object
7229     * @return slide slide mode value
7230     *
7231     * @see elm_label_slide_set()
7232     */
7233    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7234    /**
7235     * @brief Set the slide duration(speed) of the label
7236     *
7237     * @param obj The label object
7238     * @return The duration in seconds in moving text from slide begin position
7239     * to slide end position
7240     */
7241    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7242    /**
7243     * @brief Get the slide duration(speed) of the label
7244     *
7245     * @param obj The label object
7246     * @return The duration time in moving text from slide begin position to slide end position
7247     *
7248     * @see elm_label_slide_duration_set()
7249     */
7250    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7251    /**
7252     * @}
7253     */
7254
7255    /**
7256     * @defgroup Toggle Toggle
7257     *
7258     * @image html img/widget/toggle/preview-00.png
7259     * @image latex img/widget/toggle/preview-00.eps
7260     *
7261     * @brief A toggle is a slider which can be used to toggle between
7262     * two values.  It has two states: on and off.
7263     *
7264     * Signals that you can add callbacks for are:
7265     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7266     *                 until the toggle is released by the cursor (assuming it
7267     *                 has been triggered by the cursor in the first place).
7268     *
7269     * @ref tutorial_toggle show how to use a toggle.
7270     * @{
7271     */
7272    /**
7273     * @brief Add a toggle to @p parent.
7274     *
7275     * @param parent The parent object
7276     *
7277     * @return The toggle object
7278     */
7279    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7280    /**
7281     * @brief Sets the label to be displayed with the toggle.
7282     *
7283     * @param obj The toggle object
7284     * @param label The label to be displayed
7285     *
7286     * @deprecated use elm_object_text_set() instead.
7287     */
7288    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7289    /**
7290     * @brief Gets the label of the toggle
7291     *
7292     * @param obj  toggle object
7293     * @return The label of the toggle
7294     *
7295     * @deprecated use elm_object_text_get() instead.
7296     */
7297    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7298    /**
7299     * @brief Set the icon used for the toggle
7300     *
7301     * @param obj The toggle object
7302     * @param icon The icon object for the button
7303     *
7304     * Once the icon object is set, a previously set one will be deleted
7305     * If you want to keep that old content object, use the
7306     * elm_toggle_icon_unset() function.
7307     */
7308    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7309    /**
7310     * @brief Get the icon used for the toggle
7311     *
7312     * @param obj The toggle object
7313     * @return The icon object that is being used
7314     *
7315     * Return the icon object which is set for this widget.
7316     *
7317     * @see elm_toggle_icon_set()
7318     */
7319    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7320    /**
7321     * @brief Unset the icon used for the toggle
7322     *
7323     * @param obj The toggle object
7324     * @return The icon object that was being used
7325     *
7326     * Unparent and return the icon object which was set for this widget.
7327     *
7328     * @see elm_toggle_icon_set()
7329     */
7330    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7331    /**
7332     * @brief Sets the labels to be associated with the on and off states of the toggle.
7333     *
7334     * @param obj The toggle object
7335     * @param onlabel The label displayed when the toggle is in the "on" state
7336     * @param offlabel The label displayed when the toggle is in the "off" state
7337     */
7338    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7339    /**
7340     * @brief Gets the labels associated with the on and off states of the toggle.
7341     *
7342     * @param obj The toggle object
7343     * @param onlabel A char** to place the onlabel of @p obj into
7344     * @param offlabel A char** to place the offlabel of @p obj into
7345     */
7346    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7347    /**
7348     * @brief Sets the state of the toggle to @p state.
7349     *
7350     * @param obj The toggle object
7351     * @param state The state of @p obj
7352     */
7353    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7354    /**
7355     * @brief Gets the state of the toggle to @p state.
7356     *
7357     * @param obj The toggle object
7358     * @return The state of @p obj
7359     */
7360    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7361    /**
7362     * @brief Sets the state pointer of the toggle to @p statep.
7363     *
7364     * @param obj The toggle object
7365     * @param statep The state pointer of @p obj
7366     */
7367    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7368    /**
7369     * @}
7370     */
7371
7372    /**
7373     * @defgroup Frame Frame
7374     *
7375     * @image html img/widget/frame/preview-00.png
7376     * @image latex img/widget/frame/preview-00.eps
7377     *
7378     * @brief Frame is a widget that holds some content and has a title.
7379     *
7380     * The default look is a frame with a title, but Frame supports multple
7381     * styles:
7382     * @li default
7383     * @li pad_small
7384     * @li pad_medium
7385     * @li pad_large
7386     * @li pad_huge
7387     * @li outdent_top
7388     * @li outdent_bottom
7389     *
7390     * Of all this styles only default shows the title. Frame emits no signals.
7391     *
7392     * For a detailed example see the @ref tutorial_frame.
7393     *
7394     * @{
7395     */
7396    /**
7397     * @brief Add a new frame to the parent
7398     *
7399     * @param parent The parent object
7400     * @return The new object or NULL if it cannot be created
7401     */
7402    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7403    /**
7404     * @brief Set the frame label
7405     *
7406     * @param obj The frame object
7407     * @param label The label of this frame object
7408     *
7409     * @deprecated use elm_object_text_set() instead.
7410     */
7411    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7412    /**
7413     * @brief Get the frame label
7414     *
7415     * @param obj The frame object
7416     *
7417     * @return The label of this frame objet or NULL if unable to get frame
7418     *
7419     * @deprecated use elm_object_text_get() instead.
7420     */
7421    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7422    /**
7423     * @brief Set the content of the frame widget
7424     *
7425     * Once the content object is set, a previously set one will be deleted.
7426     * If you want to keep that old content object, use the
7427     * elm_frame_content_unset() function.
7428     *
7429     * @param obj The frame object
7430     * @param content The content will be filled in this frame object
7431     */
7432    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7433    /**
7434     * @brief Get the content of the frame widget
7435     *
7436     * Return the content object which is set for this widget
7437     *
7438     * @param obj The frame object
7439     * @return The content that is being used
7440     */
7441    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7442    /**
7443     * @brief Unset the content of the frame widget
7444     *
7445     * Unparent and return the content object which was set for this widget
7446     *
7447     * @param obj The frame object
7448     * @return The content that was being used
7449     */
7450    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7451    /**
7452     * @}
7453     */
7454
7455    /**
7456     * @defgroup Table Table
7457     *
7458     * A container widget to arrange other widgets in a table where items can
7459     * also span multiple columns or rows - even overlap (and then be raised or
7460     * lowered accordingly to adjust stacking if they do overlap).
7461     *
7462     * The followin are examples of how to use a table:
7463     * @li @ref tutorial_table_01
7464     * @li @ref tutorial_table_02
7465     *
7466     * @{
7467     */
7468    /**
7469     * @brief Add a new table to the parent
7470     *
7471     * @param parent The parent object
7472     * @return The new object or NULL if it cannot be created
7473     */
7474    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7475    /**
7476     * @brief Set the homogeneous layout in the table
7477     *
7478     * @param obj The layout object
7479     * @param homogeneous A boolean to set if the layout is homogeneous in the
7480     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7481     */
7482    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7483    /**
7484     * @brief Get the current table homogeneous mode.
7485     *
7486     * @param obj The table object
7487     * @return A boolean to indicating if the layout is homogeneous in the table
7488     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7489     */
7490    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7491    /**
7492     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7493     */
7494    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7495    /**
7496     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7497     */
7498    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7499    /**
7500     * @brief Set padding between cells.
7501     *
7502     * @param obj The layout object.
7503     * @param horizontal set the horizontal padding.
7504     * @param vertical set the vertical padding.
7505     *
7506     * Default value is 0.
7507     */
7508    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7509    /**
7510     * @brief Get padding between cells.
7511     *
7512     * @param obj The layout object.
7513     * @param horizontal set the horizontal padding.
7514     * @param vertical set the vertical padding.
7515     */
7516    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7517    /**
7518     * @brief Add a subobject on the table with the coordinates passed
7519     *
7520     * @param obj The table object
7521     * @param subobj The subobject to be added to the table
7522     * @param x Row number
7523     * @param y Column number
7524     * @param w rowspan
7525     * @param h colspan
7526     *
7527     * @note All positioning inside the table is relative to rows and columns, so
7528     * a value of 0 for x and y, means the top left cell of the table, and a
7529     * value of 1 for w and h means @p subobj only takes that 1 cell.
7530     */
7531    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7532    /**
7533     * @brief Remove child from table.
7534     *
7535     * @param obj The table object
7536     * @param subobj The subobject
7537     */
7538    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7539    /**
7540     * @brief Faster way to remove all child objects from a table object.
7541     *
7542     * @param obj The table object
7543     * @param clear If true, will delete children, else just remove from table.
7544     */
7545    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7546    /**
7547     * @brief Set the packing location of an existing child of the table
7548     *
7549     * @param subobj The subobject to be modified in the table
7550     * @param x Row number
7551     * @param y Column number
7552     * @param w rowspan
7553     * @param h colspan
7554     *
7555     * Modifies the position of an object already in the table.
7556     *
7557     * @note All positioning inside the table is relative to rows and columns, so
7558     * a value of 0 for x and y, means the top left cell of the table, and a
7559     * value of 1 for w and h means @p subobj only takes that 1 cell.
7560     */
7561    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7562    /**
7563     * @brief Get the packing location of an existing child of the table
7564     *
7565     * @param subobj The subobject to be modified in the table
7566     * @param x Row number
7567     * @param y Column number
7568     * @param w rowspan
7569     * @param h colspan
7570     *
7571     * @see elm_table_pack_set()
7572     */
7573    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7574    /**
7575     * @}
7576     */
7577
7578    /**
7579     * @defgroup Gengrid Gengrid (Generic grid)
7580     *
7581     * This widget aims to position objects in a grid layout while
7582     * actually creating and rendering only the visible ones, using the
7583     * same idea as the @ref Genlist "genlist": the user defines a @b
7584     * class for each item, specifying functions that will be called at
7585     * object creation, deletion, etc. When those items are selected by
7586     * the user, a callback function is issued. Users may interact with
7587     * a gengrid via the mouse (by clicking on items to select them and
7588     * clicking on the grid's viewport and swiping to pan the whole
7589     * view) or via the keyboard, navigating through item with the
7590     * arrow keys.
7591     *
7592     * @section Gengrid_Layouts Gengrid layouts
7593     *
7594     * Gengrids may layout its items in one of two possible layouts:
7595     * - horizontal or
7596     * - vertical.
7597     *
7598     * When in "horizontal mode", items will be placed in @b columns,
7599     * from top to bottom and, when the space for a column is filled,
7600     * another one is started on the right, thus expanding the grid
7601     * horizontally, making for horizontal scrolling. When in "vertical
7602     * mode" , though, items will be placed in @b rows, from left to
7603     * right and, when the space for a row is filled, another one is
7604     * started below, thus expanding the grid vertically (and making
7605     * for vertical scrolling).
7606     *
7607     * @section Gengrid_Items Gengrid items
7608     *
7609     * An item in a gengrid can have 0 or more text labels (they can be
7610     * regular text or textblock Evas objects - that's up to the style
7611     * to determine), 0 or more icons (which are simply objects
7612     * swallowed into the gengrid item's theming Edje object) and 0 or
7613     * more <b>boolean states</b>, which have the behavior left to the
7614     * user to define. The Edje part names for each of these properties
7615     * will be looked up, in the theme file for the gengrid, under the
7616     * Edje (string) data items named @c "labels", @c "icons" and @c
7617     * "states", respectively. For each of those properties, if more
7618     * than one part is provided, they must have names listed separated
7619     * by spaces in the data fields. For the default gengrid item
7620     * theme, we have @b one label part (@c "elm.text"), @b two icon
7621     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7622     * no state parts.
7623     *
7624     * A gengrid item may be at one of several styles. Elementary
7625     * provides one by default - "default", but this can be extended by
7626     * system or application custom themes/overlays/extensions (see
7627     * @ref Theme "themes" for more details).
7628     *
7629     * @section Gengrid_Item_Class Gengrid item classes
7630     *
7631     * In order to have the ability to add and delete items on the fly,
7632     * gengrid implements a class (callback) system where the
7633     * application provides a structure with information about that
7634     * type of item (gengrid may contain multiple different items with
7635     * different classes, states and styles). Gengrid will call the
7636     * functions in this struct (methods) when an item is "realized"
7637     * (i.e., created dynamically, while the user is scrolling the
7638     * grid). All objects will simply be deleted when no longer needed
7639     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7640     * contains the following members:
7641     * - @c item_style - This is a constant string and simply defines
7642     * the name of the item style. It @b must be specified and the
7643     * default should be @c "default".
7644     * - @c func.label_get - This function is called when an item
7645     * object is actually created. The @c data parameter will point to
7646     * the same data passed to elm_gengrid_item_append() and related
7647     * item creation functions. The @c obj parameter is the gengrid
7648     * object itself, while the @c part one is the name string of one
7649     * of the existing text parts in the Edje group implementing the
7650     * item's theme. This function @b must return a strdup'()ed string,
7651     * as the caller will free() it when done. See
7652     * #Elm_Gengrid_Item_Label_Get_Cb.
7653     * - @c func.icon_get - This function is called when an item object
7654     * is actually created. The @c data parameter will point to the
7655     * same data passed to elm_gengrid_item_append() and related item
7656     * creation functions. The @c obj parameter is the gengrid object
7657     * itself, while the @c part one is the name string of one of the
7658     * existing (icon) swallow parts in the Edje group implementing the
7659     * item's theme. It must return @c NULL, when no icon is desired,
7660     * or a valid object handle, otherwise. The object will be deleted
7661     * by the gengrid on its deletion or when the item is "unrealized".
7662     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7663     * - @c func.state_get - This function is called when an item
7664     * object is actually created. The @c data parameter will point to
7665     * the same data passed to elm_gengrid_item_append() and related
7666     * item creation functions. The @c obj parameter is the gengrid
7667     * object itself, while the @c part one is the name string of one
7668     * of the state parts in the Edje group implementing the item's
7669     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7670     * true/on. Gengrids will emit a signal to its theming Edje object
7671     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7672     * "source" arguments, respectively, when the state is true (the
7673     * default is false), where @c XXX is the name of the (state) part.
7674     * See #Elm_Gengrid_Item_State_Get_Cb.
7675     * - @c func.del - This is called when elm_gengrid_item_del() is
7676     * called on an item or elm_gengrid_clear() is called on the
7677     * gengrid. This is intended for use when gengrid items are
7678     * deleted, so any data attached to the item (e.g. its data
7679     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7680     *
7681     * @section Gengrid_Usage_Hints Usage hints
7682     *
7683     * If the user wants to have multiple items selected at the same
7684     * time, elm_gengrid_multi_select_set() will permit it. If the
7685     * gengrid is single-selection only (the default), then
7686     * elm_gengrid_select_item_get() will return the selected item or
7687     * @c NULL, if none is selected. If the gengrid is under
7688     * multi-selection, then elm_gengrid_selected_items_get() will
7689     * return a list (that is only valid as long as no items are
7690     * modified (added, deleted, selected or unselected) of child items
7691     * on a gengrid.
7692     *
7693     * If an item changes (internal (boolean) state, label or icon
7694     * changes), then use elm_gengrid_item_update() to have gengrid
7695     * update the item with the new state. A gengrid will re-"realize"
7696     * the item, thus calling the functions in the
7697     * #Elm_Gengrid_Item_Class set for that item.
7698     *
7699     * To programmatically (un)select an item, use
7700     * elm_gengrid_item_selected_set(). To get its selected state use
7701     * elm_gengrid_item_selected_get(). To make an item disabled
7702     * (unable to be selected and appear differently) use
7703     * elm_gengrid_item_disabled_set() to set this and
7704     * elm_gengrid_item_disabled_get() to get the disabled state.
7705     *
7706     * Grid cells will only have their selection smart callbacks called
7707     * when firstly getting selected. Any further clicks will do
7708     * nothing, unless you enable the "always select mode", with
7709     * elm_gengrid_always_select_mode_set(), thus making every click to
7710     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7711     * turn off the ability to select items entirely in the widget and
7712     * they will neither appear selected nor call the selection smart
7713     * callbacks.
7714     *
7715     * Remember that you can create new styles and add your own theme
7716     * augmentation per application with elm_theme_extension_add(). If
7717     * you absolutely must have a specific style that overrides any
7718     * theme the user or system sets up you can use
7719     * elm_theme_overlay_add() to add such a file.
7720     *
7721     * @section Gengrid_Smart_Events Gengrid smart events
7722     *
7723     * Smart events that you can add callbacks for are:
7724     * - @c "activated" - The user has double-clicked or pressed
7725     *   (enter|return|spacebar) on an item. The @c event_info parameter
7726     *   is the gengrid item that was activated.
7727     * - @c "clicked,double" - The user has double-clicked an item.
7728     *   The @c event_info parameter is the gengrid item that was double-clicked.
7729     * - @c "selected" - The user has made an item selected. The
7730     *   @c event_info parameter is the gengrid item that was selected.
7731     * - @c "unselected" - The user has made an item unselected. The
7732     *   @c event_info parameter is the gengrid item that was unselected.
7733     * - @c "realized" - This is called when the item in the gengrid
7734     *   has its implementing Evas object instantiated, de facto. @c
7735     *   event_info is the gengrid item that was created. The object
7736     *   may be deleted at any time, so it is highly advised to the
7737     *   caller @b not to use the object pointer returned from
7738     *   elm_gengrid_item_object_get(), because it may point to freed
7739     *   objects.
7740     * - @c "unrealized" - This is called when the implementing Evas
7741     *   object for this item is deleted. @c event_info is the gengrid
7742     *   item that was deleted.
7743     * - @c "changed" - Called when an item is added, removed, resized
7744     *   or moved and when the gengrid is resized or gets "horizontal"
7745     *   property changes.
7746     * - @c "drag,start,up" - Called when the item in the gengrid has
7747     *   been dragged (not scrolled) up.
7748     * - @c "drag,start,down" - Called when the item in the gengrid has
7749     *   been dragged (not scrolled) down.
7750     * - @c "drag,start,left" - Called when the item in the gengrid has
7751     *   been dragged (not scrolled) left.
7752     * - @c "drag,start,right" - Called when the item in the gengrid has
7753     *   been dragged (not scrolled) right.
7754     * - @c "drag,stop" - Called when the item in the gengrid has
7755     *   stopped being dragged.
7756     * - @c "drag" - Called when the item in the gengrid is being
7757     *   dragged.
7758     * - @c "scroll" - called when the content has been scrolled
7759     *   (moved).
7760     * - @c "scroll,drag,start" - called when dragging the content has
7761     *   started.
7762     * - @c "scroll,drag,stop" - called when dragging the content has
7763     *   stopped.
7764     *
7765     * List of gendrid examples:
7766     * @li @ref gengrid_example
7767     */
7768
7769    /**
7770     * @addtogroup Gengrid
7771     * @{
7772     */
7773
7774    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7775    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7776    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7777    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7778    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. */
7779    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. */
7780    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7781
7782    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7783    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7784    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7785    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7786
7787    /**
7788     * @struct _Elm_Gengrid_Item_Class
7789     *
7790     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7791     * field details.
7792     */
7793    struct _Elm_Gengrid_Item_Class
7794      {
7795         const char             *item_style;
7796         struct _Elm_Gengrid_Item_Class_Func
7797           {
7798              Elm_Gengrid_Item_Label_Get_Cb label_get;
7799              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7800              Elm_Gengrid_Item_State_Get_Cb state_get;
7801              Elm_Gengrid_Item_Del_Cb       del;
7802           } func;
7803      }; /**< #Elm_Gengrid_Item_Class member definitions */
7804
7805    /**
7806     * Add a new gengrid widget to the given parent Elementary
7807     * (container) object
7808     *
7809     * @param parent The parent object
7810     * @return a new gengrid widget handle or @c NULL, on errors
7811     *
7812     * This function inserts a new gengrid widget on the canvas.
7813     *
7814     * @see elm_gengrid_item_size_set()
7815     * @see elm_gengrid_horizontal_set()
7816     * @see elm_gengrid_item_append()
7817     * @see elm_gengrid_item_del()
7818     * @see elm_gengrid_clear()
7819     *
7820     * @ingroup Gengrid
7821     */
7822    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7823
7824    /**
7825     * Set the size for the items of a given gengrid widget
7826     *
7827     * @param obj The gengrid object.
7828     * @param w The items' width.
7829     * @param h The items' height;
7830     *
7831     * A gengrid, after creation, has still no information on the size
7832     * to give to each of its cells. So, you most probably will end up
7833     * with squares one @ref Fingers "finger" wide, the default
7834     * size. Use this function to force a custom size for you items,
7835     * making them as big as you wish.
7836     *
7837     * @see elm_gengrid_item_size_get()
7838     *
7839     * @ingroup Gengrid
7840     */
7841    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7842
7843    /**
7844     * Get the size set for the items of a given gengrid widget
7845     *
7846     * @param obj The gengrid object.
7847     * @param w Pointer to a variable where to store the items' width.
7848     * @param h Pointer to a variable where to store the items' height.
7849     *
7850     * @note Use @c NULL pointers on the size values you're not
7851     * interested in: they'll be ignored by the function.
7852     *
7853     * @see elm_gengrid_item_size_get() for more details
7854     *
7855     * @ingroup Gengrid
7856     */
7857    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7858
7859    /**
7860     * Set the items grid's alignment within a given gengrid widget
7861     *
7862     * @param obj The gengrid object.
7863     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7864     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7865     *
7866     * This sets the alignment of the whole grid of items of a gengrid
7867     * within its given viewport. By default, those values are both
7868     * 0.5, meaning that the gengrid will have its items grid placed
7869     * exactly in the middle of its viewport.
7870     *
7871     * @note If given alignment values are out of the cited ranges,
7872     * they'll be changed to the nearest boundary values on the valid
7873     * ranges.
7874     *
7875     * @see elm_gengrid_align_get()
7876     *
7877     * @ingroup Gengrid
7878     */
7879    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7880
7881    /**
7882     * Get the items grid's alignment values within a given gengrid
7883     * widget
7884     *
7885     * @param obj The gengrid object.
7886     * @param align_x Pointer to a variable where to store the
7887     * horizontal alignment.
7888     * @param align_y Pointer to a variable where to store the vertical
7889     * alignment.
7890     *
7891     * @note Use @c NULL pointers on the alignment values you're not
7892     * interested in: they'll be ignored by the function.
7893     *
7894     * @see elm_gengrid_align_set() for more details
7895     *
7896     * @ingroup Gengrid
7897     */
7898    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7899
7900    /**
7901     * Set whether a given gengrid widget is or not able have items
7902     * @b reordered
7903     *
7904     * @param obj The gengrid object
7905     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7906     * @c EINA_FALSE to turn it off
7907     *
7908     * If a gengrid is set to allow reordering, a click held for more
7909     * than 0.5 over a given item will highlight it specially,
7910     * signalling the gengrid has entered the reordering state. From
7911     * that time on, the user will be able to, while still holding the
7912     * mouse button down, move the item freely in the gengrid's
7913     * viewport, replacing to said item to the locations it goes to.
7914     * The replacements will be animated and, whenever the user
7915     * releases the mouse button, the item being replaced gets a new
7916     * definitive place in the grid.
7917     *
7918     * @see elm_gengrid_reorder_mode_get()
7919     *
7920     * @ingroup Gengrid
7921     */
7922    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7923
7924    /**
7925     * Get whether a given gengrid widget is or not able have items
7926     * @b reordered
7927     *
7928     * @param obj The gengrid object
7929     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
7930     * off
7931     *
7932     * @see elm_gengrid_reorder_mode_set() for more details
7933     *
7934     * @ingroup Gengrid
7935     */
7936    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7937
7938    /**
7939     * Append a new item in a given gengrid widget.
7940     *
7941     * @param obj The gengrid object.
7942     * @param gic The item class for the item.
7943     * @param data The item data.
7944     * @param func Convenience function called when the item is
7945     * selected.
7946     * @param func_data Data to be passed to @p func.
7947     * @return A handle to the item added or @c NULL, on errors.
7948     *
7949     * This adds an item to the beginning of the gengrid.
7950     *
7951     * @see elm_gengrid_item_prepend()
7952     * @see elm_gengrid_item_insert_before()
7953     * @see elm_gengrid_item_insert_after()
7954     * @see elm_gengrid_item_del()
7955     *
7956     * @ingroup Gengrid
7957     */
7958    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);
7959
7960    /**
7961     * Prepend a new item in a given gengrid widget.
7962     *
7963     * @param obj The gengrid object.
7964     * @param gic The item class for the item.
7965     * @param data The item data.
7966     * @param func Convenience function called when the item is
7967     * selected.
7968     * @param func_data Data to be passed to @p func.
7969     * @return A handle to the item added or @c NULL, on errors.
7970     *
7971     * This adds an item to the end of the gengrid.
7972     *
7973     * @see elm_gengrid_item_append()
7974     * @see elm_gengrid_item_insert_before()
7975     * @see elm_gengrid_item_insert_after()
7976     * @see elm_gengrid_item_del()
7977     *
7978     * @ingroup Gengrid
7979     */
7980    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);
7981
7982    /**
7983     * Insert an item before another in a gengrid widget
7984     *
7985     * @param obj The gengrid object.
7986     * @param gic The item class for the item.
7987     * @param data The item data.
7988     * @param relative The item to place this new one before.
7989     * @param func Convenience function called when the item is
7990     * selected.
7991     * @param func_data Data to be passed to @p func.
7992     * @return A handle to the item added or @c NULL, on errors.
7993     *
7994     * This inserts an item before another in the gengrid.
7995     *
7996     * @see elm_gengrid_item_append()
7997     * @see elm_gengrid_item_prepend()
7998     * @see elm_gengrid_item_insert_after()
7999     * @see elm_gengrid_item_del()
8000     *
8001     * @ingroup Gengrid
8002     */
8003    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);
8004
8005    /**
8006     * Insert an item after another in a gengrid widget
8007     *
8008     * @param obj The gengrid object.
8009     * @param gic The item class for the item.
8010     * @param data The item data.
8011     * @param relative The item to place this new one after.
8012     * @param func Convenience function called when the item is
8013     * selected.
8014     * @param func_data Data to be passed to @p func.
8015     * @return A handle to the item added or @c NULL, on errors.
8016     *
8017     * This inserts an item after another in the gengrid.
8018     *
8019     * @see elm_gengrid_item_append()
8020     * @see elm_gengrid_item_prepend()
8021     * @see elm_gengrid_item_insert_after()
8022     * @see elm_gengrid_item_del()
8023     *
8024     * @ingroup Gengrid
8025     */
8026    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);
8027
8028    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);
8029
8030    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);
8031
8032    /**
8033     * Set whether items on a given gengrid widget are to get their
8034     * selection callbacks issued for @b every subsequent selection
8035     * click on them or just for the first click.
8036     *
8037     * @param obj The gengrid object
8038     * @param always_select @c EINA_TRUE to make items "always
8039     * selected", @c EINA_FALSE, otherwise
8040     *
8041     * By default, grid items will only call their selection callback
8042     * function when firstly getting selected, any subsequent further
8043     * clicks will do nothing. With this call, you make those
8044     * subsequent clicks also to issue the selection callbacks.
8045     *
8046     * @note <b>Double clicks</b> will @b always be reported on items.
8047     *
8048     * @see elm_gengrid_always_select_mode_get()
8049     *
8050     * @ingroup Gengrid
8051     */
8052    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8053
8054    /**
8055     * Get whether items on a given gengrid widget have their selection
8056     * callbacks issued for @b every subsequent selection click on them
8057     * or just for the first click.
8058     *
8059     * @param obj The gengrid object.
8060     * @return @c EINA_TRUE if the gengrid items are "always selected",
8061     * @c EINA_FALSE, otherwise
8062     *
8063     * @see elm_gengrid_always_select_mode_set() for more details
8064     *
8065     * @ingroup Gengrid
8066     */
8067    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8068
8069    /**
8070     * Set whether items on a given gengrid widget can be selected or not.
8071     *
8072     * @param obj The gengrid object
8073     * @param no_select @c EINA_TRUE to make items selectable,
8074     * @c EINA_FALSE otherwise
8075     *
8076     * This will make items in @p obj selectable or not. In the latter
8077     * case, any user interacion on the gendrid items will neither make
8078     * them appear selected nor them call their selection callback
8079     * functions.
8080     *
8081     * @see elm_gengrid_no_select_mode_get()
8082     *
8083     * @ingroup Gengrid
8084     */
8085    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8086
8087    /**
8088     * Get whether items on a given gengrid widget can be selected or
8089     * not.
8090     *
8091     * @param obj The gengrid object
8092     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8093     * otherwise
8094     *
8095     * @see elm_gengrid_no_select_mode_set() for more details
8096     *
8097     * @ingroup Gengrid
8098     */
8099    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8100
8101    /**
8102     * Enable or disable multi-selection in a given gengrid widget
8103     *
8104     * @param obj The gengrid object.
8105     * @param multi @c EINA_TRUE, to enable multi-selection,
8106     * @c EINA_FALSE to disable it.
8107     *
8108     * Multi-selection is the ability for one to have @b more than one
8109     * item selected, on a given gengrid, simultaneously. When it is
8110     * enabled, a sequence of clicks on different items will make them
8111     * all selected, progressively. A click on an already selected item
8112     * will unselect it. If interecting via the keyboard,
8113     * multi-selection is enabled while holding the "Shift" key.
8114     *
8115     * @note By default, multi-selection is @b disabled on gengrids
8116     *
8117     * @see elm_gengrid_multi_select_get()
8118     *
8119     * @ingroup Gengrid
8120     */
8121    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8122
8123    /**
8124     * Get whether multi-selection is enabled or disabled for a given
8125     * gengrid widget
8126     *
8127     * @param obj The gengrid object.
8128     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8129     * EINA_FALSE otherwise
8130     *
8131     * @see elm_gengrid_multi_select_set() for more details
8132     *
8133     * @ingroup Gengrid
8134     */
8135    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8136
8137    /**
8138     * Enable or disable bouncing effect for a given gengrid widget
8139     *
8140     * @param obj The gengrid object
8141     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8142     * @c EINA_FALSE to disable it
8143     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8144     * @c EINA_FALSE to disable it
8145     *
8146     * The bouncing effect occurs whenever one reaches the gengrid's
8147     * edge's while panning it -- it will scroll past its limits a
8148     * little bit and return to the edge again, in a animated for,
8149     * automatically.
8150     *
8151     * @note By default, gengrids have bouncing enabled on both axis
8152     *
8153     * @see elm_gengrid_bounce_get()
8154     *
8155     * @ingroup Gengrid
8156     */
8157    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8158
8159    /**
8160     * Get whether bouncing effects are enabled or disabled, for a
8161     * given gengrid widget, on each axis
8162     *
8163     * @param obj The gengrid object
8164     * @param h_bounce Pointer to a variable where to store the
8165     * horizontal bouncing flag.
8166     * @param v_bounce Pointer to a variable where to store the
8167     * vertical bouncing flag.
8168     *
8169     * @see elm_gengrid_bounce_set() for more details
8170     *
8171     * @ingroup Gengrid
8172     */
8173    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8174
8175    /**
8176     * Set a given gengrid widget's scrolling page size, relative to
8177     * its viewport size.
8178     *
8179     * @param obj The gengrid object
8180     * @param h_pagerel The horizontal page (relative) size
8181     * @param v_pagerel The vertical page (relative) size
8182     *
8183     * The gengrid's scroller is capable of binding scrolling by the
8184     * user to "pages". It means that, while scrolling and, specially
8185     * after releasing the mouse button, the grid will @b snap to the
8186     * nearest displaying page's area. When page sizes are set, the
8187     * grid's continuous content area is split into (equal) page sized
8188     * pieces.
8189     *
8190     * This function sets the size of a page <b>relatively to the
8191     * viewport dimensions</b> of the gengrid, for each axis. A value
8192     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8193     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8194     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8195     * 1.0. Values beyond those will make it behave behave
8196     * inconsistently. If you only want one axis to snap to pages, use
8197     * the value @c 0.0 for the other one.
8198     *
8199     * There is a function setting page size values in @b absolute
8200     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8201     * is mutually exclusive to this one.
8202     *
8203     * @see elm_gengrid_page_relative_get()
8204     *
8205     * @ingroup Gengrid
8206     */
8207    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8208
8209    /**
8210     * Get a given gengrid widget's scrolling page size, relative to
8211     * its viewport size.
8212     *
8213     * @param obj The gengrid object
8214     * @param h_pagerel Pointer to a variable where to store the
8215     * horizontal page (relative) size
8216     * @param v_pagerel Pointer to a variable where to store the
8217     * vertical page (relative) size
8218     *
8219     * @see elm_gengrid_page_relative_set() for more details
8220     *
8221     * @ingroup Gengrid
8222     */
8223    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8224
8225    /**
8226     * Set a given gengrid widget's scrolling page size
8227     *
8228     * @param obj The gengrid object
8229     * @param h_pagerel The horizontal page size, in pixels
8230     * @param v_pagerel The vertical page size, in pixels
8231     *
8232     * The gengrid's scroller is capable of binding scrolling by the
8233     * user to "pages". It means that, while scrolling and, specially
8234     * after releasing the mouse button, the grid will @b snap to the
8235     * nearest displaying page's area. When page sizes are set, the
8236     * grid's continuous content area is split into (equal) page sized
8237     * pieces.
8238     *
8239     * This function sets the size of a page of the gengrid, in pixels,
8240     * for each axis. Sane usable values are, between @c 0 and the
8241     * dimensions of @p obj, for each axis. Values beyond those will
8242     * make it behave behave inconsistently. If you only want one axis
8243     * to snap to pages, use the value @c 0 for the other one.
8244     *
8245     * There is a function setting page size values in @b relative
8246     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8247     * use is mutually exclusive to this one.
8248     *
8249     * @ingroup Gengrid
8250     */
8251    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8252
8253    /**
8254     * Set for what direction a given gengrid widget will expand while
8255     * placing its items.
8256     *
8257     * @param obj The gengrid object.
8258     * @param setting @c EINA_TRUE to make the gengrid expand
8259     * horizontally, @c EINA_FALSE to expand vertically.
8260     *
8261     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8262     * in @b columns, from top to bottom and, when the space for a
8263     * column is filled, another one is started on the right, thus
8264     * expanding the grid horizontally. When in "vertical mode"
8265     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8266     * to right and, when the space for a row is filled, another one is
8267     * started below, thus expanding the grid vertically.
8268     *
8269     * @see elm_gengrid_horizontal_get()
8270     *
8271     * @ingroup Gengrid
8272     */
8273    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8274
8275    /**
8276     * Get for what direction a given gengrid widget will expand while
8277     * placing its items.
8278     *
8279     * @param obj The gengrid object.
8280     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8281     * @c EINA_FALSE if it's set to expand vertically.
8282     *
8283     * @see elm_gengrid_horizontal_set() for more detais
8284     *
8285     * @ingroup Gengrid
8286     */
8287    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8288
8289    /**
8290     * Get the first item in a given gengrid widget
8291     *
8292     * @param obj The gengrid object
8293     * @return The first item's handle or @c NULL, if there are no
8294     * items in @p obj (and on errors)
8295     *
8296     * This returns the first item in the @p obj's internal list of
8297     * items.
8298     *
8299     * @see elm_gengrid_last_item_get()
8300     *
8301     * @ingroup Gengrid
8302     */
8303    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8304
8305    /**
8306     * Get the last item in a given gengrid widget
8307     *
8308     * @param obj The gengrid object
8309     * @return The last item's handle or @c NULL, if there are no
8310     * items in @p obj (and on errors)
8311     *
8312     * This returns the last item in the @p obj's internal list of
8313     * items.
8314     *
8315     * @see elm_gengrid_first_item_get()
8316     *
8317     * @ingroup Gengrid
8318     */
8319    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8320
8321    /**
8322     * Get the @b next item in a gengrid widget's internal list of items,
8323     * given a handle to one of those items.
8324     *
8325     * @param item The gengrid item to fetch next from
8326     * @return The item after @p item, or @c NULL if there's none (and
8327     * on errors)
8328     *
8329     * This returns the item placed after the @p item, on the container
8330     * gengrid.
8331     *
8332     * @see elm_gengrid_item_prev_get()
8333     *
8334     * @ingroup Gengrid
8335     */
8336    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8337
8338    /**
8339     * Get the @b previous item in a gengrid widget's internal list of items,
8340     * given a handle to one of those items.
8341     *
8342     * @param item The gengrid item to fetch previous from
8343     * @return The item before @p item, or @c NULL if there's none (and
8344     * on errors)
8345     *
8346     * This returns the item placed before the @p item, on the container
8347     * gengrid.
8348     *
8349     * @see elm_gengrid_item_next_get()
8350     *
8351     * @ingroup Gengrid
8352     */
8353    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8354
8355    /**
8356     * Get the gengrid object's handle which contains a given gengrid
8357     * item
8358     *
8359     * @param item The item to fetch the container from
8360     * @return The gengrid (parent) object
8361     *
8362     * This returns the gengrid object itself that an item belongs to.
8363     *
8364     * @ingroup Gengrid
8365     */
8366    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8367
8368    /**
8369     * Remove a gengrid item from the its parent, deleting it.
8370     *
8371     * @param item The item to be removed.
8372     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8373     *
8374     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8375     * once.
8376     *
8377     * @ingroup Gengrid
8378     */
8379    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8380
8381    /**
8382     * Update the contents of a given gengrid item
8383     *
8384     * @param item The gengrid item
8385     *
8386     * This updates an item by calling all the item class functions
8387     * again to get the icons, labels and states. Use this when the
8388     * original item data has changed and you want thta changes to be
8389     * reflected.
8390     *
8391     * @ingroup Gengrid
8392     */
8393    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8394    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8395    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8396
8397    /**
8398     * Return the data associated to a given gengrid item
8399     *
8400     * @param item The gengrid item.
8401     * @return the data associated to this item.
8402     *
8403     * This returns the @c data value passed on the
8404     * elm_gengrid_item_append() and related item addition calls.
8405     *
8406     * @see elm_gengrid_item_append()
8407     * @see elm_gengrid_item_data_set()
8408     *
8409     * @ingroup Gengrid
8410     */
8411    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8412
8413    /**
8414     * Set the data associated to a given gengrid item
8415     *
8416     * @param item The gengrid item
8417     * @param data The new data pointer to set on it
8418     *
8419     * This @b overrides the @c data value passed on the
8420     * elm_gengrid_item_append() and related item addition calls. This
8421     * function @b won't call elm_gengrid_item_update() automatically,
8422     * so you'd issue it afterwards if you want to hove the item
8423     * updated to reflect the that new data.
8424     *
8425     * @see elm_gengrid_item_data_get()
8426     *
8427     * @ingroup Gengrid
8428     */
8429    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8430
8431    /**
8432     * Get a given gengrid item's position, relative to the whole
8433     * gengrid's grid area.
8434     *
8435     * @param item The Gengrid item.
8436     * @param x Pointer to variable where to store the item's <b>row
8437     * number</b>.
8438     * @param y Pointer to variable where to store the item's <b>column
8439     * number</b>.
8440     *
8441     * This returns the "logical" position of the item whithin the
8442     * gengrid. For example, @c (0, 1) would stand for first row,
8443     * second column.
8444     *
8445     * @ingroup Gengrid
8446     */
8447    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8448
8449    /**
8450     * Set whether a given gengrid item is selected or not
8451     *
8452     * @param item The gengrid item
8453     * @param selected Use @c EINA_TRUE, to make it selected, @c
8454     * EINA_FALSE to make it unselected
8455     *
8456     * This sets the selected state of an item. If multi selection is
8457     * not enabled on the containing gengrid and @p selected is @c
8458     * EINA_TRUE, any other previously selected items will get
8459     * unselected in favor of this new one.
8460     *
8461     * @see elm_gengrid_item_selected_get()
8462     *
8463     * @ingroup Gengrid
8464     */
8465    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8466
8467    /**
8468     * Get whether a given gengrid item is selected or not
8469     *
8470     * @param item The gengrid item
8471     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8472     *
8473     * @see elm_gengrid_item_selected_set() for more details
8474     *
8475     * @ingroup Gengrid
8476     */
8477    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8478
8479    /**
8480     * Get the real Evas object created to implement the view of a
8481     * given gengrid item
8482     *
8483     * @param item The gengrid item.
8484     * @return the Evas object implementing this item's view.
8485     *
8486     * This returns the actual Evas object used to implement the
8487     * specified gengrid item's view. This may be @c NULL, as it may
8488     * not have been created or may have been deleted, at any time, by
8489     * the gengrid. <b>Do not modify this object</b> (move, resize,
8490     * show, hide, etc.), as the gengrid is controlling it. This
8491     * function is for querying, emitting custom signals or hooking
8492     * lower level callbacks for events on that object. Do not delete
8493     * this object under any circumstances.
8494     *
8495     * @see elm_gengrid_item_data_get()
8496     *
8497     * @ingroup Gengrid
8498     */
8499    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8500
8501    /**
8502     * Show the portion of a gengrid's internal grid containing a given
8503     * item, @b immediately.
8504     *
8505     * @param item The item to display
8506     *
8507     * This causes gengrid to @b redraw its viewport's contents to the
8508     * region contining the given @p item item, if it is not fully
8509     * visible.
8510     *
8511     * @see elm_gengrid_item_bring_in()
8512     *
8513     * @ingroup Gengrid
8514     */
8515    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8516
8517    /**
8518     * Animatedly bring in, to the visible are of a gengrid, a given
8519     * item on it.
8520     *
8521     * @param item The gengrid item to display
8522     *
8523     * This causes gengrig to jump to the given @p item item and show
8524     * it (by scrolling), if it is not fully visible. This will use
8525     * animation to do so and take a period of time to complete.
8526     *
8527     * @see elm_gengrid_item_show()
8528     *
8529     * @ingroup Gengrid
8530     */
8531    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8532
8533    /**
8534     * Set whether a given gengrid item is disabled or not.
8535     *
8536     * @param item The gengrid item
8537     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8538     * to enable it back.
8539     *
8540     * A disabled item cannot be selected or unselected. It will also
8541     * change its appearance, to signal the user it's disabled.
8542     *
8543     * @see elm_gengrid_item_disabled_get()
8544     *
8545     * @ingroup Gengrid
8546     */
8547    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8548
8549    /**
8550     * Get whether a given gengrid item is disabled or not.
8551     *
8552     * @param item The gengrid item
8553     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8554     * (and on errors).
8555     *
8556     * @see elm_gengrid_item_disabled_set() for more details
8557     *
8558     * @ingroup Gengrid
8559     */
8560    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8561
8562    /**
8563     * Set the text to be shown in a given gengrid item's tooltips.
8564     *
8565     * @param item The gengrid item
8566     * @param text The text to set in the content
8567     *
8568     * This call will setup the text to be used as tooltip to that item
8569     * (analogous to elm_object_tooltip_text_set(), but being item
8570     * tooltips with higher precedence than object tooltips). It can
8571     * have only one tooltip at a time, so any previous tooltip data
8572     * will get removed.
8573     *
8574     * @ingroup Gengrid
8575     */
8576    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8577
8578    /**
8579     * Set the content to be shown in a given gengrid item's tooltips
8580     *
8581     * @param item The gengrid item.
8582     * @param func The function returning the tooltip contents.
8583     * @param data What to provide to @a func as callback data/context.
8584     * @param del_cb Called when data is not needed anymore, either when
8585     *        another callback replaces @p func, the tooltip is unset with
8586     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8587     *        dies. This callback receives as its first parameter the
8588     *        given @p data, being @c event_info the item handle.
8589     *
8590     * This call will setup the tooltip's contents to @p item
8591     * (analogous to elm_object_tooltip_content_cb_set(), but being
8592     * item tooltips with higher precedence than object tooltips). It
8593     * can have only one tooltip at a time, so any previous tooltip
8594     * content will get removed. @p func (with @p data) will be called
8595     * every time Elementary needs to show the tooltip and it should
8596     * return a valid Evas object, which will be fully managed by the
8597     * tooltip system, getting deleted when the tooltip is gone.
8598     *
8599     * @ingroup Gengrid
8600     */
8601    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);
8602
8603    /**
8604     * Unset a tooltip from a given gengrid item
8605     *
8606     * @param item gengrid item to remove a previously set tooltip from.
8607     *
8608     * This call removes any tooltip set on @p item. The callback
8609     * provided as @c del_cb to
8610     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8611     * notify it is not used anymore (and have resources cleaned, if
8612     * need be).
8613     *
8614     * @see elm_gengrid_item_tooltip_content_cb_set()
8615     *
8616     * @ingroup Gengrid
8617     */
8618    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8619
8620    /**
8621     * Set a different @b style for a given gengrid item's tooltip.
8622     *
8623     * @param item gengrid item with tooltip set
8624     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8625     * "default", @c "transparent", etc)
8626     *
8627     * Tooltips can have <b>alternate styles</b> to be displayed on,
8628     * which are defined by the theme set on Elementary. This function
8629     * works analogously as elm_object_tooltip_style_set(), but here
8630     * applied only to gengrid item objects. The default style for
8631     * tooltips is @c "default".
8632     *
8633     * @note before you set a style you should define a tooltip with
8634     *       elm_gengrid_item_tooltip_content_cb_set() or
8635     *       elm_gengrid_item_tooltip_text_set()
8636     *
8637     * @see elm_gengrid_item_tooltip_style_get()
8638     *
8639     * @ingroup Gengrid
8640     */
8641    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8642
8643    /**
8644     * Get the style set a given gengrid item's tooltip.
8645     *
8646     * @param item gengrid item with tooltip already set on.
8647     * @return style the theme style in use, which defaults to
8648     *         "default". If the object does not have a tooltip set,
8649     *         then @c NULL is returned.
8650     *
8651     * @see elm_gengrid_item_tooltip_style_set() for more details
8652     *
8653     * @ingroup Gengrid
8654     */
8655    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8656    /**
8657     * @brief Disable size restrictions on an object's tooltip
8658     * @param item The tooltip's anchor object
8659     * @param disable If EINA_TRUE, size restrictions are disabled
8660     * @return EINA_FALSE on failure, EINA_TRUE on success
8661     *
8662     * This function allows a tooltip to expand beyond its parant window's canvas.
8663     * It will instead be limited only by the size of the display.
8664     */
8665    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8666    /**
8667     * @brief Retrieve size restriction state of an object's tooltip
8668     * @param item The tooltip's anchor object
8669     * @return If EINA_TRUE, size restrictions are disabled
8670     *
8671     * This function returns whether a tooltip is allowed to expand beyond
8672     * its parant window's canvas.
8673     * It will instead be limited only by the size of the display.
8674     */
8675    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8676    /**
8677     * Set the type of mouse pointer/cursor decoration to be shown,
8678     * when the mouse pointer is over the given gengrid widget item
8679     *
8680     * @param item gengrid item to customize cursor on
8681     * @param cursor the cursor type's name
8682     *
8683     * This function works analogously as elm_object_cursor_set(), but
8684     * here the cursor's changing area is restricted to the item's
8685     * area, and not the whole widget's. Note that that item cursors
8686     * have precedence over widget cursors, so that a mouse over @p
8687     * item will always show cursor @p type.
8688     *
8689     * If this function is called twice for an object, a previously set
8690     * cursor will be unset on the second call.
8691     *
8692     * @see elm_object_cursor_set()
8693     * @see elm_gengrid_item_cursor_get()
8694     * @see elm_gengrid_item_cursor_unset()
8695     *
8696     * @ingroup Gengrid
8697     */
8698    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8699
8700    /**
8701     * Get the type of mouse pointer/cursor decoration set to be shown,
8702     * when the mouse pointer is over the given gengrid widget item
8703     *
8704     * @param item gengrid item with custom cursor set
8705     * @return the cursor type's name or @c NULL, if no custom cursors
8706     * were set to @p item (and on errors)
8707     *
8708     * @see elm_object_cursor_get()
8709     * @see elm_gengrid_item_cursor_set() for more details
8710     * @see elm_gengrid_item_cursor_unset()
8711     *
8712     * @ingroup Gengrid
8713     */
8714    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8715
8716    /**
8717     * Unset any custom mouse pointer/cursor decoration set to be
8718     * shown, when the mouse pointer is over the given gengrid widget
8719     * item, thus making it show the @b default cursor again.
8720     *
8721     * @param item a gengrid item
8722     *
8723     * Use this call to undo any custom settings on this item's cursor
8724     * decoration, bringing it back to defaults (no custom style set).
8725     *
8726     * @see elm_object_cursor_unset()
8727     * @see elm_gengrid_item_cursor_set() for more details
8728     *
8729     * @ingroup Gengrid
8730     */
8731    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8732
8733    /**
8734     * Set a different @b style for a given custom cursor set for a
8735     * gengrid item.
8736     *
8737     * @param item gengrid item with custom cursor set
8738     * @param style the <b>theme style</b> to use (e.g. @c "default",
8739     * @c "transparent", etc)
8740     *
8741     * This function only makes sense when one is using custom mouse
8742     * cursor decorations <b>defined in a theme file</b> , which can
8743     * have, given a cursor name/type, <b>alternate styles</b> on
8744     * it. It works analogously as elm_object_cursor_style_set(), but
8745     * here applied only to gengrid item objects.
8746     *
8747     * @warning Before you set a cursor style you should have defined a
8748     *       custom cursor previously on the item, with
8749     *       elm_gengrid_item_cursor_set()
8750     *
8751     * @see elm_gengrid_item_cursor_engine_only_set()
8752     * @see elm_gengrid_item_cursor_style_get()
8753     *
8754     * @ingroup Gengrid
8755     */
8756    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8757
8758    /**
8759     * Get the current @b style set for a given gengrid item's custom
8760     * cursor
8761     *
8762     * @param item gengrid item with custom cursor set.
8763     * @return style the cursor style in use. If the object does not
8764     *         have a cursor set, then @c NULL is returned.
8765     *
8766     * @see elm_gengrid_item_cursor_style_set() for more details
8767     *
8768     * @ingroup Gengrid
8769     */
8770    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8771
8772    /**
8773     * Set if the (custom) cursor for a given gengrid item should be
8774     * searched in its theme, also, or should only rely on the
8775     * rendering engine.
8776     *
8777     * @param item item with custom (custom) cursor already set on
8778     * @param engine_only Use @c EINA_TRUE to have cursors looked for
8779     * only on those provided by the rendering engine, @c EINA_FALSE to
8780     * have them searched on the widget's theme, as well.
8781     *
8782     * @note This call is of use only if you've set a custom cursor
8783     * for gengrid items, with elm_gengrid_item_cursor_set().
8784     *
8785     * @note By default, cursors will only be looked for between those
8786     * provided by the rendering engine.
8787     *
8788     * @ingroup Gengrid
8789     */
8790    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8791
8792    /**
8793     * Get if the (custom) cursor for a given gengrid item is being
8794     * searched in its theme, also, or is only relying on the rendering
8795     * engine.
8796     *
8797     * @param item a gengrid item
8798     * @return @c EINA_TRUE, if cursors are being looked for only on
8799     * those provided by the rendering engine, @c EINA_FALSE if they
8800     * are being searched on the widget's theme, as well.
8801     *
8802     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8803     *
8804     * @ingroup Gengrid
8805     */
8806    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8807
8808    /**
8809     * Remove all items from a given gengrid widget
8810     *
8811     * @param obj The gengrid object.
8812     *
8813     * This removes (and deletes) all items in @p obj, leaving it
8814     * empty.
8815     *
8816     * @see elm_gengrid_item_del(), to remove just one item.
8817     *
8818     * @ingroup Gengrid
8819     */
8820    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8821
8822    /**
8823     * Get the selected item in a given gengrid widget
8824     *
8825     * @param obj The gengrid object.
8826     * @return The selected item's handleor @c NULL, if none is
8827     * selected at the moment (and on errors)
8828     *
8829     * This returns the selected item in @p obj. If multi selection is
8830     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8831     * the first item in the list is selected, which might not be very
8832     * useful. For that case, see elm_gengrid_selected_items_get().
8833     *
8834     * @ingroup Gengrid
8835     */
8836    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8837
8838    /**
8839     * Get <b>a list</b> of selected items in a given gengrid
8840     *
8841     * @param obj The gengrid object.
8842     * @return The list of selected items or @c NULL, if none is
8843     * selected at the moment (and on errors)
8844     *
8845     * This returns a list of the selected items, in the order that
8846     * they appear in the grid. This list is only valid as long as no
8847     * more items are selected or unselected (or unselected implictly
8848     * by deletion). The list contains #Elm_Gengrid_Item pointers as
8849     * data, naturally.
8850     *
8851     * @see elm_gengrid_selected_item_get()
8852     *
8853     * @ingroup Gengrid
8854     */
8855    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8856
8857    /**
8858     * @}
8859     */
8860
8861    /**
8862     * @defgroup Clock Clock
8863     *
8864     * @image html img/widget/clock/preview-00.png
8865     * @image latex img/widget/clock/preview-00.eps
8866     *
8867     * This is a @b digital clock widget. In its default theme, it has a
8868     * vintage "flipping numbers clock" appearance, which will animate
8869     * sheets of individual algarisms individually as time goes by.
8870     *
8871     * A newly created clock will fetch system's time (already
8872     * considering local time adjustments) to start with, and will tick
8873     * accondingly. It may or may not show seconds.
8874     *
8875     * Clocks have an @b edition mode. When in it, the sheets will
8876     * display extra arrow indications on the top and bottom and the
8877     * user may click on them to raise or lower the time values. After
8878     * it's told to exit edition mode, it will keep ticking with that
8879     * new time set (it keeps the difference from local time).
8880     *
8881     * Also, when under edition mode, user clicks on the cited arrows
8882     * which are @b held for some time will make the clock to flip the
8883     * sheet, thus editing the time, continuosly and automatically for
8884     * the user. The interval between sheet flips will keep growing in
8885     * time, so that it helps the user to reach a time which is distant
8886     * from the one set.
8887     *
8888     * The time display is, by default, in military mode (24h), but an
8889     * am/pm indicator may be optionally shown, too, when it will
8890     * switch to 12h.
8891     *
8892     * Smart callbacks one can register to:
8893     * - "changed" - the clock's user changed the time
8894     *
8895     * Here is an example on its usage:
8896     * @li @ref clock_example
8897     */
8898
8899    /**
8900     * @addtogroup Clock
8901     * @{
8902     */
8903
8904    /**
8905     * Identifiers for which clock digits should be editable, when a
8906     * clock widget is in edition mode. Values may be ORed together to
8907     * make a mask, naturally.
8908     *
8909     * @see elm_clock_edit_set()
8910     * @see elm_clock_digit_edit_set()
8911     */
8912    typedef enum _Elm_Clock_Digedit
8913      {
8914         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8915         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8916         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
8917         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8918         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
8919         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8920         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
8921         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
8922      } Elm_Clock_Digedit;
8923
8924    /**
8925     * Add a new clock widget to the given parent Elementary
8926     * (container) object
8927     *
8928     * @param parent The parent object
8929     * @return a new clock widget handle or @c NULL, on errors
8930     *
8931     * This function inserts a new clock widget on the canvas.
8932     *
8933     * @ingroup Clock
8934     */
8935    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8936
8937    /**
8938     * Set a clock widget's time, programmatically
8939     *
8940     * @param obj The clock widget object
8941     * @param hrs The hours to set
8942     * @param min The minutes to set
8943     * @param sec The secondes to set
8944     *
8945     * This function updates the time that is showed by the clock
8946     * widget.
8947     *
8948     *  Values @b must be set within the following ranges:
8949     * - 0 - 23, for hours
8950     * - 0 - 59, for minutes
8951     * - 0 - 59, for seconds,
8952     *
8953     * even if the clock is not in "military" mode.
8954     *
8955     * @warning The behavior for values set out of those ranges is @b
8956     * indefined.
8957     *
8958     * @ingroup Clock
8959     */
8960    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
8961
8962    /**
8963     * Get a clock widget's time values
8964     *
8965     * @param obj The clock object
8966     * @param[out] hrs Pointer to the variable to get the hours value
8967     * @param[out] min Pointer to the variable to get the minutes value
8968     * @param[out] sec Pointer to the variable to get the seconds value
8969     *
8970     * This function gets the time set for @p obj, returning
8971     * it on the variables passed as the arguments to function
8972     *
8973     * @note Use @c NULL pointers on the time values you're not
8974     * interested in: they'll be ignored by the function.
8975     *
8976     * @ingroup Clock
8977     */
8978    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
8979
8980    /**
8981     * Set whether a given clock widget is under <b>edition mode</b> or
8982     * under (default) displaying-only mode.
8983     *
8984     * @param obj The clock object
8985     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
8986     * put it back to "displaying only" mode
8987     *
8988     * This function makes a clock's time to be editable or not <b>by
8989     * user interaction</b>. When in edition mode, clocks @b stop
8990     * ticking, until one brings them back to canonical mode. The
8991     * elm_clock_digit_edit_set() function will influence which digits
8992     * of the clock will be editable. By default, all of them will be
8993     * (#ELM_CLOCK_NONE).
8994     *
8995     * @note am/pm sheets, if being shown, will @b always be editable
8996     * under edition mode.
8997     *
8998     * @see elm_clock_edit_get()
8999     *
9000     * @ingroup Clock
9001     */
9002    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9003
9004    /**
9005     * Retrieve whether a given clock widget is under <b>edition
9006     * mode</b> or under (default) displaying-only mode.
9007     *
9008     * @param obj The clock object
9009     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9010     * otherwise
9011     *
9012     * This function retrieves whether the clock's time can be edited
9013     * or not by user interaction.
9014     *
9015     * @see elm_clock_edit_set() for more details
9016     *
9017     * @ingroup Clock
9018     */
9019    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9020
9021    /**
9022     * Set what digits of the given clock widget should be editable
9023     * when in edition mode.
9024     *
9025     * @param obj The clock object
9026     * @param digedit Bit mask indicating the digits to be editable
9027     * (values in #Elm_Clock_Digedit).
9028     *
9029     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9030     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9031     * EINA_FALSE).
9032     *
9033     * @see elm_clock_digit_edit_get()
9034     *
9035     * @ingroup Clock
9036     */
9037    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9038
9039    /**
9040     * Retrieve what digits of the given clock widget should be
9041     * editable when in edition mode.
9042     *
9043     * @param obj The clock object
9044     * @return Bit mask indicating the digits to be editable
9045     * (values in #Elm_Clock_Digedit).
9046     *
9047     * @see elm_clock_digit_edit_set() for more details
9048     *
9049     * @ingroup Clock
9050     */
9051    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9052
9053    /**
9054     * Set if the given clock widget must show hours in military or
9055     * am/pm mode
9056     *
9057     * @param obj The clock object
9058     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9059     * to military mode
9060     *
9061     * This function sets if the clock must show hours in military or
9062     * am/pm mode. In some countries like Brazil the military mode
9063     * (00-24h-format) is used, in opposition to the USA, where the
9064     * am/pm mode is more commonly used.
9065     *
9066     * @see elm_clock_show_am_pm_get()
9067     *
9068     * @ingroup Clock
9069     */
9070    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9071
9072    /**
9073     * Get if the given clock widget shows hours in military or am/pm
9074     * mode
9075     *
9076     * @param obj The clock object
9077     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9078     * military
9079     *
9080     * This function gets if the clock shows hours in military or am/pm
9081     * mode.
9082     *
9083     * @see elm_clock_show_am_pm_set() for more details
9084     *
9085     * @ingroup Clock
9086     */
9087    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9088
9089    /**
9090     * Set if the given clock widget must show time with seconds or not
9091     *
9092     * @param obj The clock object
9093     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9094     *
9095     * This function sets if the given clock must show or not elapsed
9096     * seconds. By default, they are @b not shown.
9097     *
9098     * @see elm_clock_show_seconds_get()
9099     *
9100     * @ingroup Clock
9101     */
9102    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9103
9104    /**
9105     * Get whether the given clock widget is showing time with seconds
9106     * or not
9107     *
9108     * @param obj The clock object
9109     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9110     *
9111     * This function gets whether @p obj is showing or not the elapsed
9112     * seconds.
9113     *
9114     * @see elm_clock_show_seconds_set()
9115     *
9116     * @ingroup Clock
9117     */
9118    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9119
9120    /**
9121     * Set the interval on time updates for an user mouse button hold
9122     * on clock widgets' time edition.
9123     *
9124     * @param obj The clock object
9125     * @param interval The (first) interval value in seconds
9126     *
9127     * This interval value is @b decreased while the user holds the
9128     * mouse pointer either incrementing or decrementing a given the
9129     * clock digit's value.
9130     *
9131     * This helps the user to get to a given time distant from the
9132     * current one easier/faster, as it will start to flip quicker and
9133     * quicker on mouse button holds.
9134     *
9135     * The calculation for the next flip interval value, starting from
9136     * the one set with this call, is the previous interval divided by
9137     * 1.05, so it decreases a little bit.
9138     *
9139     * The default starting interval value for automatic flips is
9140     * @b 0.85 seconds.
9141     *
9142     * @see elm_clock_interval_get()
9143     *
9144     * @ingroup Clock
9145     */
9146    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9147
9148    /**
9149     * Get the interval on time updates for an user mouse button hold
9150     * on clock widgets' time edition.
9151     *
9152     * @param obj The clock object
9153     * @return The (first) interval value, in seconds, set on it
9154     *
9155     * @see elm_clock_interval_set() for more details
9156     *
9157     * @ingroup Clock
9158     */
9159    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9160
9161    /**
9162     * @}
9163     */
9164
9165    /**
9166     * @defgroup Layout Layout
9167     *
9168     * @image html img/widget/layout/preview-00.png
9169     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9170     *
9171     * @image html img/layout-predefined.png
9172     * @image latex img/layout-predefined.eps width=\textwidth
9173     *
9174     * This is a container widget that takes a standard Edje design file and
9175     * wraps it very thinly in a widget.
9176     *
9177     * An Edje design (theme) file has a very wide range of possibilities to
9178     * describe the behavior of elements added to the Layout. Check out the Edje
9179     * documentation and the EDC reference to get more information about what can
9180     * be done with Edje.
9181     *
9182     * Just like @ref List, @ref Box, and other container widgets, any
9183     * object added to the Layout will become its child, meaning that it will be
9184     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9185     *
9186     * The Layout widget can contain as many Contents, Boxes or Tables as
9187     * described in its theme file. For instance, objects can be added to
9188     * different Tables by specifying the respective Table part names. The same
9189     * is valid for Content and Box.
9190     *
9191     * The objects added as child of the Layout will behave as described in the
9192     * part description where they were added. There are 3 possible types of
9193     * parts where a child can be added:
9194     *
9195     * @section secContent Content (SWALLOW part)
9196     *
9197     * Only one object can be added to the @c SWALLOW part (but you still can
9198     * have many @c SWALLOW parts and one object on each of them). Use the @c
9199     * elm_layout_content_* set of functions to set, retrieve and unset objects
9200     * as content of the @c SWALLOW. After being set to this part, the object
9201     * size, position, visibility, clipping and other description properties
9202     * will be totally controled by the description of the given part (inside
9203     * the Edje theme file).
9204     *
9205     * One can use @c evas_object_size_hint_* functions on the child to have some
9206     * kind of control over its behavior, but the resulting behavior will still
9207     * depend heavily on the @c SWALLOW part description.
9208     *
9209     * The Edje theme also can change the part description, based on signals or
9210     * scripts running inside the theme. This change can also be animated. All of
9211     * this will affect the child object set as content accordingly. The object
9212     * size will be changed if the part size is changed, it will animate move if
9213     * the part is moving, and so on.
9214     *
9215     * The following picture demonstrates a Layout widget with a child object
9216     * added to its @c SWALLOW:
9217     *
9218     * @image html layout_swallow.png
9219     * @image latex layout_swallow.eps width=\textwidth
9220     *
9221     * @section secBox Box (BOX part)
9222     *
9223     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9224     * allows one to add objects to the box and have them distributed along its
9225     * area, accordingly to the specified @a layout property (now by @a layout we
9226     * mean the chosen layouting design of the Box, not the Layout widget
9227     * itself).
9228     *
9229     * A similar effect for having a box with its position, size and other things
9230     * controled by the Layout theme would be to create an Elementary @ref Box
9231     * widget and add it as a Content in the @c SWALLOW part.
9232     *
9233     * The main difference of using the Layout Box is that its behavior, the box
9234     * properties like layouting format, padding, align, etc. will be all
9235     * controled by the theme. This means, for example, that a signal could be
9236     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9237     * handled the signal by changing the box padding, or align, or both. Using
9238     * the Elementary @ref Box widget is not necessarily harder or easier, it
9239     * just depends on the circunstances and requirements.
9240     *
9241     * The Layout Box can be used through the @c elm_layout_box_* set of
9242     * functions.
9243     *
9244     * The following picture demonstrates a Layout widget with many child objects
9245     * added to its @c BOX part:
9246     *
9247     * @image html layout_box.png
9248     * @image latex layout_box.eps width=\textwidth
9249     *
9250     * @section secTable Table (TABLE part)
9251     *
9252     * Just like the @ref secBox, the Layout Table is very similar to the
9253     * Elementary @ref Table widget. It allows one to add objects to the Table
9254     * specifying the row and column where the object should be added, and any
9255     * column or row span if necessary.
9256     *
9257     * Again, we could have this design by adding a @ref Table widget to the @c
9258     * SWALLOW part using elm_layout_content_set(). The same difference happens
9259     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9260     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9261     *
9262     * The Layout Table can be used through the @c elm_layout_table_* set of
9263     * functions.
9264     *
9265     * The following picture demonstrates a Layout widget with many child objects
9266     * added to its @c TABLE part:
9267     *
9268     * @image html layout_table.png
9269     * @image latex layout_table.eps width=\textwidth
9270     *
9271     * @section secPredef Predefined Layouts
9272     *
9273     * Another interesting thing about the Layout widget is that it offers some
9274     * predefined themes that come with the default Elementary theme. These
9275     * themes can be set by the call elm_layout_theme_set(), and provide some
9276     * basic functionality depending on the theme used.
9277     *
9278     * Most of them already send some signals, some already provide a toolbar or
9279     * back and next buttons.
9280     *
9281     * These are available predefined theme layouts. All of them have class = @c
9282     * layout, group = @c application, and style = one of the following options:
9283     *
9284     * @li @c toolbar-content - application with toolbar and main content area
9285     * @li @c toolbar-content-back - application with toolbar and main content
9286     * area with a back button and title area
9287     * @li @c toolbar-content-back-next - application with toolbar and main
9288     * content area with a back and next buttons and title area
9289     * @li @c content-back - application with a main content area with a back
9290     * button and title area
9291     * @li @c content-back-next - application with a main content area with a
9292     * back and next buttons and title area
9293     * @li @c toolbar-vbox - application with toolbar and main content area as a
9294     * vertical box
9295     * @li @c toolbar-table - application with toolbar and main content area as a
9296     * table
9297     *
9298     * @section secExamples Examples
9299     *
9300     * Some examples of the Layout widget can be found here:
9301     * @li @ref layout_example_01
9302     * @li @ref layout_example_02
9303     * @li @ref layout_example_03
9304     * @li @ref layout_example_edc
9305     *
9306     */
9307
9308    /**
9309     * Add a new layout to the parent
9310     *
9311     * @param parent The parent object
9312     * @return The new object or NULL if it cannot be created
9313     *
9314     * @see elm_layout_file_set()
9315     * @see elm_layout_theme_set()
9316     *
9317     * @ingroup Layout
9318     */
9319    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9320    /**
9321     * Set the file that will be used as layout
9322     *
9323     * @param obj The layout object
9324     * @param file The path to file (edj) that will be used as layout
9325     * @param group The group that the layout belongs in edje file
9326     *
9327     * @return (1 = success, 0 = error)
9328     *
9329     * @ingroup Layout
9330     */
9331    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9332    /**
9333     * Set the edje group from the elementary theme that will be used as layout
9334     *
9335     * @param obj The layout object
9336     * @param clas the clas of the group
9337     * @param group the group
9338     * @param style the style to used
9339     *
9340     * @return (1 = success, 0 = error)
9341     *
9342     * @ingroup Layout
9343     */
9344    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9345    /**
9346     * Set the layout content.
9347     *
9348     * @param obj The layout object
9349     * @param swallow The swallow part name in the edje file
9350     * @param content The child that will be added in this layout object
9351     *
9352     * Once the content object is set, a previously set one will be deleted.
9353     * If you want to keep that old content object, use the
9354     * elm_layout_content_unset() function.
9355     *
9356     * @note In an Edje theme, the part used as a content container is called @c
9357     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9358     * expected to be a part name just like the second parameter of
9359     * elm_layout_box_append().
9360     *
9361     * @see elm_layout_box_append()
9362     * @see elm_layout_content_get()
9363     * @see elm_layout_content_unset()
9364     * @see @ref secBox
9365     *
9366     * @ingroup Layout
9367     */
9368    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9369    /**
9370     * Get the child object in the given content part.
9371     *
9372     * @param obj The layout object
9373     * @param swallow The SWALLOW part to get its content
9374     *
9375     * @return The swallowed object or NULL if none or an error occurred
9376     *
9377     * @see elm_layout_content_set()
9378     *
9379     * @ingroup Layout
9380     */
9381    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9382    /**
9383     * Unset the layout content.
9384     *
9385     * @param obj The layout object
9386     * @param swallow The swallow part name in the edje file
9387     * @return The content that was being used
9388     *
9389     * Unparent and return the content object which was set for this part.
9390     *
9391     * @see elm_layout_content_set()
9392     *
9393     * @ingroup Layout
9394     */
9395     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9396    /**
9397     * Set the text of the given part
9398     *
9399     * @param obj The layout object
9400     * @param part The TEXT part where to set the text
9401     * @param text The text to set
9402     *
9403     * @ingroup Layout
9404     * @deprecated use elm_object_text_* instead.
9405     */
9406    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9407    /**
9408     * Get the text set in the given part
9409     *
9410     * @param obj The layout object
9411     * @param part The TEXT part to retrieve the text off
9412     *
9413     * @return The text set in @p part
9414     *
9415     * @ingroup Layout
9416     * @deprecated use elm_object_text_* instead.
9417     */
9418    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9419    /**
9420     * Append child to layout box part.
9421     *
9422     * @param obj the layout object
9423     * @param part the box part to which the object will be appended.
9424     * @param child the child object to append to box.
9425     *
9426     * Once the object is appended, it will become child of the layout. Its
9427     * lifetime will be bound to the layout, whenever the layout dies the child
9428     * will be deleted automatically. One should use elm_layout_box_remove() to
9429     * make this layout forget about the object.
9430     *
9431     * @see elm_layout_box_prepend()
9432     * @see elm_layout_box_insert_before()
9433     * @see elm_layout_box_insert_at()
9434     * @see elm_layout_box_remove()
9435     *
9436     * @ingroup Layout
9437     */
9438    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9439    /**
9440     * Prepend child to layout box part.
9441     *
9442     * @param obj the layout object
9443     * @param part the box part to prepend.
9444     * @param child the child object to prepend to box.
9445     *
9446     * Once the object is prepended, it will become child of the layout. Its
9447     * lifetime will be bound to the layout, whenever the layout dies the child
9448     * will be deleted automatically. One should use elm_layout_box_remove() to
9449     * make this layout forget about the object.
9450     *
9451     * @see elm_layout_box_append()
9452     * @see elm_layout_box_insert_before()
9453     * @see elm_layout_box_insert_at()
9454     * @see elm_layout_box_remove()
9455     *
9456     * @ingroup Layout
9457     */
9458    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9459    /**
9460     * Insert child to layout box part before a reference object.
9461     *
9462     * @param obj the layout object
9463     * @param part the box part to insert.
9464     * @param child the child object to insert into box.
9465     * @param reference another reference object to insert before in box.
9466     *
9467     * Once the object is inserted, it will become child of the layout. Its
9468     * lifetime will be bound to the layout, whenever the layout dies the child
9469     * will be deleted automatically. One should use elm_layout_box_remove() to
9470     * make this layout forget about the object.
9471     *
9472     * @see elm_layout_box_append()
9473     * @see elm_layout_box_prepend()
9474     * @see elm_layout_box_insert_before()
9475     * @see elm_layout_box_remove()
9476     *
9477     * @ingroup Layout
9478     */
9479    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9480    /**
9481     * Insert child to layout box part at a given position.
9482     *
9483     * @param obj the layout object
9484     * @param part the box part to insert.
9485     * @param child the child object to insert into box.
9486     * @param pos the numeric position >=0 to insert the child.
9487     *
9488     * Once the object is inserted, it will become child of the layout. Its
9489     * lifetime will be bound to the layout, whenever the layout dies the child
9490     * will be deleted automatically. One should use elm_layout_box_remove() to
9491     * make this layout forget about the object.
9492     *
9493     * @see elm_layout_box_append()
9494     * @see elm_layout_box_prepend()
9495     * @see elm_layout_box_insert_before()
9496     * @see elm_layout_box_remove()
9497     *
9498     * @ingroup Layout
9499     */
9500    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9501    /**
9502     * Remove a child of the given part box.
9503     *
9504     * @param obj The layout object
9505     * @param part The box part name to remove child.
9506     * @param child The object to remove from box.
9507     * @return The object that was being used, or NULL if not found.
9508     *
9509     * The object will be removed from the box part and its lifetime will
9510     * not be handled by the layout anymore. This is equivalent to
9511     * elm_layout_content_unset() for box.
9512     *
9513     * @see elm_layout_box_append()
9514     * @see elm_layout_box_remove_all()
9515     *
9516     * @ingroup Layout
9517     */
9518    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9519    /**
9520     * Remove all child of the given part box.
9521     *
9522     * @param obj The layout object
9523     * @param part The box part name to remove child.
9524     * @param clear If EINA_TRUE, then all objects will be deleted as
9525     *        well, otherwise they will just be removed and will be
9526     *        dangling on the canvas.
9527     *
9528     * The objects will be removed from the box part and their lifetime will
9529     * not be handled by the layout anymore. This is equivalent to
9530     * elm_layout_box_remove() for all box children.
9531     *
9532     * @see elm_layout_box_append()
9533     * @see elm_layout_box_remove()
9534     *
9535     * @ingroup Layout
9536     */
9537    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9538    /**
9539     * Insert child to layout table part.
9540     *
9541     * @param obj the layout object
9542     * @param part the box part to pack child.
9543     * @param child_obj the child object to pack into table.
9544     * @param col the column to which the child should be added. (>= 0)
9545     * @param row the row to which the child should be added. (>= 0)
9546     * @param colspan how many columns should be used to store this object. (>=
9547     *        1)
9548     * @param rowspan how many rows should be used to store this object. (>= 1)
9549     *
9550     * Once the object is inserted, it will become child of the table. Its
9551     * lifetime will be bound to the layout, and whenever the layout dies the
9552     * child will be deleted automatically. One should use
9553     * elm_layout_table_remove() to make this layout forget about the object.
9554     *
9555     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9556     * more space than a single cell. For instance, the following code:
9557     * @code
9558     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9559     * @endcode
9560     *
9561     * Would result in an object being added like the following picture:
9562     *
9563     * @image html layout_colspan.png
9564     * @image latex layout_colspan.eps width=\textwidth
9565     *
9566     * @see elm_layout_table_unpack()
9567     * @see elm_layout_table_clear()
9568     *
9569     * @ingroup Layout
9570     */
9571    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);
9572    /**
9573     * Unpack (remove) a child of the given part table.
9574     *
9575     * @param obj The layout object
9576     * @param part The table part name to remove child.
9577     * @param child_obj The object to remove from table.
9578     * @return The object that was being used, or NULL if not found.
9579     *
9580     * The object will be unpacked from the table part and its lifetime
9581     * will not be handled by the layout anymore. This is equivalent to
9582     * elm_layout_content_unset() for table.
9583     *
9584     * @see elm_layout_table_pack()
9585     * @see elm_layout_table_clear()
9586     *
9587     * @ingroup Layout
9588     */
9589    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9590    /**
9591     * Remove all child of the given part table.
9592     *
9593     * @param obj The layout object
9594     * @param part The table part name to remove child.
9595     * @param clear If EINA_TRUE, then all objects will be deleted as
9596     *        well, otherwise they will just be removed and will be
9597     *        dangling on the canvas.
9598     *
9599     * The objects will be removed from the table part and their lifetime will
9600     * not be handled by the layout anymore. This is equivalent to
9601     * elm_layout_table_unpack() for all table children.
9602     *
9603     * @see elm_layout_table_pack()
9604     * @see elm_layout_table_unpack()
9605     *
9606     * @ingroup Layout
9607     */
9608    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9609    /**
9610     * Get the edje layout
9611     *
9612     * @param obj The layout object
9613     *
9614     * @return A Evas_Object with the edje layout settings loaded
9615     * with function elm_layout_file_set
9616     *
9617     * This returns the edje object. It is not expected to be used to then
9618     * swallow objects via edje_object_part_swallow() for example. Use
9619     * elm_layout_content_set() instead so child object handling and sizing is
9620     * done properly.
9621     *
9622     * @note This function should only be used if you really need to call some
9623     * low level Edje function on this edje object. All the common stuff (setting
9624     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9625     * with proper elementary functions.
9626     *
9627     * @see elm_object_signal_callback_add()
9628     * @see elm_object_signal_emit()
9629     * @see elm_object_text_part_set()
9630     * @see elm_layout_content_set()
9631     * @see elm_layout_box_append()
9632     * @see elm_layout_table_pack()
9633     * @see elm_layout_data_get()
9634     *
9635     * @ingroup Layout
9636     */
9637    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9638    /**
9639     * Get the edje data from the given layout
9640     *
9641     * @param obj The layout object
9642     * @param key The data key
9643     *
9644     * @return The edje data string
9645     *
9646     * This function fetches data specified inside the edje theme of this layout.
9647     * This function return NULL if data is not found.
9648     *
9649     * In EDC this comes from a data block within the group block that @p
9650     * obj was loaded from. E.g.
9651     *
9652     * @code
9653     * collections {
9654     *   group {
9655     *     name: "a_group";
9656     *     data {
9657     *       item: "key1" "value1";
9658     *       item: "key2" "value2";
9659     *     }
9660     *   }
9661     * }
9662     * @endcode
9663     *
9664     * @ingroup Layout
9665     */
9666    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9667    /**
9668     * Eval sizing
9669     *
9670     * @param obj The layout object
9671     *
9672     * Manually forces a sizing re-evaluation. This is useful when the minimum
9673     * size required by the edje theme of this layout has changed. The change on
9674     * the minimum size required by the edje theme is not immediately reported to
9675     * the elementary layout, so one needs to call this function in order to tell
9676     * the widget (layout) that it needs to reevaluate its own size.
9677     *
9678     * The minimum size of the theme is calculated based on minimum size of
9679     * parts, the size of elements inside containers like box and table, etc. All
9680     * of this can change due to state changes, and that's when this function
9681     * should be called.
9682     *
9683     * Also note that a standard signal of "size,eval" "elm" emitted from the
9684     * edje object will cause this to happen too.
9685     *
9686     * @ingroup Layout
9687     */
9688    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9689
9690    /**
9691     * Sets a specific cursor for an edje part.
9692     *
9693     * @param obj The layout object.
9694     * @param part_name a part from loaded edje group.
9695     * @param cursor cursor name to use, see Elementary_Cursor.h
9696     *
9697     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9698     *         part not exists or it has "mouse_events: 0".
9699     *
9700     * @ingroup Layout
9701     */
9702    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9703
9704    /**
9705     * Get the cursor to be shown when mouse is over an edje part
9706     *
9707     * @param obj The layout object.
9708     * @param part_name a part from loaded edje group.
9709     * @return the cursor name.
9710     *
9711     * @ingroup Layout
9712     */
9713    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9714
9715    /**
9716     * Unsets a cursor previously set with elm_layout_part_cursor_set().
9717     *
9718     * @param obj The layout object.
9719     * @param part_name a part from loaded edje group, that had a cursor set
9720     *        with elm_layout_part_cursor_set().
9721     *
9722     * @ingroup Layout
9723     */
9724    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9725
9726    /**
9727     * Sets a specific cursor style for an edje part.
9728     *
9729     * @param obj The layout object.
9730     * @param part_name a part from loaded edje group.
9731     * @param style the theme style to use (default, transparent, ...)
9732     *
9733     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9734     *         part not exists or it did not had a cursor set.
9735     *
9736     * @ingroup Layout
9737     */
9738    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9739
9740    /**
9741     * Gets a specific cursor style for an edje part.
9742     *
9743     * @param obj The layout object.
9744     * @param part_name a part from loaded edje group.
9745     *
9746     * @return the theme style in use, defaults to "default". If the
9747     *         object does not have a cursor set, then NULL is returned.
9748     *
9749     * @ingroup Layout
9750     */
9751    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9752
9753    /**
9754     * Sets if the cursor set should be searched on the theme or should use
9755     * the provided by the engine, only.
9756     *
9757     * @note before you set if should look on theme you should define a
9758     * cursor with elm_layout_part_cursor_set(). By default it will only
9759     * look for cursors provided by the engine.
9760     *
9761     * @param obj The layout object.
9762     * @param part_name a part from loaded edje group.
9763     * @param engine_only if cursors should be just provided by the engine
9764     *        or should also search on widget's theme as well
9765     *
9766     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9767     *         part not exists or it did not had a cursor set.
9768     *
9769     * @ingroup Layout
9770     */
9771    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);
9772
9773    /**
9774     * Gets a specific cursor engine_only for an edje part.
9775     *
9776     * @param obj The layout object.
9777     * @param part_name a part from loaded edje group.
9778     *
9779     * @return whenever the cursor is just provided by engine or also from theme.
9780     *
9781     * @ingroup Layout
9782     */
9783    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9784
9785 /**
9786  * @def elm_layout_icon_set
9787  * Convienience macro to set the icon object in a layout that follows the
9788  * Elementary naming convention for its parts.
9789  *
9790  * @ingroup Layout
9791  */
9792 #define elm_layout_icon_set(_ly, _obj) \
9793   do { \
9794     const char *sig; \
9795     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9796     if ((_obj)) sig = "elm,state,icon,visible"; \
9797     else sig = "elm,state,icon,hidden"; \
9798     elm_object_signal_emit((_ly), sig, "elm"); \
9799   } while (0)
9800
9801 /**
9802  * @def elm_layout_icon_get
9803  * Convienience macro to get the icon object from a layout that follows the
9804  * Elementary naming convention for its parts.
9805  *
9806  * @ingroup Layout
9807  */
9808 #define elm_layout_icon_get(_ly) \
9809   elm_layout_content_get((_ly), "elm.swallow.icon")
9810
9811 /**
9812  * @def elm_layout_end_set
9813  * Convienience macro to set the end object in a layout that follows the
9814  * Elementary naming convention for its parts.
9815  *
9816  * @ingroup Layout
9817  */
9818 #define elm_layout_end_set(_ly, _obj) \
9819   do { \
9820     const char *sig; \
9821     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9822     if ((_obj)) sig = "elm,state,end,visible"; \
9823     else sig = "elm,state,end,hidden"; \
9824     elm_object_signal_emit((_ly), sig, "elm"); \
9825   } while (0)
9826
9827 /**
9828  * @def elm_layout_end_get
9829  * Convienience macro to get the end object in a layout that follows the
9830  * Elementary naming convention for its parts.
9831  *
9832  * @ingroup Layout
9833  */
9834 #define elm_layout_end_get(_ly) \
9835   elm_layout_content_get((_ly), "elm.swallow.end")
9836
9837 /**
9838  * @def elm_layout_label_set
9839  * Convienience macro to set the label in a layout that follows the
9840  * Elementary naming convention for its parts.
9841  *
9842  * @ingroup Layout
9843  * @deprecated use elm_object_text_* instead.
9844  */
9845 #define elm_layout_label_set(_ly, _txt) \
9846   elm_layout_text_set((_ly), "elm.text", (_txt))
9847
9848 /**
9849  * @def elm_layout_label_get
9850  * Convienience macro to get the label in a layout that follows the
9851  * Elementary naming convention for its parts.
9852  *
9853  * @ingroup Layout
9854  * @deprecated use elm_object_text_* instead.
9855  */
9856 #define elm_layout_label_get(_ly) \
9857   elm_layout_text_get((_ly), "elm.text")
9858
9859    /* smart callbacks called:
9860     * "theme,changed" - when elm theme is changed.
9861     */
9862
9863    /**
9864     * @defgroup Notify Notify
9865     *
9866     * @image html img/widget/notify/preview-00.png
9867     * @image latex img/widget/notify/preview-00.eps
9868     *
9869     * Display a container in a particular region of the parent(top, bottom,
9870     * etc.  A timeout can be set to automatically hide the notify. This is so
9871     * that, after an evas_object_show() on a notify object, if a timeout was set
9872     * on it, it will @b automatically get hidden after that time.
9873     *
9874     * Signals that you can add callbacks for are:
9875     * @li "timeout" - when timeout happens on notify and it's hidden
9876     * @li "block,clicked" - when a click outside of the notify happens
9877     *
9878     * @ref tutorial_notify show usage of the API.
9879     *
9880     * @{
9881     */
9882    /**
9883     * @brief Possible orient values for notify.
9884     *
9885     * This values should be used in conjunction to elm_notify_orient_set() to
9886     * set the position in which the notify should appear(relative to its parent)
9887     * and in conjunction with elm_notify_orient_get() to know where the notify
9888     * is appearing.
9889     */
9890    typedef enum _Elm_Notify_Orient
9891      {
9892         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9893         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9894         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9895         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9896         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9897         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9898         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9899         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9900         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9901         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9902      } Elm_Notify_Orient;
9903    /**
9904     * @brief Add a new notify to the parent
9905     *
9906     * @param parent The parent object
9907     * @return The new object or NULL if it cannot be created
9908     */
9909    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9910    /**
9911     * @brief Set the content of the notify widget
9912     *
9913     * @param obj The notify object
9914     * @param content The content will be filled in this notify object
9915     *
9916     * Once the content object is set, a previously set one will be deleted. If
9917     * you want to keep that old content object, use the
9918     * elm_notify_content_unset() function.
9919     */
9920    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9921    /**
9922     * @brief Unset the content of the notify widget
9923     *
9924     * @param obj The notify object
9925     * @return The content that was being used
9926     *
9927     * Unparent and return the content object which was set for this widget
9928     *
9929     * @see elm_notify_content_set()
9930     */
9931    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9932    /**
9933     * @brief Return the content of the notify widget
9934     *
9935     * @param obj The notify object
9936     * @return The content that is being used
9937     *
9938     * @see elm_notify_content_set()
9939     */
9940    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9941    /**
9942     * @brief Set the notify parent
9943     *
9944     * @param obj The notify object
9945     * @param content The new parent
9946     *
9947     * Once the parent object is set, a previously set one will be disconnected
9948     * and replaced.
9949     */
9950    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9951    /**
9952     * @brief Get the notify parent
9953     *
9954     * @param obj The notify object
9955     * @return The parent
9956     *
9957     * @see elm_notify_parent_set()
9958     */
9959    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9960    /**
9961     * @brief Set the orientation
9962     *
9963     * @param obj The notify object
9964     * @param orient The new orientation
9965     *
9966     * Sets the position in which the notify will appear in its parent.
9967     *
9968     * @see @ref Elm_Notify_Orient for possible values.
9969     */
9970    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
9971    /**
9972     * @brief Return the orientation
9973     * @param obj The notify object
9974     * @return The orientation of the notification
9975     *
9976     * @see elm_notify_orient_set()
9977     * @see Elm_Notify_Orient
9978     */
9979    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9980    /**
9981     * @brief Set the time interval after which the notify window is going to be
9982     * hidden.
9983     *
9984     * @param obj The notify object
9985     * @param time The timeout in seconds
9986     *
9987     * This function sets a timeout and starts the timer controlling when the
9988     * notify is hidden. Since calling evas_object_show() on a notify restarts
9989     * the timer controlling when the notify is hidden, setting this before the
9990     * notify is shown will in effect mean starting the timer when the notify is
9991     * shown.
9992     *
9993     * @note Set a value <= 0.0 to disable a running timer.
9994     *
9995     * @note If the value > 0.0 and the notify is previously visible, the
9996     * timer will be started with this value, canceling any running timer.
9997     */
9998    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
9999    /**
10000     * @brief Return the timeout value (in seconds)
10001     * @param obj the notify object
10002     *
10003     * @see elm_notify_timeout_set()
10004     */
10005    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10006    /**
10007     * @brief Sets whether events should be passed to by a click outside
10008     * its area.
10009     *
10010     * @param obj The notify object
10011     * @param repeats EINA_TRUE Events are repeats, else no
10012     *
10013     * When true if the user clicks outside the window the events will be caught
10014     * by the others widgets, else the events are blocked.
10015     *
10016     * @note The default value is EINA_TRUE.
10017     */
10018    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10019    /**
10020     * @brief Return true if events are repeat below the notify object
10021     * @param obj the notify object
10022     *
10023     * @see elm_notify_repeat_events_set()
10024     */
10025    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10026    /**
10027     * @}
10028     */
10029
10030    /**
10031     * @defgroup Hover Hover
10032     *
10033     * @image html img/widget/hover/preview-00.png
10034     * @image latex img/widget/hover/preview-00.eps
10035     *
10036     * A Hover object will hover over its @p parent object at the @p target
10037     * location. Anything in the background will be given a darker coloring to
10038     * indicate that the hover object is on top (at the default theme). When the
10039     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10040     * clicked that @b doesn't cause the hover to be dismissed.
10041     *
10042     * @note The hover object will take up the entire space of @p target
10043     * object.
10044     *
10045     * Elementary has the following styles for the hover widget:
10046     * @li default
10047     * @li popout
10048     * @li menu
10049     * @li hoversel_vertical
10050     *
10051     * The following are the available position for content:
10052     * @li left
10053     * @li top-left
10054     * @li top
10055     * @li top-right
10056     * @li right
10057     * @li bottom-right
10058     * @li bottom
10059     * @li bottom-left
10060     * @li middle
10061     * @li smart
10062     *
10063     * Signals that you can add callbacks for are:
10064     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10065     * @li "smart,changed" - a content object placed under the "smart"
10066     *                   policy was replaced to a new slot direction.
10067     *
10068     * See @ref tutorial_hover for more information.
10069     *
10070     * @{
10071     */
10072    typedef enum _Elm_Hover_Axis
10073      {
10074         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10075         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10076         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10077         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10078      } Elm_Hover_Axis;
10079    /**
10080     * @brief Adds a hover object to @p parent
10081     *
10082     * @param parent The parent object
10083     * @return The hover object or NULL if one could not be created
10084     */
10085    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10086    /**
10087     * @brief Sets the target object for the hover.
10088     *
10089     * @param obj The hover object
10090     * @param target The object to center the hover onto. The hover
10091     *
10092     * This function will cause the hover to be centered on the target object.
10093     */
10094    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10095    /**
10096     * @brief Gets the target object for the hover.
10097     *
10098     * @param obj The hover object
10099     * @param parent The object to locate the hover over.
10100     *
10101     * @see elm_hover_target_set()
10102     */
10103    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10104    /**
10105     * @brief Sets the parent object for the hover.
10106     *
10107     * @param obj The hover object
10108     * @param parent The object to locate the hover over.
10109     *
10110     * This function will cause the hover to take up the entire space that the
10111     * parent object fills.
10112     */
10113    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10114    /**
10115     * @brief Gets the parent object for the hover.
10116     *
10117     * @param obj The hover object
10118     * @return The parent object to locate the hover over.
10119     *
10120     * @see elm_hover_parent_set()
10121     */
10122    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10123    /**
10124     * @brief Sets the content of the hover object and the direction in which it
10125     * will pop out.
10126     *
10127     * @param obj The hover object
10128     * @param swallow The direction that the object will be displayed
10129     * at. Accepted values are "left", "top-left", "top", "top-right",
10130     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10131     * "smart".
10132     * @param content The content to place at @p swallow
10133     *
10134     * Once the content object is set for a given direction, a previously
10135     * set one (on the same direction) will be deleted. If you want to
10136     * keep that old content object, use the elm_hover_content_unset()
10137     * function.
10138     *
10139     * All directions may have contents at the same time, except for
10140     * "smart". This is a special placement hint and its use case
10141     * independs of the calculations coming from
10142     * elm_hover_best_content_location_get(). Its use is for cases when
10143     * one desires only one hover content, but with a dinamic special
10144     * placement within the hover area. The content's geometry, whenever
10145     * it changes, will be used to decide on a best location not
10146     * extrapolating the hover's parent object view to show it in (still
10147     * being the hover's target determinant of its medium part -- move and
10148     * resize it to simulate finger sizes, for example). If one of the
10149     * directions other than "smart" are used, a previously content set
10150     * using it will be deleted, and vice-versa.
10151     */
10152    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10153    /**
10154     * @brief Get the content of the hover object, in a given direction.
10155     *
10156     * Return the content object which was set for this widget in the
10157     * @p swallow direction.
10158     *
10159     * @param obj The hover object
10160     * @param swallow The direction that the object was display at.
10161     * @return The content that was being used
10162     *
10163     * @see elm_hover_content_set()
10164     */
10165    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10166    /**
10167     * @brief Unset the content of the hover object, in a given direction.
10168     *
10169     * Unparent and return the content object set at @p swallow direction.
10170     *
10171     * @param obj The hover object
10172     * @param swallow The direction that the object was display at.
10173     * @return The content that was being used.
10174     *
10175     * @see elm_hover_content_set()
10176     */
10177    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10178    /**
10179     * @brief Returns the best swallow location for content in the hover.
10180     *
10181     * @param obj The hover object
10182     * @param pref_axis The preferred orientation axis for the hover object to use
10183     * @return The edje location to place content into the hover or @c
10184     *         NULL, on errors.
10185     *
10186     * Best is defined here as the location at which there is the most available
10187     * space.
10188     *
10189     * @p pref_axis may be one of
10190     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10191     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10192     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10193     * - @c ELM_HOVER_AXIS_BOTH -- both
10194     *
10195     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10196     * nescessarily be along the horizontal axis("left" or "right"). If
10197     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10198     * be along the vertical axis("top" or "bottom"). Chossing
10199     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10200     * returned position may be in either axis.
10201     *
10202     * @see elm_hover_content_set()
10203     */
10204    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10205    /**
10206     * @}
10207     */
10208
10209    /* entry */
10210    /**
10211     * @defgroup Entry Entry
10212     *
10213     * @image html img/widget/entry/preview-00.png
10214     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10215     * @image html img/widget/entry/preview-01.png
10216     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10217     * @image html img/widget/entry/preview-02.png
10218     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10219     * @image html img/widget/entry/preview-03.png
10220     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10221     *
10222     * An entry is a convenience widget which shows a box that the user can
10223     * enter text into. Entries by default don't scroll, so they grow to
10224     * accomodate the entire text, resizing the parent window as needed. This
10225     * can be changed with the elm_entry_scrollable_set() function.
10226     *
10227     * They can also be single line or multi line (the default) and when set
10228     * to multi line mode they support text wrapping in any of the modes
10229     * indicated by #Elm_Wrap_Type.
10230     *
10231     * Other features include password mode, filtering of inserted text with
10232     * elm_entry_text_filter_append() and related functions, inline "items" and
10233     * formatted markup text.
10234     *
10235     * @section entry-markup Formatted text
10236     *
10237     * The markup tags supported by the Entry are defined by the theme, but
10238     * even when writing new themes or extensions it's a good idea to stick to
10239     * a sane default, to maintain coherency and avoid application breakages.
10240     * Currently defined by the default theme are the following tags:
10241     * @li \<br\>: Inserts a line break.
10242     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10243     * breaks.
10244     * @li \<tab\>: Inserts a tab.
10245     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10246     * enclosed text.
10247     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10248     * @li \<link\>...\</link\>: Underlines the enclosed text.
10249     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10250     *
10251     * @section entry-special Special markups
10252     *
10253     * Besides those used to format text, entries support two special markup
10254     * tags used to insert clickable portions of text or items inlined within
10255     * the text.
10256     *
10257     * @subsection entry-anchors Anchors
10258     *
10259     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10260     * \</a\> tags and an event will be generated when this text is clicked,
10261     * like this:
10262     *
10263     * @code
10264     * This text is outside <a href=anc-01>but this one is an anchor</a>
10265     * @endcode
10266     *
10267     * The @c href attribute in the opening tag gives the name that will be
10268     * used to identify the anchor and it can be any valid utf8 string.
10269     *
10270     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10271     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10272     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10273     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10274     * an anchor.
10275     *
10276     * @subsection entry-items Items
10277     *
10278     * Inlined in the text, any other @c Evas_Object can be inserted by using
10279     * \<item\> tags this way:
10280     *
10281     * @code
10282     * <item size=16x16 vsize=full href=emoticon/haha></item>
10283     * @endcode
10284     *
10285     * Just like with anchors, the @c href identifies each item, but these need,
10286     * in addition, to indicate their size, which is done using any one of
10287     * @c size, @c absize or @c relsize attributes. These attributes take their
10288     * value in the WxH format, where W is the width and H the height of the
10289     * item.
10290     *
10291     * @li absize: Absolute pixel size for the item. Whatever value is set will
10292     * be the item's size regardless of any scale value the object may have
10293     * been set to. The final line height will be adjusted to fit larger items.
10294     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10295     * for the object.
10296     * @li relsize: Size is adjusted for the item to fit within the current
10297     * line height.
10298     *
10299     * Besides their size, items are specificed a @c vsize value that affects
10300     * how their final size and position are calculated. The possible values
10301     * are:
10302     * @li ascent: Item will be placed within the line's baseline and its
10303     * ascent. That is, the height between the line where all characters are
10304     * positioned and the highest point in the line. For @c size and @c absize
10305     * items, the descent value will be added to the total line height to make
10306     * them fit. @c relsize items will be adjusted to fit within this space.
10307     * @li full: Items will be placed between the descent and ascent, or the
10308     * lowest point in the line and its highest.
10309     *
10310     * The next image shows different configurations of items and how they
10311     * are the previously mentioned options affect their sizes. In all cases,
10312     * the green line indicates the ascent, blue for the baseline and red for
10313     * the descent.
10314     *
10315     * @image html entry_item.png
10316     * @image latex entry_item.eps width=\textwidth
10317     *
10318     * And another one to show how size differs from absize. In the first one,
10319     * the scale value is set to 1.0, while the second one is using one of 2.0.
10320     *
10321     * @image html entry_item_scale.png
10322     * @image latex entry_item_scale.eps width=\textwidth
10323     *
10324     * After the size for an item is calculated, the entry will request an
10325     * object to place in its space. For this, the functions set with
10326     * elm_entry_item_provider_append() and related functions will be called
10327     * in order until one of them returns a @c non-NULL value. If no providers
10328     * are available, or all of them return @c NULL, then the entry falls back
10329     * to one of the internal defaults, provided the name matches with one of
10330     * them.
10331     *
10332     * All of the following are currently supported:
10333     *
10334     * - emoticon/angry
10335     * - emoticon/angry-shout
10336     * - emoticon/crazy-laugh
10337     * - emoticon/evil-laugh
10338     * - emoticon/evil
10339     * - emoticon/goggle-smile
10340     * - emoticon/grumpy
10341     * - emoticon/grumpy-smile
10342     * - emoticon/guilty
10343     * - emoticon/guilty-smile
10344     * - emoticon/haha
10345     * - emoticon/half-smile
10346     * - emoticon/happy-panting
10347     * - emoticon/happy
10348     * - emoticon/indifferent
10349     * - emoticon/kiss
10350     * - emoticon/knowing-grin
10351     * - emoticon/laugh
10352     * - emoticon/little-bit-sorry
10353     * - emoticon/love-lots
10354     * - emoticon/love
10355     * - emoticon/minimal-smile
10356     * - emoticon/not-happy
10357     * - emoticon/not-impressed
10358     * - emoticon/omg
10359     * - emoticon/opensmile
10360     * - emoticon/smile
10361     * - emoticon/sorry
10362     * - emoticon/squint-laugh
10363     * - emoticon/surprised
10364     * - emoticon/suspicious
10365     * - emoticon/tongue-dangling
10366     * - emoticon/tongue-poke
10367     * - emoticon/uh
10368     * - emoticon/unhappy
10369     * - emoticon/very-sorry
10370     * - emoticon/what
10371     * - emoticon/wink
10372     * - emoticon/worried
10373     * - emoticon/wtf
10374     *
10375     * Alternatively, an item may reference an image by its path, using
10376     * the URI form @c file:///path/to/an/image.png and the entry will then
10377     * use that image for the item.
10378     *
10379     * @section entry-files Loading and saving files
10380     *
10381     * Entries have convinience functions to load text from a file and save
10382     * changes back to it after a short delay. The automatic saving is enabled
10383     * by default, but can be disabled with elm_entry_autosave_set() and files
10384     * can be loaded directly as plain text or have any markup in them
10385     * recognized. See elm_entry_file_set() for more details.
10386     *
10387     * @section entry-signals Emitted signals
10388     *
10389     * This widget emits the following signals:
10390     *
10391     * @li "changed": The text within the entry was changed.
10392     * @li "changed,user": The text within the entry was changed because of user interaction.
10393     * @li "activated": The enter key was pressed on a single line entry.
10394     * @li "press": A mouse button has been pressed on the entry.
10395     * @li "longpressed": A mouse button has been pressed and held for a couple
10396     * seconds.
10397     * @li "clicked": The entry has been clicked (mouse press and release).
10398     * @li "clicked,double": The entry has been double clicked.
10399     * @li "clicked,triple": The entry has been triple clicked.
10400     * @li "focused": The entry has received focus.
10401     * @li "unfocused": The entry has lost focus.
10402     * @li "selection,paste": A paste of the clipboard contents was requested.
10403     * @li "selection,copy": A copy of the selected text into the clipboard was
10404     * requested.
10405     * @li "selection,cut": A cut of the selected text into the clipboard was
10406     * requested.
10407     * @li "selection,start": A selection has begun and no previous selection
10408     * existed.
10409     * @li "selection,changed": The current selection has changed.
10410     * @li "selection,cleared": The current selection has been cleared.
10411     * @li "cursor,changed": The cursor has changed position.
10412     * @li "anchor,clicked": An anchor has been clicked. The event_info
10413     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10414     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10415     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10416     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10417     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10418     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10419     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10420     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10421     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10422     * @li "preedit,changed": The preedit string has changed.
10423     *
10424     * @section entry-examples
10425     *
10426     * An overview of the Entry API can be seen in @ref entry_example_01
10427     *
10428     * @{
10429     */
10430    /**
10431     * @typedef Elm_Entry_Anchor_Info
10432     *
10433     * The info sent in the callback for the "anchor,clicked" signals emitted
10434     * by entries.
10435     */
10436    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10437    /**
10438     * @struct _Elm_Entry_Anchor_Info
10439     *
10440     * The info sent in the callback for the "anchor,clicked" signals emitted
10441     * by entries.
10442     */
10443    struct _Elm_Entry_Anchor_Info
10444      {
10445         const char *name; /**< The name of the anchor, as stated in its href */
10446         int         button; /**< The mouse button used to click on it */
10447         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10448                     y, /**< Anchor geometry, relative to canvas */
10449                     w, /**< Anchor geometry, relative to canvas */
10450                     h; /**< Anchor geometry, relative to canvas */
10451      };
10452    /**
10453     * @typedef Elm_Entry_Filter_Cb
10454     * This callback type is used by entry filters to modify text.
10455     * @param data The data specified as the last param when adding the filter
10456     * @param entry The entry object
10457     * @param text A pointer to the location of the text being filtered. This data can be modified,
10458     * but any additional allocations must be managed by the user.
10459     * @see elm_entry_text_filter_append
10460     * @see elm_entry_text_filter_prepend
10461     */
10462    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10463
10464    /**
10465     * This adds an entry to @p parent object.
10466     *
10467     * By default, entries are:
10468     * @li not scrolled
10469     * @li multi-line
10470     * @li word wrapped
10471     * @li autosave is enabled
10472     *
10473     * @param parent The parent object
10474     * @return The new object or NULL if it cannot be created
10475     */
10476    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10477    /**
10478     * Sets the entry to single line mode.
10479     *
10480     * In single line mode, entries don't ever wrap when the text reaches the
10481     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10482     * key will generate an @c "activate" event instead of adding a new line.
10483     *
10484     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10485     * and pressing enter will break the text into a different line
10486     * without generating any events.
10487     *
10488     * @param obj The entry object
10489     * @param single_line If true, the text in the entry
10490     * will be on a single line.
10491     */
10492    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10493    /**
10494     * Gets whether the entry is set to be single line.
10495     *
10496     * @param obj The entry object
10497     * @return single_line If true, the text in the entry is set to display
10498     * on a single line.
10499     *
10500     * @see elm_entry_single_line_set()
10501     */
10502    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10503    /**
10504     * Sets the entry to password mode.
10505     *
10506     * In password mode, entries are implicitly single line and the display of
10507     * any text in them is replaced with asterisks (*).
10508     *
10509     * @param obj The entry object
10510     * @param password If true, password mode is enabled.
10511     */
10512    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10513    /**
10514     * Gets whether the entry is set to password mode.
10515     *
10516     * @param obj The entry object
10517     * @return If true, the entry is set to display all characters
10518     * as asterisks (*).
10519     *
10520     * @see elm_entry_password_set()
10521     */
10522    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10523    /**
10524     * This sets the text displayed within the entry to @p entry.
10525     *
10526     * @param obj The entry object
10527     * @param entry The text to be displayed
10528     *
10529     * @deprecated Use elm_object_text_set() instead.
10530     */
10531    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10532    /**
10533     * This returns the text currently shown in object @p entry.
10534     * See also elm_entry_entry_set().
10535     *
10536     * @param obj The entry object
10537     * @return The currently displayed text or NULL on failure
10538     *
10539     * @deprecated Use elm_object_text_get() instead.
10540     */
10541    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10542    /**
10543     * Appends @p entry to the text of the entry.
10544     *
10545     * Adds the text in @p entry to the end of any text already present in the
10546     * widget.
10547     *
10548     * The appended text is subject to any filters set for the widget.
10549     *
10550     * @param obj The entry object
10551     * @param entry The text to be displayed
10552     *
10553     * @see elm_entry_text_filter_append()
10554     */
10555    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10556    /**
10557     * Gets whether the entry is empty.
10558     *
10559     * Empty means no text at all. If there are any markup tags, like an item
10560     * tag for which no provider finds anything, and no text is displayed, this
10561     * function still returns EINA_FALSE.
10562     *
10563     * @param obj The entry object
10564     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10565     */
10566    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10567    /**
10568     * Gets any selected text within the entry.
10569     *
10570     * If there's any selected text in the entry, this function returns it as
10571     * a string in markup format. NULL is returned if no selection exists or
10572     * if an error occurred.
10573     *
10574     * The returned value points to an internal string and should not be freed
10575     * or modified in any way. If the @p entry object is deleted or its
10576     * contents are changed, the returned pointer should be considered invalid.
10577     *
10578     * @param obj The entry object
10579     * @return The selected text within the entry or NULL on failure
10580     */
10581    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10582    /**
10583     * Inserts the given text into the entry at the current cursor position.
10584     *
10585     * This inserts text at the cursor position as if it was typed
10586     * by the user (note that this also allows markup which a user
10587     * can't just "type" as it would be converted to escaped text, so this
10588     * call can be used to insert things like emoticon items or bold push/pop
10589     * tags, other font and color change tags etc.)
10590     *
10591     * If any selection exists, it will be replaced by the inserted text.
10592     *
10593     * The inserted text is subject to any filters set for the widget.
10594     *
10595     * @param obj The entry object
10596     * @param entry The text to insert
10597     *
10598     * @see elm_entry_text_filter_append()
10599     */
10600    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10601    /**
10602     * Set the line wrap type to use on multi-line entries.
10603     *
10604     * Sets the wrap type used by the entry to any of the specified in
10605     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10606     * line (without inserting a line break or paragraph separator) when it
10607     * reaches the far edge of the widget.
10608     *
10609     * Note that this only makes sense for multi-line entries. A widget set
10610     * to be single line will never wrap.
10611     *
10612     * @param obj The entry object
10613     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10614     */
10615    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10616    /**
10617     * Gets the wrap mode the entry was set to use.
10618     *
10619     * @param obj The entry object
10620     * @return Wrap type
10621     *
10622     * @see also elm_entry_line_wrap_set()
10623     */
10624    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10625    /**
10626     * Sets if the entry is to be editable or not.
10627     *
10628     * By default, entries are editable and when focused, any text input by the
10629     * user will be inserted at the current cursor position. But calling this
10630     * function with @p editable as EINA_FALSE will prevent the user from
10631     * inputting text into the entry.
10632     *
10633     * The only way to change the text of a non-editable entry is to use
10634     * elm_object_text_set(), elm_entry_entry_insert() and other related
10635     * functions.
10636     *
10637     * @param obj The entry object
10638     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10639     * if not, the entry is read-only and no user input is allowed.
10640     */
10641    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10642    /**
10643     * Gets whether the entry is editable or not.
10644     *
10645     * @param obj The entry object
10646     * @return If true, the entry is editable by the user.
10647     * If false, it is not editable by the user
10648     *
10649     * @see elm_entry_editable_set()
10650     */
10651    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10652    /**
10653     * This drops any existing text selection within the entry.
10654     *
10655     * @param obj The entry object
10656     */
10657    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10658    /**
10659     * This selects all text within the entry.
10660     *
10661     * @param obj The entry object
10662     */
10663    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10664    /**
10665     * This moves the cursor one place to the right within the entry.
10666     *
10667     * @param obj The entry object
10668     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10669     */
10670    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10671    /**
10672     * This moves the cursor one place to the left within the entry.
10673     *
10674     * @param obj The entry object
10675     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10676     */
10677    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10678    /**
10679     * This moves the cursor one line up within the entry.
10680     *
10681     * @param obj The entry object
10682     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10683     */
10684    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10685    /**
10686     * This moves the cursor one line down within the entry.
10687     *
10688     * @param obj The entry object
10689     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10690     */
10691    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10692    /**
10693     * This moves the cursor to the beginning of the entry.
10694     *
10695     * @param obj The entry object
10696     */
10697    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10698    /**
10699     * This moves the cursor to the end of the entry.
10700     *
10701     * @param obj The entry object
10702     */
10703    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10704    /**
10705     * This moves the cursor to the beginning of the current line.
10706     *
10707     * @param obj The entry object
10708     */
10709    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10710    /**
10711     * This moves the cursor to the end of the current line.
10712     *
10713     * @param obj The entry object
10714     */
10715    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10716    /**
10717     * This begins a selection within the entry as though
10718     * the user were holding down the mouse button to make a selection.
10719     *
10720     * @param obj The entry object
10721     */
10722    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10723    /**
10724     * This ends a selection within the entry as though
10725     * the user had just released the mouse button while making a selection.
10726     *
10727     * @param obj The entry object
10728     */
10729    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10730    /**
10731     * Gets whether a format node exists at the current cursor position.
10732     *
10733     * A format node is anything that defines how the text is rendered. It can
10734     * be a visible format node, such as a line break or a paragraph separator,
10735     * or an invisible one, such as bold begin or end tag.
10736     * This function returns whether any format node exists at the current
10737     * cursor position.
10738     *
10739     * @param obj The entry object
10740     * @return EINA_TRUE if the current cursor position contains a format node,
10741     * EINA_FALSE otherwise.
10742     *
10743     * @see elm_entry_cursor_is_visible_format_get()
10744     */
10745    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10746    /**
10747     * Gets if the current cursor position holds a visible format node.
10748     *
10749     * @param obj The entry object
10750     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10751     * if it's an invisible one or no format exists.
10752     *
10753     * @see elm_entry_cursor_is_format_get()
10754     */
10755    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10756    /**
10757     * Gets the character pointed by the cursor at its current position.
10758     *
10759     * This function returns a string with the utf8 character stored at the
10760     * current cursor position.
10761     * Only the text is returned, any format that may exist will not be part
10762     * of the return value.
10763     *
10764     * @param obj The entry object
10765     * @return The text pointed by the cursors.
10766     */
10767    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10768    /**
10769     * This function returns the geometry of the cursor.
10770     *
10771     * It's useful if you want to draw something on the cursor (or where it is),
10772     * or for example in the case of scrolled entry where you want to show the
10773     * cursor.
10774     *
10775     * @param obj The entry object
10776     * @param x returned geometry
10777     * @param y returned geometry
10778     * @param w returned geometry
10779     * @param h returned geometry
10780     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10781     */
10782    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);
10783    /**
10784     * Sets the cursor position in the entry to the given value
10785     *
10786     * The value in @p pos is the index of the character position within the
10787     * contents of the string as returned by elm_entry_cursor_pos_get().
10788     *
10789     * @param obj The entry object
10790     * @param pos The position of the cursor
10791     */
10792    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10793    /**
10794     * Retrieves the current position of the cursor in the entry
10795     *
10796     * @param obj The entry object
10797     * @return The cursor position
10798     */
10799    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10800    /**
10801     * This executes a "cut" action on the selected text in the entry.
10802     *
10803     * @param obj The entry object
10804     */
10805    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10806    /**
10807     * This executes a "copy" action on the selected text in the entry.
10808     *
10809     * @param obj The entry object
10810     */
10811    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10812    /**
10813     * This executes a "paste" action in the entry.
10814     *
10815     * @param obj The entry object
10816     */
10817    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10818    /**
10819     * This clears and frees the items in a entry's contextual (longpress)
10820     * menu.
10821     *
10822     * @param obj The entry object
10823     *
10824     * @see elm_entry_context_menu_item_add()
10825     */
10826    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10827    /**
10828     * This adds an item to the entry's contextual menu.
10829     *
10830     * A longpress on an entry will make the contextual menu show up, if this
10831     * hasn't been disabled with elm_entry_context_menu_disabled_set().
10832     * By default, this menu provides a few options like enabling selection mode,
10833     * which is useful on embedded devices that need to be explicit about it,
10834     * and when a selection exists it also shows the copy and cut actions.
10835     *
10836     * With this function, developers can add other options to this menu to
10837     * perform any action they deem necessary.
10838     *
10839     * @param obj The entry object
10840     * @param label The item's text label
10841     * @param icon_file The item's icon file
10842     * @param icon_type The item's icon type
10843     * @param func The callback to execute when the item is clicked
10844     * @param data The data to associate with the item for related functions
10845     */
10846    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);
10847    /**
10848     * This disables the entry's contextual (longpress) menu.
10849     *
10850     * @param obj The entry object
10851     * @param disabled If true, the menu is disabled
10852     */
10853    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10854    /**
10855     * This returns whether the entry's contextual (longpress) menu is
10856     * disabled.
10857     *
10858     * @param obj The entry object
10859     * @return If true, the menu is disabled
10860     */
10861    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10862    /**
10863     * This appends a custom item provider to the list for that entry
10864     *
10865     * This appends the given callback. The list is walked from beginning to end
10866     * with each function called given the item href string in the text. If the
10867     * function returns an object handle other than NULL (it should create an
10868     * object to do this), then this object is used to replace that item. If
10869     * not the next provider is called until one provides an item object, or the
10870     * default provider in entry does.
10871     *
10872     * @param obj The entry object
10873     * @param func The function called to provide the item object
10874     * @param data The data passed to @p func
10875     *
10876     * @see @ref entry-items
10877     */
10878    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);
10879    /**
10880     * This prepends a custom item provider to the list for that entry
10881     *
10882     * This prepends the given callback. See elm_entry_item_provider_append() for
10883     * more information
10884     *
10885     * @param obj The entry object
10886     * @param func The function called to provide the item object
10887     * @param data The data passed to @p func
10888     */
10889    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);
10890    /**
10891     * This removes a custom item provider to the list for that entry
10892     *
10893     * This removes the given callback. See elm_entry_item_provider_append() for
10894     * more information
10895     *
10896     * @param obj The entry object
10897     * @param func The function called to provide the item object
10898     * @param data The data passed to @p func
10899     */
10900    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);
10901    /**
10902     * Append a filter function for text inserted in the entry
10903     *
10904     * Append the given callback to the list. This functions will be called
10905     * whenever any text is inserted into the entry, with the text to be inserted
10906     * as a parameter. The callback function is free to alter the text in any way
10907     * it wants, but it must remember to free the given pointer and update it.
10908     * If the new text is to be discarded, the function can free it and set its
10909     * text parameter to NULL. This will also prevent any following filters from
10910     * being called.
10911     *
10912     * @param obj The entry object
10913     * @param func The function to use as text filter
10914     * @param data User data to pass to @p func
10915     */
10916    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10917    /**
10918     * Prepend a filter function for text insdrted in the entry
10919     *
10920     * Prepend the given callback to the list. See elm_entry_text_filter_append()
10921     * for more information
10922     *
10923     * @param obj The entry object
10924     * @param func The function to use as text filter
10925     * @param data User data to pass to @p func
10926     */
10927    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10928    /**
10929     * Remove a filter from the list
10930     *
10931     * Removes the given callback from the filter list. See
10932     * elm_entry_text_filter_append() for more information.
10933     *
10934     * @param obj The entry object
10935     * @param func The filter function to remove
10936     * @param data The user data passed when adding the function
10937     */
10938    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10939    /**
10940     * This converts a markup (HTML-like) string into UTF-8.
10941     *
10942     * The returned string is a malloc'ed buffer and it should be freed when
10943     * not needed anymore.
10944     *
10945     * @param s The string (in markup) to be converted
10946     * @return The converted string (in UTF-8). It should be freed.
10947     */
10948    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10949    /**
10950     * This converts a UTF-8 string into markup (HTML-like).
10951     *
10952     * The returned string is a malloc'ed buffer and it should be freed when
10953     * not needed anymore.
10954     *
10955     * @param s The string (in UTF-8) to be converted
10956     * @return The converted string (in markup). It should be freed.
10957     */
10958    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10959    /**
10960     * This sets the file (and implicitly loads it) for the text to display and
10961     * then edit. All changes are written back to the file after a short delay if
10962     * the entry object is set to autosave (which is the default).
10963     *
10964     * If the entry had any other file set previously, any changes made to it
10965     * will be saved if the autosave feature is enabled, otherwise, the file
10966     * will be silently discarded and any non-saved changes will be lost.
10967     *
10968     * @param obj The entry object
10969     * @param file The path to the file to load and save
10970     * @param format The file format
10971     */
10972    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
10973    /**
10974     * Gets the file being edited by the entry.
10975     *
10976     * This function can be used to retrieve any file set on the entry for
10977     * edition, along with the format used to load and save it.
10978     *
10979     * @param obj The entry object
10980     * @param file The path to the file to load and save
10981     * @param format The file format
10982     */
10983    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
10984    /**
10985     * This function writes any changes made to the file set with
10986     * elm_entry_file_set()
10987     *
10988     * @param obj The entry object
10989     */
10990    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
10991    /**
10992     * This sets the entry object to 'autosave' the loaded text file or not.
10993     *
10994     * @param obj The entry object
10995     * @param autosave Autosave the loaded file or not
10996     *
10997     * @see elm_entry_file_set()
10998     */
10999    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11000    /**
11001     * This gets the entry object's 'autosave' status.
11002     *
11003     * @param obj The entry object
11004     * @return Autosave the loaded file or not
11005     *
11006     * @see elm_entry_file_set()
11007     */
11008    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11009    /**
11010     * Control pasting of text and images for the widget.
11011     *
11012     * Normally the entry allows both text and images to be pasted.  By setting
11013     * textonly to be true, this prevents images from being pasted.
11014     *
11015     * Note this only changes the behaviour of text.
11016     *
11017     * @param obj The entry object
11018     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11019     * text+image+other.
11020     */
11021    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11022    /**
11023     * Getting elm_entry text paste/drop mode.
11024     *
11025     * In textonly mode, only text may be pasted or dropped into the widget.
11026     *
11027     * @param obj The entry object
11028     * @return If the widget only accepts text from pastes.
11029     */
11030    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11031    /**
11032     * Enable or disable scrolling in entry
11033     *
11034     * Normally the entry is not scrollable unless you enable it with this call.
11035     *
11036     * @param obj The entry object
11037     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11038     */
11039    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11040    /**
11041     * Get the scrollable state of the entry
11042     *
11043     * Normally the entry is not scrollable. This gets the scrollable state
11044     * of the entry. See elm_entry_scrollable_set() for more information.
11045     *
11046     * @param obj The entry object
11047     * @return The scrollable state
11048     */
11049    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11050    /**
11051     * This sets a widget to be displayed to the left of a scrolled entry.
11052     *
11053     * @param obj The scrolled entry object
11054     * @param icon The widget to display on the left side of the scrolled
11055     * entry.
11056     *
11057     * @note A previously set widget will be destroyed.
11058     * @note If the object being set does not have minimum size hints set,
11059     * it won't get properly displayed.
11060     *
11061     * @see elm_entry_end_set()
11062     */
11063    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11064    /**
11065     * Gets the leftmost widget of the scrolled entry. This object is
11066     * owned by the scrolled entry and should not be modified.
11067     *
11068     * @param obj The scrolled entry object
11069     * @return the left widget inside the scroller
11070     */
11071    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11072    /**
11073     * Unset the leftmost widget of the scrolled entry, unparenting and
11074     * returning it.
11075     *
11076     * @param obj The scrolled entry object
11077     * @return the previously set icon sub-object of this entry, on
11078     * success.
11079     *
11080     * @see elm_entry_icon_set()
11081     */
11082    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11083    /**
11084     * Sets the visibility of the left-side widget of the scrolled entry,
11085     * set by elm_entry_icon_set().
11086     *
11087     * @param obj The scrolled entry object
11088     * @param setting EINA_TRUE if the object should be displayed,
11089     * EINA_FALSE if not.
11090     */
11091    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11092    /**
11093     * This sets a widget to be displayed to the end of a scrolled entry.
11094     *
11095     * @param obj The scrolled entry object
11096     * @param end The widget to display on the right side of the scrolled
11097     * entry.
11098     *
11099     * @note A previously set widget will be destroyed.
11100     * @note If the object being set does not have minimum size hints set,
11101     * it won't get properly displayed.
11102     *
11103     * @see elm_entry_icon_set
11104     */
11105    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11106    /**
11107     * Gets the endmost widget of the scrolled entry. This object is owned
11108     * by the scrolled entry and should not be modified.
11109     *
11110     * @param obj The scrolled entry object
11111     * @return the right widget inside the scroller
11112     */
11113    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11114    /**
11115     * Unset the endmost widget of the scrolled entry, unparenting and
11116     * returning it.
11117     *
11118     * @param obj The scrolled entry object
11119     * @return the previously set icon sub-object of this entry, on
11120     * success.
11121     *
11122     * @see elm_entry_icon_set()
11123     */
11124    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11125    /**
11126     * Sets the visibility of the end widget of the scrolled entry, set by
11127     * elm_entry_end_set().
11128     *
11129     * @param obj The scrolled entry object
11130     * @param setting EINA_TRUE if the object should be displayed,
11131     * EINA_FALSE if not.
11132     */
11133    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11134    /**
11135     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11136     * them).
11137     *
11138     * Setting an entry to single-line mode with elm_entry_single_line_set()
11139     * will automatically disable the display of scrollbars when the entry
11140     * moves inside its scroller.
11141     *
11142     * @param obj The scrolled entry object
11143     * @param h The horizontal scrollbar policy to apply
11144     * @param v The vertical scrollbar policy to apply
11145     */
11146    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11147    /**
11148     * This enables/disables bouncing within the entry.
11149     *
11150     * This function sets whether the entry will bounce when scrolling reaches
11151     * the end of the contained entry.
11152     *
11153     * @param obj The scrolled entry object
11154     * @param h The horizontal bounce state
11155     * @param v The vertical bounce state
11156     */
11157    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11158    /**
11159     * Get the bounce mode
11160     *
11161     * @param obj The Entry object
11162     * @param h_bounce Allow bounce horizontally
11163     * @param v_bounce Allow bounce vertically
11164     */
11165    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11166
11167    /* pre-made filters for entries */
11168    /**
11169     * @typedef Elm_Entry_Filter_Limit_Size
11170     *
11171     * Data for the elm_entry_filter_limit_size() entry filter.
11172     */
11173    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11174    /**
11175     * @struct _Elm_Entry_Filter_Limit_Size
11176     *
11177     * Data for the elm_entry_filter_limit_size() entry filter.
11178     */
11179    struct _Elm_Entry_Filter_Limit_Size
11180      {
11181         int max_char_count; /**< The maximum number of characters allowed. */
11182         int max_byte_count; /**< The maximum number of bytes allowed*/
11183      };
11184    /**
11185     * Filter inserted text based on user defined character and byte limits
11186     *
11187     * Add this filter to an entry to limit the characters that it will accept
11188     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11189     * The funtion works on the UTF-8 representation of the string, converting
11190     * it from the set markup, thus not accounting for any format in it.
11191     *
11192     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11193     * it as data when setting the filter. In it, it's possible to set limits
11194     * by character count or bytes (any of them is disabled if 0), and both can
11195     * be set at the same time. In that case, it first checks for characters,
11196     * then bytes.
11197     *
11198     * The function will cut the inserted text in order to allow only the first
11199     * number of characters that are still allowed. The cut is made in
11200     * characters, even when limiting by bytes, in order to always contain
11201     * valid ones and avoid half unicode characters making it in.
11202     *
11203     * This filter, like any others, does not apply when setting the entry text
11204     * directly with elm_object_text_set() (or the deprecated
11205     * elm_entry_entry_set()).
11206     */
11207    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11208    /**
11209     * @typedef Elm_Entry_Filter_Accept_Set
11210     *
11211     * Data for the elm_entry_filter_accept_set() entry filter.
11212     */
11213    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11214    /**
11215     * @struct _Elm_Entry_Filter_Accept_Set
11216     *
11217     * Data for the elm_entry_filter_accept_set() entry filter.
11218     */
11219    struct _Elm_Entry_Filter_Accept_Set
11220      {
11221         const char *accepted; /**< Set of characters accepted in the entry. */
11222         const char *rejected; /**< Set of characters rejected from the entry. */
11223      };
11224    /**
11225     * Filter inserted text based on accepted or rejected sets of characters
11226     *
11227     * Add this filter to an entry to restrict the set of accepted characters
11228     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11229     * This structure contains both accepted and rejected sets, but they are
11230     * mutually exclusive.
11231     *
11232     * The @c accepted set takes preference, so if it is set, the filter will
11233     * only work based on the accepted characters, ignoring anything in the
11234     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11235     *
11236     * In both cases, the function filters by matching utf8 characters to the
11237     * raw markup text, so it can be used to remove formatting tags.
11238     *
11239     * This filter, like any others, does not apply when setting the entry text
11240     * directly with elm_object_text_set() (or the deprecated
11241     * elm_entry_entry_set()).
11242     */
11243    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11244    /**
11245     * @}
11246     */
11247
11248    /* composite widgets - these basically put together basic widgets above
11249     * in convenient packages that do more than basic stuff */
11250
11251    /* anchorview */
11252    /**
11253     * @defgroup Anchorview Anchorview
11254     *
11255     * @image html img/widget/anchorview/preview-00.png
11256     * @image latex img/widget/anchorview/preview-00.eps
11257     *
11258     * Anchorview is for displaying text that contains markup with anchors
11259     * like <c>\<a href=1234\>something\</\></c> in it.
11260     *
11261     * Besides being styled differently, the anchorview widget provides the
11262     * necessary functionality so that clicking on these anchors brings up a
11263     * popup with user defined content such as "call", "add to contacts" or
11264     * "open web page". This popup is provided using the @ref Hover widget.
11265     *
11266     * This widget is very similar to @ref Anchorblock, so refer to that
11267     * widget for an example. The only difference Anchorview has is that the
11268     * widget is already provided with scrolling functionality, so if the
11269     * text set to it is too large to fit in the given space, it will scroll,
11270     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11271     * text can be displayed.
11272     *
11273     * This widget emits the following signals:
11274     * @li "anchor,clicked": will be called when an anchor is clicked. The
11275     * @p event_info parameter on the callback will be a pointer of type
11276     * ::Elm_Entry_Anchorview_Info.
11277     *
11278     * See @ref Anchorblock for an example on how to use both of them.
11279     *
11280     * @see Anchorblock
11281     * @see Entry
11282     * @see Hover
11283     *
11284     * @{
11285     */
11286    /**
11287     * @typedef Elm_Entry_Anchorview_Info
11288     *
11289     * The info sent in the callback for "anchor,clicked" signals emitted by
11290     * the Anchorview widget.
11291     */
11292    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11293    /**
11294     * @struct _Elm_Entry_Anchorview_Info
11295     *
11296     * The info sent in the callback for "anchor,clicked" signals emitted by
11297     * the Anchorview widget.
11298     */
11299    struct _Elm_Entry_Anchorview_Info
11300      {
11301         const char     *name; /**< Name of the anchor, as indicated in its href
11302                                    attribute */
11303         int             button; /**< The mouse button used to click on it */
11304         Evas_Object    *hover; /**< The hover object to use for the popup */
11305         struct {
11306              Evas_Coord    x, y, w, h;
11307         } anchor, /**< Geometry selection of text used as anchor */
11308           hover_parent; /**< Geometry of the object used as parent by the
11309                              hover */
11310         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11311                                              for content on the left side of
11312                                              the hover. Before calling the
11313                                              callback, the widget will make the
11314                                              necessary calculations to check
11315                                              which sides are fit to be set with
11316                                              content, based on the position the
11317                                              hover is activated and its distance
11318                                              to the edges of its parent object
11319                                              */
11320         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11321                                               the right side of the hover.
11322                                               See @ref hover_left */
11323         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11324                                             of the hover. See @ref hover_left */
11325         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11326                                                below the hover. See @ref
11327                                                hover_left */
11328      };
11329    /**
11330     * Add a new Anchorview object
11331     *
11332     * @param parent The parent object
11333     * @return The new object or NULL if it cannot be created
11334     */
11335    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11336    /**
11337     * Set the text to show in the anchorview
11338     *
11339     * Sets the text of the anchorview to @p text. This text can include markup
11340     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11341     * text that will be specially styled and react to click events, ended with
11342     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11343     * "anchor,clicked" signal that you can attach a callback to with
11344     * evas_object_smart_callback_add(). The name of the anchor given in the
11345     * event info struct will be the one set in the href attribute, in this
11346     * case, anchorname.
11347     *
11348     * Other markup can be used to style the text in different ways, but it's
11349     * up to the style defined in the theme which tags do what.
11350     * @deprecated use elm_object_text_set() instead.
11351     */
11352    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11353    /**
11354     * Get the markup text set for the anchorview
11355     *
11356     * Retrieves the text set on the anchorview, with markup tags included.
11357     *
11358     * @param obj The anchorview object
11359     * @return The markup text set or @c NULL if nothing was set or an error
11360     * occurred
11361     * @deprecated use elm_object_text_set() instead.
11362     */
11363    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11364    /**
11365     * Set the parent of the hover popup
11366     *
11367     * Sets the parent object to use by the hover created by the anchorview
11368     * when an anchor is clicked. See @ref Hover for more details on this.
11369     * If no parent is set, the same anchorview object will be used.
11370     *
11371     * @param obj The anchorview object
11372     * @param parent The object to use as parent for the hover
11373     */
11374    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11375    /**
11376     * Get the parent of the hover popup
11377     *
11378     * Get the object used as parent for the hover created by the anchorview
11379     * widget. See @ref Hover for more details on this.
11380     *
11381     * @param obj The anchorview object
11382     * @return The object used as parent for the hover, NULL if none is set.
11383     */
11384    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11385    /**
11386     * Set the style that the hover should use
11387     *
11388     * When creating the popup hover, anchorview will request that it's
11389     * themed according to @p style.
11390     *
11391     * @param obj The anchorview object
11392     * @param style The style to use for the underlying hover
11393     *
11394     * @see elm_object_style_set()
11395     */
11396    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11397    /**
11398     * Get the style that the hover should use
11399     *
11400     * Get the style the hover created by anchorview will use.
11401     *
11402     * @param obj The anchorview object
11403     * @return The style to use by the hover. NULL means the default is used.
11404     *
11405     * @see elm_object_style_set()
11406     */
11407    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11408    /**
11409     * Ends the hover popup in the anchorview
11410     *
11411     * When an anchor is clicked, the anchorview widget will create a hover
11412     * object to use as a popup with user provided content. This function
11413     * terminates this popup, returning the anchorview to its normal state.
11414     *
11415     * @param obj The anchorview object
11416     */
11417    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11418    /**
11419     * Set bouncing behaviour when the scrolled content reaches an edge
11420     *
11421     * Tell the internal scroller object whether it should bounce or not
11422     * when it reaches the respective edges for each axis.
11423     *
11424     * @param obj The anchorview object
11425     * @param h_bounce Whether to bounce or not in the horizontal axis
11426     * @param v_bounce Whether to bounce or not in the vertical axis
11427     *
11428     * @see elm_scroller_bounce_set()
11429     */
11430    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11431    /**
11432     * Get the set bouncing behaviour of the internal scroller
11433     *
11434     * Get whether the internal scroller should bounce when the edge of each
11435     * axis is reached scrolling.
11436     *
11437     * @param obj The anchorview object
11438     * @param h_bounce Pointer where to store the bounce state of the horizontal
11439     *                 axis
11440     * @param v_bounce Pointer where to store the bounce state of the vertical
11441     *                 axis
11442     *
11443     * @see elm_scroller_bounce_get()
11444     */
11445    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11446    /**
11447     * Appends a custom item provider to the given anchorview
11448     *
11449     * Appends the given function to the list of items providers. This list is
11450     * called, one function at a time, with the given @p data pointer, the
11451     * anchorview object and, in the @p item parameter, the item name as
11452     * referenced in its href string. Following functions in the list will be
11453     * called in order until one of them returns something different to NULL,
11454     * which should be an Evas_Object which will be used in place of the item
11455     * element.
11456     *
11457     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11458     * href=item/name\>\</item\>
11459     *
11460     * @param obj The anchorview object
11461     * @param func The function to add to the list of providers
11462     * @param data User data that will be passed to the callback function
11463     *
11464     * @see elm_entry_item_provider_append()
11465     */
11466    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);
11467    /**
11468     * Prepend a custom item provider to the given anchorview
11469     *
11470     * Like elm_anchorview_item_provider_append(), but it adds the function
11471     * @p func to the beginning of the list, instead of the end.
11472     *
11473     * @param obj The anchorview object
11474     * @param func The function to add to the list of providers
11475     * @param data User data that will be passed to the callback function
11476     */
11477    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);
11478    /**
11479     * Remove a custom item provider from the list of the given anchorview
11480     *
11481     * Removes the function and data pairing that matches @p func and @p data.
11482     * That is, unless the same function and same user data are given, the
11483     * function will not be removed from the list. This allows us to add the
11484     * same callback several times, with different @p data pointers and be
11485     * able to remove them later without conflicts.
11486     *
11487     * @param obj The anchorview object
11488     * @param func The function to remove from the list
11489     * @param data The data matching the function to remove from the list
11490     */
11491    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);
11492    /**
11493     * @}
11494     */
11495
11496    /* anchorblock */
11497    /**
11498     * @defgroup Anchorblock Anchorblock
11499     *
11500     * @image html img/widget/anchorblock/preview-00.png
11501     * @image latex img/widget/anchorblock/preview-00.eps
11502     *
11503     * Anchorblock is for displaying text that contains markup with anchors
11504     * like <c>\<a href=1234\>something\</\></c> in it.
11505     *
11506     * Besides being styled differently, the anchorblock widget provides the
11507     * necessary functionality so that clicking on these anchors brings up a
11508     * popup with user defined content such as "call", "add to contacts" or
11509     * "open web page". This popup is provided using the @ref Hover widget.
11510     *
11511     * This widget emits the following signals:
11512     * @li "anchor,clicked": will be called when an anchor is clicked. The
11513     * @p event_info parameter on the callback will be a pointer of type
11514     * ::Elm_Entry_Anchorblock_Info.
11515     *
11516     * @see Anchorview
11517     * @see Entry
11518     * @see Hover
11519     *
11520     * Since examples are usually better than plain words, we might as well
11521     * try @ref tutorial_anchorblock_example "one".
11522     */
11523    /**
11524     * @addtogroup Anchorblock
11525     * @{
11526     */
11527    /**
11528     * @typedef Elm_Entry_Anchorblock_Info
11529     *
11530     * The info sent in the callback for "anchor,clicked" signals emitted by
11531     * the Anchorblock widget.
11532     */
11533    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11534    /**
11535     * @struct _Elm_Entry_Anchorblock_Info
11536     *
11537     * The info sent in the callback for "anchor,clicked" signals emitted by
11538     * the Anchorblock widget.
11539     */
11540    struct _Elm_Entry_Anchorblock_Info
11541      {
11542         const char     *name; /**< Name of the anchor, as indicated in its href
11543                                    attribute */
11544         int             button; /**< The mouse button used to click on it */
11545         Evas_Object    *hover; /**< The hover object to use for the popup */
11546         struct {
11547              Evas_Coord    x, y, w, h;
11548         } anchor, /**< Geometry selection of text used as anchor */
11549           hover_parent; /**< Geometry of the object used as parent by the
11550                              hover */
11551         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11552                                              for content on the left side of
11553                                              the hover. Before calling the
11554                                              callback, the widget will make the
11555                                              necessary calculations to check
11556                                              which sides are fit to be set with
11557                                              content, based on the position the
11558                                              hover is activated and its distance
11559                                              to the edges of its parent object
11560                                              */
11561         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11562                                               the right side of the hover.
11563                                               See @ref hover_left */
11564         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11565                                             of the hover. See @ref hover_left */
11566         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11567                                                below the hover. See @ref
11568                                                hover_left */
11569      };
11570    /**
11571     * Add a new Anchorblock object
11572     *
11573     * @param parent The parent object
11574     * @return The new object or NULL if it cannot be created
11575     */
11576    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11577    /**
11578     * Set the text to show in the anchorblock
11579     *
11580     * Sets the text of the anchorblock to @p text. This text can include markup
11581     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11582     * of text that will be specially styled and react to click events, ended
11583     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11584     * "anchor,clicked" signal that you can attach a callback to with
11585     * evas_object_smart_callback_add(). The name of the anchor given in the
11586     * event info struct will be the one set in the href attribute, in this
11587     * case, anchorname.
11588     *
11589     * Other markup can be used to style the text in different ways, but it's
11590     * up to the style defined in the theme which tags do what.
11591     * @deprecated use elm_object_text_set() instead.
11592     */
11593    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11594    /**
11595     * Get the markup text set for the anchorblock
11596     *
11597     * Retrieves the text set on the anchorblock, with markup tags included.
11598     *
11599     * @param obj The anchorblock object
11600     * @return The markup text set or @c NULL if nothing was set or an error
11601     * occurred
11602     * @deprecated use elm_object_text_set() instead.
11603     */
11604    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11605    /**
11606     * Set the parent of the hover popup
11607     *
11608     * Sets the parent object to use by the hover created by the anchorblock
11609     * when an anchor is clicked. See @ref Hover for more details on this.
11610     *
11611     * @param obj The anchorblock object
11612     * @param parent The object to use as parent for the hover
11613     */
11614    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11615    /**
11616     * Get the parent of the hover popup
11617     *
11618     * Get the object used as parent for the hover created by the anchorblock
11619     * widget. See @ref Hover for more details on this.
11620     * If no parent is set, the same anchorblock object will be used.
11621     *
11622     * @param obj The anchorblock object
11623     * @return The object used as parent for the hover, NULL if none is set.
11624     */
11625    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11626    /**
11627     * Set the style that the hover should use
11628     *
11629     * When creating the popup hover, anchorblock will request that it's
11630     * themed according to @p style.
11631     *
11632     * @param obj The anchorblock object
11633     * @param style The style to use for the underlying hover
11634     *
11635     * @see elm_object_style_set()
11636     */
11637    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11638    /**
11639     * Get the style that the hover should use
11640     *
11641     * Get the style the hover created by anchorblock will use.
11642     *
11643     * @param obj The anchorblock object
11644     * @return The style to use by the hover. NULL means the default is used.
11645     *
11646     * @see elm_object_style_set()
11647     */
11648    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11649    /**
11650     * Ends the hover popup in the anchorblock
11651     *
11652     * When an anchor is clicked, the anchorblock widget will create a hover
11653     * object to use as a popup with user provided content. This function
11654     * terminates this popup, returning the anchorblock to its normal state.
11655     *
11656     * @param obj The anchorblock object
11657     */
11658    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11659    /**
11660     * Appends a custom item provider to the given anchorblock
11661     *
11662     * Appends the given function to the list of items providers. This list is
11663     * called, one function at a time, with the given @p data pointer, the
11664     * anchorblock object and, in the @p item parameter, the item name as
11665     * referenced in its href string. Following functions in the list will be
11666     * called in order until one of them returns something different to NULL,
11667     * which should be an Evas_Object which will be used in place of the item
11668     * element.
11669     *
11670     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11671     * href=item/name\>\</item\>
11672     *
11673     * @param obj The anchorblock object
11674     * @param func The function to add to the list of providers
11675     * @param data User data that will be passed to the callback function
11676     *
11677     * @see elm_entry_item_provider_append()
11678     */
11679    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);
11680    /**
11681     * Prepend a custom item provider to the given anchorblock
11682     *
11683     * Like elm_anchorblock_item_provider_append(), but it adds the function
11684     * @p func to the beginning of the list, instead of the end.
11685     *
11686     * @param obj The anchorblock object
11687     * @param func The function to add to the list of providers
11688     * @param data User data that will be passed to the callback function
11689     */
11690    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);
11691    /**
11692     * Remove a custom item provider from the list of the given anchorblock
11693     *
11694     * Removes the function and data pairing that matches @p func and @p data.
11695     * That is, unless the same function and same user data are given, the
11696     * function will not be removed from the list. This allows us to add the
11697     * same callback several times, with different @p data pointers and be
11698     * able to remove them later without conflicts.
11699     *
11700     * @param obj The anchorblock object
11701     * @param func The function to remove from the list
11702     * @param data The data matching the function to remove from the list
11703     */
11704    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);
11705    /**
11706     * @}
11707     */
11708
11709    /**
11710     * @defgroup Bubble Bubble
11711     *
11712     * @image html img/widget/bubble/preview-00.png
11713     * @image latex img/widget/bubble/preview-00.eps
11714     * @image html img/widget/bubble/preview-01.png
11715     * @image latex img/widget/bubble/preview-01.eps
11716     * @image html img/widget/bubble/preview-02.png
11717     * @image latex img/widget/bubble/preview-02.eps
11718     *
11719     * @brief The Bubble is a widget to show text similarly to how speech is
11720     * represented in comics.
11721     *
11722     * The bubble widget contains 5 important visual elements:
11723     * @li The frame is a rectangle with rounded rectangles and an "arrow".
11724     * @li The @p icon is an image to which the frame's arrow points to.
11725     * @li The @p label is a text which appears to the right of the icon if the
11726     * corner is "top_left" or "bottom_left" and is right aligned to the frame
11727     * otherwise.
11728     * @li The @p info is a text which appears to the right of the label. Info's
11729     * font is of a ligther color than label.
11730     * @li The @p content is an evas object that is shown inside the frame.
11731     *
11732     * The position of the arrow, icon, label and info depends on which corner is
11733     * selected. The four available corners are:
11734     * @li "top_left" - Default
11735     * @li "top_right"
11736     * @li "bottom_left"
11737     * @li "bottom_right"
11738     *
11739     * Signals that you can add callbacks for are:
11740     * @li "clicked" - This is called when a user has clicked the bubble.
11741     *
11742     * For an example of using a buble see @ref bubble_01_example_page "this".
11743     *
11744     * @{
11745     */
11746    /**
11747     * Add a new bubble to the parent
11748     *
11749     * @param parent The parent object
11750     * @return The new object or NULL if it cannot be created
11751     *
11752     * This function adds a text bubble to the given parent evas object.
11753     */
11754    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11755    /**
11756     * Set the label of the bubble
11757     *
11758     * @param obj The bubble object
11759     * @param label The string to set in the label
11760     *
11761     * This function sets the title of the bubble. Where this appears depends on
11762     * the selected corner.
11763     * @deprecated use elm_object_text_set() instead.
11764     */
11765    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11766    /**
11767     * Get the label of the bubble
11768     *
11769     * @param obj The bubble object
11770     * @return The string of set in the label
11771     *
11772     * This function gets the title of the bubble.
11773     * @deprecated use elm_object_text_get() instead.
11774     */
11775    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11776    /**
11777     * Set the info of the bubble
11778     *
11779     * @param obj The bubble object
11780     * @param info The given info about the bubble
11781     *
11782     * This function sets the info of the bubble. Where this appears depends on
11783     * the selected corner.
11784     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11785     */
11786    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11787    /**
11788     * Get the info of the bubble
11789     *
11790     * @param obj The bubble object
11791     *
11792     * @return The "info" string of the bubble
11793     *
11794     * This function gets the info text.
11795     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11796     */
11797    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11798    /**
11799     * Set the content to be shown in the bubble
11800     *
11801     * Once the content object is set, a previously set one will be deleted.
11802     * If you want to keep the old content object, use the
11803     * elm_bubble_content_unset() function.
11804     *
11805     * @param obj The bubble object
11806     * @param content The given content of the bubble
11807     *
11808     * This function sets the content shown on the middle of the bubble.
11809     */
11810    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11811    /**
11812     * Get the content shown in the bubble
11813     *
11814     * Return the content object which is set for this widget.
11815     *
11816     * @param obj The bubble object
11817     * @return The content that is being used
11818     */
11819    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11820    /**
11821     * Unset the content shown in the bubble
11822     *
11823     * Unparent and return the content object which was set for this widget.
11824     *
11825     * @param obj The bubble object
11826     * @return The content that was being used
11827     */
11828    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11829    /**
11830     * Set the icon of the bubble
11831     *
11832     * Once the icon object is set, a previously set one will be deleted.
11833     * If you want to keep the old content object, use the
11834     * elm_icon_content_unset() function.
11835     *
11836     * @param obj The bubble object
11837     * @param icon The given icon for the bubble
11838     */
11839    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11840    /**
11841     * Get the icon of the bubble
11842     *
11843     * @param obj The bubble object
11844     * @return The icon for the bubble
11845     *
11846     * This function gets the icon shown on the top left of bubble.
11847     */
11848    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11849    /**
11850     * Unset the icon of the bubble
11851     *
11852     * Unparent and return the icon object which was set for this widget.
11853     *
11854     * @param obj The bubble object
11855     * @return The icon that was being used
11856     */
11857    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11858    /**
11859     * Set the corner of the bubble
11860     *
11861     * @param obj The bubble object.
11862     * @param corner The given corner for the bubble.
11863     *
11864     * This function sets the corner of the bubble. The corner will be used to
11865     * determine where the arrow in the frame points to and where label, icon and
11866     * info arre shown.
11867     *
11868     * Possible values for corner are:
11869     * @li "top_left" - Default
11870     * @li "top_right"
11871     * @li "bottom_left"
11872     * @li "bottom_right"
11873     */
11874    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11875    /**
11876     * Get the corner of the bubble
11877     *
11878     * @param obj The bubble object.
11879     * @return The given corner for the bubble.
11880     *
11881     * This function gets the selected corner of the bubble.
11882     */
11883    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11884    /**
11885     * @}
11886     */
11887
11888    /**
11889     * @defgroup Photo Photo
11890     *
11891     * For displaying the photo of a person (contact). Simple yet
11892     * with a very specific purpose.
11893     *
11894     * Signals that you can add callbacks for are:
11895     *
11896     * "clicked" - This is called when a user has clicked the photo
11897     * "drag,start" - Someone started dragging the image out of the object
11898     * "drag,end" - Dragged item was dropped (somewhere)
11899     *
11900     * @{
11901     */
11902
11903    /**
11904     * Add a new photo to the parent
11905     *
11906     * @param parent The parent object
11907     * @return The new object or NULL if it cannot be created
11908     *
11909     * @ingroup Photo
11910     */
11911    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11912
11913    /**
11914     * Set the file that will be used as photo
11915     *
11916     * @param obj The photo object
11917     * @param file The path to file that will be used as photo
11918     *
11919     * @return (1 = success, 0 = error)
11920     *
11921     * @ingroup Photo
11922     */
11923    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
11924
11925    /**
11926     * Set the size that will be used on the photo
11927     *
11928     * @param obj The photo object
11929     * @param size The size that the photo will be
11930     *
11931     * @ingroup Photo
11932     */
11933    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
11934
11935    /**
11936     * Set if the photo should be completely visible or not.
11937     *
11938     * @param obj The photo object
11939     * @param fill if true the photo will be completely visible
11940     *
11941     * @ingroup Photo
11942     */
11943    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
11944
11945    /**
11946     * Set editability of the photo.
11947     *
11948     * An editable photo can be dragged to or from, and can be cut or
11949     * pasted too.  Note that pasting an image or dropping an item on
11950     * the image will delete the existing content.
11951     *
11952     * @param obj The photo object.
11953     * @param set To set of clear editablity.
11954     */
11955    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
11956
11957    /**
11958     * @}
11959     */
11960
11961    /* gesture layer */
11962    /**
11963     * @defgroup Elm_Gesture_Layer Gesture Layer
11964     * Gesture Layer Usage:
11965     *
11966     * Use Gesture Layer to detect gestures.
11967     * The advantage is that you don't have to implement
11968     * gesture detection, just set callbacks of gesture state.
11969     * By using gesture layer we make standard interface.
11970     *
11971     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
11972     * with a parent object parameter.
11973     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
11974     * call. Usually with same object as target (2nd parameter).
11975     *
11976     * Now you need to tell gesture layer what gestures you follow.
11977     * This is done with @ref elm_gesture_layer_cb_set call.
11978     * By setting the callback you actually saying to gesture layer:
11979     * I would like to know when the gesture @ref Elm_Gesture_Types
11980     * switches to state @ref Elm_Gesture_State.
11981     *
11982     * Next, you need to implement the actual action that follows the input
11983     * in your callback.
11984     *
11985     * Note that if you like to stop being reported about a gesture, just set
11986     * all callbacks referring this gesture to NULL.
11987     * (again with @ref elm_gesture_layer_cb_set)
11988     *
11989     * The information reported by gesture layer to your callback is depending
11990     * on @ref Elm_Gesture_Types:
11991     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
11992     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
11993     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
11994     *
11995     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
11996     * @ref ELM_GESTURE_MOMENTUM.
11997     *
11998     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
11999     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12000     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12001     * Note that we consider a flick as a line-gesture that should be completed
12002     * in flick-time-limit as defined in @ref Config.
12003     *
12004     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12005     *
12006     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12007     * */
12008
12009    /**
12010     * @enum _Elm_Gesture_Types
12011     * Enum of supported gesture types.
12012     * @ingroup Elm_Gesture_Layer
12013     */
12014    enum _Elm_Gesture_Types
12015      {
12016         ELM_GESTURE_FIRST = 0,
12017
12018         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12019         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12020         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12021         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12022
12023         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12024
12025         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12026         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12027
12028         ELM_GESTURE_ZOOM, /**< Zoom */
12029         ELM_GESTURE_ROTATE, /**< Rotate */
12030
12031         ELM_GESTURE_LAST
12032      };
12033
12034    /**
12035     * @typedef Elm_Gesture_Types
12036     * gesture types enum
12037     * @ingroup Elm_Gesture_Layer
12038     */
12039    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12040
12041    /**
12042     * @enum _Elm_Gesture_State
12043     * Enum of gesture states.
12044     * @ingroup Elm_Gesture_Layer
12045     */
12046    enum _Elm_Gesture_State
12047      {
12048         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12049         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12050         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12051         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12052         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12053      };
12054
12055    /**
12056     * @typedef Elm_Gesture_State
12057     * gesture states enum
12058     * @ingroup Elm_Gesture_Layer
12059     */
12060    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12061
12062    /**
12063     * @struct _Elm_Gesture_Taps_Info
12064     * Struct holds taps info for user
12065     * @ingroup Elm_Gesture_Layer
12066     */
12067    struct _Elm_Gesture_Taps_Info
12068      {
12069         Evas_Coord x, y;         /**< Holds center point between fingers */
12070         unsigned int n;          /**< Number of fingers tapped           */
12071         unsigned int timestamp;  /**< event timestamp       */
12072      };
12073
12074    /**
12075     * @typedef Elm_Gesture_Taps_Info
12076     * holds taps info for user
12077     * @ingroup Elm_Gesture_Layer
12078     */
12079    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12080
12081    /**
12082     * @struct _Elm_Gesture_Momentum_Info
12083     * Struct holds momentum info for user
12084     * x1 and y1 are not necessarily in sync
12085     * x1 holds x value of x direction starting point
12086     * and same holds for y1.
12087     * This is noticeable when doing V-shape movement
12088     * @ingroup Elm_Gesture_Layer
12089     */
12090    struct _Elm_Gesture_Momentum_Info
12091      {  /* Report line ends, timestamps, and momentum computed        */
12092         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12093         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12094         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12095         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12096
12097         unsigned int tx; /**< Timestamp of start of final x-swipe */
12098         unsigned int ty; /**< Timestamp of start of final y-swipe */
12099
12100         Evas_Coord mx; /**< Momentum on X */
12101         Evas_Coord my; /**< Momentum on Y */
12102      };
12103
12104    /**
12105     * @typedef Elm_Gesture_Momentum_Info
12106     * holds momentum info for user
12107     * @ingroup Elm_Gesture_Layer
12108     */
12109     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12110
12111    /**
12112     * @struct _Elm_Gesture_Line_Info
12113     * Struct holds line info for user
12114     * @ingroup Elm_Gesture_Layer
12115     */
12116    struct _Elm_Gesture_Line_Info
12117      {  /* Report line ends, timestamps, and momentum computed      */
12118         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12119         unsigned int n;            /**< Number of fingers (lines)   */
12120         /* FIXME should be radians, bot degrees */
12121         double angle;              /**< Angle (direction) of lines  */
12122      };
12123
12124    /**
12125     * @typedef Elm_Gesture_Line_Info
12126     * Holds line info for user
12127     * @ingroup Elm_Gesture_Layer
12128     */
12129     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12130
12131    /**
12132     * @struct _Elm_Gesture_Zoom_Info
12133     * Struct holds zoom info for user
12134     * @ingroup Elm_Gesture_Layer
12135     */
12136    struct _Elm_Gesture_Zoom_Info
12137      {
12138         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12139         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12140         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12141         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12142      };
12143
12144    /**
12145     * @typedef Elm_Gesture_Zoom_Info
12146     * Holds zoom info for user
12147     * @ingroup Elm_Gesture_Layer
12148     */
12149    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12150
12151    /**
12152     * @struct _Elm_Gesture_Rotate_Info
12153     * Struct holds rotation info for user
12154     * @ingroup Elm_Gesture_Layer
12155     */
12156    struct _Elm_Gesture_Rotate_Info
12157      {
12158         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12159         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12160         double base_angle; /**< Holds start-angle */
12161         double angle;      /**< Rotation value: 0.0 means no rotation         */
12162         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12163      };
12164
12165    /**
12166     * @typedef Elm_Gesture_Rotate_Info
12167     * Holds rotation info for user
12168     * @ingroup Elm_Gesture_Layer
12169     */
12170    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12171
12172    /**
12173     * @typedef Elm_Gesture_Event_Cb
12174     * User callback used to stream gesture info from gesture layer
12175     * @param data user data
12176     * @param event_info gesture report info
12177     * Returns a flag field to be applied on the causing event.
12178     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12179     * upon the event, in an irreversible way.
12180     *
12181     * @ingroup Elm_Gesture_Layer
12182     */
12183    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12184
12185    /**
12186     * Use function to set callbacks to be notified about
12187     * change of state of gesture.
12188     * When a user registers a callback with this function
12189     * this means this gesture has to be tested.
12190     *
12191     * When ALL callbacks for a gesture are set to NULL
12192     * it means user isn't interested in gesture-state
12193     * and it will not be tested.
12194     *
12195     * @param obj Pointer to gesture-layer.
12196     * @param idx The gesture you would like to track its state.
12197     * @param cb callback function pointer.
12198     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12199     * @param data user info to be sent to callback (usually, Smart Data)
12200     *
12201     * @ingroup Elm_Gesture_Layer
12202     */
12203    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);
12204
12205    /**
12206     * Call this function to get repeat-events settings.
12207     *
12208     * @param obj Pointer to gesture-layer.
12209     *
12210     * @return repeat events settings.
12211     * @see elm_gesture_layer_hold_events_set()
12212     * @ingroup Elm_Gesture_Layer
12213     */
12214    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12215
12216    /**
12217     * This function called in order to make gesture-layer repeat events.
12218     * Set this of you like to get the raw events only if gestures were not detected.
12219     * Clear this if you like gesture layer to fwd events as testing gestures.
12220     *
12221     * @param obj Pointer to gesture-layer.
12222     * @param r Repeat: TRUE/FALSE
12223     *
12224     * @ingroup Elm_Gesture_Layer
12225     */
12226    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12227
12228    /**
12229     * This function sets step-value for zoom action.
12230     * Set step to any positive value.
12231     * Cancel step setting by setting to 0.0
12232     *
12233     * @param obj Pointer to gesture-layer.
12234     * @param s new zoom step value.
12235     *
12236     * @ingroup Elm_Gesture_Layer
12237     */
12238    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12239
12240    /**
12241     * This function sets step-value for rotate action.
12242     * Set step to any positive value.
12243     * Cancel step setting by setting to 0.0
12244     *
12245     * @param obj Pointer to gesture-layer.
12246     * @param s new roatate step value.
12247     *
12248     * @ingroup Elm_Gesture_Layer
12249     */
12250    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12251
12252    /**
12253     * This function called to attach gesture-layer to an Evas_Object.
12254     * @param obj Pointer to gesture-layer.
12255     * @param t Pointer to underlying object (AKA Target)
12256     *
12257     * @return TRUE, FALSE on success, failure.
12258     *
12259     * @ingroup Elm_Gesture_Layer
12260     */
12261    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12262
12263    /**
12264     * Call this function to construct a new gesture-layer object.
12265     * This does not activate the gesture layer. You have to
12266     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12267     *
12268     * @param parent the parent object.
12269     *
12270     * @return Pointer to new gesture-layer object.
12271     *
12272     * @ingroup Elm_Gesture_Layer
12273     */
12274    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12275
12276    /**
12277     * @defgroup Thumb Thumb
12278     *
12279     * @image html img/widget/thumb/preview-00.png
12280     * @image latex img/widget/thumb/preview-00.eps
12281     *
12282     * A thumb object is used for displaying the thumbnail of an image or video.
12283     * You must have compiled Elementary with Ethumb_Client support and the DBus
12284     * service must be present and auto-activated in order to have thumbnails to
12285     * be generated.
12286     *
12287     * Once the thumbnail object becomes visible, it will check if there is a
12288     * previously generated thumbnail image for the file set on it. If not, it
12289     * will start generating this thumbnail.
12290     *
12291     * Different config settings will cause different thumbnails to be generated
12292     * even on the same file.
12293     *
12294     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12295     * Ethumb documentation to change this path, and to see other configuration
12296     * options.
12297     *
12298     * Signals that you can add callbacks for are:
12299     *
12300     * - "clicked" - This is called when a user has clicked the thumb without dragging
12301     *             around.
12302     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12303     * - "press" - This is called when a user has pressed down the thumb.
12304     * - "generate,start" - The thumbnail generation started.
12305     * - "generate,stop" - The generation process stopped.
12306     * - "generate,error" - The generation failed.
12307     * - "load,error" - The thumbnail image loading failed.
12308     *
12309     * available styles:
12310     * - default
12311     * - noframe
12312     *
12313     * An example of use of thumbnail:
12314     *
12315     * - @ref thumb_example_01
12316     */
12317
12318    /**
12319     * @addtogroup Thumb
12320     * @{
12321     */
12322
12323    /**
12324     * @enum _Elm_Thumb_Animation_Setting
12325     * @typedef Elm_Thumb_Animation_Setting
12326     *
12327     * Used to set if a video thumbnail is animating or not.
12328     *
12329     * @ingroup Thumb
12330     */
12331    typedef enum _Elm_Thumb_Animation_Setting
12332      {
12333         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12334         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12335         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12336         ELM_THUMB_ANIMATION_LAST
12337      } Elm_Thumb_Animation_Setting;
12338
12339    /**
12340     * Add a new thumb object to the parent.
12341     *
12342     * @param parent The parent object.
12343     * @return The new object or NULL if it cannot be created.
12344     *
12345     * @see elm_thumb_file_set()
12346     * @see elm_thumb_ethumb_client_get()
12347     *
12348     * @ingroup Thumb
12349     */
12350    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12351    /**
12352     * Reload thumbnail if it was generated before.
12353     *
12354     * @param obj The thumb object to reload
12355     *
12356     * This is useful if the ethumb client configuration changed, like its
12357     * size, aspect or any other property one set in the handle returned
12358     * by elm_thumb_ethumb_client_get().
12359     *
12360     * If the options didn't change, the thumbnail won't be generated again, but
12361     * the old one will still be used.
12362     *
12363     * @see elm_thumb_file_set()
12364     *
12365     * @ingroup Thumb
12366     */
12367    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12368    /**
12369     * Set the file that will be used as thumbnail.
12370     *
12371     * @param obj The thumb object.
12372     * @param file The path to file that will be used as thumb.
12373     * @param key The key used in case of an EET file.
12374     *
12375     * The file can be an image or a video (in that case, acceptable extensions are:
12376     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12377     * function elm_thumb_animate().
12378     *
12379     * @see elm_thumb_file_get()
12380     * @see elm_thumb_reload()
12381     * @see elm_thumb_animate()
12382     *
12383     * @ingroup Thumb
12384     */
12385    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12386    /**
12387     * Get the image or video path and key used to generate the thumbnail.
12388     *
12389     * @param obj The thumb object.
12390     * @param file Pointer to filename.
12391     * @param key Pointer to key.
12392     *
12393     * @see elm_thumb_file_set()
12394     * @see elm_thumb_path_get()
12395     *
12396     * @ingroup Thumb
12397     */
12398    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12399    /**
12400     * Get the path and key to the image or video generated by ethumb.
12401     *
12402     * One just need to make sure that the thumbnail was generated before getting
12403     * its path; otherwise, the path will be NULL. One way to do that is by asking
12404     * for the path when/after the "generate,stop" smart callback is called.
12405     *
12406     * @param obj The thumb object.
12407     * @param file Pointer to thumb path.
12408     * @param key Pointer to thumb key.
12409     *
12410     * @see elm_thumb_file_get()
12411     *
12412     * @ingroup Thumb
12413     */
12414    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12415    /**
12416     * Set the animation state for the thumb object. If its content is an animated
12417     * video, you may start/stop the animation or tell it to play continuously and
12418     * looping.
12419     *
12420     * @param obj The thumb object.
12421     * @param setting The animation setting.
12422     *
12423     * @see elm_thumb_file_set()
12424     *
12425     * @ingroup Thumb
12426     */
12427    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12428    /**
12429     * Get the animation state for the thumb object.
12430     *
12431     * @param obj The thumb object.
12432     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12433     * on errors.
12434     *
12435     * @see elm_thumb_animate_set()
12436     *
12437     * @ingroup Thumb
12438     */
12439    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12440    /**
12441     * Get the ethumb_client handle so custom configuration can be made.
12442     *
12443     * @return Ethumb_Client instance or NULL.
12444     *
12445     * This must be called before the objects are created to be sure no object is
12446     * visible and no generation started.
12447     *
12448     * Example of usage:
12449     *
12450     * @code
12451     * #include <Elementary.h>
12452     * #ifndef ELM_LIB_QUICKLAUNCH
12453     * EAPI int
12454     * elm_main(int argc, char **argv)
12455     * {
12456     *    Ethumb_Client *client;
12457     *
12458     *    elm_need_ethumb();
12459     *
12460     *    // ... your code
12461     *
12462     *    client = elm_thumb_ethumb_client_get();
12463     *    if (!client)
12464     *      {
12465     *         ERR("could not get ethumb_client");
12466     *         return 1;
12467     *      }
12468     *    ethumb_client_size_set(client, 100, 100);
12469     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12470     *    // ... your code
12471     *
12472     *    // Create elm_thumb objects here
12473     *
12474     *    elm_run();
12475     *    elm_shutdown();
12476     *    return 0;
12477     * }
12478     * #endif
12479     * ELM_MAIN()
12480     * @endcode
12481     *
12482     * @note There's only one client handle for Ethumb, so once a configuration
12483     * change is done to it, any other request for thumbnails (for any thumbnail
12484     * object) will use that configuration. Thus, this configuration is global.
12485     *
12486     * @ingroup Thumb
12487     */
12488    EAPI void                        *elm_thumb_ethumb_client_get(void);
12489    /**
12490     * Get the ethumb_client connection state.
12491     *
12492     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12493     * otherwise.
12494     */
12495    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12496    /**
12497     * Make the thumbnail 'editable'.
12498     *
12499     * @param obj Thumb object.
12500     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12501     *
12502     * This means the thumbnail is a valid drag target for drag and drop, and can be
12503     * cut or pasted too.
12504     *
12505     * @see elm_thumb_editable_get()
12506     *
12507     * @ingroup Thumb
12508     */
12509    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12510    /**
12511     * Make the thumbnail 'editable'.
12512     *
12513     * @param obj Thumb object.
12514     * @return Editability.
12515     *
12516     * This means the thumbnail is a valid drag target for drag and drop, and can be
12517     * cut or pasted too.
12518     *
12519     * @see elm_thumb_editable_set()
12520     *
12521     * @ingroup Thumb
12522     */
12523    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12524
12525    /**
12526     * @}
12527     */
12528
12529    /**
12530     * @defgroup Hoversel Hoversel
12531     *
12532     * @image html img/widget/hoversel/preview-00.png
12533     * @image latex img/widget/hoversel/preview-00.eps
12534     *
12535     * A hoversel is a button that pops up a list of items (automatically
12536     * choosing the direction to display) that have a label and, optionally, an
12537     * icon to select from. It is a convenience widget to avoid the need to do
12538     * all the piecing together yourself. It is intended for a small number of
12539     * items in the hoversel menu (no more than 8), though is capable of many
12540     * more.
12541     *
12542     * Signals that you can add callbacks for are:
12543     * "clicked" - the user clicked the hoversel button and popped up the sel
12544     * "selected" - an item in the hoversel list is selected. event_info is the item
12545     * "dismissed" - the hover is dismissed
12546     *
12547     * See @ref tutorial_hoversel for an example.
12548     * @{
12549     */
12550    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12551    /**
12552     * @brief Add a new Hoversel object
12553     *
12554     * @param parent The parent object
12555     * @return The new object or NULL if it cannot be created
12556     */
12557    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12558    /**
12559     * @brief This sets the hoversel to expand horizontally.
12560     *
12561     * @param obj The hoversel object
12562     * @param horizontal If true, the hover will expand horizontally to the
12563     * right.
12564     *
12565     * @note The initial button will display horizontally regardless of this
12566     * setting.
12567     */
12568    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12569    /**
12570     * @brief This returns whether the hoversel is set to expand horizontally.
12571     *
12572     * @param obj The hoversel object
12573     * @return If true, the hover will expand horizontally to the right.
12574     *
12575     * @see elm_hoversel_horizontal_set()
12576     */
12577    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12578    /**
12579     * @brief Set the Hover parent
12580     *
12581     * @param obj The hoversel object
12582     * @param parent The parent to use
12583     *
12584     * Sets the hover parent object, the area that will be darkened when the
12585     * hoversel is clicked. Should probably be the window that the hoversel is
12586     * in. See @ref Hover objects for more information.
12587     */
12588    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12589    /**
12590     * @brief Get the Hover parent
12591     *
12592     * @param obj The hoversel object
12593     * @return The used parent
12594     *
12595     * Gets the hover parent object.
12596     *
12597     * @see elm_hoversel_hover_parent_set()
12598     */
12599    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12600    /**
12601     * @brief Set the hoversel button label
12602     *
12603     * @param obj The hoversel object
12604     * @param label The label text.
12605     *
12606     * This sets the label of the button that is always visible (before it is
12607     * clicked and expanded).
12608     *
12609     * @deprecated elm_object_text_set()
12610     */
12611    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12612    /**
12613     * @brief Get the hoversel button label
12614     *
12615     * @param obj The hoversel object
12616     * @return The label text.
12617     *
12618     * @deprecated elm_object_text_get()
12619     */
12620    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12621    /**
12622     * @brief Set the icon of the hoversel button
12623     *
12624     * @param obj The hoversel object
12625     * @param icon The icon object
12626     *
12627     * Sets the icon of the button that is always visible (before it is clicked
12628     * and expanded).  Once the icon object is set, a previously set one will be
12629     * deleted, if you want to keep that old content object, use the
12630     * elm_hoversel_icon_unset() function.
12631     *
12632     * @see elm_button_icon_set()
12633     */
12634    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12635    /**
12636     * @brief Get the icon of the hoversel button
12637     *
12638     * @param obj The hoversel object
12639     * @return The icon object
12640     *
12641     * Get the icon of the button that is always visible (before it is clicked
12642     * and expanded). Also see elm_button_icon_get().
12643     *
12644     * @see elm_hoversel_icon_set()
12645     */
12646    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12647    /**
12648     * @brief Get and unparent the icon of the hoversel button
12649     *
12650     * @param obj The hoversel object
12651     * @return The icon object that was being used
12652     *
12653     * Unparent and return the icon of the button that is always visible
12654     * (before it is clicked and expanded).
12655     *
12656     * @see elm_hoversel_icon_set()
12657     * @see elm_button_icon_unset()
12658     */
12659    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12660    /**
12661     * @brief This triggers the hoversel popup from code, the same as if the user
12662     * had clicked the button.
12663     *
12664     * @param obj The hoversel object
12665     */
12666    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12667    /**
12668     * @brief This dismisses the hoversel popup as if the user had clicked
12669     * outside the hover.
12670     *
12671     * @param obj The hoversel object
12672     */
12673    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12674    /**
12675     * @brief Returns whether the hoversel is expanded.
12676     *
12677     * @param obj The hoversel object
12678     * @return  This will return EINA_TRUE if the hoversel is expanded or
12679     * EINA_FALSE if it is not expanded.
12680     */
12681    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12682    /**
12683     * @brief This will remove all the children items from the hoversel.
12684     *
12685     * @param obj The hoversel object
12686     *
12687     * @warning Should @b not be called while the hoversel is active; use
12688     * elm_hoversel_expanded_get() to check first.
12689     *
12690     * @see elm_hoversel_item_del_cb_set()
12691     * @see elm_hoversel_item_del()
12692     */
12693    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12694    /**
12695     * @brief Get the list of items within the given hoversel.
12696     *
12697     * @param obj The hoversel object
12698     * @return Returns a list of Elm_Hoversel_Item*
12699     *
12700     * @see elm_hoversel_item_add()
12701     */
12702    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12703    /**
12704     * @brief Add an item to the hoversel button
12705     *
12706     * @param obj The hoversel object
12707     * @param label The text label to use for the item (NULL if not desired)
12708     * @param icon_file An image file path on disk to use for the icon or standard
12709     * icon name (NULL if not desired)
12710     * @param icon_type The icon type if relevant
12711     * @param func Convenience function to call when this item is selected
12712     * @param data Data to pass to item-related functions
12713     * @return A handle to the item added.
12714     *
12715     * This adds an item to the hoversel to show when it is clicked. Note: if you
12716     * need to use an icon from an edje file then use
12717     * elm_hoversel_item_icon_set() right after the this function, and set
12718     * icon_file to NULL here.
12719     *
12720     * For more information on what @p icon_file and @p icon_type are see the
12721     * @ref Icon "icon documentation".
12722     */
12723    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);
12724    /**
12725     * @brief Delete an item from the hoversel
12726     *
12727     * @param item The item to delete
12728     *
12729     * This deletes the item from the hoversel (should not be called while the
12730     * hoversel is active; use elm_hoversel_expanded_get() to check first).
12731     *
12732     * @see elm_hoversel_item_add()
12733     * @see elm_hoversel_item_del_cb_set()
12734     */
12735    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12736    /**
12737     * @brief Set the function to be called when an item from the hoversel is
12738     * freed.
12739     *
12740     * @param item The item to set the callback on
12741     * @param func The function called
12742     *
12743     * That function will receive these parameters:
12744     * @li void *item_data
12745     * @li Evas_Object *the_item_object
12746     * @li Elm_Hoversel_Item *the_object_struct
12747     *
12748     * @see elm_hoversel_item_add()
12749     */
12750    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12751    /**
12752     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12753     * that will be passed to associated function callbacks.
12754     *
12755     * @param item The item to get the data from
12756     * @return The data pointer set with elm_hoversel_item_add()
12757     *
12758     * @see elm_hoversel_item_add()
12759     */
12760    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12761    /**
12762     * @brief This returns the label text of the given hoversel item.
12763     *
12764     * @param item The item to get the label
12765     * @return The label text of the hoversel item
12766     *
12767     * @see elm_hoversel_item_add()
12768     */
12769    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12770    /**
12771     * @brief This sets the icon for the given hoversel item.
12772     *
12773     * @param item The item to set the icon
12774     * @param icon_file An image file path on disk to use for the icon or standard
12775     * icon name
12776     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12777     * to NULL if the icon is not an edje file
12778     * @param icon_type The icon type
12779     *
12780     * The icon can be loaded from the standard set, from an image file, or from
12781     * an edje file.
12782     *
12783     * @see elm_hoversel_item_add()
12784     */
12785    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);
12786    /**
12787     * @brief Get the icon object of the hoversel item
12788     *
12789     * @param item The item to get the icon from
12790     * @param icon_file The image file path on disk used for the icon or standard
12791     * icon name
12792     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12793     * if the icon is not an edje file
12794     * @param icon_type The icon type
12795     *
12796     * @see elm_hoversel_item_icon_set()
12797     * @see elm_hoversel_item_add()
12798     */
12799    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);
12800    /**
12801     * @}
12802     */
12803
12804    /**
12805     * @defgroup Toolbar Toolbar
12806     * @ingroup Elementary
12807     *
12808     * @image html img/widget/toolbar/preview-00.png
12809     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12810     *
12811     * @image html img/toolbar.png
12812     * @image latex img/toolbar.eps width=\textwidth
12813     *
12814     * A toolbar is a widget that displays a list of items inside
12815     * a box. It can be scrollable, show a menu with items that don't fit
12816     * to toolbar size or even crop them.
12817     *
12818     * Only one item can be selected at a time.
12819     *
12820     * Items can have multiple states, or show menus when selected by the user.
12821     *
12822     * Smart callbacks one can listen to:
12823     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12824     *
12825     * Available styles for it:
12826     * - @c "default"
12827     * - @c "transparent" - no background or shadow, just show the content
12828     *
12829     * List of examples:
12830     * @li @ref toolbar_example_01
12831     * @li @ref toolbar_example_02
12832     * @li @ref toolbar_example_03
12833     */
12834
12835    /**
12836     * @addtogroup Toolbar
12837     * @{
12838     */
12839
12840    /**
12841     * @enum _Elm_Toolbar_Shrink_Mode
12842     * @typedef Elm_Toolbar_Shrink_Mode
12843     *
12844     * Set toolbar's items display behavior, it can be scrollabel,
12845     * show a menu with exceeding items, or simply hide them.
12846     *
12847     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12848     * from elm config.
12849     *
12850     * Values <b> don't </b> work as bitmask, only one can be choosen.
12851     *
12852     * @see elm_toolbar_mode_shrink_set()
12853     * @see elm_toolbar_mode_shrink_get()
12854     *
12855     * @ingroup Toolbar
12856     */
12857    typedef enum _Elm_Toolbar_Shrink_Mode
12858      {
12859         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
12860         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
12861         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12862         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
12863      } Elm_Toolbar_Shrink_Mode;
12864
12865    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(). */
12866
12867    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(). */
12868
12869    /**
12870     * Add a new toolbar widget to the given parent Elementary
12871     * (container) object.
12872     *
12873     * @param parent The parent object.
12874     * @return a new toolbar widget handle or @c NULL, on errors.
12875     *
12876     * This function inserts a new toolbar widget on the canvas.
12877     *
12878     * @ingroup Toolbar
12879     */
12880    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12881
12882    /**
12883     * Set the icon size, in pixels, to be used by toolbar items.
12884     *
12885     * @param obj The toolbar object
12886     * @param icon_size The icon size in pixels
12887     *
12888     * @note Default value is @c 32. It reads value from elm config.
12889     *
12890     * @see elm_toolbar_icon_size_get()
12891     *
12892     * @ingroup Toolbar
12893     */
12894    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12895
12896    /**
12897     * Get the icon size, in pixels, to be used by toolbar items.
12898     *
12899     * @param obj The toolbar object.
12900     * @return The icon size in pixels.
12901     *
12902     * @see elm_toolbar_icon_size_set() for details.
12903     *
12904     * @ingroup Toolbar
12905     */
12906    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12907
12908    /**
12909     * Sets icon lookup order, for toolbar items' icons.
12910     *
12911     * @param obj The toolbar object.
12912     * @param order The icon lookup order.
12913     *
12914     * Icons added before calling this function will not be affected.
12915     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12916     *
12917     * @see elm_toolbar_icon_order_lookup_get()
12918     *
12919     * @ingroup Toolbar
12920     */
12921    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12922
12923    /**
12924     * Gets the icon lookup order.
12925     *
12926     * @param obj The toolbar object.
12927     * @return The icon lookup order.
12928     *
12929     * @see elm_toolbar_icon_order_lookup_set() for details.
12930     *
12931     * @ingroup Toolbar
12932     */
12933    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12934
12935    /**
12936     * Set whether the toolbar items' should be selected by the user or not.
12937     *
12938     * @param obj The toolbar object.
12939     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
12940     * enable it.
12941     *
12942     * This will turn off the ability to select items entirely and they will
12943     * neither appear selected nor emit selected signals. The clicked
12944     * callback function will still be called.
12945     *
12946     * Selection is enabled by default.
12947     *
12948     * @see elm_toolbar_no_select_mode_get().
12949     *
12950     * @ingroup Toolbar
12951     */
12952    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12953
12954    /**
12955     * Set whether the toolbar items' should be selected by the user or not.
12956     *
12957     * @param obj The toolbar object.
12958     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
12959     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
12960     *
12961     * @see elm_toolbar_no_select_mode_set() for details.
12962     *
12963     * @ingroup Toolbar
12964     */
12965    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12966
12967    /**
12968     * Append item to the toolbar.
12969     *
12970     * @param obj The toolbar object.
12971     * @param icon A string with icon name or the absolute path of an image file.
12972     * @param label The label of the item.
12973     * @param func The function to call when the item is clicked.
12974     * @param data The data to associate with the item for related callbacks.
12975     * @return The created item or @c NULL upon failure.
12976     *
12977     * A new item will be created and appended to the toolbar, i.e., will
12978     * be set as @b last item.
12979     *
12980     * Items created with this method can be deleted with
12981     * elm_toolbar_item_del().
12982     *
12983     * Associated @p data can be properly freed when item is deleted if a
12984     * callback function is set with elm_toolbar_item_del_cb_set().
12985     *
12986     * If a function is passed as argument, it will be called everytime this item
12987     * is selected, i.e., the user clicks over an unselected item.
12988     * If such function isn't needed, just passing
12989     * @c NULL as @p func is enough. The same should be done for @p data.
12990     *
12991     * Toolbar will load icon image from fdo or current theme.
12992     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12993     * If an absolute path is provided it will load it direct from a file.
12994     *
12995     * @see elm_toolbar_item_icon_set()
12996     * @see elm_toolbar_item_del()
12997     * @see elm_toolbar_item_del_cb_set()
12998     *
12999     * @ingroup Toolbar
13000     */
13001    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);
13002
13003    /**
13004     * Prepend item to the toolbar.
13005     *
13006     * @param obj The toolbar object.
13007     * @param icon A string with icon name or the absolute path of an image file.
13008     * @param label The label of the item.
13009     * @param func The function to call when the item is clicked.
13010     * @param data The data to associate with the item for related callbacks.
13011     * @return The created item or @c NULL upon failure.
13012     *
13013     * A new item will be created and prepended to the toolbar, i.e., will
13014     * be set as @b first item.
13015     *
13016     * Items created with this method can be deleted with
13017     * elm_toolbar_item_del().
13018     *
13019     * Associated @p data can be properly freed when item is deleted if a
13020     * callback function is set with elm_toolbar_item_del_cb_set().
13021     *
13022     * If a function is passed as argument, it will be called everytime this item
13023     * is selected, i.e., the user clicks over an unselected item.
13024     * If such function isn't needed, just passing
13025     * @c NULL as @p func is enough. The same should be done for @p data.
13026     *
13027     * Toolbar will load icon image from fdo or current theme.
13028     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13029     * If an absolute path is provided it will load it direct from a file.
13030     *
13031     * @see elm_toolbar_item_icon_set()
13032     * @see elm_toolbar_item_del()
13033     * @see elm_toolbar_item_del_cb_set()
13034     *
13035     * @ingroup Toolbar
13036     */
13037    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);
13038
13039    /**
13040     * Insert a new item into the toolbar object before item @p before.
13041     *
13042     * @param obj The toolbar object.
13043     * @param before The toolbar item to insert before.
13044     * @param icon A string with icon name or the absolute path of an image file.
13045     * @param label The label of the item.
13046     * @param func The function to call when the item is clicked.
13047     * @param data The data to associate with the item for related callbacks.
13048     * @return The created item or @c NULL upon failure.
13049     *
13050     * A new item will be created and added to the toolbar. Its position in
13051     * this toolbar will be just before item @p before.
13052     *
13053     * Items created with this method can be deleted with
13054     * elm_toolbar_item_del().
13055     *
13056     * Associated @p data can be properly freed when item is deleted if a
13057     * callback function is set with elm_toolbar_item_del_cb_set().
13058     *
13059     * If a function is passed as argument, it will be called everytime this item
13060     * is selected, i.e., the user clicks over an unselected item.
13061     * If such function isn't needed, just passing
13062     * @c NULL as @p func is enough. The same should be done for @p data.
13063     *
13064     * Toolbar will load icon image from fdo or current theme.
13065     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13066     * If an absolute path is provided it will load it direct from a file.
13067     *
13068     * @see elm_toolbar_item_icon_set()
13069     * @see elm_toolbar_item_del()
13070     * @see elm_toolbar_item_del_cb_set()
13071     *
13072     * @ingroup Toolbar
13073     */
13074    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);
13075
13076    /**
13077     * Insert a new item into the toolbar object after item @p after.
13078     *
13079     * @param obj The toolbar object.
13080     * @param before The toolbar item to insert before.
13081     * @param icon A string with icon name or the absolute path of an image file.
13082     * @param label The label of the item.
13083     * @param func The function to call when the item is clicked.
13084     * @param data The data to associate with the item for related callbacks.
13085     * @return The created item or @c NULL upon failure.
13086     *
13087     * A new item will be created and added to the toolbar. Its position in
13088     * this toolbar will be just after item @p after.
13089     *
13090     * Items created with this method can be deleted with
13091     * elm_toolbar_item_del().
13092     *
13093     * Associated @p data can be properly freed when item is deleted if a
13094     * callback function is set with elm_toolbar_item_del_cb_set().
13095     *
13096     * If a function is passed as argument, it will be called everytime this item
13097     * is selected, i.e., the user clicks over an unselected item.
13098     * If such function isn't needed, just passing
13099     * @c NULL as @p func is enough. The same should be done for @p data.
13100     *
13101     * Toolbar will load icon image from fdo or current theme.
13102     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13103     * If an absolute path is provided it will load it direct from a file.
13104     *
13105     * @see elm_toolbar_item_icon_set()
13106     * @see elm_toolbar_item_del()
13107     * @see elm_toolbar_item_del_cb_set()
13108     *
13109     * @ingroup Toolbar
13110     */
13111    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);
13112
13113    /**
13114     * Get the first item in the given toolbar widget's list of
13115     * items.
13116     *
13117     * @param obj The toolbar object
13118     * @return The first item or @c NULL, if it has no items (and on
13119     * errors)
13120     *
13121     * @see elm_toolbar_item_append()
13122     * @see elm_toolbar_last_item_get()
13123     *
13124     * @ingroup Toolbar
13125     */
13126    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13127
13128    /**
13129     * Get the last item in the given toolbar widget's list of
13130     * items.
13131     *
13132     * @param obj The toolbar object
13133     * @return The last item or @c NULL, if it has no items (and on
13134     * errors)
13135     *
13136     * @see elm_toolbar_item_prepend()
13137     * @see elm_toolbar_first_item_get()
13138     *
13139     * @ingroup Toolbar
13140     */
13141    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13142
13143    /**
13144     * Get the item after @p item in toolbar.
13145     *
13146     * @param item The toolbar item.
13147     * @return The item after @p item, or @c NULL if none or on failure.
13148     *
13149     * @note If it is the last item, @c NULL will be returned.
13150     *
13151     * @see elm_toolbar_item_append()
13152     *
13153     * @ingroup Toolbar
13154     */
13155    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13156
13157    /**
13158     * Get the item before @p item in toolbar.
13159     *
13160     * @param item The toolbar item.
13161     * @return The item before @p item, or @c NULL if none or on failure.
13162     *
13163     * @note If it is the first item, @c NULL will be returned.
13164     *
13165     * @see elm_toolbar_item_prepend()
13166     *
13167     * @ingroup Toolbar
13168     */
13169    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13170
13171    /**
13172     * Get the toolbar object from an item.
13173     *
13174     * @param item The item.
13175     * @return The toolbar object.
13176     *
13177     * This returns the toolbar object itself that an item belongs to.
13178     *
13179     * @ingroup Toolbar
13180     */
13181    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13182
13183    /**
13184     * Set the priority of a toolbar item.
13185     *
13186     * @param item The toolbar item.
13187     * @param priority The item priority. The default is zero.
13188     *
13189     * This is used only when the toolbar shrink mode is set to
13190     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13191     * When space is less than required, items with low priority
13192     * will be removed from the toolbar and added to a dynamically-created menu,
13193     * while items with higher priority will remain on the toolbar,
13194     * with the same order they were added.
13195     *
13196     * @see elm_toolbar_item_priority_get()
13197     *
13198     * @ingroup Toolbar
13199     */
13200    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13201
13202    /**
13203     * Get the priority of a toolbar item.
13204     *
13205     * @param item The toolbar item.
13206     * @return The @p item priority, or @c 0 on failure.
13207     *
13208     * @see elm_toolbar_item_priority_set() for details.
13209     *
13210     * @ingroup Toolbar
13211     */
13212    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13213
13214    /**
13215     * Get the label of item.
13216     *
13217     * @param item The item of toolbar.
13218     * @return The label of item.
13219     *
13220     * The return value is a pointer to the label associated to @p item when
13221     * it was created, with function elm_toolbar_item_append() or similar,
13222     * or later,
13223     * with function elm_toolbar_item_label_set. If no label
13224     * was passed as argument, it will return @c NULL.
13225     *
13226     * @see elm_toolbar_item_label_set() for more details.
13227     * @see elm_toolbar_item_append()
13228     *
13229     * @ingroup Toolbar
13230     */
13231    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13232
13233    /**
13234     * Set the label of item.
13235     *
13236     * @param item The item of toolbar.
13237     * @param text The label of item.
13238     *
13239     * The label to be displayed by the item.
13240     * Label will be placed at icons bottom (if set).
13241     *
13242     * If a label was passed as argument on item creation, with function
13243     * elm_toolbar_item_append() or similar, it will be already
13244     * displayed by the item.
13245     *
13246     * @see elm_toolbar_item_label_get()
13247     * @see elm_toolbar_item_append()
13248     *
13249     * @ingroup Toolbar
13250     */
13251    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13252
13253    /**
13254     * Return the data associated with a given toolbar widget item.
13255     *
13256     * @param item The toolbar widget item handle.
13257     * @return The data associated with @p item.
13258     *
13259     * @see elm_toolbar_item_data_set()
13260     *
13261     * @ingroup Toolbar
13262     */
13263    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13264
13265    /**
13266     * Set the data associated with a given toolbar widget item.
13267     *
13268     * @param item The toolbar widget item handle.
13269     * @param data The new data pointer to set to @p item.
13270     *
13271     * This sets new item data on @p item.
13272     *
13273     * @warning The old data pointer won't be touched by this function, so
13274     * the user had better to free that old data himself/herself.
13275     *
13276     * @ingroup Toolbar
13277     */
13278    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13279
13280    /**
13281     * Returns a pointer to a toolbar item by its label.
13282     *
13283     * @param obj The toolbar object.
13284     * @param label The label of the item to find.
13285     *
13286     * @return The pointer to the toolbar item matching @p label or @c NULL
13287     * on failure.
13288     *
13289     * @ingroup Toolbar
13290     */
13291    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13292
13293    /*
13294     * Get whether the @p item is selected or not.
13295     *
13296     * @param item The toolbar item.
13297     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13298     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13299     *
13300     * @see elm_toolbar_selected_item_set() for details.
13301     * @see elm_toolbar_item_selected_get()
13302     *
13303     * @ingroup Toolbar
13304     */
13305    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13306
13307    /**
13308     * Set the selected state of an item.
13309     *
13310     * @param item The toolbar item
13311     * @param selected The selected state
13312     *
13313     * This sets the selected state of the given item @p it.
13314     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13315     *
13316     * If a new item is selected the previosly selected will be unselected.
13317     * Previoulsy selected item can be get with function
13318     * elm_toolbar_selected_item_get().
13319     *
13320     * Selected items will be highlighted.
13321     *
13322     * @see elm_toolbar_item_selected_get()
13323     * @see elm_toolbar_selected_item_get()
13324     *
13325     * @ingroup Toolbar
13326     */
13327    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13328
13329    /**
13330     * Get the selected item.
13331     *
13332     * @param obj The toolbar object.
13333     * @return The selected toolbar item.
13334     *
13335     * The selected item can be unselected with function
13336     * elm_toolbar_item_selected_set().
13337     *
13338     * The selected item always will be highlighted on toolbar.
13339     *
13340     * @see elm_toolbar_selected_items_get()
13341     *
13342     * @ingroup Toolbar
13343     */
13344    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13345
13346    /**
13347     * Set the icon associated with @p item.
13348     *
13349     * @param obj The parent of this item.
13350     * @param item The toolbar item.
13351     * @param icon A string with icon name or the absolute path of an image file.
13352     *
13353     * Toolbar will load icon image from fdo or current theme.
13354     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13355     * If an absolute path is provided it will load it direct from a file.
13356     *
13357     * @see elm_toolbar_icon_order_lookup_set()
13358     * @see elm_toolbar_icon_order_lookup_get()
13359     *
13360     * @ingroup Toolbar
13361     */
13362    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13363
13364    /**
13365     * Get the string used to set the icon of @p item.
13366     *
13367     * @param item The toolbar item.
13368     * @return The string associated with the icon object.
13369     *
13370     * @see elm_toolbar_item_icon_set() for details.
13371     *
13372     * @ingroup Toolbar
13373     */
13374    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13375
13376    /**
13377     * Delete them item from the toolbar.
13378     *
13379     * @param item The item of toolbar to be deleted.
13380     *
13381     * @see elm_toolbar_item_append()
13382     * @see elm_toolbar_item_del_cb_set()
13383     *
13384     * @ingroup Toolbar
13385     */
13386    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13387
13388    /**
13389     * Set the function called when a toolbar item is freed.
13390     *
13391     * @param item The item to set the callback on.
13392     * @param func The function called.
13393     *
13394     * If there is a @p func, then it will be called prior item's memory release.
13395     * That will be called with the following arguments:
13396     * @li item's data;
13397     * @li item's Evas object;
13398     * @li item itself;
13399     *
13400     * This way, a data associated to a toolbar item could be properly freed.
13401     *
13402     * @ingroup Toolbar
13403     */
13404    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13405
13406    /**
13407     * Get a value whether toolbar item is disabled or not.
13408     *
13409     * @param item The item.
13410     * @return The disabled state.
13411     *
13412     * @see elm_toolbar_item_disabled_set() for more details.
13413     *
13414     * @ingroup Toolbar
13415     */
13416    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13417
13418    /**
13419     * Sets the disabled/enabled state of a toolbar item.
13420     *
13421     * @param item The item.
13422     * @param disabled The disabled state.
13423     *
13424     * A disabled item cannot be selected or unselected. It will also
13425     * change its appearance (generally greyed out). This sets the
13426     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13427     * enabled).
13428     *
13429     * @ingroup Toolbar
13430     */
13431    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13432
13433    /**
13434     * Set or unset item as a separator.
13435     *
13436     * @param item The toolbar item.
13437     * @param setting @c EINA_TRUE to set item @p item as separator or
13438     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13439     *
13440     * Items aren't set as separator by default.
13441     *
13442     * If set as separator it will display separator theme, so won't display
13443     * icons or label.
13444     *
13445     * @see elm_toolbar_item_separator_get()
13446     *
13447     * @ingroup Toolbar
13448     */
13449    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13450
13451    /**
13452     * Get a value whether item is a separator or not.
13453     *
13454     * @param item The toolbar item.
13455     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13456     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13457     *
13458     * @see elm_toolbar_item_separator_set() for details.
13459     *
13460     * @ingroup Toolbar
13461     */
13462    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13463
13464    /**
13465     * Set the shrink state of toolbar @p obj.
13466     *
13467     * @param obj The toolbar object.
13468     * @param shrink_mode Toolbar's items display behavior.
13469     *
13470     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13471     * but will enforce a minimun size so all the items will fit, won't scroll
13472     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13473     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13474     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13475     *
13476     * @ingroup Toolbar
13477     */
13478    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13479
13480    /**
13481     * Get the shrink mode of toolbar @p obj.
13482     *
13483     * @param obj The toolbar object.
13484     * @return Toolbar's items display behavior.
13485     *
13486     * @see elm_toolbar_mode_shrink_set() for details.
13487     *
13488     * @ingroup Toolbar
13489     */
13490    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13491
13492    /**
13493     * Enable/disable homogenous mode.
13494     *
13495     * @param obj The toolbar object
13496     * @param homogeneous Assume the items within the toolbar are of the
13497     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13498     *
13499     * This will enable the homogeneous mode where items are of the same size.
13500     * @see elm_toolbar_homogeneous_get()
13501     *
13502     * @ingroup Toolbar
13503     */
13504    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13505
13506    /**
13507     * Get whether the homogenous mode is enabled.
13508     *
13509     * @param obj The toolbar object.
13510     * @return Assume the items within the toolbar are of the same height
13511     * and width (EINA_TRUE = on, EINA_FALSE = off).
13512     *
13513     * @see elm_toolbar_homogeneous_set()
13514     *
13515     * @ingroup Toolbar
13516     */
13517    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13518
13519    /**
13520     * Enable/disable homogenous mode.
13521     *
13522     * @param obj The toolbar object
13523     * @param homogeneous Assume the items within the toolbar are of the
13524     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13525     *
13526     * This will enable the homogeneous mode where items are of the same size.
13527     * @see elm_toolbar_homogeneous_get()
13528     *
13529     * @deprecated use elm_toolbar_homogeneous_set() instead.
13530     *
13531     * @ingroup Toolbar
13532     */
13533    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13534
13535    /**
13536     * Get whether the homogenous mode is enabled.
13537     *
13538     * @param obj The toolbar object.
13539     * @return Assume the items within the toolbar are of the same height
13540     * and width (EINA_TRUE = on, EINA_FALSE = off).
13541     *
13542     * @see elm_toolbar_homogeneous_set()
13543     * @deprecated use elm_toolbar_homogeneous_get() instead.
13544     *
13545     * @ingroup Toolbar
13546     */
13547    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13548
13549    /**
13550     * Set the parent object of the toolbar items' menus.
13551     *
13552     * @param obj The toolbar object.
13553     * @param parent The parent of the menu objects.
13554     *
13555     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13556     *
13557     * For more details about setting the parent for toolbar menus, see
13558     * elm_menu_parent_set().
13559     *
13560     * @see elm_menu_parent_set() for details.
13561     * @see elm_toolbar_item_menu_set() for details.
13562     *
13563     * @ingroup Toolbar
13564     */
13565    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13566
13567    /**
13568     * Get the parent object of the toolbar items' menus.
13569     *
13570     * @param obj The toolbar object.
13571     * @return The parent of the menu objects.
13572     *
13573     * @see elm_toolbar_menu_parent_set() for details.
13574     *
13575     * @ingroup Toolbar
13576     */
13577    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13578
13579    /**
13580     * Set the alignment of the items.
13581     *
13582     * @param obj The toolbar object.
13583     * @param align The new alignment, a float between <tt> 0.0 </tt>
13584     * and <tt> 1.0 </tt>.
13585     *
13586     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13587     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13588     * items.
13589     *
13590     * Centered items by default.
13591     *
13592     * @see elm_toolbar_align_get()
13593     *
13594     * @ingroup Toolbar
13595     */
13596    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13597
13598    /**
13599     * Get the alignment of the items.
13600     *
13601     * @param obj The toolbar object.
13602     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13603     * <tt> 1.0 </tt>.
13604     *
13605     * @see elm_toolbar_align_set() for details.
13606     *
13607     * @ingroup Toolbar
13608     */
13609    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13610
13611    /**
13612     * Set whether the toolbar item opens a menu.
13613     *
13614     * @param item The toolbar item.
13615     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13616     *
13617     * A toolbar item can be set to be a menu, using this function.
13618     *
13619     * Once it is set to be a menu, it can be manipulated through the
13620     * menu-like function elm_toolbar_menu_parent_set() and the other
13621     * elm_menu functions, using the Evas_Object @c menu returned by
13622     * elm_toolbar_item_menu_get().
13623     *
13624     * So, items to be displayed in this item's menu should be added with
13625     * elm_menu_item_add().
13626     *
13627     * The following code exemplifies the most basic usage:
13628     * @code
13629     * tb = elm_toolbar_add(win)
13630     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13631     * elm_toolbar_item_menu_set(item, EINA_TRUE);
13632     * elm_toolbar_menu_parent_set(tb, win);
13633     * menu = elm_toolbar_item_menu_get(item);
13634     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13635     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13636     * NULL);
13637     * @endcode
13638     *
13639     * @see elm_toolbar_item_menu_get()
13640     *
13641     * @ingroup Toolbar
13642     */
13643    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13644
13645    /**
13646     * Get toolbar item's menu.
13647     *
13648     * @param item The toolbar item.
13649     * @return Item's menu object or @c NULL on failure.
13650     *
13651     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13652     * this function will set it.
13653     *
13654     * @see elm_toolbar_item_menu_set() for details.
13655     *
13656     * @ingroup Toolbar
13657     */
13658    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13659
13660    /**
13661     * Add a new state to @p item.
13662     *
13663     * @param item The item.
13664     * @param icon A string with icon name or the absolute path of an image file.
13665     * @param label The label of the new state.
13666     * @param func The function to call when the item is clicked when this
13667     * state is selected.
13668     * @param data The data to associate with the state.
13669     * @return The toolbar item state, or @c NULL upon failure.
13670     *
13671     * Toolbar will load icon image from fdo or current theme.
13672     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13673     * If an absolute path is provided it will load it direct from a file.
13674     *
13675     * States created with this function can be removed with
13676     * elm_toolbar_item_state_del().
13677     *
13678     * @see elm_toolbar_item_state_del()
13679     * @see elm_toolbar_item_state_sel()
13680     * @see elm_toolbar_item_state_get()
13681     *
13682     * @ingroup Toolbar
13683     */
13684    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);
13685
13686    /**
13687     * Delete a previoulsy added state to @p item.
13688     *
13689     * @param item The toolbar item.
13690     * @param state The state to be deleted.
13691     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13692     *
13693     * @see elm_toolbar_item_state_add()
13694     */
13695    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13696
13697    /**
13698     * Set @p state as the current state of @p it.
13699     *
13700     * @param it The item.
13701     * @param state The state to use.
13702     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13703     *
13704     * If @p state is @c NULL, it won't select any state and the default item's
13705     * icon and label will be used. It's the same behaviour than
13706     * elm_toolbar_item_state_unser().
13707     *
13708     * @see elm_toolbar_item_state_unset()
13709     *
13710     * @ingroup Toolbar
13711     */
13712    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13713
13714    /**
13715     * Unset the state of @p it.
13716     *
13717     * @param it The item.
13718     *
13719     * The default icon and label from this item will be displayed.
13720     *
13721     * @see elm_toolbar_item_state_set() for more details.
13722     *
13723     * @ingroup Toolbar
13724     */
13725    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13726
13727    /**
13728     * Get the current state of @p it.
13729     *
13730     * @param item The item.
13731     * @return The selected state or @c NULL if none is selected or on failure.
13732     *
13733     * @see elm_toolbar_item_state_set() for details.
13734     * @see elm_toolbar_item_state_unset()
13735     * @see elm_toolbar_item_state_add()
13736     *
13737     * @ingroup Toolbar
13738     */
13739    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13740
13741    /**
13742     * Get the state after selected state in toolbar's @p item.
13743     *
13744     * @param it The toolbar item to change state.
13745     * @return The state after current state, or @c NULL on failure.
13746     *
13747     * If last state is selected, this function will return first state.
13748     *
13749     * @see elm_toolbar_item_state_set()
13750     * @see elm_toolbar_item_state_add()
13751     *
13752     * @ingroup Toolbar
13753     */
13754    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13755
13756    /**
13757     * Get the state before selected state in toolbar's @p item.
13758     *
13759     * @param it The toolbar item to change state.
13760     * @return The state before current state, or @c NULL on failure.
13761     *
13762     * If first state is selected, this function will return last state.
13763     *
13764     * @see elm_toolbar_item_state_set()
13765     * @see elm_toolbar_item_state_add()
13766     *
13767     * @ingroup Toolbar
13768     */
13769    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13770
13771    /**
13772     * Set the text to be shown in a given toolbar item's tooltips.
13773     *
13774     * @param item Target item.
13775     * @param text The text to set in the content.
13776     *
13777     * Setup the text as tooltip to object. The item can have only one tooltip,
13778     * so any previous tooltip data - set with this function or
13779     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13780     *
13781     * @see elm_object_tooltip_text_set() for more details.
13782     *
13783     * @ingroup Toolbar
13784     */
13785    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13786
13787    /**
13788     * Set the content to be shown in the tooltip item.
13789     *
13790     * Setup the tooltip to item. The item can have only one tooltip,
13791     * so any previous tooltip data is removed. @p func(with @p data) will
13792     * be called every time that need show the tooltip and it should
13793     * return a valid Evas_Object. This object is then managed fully by
13794     * tooltip system and is deleted when the tooltip is gone.
13795     *
13796     * @param item the toolbar item being attached a tooltip.
13797     * @param func the function used to create the tooltip contents.
13798     * @param data what to provide to @a func as callback data/context.
13799     * @param del_cb called when data is not needed anymore, either when
13800     *        another callback replaces @a func, the tooltip is unset with
13801     *        elm_toolbar_item_tooltip_unset() or the owner @a item
13802     *        dies. This callback receives as the first parameter the
13803     *        given @a data, and @c event_info is the item.
13804     *
13805     * @see elm_object_tooltip_content_cb_set() for more details.
13806     *
13807     * @ingroup Toolbar
13808     */
13809    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);
13810
13811    /**
13812     * Unset tooltip from item.
13813     *
13814     * @param item toolbar item to remove previously set tooltip.
13815     *
13816     * Remove tooltip from item. The callback provided as del_cb to
13817     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13818     * it is not used anymore.
13819     *
13820     * @see elm_object_tooltip_unset() for more details.
13821     * @see elm_toolbar_item_tooltip_content_cb_set()
13822     *
13823     * @ingroup Toolbar
13824     */
13825    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13826
13827    /**
13828     * Sets a different style for this item tooltip.
13829     *
13830     * @note before you set a style you should define a tooltip with
13831     *       elm_toolbar_item_tooltip_content_cb_set() or
13832     *       elm_toolbar_item_tooltip_text_set()
13833     *
13834     * @param item toolbar item with tooltip already set.
13835     * @param style the theme style to use (default, transparent, ...)
13836     *
13837     * @see elm_object_tooltip_style_set() for more details.
13838     *
13839     * @ingroup Toolbar
13840     */
13841    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13842
13843    /**
13844     * Get the style for this item tooltip.
13845     *
13846     * @param item toolbar item with tooltip already set.
13847     * @return style the theme style in use, defaults to "default". If the
13848     *         object does not have a tooltip set, then NULL is returned.
13849     *
13850     * @see elm_object_tooltip_style_get() for more details.
13851     * @see elm_toolbar_item_tooltip_style_set()
13852     *
13853     * @ingroup Toolbar
13854     */
13855    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13856
13857    /**
13858     * Set the type of mouse pointer/cursor decoration to be shown,
13859     * when the mouse pointer is over the given toolbar widget item
13860     *
13861     * @param item toolbar item to customize cursor on
13862     * @param cursor the cursor type's name
13863     *
13864     * This function works analogously as elm_object_cursor_set(), but
13865     * here the cursor's changing area is restricted to the item's
13866     * area, and not the whole widget's. Note that that item cursors
13867     * have precedence over widget cursors, so that a mouse over an
13868     * item with custom cursor set will always show @b that cursor.
13869     *
13870     * If this function is called twice for an object, a previously set
13871     * cursor will be unset on the second call.
13872     *
13873     * @see elm_object_cursor_set()
13874     * @see elm_toolbar_item_cursor_get()
13875     * @see elm_toolbar_item_cursor_unset()
13876     *
13877     * @ingroup Toolbar
13878     */
13879    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13880
13881    /*
13882     * Get the type of mouse pointer/cursor decoration set to be shown,
13883     * when the mouse pointer is over the given toolbar widget item
13884     *
13885     * @param item toolbar item with custom cursor set
13886     * @return the cursor type's name or @c NULL, if no custom cursors
13887     * were set to @p item (and on errors)
13888     *
13889     * @see elm_object_cursor_get()
13890     * @see elm_toolbar_item_cursor_set()
13891     * @see elm_toolbar_item_cursor_unset()
13892     *
13893     * @ingroup Toolbar
13894     */
13895    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13896
13897    /**
13898     * Unset any custom mouse pointer/cursor decoration set to be
13899     * shown, when the mouse pointer is over the given toolbar widget
13900     * item, thus making it show the @b default cursor again.
13901     *
13902     * @param item a toolbar item
13903     *
13904     * Use this call to undo any custom settings on this item's cursor
13905     * decoration, bringing it back to defaults (no custom style set).
13906     *
13907     * @see elm_object_cursor_unset()
13908     * @see elm_toolbar_item_cursor_set()
13909     *
13910     * @ingroup Toolbar
13911     */
13912    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13913
13914    /**
13915     * Set a different @b style for a given custom cursor set for a
13916     * toolbar item.
13917     *
13918     * @param item toolbar item with custom cursor set
13919     * @param style the <b>theme style</b> to use (e.g. @c "default",
13920     * @c "transparent", etc)
13921     *
13922     * This function only makes sense when one is using custom mouse
13923     * cursor decorations <b>defined in a theme file</b>, which can have,
13924     * given a cursor name/type, <b>alternate styles</b> on it. It
13925     * works analogously as elm_object_cursor_style_set(), but here
13926     * applyed only to toolbar item objects.
13927     *
13928     * @warning Before you set a cursor style you should have definen a
13929     *       custom cursor previously on the item, with
13930     *       elm_toolbar_item_cursor_set()
13931     *
13932     * @see elm_toolbar_item_cursor_engine_only_set()
13933     * @see elm_toolbar_item_cursor_style_get()
13934     *
13935     * @ingroup Toolbar
13936     */
13937    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13938
13939    /**
13940     * Get the current @b style set for a given toolbar item's custom
13941     * cursor
13942     *
13943     * @param item toolbar item with custom cursor set.
13944     * @return style the cursor style in use. If the object does not
13945     *         have a cursor set, then @c NULL is returned.
13946     *
13947     * @see elm_toolbar_item_cursor_style_set() for more details
13948     *
13949     * @ingroup Toolbar
13950     */
13951    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13952
13953    /**
13954     * Set if the (custom)cursor for a given toolbar item should be
13955     * searched in its theme, also, or should only rely on the
13956     * rendering engine.
13957     *
13958     * @param item item with custom (custom) cursor already set on
13959     * @param engine_only Use @c EINA_TRUE to have cursors looked for
13960     * only on those provided by the rendering engine, @c EINA_FALSE to
13961     * have them searched on the widget's theme, as well.
13962     *
13963     * @note This call is of use only if you've set a custom cursor
13964     * for toolbar items, with elm_toolbar_item_cursor_set().
13965     *
13966     * @note By default, cursors will only be looked for between those
13967     * provided by the rendering engine.
13968     *
13969     * @ingroup Toolbar
13970     */
13971    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13972
13973    /**
13974     * Get if the (custom) cursor for a given toolbar item is being
13975     * searched in its theme, also, or is only relying on the rendering
13976     * engine.
13977     *
13978     * @param item a toolbar item
13979     * @return @c EINA_TRUE, if cursors are being looked for only on
13980     * those provided by the rendering engine, @c EINA_FALSE if they
13981     * are being searched on the widget's theme, as well.
13982     *
13983     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
13984     *
13985     * @ingroup Toolbar
13986     */
13987    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13988
13989    /**
13990     * Change a toolbar's orientation
13991     * @param obj The toolbar object
13992     * @param vertical If @c EINA_TRUE, the toolbar is vertical
13993     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
13994     * @ingroup Toolbar
13995     */
13996    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
13997
13998    /**
13999     * Get a toolbar's orientation
14000     * @param obj The toolbar object
14001     * @return If @c EINA_TRUE, the toolbar is vertical
14002     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14003     * @ingroup Toolbar
14004     */
14005    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14006
14007    /**
14008     * @}
14009     */
14010
14011    /**
14012     * @defgroup Tooltips Tooltips
14013     *
14014     * The Tooltip is an (internal, for now) smart object used to show a
14015     * content in a frame on mouse hover of objects(or widgets), with
14016     * tips/information about them.
14017     *
14018     * @{
14019     */
14020
14021    EAPI double       elm_tooltip_delay_get(void);
14022    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
14023    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14024    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14025    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14026    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);
14027    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14028    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14029    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14030    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14031    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14032
14033    /**
14034     * @}
14035     */
14036
14037    /**
14038     * @defgroup Cursors Cursors
14039     *
14040     * The Elementary cursor is an internal smart object used to
14041     * customize the mouse cursor displayed over objects (or
14042     * widgets). In the most common scenario, the cursor decoration
14043     * comes from the graphical @b engine Elementary is running
14044     * on. Those engines may provide different decorations for cursors,
14045     * and Elementary provides functions to choose them (think of X11
14046     * cursors, as an example).
14047     *
14048     * There's also the possibility of, besides using engine provided
14049     * cursors, also use ones coming from Edje theming files. Both
14050     * globally and per widget, Elementary makes it possible for one to
14051     * make the cursors lookup to be held on engines only or on
14052     * Elementary's theme file, too.
14053     *
14054     * @{
14055     */
14056
14057    /**
14058     * Set the cursor to be shown when mouse is over the object
14059     *
14060     * Set the cursor that will be displayed when mouse is over the
14061     * object. The object can have only one cursor set to it, so if
14062     * this function is called twice for an object, the previous set
14063     * will be unset.
14064     * If using X cursors, a definition of all the valid cursor names
14065     * is listed on Elementary_Cursors.h. If an invalid name is set
14066     * the default cursor will be used.
14067     *
14068     * @param obj the object being set a cursor.
14069     * @param cursor the cursor name to be used.
14070     *
14071     * @ingroup Cursors
14072     */
14073    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14074
14075    /**
14076     * Get the cursor to be shown when mouse is over the object
14077     *
14078     * @param obj an object with cursor already set.
14079     * @return the cursor name.
14080     *
14081     * @ingroup Cursors
14082     */
14083    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14084
14085    /**
14086     * Unset cursor for object
14087     *
14088     * Unset cursor for object, and set the cursor to default if the mouse
14089     * was over this object.
14090     *
14091     * @param obj Target object
14092     * @see elm_object_cursor_set()
14093     *
14094     * @ingroup Cursors
14095     */
14096    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14097
14098    /**
14099     * Sets a different style for this object cursor.
14100     *
14101     * @note before you set a style you should define a cursor with
14102     *       elm_object_cursor_set()
14103     *
14104     * @param obj an object with cursor already set.
14105     * @param style the theme style to use (default, transparent, ...)
14106     *
14107     * @ingroup Cursors
14108     */
14109    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14110
14111    /**
14112     * Get the style for this object cursor.
14113     *
14114     * @param obj an object with cursor already set.
14115     * @return style the theme style in use, defaults to "default". If the
14116     *         object does not have a cursor set, then NULL is returned.
14117     *
14118     * @ingroup Cursors
14119     */
14120    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14121
14122    /**
14123     * Set if the cursor set should be searched on the theme or should use
14124     * the provided by the engine, only.
14125     *
14126     * @note before you set if should look on theme you should define a cursor
14127     * with elm_object_cursor_set(). By default it will only look for cursors
14128     * provided by the engine.
14129     *
14130     * @param obj an object with cursor already set.
14131     * @param engine_only boolean to define it cursors should be looked only
14132     * between the provided by the engine or searched on widget's theme as well.
14133     *
14134     * @ingroup Cursors
14135     */
14136    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14137
14138    /**
14139     * Get the cursor engine only usage for this object cursor.
14140     *
14141     * @param obj an object with cursor already set.
14142     * @return engine_only boolean to define it cursors should be
14143     * looked only between the provided by the engine or searched on
14144     * widget's theme as well. If the object does not have a cursor
14145     * set, then EINA_FALSE is returned.
14146     *
14147     * @ingroup Cursors
14148     */
14149    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14150
14151    /**
14152     * Get the configured cursor engine only usage
14153     *
14154     * This gets the globally configured exclusive usage of engine cursors.
14155     *
14156     * @return 1 if only engine cursors should be used
14157     * @ingroup Cursors
14158     */
14159    EAPI int          elm_cursor_engine_only_get(void);
14160
14161    /**
14162     * Set the configured cursor engine only usage
14163     *
14164     * This sets the globally configured exclusive usage of engine cursors.
14165     * It won't affect cursors set before changing this value.
14166     *
14167     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14168     * look for them on theme before.
14169     * @return EINA_TRUE if value is valid and setted (0 or 1)
14170     * @ingroup Cursors
14171     */
14172    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
14173
14174    /**
14175     * @}
14176     */
14177
14178    /**
14179     * @defgroup Menu Menu
14180     *
14181     * @image html img/widget/menu/preview-00.png
14182     * @image latex img/widget/menu/preview-00.eps
14183     *
14184     * A menu is a list of items displayed above its parent. When the menu is
14185     * showing its parent is darkened. Each item can have a sub-menu. The menu
14186     * object can be used to display a menu on a right click event, in a toolbar,
14187     * anywhere.
14188     *
14189     * Signals that you can add callbacks for are:
14190     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14191     *             event_info is NULL.
14192     *
14193     * @see @ref tutorial_menu
14194     * @{
14195     */
14196    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14197    /**
14198     * @brief Add a new menu to the parent
14199     *
14200     * @param parent The parent object.
14201     * @return The new object or NULL if it cannot be created.
14202     */
14203    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14204    /**
14205     * @brief Set the parent for the given menu widget
14206     *
14207     * @param obj The menu object.
14208     * @param parent The new parent.
14209     */
14210    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14211    /**
14212     * @brief Get the parent for the given menu widget
14213     *
14214     * @param obj The menu object.
14215     * @return The parent.
14216     *
14217     * @see elm_menu_parent_set()
14218     */
14219    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14220    /**
14221     * @brief Move the menu to a new position
14222     *
14223     * @param obj The menu object.
14224     * @param x The new position.
14225     * @param y The new position.
14226     *
14227     * Sets the top-left position of the menu to (@p x,@p y).
14228     *
14229     * @note @p x and @p y coordinates are relative to parent.
14230     */
14231    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14232    /**
14233     * @brief Close a opened menu
14234     *
14235     * @param obj the menu object
14236     * @return void
14237     *
14238     * Hides the menu and all it's sub-menus.
14239     */
14240    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14241    /**
14242     * @brief Returns a list of @p item's items.
14243     *
14244     * @param obj The menu object
14245     * @return An Eina_List* of @p item's items
14246     */
14247    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14248    /**
14249     * @brief Get the Evas_Object of an Elm_Menu_Item
14250     *
14251     * @param item The menu item object.
14252     * @return The edje object containing the swallowed content
14253     *
14254     * @warning Don't manipulate this object!
14255     */
14256    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14257    /**
14258     * @brief Add an item at the end of the given menu widget
14259     *
14260     * @param obj The menu object.
14261     * @param parent The parent menu item (optional)
14262     * @param icon A icon display on the item. The icon will be destryed by the menu.
14263     * @param label The label of the item.
14264     * @param func Function called when the user select the item.
14265     * @param data Data sent by the callback.
14266     * @return Returns the new item.
14267     */
14268    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);
14269    /**
14270     * @brief Add an object swallowed in an item at the end of the given menu
14271     * widget
14272     *
14273     * @param obj The menu object.
14274     * @param parent The parent menu item (optional)
14275     * @param subobj The object to swallow
14276     * @param func Function called when the user select the item.
14277     * @param data Data sent by the callback.
14278     * @return Returns the new item.
14279     *
14280     * Add an evas object as an item to the menu.
14281     */
14282    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);
14283    /**
14284     * @brief Set the label of a menu item
14285     *
14286     * @param item The menu item object.
14287     * @param label The label to set for @p item
14288     *
14289     * @warning Don't use this funcion on items created with
14290     * elm_menu_item_add_object() or elm_menu_item_separator_add().
14291     */
14292    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14293    /**
14294     * @brief Get the label of a menu item
14295     *
14296     * @param item The menu item object.
14297     * @return The label of @p item
14298     */
14299    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14300    /**
14301     * @brief Set the icon of a menu item to the standard icon with name @p icon
14302     *
14303     * @param item The menu item object.
14304     * @param icon The icon object to set for the content of @p item
14305     *
14306     * Once this icon is set, any previously set icon will be deleted.
14307     */
14308    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14309    /**
14310     * @brief Get the string representation from the icon of a menu item
14311     *
14312     * @param item The menu item object.
14313     * @return The string representation of @p item's icon or NULL
14314     *
14315     * @see elm_menu_item_object_icon_name_set()
14316     */
14317    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14318    /**
14319     * @brief Set the content object of a menu item
14320     *
14321     * @param item The menu item object
14322     * @param The content object or NULL
14323     * @return EINA_TRUE on success, else EINA_FALSE
14324     *
14325     * Use this function to change the object swallowed by a menu item, deleting
14326     * any previously swallowed object.
14327     */
14328    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14329    /**
14330     * @brief Get the content object of a menu item
14331     *
14332     * @param item The menu item object
14333     * @return The content object or NULL
14334     * @note If @p item was added with elm_menu_item_add_object, this
14335     * function will return the object passed, else it will return the
14336     * icon object.
14337     *
14338     * @see elm_menu_item_object_content_set()
14339     */
14340    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14341    /**
14342     * @brief Set the selected state of @p item.
14343     *
14344     * @param item The menu item object.
14345     * @param selected The selected/unselected state of the item
14346     */
14347    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14348    /**
14349     * @brief Get the selected state of @p item.
14350     *
14351     * @param item The menu item object.
14352     * @return The selected/unselected state of the item
14353     *
14354     * @see elm_menu_item_selected_set()
14355     */
14356    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14357    /**
14358     * @brief Set the disabled state of @p item.
14359     *
14360     * @param item The menu item object.
14361     * @param disabled The enabled/disabled state of the item
14362     */
14363    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14364    /**
14365     * @brief Get the disabled state of @p item.
14366     *
14367     * @param item The menu item object.
14368     * @return The enabled/disabled state of the item
14369     *
14370     * @see elm_menu_item_disabled_set()
14371     */
14372    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14373    /**
14374     * @brief Add a separator item to menu @p obj under @p parent.
14375     *
14376     * @param obj The menu object
14377     * @param parent The item to add the separator under
14378     * @return The created item or NULL on failure
14379     *
14380     * This is item is a @ref Separator.
14381     */
14382    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14383    /**
14384     * @brief Returns whether @p item is a separator.
14385     *
14386     * @param item The item to check
14387     * @return If true, @p item is a separator
14388     *
14389     * @see elm_menu_item_separator_add()
14390     */
14391    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14392    /**
14393     * @brief Deletes an item from the menu.
14394     *
14395     * @param item The item to delete.
14396     *
14397     * @see elm_menu_item_add()
14398     */
14399    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14400    /**
14401     * @brief Set the function called when a menu item is deleted.
14402     *
14403     * @param item The item to set the callback on
14404     * @param func The function called
14405     *
14406     * @see elm_menu_item_add()
14407     * @see elm_menu_item_del()
14408     */
14409    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14410    /**
14411     * @brief Returns the data associated with menu item @p item.
14412     *
14413     * @param item The item
14414     * @return The data associated with @p item or NULL if none was set.
14415     *
14416     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14417     */
14418    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14419    /**
14420     * @brief Sets the data to be associated with menu item @p item.
14421     *
14422     * @param item The item
14423     * @param data The data to be associated with @p item
14424     */
14425    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14426    /**
14427     * @brief Returns a list of @p item's subitems.
14428     *
14429     * @param item The item
14430     * @return An Eina_List* of @p item's subitems
14431     *
14432     * @see elm_menu_add()
14433     */
14434    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14435    /**
14436     * @brief Get the position of a menu item
14437     *
14438     * @param item The menu item
14439     * @return The item's index
14440     *
14441     * This function returns the index position of a menu item in a menu.
14442     * For a sub-menu, this number is relative to the first item in the sub-menu.
14443     *
14444     * @note Index values begin with 0
14445     */
14446    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14447    /**
14448     * @brief @brief Return a menu item's owner menu
14449     *
14450     * @param item The menu item
14451     * @return The menu object owning @p item, or NULL on failure
14452     *
14453     * Use this function to get the menu object owning an item.
14454     */
14455    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14456    /**
14457     * @brief Get the selected item in the menu
14458     *
14459     * @param obj The menu object
14460     * @return The selected item, or NULL if none
14461     *
14462     * @see elm_menu_item_selected_get()
14463     * @see elm_menu_item_selected_set()
14464     */
14465    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14466    /**
14467     * @brief Get the last item in the menu
14468     *
14469     * @param obj The menu object
14470     * @return The last item, or NULL if none
14471     */
14472    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14473    /**
14474     * @brief Get the first item in the menu
14475     *
14476     * @param obj The menu object
14477     * @return The first item, or NULL if none
14478     */
14479    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14480    /**
14481     * @brief Get the next item in the menu.
14482     *
14483     * @param item The menu item object.
14484     * @return The item after it, or NULL if none
14485     */
14486    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14487    /**
14488     * @brief Get the previous item in the menu.
14489     *
14490     * @param item The menu item object.
14491     * @return The item before it, or NULL if none
14492     */
14493    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14494    /**
14495     * @}
14496     */
14497
14498    /**
14499     * @defgroup List List
14500     * @ingroup Elementary
14501     *
14502     * @image html img/widget/list/preview-00.png
14503     * @image latex img/widget/list/preview-00.eps width=\textwidth
14504     *
14505     * @image html img/list.png
14506     * @image latex img/list.eps width=\textwidth
14507     *
14508     * A list widget is a container whose children are displayed vertically or
14509     * horizontally, in order, and can be selected.
14510     * The list can accept only one or multiple items selection. Also has many
14511     * modes of items displaying.
14512     *
14513     * A list is a very simple type of list widget.  For more robust
14514     * lists, @ref Genlist should probably be used.
14515     *
14516     * Smart callbacks one can listen to:
14517     * - @c "activated" - The user has double-clicked or pressed
14518     *   (enter|return|spacebar) on an item. The @c event_info parameter
14519     *   is the item that was activated.
14520     * - @c "clicked,double" - The user has double-clicked an item.
14521     *   The @c event_info parameter is the item that was double-clicked.
14522     * - "selected" - when the user selected an item
14523     * - "unselected" - when the user unselected an item
14524     * - "longpressed" - an item in the list is long-pressed
14525     * - "scroll,edge,top" - the list is scrolled until the top edge
14526     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14527     * - "scroll,edge,left" - the list is scrolled until the left edge
14528     * - "scroll,edge,right" - the list is scrolled until the right edge
14529     *
14530     * Available styles for it:
14531     * - @c "default"
14532     *
14533     * List of examples:
14534     * @li @ref list_example_01
14535     * @li @ref list_example_02
14536     * @li @ref list_example_03
14537     */
14538
14539    /**
14540     * @addtogroup List
14541     * @{
14542     */
14543
14544    /**
14545     * @enum _Elm_List_Mode
14546     * @typedef Elm_List_Mode
14547     *
14548     * Set list's resize behavior, transverse axis scroll and
14549     * items cropping. See each mode's description for more details.
14550     *
14551     * @note Default value is #ELM_LIST_SCROLL.
14552     *
14553     * Values <b> don't </b> work as bitmask, only one can be choosen.
14554     *
14555     * @see elm_list_mode_set()
14556     * @see elm_list_mode_get()
14557     *
14558     * @ingroup List
14559     */
14560    typedef enum _Elm_List_Mode
14561      {
14562         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. */
14563         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). */
14564         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. */
14565         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. */
14566         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14567      } Elm_List_Mode;
14568
14569    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().  */
14570
14571    /**
14572     * Add a new list widget to the given parent Elementary
14573     * (container) object.
14574     *
14575     * @param parent The parent object.
14576     * @return a new list widget handle or @c NULL, on errors.
14577     *
14578     * This function inserts a new list widget on the canvas.
14579     *
14580     * @ingroup List
14581     */
14582    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14583
14584    /**
14585     * Starts the list.
14586     *
14587     * @param obj The list object
14588     *
14589     * @note Call before running show() on the list object.
14590     * @warning If not called, it won't display the list properly.
14591     *
14592     * @code
14593     * li = elm_list_add(win);
14594     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14595     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14596     * elm_list_go(li);
14597     * evas_object_show(li);
14598     * @endcode
14599     *
14600     * @ingroup List
14601     */
14602    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14603
14604    /**
14605     * Enable or disable multiple items selection on the list object.
14606     *
14607     * @param obj The list object
14608     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14609     * disable it.
14610     *
14611     * Disabled by default. If disabled, the user can select a single item of
14612     * the list each time. Selected items are highlighted on list.
14613     * If enabled, many items can be selected.
14614     *
14615     * If a selected item is selected again, it will be unselected.
14616     *
14617     * @see elm_list_multi_select_get()
14618     *
14619     * @ingroup List
14620     */
14621    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14622
14623    /**
14624     * Get a value whether multiple items selection is enabled or not.
14625     *
14626     * @see elm_list_multi_select_set() for details.
14627     *
14628     * @param obj The list object.
14629     * @return @c EINA_TRUE means multiple items selection is enabled.
14630     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14631     * @c EINA_FALSE is returned.
14632     *
14633     * @ingroup List
14634     */
14635    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14636
14637    /**
14638     * Set which mode to use for the list object.
14639     *
14640     * @param obj The list object
14641     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14642     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14643     *
14644     * Set list's resize behavior, transverse axis scroll and
14645     * items cropping. See each mode's description for more details.
14646     *
14647     * @note Default value is #ELM_LIST_SCROLL.
14648     *
14649     * Only one can be set, if a previous one was set, it will be changed
14650     * by the new mode set. Bitmask won't work as well.
14651     *
14652     * @see elm_list_mode_get()
14653     *
14654     * @ingroup List
14655     */
14656    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14657
14658    /**
14659     * Get the mode the list is at.
14660     *
14661     * @param obj The list object
14662     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14663     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14664     *
14665     * @note see elm_list_mode_set() for more information.
14666     *
14667     * @ingroup List
14668     */
14669    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14670
14671    /**
14672     * Enable or disable horizontal mode on the list object.
14673     *
14674     * @param obj The list object.
14675     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14676     * disable it, i.e., to enable vertical mode.
14677     *
14678     * @note Vertical mode is set by default.
14679     *
14680     * On horizontal mode items are displayed on list from left to right,
14681     * instead of from top to bottom. Also, the list will scroll horizontally.
14682     * Each item will presents left icon on top and right icon, or end, at
14683     * the bottom.
14684     *
14685     * @see elm_list_horizontal_get()
14686     *
14687     * @ingroup List
14688     */
14689    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14690
14691    /**
14692     * Get a value whether horizontal mode is enabled or not.
14693     *
14694     * @param obj The list object.
14695     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14696     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14697     * @c EINA_FALSE is returned.
14698     *
14699     * @see elm_list_horizontal_set() for details.
14700     *
14701     * @ingroup List
14702     */
14703    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14704
14705    /**
14706     * Enable or disable always select mode on the list object.
14707     *
14708     * @param obj The list object
14709     * @param always_select @c EINA_TRUE to enable always select mode or
14710     * @c EINA_FALSE to disable it.
14711     *
14712     * @note Always select mode is disabled by default.
14713     *
14714     * Default behavior of list items is to only call its callback function
14715     * the first time it's pressed, i.e., when it is selected. If a selected
14716     * item is pressed again, and multi-select is disabled, it won't call
14717     * this function (if multi-select is enabled it will unselect the item).
14718     *
14719     * If always select is enabled, it will call the callback function
14720     * everytime a item is pressed, so it will call when the item is selected,
14721     * and again when a selected item is pressed.
14722     *
14723     * @see elm_list_always_select_mode_get()
14724     * @see elm_list_multi_select_set()
14725     *
14726     * @ingroup List
14727     */
14728    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14729
14730    /**
14731     * Get a value whether always select mode is enabled or not, meaning that
14732     * an item will always call its callback function, even if already selected.
14733     *
14734     * @param obj The list object
14735     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14736     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14737     * @c EINA_FALSE is returned.
14738     *
14739     * @see elm_list_always_select_mode_set() for details.
14740     *
14741     * @ingroup List
14742     */
14743    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14744
14745    /**
14746     * Set bouncing behaviour when the scrolled content reaches an edge.
14747     *
14748     * Tell the internal scroller object whether it should bounce or not
14749     * when it reaches the respective edges for each axis.
14750     *
14751     * @param obj The list object
14752     * @param h_bounce Whether to bounce or not in the horizontal axis.
14753     * @param v_bounce Whether to bounce or not in the vertical axis.
14754     *
14755     * @see elm_scroller_bounce_set()
14756     *
14757     * @ingroup List
14758     */
14759    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14760
14761    /**
14762     * Get the bouncing behaviour of the internal scroller.
14763     *
14764     * Get whether the internal scroller should bounce when the edge of each
14765     * axis is reached scrolling.
14766     *
14767     * @param obj The list object.
14768     * @param h_bounce Pointer where to store the bounce state of the horizontal
14769     * axis.
14770     * @param v_bounce Pointer where to store the bounce state of the vertical
14771     * axis.
14772     *
14773     * @see elm_scroller_bounce_get()
14774     * @see elm_list_bounce_set()
14775     *
14776     * @ingroup List
14777     */
14778    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14779
14780    /**
14781     * Set the scrollbar policy.
14782     *
14783     * @param obj The list object
14784     * @param policy_h Horizontal scrollbar policy.
14785     * @param policy_v Vertical scrollbar policy.
14786     *
14787     * This sets the scrollbar visibility policy for the given scroller.
14788     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14789     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14790     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14791     * This applies respectively for the horizontal and vertical scrollbars.
14792     *
14793     * The both are disabled by default, i.e., are set to
14794     * #ELM_SCROLLER_POLICY_OFF.
14795     *
14796     * @ingroup List
14797     */
14798    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14799
14800    /**
14801     * Get the scrollbar policy.
14802     *
14803     * @see elm_list_scroller_policy_get() for details.
14804     *
14805     * @param obj The list object.
14806     * @param policy_h Pointer where to store horizontal scrollbar policy.
14807     * @param policy_v Pointer where to store vertical scrollbar policy.
14808     *
14809     * @ingroup List
14810     */
14811    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);
14812
14813    /**
14814     * Append a new item to the list object.
14815     *
14816     * @param obj The list object.
14817     * @param label The label of the list item.
14818     * @param icon The icon object to use for the left side of the item. An
14819     * icon can be any Evas object, but usually it is an icon created
14820     * with elm_icon_add().
14821     * @param end The icon object to use for the right side of the item. An
14822     * icon can be any Evas object.
14823     * @param func The function to call when the item is clicked.
14824     * @param data The data to associate with the item for related callbacks.
14825     *
14826     * @return The created item or @c NULL upon failure.
14827     *
14828     * A new item will be created and appended to the list, i.e., will
14829     * be set as @b last item.
14830     *
14831     * Items created with this method can be deleted with
14832     * elm_list_item_del().
14833     *
14834     * Associated @p data can be properly freed when item is deleted if a
14835     * callback function is set with elm_list_item_del_cb_set().
14836     *
14837     * If a function is passed as argument, it will be called everytime this item
14838     * is selected, i.e., the user clicks over an unselected item.
14839     * If always select is enabled it will call this function every time
14840     * user clicks over an item (already selected or not).
14841     * If such function isn't needed, just passing
14842     * @c NULL as @p func is enough. The same should be done for @p data.
14843     *
14844     * Simple example (with no function callback or data associated):
14845     * @code
14846     * li = elm_list_add(win);
14847     * ic = elm_icon_add(win);
14848     * elm_icon_file_set(ic, "path/to/image", NULL);
14849     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14850     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14851     * elm_list_go(li);
14852     * evas_object_show(li);
14853     * @endcode
14854     *
14855     * @see elm_list_always_select_mode_set()
14856     * @see elm_list_item_del()
14857     * @see elm_list_item_del_cb_set()
14858     * @see elm_list_clear()
14859     * @see elm_icon_add()
14860     *
14861     * @ingroup List
14862     */
14863    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);
14864
14865    /**
14866     * Prepend a new item to the list object.
14867     *
14868     * @param obj The list object.
14869     * @param label The label of the list item.
14870     * @param icon The icon object to use for the left side of the item. An
14871     * icon can be any Evas object, but usually it is an icon created
14872     * with elm_icon_add().
14873     * @param end The icon object to use for the right side of the item. An
14874     * icon can be any Evas object.
14875     * @param func The function to call when the item is clicked.
14876     * @param data The data to associate with the item for related callbacks.
14877     *
14878     * @return The created item or @c NULL upon failure.
14879     *
14880     * A new item will be created and prepended to the list, i.e., will
14881     * be set as @b first item.
14882     *
14883     * Items created with this method can be deleted with
14884     * elm_list_item_del().
14885     *
14886     * Associated @p data can be properly freed when item is deleted if a
14887     * callback function is set with elm_list_item_del_cb_set().
14888     *
14889     * If a function is passed as argument, it will be called everytime this item
14890     * is selected, i.e., the user clicks over an unselected item.
14891     * If always select is enabled it will call this function every time
14892     * user clicks over an item (already selected or not).
14893     * If such function isn't needed, just passing
14894     * @c NULL as @p func is enough. The same should be done for @p data.
14895     *
14896     * @see elm_list_item_append() for a simple code example.
14897     * @see elm_list_always_select_mode_set()
14898     * @see elm_list_item_del()
14899     * @see elm_list_item_del_cb_set()
14900     * @see elm_list_clear()
14901     * @see elm_icon_add()
14902     *
14903     * @ingroup List
14904     */
14905    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);
14906
14907    /**
14908     * Insert a new item into the list object before item @p before.
14909     *
14910     * @param obj The list object.
14911     * @param before The list item to insert before.
14912     * @param label The label of the list item.
14913     * @param icon The icon object to use for the left side of the item. An
14914     * icon can be any Evas object, but usually it is an icon created
14915     * with elm_icon_add().
14916     * @param end The icon object to use for the right side of the item. An
14917     * icon can be any Evas object.
14918     * @param func The function to call when the item is clicked.
14919     * @param data The data to associate with the item for related callbacks.
14920     *
14921     * @return The created item or @c NULL upon failure.
14922     *
14923     * A new item will be created and added to the list. Its position in
14924     * this list will be just before item @p before.
14925     *
14926     * Items created with this method can be deleted with
14927     * elm_list_item_del().
14928     *
14929     * Associated @p data can be properly freed when item is deleted if a
14930     * callback function is set with elm_list_item_del_cb_set().
14931     *
14932     * If a function is passed as argument, it will be called everytime this item
14933     * is selected, i.e., the user clicks over an unselected item.
14934     * If always select is enabled it will call this function every time
14935     * user clicks over an item (already selected or not).
14936     * If such function isn't needed, just passing
14937     * @c NULL as @p func is enough. The same should be done for @p data.
14938     *
14939     * @see elm_list_item_append() for a simple code example.
14940     * @see elm_list_always_select_mode_set()
14941     * @see elm_list_item_del()
14942     * @see elm_list_item_del_cb_set()
14943     * @see elm_list_clear()
14944     * @see elm_icon_add()
14945     *
14946     * @ingroup List
14947     */
14948    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);
14949
14950    /**
14951     * Insert a new item into the list object after item @p after.
14952     *
14953     * @param obj The list object.
14954     * @param after The list item to insert after.
14955     * @param label The label of the list item.
14956     * @param icon The icon object to use for the left side of the item. An
14957     * icon can be any Evas object, but usually it is an icon created
14958     * with elm_icon_add().
14959     * @param end The icon object to use for the right side of the item. An
14960     * icon can be any Evas object.
14961     * @param func The function to call when the item is clicked.
14962     * @param data The data to associate with the item for related callbacks.
14963     *
14964     * @return The created item or @c NULL upon failure.
14965     *
14966     * A new item will be created and added to the list. Its position in
14967     * this list will be just after item @p after.
14968     *
14969     * Items created with this method can be deleted with
14970     * elm_list_item_del().
14971     *
14972     * Associated @p data can be properly freed when item is deleted if a
14973     * callback function is set with elm_list_item_del_cb_set().
14974     *
14975     * If a function is passed as argument, it will be called everytime this item
14976     * is selected, i.e., the user clicks over an unselected item.
14977     * If always select is enabled it will call this function every time
14978     * user clicks over an item (already selected or not).
14979     * If such function isn't needed, just passing
14980     * @c NULL as @p func is enough. The same should be done for @p data.
14981     *
14982     * @see elm_list_item_append() for a simple code example.
14983     * @see elm_list_always_select_mode_set()
14984     * @see elm_list_item_del()
14985     * @see elm_list_item_del_cb_set()
14986     * @see elm_list_clear()
14987     * @see elm_icon_add()
14988     *
14989     * @ingroup List
14990     */
14991    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);
14992
14993    /**
14994     * Insert a new item into the sorted list object.
14995     *
14996     * @param obj The list object.
14997     * @param label The label of the list item.
14998     * @param icon The icon object to use for the left side of the item. An
14999     * icon can be any Evas object, but usually it is an icon created
15000     * with elm_icon_add().
15001     * @param end The icon object to use for the right side of the item. An
15002     * icon can be any Evas object.
15003     * @param func The function to call when the item is clicked.
15004     * @param data The data to associate with the item for related callbacks.
15005     * @param cmp_func The comparing function to be used to sort list
15006     * items <b>by #Elm_List_Item item handles</b>. This function will
15007     * receive two items and compare them, returning a non-negative integer
15008     * if the second item should be place after the first, or negative value
15009     * if should be placed before.
15010     *
15011     * @return The created item or @c NULL upon failure.
15012     *
15013     * @note This function inserts values into a list object assuming it was
15014     * sorted and the result will be sorted.
15015     *
15016     * A new item will be created and added to the list. Its position in
15017     * this list will be found comparing the new item with previously inserted
15018     * items using function @p cmp_func.
15019     *
15020     * Items created with this method can be deleted with
15021     * elm_list_item_del().
15022     *
15023     * Associated @p data can be properly freed when item is deleted if a
15024     * callback function is set with elm_list_item_del_cb_set().
15025     *
15026     * If a function is passed as argument, it will be called everytime this item
15027     * is selected, i.e., the user clicks over an unselected item.
15028     * If always select is enabled it will call this function every time
15029     * user clicks over an item (already selected or not).
15030     * If such function isn't needed, just passing
15031     * @c NULL as @p func is enough. The same should be done for @p data.
15032     *
15033     * @see elm_list_item_append() for a simple code example.
15034     * @see elm_list_always_select_mode_set()
15035     * @see elm_list_item_del()
15036     * @see elm_list_item_del_cb_set()
15037     * @see elm_list_clear()
15038     * @see elm_icon_add()
15039     *
15040     * @ingroup List
15041     */
15042    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);
15043
15044    /**
15045     * Remove all list's items.
15046     *
15047     * @param obj The list object
15048     *
15049     * @see elm_list_item_del()
15050     * @see elm_list_item_append()
15051     *
15052     * @ingroup List
15053     */
15054    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15055
15056    /**
15057     * Get a list of all the list items.
15058     *
15059     * @param obj The list object
15060     * @return An @c Eina_List of list items, #Elm_List_Item,
15061     * or @c NULL on failure.
15062     *
15063     * @see elm_list_item_append()
15064     * @see elm_list_item_del()
15065     * @see elm_list_clear()
15066     *
15067     * @ingroup List
15068     */
15069    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15070
15071    /**
15072     * Get the selected item.
15073     *
15074     * @param obj The list object.
15075     * @return The selected list item.
15076     *
15077     * The selected item can be unselected with function
15078     * elm_list_item_selected_set().
15079     *
15080     * The selected item always will be highlighted on list.
15081     *
15082     * @see elm_list_selected_items_get()
15083     *
15084     * @ingroup List
15085     */
15086    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15087
15088    /**
15089     * Return a list of the currently selected list items.
15090     *
15091     * @param obj The list object.
15092     * @return An @c Eina_List of list items, #Elm_List_Item,
15093     * or @c NULL on failure.
15094     *
15095     * Multiple items can be selected if multi select is enabled. It can be
15096     * done with elm_list_multi_select_set().
15097     *
15098     * @see elm_list_selected_item_get()
15099     * @see elm_list_multi_select_set()
15100     *
15101     * @ingroup List
15102     */
15103    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15104
15105    /**
15106     * Set the selected state of an item.
15107     *
15108     * @param item The list item
15109     * @param selected The selected state
15110     *
15111     * This sets the selected state of the given item @p it.
15112     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15113     *
15114     * If a new item is selected the previosly selected will be unselected,
15115     * unless multiple selection is enabled with elm_list_multi_select_set().
15116     * Previoulsy selected item can be get with function
15117     * elm_list_selected_item_get().
15118     *
15119     * Selected items will be highlighted.
15120     *
15121     * @see elm_list_item_selected_get()
15122     * @see elm_list_selected_item_get()
15123     * @see elm_list_multi_select_set()
15124     *
15125     * @ingroup List
15126     */
15127    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15128
15129    /*
15130     * Get whether the @p item is selected or not.
15131     *
15132     * @param item The list item.
15133     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15134     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15135     *
15136     * @see elm_list_selected_item_set() for details.
15137     * @see elm_list_item_selected_get()
15138     *
15139     * @ingroup List
15140     */
15141    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15142
15143    /**
15144     * Set or unset item as a separator.
15145     *
15146     * @param it The list item.
15147     * @param setting @c EINA_TRUE to set item @p it as separator or
15148     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15149     *
15150     * Items aren't set as separator by default.
15151     *
15152     * If set as separator it will display separator theme, so won't display
15153     * icons or label.
15154     *
15155     * @see elm_list_item_separator_get()
15156     *
15157     * @ingroup List
15158     */
15159    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15160
15161    /**
15162     * Get a value whether item is a separator or not.
15163     *
15164     * @see elm_list_item_separator_set() for details.
15165     *
15166     * @param it The list item.
15167     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15168     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15169     *
15170     * @ingroup List
15171     */
15172    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15173
15174    /**
15175     * Show @p item in the list view.
15176     *
15177     * @param item The list item to be shown.
15178     *
15179     * It won't animate list until item is visible. If such behavior is wanted,
15180     * use elm_list_bring_in() intead.
15181     *
15182     * @ingroup List
15183     */
15184    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15185
15186    /**
15187     * Bring in the given item to list view.
15188     *
15189     * @param item The item.
15190     *
15191     * This causes list to jump to the given item @p item and show it
15192     * (by scrolling), if it is not fully visible.
15193     *
15194     * This may use animation to do so and take a period of time.
15195     *
15196     * If animation isn't wanted, elm_list_item_show() can be used.
15197     *
15198     * @ingroup List
15199     */
15200    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15201
15202    /**
15203     * Delete them item from the list.
15204     *
15205     * @param item The item of list to be deleted.
15206     *
15207     * If deleting all list items is required, elm_list_clear()
15208     * should be used instead of getting items list and deleting each one.
15209     *
15210     * @see elm_list_clear()
15211     * @see elm_list_item_append()
15212     * @see elm_list_item_del_cb_set()
15213     *
15214     * @ingroup List
15215     */
15216    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15217
15218    /**
15219     * Set the function called when a list item is freed.
15220     *
15221     * @param item The item to set the callback on
15222     * @param func The function called
15223     *
15224     * If there is a @p func, then it will be called prior item's memory release.
15225     * That will be called with the following arguments:
15226     * @li item's data;
15227     * @li item's Evas object;
15228     * @li item itself;
15229     *
15230     * This way, a data associated to a list item could be properly freed.
15231     *
15232     * @ingroup List
15233     */
15234    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15235
15236    /**
15237     * Get the data associated to the item.
15238     *
15239     * @param item The list item
15240     * @return The data associated to @p item
15241     *
15242     * The return value is a pointer to data associated to @p item when it was
15243     * created, with function elm_list_item_append() or similar. If no data
15244     * was passed as argument, it will return @c NULL.
15245     *
15246     * @see elm_list_item_append()
15247     *
15248     * @ingroup List
15249     */
15250    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15251
15252    /**
15253     * Get the left side icon associated to the item.
15254     *
15255     * @param item The list item
15256     * @return The left side icon associated to @p item
15257     *
15258     * The return value is a pointer to the icon associated to @p item when
15259     * it was
15260     * created, with function elm_list_item_append() or similar, or later
15261     * with function elm_list_item_icon_set(). If no icon
15262     * was passed as argument, it will return @c NULL.
15263     *
15264     * @see elm_list_item_append()
15265     * @see elm_list_item_icon_set()
15266     *
15267     * @ingroup List
15268     */
15269    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15270
15271    /**
15272     * Set the left side icon associated to the item.
15273     *
15274     * @param item The list item
15275     * @param icon The left side icon object to associate with @p item
15276     *
15277     * The icon object to use at left side of the item. An
15278     * icon can be any Evas object, but usually it is an icon created
15279     * with elm_icon_add().
15280     *
15281     * Once the icon object is set, a previously set one will be deleted.
15282     * @warning Setting the same icon for two items will cause the icon to
15283     * dissapear from the first item.
15284     *
15285     * If an icon was passed as argument on item creation, with function
15286     * elm_list_item_append() or similar, it will be already
15287     * associated to the item.
15288     *
15289     * @see elm_list_item_append()
15290     * @see elm_list_item_icon_get()
15291     *
15292     * @ingroup List
15293     */
15294    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15295
15296    /**
15297     * Get the right side icon associated to the item.
15298     *
15299     * @param item The list item
15300     * @return The right side icon associated to @p item
15301     *
15302     * The return value is a pointer to the icon associated to @p item when
15303     * it was
15304     * created, with function elm_list_item_append() or similar, or later
15305     * with function elm_list_item_icon_set(). If no icon
15306     * was passed as argument, it will return @c NULL.
15307     *
15308     * @see elm_list_item_append()
15309     * @see elm_list_item_icon_set()
15310     *
15311     * @ingroup List
15312     */
15313    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15314
15315    /**
15316     * Set the right side icon associated to the item.
15317     *
15318     * @param item The list item
15319     * @param end The right side icon object to associate with @p item
15320     *
15321     * The icon object to use at right side of the item. An
15322     * icon can be any Evas object, but usually it is an icon created
15323     * with elm_icon_add().
15324     *
15325     * Once the icon object is set, a previously set one will be deleted.
15326     * @warning Setting the same icon for two items will cause the icon to
15327     * dissapear from the first item.
15328     *
15329     * If an icon was passed as argument on item creation, with function
15330     * elm_list_item_append() or similar, it will be already
15331     * associated to the item.
15332     *
15333     * @see elm_list_item_append()
15334     * @see elm_list_item_end_get()
15335     *
15336     * @ingroup List
15337     */
15338    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15339
15340    /**
15341     * Gets the base object of the item.
15342     *
15343     * @param item The list item
15344     * @return The base object associated with @p item
15345     *
15346     * Base object is the @c Evas_Object that represents that item.
15347     *
15348     * @ingroup List
15349     */
15350    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15351
15352    /**
15353     * Get the label of item.
15354     *
15355     * @param item The item of list.
15356     * @return The label of item.
15357     *
15358     * The return value is a pointer to the label associated to @p item when
15359     * it was created, with function elm_list_item_append(), or later
15360     * with function elm_list_item_label_set. If no label
15361     * was passed as argument, it will return @c NULL.
15362     *
15363     * @see elm_list_item_label_set() for more details.
15364     * @see elm_list_item_append()
15365     *
15366     * @ingroup List
15367     */
15368    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15369
15370    /**
15371     * Set the label of item.
15372     *
15373     * @param item The item of list.
15374     * @param text The label of item.
15375     *
15376     * The label to be displayed by the item.
15377     * Label will be placed between left and right side icons (if set).
15378     *
15379     * If a label was passed as argument on item creation, with function
15380     * elm_list_item_append() or similar, it will be already
15381     * displayed by the item.
15382     *
15383     * @see elm_list_item_label_get()
15384     * @see elm_list_item_append()
15385     *
15386     * @ingroup List
15387     */
15388    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15389
15390
15391    /**
15392     * Get the item before @p it in list.
15393     *
15394     * @param it The list item.
15395     * @return The item before @p it, or @c NULL if none or on failure.
15396     *
15397     * @note If it is the first item, @c NULL will be returned.
15398     *
15399     * @see elm_list_item_append()
15400     * @see elm_list_items_get()
15401     *
15402     * @ingroup List
15403     */
15404    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15405
15406    /**
15407     * Get the item after @p it in list.
15408     *
15409     * @param it The list item.
15410     * @return The item after @p it, or @c NULL if none or on failure.
15411     *
15412     * @note If it is the last item, @c NULL will be returned.
15413     *
15414     * @see elm_list_item_append()
15415     * @see elm_list_items_get()
15416     *
15417     * @ingroup List
15418     */
15419    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15420
15421    /**
15422     * Sets the disabled/enabled state of a list item.
15423     *
15424     * @param it The item.
15425     * @param disabled The disabled state.
15426     *
15427     * A disabled item cannot be selected or unselected. It will also
15428     * change its appearance (generally greyed out). This sets the
15429     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15430     * enabled).
15431     *
15432     * @ingroup List
15433     */
15434    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15435
15436    /**
15437     * Get a value whether list item is disabled or not.
15438     *
15439     * @param it The item.
15440     * @return The disabled state.
15441     *
15442     * @see elm_list_item_disabled_set() for more details.
15443     *
15444     * @ingroup List
15445     */
15446    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15447
15448    /**
15449     * Set the text to be shown in a given list item's tooltips.
15450     *
15451     * @param item Target item.
15452     * @param text The text to set in the content.
15453     *
15454     * Setup the text as tooltip to object. The item can have only one tooltip,
15455     * so any previous tooltip data - set with this function or
15456     * elm_list_item_tooltip_content_cb_set() - is removed.
15457     *
15458     * @see elm_object_tooltip_text_set() for more details.
15459     *
15460     * @ingroup List
15461     */
15462    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15463
15464
15465    /**
15466     * @brief Disable size restrictions on an object's tooltip
15467     * @param item The tooltip's anchor object
15468     * @param disable If EINA_TRUE, size restrictions are disabled
15469     * @return EINA_FALSE on failure, EINA_TRUE on success
15470     *
15471     * This function allows a tooltip to expand beyond its parant window's canvas.
15472     * It will instead be limited only by the size of the display.
15473     */
15474    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15475    /**
15476     * @brief Retrieve size restriction state of an object's tooltip
15477     * @param obj The tooltip's anchor object
15478     * @return If EINA_TRUE, size restrictions are disabled
15479     *
15480     * This function returns whether a tooltip is allowed to expand beyond
15481     * its parant window's canvas.
15482     * It will instead be limited only by the size of the display.
15483     */
15484    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15485
15486    /**
15487     * Set the content to be shown in the tooltip item.
15488     *
15489     * Setup the tooltip to item. The item can have only one tooltip,
15490     * so any previous tooltip data is removed. @p func(with @p data) will
15491     * be called every time that need show the tooltip and it should
15492     * return a valid Evas_Object. This object is then managed fully by
15493     * tooltip system and is deleted when the tooltip is gone.
15494     *
15495     * @param item the list item being attached a tooltip.
15496     * @param func the function used to create the tooltip contents.
15497     * @param data what to provide to @a func as callback data/context.
15498     * @param del_cb called when data is not needed anymore, either when
15499     *        another callback replaces @a func, the tooltip is unset with
15500     *        elm_list_item_tooltip_unset() or the owner @a item
15501     *        dies. This callback receives as the first parameter the
15502     *        given @a data, and @c event_info is the item.
15503     *
15504     * @see elm_object_tooltip_content_cb_set() for more details.
15505     *
15506     * @ingroup List
15507     */
15508    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);
15509
15510    /**
15511     * Unset tooltip from item.
15512     *
15513     * @param item list item to remove previously set tooltip.
15514     *
15515     * Remove tooltip from item. The callback provided as del_cb to
15516     * elm_list_item_tooltip_content_cb_set() will be called to notify
15517     * it is not used anymore.
15518     *
15519     * @see elm_object_tooltip_unset() for more details.
15520     * @see elm_list_item_tooltip_content_cb_set()
15521     *
15522     * @ingroup List
15523     */
15524    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15525
15526    /**
15527     * Sets a different style for this item tooltip.
15528     *
15529     * @note before you set a style you should define a tooltip with
15530     *       elm_list_item_tooltip_content_cb_set() or
15531     *       elm_list_item_tooltip_text_set()
15532     *
15533     * @param item list item with tooltip already set.
15534     * @param style the theme style to use (default, transparent, ...)
15535     *
15536     * @see elm_object_tooltip_style_set() for more details.
15537     *
15538     * @ingroup List
15539     */
15540    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15541
15542    /**
15543     * Get the style for this item tooltip.
15544     *
15545     * @param item list item with tooltip already set.
15546     * @return style the theme style in use, defaults to "default". If the
15547     *         object does not have a tooltip set, then NULL is returned.
15548     *
15549     * @see elm_object_tooltip_style_get() for more details.
15550     * @see elm_list_item_tooltip_style_set()
15551     *
15552     * @ingroup List
15553     */
15554    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15555
15556    /**
15557     * Set the type of mouse pointer/cursor decoration to be shown,
15558     * when the mouse pointer is over the given list widget item
15559     *
15560     * @param item list item to customize cursor on
15561     * @param cursor the cursor type's name
15562     *
15563     * This function works analogously as elm_object_cursor_set(), but
15564     * here the cursor's changing area is restricted to the item's
15565     * area, and not the whole widget's. Note that that item cursors
15566     * have precedence over widget cursors, so that a mouse over an
15567     * item with custom cursor set will always show @b that cursor.
15568     *
15569     * If this function is called twice for an object, a previously set
15570     * cursor will be unset on the second call.
15571     *
15572     * @see elm_object_cursor_set()
15573     * @see elm_list_item_cursor_get()
15574     * @see elm_list_item_cursor_unset()
15575     *
15576     * @ingroup List
15577     */
15578    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15579
15580    /*
15581     * Get the type of mouse pointer/cursor decoration set to be shown,
15582     * when the mouse pointer is over the given list widget item
15583     *
15584     * @param item list item with custom cursor set
15585     * @return the cursor type's name or @c NULL, if no custom cursors
15586     * were set to @p item (and on errors)
15587     *
15588     * @see elm_object_cursor_get()
15589     * @see elm_list_item_cursor_set()
15590     * @see elm_list_item_cursor_unset()
15591     *
15592     * @ingroup List
15593     */
15594    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15595
15596    /**
15597     * Unset any custom mouse pointer/cursor decoration set to be
15598     * shown, when the mouse pointer is over the given list widget
15599     * item, thus making it show the @b default cursor again.
15600     *
15601     * @param item a list item
15602     *
15603     * Use this call to undo any custom settings on this item's cursor
15604     * decoration, bringing it back to defaults (no custom style set).
15605     *
15606     * @see elm_object_cursor_unset()
15607     * @see elm_list_item_cursor_set()
15608     *
15609     * @ingroup List
15610     */
15611    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15612
15613    /**
15614     * Set a different @b style for a given custom cursor set for a
15615     * list item.
15616     *
15617     * @param item list item with custom cursor set
15618     * @param style the <b>theme style</b> to use (e.g. @c "default",
15619     * @c "transparent", etc)
15620     *
15621     * This function only makes sense when one is using custom mouse
15622     * cursor decorations <b>defined in a theme file</b>, which can have,
15623     * given a cursor name/type, <b>alternate styles</b> on it. It
15624     * works analogously as elm_object_cursor_style_set(), but here
15625     * applyed only to list item objects.
15626     *
15627     * @warning Before you set a cursor style you should have definen a
15628     *       custom cursor previously on the item, with
15629     *       elm_list_item_cursor_set()
15630     *
15631     * @see elm_list_item_cursor_engine_only_set()
15632     * @see elm_list_item_cursor_style_get()
15633     *
15634     * @ingroup List
15635     */
15636    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15637
15638    /**
15639     * Get the current @b style set for a given list item's custom
15640     * cursor
15641     *
15642     * @param item list item with custom cursor set.
15643     * @return style the cursor style in use. If the object does not
15644     *         have a cursor set, then @c NULL is returned.
15645     *
15646     * @see elm_list_item_cursor_style_set() for more details
15647     *
15648     * @ingroup List
15649     */
15650    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15651
15652    /**
15653     * Set if the (custom)cursor for a given list item should be
15654     * searched in its theme, also, or should only rely on the
15655     * rendering engine.
15656     *
15657     * @param item item with custom (custom) cursor already set on
15658     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15659     * only on those provided by the rendering engine, @c EINA_FALSE to
15660     * have them searched on the widget's theme, as well.
15661     *
15662     * @note This call is of use only if you've set a custom cursor
15663     * for list items, with elm_list_item_cursor_set().
15664     *
15665     * @note By default, cursors will only be looked for between those
15666     * provided by the rendering engine.
15667     *
15668     * @ingroup List
15669     */
15670    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15671
15672    /**
15673     * Get if the (custom) cursor for a given list item is being
15674     * searched in its theme, also, or is only relying on the rendering
15675     * engine.
15676     *
15677     * @param item a list item
15678     * @return @c EINA_TRUE, if cursors are being looked for only on
15679     * those provided by the rendering engine, @c EINA_FALSE if they
15680     * are being searched on the widget's theme, as well.
15681     *
15682     * @see elm_list_item_cursor_engine_only_set(), for more details
15683     *
15684     * @ingroup List
15685     */
15686    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15687
15688    /**
15689     * @}
15690     */
15691
15692    /**
15693     * @defgroup Slider Slider
15694     * @ingroup Elementary
15695     *
15696     * @image html img/widget/slider/preview-00.png
15697     * @image latex img/widget/slider/preview-00.eps width=\textwidth
15698     *
15699     * The slider adds a dragable “slider” widget for selecting the value of
15700     * something within a range.
15701     *
15702     * A slider can be horizontal or vertical. It can contain an Icon and has a
15703     * primary label as well as a units label (that is formatted with floating
15704     * point values and thus accepts a printf-style format string, like
15705     * “%1.2f units”. There is also an indicator string that may be somewhere
15706     * else (like on the slider itself) that also accepts a format string like
15707     * units. Label, Icon Unit and Indicator strings/objects are optional.
15708     *
15709     * A slider may be inverted which means values invert, with high vales being
15710     * on the left or top and low values on the right or bottom (as opposed to
15711     * normally being low on the left or top and high on the bottom and right).
15712     *
15713     * The slider should have its minimum and maximum values set by the
15714     * application with  elm_slider_min_max_set() and value should also be set by
15715     * the application before use with  elm_slider_value_set(). The span of the
15716     * slider is its length (horizontally or vertically). This will be scaled by
15717     * the object or applications scaling factor. At any point code can query the
15718     * slider for its value with elm_slider_value_get().
15719     *
15720     * Smart callbacks one can listen to:
15721     * - "changed" - Whenever the slider value is changed by the user.
15722     * - "slider,drag,start" - dragging the slider indicator around has started.
15723     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15724     * - "delay,changed" - A short time after the value is changed by the user.
15725     * This will be called only when the user stops dragging for
15726     * a very short period or when they release their
15727     * finger/mouse, so it avoids possibly expensive reactions to
15728     * the value change.
15729     *
15730     * Available styles for it:
15731     * - @c "default"
15732     *
15733     * Here is an example on its usage:
15734     * @li @ref slider_example
15735     */
15736
15737    /**
15738     * @addtogroup Slider
15739     * @{
15740     */
15741
15742    /**
15743     * Add a new slider widget to the given parent Elementary
15744     * (container) object.
15745     *
15746     * @param parent The parent object.
15747     * @return a new slider widget handle or @c NULL, on errors.
15748     *
15749     * This function inserts a new slider widget on the canvas.
15750     *
15751     * @ingroup Slider
15752     */
15753    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15754
15755    /**
15756     * Set the label of a given slider widget
15757     *
15758     * @param obj The progress bar object
15759     * @param label The text label string, in UTF-8
15760     *
15761     * @ingroup Slider
15762     * @deprecated use elm_object_text_set() instead.
15763     */
15764    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15765
15766    /**
15767     * Get the label of a given slider widget
15768     *
15769     * @param obj The progressbar object
15770     * @return The text label string, in UTF-8
15771     *
15772     * @ingroup Slider
15773     * @deprecated use elm_object_text_get() instead.
15774     */
15775    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15776
15777    /**
15778     * Set the icon object of the slider object.
15779     *
15780     * @param obj The slider object.
15781     * @param icon The icon object.
15782     *
15783     * On horizontal mode, icon is placed at left, and on vertical mode,
15784     * placed at top.
15785     *
15786     * @note Once the icon object is set, a previously set one will be deleted.
15787     * If you want to keep that old content object, use the
15788     * elm_slider_icon_unset() function.
15789     *
15790     * @warning If the object being set does not have minimum size hints set,
15791     * it won't get properly displayed.
15792     *
15793     * @ingroup Slider
15794     */
15795    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15796
15797    /**
15798     * Unset an icon set on a given slider widget.
15799     *
15800     * @param obj The slider object.
15801     * @return The icon object that was being used, if any was set, or
15802     * @c NULL, otherwise (and on errors).
15803     *
15804     * On horizontal mode, icon is placed at left, and on vertical mode,
15805     * placed at top.
15806     *
15807     * This call will unparent and return the icon object which was set
15808     * for this widget, previously, on success.
15809     *
15810     * @see elm_slider_icon_set() for more details
15811     * @see elm_slider_icon_get()
15812     *
15813     * @ingroup Slider
15814     */
15815    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15816
15817    /**
15818     * Retrieve the icon object set for a given slider widget.
15819     *
15820     * @param obj The slider object.
15821     * @return The icon object's handle, if @p obj had one set, or @c NULL,
15822     * otherwise (and on errors).
15823     *
15824     * On horizontal mode, icon is placed at left, and on vertical mode,
15825     * placed at top.
15826     *
15827     * @see elm_slider_icon_set() for more details
15828     * @see elm_slider_icon_unset()
15829     *
15830     * @ingroup Slider
15831     */
15832    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15833
15834    /**
15835     * Set the end object of the slider object.
15836     *
15837     * @param obj The slider object.
15838     * @param end The end object.
15839     *
15840     * On horizontal mode, end is placed at left, and on vertical mode,
15841     * placed at bottom.
15842     *
15843     * @note Once the icon object is set, a previously set one will be deleted.
15844     * If you want to keep that old content object, use the
15845     * elm_slider_end_unset() function.
15846     *
15847     * @warning If the object being set does not have minimum size hints set,
15848     * it won't get properly displayed.
15849     *
15850     * @ingroup Slider
15851     */
15852    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15853
15854    /**
15855     * Unset an end object set on a given slider widget.
15856     *
15857     * @param obj The slider object.
15858     * @return The end object that was being used, if any was set, or
15859     * @c NULL, otherwise (and on errors).
15860     *
15861     * On horizontal mode, end is placed at left, and on vertical mode,
15862     * placed at bottom.
15863     *
15864     * This call will unparent and return the icon object which was set
15865     * for this widget, previously, on success.
15866     *
15867     * @see elm_slider_end_set() for more details.
15868     * @see elm_slider_end_get()
15869     *
15870     * @ingroup Slider
15871     */
15872    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15873
15874    /**
15875     * Retrieve the end object set for a given slider widget.
15876     *
15877     * @param obj The slider object.
15878     * @return The end object's handle, if @p obj had one set, or @c NULL,
15879     * otherwise (and on errors).
15880     *
15881     * On horizontal mode, icon is placed at right, and on vertical mode,
15882     * placed at bottom.
15883     *
15884     * @see elm_slider_end_set() for more details.
15885     * @see elm_slider_end_unset()
15886     *
15887     * @ingroup Slider
15888     */
15889    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15890
15891    /**
15892     * Set the (exact) length of the bar region of a given slider widget.
15893     *
15894     * @param obj The slider object.
15895     * @param size The length of the slider's bar region.
15896     *
15897     * This sets the minimum width (when in horizontal mode) or height
15898     * (when in vertical mode) of the actual bar area of the slider
15899     * @p obj. This in turn affects the object's minimum size. Use
15900     * this when you're not setting other size hints expanding on the
15901     * given direction (like weight and alignment hints) and you would
15902     * like it to have a specific size.
15903     *
15904     * @note Icon, end, label, indicator and unit text around @p obj
15905     * will require their
15906     * own space, which will make @p obj to require more the @p size,
15907     * actually.
15908     *
15909     * @see elm_slider_span_size_get()
15910     *
15911     * @ingroup Slider
15912     */
15913    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15914
15915    /**
15916     * Get the length set for the bar region of a given slider widget
15917     *
15918     * @param obj The slider object.
15919     * @return The length of the slider's bar region.
15920     *
15921     * If that size was not set previously, with
15922     * elm_slider_span_size_set(), this call will return @c 0.
15923     *
15924     * @ingroup Slider
15925     */
15926    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15927
15928    /**
15929     * Set the format string for the unit label.
15930     *
15931     * @param obj The slider object.
15932     * @param format The format string for the unit display.
15933     *
15934     * Unit label is displayed all the time, if set, after slider's bar.
15935     * In horizontal mode, at right and in vertical mode, at bottom.
15936     *
15937     * If @c NULL, unit label won't be visible. If not it sets the format
15938     * string for the label text. To the label text is provided a floating point
15939     * value, so the label text can display up to 1 floating point value.
15940     * Note that this is optional.
15941     *
15942     * Use a format string such as "%1.2f meters" for example, and it will
15943     * display values like: "3.14 meters" for a value equal to 3.14159.
15944     *
15945     * Default is unit label disabled.
15946     *
15947     * @see elm_slider_indicator_format_get()
15948     *
15949     * @ingroup Slider
15950     */
15951    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
15952
15953    /**
15954     * Get the unit label format of the slider.
15955     *
15956     * @param obj The slider object.
15957     * @return The unit label format string in UTF-8.
15958     *
15959     * Unit label is displayed all the time, if set, after slider's bar.
15960     * In horizontal mode, at right and in vertical mode, at bottom.
15961     *
15962     * @see elm_slider_unit_format_set() for more
15963     * information on how this works.
15964     *
15965     * @ingroup Slider
15966     */
15967    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15968
15969    /**
15970     * Set the format string for the indicator label.
15971     *
15972     * @param obj The slider object.
15973     * @param indicator The format string for the indicator display.
15974     *
15975     * The slider may display its value somewhere else then unit label,
15976     * for example, above the slider knob that is dragged around. This function
15977     * sets the format string used for this.
15978     *
15979     * If @c NULL, indicator label won't be visible. If not it sets the format
15980     * string for the label text. To the label text is provided a floating point
15981     * value, so the label text can display up to 1 floating point value.
15982     * Note that this is optional.
15983     *
15984     * Use a format string such as "%1.2f meters" for example, and it will
15985     * display values like: "3.14 meters" for a value equal to 3.14159.
15986     *
15987     * Default is indicator label disabled.
15988     *
15989     * @see elm_slider_indicator_format_get()
15990     *
15991     * @ingroup Slider
15992     */
15993    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
15994
15995    /**
15996     * Get the indicator label format of the slider.
15997     *
15998     * @param obj The slider object.
15999     * @return The indicator label format string in UTF-8.
16000     *
16001     * The slider may display its value somewhere else then unit label,
16002     * for example, above the slider knob that is dragged around. This function
16003     * gets the format string used for this.
16004     *
16005     * @see elm_slider_indicator_format_set() for more
16006     * information on how this works.
16007     *
16008     * @ingroup Slider
16009     */
16010    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16011
16012    /**
16013     * Set the format function pointer for the indicator label
16014     *
16015     * @param obj The slider object.
16016     * @param func The indicator format function.
16017     * @param free_func The freeing function for the format string.
16018     *
16019     * Set the callback function to format the indicator string.
16020     *
16021     * @see elm_slider_indicator_format_set() for more info on how this works.
16022     *
16023     * @ingroup Slider
16024     */
16025   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);
16026
16027   /**
16028    * Set the format function pointer for the units label
16029    *
16030    * @param obj The slider object.
16031    * @param func The units format function.
16032    * @param free_func The freeing function for the format string.
16033    *
16034    * Set the callback function to format the indicator string.
16035    *
16036    * @see elm_slider_units_format_set() for more info on how this works.
16037    *
16038    * @ingroup Slider
16039    */
16040   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);
16041
16042   /**
16043    * Set the orientation of a given slider widget.
16044    *
16045    * @param obj The slider object.
16046    * @param horizontal Use @c EINA_TRUE to make @p obj to be
16047    * @b horizontal, @c EINA_FALSE to make it @b vertical.
16048    *
16049    * Use this function to change how your slider is to be
16050    * disposed: vertically or horizontally.
16051    *
16052    * By default it's displayed horizontally.
16053    *
16054    * @see elm_slider_horizontal_get()
16055    *
16056    * @ingroup Slider
16057    */
16058    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16059
16060    /**
16061     * Retrieve the orientation of a given slider widget
16062     *
16063     * @param obj The slider object.
16064     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16065     * @c EINA_FALSE if it's @b vertical (and on errors).
16066     *
16067     * @see elm_slider_horizontal_set() for more details.
16068     *
16069     * @ingroup Slider
16070     */
16071    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16072
16073    /**
16074     * Set the minimum and maximum values for the slider.
16075     *
16076     * @param obj The slider object.
16077     * @param min The minimum value.
16078     * @param max The maximum value.
16079     *
16080     * Define the allowed range of values to be selected by the user.
16081     *
16082     * If actual value is less than @p min, it will be updated to @p min. If it
16083     * is bigger then @p max, will be updated to @p max. Actual value can be
16084     * get with elm_slider_value_get().
16085     *
16086     * By default, min is equal to 0.0, and max is equal to 1.0.
16087     *
16088     * @warning Maximum must be greater than minimum, otherwise behavior
16089     * is undefined.
16090     *
16091     * @see elm_slider_min_max_get()
16092     *
16093     * @ingroup Slider
16094     */
16095    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16096
16097    /**
16098     * Get the minimum and maximum values of the slider.
16099     *
16100     * @param obj The slider object.
16101     * @param min Pointer where to store the minimum value.
16102     * @param max Pointer where to store the maximum value.
16103     *
16104     * @note If only one value is needed, the other pointer can be passed
16105     * as @c NULL.
16106     *
16107     * @see elm_slider_min_max_set() for details.
16108     *
16109     * @ingroup Slider
16110     */
16111    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16112
16113    /**
16114     * Set the value the slider displays.
16115     *
16116     * @param obj The slider object.
16117     * @param val The value to be displayed.
16118     *
16119     * Value will be presented on the unit label following format specified with
16120     * elm_slider_unit_format_set() and on indicator with
16121     * elm_slider_indicator_format_set().
16122     *
16123     * @warning The value must to be between min and max values. This values
16124     * are set by elm_slider_min_max_set().
16125     *
16126     * @see elm_slider_value_get()
16127     * @see elm_slider_unit_format_set()
16128     * @see elm_slider_indicator_format_set()
16129     * @see elm_slider_min_max_set()
16130     *
16131     * @ingroup Slider
16132     */
16133    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16134
16135    /**
16136     * Get the value displayed by the spinner.
16137     *
16138     * @param obj The spinner object.
16139     * @return The value displayed.
16140     *
16141     * @see elm_spinner_value_set() for details.
16142     *
16143     * @ingroup Slider
16144     */
16145    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16146
16147    /**
16148     * Invert a given slider widget's displaying values order
16149     *
16150     * @param obj The slider object.
16151     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16152     * @c EINA_FALSE to bring it back to default, non-inverted values.
16153     *
16154     * A slider may be @b inverted, in which state it gets its
16155     * values inverted, with high vales being on the left or top and
16156     * low values on the right or bottom, as opposed to normally have
16157     * the low values on the former and high values on the latter,
16158     * respectively, for horizontal and vertical modes.
16159     *
16160     * @see elm_slider_inverted_get()
16161     *
16162     * @ingroup Slider
16163     */
16164    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16165
16166    /**
16167     * Get whether a given slider widget's displaying values are
16168     * inverted or not.
16169     *
16170     * @param obj The slider object.
16171     * @return @c EINA_TRUE, if @p obj has inverted values,
16172     * @c EINA_FALSE otherwise (and on errors).
16173     *
16174     * @see elm_slider_inverted_set() for more details.
16175     *
16176     * @ingroup Slider
16177     */
16178    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16179
16180    /**
16181     * Set whether to enlarge slider indicator (augmented knob) or not.
16182     *
16183     * @param obj The slider object.
16184     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16185     * let the knob always at default size.
16186     *
16187     * By default, indicator will be bigger while dragged by the user.
16188     *
16189     * @warning It won't display values set with
16190     * elm_slider_indicator_format_set() if you disable indicator.
16191     *
16192     * @ingroup Slider
16193     */
16194    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16195
16196    /**
16197     * Get whether a given slider widget's enlarging indicator or not.
16198     *
16199     * @param obj The slider object.
16200     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16201     * @c EINA_FALSE otherwise (and on errors).
16202     *
16203     * @see elm_slider_indicator_show_set() for details.
16204     *
16205     * @ingroup Slider
16206     */
16207    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16208
16209    /**
16210     * @}
16211     */
16212
16213    /**
16214     * @addtogroup Actionslider Actionslider
16215     *
16216     * @image html img/widget/actionslider/preview-00.png
16217     * @image latex img/widget/actionslider/preview-00.eps
16218     *
16219     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16220     * properties. The indicator is the element the user drags to choose a label.
16221     * When the position is set with magnet, when released the indicator will be
16222     * moved to it if it's nearest the magnetized position.
16223     *
16224     * @note By default all positions are set as enabled.
16225     *
16226     * Signals that you can add callbacks for are:
16227     *
16228     * "selected" - when user selects an enabled position (the label is passed
16229     *              as event info)".
16230     * @n
16231     * "pos_changed" - when the indicator reaches any of the positions("left",
16232     *                 "right" or "center").
16233     *
16234     * See an example of actionslider usage @ref actionslider_example_page "here"
16235     * @{
16236     */
16237    typedef enum _Elm_Actionslider_Pos
16238      {
16239         ELM_ACTIONSLIDER_NONE = 0,
16240         ELM_ACTIONSLIDER_LEFT = 1 << 0,
16241         ELM_ACTIONSLIDER_CENTER = 1 << 1,
16242         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16243         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16244      } Elm_Actionslider_Pos;
16245
16246    /**
16247     * Add a new actionslider to the parent.
16248     *
16249     * @param parent The parent object
16250     * @return The new actionslider object or NULL if it cannot be created
16251     */
16252    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16253    /**
16254     * Set actionslider labels.
16255     *
16256     * @param obj The actionslider object
16257     * @param left_label The label to be set on the left.
16258     * @param center_label The label to be set on the center.
16259     * @param right_label The label to be set on the right.
16260     * @deprecated use elm_object_text_set() instead.
16261     */
16262    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);
16263    /**
16264     * Get actionslider labels.
16265     *
16266     * @param obj The actionslider object
16267     * @param left_label A char** to place the left_label of @p obj into.
16268     * @param center_label A char** to place the center_label of @p obj into.
16269     * @param right_label A char** to place the right_label of @p obj into.
16270     * @deprecated use elm_object_text_set() instead.
16271     */
16272    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);
16273    /**
16274     * Get actionslider selected label.
16275     *
16276     * @param obj The actionslider object
16277     * @return The selected label
16278     */
16279    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16280    /**
16281     * Set actionslider indicator position.
16282     *
16283     * @param obj The actionslider object.
16284     * @param pos The position of the indicator.
16285     */
16286    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16287    /**
16288     * Get actionslider indicator position.
16289     *
16290     * @param obj The actionslider object.
16291     * @return The position of the indicator.
16292     */
16293    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16294    /**
16295     * Set actionslider magnet position. To make multiple positions magnets @c or
16296     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16297     *
16298     * @param obj The actionslider object.
16299     * @param pos Bit mask indicating the magnet positions.
16300     */
16301    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16302    /**
16303     * Get actionslider magnet position.
16304     *
16305     * @param obj The actionslider object.
16306     * @return The positions with magnet property.
16307     */
16308    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16309    /**
16310     * Set actionslider enabled position. To set multiple positions as enabled @c or
16311     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16312     *
16313     * @note All the positions are enabled by default.
16314     *
16315     * @param obj The actionslider object.
16316     * @param pos Bit mask indicating the enabled positions.
16317     */
16318    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16319    /**
16320     * Get actionslider enabled position.
16321     *
16322     * @param obj The actionslider object.
16323     * @return The enabled positions.
16324     */
16325    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16326    /**
16327     * Set the label used on the indicator.
16328     *
16329     * @param obj The actionslider object
16330     * @param label The label to be set on the indicator.
16331     * @deprecated use elm_object_text_set() instead.
16332     */
16333    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16334    /**
16335     * Get the label used on the indicator object.
16336     *
16337     * @param obj The actionslider object
16338     * @return The indicator label
16339     * @deprecated use elm_object_text_get() instead.
16340     */
16341    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16342    /**
16343     * @}
16344     */
16345
16346    /**
16347     * @defgroup Genlist Genlist
16348     *
16349     * @image html img/widget/genlist/preview-00.png
16350     * @image latex img/widget/genlist/preview-00.eps
16351     * @image html img/genlist.png
16352     * @image latex img/genlist.eps
16353     *
16354     * This widget aims to have more expansive list than the simple list in
16355     * Elementary that could have more flexible items and allow many more entries
16356     * while still being fast and low on memory usage. At the same time it was
16357     * also made to be able to do tree structures. But the price to pay is more
16358     * complexity when it comes to usage. If all you want is a simple list with
16359     * icons and a single label, use the normal @ref List object.
16360     *
16361     * Genlist has a fairly large API, mostly because it's relatively complex,
16362     * trying to be both expansive, powerful and efficient. First we will begin
16363     * an overview on the theory behind genlist.
16364     *
16365     * @section Genlist_Item_Class Genlist item classes - creating items
16366     *
16367     * In order to have the ability to add and delete items on the fly, genlist
16368     * implements a class (callback) system where the application provides a
16369     * structure with information about that type of item (genlist may contain
16370     * multiple different items with different classes, states and styles).
16371     * Genlist will call the functions in this struct (methods) when an item is
16372     * "realized" (i.e., created dynamically, while the user is scrolling the
16373     * grid). All objects will simply be deleted when no longer needed with
16374     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16375     * following members:
16376     * - @c item_style - This is a constant string and simply defines the name
16377     *   of the item style. It @b must be specified and the default should be @c
16378     *   "default".
16379     * - @c mode_item_style - This is a constant string and simply defines the
16380     *   name of the style that will be used for mode animations. It can be left
16381     *   as @c NULL if you don't plan to use Genlist mode. See
16382     *   elm_genlist_item_mode_set() for more info.
16383     *
16384     * - @c func - A struct with pointers to functions that will be called when
16385     *   an item is going to be actually created. All of them receive a @c data
16386     *   parameter that will point to the same data passed to
16387     *   elm_genlist_item_append() and related item creation functions, and a @c
16388     *   obj parameter that points to the genlist object itself.
16389     *
16390     * The function pointers inside @c func are @c label_get, @c icon_get, @c
16391     * state_get and @c del. The 3 first functions also receive a @c part
16392     * parameter described below. A brief description of these functions follows:
16393     *
16394     * - @c label_get - The @c part parameter is the name string of one of the
16395     *   existing text parts in the Edje group implementing the item's theme.
16396     *   This function @b must return a strdup'()ed string, as the caller will
16397     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16398     * - @c icon_get - The @c part parameter is the name string of one of the
16399     *   existing (icon) swallow parts in the Edje group implementing the item's
16400     *   theme. It must return @c NULL, when no icon is desired, or a valid
16401     *   object handle, otherwise.  The object will be deleted by the genlist on
16402     *   its deletion or when the item is "unrealized".  See
16403     *   #Elm_Genlist_Item_Icon_Get_Cb.
16404     * - @c func.state_get - The @c part parameter is the name string of one of
16405     *   the state parts in the Edje group implementing the item's theme. Return
16406     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16407     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16408     *   and @c "elm" as "emission" and "source" arguments, respectively, when
16409     *   the state is true (the default is false), where @c XXX is the name of
16410     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
16411     * - @c func.del - This is intended for use when genlist items are deleted,
16412     *   so any data attached to the item (e.g. its data parameter on creation)
16413     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
16414     *
16415     * available item styles:
16416     * - default
16417     * - default_style - The text part is a textblock
16418     *
16419     * @image html img/widget/genlist/preview-04.png
16420     * @image latex img/widget/genlist/preview-04.eps
16421     *
16422     * - double_label
16423     *
16424     * @image html img/widget/genlist/preview-01.png
16425     * @image latex img/widget/genlist/preview-01.eps
16426     *
16427     * - icon_top_text_bottom
16428     *
16429     * @image html img/widget/genlist/preview-02.png
16430     * @image latex img/widget/genlist/preview-02.eps
16431     *
16432     * - group_index
16433     *
16434     * @image html img/widget/genlist/preview-03.png
16435     * @image latex img/widget/genlist/preview-03.eps
16436     *
16437     * @section Genlist_Items Structure of items
16438     *
16439     * An item in a genlist can have 0 or more text labels (they can be regular
16440     * text or textblock Evas objects - that's up to the style to determine), 0
16441     * or more icons (which are simply objects swallowed into the genlist item's
16442     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16443     * behavior left to the user to define. The Edje part names for each of
16444     * these properties will be looked up, in the theme file for the genlist,
16445     * under the Edje (string) data items named @c "labels", @c "icons" and @c
16446     * "states", respectively. For each of those properties, if more than one
16447     * part is provided, they must have names listed separated by spaces in the
16448     * data fields. For the default genlist item theme, we have @b one label
16449     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16450     * "elm.swallow.end") and @b no state parts.
16451     *
16452     * A genlist item may be at one of several styles. Elementary provides one
16453     * by default - "default", but this can be extended by system or application
16454     * custom themes/overlays/extensions (see @ref Theme "themes" for more
16455     * details).
16456     *
16457     * @section Genlist_Manipulation Editing and Navigating
16458     *
16459     * Items can be added by several calls. All of them return a @ref
16460     * Elm_Genlist_Item handle that is an internal member inside the genlist.
16461     * They all take a data parameter that is meant to be used for a handle to
16462     * the applications internal data (eg the struct with the original item
16463     * data). The parent parameter is the parent genlist item this belongs to if
16464     * it is a tree or an indexed group, and NULL if there is no parent. The
16465     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16466     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16467     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16468     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
16469     * is set then this item is group index item that is displayed at the top
16470     * until the next group comes. The func parameter is a convenience callback
16471     * that is called when the item is selected and the data parameter will be
16472     * the func_data parameter, obj be the genlist object and event_info will be
16473     * the genlist item.
16474     *
16475     * elm_genlist_item_append() adds an item to the end of the list, or if
16476     * there is a parent, to the end of all the child items of the parent.
16477     * elm_genlist_item_prepend() is the same but adds to the beginning of
16478     * the list or children list. elm_genlist_item_insert_before() inserts at
16479     * item before another item and elm_genlist_item_insert_after() inserts after
16480     * the indicated item.
16481     *
16482     * The application can clear the list with elm_genlist_clear() which deletes
16483     * all the items in the list and elm_genlist_item_del() will delete a specific
16484     * item. elm_genlist_item_subitems_clear() will clear all items that are
16485     * children of the indicated parent item.
16486     *
16487     * To help inspect list items you can jump to the item at the top of the list
16488     * with elm_genlist_first_item_get() which will return the item pointer, and
16489     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16490     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16491     * and previous items respectively relative to the indicated item. Using
16492     * these calls you can walk the entire item list/tree. Note that as a tree
16493     * the items are flattened in the list, so elm_genlist_item_parent_get() will
16494     * let you know which item is the parent (and thus know how to skip them if
16495     * wanted).
16496     *
16497     * @section Genlist_Muti_Selection Multi-selection
16498     *
16499     * If the application wants multiple items to be able to be selected,
16500     * elm_genlist_multi_select_set() can enable this. If the list is
16501     * single-selection only (the default), then elm_genlist_selected_item_get()
16502     * will return the selected item, if any, or NULL I none is selected. If the
16503     * list is multi-select then elm_genlist_selected_items_get() will return a
16504     * list (that is only valid as long as no items are modified (added, deleted,
16505     * selected or unselected)).
16506     *
16507     * @section Genlist_Usage_Hints Usage hints
16508     *
16509     * There are also convenience functions. elm_genlist_item_genlist_get() will
16510     * return the genlist object the item belongs to. elm_genlist_item_show()
16511     * will make the scroller scroll to show that specific item so its visible.
16512     * elm_genlist_item_data_get() returns the data pointer set by the item
16513     * creation functions.
16514     *
16515     * If an item changes (state of boolean changes, label or icons change),
16516     * then use elm_genlist_item_update() to have genlist update the item with
16517     * the new state. Genlist will re-realize the item thus call the functions
16518     * in the _Elm_Genlist_Item_Class for that item.
16519     *
16520     * To programmatically (un)select an item use elm_genlist_item_selected_set().
16521     * To get its selected state use elm_genlist_item_selected_get(). Similarly
16522     * to expand/contract an item and get its expanded state, use
16523     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16524     * again to make an item disabled (unable to be selected and appear
16525     * differently) use elm_genlist_item_disabled_set() to set this and
16526     * elm_genlist_item_disabled_get() to get the disabled state.
16527     *
16528     * In general to indicate how the genlist should expand items horizontally to
16529     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16530     * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16531     * mode means that if items are too wide to fit, the scroller will scroll
16532     * horizontally. Otherwise items are expanded to fill the width of the
16533     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16534     * to the viewport width and limited to that size. This can be combined with
16535     * a different style that uses edjes' ellipsis feature (cutting text off like
16536     * this: "tex...").
16537     *
16538     * Items will only call their selection func and callback when first becoming
16539     * selected. Any further clicks will do nothing, unless you enable always
16540     * select with elm_genlist_always_select_mode_set(). This means even if
16541     * selected, every click will make the selected callbacks be called.
16542     * elm_genlist_no_select_mode_set() will turn off the ability to select
16543     * items entirely and they will neither appear selected nor call selected
16544     * callback functions.
16545     *
16546     * Remember that you can create new styles and add your own theme augmentation
16547     * per application with elm_theme_extension_add(). If you absolutely must
16548     * have a specific style that overrides any theme the user or system sets up
16549     * you can use elm_theme_overlay_add() to add such a file.
16550     *
16551     * @section Genlist_Implementation Implementation
16552     *
16553     * Evas tracks every object you create. Every time it processes an event
16554     * (mouse move, down, up etc.) it needs to walk through objects and find out
16555     * what event that affects. Even worse every time it renders display updates,
16556     * in order to just calculate what to re-draw, it needs to walk through many
16557     * many many objects. Thus, the more objects you keep active, the more
16558     * overhead Evas has in just doing its work. It is advisable to keep your
16559     * active objects to the minimum working set you need. Also remember that
16560     * object creation and deletion carries an overhead, so there is a
16561     * middle-ground, which is not easily determined. But don't keep massive lists
16562     * of objects you can't see or use. Genlist does this with list objects. It
16563     * creates and destroys them dynamically as you scroll around. It groups them
16564     * into blocks so it can determine the visibility etc. of a whole block at
16565     * once as opposed to having to walk the whole list. This 2-level list allows
16566     * for very large numbers of items to be in the list (tests have used up to
16567     * 2,000,000 items). Also genlist employs a queue for adding items. As items
16568     * may be different sizes, every item added needs to be calculated as to its
16569     * size and thus this presents a lot of overhead on populating the list, this
16570     * genlist employs a queue. Any item added is queued and spooled off over
16571     * time, actually appearing some time later, so if your list has many members
16572     * you may find it takes a while for them to all appear, with your process
16573     * consuming a lot of CPU while it is busy spooling.
16574     *
16575     * Genlist also implements a tree structure, but it does so with callbacks to
16576     * the application, with the application filling in tree structures when
16577     * requested (allowing for efficient building of a very deep tree that could
16578     * even be used for file-management). See the above smart signal callbacks for
16579     * details.
16580     *
16581     * @section Genlist_Smart_Events Genlist smart events
16582     *
16583     * Signals that you can add callbacks for are:
16584     * - @c "activated" - The user has double-clicked or pressed
16585     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
16586     *   item that was activated.
16587     * - @c "clicked,double" - The user has double-clicked an item.  The @c
16588     *   event_info parameter is the item that was double-clicked.
16589     * - @c "selected" - This is called when a user has made an item selected.
16590     *   The event_info parameter is the genlist item that was selected.
16591     * - @c "unselected" - This is called when a user has made an item
16592     *   unselected. The event_info parameter is the genlist item that was
16593     *   unselected.
16594     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16595     *   called and the item is now meant to be expanded. The event_info
16596     *   parameter is the genlist item that was indicated to expand.  It is the
16597     *   job of this callback to then fill in the child items.
16598     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16599     *   called and the item is now meant to be contracted. The event_info
16600     *   parameter is the genlist item that was indicated to contract. It is the
16601     *   job of this callback to then delete the child items.
16602     * - @c "expand,request" - This is called when a user has indicated they want
16603     *   to expand a tree branch item. The callback should decide if the item can
16604     *   expand (has any children) and then call elm_genlist_item_expanded_set()
16605     *   appropriately to set the state. The event_info parameter is the genlist
16606     *   item that was indicated to expand.
16607     * - @c "contract,request" - This is called when a user has indicated they
16608     *   want to contract a tree branch item. The callback should decide if the
16609     *   item can contract (has any children) and then call
16610     *   elm_genlist_item_expanded_set() appropriately to set the state. The
16611     *   event_info parameter is the genlist item that was indicated to contract.
16612     * - @c "realized" - This is called when the item in the list is created as a
16613     *   real evas object. event_info parameter is the genlist item that was
16614     *   created. The object may be deleted at any time, so it is up to the
16615     *   caller to not use the object pointer from elm_genlist_item_object_get()
16616     *   in a way where it may point to freed objects.
16617     * - @c "unrealized" - This is called just before an item is unrealized.
16618     *   After this call icon objects provided will be deleted and the item
16619     *   object itself delete or be put into a floating cache.
16620     * - @c "drag,start,up" - This is called when the item in the list has been
16621     *   dragged (not scrolled) up.
16622     * - @c "drag,start,down" - This is called when the item in the list has been
16623     *   dragged (not scrolled) down.
16624     * - @c "drag,start,left" - This is called when the item in the list has been
16625     *   dragged (not scrolled) left.
16626     * - @c "drag,start,right" - This is called when the item in the list has
16627     *   been dragged (not scrolled) right.
16628     * - @c "drag,stop" - This is called when the item in the list has stopped
16629     *   being dragged.
16630     * - @c "drag" - This is called when the item in the list is being dragged.
16631     * - @c "longpressed" - This is called when the item is pressed for a certain
16632     *   amount of time. By default it's 1 second.
16633     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16634     *   the top edge.
16635     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16636     *   until the bottom edge.
16637     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16638     *   until the left edge.
16639     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16640     *   until the right edge.
16641     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16642     *   swiped left.
16643     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16644     *   swiped right.
16645     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16646     *   swiped up.
16647     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16648     *   swiped down.
16649     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16650     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
16651     *   multi-touch pinched in.
16652     * - @c "swipe" - This is called when the genlist is swiped.
16653     *
16654     * @section Genlist_Examples Examples
16655     *
16656     * Here is a list of examples that use the genlist, trying to show some of
16657     * its capabilities:
16658     * - @ref genlist_example_01
16659     * - @ref genlist_example_02
16660     * - @ref genlist_example_03
16661     * - @ref genlist_example_04
16662     * - @ref genlist_example_05
16663     */
16664
16665    /**
16666     * @addtogroup Genlist
16667     * @{
16668     */
16669
16670    /**
16671     * @enum _Elm_Genlist_Item_Flags
16672     * @typedef Elm_Genlist_Item_Flags
16673     *
16674     * Defines if the item is of any special type (has subitems or it's the
16675     * index of a group), or is just a simple item.
16676     *
16677     * @ingroup Genlist
16678     */
16679    typedef enum _Elm_Genlist_Item_Flags
16680      {
16681         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16682         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16683         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16684      } Elm_Genlist_Item_Flags;
16685    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
16686    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16687    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16688    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16689    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. */
16690    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. */
16691    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16692    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16693
16694    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16695    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16696    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16697    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16698
16699    /**
16700     * @struct _Elm_Genlist_Item_Class
16701     *
16702     * Genlist item class definition structs.
16703     *
16704     * This struct contains the style and fetching functions that will define the
16705     * contents of each item.
16706     *
16707     * @see @ref Genlist_Item_Class
16708     */
16709    struct _Elm_Genlist_Item_Class
16710      {
16711         const char                *item_style; /**< style of this class. */
16712         struct
16713           {
16714              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
16715              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
16716              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
16717              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
16718              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
16719           } func;
16720         const char                *mode_item_style;
16721      };
16722
16723    /**
16724     * Add a new genlist widget to the given parent Elementary
16725     * (container) object
16726     *
16727     * @param parent The parent object
16728     * @return a new genlist widget handle or @c NULL, on errors
16729     *
16730     * This function inserts a new genlist widget on the canvas.
16731     *
16732     * @see elm_genlist_item_append()
16733     * @see elm_genlist_item_del()
16734     * @see elm_genlist_clear()
16735     *
16736     * @ingroup Genlist
16737     */
16738    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16739    /**
16740     * Remove all items from a given genlist widget.
16741     *
16742     * @param obj The genlist object
16743     *
16744     * This removes (and deletes) all items in @p obj, leaving it empty.
16745     *
16746     * @see elm_genlist_item_del(), to remove just one item.
16747     *
16748     * @ingroup Genlist
16749     */
16750    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16751    /**
16752     * Enable or disable multi-selection in the genlist
16753     *
16754     * @param obj The genlist object
16755     * @param multi Multi-select enable/disable. Default is disabled.
16756     *
16757     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16758     * the list. This allows more than 1 item to be selected. To retrieve the list
16759     * of selected items, use elm_genlist_selected_items_get().
16760     *
16761     * @see elm_genlist_selected_items_get()
16762     * @see elm_genlist_multi_select_get()
16763     *
16764     * @ingroup Genlist
16765     */
16766    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16767    /**
16768     * Gets if multi-selection in genlist is enabled or disabled.
16769     *
16770     * @param obj The genlist object
16771     * @return Multi-select enabled/disabled
16772     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16773     *
16774     * @see elm_genlist_multi_select_set()
16775     *
16776     * @ingroup Genlist
16777     */
16778    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16779    /**
16780     * This sets the horizontal stretching mode.
16781     *
16782     * @param obj The genlist object
16783     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16784     *
16785     * This sets the mode used for sizing items horizontally. Valid modes
16786     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16787     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16788     * the scroller will scroll horizontally. Otherwise items are expanded
16789     * to fill the width of the viewport of the scroller. If it is
16790     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16791     * limited to that size.
16792     *
16793     * @see elm_genlist_horizontal_get()
16794     *
16795     * @ingroup Genlist
16796     */
16797    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16798    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16799    /**
16800     * Gets the horizontal stretching mode.
16801     *
16802     * @param obj The genlist object
16803     * @return The mode to use
16804     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16805     *
16806     * @see elm_genlist_horizontal_set()
16807     *
16808     * @ingroup Genlist
16809     */
16810    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16811    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16812    /**
16813     * Set the always select mode.
16814     *
16815     * @param obj The genlist object
16816     * @param always_select The always select mode (@c EINA_TRUE = on, @c
16817     * EINA_FALSE = off). Default is @c EINA_FALSE.
16818     *
16819     * Items will only call their selection func and callback when first
16820     * becoming selected. Any further clicks will do nothing, unless you
16821     * enable always select with elm_genlist_always_select_mode_set().
16822     * This means that, even if selected, every click will make the selected
16823     * callbacks be called.
16824     *
16825     * @see elm_genlist_always_select_mode_get()
16826     *
16827     * @ingroup Genlist
16828     */
16829    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16830    /**
16831     * Get the always select mode.
16832     *
16833     * @param obj The genlist object
16834     * @return The always select mode
16835     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16836     *
16837     * @see elm_genlist_always_select_mode_set()
16838     *
16839     * @ingroup Genlist
16840     */
16841    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16842    /**
16843     * Enable/disable the no select mode.
16844     *
16845     * @param obj The genlist object
16846     * @param no_select The no select mode
16847     * (EINA_TRUE = on, EINA_FALSE = off)
16848     *
16849     * This will turn off the ability to select items entirely and they
16850     * will neither appear selected nor call selected callback functions.
16851     *
16852     * @see elm_genlist_no_select_mode_get()
16853     *
16854     * @ingroup Genlist
16855     */
16856    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16857    /**
16858     * Gets whether the no select mode is enabled.
16859     *
16860     * @param obj The genlist object
16861     * @return The no select mode
16862     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16863     *
16864     * @see elm_genlist_no_select_mode_set()
16865     *
16866     * @ingroup Genlist
16867     */
16868    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16869    /**
16870     * Enable/disable compress mode.
16871     *
16872     * @param obj The genlist object
16873     * @param compress The compress mode
16874     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16875     *
16876     * This will enable the compress mode where items are "compressed"
16877     * horizontally to fit the genlist scrollable viewport width. This is
16878     * special for genlist.  Do not rely on
16879     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16880     * work as genlist needs to handle it specially.
16881     *
16882     * @see elm_genlist_compress_mode_get()
16883     *
16884     * @ingroup Genlist
16885     */
16886    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16887    /**
16888     * Get whether the compress mode is enabled.
16889     *
16890     * @param obj The genlist object
16891     * @return The compress mode
16892     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16893     *
16894     * @see elm_genlist_compress_mode_set()
16895     *
16896     * @ingroup Genlist
16897     */
16898    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16899    /**
16900     * Enable/disable height-for-width mode.
16901     *
16902     * @param obj The genlist object
16903     * @param setting The height-for-width mode (@c EINA_TRUE = on,
16904     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16905     *
16906     * With height-for-width mode the item width will be fixed (restricted
16907     * to a minimum of) to the list width when calculating its size in
16908     * order to allow the height to be calculated based on it. This allows,
16909     * for instance, text block to wrap lines if the Edje part is
16910     * configured with "text.min: 0 1".
16911     *
16912     * @note This mode will make list resize slower as it will have to
16913     *       recalculate every item height again whenever the list width
16914     *       changes!
16915     *
16916     * @note When height-for-width mode is enabled, it also enables
16917     *       compress mode (see elm_genlist_compress_mode_set()) and
16918     *       disables homogeneous (see elm_genlist_homogeneous_set()).
16919     *
16920     * @ingroup Genlist
16921     */
16922    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
16923    /**
16924     * Get whether the height-for-width mode is enabled.
16925     *
16926     * @param obj The genlist object
16927     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
16928     * off)
16929     *
16930     * @ingroup Genlist
16931     */
16932    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16933    /**
16934     * Enable/disable horizontal and vertical bouncing effect.
16935     *
16936     * @param obj The genlist object
16937     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
16938     * EINA_FALSE = off). Default is @c EINA_FALSE.
16939     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
16940     * EINA_FALSE = off). Default is @c EINA_TRUE.
16941     *
16942     * This will enable or disable the scroller bouncing effect for the
16943     * genlist. See elm_scroller_bounce_set() for details.
16944     *
16945     * @see elm_scroller_bounce_set()
16946     * @see elm_genlist_bounce_get()
16947     *
16948     * @ingroup Genlist
16949     */
16950    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16951    /**
16952     * Get whether the horizontal and vertical bouncing effect is enabled.
16953     *
16954     * @param obj The genlist object
16955     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
16956     * option is set.
16957     * @param v_bounce Pointer to a bool to receive if the bounce vertically
16958     * option is set.
16959     *
16960     * @see elm_genlist_bounce_set()
16961     *
16962     * @ingroup Genlist
16963     */
16964    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16965    /**
16966     * Enable/disable homogenous mode.
16967     *
16968     * @param obj The genlist object
16969     * @param homogeneous Assume the items within the genlist are of the
16970     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
16971     * EINA_FALSE.
16972     *
16973     * This will enable the homogeneous mode where items are of the same
16974     * height and width so that genlist may do the lazy-loading at its
16975     * maximum (which increases the performance for scrolling the list). This
16976     * implies 'compressed' mode.
16977     *
16978     * @see elm_genlist_compress_mode_set()
16979     * @see elm_genlist_homogeneous_get()
16980     *
16981     * @ingroup Genlist
16982     */
16983    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16984    /**
16985     * Get whether the homogenous mode is enabled.
16986     *
16987     * @param obj The genlist object
16988     * @return Assume the items within the genlist are of the same height
16989     * and width (EINA_TRUE = on, EINA_FALSE = off)
16990     *
16991     * @see elm_genlist_homogeneous_set()
16992     *
16993     * @ingroup Genlist
16994     */
16995    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16996    /**
16997     * Set the maximum number of items within an item block
16998     *
16999     * @param obj The genlist object
17000     * @param n   Maximum number of items within an item block. Default is 32.
17001     *
17002     * This will configure the block count to tune to the target with
17003     * particular performance matrix.
17004     *
17005     * A block of objects will be used to reduce the number of operations due to
17006     * many objects in the screen. It can determine the visibility, or if the
17007     * object has changed, it theme needs to be updated, etc. doing this kind of
17008     * calculation to the entire block, instead of per object.
17009     *
17010     * The default value for the block count is enough for most lists, so unless
17011     * you know you will have a lot of objects visible in the screen at the same
17012     * time, don't try to change this.
17013     *
17014     * @see elm_genlist_block_count_get()
17015     * @see @ref Genlist_Implementation
17016     *
17017     * @ingroup Genlist
17018     */
17019    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17020    /**
17021     * Get the maximum number of items within an item block
17022     *
17023     * @param obj The genlist object
17024     * @return Maximum number of items within an item block
17025     *
17026     * @see elm_genlist_block_count_set()
17027     *
17028     * @ingroup Genlist
17029     */
17030    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17031    /**
17032     * Set the timeout in seconds for the longpress event.
17033     *
17034     * @param obj The genlist object
17035     * @param timeout timeout in seconds. Default is 1.
17036     *
17037     * This option will change how long it takes to send an event "longpressed"
17038     * after the mouse down signal is sent to the list. If this event occurs, no
17039     * "clicked" event will be sent.
17040     *
17041     * @see elm_genlist_longpress_timeout_set()
17042     *
17043     * @ingroup Genlist
17044     */
17045    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17046    /**
17047     * Get the timeout in seconds for the longpress event.
17048     *
17049     * @param obj The genlist object
17050     * @return timeout in seconds
17051     *
17052     * @see elm_genlist_longpress_timeout_get()
17053     *
17054     * @ingroup Genlist
17055     */
17056    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17057    /**
17058     * Append a new item in a given genlist widget.
17059     *
17060     * @param obj The genlist object
17061     * @param itc The item class for the item
17062     * @param data The item data
17063     * @param parent The parent item, or NULL if none
17064     * @param flags Item flags
17065     * @param func Convenience function called when the item is selected
17066     * @param func_data Data passed to @p func above.
17067     * @return A handle to the item added or @c NULL if not possible
17068     *
17069     * This adds the given item to the end of the list or the end of
17070     * the children list if the @p parent is given.
17071     *
17072     * @see elm_genlist_item_prepend()
17073     * @see elm_genlist_item_insert_before()
17074     * @see elm_genlist_item_insert_after()
17075     * @see elm_genlist_item_del()
17076     *
17077     * @ingroup Genlist
17078     */
17079    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);
17080    /**
17081     * Prepend a new item in a given genlist widget.
17082     *
17083     * @param obj The genlist object
17084     * @param itc The item class for the item
17085     * @param data The item data
17086     * @param parent The parent item, or NULL if none
17087     * @param flags Item flags
17088     * @param func Convenience function called when the item is selected
17089     * @param func_data Data passed to @p func above.
17090     * @return A handle to the item added or NULL if not possible
17091     *
17092     * This adds an item to the beginning of the list or beginning of the
17093     * children of the parent if given.
17094     *
17095     * @see elm_genlist_item_append()
17096     * @see elm_genlist_item_insert_before()
17097     * @see elm_genlist_item_insert_after()
17098     * @see elm_genlist_item_del()
17099     *
17100     * @ingroup Genlist
17101     */
17102    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);
17103    /**
17104     * Insert an item before another in a genlist widget
17105     *
17106     * @param obj The genlist object
17107     * @param itc The item class for the item
17108     * @param data The item data
17109     * @param before The item to place this new one before.
17110     * @param flags Item flags
17111     * @param func Convenience function called when the item is selected
17112     * @param func_data Data passed to @p func above.
17113     * @return A handle to the item added or @c NULL if not possible
17114     *
17115     * This inserts an item before another in the list. It will be in the
17116     * same tree level or group as the item it is inserted before.
17117     *
17118     * @see elm_genlist_item_append()
17119     * @see elm_genlist_item_prepend()
17120     * @see elm_genlist_item_insert_after()
17121     * @see elm_genlist_item_del()
17122     *
17123     * @ingroup Genlist
17124     */
17125    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);
17126    /**
17127     * Insert an item after another in a genlist widget
17128     *
17129     * @param obj The genlist object
17130     * @param itc The item class for the item
17131     * @param data The item data
17132     * @param after The item to place this new one after.
17133     * @param flags Item flags
17134     * @param func Convenience function called when the item is selected
17135     * @param func_data Data passed to @p func above.
17136     * @return A handle to the item added or @c NULL if not possible
17137     *
17138     * This inserts an item after another in the list. It will be in the
17139     * same tree level or group as the item it is inserted after.
17140     *
17141     * @see elm_genlist_item_append()
17142     * @see elm_genlist_item_prepend()
17143     * @see elm_genlist_item_insert_before()
17144     * @see elm_genlist_item_del()
17145     *
17146     * @ingroup Genlist
17147     */
17148    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);
17149    /**
17150     * Insert a new item into the sorted genlist object
17151     *
17152     * @param obj The genlist object
17153     * @param itc The item class for the item
17154     * @param data The item data
17155     * @param parent The parent item, or NULL if none
17156     * @param flags Item flags
17157     * @param comp The function called for the sort
17158     * @param func Convenience function called when item selected
17159     * @param func_data Data passed to @p func above.
17160     * @return A handle to the item added or NULL if not possible
17161     *
17162     * @ingroup Genlist
17163     */
17164    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);
17165    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);
17166    /* operations to retrieve existing items */
17167    /**
17168     * Get the selectd item in the genlist.
17169     *
17170     * @param obj The genlist object
17171     * @return The selected item, or NULL if none is selected.
17172     *
17173     * This gets the selected item in the list (if multi-selection is enabled, only
17174     * the item that was first selected in the list is returned - which is not very
17175     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17176     * used).
17177     *
17178     * If no item is selected, NULL is returned.
17179     *
17180     * @see elm_genlist_selected_items_get()
17181     *
17182     * @ingroup Genlist
17183     */
17184    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17185    /**
17186     * Get a list of selected items in the genlist.
17187     *
17188     * @param obj The genlist object
17189     * @return The list of selected items, or NULL if none are selected.
17190     *
17191     * It returns a list of the selected items. This list pointer is only valid so
17192     * long as the selection doesn't change (no items are selected or unselected, or
17193     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17194     * pointers. The order of the items in this list is the order which they were
17195     * selected, i.e. the first item in this list is the first item that was
17196     * selected, and so on.
17197     *
17198     * @note If not in multi-select mode, consider using function
17199     * elm_genlist_selected_item_get() instead.
17200     *
17201     * @see elm_genlist_multi_select_set()
17202     * @see elm_genlist_selected_item_get()
17203     *
17204     * @ingroup Genlist
17205     */
17206    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17207    /**
17208     * Get a list of realized items in genlist
17209     *
17210     * @param obj The genlist object
17211     * @return The list of realized items, nor NULL if none are realized.
17212     *
17213     * This returns a list of the realized items in the genlist. The list
17214     * contains Elm_Genlist_Item pointers. The list must be freed by the
17215     * caller when done with eina_list_free(). The item pointers in the
17216     * list are only valid so long as those items are not deleted or the
17217     * genlist is not deleted.
17218     *
17219     * @see elm_genlist_realized_items_update()
17220     *
17221     * @ingroup Genlist
17222     */
17223    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17224    /**
17225     * Get the item that is at the x, y canvas coords.
17226     *
17227     * @param obj The gelinst object.
17228     * @param x The input x coordinate
17229     * @param y The input y coordinate
17230     * @param posret The position relative to the item returned here
17231     * @return The item at the coordinates or NULL if none
17232     *
17233     * This returns the item at the given coordinates (which are canvas
17234     * relative, not object-relative). If an item is at that coordinate,
17235     * that item handle is returned, and if @p posret is not NULL, the
17236     * integer pointed to is set to a value of -1, 0 or 1, depending if
17237     * the coordinate is on the upper portion of that item (-1), on the
17238     * middle section (0) or on the lower part (1). If NULL is returned as
17239     * an item (no item found there), then posret may indicate -1 or 1
17240     * based if the coordinate is above or below all items respectively in
17241     * the genlist.
17242     *
17243     * @ingroup Genlist
17244     */
17245    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);
17246    /**
17247     * Get the first item in the genlist
17248     *
17249     * This returns the first item in the list.
17250     *
17251     * @param obj The genlist object
17252     * @return The first item, or NULL if none
17253     *
17254     * @ingroup Genlist
17255     */
17256    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17257    /**
17258     * Get the last item in the genlist
17259     *
17260     * This returns the last item in the list.
17261     *
17262     * @return The last item, or NULL if none
17263     *
17264     * @ingroup Genlist
17265     */
17266    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17267    /**
17268     * Set the scrollbar policy
17269     *
17270     * @param obj The genlist object
17271     * @param policy_h Horizontal scrollbar policy.
17272     * @param policy_v Vertical scrollbar policy.
17273     *
17274     * This sets the scrollbar visibility policy for the given genlist
17275     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17276     * made visible if it is needed, and otherwise kept hidden.
17277     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17278     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17279     * respectively for the horizontal and vertical scrollbars. Default is
17280     * #ELM_SMART_SCROLLER_POLICY_AUTO
17281     *
17282     * @see elm_genlist_scroller_policy_get()
17283     *
17284     * @ingroup Genlist
17285     */
17286    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17287    /**
17288     * Get the scrollbar policy
17289     *
17290     * @param obj The genlist object
17291     * @param policy_h Pointer to store the horizontal scrollbar policy.
17292     * @param policy_v Pointer to store the vertical scrollbar policy.
17293     *
17294     * @see elm_genlist_scroller_policy_set()
17295     *
17296     * @ingroup Genlist
17297     */
17298    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);
17299    /**
17300     * Get the @b next item in a genlist widget's internal list of items,
17301     * given a handle to one of those items.
17302     *
17303     * @param item The genlist item to fetch next from
17304     * @return The item after @p item, or @c NULL if there's none (and
17305     * on errors)
17306     *
17307     * This returns the item placed after the @p item, on the container
17308     * genlist.
17309     *
17310     * @see elm_genlist_item_prev_get()
17311     *
17312     * @ingroup Genlist
17313     */
17314    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17315    /**
17316     * Get the @b previous item in a genlist widget's internal list of items,
17317     * given a handle to one of those items.
17318     *
17319     * @param item The genlist item to fetch previous from
17320     * @return The item before @p item, or @c NULL if there's none (and
17321     * on errors)
17322     *
17323     * This returns the item placed before the @p item, on the container
17324     * genlist.
17325     *
17326     * @see elm_genlist_item_next_get()
17327     *
17328     * @ingroup Genlist
17329     */
17330    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17331    /**
17332     * Get the genlist object's handle which contains a given genlist
17333     * item
17334     *
17335     * @param item The item to fetch the container from
17336     * @return The genlist (parent) object
17337     *
17338     * This returns the genlist object itself that an item belongs to.
17339     *
17340     * @ingroup Genlist
17341     */
17342    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17343    /**
17344     * Get the parent item of the given item
17345     *
17346     * @param it The item
17347     * @return The parent of the item or @c NULL if it has no parent.
17348     *
17349     * This returns the item that was specified as parent of the item @p it on
17350     * elm_genlist_item_append() and insertion related functions.
17351     *
17352     * @ingroup Genlist
17353     */
17354    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17355    /**
17356     * Remove all sub-items (children) of the given item
17357     *
17358     * @param it The item
17359     *
17360     * This removes all items that are children (and their descendants) of the
17361     * given item @p it.
17362     *
17363     * @see elm_genlist_clear()
17364     * @see elm_genlist_item_del()
17365     *
17366     * @ingroup Genlist
17367     */
17368    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17369    /**
17370     * Set whether a given genlist item is selected or not
17371     *
17372     * @param it The item
17373     * @param selected Use @c EINA_TRUE, to make it selected, @c
17374     * EINA_FALSE to make it unselected
17375     *
17376     * This sets the selected state of an item. If multi selection is
17377     * not enabled on the containing genlist and @p selected is @c
17378     * EINA_TRUE, any other previously selected items will get
17379     * unselected in favor of this new one.
17380     *
17381     * @see elm_genlist_item_selected_get()
17382     *
17383     * @ingroup Genlist
17384     */
17385    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17386    /**
17387     * Get whether a given genlist item is selected or not
17388     *
17389     * @param it The item
17390     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17391     *
17392     * @see elm_genlist_item_selected_set() for more details
17393     *
17394     * @ingroup Genlist
17395     */
17396    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17397    /**
17398     * Sets the expanded state of an item.
17399     *
17400     * @param it The item
17401     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17402     *
17403     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17404     * expanded or not.
17405     *
17406     * The theme will respond to this change visually, and a signal "expanded" or
17407     * "contracted" will be sent from the genlist with a pointer to the item that
17408     * has been expanded/contracted.
17409     *
17410     * Calling this function won't show or hide any child of this item (if it is
17411     * a parent). You must manually delete and create them on the callbacks fo
17412     * the "expanded" or "contracted" signals.
17413     *
17414     * @see elm_genlist_item_expanded_get()
17415     *
17416     * @ingroup Genlist
17417     */
17418    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17419    /**
17420     * Get the expanded state of an item
17421     *
17422     * @param it The item
17423     * @return The expanded state
17424     *
17425     * This gets the expanded state of an item.
17426     *
17427     * @see elm_genlist_item_expanded_set()
17428     *
17429     * @ingroup Genlist
17430     */
17431    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17432    /**
17433     * Get the depth of expanded item
17434     *
17435     * @param it The genlist item object
17436     * @return The depth of expanded item
17437     *
17438     * @ingroup Genlist
17439     */
17440    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17441    /**
17442     * Set whether a given genlist item is disabled or not.
17443     *
17444     * @param it The item
17445     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17446     * to enable it back.
17447     *
17448     * A disabled item cannot be selected or unselected. It will also
17449     * change its appearance, to signal the user it's disabled.
17450     *
17451     * @see elm_genlist_item_disabled_get()
17452     *
17453     * @ingroup Genlist
17454     */
17455    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17456    /**
17457     * Get whether a given genlist item is disabled or not.
17458     *
17459     * @param it The item
17460     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17461     * (and on errors).
17462     *
17463     * @see elm_genlist_item_disabled_set() for more details
17464     *
17465     * @ingroup Genlist
17466     */
17467    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17468    /**
17469     * Sets the display only state of an item.
17470     *
17471     * @param it The item
17472     * @param display_only @c EINA_TRUE if the item is display only, @c
17473     * EINA_FALSE otherwise.
17474     *
17475     * A display only item cannot be selected or unselected. It is for
17476     * display only and not selecting or otherwise clicking, dragging
17477     * etc. by the user, thus finger size rules will not be applied to
17478     * this item.
17479     *
17480     * It's good to set group index items to display only state.
17481     *
17482     * @see elm_genlist_item_display_only_get()
17483     *
17484     * @ingroup Genlist
17485     */
17486    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17487    /**
17488     * Get the display only state of an item
17489     *
17490     * @param it The item
17491     * @return @c EINA_TRUE if the item is display only, @c
17492     * EINA_FALSE otherwise.
17493     *
17494     * @see elm_genlist_item_display_only_set()
17495     *
17496     * @ingroup Genlist
17497     */
17498    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17499    /**
17500     * Show the portion of a genlist's internal list containing a given
17501     * item, immediately.
17502     *
17503     * @param it The item to display
17504     *
17505     * This causes genlist to jump to the given item @p it and show it (by
17506     * immediately scrolling to that position), if it is not fully visible.
17507     *
17508     * @see elm_genlist_item_bring_in()
17509     * @see elm_genlist_item_top_show()
17510     * @see elm_genlist_item_middle_show()
17511     *
17512     * @ingroup Genlist
17513     */
17514    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17515    /**
17516     * Animatedly bring in, to the visible are of a genlist, a given
17517     * item on it.
17518     *
17519     * @param it The item to display
17520     *
17521     * This causes genlist to jump to the given item @p it and show it (by
17522     * animatedly scrolling), if it is not fully visible. This may use animation
17523     * to do so and take a period of time
17524     *
17525     * @see elm_genlist_item_show()
17526     * @see elm_genlist_item_top_bring_in()
17527     * @see elm_genlist_item_middle_bring_in()
17528     *
17529     * @ingroup Genlist
17530     */
17531    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17532    /**
17533     * Show the portion of a genlist's internal list containing a given
17534     * item, immediately.
17535     *
17536     * @param it The item to display
17537     *
17538     * This causes genlist to jump to the given item @p it and show it (by
17539     * immediately scrolling to that position), if it is not fully visible.
17540     *
17541     * The item will be positioned at the top of the genlist viewport.
17542     *
17543     * @see elm_genlist_item_show()
17544     * @see elm_genlist_item_top_bring_in()
17545     *
17546     * @ingroup Genlist
17547     */
17548    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17549    /**
17550     * Animatedly bring in, to the visible are of a genlist, a given
17551     * item on it.
17552     *
17553     * @param it The item
17554     *
17555     * This causes genlist to jump to the given item @p it and show it (by
17556     * animatedly scrolling), if it is not fully visible. This may use animation
17557     * to do so and take a period of time
17558     *
17559     * The item will be positioned at the top of the genlist viewport.
17560     *
17561     * @see elm_genlist_item_bring_in()
17562     * @see elm_genlist_item_top_show()
17563     *
17564     * @ingroup Genlist
17565     */
17566    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17567    /**
17568     * Show the portion of a genlist's internal list containing a given
17569     * item, immediately.
17570     *
17571     * @param it The item to display
17572     *
17573     * This causes genlist to jump to the given item @p it and show it (by
17574     * immediately scrolling to that position), if it is not fully visible.
17575     *
17576     * The item will be positioned at the middle of the genlist viewport.
17577     *
17578     * @see elm_genlist_item_show()
17579     * @see elm_genlist_item_middle_bring_in()
17580     *
17581     * @ingroup Genlist
17582     */
17583    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17584    /**
17585     * Animatedly bring in, to the visible are of a genlist, a given
17586     * item on it.
17587     *
17588     * @param it The item
17589     *
17590     * This causes genlist to jump to the given item @p it and show it (by
17591     * animatedly scrolling), if it is not fully visible. This may use animation
17592     * to do so and take a period of time
17593     *
17594     * The item will be positioned at the middle of the genlist viewport.
17595     *
17596     * @see elm_genlist_item_bring_in()
17597     * @see elm_genlist_item_middle_show()
17598     *
17599     * @ingroup Genlist
17600     */
17601    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17602    /**
17603     * Remove a genlist item from the its parent, deleting it.
17604     *
17605     * @param item The item to be removed.
17606     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17607     *
17608     * @see elm_genlist_clear(), to remove all items in a genlist at
17609     * once.
17610     *
17611     * @ingroup Genlist
17612     */
17613    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17614    /**
17615     * Return the data associated to a given genlist item
17616     *
17617     * @param item The genlist item.
17618     * @return the data associated to this item.
17619     *
17620     * This returns the @c data value passed on the
17621     * elm_genlist_item_append() and related item addition calls.
17622     *
17623     * @see elm_genlist_item_append()
17624     * @see elm_genlist_item_data_set()
17625     *
17626     * @ingroup Genlist
17627     */
17628    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17629    /**
17630     * Set the data associated to a given genlist item
17631     *
17632     * @param item The genlist item
17633     * @param data The new data pointer to set on it
17634     *
17635     * This @b overrides the @c data value passed on the
17636     * elm_genlist_item_append() and related item addition calls. This
17637     * function @b won't call elm_genlist_item_update() automatically,
17638     * so you'd issue it afterwards if you want to hove the item
17639     * updated to reflect the that new data.
17640     *
17641     * @see elm_genlist_item_data_get()
17642     *
17643     * @ingroup Genlist
17644     */
17645    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17646    /**
17647     * Tells genlist to "orphan" icons fetchs by the item class
17648     *
17649     * @param it The item
17650     *
17651     * This instructs genlist to release references to icons in the item,
17652     * meaning that they will no longer be managed by genlist and are
17653     * floating "orphans" that can be re-used elsewhere if the user wants
17654     * to.
17655     *
17656     * @ingroup Genlist
17657     */
17658    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17659    /**
17660     * Get the real Evas object created to implement the view of a
17661     * given genlist item
17662     *
17663     * @param item The genlist item.
17664     * @return the Evas object implementing this item's view.
17665     *
17666     * This returns the actual Evas object used to implement the
17667     * specified genlist item's view. This may be @c NULL, as it may
17668     * not have been created or may have been deleted, at any time, by
17669     * the genlist. <b>Do not modify this object</b> (move, resize,
17670     * show, hide, etc.), as the genlist is controlling it. This
17671     * function is for querying, emitting custom signals or hooking
17672     * lower level callbacks for events on that object. Do not delete
17673     * this object under any circumstances.
17674     *
17675     * @see elm_genlist_item_data_get()
17676     *
17677     * @ingroup Genlist
17678     */
17679    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17680    /**
17681     * Update the contents of an item
17682     *
17683     * @param it The item
17684     *
17685     * This updates an item by calling all the item class functions again
17686     * to get the icons, labels and states. Use this when the original
17687     * item data has changed and the changes are desired to be reflected.
17688     *
17689     * Use elm_genlist_realized_items_update() to update all already realized
17690     * items.
17691     *
17692     * @see elm_genlist_realized_items_update()
17693     *
17694     * @ingroup Genlist
17695     */
17696    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17697    /**
17698     * Update the item class of an item
17699     *
17700     * @param it The item
17701     * @param itc The item class for the item
17702     *
17703     * This sets another class fo the item, changing the way that it is
17704     * displayed. After changing the item class, elm_genlist_item_update() is
17705     * called on the item @p it.
17706     *
17707     * @ingroup Genlist
17708     */
17709    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17710    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17711    /**
17712     * Set the text to be shown in a given genlist item's tooltips.
17713     *
17714     * @param item The genlist item
17715     * @param text The text to set in the content
17716     *
17717     * This call will setup the text to be used as tooltip to that item
17718     * (analogous to elm_object_tooltip_text_set(), but being item
17719     * tooltips with higher precedence than object tooltips). It can
17720     * have only one tooltip at a time, so any previous tooltip data
17721     * will get removed.
17722     *
17723     * In order to set an icon or something else as a tooltip, look at
17724     * elm_genlist_item_tooltip_content_cb_set().
17725     *
17726     * @ingroup Genlist
17727     */
17728    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17729    /**
17730     * Set the content to be shown in a given genlist item's tooltips
17731     *
17732     * @param item The genlist item.
17733     * @param func The function returning the tooltip contents.
17734     * @param data What to provide to @a func as callback data/context.
17735     * @param del_cb Called when data is not needed anymore, either when
17736     *        another callback replaces @p func, the tooltip is unset with
17737     *        elm_genlist_item_tooltip_unset() or the owner @p item
17738     *        dies. This callback receives as its first parameter the
17739     *        given @p data, being @c event_info the item handle.
17740     *
17741     * This call will setup the tooltip's contents to @p item
17742     * (analogous to elm_object_tooltip_content_cb_set(), but being
17743     * item tooltips with higher precedence than object tooltips). It
17744     * can have only one tooltip at a time, so any previous tooltip
17745     * content will get removed. @p func (with @p data) will be called
17746     * every time Elementary needs to show the tooltip and it should
17747     * return a valid Evas object, which will be fully managed by the
17748     * tooltip system, getting deleted when the tooltip is gone.
17749     *
17750     * In order to set just a text as a tooltip, look at
17751     * elm_genlist_item_tooltip_text_set().
17752     *
17753     * @ingroup Genlist
17754     */
17755    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);
17756    /**
17757     * Unset a tooltip from a given genlist item
17758     *
17759     * @param item genlist item to remove a previously set tooltip from.
17760     *
17761     * This call removes any tooltip set on @p item. The callback
17762     * provided as @c del_cb to
17763     * elm_genlist_item_tooltip_content_cb_set() will be called to
17764     * notify it is not used anymore (and have resources cleaned, if
17765     * need be).
17766     *
17767     * @see elm_genlist_item_tooltip_content_cb_set()
17768     *
17769     * @ingroup Genlist
17770     */
17771    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17772    /**
17773     * Set a different @b style for a given genlist item's tooltip.
17774     *
17775     * @param item genlist item with tooltip set
17776     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17777     * "default", @c "transparent", etc)
17778     *
17779     * Tooltips can have <b>alternate styles</b> to be displayed on,
17780     * which are defined by the theme set on Elementary. This function
17781     * works analogously as elm_object_tooltip_style_set(), but here
17782     * applied only to genlist item objects. The default style for
17783     * tooltips is @c "default".
17784     *
17785     * @note before you set a style you should define a tooltip with
17786     *       elm_genlist_item_tooltip_content_cb_set() or
17787     *       elm_genlist_item_tooltip_text_set()
17788     *
17789     * @see elm_genlist_item_tooltip_style_get()
17790     *
17791     * @ingroup Genlist
17792     */
17793    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17794    /**
17795     * Get the style set a given genlist item's tooltip.
17796     *
17797     * @param item genlist item with tooltip already set on.
17798     * @return style the theme style in use, which defaults to
17799     *         "default". If the object does not have a tooltip set,
17800     *         then @c NULL is returned.
17801     *
17802     * @see elm_genlist_item_tooltip_style_set() for more details
17803     *
17804     * @ingroup Genlist
17805     */
17806    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17807    /**
17808     * @brief Disable size restrictions on an object's tooltip
17809     * @param item The tooltip's anchor object
17810     * @param disable If EINA_TRUE, size restrictions are disabled
17811     * @return EINA_FALSE on failure, EINA_TRUE on success
17812     *
17813     * This function allows a tooltip to expand beyond its parant window's canvas.
17814     * It will instead be limited only by the size of the display.
17815     */
17816    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17817    /**
17818     * @brief Retrieve size restriction state of an object's tooltip
17819     * @param item The tooltip's anchor object
17820     * @return If EINA_TRUE, size restrictions are disabled
17821     *
17822     * This function returns whether a tooltip is allowed to expand beyond
17823     * its parant window's canvas.
17824     * It will instead be limited only by the size of the display.
17825     */
17826    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17827    /**
17828     * Set the type of mouse pointer/cursor decoration to be shown,
17829     * when the mouse pointer is over the given genlist widget item
17830     *
17831     * @param item genlist item to customize cursor on
17832     * @param cursor the cursor type's name
17833     *
17834     * This function works analogously as elm_object_cursor_set(), but
17835     * here the cursor's changing area is restricted to the item's
17836     * area, and not the whole widget's. Note that that item cursors
17837     * have precedence over widget cursors, so that a mouse over @p
17838     * item will always show cursor @p type.
17839     *
17840     * If this function is called twice for an object, a previously set
17841     * cursor will be unset on the second call.
17842     *
17843     * @see elm_object_cursor_set()
17844     * @see elm_genlist_item_cursor_get()
17845     * @see elm_genlist_item_cursor_unset()
17846     *
17847     * @ingroup Genlist
17848     */
17849    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17850    /**
17851     * Get the type of mouse pointer/cursor decoration set to be shown,
17852     * when the mouse pointer is over the given genlist widget item
17853     *
17854     * @param item genlist item with custom cursor set
17855     * @return the cursor type's name or @c NULL, if no custom cursors
17856     * were set to @p item (and on errors)
17857     *
17858     * @see elm_object_cursor_get()
17859     * @see elm_genlist_item_cursor_set() for more details
17860     * @see elm_genlist_item_cursor_unset()
17861     *
17862     * @ingroup Genlist
17863     */
17864    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17865    /**
17866     * Unset any custom mouse pointer/cursor decoration set to be
17867     * shown, when the mouse pointer is over the given genlist widget
17868     * item, thus making it show the @b default cursor again.
17869     *
17870     * @param item a genlist item
17871     *
17872     * Use this call to undo any custom settings on this item's cursor
17873     * decoration, bringing it back to defaults (no custom style set).
17874     *
17875     * @see elm_object_cursor_unset()
17876     * @see elm_genlist_item_cursor_set() for more details
17877     *
17878     * @ingroup Genlist
17879     */
17880    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17881    /**
17882     * Set a different @b style for a given custom cursor set for a
17883     * genlist item.
17884     *
17885     * @param item genlist item with custom cursor set
17886     * @param style the <b>theme style</b> to use (e.g. @c "default",
17887     * @c "transparent", etc)
17888     *
17889     * This function only makes sense when one is using custom mouse
17890     * cursor decorations <b>defined in a theme file</b> , which can
17891     * have, given a cursor name/type, <b>alternate styles</b> on
17892     * it. It works analogously as elm_object_cursor_style_set(), but
17893     * here applied only to genlist item objects.
17894     *
17895     * @warning Before you set a cursor style you should have defined a
17896     *       custom cursor previously on the item, with
17897     *       elm_genlist_item_cursor_set()
17898     *
17899     * @see elm_genlist_item_cursor_engine_only_set()
17900     * @see elm_genlist_item_cursor_style_get()
17901     *
17902     * @ingroup Genlist
17903     */
17904    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17905    /**
17906     * Get the current @b style set for a given genlist item's custom
17907     * cursor
17908     *
17909     * @param item genlist item with custom cursor set.
17910     * @return style the cursor style in use. If the object does not
17911     *         have a cursor set, then @c NULL is returned.
17912     *
17913     * @see elm_genlist_item_cursor_style_set() for more details
17914     *
17915     * @ingroup Genlist
17916     */
17917    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17918    /**
17919     * Set if the (custom) cursor for a given genlist item should be
17920     * searched in its theme, also, or should only rely on the
17921     * rendering engine.
17922     *
17923     * @param item item with custom (custom) cursor already set on
17924     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17925     * only on those provided by the rendering engine, @c EINA_FALSE to
17926     * have them searched on the widget's theme, as well.
17927     *
17928     * @note This call is of use only if you've set a custom cursor
17929     * for genlist items, with elm_genlist_item_cursor_set().
17930     *
17931     * @note By default, cursors will only be looked for between those
17932     * provided by the rendering engine.
17933     *
17934     * @ingroup Genlist
17935     */
17936    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17937    /**
17938     * Get if the (custom) cursor for a given genlist item is being
17939     * searched in its theme, also, or is only relying on the rendering
17940     * engine.
17941     *
17942     * @param item a genlist item
17943     * @return @c EINA_TRUE, if cursors are being looked for only on
17944     * those provided by the rendering engine, @c EINA_FALSE if they
17945     * are being searched on the widget's theme, as well.
17946     *
17947     * @see elm_genlist_item_cursor_engine_only_set(), for more details
17948     *
17949     * @ingroup Genlist
17950     */
17951    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17952    /**
17953     * Update the contents of all realized items.
17954     *
17955     * @param obj The genlist object.
17956     *
17957     * This updates all realized items by calling all the item class functions again
17958     * to get the icons, labels and states. Use this when the original
17959     * item data has changed and the changes are desired to be reflected.
17960     *
17961     * To update just one item, use elm_genlist_item_update().
17962     *
17963     * @see elm_genlist_realized_items_get()
17964     * @see elm_genlist_item_update()
17965     *
17966     * @ingroup Genlist
17967     */
17968    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
17969    /**
17970     * Activate a genlist mode on an item
17971     *
17972     * @param item The genlist item
17973     * @param mode Mode name
17974     * @param mode_set Boolean to define set or unset mode.
17975     *
17976     * A genlist mode is a different way of selecting an item. Once a mode is
17977     * activated on an item, any other selected item is immediately unselected.
17978     * This feature provides an easy way of implementing a new kind of animation
17979     * for selecting an item, without having to entirely rewrite the item style
17980     * theme. However, the elm_genlist_selected_* API can't be used to get what
17981     * item is activate for a mode.
17982     *
17983     * The current item style will still be used, but applying a genlist mode to
17984     * an item will select it using a different kind of animation.
17985     *
17986     * The current active item for a mode can be found by
17987     * elm_genlist_mode_item_get().
17988     *
17989     * The characteristics of genlist mode are:
17990     * - Only one mode can be active at any time, and for only one item.
17991     * - Genlist handles deactivating other items when one item is activated.
17992     * - A mode is defined in the genlist theme (edc), and more modes can easily
17993     *   be added.
17994     * - A mode style and the genlist item style are different things. They
17995     *   can be combined to provide a default style to the item, with some kind
17996     *   of animation for that item when the mode is activated.
17997     *
17998     * When a mode is activated on an item, a new view for that item is created.
17999     * The theme of this mode defines the animation that will be used to transit
18000     * the item from the old view to the new view. This second (new) view will be
18001     * active for that item while the mode is active on the item, and will be
18002     * destroyed after the mode is totally deactivated from that item.
18003     *
18004     * @see elm_genlist_mode_get()
18005     * @see elm_genlist_mode_item_get()
18006     *
18007     * @ingroup Genlist
18008     */
18009    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18010    /**
18011     * Get the last (or current) genlist mode used.
18012     *
18013     * @param obj The genlist object
18014     *
18015     * This function just returns the name of the last used genlist mode. It will
18016     * be the current mode if it's still active.
18017     *
18018     * @see elm_genlist_item_mode_set()
18019     * @see elm_genlist_mode_item_get()
18020     *
18021     * @ingroup Genlist
18022     */
18023    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18024    /**
18025     * Get active genlist mode item
18026     *
18027     * @param obj The genlist object
18028     * @return The active item for that current mode. Or @c NULL if no item is
18029     * activated with any mode.
18030     *
18031     * This function returns the item that was activated with a mode, by the
18032     * function elm_genlist_item_mode_set().
18033     *
18034     * @see elm_genlist_item_mode_set()
18035     * @see elm_genlist_mode_get()
18036     *
18037     * @ingroup Genlist
18038     */
18039    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18040
18041    /**
18042     * Set reorder mode
18043     *
18044     * @param obj The genlist object
18045     * @param reorder_mode The reorder mode
18046     * (EINA_TRUE = on, EINA_FALSE = off)
18047     *
18048     * @ingroup Genlist
18049     */
18050    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18051
18052    /**
18053     * Get the reorder mode
18054     *
18055     * @param obj The genlist object
18056     * @return The reorder mode
18057     * (EINA_TRUE = on, EINA_FALSE = off)
18058     *
18059     * @ingroup Genlist
18060     */
18061    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18062
18063    /**
18064     * @}
18065     */
18066
18067    /**
18068     * @defgroup Check Check
18069     *
18070     * @image html img/widget/check/preview-00.png
18071     * @image latex img/widget/check/preview-00.eps
18072     * @image html img/widget/check/preview-01.png
18073     * @image latex img/widget/check/preview-01.eps
18074     * @image html img/widget/check/preview-02.png
18075     * @image latex img/widget/check/preview-02.eps
18076     *
18077     * @brief The check widget allows for toggling a value between true and
18078     * false.
18079     *
18080     * Check objects are a lot like radio objects in layout and functionality
18081     * except they do not work as a group, but independently and only toggle the
18082     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18083     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18084     * returns the current state. For convenience, like the radio objects, you
18085     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18086     * for it to modify.
18087     *
18088     * Signals that you can add callbacks for are:
18089     * "changed" - This is called whenever the user changes the state of one of
18090     *             the check object(event_info is NULL).
18091     *
18092     * @ref tutorial_check should give you a firm grasp of how to use this widget.
18093     * @{
18094     */
18095    /**
18096     * @brief Add a new Check object
18097     *
18098     * @param parent The parent object
18099     * @return The new object or NULL if it cannot be created
18100     */
18101    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18102    /**
18103     * @brief Set the text label of the check object
18104     *
18105     * @param obj The check object
18106     * @param label The text label string in UTF-8
18107     *
18108     * @deprecated use elm_object_text_set() instead.
18109     */
18110    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18111    /**
18112     * @brief Get the text label of the check object
18113     *
18114     * @param obj The check object
18115     * @return The text label string in UTF-8
18116     *
18117     * @deprecated use elm_object_text_get() instead.
18118     */
18119    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18120    /**
18121     * @brief Set the icon object of the check object
18122     *
18123     * @param obj The check object
18124     * @param icon The icon object
18125     *
18126     * Once the icon object is set, a previously set one will be deleted.
18127     * If you want to keep that old content object, use the
18128     * elm_check_icon_unset() function.
18129     */
18130    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18131    /**
18132     * @brief Get the icon object of the check object
18133     *
18134     * @param obj The check object
18135     * @return The icon object
18136     */
18137    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18138    /**
18139     * @brief Unset the icon used for the check object
18140     *
18141     * @param obj The check object
18142     * @return The icon object that was being used
18143     *
18144     * Unparent and return the icon object which was set for this widget.
18145     */
18146    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18147    /**
18148     * @brief Set the on/off state of the check object
18149     *
18150     * @param obj The check object
18151     * @param state The state to use (1 == on, 0 == off)
18152     *
18153     * This sets the state of the check. If set
18154     * with elm_check_state_pointer_set() the state of that variable is also
18155     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18156     */
18157    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18158    /**
18159     * @brief Get the state of the check object
18160     *
18161     * @param obj The check object
18162     * @return The boolean state
18163     */
18164    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18165    /**
18166     * @brief Set a convenience pointer to a boolean to change
18167     *
18168     * @param obj The check object
18169     * @param statep Pointer to the boolean to modify
18170     *
18171     * This sets a pointer to a boolean, that, in addition to the check objects
18172     * state will also be modified directly. To stop setting the object pointed
18173     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18174     * then when this is called, the check objects state will also be modified to
18175     * reflect the value of the boolean @p statep points to, just like calling
18176     * elm_check_state_set().
18177     */
18178    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18179    /**
18180     * @}
18181     */
18182
18183    /**
18184     * @defgroup Radio Radio
18185     *
18186     * @image html img/widget/radio/preview-00.png
18187     * @image latex img/widget/radio/preview-00.eps
18188     *
18189     * @brief Radio is a widget that allows for 1 or more options to be displayed
18190     * and have the user choose only 1 of them.
18191     *
18192     * A radio object contains an indicator, an optional Label and an optional
18193     * icon object. While it's possible to have a group of only one radio they,
18194     * are normally used in groups of 2 or more. To add a radio to a group use
18195     * elm_radio_group_add(). The radio object(s) will select from one of a set
18196     * of integer values, so any value they are configuring needs to be mapped to
18197     * a set of integers. To configure what value that radio object represents,
18198     * use  elm_radio_state_value_set() to set the integer it represents. To set
18199     * the value the whole group(which one is currently selected) is to indicate
18200     * use elm_radio_value_set() on any group member, and to get the groups value
18201     * use elm_radio_value_get(). For convenience the radio objects are also able
18202     * to directly set an integer(int) to the value that is selected. To specify
18203     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18204     * The radio objects will modify this directly. That implies the pointer must
18205     * point to valid memory for as long as the radio objects exist.
18206     *
18207     * Signals that you can add callbacks for are:
18208     * @li changed - This is called whenever the user changes the state of one of
18209     * the radio objects within the group of radio objects that work together.
18210     *
18211     * @ref tutorial_radio show most of this API in action.
18212     * @{
18213     */
18214    /**
18215     * @brief Add a new radio to the parent
18216     *
18217     * @param parent The parent object
18218     * @return The new object or NULL if it cannot be created
18219     */
18220    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18221    /**
18222     * @brief Set the text label of the radio object
18223     *
18224     * @param obj The radio object
18225     * @param label The text label string in UTF-8
18226     *
18227     * @deprecated use elm_object_text_set() instead.
18228     */
18229    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18230    /**
18231     * @brief Get the text label of the radio object
18232     *
18233     * @param obj The radio object
18234     * @return The text label string in UTF-8
18235     *
18236     * @deprecated use elm_object_text_set() instead.
18237     */
18238    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18239    /**
18240     * @brief Set the icon object of the radio object
18241     *
18242     * @param obj The radio object
18243     * @param icon The icon object
18244     *
18245     * Once the icon object is set, a previously set one will be deleted. If you
18246     * want to keep that old content object, use the elm_radio_icon_unset()
18247     * function.
18248     */
18249    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18250    /**
18251     * @brief Get the icon object of the radio object
18252     *
18253     * @param obj The radio object
18254     * @return The icon object
18255     *
18256     * @see elm_radio_icon_set()
18257     */
18258    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18259    /**
18260     * @brief Unset the icon used for the radio object
18261     *
18262     * @param obj The radio object
18263     * @return The icon object that was being used
18264     *
18265     * Unparent and return the icon object which was set for this widget.
18266     *
18267     * @see elm_radio_icon_set()
18268     */
18269    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18270    /**
18271     * @brief Add this radio to a group of other radio objects
18272     *
18273     * @param obj The radio object
18274     * @param group Any object whose group the @p obj is to join.
18275     *
18276     * Radio objects work in groups. Each member should have a different integer
18277     * value assigned. In order to have them work as a group, they need to know
18278     * about each other. This adds the given radio object to the group of which
18279     * the group object indicated is a member.
18280     */
18281    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18282    /**
18283     * @brief Set the integer value that this radio object represents
18284     *
18285     * @param obj The radio object
18286     * @param value The value to use if this radio object is selected
18287     *
18288     * This sets the value of the radio.
18289     */
18290    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18291    /**
18292     * @brief Get the integer value that this radio object represents
18293     *
18294     * @param obj The radio object
18295     * @return The value used if this radio object is selected
18296     *
18297     * This gets the value of the radio.
18298     *
18299     * @see elm_radio_value_set()
18300     */
18301    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18302    /**
18303     * @brief Set the value of the radio.
18304     *
18305     * @param obj The radio object
18306     * @param value The value to use for the group
18307     *
18308     * This sets the value of the radio group and will also set the value if
18309     * pointed to, to the value supplied, but will not call any callbacks.
18310     */
18311    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18312    /**
18313     * @brief Get the state of the radio object
18314     *
18315     * @param obj The radio object
18316     * @return The integer state
18317     */
18318    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18319    /**
18320     * @brief Set a convenience pointer to a integer to change
18321     *
18322     * @param obj The radio object
18323     * @param valuep Pointer to the integer to modify
18324     *
18325     * This sets a pointer to a integer, that, in addition to the radio objects
18326     * state will also be modified directly. To stop setting the object pointed
18327     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18328     * when this is called, the radio objects state will also be modified to
18329     * reflect the value of the integer valuep points to, just like calling
18330     * elm_radio_value_set().
18331     */
18332    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18333    /**
18334     * @}
18335     */
18336
18337    /**
18338     * @defgroup Pager Pager
18339     *
18340     * @image html img/widget/pager/preview-00.png
18341     * @image latex img/widget/pager/preview-00.eps
18342     *
18343     * @brief Widget that allows flipping between 1 or more “pages” of objects.
18344     *
18345     * The flipping between “pages” of objects is animated. All content in pager
18346     * is kept in a stack, the last content to be added will be on the top of the
18347     * stack(be visible).
18348     *
18349     * Objects can be pushed or popped from the stack or deleted as normal.
18350     * Pushes and pops will animate (and a pop will delete the object once the
18351     * animation is finished). Any object already in the pager can be promoted to
18352     * the top(from its current stacking position) through the use of
18353     * elm_pager_content_promote(). Objects are pushed to the top with
18354     * elm_pager_content_push() and when the top item is no longer wanted, simply
18355     * pop it with elm_pager_content_pop() and it will also be deleted. If an
18356     * object is no longer needed and is not the top item, just delete it as
18357     * normal. You can query which objects are the top and bottom with
18358     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18359     *
18360     * Signals that you can add callbacks for are:
18361     * "hide,finished" - when the previous page is hided
18362     *
18363     * This widget has the following styles available:
18364     * @li default
18365     * @li fade
18366     * @li fade_translucide
18367     * @li fade_invisible
18368     * @note This styles affect only the flipping animations, the appearance when
18369     * not animating is unaffected by styles.
18370     *
18371     * @ref tutorial_pager gives a good overview of the usage of the API.
18372     * @{
18373     */
18374    /**
18375     * Add a new pager to the parent
18376     *
18377     * @param parent The parent object
18378     * @return The new object or NULL if it cannot be created
18379     *
18380     * @ingroup Pager
18381     */
18382    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18383    /**
18384     * @brief Push an object to the top of the pager stack (and show it).
18385     *
18386     * @param obj The pager object
18387     * @param content The object to push
18388     *
18389     * The object pushed becomes a child of the pager, it will be controlled and
18390     * deleted when the pager is deleted.
18391     *
18392     * @note If the content is already in the stack use
18393     * elm_pager_content_promote().
18394     * @warning Using this function on @p content already in the stack results in
18395     * undefined behavior.
18396     */
18397    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18398    /**
18399     * @brief Pop the object that is on top of the stack
18400     *
18401     * @param obj The pager object
18402     *
18403     * This pops the object that is on the top(visible) of the pager, makes it
18404     * disappear, then deletes the object. The object that was underneath it on
18405     * the stack will become visible.
18406     */
18407    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18408    /**
18409     * @brief Moves an object already in the pager stack to the top of the stack.
18410     *
18411     * @param obj The pager object
18412     * @param content The object to promote
18413     *
18414     * This will take the @p content and move it to the top of the stack as
18415     * if it had been pushed there.
18416     *
18417     * @note If the content isn't already in the stack use
18418     * elm_pager_content_push().
18419     * @warning Using this function on @p content not already in the stack
18420     * results in undefined behavior.
18421     */
18422    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18423    /**
18424     * @brief Return the object at the bottom of the pager stack
18425     *
18426     * @param obj The pager object
18427     * @return The bottom object or NULL if none
18428     */
18429    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18430    /**
18431     * @brief  Return the object at the top of the pager stack
18432     *
18433     * @param obj The pager object
18434     * @return The top object or NULL if none
18435     */
18436    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18437    /**
18438     * @}
18439     */
18440
18441    /**
18442     * @defgroup Slideshow Slideshow
18443     *
18444     * @image html img/widget/slideshow/preview-00.png
18445     * @image latex img/widget/slideshow/preview-00.eps
18446     *
18447     * This widget, as the name indicates, is a pre-made image
18448     * slideshow panel, with API functions acting on (child) image
18449     * items presentation. Between those actions, are:
18450     * - advance to next/previous image
18451     * - select the style of image transition animation
18452     * - set the exhibition time for each image
18453     * - start/stop the slideshow
18454     *
18455     * The transition animations are defined in the widget's theme,
18456     * consequently new animations can be added without having to
18457     * update the widget's code.
18458     *
18459     * @section Slideshow_Items Slideshow items
18460     *
18461     * For slideshow items, just like for @ref Genlist "genlist" ones,
18462     * the user defines a @b classes, specifying functions that will be
18463     * called on the item's creation and deletion times.
18464     *
18465     * The #Elm_Slideshow_Item_Class structure contains the following
18466     * members:
18467     *
18468     * - @c func.get - When an item is displayed, this function is
18469     *   called, and it's where one should create the item object, de
18470     *   facto. For example, the object can be a pure Evas image object
18471     *   or an Elementary @ref Photocam "photocam" widget. See
18472     *   #SlideshowItemGetFunc.
18473     * - @c func.del - When an item is no more displayed, this function
18474     *   is called, where the user must delete any data associated to
18475     *   the item. See #SlideshowItemDelFunc.
18476     *
18477     * @section Slideshow_Caching Slideshow caching
18478     *
18479     * The slideshow provides facilities to have items adjacent to the
18480     * one being displayed <b>already "realized"</b> (i.e. loaded) for
18481     * you, so that the system does not have to decode image data
18482     * anymore at the time it has to actually switch images on its
18483     * viewport. The user is able to set the numbers of items to be
18484     * cached @b before and @b after the current item, in the widget's
18485     * item list.
18486     *
18487     * Smart events one can add callbacks for are:
18488     *
18489     * - @c "changed" - when the slideshow switches its view to a new
18490     *   item
18491     *
18492     * List of examples for the slideshow widget:
18493     * @li @ref slideshow_example
18494     */
18495
18496    /**
18497     * @addtogroup Slideshow
18498     * @{
18499     */
18500
18501    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18502    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18503    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
18504    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18505    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18506
18507    /**
18508     * @struct _Elm_Slideshow_Item_Class
18509     *
18510     * Slideshow item class definition. See @ref Slideshow_Items for
18511     * field details.
18512     */
18513    struct _Elm_Slideshow_Item_Class
18514      {
18515         struct _Elm_Slideshow_Item_Class_Func
18516           {
18517              SlideshowItemGetFunc get;
18518              SlideshowItemDelFunc del;
18519           } func;
18520      }; /**< #Elm_Slideshow_Item_Class member definitions */
18521
18522    /**
18523     * Add a new slideshow widget to the given parent Elementary
18524     * (container) object
18525     *
18526     * @param parent The parent object
18527     * @return A new slideshow widget handle or @c NULL, on errors
18528     *
18529     * This function inserts a new slideshow widget on the canvas.
18530     *
18531     * @ingroup Slideshow
18532     */
18533    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18534
18535    /**
18536     * Add (append) a new item in a given slideshow widget.
18537     *
18538     * @param obj The slideshow object
18539     * @param itc The item class for the item
18540     * @param data The item's data
18541     * @return A handle to the item added or @c NULL, on errors
18542     *
18543     * Add a new item to @p obj's internal list of items, appending it.
18544     * The item's class must contain the function really fetching the
18545     * image object to show for this item, which could be an Evas image
18546     * object or an Elementary photo, for example. The @p data
18547     * parameter is going to be passed to both class functions of the
18548     * item.
18549     *
18550     * @see #Elm_Slideshow_Item_Class
18551     * @see elm_slideshow_item_sorted_insert()
18552     *
18553     * @ingroup Slideshow
18554     */
18555    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18556
18557    /**
18558     * Insert a new item into the given slideshow widget, using the @p func
18559     * function to sort items (by item handles).
18560     *
18561     * @param obj The slideshow object
18562     * @param itc The item class for the item
18563     * @param data The item's data
18564     * @param func The comparing function to be used to sort slideshow
18565     * items <b>by #Elm_Slideshow_Item item handles</b>
18566     * @return Returns The slideshow item handle, on success, or
18567     * @c NULL, on errors
18568     *
18569     * Add a new item to @p obj's internal list of items, in a position
18570     * determined by the @p func comparing function. The item's class
18571     * must contain the function really fetching the image object to
18572     * show for this item, which could be an Evas image object or an
18573     * Elementary photo, for example. The @p data parameter is going to
18574     * be passed to both class functions of the item.
18575     *
18576     * @see #Elm_Slideshow_Item_Class
18577     * @see elm_slideshow_item_add()
18578     *
18579     * @ingroup Slideshow
18580     */
18581    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);
18582
18583    /**
18584     * Display a given slideshow widget's item, programmatically.
18585     *
18586     * @param obj The slideshow object
18587     * @param item The item to display on @p obj's viewport
18588     *
18589     * The change between the current item and @p item will use the
18590     * transition @p obj is set to use (@see
18591     * elm_slideshow_transition_set()).
18592     *
18593     * @ingroup Slideshow
18594     */
18595    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18596
18597    /**
18598     * Slide to the @b next item, in a given slideshow widget
18599     *
18600     * @param obj The slideshow object
18601     *
18602     * The sliding animation @p obj is set to use will be the
18603     * transition effect used, after this call is issued.
18604     *
18605     * @note If the end of the slideshow's internal list of items is
18606     * reached, it'll wrap around to the list's beginning, again.
18607     *
18608     * @ingroup Slideshow
18609     */
18610    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18611
18612    /**
18613     * Slide to the @b previous item, in a given slideshow widget
18614     *
18615     * @param obj The slideshow object
18616     *
18617     * The sliding animation @p obj is set to use will be the
18618     * transition effect used, after this call is issued.
18619     *
18620     * @note If the beginning of the slideshow's internal list of items
18621     * is reached, it'll wrap around to the list's end, again.
18622     *
18623     * @ingroup Slideshow
18624     */
18625    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18626
18627    /**
18628     * Returns the list of sliding transition/effect names available, for a
18629     * given slideshow widget.
18630     *
18631     * @param obj The slideshow object
18632     * @return The list of transitions (list of @b stringshared strings
18633     * as data)
18634     *
18635     * The transitions, which come from @p obj's theme, must be an EDC
18636     * data item named @c "transitions" on the theme file, with (prefix)
18637     * names of EDC programs actually implementing them.
18638     *
18639     * The available transitions for slideshows on the default theme are:
18640     * - @c "fade" - the current item fades out, while the new one
18641     *   fades in to the slideshow's viewport.
18642     * - @c "black_fade" - the current item fades to black, and just
18643     *   then, the new item will fade in.
18644     * - @c "horizontal" - the current item slides horizontally, until
18645     *   it gets out of the slideshow's viewport, while the new item
18646     *   comes from the left to take its place.
18647     * - @c "vertical" - the current item slides vertically, until it
18648     *   gets out of the slideshow's viewport, while the new item comes
18649     *   from the bottom to take its place.
18650     * - @c "square" - the new item starts to appear from the middle of
18651     *   the current one, but with a tiny size, growing until its
18652     *   target (full) size and covering the old one.
18653     *
18654     * @warning The stringshared strings get no new references
18655     * exclusive to the user grabbing the list, here, so if you'd like
18656     * to use them out of this call's context, you'd better @c
18657     * eina_stringshare_ref() them.
18658     *
18659     * @see elm_slideshow_transition_set()
18660     *
18661     * @ingroup Slideshow
18662     */
18663    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18664
18665    /**
18666     * Set the current slide transition/effect in use for a given
18667     * slideshow widget
18668     *
18669     * @param obj The slideshow object
18670     * @param transition The new transition's name string
18671     *
18672     * If @p transition is implemented in @p obj's theme (i.e., is
18673     * contained in the list returned by
18674     * elm_slideshow_transitions_get()), this new sliding effect will
18675     * be used on the widget.
18676     *
18677     * @see elm_slideshow_transitions_get() for more details
18678     *
18679     * @ingroup Slideshow
18680     */
18681    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18682
18683    /**
18684     * Get the current slide transition/effect in use for a given
18685     * slideshow widget
18686     *
18687     * @param obj The slideshow object
18688     * @return The current transition's name
18689     *
18690     * @see elm_slideshow_transition_set() for more details
18691     *
18692     * @ingroup Slideshow
18693     */
18694    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18695
18696    /**
18697     * Set the interval between each image transition on a given
18698     * slideshow widget, <b>and start the slideshow, itself</b>
18699     *
18700     * @param obj The slideshow object
18701     * @param timeout The new displaying timeout for images
18702     *
18703     * After this call, the slideshow widget will start cycling its
18704     * view, sequentially and automatically, with the images of the
18705     * items it has. The time between each new image displayed is going
18706     * to be @p timeout, in @b seconds. If a different timeout was set
18707     * previously and an slideshow was in progress, it will continue
18708     * with the new time between transitions, after this call.
18709     *
18710     * @note A value less than or equal to 0 on @p timeout will disable
18711     * the widget's internal timer, thus halting any slideshow which
18712     * could be happening on @p obj.
18713     *
18714     * @see elm_slideshow_timeout_get()
18715     *
18716     * @ingroup Slideshow
18717     */
18718    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18719
18720    /**
18721     * Get the interval set for image transitions on a given slideshow
18722     * widget.
18723     *
18724     * @param obj The slideshow object
18725     * @return Returns the timeout set on it
18726     *
18727     * @see elm_slideshow_timeout_set() for more details
18728     *
18729     * @ingroup Slideshow
18730     */
18731    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18732
18733    /**
18734     * Set if, after a slideshow is started, for a given slideshow
18735     * widget, its items should be displayed cyclically or not.
18736     *
18737     * @param obj The slideshow object
18738     * @param loop Use @c EINA_TRUE to make it cycle through items or
18739     * @c EINA_FALSE for it to stop at the end of @p obj's internal
18740     * list of items
18741     *
18742     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18743     * ignore what is set by this functions, i.e., they'll @b always
18744     * cycle through items. This affects only the "automatic"
18745     * slideshow, as set by elm_slideshow_timeout_set().
18746     *
18747     * @see elm_slideshow_loop_get()
18748     *
18749     * @ingroup Slideshow
18750     */
18751    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18752
18753    /**
18754     * Get if, after a slideshow is started, for a given slideshow
18755     * widget, its items are to be displayed cyclically or not.
18756     *
18757     * @param obj The slideshow object
18758     * @return @c EINA_TRUE, if the items in @p obj will be cycled
18759     * through or @c EINA_FALSE, otherwise
18760     *
18761     * @see elm_slideshow_loop_set() for more details
18762     *
18763     * @ingroup Slideshow
18764     */
18765    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18766
18767    /**
18768     * Remove all items from a given slideshow widget
18769     *
18770     * @param obj The slideshow object
18771     *
18772     * This removes (and deletes) all items in @p obj, leaving it
18773     * empty.
18774     *
18775     * @see elm_slideshow_item_del(), to remove just one item.
18776     *
18777     * @ingroup Slideshow
18778     */
18779    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18780
18781    /**
18782     * Get the internal list of items in a given slideshow widget.
18783     *
18784     * @param obj The slideshow object
18785     * @return The list of items (#Elm_Slideshow_Item as data) or
18786     * @c NULL on errors.
18787     *
18788     * This list is @b not to be modified in any way and must not be
18789     * freed. Use the list members with functions like
18790     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18791     *
18792     * @warning This list is only valid until @p obj object's internal
18793     * items list is changed. It should be fetched again with another
18794     * call to this function when changes happen.
18795     *
18796     * @ingroup Slideshow
18797     */
18798    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18799
18800    /**
18801     * Delete a given item from a slideshow widget.
18802     *
18803     * @param item The slideshow item
18804     *
18805     * @ingroup Slideshow
18806     */
18807    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18808
18809    /**
18810     * Return the data associated with a given slideshow item
18811     *
18812     * @param item The slideshow item
18813     * @return Returns the data associated to this item
18814     *
18815     * @ingroup Slideshow
18816     */
18817    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18818
18819    /**
18820     * Returns the currently displayed item, in a given slideshow widget
18821     *
18822     * @param obj The slideshow object
18823     * @return A handle to the item being displayed in @p obj or
18824     * @c NULL, if none is (and on errors)
18825     *
18826     * @ingroup Slideshow
18827     */
18828    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18829
18830    /**
18831     * Get the real Evas object created to implement the view of a
18832     * given slideshow item
18833     *
18834     * @param item The slideshow item.
18835     * @return the Evas object implementing this item's view.
18836     *
18837     * This returns the actual Evas object used to implement the
18838     * specified slideshow item's view. This may be @c NULL, as it may
18839     * not have been created or may have been deleted, at any time, by
18840     * the slideshow. <b>Do not modify this object</b> (move, resize,
18841     * show, hide, etc.), as the slideshow is controlling it. This
18842     * function is for querying, emitting custom signals or hooking
18843     * lower level callbacks for events on that object. Do not delete
18844     * this object under any circumstances.
18845     *
18846     * @see elm_slideshow_item_data_get()
18847     *
18848     * @ingroup Slideshow
18849     */
18850    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18851
18852    /**
18853     * Get the the item, in a given slideshow widget, placed at
18854     * position @p nth, in its internal items list
18855     *
18856     * @param obj The slideshow object
18857     * @param nth The number of the item to grab a handle to (0 being
18858     * the first)
18859     * @return The item stored in @p obj at position @p nth or @c NULL,
18860     * if there's no item with that index (and on errors)
18861     *
18862     * @ingroup Slideshow
18863     */
18864    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18865
18866    /**
18867     * Set the current slide layout in use for a given slideshow widget
18868     *
18869     * @param obj The slideshow object
18870     * @param layout The new layout's name string
18871     *
18872     * If @p layout is implemented in @p obj's theme (i.e., is contained
18873     * in the list returned by elm_slideshow_layouts_get()), this new
18874     * images layout will be used on the widget.
18875     *
18876     * @see elm_slideshow_layouts_get() for more details
18877     *
18878     * @ingroup Slideshow
18879     */
18880    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18881
18882    /**
18883     * Get the current slide layout in use for a given slideshow widget
18884     *
18885     * @param obj The slideshow object
18886     * @return The current layout's name
18887     *
18888     * @see elm_slideshow_layout_set() for more details
18889     *
18890     * @ingroup Slideshow
18891     */
18892    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18893
18894    /**
18895     * Returns the list of @b layout names available, for a given
18896     * slideshow widget.
18897     *
18898     * @param obj The slideshow object
18899     * @return The list of layouts (list of @b stringshared strings
18900     * as data)
18901     *
18902     * Slideshow layouts will change how the widget is to dispose each
18903     * image item in its viewport, with regard to cropping, scaling,
18904     * etc.
18905     *
18906     * The layouts, which come from @p obj's theme, must be an EDC
18907     * data item name @c "layouts" on the theme file, with (prefix)
18908     * names of EDC programs actually implementing them.
18909     *
18910     * The available layouts for slideshows on the default theme are:
18911     * - @c "fullscreen" - item images with original aspect, scaled to
18912     *   touch top and down slideshow borders or, if the image's heigh
18913     *   is not enough, left and right slideshow borders.
18914     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
18915     *   one, but always leaving 10% of the slideshow's dimensions of
18916     *   distance between the item image's borders and the slideshow
18917     *   borders, for each axis.
18918     *
18919     * @warning The stringshared strings get no new references
18920     * exclusive to the user grabbing the list, here, so if you'd like
18921     * to use them out of this call's context, you'd better @c
18922     * eina_stringshare_ref() them.
18923     *
18924     * @see elm_slideshow_layout_set()
18925     *
18926     * @ingroup Slideshow
18927     */
18928    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18929
18930    /**
18931     * Set the number of items to cache, on a given slideshow widget,
18932     * <b>before the current item</b>
18933     *
18934     * @param obj The slideshow object
18935     * @param count Number of items to cache before the current one
18936     *
18937     * The default value for this property is @c 2. See
18938     * @ref Slideshow_Caching "slideshow caching" for more details.
18939     *
18940     * @see elm_slideshow_cache_before_get()
18941     *
18942     * @ingroup Slideshow
18943     */
18944    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18945
18946    /**
18947     * Retrieve the number of items to cache, on a given slideshow widget,
18948     * <b>before the current item</b>
18949     *
18950     * @param obj The slideshow object
18951     * @return The number of items set to be cached before the current one
18952     *
18953     * @see elm_slideshow_cache_before_set() for more details
18954     *
18955     * @ingroup Slideshow
18956     */
18957    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18958
18959    /**
18960     * Set the number of items to cache, on a given slideshow widget,
18961     * <b>after the current item</b>
18962     *
18963     * @param obj The slideshow object
18964     * @param count Number of items to cache after the current one
18965     *
18966     * The default value for this property is @c 2. See
18967     * @ref Slideshow_Caching "slideshow caching" for more details.
18968     *
18969     * @see elm_slideshow_cache_after_get()
18970     *
18971     * @ingroup Slideshow
18972     */
18973    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18974
18975    /**
18976     * Retrieve the number of items to cache, on a given slideshow widget,
18977     * <b>after the current item</b>
18978     *
18979     * @param obj The slideshow object
18980     * @return The number of items set to be cached after the current one
18981     *
18982     * @see elm_slideshow_cache_after_set() for more details
18983     *
18984     * @ingroup Slideshow
18985     */
18986    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18987
18988    /**
18989     * Get the number of items stored in a given slideshow widget
18990     *
18991     * @param obj The slideshow object
18992     * @return The number of items on @p obj, at the moment of this call
18993     *
18994     * @ingroup Slideshow
18995     */
18996    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18997
18998    /**
18999     * @}
19000     */
19001
19002    /**
19003     * @defgroup Fileselector File Selector
19004     *
19005     * @image html img/widget/fileselector/preview-00.png
19006     * @image latex img/widget/fileselector/preview-00.eps
19007     *
19008     * A file selector is a widget that allows a user to navigate
19009     * through a file system, reporting file selections back via its
19010     * API.
19011     *
19012     * It contains shortcut buttons for home directory (@c ~) and to
19013     * jump one directory upwards (..), as well as cancel/ok buttons to
19014     * confirm/cancel a given selection. After either one of those two
19015     * former actions, the file selector will issue its @c "done" smart
19016     * callback.
19017     *
19018     * There's a text entry on it, too, showing the name of the current
19019     * selection. There's the possibility of making it editable, so it
19020     * is useful on file saving dialogs on applications, where one
19021     * gives a file name to save contents to, in a given directory in
19022     * the system. This custom file name will be reported on the @c
19023     * "done" smart callback (explained in sequence).
19024     *
19025     * Finally, it has a view to display file system items into in two
19026     * possible forms:
19027     * - list
19028     * - grid
19029     *
19030     * If Elementary is built with support of the Ethumb thumbnailing
19031     * library, the second form of view will display preview thumbnails
19032     * of files which it supports.
19033     *
19034     * Smart callbacks one can register to:
19035     *
19036     * - @c "selected" - the user has clicked on a file (when not in
19037     *      folders-only mode) or directory (when in folders-only mode)
19038     * - @c "directory,open" - the list has been populated with new
19039     *      content (@c event_info is a pointer to the directory's
19040     *      path, a @b stringshared string)
19041     * - @c "done" - the user has clicked on the "ok" or "cancel"
19042     *      buttons (@c event_info is a pointer to the selection's
19043     *      path, a @b stringshared string)
19044     *
19045     * Here is an example on its usage:
19046     * @li @ref fileselector_example
19047     */
19048
19049    /**
19050     * @addtogroup Fileselector
19051     * @{
19052     */
19053
19054    /**
19055     * Defines how a file selector widget is to layout its contents
19056     * (file system entries).
19057     */
19058    typedef enum _Elm_Fileselector_Mode
19059      {
19060         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19061         ELM_FILESELECTOR_GRID, /**< layout as a grid */
19062         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19063      } Elm_Fileselector_Mode;
19064
19065    /**
19066     * Add a new file selector widget to the given parent Elementary
19067     * (container) object
19068     *
19069     * @param parent The parent object
19070     * @return a new file selector widget handle or @c NULL, on errors
19071     *
19072     * This function inserts a new file selector widget on the canvas.
19073     *
19074     * @ingroup Fileselector
19075     */
19076    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19077
19078    /**
19079     * Enable/disable the file name entry box where the user can type
19080     * in a name for a file, in a given file selector widget
19081     *
19082     * @param obj The file selector object
19083     * @param is_save @c EINA_TRUE to make the file selector a "saving
19084     * dialog", @c EINA_FALSE otherwise
19085     *
19086     * Having the entry editable is useful on file saving dialogs on
19087     * applications, where one gives a file name to save contents to,
19088     * in a given directory in the system. This custom file name will
19089     * be reported on the @c "done" smart callback.
19090     *
19091     * @see elm_fileselector_is_save_get()
19092     *
19093     * @ingroup Fileselector
19094     */
19095    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19096
19097    /**
19098     * Get whether the given file selector is in "saving dialog" mode
19099     *
19100     * @param obj The file selector object
19101     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19102     * mode, @c EINA_FALSE otherwise (and on errors)
19103     *
19104     * @see elm_fileselector_is_save_set() for more details
19105     *
19106     * @ingroup Fileselector
19107     */
19108    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19109
19110    /**
19111     * Enable/disable folder-only view for a given file selector widget
19112     *
19113     * @param obj The file selector object
19114     * @param only @c EINA_TRUE to make @p obj only display
19115     * directories, @c EINA_FALSE to make files to be displayed in it
19116     * too
19117     *
19118     * If enabled, the widget's view will only display folder items,
19119     * naturally.
19120     *
19121     * @see elm_fileselector_folder_only_get()
19122     *
19123     * @ingroup Fileselector
19124     */
19125    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19126
19127    /**
19128     * Get whether folder-only view is set for a given file selector
19129     * widget
19130     *
19131     * @param obj The file selector object
19132     * @return only @c EINA_TRUE if @p obj is only displaying
19133     * directories, @c EINA_FALSE if files are being displayed in it
19134     * too (and on errors)
19135     *
19136     * @see elm_fileselector_folder_only_get()
19137     *
19138     * @ingroup Fileselector
19139     */
19140    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19141
19142    /**
19143     * Enable/disable the "ok" and "cancel" buttons on a given file
19144     * selector widget
19145     *
19146     * @param obj The file selector object
19147     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19148     *
19149     * @note A file selector without those buttons will never emit the
19150     * @c "done" smart event, and is only usable if one is just hooking
19151     * to the other two events.
19152     *
19153     * @see elm_fileselector_buttons_ok_cancel_get()
19154     *
19155     * @ingroup Fileselector
19156     */
19157    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19158
19159    /**
19160     * Get whether the "ok" and "cancel" buttons on a given file
19161     * selector widget are being shown.
19162     *
19163     * @param obj The file selector object
19164     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19165     * otherwise (and on errors)
19166     *
19167     * @see elm_fileselector_buttons_ok_cancel_set() for more details
19168     *
19169     * @ingroup Fileselector
19170     */
19171    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19172
19173    /**
19174     * Enable/disable a tree view in the given file selector widget,
19175     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19176     *
19177     * @param obj The file selector object
19178     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19179     * disable
19180     *
19181     * In a tree view, arrows are created on the sides of directories,
19182     * allowing them to expand in place.
19183     *
19184     * @note If it's in other mode, the changes made by this function
19185     * will only be visible when one switches back to "list" mode.
19186     *
19187     * @see elm_fileselector_expandable_get()
19188     *
19189     * @ingroup Fileselector
19190     */
19191    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19192
19193    /**
19194     * Get whether tree view is enabled for the given file selector
19195     * widget
19196     *
19197     * @param obj The file selector object
19198     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19199     * otherwise (and or errors)
19200     *
19201     * @see elm_fileselector_expandable_set() for more details
19202     *
19203     * @ingroup Fileselector
19204     */
19205    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19206
19207    /**
19208     * Set, programmatically, the @b directory that a given file
19209     * selector widget will display contents from
19210     *
19211     * @param obj The file selector object
19212     * @param path The path to display in @p obj
19213     *
19214     * This will change the @b directory that @p obj is displaying. It
19215     * will also clear the text entry area on the @p obj object, which
19216     * displays select files' names.
19217     *
19218     * @see elm_fileselector_path_get()
19219     *
19220     * @ingroup Fileselector
19221     */
19222    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19223
19224    /**
19225     * Get the parent directory's path that a given file selector
19226     * widget is displaying
19227     *
19228     * @param obj The file selector object
19229     * @return The (full) path of the directory the file selector is
19230     * displaying, a @b stringshared string
19231     *
19232     * @see elm_fileselector_path_set()
19233     *
19234     * @ingroup Fileselector
19235     */
19236    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19237
19238    /**
19239     * Set, programmatically, the currently selected file/directory in
19240     * the given file selector widget
19241     *
19242     * @param obj The file selector object
19243     * @param path The (full) path to a file or directory
19244     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19245     * latter case occurs if the directory or file pointed to do not
19246     * exist.
19247     *
19248     * @see elm_fileselector_selected_get()
19249     *
19250     * @ingroup Fileselector
19251     */
19252    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19253
19254    /**
19255     * Get the currently selected item's (full) path, in the given file
19256     * selector widget
19257     *
19258     * @param obj The file selector object
19259     * @return The absolute path of the selected item, a @b
19260     * stringshared string
19261     *
19262     * @note Custom editions on @p obj object's text entry, if made,
19263     * will appear on the return string of this function, naturally.
19264     *
19265     * @see elm_fileselector_selected_set() for more details
19266     *
19267     * @ingroup Fileselector
19268     */
19269    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19270
19271    /**
19272     * Set the mode in which a given file selector widget will display
19273     * (layout) file system entries in its view
19274     *
19275     * @param obj The file selector object
19276     * @param mode The mode of the fileselector, being it one of
19277     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19278     * first one, naturally, will display the files in a list. The
19279     * latter will make the widget to display its entries in a grid
19280     * form.
19281     *
19282     * @note By using elm_fileselector_expandable_set(), the user may
19283     * trigger a tree view for that list.
19284     *
19285     * @note If Elementary is built with support of the Ethumb
19286     * thumbnailing library, the second form of view will display
19287     * preview thumbnails of files which it supports. You must have
19288     * elm_need_ethumb() called in your Elementary for thumbnailing to
19289     * work, though.
19290     *
19291     * @see elm_fileselector_expandable_set().
19292     * @see elm_fileselector_mode_get().
19293     *
19294     * @ingroup Fileselector
19295     */
19296    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19297
19298    /**
19299     * Get the mode in which a given file selector widget is displaying
19300     * (layouting) file system entries in its view
19301     *
19302     * @param obj The fileselector object
19303     * @return The mode in which the fileselector is at
19304     *
19305     * @see elm_fileselector_mode_set() for more details
19306     *
19307     * @ingroup Fileselector
19308     */
19309    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19310
19311    /**
19312     * @}
19313     */
19314
19315    /**
19316     * @defgroup Progressbar Progress bar
19317     *
19318     * The progress bar is a widget for visually representing the
19319     * progress status of a given job/task.
19320     *
19321     * A progress bar may be horizontal or vertical. It may display an
19322     * icon besides it, as well as primary and @b units labels. The
19323     * former is meant to label the widget as a whole, while the
19324     * latter, which is formatted with floating point values (and thus
19325     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19326     * units"</c>), is meant to label the widget's <b>progress
19327     * value</b>. Label, icon and unit strings/objects are @b optional
19328     * for progress bars.
19329     *
19330     * A progress bar may be @b inverted, in which state it gets its
19331     * values inverted, with high values being on the left or top and
19332     * low values on the right or bottom, as opposed to normally have
19333     * the low values on the former and high values on the latter,
19334     * respectively, for horizontal and vertical modes.
19335     *
19336     * The @b span of the progress, as set by
19337     * elm_progressbar_span_size_set(), is its length (horizontally or
19338     * vertically), unless one puts size hints on the widget to expand
19339     * on desired directions, by any container. That length will be
19340     * scaled by the object or applications scaling factor. At any
19341     * point code can query the progress bar for its value with
19342     * elm_progressbar_value_get().
19343     *
19344     * Available widget styles for progress bars:
19345     * - @c "default"
19346     * - @c "wheel" (simple style, no text, no progression, only
19347     *      "pulse" effect is available)
19348     *
19349     * Here is an example on its usage:
19350     * @li @ref progressbar_example
19351     */
19352
19353    /**
19354     * Add a new progress bar widget to the given parent Elementary
19355     * (container) object
19356     *
19357     * @param parent The parent object
19358     * @return a new progress bar widget handle or @c NULL, on errors
19359     *
19360     * This function inserts a new progress bar widget on the canvas.
19361     *
19362     * @ingroup Progressbar
19363     */
19364    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19365
19366    /**
19367     * Set whether a given progress bar widget is at "pulsing mode" or
19368     * not.
19369     *
19370     * @param obj The progress bar object
19371     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19372     * @c EINA_FALSE to put it back to its default one
19373     *
19374     * By default, progress bars will display values from the low to
19375     * high value boundaries. There are, though, contexts in which the
19376     * state of progression of a given task is @b unknown.  For those,
19377     * one can set a progress bar widget to a "pulsing state", to give
19378     * the user an idea that some computation is being held, but
19379     * without exact progress values. In the default theme it will
19380     * animate its bar with the contents filling in constantly and back
19381     * to non-filled, in a loop. To start and stop this pulsing
19382     * animation, one has to explicitly call elm_progressbar_pulse().
19383     *
19384     * @see elm_progressbar_pulse_get()
19385     * @see elm_progressbar_pulse()
19386     *
19387     * @ingroup Progressbar
19388     */
19389    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19390
19391    /**
19392     * Get whether a given progress bar widget is at "pulsing mode" or
19393     * not.
19394     *
19395     * @param obj The progress bar object
19396     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19397     * if it's in the default one (and on errors)
19398     *
19399     * @ingroup Progressbar
19400     */
19401    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19402
19403    /**
19404     * Start/stop a given progress bar "pulsing" animation, if its
19405     * under that mode
19406     *
19407     * @param obj The progress bar object
19408     * @param state @c EINA_TRUE, to @b start the pulsing animation,
19409     * @c EINA_FALSE to @b stop it
19410     *
19411     * @note This call won't do anything if @p obj is not under "pulsing mode".
19412     *
19413     * @see elm_progressbar_pulse_set() for more details.
19414     *
19415     * @ingroup Progressbar
19416     */
19417    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19418
19419    /**
19420     * Set the progress value (in percentage) on a given progress bar
19421     * widget
19422     *
19423     * @param obj The progress bar object
19424     * @param val The progress value (@b must be between @c 0.0 and @c
19425     * 1.0)
19426     *
19427     * Use this call to set progress bar levels.
19428     *
19429     * @note If you passes a value out of the specified range for @p
19430     * val, it will be interpreted as the @b closest of the @b boundary
19431     * values in the range.
19432     *
19433     * @ingroup Progressbar
19434     */
19435    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19436
19437    /**
19438     * Get the progress value (in percentage) on a given progress bar
19439     * widget
19440     *
19441     * @param obj The progress bar object
19442     * @return The value of the progressbar
19443     *
19444     * @see elm_progressbar_value_set() for more details
19445     *
19446     * @ingroup Progressbar
19447     */
19448    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19449
19450    /**
19451     * Set the label of a given progress bar widget
19452     *
19453     * @param obj The progress bar object
19454     * @param label The text label string, in UTF-8
19455     *
19456     * @ingroup Progressbar
19457     * @deprecated use elm_object_text_set() instead.
19458     */
19459    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19460
19461    /**
19462     * Get the label of a given progress bar widget
19463     *
19464     * @param obj The progressbar object
19465     * @return The text label string, in UTF-8
19466     *
19467     * @ingroup Progressbar
19468     * @deprecated use elm_object_text_set() instead.
19469     */
19470    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19471
19472    /**
19473     * Set the icon object of a given progress bar widget
19474     *
19475     * @param obj The progress bar object
19476     * @param icon The icon object
19477     *
19478     * Use this call to decorate @p obj with an icon next to it.
19479     *
19480     * @note Once the icon object is set, a previously set one will be
19481     * deleted. If you want to keep that old content object, use the
19482     * elm_progressbar_icon_unset() function.
19483     *
19484     * @see elm_progressbar_icon_get()
19485     *
19486     * @ingroup Progressbar
19487     */
19488    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19489
19490    /**
19491     * Retrieve the icon object set for a given progress bar widget
19492     *
19493     * @param obj The progress bar object
19494     * @return The icon object's handle, if @p obj had one set, or @c NULL,
19495     * otherwise (and on errors)
19496     *
19497     * @see elm_progressbar_icon_set() for more details
19498     *
19499     * @ingroup Progressbar
19500     */
19501    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19502
19503    /**
19504     * Unset an icon set on a given progress bar widget
19505     *
19506     * @param obj The progress bar object
19507     * @return The icon object that was being used, if any was set, or
19508     * @c NULL, otherwise (and on errors)
19509     *
19510     * This call will unparent and return the icon object which was set
19511     * for this widget, previously, on success.
19512     *
19513     * @see elm_progressbar_icon_set() for more details
19514     *
19515     * @ingroup Progressbar
19516     */
19517    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19518
19519    /**
19520     * Set the (exact) length of the bar region of a given progress bar
19521     * widget
19522     *
19523     * @param obj The progress bar object
19524     * @param size The length of the progress bar's bar region
19525     *
19526     * This sets the minimum width (when in horizontal mode) or height
19527     * (when in vertical mode) of the actual bar area of the progress
19528     * bar @p obj. This in turn affects the object's minimum size. Use
19529     * this when you're not setting other size hints expanding on the
19530     * given direction (like weight and alignment hints) and you would
19531     * like it to have a specific size.
19532     *
19533     * @note Icon, label and unit text around @p obj will require their
19534     * own space, which will make @p obj to require more the @p size,
19535     * actually.
19536     *
19537     * @see elm_progressbar_span_size_get()
19538     *
19539     * @ingroup Progressbar
19540     */
19541    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19542
19543    /**
19544     * Get the length set for the bar region of a given progress bar
19545     * widget
19546     *
19547     * @param obj The progress bar object
19548     * @return The length of the progress bar's bar region
19549     *
19550     * If that size was not set previously, with
19551     * elm_progressbar_span_size_set(), this call will return @c 0.
19552     *
19553     * @ingroup Progressbar
19554     */
19555    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19556
19557    /**
19558     * Set the format string for a given progress bar widget's units
19559     * label
19560     *
19561     * @param obj The progress bar object
19562     * @param format The format string for @p obj's units label
19563     *
19564     * If @c NULL is passed on @p format, it will make @p obj's units
19565     * area to be hidden completely. If not, it'll set the <b>format
19566     * string</b> for the units label's @b text. The units label is
19567     * provided a floating point value, so the units text is up display
19568     * at most one floating point falue. Note that the units label is
19569     * optional. Use a format string such as "%1.2f meters" for
19570     * example.
19571     *
19572     * @note The default format string for a progress bar is an integer
19573     * percentage, as in @c "%.0f %%".
19574     *
19575     * @see elm_progressbar_unit_format_get()
19576     *
19577     * @ingroup Progressbar
19578     */
19579    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19580
19581    /**
19582     * Retrieve the format string set for a given progress bar widget's
19583     * units label
19584     *
19585     * @param obj The progress bar object
19586     * @return The format set string for @p obj's units label or
19587     * @c NULL, if none was set (and on errors)
19588     *
19589     * @see elm_progressbar_unit_format_set() for more details
19590     *
19591     * @ingroup Progressbar
19592     */
19593    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19594
19595    /**
19596     * Set the orientation of a given progress bar widget
19597     *
19598     * @param obj The progress bar object
19599     * @param horizontal Use @c EINA_TRUE to make @p obj to be
19600     * @b horizontal, @c EINA_FALSE to make it @b vertical
19601     *
19602     * Use this function to change how your progress bar is to be
19603     * disposed: vertically or horizontally.
19604     *
19605     * @see elm_progressbar_horizontal_get()
19606     *
19607     * @ingroup Progressbar
19608     */
19609    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19610
19611    /**
19612     * Retrieve the orientation of a given progress bar widget
19613     *
19614     * @param obj The progress bar object
19615     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19616     * @c EINA_FALSE if it's @b vertical (and on errors)
19617     *
19618     * @see elm_progressbar_horizontal_set() for more details
19619     *
19620     * @ingroup Progressbar
19621     */
19622    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19623
19624    /**
19625     * Invert a given progress bar widget's displaying values order
19626     *
19627     * @param obj The progress bar object
19628     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19629     * @c EINA_FALSE to bring it back to default, non-inverted values.
19630     *
19631     * A progress bar may be @b inverted, in which state it gets its
19632     * values inverted, with high values being on the left or top and
19633     * low values on the right or bottom, as opposed to normally have
19634     * the low values on the former and high values on the latter,
19635     * respectively, for horizontal and vertical modes.
19636     *
19637     * @see elm_progressbar_inverted_get()
19638     *
19639     * @ingroup Progressbar
19640     */
19641    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19642
19643    /**
19644     * Get whether a given progress bar widget's displaying values are
19645     * inverted or not
19646     *
19647     * @param obj The progress bar object
19648     * @return @c EINA_TRUE, if @p obj has inverted values,
19649     * @c EINA_FALSE otherwise (and on errors)
19650     *
19651     * @see elm_progressbar_inverted_set() for more details
19652     *
19653     * @ingroup Progressbar
19654     */
19655    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19656
19657    /**
19658     * @defgroup Separator Separator
19659     *
19660     * @brief Separator is a very thin object used to separate other objects.
19661     *
19662     * A separator can be vertical or horizontal.
19663     *
19664     * @ref tutorial_separator is a good example of how to use a separator.
19665     * @{
19666     */
19667    /**
19668     * @brief Add a separator object to @p parent
19669     *
19670     * @param parent The parent object
19671     *
19672     * @return The separator object, or NULL upon failure
19673     */
19674    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19675    /**
19676     * @brief Set the horizontal mode of a separator object
19677     *
19678     * @param obj The separator object
19679     * @param horizontal If true, the separator is horizontal
19680     */
19681    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19682    /**
19683     * @brief Get the horizontal mode of a separator object
19684     *
19685     * @param obj The separator object
19686     * @return If true, the separator is horizontal
19687     *
19688     * @see elm_separator_horizontal_set()
19689     */
19690    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19691    /**
19692     * @}
19693     */
19694
19695    /**
19696     * @defgroup Spinner Spinner
19697     * @ingroup Elementary
19698     *
19699     * @image html img/widget/spinner/preview-00.png
19700     * @image latex img/widget/spinner/preview-00.eps
19701     *
19702     * A spinner is a widget which allows the user to increase or decrease
19703     * numeric values using arrow buttons, or edit values directly, clicking
19704     * over it and typing the new value.
19705     *
19706     * By default the spinner will not wrap and has a label
19707     * of "%.0f" (just showing the integer value of the double).
19708     *
19709     * A spinner has a label that is formatted with floating
19710     * point values and thus accepts a printf-style format string, like
19711     * “%1.2f units”.
19712     *
19713     * It also allows specific values to be replaced by pre-defined labels.
19714     *
19715     * Smart callbacks one can register to:
19716     *
19717     * - "changed" - Whenever the spinner value is changed.
19718     * - "delay,changed" - A short time after the value is changed by the user.
19719     *    This will be called only when the user stops dragging for a very short
19720     *    period or when they release their finger/mouse, so it avoids possibly
19721     *    expensive reactions to the value change.
19722     *
19723     * Available styles for it:
19724     * - @c "default";
19725     * - @c "vertical": up/down buttons at the right side and text left aligned.
19726     *
19727     * Here is an example on its usage:
19728     * @ref spinner_example
19729     */
19730
19731    /**
19732     * @addtogroup Spinner
19733     * @{
19734     */
19735
19736    /**
19737     * Add a new spinner widget to the given parent Elementary
19738     * (container) object.
19739     *
19740     * @param parent The parent object.
19741     * @return a new spinner widget handle or @c NULL, on errors.
19742     *
19743     * This function inserts a new spinner widget on the canvas.
19744     *
19745     * @ingroup Spinner
19746     *
19747     */
19748    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19749
19750    /**
19751     * Set the format string of the displayed label.
19752     *
19753     * @param obj The spinner object.
19754     * @param fmt The format string for the label display.
19755     *
19756     * If @c NULL, this sets the format to "%.0f". If not it sets the format
19757     * string for the label text. The label text is provided a floating point
19758     * value, so the label text can display up to 1 floating point value.
19759     * Note that this is optional.
19760     *
19761     * Use a format string such as "%1.2f meters" for example, and it will
19762     * display values like: "3.14 meters" for a value equal to 3.14159.
19763     *
19764     * Default is "%0.f".
19765     *
19766     * @see elm_spinner_label_format_get()
19767     *
19768     * @ingroup Spinner
19769     */
19770    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19771
19772    /**
19773     * Get the label format of the spinner.
19774     *
19775     * @param obj The spinner object.
19776     * @return The text label format string in UTF-8.
19777     *
19778     * @see elm_spinner_label_format_set() for details.
19779     *
19780     * @ingroup Spinner
19781     */
19782    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19783
19784    /**
19785     * Set the minimum and maximum values for the spinner.
19786     *
19787     * @param obj The spinner object.
19788     * @param min The minimum value.
19789     * @param max The maximum value.
19790     *
19791     * Define the allowed range of values to be selected by the user.
19792     *
19793     * If actual value is less than @p min, it will be updated to @p min. If it
19794     * is bigger then @p max, will be updated to @p max. Actual value can be
19795     * get with elm_spinner_value_get().
19796     *
19797     * By default, min is equal to 0, and max is equal to 100.
19798     *
19799     * @warning Maximum must be greater than minimum.
19800     *
19801     * @see elm_spinner_min_max_get()
19802     *
19803     * @ingroup Spinner
19804     */
19805    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19806
19807    /**
19808     * Get the minimum and maximum values of the spinner.
19809     *
19810     * @param obj The spinner object.
19811     * @param min Pointer where to store the minimum value.
19812     * @param max Pointer where to store the maximum value.
19813     *
19814     * @note If only one value is needed, the other pointer can be passed
19815     * as @c NULL.
19816     *
19817     * @see elm_spinner_min_max_set() for details.
19818     *
19819     * @ingroup Spinner
19820     */
19821    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19822
19823    /**
19824     * Set the step used to increment or decrement the spinner value.
19825     *
19826     * @param obj The spinner object.
19827     * @param step The step value.
19828     *
19829     * This value will be incremented or decremented to the displayed value.
19830     * It will be incremented while the user keep right or top arrow pressed,
19831     * and will be decremented while the user keep left or bottom arrow pressed.
19832     *
19833     * The interval to increment / decrement can be set with
19834     * elm_spinner_interval_set().
19835     *
19836     * By default step value is equal to 1.
19837     *
19838     * @see elm_spinner_step_get()
19839     *
19840     * @ingroup Spinner
19841     */
19842    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19843
19844    /**
19845     * Get the step used to increment or decrement the spinner value.
19846     *
19847     * @param obj The spinner object.
19848     * @return The step value.
19849     *
19850     * @see elm_spinner_step_get() for more details.
19851     *
19852     * @ingroup Spinner
19853     */
19854    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19855
19856    /**
19857     * Set the value the spinner displays.
19858     *
19859     * @param obj The spinner object.
19860     * @param val The value to be displayed.
19861     *
19862     * Value will be presented on the label following format specified with
19863     * elm_spinner_format_set().
19864     *
19865     * @warning The value must to be between min and max values. This values
19866     * are set by elm_spinner_min_max_set().
19867     *
19868     * @see elm_spinner_value_get().
19869     * @see elm_spinner_format_set().
19870     * @see elm_spinner_min_max_set().
19871     *
19872     * @ingroup Spinner
19873     */
19874    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19875
19876    /**
19877     * Get the value displayed by the spinner.
19878     *
19879     * @param obj The spinner object.
19880     * @return The value displayed.
19881     *
19882     * @see elm_spinner_value_set() for details.
19883     *
19884     * @ingroup Spinner
19885     */
19886    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19887
19888    /**
19889     * Set whether the spinner should wrap when it reaches its
19890     * minimum or maximum value.
19891     *
19892     * @param obj The spinner object.
19893     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19894     * disable it.
19895     *
19896     * Disabled by default. If disabled, when the user tries to increment the
19897     * value,
19898     * but displayed value plus step value is bigger than maximum value,
19899     * the spinner
19900     * won't allow it. The same happens when the user tries to decrement it,
19901     * but the value less step is less than minimum value.
19902     *
19903     * When wrap is enabled, in such situations it will allow these changes,
19904     * but will get the value that would be less than minimum and subtracts
19905     * from maximum. Or add the value that would be more than maximum to
19906     * the minimum.
19907     *
19908     * E.g.:
19909     * @li min value = 10
19910     * @li max value = 50
19911     * @li step value = 20
19912     * @li displayed value = 20
19913     *
19914     * When the user decrement value (using left or bottom arrow), it will
19915     * displays @c 40, because max - (min - (displayed - step)) is
19916     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
19917     *
19918     * @see elm_spinner_wrap_get().
19919     *
19920     * @ingroup Spinner
19921     */
19922    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
19923
19924    /**
19925     * Get whether the spinner should wrap when it reaches its
19926     * minimum or maximum value.
19927     *
19928     * @param obj The spinner object
19929     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
19930     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19931     *
19932     * @see elm_spinner_wrap_set() for details.
19933     *
19934     * @ingroup Spinner
19935     */
19936    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19937
19938    /**
19939     * Set whether the spinner can be directly edited by the user or not.
19940     *
19941     * @param obj The spinner object.
19942     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
19943     * don't allow users to edit it directly.
19944     *
19945     * Spinner objects can have edition @b disabled, in which state they will
19946     * be changed only by arrows.
19947     * Useful for contexts
19948     * where you don't want your users to interact with it writting the value.
19949     * Specially
19950     * when using special values, the user can see real value instead
19951     * of special label on edition.
19952     *
19953     * It's enabled by default.
19954     *
19955     * @see elm_spinner_editable_get()
19956     *
19957     * @ingroup Spinner
19958     */
19959    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19960
19961    /**
19962     * Get whether the spinner can be directly edited by the user or not.
19963     *
19964     * @param obj The spinner object.
19965     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
19966     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19967     *
19968     * @see elm_spinner_editable_set() for details.
19969     *
19970     * @ingroup Spinner
19971     */
19972    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19973
19974    /**
19975     * Set a special string to display in the place of the numerical value.
19976     *
19977     * @param obj The spinner object.
19978     * @param value The value to be replaced.
19979     * @param label The label to be used.
19980     *
19981     * It's useful for cases when a user should select an item that is
19982     * better indicated by a label than a value. For example, weekdays or months.
19983     *
19984     * E.g.:
19985     * @code
19986     * sp = elm_spinner_add(win);
19987     * elm_spinner_min_max_set(sp, 1, 3);
19988     * elm_spinner_special_value_add(sp, 1, "January");
19989     * elm_spinner_special_value_add(sp, 2, "February");
19990     * elm_spinner_special_value_add(sp, 3, "March");
19991     * evas_object_show(sp);
19992     * @endcode
19993     *
19994     * @ingroup Spinner
19995     */
19996    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
19997
19998    /**
19999     * Set the interval on time updates for an user mouse button hold
20000     * on spinner widgets' arrows.
20001     *
20002     * @param obj The spinner object.
20003     * @param interval The (first) interval value in seconds.
20004     *
20005     * This interval value is @b decreased while the user holds the
20006     * mouse pointer either incrementing or decrementing spinner's value.
20007     *
20008     * This helps the user to get to a given value distant from the
20009     * current one easier/faster, as it will start to change quicker and
20010     * quicker on mouse button holds.
20011     *
20012     * The calculation for the next change interval value, starting from
20013     * the one set with this call, is the previous interval divided by
20014     * @c 1.05, so it decreases a little bit.
20015     *
20016     * The default starting interval value for automatic changes is
20017     * @c 0.85 seconds.
20018     *
20019     * @see elm_spinner_interval_get()
20020     *
20021     * @ingroup Spinner
20022     */
20023    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20024
20025    /**
20026     * Get the interval on time updates for an user mouse button hold
20027     * on spinner widgets' arrows.
20028     *
20029     * @param obj The spinner object.
20030     * @return The (first) interval value, in seconds, set on it.
20031     *
20032     * @see elm_spinner_interval_set() for more details.
20033     *
20034     * @ingroup Spinner
20035     */
20036    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20037
20038    /**
20039     * @}
20040     */
20041
20042    /**
20043     * @defgroup Index Index
20044     *
20045     * @image html img/widget/index/preview-00.png
20046     * @image latex img/widget/index/preview-00.eps
20047     *
20048     * An index widget gives you an index for fast access to whichever
20049     * group of other UI items one might have. It's a list of text
20050     * items (usually letters, for alphabetically ordered access).
20051     *
20052     * Index widgets are by default hidden and just appear when the
20053     * user clicks over it's reserved area in the canvas. In its
20054     * default theme, it's an area one @ref Fingers "finger" wide on
20055     * the right side of the index widget's container.
20056     *
20057     * When items on the index are selected, smart callbacks get
20058     * called, so that its user can make other container objects to
20059     * show a given area or child object depending on the index item
20060     * selected. You'd probably be using an index together with @ref
20061     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20062     * "general grids".
20063     *
20064     * Smart events one  can add callbacks for are:
20065     * - @c "changed" - When the selected index item changes. @c
20066     *      event_info is the selected item's data pointer.
20067     * - @c "delay,changed" - When the selected index item changes, but
20068     *      after a small idling period. @c event_info is the selected
20069     *      item's data pointer.
20070     * - @c "selected" - When the user releases a mouse button and
20071     *      selects an item. @c event_info is the selected item's data
20072     *      pointer.
20073     * - @c "level,up" - when the user moves a finger from the first
20074     *      level to the second level
20075     * - @c "level,down" - when the user moves a finger from the second
20076     *      level to the first level
20077     *
20078     * The @c "delay,changed" event is so that it'll wait a small time
20079     * before actually reporting those events and, moreover, just the
20080     * last event happening on those time frames will actually be
20081     * reported.
20082     *
20083     * Here are some examples on its usage:
20084     * @li @ref index_example_01
20085     * @li @ref index_example_02
20086     */
20087
20088    /**
20089     * @addtogroup Index
20090     * @{
20091     */
20092
20093    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20094
20095    /**
20096     * Add a new index widget to the given parent Elementary
20097     * (container) object
20098     *
20099     * @param parent The parent object
20100     * @return a new index widget handle or @c NULL, on errors
20101     *
20102     * This function inserts a new index widget on the canvas.
20103     *
20104     * @ingroup Index
20105     */
20106    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20107
20108    /**
20109     * Set whether a given index widget is or not visible,
20110     * programatically.
20111     *
20112     * @param obj The index object
20113     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20114     *
20115     * Not to be confused with visible as in @c evas_object_show() --
20116     * visible with regard to the widget's auto hiding feature.
20117     *
20118     * @see elm_index_active_get()
20119     *
20120     * @ingroup Index
20121     */
20122    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20123
20124    /**
20125     * Get whether a given index widget is currently visible or not.
20126     *
20127     * @param obj The index object
20128     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20129     *
20130     * @see elm_index_active_set() for more details
20131     *
20132     * @ingroup Index
20133     */
20134    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20135
20136    /**
20137     * Set the items level for a given index widget.
20138     *
20139     * @param obj The index object.
20140     * @param level @c 0 or @c 1, the currently implemented levels.
20141     *
20142     * @see elm_index_item_level_get()
20143     *
20144     * @ingroup Index
20145     */
20146    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20147
20148    /**
20149     * Get the items level set for a given index widget.
20150     *
20151     * @param obj The index object.
20152     * @return @c 0 or @c 1, which are the levels @p obj might be at.
20153     *
20154     * @see elm_index_item_level_set() for more information
20155     *
20156     * @ingroup Index
20157     */
20158    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20159
20160    /**
20161     * Returns the last selected item's data, for a given index widget.
20162     *
20163     * @param obj The index object.
20164     * @return The item @b data associated to the last selected item on
20165     * @p obj (or @c NULL, on errors).
20166     *
20167     * @warning The returned value is @b not an #Elm_Index_Item item
20168     * handle, but the data associated to it (see the @c item parameter
20169     * in elm_index_item_append(), as an example).
20170     *
20171     * @ingroup Index
20172     */
20173    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20174
20175    /**
20176     * Append a new item on a given index widget.
20177     *
20178     * @param obj The index object.
20179     * @param letter Letter under which the item should be indexed
20180     * @param item The item data to set for the index's item
20181     *
20182     * Despite the most common usage of the @p letter argument is for
20183     * single char strings, one could use arbitrary strings as index
20184     * entries.
20185     *
20186     * @c item will be the pointer returned back on @c "changed", @c
20187     * "delay,changed" and @c "selected" smart events.
20188     *
20189     * @ingroup Index
20190     */
20191    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20192
20193    /**
20194     * Prepend a new item on a given index widget.
20195     *
20196     * @param obj The index object.
20197     * @param letter Letter under which the item should be indexed
20198     * @param item The item data to set for the index's item
20199     *
20200     * Despite the most common usage of the @p letter argument is for
20201     * single char strings, one could use arbitrary strings as index
20202     * entries.
20203     *
20204     * @c item will be the pointer returned back on @c "changed", @c
20205     * "delay,changed" and @c "selected" smart events.
20206     *
20207     * @ingroup Index
20208     */
20209    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20210
20211    /**
20212     * Append a new item, on a given index widget, <b>after the item
20213     * having @p relative as data</b>.
20214     *
20215     * @param obj The index object.
20216     * @param letter Letter under which the item should be indexed
20217     * @param item The item data to set for the index's item
20218     * @param relative The item data of the index item to be the
20219     * predecessor of this new one
20220     *
20221     * Despite the most common usage of the @p letter argument is for
20222     * single char strings, one could use arbitrary strings as index
20223     * entries.
20224     *
20225     * @c item will be the pointer returned back on @c "changed", @c
20226     * "delay,changed" and @c "selected" smart events.
20227     *
20228     * @note If @p relative is @c NULL or if it's not found to be data
20229     * set on any previous item on @p obj, this function will behave as
20230     * elm_index_item_append().
20231     *
20232     * @ingroup Index
20233     */
20234    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20235
20236    /**
20237     * Prepend a new item, on a given index widget, <b>after the item
20238     * having @p relative as data</b>.
20239     *
20240     * @param obj The index object.
20241     * @param letter Letter under which the item should be indexed
20242     * @param item The item data to set for the index's item
20243     * @param relative The item data of the index item to be the
20244     * successor of this new one
20245     *
20246     * Despite the most common usage of the @p letter argument is for
20247     * single char strings, one could use arbitrary strings as index
20248     * entries.
20249     *
20250     * @c item will be the pointer returned back on @c "changed", @c
20251     * "delay,changed" and @c "selected" smart events.
20252     *
20253     * @note If @p relative is @c NULL or if it's not found to be data
20254     * set on any previous item on @p obj, this function will behave as
20255     * elm_index_item_prepend().
20256     *
20257     * @ingroup Index
20258     */
20259    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20260
20261    /**
20262     * Insert a new item into the given index widget, using @p cmp_func
20263     * function to sort items (by item handles).
20264     *
20265     * @param obj The index object.
20266     * @param letter Letter under which the item should be indexed
20267     * @param item The item data to set for the index's item
20268     * @param cmp_func The comparing function to be used to sort index
20269     * items <b>by #Elm_Index_Item item handles</b>
20270     * @param cmp_data_func A @b fallback function to be called for the
20271     * sorting of index items <b>by item data</b>). It will be used
20272     * when @p cmp_func returns @c 0 (equality), which means an index
20273     * item with provided item data already exists. To decide which
20274     * data item should be pointed to by the index item in question, @p
20275     * cmp_data_func will be used. If @p cmp_data_func returns a
20276     * non-negative value, the previous index item data will be
20277     * replaced by the given @p item pointer. If the previous data need
20278     * to be freed, it should be done by the @p cmp_data_func function,
20279     * because all references to it will be lost. If this function is
20280     * not provided (@c NULL is given), index items will be @b
20281     * duplicated, if @p cmp_func returns @c 0.
20282     *
20283     * Despite the most common usage of the @p letter argument is for
20284     * single char strings, one could use arbitrary strings as index
20285     * entries.
20286     *
20287     * @c item will be the pointer returned back on @c "changed", @c
20288     * "delay,changed" and @c "selected" smart events.
20289     *
20290     * @ingroup Index
20291     */
20292    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);
20293
20294    /**
20295     * Remove an item from a given index widget, <b>to be referenced by
20296     * it's data value</b>.
20297     *
20298     * @param obj The index object
20299     * @param item The item's data pointer for the item to be removed
20300     * from @p obj
20301     *
20302     * If a deletion callback is set, via elm_index_item_del_cb_set(),
20303     * that callback function will be called by this one.
20304     *
20305     * @warning The item to be removed from @p obj will be found via
20306     * its item data pointer, and not by an #Elm_Index_Item handle.
20307     *
20308     * @ingroup Index
20309     */
20310    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20311
20312    /**
20313     * Find a given index widget's item, <b>using item data</b>.
20314     *
20315     * @param obj The index object
20316     * @param item The item data pointed to by the desired index item
20317     * @return The index item handle, if found, or @c NULL otherwise
20318     *
20319     * @ingroup Index
20320     */
20321    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20322
20323    /**
20324     * Removes @b all items from a given index widget.
20325     *
20326     * @param obj The index object.
20327     *
20328     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20329     * that callback function will be called for each item in @p obj.
20330     *
20331     * @ingroup Index
20332     */
20333    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20334
20335    /**
20336     * Go to a given items level on a index widget
20337     *
20338     * @param obj The index object
20339     * @param level The index level (one of @c 0 or @c 1)
20340     *
20341     * @ingroup Index
20342     */
20343    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20344
20345    /**
20346     * Return the data associated with a given index widget item
20347     *
20348     * @param it The index widget item handle
20349     * @return The data associated with @p it
20350     *
20351     * @see elm_index_item_data_set()
20352     *
20353     * @ingroup Index
20354     */
20355    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20356
20357    /**
20358     * Set the data associated with a given index widget item
20359     *
20360     * @param it The index widget item handle
20361     * @param data The new data pointer to set to @p it
20362     *
20363     * This sets new item data on @p it.
20364     *
20365     * @warning The old data pointer won't be touched by this function, so
20366     * the user had better to free that old data himself/herself.
20367     *
20368     * @ingroup Index
20369     */
20370    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20371
20372    /**
20373     * Set the function to be called when a given index widget item is freed.
20374     *
20375     * @param it The item to set the callback on
20376     * @param func The function to call on the item's deletion
20377     *
20378     * When called, @p func will have both @c data and @c event_info
20379     * arguments with the @p it item's data value and, naturally, the
20380     * @c obj argument with a handle to the parent index widget.
20381     *
20382     * @ingroup Index
20383     */
20384    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20385
20386    /**
20387     * Get the letter (string) set on a given index widget item.
20388     *
20389     * @param it The index item handle
20390     * @return The letter string set on @p it
20391     *
20392     * @ingroup Index
20393     */
20394    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20395
20396    /**
20397     * @}
20398     */
20399
20400    /**
20401     * @defgroup Photocam Photocam
20402     *
20403     * @image html img/widget/photocam/preview-00.png
20404     * @image latex img/widget/photocam/preview-00.eps
20405     *
20406     * This is a widget specifically for displaying high-resolution digital
20407     * camera photos giving speedy feedback (fast load), low memory footprint
20408     * and zooming and panning as well as fitting logic. It is entirely focused
20409     * on jpeg images, and takes advantage of properties of the jpeg format (via
20410     * evas loader features in the jpeg loader).
20411     *
20412     * Signals that you can add callbacks for are:
20413     * @li "clicked" - This is called when a user has clicked the photo without
20414     *                 dragging around.
20415     * @li "press" - This is called when a user has pressed down on the photo.
20416     * @li "longpressed" - This is called when a user has pressed down on the
20417     *                     photo for a long time without dragging around.
20418     * @li "clicked,double" - This is called when a user has double-clicked the
20419     *                        photo.
20420     * @li "load" - Photo load begins.
20421     * @li "loaded" - This is called when the image file load is complete for the
20422     *                first view (low resolution blurry version).
20423     * @li "load,detail" - Photo detailed data load begins.
20424     * @li "loaded,detail" - This is called when the image file load is complete
20425     *                      for the detailed image data (full resolution needed).
20426     * @li "zoom,start" - Zoom animation started.
20427     * @li "zoom,stop" - Zoom animation stopped.
20428     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20429     * @li "scroll" - the content has been scrolled (moved)
20430     * @li "scroll,anim,start" - scrolling animation has started
20431     * @li "scroll,anim,stop" - scrolling animation has stopped
20432     * @li "scroll,drag,start" - dragging the contents around has started
20433     * @li "scroll,drag,stop" - dragging the contents around has stopped
20434     *
20435     * @ref tutorial_photocam shows the API in action.
20436     * @{
20437     */
20438    /**
20439     * @brief Types of zoom available.
20440     */
20441    typedef enum _Elm_Photocam_Zoom_Mode
20442      {
20443         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20444         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20445         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20446         ELM_PHOTOCAM_ZOOM_MODE_LAST
20447      } Elm_Photocam_Zoom_Mode;
20448    /**
20449     * @brief Add a new Photocam object
20450     *
20451     * @param parent The parent object
20452     * @return The new object or NULL if it cannot be created
20453     */
20454    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20455    /**
20456     * @brief Set the photo file to be shown
20457     *
20458     * @param obj The photocam object
20459     * @param file The photo file
20460     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20461     *
20462     * This sets (and shows) the specified file (with a relative or absolute
20463     * path) and will return a load error (same error that
20464     * evas_object_image_load_error_get() will return). The image will change and
20465     * adjust its size at this point and begin a background load process for this
20466     * photo that at some time in the future will be displayed at the full
20467     * quality needed.
20468     */
20469    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20470    /**
20471     * @brief Returns the path of the current image file
20472     *
20473     * @param obj The photocam object
20474     * @return Returns the path
20475     *
20476     * @see elm_photocam_file_set()
20477     */
20478    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20479    /**
20480     * @brief Set the zoom level of the photo
20481     *
20482     * @param obj The photocam object
20483     * @param zoom The zoom level to set
20484     *
20485     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20486     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20487     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20488     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20489     * 16, 32, etc.).
20490     */
20491    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20492    /**
20493     * @brief Get the zoom level of the photo
20494     *
20495     * @param obj The photocam object
20496     * @return The current zoom level
20497     *
20498     * This returns the current zoom level of the photocam object. Note that if
20499     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20500     * (which is the default), the zoom level may be changed at any time by the
20501     * photocam object itself to account for photo size and photocam viewpoer
20502     * size.
20503     *
20504     * @see elm_photocam_zoom_set()
20505     * @see elm_photocam_zoom_mode_set()
20506     */
20507    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20508    /**
20509     * @brief Set the zoom mode
20510     *
20511     * @param obj The photocam object
20512     * @param mode The desired mode
20513     *
20514     * This sets the zoom mode to manual or one of several automatic levels.
20515     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20516     * elm_photocam_zoom_set() and will stay at that level until changed by code
20517     * or until zoom mode is changed. This is the default mode. The Automatic
20518     * modes will allow the photocam object to automatically adjust zoom mode
20519     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20520     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20521     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20522     * pixels within the frame are left unfilled.
20523     */
20524    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20525    /**
20526     * @brief Get the zoom mode
20527     *
20528     * @param obj The photocam object
20529     * @return The current zoom mode
20530     *
20531     * This gets the current zoom mode of the photocam object.
20532     *
20533     * @see elm_photocam_zoom_mode_set()
20534     */
20535    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20536    /**
20537     * @brief Get the current image pixel width and height
20538     *
20539     * @param obj The photocam object
20540     * @param w A pointer to the width return
20541     * @param h A pointer to the height return
20542     *
20543     * This gets the current photo pixel width and height (for the original).
20544     * The size will be returned in the integers @p w and @p h that are pointed
20545     * to.
20546     */
20547    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20548    /**
20549     * @brief Get the area of the image that is currently shown
20550     *
20551     * @param obj
20552     * @param x A pointer to the X-coordinate of region
20553     * @param y A pointer to the Y-coordinate of region
20554     * @param w A pointer to the width
20555     * @param h A pointer to the height
20556     *
20557     * @see elm_photocam_image_region_show()
20558     * @see elm_photocam_image_region_bring_in()
20559     */
20560    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20561    /**
20562     * @brief Set the viewed portion of the image
20563     *
20564     * @param obj The photocam object
20565     * @param x X-coordinate of region in image original pixels
20566     * @param y Y-coordinate of region in image original pixels
20567     * @param w Width of region in image original pixels
20568     * @param h Height of region in image original pixels
20569     *
20570     * This shows the region of the image without using animation.
20571     */
20572    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20573    /**
20574     * @brief Bring in the viewed portion of the image
20575     *
20576     * @param obj The photocam object
20577     * @param x X-coordinate of region in image original pixels
20578     * @param y Y-coordinate of region in image original pixels
20579     * @param w Width of region in image original pixels
20580     * @param h Height of region in image original pixels
20581     *
20582     * This shows the region of the image using animation.
20583     */
20584    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20585    /**
20586     * @brief Set the paused state for photocam
20587     *
20588     * @param obj The photocam object
20589     * @param paused The pause state to set
20590     *
20591     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20592     * photocam. The default is off. This will stop zooming using animation on
20593     * zoom levels changes and change instantly. This will stop any existing
20594     * animations that are running.
20595     */
20596    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20597    /**
20598     * @brief Get the paused state for photocam
20599     *
20600     * @param obj The photocam object
20601     * @return The current paused state
20602     *
20603     * This gets the current paused state for the photocam object.
20604     *
20605     * @see elm_photocam_paused_set()
20606     */
20607    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20608    /**
20609     * @brief Get the internal low-res image used for photocam
20610     *
20611     * @param obj The photocam object
20612     * @return The internal image object handle, or NULL if none exists
20613     *
20614     * This gets the internal image object inside photocam. Do not modify it. It
20615     * is for inspection only, and hooking callbacks to. Nothing else. It may be
20616     * deleted at any time as well.
20617     */
20618    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20619    /**
20620     * @brief Set the photocam scrolling bouncing.
20621     *
20622     * @param obj The photocam object
20623     * @param h_bounce bouncing for horizontal
20624     * @param v_bounce bouncing for vertical
20625     */
20626    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20627    /**
20628     * @brief Get the photocam scrolling bouncing.
20629     *
20630     * @param obj The photocam object
20631     * @param h_bounce bouncing for horizontal
20632     * @param v_bounce bouncing for vertical
20633     *
20634     * @see elm_photocam_bounce_set()
20635     */
20636    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20637    /**
20638     * @}
20639     */
20640
20641    /**
20642     * @defgroup Map Map
20643     * @ingroup Elementary
20644     *
20645     * @image html img/widget/map/preview-00.png
20646     * @image latex img/widget/map/preview-00.eps
20647     *
20648     * This is a widget specifically for displaying a map. It uses basically
20649     * OpenStreetMap provider http://www.openstreetmap.org/,
20650     * but custom providers can be added.
20651     *
20652     * It supports some basic but yet nice features:
20653     * @li zoom and scroll
20654     * @li markers with content to be displayed when user clicks over it
20655     * @li group of markers
20656     * @li routes
20657     *
20658     * Smart callbacks one can listen to:
20659     *
20660     * - "clicked" - This is called when a user has clicked the map without
20661     *   dragging around.
20662     * - "press" - This is called when a user has pressed down on the map.
20663     * - "longpressed" - This is called when a user has pressed down on the map
20664     *   for a long time without dragging around.
20665     * - "clicked,double" - This is called when a user has double-clicked
20666     *   the map.
20667     * - "load,detail" - Map detailed data load begins.
20668     * - "loaded,detail" - This is called when all currently visible parts of
20669     *   the map are loaded.
20670     * - "zoom,start" - Zoom animation started.
20671     * - "zoom,stop" - Zoom animation stopped.
20672     * - "zoom,change" - Zoom changed when using an auto zoom mode.
20673     * - "scroll" - the content has been scrolled (moved).
20674     * - "scroll,anim,start" - scrolling animation has started.
20675     * - "scroll,anim,stop" - scrolling animation has stopped.
20676     * - "scroll,drag,start" - dragging the contents around has started.
20677     * - "scroll,drag,stop" - dragging the contents around has stopped.
20678     * - "downloaded" - This is called when all currently required map images
20679     *   are downloaded.
20680     * - "route,load" - This is called when route request begins.
20681     * - "route,loaded" - This is called when route request ends.
20682     * - "name,load" - This is called when name request begins.
20683     * - "name,loaded- This is called when name request ends.
20684     *
20685     * Available style for map widget:
20686     * - @c "default"
20687     *
20688     * Available style for markers:
20689     * - @c "radio"
20690     * - @c "radio2"
20691     * - @c "empty"
20692     *
20693     * Available style for marker bubble:
20694     * - @c "default"
20695     *
20696     * List of examples:
20697     * @li @ref map_example_01
20698     * @li @ref map_example_02
20699     * @li @ref map_example_03
20700     */
20701
20702    /**
20703     * @addtogroup Map
20704     * @{
20705     */
20706
20707    /**
20708     * @enum _Elm_Map_Zoom_Mode
20709     * @typedef Elm_Map_Zoom_Mode
20710     *
20711     * Set map's zoom behavior. It can be set to manual or automatic.
20712     *
20713     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20714     *
20715     * Values <b> don't </b> work as bitmask, only one can be choosen.
20716     *
20717     * @note Valid sizes are 2^zoom, consequently the map may be smaller
20718     * than the scroller view.
20719     *
20720     * @see elm_map_zoom_mode_set()
20721     * @see elm_map_zoom_mode_get()
20722     *
20723     * @ingroup Map
20724     */
20725    typedef enum _Elm_Map_Zoom_Mode
20726      {
20727         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20728         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20729         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20730         ELM_MAP_ZOOM_MODE_LAST
20731      } Elm_Map_Zoom_Mode;
20732
20733    /**
20734     * @enum _Elm_Map_Route_Sources
20735     * @typedef Elm_Map_Route_Sources
20736     *
20737     * Set route service to be used. By default used source is
20738     * #ELM_MAP_ROUTE_SOURCE_YOURS.
20739     *
20740     * @see elm_map_route_source_set()
20741     * @see elm_map_route_source_get()
20742     *
20743     * @ingroup Map
20744     */
20745    typedef enum _Elm_Map_Route_Sources
20746      {
20747         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20748         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. */
20749         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20750         ELM_MAP_ROUTE_SOURCE_LAST
20751      } Elm_Map_Route_Sources;
20752
20753    typedef enum _Elm_Map_Name_Sources
20754      {
20755         ELM_MAP_NAME_SOURCE_NOMINATIM,
20756         ELM_MAP_NAME_SOURCE_LAST
20757      } Elm_Map_Name_Sources;
20758
20759    /**
20760     * @enum _Elm_Map_Route_Type
20761     * @typedef Elm_Map_Route_Type
20762     *
20763     * Set type of transport used on route.
20764     *
20765     * @see elm_map_route_add()
20766     *
20767     * @ingroup Map
20768     */
20769    typedef enum _Elm_Map_Route_Type
20770      {
20771         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20772         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20773         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20774         ELM_MAP_ROUTE_TYPE_LAST
20775      } Elm_Map_Route_Type;
20776
20777    /**
20778     * @enum _Elm_Map_Route_Method
20779     * @typedef Elm_Map_Route_Method
20780     *
20781     * Set the routing method, what should be priorized, time or distance.
20782     *
20783     * @see elm_map_route_add()
20784     *
20785     * @ingroup Map
20786     */
20787    typedef enum _Elm_Map_Route_Method
20788      {
20789         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20790         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20791         ELM_MAP_ROUTE_METHOD_LAST
20792      } Elm_Map_Route_Method;
20793
20794    typedef enum _Elm_Map_Name_Method
20795      {
20796         ELM_MAP_NAME_METHOD_SEARCH,
20797         ELM_MAP_NAME_METHOD_REVERSE,
20798         ELM_MAP_NAME_METHOD_LAST
20799      } Elm_Map_Name_Method;
20800
20801    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(). */
20802    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(). */
20803    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(). */
20804    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(). */
20805    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
20806    typedef struct _Elm_Map_Track           Elm_Map_Track;
20807
20808    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. */
20809    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20810    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20811    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20812
20813    typedef char        *(*ElmMapModuleSourceFunc) (void);
20814    typedef int          (*ElmMapModuleZoomMinFunc) (void);
20815    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
20816    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20817    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
20818    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20819    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20820    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20821    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20822
20823    /**
20824     * Add a new map widget to the given parent Elementary (container) object.
20825     *
20826     * @param parent The parent object.
20827     * @return a new map widget handle or @c NULL, on errors.
20828     *
20829     * This function inserts a new map widget on the canvas.
20830     *
20831     * @ingroup Map
20832     */
20833    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20834
20835    /**
20836     * Set the zoom level of the map.
20837     *
20838     * @param obj The map object.
20839     * @param zoom The zoom level to set.
20840     *
20841     * This sets the zoom level.
20842     *
20843     * It will respect limits defined by elm_map_source_zoom_min_set() and
20844     * elm_map_source_zoom_max_set().
20845     *
20846     * By default these values are 0 (world map) and 18 (maximum zoom).
20847     *
20848     * This function should be used when zoom mode is set to
20849     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20850     * with elm_map_zoom_mode_set().
20851     *
20852     * @see elm_map_zoom_mode_set().
20853     * @see elm_map_zoom_get().
20854     *
20855     * @ingroup Map
20856     */
20857    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20858
20859    /**
20860     * Get the zoom level of the map.
20861     *
20862     * @param obj The map object.
20863     * @return The current zoom level.
20864     *
20865     * This returns the current zoom level of the map object.
20866     *
20867     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20868     * (which is the default), the zoom level may be changed at any time by the
20869     * map object itself to account for map size and map viewport size.
20870     *
20871     * @see elm_map_zoom_set() for details.
20872     *
20873     * @ingroup Map
20874     */
20875    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20876
20877    /**
20878     * Set the zoom mode used by the map object.
20879     *
20880     * @param obj The map object.
20881     * @param mode The zoom mode of the map, being it one of
20882     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20883     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20884     *
20885     * This sets the zoom mode to manual or one of the automatic levels.
20886     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20887     * elm_map_zoom_set() and will stay at that level until changed by code
20888     * or until zoom mode is changed. This is the default mode.
20889     *
20890     * The Automatic modes will allow the map object to automatically
20891     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20892     * adjust zoom so the map fits inside the scroll frame with no pixels
20893     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20894     * ensure no pixels within the frame are left unfilled. Do not forget that
20895     * the valid sizes are 2^zoom, consequently the map may be smaller than
20896     * the scroller view.
20897     *
20898     * @see elm_map_zoom_set()
20899     *
20900     * @ingroup Map
20901     */
20902    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20903
20904    /**
20905     * Get the zoom mode used by the map object.
20906     *
20907     * @param obj The map object.
20908     * @return The zoom mode of the map, being it one of
20909     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20910     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20911     *
20912     * This function returns the current zoom mode used by the map object.
20913     *
20914     * @see elm_map_zoom_mode_set() for more details.
20915     *
20916     * @ingroup Map
20917     */
20918    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20919
20920    /**
20921     * Get the current coordinates of the map.
20922     *
20923     * @param obj The map object.
20924     * @param lon Pointer where to store longitude.
20925     * @param lat Pointer where to store latitude.
20926     *
20927     * This gets the current center coordinates of the map object. It can be
20928     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
20929     *
20930     * @see elm_map_geo_region_bring_in()
20931     * @see elm_map_geo_region_show()
20932     *
20933     * @ingroup Map
20934     */
20935    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
20936
20937    /**
20938     * Animatedly bring in given coordinates to the center of the map.
20939     *
20940     * @param obj The map object.
20941     * @param lon Longitude to center at.
20942     * @param lat Latitude to center at.
20943     *
20944     * This causes map to jump to the given @p lat and @p lon coordinates
20945     * and show it (by scrolling) in the center of the viewport, if it is not
20946     * already centered. This will use animation to do so and take a period
20947     * of time to complete.
20948     *
20949     * @see elm_map_geo_region_show() for a function to avoid animation.
20950     * @see elm_map_geo_region_get()
20951     *
20952     * @ingroup Map
20953     */
20954    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20955
20956    /**
20957     * Show the given coordinates at the center of the map, @b immediately.
20958     *
20959     * @param obj The map object.
20960     * @param lon Longitude to center at.
20961     * @param lat Latitude to center at.
20962     *
20963     * This causes map to @b redraw its viewport's contents to the
20964     * region contining the given @p lat and @p lon, that will be moved to the
20965     * center of the map.
20966     *
20967     * @see elm_map_geo_region_bring_in() for a function to move with animation.
20968     * @see elm_map_geo_region_get()
20969     *
20970     * @ingroup Map
20971     */
20972    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20973
20974    /**
20975     * Pause or unpause the map.
20976     *
20977     * @param obj The map object.
20978     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
20979     * to unpause it.
20980     *
20981     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20982     * for map.
20983     *
20984     * The default is off.
20985     *
20986     * This will stop zooming using animation, changing zoom levels will
20987     * change instantly. This will stop any existing animations that are running.
20988     *
20989     * @see elm_map_paused_get()
20990     *
20991     * @ingroup Map
20992     */
20993    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20994
20995    /**
20996     * Get a value whether map is paused or not.
20997     *
20998     * @param obj The map object.
20999     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21000     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21001     *
21002     * This gets the current paused state for the map object.
21003     *
21004     * @see elm_map_paused_set() for details.
21005     *
21006     * @ingroup Map
21007     */
21008    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21009
21010    /**
21011     * Set to show markers during zoom level changes or not.
21012     *
21013     * @param obj The map object.
21014     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21015     * to show them.
21016     *
21017     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21018     * for map.
21019     *
21020     * The default is off.
21021     *
21022     * This will stop zooming using animation, changing zoom levels will
21023     * change instantly. This will stop any existing animations that are running.
21024     *
21025     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21026     * for the markers.
21027     *
21028     * The default  is off.
21029     *
21030     * Enabling it will force the map to stop displaying the markers during
21031     * zoom level changes. Set to on if you have a large number of markers.
21032     *
21033     * @see elm_map_paused_markers_get()
21034     *
21035     * @ingroup Map
21036     */
21037    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21038
21039    /**
21040     * Get a value whether markers will be displayed on zoom level changes or not
21041     *
21042     * @param obj The map object.
21043     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21044     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21045     *
21046     * This gets the current markers paused state for the map object.
21047     *
21048     * @see elm_map_paused_markers_set() for details.
21049     *
21050     * @ingroup Map
21051     */
21052    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21053
21054    /**
21055     * Get the information of downloading status.
21056     *
21057     * @param obj The map object.
21058     * @param try_num Pointer where to store number of tiles being downloaded.
21059     * @param finish_num Pointer where to store number of tiles successfully
21060     * downloaded.
21061     *
21062     * This gets the current downloading status for the map object, the number
21063     * of tiles being downloaded and the number of tiles already downloaded.
21064     *
21065     * @ingroup Map
21066     */
21067    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21068
21069    /**
21070     * Convert a pixel coordinate (x,y) into a geographic coordinate
21071     * (longitude, latitude).
21072     *
21073     * @param obj The map object.
21074     * @param x the coordinate.
21075     * @param y the coordinate.
21076     * @param size the size in pixels of the map.
21077     * The map is a square and generally his size is : pow(2.0, zoom)*256.
21078     * @param lon Pointer where to store the longitude that correspond to x.
21079     * @param lat Pointer where to store the latitude that correspond to y.
21080     *
21081     * @note Origin pixel point is the top left corner of the viewport.
21082     * Map zoom and size are taken on account.
21083     *
21084     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21085     *
21086     * @ingroup Map
21087     */
21088    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);
21089
21090    /**
21091     * Convert a geographic coordinate (longitude, latitude) into a pixel
21092     * coordinate (x, y).
21093     *
21094     * @param obj The map object.
21095     * @param lon the longitude.
21096     * @param lat the latitude.
21097     * @param size the size in pixels of the map. The map is a square
21098     * and generally his size is : pow(2.0, zoom)*256.
21099     * @param x Pointer where to store the horizontal pixel coordinate that
21100     * correspond to the longitude.
21101     * @param y Pointer where to store the vertical pixel coordinate that
21102     * correspond to the latitude.
21103     *
21104     * @note Origin pixel point is the top left corner of the viewport.
21105     * Map zoom and size are taken on account.
21106     *
21107     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21108     *
21109     * @ingroup Map
21110     */
21111    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);
21112
21113    /**
21114     * Convert a geographic coordinate (longitude, latitude) into a name
21115     * (address).
21116     *
21117     * @param obj The map object.
21118     * @param lon the longitude.
21119     * @param lat the latitude.
21120     * @return name A #Elm_Map_Name handle for this coordinate.
21121     *
21122     * To get the string for this address, elm_map_name_address_get()
21123     * should be used.
21124     *
21125     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21126     *
21127     * @ingroup Map
21128     */
21129    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21130
21131    /**
21132     * Convert a name (address) into a geographic coordinate
21133     * (longitude, latitude).
21134     *
21135     * @param obj The map object.
21136     * @param name The address.
21137     * @return name A #Elm_Map_Name handle for this address.
21138     *
21139     * To get the longitude and latitude, elm_map_name_region_get()
21140     * should be used.
21141     *
21142     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21143     *
21144     * @ingroup Map
21145     */
21146    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21147
21148    /**
21149     * Convert a pixel coordinate into a rotated pixel coordinate.
21150     *
21151     * @param obj The map object.
21152     * @param x horizontal coordinate of the point to rotate.
21153     * @param y vertical coordinate of the point to rotate.
21154     * @param cx rotation's center horizontal position.
21155     * @param cy rotation's center vertical position.
21156     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21157     * @param xx Pointer where to store rotated x.
21158     * @param yy Pointer where to store rotated y.
21159     *
21160     * @ingroup Map
21161     */
21162    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);
21163
21164    /**
21165     * Add a new marker to the map object.
21166     *
21167     * @param obj The map object.
21168     * @param lon The longitude of the marker.
21169     * @param lat The latitude of the marker.
21170     * @param clas The class, to use when marker @b isn't grouped to others.
21171     * @param clas_group The class group, to use when marker is grouped to others
21172     * @param data The data passed to the callbacks.
21173     *
21174     * @return The created marker or @c NULL upon failure.
21175     *
21176     * A marker will be created and shown in a specific point of the map, defined
21177     * by @p lon and @p lat.
21178     *
21179     * It will be displayed using style defined by @p class when this marker
21180     * is displayed alone (not grouped). A new class can be created with
21181     * elm_map_marker_class_new().
21182     *
21183     * If the marker is grouped to other markers, it will be displayed with
21184     * style defined by @p class_group. Markers with the same group are grouped
21185     * if they are close. A new group class can be created with
21186     * elm_map_marker_group_class_new().
21187     *
21188     * Markers created with this method can be deleted with
21189     * elm_map_marker_remove().
21190     *
21191     * A marker can have associated content to be displayed by a bubble,
21192     * when a user click over it, as well as an icon. These objects will
21193     * be fetch using class' callback functions.
21194     *
21195     * @see elm_map_marker_class_new()
21196     * @see elm_map_marker_group_class_new()
21197     * @see elm_map_marker_remove()
21198     *
21199     * @ingroup Map
21200     */
21201    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);
21202
21203    /**
21204     * Set the maximum numbers of markers' content to be displayed in a group.
21205     *
21206     * @param obj The map object.
21207     * @param max The maximum numbers of items displayed in a bubble.
21208     *
21209     * A bubble will be displayed when the user clicks over the group,
21210     * and will place the content of markers that belong to this group
21211     * inside it.
21212     *
21213     * A group can have a long list of markers, consequently the creation
21214     * of the content of the bubble can be very slow.
21215     *
21216     * In order to avoid this, a maximum number of items is displayed
21217     * in a bubble.
21218     *
21219     * By default this number is 30.
21220     *
21221     * Marker with the same group class are grouped if they are close.
21222     *
21223     * @see elm_map_marker_add()
21224     *
21225     * @ingroup Map
21226     */
21227    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21228
21229    /**
21230     * Remove a marker from the map.
21231     *
21232     * @param marker The marker to remove.
21233     *
21234     * @see elm_map_marker_add()
21235     *
21236     * @ingroup Map
21237     */
21238    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21239
21240    /**
21241     * Get the current coordinates of the marker.
21242     *
21243     * @param marker marker.
21244     * @param lat Pointer where to store the marker's latitude.
21245     * @param lon Pointer where to store the marker's longitude.
21246     *
21247     * These values are set when adding markers, with function
21248     * elm_map_marker_add().
21249     *
21250     * @see elm_map_marker_add()
21251     *
21252     * @ingroup Map
21253     */
21254    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21255
21256    /**
21257     * Animatedly bring in given marker to the center of the map.
21258     *
21259     * @param marker The marker to center at.
21260     *
21261     * This causes map to jump to the given @p marker's coordinates
21262     * and show it (by scrolling) in the center of the viewport, if it is not
21263     * already centered. This will use animation to do so and take a period
21264     * of time to complete.
21265     *
21266     * @see elm_map_marker_show() for a function to avoid animation.
21267     * @see elm_map_marker_region_get()
21268     *
21269     * @ingroup Map
21270     */
21271    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21272
21273    /**
21274     * Show the given marker at the center of the map, @b immediately.
21275     *
21276     * @param marker The marker to center at.
21277     *
21278     * This causes map to @b redraw its viewport's contents to the
21279     * region contining the given @p marker's coordinates, that will be
21280     * moved to the center of the map.
21281     *
21282     * @see elm_map_marker_bring_in() for a function to move with animation.
21283     * @see elm_map_markers_list_show() if more than one marker need to be
21284     * displayed.
21285     * @see elm_map_marker_region_get()
21286     *
21287     * @ingroup Map
21288     */
21289    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21290
21291    /**
21292     * Move and zoom the map to display a list of markers.
21293     *
21294     * @param markers A list of #Elm_Map_Marker handles.
21295     *
21296     * The map will be centered on the center point of the markers in the list.
21297     * Then the map will be zoomed in order to fit the markers using the maximum
21298     * zoom which allows display of all the markers.
21299     *
21300     * @warning All the markers should belong to the same map object.
21301     *
21302     * @see elm_map_marker_show() to show a single marker.
21303     * @see elm_map_marker_bring_in()
21304     *
21305     * @ingroup Map
21306     */
21307    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21308
21309    /**
21310     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21311     *
21312     * @param marker The marker wich content should be returned.
21313     * @return Return the evas object if it exists, else @c NULL.
21314     *
21315     * To set callback function #ElmMapMarkerGetFunc for the marker class,
21316     * elm_map_marker_class_get_cb_set() should be used.
21317     *
21318     * This content is what will be inside the bubble that will be displayed
21319     * when an user clicks over the marker.
21320     *
21321     * This returns the actual Evas object used to be placed inside
21322     * the bubble. This may be @c NULL, as it may
21323     * not have been created or may have been deleted, at any time, by
21324     * the map. <b>Do not modify this object</b> (move, resize,
21325     * show, hide, etc.), as the map is controlling it. This
21326     * function is for querying, emitting custom signals or hooking
21327     * lower level callbacks for events on that object. Do not delete
21328     * this object under any circumstances.
21329     *
21330     * @ingroup Map
21331     */
21332    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21333
21334    /**
21335     * Update the marker
21336     *
21337     * @param marker The marker to be updated.
21338     *
21339     * If a content is set to this marker, it will call function to delete it,
21340     * #ElmMapMarkerDelFunc, and then will fetch the content again with
21341     * #ElmMapMarkerGetFunc.
21342     *
21343     * These functions are set for the marker class with
21344     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21345     *
21346     * @ingroup Map
21347     */
21348    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21349
21350    /**
21351     * Close all the bubbles opened by the user.
21352     *
21353     * @param obj The map object.
21354     *
21355     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21356     * when the user clicks on a marker.
21357     *
21358     * This functions is set for the marker class with
21359     * elm_map_marker_class_get_cb_set().
21360     *
21361     * @ingroup Map
21362     */
21363    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21364
21365    /**
21366     * Create a new group class.
21367     *
21368     * @param obj The map object.
21369     * @return Returns the new group class.
21370     *
21371     * Each marker must be associated to a group class. Markers in the same
21372     * group are grouped if they are close.
21373     *
21374     * The group class defines the style of the marker when a marker is grouped
21375     * to others markers. When it is alone, another class will be used.
21376     *
21377     * A group class will need to be provided when creating a marker with
21378     * elm_map_marker_add().
21379     *
21380     * Some properties and functions can be set by class, as:
21381     * - style, with elm_map_group_class_style_set()
21382     * - data - to be associated to the group class. It can be set using
21383     *   elm_map_group_class_data_set().
21384     * - min zoom to display markers, set with
21385     *   elm_map_group_class_zoom_displayed_set().
21386     * - max zoom to group markers, set using
21387     *   elm_map_group_class_zoom_grouped_set().
21388     * - visibility - set if markers will be visible or not, set with
21389     *   elm_map_group_class_hide_set().
21390     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21391     *   It can be set using elm_map_group_class_icon_cb_set().
21392     *
21393     * @see elm_map_marker_add()
21394     * @see elm_map_group_class_style_set()
21395     * @see elm_map_group_class_data_set()
21396     * @see elm_map_group_class_zoom_displayed_set()
21397     * @see elm_map_group_class_zoom_grouped_set()
21398     * @see elm_map_group_class_hide_set()
21399     * @see elm_map_group_class_icon_cb_set()
21400     *
21401     * @ingroup Map
21402     */
21403    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21404
21405    /**
21406     * Set the marker's style of a group class.
21407     *
21408     * @param clas The group class.
21409     * @param style The style to be used by markers.
21410     *
21411     * Each marker must be associated to a group class, and will use the style
21412     * defined by such class when grouped to other markers.
21413     *
21414     * The following styles are provided by default theme:
21415     * @li @c radio - blue circle
21416     * @li @c radio2 - green circle
21417     * @li @c empty
21418     *
21419     * @see elm_map_group_class_new() for more details.
21420     * @see elm_map_marker_add()
21421     *
21422     * @ingroup Map
21423     */
21424    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21425
21426    /**
21427     * Set the icon callback function of a group class.
21428     *
21429     * @param clas The group class.
21430     * @param icon_get The callback function that will return the icon.
21431     *
21432     * Each marker must be associated to a group class, and it can display a
21433     * custom icon. The function @p icon_get must return this icon.
21434     *
21435     * @see elm_map_group_class_new() for more details.
21436     * @see elm_map_marker_add()
21437     *
21438     * @ingroup Map
21439     */
21440    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21441
21442    /**
21443     * Set the data associated to the group class.
21444     *
21445     * @param clas The group class.
21446     * @param data The new user data.
21447     *
21448     * This data will be passed for callback functions, like icon get callback,
21449     * that can be set with elm_map_group_class_icon_cb_set().
21450     *
21451     * If a data was previously set, the object will lose the pointer for it,
21452     * so if needs to be freed, you must do it yourself.
21453     *
21454     * @see elm_map_group_class_new() for more details.
21455     * @see elm_map_group_class_icon_cb_set()
21456     * @see elm_map_marker_add()
21457     *
21458     * @ingroup Map
21459     */
21460    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21461
21462    /**
21463     * Set the minimum zoom from where the markers are displayed.
21464     *
21465     * @param clas The group class.
21466     * @param zoom The minimum zoom.
21467     *
21468     * Markers only will be displayed when the map is displayed at @p zoom
21469     * or bigger.
21470     *
21471     * @see elm_map_group_class_new() for more details.
21472     * @see elm_map_marker_add()
21473     *
21474     * @ingroup Map
21475     */
21476    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21477
21478    /**
21479     * Set the zoom from where the markers are no more grouped.
21480     *
21481     * @param clas The group class.
21482     * @param zoom The maximum zoom.
21483     *
21484     * Markers only will be grouped when the map is displayed at
21485     * less than @p zoom.
21486     *
21487     * @see elm_map_group_class_new() for more details.
21488     * @see elm_map_marker_add()
21489     *
21490     * @ingroup Map
21491     */
21492    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21493
21494    /**
21495     * Set if the markers associated to the group class @clas are hidden or not.
21496     *
21497     * @param clas The group class.
21498     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21499     * to show them.
21500     *
21501     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21502     * is to show them.
21503     *
21504     * @ingroup Map
21505     */
21506    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21507
21508    /**
21509     * Create a new marker class.
21510     *
21511     * @param obj The map object.
21512     * @return Returns the new group class.
21513     *
21514     * Each marker must be associated to a class.
21515     *
21516     * The marker class defines the style of the marker when a marker is
21517     * displayed alone, i.e., not grouped to to others markers. When grouped
21518     * it will use group class style.
21519     *
21520     * A marker class will need to be provided when creating a marker with
21521     * elm_map_marker_add().
21522     *
21523     * Some properties and functions can be set by class, as:
21524     * - style, with elm_map_marker_class_style_set()
21525     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21526     *   It can be set using elm_map_marker_class_icon_cb_set().
21527     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21528     *   Set using elm_map_marker_class_get_cb_set().
21529     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21530     *   Set using elm_map_marker_class_del_cb_set().
21531     *
21532     * @see elm_map_marker_add()
21533     * @see elm_map_marker_class_style_set()
21534     * @see elm_map_marker_class_icon_cb_set()
21535     * @see elm_map_marker_class_get_cb_set()
21536     * @see elm_map_marker_class_del_cb_set()
21537     *
21538     * @ingroup Map
21539     */
21540    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21541
21542    /**
21543     * Set the marker's style of a marker class.
21544     *
21545     * @param clas The marker class.
21546     * @param style The style to be used by markers.
21547     *
21548     * Each marker must be associated to a marker class, and will use the style
21549     * defined by such class when alone, i.e., @b not grouped to other markers.
21550     *
21551     * The following styles are provided by default theme:
21552     * @li @c radio
21553     * @li @c radio2
21554     * @li @c empty
21555     *
21556     * @see elm_map_marker_class_new() for more details.
21557     * @see elm_map_marker_add()
21558     *
21559     * @ingroup Map
21560     */
21561    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21562
21563    /**
21564     * Set the icon callback function of a marker class.
21565     *
21566     * @param clas The marker class.
21567     * @param icon_get The callback function that will return the icon.
21568     *
21569     * Each marker must be associated to a marker class, and it can display a
21570     * custom icon. The function @p icon_get must return this icon.
21571     *
21572     * @see elm_map_marker_class_new() for more details.
21573     * @see elm_map_marker_add()
21574     *
21575     * @ingroup Map
21576     */
21577    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21578
21579    /**
21580     * Set the bubble content callback function of a marker class.
21581     *
21582     * @param clas The marker class.
21583     * @param get The callback function that will return the content.
21584     *
21585     * Each marker must be associated to a marker class, and it can display a
21586     * a content on a bubble that opens when the user click over the marker.
21587     * The function @p get must return this content object.
21588     *
21589     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21590     * can be used.
21591     *
21592     * @see elm_map_marker_class_new() for more details.
21593     * @see elm_map_marker_class_del_cb_set()
21594     * @see elm_map_marker_add()
21595     *
21596     * @ingroup Map
21597     */
21598    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21599
21600    /**
21601     * Set the callback function used to delete bubble content of a marker class.
21602     *
21603     * @param clas The marker class.
21604     * @param del The callback function that will delete the content.
21605     *
21606     * Each marker must be associated to a marker class, and it can display a
21607     * a content on a bubble that opens when the user click over the marker.
21608     * The function to return such content can be set with
21609     * elm_map_marker_class_get_cb_set().
21610     *
21611     * If this content must be freed, a callback function need to be
21612     * set for that task with this function.
21613     *
21614     * If this callback is defined it will have to delete (or not) the
21615     * object inside, but if the callback is not defined the object will be
21616     * destroyed with evas_object_del().
21617     *
21618     * @see elm_map_marker_class_new() for more details.
21619     * @see elm_map_marker_class_get_cb_set()
21620     * @see elm_map_marker_add()
21621     *
21622     * @ingroup Map
21623     */
21624    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21625
21626    /**
21627     * Get the list of available sources.
21628     *
21629     * @param obj The map object.
21630     * @return The source names list.
21631     *
21632     * It will provide a list with all available sources, that can be set as
21633     * current source with elm_map_source_name_set(), or get with
21634     * elm_map_source_name_get().
21635     *
21636     * Available sources:
21637     * @li "Mapnik"
21638     * @li "Osmarender"
21639     * @li "CycleMap"
21640     * @li "Maplint"
21641     *
21642     * @see elm_map_source_name_set() for more details.
21643     * @see elm_map_source_name_get()
21644     *
21645     * @ingroup Map
21646     */
21647    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21648
21649    /**
21650     * Set the source of the map.
21651     *
21652     * @param obj The map object.
21653     * @param source The source to be used.
21654     *
21655     * Map widget retrieves images that composes the map from a web service.
21656     * This web service can be set with this method.
21657     *
21658     * A different service can return a different maps with different
21659     * information and it can use different zoom values.
21660     *
21661     * The @p source_name need to match one of the names provided by
21662     * elm_map_source_names_get().
21663     *
21664     * The current source can be get using elm_map_source_name_get().
21665     *
21666     * @see elm_map_source_names_get()
21667     * @see elm_map_source_name_get()
21668     *
21669     *
21670     * @ingroup Map
21671     */
21672    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21673
21674    /**
21675     * Get the name of currently used source.
21676     *
21677     * @param obj The map object.
21678     * @return Returns the name of the source in use.
21679     *
21680     * @see elm_map_source_name_set() for more details.
21681     *
21682     * @ingroup Map
21683     */
21684    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21685
21686    /**
21687     * Set the source of the route service to be used by the map.
21688     *
21689     * @param obj The map object.
21690     * @param source The route service to be used, being it one of
21691     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21692     * and #ELM_MAP_ROUTE_SOURCE_ORS.
21693     *
21694     * Each one has its own algorithm, so the route retrieved may
21695     * differ depending on the source route. Now, only the default is working.
21696     *
21697     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21698     * http://www.yournavigation.org/.
21699     *
21700     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21701     * assumptions. Its routing core is based on Contraction Hierarchies.
21702     *
21703     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21704     *
21705     * @see elm_map_route_source_get().
21706     *
21707     * @ingroup Map
21708     */
21709    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21710
21711    /**
21712     * Get the current route source.
21713     *
21714     * @param obj The map object.
21715     * @return The source of the route service used by the map.
21716     *
21717     * @see elm_map_route_source_set() for details.
21718     *
21719     * @ingroup Map
21720     */
21721    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21722
21723    /**
21724     * Set the minimum zoom of the source.
21725     *
21726     * @param obj The map object.
21727     * @param zoom New minimum zoom value to be used.
21728     *
21729     * By default, it's 0.
21730     *
21731     * @ingroup Map
21732     */
21733    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21734
21735    /**
21736     * Get the minimum zoom of the source.
21737     *
21738     * @param obj The map object.
21739     * @return Returns the minimum zoom of the source.
21740     *
21741     * @see elm_map_source_zoom_min_set() for details.
21742     *
21743     * @ingroup Map
21744     */
21745    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21746
21747    /**
21748     * Set the maximum zoom of the source.
21749     *
21750     * @param obj The map object.
21751     * @param zoom New maximum zoom value to be used.
21752     *
21753     * By default, it's 18.
21754     *
21755     * @ingroup Map
21756     */
21757    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21758
21759    /**
21760     * Get the maximum zoom of the source.
21761     *
21762     * @param obj The map object.
21763     * @return Returns the maximum zoom of the source.
21764     *
21765     * @see elm_map_source_zoom_min_set() for details.
21766     *
21767     * @ingroup Map
21768     */
21769    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21770
21771    /**
21772     * Set the user agent used by the map object to access routing services.
21773     *
21774     * @param obj The map object.
21775     * @param user_agent The user agent to be used by the map.
21776     *
21777     * User agent is a client application implementing a network protocol used
21778     * in communications within a client–server distributed computing system
21779     *
21780     * The @p user_agent identification string will transmitted in a header
21781     * field @c User-Agent.
21782     *
21783     * @see elm_map_user_agent_get()
21784     *
21785     * @ingroup Map
21786     */
21787    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21788
21789    /**
21790     * Get the user agent used by the map object.
21791     *
21792     * @param obj The map object.
21793     * @return The user agent identification string used by the map.
21794     *
21795     * @see elm_map_user_agent_set() for details.
21796     *
21797     * @ingroup Map
21798     */
21799    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21800
21801    /**
21802     * Add a new route to the map object.
21803     *
21804     * @param obj The map object.
21805     * @param type The type of transport to be considered when tracing a route.
21806     * @param method The routing method, what should be priorized.
21807     * @param flon The start longitude.
21808     * @param flat The start latitude.
21809     * @param tlon The destination longitude.
21810     * @param tlat The destination latitude.
21811     *
21812     * @return The created route or @c NULL upon failure.
21813     *
21814     * A route will be traced by point on coordinates (@p flat, @p flon)
21815     * to point on coordinates (@p tlat, @p tlon), using the route service
21816     * set with elm_map_route_source_set().
21817     *
21818     * It will take @p type on consideration to define the route,
21819     * depending if the user will be walking or driving, the route may vary.
21820     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21821     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21822     *
21823     * Another parameter is what the route should priorize, the minor distance
21824     * or the less time to be spend on the route. So @p method should be one
21825     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21826     *
21827     * Routes created with this method can be deleted with
21828     * elm_map_route_remove(), colored with elm_map_route_color_set(),
21829     * and distance can be get with elm_map_route_distance_get().
21830     *
21831     * @see elm_map_route_remove()
21832     * @see elm_map_route_color_set()
21833     * @see elm_map_route_distance_get()
21834     * @see elm_map_route_source_set()
21835     *
21836     * @ingroup Map
21837     */
21838    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);
21839
21840    /**
21841     * Remove a route from the map.
21842     *
21843     * @param route The route to remove.
21844     *
21845     * @see elm_map_route_add()
21846     *
21847     * @ingroup Map
21848     */
21849    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21850
21851    /**
21852     * Set the route color.
21853     *
21854     * @param route The route object.
21855     * @param r Red channel value, from 0 to 255.
21856     * @param g Green channel value, from 0 to 255.
21857     * @param b Blue channel value, from 0 to 255.
21858     * @param a Alpha channel value, from 0 to 255.
21859     *
21860     * It uses an additive color model, so each color channel represents
21861     * how much of each primary colors must to be used. 0 represents
21862     * ausence of this color, so if all of the three are set to 0,
21863     * the color will be black.
21864     *
21865     * These component values should be integers in the range 0 to 255,
21866     * (single 8-bit byte).
21867     *
21868     * This sets the color used for the route. By default, it is set to
21869     * solid red (r = 255, g = 0, b = 0, a = 255).
21870     *
21871     * For alpha channel, 0 represents completely transparent, and 255, opaque.
21872     *
21873     * @see elm_map_route_color_get()
21874     *
21875     * @ingroup Map
21876     */
21877    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21878
21879    /**
21880     * Get the route color.
21881     *
21882     * @param route The route object.
21883     * @param r Pointer where to store the red channel value.
21884     * @param g Pointer where to store the green channel value.
21885     * @param b Pointer where to store the blue channel value.
21886     * @param a Pointer where to store the alpha channel value.
21887     *
21888     * @see elm_map_route_color_set() for details.
21889     *
21890     * @ingroup Map
21891     */
21892    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21893
21894    /**
21895     * Get the route distance in kilometers.
21896     *
21897     * @param route The route object.
21898     * @return The distance of route (unit : km).
21899     *
21900     * @ingroup Map
21901     */
21902    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21903
21904    /**
21905     * Get the information of route nodes.
21906     *
21907     * @param route The route object.
21908     * @return Returns a string with the nodes of route.
21909     *
21910     * @ingroup Map
21911     */
21912    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21913
21914    /**
21915     * Get the information of route waypoint.
21916     *
21917     * @param route the route object.
21918     * @return Returns a string with information about waypoint of route.
21919     *
21920     * @ingroup Map
21921     */
21922    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21923
21924    /**
21925     * Get the address of the name.
21926     *
21927     * @param name The name handle.
21928     * @return Returns the address string of @p name.
21929     *
21930     * This gets the coordinates of the @p name, created with one of the
21931     * conversion functions.
21932     *
21933     * @see elm_map_utils_convert_name_into_coord()
21934     * @see elm_map_utils_convert_coord_into_name()
21935     *
21936     * @ingroup Map
21937     */
21938    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21939
21940    /**
21941     * Get the current coordinates of the name.
21942     *
21943     * @param name The name handle.
21944     * @param lat Pointer where to store the latitude.
21945     * @param lon Pointer where to store The longitude.
21946     *
21947     * This gets the coordinates of the @p name, created with one of the
21948     * conversion functions.
21949     *
21950     * @see elm_map_utils_convert_name_into_coord()
21951     * @see elm_map_utils_convert_coord_into_name()
21952     *
21953     * @ingroup Map
21954     */
21955    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
21956
21957    /**
21958     * Remove a name from the map.
21959     *
21960     * @param name The name to remove.
21961     *
21962     * Basically the struct handled by @p name will be freed, so convertions
21963     * between address and coordinates will be lost.
21964     *
21965     * @see elm_map_utils_convert_name_into_coord()
21966     * @see elm_map_utils_convert_coord_into_name()
21967     *
21968     * @ingroup Map
21969     */
21970    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21971
21972    /**
21973     * Rotate the map.
21974     *
21975     * @param obj The map object.
21976     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
21977     * @param cx Rotation's center horizontal position.
21978     * @param cy Rotation's center vertical position.
21979     *
21980     * @see elm_map_rotate_get()
21981     *
21982     * @ingroup Map
21983     */
21984    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
21985
21986    /**
21987     * Get the rotate degree of the map
21988     *
21989     * @param obj The map object
21990     * @param degree Pointer where to store degrees from 0.0 to 360.0
21991     * to rotate arount Z axis.
21992     * @param cx Pointer where to store rotation's center horizontal position.
21993     * @param cy Pointer where to store rotation's center vertical position.
21994     *
21995     * @see elm_map_rotate_set() to set map rotation.
21996     *
21997     * @ingroup Map
21998     */
21999    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);
22000
22001    /**
22002     * Enable or disable mouse wheel to be used to zoom in / out the map.
22003     *
22004     * @param obj The map object.
22005     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22006     * to enable it.
22007     *
22008     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22009     *
22010     * It's disabled by default.
22011     *
22012     * @see elm_map_wheel_disabled_get()
22013     *
22014     * @ingroup Map
22015     */
22016    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22017
22018    /**
22019     * Get a value whether mouse wheel is enabled or not.
22020     *
22021     * @param obj The map object.
22022     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22023     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22024     *
22025     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22026     *
22027     * @see elm_map_wheel_disabled_set() for details.
22028     *
22029     * @ingroup Map
22030     */
22031    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22032
22033 #ifdef ELM_EMAP
22034    /**
22035     * Add a track on the map
22036     *
22037     * @param obj The map object.
22038     * @param emap The emap route object.
22039     * @return The route object. This is an elm object of type Route.
22040     *
22041     * @see elm_route_add() for details.
22042     *
22043     * @ingroup Map
22044     */
22045    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22046 #endif
22047
22048    /**
22049     * Remove a track from the map
22050     *
22051     * @param obj The map object.
22052     * @param route The track to remove.
22053     *
22054     * @ingroup Map
22055     */
22056    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22057
22058    /**
22059     * @}
22060     */
22061
22062    /* Route */
22063    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22064 #ifdef ELM_EMAP
22065    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22066 #endif
22067    EAPI double elm_route_lon_min_get(Evas_Object *obj);
22068    EAPI double elm_route_lat_min_get(Evas_Object *obj);
22069    EAPI double elm_route_lon_max_get(Evas_Object *obj);
22070    EAPI double elm_route_lat_max_get(Evas_Object *obj);
22071
22072
22073    /**
22074     * @defgroup Panel Panel
22075     *
22076     * @image html img/widget/panel/preview-00.png
22077     * @image latex img/widget/panel/preview-00.eps
22078     *
22079     * @brief A panel is a type of animated container that contains subobjects.
22080     * It can be expanded or contracted by clicking the button on it's edge.
22081     *
22082     * Orientations are as follows:
22083     * @li ELM_PANEL_ORIENT_TOP
22084     * @li ELM_PANEL_ORIENT_LEFT
22085     * @li ELM_PANEL_ORIENT_RIGHT
22086     *
22087     * @ref tutorial_panel shows one way to use this widget.
22088     * @{
22089     */
22090    typedef enum _Elm_Panel_Orient
22091      {
22092         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22093         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22094         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22095         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22096      } Elm_Panel_Orient;
22097    /**
22098     * @brief Adds a panel object
22099     *
22100     * @param parent The parent object
22101     *
22102     * @return The panel object, or NULL on failure
22103     */
22104    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22105    /**
22106     * @brief Sets the orientation of the panel
22107     *
22108     * @param parent The parent object
22109     * @param orient The panel orientation. Can be one of the following:
22110     * @li ELM_PANEL_ORIENT_TOP
22111     * @li ELM_PANEL_ORIENT_LEFT
22112     * @li ELM_PANEL_ORIENT_RIGHT
22113     *
22114     * Sets from where the panel will (dis)appear.
22115     */
22116    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22117    /**
22118     * @brief Get the orientation of the panel.
22119     *
22120     * @param obj The panel object
22121     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22122     */
22123    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22124    /**
22125     * @brief Set the content of the panel.
22126     *
22127     * @param obj The panel object
22128     * @param content The panel content
22129     *
22130     * Once the content object is set, a previously set one will be deleted.
22131     * If you want to keep that old content object, use the
22132     * elm_panel_content_unset() function.
22133     */
22134    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22135    /**
22136     * @brief Get the content of the panel.
22137     *
22138     * @param obj The panel object
22139     * @return The content that is being used
22140     *
22141     * Return the content object which is set for this widget.
22142     *
22143     * @see elm_panel_content_set()
22144     */
22145    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22146    /**
22147     * @brief Unset the content of the panel.
22148     *
22149     * @param obj The panel object
22150     * @return The content that was being used
22151     *
22152     * Unparent and return the content object which was set for this widget.
22153     *
22154     * @see elm_panel_content_set()
22155     */
22156    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22157    /**
22158     * @brief Set the state of the panel.
22159     *
22160     * @param obj The panel object
22161     * @param hidden If true, the panel will run the animation to contract
22162     */
22163    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22164    /**
22165     * @brief Get the state of the panel.
22166     *
22167     * @param obj The panel object
22168     * @param hidden If true, the panel is in the "hide" state
22169     */
22170    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22171    /**
22172     * @brief Toggle the hidden state of the panel from code
22173     *
22174     * @param obj The panel object
22175     */
22176    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22177    /**
22178     * @}
22179     */
22180
22181    /**
22182     * @defgroup Panes Panes
22183     * @ingroup Elementary
22184     *
22185     * @image html img/widget/panes/preview-00.png
22186     * @image latex img/widget/panes/preview-00.eps width=\textwidth
22187     *
22188     * @image html img/panes.png
22189     * @image latex img/panes.eps width=\textwidth
22190     *
22191     * The panes adds a dragable bar between two contents. When dragged
22192     * this bar will resize contents size.
22193     *
22194     * Panes can be displayed vertically or horizontally, and contents
22195     * size proportion can be customized (homogeneous by default).
22196     *
22197     * Smart callbacks one can listen to:
22198     * - "press" - The panes has been pressed (button wasn't released yet).
22199     * - "unpressed" - The panes was released after being pressed.
22200     * - "clicked" - The panes has been clicked>
22201     * - "clicked,double" - The panes has been double clicked
22202     *
22203     * Available styles for it:
22204     * - @c "default"
22205     *
22206     * Here is an example on its usage:
22207     * @li @ref panes_example
22208     */
22209
22210    /**
22211     * @addtogroup Panes
22212     * @{
22213     */
22214
22215    /**
22216     * Add a new panes widget to the given parent Elementary
22217     * (container) object.
22218     *
22219     * @param parent The parent object.
22220     * @return a new panes widget handle or @c NULL, on errors.
22221     *
22222     * This function inserts a new panes widget on the canvas.
22223     *
22224     * @ingroup Panes
22225     */
22226    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22227
22228    /**
22229     * Set the left content of the panes widget.
22230     *
22231     * @param obj The panes object.
22232     * @param content The new left content object.
22233     *
22234     * Once the content object is set, a previously set one will be deleted.
22235     * If you want to keep that old content object, use the
22236     * elm_panes_content_left_unset() function.
22237     *
22238     * If panes is displayed vertically, left content will be displayed at
22239     * top.
22240     *
22241     * @see elm_panes_content_left_get()
22242     * @see elm_panes_content_right_set() to set content on the other side.
22243     *
22244     * @ingroup Panes
22245     */
22246    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22247
22248    /**
22249     * Set the right content of the panes widget.
22250     *
22251     * @param obj The panes object.
22252     * @param content The new right content object.
22253     *
22254     * Once the content object is set, a previously set one will be deleted.
22255     * If you want to keep that old content object, use the
22256     * elm_panes_content_right_unset() function.
22257     *
22258     * If panes is displayed vertically, left content will be displayed at
22259     * bottom.
22260     *
22261     * @see elm_panes_content_right_get()
22262     * @see elm_panes_content_left_set() to set content on the other side.
22263     *
22264     * @ingroup Panes
22265     */
22266    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22267
22268    /**
22269     * Get the left content of the panes.
22270     *
22271     * @param obj The panes object.
22272     * @return The left content object that is being used.
22273     *
22274     * Return the left content object which is set for this widget.
22275     *
22276     * @see elm_panes_content_left_set() for details.
22277     *
22278     * @ingroup Panes
22279     */
22280    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22281
22282    /**
22283     * Get the right content of the panes.
22284     *
22285     * @param obj The panes object
22286     * @return The right content object that is being used
22287     *
22288     * Return the right content object which is set for this widget.
22289     *
22290     * @see elm_panes_content_right_set() for details.
22291     *
22292     * @ingroup Panes
22293     */
22294    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22295
22296    /**
22297     * Unset the left content used for the panes.
22298     *
22299     * @param obj The panes object.
22300     * @return The left content object that was being used.
22301     *
22302     * Unparent and return the left content object which was set for this widget.
22303     *
22304     * @see elm_panes_content_left_set() for details.
22305     * @see elm_panes_content_left_get().
22306     *
22307     * @ingroup Panes
22308     */
22309    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22310
22311    /**
22312     * Unset the right content used for the panes.
22313     *
22314     * @param obj The panes object.
22315     * @return The right content object that was being used.
22316     *
22317     * Unparent and return the right content object which was set for this
22318     * widget.
22319     *
22320     * @see elm_panes_content_right_set() for details.
22321     * @see elm_panes_content_right_get().
22322     *
22323     * @ingroup Panes
22324     */
22325    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22326
22327    /**
22328     * Get the size proportion of panes widget's left side.
22329     *
22330     * @param obj The panes object.
22331     * @return float value between 0.0 and 1.0 representing size proportion
22332     * of left side.
22333     *
22334     * @see elm_panes_content_left_size_set() for more details.
22335     *
22336     * @ingroup Panes
22337     */
22338    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22339
22340    /**
22341     * Set the size proportion of panes widget's left side.
22342     *
22343     * @param obj The panes object.
22344     * @param size Value between 0.0 and 1.0 representing size proportion
22345     * of left side.
22346     *
22347     * By default it's homogeneous, i.e., both sides have the same size.
22348     *
22349     * If something different is required, it can be set with this function.
22350     * For example, if the left content should be displayed over
22351     * 75% of the panes size, @p size should be passed as @c 0.75.
22352     * This way, right content will be resized to 25% of panes size.
22353     *
22354     * If displayed vertically, left content is displayed at top, and
22355     * right content at bottom.
22356     *
22357     * @note This proportion will change when user drags the panes bar.
22358     *
22359     * @see elm_panes_content_left_size_get()
22360     *
22361     * @ingroup Panes
22362     */
22363    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22364
22365   /**
22366    * Set the orientation of a given panes widget.
22367    *
22368    * @param obj The panes object.
22369    * @param horizontal Use @c EINA_TRUE to make @p obj to be
22370    * @b horizontal, @c EINA_FALSE to make it @b vertical.
22371    *
22372    * Use this function to change how your panes is to be
22373    * disposed: vertically or horizontally.
22374    *
22375    * By default it's displayed horizontally.
22376    *
22377    * @see elm_panes_horizontal_get()
22378    *
22379    * @ingroup Panes
22380    */
22381    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22382
22383    /**
22384     * Retrieve the orientation of a given panes widget.
22385     *
22386     * @param obj The panes object.
22387     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22388     * @c EINA_FALSE if it's @b vertical (and on errors).
22389     *
22390     * @see elm_panes_horizontal_set() for more details.
22391     *
22392     * @ingroup Panes
22393     */
22394    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22395
22396    /**
22397     * @}
22398     */
22399
22400    /**
22401     * @defgroup Flip Flip
22402     *
22403     * @image html img/widget/flip/preview-00.png
22404     * @image latex img/widget/flip/preview-00.eps
22405     *
22406     * This widget holds 2 content objects(Evas_Object): one on the front and one
22407     * on the back. It allows you to flip from front to back and vice-versa using
22408     * various animations.
22409     *
22410     * If either the front or back contents are not set the flip will treat that
22411     * as transparent. So if you wore to set the front content but not the back,
22412     * and then call elm_flip_go() you would see whatever is below the flip.
22413     *
22414     * For a list of supported animations see elm_flip_go().
22415     *
22416     * Signals that you can add callbacks for are:
22417     * "animate,begin" - when a flip animation was started
22418     * "animate,done" - when a flip animation is finished
22419     *
22420     * @ref tutorial_flip show how to use most of the API.
22421     *
22422     * @{
22423     */
22424    typedef enum _Elm_Flip_Mode
22425      {
22426         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22427         ELM_FLIP_ROTATE_X_CENTER_AXIS,
22428         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22429         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22430         ELM_FLIP_CUBE_LEFT,
22431         ELM_FLIP_CUBE_RIGHT,
22432         ELM_FLIP_CUBE_UP,
22433         ELM_FLIP_CUBE_DOWN,
22434         ELM_FLIP_PAGE_LEFT,
22435         ELM_FLIP_PAGE_RIGHT,
22436         ELM_FLIP_PAGE_UP,
22437         ELM_FLIP_PAGE_DOWN
22438      } Elm_Flip_Mode;
22439    typedef enum _Elm_Flip_Interaction
22440      {
22441         ELM_FLIP_INTERACTION_NONE,
22442         ELM_FLIP_INTERACTION_ROTATE,
22443         ELM_FLIP_INTERACTION_CUBE,
22444         ELM_FLIP_INTERACTION_PAGE
22445      } Elm_Flip_Interaction;
22446    typedef enum _Elm_Flip_Direction
22447      {
22448         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22449         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22450         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22451         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22452      } Elm_Flip_Direction;
22453    /**
22454     * @brief Add a new flip to the parent
22455     *
22456     * @param parent The parent object
22457     * @return The new object or NULL if it cannot be created
22458     */
22459    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22460    /**
22461     * @brief Set the front content of the flip widget.
22462     *
22463     * @param obj The flip object
22464     * @param content The new front content object
22465     *
22466     * Once the content object is set, a previously set one will be deleted.
22467     * If you want to keep that old content object, use the
22468     * elm_flip_content_front_unset() function.
22469     */
22470    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22471    /**
22472     * @brief Set the back content of the flip widget.
22473     *
22474     * @param obj The flip object
22475     * @param content The new back content object
22476     *
22477     * Once the content object is set, a previously set one will be deleted.
22478     * If you want to keep that old content object, use the
22479     * elm_flip_content_back_unset() function.
22480     */
22481    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22482    /**
22483     * @brief Get the front content used for the flip
22484     *
22485     * @param obj The flip object
22486     * @return The front content object that is being used
22487     *
22488     * Return the front content object which is set for this widget.
22489     */
22490    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22491    /**
22492     * @brief Get the back content used for the flip
22493     *
22494     * @param obj The flip object
22495     * @return The back content object that is being used
22496     *
22497     * Return the back content object which is set for this widget.
22498     */
22499    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22500    /**
22501     * @brief Unset the front content used for the flip
22502     *
22503     * @param obj The flip object
22504     * @return The front content object that was being used
22505     *
22506     * Unparent and return the front content object which was set for this widget.
22507     */
22508    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22509    /**
22510     * @brief Unset the back content used for the flip
22511     *
22512     * @param obj The flip object
22513     * @return The back content object that was being used
22514     *
22515     * Unparent and return the back content object which was set for this widget.
22516     */
22517    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22518    /**
22519     * @brief Get flip front visibility state
22520     *
22521     * @param obj The flip objct
22522     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22523     * showing.
22524     */
22525    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22526    /**
22527     * @brief Set flip perspective
22528     *
22529     * @param obj The flip object
22530     * @param foc The coordinate to set the focus on
22531     * @param x The X coordinate
22532     * @param y The Y coordinate
22533     *
22534     * @warning This function currently does nothing.
22535     */
22536    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22537    /**
22538     * @brief Runs the flip animation
22539     *
22540     * @param obj The flip object
22541     * @param mode The mode type
22542     *
22543     * Flips the front and back contents using the @p mode animation. This
22544     * efectively hides the currently visible content and shows the hidden one.
22545     *
22546     * There a number of possible animations to use for the flipping:
22547     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22548     * around a horizontal axis in the middle of its height, the other content
22549     * is shown as the other side of the flip.
22550     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22551     * around a vertical axis in the middle of its width, the other content is
22552     * shown as the other side of the flip.
22553     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22554     * around a diagonal axis in the middle of its width, the other content is
22555     * shown as the other side of the flip.
22556     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22557     * around a diagonal axis in the middle of its height, the other content is
22558     * shown as the other side of the flip.
22559     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22560     * as if the flip was a cube, the other content is show as the right face of
22561     * the cube.
22562     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22563     * right as if the flip was a cube, the other content is show as the left
22564     * face of the cube.
22565     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22566     * flip was a cube, the other content is show as the bottom face of the cube.
22567     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22568     * the flip was a cube, the other content is show as the upper face of the
22569     * cube.
22570     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22571     * if the flip was a book, the other content is shown as the page below that.
22572     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22573     * as if the flip was a book, the other content is shown as the page below
22574     * that.
22575     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22576     * flip was a book, the other content is shown as the page below that.
22577     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22578     * flip was a book, the other content is shown as the page below that.
22579     *
22580     * @image html elm_flip.png
22581     * @image latex elm_flip.eps width=\textwidth
22582     */
22583    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22584    /**
22585     * @brief Set the interactive flip mode
22586     *
22587     * @param obj The flip object
22588     * @param mode The interactive flip mode to use
22589     *
22590     * This sets if the flip should be interactive (allow user to click and
22591     * drag a side of the flip to reveal the back page and cause it to flip).
22592     * By default a flip is not interactive. You may also need to set which
22593     * sides of the flip are "active" for flipping and how much space they use
22594     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22595     * and elm_flip_interacton_direction_hitsize_set()
22596     *
22597     * The four avilable mode of interaction are:
22598     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22599     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22600     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22601     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22602     *
22603     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22604     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22605     * happen, those can only be acheived with elm_flip_go();
22606     */
22607    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22608    /**
22609     * @brief Get the interactive flip mode
22610     *
22611     * @param obj The flip object
22612     * @return The interactive flip mode
22613     *
22614     * Returns the interactive flip mode set by elm_flip_interaction_set()
22615     */
22616    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22617    /**
22618     * @brief Set which directions of the flip respond to interactive flip
22619     *
22620     * @param obj The flip object
22621     * @param dir The direction to change
22622     * @param enabled If that direction is enabled or not
22623     *
22624     * By default all directions are disabled, so you may want to enable the
22625     * desired directions for flipping if you need interactive flipping. You must
22626     * call this function once for each direction that should be enabled.
22627     *
22628     * @see elm_flip_interaction_set()
22629     */
22630    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22631    /**
22632     * @brief Get the enabled state of that flip direction
22633     *
22634     * @param obj The flip object
22635     * @param dir The direction to check
22636     * @return If that direction is enabled or not
22637     *
22638     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22639     *
22640     * @see elm_flip_interaction_set()
22641     */
22642    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22643    /**
22644     * @brief Set the amount of the flip that is sensitive to interactive flip
22645     *
22646     * @param obj The flip object
22647     * @param dir The direction to modify
22648     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22649     *
22650     * Set the amount of the flip that is sensitive to interactive flip, with 0
22651     * representing no area in the flip and 1 representing the entire flip. There
22652     * is however a consideration to be made in that the area will never be
22653     * smaller than the finger size set(as set in your Elementary configuration).
22654     *
22655     * @see elm_flip_interaction_set()
22656     */
22657    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22658    /**
22659     * @brief Get the amount of the flip that is sensitive to interactive flip
22660     *
22661     * @param obj The flip object
22662     * @param dir The direction to check
22663     * @return The size set for that direction
22664     *
22665     * Returns the amount os sensitive area set by
22666     * elm_flip_interacton_direction_hitsize_set().
22667     */
22668    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22669    /**
22670     * @}
22671     */
22672
22673    /* scrolledentry */
22674    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22675    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22676    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22677    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22678    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22679    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22680    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22681    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22682    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22683    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22684    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22685    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22686    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22687    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22688    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22689    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22690    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22691    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22692    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22693    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22694    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22695    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22696    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22697    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22698    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22699    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22700    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22701    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22702    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22703    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22704    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22705    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22706    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22707    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22708    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22709    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);
22710    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22711    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22712    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);
22713    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22714    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);
22715    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22716    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22717    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22718    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22719    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22720    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22721    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22722    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22723    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);
22724    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);
22725    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);
22726    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);
22727    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);
22728    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);
22729    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22730    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22731    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22732    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22733    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22734    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22735    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22736
22737    /**
22738     * @defgroup Conformant Conformant
22739     * @ingroup Elementary
22740     *
22741     * @image html img/widget/conformant/preview-00.png
22742     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22743     *
22744     * @image html img/conformant.png
22745     * @image latex img/conformant.eps width=\textwidth
22746     *
22747     * The aim is to provide a widget that can be used in elementary apps to
22748     * account for space taken up by the indicator, virtual keypad & softkey
22749     * windows when running the illume2 module of E17.
22750     *
22751     * So conformant content will be sized and positioned considering the
22752     * space required for such stuff, and when they popup, as a keyboard
22753     * shows when an entry is selected, conformant content won't change.
22754     *
22755     * Available styles for it:
22756     * - @c "default"
22757     *
22758     * See how to use this widget in this example:
22759     * @ref conformant_example
22760     */
22761
22762    /**
22763     * @addtogroup Conformant
22764     * @{
22765     */
22766
22767    /**
22768     * Add a new conformant widget to the given parent Elementary
22769     * (container) object.
22770     *
22771     * @param parent The parent object.
22772     * @return A new conformant widget handle or @c NULL, on errors.
22773     *
22774     * This function inserts a new conformant widget on the canvas.
22775     *
22776     * @ingroup Conformant
22777     */
22778    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22779
22780    /**
22781     * Set the content of the conformant widget.
22782     *
22783     * @param obj The conformant object.
22784     * @param content The content to be displayed by the conformant.
22785     *
22786     * Content will be sized and positioned considering the space required
22787     * to display a virtual keyboard. So it won't fill all the conformant
22788     * size. This way is possible to be sure that content won't resize
22789     * or be re-positioned after the keyboard is displayed.
22790     *
22791     * Once the content object is set, a previously set one will be deleted.
22792     * If you want to keep that old content object, use the
22793     * elm_conformat_content_unset() function.
22794     *
22795     * @see elm_conformant_content_unset()
22796     * @see elm_conformant_content_get()
22797     *
22798     * @ingroup Conformant
22799     */
22800    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22801
22802    /**
22803     * Get the content of the conformant widget.
22804     *
22805     * @param obj The conformant object.
22806     * @return The content that is being used.
22807     *
22808     * Return the content object which is set for this widget.
22809     * It won't be unparent from conformant. For that, use
22810     * elm_conformant_content_unset().
22811     *
22812     * @see elm_conformant_content_set() for more details.
22813     * @see elm_conformant_content_unset()
22814     *
22815     * @ingroup Conformant
22816     */
22817    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22818
22819    /**
22820     * Unset the content of the conformant widget.
22821     *
22822     * @param obj The conformant object.
22823     * @return The content that was being used.
22824     *
22825     * Unparent and return the content object which was set for this widget.
22826     *
22827     * @see elm_conformant_content_set() for more details.
22828     *
22829     * @ingroup Conformant
22830     */
22831    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22832
22833    /**
22834     * Returns the Evas_Object that represents the content area.
22835     *
22836     * @param obj The conformant object.
22837     * @return The content area of the widget.
22838     *
22839     * @ingroup Conformant
22840     */
22841    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22842
22843    /**
22844     * @}
22845     */
22846
22847    /**
22848     * @defgroup Mapbuf Mapbuf
22849     * @ingroup Elementary
22850     *
22851     * @image html img/widget/mapbuf/preview-00.png
22852     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22853     *
22854     * This holds one content object and uses an Evas Map of transformation
22855     * points to be later used with this content. So the content will be
22856     * moved, resized, etc as a single image. So it will improve performance
22857     * when you have a complex interafce, with a lot of elements, and will
22858     * need to resize or move it frequently (the content object and its
22859     * children).
22860     *
22861     * See how to use this widget in this example:
22862     * @ref mapbuf_example
22863     */
22864
22865    /**
22866     * @addtogroup Mapbuf
22867     * @{
22868     */
22869
22870    /**
22871     * Add a new mapbuf widget to the given parent Elementary
22872     * (container) object.
22873     *
22874     * @param parent The parent object.
22875     * @return A new mapbuf widget handle or @c NULL, on errors.
22876     *
22877     * This function inserts a new mapbuf widget on the canvas.
22878     *
22879     * @ingroup Mapbuf
22880     */
22881    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22882
22883    /**
22884     * Set the content of the mapbuf.
22885     *
22886     * @param obj The mapbuf object.
22887     * @param content The content that will be filled in this mapbuf object.
22888     *
22889     * Once the content object is set, a previously set one will be deleted.
22890     * If you want to keep that old content object, use the
22891     * elm_mapbuf_content_unset() function.
22892     *
22893     * To enable map, elm_mapbuf_enabled_set() should be used.
22894     *
22895     * @ingroup Mapbuf
22896     */
22897    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22898
22899    /**
22900     * Get the content of the mapbuf.
22901     *
22902     * @param obj The mapbuf object.
22903     * @return The content that is being used.
22904     *
22905     * Return the content object which is set for this widget.
22906     *
22907     * @see elm_mapbuf_content_set() for details.
22908     *
22909     * @ingroup Mapbuf
22910     */
22911    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22912
22913    /**
22914     * Unset the content of the mapbuf.
22915     *
22916     * @param obj The mapbuf object.
22917     * @return The content that was being used.
22918     *
22919     * Unparent and return the content object which was set for this widget.
22920     *
22921     * @see elm_mapbuf_content_set() for details.
22922     *
22923     * @ingroup Mapbuf
22924     */
22925    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22926
22927    /**
22928     * Enable or disable the map.
22929     *
22930     * @param obj The mapbuf object.
22931     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
22932     *
22933     * This enables the map that is set or disables it. On enable, the object
22934     * geometry will be saved, and the new geometry will change (position and
22935     * size) to reflect the map geometry set.
22936     *
22937     * Also, when enabled, alpha and smooth states will be used, so if the
22938     * content isn't solid, alpha should be enabled, for example, otherwise
22939     * a black retangle will fill the content.
22940     *
22941     * When disabled, the stored map will be freed and geometry prior to
22942     * enabling the map will be restored.
22943     *
22944     * It's disabled by default.
22945     *
22946     * @see elm_mapbuf_alpha_set()
22947     * @see elm_mapbuf_smooth_set()
22948     *
22949     * @ingroup Mapbuf
22950     */
22951    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22952
22953    /**
22954     * Get a value whether map is enabled or not.
22955     *
22956     * @param obj The mapbuf object.
22957     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
22958     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22959     *
22960     * @see elm_mapbuf_enabled_set() for details.
22961     *
22962     * @ingroup Mapbuf
22963     */
22964    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22965
22966    /**
22967     * Enable or disable smooth map rendering.
22968     *
22969     * @param obj The mapbuf object.
22970     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
22971     * to disable it.
22972     *
22973     * This sets smoothing for map rendering. If the object is a type that has
22974     * its own smoothing settings, then both the smooth settings for this object
22975     * and the map must be turned off.
22976     *
22977     * By default smooth maps are enabled.
22978     *
22979     * @ingroup Mapbuf
22980     */
22981    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
22982
22983    /**
22984     * Get a value whether smooth map rendering is enabled or not.
22985     *
22986     * @param obj The mapbuf object.
22987     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
22988     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22989     *
22990     * @see elm_mapbuf_smooth_set() for details.
22991     *
22992     * @ingroup Mapbuf
22993     */
22994    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22995
22996    /**
22997     * Set or unset alpha flag for map rendering.
22998     *
22999     * @param obj The mapbuf object.
23000     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23001     * to disable it.
23002     *
23003     * This sets alpha flag for map rendering. If the object is a type that has
23004     * its own alpha settings, then this will take precedence. Only image objects
23005     * have this currently. It stops alpha blending of the map area, and is
23006     * useful if you know the object and/or all sub-objects is 100% solid.
23007     *
23008     * Alpha is enabled by default.
23009     *
23010     * @ingroup Mapbuf
23011     */
23012    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23013
23014    /**
23015     * Get a value whether alpha blending is enabled or not.
23016     *
23017     * @param obj The mapbuf object.
23018     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23019     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23020     *
23021     * @see elm_mapbuf_alpha_set() for details.
23022     *
23023     * @ingroup Mapbuf
23024     */
23025    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23026
23027    /**
23028     * @}
23029     */
23030
23031    /**
23032     * @defgroup Flipselector Flip Selector
23033     *
23034     * @image html img/widget/flipselector/preview-00.png
23035     * @image latex img/widget/flipselector/preview-00.eps
23036     *
23037     * A flip selector is a widget to show a set of @b text items, one
23038     * at a time, with the same sheet switching style as the @ref Clock
23039     * "clock" widget, when one changes the current displaying sheet
23040     * (thus, the "flip" in the name).
23041     *
23042     * User clicks to flip sheets which are @b held for some time will
23043     * make the flip selector to flip continuosly and automatically for
23044     * the user. The interval between flips will keep growing in time,
23045     * so that it helps the user to reach an item which is distant from
23046     * the current selection.
23047     *
23048     * Smart callbacks one can register to:
23049     * - @c "selected" - when the widget's selected text item is changed
23050     * - @c "overflowed" - when the widget's current selection is changed
23051     *   from the first item in its list to the last
23052     * - @c "underflowed" - when the widget's current selection is changed
23053     *   from the last item in its list to the first
23054     *
23055     * Available styles for it:
23056     * - @c "default"
23057     *
23058     * Here is an example on its usage:
23059     * @li @ref flipselector_example
23060     */
23061
23062    /**
23063     * @addtogroup Flipselector
23064     * @{
23065     */
23066
23067    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23068
23069    /**
23070     * Add a new flip selector widget to the given parent Elementary
23071     * (container) widget
23072     *
23073     * @param parent The parent object
23074     * @return a new flip selector widget handle or @c NULL, on errors
23075     *
23076     * This function inserts a new flip selector widget on the canvas.
23077     *
23078     * @ingroup Flipselector
23079     */
23080    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23081
23082    /**
23083     * Programmatically select the next item of a flip selector widget
23084     *
23085     * @param obj The flipselector object
23086     *
23087     * @note The selection will be animated. Also, if it reaches the
23088     * end of its list of member items, it will continue with the first
23089     * one onwards.
23090     *
23091     * @ingroup Flipselector
23092     */
23093    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23094
23095    /**
23096     * Programmatically select the previous item of a flip selector
23097     * widget
23098     *
23099     * @param obj The flipselector object
23100     *
23101     * @note The selection will be animated.  Also, if it reaches the
23102     * beginning of its list of member items, it will continue with the
23103     * last one backwards.
23104     *
23105     * @ingroup Flipselector
23106     */
23107    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23108
23109    /**
23110     * Append a (text) item to a flip selector widget
23111     *
23112     * @param obj The flipselector object
23113     * @param label The (text) label of the new item
23114     * @param func Convenience callback function to take place when
23115     * item is selected
23116     * @param data Data passed to @p func, above
23117     * @return A handle to the item added or @c NULL, on errors
23118     *
23119     * The widget's list of labels to show will be appended with the
23120     * given value. If the user wishes so, a callback function pointer
23121     * can be passed, which will get called when this same item is
23122     * selected.
23123     *
23124     * @note The current selection @b won't be modified by appending an
23125     * element to the list.
23126     *
23127     * @note The maximum length of the text label is going to be
23128     * determined <b>by the widget's theme</b>. Strings larger than
23129     * that value are going to be @b truncated.
23130     *
23131     * @ingroup Flipselector
23132     */
23133    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23134
23135    /**
23136     * Prepend a (text) item to a flip selector widget
23137     *
23138     * @param obj The flipselector object
23139     * @param label The (text) label of the new item
23140     * @param func Convenience callback function to take place when
23141     * item is selected
23142     * @param data Data passed to @p func, above
23143     * @return A handle to the item added or @c NULL, on errors
23144     *
23145     * The widget's list of labels to show will be prepended with the
23146     * given value. If the user wishes so, a callback function pointer
23147     * can be passed, which will get called when this same item is
23148     * selected.
23149     *
23150     * @note The current selection @b won't be modified by prepending
23151     * an element to the list.
23152     *
23153     * @note The maximum length of the text label is going to be
23154     * determined <b>by the widget's theme</b>. Strings larger than
23155     * that value are going to be @b truncated.
23156     *
23157     * @ingroup Flipselector
23158     */
23159    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23160
23161    /**
23162     * Get the internal list of items in a given flip selector widget.
23163     *
23164     * @param obj The flipselector object
23165     * @return The list of items (#Elm_Flipselector_Item as data) or
23166     * @c NULL on errors.
23167     *
23168     * This list is @b not to be modified in any way and must not be
23169     * freed. Use the list members with functions like
23170     * elm_flipselector_item_label_set(),
23171     * elm_flipselector_item_label_get(),
23172     * elm_flipselector_item_del(),
23173     * elm_flipselector_item_selected_get(),
23174     * elm_flipselector_item_selected_set().
23175     *
23176     * @warning This list is only valid until @p obj object's internal
23177     * items list is changed. It should be fetched again with another
23178     * call to this function when changes happen.
23179     *
23180     * @ingroup Flipselector
23181     */
23182    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23183
23184    /**
23185     * Get the first item in the given flip selector widget's list of
23186     * items.
23187     *
23188     * @param obj The flipselector object
23189     * @return The first item or @c NULL, if it has no items (and on
23190     * errors)
23191     *
23192     * @see elm_flipselector_item_append()
23193     * @see elm_flipselector_last_item_get()
23194     *
23195     * @ingroup Flipselector
23196     */
23197    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23198
23199    /**
23200     * Get the last item in the given flip selector widget's list of
23201     * items.
23202     *
23203     * @param obj The flipselector object
23204     * @return The last item or @c NULL, if it has no items (and on
23205     * errors)
23206     *
23207     * @see elm_flipselector_item_prepend()
23208     * @see elm_flipselector_first_item_get()
23209     *
23210     * @ingroup Flipselector
23211     */
23212    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23213
23214    /**
23215     * Get the currently selected item in a flip selector widget.
23216     *
23217     * @param obj The flipselector object
23218     * @return The selected item or @c NULL, if the widget has no items
23219     * (and on erros)
23220     *
23221     * @ingroup Flipselector
23222     */
23223    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23224
23225    /**
23226     * Set whether a given flip selector widget's item should be the
23227     * currently selected one.
23228     *
23229     * @param item The flip selector item
23230     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23231     *
23232     * This sets whether @p item is or not the selected (thus, under
23233     * display) one. If @p item is different than one under display,
23234     * the latter will be unselected. If the @p item is set to be
23235     * unselected, on the other hand, the @b first item in the widget's
23236     * internal members list will be the new selected one.
23237     *
23238     * @see elm_flipselector_item_selected_get()
23239     *
23240     * @ingroup Flipselector
23241     */
23242    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23243
23244    /**
23245     * Get whether a given flip selector widget's item is the currently
23246     * selected one.
23247     *
23248     * @param item The flip selector item
23249     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23250     * (or on errors).
23251     *
23252     * @see elm_flipselector_item_selected_set()
23253     *
23254     * @ingroup Flipselector
23255     */
23256    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23257
23258    /**
23259     * Delete a given item from a flip selector widget.
23260     *
23261     * @param item The item to delete
23262     *
23263     * @ingroup Flipselector
23264     */
23265    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23266
23267    /**
23268     * Get the label of a given flip selector widget's item.
23269     *
23270     * @param item The item to get label from
23271     * @return The text label of @p item or @c NULL, on errors
23272     *
23273     * @see elm_flipselector_item_label_set()
23274     *
23275     * @ingroup Flipselector
23276     */
23277    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23278
23279    /**
23280     * Set the label of a given flip selector widget's item.
23281     *
23282     * @param item The item to set label on
23283     * @param label The text label string, in UTF-8 encoding
23284     *
23285     * @see elm_flipselector_item_label_get()
23286     *
23287     * @ingroup Flipselector
23288     */
23289    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23290
23291    /**
23292     * Gets the item before @p item in a flip selector widget's
23293     * internal list of items.
23294     *
23295     * @param item The item to fetch previous from
23296     * @return The item before the @p item, in its parent's list. If
23297     *         there is no previous item for @p item or there's an
23298     *         error, @c NULL is returned.
23299     *
23300     * @see elm_flipselector_item_next_get()
23301     *
23302     * @ingroup Flipselector
23303     */
23304    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23305
23306    /**
23307     * Gets the item after @p item in a flip selector widget's
23308     * internal list of items.
23309     *
23310     * @param item The item to fetch next from
23311     * @return The item after the @p item, in its parent's list. If
23312     *         there is no next item for @p item or there's an
23313     *         error, @c NULL is returned.
23314     *
23315     * @see elm_flipselector_item_next_get()
23316     *
23317     * @ingroup Flipselector
23318     */
23319    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23320
23321    /**
23322     * Set the interval on time updates for an user mouse button hold
23323     * on a flip selector widget.
23324     *
23325     * @param obj The flip selector object
23326     * @param interval The (first) interval value in seconds
23327     *
23328     * This interval value is @b decreased while the user holds the
23329     * mouse pointer either flipping up or flipping doww a given flip
23330     * selector.
23331     *
23332     * This helps the user to get to a given item distant from the
23333     * current one easier/faster, as it will start to flip quicker and
23334     * quicker on mouse button holds.
23335     *
23336     * The calculation for the next flip interval value, starting from
23337     * the one set with this call, is the previous interval divided by
23338     * 1.05, so it decreases a little bit.
23339     *
23340     * The default starting interval value for automatic flips is
23341     * @b 0.85 seconds.
23342     *
23343     * @see elm_flipselector_interval_get()
23344     *
23345     * @ingroup Flipselector
23346     */
23347    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23348
23349    /**
23350     * Get the interval on time updates for an user mouse button hold
23351     * on a flip selector widget.
23352     *
23353     * @param obj The flip selector object
23354     * @return The (first) interval value, in seconds, set on it
23355     *
23356     * @see elm_flipselector_interval_set() for more details
23357     *
23358     * @ingroup Flipselector
23359     */
23360    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23361    /**
23362     * @}
23363     */
23364
23365    /**
23366     * @addtogroup Calendar
23367     * @{
23368     */
23369
23370    /**
23371     * @enum _Elm_Calendar_Mark_Repeat
23372     * @typedef Elm_Calendar_Mark_Repeat
23373     *
23374     * Event periodicity, used to define if a mark should be repeated
23375     * @b beyond event's day. It's set when a mark is added.
23376     *
23377     * So, for a mark added to 13th May with periodicity set to WEEKLY,
23378     * there will be marks every week after this date. Marks will be displayed
23379     * at 13th, 20th, 27th, 3rd June ...
23380     *
23381     * Values don't work as bitmask, only one can be choosen.
23382     *
23383     * @see elm_calendar_mark_add()
23384     *
23385     * @ingroup Calendar
23386     */
23387    typedef enum _Elm_Calendar_Mark_Repeat
23388      {
23389         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23390         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23391         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23392         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*/
23393         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. */
23394      } Elm_Calendar_Mark_Repeat;
23395
23396    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(). */
23397
23398    /**
23399     * Add a new calendar widget to the given parent Elementary
23400     * (container) object.
23401     *
23402     * @param parent The parent object.
23403     * @return a new calendar widget handle or @c NULL, on errors.
23404     *
23405     * This function inserts a new calendar widget on the canvas.
23406     *
23407     * @ref calendar_example_01
23408     *
23409     * @ingroup Calendar
23410     */
23411    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23412
23413    /**
23414     * Get weekdays names displayed by the calendar.
23415     *
23416     * @param obj The calendar object.
23417     * @return Array of seven strings to be used as weekday names.
23418     *
23419     * By default, weekdays abbreviations get from system are displayed:
23420     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23421     * The first string is related to Sunday, the second to Monday...
23422     *
23423     * @see elm_calendar_weekdays_name_set()
23424     *
23425     * @ref calendar_example_05
23426     *
23427     * @ingroup Calendar
23428     */
23429    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23430
23431    /**
23432     * Set weekdays names to be displayed by the calendar.
23433     *
23434     * @param obj The calendar object.
23435     * @param weekdays Array of seven strings to be used as weekday names.
23436     * @warning It must have 7 elements, or it will access invalid memory.
23437     * @warning The strings must be NULL terminated ('@\0').
23438     *
23439     * By default, weekdays abbreviations get from system are displayed:
23440     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23441     *
23442     * The first string should be related to Sunday, the second to Monday...
23443     *
23444     * The usage should be like this:
23445     * @code
23446     *   const char *weekdays[] =
23447     *   {
23448     *      "Sunday", "Monday", "Tuesday", "Wednesday",
23449     *      "Thursday", "Friday", "Saturday"
23450     *   };
23451     *   elm_calendar_weekdays_names_set(calendar, weekdays);
23452     * @endcode
23453     *
23454     * @see elm_calendar_weekdays_name_get()
23455     *
23456     * @ref calendar_example_02
23457     *
23458     * @ingroup Calendar
23459     */
23460    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23461
23462    /**
23463     * Set the minimum and maximum values for the year
23464     *
23465     * @param obj The calendar object
23466     * @param min The minimum year, greater than 1901;
23467     * @param max The maximum year;
23468     *
23469     * Maximum must be greater than minimum, except if you don't wan't to set
23470     * maximum year.
23471     * Default values are 1902 and -1.
23472     *
23473     * If the maximum year is a negative value, it will be limited depending
23474     * on the platform architecture (year 2037 for 32 bits);
23475     *
23476     * @see elm_calendar_min_max_year_get()
23477     *
23478     * @ref calendar_example_03
23479     *
23480     * @ingroup Calendar
23481     */
23482    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23483
23484    /**
23485     * Get the minimum and maximum values for the year
23486     *
23487     * @param obj The calendar object.
23488     * @param min The minimum year.
23489     * @param max The maximum year.
23490     *
23491     * Default values are 1902 and -1.
23492     *
23493     * @see elm_calendar_min_max_year_get() for more details.
23494     *
23495     * @ref calendar_example_05
23496     *
23497     * @ingroup Calendar
23498     */
23499    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23500
23501    /**
23502     * Enable or disable day selection
23503     *
23504     * @param obj The calendar object.
23505     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23506     * disable it.
23507     *
23508     * Enabled by default. If disabled, the user still can select months,
23509     * but not days. Selected days are highlighted on calendar.
23510     * It should be used if you won't need such selection for the widget usage.
23511     *
23512     * When a day is selected, or month is changed, smart callbacks for
23513     * signal "changed" will be called.
23514     *
23515     * @see elm_calendar_day_selection_enable_get()
23516     *
23517     * @ref calendar_example_04
23518     *
23519     * @ingroup Calendar
23520     */
23521    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23522
23523    /**
23524     * Get a value whether day selection is enabled or not.
23525     *
23526     * @see elm_calendar_day_selection_enable_set() for details.
23527     *
23528     * @param obj The calendar object.
23529     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23530     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23531     *
23532     * @ref calendar_example_05
23533     *
23534     * @ingroup Calendar
23535     */
23536    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23537
23538
23539    /**
23540     * Set selected date to be highlighted on calendar.
23541     *
23542     * @param obj The calendar object.
23543     * @param selected_time A @b tm struct to represent the selected date.
23544     *
23545     * Set the selected date, changing the displayed month if needed.
23546     * Selected date changes when the user goes to next/previous month or
23547     * select a day pressing over it on calendar.
23548     *
23549     * @see elm_calendar_selected_time_get()
23550     *
23551     * @ref calendar_example_04
23552     *
23553     * @ingroup Calendar
23554     */
23555    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23556
23557    /**
23558     * Get selected date.
23559     *
23560     * @param obj The calendar object
23561     * @param selected_time A @b tm struct to point to selected date
23562     * @return EINA_FALSE means an error ocurred and returned time shouldn't
23563     * be considered.
23564     *
23565     * Get date selected by the user or set by function
23566     * elm_calendar_selected_time_set().
23567     * Selected date changes when the user goes to next/previous month or
23568     * select a day pressing over it on calendar.
23569     *
23570     * @see elm_calendar_selected_time_get()
23571     *
23572     * @ref calendar_example_05
23573     *
23574     * @ingroup Calendar
23575     */
23576    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23577
23578    /**
23579     * Set a function to format the string that will be used to display
23580     * month and year;
23581     *
23582     * @param obj The calendar object
23583     * @param format_function Function to set the month-year string given
23584     * the selected date
23585     *
23586     * By default it uses strftime with "%B %Y" format string.
23587     * It should allocate the memory that will be used by the string,
23588     * that will be freed by the widget after usage.
23589     * A pointer to the string and a pointer to the time struct will be provided.
23590     *
23591     * Example:
23592     * @code
23593     * static char *
23594     * _format_month_year(struct tm *selected_time)
23595     * {
23596     *    char buf[32];
23597     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23598     *    return strdup(buf);
23599     * }
23600     *
23601     * elm_calendar_format_function_set(calendar, _format_month_year);
23602     * @endcode
23603     *
23604     * @ref calendar_example_02
23605     *
23606     * @ingroup Calendar
23607     */
23608    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23609
23610    /**
23611     * Add a new mark to the calendar
23612     *
23613     * @param obj The calendar object
23614     * @param mark_type A string used to define the type of mark. It will be
23615     * emitted to the theme, that should display a related modification on these
23616     * days representation.
23617     * @param mark_time A time struct to represent the date of inclusion of the
23618     * mark. For marks that repeats it will just be displayed after the inclusion
23619     * date in the calendar.
23620     * @param repeat Repeat the event following this periodicity. Can be a unique
23621     * mark (that don't repeat), daily, weekly, monthly or annually.
23622     * @return The created mark or @p NULL upon failure.
23623     *
23624     * Add a mark that will be drawn in the calendar respecting the insertion
23625     * time and periodicity. It will emit the type as signal to the widget theme.
23626     * Default theme supports "holiday" and "checked", but it can be extended.
23627     *
23628     * It won't immediately update the calendar, drawing the marks.
23629     * For this, call elm_calendar_marks_draw(). However, when user selects
23630     * next or previous month calendar forces marks drawn.
23631     *
23632     * Marks created with this method can be deleted with
23633     * elm_calendar_mark_del().
23634     *
23635     * Example
23636     * @code
23637     * struct tm selected_time;
23638     * time_t current_time;
23639     *
23640     * current_time = time(NULL) + 5 * 84600;
23641     * localtime_r(&current_time, &selected_time);
23642     * elm_calendar_mark_add(cal, "holiday", selected_time,
23643     *     ELM_CALENDAR_ANNUALLY);
23644     *
23645     * current_time = time(NULL) + 1 * 84600;
23646     * localtime_r(&current_time, &selected_time);
23647     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23648     *
23649     * elm_calendar_marks_draw(cal);
23650     * @endcode
23651     *
23652     * @see elm_calendar_marks_draw()
23653     * @see elm_calendar_mark_del()
23654     *
23655     * @ref calendar_example_06
23656     *
23657     * @ingroup Calendar
23658     */
23659    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);
23660
23661    /**
23662     * Delete mark from the calendar.
23663     *
23664     * @param mark The mark to be deleted.
23665     *
23666     * If deleting all calendar marks is required, elm_calendar_marks_clear()
23667     * should be used instead of getting marks list and deleting each one.
23668     *
23669     * @see elm_calendar_mark_add()
23670     *
23671     * @ref calendar_example_06
23672     *
23673     * @ingroup Calendar
23674     */
23675    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23676
23677    /**
23678     * Remove all calendar's marks
23679     *
23680     * @param obj The calendar object.
23681     *
23682     * @see elm_calendar_mark_add()
23683     * @see elm_calendar_mark_del()
23684     *
23685     * @ingroup Calendar
23686     */
23687    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23688
23689
23690    /**
23691     * Get a list of all the calendar marks.
23692     *
23693     * @param obj The calendar object.
23694     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23695     *
23696     * @see elm_calendar_mark_add()
23697     * @see elm_calendar_mark_del()
23698     * @see elm_calendar_marks_clear()
23699     *
23700     * @ingroup Calendar
23701     */
23702    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23703
23704    /**
23705     * Draw calendar marks.
23706     *
23707     * @param obj The calendar object.
23708     *
23709     * Should be used after adding, removing or clearing marks.
23710     * It will go through the entire marks list updating the calendar.
23711     * If lots of marks will be added, add all the marks and then call
23712     * this function.
23713     *
23714     * When the month is changed, i.e. user selects next or previous month,
23715     * marks will be drawed.
23716     *
23717     * @see elm_calendar_mark_add()
23718     * @see elm_calendar_mark_del()
23719     * @see elm_calendar_marks_clear()
23720     *
23721     * @ref calendar_example_06
23722     *
23723     * @ingroup Calendar
23724     */
23725    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23726
23727    /**
23728     * Set a day text color to the same that represents Saturdays.
23729     *
23730     * @param obj The calendar object.
23731     * @param pos The text position. Position is the cell counter, from left
23732     * to right, up to down. It starts on 0 and ends on 41.
23733     *
23734     * @deprecated use elm_calendar_mark_add() instead like:
23735     *
23736     * @code
23737     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23738     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23739     * @endcode
23740     *
23741     * @see elm_calendar_mark_add()
23742     *
23743     * @ingroup Calendar
23744     */
23745    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23746
23747    /**
23748     * Set a day text color to the same that represents Sundays.
23749     *
23750     * @param obj The calendar object.
23751     * @param pos The text position. Position is the cell counter, from left
23752     * to right, up to down. It starts on 0 and ends on 41.
23753
23754     * @deprecated use elm_calendar_mark_add() instead like:
23755     *
23756     * @code
23757     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23758     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23759     * @endcode
23760     *
23761     * @see elm_calendar_mark_add()
23762     *
23763     * @ingroup Calendar
23764     */
23765    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23766
23767    /**
23768     * Set a day text color to the same that represents Weekdays.
23769     *
23770     * @param obj The calendar object
23771     * @param pos The text position. Position is the cell counter, from left
23772     * to right, up to down. It starts on 0 and ends on 41.
23773     *
23774     * @deprecated use elm_calendar_mark_add() instead like:
23775     *
23776     * @code
23777     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23778     *
23779     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23780     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23781     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23782     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23783     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23784     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23785     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23786     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23787     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23788     * @endcode
23789     *
23790     * @see elm_calendar_mark_add()
23791     *
23792     * @ingroup Calendar
23793     */
23794    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23795
23796    /**
23797     * Set the interval on time updates for an user mouse button hold
23798     * on calendar widgets' month selection.
23799     *
23800     * @param obj The calendar object
23801     * @param interval The (first) interval value in seconds
23802     *
23803     * This interval value is @b decreased while the user holds the
23804     * mouse pointer either selecting next or previous month.
23805     *
23806     * This helps the user to get to a given month distant from the
23807     * current one easier/faster, as it will start to change quicker and
23808     * quicker on mouse button holds.
23809     *
23810     * The calculation for the next change interval value, starting from
23811     * the one set with this call, is the previous interval divided by
23812     * 1.05, so it decreases a little bit.
23813     *
23814     * The default starting interval value for automatic changes is
23815     * @b 0.85 seconds.
23816     *
23817     * @see elm_calendar_interval_get()
23818     *
23819     * @ingroup Calendar
23820     */
23821    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23822
23823    /**
23824     * Get the interval on time updates for an user mouse button hold
23825     * on calendar widgets' month selection.
23826     *
23827     * @param obj The calendar object
23828     * @return The (first) interval value, in seconds, set on it
23829     *
23830     * @see elm_calendar_interval_set() for more details
23831     *
23832     * @ingroup Calendar
23833     */
23834    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23835
23836    /**
23837     * @}
23838     */
23839
23840    /**
23841     * @defgroup Diskselector Diskselector
23842     * @ingroup Elementary
23843     *
23844     * @image html img/widget/diskselector/preview-00.png
23845     * @image latex img/widget/diskselector/preview-00.eps
23846     *
23847     * A diskselector is a kind of list widget. It scrolls horizontally,
23848     * and can contain label and icon objects. Three items are displayed
23849     * with the selected one in the middle.
23850     *
23851     * It can act like a circular list with round mode and labels can be
23852     * reduced for a defined length for side items.
23853     *
23854     * Smart callbacks one can listen to:
23855     * - "selected" - when item is selected, i.e. scroller stops.
23856     *
23857     * Available styles for it:
23858     * - @c "default"
23859     *
23860     * List of examples:
23861     * @li @ref diskselector_example_01
23862     * @li @ref diskselector_example_02
23863     */
23864
23865    /**
23866     * @addtogroup Diskselector
23867     * @{
23868     */
23869
23870    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(). */
23871
23872    /**
23873     * Add a new diskselector widget to the given parent Elementary
23874     * (container) object.
23875     *
23876     * @param parent The parent object.
23877     * @return a new diskselector widget handle or @c NULL, on errors.
23878     *
23879     * This function inserts a new diskselector widget on the canvas.
23880     *
23881     * @ingroup Diskselector
23882     */
23883    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23884
23885    /**
23886     * Enable or disable round mode.
23887     *
23888     * @param obj The diskselector object.
23889     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23890     * disable it.
23891     *
23892     * Disabled by default. If round mode is enabled the items list will
23893     * work like a circle list, so when the user reaches the last item,
23894     * the first one will popup.
23895     *
23896     * @see elm_diskselector_round_get()
23897     *
23898     * @ingroup Diskselector
23899     */
23900    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23901
23902    /**
23903     * Get a value whether round mode is enabled or not.
23904     *
23905     * @see elm_diskselector_round_set() for details.
23906     *
23907     * @param obj The diskselector object.
23908     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23909     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23910     *
23911     * @ingroup Diskselector
23912     */
23913    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23914
23915    /**
23916     * Get the side labels max length.
23917     *
23918     * @deprecated use elm_diskselector_side_label_length_get() instead:
23919     *
23920     * @param obj The diskselector object.
23921     * @return The max length defined for side labels, or 0 if not a valid
23922     * diskselector.
23923     *
23924     * @ingroup Diskselector
23925     */
23926    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23927
23928    /**
23929     * Set the side labels max length.
23930     *
23931     * @deprecated use elm_diskselector_side_label_length_set() instead:
23932     *
23933     * @param obj The diskselector object.
23934     * @param len The max length defined for side labels.
23935     *
23936     * @ingroup Diskselector
23937     */
23938    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23939
23940    /**
23941     * Get the side labels max length.
23942     *
23943     * @see elm_diskselector_side_label_length_set() for details.
23944     *
23945     * @param obj The diskselector object.
23946     * @return The max length defined for side labels, or 0 if not a valid
23947     * diskselector.
23948     *
23949     * @ingroup Diskselector
23950     */
23951    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23952
23953    /**
23954     * Set the side labels max length.
23955     *
23956     * @param obj The diskselector object.
23957     * @param len The max length defined for side labels.
23958     *
23959     * Length is the number of characters of items' label that will be
23960     * visible when it's set on side positions. It will just crop
23961     * the string after defined size. E.g.:
23962     *
23963     * An item with label "January" would be displayed on side position as
23964     * "Jan" if max length is set to 3, or "Janu", if this property
23965     * is set to 4.
23966     *
23967     * When it's selected, the entire label will be displayed, except for
23968     * width restrictions. In this case label will be cropped and "..."
23969     * will be concatenated.
23970     *
23971     * Default side label max length is 3.
23972     *
23973     * This property will be applyed over all items, included before or
23974     * later this function call.
23975     *
23976     * @ingroup Diskselector
23977     */
23978    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23979
23980    /**
23981     * Set the number of items to be displayed.
23982     *
23983     * @param obj The diskselector object.
23984     * @param num The number of items the diskselector will display.
23985     *
23986     * Default value is 3, and also it's the minimun. If @p num is less
23987     * than 3, it will be set to 3.
23988     *
23989     * Also, it can be set on theme, using data item @c display_item_num
23990     * on group "elm/diskselector/item/X", where X is style set.
23991     * E.g.:
23992     *
23993     * group { name: "elm/diskselector/item/X";
23994     * data {
23995     *     item: "display_item_num" "5";
23996     *     }
23997     *
23998     * @ingroup Diskselector
23999     */
24000    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24001
24002    /**
24003     * Set bouncing behaviour when the scrolled content reaches an edge.
24004     *
24005     * Tell the internal scroller object whether it should bounce or not
24006     * when it reaches the respective edges for each axis.
24007     *
24008     * @param obj The diskselector object.
24009     * @param h_bounce Whether to bounce or not in the horizontal axis.
24010     * @param v_bounce Whether to bounce or not in the vertical axis.
24011     *
24012     * @see elm_scroller_bounce_set()
24013     *
24014     * @ingroup Diskselector
24015     */
24016    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24017
24018    /**
24019     * Get the bouncing behaviour of the internal scroller.
24020     *
24021     * Get whether the internal scroller should bounce when the edge of each
24022     * axis is reached scrolling.
24023     *
24024     * @param obj The diskselector object.
24025     * @param h_bounce Pointer where to store the bounce state of the horizontal
24026     * axis.
24027     * @param v_bounce Pointer where to store the bounce state of the vertical
24028     * axis.
24029     *
24030     * @see elm_scroller_bounce_get()
24031     * @see elm_diskselector_bounce_set()
24032     *
24033     * @ingroup Diskselector
24034     */
24035    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24036
24037    /**
24038     * Get the scrollbar policy.
24039     *
24040     * @see elm_diskselector_scroller_policy_get() for details.
24041     *
24042     * @param obj The diskselector object.
24043     * @param policy_h Pointer where to store horizontal scrollbar policy.
24044     * @param policy_v Pointer where to store vertical scrollbar policy.
24045     *
24046     * @ingroup Diskselector
24047     */
24048    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);
24049
24050    /**
24051     * Set the scrollbar policy.
24052     *
24053     * @param obj The diskselector object.
24054     * @param policy_h Horizontal scrollbar policy.
24055     * @param policy_v Vertical scrollbar policy.
24056     *
24057     * This sets the scrollbar visibility policy for the given scroller.
24058     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
24059     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24060     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24061     * This applies respectively for the horizontal and vertical scrollbars.
24062     *
24063     * The both are disabled by default, i.e., are set to
24064     * #ELM_SCROLLER_POLICY_OFF.
24065     *
24066     * @ingroup Diskselector
24067     */
24068    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24069
24070    /**
24071     * Remove all diskselector's items.
24072     *
24073     * @param obj The diskselector object.
24074     *
24075     * @see elm_diskselector_item_del()
24076     * @see elm_diskselector_item_append()
24077     *
24078     * @ingroup Diskselector
24079     */
24080    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24081
24082    /**
24083     * Get a list of all the diskselector items.
24084     *
24085     * @param obj The diskselector object.
24086     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24087     * or @c NULL on failure.
24088     *
24089     * @see elm_diskselector_item_append()
24090     * @see elm_diskselector_item_del()
24091     * @see elm_diskselector_clear()
24092     *
24093     * @ingroup Diskselector
24094     */
24095    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24096
24097    /**
24098     * Appends a new item to the diskselector object.
24099     *
24100     * @param obj The diskselector object.
24101     * @param label The label of the diskselector item.
24102     * @param icon The icon object to use at left side of the item. An
24103     * icon can be any Evas object, but usually it is an icon created
24104     * with elm_icon_add().
24105     * @param func The function to call when the item is selected.
24106     * @param data The data to associate with the item for related callbacks.
24107     *
24108     * @return The created item or @c NULL upon failure.
24109     *
24110     * A new item will be created and appended to the diskselector, i.e., will
24111     * be set as last item. Also, if there is no selected item, it will
24112     * be selected. This will always happens for the first appended item.
24113     *
24114     * If no icon is set, label will be centered on item position, otherwise
24115     * the icon will be placed at left of the label, that will be shifted
24116     * to the right.
24117     *
24118     * Items created with this method can be deleted with
24119     * elm_diskselector_item_del().
24120     *
24121     * Associated @p data can be properly freed when item is deleted if a
24122     * callback function is set with elm_diskselector_item_del_cb_set().
24123     *
24124     * If a function is passed as argument, it will be called everytime this item
24125     * is selected, i.e., the user stops the diskselector with this
24126     * item on center position. If such function isn't needed, just passing
24127     * @c NULL as @p func is enough. The same should be done for @p data.
24128     *
24129     * Simple example (with no function callback or data associated):
24130     * @code
24131     * disk = elm_diskselector_add(win);
24132     * ic = elm_icon_add(win);
24133     * elm_icon_file_set(ic, "path/to/image", NULL);
24134     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24135     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24136     * @endcode
24137     *
24138     * @see elm_diskselector_item_del()
24139     * @see elm_diskselector_item_del_cb_set()
24140     * @see elm_diskselector_clear()
24141     * @see elm_icon_add()
24142     *
24143     * @ingroup Diskselector
24144     */
24145    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);
24146
24147
24148    /**
24149     * Delete them item from the diskselector.
24150     *
24151     * @param it The item of diskselector to be deleted.
24152     *
24153     * If deleting all diskselector items is required, elm_diskselector_clear()
24154     * should be used instead of getting items list and deleting each one.
24155     *
24156     * @see elm_diskselector_clear()
24157     * @see elm_diskselector_item_append()
24158     * @see elm_diskselector_item_del_cb_set()
24159     *
24160     * @ingroup Diskselector
24161     */
24162    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24163
24164    /**
24165     * Set the function called when a diskselector item is freed.
24166     *
24167     * @param it The item to set the callback on
24168     * @param func The function called
24169     *
24170     * If there is a @p func, then it will be called prior item's memory release.
24171     * That will be called with the following arguments:
24172     * @li item's data;
24173     * @li item's Evas object;
24174     * @li item itself;
24175     *
24176     * This way, a data associated to a diskselector item could be properly
24177     * freed.
24178     *
24179     * @ingroup Diskselector
24180     */
24181    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24182
24183    /**
24184     * Get the data associated to the item.
24185     *
24186     * @param it The diskselector item
24187     * @return The data associated to @p it
24188     *
24189     * The return value is a pointer to data associated to @p item when it was
24190     * created, with function elm_diskselector_item_append(). If no data
24191     * was passed as argument, it will return @c NULL.
24192     *
24193     * @see elm_diskselector_item_append()
24194     *
24195     * @ingroup Diskselector
24196     */
24197    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24198
24199    /**
24200     * Set the icon associated to the item.
24201     *
24202     * @param it The diskselector item
24203     * @param icon The icon object to associate with @p it
24204     *
24205     * The icon object to use at left side of the item. An
24206     * icon can be any Evas object, but usually it is an icon created
24207     * with elm_icon_add().
24208     *
24209     * Once the icon object is set, a previously set one will be deleted.
24210     * @warning Setting the same icon for two items will cause the icon to
24211     * dissapear from the first item.
24212     *
24213     * If an icon was passed as argument on item creation, with function
24214     * elm_diskselector_item_append(), it will be already
24215     * associated to the item.
24216     *
24217     * @see elm_diskselector_item_append()
24218     * @see elm_diskselector_item_icon_get()
24219     *
24220     * @ingroup Diskselector
24221     */
24222    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24223
24224    /**
24225     * Get the icon associated to the item.
24226     *
24227     * @param it The diskselector item
24228     * @return The icon associated to @p it
24229     *
24230     * The return value is a pointer to the icon associated to @p item when it was
24231     * created, with function elm_diskselector_item_append(), or later
24232     * with function elm_diskselector_item_icon_set. If no icon
24233     * was passed as argument, it will return @c NULL.
24234     *
24235     * @see elm_diskselector_item_append()
24236     * @see elm_diskselector_item_icon_set()
24237     *
24238     * @ingroup Diskselector
24239     */
24240    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24241
24242    /**
24243     * Set the label of item.
24244     *
24245     * @param it The item of diskselector.
24246     * @param label The label of item.
24247     *
24248     * The label to be displayed by the item.
24249     *
24250     * If no icon is set, label will be centered on item position, otherwise
24251     * the icon will be placed at left of the label, that will be shifted
24252     * to the right.
24253     *
24254     * An item with label "January" would be displayed on side position as
24255     * "Jan" if max length is set to 3 with function
24256     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24257     * is set to 4.
24258     *
24259     * When this @p item is selected, the entire label will be displayed,
24260     * except for width restrictions.
24261     * In this case label will be cropped and "..." will be concatenated,
24262     * but only for display purposes. It will keep the entire string, so
24263     * if diskselector is resized the remaining characters will be displayed.
24264     *
24265     * If a label was passed as argument on item creation, with function
24266     * elm_diskselector_item_append(), it will be already
24267     * displayed by the item.
24268     *
24269     * @see elm_diskselector_side_label_lenght_set()
24270     * @see elm_diskselector_item_label_get()
24271     * @see elm_diskselector_item_append()
24272     *
24273     * @ingroup Diskselector
24274     */
24275    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24276
24277    /**
24278     * Get the label of item.
24279     *
24280     * @param it The item of diskselector.
24281     * @return The label of item.
24282     *
24283     * The return value is a pointer to the label associated to @p item when it was
24284     * created, with function elm_diskselector_item_append(), or later
24285     * with function elm_diskselector_item_label_set. If no label
24286     * was passed as argument, it will return @c NULL.
24287     *
24288     * @see elm_diskselector_item_label_set() for more details.
24289     * @see elm_diskselector_item_append()
24290     *
24291     * @ingroup Diskselector
24292     */
24293    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24294
24295    /**
24296     * Get the selected item.
24297     *
24298     * @param obj The diskselector object.
24299     * @return The selected diskselector item.
24300     *
24301     * The selected item can be unselected with function
24302     * elm_diskselector_item_selected_set(), and the first item of
24303     * diskselector will be selected.
24304     *
24305     * The selected item always will be centered on diskselector, with
24306     * full label displayed, i.e., max lenght set to side labels won't
24307     * apply on the selected item. More details on
24308     * elm_diskselector_side_label_length_set().
24309     *
24310     * @ingroup Diskselector
24311     */
24312    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24313
24314    /**
24315     * Set the selected state of an item.
24316     *
24317     * @param it The diskselector item
24318     * @param selected The selected state
24319     *
24320     * This sets the selected state of the given item @p it.
24321     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24322     *
24323     * If a new item is selected the previosly selected will be unselected.
24324     * Previoulsy selected item can be get with function
24325     * elm_diskselector_selected_item_get().
24326     *
24327     * If the item @p it is unselected, the first item of diskselector will
24328     * be selected.
24329     *
24330     * Selected items will be visible on center position of diskselector.
24331     * So if it was on another position before selected, or was invisible,
24332     * diskselector will animate items until the selected item reaches center
24333     * position.
24334     *
24335     * @see elm_diskselector_item_selected_get()
24336     * @see elm_diskselector_selected_item_get()
24337     *
24338     * @ingroup Diskselector
24339     */
24340    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24341
24342    /*
24343     * Get whether the @p item is selected or not.
24344     *
24345     * @param it The diskselector item.
24346     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24347     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24348     *
24349     * @see elm_diskselector_selected_item_set() for details.
24350     * @see elm_diskselector_item_selected_get()
24351     *
24352     * @ingroup Diskselector
24353     */
24354    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24355
24356    /**
24357     * Get the first item of the diskselector.
24358     *
24359     * @param obj The diskselector object.
24360     * @return The first item, or @c NULL if none.
24361     *
24362     * The list of items follows append order. So it will return the first
24363     * item appended to the widget that wasn't deleted.
24364     *
24365     * @see elm_diskselector_item_append()
24366     * @see elm_diskselector_items_get()
24367     *
24368     * @ingroup Diskselector
24369     */
24370    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24371
24372    /**
24373     * Get the last item of the diskselector.
24374     *
24375     * @param obj The diskselector object.
24376     * @return The last item, or @c NULL if none.
24377     *
24378     * The list of items follows append order. So it will return last first
24379     * item appended to the widget that wasn't deleted.
24380     *
24381     * @see elm_diskselector_item_append()
24382     * @see elm_diskselector_items_get()
24383     *
24384     * @ingroup Diskselector
24385     */
24386    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24387
24388    /**
24389     * Get the item before @p item in diskselector.
24390     *
24391     * @param it The diskselector item.
24392     * @return The item before @p item, or @c NULL if none or on failure.
24393     *
24394     * The list of items follows append order. So it will return item appended
24395     * just before @p item and that wasn't deleted.
24396     *
24397     * If it is the first item, @c NULL will be returned.
24398     * First item can be get by elm_diskselector_first_item_get().
24399     *
24400     * @see elm_diskselector_item_append()
24401     * @see elm_diskselector_items_get()
24402     *
24403     * @ingroup Diskselector
24404     */
24405    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24406
24407    /**
24408     * Get the item after @p item in diskselector.
24409     *
24410     * @param it The diskselector item.
24411     * @return The item after @p item, or @c NULL if none or on failure.
24412     *
24413     * The list of items follows append order. So it will return item appended
24414     * just after @p item and that wasn't deleted.
24415     *
24416     * If it is the last item, @c NULL will be returned.
24417     * Last item can be get by elm_diskselector_last_item_get().
24418     *
24419     * @see elm_diskselector_item_append()
24420     * @see elm_diskselector_items_get()
24421     *
24422     * @ingroup Diskselector
24423     */
24424    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24425
24426    /**
24427     * Set the text to be shown in the diskselector item.
24428     *
24429     * @param item Target item
24430     * @param text The text to set in the content
24431     *
24432     * Setup the text as tooltip to object. The item can have only one tooltip,
24433     * so any previous tooltip data is removed.
24434     *
24435     * @see elm_object_tooltip_text_set() for more details.
24436     *
24437     * @ingroup Diskselector
24438     */
24439    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24440
24441    /**
24442     * Set the content to be shown in the tooltip item.
24443     *
24444     * Setup the tooltip to item. The item can have only one tooltip,
24445     * so any previous tooltip data is removed. @p func(with @p data) will
24446     * be called every time that need show the tooltip and it should
24447     * return a valid Evas_Object. This object is then managed fully by
24448     * tooltip system and is deleted when the tooltip is gone.
24449     *
24450     * @param item the diskselector item being attached a tooltip.
24451     * @param func the function used to create the tooltip contents.
24452     * @param data what to provide to @a func as callback data/context.
24453     * @param del_cb called when data is not needed anymore, either when
24454     *        another callback replaces @p func, the tooltip is unset with
24455     *        elm_diskselector_item_tooltip_unset() or the owner @a item
24456     *        dies. This callback receives as the first parameter the
24457     *        given @a data, and @c event_info is the item.
24458     *
24459     * @see elm_object_tooltip_content_cb_set() for more details.
24460     *
24461     * @ingroup Diskselector
24462     */
24463    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);
24464
24465    /**
24466     * Unset tooltip from item.
24467     *
24468     * @param item diskselector item to remove previously set tooltip.
24469     *
24470     * Remove tooltip from item. The callback provided as del_cb to
24471     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24472     * it is not used anymore.
24473     *
24474     * @see elm_object_tooltip_unset() for more details.
24475     * @see elm_diskselector_item_tooltip_content_cb_set()
24476     *
24477     * @ingroup Diskselector
24478     */
24479    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24480
24481
24482    /**
24483     * Sets a different style for this item tooltip.
24484     *
24485     * @note before you set a style you should define a tooltip with
24486     *       elm_diskselector_item_tooltip_content_cb_set() or
24487     *       elm_diskselector_item_tooltip_text_set()
24488     *
24489     * @param item diskselector item with tooltip already set.
24490     * @param style the theme style to use (default, transparent, ...)
24491     *
24492     * @see elm_object_tooltip_style_set() for more details.
24493     *
24494     * @ingroup Diskselector
24495     */
24496    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24497
24498    /**
24499     * Get the style for this item tooltip.
24500     *
24501     * @param item diskselector item with tooltip already set.
24502     * @return style the theme style in use, defaults to "default". If the
24503     *         object does not have a tooltip set, then NULL is returned.
24504     *
24505     * @see elm_object_tooltip_style_get() for more details.
24506     * @see elm_diskselector_item_tooltip_style_set()
24507     *
24508     * @ingroup Diskselector
24509     */
24510    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24511
24512    /**
24513     * Set the cursor to be shown when mouse is over the diskselector item
24514     *
24515     * @param item Target item
24516     * @param cursor the cursor name to be used.
24517     *
24518     * @see elm_object_cursor_set() for more details.
24519     *
24520     * @ingroup Diskselector
24521     */
24522    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24523
24524    /**
24525     * Get the cursor to be shown when mouse is over the diskselector item
24526     *
24527     * @param item diskselector item with cursor already set.
24528     * @return the cursor name.
24529     *
24530     * @see elm_object_cursor_get() for more details.
24531     * @see elm_diskselector_cursor_set()
24532     *
24533     * @ingroup Diskselector
24534     */
24535    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24536
24537
24538    /**
24539     * Unset the cursor to be shown when mouse is over the diskselector item
24540     *
24541     * @param item Target item
24542     *
24543     * @see elm_object_cursor_unset() for more details.
24544     * @see elm_diskselector_cursor_set()
24545     *
24546     * @ingroup Diskselector
24547     */
24548    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24549
24550    /**
24551     * Sets a different style for this item cursor.
24552     *
24553     * @note before you set a style you should define a cursor with
24554     *       elm_diskselector_item_cursor_set()
24555     *
24556     * @param item diskselector item with cursor already set.
24557     * @param style the theme style to use (default, transparent, ...)
24558     *
24559     * @see elm_object_cursor_style_set() for more details.
24560     *
24561     * @ingroup Diskselector
24562     */
24563    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24564
24565
24566    /**
24567     * Get the style for this item cursor.
24568     *
24569     * @param item diskselector item with cursor already set.
24570     * @return style the theme style in use, defaults to "default". If the
24571     *         object does not have a cursor set, then @c NULL is returned.
24572     *
24573     * @see elm_object_cursor_style_get() for more details.
24574     * @see elm_diskselector_item_cursor_style_set()
24575     *
24576     * @ingroup Diskselector
24577     */
24578    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24579
24580
24581    /**
24582     * Set if the cursor set should be searched on the theme or should use
24583     * the provided by the engine, only.
24584     *
24585     * @note before you set if should look on theme you should define a cursor
24586     * with elm_diskselector_item_cursor_set().
24587     * By default it will only look for cursors provided by the engine.
24588     *
24589     * @param item widget item with cursor already set.
24590     * @param engine_only boolean to define if cursors set with
24591     * elm_diskselector_item_cursor_set() should be searched only
24592     * between cursors provided by the engine or searched on widget's
24593     * theme as well.
24594     *
24595     * @see elm_object_cursor_engine_only_set() for more details.
24596     *
24597     * @ingroup Diskselector
24598     */
24599    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24600
24601    /**
24602     * Get the cursor engine only usage for this item cursor.
24603     *
24604     * @param item widget item with cursor already set.
24605     * @return engine_only boolean to define it cursors should be looked only
24606     * between the provided by the engine or searched on widget's theme as well.
24607     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24608     *
24609     * @see elm_object_cursor_engine_only_get() for more details.
24610     * @see elm_diskselector_item_cursor_engine_only_set()
24611     *
24612     * @ingroup Diskselector
24613     */
24614    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24615
24616    /**
24617     * @}
24618     */
24619
24620    /**
24621     * @defgroup Colorselector Colorselector
24622     *
24623     * @{
24624     *
24625     * @image html img/widget/colorselector/preview-00.png
24626     * @image latex img/widget/colorselector/preview-00.eps
24627     *
24628     * @brief Widget for user to select a color.
24629     *
24630     * Signals that you can add callbacks for are:
24631     * "changed" - When the color value changes(event_info is NULL).
24632     *
24633     * See @ref tutorial_colorselector.
24634     */
24635    /**
24636     * @brief Add a new colorselector to the parent
24637     *
24638     * @param parent The parent object
24639     * @return The new object or NULL if it cannot be created
24640     *
24641     * @ingroup Colorselector
24642     */
24643    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24644    /**
24645     * Set a color for the colorselector
24646     *
24647     * @param obj   Colorselector object
24648     * @param r     r-value of color
24649     * @param g     g-value of color
24650     * @param b     b-value of color
24651     * @param a     a-value of color
24652     *
24653     * @ingroup Colorselector
24654     */
24655    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24656    /**
24657     * Get a color from the colorselector
24658     *
24659     * @param obj   Colorselector object
24660     * @param r     integer pointer for r-value of color
24661     * @param g     integer pointer for g-value of color
24662     * @param b     integer pointer for b-value of color
24663     * @param a     integer pointer for a-value of color
24664     *
24665     * @ingroup Colorselector
24666     */
24667    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24668    /**
24669     * @}
24670     */
24671
24672    /**
24673     * @defgroup Ctxpopup Ctxpopup
24674     *
24675     * @image html img/widget/ctxpopup/preview-00.png
24676     * @image latex img/widget/ctxpopup/preview-00.eps
24677     *
24678     * @brief Context popup widet.
24679     *
24680     * A ctxpopup is a widget that, when shown, pops up a list of items.
24681     * It automatically chooses an area inside its parent object's view
24682     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24683     * optimally fit into it. In the default theme, it will also point an
24684     * arrow to it's top left position at the time one shows it. Ctxpopup
24685     * items have a label and/or an icon. It is intended for a small
24686     * number of items (hence the use of list, not genlist).
24687     *
24688     * @note Ctxpopup is a especialization of @ref Hover.
24689     *
24690     * Signals that you can add callbacks for are:
24691     * "dismissed" - the ctxpopup was dismissed
24692     *
24693     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24694     * @{
24695     */
24696    typedef enum _Elm_Ctxpopup_Direction
24697      {
24698         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24699                                           area */
24700         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24701                                            the clicked area */
24702         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24703                                           the clicked area */
24704         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24705                                         area */
24706      } Elm_Ctxpopup_Direction;
24707
24708    /**
24709     * @brief Add a new Ctxpopup object to the parent.
24710     *
24711     * @param parent Parent object
24712     * @return New object or @c NULL, if it cannot be created
24713     */
24714    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24715    /**
24716     * @brief Set the Ctxpopup's parent
24717     *
24718     * @param obj The ctxpopup object
24719     * @param area The parent to use
24720     *
24721     * Set the parent object.
24722     *
24723     * @note elm_ctxpopup_add() will automatically call this function
24724     * with its @c parent argument.
24725     *
24726     * @see elm_ctxpopup_add()
24727     * @see elm_hover_parent_set()
24728     */
24729    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24730    /**
24731     * @brief Get the Ctxpopup's parent
24732     *
24733     * @param obj The ctxpopup object
24734     *
24735     * @see elm_ctxpopup_hover_parent_set() for more information
24736     */
24737    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24738    /**
24739     * @brief Clear all items in the given ctxpopup object.
24740     *
24741     * @param obj Ctxpopup object
24742     */
24743    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24744    /**
24745     * @brief Change the ctxpopup's orientation to horizontal or vertical.
24746     *
24747     * @param obj Ctxpopup object
24748     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24749     */
24750    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24751    /**
24752     * @brief Get the value of current ctxpopup object's orientation.
24753     *
24754     * @param obj Ctxpopup object
24755     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24756     *
24757     * @see elm_ctxpopup_horizontal_set()
24758     */
24759    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24760    /**
24761     * @brief Add a new item to a ctxpopup object.
24762     *
24763     * @param obj Ctxpopup object
24764     * @param icon Icon to be set on new item
24765     * @param label The Label of the new item
24766     * @param func Convenience function called when item selected
24767     * @param data Data passed to @p func
24768     * @return A handle to the item added or @c NULL, on errors
24769     *
24770     * @warning Ctxpopup can't hold both an item list and a content at the same
24771     * time. When an item is added, any previous content will be removed.
24772     *
24773     * @see elm_ctxpopup_content_set()
24774     */
24775    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);
24776    /**
24777     * @brief Delete the given item in a ctxpopup object.
24778     *
24779     * @param it Ctxpopup item to be deleted
24780     *
24781     * @see elm_ctxpopup_item_append()
24782     */
24783    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24784    /**
24785     * @brief Set the ctxpopup item's state as disabled or enabled.
24786     *
24787     * @param it Ctxpopup item to be enabled/disabled
24788     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24789     *
24790     * When disabled the item is greyed out to indicate it's state.
24791     */
24792    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24793    /**
24794     * @brief Get the ctxpopup item's disabled/enabled state.
24795     *
24796     * @param it Ctxpopup item to be enabled/disabled
24797     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24798     *
24799     * @see elm_ctxpopup_item_disabled_set()
24800     */
24801    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24802    /**
24803     * @brief Get the icon object for the given ctxpopup item.
24804     *
24805     * @param it Ctxpopup item
24806     * @return icon object or @c NULL, if the item does not have icon or an error
24807     * occurred
24808     *
24809     * @see elm_ctxpopup_item_append()
24810     * @see elm_ctxpopup_item_icon_set()
24811     */
24812    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24813    /**
24814     * @brief Sets the side icon associated with the ctxpopup item
24815     *
24816     * @param it Ctxpopup item
24817     * @param icon Icon object to be set
24818     *
24819     * Once the icon object is set, a previously set one will be deleted.
24820     * @warning Setting the same icon for two items will cause the icon to
24821     * dissapear from the first item.
24822     *
24823     * @see elm_ctxpopup_item_append()
24824     */
24825    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24826    /**
24827     * @brief Get the label for the given ctxpopup item.
24828     *
24829     * @param it Ctxpopup item
24830     * @return label string or @c NULL, if the item does not have label or an
24831     * error occured
24832     *
24833     * @see elm_ctxpopup_item_append()
24834     * @see elm_ctxpopup_item_label_set()
24835     */
24836    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24837    /**
24838     * @brief (Re)set the label on the given ctxpopup item.
24839     *
24840     * @param it Ctxpopup item
24841     * @param label String to set as label
24842     */
24843    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24844    /**
24845     * @brief Set an elm widget as the content of the ctxpopup.
24846     *
24847     * @param obj Ctxpopup object
24848     * @param content Content to be swallowed
24849     *
24850     * If the content object is already set, a previous one will bedeleted. If
24851     * you want to keep that old content object, use the
24852     * elm_ctxpopup_content_unset() function.
24853     *
24854     * @deprecated use elm_object_content_set()
24855     *
24856     * @warning Ctxpopup can't hold both a item list and a content at the same
24857     * time. When a content is set, any previous items will be removed.
24858     */
24859    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24860    /**
24861     * @brief Unset the ctxpopup content
24862     *
24863     * @param obj Ctxpopup object
24864     * @return The content that was being used
24865     *
24866     * Unparent and return the content object which was set for this widget.
24867     *
24868     * @deprecated use elm_object_content_unset()
24869     *
24870     * @see elm_ctxpopup_content_set()
24871     */
24872    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24873    /**
24874     * @brief Set the direction priority of a ctxpopup.
24875     *
24876     * @param obj Ctxpopup object
24877     * @param first 1st priority of direction
24878     * @param second 2nd priority of direction
24879     * @param third 3th priority of direction
24880     * @param fourth 4th priority of direction
24881     *
24882     * This functions gives a chance to user to set the priority of ctxpopup
24883     * showing direction. This doesn't guarantee the ctxpopup will appear in the
24884     * requested direction.
24885     *
24886     * @see Elm_Ctxpopup_Direction
24887     */
24888    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);
24889    /**
24890     * @brief Get the direction priority of a ctxpopup.
24891     *
24892     * @param obj Ctxpopup object
24893     * @param first 1st priority of direction to be returned
24894     * @param second 2nd priority of direction to be returned
24895     * @param third 3th priority of direction to be returned
24896     * @param fourth 4th priority of direction to be returned
24897     *
24898     * @see elm_ctxpopup_direction_priority_set() for more information.
24899     */
24900    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);
24901    /**
24902     * @}
24903     */
24904
24905    /* transit */
24906    /**
24907     *
24908     * @defgroup Transit Transit
24909     * @ingroup Elementary
24910     *
24911     * Transit is designed to apply various animated transition effects to @c
24912     * Evas_Object, such like translation, rotation, etc. For using these
24913     * effects, create an @ref Elm_Transit and add the desired transition effects.
24914     *
24915     * Once the effects are added into transit, they will be automatically
24916     * managed (their callback will be called until the duration is ended, and
24917     * they will be deleted on completion).
24918     *
24919     * Example:
24920     * @code
24921     * Elm_Transit *trans = elm_transit_add();
24922     * elm_transit_object_add(trans, obj);
24923     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
24924     * elm_transit_duration_set(transit, 1);
24925     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
24926     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
24927     * elm_transit_repeat_times_set(transit, 3);
24928     * @endcode
24929     *
24930     * Some transition effects are used to change the properties of objects. They
24931     * are:
24932     * @li @ref elm_transit_effect_translation_add
24933     * @li @ref elm_transit_effect_color_add
24934     * @li @ref elm_transit_effect_rotation_add
24935     * @li @ref elm_transit_effect_wipe_add
24936     * @li @ref elm_transit_effect_zoom_add
24937     * @li @ref elm_transit_effect_resizing_add
24938     *
24939     * Other transition effects are used to make one object disappear and another
24940     * object appear on its old place. These effects are:
24941     *
24942     * @li @ref elm_transit_effect_flip_add
24943     * @li @ref elm_transit_effect_resizable_flip_add
24944     * @li @ref elm_transit_effect_fade_add
24945     * @li @ref elm_transit_effect_blend_add
24946     *
24947     * It's also possible to make a transition chain with @ref
24948     * elm_transit_chain_transit_add.
24949     *
24950     * @warning We strongly recommend to use elm_transit just when edje can not do
24951     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
24952     * animations can be manipulated inside the theme.
24953     *
24954     * List of examples:
24955     * @li @ref transit_example_01_explained
24956     * @li @ref transit_example_02_explained
24957     * @li @ref transit_example_03_c
24958     * @li @ref transit_example_04_c
24959     *
24960     * @{
24961     */
24962
24963    /**
24964     * @enum Elm_Transit_Tween_Mode
24965     *
24966     * The type of acceleration used in the transition.
24967     */
24968    typedef enum
24969      {
24970         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
24971         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
24972                                              over time, then decrease again
24973                                              and stop slowly */
24974         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
24975                                              speed over time */
24976         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
24977                                             over time */
24978      } Elm_Transit_Tween_Mode;
24979
24980    /**
24981     * @enum Elm_Transit_Effect_Flip_Axis
24982     *
24983     * The axis where flip effect should be applied.
24984     */
24985    typedef enum
24986      {
24987         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
24988         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
24989      } Elm_Transit_Effect_Flip_Axis;
24990    /**
24991     * @enum Elm_Transit_Effect_Wipe_Dir
24992     *
24993     * The direction where the wipe effect should occur.
24994     */
24995    typedef enum
24996      {
24997         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
24998         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
24999         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25000         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25001      } Elm_Transit_Effect_Wipe_Dir;
25002    /** @enum Elm_Transit_Effect_Wipe_Type
25003     *
25004     * Whether the wipe effect should show or hide the object.
25005     */
25006    typedef enum
25007      {
25008         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25009                                              animation */
25010         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25011                                             animation */
25012      } Elm_Transit_Effect_Wipe_Type;
25013
25014    /**
25015     * @typedef Elm_Transit
25016     *
25017     * The Transit created with elm_transit_add(). This type has the information
25018     * about the objects which the transition will be applied, and the
25019     * transition effects that will be used. It also contains info about
25020     * duration, number of repetitions, auto-reverse, etc.
25021     */
25022    typedef struct _Elm_Transit Elm_Transit;
25023    typedef void Elm_Transit_Effect;
25024    /**
25025     * @typedef Elm_Transit_Effect_Transition_Cb
25026     *
25027     * Transition callback called for this effect on each transition iteration.
25028     */
25029    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25030    /**
25031     * Elm_Transit_Effect_End_Cb
25032     *
25033     * Transition callback called for this effect when the transition is over.
25034     */
25035    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25036
25037    /**
25038     * Elm_Transit_Del_Cb
25039     *
25040     * A callback called when the transit is deleted.
25041     */
25042    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25043
25044    /**
25045     * Add new transit.
25046     *
25047     * @note Is not necessary to delete the transit object, it will be deleted at
25048     * the end of its operation.
25049     * @note The transit will start playing when the program enter in the main loop, is not
25050     * necessary to give a start to the transit.
25051     *
25052     * @return The transit object.
25053     *
25054     * @ingroup Transit
25055     */
25056    EAPI Elm_Transit                *elm_transit_add(void);
25057
25058    /**
25059     * Stops the animation and delete the @p transit object.
25060     *
25061     * Call this function if you wants to stop the animation before the duration
25062     * time. Make sure the @p transit object is still alive with
25063     * elm_transit_del_cb_set() function.
25064     * All added effects will be deleted, calling its repective data_free_cb
25065     * functions. The function setted by elm_transit_del_cb_set() will be called.
25066     *
25067     * @see elm_transit_del_cb_set()
25068     *
25069     * @param transit The transit object to be deleted.
25070     *
25071     * @ingroup Transit
25072     * @warning Just call this function if you are sure the transit is alive.
25073     */
25074    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25075
25076    /**
25077     * Add a new effect to the transit.
25078     *
25079     * @note The cb function and the data are the key to the effect. If you try to
25080     * add an already added effect, nothing is done.
25081     * @note After the first addition of an effect in @p transit, if its
25082     * effect list become empty again, the @p transit will be killed by
25083     * elm_transit_del(transit) function.
25084     *
25085     * Exemple:
25086     * @code
25087     * Elm_Transit *transit = elm_transit_add();
25088     * elm_transit_effect_add(transit,
25089     *                        elm_transit_effect_blend_op,
25090     *                        elm_transit_effect_blend_context_new(),
25091     *                        elm_transit_effect_blend_context_free);
25092     * @endcode
25093     *
25094     * @param transit The transit object.
25095     * @param transition_cb The operation function. It is called when the
25096     * animation begins, it is the function that actually performs the animation.
25097     * It is called with the @p data, @p transit and the time progression of the
25098     * animation (a double value between 0.0 and 1.0).
25099     * @param effect The context data of the effect.
25100     * @param end_cb The function to free the context data, it will be called
25101     * at the end of the effect, it must finalize the animation and free the
25102     * @p data.
25103     *
25104     * @ingroup Transit
25105     * @warning The transit free the context data at the and of the transition with
25106     * the data_free_cb function, do not use the context data in another transit.
25107     */
25108    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);
25109
25110    /**
25111     * Delete an added effect.
25112     *
25113     * This function will remove the effect from the @p transit, calling the
25114     * data_free_cb to free the @p data.
25115     *
25116     * @see elm_transit_effect_add()
25117     *
25118     * @note If the effect is not found, nothing is done.
25119     * @note If the effect list become empty, this function will call
25120     * elm_transit_del(transit), that is, it will kill the @p transit.
25121     *
25122     * @param transit The transit object.
25123     * @param transition_cb The operation function.
25124     * @param effect The context data of the effect.
25125     *
25126     * @ingroup Transit
25127     */
25128    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);
25129
25130    /**
25131     * Add new object to apply the effects.
25132     *
25133     * @note After the first addition of an object in @p transit, if its
25134     * object list become empty again, the @p transit will be killed by
25135     * elm_transit_del(transit) function.
25136     * @note If the @p obj belongs to another transit, the @p obj will be
25137     * removed from it and it will only belong to the @p transit. If the old
25138     * transit stays without objects, it will die.
25139     * @note When you add an object into the @p transit, its state from
25140     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25141     * transit ends, if you change this state whith evas_object_pass_events_set()
25142     * after add the object, this state will change again when @p transit stops to
25143     * run.
25144     *
25145     * @param transit The transit object.
25146     * @param obj Object to be animated.
25147     *
25148     * @ingroup Transit
25149     * @warning It is not allowed to add a new object after transit begins to go.
25150     */
25151    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25152
25153    /**
25154     * Removes an added object from the transit.
25155     *
25156     * @note If the @p obj is not in the @p transit, nothing is done.
25157     * @note If the list become empty, this function will call
25158     * elm_transit_del(transit), that is, it will kill the @p transit.
25159     *
25160     * @param transit The transit object.
25161     * @param obj Object to be removed from @p transit.
25162     *
25163     * @ingroup Transit
25164     * @warning It is not allowed to remove objects after transit begins to go.
25165     */
25166    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25167
25168    /**
25169     * Get the objects of the transit.
25170     *
25171     * @param transit The transit object.
25172     * @return a Eina_List with the objects from the transit.
25173     *
25174     * @ingroup Transit
25175     */
25176    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25177
25178    /**
25179     * Enable/disable keeping up the objects states.
25180     * If it is not kept, the objects states will be reset when transition ends.
25181     *
25182     * @note @p transit can not be NULL.
25183     * @note One state includes geometry, color, map data.
25184     *
25185     * @param transit The transit object.
25186     * @param state_keep Keeping or Non Keeping.
25187     *
25188     * @ingroup Transit
25189     */
25190    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25191
25192    /**
25193     * Get a value whether the objects states will be reset or not.
25194     *
25195     * @note @p transit can not be NULL
25196     *
25197     * @see elm_transit_objects_final_state_keep_set()
25198     *
25199     * @param transit The transit object.
25200     * @return EINA_TRUE means the states of the objects will be reset.
25201     * If @p transit is NULL, EINA_FALSE is returned
25202     *
25203     * @ingroup Transit
25204     */
25205    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25206
25207    /**
25208     * Set the event enabled when transit is operating.
25209     *
25210     * If @p enabled is EINA_TRUE, the objects of the transit will receives
25211     * events from mouse and keyboard during the animation.
25212     * @note When you add an object with elm_transit_object_add(), its state from
25213     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25214     * transit ends, if you change this state with evas_object_pass_events_set()
25215     * after adding the object, this state will change again when @p transit stops
25216     * to run.
25217     *
25218     * @param transit The transit object.
25219     * @param enabled Events are received when enabled is @c EINA_TRUE, and
25220     * ignored otherwise.
25221     *
25222     * @ingroup Transit
25223     */
25224    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25225
25226    /**
25227     * Get the value of event enabled status.
25228     *
25229     * @see elm_transit_event_enabled_set()
25230     *
25231     * @param transit The Transit object
25232     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25233     * EINA_FALSE is returned
25234     *
25235     * @ingroup Transit
25236     */
25237    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25238
25239    /**
25240     * Set the user-callback function when the transit is deleted.
25241     *
25242     * @note Using this function twice will overwrite the first function setted.
25243     * @note the @p transit object will be deleted after call @p cb function.
25244     *
25245     * @param transit The transit object.
25246     * @param cb Callback function pointer. This function will be called before
25247     * the deletion of the transit.
25248     * @param data Callback funtion user data. It is the @p op parameter.
25249     *
25250     * @ingroup Transit
25251     */
25252    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25253
25254    /**
25255     * Set reverse effect automatically.
25256     *
25257     * If auto reverse is setted, after running the effects with the progress
25258     * parameter from 0 to 1, it will call the effecs again with the progress
25259     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25260     * where the duration was setted with the function elm_transit_add and
25261     * the repeat with the function elm_transit_repeat_times_set().
25262     *
25263     * @param transit The transit object.
25264     * @param reverse EINA_TRUE means the auto_reverse is on.
25265     *
25266     * @ingroup Transit
25267     */
25268    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25269
25270    /**
25271     * Get if the auto reverse is on.
25272     *
25273     * @see elm_transit_auto_reverse_set()
25274     *
25275     * @param transit The transit object.
25276     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25277     * EINA_FALSE is returned
25278     *
25279     * @ingroup Transit
25280     */
25281    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25282
25283    /**
25284     * Set the transit repeat count. Effect will be repeated by repeat count.
25285     *
25286     * This function sets the number of repetition the transit will run after
25287     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25288     * If the @p repeat is a negative number, it will repeat infinite times.
25289     *
25290     * @note If this function is called during the transit execution, the transit
25291     * will run @p repeat times, ignoring the times it already performed.
25292     *
25293     * @param transit The transit object
25294     * @param repeat Repeat count
25295     *
25296     * @ingroup Transit
25297     */
25298    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25299
25300    /**
25301     * Get the transit repeat count.
25302     *
25303     * @see elm_transit_repeat_times_set()
25304     *
25305     * @param transit The Transit object.
25306     * @return The repeat count. If @p transit is NULL
25307     * 0 is returned
25308     *
25309     * @ingroup Transit
25310     */
25311    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25312
25313    /**
25314     * Set the transit animation acceleration type.
25315     *
25316     * This function sets the tween mode of the transit that can be:
25317     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25318     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25319     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25320     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25321     *
25322     * @param transit The transit object.
25323     * @param tween_mode The tween type.
25324     *
25325     * @ingroup Transit
25326     */
25327    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25328
25329    /**
25330     * Get the transit animation acceleration type.
25331     *
25332     * @note @p transit can not be NULL
25333     *
25334     * @param transit The transit object.
25335     * @return The tween type. If @p transit is NULL
25336     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25337     *
25338     * @ingroup Transit
25339     */
25340    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25341
25342    /**
25343     * Set the transit animation time
25344     *
25345     * @note @p transit can not be NULL
25346     *
25347     * @param transit The transit object.
25348     * @param duration The animation time.
25349     *
25350     * @ingroup Transit
25351     */
25352    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25353
25354    /**
25355     * Get the transit animation time
25356     *
25357     * @note @p transit can not be NULL
25358     *
25359     * @param transit The transit object.
25360     *
25361     * @return The transit animation time.
25362     *
25363     * @ingroup Transit
25364     */
25365    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25366
25367    /**
25368     * Starts the transition.
25369     * Once this API is called, the transit begins to measure the time.
25370     *
25371     * @note @p transit can not be NULL
25372     *
25373     * @param transit The transit object.
25374     *
25375     * @ingroup Transit
25376     */
25377    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25378
25379    /**
25380     * Pause/Resume the transition.
25381     *
25382     * If you call elm_transit_go again, the transit will be started from the
25383     * beginning, and will be unpaused.
25384     *
25385     * @note @p transit can not be NULL
25386     *
25387     * @param transit The transit object.
25388     * @param paused Whether the transition should be paused or not.
25389     *
25390     * @ingroup Transit
25391     */
25392    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25393
25394    /**
25395     * Get the value of paused status.
25396     *
25397     * @see elm_transit_paused_set()
25398     *
25399     * @note @p transit can not be NULL
25400     *
25401     * @param transit The transit object.
25402     * @return EINA_TRUE means transition is paused. If @p transit is NULL
25403     * EINA_FALSE is returned
25404     *
25405     * @ingroup Transit
25406     */
25407    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25408
25409    /**
25410     * Get the time progression of the animation (a double value between 0.0 and 1.0).
25411     *
25412     * The value returned is a fraction (current time / total time). It
25413     * represents the progression position relative to the total.
25414     *
25415     * @note @p transit can not be NULL
25416     *
25417     * @param transit The transit object.
25418     *
25419     * @return The time progression value. If @p transit is NULL
25420     * 0 is returned
25421     *
25422     * @ingroup Transit
25423     */
25424    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25425
25426    /**
25427     * Makes the chain relationship between two transits.
25428     *
25429     * @note @p transit can not be NULL. Transit would have multiple chain transits.
25430     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25431     *
25432     * @param transit The transit object.
25433     * @param chain_transit The chain transit object. This transit will be operated
25434     *        after transit is done.
25435     *
25436     * This function adds @p chain_transit transition to a chain after the @p
25437     * transit, and will be started as soon as @p transit ends. See @ref
25438     * transit_example_02_explained for a full example.
25439     *
25440     * @ingroup Transit
25441     */
25442    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25443
25444    /**
25445     * Cut off the chain relationship between two transits.
25446     *
25447     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25448     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25449     *
25450     * @param transit The transit object.
25451     * @param chain_transit The chain transit object.
25452     *
25453     * This function remove the @p chain_transit transition from the @p transit.
25454     *
25455     * @ingroup Transit
25456     */
25457    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25458
25459    /**
25460     * Get the current chain transit list.
25461     *
25462     * @note @p transit can not be NULL.
25463     *
25464     * @param transit The transit object.
25465     * @return chain transit list.
25466     *
25467     * @ingroup Transit
25468     */
25469    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
25470
25471    /**
25472     * Add the Resizing Effect to Elm_Transit.
25473     *
25474     * @note This API is one of the facades. It creates resizing effect context
25475     * and add it's required APIs to elm_transit_effect_add.
25476     *
25477     * @see elm_transit_effect_add()
25478     *
25479     * @param transit Transit object.
25480     * @param from_w Object width size when effect begins.
25481     * @param from_h Object height size when effect begins.
25482     * @param to_w Object width size when effect ends.
25483     * @param to_h Object height size when effect ends.
25484     * @return Resizing effect context data.
25485     *
25486     * @ingroup Transit
25487     */
25488    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);
25489
25490    /**
25491     * Add the Translation Effect to Elm_Transit.
25492     *
25493     * @note This API is one of the facades. It creates translation effect context
25494     * and add it's required APIs to elm_transit_effect_add.
25495     *
25496     * @see elm_transit_effect_add()
25497     *
25498     * @param transit Transit object.
25499     * @param from_dx X Position variation when effect begins.
25500     * @param from_dy Y Position variation when effect begins.
25501     * @param to_dx X Position variation when effect ends.
25502     * @param to_dy Y Position variation when effect ends.
25503     * @return Translation effect context data.
25504     *
25505     * @ingroup Transit
25506     * @warning It is highly recommended just create a transit with this effect when
25507     * the window that the objects of the transit belongs has already been created.
25508     * This is because this effect needs the geometry information about the objects,
25509     * and if the window was not created yet, it can get a wrong information.
25510     */
25511    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);
25512
25513    /**
25514     * Add the Zoom Effect to Elm_Transit.
25515     *
25516     * @note This API is one of the facades. It creates zoom effect context
25517     * and add it's required APIs to elm_transit_effect_add.
25518     *
25519     * @see elm_transit_effect_add()
25520     *
25521     * @param transit Transit object.
25522     * @param from_rate Scale rate when effect begins (1 is current rate).
25523     * @param to_rate Scale rate when effect ends.
25524     * @return Zoom effect context data.
25525     *
25526     * @ingroup Transit
25527     * @warning It is highly recommended just create a transit with this effect when
25528     * the window that the objects of the transit belongs has already been created.
25529     * This is because this effect needs the geometry information about the objects,
25530     * and if the window was not created yet, it can get a wrong information.
25531     */
25532    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25533
25534    /**
25535     * Add the Flip Effect to Elm_Transit.
25536     *
25537     * @note This API is one of the facades. It creates flip effect context
25538     * and add it's required APIs to elm_transit_effect_add.
25539     * @note This effect is applied to each pair of objects in the order they are listed
25540     * in the transit list of objects. The first object in the pair will be the
25541     * "front" object and the second will be the "back" object.
25542     *
25543     * @see elm_transit_effect_add()
25544     *
25545     * @param transit Transit object.
25546     * @param axis Flipping Axis(X or Y).
25547     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25548     * @return Flip effect context data.
25549     *
25550     * @ingroup Transit
25551     * @warning It is highly recommended just create a transit with this effect when
25552     * the window that the objects of the transit belongs has already been created.
25553     * This is because this effect needs the geometry information about the objects,
25554     * and if the window was not created yet, it can get a wrong information.
25555     */
25556    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25557
25558    /**
25559     * Add the Resizable Flip Effect to Elm_Transit.
25560     *
25561     * @note This API is one of the facades. It creates resizable flip effect context
25562     * and add it's required APIs to elm_transit_effect_add.
25563     * @note This effect is applied to each pair of objects in the order they are listed
25564     * in the transit list of objects. The first object in the pair will be the
25565     * "front" object and the second will be the "back" object.
25566     *
25567     * @see elm_transit_effect_add()
25568     *
25569     * @param transit Transit object.
25570     * @param axis Flipping Axis(X or Y).
25571     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25572     * @return Resizable flip effect context data.
25573     *
25574     * @ingroup Transit
25575     * @warning It is highly recommended just create a transit with this effect when
25576     * the window that the objects of the transit belongs has already been created.
25577     * This is because this effect needs the geometry information about the objects,
25578     * and if the window was not created yet, it can get a wrong information.
25579     */
25580    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25581
25582    /**
25583     * Add the Wipe Effect to Elm_Transit.
25584     *
25585     * @note This API is one of the facades. It creates wipe effect context
25586     * and add it's required APIs to elm_transit_effect_add.
25587     *
25588     * @see elm_transit_effect_add()
25589     *
25590     * @param transit Transit object.
25591     * @param type Wipe type. Hide or show.
25592     * @param dir Wipe Direction.
25593     * @return Wipe effect context data.
25594     *
25595     * @ingroup Transit
25596     * @warning It is highly recommended just create a transit with this effect when
25597     * the window that the objects of the transit belongs has already been created.
25598     * This is because this effect needs the geometry information about the objects,
25599     * and if the window was not created yet, it can get a wrong information.
25600     */
25601    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25602
25603    /**
25604     * Add the Color Effect to Elm_Transit.
25605     *
25606     * @note This API is one of the facades. It creates color effect context
25607     * and add it's required APIs to elm_transit_effect_add.
25608     *
25609     * @see elm_transit_effect_add()
25610     *
25611     * @param transit        Transit object.
25612     * @param  from_r        RGB R when effect begins.
25613     * @param  from_g        RGB G when effect begins.
25614     * @param  from_b        RGB B when effect begins.
25615     * @param  from_a        RGB A when effect begins.
25616     * @param  to_r          RGB R when effect ends.
25617     * @param  to_g          RGB G when effect ends.
25618     * @param  to_b          RGB B when effect ends.
25619     * @param  to_a          RGB A when effect ends.
25620     * @return               Color effect context data.
25621     *
25622     * @ingroup Transit
25623     */
25624    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);
25625
25626    /**
25627     * Add the Fade Effect to Elm_Transit.
25628     *
25629     * @note This API is one of the facades. It creates fade effect context
25630     * and add it's required APIs to elm_transit_effect_add.
25631     * @note This effect is applied to each pair of objects in the order they are listed
25632     * in the transit list of objects. The first object in the pair will be the
25633     * "before" object and the second will be the "after" object.
25634     *
25635     * @see elm_transit_effect_add()
25636     *
25637     * @param transit Transit object.
25638     * @return Fade effect context data.
25639     *
25640     * @ingroup Transit
25641     * @warning It is highly recommended just create a transit with this effect when
25642     * the window that the objects of the transit belongs has already been created.
25643     * This is because this effect needs the color information about the objects,
25644     * and if the window was not created yet, it can get a wrong information.
25645     */
25646    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25647
25648    /**
25649     * Add the Blend Effect to Elm_Transit.
25650     *
25651     * @note This API is one of the facades. It creates blend effect context
25652     * and add it's required APIs to elm_transit_effect_add.
25653     * @note This effect is applied to each pair of objects in the order they are listed
25654     * in the transit list of objects. The first object in the pair will be the
25655     * "before" object and the second will be the "after" object.
25656     *
25657     * @see elm_transit_effect_add()
25658     *
25659     * @param transit Transit object.
25660     * @return Blend effect context data.
25661     *
25662     * @ingroup Transit
25663     * @warning It is highly recommended just create a transit with this effect when
25664     * the window that the objects of the transit belongs has already been created.
25665     * This is because this effect needs the color information about the objects,
25666     * and if the window was not created yet, it can get a wrong information.
25667     */
25668    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25669
25670    /**
25671     * Add the Rotation Effect to Elm_Transit.
25672     *
25673     * @note This API is one of the facades. It creates rotation effect context
25674     * and add it's required APIs to elm_transit_effect_add.
25675     *
25676     * @see elm_transit_effect_add()
25677     *
25678     * @param transit Transit object.
25679     * @param from_degree Degree when effect begins.
25680     * @param to_degree Degree when effect is ends.
25681     * @return Rotation effect context data.
25682     *
25683     * @ingroup Transit
25684     * @warning It is highly recommended just create a transit with this effect when
25685     * the window that the objects of the transit belongs has already been created.
25686     * This is because this effect needs the geometry information about the objects,
25687     * and if the window was not created yet, it can get a wrong information.
25688     */
25689    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25690
25691    /**
25692     * Add the ImageAnimation Effect to Elm_Transit.
25693     *
25694     * @note This API is one of the facades. It creates image animation effect context
25695     * and add it's required APIs to elm_transit_effect_add.
25696     * The @p images parameter is a list images paths. This list and
25697     * its contents will be deleted at the end of the effect by
25698     * elm_transit_effect_image_animation_context_free() function.
25699     *
25700     * Example:
25701     * @code
25702     * char buf[PATH_MAX];
25703     * Eina_List *images = NULL;
25704     * Elm_Transit *transi = elm_transit_add();
25705     *
25706     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25707     * images = eina_list_append(images, eina_stringshare_add(buf));
25708     *
25709     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25710     * images = eina_list_append(images, eina_stringshare_add(buf));
25711     * elm_transit_effect_image_animation_add(transi, images);
25712     *
25713     * @endcode
25714     *
25715     * @see elm_transit_effect_add()
25716     *
25717     * @param transit Transit object.
25718     * @param images Eina_List of images file paths. This list and
25719     * its contents will be deleted at the end of the effect by
25720     * elm_transit_effect_image_animation_context_free() function.
25721     * @return Image Animation effect context data.
25722     *
25723     * @ingroup Transit
25724     */
25725    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25726    /**
25727     * @}
25728     */
25729
25730   typedef struct _Elm_Store                      Elm_Store;
25731   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
25732   typedef struct _Elm_Store_Item                 Elm_Store_Item;
25733   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
25734   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
25735   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25736   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
25737   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
25738   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
25739   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
25740   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
25741
25742   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25743   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25744   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25745   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25746
25747   typedef enum
25748     {
25749        ELM_STORE_ITEM_MAPPING_NONE = 0,
25750        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25751        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25752        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25753        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25754        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25755        // can add more here as needed by common apps
25756        ELM_STORE_ITEM_MAPPING_LAST
25757     } Elm_Store_Item_Mapping_Type;
25758
25759   struct _Elm_Store_Item_Mapping_Icon
25760     {
25761        // FIXME: allow edje file icons
25762        int                   w, h;
25763        Elm_Icon_Lookup_Order lookup_order;
25764        Eina_Bool             standard_name : 1;
25765        Eina_Bool             no_scale : 1;
25766        Eina_Bool             smooth : 1;
25767        Eina_Bool             scale_up : 1;
25768        Eina_Bool             scale_down : 1;
25769     };
25770
25771   struct _Elm_Store_Item_Mapping_Empty
25772     {
25773        Eina_Bool             dummy;
25774     };
25775
25776   struct _Elm_Store_Item_Mapping_Photo
25777     {
25778        int                   size;
25779     };
25780
25781   struct _Elm_Store_Item_Mapping_Custom
25782     {
25783        Elm_Store_Item_Mapping_Cb func;
25784     };
25785
25786   struct _Elm_Store_Item_Mapping
25787     {
25788        Elm_Store_Item_Mapping_Type     type;
25789        const char                     *part;
25790        int                             offset;
25791        union
25792          {
25793             Elm_Store_Item_Mapping_Empty  empty;
25794             Elm_Store_Item_Mapping_Icon   icon;
25795             Elm_Store_Item_Mapping_Photo  photo;
25796             Elm_Store_Item_Mapping_Custom custom;
25797             // add more types here
25798          } details;
25799     };
25800
25801   struct _Elm_Store_Item_Info
25802     {
25803       Elm_Genlist_Item_Class       *item_class;
25804       const Elm_Store_Item_Mapping *mapping;
25805       void                         *data;
25806       char                         *sort_id;
25807     };
25808
25809   struct _Elm_Store_Item_Info_Filesystem
25810     {
25811       Elm_Store_Item_Info  base;
25812       char                *path;
25813     };
25814
25815 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25816 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25817
25818   EAPI void                    elm_store_free(Elm_Store *st);
25819
25820   EAPI Elm_Store              *elm_store_filesystem_new(void);
25821   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25822   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25823   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25824
25825   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25826
25827   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25828   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25829   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25830   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25831   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25832   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25833
25834   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25835   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25836   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25837   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25838   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25839   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25840   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25841
25842    /**
25843     * @defgroup SegmentControl SegmentControl
25844     * @ingroup Elementary
25845     *
25846     * @image html img/widget/segment_control/preview-00.png
25847     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25848     *
25849     * @image html img/segment_control.png
25850     * @image latex img/segment_control.eps width=\textwidth
25851     *
25852     * Segment control widget is a horizontal control made of multiple segment
25853     * items, each segment item functioning similar to discrete two state button.
25854     * A segment control groups the items together and provides compact
25855     * single button with multiple equal size segments.
25856     *
25857     * Segment item size is determined by base widget
25858     * size and the number of items added.
25859     * Only one segment item can be at selected state. A segment item can display
25860     * combination of Text and any Evas_Object like Images or other widget.
25861     *
25862     * Smart callbacks one can listen to:
25863     * - "changed" - When the user clicks on a segment item which is not
25864     *   previously selected and get selected. The event_info parameter is the
25865     *   segment item index.
25866     *
25867     * Available styles for it:
25868     * - @c "default"
25869     *
25870     * Here is an example on its usage:
25871     * @li @ref segment_control_example
25872     */
25873
25874    /**
25875     * @addtogroup SegmentControl
25876     * @{
25877     */
25878
25879    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25880
25881    /**
25882     * Add a new segment control widget to the given parent Elementary
25883     * (container) object.
25884     *
25885     * @param parent The parent object.
25886     * @return a new segment control widget handle or @c NULL, on errors.
25887     *
25888     * This function inserts a new segment control widget on the canvas.
25889     *
25890     * @ingroup SegmentControl
25891     */
25892    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25893
25894    /**
25895     * Append a new item to the segment control object.
25896     *
25897     * @param obj The segment control object.
25898     * @param icon The icon object to use for the left side of the item. An
25899     * icon can be any Evas object, but usually it is an icon created
25900     * with elm_icon_add().
25901     * @param label The label of the item.
25902     *        Note that, NULL is different from empty string "".
25903     * @return The created item or @c NULL upon failure.
25904     *
25905     * A new item will be created and appended to the segment control, i.e., will
25906     * be set as @b last item.
25907     *
25908     * If it should be inserted at another position,
25909     * elm_segment_control_item_insert_at() should be used instead.
25910     *
25911     * Items created with this function can be deleted with function
25912     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25913     *
25914     * @note @p label set to @c NULL is different from empty string "".
25915     * If an item
25916     * only has icon, it will be displayed bigger and centered. If it has
25917     * icon and label, even that an empty string, icon will be smaller and
25918     * positioned at left.
25919     *
25920     * Simple example:
25921     * @code
25922     * sc = elm_segment_control_add(win);
25923     * ic = elm_icon_add(win);
25924     * elm_icon_file_set(ic, "path/to/image", NULL);
25925     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25926     * elm_segment_control_item_add(sc, ic, "label");
25927     * evas_object_show(sc);
25928     * @endcode
25929     *
25930     * @see elm_segment_control_item_insert_at()
25931     * @see elm_segment_control_item_del()
25932     *
25933     * @ingroup SegmentControl
25934     */
25935    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
25936
25937    /**
25938     * Insert a new item to the segment control object at specified position.
25939     *
25940     * @param obj The segment control object.
25941     * @param icon The icon object to use for the left side of the item. An
25942     * icon can be any Evas object, but usually it is an icon created
25943     * with elm_icon_add().
25944     * @param label The label of the item.
25945     * @param index Item position. Value should be between 0 and items count.
25946     * @return The created item or @c NULL upon failure.
25947
25948     * Index values must be between @c 0, when item will be prepended to
25949     * segment control, and items count, that can be get with
25950     * elm_segment_control_item_count_get(), case when item will be appended
25951     * to segment control, just like elm_segment_control_item_add().
25952     *
25953     * Items created with this function can be deleted with function
25954     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25955     *
25956     * @note @p label set to @c NULL is different from empty string "".
25957     * If an item
25958     * only has icon, it will be displayed bigger and centered. If it has
25959     * icon and label, even that an empty string, icon will be smaller and
25960     * positioned at left.
25961     *
25962     * @see elm_segment_control_item_add()
25963     * @see elm_segment_control_count_get()
25964     * @see elm_segment_control_item_del()
25965     *
25966     * @ingroup SegmentControl
25967     */
25968    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);
25969
25970    /**
25971     * Remove a segment control item from its parent, deleting it.
25972     *
25973     * @param it The item to be removed.
25974     *
25975     * Items can be added with elm_segment_control_item_add() or
25976     * elm_segment_control_item_insert_at().
25977     *
25978     * @ingroup SegmentControl
25979     */
25980    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25981
25982    /**
25983     * Remove a segment control item at given index from its parent,
25984     * deleting it.
25985     *
25986     * @param obj The segment control object.
25987     * @param index The position of the segment control item to be deleted.
25988     *
25989     * Items can be added with elm_segment_control_item_add() or
25990     * elm_segment_control_item_insert_at().
25991     *
25992     * @ingroup SegmentControl
25993     */
25994    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25995
25996    /**
25997     * Get the Segment items count from segment control.
25998     *
25999     * @param obj The segment control object.
26000     * @return Segment items count.
26001     *
26002     * It will just return the number of items added to segment control @p obj.
26003     *
26004     * @ingroup SegmentControl
26005     */
26006    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26007
26008    /**
26009     * Get the item placed at specified index.
26010     *
26011     * @param obj The segment control object.
26012     * @param index The index of the segment item.
26013     * @return The segment control item or @c NULL on failure.
26014     *
26015     * Index is the position of an item in segment control widget. Its
26016     * range is from @c 0 to <tt> count - 1 </tt>.
26017     * Count is the number of items, that can be get with
26018     * elm_segment_control_item_count_get().
26019     *
26020     * @ingroup SegmentControl
26021     */
26022    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26023
26024    /**
26025     * Get the label of item.
26026     *
26027     * @param obj The segment control object.
26028     * @param index The index of the segment item.
26029     * @return The label of the item at @p index.
26030     *
26031     * The return value is a pointer to the label associated to the item when
26032     * it was created, with function elm_segment_control_item_add(), or later
26033     * with function elm_segment_control_item_label_set. If no label
26034     * was passed as argument, it will return @c NULL.
26035     *
26036     * @see elm_segment_control_item_label_set() for more details.
26037     * @see elm_segment_control_item_add()
26038     *
26039     * @ingroup SegmentControl
26040     */
26041    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26042
26043    /**
26044     * Set the label of item.
26045     *
26046     * @param it The item of segment control.
26047     * @param text The label of item.
26048     *
26049     * The label to be displayed by the item.
26050     * Label will be at right of the icon (if set).
26051     *
26052     * If a label was passed as argument on item creation, with function
26053     * elm_control_segment_item_add(), it will be already
26054     * displayed by the item.
26055     *
26056     * @see elm_segment_control_item_label_get()
26057     * @see elm_segment_control_item_add()
26058     *
26059     * @ingroup SegmentControl
26060     */
26061    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26062
26063    /**
26064     * Get the icon associated to the item.
26065     *
26066     * @param obj The segment control object.
26067     * @param index The index of the segment item.
26068     * @return The left side icon associated to the item at @p index.
26069     *
26070     * The return value is a pointer to the icon associated to the item when
26071     * it was created, with function elm_segment_control_item_add(), or later
26072     * with function elm_segment_control_item_icon_set(). If no icon
26073     * was passed as argument, it will return @c NULL.
26074     *
26075     * @see elm_segment_control_item_add()
26076     * @see elm_segment_control_item_icon_set()
26077     *
26078     * @ingroup SegmentControl
26079     */
26080    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26081
26082    /**
26083     * Set the icon associated to the item.
26084     *
26085     * @param it The segment control item.
26086     * @param icon The icon object to associate with @p it.
26087     *
26088     * The icon object to use at left side of the item. An
26089     * icon can be any Evas object, but usually it is an icon created
26090     * with elm_icon_add().
26091     *
26092     * Once the icon object is set, a previously set one will be deleted.
26093     * @warning Setting the same icon for two items will cause the icon to
26094     * dissapear from the first item.
26095     *
26096     * If an icon was passed as argument on item creation, with function
26097     * elm_segment_control_item_add(), it will be already
26098     * associated to the item.
26099     *
26100     * @see elm_segment_control_item_add()
26101     * @see elm_segment_control_item_icon_get()
26102     *
26103     * @ingroup SegmentControl
26104     */
26105    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26106
26107    /**
26108     * Get the index of an item.
26109     *
26110     * @param it The segment control item.
26111     * @return The position of item in segment control widget.
26112     *
26113     * Index is the position of an item in segment control widget. Its
26114     * range is from @c 0 to <tt> count - 1 </tt>.
26115     * Count is the number of items, that can be get with
26116     * elm_segment_control_item_count_get().
26117     *
26118     * @ingroup SegmentControl
26119     */
26120    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26121
26122    /**
26123     * Get the base object of the item.
26124     *
26125     * @param it The segment control item.
26126     * @return The base object associated with @p it.
26127     *
26128     * Base object is the @c Evas_Object that represents that item.
26129     *
26130     * @ingroup SegmentControl
26131     */
26132    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26133
26134    /**
26135     * Get the selected item.
26136     *
26137     * @param obj The segment control object.
26138     * @return The selected item or @c NULL if none of segment items is
26139     * selected.
26140     *
26141     * The selected item can be unselected with function
26142     * elm_segment_control_item_selected_set().
26143     *
26144     * The selected item always will be highlighted on segment control.
26145     *
26146     * @ingroup SegmentControl
26147     */
26148    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26149
26150    /**
26151     * Set the selected state of an item.
26152     *
26153     * @param it The segment control item
26154     * @param select The selected state
26155     *
26156     * This sets the selected state of the given item @p it.
26157     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26158     *
26159     * If a new item is selected the previosly selected will be unselected.
26160     * Previoulsy selected item can be get with function
26161     * elm_segment_control_item_selected_get().
26162     *
26163     * The selected item always will be highlighted on segment control.
26164     *
26165     * @see elm_segment_control_item_selected_get()
26166     *
26167     * @ingroup SegmentControl
26168     */
26169    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26170
26171    /**
26172     * @}
26173     */
26174
26175    /**
26176     * @defgroup Grid Grid
26177     *
26178     * The grid is a grid layout widget that lays out a series of children as a
26179     * fixed "grid" of widgets using a given percentage of the grid width and
26180     * height each using the child object.
26181     *
26182     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26183     * widgets size itself. The default is 100 x 100, so that means the
26184     * position and sizes of children will effectively be percentages (0 to 100)
26185     * of the width or height of the grid widget
26186     *
26187     * @{
26188     */
26189
26190    /**
26191     * Add a new grid to the parent
26192     *
26193     * @param parent The parent object
26194     * @return The new object or NULL if it cannot be created
26195     *
26196     * @ingroup Grid
26197     */
26198    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26199
26200    /**
26201     * Set the virtual size of the grid
26202     *
26203     * @param obj The grid object
26204     * @param w The virtual width of the grid
26205     * @param h The virtual height of the grid
26206     *
26207     * @ingroup Grid
26208     */
26209    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
26210
26211    /**
26212     * Get the virtual size of the grid
26213     *
26214     * @param obj The grid object
26215     * @param w Pointer to integer to store the virtual width of the grid
26216     * @param h Pointer to integer to store the virtual height of the grid
26217     *
26218     * @ingroup Grid
26219     */
26220    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26221
26222    /**
26223     * Pack child at given position and size
26224     *
26225     * @param obj The grid object
26226     * @param subobj The child to pack
26227     * @param x The virtual x coord at which to pack it
26228     * @param y The virtual y coord at which to pack it
26229     * @param w The virtual width at which to pack it
26230     * @param h The virtual height at which to pack it
26231     *
26232     * @ingroup Grid
26233     */
26234    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26235
26236    /**
26237     * Unpack a child from a grid object
26238     *
26239     * @param obj The grid object
26240     * @param subobj The child to unpack
26241     *
26242     * @ingroup Grid
26243     */
26244    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26245
26246    /**
26247     * Faster way to remove all child objects from a grid object.
26248     *
26249     * @param obj The grid object
26250     * @param clear If true, it will delete just removed children
26251     *
26252     * @ingroup Grid
26253     */
26254    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26255
26256    /**
26257     * Set packing of an existing child at to position and size
26258     *
26259     * @param subobj The child to set packing of
26260     * @param x The virtual x coord at which to pack it
26261     * @param y The virtual y coord at which to pack it
26262     * @param w The virtual width at which to pack it
26263     * @param h The virtual height at which to pack it
26264     *
26265     * @ingroup Grid
26266     */
26267    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26268
26269    /**
26270     * get packing of a child
26271     *
26272     * @param subobj The child to query
26273     * @param x Pointer to integer to store the virtual x coord
26274     * @param y Pointer to integer to store the virtual y coord
26275     * @param w Pointer to integer to store the virtual width
26276     * @param h Pointer to integer to store the virtual height
26277     *
26278     * @ingroup Grid
26279     */
26280    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26281
26282    /**
26283     * @}
26284     */
26285
26286    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26287    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26288    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26289
26290    /**
26291     * @defgroup Video Video
26292     *
26293     * This object display an player that let you control an Elm_Video
26294     * object. It take care of updating it's content according to what is
26295     * going on inside the Emotion object. It does activate the remember
26296     * function on the linked Elm_Video object.
26297     *
26298     * Signals that you cann add callback for are :
26299     *
26300     * "forward,clicked" - the user clicked the forward button.
26301     * "info,clicked" - the user clicked the info button.
26302     * "next,clicked" - the user clicked the next button.
26303     * "pause,clicked" - the user clicked the pause button.
26304     * "play,clicked" - the user clicked the play button.
26305     * "prev,clicked" - the user clicked the prev button.
26306     * "rewind,clicked" - the user clicked the rewind button.
26307     * "stop,clicked" - the user clicked the stop button.
26308     */
26309    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26310    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26311    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26312    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26313    EAPI void elm_video_play(Evas_Object *video);
26314    EAPI void elm_video_pause(Evas_Object *video);
26315    EAPI void elm_video_stop(Evas_Object *video);
26316    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26317    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26318    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26319    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26320    EAPI double elm_video_audio_level_get(Evas_Object *video);
26321    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26322    EAPI double elm_video_play_position_get(Evas_Object *video);
26323    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26324    EAPI double elm_video_play_length_get(Evas_Object *video);
26325    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26326    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26327    EAPI const char *elm_video_title_get(Evas_Object *video);
26328
26329    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26330    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26331
26332   /* naviframe */
26333    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26334    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);
26335    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26336    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26337    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26338    EAPI void                elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26339    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26340    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26341    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26342    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26343    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26344    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26345    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26346    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26347    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26348
26349 #ifdef __cplusplus
26350 }
26351 #endif
26352
26353 #endif