elm list: Changed elm_list_item_base_get() to elm_list_item_object_get() like other...
[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 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
300
301 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
302 contact with the developers and maintainers.
303  */
304
305 #ifndef ELEMENTARY_H
306 #define ELEMENTARY_H
307
308 /**
309  * @file Elementary.h
310  * @brief Elementary's API
311  *
312  * Elementary API.
313  */
314
315 @ELM_UNIX_DEF@ ELM_UNIX
316 @ELM_WIN32_DEF@ ELM_WIN32
317 @ELM_WINCE_DEF@ ELM_WINCE
318 @ELM_EDBUS_DEF@ ELM_EDBUS
319 @ELM_EFREET_DEF@ ELM_EFREET
320 @ELM_ETHUMB_DEF@ ELM_ETHUMB
321 @ELM_EMAP_DEF@ ELM_EMAP
322 @ELM_DEBUG_DEF@ ELM_DEBUG
323 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
324 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
325
326 /* Standard headers for standard system calls etc. */
327 #include <stdio.h>
328 #include <stdlib.h>
329 #include <unistd.h>
330 #include <string.h>
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
335 #include <dlfcn.h>
336 #include <math.h>
337 #include <fnmatch.h>
338 #include <limits.h>
339 #include <ctype.h>
340 #include <time.h>
341 #include <dirent.h>
342 #include <pwd.h>
343 #include <errno.h>
344
345 #ifdef ELM_UNIX
346 # include <locale.h>
347 # ifdef ELM_LIBINTL_H
348 #  include <libintl.h>
349 # endif
350 # include <signal.h>
351 # include <grp.h>
352 # include <glob.h>
353 #endif
354
355 #ifdef ELM_ALLOCA_H
356 # include <alloca.h>
357 #endif
358
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
360 # include <malloc.h>
361 # ifndef alloca
362 #  define alloca _alloca
363 # endif
364 #endif
365
366
367 /* EFL headers */
368 #include <Eina.h>
369 #include <Eet.h>
370 #include <Evas.h>
371 #include <Evas_GL.h>
372 #include <Ecore.h>
373 #include <Ecore_Evas.h>
374 #include <Ecore_File.h>
375 #include <Ecore_IMF.h>
376 #include <Ecore_Con.h>
377 #include <Edje.h>
378
379 #ifdef ELM_EDBUS
380 # include <E_DBus.h>
381 #endif
382
383 #ifdef ELM_EFREET
384 # include <Efreet.h>
385 # include <Efreet_Mime.h>
386 # include <Efreet_Trash.h>
387 #endif
388
389 #ifdef ELM_ETHUMB
390 # include <Ethumb_Client.h>
391 #endif
392
393 #ifdef ELM_EMAP
394 # include <EMap.h>
395 #endif
396
397 #ifdef EAPI
398 # undef EAPI
399 #endif
400
401 #ifdef _WIN32
402 # ifdef ELEMENTARY_BUILD
403 #  ifdef DLL_EXPORT
404 #   define EAPI __declspec(dllexport)
405 #  else
406 #   define EAPI
407 #  endif /* ! DLL_EXPORT */
408 # else
409 #  define EAPI __declspec(dllimport)
410 # endif /* ! EFL_EVAS_BUILD */
411 #else
412 # ifdef __GNUC__
413 #  if __GNUC__ >= 4
414 #   define EAPI __attribute__ ((visibility("default")))
415 #  else
416 #   define EAPI
417 #  endif
418 # else
419 #  define EAPI
420 # endif
421 #endif /* ! _WIN32 */
422
423
424 /* allow usage from c++ */
425 #ifdef __cplusplus
426 extern "C" {
427 #endif
428
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
431
432    typedef struct _Elm_Version
433      {
434         int major;
435         int minor;
436         int micro;
437         int revision;
438      } Elm_Version;
439
440    EAPI extern Elm_Version *elm_version;
441
442 /* handy macros */
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
445
446    /**
447     * @defgroup General General
448     *
449     * @brief General Elementary API. Functions that don't relate to
450     * Elementary objects specifically.
451     *
452     * Here are documented functions which init/shutdown the library,
453     * that apply to generic Elementary objects, that deal with
454     * configuration, et cetera.
455     *
456     * @ref general_functions_example_page "This" example contemplates
457     * some of these functions.
458     */
459
460    /**
461     * @addtogroup General
462     * @{
463     */
464
465   /**
466    * Defines couple of standard Evas_Object layers to be used
467    * with evas_object_layer_set().
468    *
469    * @note whenever extending with new values, try to keep some padding
470    *       to siblings so there is room for further extensions.
471    */
472   typedef enum _Elm_Object_Layer
473     {
474        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
480     } Elm_Object_Layer;
481
482 /**************************************************************************/
483    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
484
485    /**
486     * Emitted when any Elementary's policy value is changed.
487     */
488    EAPI extern int ELM_EVENT_POLICY_CHANGED;
489
490    /**
491     * @typedef Elm_Event_Policy_Changed
492     *
493     * Data on the event when an Elementary policy has changed
494     */
495     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
496
497    /**
498     * @struct _Elm_Event_Policy_Changed
499     *
500     * Data on the event when an Elementary policy has changed
501     */
502     struct _Elm_Event_Policy_Changed
503      {
504         unsigned int policy; /**< the policy identifier */
505         int          new_value; /**< value the policy had before the change */
506         int          old_value; /**< new value the policy got */
507     };
508
509    /**
510     * Policy identifiers.
511     */
512     typedef enum _Elm_Policy
513     {
514         ELM_POLICY_QUIT, /**< under which circumstances the application
515                           * should quit automatically. @see
516                           * Elm_Policy_Quit.
517                           */
518         ELM_POLICY_LAST
519     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
520  */
521
522    typedef enum _Elm_Policy_Quit
523      {
524         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
525                                    * automatically */
526         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
527                                             * application's last
528                                             * window is closed */
529      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
530
531    typedef enum _Elm_Focus_Direction
532      {
533         ELM_FOCUS_PREVIOUS,
534         ELM_FOCUS_NEXT
535      } Elm_Focus_Direction;
536
537    typedef enum _Elm_Text_Format
538      {
539         ELM_TEXT_FORMAT_PLAIN_UTF8,
540         ELM_TEXT_FORMAT_MARKUP_UTF8
541      } Elm_Text_Format;
542
543    /**
544     * Line wrapping types.
545     */
546    typedef enum _Elm_Wrap_Type
547      {
548         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
549         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
550         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
551         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
552         ELM_WRAP_LAST
553      } Elm_Wrap_Type;
554
555    /**
556     * @typedef Elm_Object_Item
557     * An Elementary Object item handle.
558     * @ingroup General
559     */
560    typedef struct _Elm_Object_Item Elm_Object_Item;
561
562
563    /**
564     * Called back when a widget's tooltip is activated and needs content.
565     * @param data user-data given to elm_object_tooltip_content_cb_set()
566     * @param obj owner widget.
567     * @param tooltip The tooltip object (affix content to this!)
568     */
569    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
570
571    /**
572     * Called back when a widget's item tooltip is activated and needs content.
573     * @param data user-data given to elm_object_tooltip_content_cb_set()
574     * @param obj owner widget.
575     * @param tooltip The tooltip object (affix content to this!)
576     * @param item context dependent item. As an example, if tooltip was
577     *        set on Elm_List_Item, then it is of this type.
578     */
579    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
580
581    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. */
582
583 #ifndef ELM_LIB_QUICKLAUNCH
584 #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 */
585 #else
586 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
587 #endif
588
589 /**************************************************************************/
590    /* General calls */
591
592    /**
593     * Initialize Elementary
594     *
595     * @param[in] argc System's argument count value
596     * @param[in] argv System's pointer to array of argument strings
597     * @return The init counter value.
598     *
599     * This function initializes Elementary and increments a counter of
600     * the number of calls to it. It returns the new counter's value.
601     *
602     * @warning This call is exported only for use by the @c ELM_MAIN()
603     * macro. There is no need to use this if you use this macro (which
604     * is highly advisable). An elm_main() should contain the entry
605     * point code for your application, having the same prototype as
606     * elm_init(), and @b not being static (putting the @c EAPI symbol
607     * in front of its type declaration is advisable). The @c
608     * ELM_MAIN() call should be placed just after it.
609     *
610     * Example:
611     * @dontinclude bg_example_01.c
612     * @skip static void
613     * @until ELM_MAIN
614     *
615     * See the full @ref bg_example_01_c "example".
616     *
617     * @see elm_shutdown().
618     * @ingroup General
619     */
620    EAPI int          elm_init(int argc, char **argv);
621
622    /**
623     * Shut down Elementary
624     *
625     * @return The init counter value.
626     *
627     * This should be called at the end of your application, just
628     * before it ceases to do any more processing. This will clean up
629     * any permanent resources your application may have allocated via
630     * Elementary that would otherwise persist.
631     *
632     * @see elm_init() for an example
633     *
634     * @ingroup General
635     */
636    EAPI int          elm_shutdown(void);
637
638    /**
639     * Run Elementary's main loop
640     *
641     * This call should be issued just after all initialization is
642     * completed. This function will not return until elm_exit() is
643     * called. It will keep looping, running the main
644     * (event/processing) loop for Elementary.
645     *
646     * @see elm_init() for an example
647     *
648     * @ingroup General
649     */
650    EAPI void         elm_run(void);
651
652    /**
653     * Exit Elementary's main loop
654     *
655     * If this call is issued, it will flag the main loop to cease
656     * processing and return back to its parent function (usually your
657     * elm_main() function).
658     *
659     * @see elm_init() for an example. There, just after a request to
660     * close the window comes, the main loop will be left.
661     *
662     * @note By using the #ELM_POLICY_QUIT on your Elementary
663     * applications, you'll this function called automatically for you.
664     *
665     * @ingroup General
666     */
667    EAPI void         elm_exit(void);
668
669    /**
670     * Provide information in order to make Elementary determine the @b
671     * run time location of the software in question, so other data files
672     * such as images, sound files, executable utilities, libraries,
673     * modules and locale files can be found.
674     *
675     * @param mainfunc This is your application's main function name,
676     *        whose binary's location is to be found. Providing @c NULL
677     *        will make Elementary not to use it
678     * @param dom This will be used as the application's "domain", in the
679     *        form of a prefix to any environment variables that may
680     *        override prefix detection and the directory name, inside the
681     *        standard share or data directories, where the software's
682     *        data files will be looked for.
683     * @param checkfile This is an (optional) magic file's path to check
684     *        for existence (and it must be located in the data directory,
685     *        under the share directory provided above). Its presence will
686     *        help determine the prefix found was correct. Pass @c NULL if
687     *        the check is not to be done.
688     *
689     * This function allows one to re-locate the application somewhere
690     * else after compilation, if the developer wishes for easier
691     * distribution of pre-compiled binaries.
692     *
693     * The prefix system is designed to locate where the given software is
694     * installed (under a common path prefix) at run time and then report
695     * specific locations of this prefix and common directories inside
696     * this prefix like the binary, library, data and locale directories,
697     * through the @c elm_app_*_get() family of functions.
698     *
699     * Call elm_app_info_set() early on before you change working
700     * directory or anything about @c argv[0], so it gets accurate
701     * information.
702     *
703     * It will then try and trace back which file @p mainfunc comes from,
704     * if provided, to determine the application's prefix directory.
705     *
706     * The @p dom parameter provides a string prefix to prepend before
707     * environment variables, allowing a fallback to @b specific
708     * environment variables to locate the software. You would most
709     * probably provide a lowercase string there, because it will also
710     * serve as directory domain, explained next. For environment
711     * variables purposes, this string is made uppercase. For example if
712     * @c "myapp" is provided as the prefix, then the program would expect
713     * @c "MYAPP_PREFIX" as a master environment variable to specify the
714     * exact install prefix for the software, or more specific environment
715     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
716     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
717     * the user or scripts before launching. If not provided (@c NULL),
718     * environment variables will not be used to override compiled-in
719     * defaults or auto detections.
720     *
721     * The @p dom string also provides a subdirectory inside the system
722     * shared data directory for data files. For example, if the system
723     * directory is @c /usr/local/share, then this directory name is
724     * appended, creating @c /usr/local/share/myapp, if it @p was @c
725     * "myapp". It is expected the application installs data files in
726     * this directory.
727     *
728     * The @p checkfile is a file name or path of something inside the
729     * share or data directory to be used to test that the prefix
730     * detection worked. For example, your app will install a wallpaper
731     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
732     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
733     * checkfile string.
734     *
735     * @see elm_app_compile_bin_dir_set()
736     * @see elm_app_compile_lib_dir_set()
737     * @see elm_app_compile_data_dir_set()
738     * @see elm_app_compile_locale_set()
739     * @see elm_app_prefix_dir_get()
740     * @see elm_app_bin_dir_get()
741     * @see elm_app_lib_dir_get()
742     * @see elm_app_data_dir_get()
743     * @see elm_app_locale_dir_get()
744     */
745    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
746
747    /**
748     * Provide information on the @b fallback application's binaries
749     * directory, on scenarios where they get overriden by
750     * elm_app_info_set().
751     *
752     * @param dir The path to the default binaries directory (compile time
753     * one)
754     *
755     * @note Elementary will as well use this path to determine actual
756     * names of binaries' directory paths, maybe changing it to be @c
757     * something/local/bin instead of @c something/bin, only, for
758     * example.
759     *
760     * @warning You should call this function @b before
761     * elm_app_info_set().
762     */
763    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
764
765    /**
766     * Provide information on the @b fallback application's libraries
767     * directory, on scenarios where they get overriden by
768     * elm_app_info_set().
769     *
770     * @param dir The path to the default libraries directory (compile
771     * time one)
772     *
773     * @note Elementary will as well use this path to determine actual
774     * names of libraries' directory paths, maybe changing it to be @c
775     * something/lib32 or @c something/lib64 instead of @c something/lib,
776     * only, for example.
777     *
778     * @warning You should call this function @b before
779     * elm_app_info_set().
780     */
781    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
782
783    /**
784     * Provide information on the @b fallback application's data
785     * directory, on scenarios where they get overriden by
786     * elm_app_info_set().
787     *
788     * @param dir The path to the default data directory (compile time
789     * one)
790     *
791     * @note Elementary will as well use this path to determine actual
792     * names of data directory paths, maybe changing it to be @c
793     * something/local/share instead of @c something/share, only, for
794     * example.
795     *
796     * @warning You should call this function @b before
797     * elm_app_info_set().
798     */
799    EAPI void         elm_app_compile_data_dir_set(const char *dir);
800
801    /**
802     * Provide information on the @b fallback application's locale
803     * directory, on scenarios where they get overriden by
804     * elm_app_info_set().
805     *
806     * @param dir The path to the default locale directory (compile time
807     * one)
808     *
809     * @warning You should call this function @b before
810     * elm_app_info_set().
811     */
812    EAPI void         elm_app_compile_locale_set(const char *dir);
813
814    /**
815     * Retrieve the application's run time prefix directory, as set by
816     * elm_app_info_set() and the way (environment) the application was
817     * run from.
818     *
819     * @return The directory prefix the application is actually using
820     */
821    EAPI const char  *elm_app_prefix_dir_get(void);
822
823    /**
824     * Retrieve the application's run time binaries prefix directory, as
825     * set by elm_app_info_set() and the way (environment) the application
826     * was run from.
827     *
828     * @return The binaries directory prefix the application is actually
829     * using
830     */
831    EAPI const char  *elm_app_bin_dir_get(void);
832
833    /**
834     * Retrieve the application's run time libraries prefix directory, as
835     * set by elm_app_info_set() and the way (environment) the application
836     * was run from.
837     *
838     * @return The libraries directory prefix the application is actually
839     * using
840     */
841    EAPI const char  *elm_app_lib_dir_get(void);
842
843    /**
844     * Retrieve the application's run time data prefix directory, as
845     * set by elm_app_info_set() and the way (environment) the application
846     * was run from.
847     *
848     * @return The data directory prefix the application is actually
849     * using
850     */
851    EAPI const char  *elm_app_data_dir_get(void);
852
853    /**
854     * Retrieve the application's run time locale prefix directory, as
855     * set by elm_app_info_set() and the way (environment) the application
856     * was run from.
857     *
858     * @return The locale directory prefix the application is actually
859     * using
860     */
861    EAPI const char  *elm_app_locale_dir_get(void);
862
863    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
864    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
865    EAPI int          elm_quicklaunch_init(int argc, char **argv);
866    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
867    EAPI int          elm_quicklaunch_sub_shutdown(void);
868    EAPI int          elm_quicklaunch_shutdown(void);
869    EAPI void         elm_quicklaunch_seed(void);
870    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
871    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
872    EAPI void         elm_quicklaunch_cleanup(void);
873    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
874    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
875
876    EAPI Eina_Bool    elm_need_efreet(void);
877    EAPI Eina_Bool    elm_need_e_dbus(void);
878
879    /**
880     * This must be called before any other function that handle with
881     * elm_thumb objects or ethumb_client instances.
882     *
883     * @ingroup Thumb
884     */
885    EAPI Eina_Bool    elm_need_ethumb(void);
886
887    /**
888     * Set a new policy's value (for a given policy group/identifier).
889     *
890     * @param policy policy identifier, as in @ref Elm_Policy.
891     * @param value policy value, which depends on the identifier
892     *
893     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
894     *
895     * Elementary policies define applications' behavior,
896     * somehow. These behaviors are divided in policy groups (see
897     * #Elm_Policy enumeration). This call will emit the Ecore event
898     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
899     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
900     * then.
901     *
902     * @note Currently, we have only one policy identifier/group
903     * (#ELM_POLICY_QUIT), which has two possible values.
904     *
905     * @ingroup General
906     */
907    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
908
909    /**
910     * Gets the policy value set for given policy identifier.
911     *
912     * @param policy policy identifier, as in #Elm_Policy.
913     * @return The currently set policy value, for that
914     * identifier. Will be @c 0 if @p policy passed is invalid.
915     *
916     * @ingroup General
917     */
918    EAPI int          elm_policy_get(unsigned int policy);
919
920    /**
921     * Set a label of an object
922     *
923     * @param obj The Elementary object
924     * @param part The text part name to set (NULL for the default label)
925     * @param label The new text of the label
926     *
927     * @note Elementary objects may have many labels (e.g. Action Slider)
928     *
929     * @ingroup General
930     */
931    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
932
933 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
934
935    /**
936     * Get a label of an object
937     *
938     * @param obj The Elementary object
939     * @param part The text part name to get (NULL for the default label)
940     * @return text of the label or NULL for any error
941     *
942     * @note Elementary objects may have many labels (e.g. Action Slider)
943     *
944     * @ingroup General
945     */
946    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
947
948 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
949
950    /**
951     * Set a content of an object
952     *
953     * @param obj The Elementary object
954     * @param part The content part name to set (NULL for the default content)
955     * @param content The new content of the object
956     *
957     * @note Elementary objects may have many contents
958     *
959     * @ingroup General
960     */
961    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
962
963 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
964
965    /**
966     * Get a content of an object
967     *
968     * @param obj The Elementary object
969     * @param item The content part name to get (NULL for the default content)
970     * @return content of the object or NULL for any error
971     *
972     * @note Elementary objects may have many contents
973     *
974     * @ingroup General
975     */
976    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
977
978 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
979
980    /**
981     * Unset a content of an object
982     *
983     * @param obj The Elementary object
984     * @param item The content part name to unset (NULL for the default content)
985     *
986     * @note Elementary objects may have many contents
987     *
988     * @ingroup General
989     */
990    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
991
992 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
993
994    /**
995     * Set a content of an object item
996     *
997     * @param it The Elementary object item
998     * @param part The content part name to unset (NULL for the default content)
999     * @param content The new content of the object item
1000     *
1001     * @note Elementary object items may have many contents
1002     *
1003     * @ingroup General
1004     */
1005    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1006
1007 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1008
1009    /**
1010     * Get a content of an object item
1011     *
1012     * @param it The Elementary object item
1013     * @param part The content part name to unset (NULL for the default content)
1014     * @return content of the object item or NULL for any error
1015     *
1016     * @note Elementary object items may have many contents
1017     *
1018     * @ingroup General
1019     */
1020    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1021
1022 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1023
1024    /**
1025     * Unset a content of an object item
1026     *
1027     * @param it The Elementary object item
1028     * @param part The content part name to unset (NULL for the default content)
1029     *
1030     * @note Elementary object items may have many contents
1031     *
1032     * @ingroup General
1033     */
1034    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1035
1036 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1037
1038    /**
1039     * Set a label of an objec itemt
1040     *
1041     * @param it The Elementary object item
1042     * @param part The text part name to set (NULL for the default label)
1043     * @param label The new text of the label
1044     *
1045     * @note Elementary object items may have many labels
1046     *
1047     * @ingroup General
1048     */
1049    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1050
1051 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1052
1053    /**
1054     * Get a label of an object
1055     *
1056     * @param it The Elementary object item
1057     * @param part The text part name to get (NULL for the default label)
1058     * @return text of the label or NULL for any error
1059     *
1060     * @note Elementary object items may have many labels
1061     *
1062     * @ingroup General
1063     */
1064    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1065
1066    /**
1067     * Set the text to read out when in accessibility mode
1068     *
1069     * @param obj The object which is described
1070     * @param txt The text that describes the widget to people with poor or no vision
1071     *
1072     * @ingroup General
1073     */
1074    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1075
1076 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1077
1078    /**
1079     * @}
1080     */
1081
1082    /**
1083     * @defgroup Caches Caches
1084     *
1085     * These are functions which let one fine-tune some cache values for
1086     * Elementary applications, thus allowing for performance adjustments.
1087     *
1088     * @{
1089     */
1090
1091    /**
1092     * @brief Flush all caches.
1093     *
1094     * Frees all data that was in cache and is not currently being used to reduce
1095     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1096     * to calling all of the following functions:
1097     * @li edje_file_cache_flush()
1098     * @li edje_collection_cache_flush()
1099     * @li eet_clearcache()
1100     * @li evas_image_cache_flush()
1101     * @li evas_font_cache_flush()
1102     * @li evas_render_dump()
1103     * @note Evas caches are flushed for every canvas associated with a window.
1104     *
1105     * @ingroup Caches
1106     */
1107    EAPI void         elm_all_flush(void);
1108
1109    /**
1110     * Get the configured cache flush interval time
1111     *
1112     * This gets the globally configured cache flush interval time, in
1113     * ticks
1114     *
1115     * @return The cache flush interval time
1116     * @ingroup Caches
1117     *
1118     * @see elm_all_flush()
1119     */
1120    EAPI int          elm_cache_flush_interval_get(void);
1121
1122    /**
1123     * Set the configured cache flush interval time
1124     *
1125     * This sets the globally configured cache flush interval time, in ticks
1126     *
1127     * @param size The cache flush interval time
1128     * @ingroup Caches
1129     *
1130     * @see elm_all_flush()
1131     */
1132    EAPI void         elm_cache_flush_interval_set(int size);
1133
1134    /**
1135     * Set the configured cache flush interval time for all applications on the
1136     * display
1137     *
1138     * This sets the globally configured cache flush interval time -- in ticks
1139     * -- for all applications on the display.
1140     *
1141     * @param size The cache flush interval time
1142     * @ingroup Caches
1143     */
1144    EAPI void         elm_cache_flush_interval_all_set(int size);
1145
1146    /**
1147     * Get the configured cache flush enabled state
1148     *
1149     * This gets the globally configured cache flush state - if it is enabled
1150     * or not. When cache flushing is enabled, elementary will regularly
1151     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1152     * memory and allow usage to re-seed caches and data in memory where it
1153     * can do so. An idle application will thus minimise its memory usage as
1154     * data will be freed from memory and not be re-loaded as it is idle and
1155     * not rendering or doing anything graphically right now.
1156     *
1157     * @return The cache flush state
1158     * @ingroup Caches
1159     *
1160     * @see elm_all_flush()
1161     */
1162    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1163
1164    /**
1165     * Set the configured cache flush enabled state
1166     *
1167     * This sets the globally configured cache flush enabled state
1168     *
1169     * @param size The cache flush enabled state
1170     * @ingroup Caches
1171     *
1172     * @see elm_all_flush()
1173     */
1174    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1175
1176    /**
1177     * Set the configured cache flush enabled state for all applications on the
1178     * display
1179     *
1180     * This sets the globally configured cache flush enabled state for all
1181     * applications on the display.
1182     *
1183     * @param size The cache flush enabled state
1184     * @ingroup Caches
1185     */
1186    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1187
1188    /**
1189     * Get the configured font cache size
1190     *
1191     * This gets the globally configured font cache size, in bytes
1192     *
1193     * @return The font cache size
1194     * @ingroup Caches
1195     */
1196    EAPI int          elm_font_cache_get(void);
1197
1198    /**
1199     * Set the configured font cache size
1200     *
1201     * This sets the globally configured font cache size, in bytes
1202     *
1203     * @param size The font cache size
1204     * @ingroup Caches
1205     */
1206    EAPI void         elm_font_cache_set(int size);
1207
1208    /**
1209     * Set the configured font cache size for all applications on the
1210     * display
1211     *
1212     * This sets the globally configured font cache size -- in bytes
1213     * -- for all applications on the display.
1214     *
1215     * @param size The font cache size
1216     * @ingroup Caches
1217     */
1218    EAPI void         elm_font_cache_all_set(int size);
1219
1220    /**
1221     * Get the configured image cache size
1222     *
1223     * This gets the globally configured image cache size, in bytes
1224     *
1225     * @return The image cache size
1226     * @ingroup Caches
1227     */
1228    EAPI int          elm_image_cache_get(void);
1229
1230    /**
1231     * Set the configured image cache size
1232     *
1233     * This sets the globally configured image cache size, in bytes
1234     *
1235     * @param size The image cache size
1236     * @ingroup Caches
1237     */
1238    EAPI void         elm_image_cache_set(int size);
1239
1240    /**
1241     * Set the configured image cache size for all applications on the
1242     * display
1243     *
1244     * This sets the globally configured image cache size -- in bytes
1245     * -- for all applications on the display.
1246     *
1247     * @param size The image cache size
1248     * @ingroup Caches
1249     */
1250    EAPI void         elm_image_cache_all_set(int size);
1251
1252    /**
1253     * Get the configured edje file cache size.
1254     *
1255     * This gets the globally configured edje file cache size, in number
1256     * of files.
1257     *
1258     * @return The edje file cache size
1259     * @ingroup Caches
1260     */
1261    EAPI int          elm_edje_file_cache_get(void);
1262
1263    /**
1264     * Set the configured edje file cache size
1265     *
1266     * This sets the globally configured edje file cache size, in number
1267     * of files.
1268     *
1269     * @param size The edje file cache size
1270     * @ingroup Caches
1271     */
1272    EAPI void         elm_edje_file_cache_set(int size);
1273
1274    /**
1275     * Set the configured edje file cache size for all applications on the
1276     * display
1277     *
1278     * This sets the globally configured edje file cache size -- in number
1279     * of files -- for all applications on the display.
1280     *
1281     * @param size The edje file cache size
1282     * @ingroup Caches
1283     */
1284    EAPI void         elm_edje_file_cache_all_set(int size);
1285
1286    /**
1287     * Get the configured edje collections (groups) cache size.
1288     *
1289     * This gets the globally configured edje collections cache size, in
1290     * number of collections.
1291     *
1292     * @return The edje collections cache size
1293     * @ingroup Caches
1294     */
1295    EAPI int          elm_edje_collection_cache_get(void);
1296
1297    /**
1298     * Set the configured edje collections (groups) cache size
1299     *
1300     * This sets the globally configured edje collections cache size, in
1301     * number of collections.
1302     *
1303     * @param size The edje collections cache size
1304     * @ingroup Caches
1305     */
1306    EAPI void         elm_edje_collection_cache_set(int size);
1307
1308    /**
1309     * Set the configured edje collections (groups) cache size for all
1310     * applications on the display
1311     *
1312     * This sets the globally configured edje collections cache size -- in
1313     * number of collections -- for all applications on the display.
1314     *
1315     * @param size The edje collections cache size
1316     * @ingroup Caches
1317     */
1318    EAPI void         elm_edje_collection_cache_all_set(int size);
1319
1320    /**
1321     * @}
1322     */
1323
1324    /**
1325     * @defgroup Scaling Widget Scaling
1326     *
1327     * Different widgets can be scaled independently. These functions
1328     * allow you to manipulate this scaling on a per-widget basis. The
1329     * object and all its children get their scaling factors multiplied
1330     * by the scale factor set. This is multiplicative, in that if a
1331     * child also has a scale size set it is in turn multiplied by its
1332     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1333     * double size, @c 0.5 is half, etc.
1334     *
1335     * @ref general_functions_example_page "This" example contemplates
1336     * some of these functions.
1337     */
1338
1339    /**
1340     * Get the global scaling factor
1341     *
1342     * This gets the globally configured scaling factor that is applied to all
1343     * objects.
1344     *
1345     * @return The scaling factor
1346     * @ingroup Scaling
1347     */
1348    EAPI double       elm_scale_get(void);
1349
1350    /**
1351     * Set the global scaling factor
1352     *
1353     * This sets the globally configured scaling factor that is applied to all
1354     * objects.
1355     *
1356     * @param scale The scaling factor to set
1357     * @ingroup Scaling
1358     */
1359    EAPI void         elm_scale_set(double scale);
1360
1361    /**
1362     * Set the global scaling factor for all applications on the display
1363     *
1364     * This sets the globally configured scaling factor that is applied to all
1365     * objects for all applications.
1366     * @param scale The scaling factor to set
1367     * @ingroup Scaling
1368     */
1369    EAPI void         elm_scale_all_set(double scale);
1370
1371    /**
1372     * Set the scaling factor for a given Elementary object
1373     *
1374     * @param obj The Elementary to operate on
1375     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1376     * no scaling)
1377     *
1378     * @ingroup Scaling
1379     */
1380    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1381
1382    /**
1383     * Get the scaling factor for a given Elementary object
1384     *
1385     * @param obj The object
1386     * @return The scaling factor set by elm_object_scale_set()
1387     *
1388     * @ingroup Scaling
1389     */
1390    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1391
1392    /**
1393     * @defgroup UI-Mirroring Selective Widget mirroring
1394     *
1395     * These functions allow you to set ui-mirroring on specific
1396     * widgets or the whole interface. Widgets can be in one of two
1397     * modes, automatic and manual.  Automatic means they'll be changed
1398     * according to the system mirroring mode and manual means only
1399     * explicit changes will matter. You are not supposed to change
1400     * mirroring state of a widget set to automatic, will mostly work,
1401     * but the behavior is not really defined.
1402     *
1403     * @{
1404     */
1405
1406    EAPI Eina_Bool    elm_mirrored_get(void);
1407    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1408
1409    /**
1410     * Get the system mirrored mode. This determines the default mirrored mode
1411     * of widgets.
1412     *
1413     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1414     */
1415    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1416
1417    /**
1418     * Set the system mirrored mode. This determines the default mirrored mode
1419     * of widgets.
1420     *
1421     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1422     */
1423    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1424
1425    /**
1426     * Returns the widget's mirrored mode setting.
1427     *
1428     * @param obj The widget.
1429     * @return mirrored mode setting of the object.
1430     *
1431     **/
1432    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1433
1434    /**
1435     * Sets the widget's mirrored mode setting.
1436     * When widget in automatic mode, it follows the system mirrored mode set by
1437     * elm_mirrored_set().
1438     * @param obj The widget.
1439     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1440     */
1441    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1442
1443    /**
1444     * @}
1445     */
1446
1447    /**
1448     * Set the style to use by a widget
1449     *
1450     * Sets the style name that will define the appearance of a widget. Styles
1451     * vary from widget to widget and may also be defined by other themes
1452     * by means of extensions and overlays.
1453     *
1454     * @param obj The Elementary widget to style
1455     * @param style The style name to use
1456     *
1457     * @see elm_theme_extension_add()
1458     * @see elm_theme_extension_del()
1459     * @see elm_theme_overlay_add()
1460     * @see elm_theme_overlay_del()
1461     *
1462     * @ingroup Styles
1463     */
1464    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1465    /**
1466     * Get the style used by the widget
1467     *
1468     * This gets the style being used for that widget. Note that the string
1469     * pointer is only valid as longas the object is valid and the style doesn't
1470     * change.
1471     *
1472     * @param obj The Elementary widget to query for its style
1473     * @return The style name used
1474     *
1475     * @see elm_object_style_set()
1476     *
1477     * @ingroup Styles
1478     */
1479    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1480
1481    /**
1482     * @defgroup Styles Styles
1483     *
1484     * Widgets can have different styles of look. These generic API's
1485     * set styles of widgets, if they support them (and if the theme(s)
1486     * do).
1487     *
1488     * @ref general_functions_example_page "This" example contemplates
1489     * some of these functions.
1490     */
1491
1492    /**
1493     * Set the disabled state of an Elementary object.
1494     *
1495     * @param obj The Elementary object to operate on
1496     * @param disabled The state to put in in: @c EINA_TRUE for
1497     *        disabled, @c EINA_FALSE for enabled
1498     *
1499     * Elementary objects can be @b disabled, in which state they won't
1500     * receive input and, in general, will be themed differently from
1501     * their normal state, usually greyed out. Useful for contexts
1502     * where you don't want your users to interact with some of the
1503     * parts of you interface.
1504     *
1505     * This sets the state for the widget, either disabling it or
1506     * enabling it back.
1507     *
1508     * @ingroup Styles
1509     */
1510    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1511
1512    /**
1513     * Get the disabled state of an Elementary object.
1514     *
1515     * @param obj The Elementary object to operate on
1516     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1517     *            if it's enabled (or on errors)
1518     *
1519     * This gets the state of the widget, which might be enabled or disabled.
1520     *
1521     * @ingroup Styles
1522     */
1523    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1524
1525    /**
1526     * @defgroup WidgetNavigation Widget Tree Navigation.
1527     *
1528     * How to check if an Evas Object is an Elementary widget? How to
1529     * get the first elementary widget that is parent of the given
1530     * object?  These are all covered in widget tree navigation.
1531     *
1532     * @ref general_functions_example_page "This" example contemplates
1533     * some of these functions.
1534     */
1535
1536    /**
1537     * Check if the given Evas Object is an Elementary widget.
1538     *
1539     * @param obj the object to query.
1540     * @return @c EINA_TRUE if it is an elementary widget variant,
1541     *         @c EINA_FALSE otherwise
1542     * @ingroup WidgetNavigation
1543     */
1544    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1545
1546    /**
1547     * Get the first parent of the given object that is an Elementary
1548     * widget.
1549     *
1550     * @param obj the Elementary object to query parent from.
1551     * @return the parent object that is an Elementary widget, or @c
1552     *         NULL, if it was not found.
1553     *
1554     * Use this to query for an object's parent widget.
1555     *
1556     * @note Most of Elementary users wouldn't be mixing non-Elementary
1557     * smart objects in the objects tree of an application, as this is
1558     * an advanced usage of Elementary with Evas. So, except for the
1559     * application's window, which is the root of that tree, all other
1560     * objects would have valid Elementary widget parents.
1561     *
1562     * @ingroup WidgetNavigation
1563     */
1564    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1565
1566    /**
1567     * Get the top level parent of an Elementary widget.
1568     *
1569     * @param obj The object to query.
1570     * @return The top level Elementary widget, or @c NULL if parent cannot be
1571     * found.
1572     * @ingroup WidgetNavigation
1573     */
1574    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1575
1576    /**
1577     * Get the string that represents this Elementary widget.
1578     *
1579     * @note Elementary is weird and exposes itself as a single
1580     *       Evas_Object_Smart_Class of type "elm_widget", so
1581     *       evas_object_type_get() always return that, making debug and
1582     *       language bindings hard. This function tries to mitigate this
1583     *       problem, but the solution is to change Elementary to use
1584     *       proper inheritance.
1585     *
1586     * @param obj the object to query.
1587     * @return Elementary widget name, or @c NULL if not a valid widget.
1588     * @ingroup WidgetNavigation
1589     */
1590    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1591
1592    /**
1593     * @defgroup Config Elementary Config
1594     *
1595     * Elementary configuration is formed by a set options bounded to a
1596     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1597     * "finger size", etc. These are functions with which one syncronizes
1598     * changes made to those values to the configuration storing files, de
1599     * facto. You most probably don't want to use the functions in this
1600     * group unlees you're writing an elementary configuration manager.
1601     *
1602     * @{
1603     */
1604
1605    /**
1606     * Save back Elementary's configuration, so that it will persist on
1607     * future sessions.
1608     *
1609     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1610     * @ingroup Config
1611     *
1612     * This function will take effect -- thus, do I/O -- immediately. Use
1613     * it when you want to apply all configuration changes at once. The
1614     * current configuration set will get saved onto the current profile
1615     * configuration file.
1616     *
1617     */
1618    EAPI Eina_Bool    elm_config_save(void);
1619
1620    /**
1621     * Reload Elementary's configuration, bounded to current selected
1622     * profile.
1623     *
1624     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1625     * @ingroup Config
1626     *
1627     * Useful when you want to force reloading of configuration values for
1628     * a profile. If one removes user custom configuration directories,
1629     * for example, it will force a reload with system values insted.
1630     *
1631     */
1632    EAPI void         elm_config_reload(void);
1633
1634    /**
1635     * @}
1636     */
1637
1638    /**
1639     * @defgroup Profile Elementary Profile
1640     *
1641     * Profiles are pre-set options that affect the whole look-and-feel of
1642     * Elementary-based applications. There are, for example, profiles
1643     * aimed at desktop computer applications and others aimed at mobile,
1644     * touchscreen-based ones. You most probably don't want to use the
1645     * functions in this group unlees you're writing an elementary
1646     * configuration manager.
1647     *
1648     * @{
1649     */
1650
1651    /**
1652     * Get Elementary's profile in use.
1653     *
1654     * This gets the global profile that is applied to all Elementary
1655     * applications.
1656     *
1657     * @return The profile's name
1658     * @ingroup Profile
1659     */
1660    EAPI const char  *elm_profile_current_get(void);
1661
1662    /**
1663     * Get an Elementary's profile directory path in the filesystem. One
1664     * may want to fetch a system profile's dir or an user one (fetched
1665     * inside $HOME).
1666     *
1667     * @param profile The profile's name
1668     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1669     *                or a system one (@c EINA_FALSE)
1670     * @return The profile's directory path.
1671     * @ingroup Profile
1672     *
1673     * @note You must free it with elm_profile_dir_free().
1674     */
1675    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1676
1677    /**
1678     * Free an Elementary's profile directory path, as returned by
1679     * elm_profile_dir_get().
1680     *
1681     * @param p_dir The profile's path
1682     * @ingroup Profile
1683     *
1684     */
1685    EAPI void         elm_profile_dir_free(const char *p_dir);
1686
1687    /**
1688     * Get Elementary's list of available profiles.
1689     *
1690     * @return The profiles list. List node data are the profile name
1691     *         strings.
1692     * @ingroup Profile
1693     *
1694     * @note One must free this list, after usage, with the function
1695     *       elm_profile_list_free().
1696     */
1697    EAPI Eina_List   *elm_profile_list_get(void);
1698
1699    /**
1700     * Free Elementary's list of available profiles.
1701     *
1702     * @param l The profiles list, as returned by elm_profile_list_get().
1703     * @ingroup Profile
1704     *
1705     */
1706    EAPI void         elm_profile_list_free(Eina_List *l);
1707
1708    /**
1709     * Set Elementary's profile.
1710     *
1711     * This sets the global profile that is applied to Elementary
1712     * applications. Just the process the call comes from will be
1713     * affected.
1714     *
1715     * @param profile The profile's name
1716     * @ingroup Profile
1717     *
1718     */
1719    EAPI void         elm_profile_set(const char *profile);
1720
1721    /**
1722     * Set Elementary's profile.
1723     *
1724     * This sets the global profile that is applied to all Elementary
1725     * applications. All running Elementary windows will be affected.
1726     *
1727     * @param profile The profile's name
1728     * @ingroup Profile
1729     *
1730     */
1731    EAPI void         elm_profile_all_set(const char *profile);
1732
1733    /**
1734     * @}
1735     */
1736
1737    /**
1738     * @defgroup Engine Elementary Engine
1739     *
1740     * These are functions setting and querying which rendering engine
1741     * Elementary will use for drawing its windows' pixels.
1742     *
1743     * The following are the available engines:
1744     * @li "software_x11"
1745     * @li "fb"
1746     * @li "directfb"
1747     * @li "software_16_x11"
1748     * @li "software_8_x11"
1749     * @li "xrender_x11"
1750     * @li "opengl_x11"
1751     * @li "software_gdi"
1752     * @li "software_16_wince_gdi"
1753     * @li "sdl"
1754     * @li "software_16_sdl"
1755     * @li "opengl_sdl"
1756     * @li "buffer"
1757     *
1758     * @{
1759     */
1760
1761    /**
1762     * @brief Get Elementary's rendering engine in use.
1763     *
1764     * @return The rendering engine's name
1765     * @note there's no need to free the returned string, here.
1766     *
1767     * This gets the global rendering engine that is applied to all Elementary
1768     * applications.
1769     *
1770     * @see elm_engine_set()
1771     */
1772    EAPI const char  *elm_engine_current_get(void);
1773
1774    /**
1775     * @brief Set Elementary's rendering engine for use.
1776     *
1777     * @param engine The rendering engine's name
1778     *
1779     * This sets global rendering engine that is applied to all Elementary
1780     * applications. Note that it will take effect only to Elementary windows
1781     * created after this is called.
1782     *
1783     * @see elm_win_add()
1784     */
1785    EAPI void         elm_engine_set(const char *engine);
1786
1787    /**
1788     * @}
1789     */
1790
1791    /**
1792     * @defgroup Fonts Elementary Fonts
1793     *
1794     * These are functions dealing with font rendering, selection and the
1795     * like for Elementary applications. One might fetch which system
1796     * fonts are there to use and set custom fonts for individual classes
1797     * of UI items containing text (text classes).
1798     *
1799     * @{
1800     */
1801
1802   typedef struct _Elm_Text_Class
1803     {
1804        const char *name;
1805        const char *desc;
1806     } Elm_Text_Class;
1807
1808   typedef struct _Elm_Font_Overlay
1809     {
1810        const char     *text_class;
1811        const char     *font;
1812        Evas_Font_Size  size;
1813     } Elm_Font_Overlay;
1814
1815   typedef struct _Elm_Font_Properties
1816     {
1817        const char *name;
1818        Eina_List  *styles;
1819     } Elm_Font_Properties;
1820
1821    /**
1822     * Get Elementary's list of supported text classes.
1823     *
1824     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1825     * @ingroup Fonts
1826     *
1827     * Release the list with elm_text_classes_list_free().
1828     */
1829    EAPI const Eina_List     *elm_text_classes_list_get(void);
1830
1831    /**
1832     * Free Elementary's list of supported text classes.
1833     *
1834     * @ingroup Fonts
1835     *
1836     * @see elm_text_classes_list_get().
1837     */
1838    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1839
1840    /**
1841     * Get Elementary's list of font overlays, set with
1842     * elm_font_overlay_set().
1843     *
1844     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1845     * data.
1846     *
1847     * @ingroup Fonts
1848     *
1849     * For each text class, one can set a <b>font overlay</b> for it,
1850     * overriding the default font properties for that class coming from
1851     * the theme in use. There is no need to free this list.
1852     *
1853     * @see elm_font_overlay_set() and elm_font_overlay_unset().
1854     */
1855    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1856
1857    /**
1858     * Set a font overlay for a given Elementary text class.
1859     *
1860     * @param text_class Text class name
1861     * @param font Font name and style string
1862     * @param size Font size
1863     *
1864     * @ingroup Fonts
1865     *
1866     * @p font has to be in the format returned by
1867     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1868     * and elm_font_overlay_unset().
1869     */
1870    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1871
1872    /**
1873     * Unset a font overlay for a given Elementary text class.
1874     *
1875     * @param text_class Text class name
1876     *
1877     * @ingroup Fonts
1878     *
1879     * This will bring back text elements belonging to text class
1880     * @p text_class back to their default font settings.
1881     */
1882    EAPI void                 elm_font_overlay_unset(const char *text_class);
1883
1884    /**
1885     * Apply the changes made with elm_font_overlay_set() and
1886     * elm_font_overlay_unset() on the current Elementary window.
1887     *
1888     * @ingroup Fonts
1889     *
1890     * This applies all font overlays set to all objects in the UI.
1891     */
1892    EAPI void                 elm_font_overlay_apply(void);
1893
1894    /**
1895     * Apply the changes made with elm_font_overlay_set() and
1896     * elm_font_overlay_unset() on all Elementary application windows.
1897     *
1898     * @ingroup Fonts
1899     *
1900     * This applies all font overlays set to all objects in the UI.
1901     */
1902    EAPI void                 elm_font_overlay_all_apply(void);
1903
1904    /**
1905     * Translate a font (family) name string in fontconfig's font names
1906     * syntax into an @c Elm_Font_Properties struct.
1907     *
1908     * @param font The font name and styles string
1909     * @return the font properties struct
1910     *
1911     * @ingroup Fonts
1912     *
1913     * @note The reverse translation can be achived with
1914     * elm_font_fontconfig_name_get(), for one style only (single font
1915     * instance, not family).
1916     */
1917    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1918
1919    /**
1920     * Free font properties return by elm_font_properties_get().
1921     *
1922     * @param efp the font properties struct
1923     *
1924     * @ingroup Fonts
1925     */
1926    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1927
1928    /**
1929     * Translate a font name, bound to a style, into fontconfig's font names
1930     * syntax.
1931     *
1932     * @param name The font (family) name
1933     * @param style The given style (may be @c NULL)
1934     *
1935     * @return the font name and style string
1936     *
1937     * @ingroup Fonts
1938     *
1939     * @note The reverse translation can be achived with
1940     * elm_font_properties_get(), for one style only (single font
1941     * instance, not family).
1942     */
1943    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1944
1945    /**
1946     * Free the font string return by elm_font_fontconfig_name_get().
1947     *
1948     * @param efp the font properties struct
1949     *
1950     * @ingroup Fonts
1951     */
1952    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1953
1954    /**
1955     * Create a font hash table of available system fonts.
1956     *
1957     * One must call it with @p list being the return value of
1958     * evas_font_available_list(). The hash will be indexed by font
1959     * (family) names, being its values @c Elm_Font_Properties blobs.
1960     *
1961     * @param list The list of available system fonts, as returned by
1962     * evas_font_available_list().
1963     * @return the font hash.
1964     *
1965     * @ingroup Fonts
1966     *
1967     * @note The user is supposed to get it populated at least with 3
1968     * default font families (Sans, Serif, Monospace), which should be
1969     * present on most systems.
1970     */
1971    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
1972
1973    /**
1974     * Free the hash return by elm_font_available_hash_add().
1975     *
1976     * @param hash the hash to be freed.
1977     *
1978     * @ingroup Fonts
1979     */
1980    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
1981
1982    /**
1983     * @}
1984     */
1985
1986    /**
1987     * @defgroup Fingers Fingers
1988     *
1989     * Elementary is designed to be finger-friendly for touchscreens,
1990     * and so in addition to scaling for display resolution, it can
1991     * also scale based on finger "resolution" (or size). You can then
1992     * customize the granularity of the areas meant to receive clicks
1993     * on touchscreens.
1994     *
1995     * Different profiles may have pre-set values for finger sizes.
1996     *
1997     * @ref general_functions_example_page "This" example contemplates
1998     * some of these functions.
1999     *
2000     * @{
2001     */
2002
2003    /**
2004     * Get the configured "finger size"
2005     *
2006     * @return The finger size
2007     *
2008     * This gets the globally configured finger size, <b>in pixels</b>
2009     *
2010     * @ingroup Fingers
2011     */
2012    EAPI Evas_Coord       elm_finger_size_get(void);
2013
2014    /**
2015     * Set the configured finger size
2016     *
2017     * This sets the globally configured finger size in pixels
2018     *
2019     * @param size The finger size
2020     * @ingroup Fingers
2021     */
2022    EAPI void             elm_finger_size_set(Evas_Coord size);
2023
2024    /**
2025     * Set the configured finger size for all applications on the display
2026     *
2027     * This sets the globally configured finger size in pixels for all
2028     * applications on the display
2029     *
2030     * @param size The finger size
2031     * @ingroup Fingers
2032     */
2033    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2034
2035    /**
2036     * @}
2037     */
2038
2039    /**
2040     * @defgroup Focus Focus
2041     *
2042     * An Elementary application has, at all times, one (and only one)
2043     * @b focused object. This is what determines where the input
2044     * events go to within the application's window. Also, focused
2045     * objects can be decorated differently, in order to signal to the
2046     * user where the input is, at a given moment.
2047     *
2048     * Elementary applications also have the concept of <b>focus
2049     * chain</b>: one can cycle through all the windows' focusable
2050     * objects by input (tab key) or programmatically. The default
2051     * focus chain for an application is the one define by the order in
2052     * which the widgets where added in code. One will cycle through
2053     * top level widgets, and, for each one containg sub-objects, cycle
2054     * through them all, before returning to the level
2055     * above. Elementary also allows one to set @b custom focus chains
2056     * for their applications.
2057     *
2058     * Besides the focused decoration a widget may exhibit, when it
2059     * gets focus, Elementary has a @b global focus highlight object
2060     * that can be enabled for a window. If one chooses to do so, this
2061     * extra highlight effect will surround the current focused object,
2062     * too.
2063     *
2064     * @note Some Elementary widgets are @b unfocusable, after
2065     * creation, by their very nature: they are not meant to be
2066     * interacted with input events, but are there just for visual
2067     * purposes.
2068     *
2069     * @ref general_functions_example_page "This" example contemplates
2070     * some of these functions.
2071     */
2072
2073    /**
2074     * Get the enable status of the focus highlight
2075     *
2076     * This gets whether the highlight on focused objects is enabled or not
2077     * @ingroup Focus
2078     */
2079    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2080
2081    /**
2082     * Set the enable status of the focus highlight
2083     *
2084     * Set whether to show or not the highlight on focused objects
2085     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2086     * @ingroup Focus
2087     */
2088    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2089
2090    /**
2091     * Get the enable status of the highlight animation
2092     *
2093     * Get whether the focus highlight, if enabled, will animate its switch from
2094     * one object to the next
2095     * @ingroup Focus
2096     */
2097    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2098
2099    /**
2100     * Set the enable status of the highlight animation
2101     *
2102     * Set whether the focus highlight, if enabled, will animate its switch from
2103     * one object to the next
2104     * @param animate Enable animation if EINA_TRUE, disable otherwise
2105     * @ingroup Focus
2106     */
2107    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2108
2109    /**
2110     * Get the whether an Elementary object has the focus or not.
2111     *
2112     * @param obj The Elementary object to get the information from
2113     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2114     *            not (and on errors).
2115     *
2116     * @see elm_object_focus_set()
2117     *
2118     * @ingroup Focus
2119     */
2120    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2121
2122    /**
2123     * Set/unset focus to a given Elementary object.
2124     *
2125     * @param obj The Elementary object to operate on.
2126     * @param enable @c EINA_TRUE Set focus to a given object,
2127     *               @c EINA_FALSE Unset focus to a given object.
2128     *
2129     * @note When you set focus to this object, if it can handle focus, will
2130     * take the focus away from the one who had it previously and will, for
2131     * now on, be the one receiving input events. Unsetting focus will remove
2132     * the focus from @p obj, passing it back to the previous element in the
2133     * focus chain list.
2134     *
2135     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2136     *
2137     * @ingroup Focus
2138     */
2139    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2140
2141    /**
2142     * Make a given Elementary object the focused one.
2143     *
2144     * @param obj The Elementary object to make focused.
2145     *
2146     * @note This object, if it can handle focus, will take the focus
2147     * away from the one who had it previously and will, for now on, be
2148     * the one receiving input events.
2149     *
2150     * @see elm_object_focus_get()
2151     * @deprecated use elm_object_focus_set() instead.
2152     *
2153     * @ingroup Focus
2154     */
2155    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2156
2157    /**
2158     * Remove the focus from an Elementary object
2159     *
2160     * @param obj The Elementary to take focus from
2161     *
2162     * This removes the focus from @p obj, passing it back to the
2163     * previous element in the focus chain list.
2164     *
2165     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2166     * @deprecated use elm_object_focus_set() instead.
2167     *
2168     * @ingroup Focus
2169     */
2170    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2171
2172    /**
2173     * Set the ability for an Element object to be focused
2174     *
2175     * @param obj The Elementary object to operate on
2176     * @param enable @c EINA_TRUE if the object can be focused, @c
2177     *        EINA_FALSE if not (and on errors)
2178     *
2179     * This sets whether the object @p obj is able to take focus or
2180     * not. Unfocusable objects do nothing when programmatically
2181     * focused, being the nearest focusable parent object the one
2182     * really getting focus. Also, when they receive mouse input, they
2183     * will get the event, but not take away the focus from where it
2184     * was previously.
2185     *
2186     * @ingroup Focus
2187     */
2188    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2189
2190    /**
2191     * Get whether an Elementary object is focusable or not
2192     *
2193     * @param obj The Elementary object to operate on
2194     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2195     *             EINA_FALSE if not (and on errors)
2196     *
2197     * @note Objects which are meant to be interacted with by input
2198     * events are created able to be focused, by default. All the
2199     * others are not.
2200     *
2201     * @ingroup Focus
2202     */
2203    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2204
2205    /**
2206     * Set custom focus chain.
2207     *
2208     * This function overwrites any previous custom focus chain within
2209     * the list of objects. The previous list will be deleted and this list
2210     * will be managed by elementary. After it is set, don't modify it.
2211     *
2212     * @note On focus cycle, only will be evaluated children of this container.
2213     *
2214     * @param obj The container object
2215     * @param objs Chain of objects to pass focus
2216     * @ingroup Focus
2217     */
2218    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2219
2220    /**
2221     * Unset a custom focus chain on a given Elementary widget
2222     *
2223     * @param obj The container object to remove focus chain from
2224     *
2225     * Any focus chain previously set on @p obj (for its child objects)
2226     * is removed entirely after this call.
2227     *
2228     * @ingroup Focus
2229     */
2230    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2231
2232    /**
2233     * Get custom focus chain
2234     *
2235     * @param obj The container object
2236     * @ingroup Focus
2237     */
2238    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2239
2240    /**
2241     * Append object to custom focus chain.
2242     *
2243     * @note If relative_child equal to NULL or not in custom chain, the object
2244     * will be added in end.
2245     *
2246     * @note On focus cycle, only will be evaluated children of this container.
2247     *
2248     * @param obj The container object
2249     * @param child The child to be added in custom chain
2250     * @param relative_child The relative object to position the child
2251     * @ingroup Focus
2252     */
2253    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2254
2255    /**
2256     * Prepend object to custom focus chain.
2257     *
2258     * @note If relative_child equal to NULL or not in custom chain, the object
2259     * will be added in begin.
2260     *
2261     * @note On focus cycle, only will be evaluated children of this container.
2262     *
2263     * @param obj The container object
2264     * @param child The child to be added in custom chain
2265     * @param relative_child The relative object to position the child
2266     * @ingroup Focus
2267     */
2268    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2269
2270    /**
2271     * Give focus to next object in object tree.
2272     *
2273     * Give focus to next object in focus chain of one object sub-tree.
2274     * If the last object of chain already have focus, the focus will go to the
2275     * first object of chain.
2276     *
2277     * @param obj The object root of sub-tree
2278     * @param dir Direction to cycle the focus
2279     *
2280     * @ingroup Focus
2281     */
2282    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2283
2284    /**
2285     * Give focus to near object in one direction.
2286     *
2287     * Give focus to near object in direction of one object.
2288     * If none focusable object in given direction, the focus will not change.
2289     *
2290     * @param obj The reference object
2291     * @param x Horizontal component of direction to focus
2292     * @param y Vertical component of direction to focus
2293     *
2294     * @ingroup Focus
2295     */
2296    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2297
2298    /**
2299     * Make the elementary object and its children to be unfocusable
2300     * (or focusable).
2301     *
2302     * @param obj The Elementary object to operate on
2303     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2304     *        @c EINA_FALSE for focusable.
2305     *
2306     * This sets whether the object @p obj and its children objects
2307     * are able to take focus or not. If the tree is set as unfocusable,
2308     * newest focused object which is not in this tree will get focus.
2309     * This API can be helpful for an object to be deleted.
2310     * When an object will be deleted soon, it and its children may not
2311     * want to get focus (by focus reverting or by other focus controls).
2312     * Then, just use this API before deleting.
2313     *
2314     * @see elm_object_tree_unfocusable_get()
2315     *
2316     * @ingroup Focus
2317     */
2318    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2319
2320    /**
2321     * Get whether an Elementary object and its children are unfocusable or not.
2322     *
2323     * @param obj The Elementary object to get the information from
2324     * @return @c EINA_TRUE, if the tree is unfocussable,
2325     *         @c EINA_FALSE if not (and on errors).
2326     *
2327     * @see elm_object_tree_unfocusable_set()
2328     *
2329     * @ingroup Focus
2330     */
2331    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2332
2333    /**
2334     * @defgroup Scrolling Scrolling
2335     *
2336     * These are functions setting how scrollable views in Elementary
2337     * widgets should behave on user interaction.
2338     *
2339     * @{
2340     */
2341
2342    /**
2343     * Get whether scrollers should bounce when they reach their
2344     * viewport's edge during a scroll.
2345     *
2346     * @return the thumb scroll bouncing state
2347     *
2348     * This is the default behavior for touch screens, in general.
2349     * @ingroup Scrolling
2350     */
2351    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2352
2353    /**
2354     * Set whether scrollers should bounce when they reach their
2355     * viewport's edge during a scroll.
2356     *
2357     * @param enabled the thumb scroll bouncing state
2358     *
2359     * @see elm_thumbscroll_bounce_enabled_get()
2360     * @ingroup Scrolling
2361     */
2362    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2363
2364    /**
2365     * Set whether scrollers should bounce when they reach their
2366     * viewport's edge during a scroll, for all Elementary application
2367     * windows.
2368     *
2369     * @param enabled the thumb scroll bouncing state
2370     *
2371     * @see elm_thumbscroll_bounce_enabled_get()
2372     * @ingroup Scrolling
2373     */
2374    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2375
2376    /**
2377     * Get the amount of inertia a scroller will impose at bounce
2378     * animations.
2379     *
2380     * @return the thumb scroll bounce friction
2381     *
2382     * @ingroup Scrolling
2383     */
2384    EAPI double           elm_scroll_bounce_friction_get(void);
2385
2386    /**
2387     * Set the amount of inertia a scroller will impose at bounce
2388     * animations.
2389     *
2390     * @param friction the thumb scroll bounce friction
2391     *
2392     * @see elm_thumbscroll_bounce_friction_get()
2393     * @ingroup Scrolling
2394     */
2395    EAPI void             elm_scroll_bounce_friction_set(double friction);
2396
2397    /**
2398     * Set the amount of inertia a scroller will impose at bounce
2399     * animations, for all Elementary application windows.
2400     *
2401     * @param friction the thumb scroll bounce friction
2402     *
2403     * @see elm_thumbscroll_bounce_friction_get()
2404     * @ingroup Scrolling
2405     */
2406    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2407
2408    /**
2409     * Get the amount of inertia a <b>paged</b> scroller will impose at
2410     * page fitting animations.
2411     *
2412     * @return the page scroll friction
2413     *
2414     * @ingroup Scrolling
2415     */
2416    EAPI double           elm_scroll_page_scroll_friction_get(void);
2417
2418    /**
2419     * Set the amount of inertia a <b>paged</b> scroller will impose at
2420     * page fitting animations.
2421     *
2422     * @param friction the page scroll friction
2423     *
2424     * @see elm_thumbscroll_page_scroll_friction_get()
2425     * @ingroup Scrolling
2426     */
2427    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2428
2429    /**
2430     * Set the amount of inertia a <b>paged</b> scroller will impose at
2431     * page fitting animations, for all Elementary application windows.
2432     *
2433     * @param friction the page scroll friction
2434     *
2435     * @see elm_thumbscroll_page_scroll_friction_get()
2436     * @ingroup Scrolling
2437     */
2438    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2439
2440    /**
2441     * Get the amount of inertia a scroller will impose at region bring
2442     * animations.
2443     *
2444     * @return the bring in scroll friction
2445     *
2446     * @ingroup Scrolling
2447     */
2448    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2449
2450    /**
2451     * Set the amount of inertia a scroller will impose at region bring
2452     * animations.
2453     *
2454     * @param friction the bring in scroll friction
2455     *
2456     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2457     * @ingroup Scrolling
2458     */
2459    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2460
2461    /**
2462     * Set the amount of inertia a scroller will impose at region bring
2463     * animations, for all Elementary application windows.
2464     *
2465     * @param friction the bring in scroll friction
2466     *
2467     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2468     * @ingroup Scrolling
2469     */
2470    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2471
2472    /**
2473     * Get the amount of inertia scrollers will impose at animations
2474     * triggered by Elementary widgets' zooming API.
2475     *
2476     * @return the zoom friction
2477     *
2478     * @ingroup Scrolling
2479     */
2480    EAPI double           elm_scroll_zoom_friction_get(void);
2481
2482    /**
2483     * Set the amount of inertia scrollers will impose at animations
2484     * triggered by Elementary widgets' zooming API.
2485     *
2486     * @param friction the zoom friction
2487     *
2488     * @see elm_thumbscroll_zoom_friction_get()
2489     * @ingroup Scrolling
2490     */
2491    EAPI void             elm_scroll_zoom_friction_set(double friction);
2492
2493    /**
2494     * Set the amount of inertia scrollers will impose at animations
2495     * triggered by Elementary widgets' zooming API, for all Elementary
2496     * application windows.
2497     *
2498     * @param friction the zoom friction
2499     *
2500     * @see elm_thumbscroll_zoom_friction_get()
2501     * @ingroup Scrolling
2502     */
2503    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2504
2505    /**
2506     * Get whether scrollers should be draggable from any point in their
2507     * views.
2508     *
2509     * @return the thumb scroll state
2510     *
2511     * @note This is the default behavior for touch screens, in general.
2512     * @note All other functions namespaced with "thumbscroll" will only
2513     *       have effect if this mode is enabled.
2514     *
2515     * @ingroup Scrolling
2516     */
2517    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2518
2519    /**
2520     * Set whether scrollers should be draggable from any point in their
2521     * views.
2522     *
2523     * @param enabled the thumb scroll state
2524     *
2525     * @see elm_thumbscroll_enabled_get()
2526     * @ingroup Scrolling
2527     */
2528    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2529
2530    /**
2531     * Set whether scrollers should be draggable from any point in their
2532     * views, for all Elementary application windows.
2533     *
2534     * @param enabled the thumb scroll state
2535     *
2536     * @see elm_thumbscroll_enabled_get()
2537     * @ingroup Scrolling
2538     */
2539    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2540
2541    /**
2542     * Get the number of pixels one should travel while dragging a
2543     * scroller's view to actually trigger scrolling.
2544     *
2545     * @return the thumb scroll threshould
2546     *
2547     * One would use higher values for touch screens, in general, because
2548     * of their inherent imprecision.
2549     * @ingroup Scrolling
2550     */
2551    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2552
2553    /**
2554     * Set the number of pixels one should travel while dragging a
2555     * scroller's view to actually trigger scrolling.
2556     *
2557     * @param threshold the thumb scroll threshould
2558     *
2559     * @see elm_thumbscroll_threshould_get()
2560     * @ingroup Scrolling
2561     */
2562    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2563
2564    /**
2565     * Set the number of pixels one should travel while dragging a
2566     * scroller's view to actually trigger scrolling, for all Elementary
2567     * application windows.
2568     *
2569     * @param threshold the thumb scroll threshould
2570     *
2571     * @see elm_thumbscroll_threshould_get()
2572     * @ingroup Scrolling
2573     */
2574    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2575
2576    /**
2577     * Get the minimum speed of mouse cursor movement which will trigger
2578     * list self scrolling animation after a mouse up event
2579     * (pixels/second).
2580     *
2581     * @return the thumb scroll momentum threshould
2582     *
2583     * @ingroup Scrolling
2584     */
2585    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2586
2587    /**
2588     * Set the minimum speed of mouse cursor movement which will trigger
2589     * list self scrolling animation after a mouse up event
2590     * (pixels/second).
2591     *
2592     * @param threshold the thumb scroll momentum threshould
2593     *
2594     * @see elm_thumbscroll_momentum_threshould_get()
2595     * @ingroup Scrolling
2596     */
2597    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2598
2599    /**
2600     * Set the minimum speed of mouse cursor movement which will trigger
2601     * list self scrolling animation after a mouse up event
2602     * (pixels/second), for all Elementary application windows.
2603     *
2604     * @param threshold the thumb scroll momentum threshould
2605     *
2606     * @see elm_thumbscroll_momentum_threshould_get()
2607     * @ingroup Scrolling
2608     */
2609    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2610
2611    /**
2612     * Get the amount of inertia a scroller will impose at self scrolling
2613     * animations.
2614     *
2615     * @return the thumb scroll friction
2616     *
2617     * @ingroup Scrolling
2618     */
2619    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2620
2621    /**
2622     * Set the amount of inertia a scroller will impose at self scrolling
2623     * animations.
2624     *
2625     * @param friction the thumb scroll friction
2626     *
2627     * @see elm_thumbscroll_friction_get()
2628     * @ingroup Scrolling
2629     */
2630    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2631
2632    /**
2633     * Set the amount of inertia a scroller will impose at self scrolling
2634     * animations, for all Elementary application windows.
2635     *
2636     * @param friction the thumb scroll friction
2637     *
2638     * @see elm_thumbscroll_friction_get()
2639     * @ingroup Scrolling
2640     */
2641    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2642
2643    /**
2644     * Get the amount of lag between your actual mouse cursor dragging
2645     * movement and a scroller's view movement itself, while pushing it
2646     * into bounce state manually.
2647     *
2648     * @return the thumb scroll border friction
2649     *
2650     * @ingroup Scrolling
2651     */
2652    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2653
2654    /**
2655     * Set the amount of lag between your actual mouse cursor dragging
2656     * movement and a scroller's view movement itself, while pushing it
2657     * into bounce state manually.
2658     *
2659     * @param friction the thumb scroll border friction. @c 0.0 for
2660     *        perfect synchrony between two movements, @c 1.0 for maximum
2661     *        lag.
2662     *
2663     * @see elm_thumbscroll_border_friction_get()
2664     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2665     *
2666     * @ingroup Scrolling
2667     */
2668    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2669
2670    /**
2671     * Set the amount of lag between your actual mouse cursor dragging
2672     * movement and a scroller's view movement itself, while pushing it
2673     * into bounce state manually, for all Elementary application windows.
2674     *
2675     * @param friction the thumb scroll border friction. @c 0.0 for
2676     *        perfect synchrony between two movements, @c 1.0 for maximum
2677     *        lag.
2678     *
2679     * @see elm_thumbscroll_border_friction_get()
2680     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2681     *
2682     * @ingroup Scrolling
2683     */
2684    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2685
2686    /**
2687     * @}
2688     */
2689
2690    /**
2691     * @defgroup Scrollhints Scrollhints
2692     *
2693     * Objects when inside a scroller can scroll, but this may not always be
2694     * desirable in certain situations. This allows an object to hint to itself
2695     * and parents to "not scroll" in one of 2 ways. If any child object of a
2696     * scroller has pushed a scroll freeze or hold then it affects all parent
2697     * scrollers until all children have released them.
2698     *
2699     * 1. To hold on scrolling. This means just flicking and dragging may no
2700     * longer scroll, but pressing/dragging near an edge of the scroller will
2701     * still scroll. This is automatically used by the entry object when
2702     * selecting text.
2703     *
2704     * 2. To totally freeze scrolling. This means it stops. until
2705     * popped/released.
2706     *
2707     * @{
2708     */
2709
2710    /**
2711     * Push the scroll hold by 1
2712     *
2713     * This increments the scroll hold count by one. If it is more than 0 it will
2714     * take effect on the parents of the indicated object.
2715     *
2716     * @param obj The object
2717     * @ingroup Scrollhints
2718     */
2719    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2720
2721    /**
2722     * Pop the scroll hold by 1
2723     *
2724     * This decrements the scroll hold count by one. If it is more than 0 it will
2725     * take effect on the parents of the indicated object.
2726     *
2727     * @param obj The object
2728     * @ingroup Scrollhints
2729     */
2730    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2731
2732    /**
2733     * Push the scroll freeze by 1
2734     *
2735     * This increments the scroll freeze count by one. If it is more
2736     * than 0 it will take effect on the parents of the indicated
2737     * object.
2738     *
2739     * @param obj The object
2740     * @ingroup Scrollhints
2741     */
2742    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2743
2744    /**
2745     * Pop the scroll freeze by 1
2746     *
2747     * This decrements the scroll freeze count by one. If it is more
2748     * than 0 it will take effect on the parents of the indicated
2749     * object.
2750     *
2751     * @param obj The object
2752     * @ingroup Scrollhints
2753     */
2754    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2755
2756    /**
2757     * Lock the scrolling of the given widget (and thus all parents)
2758     *
2759     * This locks the given object from scrolling in the X axis (and implicitly
2760     * also locks all parent scrollers too from doing the same).
2761     *
2762     * @param obj The object
2763     * @param lock The lock state (1 == locked, 0 == unlocked)
2764     * @ingroup Scrollhints
2765     */
2766    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2767
2768    /**
2769     * Lock the scrolling of the given widget (and thus all parents)
2770     *
2771     * This locks the given object from scrolling in the Y axis (and implicitly
2772     * also locks all parent scrollers too from doing the same).
2773     *
2774     * @param obj The object
2775     * @param lock The lock state (1 == locked, 0 == unlocked)
2776     * @ingroup Scrollhints
2777     */
2778    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2779
2780    /**
2781     * Get the scrolling lock of the given widget
2782     *
2783     * This gets the lock for X axis scrolling.
2784     *
2785     * @param obj The object
2786     * @ingroup Scrollhints
2787     */
2788    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2789
2790    /**
2791     * Get the scrolling lock of the given widget
2792     *
2793     * This gets the lock for X axis scrolling.
2794     *
2795     * @param obj The object
2796     * @ingroup Scrollhints
2797     */
2798    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2799
2800    /**
2801     * @}
2802     */
2803
2804    /**
2805     * Send a signal to the widget edje object.
2806     *
2807     * This function sends a signal to the edje object of the obj. An
2808     * edje program can respond to a signal by specifying matching
2809     * 'signal' and 'source' fields.
2810     *
2811     * @param obj The object
2812     * @param emission The signal's name.
2813     * @param source The signal's source.
2814     * @ingroup General
2815     */
2816    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2817
2818    /**
2819     * Add a callback for a signal emitted by widget edje object.
2820     *
2821     * This function connects a callback function to a signal emitted by the
2822     * edje object of the obj.
2823     * Globs can occur in either the emission or source name.
2824     *
2825     * @param obj The object
2826     * @param emission The signal's name.
2827     * @param source The signal's source.
2828     * @param func The callback function to be executed when the signal is
2829     * emitted.
2830     * @param data A pointer to data to pass in to the callback function.
2831     * @ingroup General
2832     */
2833    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);
2834
2835    /**
2836     * Remove a signal-triggered callback from a widget edje object.
2837     *
2838     * This function removes a callback, previoulsy attached to a
2839     * signal emitted by the edje object of the obj.  The parameters
2840     * emission, source and func must match exactly those passed to a
2841     * previous call to elm_object_signal_callback_add(). The data
2842     * pointer that was passed to this call will be returned.
2843     *
2844     * @param obj The object
2845     * @param emission The signal's name.
2846     * @param source The signal's source.
2847     * @param func The callback function to be executed when the signal is
2848     * emitted.
2849     * @return The data pointer
2850     * @ingroup General
2851     */
2852    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);
2853
2854    /**
2855     * Add a callback for input events (key up, key down, mouse wheel)
2856     * on a given Elementary widget
2857     *
2858     * @param obj The widget to add an event callback on
2859     * @param func The callback function to be executed when the event
2860     * happens
2861     * @param data Data to pass in to @p func
2862     *
2863     * Every widget in an Elementary interface set to receive focus,
2864     * with elm_object_focus_allow_set(), will propagate @b all of its
2865     * key up, key down and mouse wheel input events up to its parent
2866     * object, and so on. All of the focusable ones in this chain which
2867     * had an event callback set, with this call, will be able to treat
2868     * those events. There are two ways of making the propagation of
2869     * these event upwards in the tree of widgets to @b cease:
2870     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2871     *   the event was @b not processed, so the propagation will go on.
2872     * - The @c event_info pointer passed to @p func will contain the
2873     *   event's structure and, if you OR its @c event_flags inner
2874     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2875     *   one has already handled it, thus killing the event's
2876     *   propagation, too.
2877     *
2878     * @note Your event callback will be issued on those events taking
2879     * place only if no other child widget of @obj has consumed the
2880     * event already.
2881     *
2882     * @note Not to be confused with @c
2883     * evas_object_event_callback_add(), which will add event callbacks
2884     * per type on general Evas objects (no event propagation
2885     * infrastructure taken in account).
2886     *
2887     * @note Not to be confused with @c
2888     * elm_object_signal_callback_add(), which will add callbacks to @b
2889     * signals coming from a widget's theme, not input events.
2890     *
2891     * @note Not to be confused with @c
2892     * edje_object_signal_callback_add(), which does the same as
2893     * elm_object_signal_callback_add(), but directly on an Edje
2894     * object.
2895     *
2896     * @note Not to be confused with @c
2897     * evas_object_smart_callback_add(), which adds callbacks to smart
2898     * objects' <b>smart events</b>, and not input events.
2899     *
2900     * @see elm_object_event_callback_del()
2901     *
2902     * @ingroup General
2903     */
2904    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2905
2906    /**
2907     * Remove an event callback from a widget.
2908     *
2909     * This function removes a callback, previoulsy attached to event emission
2910     * by the @p obj.
2911     * The parameters func and data must match exactly those passed to
2912     * a previous call to elm_object_event_callback_add(). The data pointer that
2913     * was passed to this call will be returned.
2914     *
2915     * @param obj The object
2916     * @param func The callback function to be executed when the event is
2917     * emitted.
2918     * @param data Data to pass in to the callback function.
2919     * @return The data pointer
2920     * @ingroup General
2921     */
2922    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2923
2924    /**
2925     * Adjust size of an element for finger usage.
2926     *
2927     * @param times_w How many fingers should fit horizontally
2928     * @param w Pointer to the width size to adjust
2929     * @param times_h How many fingers should fit vertically
2930     * @param h Pointer to the height size to adjust
2931     *
2932     * This takes width and height sizes (in pixels) as input and a
2933     * size multiple (which is how many fingers you want to place
2934     * within the area, being "finger" the size set by
2935     * elm_finger_size_set()), and adjusts the size to be large enough
2936     * to accommodate the resulting size -- if it doesn't already
2937     * accommodate it. On return the @p w and @p h sizes pointed to by
2938     * these parameters will be modified, on those conditions.
2939     *
2940     * @note This is kind of a low level Elementary call, most useful
2941     * on size evaluation times for widgets. An external user wouldn't
2942     * be calling, most of the time.
2943     *
2944     * @ingroup Fingers
2945     */
2946    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2947
2948    /**
2949     * Get the duration for occuring long press event.
2950     *
2951     * @return Timeout for long press event
2952     * @ingroup Longpress
2953     */
2954    EAPI double           elm_longpress_timeout_get(void);
2955
2956    /**
2957     * Set the duration for occuring long press event.
2958     *
2959     * @param lonpress_timeout Timeout for long press event
2960     * @ingroup Longpress
2961     */
2962    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
2963
2964    /**
2965     * @defgroup Debug Debug
2966     * don't use it unless you are sure
2967     *
2968     * @{
2969     */
2970
2971    /**
2972     * Print Tree object hierarchy in stdout
2973     *
2974     * @param obj The root object
2975     * @ingroup Debug
2976     */
2977    EAPI void             elm_object_tree_dump(const Evas_Object *top);
2978
2979    /**
2980     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
2981     *
2982     * @param obj The root object
2983     * @param file The path of output file
2984     * @ingroup Debug
2985     */
2986    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
2987
2988    /**
2989     * @}
2990     */
2991
2992    /**
2993     * @defgroup Theme Theme
2994     *
2995     * Elementary uses Edje to theme its widgets, naturally. But for the most
2996     * part this is hidden behind a simpler interface that lets the user set
2997     * extensions and choose the style of widgets in a much easier way.
2998     *
2999     * Instead of thinking in terms of paths to Edje files and their groups
3000     * each time you want to change the appearance of a widget, Elementary
3001     * works so you can add any theme file with extensions or replace the
3002     * main theme at one point in the application, and then just set the style
3003     * of widgets with elm_object_style_set() and related functions. Elementary
3004     * will then look in its list of themes for a matching group and apply it,
3005     * and when the theme changes midway through the application, all widgets
3006     * will be updated accordingly.
3007     *
3008     * There are three concepts you need to know to understand how Elementary
3009     * theming works: default theme, extensions and overlays.
3010     *
3011     * Default theme, obviously enough, is the one that provides the default
3012     * look of all widgets. End users can change the theme used by Elementary
3013     * by setting the @c ELM_THEME environment variable before running an
3014     * application, or globally for all programs using the @c elementary_config
3015     * utility. Applications can change the default theme using elm_theme_set(),
3016     * but this can go against the user wishes, so it's not an adviced practice.
3017     *
3018     * Ideally, applications should find everything they need in the already
3019     * provided theme, but there may be occasions when that's not enough and
3020     * custom styles are required to correctly express the idea. For this
3021     * cases, Elementary has extensions.
3022     *
3023     * Extensions allow the application developer to write styles of its own
3024     * to apply to some widgets. This requires knowledge of how each widget
3025     * is themed, as extensions will always replace the entire group used by
3026     * the widget, so important signals and parts need to be there for the
3027     * object to behave properly (see documentation of Edje for details).
3028     * Once the theme for the extension is done, the application needs to add
3029     * it to the list of themes Elementary will look into, using
3030     * elm_theme_extension_add(), and set the style of the desired widgets as
3031     * he would normally with elm_object_style_set().
3032     *
3033     * Overlays, on the other hand, can replace the look of all widgets by
3034     * overriding the default style. Like extensions, it's up to the application
3035     * developer to write the theme for the widgets it wants, the difference
3036     * being that when looking for the theme, Elementary will check first the
3037     * list of overlays, then the set theme and lastly the list of extensions,
3038     * so with overlays it's possible to replace the default view and every
3039     * widget will be affected. This is very much alike to setting the whole
3040     * theme for the application and will probably clash with the end user
3041     * options, not to mention the risk of ending up with not matching styles
3042     * across the program. Unless there's a very special reason to use them,
3043     * overlays should be avoided for the resons exposed before.
3044     *
3045     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3046     * keeps one default internally and every function that receives one of
3047     * these can be called with NULL to refer to this default (except for
3048     * elm_theme_free()). It's possible to create a new instance of a
3049     * ::Elm_Theme to set other theme for a specific widget (and all of its
3050     * children), but this is as discouraged, if not even more so, than using
3051     * overlays. Don't use this unless you really know what you are doing.
3052     *
3053     * But to be less negative about things, you can look at the following
3054     * examples:
3055     * @li @ref theme_example_01 "Using extensions"
3056     * @li @ref theme_example_02 "Using overlays"
3057     *
3058     * @{
3059     */
3060    /**
3061     * @typedef Elm_Theme
3062     *
3063     * Opaque handler for the list of themes Elementary looks for when
3064     * rendering widgets.
3065     *
3066     * Stay out of this unless you really know what you are doing. For most
3067     * cases, sticking to the default is all a developer needs.
3068     */
3069    typedef struct _Elm_Theme Elm_Theme;
3070
3071    /**
3072     * Create a new specific theme
3073     *
3074     * This creates an empty specific theme that only uses the default theme. A
3075     * specific theme has its own private set of extensions and overlays too
3076     * (which are empty by default). Specific themes do not fall back to themes
3077     * of parent objects. They are not intended for this use. Use styles, overlays
3078     * and extensions when needed, but avoid specific themes unless there is no
3079     * other way (example: you want to have a preview of a new theme you are
3080     * selecting in a "theme selector" window. The preview is inside a scroller
3081     * and should display what the theme you selected will look like, but not
3082     * actually apply it yet. The child of the scroller will have a specific
3083     * theme set to show this preview before the user decides to apply it to all
3084     * applications).
3085     */
3086    EAPI Elm_Theme       *elm_theme_new(void);
3087    /**
3088     * Free a specific theme
3089     *
3090     * @param th The theme to free
3091     *
3092     * This frees a theme created with elm_theme_new().
3093     */
3094    EAPI void             elm_theme_free(Elm_Theme *th);
3095    /**
3096     * Copy the theme fom the source to the destination theme
3097     *
3098     * @param th The source theme to copy from
3099     * @param thdst The destination theme to copy data to
3100     *
3101     * This makes a one-time static copy of all the theme config, extensions
3102     * and overlays from @p th to @p thdst. If @p th references a theme, then
3103     * @p thdst is also set to reference it, with all the theme settings,
3104     * overlays and extensions that @p th had.
3105     */
3106    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3107    /**
3108     * Tell the source theme to reference the ref theme
3109     *
3110     * @param th The theme that will do the referencing
3111     * @param thref The theme that is the reference source
3112     *
3113     * This clears @p th to be empty and then sets it to refer to @p thref
3114     * so @p th acts as an override to @p thref, but where its overrides
3115     * don't apply, it will fall through to @p thref for configuration.
3116     */
3117    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3118    /**
3119     * Return the theme referred to
3120     *
3121     * @param th The theme to get the reference from
3122     * @return The referenced theme handle
3123     *
3124     * This gets the theme set as the reference theme by elm_theme_ref_set().
3125     * If no theme is set as a reference, NULL is returned.
3126     */
3127    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3128    /**
3129     * Return the default theme
3130     *
3131     * @return The default theme handle
3132     *
3133     * This returns the internal default theme setup handle that all widgets
3134     * use implicitly unless a specific theme is set. This is also often use
3135     * as a shorthand of NULL.
3136     */
3137    EAPI Elm_Theme       *elm_theme_default_get(void);
3138    /**
3139     * Prepends a theme overlay to the list of overlays
3140     *
3141     * @param th The theme to add to, or if NULL, the default theme
3142     * @param item The Edje file path to be used
3143     *
3144     * Use this if your application needs to provide some custom overlay theme
3145     * (An Edje file that replaces some default styles of widgets) where adding
3146     * new styles, or changing system theme configuration is not possible. Do
3147     * NOT use this instead of a proper system theme configuration. Use proper
3148     * configuration files, profiles, environment variables etc. to set a theme
3149     * so that the theme can be altered by simple confiugration by a user. Using
3150     * this call to achieve that effect is abusing the API and will create lots
3151     * of trouble.
3152     *
3153     * @see elm_theme_extension_add()
3154     */
3155    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3156    /**
3157     * Delete a theme overlay from the list of overlays
3158     *
3159     * @param th The theme to delete from, or if NULL, the default theme
3160     * @param item The name of the theme overlay
3161     *
3162     * @see elm_theme_overlay_add()
3163     */
3164    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3165    /**
3166     * Appends a theme extension to the list of extensions.
3167     *
3168     * @param th The theme to add to, or if NULL, the default theme
3169     * @param item The Edje file path to be used
3170     *
3171     * This is intended when an application needs more styles of widgets or new
3172     * widget themes that the default does not provide (or may not provide). The
3173     * application has "extended" usage by coming up with new custom style names
3174     * for widgets for specific uses, but as these are not "standard", they are
3175     * not guaranteed to be provided by a default theme. This means the
3176     * application is required to provide these extra elements itself in specific
3177     * Edje files. This call adds one of those Edje files to the theme search
3178     * path to be search after the default theme. The use of this call is
3179     * encouraged when default styles do not meet the needs of the application.
3180     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3181     *
3182     * @see elm_object_style_set()
3183     */
3184    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3185    /**
3186     * Deletes a theme extension from the list of extensions.
3187     *
3188     * @param th The theme to delete from, or if NULL, the default theme
3189     * @param item The name of the theme extension
3190     *
3191     * @see elm_theme_extension_add()
3192     */
3193    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3194    /**
3195     * Set the theme search order for the given theme
3196     *
3197     * @param th The theme to set the search order, or if NULL, the default theme
3198     * @param theme Theme search string
3199     *
3200     * This sets the search string for the theme in path-notation from first
3201     * theme to search, to last, delimited by the : character. Example:
3202     *
3203     * "shiny:/path/to/file.edj:default"
3204     *
3205     * See the ELM_THEME environment variable for more information.
3206     *
3207     * @see elm_theme_get()
3208     * @see elm_theme_list_get()
3209     */
3210    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3211    /**
3212     * Return the theme search order
3213     *
3214     * @param th The theme to get the search order, or if NULL, the default theme
3215     * @return The internal search order path
3216     *
3217     * This function returns a colon separated string of theme elements as
3218     * returned by elm_theme_list_get().
3219     *
3220     * @see elm_theme_set()
3221     * @see elm_theme_list_get()
3222     */
3223    EAPI const char      *elm_theme_get(Elm_Theme *th);
3224    /**
3225     * Return a list of theme elements to be used in a theme.
3226     *
3227     * @param th Theme to get the list of theme elements from.
3228     * @return The internal list of theme elements
3229     *
3230     * This returns the internal list of theme elements (will only be valid as
3231     * long as the theme is not modified by elm_theme_set() or theme is not
3232     * freed by elm_theme_free(). This is a list of strings which must not be
3233     * altered as they are also internal. If @p th is NULL, then the default
3234     * theme element list is returned.
3235     *
3236     * A theme element can consist of a full or relative path to a .edj file,
3237     * or a name, without extension, for a theme to be searched in the known
3238     * theme paths for Elemementary.
3239     *
3240     * @see elm_theme_set()
3241     * @see elm_theme_get()
3242     */
3243    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3244    /**
3245     * Return the full patrh for a theme element
3246     *
3247     * @param f The theme element name
3248     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3249     * @return The full path to the file found.
3250     *
3251     * This returns a string you should free with free() on success, NULL on
3252     * failure. This will search for the given theme element, and if it is a
3253     * full or relative path element or a simple searchable name. The returned
3254     * path is the full path to the file, if searched, and the file exists, or it
3255     * is simply the full path given in the element or a resolved path if
3256     * relative to home. The @p in_search_path boolean pointed to is set to
3257     * EINA_TRUE if the file was a searchable file andis in the search path,
3258     * and EINA_FALSE otherwise.
3259     */
3260    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3261    /**
3262     * Flush the current theme.
3263     *
3264     * @param th Theme to flush
3265     *
3266     * This flushes caches that let elementary know where to find theme elements
3267     * in the given theme. If @p th is NULL, then the default theme is flushed.
3268     * Call this function if source theme data has changed in such a way as to
3269     * make any caches Elementary kept invalid.
3270     */
3271    EAPI void             elm_theme_flush(Elm_Theme *th);
3272    /**
3273     * This flushes all themes (default and specific ones).
3274     *
3275     * This will flush all themes in the current application context, by calling
3276     * elm_theme_flush() on each of them.
3277     */
3278    EAPI void             elm_theme_full_flush(void);
3279    /**
3280     * Set the theme for all elementary using applications on the current display
3281     *
3282     * @param theme The name of the theme to use. Format same as the ELM_THEME
3283     * environment variable.
3284     */
3285    EAPI void             elm_theme_all_set(const char *theme);
3286    /**
3287     * Return a list of theme elements in the theme search path
3288     *
3289     * @return A list of strings that are the theme element names.
3290     *
3291     * This lists all available theme files in the standard Elementary search path
3292     * for theme elements, and returns them in alphabetical order as theme
3293     * element names in a list of strings. Free this with
3294     * elm_theme_name_available_list_free() when you are done with the list.
3295     */
3296    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3297    /**
3298     * Free the list returned by elm_theme_name_available_list_new()
3299     *
3300     * This frees the list of themes returned by
3301     * elm_theme_name_available_list_new(). Once freed the list should no longer
3302     * be used. a new list mys be created.
3303     */
3304    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3305    /**
3306     * Set a specific theme to be used for this object and its children
3307     *
3308     * @param obj The object to set the theme on
3309     * @param th The theme to set
3310     *
3311     * This sets a specific theme that will be used for the given object and any
3312     * child objects it has. If @p th is NULL then the theme to be used is
3313     * cleared and the object will inherit its theme from its parent (which
3314     * ultimately will use the default theme if no specific themes are set).
3315     *
3316     * Use special themes with great care as this will annoy users and make
3317     * configuration difficult. Avoid any custom themes at all if it can be
3318     * helped.
3319     */
3320    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3321    /**
3322     * Get the specific theme to be used
3323     *
3324     * @param obj The object to get the specific theme from
3325     * @return The specifc theme set.
3326     *
3327     * This will return a specific theme set, or NULL if no specific theme is
3328     * set on that object. It will not return inherited themes from parents, only
3329     * the specific theme set for that specific object. See elm_object_theme_set()
3330     * for more information.
3331     */
3332    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3333    /**
3334     * @}
3335     */
3336
3337    /* win */
3338    /** @defgroup Win Win
3339     *
3340     * @image html img/widget/win/preview-00.png
3341     * @image latex img/widget/win/preview-00.eps
3342     *
3343     * The window class of Elementary.  Contains functions to manipulate
3344     * windows. The Evas engine used to render the window contents is specified
3345     * in the system or user elementary config files (whichever is found last),
3346     * and can be overridden with the ELM_ENGINE environment variable for
3347     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3348     * compilation setup and modules actually installed at runtime) are (listed
3349     * in order of best supported and most likely to be complete and work to
3350     * lowest quality).
3351     *
3352     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3353     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3354     * rendering in X11)
3355     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3356     * exits)
3357     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3358     * rendering)
3359     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3360     * buffer)
3361     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3362     * rendering using SDL as the buffer)
3363     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3364     * GDI with software)
3365     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3366     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3367     * grayscale using dedicated 8bit software engine in X11)
3368     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3369     * X11 using 16bit software engine)
3370     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3371     * (Windows CE rendering via GDI with 16bit software renderer)
3372     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3373     * buffer with 16bit software renderer)
3374     *
3375     * All engines use a simple string to select the engine to render, EXCEPT
3376     * the "shot" engine. This actually encodes the output of the virtual
3377     * screenshot and how long to delay in the engine string. The engine string
3378     * is encoded in the following way:
3379     *
3380     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3381     *
3382     * Where options are separated by a ":" char if more than one option is
3383     * given, with delay, if provided being the first option and file the last
3384     * (order is important). The delay specifies how long to wait after the
3385     * window is shown before doing the virtual "in memory" rendering and then
3386     * save the output to the file specified by the file option (and then exit).
3387     * If no delay is given, the default is 0.5 seconds. If no file is given the
3388     * default output file is "out.png". Repeat option is for continous
3389     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3390     * fixed to "out001.png" Some examples of using the shot engine:
3391     *
3392     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3393     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3394     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3395     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3396     *   ELM_ENGINE="shot:" elementary_test
3397     *
3398     * Signals that you can add callbacks for are:
3399     *
3400     * @li "delete,request": the user requested to close the window. See
3401     * elm_win_autodel_set().
3402     * @li "focus,in": window got focus
3403     * @li "focus,out": window lost focus
3404     * @li "moved": window that holds the canvas was moved
3405     *
3406     * Examples:
3407     * @li @ref win_example_01
3408     *
3409     * @{
3410     */
3411    /**
3412     * Defines the types of window that can be created
3413     *
3414     * These are hints set on the window so that a running Window Manager knows
3415     * how the window should be handled and/or what kind of decorations it
3416     * should have.
3417     *
3418     * Currently, only the X11 backed engines use them.
3419     */
3420    typedef enum _Elm_Win_Type
3421      {
3422         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3423                          window. Almost every window will be created with this
3424                          type. */
3425         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3426         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3427                            window holding desktop icons. */
3428         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3429                         be kept on top of any other window by the Window
3430                         Manager. */
3431         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3432                            similar. */
3433         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3434         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3435                            pallete. */
3436         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3437         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3438                                  entry in a menubar is clicked. Typically used
3439                                  with elm_win_override_set(). This hint exists
3440                                  for completion only, as the EFL way of
3441                                  implementing a menu would not normally use a
3442                                  separate window for its contents. */
3443         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3444                               triggered by right-clicking an object. */
3445         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3446                            explanatory text that typically appear after the
3447                            mouse cursor hovers over an object for a while.
3448                            Typically used with elm_win_override_set() and also
3449                            not very commonly used in the EFL. */
3450         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3451                                 battery life or a new E-Mail received. */
3452         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3453                          usually used in the EFL. */
3454         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3455                        object being dragged across different windows, or even
3456                        applications. Typically used with
3457                        elm_win_override_set(). */
3458         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3459                                  buffer. No actual window is created for this
3460                                  type, instead the window and all of its
3461                                  contents will be rendered to an image buffer.
3462                                  This allows to have children window inside a
3463                                  parent one just like any other object would
3464                                  be, and do other things like applying @c
3465                                  Evas_Map effects to it. This is the only type
3466                                  of window that requires the @c parent
3467                                  parameter of elm_win_add() to be a valid @c
3468                                  Evas_Object. */
3469      } Elm_Win_Type;
3470
3471    /**
3472     * The differents layouts that can be requested for the virtual keyboard.
3473     *
3474     * When the application window is being managed by Illume, it may request
3475     * any of the following layouts for the virtual keyboard.
3476     */
3477    typedef enum _Elm_Win_Keyboard_Mode
3478      {
3479         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3480         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3481         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3482         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3483         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3484         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3485         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3486         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3487         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3488         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3489         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3490         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3491         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3492         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3493         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3494         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3495      } Elm_Win_Keyboard_Mode;
3496
3497    /**
3498     * Available commands that can be sent to the Illume manager.
3499     *
3500     * When running under an Illume session, a window may send commands to the
3501     * Illume manager to perform different actions.
3502     */
3503    typedef enum _Elm_Illume_Command
3504      {
3505         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3506                                          window */
3507         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3508                                             in the list */
3509         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3510                                          screen */
3511         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3512      } Elm_Illume_Command;
3513
3514    /**
3515     * Adds a window object. If this is the first window created, pass NULL as
3516     * @p parent.
3517     *
3518     * @param parent Parent object to add the window to, or NULL
3519     * @param name The name of the window
3520     * @param type The window type, one of #Elm_Win_Type.
3521     *
3522     * The @p parent paramter can be @c NULL for every window @p type except
3523     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3524     * which the image object will be created.
3525     *
3526     * @return The created object, or NULL on failure
3527     */
3528    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3529    /**
3530     * Add @p subobj as a resize object of window @p obj.
3531     *
3532     *
3533     * Setting an object as a resize object of the window means that the
3534     * @p subobj child's size and position will be controlled by the window
3535     * directly. That is, the object will be resized to match the window size
3536     * and should never be moved or resized manually by the developer.
3537     *
3538     * In addition, resize objects of the window control what the minimum size
3539     * of it will be, as well as whether it can or not be resized by the user.
3540     *
3541     * For the end user to be able to resize a window by dragging the handles
3542     * or borders provided by the Window Manager, or using any other similar
3543     * mechanism, all of the resize objects in the window should have their
3544     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3545     *
3546     * @param obj The window object
3547     * @param subobj The resize object to add
3548     */
3549    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3550    /**
3551     * Delete @p subobj as a resize object of window @p obj.
3552     *
3553     * This function removes the object @p subobj from the resize objects of
3554     * the window @p obj. It will not delete the object itself, which will be
3555     * left unmanaged and should be deleted by the developer, manually handled
3556     * or set as child of some other container.
3557     *
3558     * @param obj The window object
3559     * @param subobj The resize object to add
3560     */
3561    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3562    /**
3563     * Set the title of the window
3564     *
3565     * @param obj The window object
3566     * @param title The title to set
3567     */
3568    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3569    /**
3570     * Get the title of the window
3571     *
3572     * The returned string is an internal one and should not be freed or
3573     * modified. It will also be rendered invalid if a new title is set or if
3574     * the window is destroyed.
3575     *
3576     * @param obj The window object
3577     * @return The title
3578     */
3579    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3580    /**
3581     * Set the window's autodel state.
3582     *
3583     * When closing the window in any way outside of the program control, like
3584     * pressing the X button in the titlebar or using a command from the
3585     * Window Manager, a "delete,request" signal is emitted to indicate that
3586     * this event occurred and the developer can take any action, which may
3587     * include, or not, destroying the window object.
3588     *
3589     * When the @p autodel parameter is set, the window will be automatically
3590     * destroyed when this event occurs, after the signal is emitted.
3591     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3592     * and is up to the program to do so when it's required.
3593     *
3594     * @param obj The window object
3595     * @param autodel If true, the window will automatically delete itself when
3596     * closed
3597     */
3598    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3599    /**
3600     * Get the window's autodel state.
3601     *
3602     * @param obj The window object
3603     * @return If the window will automatically delete itself when closed
3604     *
3605     * @see elm_win_autodel_set()
3606     */
3607    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3608    /**
3609     * Activate a window object.
3610     *
3611     * This function sends a request to the Window Manager to activate the
3612     * window pointed by @p obj. If honored by the WM, the window will receive
3613     * the keyboard focus.
3614     *
3615     * @note This is just a request that a Window Manager may ignore, so calling
3616     * this function does not ensure in any way that the window will be the
3617     * active one after it.
3618     *
3619     * @param obj The window object
3620     */
3621    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3622    /**
3623     * Lower a window object.
3624     *
3625     * Places the window pointed by @p obj at the bottom of the stack, so that
3626     * no other window is covered by it.
3627     *
3628     * If elm_win_override_set() is not set, the Window Manager may ignore this
3629     * request.
3630     *
3631     * @param obj The window object
3632     */
3633    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3634    /**
3635     * Raise a window object.
3636     *
3637     * Places the window pointed by @p obj at the top of the stack, so that it's
3638     * not covered by any other window.
3639     *
3640     * If elm_win_override_set() is not set, the Window Manager may ignore this
3641     * request.
3642     *
3643     * @param obj The window object
3644     */
3645    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3646    /**
3647     * Set the borderless state of a window.
3648     *
3649     * This function requests the Window Manager to not draw any decoration
3650     * around the window.
3651     *
3652     * @param obj The window object
3653     * @param borderless If true, the window is borderless
3654     */
3655    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3656    /**
3657     * Get the borderless state of a window.
3658     *
3659     * @param obj The window object
3660     * @return If true, the window is borderless
3661     */
3662    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3663    /**
3664     * Set the shaped state of a window.
3665     *
3666     * Shaped windows, when supported, will render the parts of the window that
3667     * has no content, transparent.
3668     *
3669     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3670     * background object or cover the entire window in any other way, or the
3671     * parts of the canvas that have no data will show framebuffer artifacts.
3672     *
3673     * @param obj The window object
3674     * @param shaped If true, the window is shaped
3675     *
3676     * @see elm_win_alpha_set()
3677     */
3678    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3679    /**
3680     * Get the shaped state of a window.
3681     *
3682     * @param obj The window object
3683     * @return If true, the window is shaped
3684     *
3685     * @see elm_win_shaped_set()
3686     */
3687    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3688    /**
3689     * Set the alpha channel state of a window.
3690     *
3691     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3692     * possibly making parts of the window completely or partially transparent.
3693     * This is also subject to the underlying system supporting it, like for
3694     * example, running under a compositing manager. If no compositing is
3695     * available, enabling this option will instead fallback to using shaped
3696     * windows, with elm_win_shaped_set().
3697     *
3698     * @param obj The window object
3699     * @param alpha If true, the window has an alpha channel
3700     *
3701     * @see elm_win_alpha_set()
3702     */
3703    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3704    /**
3705     * Get the transparency state of a window.
3706     *
3707     * @param obj The window object
3708     * @return If true, the window is transparent
3709     *
3710     * @see elm_win_transparent_set()
3711     */
3712    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3713    /**
3714     * Set the transparency state of a window.
3715     *
3716     * Use elm_win_alpha_set() instead.
3717     *
3718     * @param obj The window object
3719     * @param transparent If true, the window is transparent
3720     *
3721     * @see elm_win_alpha_set()
3722     */
3723    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3724    /**
3725     * Get the alpha channel state of a window.
3726     *
3727     * @param obj The window object
3728     * @return If true, the window has an alpha channel
3729     */
3730    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3731    /**
3732     * Set the override state of a window.
3733     *
3734     * A window with @p override set to EINA_TRUE will not be managed by the
3735     * Window Manager. This means that no decorations of any kind will be shown
3736     * for it, moving and resizing must be handled by the application, as well
3737     * as the window visibility.
3738     *
3739     * This should not be used for normal windows, and even for not so normal
3740     * ones, it should only be used when there's a good reason and with a lot
3741     * of care. Mishandling override windows may result situations that
3742     * disrupt the normal workflow of the end user.
3743     *
3744     * @param obj The window object
3745     * @param override If true, the window is overridden
3746     */
3747    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3748    /**
3749     * Get the override state of a window.
3750     *
3751     * @param obj The window object
3752     * @return If true, the window is overridden
3753     *
3754     * @see elm_win_override_set()
3755     */
3756    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3757    /**
3758     * Set the fullscreen state of a window.
3759     *
3760     * @param obj The window object
3761     * @param fullscreen If true, the window is fullscreen
3762     */
3763    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3764    /**
3765     * Get the fullscreen state of a window.
3766     *
3767     * @param obj The window object
3768     * @return If true, the window is fullscreen
3769     */
3770    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3771    /**
3772     * Set the maximized state of a window.
3773     *
3774     * @param obj The window object
3775     * @param maximized If true, the window is maximized
3776     */
3777    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3778    /**
3779     * Get the maximized state of a window.
3780     *
3781     * @param obj The window object
3782     * @return If true, the window is maximized
3783     */
3784    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3785    /**
3786     * Set the iconified state of a window.
3787     *
3788     * @param obj The window object
3789     * @param iconified If true, the window is iconified
3790     */
3791    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3792    /**
3793     * Get the iconified state of a window.
3794     *
3795     * @param obj The window object
3796     * @return If true, the window is iconified
3797     */
3798    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3799    /**
3800     * Set the layer of the window.
3801     *
3802     * What this means exactly will depend on the underlying engine used.
3803     *
3804     * In the case of X11 backed engines, the value in @p layer has the
3805     * following meanings:
3806     * @li < 3: The window will be placed below all others.
3807     * @li > 5: The window will be placed above all others.
3808     * @li other: The window will be placed in the default layer.
3809     *
3810     * @param obj The window object
3811     * @param layer The layer of the window
3812     */
3813    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3814    /**
3815     * Get the layer of the window.
3816     *
3817     * @param obj The window object
3818     * @return The layer of the window
3819     *
3820     * @see elm_win_layer_set()
3821     */
3822    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3823    /**
3824     * Set the rotation of the window.
3825     *
3826     * Most engines only work with multiples of 90.
3827     *
3828     * This function is used to set the orientation of the window @p obj to
3829     * match that of the screen. The window itself will be resized to adjust
3830     * to the new geometry of its contents. If you want to keep the window size,
3831     * see elm_win_rotation_with_resize_set().
3832     *
3833     * @param obj The window object
3834     * @param rotation The rotation of the window, in degrees (0-360),
3835     * counter-clockwise.
3836     */
3837    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3838    /**
3839     * Rotates the window and resizes it.
3840     *
3841     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3842     * that they fit inside the current window geometry.
3843     *
3844     * @param obj The window object
3845     * @param layer The rotation of the window in degrees (0-360),
3846     * counter-clockwise.
3847     */
3848    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3849    /**
3850     * Get the rotation of the window.
3851     *
3852     * @param obj The window object
3853     * @return The rotation of the window in degrees (0-360)
3854     *
3855     * @see elm_win_rotation_set()
3856     * @see elm_win_rotation_with_resize_set()
3857     */
3858    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3859    /**
3860     * Set the sticky state of the window.
3861     *
3862     * Hints the Window Manager that the window in @p obj should be left fixed
3863     * at its position even when the virtual desktop it's on moves or changes.
3864     *
3865     * @param obj The window object
3866     * @param sticky If true, the window's sticky state is enabled
3867     */
3868    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3869    /**
3870     * Get the sticky state of the window.
3871     *
3872     * @param obj The window object
3873     * @return If true, the window's sticky state is enabled
3874     *
3875     * @see elm_win_sticky_set()
3876     */
3877    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3878    /**
3879     * Set if this window is an illume conformant window
3880     *
3881     * @param obj The window object
3882     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3883     */
3884    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3885    /**
3886     * Get if this window is an illume conformant window
3887     *
3888     * @param obj The window object
3889     * @return A boolean if this window is illume conformant or not
3890     */
3891    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3892    /**
3893     * Set a window to be an illume quickpanel window
3894     *
3895     * By default window objects are not quickpanel windows.
3896     *
3897     * @param obj The window object
3898     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3899     */
3900    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3901    /**
3902     * Get if this window is a quickpanel or not
3903     *
3904     * @param obj The window object
3905     * @return A boolean if this window is a quickpanel or not
3906     */
3907    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3908    /**
3909     * Set the major priority of a quickpanel window
3910     *
3911     * @param obj The window object
3912     * @param priority The major priority for this quickpanel
3913     */
3914    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3915    /**
3916     * Get the major priority of a quickpanel window
3917     *
3918     * @param obj The window object
3919     * @return The major priority of this quickpanel
3920     */
3921    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3922    /**
3923     * Set the minor priority of a quickpanel window
3924     *
3925     * @param obj The window object
3926     * @param priority The minor priority for this quickpanel
3927     */
3928    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3929    /**
3930     * Get the minor priority of a quickpanel window
3931     *
3932     * @param obj The window object
3933     * @return The minor priority of this quickpanel
3934     */
3935    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3936    /**
3937     * Set which zone this quickpanel should appear in
3938     *
3939     * @param obj The window object
3940     * @param zone The requested zone for this quickpanel
3941     */
3942    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
3943    /**
3944     * Get which zone this quickpanel should appear in
3945     *
3946     * @param obj The window object
3947     * @return The requested zone for this quickpanel
3948     */
3949    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3950    /**
3951     * Set the window to be skipped by keyboard focus
3952     *
3953     * This sets the window to be skipped by normal keyboard input. This means
3954     * a window manager will be asked to not focus this window as well as omit
3955     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
3956     *
3957     * Call this and enable it on a window BEFORE you show it for the first time,
3958     * otherwise it may have no effect.
3959     *
3960     * Use this for windows that have only output information or might only be
3961     * interacted with by the mouse or fingers, and never for typing input.
3962     * Be careful that this may have side-effects like making the window
3963     * non-accessible in some cases unless the window is specially handled. Use
3964     * this with care.
3965     *
3966     * @param obj The window object
3967     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
3968     */
3969    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
3970    /**
3971     * Send a command to the windowing environment
3972     *
3973     * This is intended to work in touchscreen or small screen device
3974     * environments where there is a more simplistic window management policy in
3975     * place. This uses the window object indicated to select which part of the
3976     * environment to control (the part that this window lives in), and provides
3977     * a command and an optional parameter structure (use NULL for this if not
3978     * needed).
3979     *
3980     * @param obj The window object that lives in the environment to control
3981     * @param command The command to send
3982     * @param params Optional parameters for the command
3983     */
3984    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
3985    /**
3986     * Get the inlined image object handle
3987     *
3988     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
3989     * then the window is in fact an evas image object inlined in the parent
3990     * canvas. You can get this object (be careful to not manipulate it as it
3991     * is under control of elementary), and use it to do things like get pixel
3992     * data, save the image to a file, etc.
3993     *
3994     * @param obj The window object to get the inlined image from
3995     * @return The inlined image object, or NULL if none exists
3996     */
3997    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
3998    /**
3999     * Set the enabled status for the focus highlight in a window
4000     *
4001     * This function will enable or disable the focus highlight only for the
4002     * given window, regardless of the global setting for it
4003     *
4004     * @param obj The window where to enable the highlight
4005     * @param enabled The enabled value for the highlight
4006     */
4007    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4008    /**
4009     * Get the enabled value of the focus highlight for this window
4010     *
4011     * @param obj The window in which to check if the focus highlight is enabled
4012     *
4013     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4014     */
4015    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4016    /**
4017     * Set the style for the focus highlight on this window
4018     *
4019     * Sets the style to use for theming the highlight of focused objects on
4020     * the given window. If @p style is NULL, the default will be used.
4021     *
4022     * @param obj The window where to set the style
4023     * @param style The style to set
4024     */
4025    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4026    /**
4027     * Get the style set for the focus highlight object
4028     *
4029     * Gets the style set for this windows highilght object, or NULL if none
4030     * is set.
4031     *
4032     * @param obj The window to retrieve the highlights style from
4033     *
4034     * @return The style set or NULL if none was. Default is used in that case.
4035     */
4036    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4037    /*...
4038     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4039     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4040     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4041     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4042     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4043     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4044     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4045     *
4046     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4047     * (blank mouse, private mouse obj, defaultmouse)
4048     *
4049     */
4050    /**
4051     * Sets the keyboard mode of the window.
4052     *
4053     * @param obj The window object
4054     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4055     */
4056    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4057    /**
4058     * Gets the keyboard mode of the window.
4059     *
4060     * @param obj The window object
4061     * @return The mode, one of #Elm_Win_Keyboard_Mode
4062     */
4063    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4064    /**
4065     * Sets whether the window is a keyboard.
4066     *
4067     * @param obj The window object
4068     * @param is_keyboard If true, the window is a virtual keyboard
4069     */
4070    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4071    /**
4072     * Gets whether the window is a keyboard.
4073     *
4074     * @param obj The window object
4075     * @return If the window is a virtual keyboard
4076     */
4077    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4078
4079    /**
4080     * Get the screen position of a window.
4081     *
4082     * @param obj The window object
4083     * @param x The int to store the x coordinate to
4084     * @param y The int to store the y coordinate to
4085     */
4086    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4087    /**
4088     * @}
4089     */
4090
4091    /**
4092     * @defgroup Inwin Inwin
4093     *
4094     * @image html img/widget/inwin/preview-00.png
4095     * @image latex img/widget/inwin/preview-00.eps
4096     * @image html img/widget/inwin/preview-01.png
4097     * @image latex img/widget/inwin/preview-01.eps
4098     * @image html img/widget/inwin/preview-02.png
4099     * @image latex img/widget/inwin/preview-02.eps
4100     *
4101     * An inwin is a window inside a window that is useful for a quick popup.
4102     * It does not hover.
4103     *
4104     * It works by creating an object that will occupy the entire window, so it
4105     * must be created using an @ref Win "elm_win" as parent only. The inwin
4106     * object can be hidden or restacked below every other object if it's
4107     * needed to show what's behind it without destroying it. If this is done,
4108     * the elm_win_inwin_activate() function can be used to bring it back to
4109     * full visibility again.
4110     *
4111     * There are three styles available in the default theme. These are:
4112     * @li default: The inwin is sized to take over most of the window it's
4113     * placed in.
4114     * @li minimal: The size of the inwin will be the minimum necessary to show
4115     * its contents.
4116     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4117     * possible, but it's sized vertically the most it needs to fit its\
4118     * contents.
4119     *
4120     * Some examples of Inwin can be found in the following:
4121     * @li @ref inwin_example_01
4122     *
4123     * @{
4124     */
4125    /**
4126     * Adds an inwin to the current window
4127     *
4128     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4129     * Never call this function with anything other than the top-most window
4130     * as its parameter, unless you are fond of undefined behavior.
4131     *
4132     * After creating the object, the widget will set itself as resize object
4133     * for the window with elm_win_resize_object_add(), so when shown it will
4134     * appear to cover almost the entire window (how much of it depends on its
4135     * content and the style used). It must not be added into other container
4136     * objects and it needs not be moved or resized manually.
4137     *
4138     * @param parent The parent object
4139     * @return The new object or NULL if it cannot be created
4140     */
4141    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4142    /**
4143     * Activates an inwin object, ensuring its visibility
4144     *
4145     * This function will make sure that the inwin @p obj is completely visible
4146     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4147     * to the front. It also sets the keyboard focus to it, which will be passed
4148     * onto its content.
4149     *
4150     * The object's theme will also receive the signal "elm,action,show" with
4151     * source "elm".
4152     *
4153     * @param obj The inwin to activate
4154     */
4155    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4156    /**
4157     * Set the content of an inwin object.
4158     *
4159     * Once the content object is set, a previously set one will be deleted.
4160     * If you want to keep that old content object, use the
4161     * elm_win_inwin_content_unset() function.
4162     *
4163     * @param obj The inwin object
4164     * @param content The object to set as content
4165     */
4166    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4167    /**
4168     * Get the content of an inwin object.
4169     *
4170     * Return the content object which is set for this widget.
4171     *
4172     * The returned object is valid as long as the inwin is still alive and no
4173     * other content is set on it. Deleting the object will notify the inwin
4174     * about it and this one will be left empty.
4175     *
4176     * If you need to remove an inwin's content to be reused somewhere else,
4177     * see elm_win_inwin_content_unset().
4178     *
4179     * @param obj The inwin object
4180     * @return The content that is being used
4181     */
4182    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4183    /**
4184     * Unset the content of an inwin object.
4185     *
4186     * Unparent and return the content object which was set for this widget.
4187     *
4188     * @param obj The inwin object
4189     * @return The content that was being used
4190     */
4191    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4192    /**
4193     * @}
4194     */
4195    /* X specific calls - won't work on non-x engines (return 0) */
4196
4197    /**
4198     * Get the Ecore_X_Window of an Evas_Object
4199     *
4200     * @param obj The object
4201     *
4202     * @return The Ecore_X_Window of @p obj
4203     *
4204     * @ingroup Win
4205     */
4206    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4207
4208    /* smart callbacks called:
4209     * "delete,request" - the user requested to delete the window
4210     * "focus,in" - window got focus
4211     * "focus,out" - window lost focus
4212     * "moved" - window that holds the canvas was moved
4213     */
4214
4215    /**
4216     * @defgroup Bg Bg
4217     *
4218     * @image html img/widget/bg/preview-00.png
4219     * @image latex img/widget/bg/preview-00.eps
4220     *
4221     * @brief Background object, used for setting a solid color, image or Edje
4222     * group as background to a window or any container object.
4223     *
4224     * The bg object is used for setting a solid background to a window or
4225     * packing into any container object. It works just like an image, but has
4226     * some properties useful to a background, like setting it to tiled,
4227     * centered, scaled or stretched.
4228     *
4229     * Here is some sample code using it:
4230     * @li @ref bg_01_example_page
4231     * @li @ref bg_02_example_page
4232     * @li @ref bg_03_example_page
4233     */
4234
4235    /* bg */
4236    typedef enum _Elm_Bg_Option
4237      {
4238         ELM_BG_OPTION_CENTER,  /**< center the background */
4239         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4240         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4241         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4242      } Elm_Bg_Option;
4243
4244    /**
4245     * Add a new background to the parent
4246     *
4247     * @param parent The parent object
4248     * @return The new object or NULL if it cannot be created
4249     *
4250     * @ingroup Bg
4251     */
4252    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4253
4254    /**
4255     * Set the file (image or edje) used for the background
4256     *
4257     * @param obj The bg object
4258     * @param file The file path
4259     * @param group Optional key (group in Edje) within the file
4260     *
4261     * This sets the image file used in the background object. The image (or edje)
4262     * will be stretched (retaining aspect if its an image file) to completely fill
4263     * the bg object. This may mean some parts are not visible.
4264     *
4265     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4266     * even if @p file is NULL.
4267     *
4268     * @ingroup Bg
4269     */
4270    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4271
4272    /**
4273     * Get the file (image or edje) used for the background
4274     *
4275     * @param obj The bg object
4276     * @param file The file path
4277     * @param group Optional key (group in Edje) within the file
4278     *
4279     * @ingroup Bg
4280     */
4281    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4282
4283    /**
4284     * Set the option used for the background image
4285     *
4286     * @param obj The bg object
4287     * @param option The desired background option (TILE, SCALE)
4288     *
4289     * This sets the option used for manipulating the display of the background
4290     * image. The image can be tiled or scaled.
4291     *
4292     * @ingroup Bg
4293     */
4294    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4295
4296    /**
4297     * Get the option used for the background image
4298     *
4299     * @param obj The bg object
4300     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4301     *
4302     * @ingroup Bg
4303     */
4304    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4305    /**
4306     * Set the option used for the background color
4307     *
4308     * @param obj The bg object
4309     * @param r
4310     * @param g
4311     * @param b
4312     *
4313     * This sets the color used for the background rectangle. Its range goes
4314     * from 0 to 255.
4315     *
4316     * @ingroup Bg
4317     */
4318    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4319    /**
4320     * Get the option used for the background color
4321     *
4322     * @param obj The bg object
4323     * @param r
4324     * @param g
4325     * @param b
4326     *
4327     * @ingroup Bg
4328     */
4329    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4330
4331    /**
4332     * Set the overlay object used for the background object.
4333     *
4334     * @param obj The bg object
4335     * @param overlay The overlay object
4336     *
4337     * This provides a way for elm_bg to have an 'overlay' that will be on top
4338     * of the bg. Once the over object is set, a previously set one will be
4339     * deleted, even if you set the new one to NULL. If you want to keep that
4340     * old content object, use the elm_bg_overlay_unset() function.
4341     *
4342     * @ingroup Bg
4343     */
4344
4345    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4346
4347    /**
4348     * Get the overlay object used for the background object.
4349     *
4350     * @param obj The bg object
4351     * @return The content that is being used
4352     *
4353     * Return the content object which is set for this widget
4354     *
4355     * @ingroup Bg
4356     */
4357    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4358
4359    /**
4360     * Get the overlay object used for the background object.
4361     *
4362     * @param obj The bg object
4363     * @return The content that was being used
4364     *
4365     * Unparent and return the overlay object which was set for this widget
4366     *
4367     * @ingroup Bg
4368     */
4369    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4370
4371    /**
4372     * Set the size of the pixmap representation of the image.
4373     *
4374     * This option just makes sense if an image is going to be set in the bg.
4375     *
4376     * @param obj The bg object
4377     * @param w The new width of the image pixmap representation.
4378     * @param h The new height of the image pixmap representation.
4379     *
4380     * This function sets a new size for pixmap representation of the given bg
4381     * image. It allows the image to be loaded already in the specified size,
4382     * reducing the memory usage and load time when loading a big image with load
4383     * size set to a smaller size.
4384     *
4385     * NOTE: this is just a hint, the real size of the pixmap may differ
4386     * depending on the type of image being loaded, being bigger than requested.
4387     *
4388     * @ingroup Bg
4389     */
4390    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4391    /* smart callbacks called:
4392     */
4393
4394    /**
4395     * @defgroup Icon Icon
4396     *
4397     * @image html img/widget/icon/preview-00.png
4398     * @image latex img/widget/icon/preview-00.eps
4399     *
4400     * An object that provides standard icon images (delete, edit, arrows, etc.)
4401     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4402     *
4403     * The icon image requested can be in the elementary theme, or in the
4404     * freedesktop.org paths. It's possible to set the order of preference from
4405     * where the image will be used.
4406     *
4407     * This API is very similar to @ref Image, but with ready to use images.
4408     *
4409     * Default images provided by the theme are described below.
4410     *
4411     * The first list contains icons that were first intended to be used in
4412     * toolbars, but can be used in many other places too:
4413     * @li home
4414     * @li close
4415     * @li apps
4416     * @li arrow_up
4417     * @li arrow_down
4418     * @li arrow_left
4419     * @li arrow_right
4420     * @li chat
4421     * @li clock
4422     * @li delete
4423     * @li edit
4424     * @li refresh
4425     * @li folder
4426     * @li file
4427     *
4428     * Now some icons that were designed to be used in menus (but again, you can
4429     * use them anywhere else):
4430     * @li menu/home
4431     * @li menu/close
4432     * @li menu/apps
4433     * @li menu/arrow_up
4434     * @li menu/arrow_down
4435     * @li menu/arrow_left
4436     * @li menu/arrow_right
4437     * @li menu/chat
4438     * @li menu/clock
4439     * @li menu/delete
4440     * @li menu/edit
4441     * @li menu/refresh
4442     * @li menu/folder
4443     * @li menu/file
4444     *
4445     * And here we have some media player specific icons:
4446     * @li media_player/forward
4447     * @li media_player/info
4448     * @li media_player/next
4449     * @li media_player/pause
4450     * @li media_player/play
4451     * @li media_player/prev
4452     * @li media_player/rewind
4453     * @li media_player/stop
4454     *
4455     * Signals that you can add callbacks for are:
4456     *
4457     * "clicked" - This is called when a user has clicked the icon
4458     *
4459     * An example of usage for this API follows:
4460     * @li @ref tutorial_icon
4461     */
4462
4463    /**
4464     * @addtogroup Icon
4465     * @{
4466     */
4467
4468    typedef enum _Elm_Icon_Type
4469      {
4470         ELM_ICON_NONE,
4471         ELM_ICON_FILE,
4472         ELM_ICON_STANDARD
4473      } Elm_Icon_Type;
4474    /**
4475     * @enum _Elm_Icon_Lookup_Order
4476     * @typedef Elm_Icon_Lookup_Order
4477     *
4478     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4479     * theme, FDO paths, or both?
4480     *
4481     * @ingroup Icon
4482     */
4483    typedef enum _Elm_Icon_Lookup_Order
4484      {
4485         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4486         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4487         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4488         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4489      } Elm_Icon_Lookup_Order;
4490
4491    /**
4492     * Add a new icon object to the parent.
4493     *
4494     * @param parent The parent object
4495     * @return The new object or NULL if it cannot be created
4496     *
4497     * @see elm_icon_file_set()
4498     *
4499     * @ingroup Icon
4500     */
4501    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4502    /**
4503     * Set the file that will be used as icon.
4504     *
4505     * @param obj The icon object
4506     * @param file The path to file that will be used as icon image
4507     * @param group The group that the icon belongs to in edje file
4508     *
4509     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4510     *
4511     * @note The icon image set by this function can be changed by
4512     * elm_icon_standard_set().
4513     *
4514     * @see elm_icon_file_get()
4515     *
4516     * @ingroup Icon
4517     */
4518    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4519    /**
4520     * Set a location in memory to be used as an icon
4521     *
4522     * @param obj The icon object
4523     * @param img The binary data that will be used as an image
4524     * @param size The size of binary data @p img
4525     * @param format Optional format of @p img to pass to the image loader
4526     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4527     *
4528     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4529     *
4530     * @note The icon image set by this function can be changed by
4531     * elm_icon_standard_set().
4532     *
4533     * @ingroup Icon
4534     */
4535    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);
4536    /**
4537     * Get the file that will be used as icon.
4538     *
4539     * @param obj The icon object
4540     * @param file The path to file that will be used as icon icon image
4541     * @param group The group that the icon belongs to in edje file
4542     *
4543     * @see elm_icon_file_set()
4544     *
4545     * @ingroup Icon
4546     */
4547    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4548    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4549    /**
4550     * Set the icon by icon standards names.
4551     *
4552     * @param obj The icon object
4553     * @param name The icon name
4554     *
4555     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4556     *
4557     * For example, freedesktop.org defines standard icon names such as "home",
4558     * "network", etc. There can be different icon sets to match those icon
4559     * keys. The @p name given as parameter is one of these "keys", and will be
4560     * used to look in the freedesktop.org paths and elementary theme. One can
4561     * change the lookup order with elm_icon_order_lookup_set().
4562     *
4563     * If name is not found in any of the expected locations and it is the
4564     * absolute path of an image file, this image will be used.
4565     *
4566     * @note The icon image set by this function can be changed by
4567     * elm_icon_file_set().
4568     *
4569     * @see elm_icon_standard_get()
4570     * @see elm_icon_file_set()
4571     *
4572     * @ingroup Icon
4573     */
4574    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4575    /**
4576     * Get the icon name set by icon standard names.
4577     *
4578     * @param obj The icon object
4579     * @return The icon name
4580     *
4581     * If the icon image was set using elm_icon_file_set() instead of
4582     * elm_icon_standard_set(), then this function will return @c NULL.
4583     *
4584     * @see elm_icon_standard_set()
4585     *
4586     * @ingroup Icon
4587     */
4588    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4589    /**
4590     * Set the smooth effect for an icon object.
4591     *
4592     * @param obj The icon object
4593     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4594     * otherwise. Default is @c EINA_TRUE.
4595     *
4596     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4597     * scaling provides a better resulting image, but is slower.
4598     *
4599     * The smooth scaling should be disabled when making animations that change
4600     * the icon size, since they will be faster. Animations that don't require
4601     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4602     * is already scaled, since the scaled icon image will be cached).
4603     *
4604     * @see elm_icon_smooth_get()
4605     *
4606     * @ingroup Icon
4607     */
4608    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4609    /**
4610     * Get the smooth effect for an icon object.
4611     *
4612     * @param obj The icon object
4613     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4614     *
4615     * @see elm_icon_smooth_set()
4616     *
4617     * @ingroup Icon
4618     */
4619    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4620    /**
4621     * Disable scaling of this object.
4622     *
4623     * @param obj The icon object.
4624     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4625     * otherwise. Default is @c EINA_FALSE.
4626     *
4627     * This function disables scaling of the icon object through the function
4628     * elm_object_scale_set(). However, this does not affect the object
4629     * size/resize in any way. For that effect, take a look at
4630     * elm_icon_scale_set().
4631     *
4632     * @see elm_icon_no_scale_get()
4633     * @see elm_icon_scale_set()
4634     * @see elm_object_scale_set()
4635     *
4636     * @ingroup Icon
4637     */
4638    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4639    /**
4640     * Get whether scaling is disabled on the object.
4641     *
4642     * @param obj The icon object
4643     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4644     *
4645     * @see elm_icon_no_scale_set()
4646     *
4647     * @ingroup Icon
4648     */
4649    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4650    /**
4651     * Set if the object is (up/down) resizable.
4652     *
4653     * @param obj The icon object
4654     * @param scale_up A bool to set if the object is resizable up. Default is
4655     * @c EINA_TRUE.
4656     * @param scale_down A bool to set if the object is resizable down. Default
4657     * is @c EINA_TRUE.
4658     *
4659     * This function limits the icon object resize ability. If @p scale_up is set to
4660     * @c EINA_FALSE, the object can't have its height or width resized to a value
4661     * higher than the original icon size. Same is valid for @p scale_down.
4662     *
4663     * @see elm_icon_scale_get()
4664     *
4665     * @ingroup Icon
4666     */
4667    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4668    /**
4669     * Get if the object is (up/down) resizable.
4670     *
4671     * @param obj The icon object
4672     * @param scale_up A bool to set if the object is resizable up
4673     * @param scale_down A bool to set if the object is resizable down
4674     *
4675     * @see elm_icon_scale_set()
4676     *
4677     * @ingroup Icon
4678     */
4679    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4680    /**
4681     * Get the object's image size
4682     *
4683     * @param obj The icon object
4684     * @param w A pointer to store the width in
4685     * @param h A pointer to store the height in
4686     *
4687     * @ingroup Icon
4688     */
4689    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4690    /**
4691     * Set if the icon fill the entire object area.
4692     *
4693     * @param obj The icon object
4694     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4695     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4696     *
4697     * When the icon object is resized to a different aspect ratio from the
4698     * original icon image, the icon image will still keep its aspect. This flag
4699     * tells how the image should fill the object's area. They are: keep the
4700     * entire icon inside the limits of height and width of the object (@p
4701     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4702     * of the object, and the icon will fill the entire object (@p fill_outside
4703     * is @c EINA_TRUE).
4704     *
4705     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4706     * retain property to false. Thus, the icon image will always keep its
4707     * original aspect ratio.
4708     *
4709     * @see elm_icon_fill_outside_get()
4710     * @see elm_image_fill_outside_set()
4711     *
4712     * @ingroup Icon
4713     */
4714    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4715    /**
4716     * Get if the object is filled outside.
4717     *
4718     * @param obj The icon object
4719     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4720     *
4721     * @see elm_icon_fill_outside_set()
4722     *
4723     * @ingroup Icon
4724     */
4725    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4726    /**
4727     * Set the prescale size for the icon.
4728     *
4729     * @param obj The icon object
4730     * @param size The prescale size. This value is used for both width and
4731     * height.
4732     *
4733     * This function sets a new size for pixmap representation of the given
4734     * icon. It allows the icon to be loaded already in the specified size,
4735     * reducing the memory usage and load time when loading a big icon with load
4736     * size set to a smaller size.
4737     *
4738     * It's equivalent to the elm_bg_load_size_set() function for bg.
4739     *
4740     * @note this is just a hint, the real size of the pixmap may differ
4741     * depending on the type of icon being loaded, being bigger than requested.
4742     *
4743     * @see elm_icon_prescale_get()
4744     * @see elm_bg_load_size_set()
4745     *
4746     * @ingroup Icon
4747     */
4748    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4749    /**
4750     * Get the prescale size for the icon.
4751     *
4752     * @param obj The icon object
4753     * @return The prescale size
4754     *
4755     * @see elm_icon_prescale_set()
4756     *
4757     * @ingroup Icon
4758     */
4759    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4760    /**
4761     * Sets the icon lookup order used by elm_icon_standard_set().
4762     *
4763     * @param obj The icon object
4764     * @param order The icon lookup order (can be one of
4765     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4766     * or ELM_ICON_LOOKUP_THEME)
4767     *
4768     * @see elm_icon_order_lookup_get()
4769     * @see Elm_Icon_Lookup_Order
4770     *
4771     * @ingroup Icon
4772     */
4773    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4774    /**
4775     * Gets the icon lookup order.
4776     *
4777     * @param obj The icon object
4778     * @return The icon lookup order
4779     *
4780     * @see elm_icon_order_lookup_set()
4781     * @see Elm_Icon_Lookup_Order
4782     *
4783     * @ingroup Icon
4784     */
4785    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4786    /**
4787     * Get if the icon supports animation or not.
4788     *
4789     * @param obj The icon object
4790     * @return @c EINA_TRUE if the icon supports animation,
4791     *         @c EINA_FALSE otherwise.
4792     *
4793     * Return if this elm icon's image can be animated. Currently Evas only
4794     * supports gif animation. If the return value is EINA_FALSE, other
4795     * elm_icon_animated_XXX APIs won't work.
4796     * @ingroup Icon
4797     */
4798    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4799    /**
4800     * Set animation mode of the icon.
4801     *
4802     * @param obj The icon object
4803     * @param anim @c EINA_TRUE if the object do animation job,
4804     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4805     *
4806     * Even though elm icon's file can be animated,
4807     * sometimes appication developer want to just first page of image.
4808     * In that time, don't call this function, because default value is EINA_FALSE
4809     * Only when you want icon support anition,
4810     * use this function and set animated to EINA_TURE
4811     * @ingroup Icon
4812     */
4813    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4814    /**
4815     * Get animation mode of the icon.
4816     *
4817     * @param obj The icon object
4818     * @return The animation mode of the icon object
4819     * @see elm_icon_animated_set
4820     * @ingroup Icon
4821     */
4822    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4823    /**
4824     * Set animation play mode of the icon.
4825     *
4826     * @param obj The icon object
4827     * @param play @c EINA_TRUE the object play animation images,
4828     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4829     *
4830     * If you want to play elm icon's animation, you set play to EINA_TURE.
4831     * For example, you make gif player using this set/get API and click event.
4832     *
4833     * 1. Click event occurs
4834     * 2. Check play flag using elm_icon_animaged_play_get
4835     * 3. If elm icon was playing, set play to EINA_FALSE.
4836     *    Then animation will be stopped and vice versa
4837     * @ingroup Icon
4838     */
4839    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4840    /**
4841     * Get animation play mode of the icon.
4842     *
4843     * @param obj The icon object
4844     * @return The play mode of the icon object
4845     *
4846     * @see elm_icon_animated_lay_get
4847     * @ingroup Icon
4848     */
4849    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4850
4851    /**
4852     * @}
4853     */
4854
4855    /**
4856     * @defgroup Image Image
4857     *
4858     * @image html img/widget/image/preview-00.png
4859     * @image latex img/widget/image/preview-00.eps
4860
4861     *
4862     * An object that allows one to load an image file to it. It can be used
4863     * anywhere like any other elementary widget.
4864     *
4865     * This widget provides most of the functionality provided from @ref Bg or @ref
4866     * Icon, but with a slightly different API (use the one that fits better your
4867     * needs).
4868     *
4869     * The features not provided by those two other image widgets are:
4870     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4871     * @li change the object orientation with elm_image_orient_set();
4872     * @li and turning the image editable with elm_image_editable_set().
4873     *
4874     * Signals that you can add callbacks for are:
4875     *
4876     * @li @c "clicked" - This is called when a user has clicked the image
4877     *
4878     * An example of usage for this API follows:
4879     * @li @ref tutorial_image
4880     */
4881
4882    /**
4883     * @addtogroup Image
4884     * @{
4885     */
4886
4887    /**
4888     * @enum _Elm_Image_Orient
4889     * @typedef Elm_Image_Orient
4890     *
4891     * Possible orientation options for elm_image_orient_set().
4892     *
4893     * @image html elm_image_orient_set.png
4894     * @image latex elm_image_orient_set.eps width=\textwidth
4895     *
4896     * @ingroup Image
4897     */
4898    typedef enum _Elm_Image_Orient
4899      {
4900         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4901         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4902         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4903         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4904         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4905         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4906         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4907         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4908      } Elm_Image_Orient;
4909
4910    /**
4911     * Add a new image to the parent.
4912     *
4913     * @param parent The parent object
4914     * @return The new object or NULL if it cannot be created
4915     *
4916     * @see elm_image_file_set()
4917     *
4918     * @ingroup Image
4919     */
4920    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4921    /**
4922     * Set the file that will be used as image.
4923     *
4924     * @param obj The image object
4925     * @param file The path to file that will be used as image
4926     * @param group The group that the image belongs in edje file (if it's an
4927     * edje image)
4928     *
4929     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4930     *
4931     * @see elm_image_file_get()
4932     *
4933     * @ingroup Image
4934     */
4935    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4936    /**
4937     * Get the file that will be used as image.
4938     *
4939     * @param obj The image object
4940     * @param file The path to file
4941     * @param group The group that the image belongs in edje file
4942     *
4943     * @see elm_image_file_set()
4944     *
4945     * @ingroup Image
4946     */
4947    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4948    /**
4949     * Set the smooth effect for an image.
4950     *
4951     * @param obj The image object
4952     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4953     * otherwise. Default is @c EINA_TRUE.
4954     *
4955     * Set the scaling algorithm to be used when scaling the image. Smooth
4956     * scaling provides a better resulting image, but is slower.
4957     *
4958     * The smooth scaling should be disabled when making animations that change
4959     * the image size, since it will be faster. Animations that don't require
4960     * resizing of the image can keep the smooth scaling enabled (even if the
4961     * image is already scaled, since the scaled image will be cached).
4962     *
4963     * @see elm_image_smooth_get()
4964     *
4965     * @ingroup Image
4966     */
4967    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4968    /**
4969     * Get the smooth effect for an image.
4970     *
4971     * @param obj The image object
4972     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4973     *
4974     * @see elm_image_smooth_get()
4975     *
4976     * @ingroup Image
4977     */
4978    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4979    /**
4980     * Gets the current size of the image.
4981     *
4982     * @param obj The image object.
4983     * @param w Pointer to store width, or NULL.
4984     * @param h Pointer to store height, or NULL.
4985     *
4986     * This is the real size of the image, not the size of the object.
4987     *
4988     * On error, neither w or h will be written.
4989     *
4990     * @ingroup Image
4991     */
4992    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4993    /**
4994     * Disable scaling of this object.
4995     *
4996     * @param obj The image object.
4997     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4998     * otherwise. Default is @c EINA_FALSE.
4999     *
5000     * This function disables scaling of the elm_image widget through the
5001     * function elm_object_scale_set(). However, this does not affect the widget
5002     * size/resize in any way. For that effect, take a look at
5003     * elm_image_scale_set().
5004     *
5005     * @see elm_image_no_scale_get()
5006     * @see elm_image_scale_set()
5007     * @see elm_object_scale_set()
5008     *
5009     * @ingroup Image
5010     */
5011    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5012    /**
5013     * Get whether scaling is disabled on the object.
5014     *
5015     * @param obj The image object
5016     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5017     *
5018     * @see elm_image_no_scale_set()
5019     *
5020     * @ingroup Image
5021     */
5022    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5023    /**
5024     * Set if the object is (up/down) resizable.
5025     *
5026     * @param obj The image object
5027     * @param scale_up A bool to set if the object is resizable up. Default is
5028     * @c EINA_TRUE.
5029     * @param scale_down A bool to set if the object is resizable down. Default
5030     * is @c EINA_TRUE.
5031     *
5032     * This function limits the image resize ability. If @p scale_up is set to
5033     * @c EINA_FALSE, the object can't have its height or width resized to a value
5034     * higher than the original image size. Same is valid for @p scale_down.
5035     *
5036     * @see elm_image_scale_get()
5037     *
5038     * @ingroup Image
5039     */
5040    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5041    /**
5042     * Get if the object is (up/down) resizable.
5043     *
5044     * @param obj The image object
5045     * @param scale_up A bool to set if the object is resizable up
5046     * @param scale_down A bool to set if the object is resizable down
5047     *
5048     * @see elm_image_scale_set()
5049     *
5050     * @ingroup Image
5051     */
5052    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5053    /**
5054     * Set if the image fill the entire object area when keeping the aspect ratio.
5055     *
5056     * @param obj The image object
5057     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5058     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5059     *
5060     * When the image should keep its aspect ratio even if resized to another
5061     * aspect ratio, there are two possibilities to resize it: keep the entire
5062     * image inside the limits of height and width of the object (@p fill_outside
5063     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5064     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5065     *
5066     * @note This option will have no effect if
5067     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5068     *
5069     * @see elm_image_fill_outside_get()
5070     * @see elm_image_aspect_ratio_retained_set()
5071     *
5072     * @ingroup Image
5073     */
5074    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5075    /**
5076     * Get if the object is filled outside
5077     *
5078     * @param obj The image object
5079     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5080     *
5081     * @see elm_image_fill_outside_set()
5082     *
5083     * @ingroup Image
5084     */
5085    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5086    /**
5087     * Set the prescale size for the image
5088     *
5089     * @param obj The image object
5090     * @param size The prescale size. This value is used for both width and
5091     * height.
5092     *
5093     * This function sets a new size for pixmap representation of the given
5094     * image. It allows the image to be loaded already in the specified size,
5095     * reducing the memory usage and load time when loading a big image with load
5096     * size set to a smaller size.
5097     *
5098     * It's equivalent to the elm_bg_load_size_set() function for bg.
5099     *
5100     * @note this is just a hint, the real size of the pixmap may differ
5101     * depending on the type of image being loaded, being bigger than requested.
5102     *
5103     * @see elm_image_prescale_get()
5104     * @see elm_bg_load_size_set()
5105     *
5106     * @ingroup Image
5107     */
5108    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5109    /**
5110     * Get the prescale size for the image
5111     *
5112     * @param obj The image object
5113     * @return The prescale size
5114     *
5115     * @see elm_image_prescale_set()
5116     *
5117     * @ingroup Image
5118     */
5119    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5120    /**
5121     * Set the image orientation.
5122     *
5123     * @param obj The image object
5124     * @param orient The image orientation
5125     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5126     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5127     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5128     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5129     *  Default is #ELM_IMAGE_ORIENT_NONE.
5130     *
5131     * This function allows to rotate or flip the given image.
5132     *
5133     * @see elm_image_orient_get()
5134     * @see @ref Elm_Image_Orient
5135     *
5136     * @ingroup Image
5137     */
5138    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5139    /**
5140     * Get the image orientation.
5141     *
5142     * @param obj The image object
5143     * @return The image orientation
5144     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5145     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5146     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5147     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5148     *
5149     * @see elm_image_orient_set()
5150     * @see @ref Elm_Image_Orient
5151     *
5152     * @ingroup Image
5153     */
5154    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5155    /**
5156     * Make the image 'editable'.
5157     *
5158     * @param obj Image object.
5159     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5160     *
5161     * This means the image is a valid drag target for drag and drop, and can be
5162     * cut or pasted too.
5163     *
5164     * @ingroup Image
5165     */
5166    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5167    /**
5168     * Make the image 'editable'.
5169     *
5170     * @param obj Image object.
5171     * @return Editability.
5172     *
5173     * This means the image is a valid drag target for drag and drop, and can be
5174     * cut or pasted too.
5175     *
5176     * @ingroup Image
5177     */
5178    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5179    /**
5180     * Get the basic Evas_Image object from this object (widget).
5181     *
5182     * @param obj The image object to get the inlined image from
5183     * @return The inlined image object, or NULL if none exists
5184     *
5185     * This function allows one to get the underlying @c Evas_Object of type
5186     * Image from this elementary widget. It can be useful to do things like get
5187     * the pixel data, save the image to a file, etc.
5188     *
5189     * @note Be careful to not manipulate it, as it is under control of
5190     * elementary.
5191     *
5192     * @ingroup Image
5193     */
5194    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5195    /**
5196     * Set whether the original aspect ratio of the image should be kept on resize.
5197     *
5198     * @param obj The image object.
5199     * @param retained @c EINA_TRUE if the image should retain the aspect,
5200     * @c EINA_FALSE otherwise.
5201     *
5202     * The original aspect ratio (width / height) of the image is usually
5203     * distorted to match the object's size. Enabling this option will retain
5204     * this original aspect, and the way that the image is fit into the object's
5205     * area depends on the option set by elm_image_fill_outside_set().
5206     *
5207     * @see elm_image_aspect_ratio_retained_get()
5208     * @see elm_image_fill_outside_set()
5209     *
5210     * @ingroup Image
5211     */
5212    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5213    /**
5214     * Get if the object retains the original aspect ratio.
5215     *
5216     * @param obj The image object.
5217     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5218     * otherwise.
5219     *
5220     * @ingroup Image
5221     */
5222    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5223
5224    /* smart callbacks called:
5225     * "clicked" - the user clicked the image
5226     */
5227
5228    /**
5229     * @}
5230     */
5231
5232    /* glview */
5233    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5234
5235    typedef enum _Elm_GLView_Mode
5236      {
5237         ELM_GLVIEW_ALPHA   = 1,
5238         ELM_GLVIEW_DEPTH   = 2,
5239         ELM_GLVIEW_STENCIL = 4
5240      } Elm_GLView_Mode;
5241
5242    /**
5243     * Defines a policy for the glview resizing.
5244     *
5245     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5246     */
5247    typedef enum _Elm_GLView_Resize_Policy
5248      {
5249         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5250         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5251      } Elm_GLView_Resize_Policy;
5252
5253    typedef enum _Elm_GLView_Render_Policy
5254      {
5255         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5256         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5257      } Elm_GLView_Render_Policy;
5258
5259    /**
5260     * @defgroup GLView
5261     *
5262     * A simple GLView widget that allows GL rendering.
5263     *
5264     * Signals that you can add callbacks for are:
5265     *
5266     * @{
5267     */
5268
5269    /**
5270     * Add a new glview to the parent
5271     *
5272     * @param parent The parent object
5273     * @return The new object or NULL if it cannot be created
5274     *
5275     * @ingroup GLView
5276     */
5277    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5278
5279    /**
5280     * Sets the size of the glview
5281     *
5282     * @param obj The glview object
5283     * @param width width of the glview object
5284     * @param height height of the glview object
5285     *
5286     * @ingroup GLView
5287     */
5288    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5289
5290    /**
5291     * Gets the size of the glview.
5292     *
5293     * @param obj The glview object
5294     * @param width width of the glview object
5295     * @param height height of the glview object
5296     *
5297     * Note that this function returns the actual image size of the
5298     * glview.  This means that when the scale policy is set to
5299     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5300     * size.
5301     *
5302     * @ingroup GLView
5303     */
5304    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5305
5306    /**
5307     * Gets the gl api struct for gl rendering
5308     *
5309     * @param obj The glview object
5310     * @return The api object or NULL if it cannot be created
5311     *
5312     * @ingroup GLView
5313     */
5314    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5315
5316    /**
5317     * Set the mode of the GLView. Supports Three simple modes.
5318     *
5319     * @param obj The glview object
5320     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5321     * @return True if set properly.
5322     *
5323     * @ingroup GLView
5324     */
5325    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5326
5327    /**
5328     * Set the resize policy for the glview object.
5329     *
5330     * @param obj The glview object.
5331     * @param policy The scaling policy.
5332     *
5333     * By default, the resize policy is set to
5334     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5335     * destroys the previous surface and recreates the newly specified
5336     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5337     * however, glview only scales the image object and not the underlying
5338     * GL Surface.
5339     *
5340     * @ingroup GLView
5341     */
5342    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5343
5344    /**
5345     * Set the render policy for the glview object.
5346     *
5347     * @param obj The glview object.
5348     * @param policy The render policy.
5349     *
5350     * By default, the render policy is set to
5351     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5352     * that during the render loop, glview is only redrawn if it needs
5353     * to be redrawn. (i.e. When it is visible) If the policy is set to
5354     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5355     * whether it is visible/need redrawing or not.
5356     *
5357     * @ingroup GLView
5358     */
5359    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5360
5361    /**
5362     * Set the init function that runs once in the main loop.
5363     *
5364     * @param obj The glview object.
5365     * @param func The init function to be registered.
5366     *
5367     * The registered init function gets called once during the render loop.
5368     *
5369     * @ingroup GLView
5370     */
5371    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5372
5373    /**
5374     * Set the render function that runs in the main loop.
5375     *
5376     * @param obj The glview object.
5377     * @param func The delete function to be registered.
5378     *
5379     * The registered del function gets called when GLView object is deleted.
5380     *
5381     * @ingroup GLView
5382     */
5383    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5384
5385    /**
5386     * Set the resize function that gets called when resize happens.
5387     *
5388     * @param obj The glview object.
5389     * @param func The resize function to be registered.
5390     *
5391     * @ingroup GLView
5392     */
5393    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5394
5395    /**
5396     * Set the render function that runs in the main loop.
5397     *
5398     * @param obj The glview object.
5399     * @param func The render function to be registered.
5400     *
5401     * @ingroup GLView
5402     */
5403    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5404
5405    /**
5406     * Notifies that there has been changes in the GLView.
5407     *
5408     * @param obj The glview object.
5409     *
5410     * @ingroup GLView
5411     */
5412    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5413
5414    /**
5415     * @}
5416     */
5417
5418    /* box */
5419    /**
5420     * @defgroup Box Box
5421     *
5422     * @image html img/widget/box/preview-00.png
5423     * @image latex img/widget/box/preview-00.eps width=\textwidth
5424     *
5425     * @image html img/box.png
5426     * @image latex img/box.eps width=\textwidth
5427     *
5428     * A box arranges objects in a linear fashion, governed by a layout function
5429     * that defines the details of this arrangement.
5430     *
5431     * By default, the box will use an internal function to set the layout to
5432     * a single row, either vertical or horizontal. This layout is affected
5433     * by a number of parameters, such as the homogeneous flag set by
5434     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5435     * elm_box_align_set() and the hints set to each object in the box.
5436     *
5437     * For this default layout, it's possible to change the orientation with
5438     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5439     * placing its elements ordered from top to bottom. When horizontal is set,
5440     * the order will go from left to right. If the box is set to be
5441     * homogeneous, every object in it will be assigned the same space, that
5442     * of the largest object. Padding can be used to set some spacing between
5443     * the cell given to each object. The alignment of the box, set with
5444     * elm_box_align_set(), determines how the bounding box of all the elements
5445     * will be placed within the space given to the box widget itself.
5446     *
5447     * The size hints of each object also affect how they are placed and sized
5448     * within the box. evas_object_size_hint_min_set() will give the minimum
5449     * size the object can have, and the box will use it as the basis for all
5450     * latter calculations. Elementary widgets set their own minimum size as
5451     * needed, so there's rarely any need to use it manually.
5452     *
5453     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5454     * used to tell whether the object will be allocated the minimum size it
5455     * needs or if the space given to it should be expanded. It's important
5456     * to realize that expanding the size given to the object is not the same
5457     * thing as resizing the object. It could very well end being a small
5458     * widget floating in a much larger empty space. If not set, the weight
5459     * for objects will normally be 0.0 for both axis, meaning the widget will
5460     * not be expanded. To take as much space possible, set the weight to
5461     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5462     *
5463     * Besides how much space each object is allocated, it's possible to control
5464     * how the widget will be placed within that space using
5465     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5466     * for both axis, meaning the object will be centered, but any value from
5467     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5468     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5469     * is -1.0, means the object will be resized to fill the entire space it
5470     * was allocated.
5471     *
5472     * In addition, customized functions to define the layout can be set, which
5473     * allow the application developer to organize the objects within the box
5474     * in any number of ways.
5475     *
5476     * The special elm_box_layout_transition() function can be used
5477     * to switch from one layout to another, animating the motion of the
5478     * children of the box.
5479     *
5480     * @note Objects should not be added to box objects using _add() calls.
5481     *
5482     * Some examples on how to use boxes follow:
5483     * @li @ref box_example_01
5484     * @li @ref box_example_02
5485     *
5486     * @{
5487     */
5488    /**
5489     * @typedef Elm_Box_Transition
5490     *
5491     * Opaque handler containing the parameters to perform an animated
5492     * transition of the layout the box uses.
5493     *
5494     * @see elm_box_transition_new()
5495     * @see elm_box_layout_set()
5496     * @see elm_box_layout_transition()
5497     */
5498    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5499
5500    /**
5501     * Add a new box to the parent
5502     *
5503     * By default, the box will be in vertical mode and non-homogeneous.
5504     *
5505     * @param parent The parent object
5506     * @return The new object or NULL if it cannot be created
5507     */
5508    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5509    /**
5510     * Set the horizontal orientation
5511     *
5512     * By default, box object arranges their contents vertically from top to
5513     * bottom.
5514     * By calling this function with @p horizontal as EINA_TRUE, the box will
5515     * become horizontal, arranging contents from left to right.
5516     *
5517     * @note This flag is ignored if a custom layout function is set.
5518     *
5519     * @param obj The box object
5520     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5521     * EINA_FALSE = vertical)
5522     */
5523    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5524    /**
5525     * Get the horizontal orientation
5526     *
5527     * @param obj The box object
5528     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5529     */
5530    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5531    /**
5532     * Set the box to arrange its children homogeneously
5533     *
5534     * If enabled, homogeneous layout makes all items the same size, according
5535     * to the size of the largest of its children.
5536     *
5537     * @note This flag is ignored if a custom layout function is set.
5538     *
5539     * @param obj The box object
5540     * @param homogeneous The homogeneous flag
5541     */
5542    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5543    /**
5544     * Get whether the box is using homogeneous mode or not
5545     *
5546     * @param obj The box object
5547     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5548     */
5549    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5550    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5551    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5552    /**
5553     * Add an object to the beginning of the pack list
5554     *
5555     * Pack @p subobj into the box @p obj, placing it first in the list of
5556     * children objects. The actual position the object will get on screen
5557     * depends on the layout used. If no custom layout is set, it will be at
5558     * the top or left, depending if the box is vertical or horizontal,
5559     * respectively.
5560     *
5561     * @param obj The box object
5562     * @param subobj The object to add to the box
5563     *
5564     * @see elm_box_pack_end()
5565     * @see elm_box_pack_before()
5566     * @see elm_box_pack_after()
5567     * @see elm_box_unpack()
5568     * @see elm_box_unpack_all()
5569     * @see elm_box_clear()
5570     */
5571    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5572    /**
5573     * Add an object at the end of the pack list
5574     *
5575     * Pack @p subobj into the box @p obj, placing it last in the list of
5576     * children objects. The actual position the object will get on screen
5577     * depends on the layout used. If no custom layout is set, it will be at
5578     * the bottom or right, depending if the box is vertical or horizontal,
5579     * respectively.
5580     *
5581     * @param obj The box object
5582     * @param subobj The object to add to the box
5583     *
5584     * @see elm_box_pack_start()
5585     * @see elm_box_pack_before()
5586     * @see elm_box_pack_after()
5587     * @see elm_box_unpack()
5588     * @see elm_box_unpack_all()
5589     * @see elm_box_clear()
5590     */
5591    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5592    /**
5593     * Adds an object to the box before the indicated object
5594     *
5595     * This will add the @p subobj to the box indicated before the object
5596     * indicated with @p before. If @p before is not already in the box, results
5597     * are undefined. Before means either to the left of the indicated object or
5598     * above it depending on orientation.
5599     *
5600     * @param obj The box object
5601     * @param subobj The object to add to the box
5602     * @param before The object before which to add it
5603     *
5604     * @see elm_box_pack_start()
5605     * @see elm_box_pack_end()
5606     * @see elm_box_pack_after()
5607     * @see elm_box_unpack()
5608     * @see elm_box_unpack_all()
5609     * @see elm_box_clear()
5610     */
5611    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5612    /**
5613     * Adds an object to the box after the indicated object
5614     *
5615     * This will add the @p subobj to the box indicated after the object
5616     * indicated with @p after. If @p after is not already in the box, results
5617     * are undefined. After means either to the right of the indicated object or
5618     * below it depending on orientation.
5619     *
5620     * @param obj The box object
5621     * @param subobj The object to add to the box
5622     * @param after The object after which to add it
5623     *
5624     * @see elm_box_pack_start()
5625     * @see elm_box_pack_end()
5626     * @see elm_box_pack_before()
5627     * @see elm_box_unpack()
5628     * @see elm_box_unpack_all()
5629     * @see elm_box_clear()
5630     */
5631    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5632    /**
5633     * Clear the box of all children
5634     *
5635     * Remove all the elements contained by the box, deleting the respective
5636     * objects.
5637     *
5638     * @param obj The box object
5639     *
5640     * @see elm_box_unpack()
5641     * @see elm_box_unpack_all()
5642     */
5643    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5644    /**
5645     * Unpack a box item
5646     *
5647     * Remove the object given by @p subobj from the box @p obj without
5648     * deleting it.
5649     *
5650     * @param obj The box object
5651     *
5652     * @see elm_box_unpack_all()
5653     * @see elm_box_clear()
5654     */
5655    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5656    /**
5657     * Remove all items from the box, without deleting them
5658     *
5659     * Clear the box from all children, but don't delete the respective objects.
5660     * If no other references of the box children exist, the objects will never
5661     * be deleted, and thus the application will leak the memory. Make sure
5662     * when using this function that you hold a reference to all the objects
5663     * in the box @p obj.
5664     *
5665     * @param obj The box object
5666     *
5667     * @see elm_box_clear()
5668     * @see elm_box_unpack()
5669     */
5670    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5671    /**
5672     * Retrieve a list of the objects packed into the box
5673     *
5674     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5675     * The order of the list corresponds to the packing order the box uses.
5676     *
5677     * You must free this list with eina_list_free() once you are done with it.
5678     *
5679     * @param obj The box object
5680     */
5681    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5682    /**
5683     * Set the space (padding) between the box's elements.
5684     *
5685     * Extra space in pixels that will be added between a box child and its
5686     * neighbors after its containing cell has been calculated. This padding
5687     * is set for all elements in the box, besides any possible padding that
5688     * individual elements may have through their size hints.
5689     *
5690     * @param obj The box object
5691     * @param horizontal The horizontal space between elements
5692     * @param vertical The vertical space between elements
5693     */
5694    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5695    /**
5696     * Get the space (padding) between the box's elements.
5697     *
5698     * @param obj The box object
5699     * @param horizontal The horizontal space between elements
5700     * @param vertical The vertical space between elements
5701     *
5702     * @see elm_box_padding_set()
5703     */
5704    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5705    /**
5706     * Set the alignment of the whole bouding box of contents.
5707     *
5708     * Sets how the bounding box containing all the elements of the box, after
5709     * their sizes and position has been calculated, will be aligned within
5710     * the space given for the whole box widget.
5711     *
5712     * @param obj The box object
5713     * @param horizontal The horizontal alignment of elements
5714     * @param vertical The vertical alignment of elements
5715     */
5716    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5717    /**
5718     * Get the alignment of the whole bouding box of contents.
5719     *
5720     * @param obj The box object
5721     * @param horizontal The horizontal alignment of elements
5722     * @param vertical The vertical alignment of elements
5723     *
5724     * @see elm_box_align_set()
5725     */
5726    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5727
5728    /**
5729     * Set the layout defining function to be used by the box
5730     *
5731     * Whenever anything changes that requires the box in @p obj to recalculate
5732     * the size and position of its elements, the function @p cb will be called
5733     * to determine what the layout of the children will be.
5734     *
5735     * Once a custom function is set, everything about the children layout
5736     * is defined by it. The flags set by elm_box_horizontal_set() and
5737     * elm_box_homogeneous_set() no longer have any meaning, and the values
5738     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5739     * layout function to decide if they are used and how. These last two
5740     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5741     * passed to @p cb. The @c Evas_Object the function receives is not the
5742     * Elementary widget, but the internal Evas Box it uses, so none of the
5743     * functions described here can be used on it.
5744     *
5745     * Any of the layout functions in @c Evas can be used here, as well as the
5746     * special elm_box_layout_transition().
5747     *
5748     * The final @p data argument received by @p cb is the same @p data passed
5749     * here, and the @p free_data function will be called to free it
5750     * whenever the box is destroyed or another layout function is set.
5751     *
5752     * Setting @p cb to NULL will revert back to the default layout function.
5753     *
5754     * @param obj The box object
5755     * @param cb The callback function used for layout
5756     * @param data Data that will be passed to layout function
5757     * @param free_data Function called to free @p data
5758     *
5759     * @see elm_box_layout_transition()
5760     */
5761    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);
5762    /**
5763     * Special layout function that animates the transition from one layout to another
5764     *
5765     * Normally, when switching the layout function for a box, this will be
5766     * reflected immediately on screen on the next render, but it's also
5767     * possible to do this through an animated transition.
5768     *
5769     * This is done by creating an ::Elm_Box_Transition and setting the box
5770     * layout to this function.
5771     *
5772     * For example:
5773     * @code
5774     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5775     *                            evas_object_box_layout_vertical, // start
5776     *                            NULL, // data for initial layout
5777     *                            NULL, // free function for initial data
5778     *                            evas_object_box_layout_horizontal, // end
5779     *                            NULL, // data for final layout
5780     *                            NULL, // free function for final data
5781     *                            anim_end, // will be called when animation ends
5782     *                            NULL); // data for anim_end function\
5783     * elm_box_layout_set(box, elm_box_layout_transition, t,
5784     *                    elm_box_transition_free);
5785     * @endcode
5786     *
5787     * @note This function can only be used with elm_box_layout_set(). Calling
5788     * it directly will not have the expected results.
5789     *
5790     * @see elm_box_transition_new
5791     * @see elm_box_transition_free
5792     * @see elm_box_layout_set
5793     */
5794    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5795    /**
5796     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5797     *
5798     * If you want to animate the change from one layout to another, you need
5799     * to set the layout function of the box to elm_box_layout_transition(),
5800     * passing as user data to it an instance of ::Elm_Box_Transition with the
5801     * necessary information to perform this animation. The free function to
5802     * set for the layout is elm_box_transition_free().
5803     *
5804     * The parameters to create an ::Elm_Box_Transition sum up to how long
5805     * will it be, in seconds, a layout function to describe the initial point,
5806     * another for the final position of the children and one function to be
5807     * called when the whole animation ends. This last function is useful to
5808     * set the definitive layout for the box, usually the same as the end
5809     * layout for the animation, but could be used to start another transition.
5810     *
5811     * @param start_layout The layout function that will be used to start the animation
5812     * @param start_layout_data The data to be passed the @p start_layout function
5813     * @param start_layout_free_data Function to free @p start_layout_data
5814     * @param end_layout The layout function that will be used to end the animation
5815     * @param end_layout_free_data The data to be passed the @p end_layout function
5816     * @param end_layout_free_data Function to free @p end_layout_data
5817     * @param transition_end_cb Callback function called when animation ends
5818     * @param transition_end_data Data to be passed to @p transition_end_cb
5819     * @return An instance of ::Elm_Box_Transition
5820     *
5821     * @see elm_box_transition_new
5822     * @see elm_box_layout_transition
5823     */
5824    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);
5825    /**
5826     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5827     *
5828     * This function is mostly useful as the @c free_data parameter in
5829     * elm_box_layout_set() when elm_box_layout_transition().
5830     *
5831     * @param data The Elm_Box_Transition instance to be freed.
5832     *
5833     * @see elm_box_transition_new
5834     * @see elm_box_layout_transition
5835     */
5836    EAPI void                elm_box_transition_free(void *data);
5837    /**
5838     * @}
5839     */
5840
5841    /* button */
5842    /**
5843     * @defgroup Button Button
5844     *
5845     * @image html img/widget/button/preview-00.png
5846     * @image latex img/widget/button/preview-00.eps
5847     * @image html img/widget/button/preview-01.png
5848     * @image latex img/widget/button/preview-01.eps
5849     * @image html img/widget/button/preview-02.png
5850     * @image latex img/widget/button/preview-02.eps
5851     *
5852     * This is a push-button. Press it and run some function. It can contain
5853     * a simple label and icon object and it also has an autorepeat feature.
5854     *
5855     * This widgets emits the following signals:
5856     * @li "clicked": the user clicked the button (press/release).
5857     * @li "repeated": the user pressed the button without releasing it.
5858     * @li "pressed": button was pressed.
5859     * @li "unpressed": button was released after being pressed.
5860     * In all three cases, the @c event parameter of the callback will be
5861     * @c NULL.
5862     *
5863     * Also, defined in the default theme, the button has the following styles
5864     * available:
5865     * @li default: a normal button.
5866     * @li anchor: Like default, but the button fades away when the mouse is not
5867     * over it, leaving only the text or icon.
5868     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5869     * continuous look across its options.
5870     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5871     *
5872     * Follow through a complete example @ref button_example_01 "here".
5873     * @{
5874     */
5875    /**
5876     * Add a new button to the parent's canvas
5877     *
5878     * @param parent The parent object
5879     * @return The new object or NULL if it cannot be created
5880     */
5881    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5882    /**
5883     * Set the label used in the button
5884     *
5885     * The passed @p label can be NULL to clean any existing text in it and
5886     * leave the button as an icon only object.
5887     *
5888     * @param obj The button object
5889     * @param label The text will be written on the button
5890     * @deprecated use elm_object_text_set() instead.
5891     */
5892    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5893    /**
5894     * Get the label set for the button
5895     *
5896     * The string returned is an internal pointer and should not be freed or
5897     * altered. It will also become invalid when the button is destroyed.
5898     * The string returned, if not NULL, is a stringshare, so if you need to
5899     * keep it around even after the button is destroyed, you can use
5900     * eina_stringshare_ref().
5901     *
5902     * @param obj The button object
5903     * @return The text set to the label, or NULL if nothing is set
5904     * @deprecated use elm_object_text_set() instead.
5905     */
5906    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5907    /**
5908     * Set the icon used for the button
5909     *
5910     * Setting a new icon will delete any other that was previously set, making
5911     * any reference to them invalid. If you need to maintain the previous
5912     * object alive, unset it first with elm_button_icon_unset().
5913     *
5914     * @param obj The button object
5915     * @param icon The icon object for the button
5916     */
5917    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5918    /**
5919     * Get the icon used for the button
5920     *
5921     * Return the icon object which is set for this widget. If the button is
5922     * destroyed or another icon is set, the returned object will be deleted
5923     * and any reference to it will be invalid.
5924     *
5925     * @param obj The button object
5926     * @return The icon object that is being used
5927     *
5928     * @see elm_button_icon_unset()
5929     */
5930    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5931    /**
5932     * Remove the icon set without deleting it and return the object
5933     *
5934     * This function drops the reference the button holds of the icon object
5935     * and returns this last object. It is used in case you want to remove any
5936     * icon, or set another one, without deleting the actual object. The button
5937     * will be left without an icon set.
5938     *
5939     * @param obj The button object
5940     * @return The icon object that was being used
5941     */
5942    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5943    /**
5944     * Turn on/off the autorepeat event generated when the button is kept pressed
5945     *
5946     * When off, no autorepeat is performed and buttons emit a normal @c clicked
5947     * signal when they are clicked.
5948     *
5949     * When on, keeping a button pressed will continuously emit a @c repeated
5950     * signal until the button is released. The time it takes until it starts
5951     * emitting the signal is given by
5952     * elm_button_autorepeat_initial_timeout_set(), and the time between each
5953     * new emission by elm_button_autorepeat_gap_timeout_set().
5954     *
5955     * @param obj The button object
5956     * @param on  A bool to turn on/off the event
5957     */
5958    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5959    /**
5960     * Get whether the autorepeat feature is enabled
5961     *
5962     * @param obj The button object
5963     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5964     *
5965     * @see elm_button_autorepeat_set()
5966     */
5967    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5968    /**
5969     * Set the initial timeout before the autorepeat event is generated
5970     *
5971     * Sets the timeout, in seconds, since the button is pressed until the
5972     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5973     * won't be any delay and the even will be fired the moment the button is
5974     * pressed.
5975     *
5976     * @param obj The button object
5977     * @param t   Timeout in seconds
5978     *
5979     * @see elm_button_autorepeat_set()
5980     * @see elm_button_autorepeat_gap_timeout_set()
5981     */
5982    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5983    /**
5984     * Get the initial timeout before the autorepeat event is generated
5985     *
5986     * @param obj The button object
5987     * @return Timeout in seconds
5988     *
5989     * @see elm_button_autorepeat_initial_timeout_set()
5990     */
5991    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5992    /**
5993     * Set the interval between each generated autorepeat event
5994     *
5995     * After the first @c repeated event is fired, all subsequent ones will
5996     * follow after a delay of @p t seconds for each.
5997     *
5998     * @param obj The button object
5999     * @param t   Interval in seconds
6000     *
6001     * @see elm_button_autorepeat_initial_timeout_set()
6002     */
6003    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6004    /**
6005     * Get the interval between each generated autorepeat event
6006     *
6007     * @param obj The button object
6008     * @return Interval in seconds
6009     */
6010    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6011    /**
6012     * @}
6013     */
6014
6015    /**
6016     * @defgroup File_Selector_Button File Selector Button
6017     *
6018     * @image html img/widget/fileselector_button/preview-00.png
6019     * @image latex img/widget/fileselector_button/preview-00.eps
6020     * @image html img/widget/fileselector_button/preview-01.png
6021     * @image latex img/widget/fileselector_button/preview-01.eps
6022     * @image html img/widget/fileselector_button/preview-02.png
6023     * @image latex img/widget/fileselector_button/preview-02.eps
6024     *
6025     * This is a button that, when clicked, creates an Elementary
6026     * window (or inner window) <b> with a @ref Fileselector "file
6027     * selector widget" within</b>. When a file is chosen, the (inner)
6028     * window is closed and the button emits a signal having the
6029     * selected file as it's @c event_info.
6030     *
6031     * This widget encapsulates operations on its internal file
6032     * selector on its own API. There is less control over its file
6033     * selector than that one would have instatiating one directly.
6034     *
6035     * The following styles are available for this button:
6036     * @li @c "default"
6037     * @li @c "anchor"
6038     * @li @c "hoversel_vertical"
6039     * @li @c "hoversel_vertical_entry"
6040     *
6041     * Smart callbacks one can register to:
6042     * - @c "file,chosen" - the user has selected a path, whose string
6043     *   pointer comes as the @c event_info data (a stringshared
6044     *   string)
6045     *
6046     * Here is an example on its usage:
6047     * @li @ref fileselector_button_example
6048     *
6049     * @see @ref File_Selector_Entry for a similar widget.
6050     * @{
6051     */
6052
6053    /**
6054     * Add a new file selector button widget to the given parent
6055     * Elementary (container) object
6056     *
6057     * @param parent The parent object
6058     * @return a new file selector button widget handle or @c NULL, on
6059     * errors
6060     */
6061    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6062
6063    /**
6064     * Set the label for a given file selector button widget
6065     *
6066     * @param obj The file selector button widget
6067     * @param label The text label to be displayed on @p obj
6068     *
6069     * @deprecated use elm_object_text_set() instead.
6070     */
6071    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6072
6073    /**
6074     * Get the label set for a given file selector button widget
6075     *
6076     * @param obj The file selector button widget
6077     * @return The button label
6078     *
6079     * @deprecated use elm_object_text_set() instead.
6080     */
6081    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6082
6083    /**
6084     * Set the icon on a given file selector button widget
6085     *
6086     * @param obj The file selector button widget
6087     * @param icon The icon object for the button
6088     *
6089     * Once the icon object is set, a previously set one will be
6090     * deleted. If you want to keep the latter, use the
6091     * elm_fileselector_button_icon_unset() function.
6092     *
6093     * @see elm_fileselector_button_icon_get()
6094     */
6095    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6096
6097    /**
6098     * Get the icon set for a given file selector button widget
6099     *
6100     * @param obj The file selector button widget
6101     * @return The icon object currently set on @p obj or @c NULL, if
6102     * none is
6103     *
6104     * @see elm_fileselector_button_icon_set()
6105     */
6106    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6107
6108    /**
6109     * Unset the icon used in a given file selector button widget
6110     *
6111     * @param obj The file selector button widget
6112     * @return The icon object that was being used on @p obj or @c
6113     * NULL, on errors
6114     *
6115     * Unparent and return the icon object which was set for this
6116     * widget.
6117     *
6118     * @see elm_fileselector_button_icon_set()
6119     */
6120    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6121
6122    /**
6123     * Set the title for a given file selector button widget's window
6124     *
6125     * @param obj The file selector button widget
6126     * @param title The title string
6127     *
6128     * This will change the window's title, when the file selector pops
6129     * out after a click on the button. Those windows have the default
6130     * (unlocalized) value of @c "Select a file" as titles.
6131     *
6132     * @note It will only take any effect if the file selector
6133     * button widget is @b not under "inwin mode".
6134     *
6135     * @see elm_fileselector_button_window_title_get()
6136     */
6137    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6138
6139    /**
6140     * Get the title set for a given file selector button widget's
6141     * window
6142     *
6143     * @param obj The file selector button widget
6144     * @return Title of the file selector button's window
6145     *
6146     * @see elm_fileselector_button_window_title_get() for more details
6147     */
6148    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6149
6150    /**
6151     * Set the size of a given file selector button widget's window,
6152     * holding the file selector itself.
6153     *
6154     * @param obj The file selector button widget
6155     * @param width The window's width
6156     * @param height The window's height
6157     *
6158     * @note it will only take any effect if the file selector button
6159     * widget is @b not under "inwin mode". The default size for the
6160     * window (when applicable) is 400x400 pixels.
6161     *
6162     * @see elm_fileselector_button_window_size_get()
6163     */
6164    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6165
6166    /**
6167     * Get the size of a given file selector button widget's window,
6168     * holding the file selector itself.
6169     *
6170     * @param obj The file selector button widget
6171     * @param width Pointer into which to store the width value
6172     * @param height Pointer into which to store the height value
6173     *
6174     * @note Use @c NULL pointers on the size values you're not
6175     * interested in: they'll be ignored by the function.
6176     *
6177     * @see elm_fileselector_button_window_size_set(), for more details
6178     */
6179    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6180
6181    /**
6182     * Set the initial file system path for a given file selector
6183     * button widget
6184     *
6185     * @param obj The file selector button widget
6186     * @param path The path string
6187     *
6188     * It must be a <b>directory</b> path, which will have the contents
6189     * displayed initially in the file selector's view, when invoked
6190     * from @p obj. The default initial path is the @c "HOME"
6191     * environment variable's value.
6192     *
6193     * @see elm_fileselector_button_path_get()
6194     */
6195    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6196
6197    /**
6198     * Get the initial file system path set for a given file selector
6199     * button widget
6200     *
6201     * @param obj The file selector button widget
6202     * @return path The path string
6203     *
6204     * @see elm_fileselector_button_path_set() for more details
6205     */
6206    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6207
6208    /**
6209     * Enable/disable a tree view in the given file selector button
6210     * widget's internal file selector
6211     *
6212     * @param obj The file selector button widget
6213     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6214     * disable
6215     *
6216     * This has the same effect as elm_fileselector_expandable_set(),
6217     * but now applied to a file selector button's internal file
6218     * selector.
6219     *
6220     * @note There's no way to put a file selector button's internal
6221     * file selector in "grid mode", as one may do with "pure" file
6222     * selectors.
6223     *
6224     * @see elm_fileselector_expandable_get()
6225     */
6226    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6227
6228    /**
6229     * Get whether tree view is enabled for the given file selector
6230     * button widget's internal file selector
6231     *
6232     * @param obj The file selector button widget
6233     * @return @c EINA_TRUE if @p obj widget's internal file selector
6234     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6235     *
6236     * @see elm_fileselector_expandable_set() for more details
6237     */
6238    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6239
6240    /**
6241     * Set whether a given file selector button widget's internal file
6242     * selector is to display folders only or the directory contents,
6243     * as well.
6244     *
6245     * @param obj The file selector button widget
6246     * @param only @c EINA_TRUE to make @p obj widget's internal file
6247     * selector only display directories, @c EINA_FALSE to make files
6248     * to be displayed in it too
6249     *
6250     * This has the same effect as elm_fileselector_folder_only_set(),
6251     * but now applied to a file selector button's internal file
6252     * selector.
6253     *
6254     * @see elm_fileselector_folder_only_get()
6255     */
6256    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6257
6258    /**
6259     * Get whether a given file selector button widget's internal file
6260     * selector is displaying folders only or the directory contents,
6261     * as well.
6262     *
6263     * @param obj The file selector button widget
6264     * @return @c EINA_TRUE if @p obj widget's internal file
6265     * selector is only displaying directories, @c EINA_FALSE if files
6266     * are being displayed in it too (and on errors)
6267     *
6268     * @see elm_fileselector_button_folder_only_set() for more details
6269     */
6270    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6271
6272    /**
6273     * Enable/disable the file name entry box where the user can type
6274     * in a name for a file, in a given file selector button widget's
6275     * internal file selector.
6276     *
6277     * @param obj The file selector button widget
6278     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6279     * file selector a "saving dialog", @c EINA_FALSE otherwise
6280     *
6281     * This has the same effect as elm_fileselector_is_save_set(),
6282     * but now applied to a file selector button's internal file
6283     * selector.
6284     *
6285     * @see elm_fileselector_is_save_get()
6286     */
6287    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6288
6289    /**
6290     * Get whether the given file selector button widget's internal
6291     * file selector is in "saving dialog" mode
6292     *
6293     * @param obj The file selector button widget
6294     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6295     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6296     * errors)
6297     *
6298     * @see elm_fileselector_button_is_save_set() for more details
6299     */
6300    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6301
6302    /**
6303     * Set whether a given file selector button widget's internal file
6304     * selector will raise an Elementary "inner window", instead of a
6305     * dedicated Elementary window. By default, it won't.
6306     *
6307     * @param obj The file selector button widget
6308     * @param value @c EINA_TRUE to make it use an inner window, @c
6309     * EINA_TRUE to make it use a dedicated window
6310     *
6311     * @see elm_win_inwin_add() for more information on inner windows
6312     * @see elm_fileselector_button_inwin_mode_get()
6313     */
6314    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6315
6316    /**
6317     * Get whether a given file selector button widget's internal file
6318     * selector will raise an Elementary "inner window", instead of a
6319     * dedicated Elementary window.
6320     *
6321     * @param obj The file selector button widget
6322     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6323     * if it will use a dedicated window
6324     *
6325     * @see elm_fileselector_button_inwin_mode_set() for more details
6326     */
6327    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6328
6329    /**
6330     * @}
6331     */
6332
6333     /**
6334     * @defgroup File_Selector_Entry File Selector Entry
6335     *
6336     * @image html img/widget/fileselector_entry/preview-00.png
6337     * @image latex img/widget/fileselector_entry/preview-00.eps
6338     *
6339     * This is an entry made to be filled with or display a <b>file
6340     * system path string</b>. Besides the entry itself, the widget has
6341     * a @ref File_Selector_Button "file selector button" on its side,
6342     * which will raise an internal @ref Fileselector "file selector widget",
6343     * when clicked, for path selection aided by file system
6344     * navigation.
6345     *
6346     * This file selector may appear in an Elementary window or in an
6347     * inner window. When a file is chosen from it, the (inner) window
6348     * is closed and the selected file's path string is exposed both as
6349     * an smart event and as the new text on the entry.
6350     *
6351     * This widget encapsulates operations on its internal file
6352     * selector on its own API. There is less control over its file
6353     * selector than that one would have instatiating one directly.
6354     *
6355     * Smart callbacks one can register to:
6356     * - @c "changed" - The text within the entry was changed
6357     * - @c "activated" - The entry has had editing finished and
6358     *   changes are to be "committed"
6359     * - @c "press" - The entry has been clicked
6360     * - @c "longpressed" - The entry has been clicked (and held) for a
6361     *   couple seconds
6362     * - @c "clicked" - The entry has been clicked
6363     * - @c "clicked,double" - The entry has been double clicked
6364     * - @c "focused" - The entry has received focus
6365     * - @c "unfocused" - The entry has lost focus
6366     * - @c "selection,paste" - A paste action has occurred on the
6367     *   entry
6368     * - @c "selection,copy" - A copy action has occurred on the entry
6369     * - @c "selection,cut" - A cut action has occurred on the entry
6370     * - @c "unpressed" - The file selector entry's button was released
6371     *   after being pressed.
6372     * - @c "file,chosen" - The user has selected a path via the file
6373     *   selector entry's internal file selector, whose string pointer
6374     *   comes as the @c event_info data (a stringshared string)
6375     *
6376     * Here is an example on its usage:
6377     * @li @ref fileselector_entry_example
6378     *
6379     * @see @ref File_Selector_Button for a similar widget.
6380     * @{
6381     */
6382
6383    /**
6384     * Add a new file selector entry widget to the given parent
6385     * Elementary (container) object
6386     *
6387     * @param parent The parent object
6388     * @return a new file selector entry widget handle or @c NULL, on
6389     * errors
6390     */
6391    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6392
6393    /**
6394     * Set the label for a given file selector entry widget's button
6395     *
6396     * @param obj The file selector entry widget
6397     * @param label The text label to be displayed on @p obj widget's
6398     * button
6399     *
6400     * @deprecated use elm_object_text_set() instead.
6401     */
6402    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6403
6404    /**
6405     * Get the label set for a given file selector entry widget's button
6406     *
6407     * @param obj The file selector entry widget
6408     * @return The widget button's label
6409     *
6410     * @deprecated use elm_object_text_set() instead.
6411     */
6412    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6413
6414    /**
6415     * Set the icon on a given file selector entry widget's button
6416     *
6417     * @param obj The file selector entry widget
6418     * @param icon The icon object for the entry's button
6419     *
6420     * Once the icon object is set, a previously set one will be
6421     * deleted. If you want to keep the latter, use the
6422     * elm_fileselector_entry_button_icon_unset() function.
6423     *
6424     * @see elm_fileselector_entry_button_icon_get()
6425     */
6426    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6427
6428    /**
6429     * Get the icon set for a given file selector entry widget's button
6430     *
6431     * @param obj The file selector entry widget
6432     * @return The icon object currently set on @p obj widget's button
6433     * or @c NULL, if none is
6434     *
6435     * @see elm_fileselector_entry_button_icon_set()
6436     */
6437    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6438
6439    /**
6440     * Unset the icon used in a given file selector entry widget's
6441     * button
6442     *
6443     * @param obj The file selector entry widget
6444     * @return The icon object that was being used on @p obj widget's
6445     * button or @c NULL, on errors
6446     *
6447     * Unparent and return the icon object which was set for this
6448     * widget's button.
6449     *
6450     * @see elm_fileselector_entry_button_icon_set()
6451     */
6452    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6453
6454    /**
6455     * Set the title for a given file selector entry widget's window
6456     *
6457     * @param obj The file selector entry widget
6458     * @param title The title string
6459     *
6460     * This will change the window's title, when the file selector pops
6461     * out after a click on the entry's button. Those windows have the
6462     * default (unlocalized) value of @c "Select a file" as titles.
6463     *
6464     * @note It will only take any effect if the file selector
6465     * entry widget is @b not under "inwin mode".
6466     *
6467     * @see elm_fileselector_entry_window_title_get()
6468     */
6469    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6470
6471    /**
6472     * Get the title set for a given file selector entry widget's
6473     * window
6474     *
6475     * @param obj The file selector entry widget
6476     * @return Title of the file selector entry's window
6477     *
6478     * @see elm_fileselector_entry_window_title_get() for more details
6479     */
6480    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6481
6482    /**
6483     * Set the size of a given file selector entry widget's window,
6484     * holding the file selector itself.
6485     *
6486     * @param obj The file selector entry widget
6487     * @param width The window's width
6488     * @param height The window's height
6489     *
6490     * @note it will only take any effect if the file selector entry
6491     * widget is @b not under "inwin mode". The default size for the
6492     * window (when applicable) is 400x400 pixels.
6493     *
6494     * @see elm_fileselector_entry_window_size_get()
6495     */
6496    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6497
6498    /**
6499     * Get the size of a given file selector entry widget's window,
6500     * holding the file selector itself.
6501     *
6502     * @param obj The file selector entry widget
6503     * @param width Pointer into which to store the width value
6504     * @param height Pointer into which to store the height value
6505     *
6506     * @note Use @c NULL pointers on the size values you're not
6507     * interested in: they'll be ignored by the function.
6508     *
6509     * @see elm_fileselector_entry_window_size_set(), for more details
6510     */
6511    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6512
6513    /**
6514     * Set the initial file system path and the entry's path string for
6515     * a given file selector entry widget
6516     *
6517     * @param obj The file selector entry widget
6518     * @param path The path string
6519     *
6520     * It must be a <b>directory</b> path, which will have the contents
6521     * displayed initially in the file selector's view, when invoked
6522     * from @p obj. The default initial path is the @c "HOME"
6523     * environment variable's value.
6524     *
6525     * @see elm_fileselector_entry_path_get()
6526     */
6527    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6528
6529    /**
6530     * Get the entry's path string for a given file selector entry
6531     * widget
6532     *
6533     * @param obj The file selector entry widget
6534     * @return path The path string
6535     *
6536     * @see elm_fileselector_entry_path_set() for more details
6537     */
6538    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6539
6540    /**
6541     * Enable/disable a tree view in the given file selector entry
6542     * widget's internal file selector
6543     *
6544     * @param obj The file selector entry widget
6545     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6546     * disable
6547     *
6548     * This has the same effect as elm_fileselector_expandable_set(),
6549     * but now applied to a file selector entry's internal file
6550     * selector.
6551     *
6552     * @note There's no way to put a file selector entry's internal
6553     * file selector in "grid mode", as one may do with "pure" file
6554     * selectors.
6555     *
6556     * @see elm_fileselector_expandable_get()
6557     */
6558    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6559
6560    /**
6561     * Get whether tree view is enabled for the given file selector
6562     * entry widget's internal file selector
6563     *
6564     * @param obj The file selector entry widget
6565     * @return @c EINA_TRUE if @p obj widget's internal file selector
6566     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6567     *
6568     * @see elm_fileselector_expandable_set() for more details
6569     */
6570    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6571
6572    /**
6573     * Set whether a given file selector entry widget's internal file
6574     * selector is to display folders only or the directory contents,
6575     * as well.
6576     *
6577     * @param obj The file selector entry widget
6578     * @param only @c EINA_TRUE to make @p obj widget's internal file
6579     * selector only display directories, @c EINA_FALSE to make files
6580     * to be displayed in it too
6581     *
6582     * This has the same effect as elm_fileselector_folder_only_set(),
6583     * but now applied to a file selector entry's internal file
6584     * selector.
6585     *
6586     * @see elm_fileselector_folder_only_get()
6587     */
6588    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6589
6590    /**
6591     * Get whether a given file selector entry widget's internal file
6592     * selector is displaying folders only or the directory contents,
6593     * as well.
6594     *
6595     * @param obj The file selector entry widget
6596     * @return @c EINA_TRUE if @p obj widget's internal file
6597     * selector is only displaying directories, @c EINA_FALSE if files
6598     * are being displayed in it too (and on errors)
6599     *
6600     * @see elm_fileselector_entry_folder_only_set() for more details
6601     */
6602    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6603
6604    /**
6605     * Enable/disable the file name entry box where the user can type
6606     * in a name for a file, in a given file selector entry widget's
6607     * internal file selector.
6608     *
6609     * @param obj The file selector entry widget
6610     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6611     * file selector a "saving dialog", @c EINA_FALSE otherwise
6612     *
6613     * This has the same effect as elm_fileselector_is_save_set(),
6614     * but now applied to a file selector entry's internal file
6615     * selector.
6616     *
6617     * @see elm_fileselector_is_save_get()
6618     */
6619    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6620
6621    /**
6622     * Get whether the given file selector entry widget's internal
6623     * file selector is in "saving dialog" mode
6624     *
6625     * @param obj The file selector entry widget
6626     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6627     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6628     * errors)
6629     *
6630     * @see elm_fileselector_entry_is_save_set() for more details
6631     */
6632    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6633
6634    /**
6635     * Set whether a given file selector entry widget's internal file
6636     * selector will raise an Elementary "inner window", instead of a
6637     * dedicated Elementary window. By default, it won't.
6638     *
6639     * @param obj The file selector entry widget
6640     * @param value @c EINA_TRUE to make it use an inner window, @c
6641     * EINA_TRUE to make it use a dedicated window
6642     *
6643     * @see elm_win_inwin_add() for more information on inner windows
6644     * @see elm_fileselector_entry_inwin_mode_get()
6645     */
6646    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6647
6648    /**
6649     * Get whether a given file selector entry widget's internal file
6650     * selector will raise an Elementary "inner window", instead of a
6651     * dedicated Elementary window.
6652     *
6653     * @param obj The file selector entry widget
6654     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6655     * if it will use a dedicated window
6656     *
6657     * @see elm_fileselector_entry_inwin_mode_set() for more details
6658     */
6659    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6660
6661    /**
6662     * Set the initial file system path for a given file selector entry
6663     * widget
6664     *
6665     * @param obj The file selector entry widget
6666     * @param path The path string
6667     *
6668     * It must be a <b>directory</b> path, which will have the contents
6669     * displayed initially in the file selector's view, when invoked
6670     * from @p obj. The default initial path is the @c "HOME"
6671     * environment variable's value.
6672     *
6673     * @see elm_fileselector_entry_path_get()
6674     */
6675    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6676
6677    /**
6678     * Get the parent directory's path to the latest file selection on
6679     * a given filer selector entry widget
6680     *
6681     * @param obj The file selector object
6682     * @return The (full) path of the directory of the last selection
6683     * on @p obj widget, a @b stringshared string
6684     *
6685     * @see elm_fileselector_entry_path_set()
6686     */
6687    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6688
6689    /**
6690     * @}
6691     */
6692
6693    /**
6694     * @defgroup Scroller Scroller
6695     *
6696     * A scroller holds a single object and "scrolls it around". This means that
6697     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6698     * region around, allowing to move through a much larger object that is
6699     * contained in the scroller. The scroiller will always have a small minimum
6700     * size by default as it won't be limited by the contents of the scroller.
6701     *
6702     * Signals that you can add callbacks for are:
6703     * @li "edge,left" - the left edge of the content has been reached
6704     * @li "edge,right" - the right edge of the content has been reached
6705     * @li "edge,top" - the top edge of the content has been reached
6706     * @li "edge,bottom" - the bottom edge of the content has been reached
6707     * @li "scroll" - the content has been scrolled (moved)
6708     * @li "scroll,anim,start" - scrolling animation has started
6709     * @li "scroll,anim,stop" - scrolling animation has stopped
6710     * @li "scroll,drag,start" - dragging the contents around has started
6711     * @li "scroll,drag,stop" - dragging the contents around has stopped
6712     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6713     * user intervetion.
6714     *
6715     * @note When Elemementary is in embedded mode the scrollbars will not be
6716     * dragable, they appear merely as indicators of how much has been scrolled.
6717     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6718     * fingerscroll) won't work.
6719     *
6720     * In @ref tutorial_scroller you'll find an example of how to use most of
6721     * this API.
6722     * @{
6723     */
6724    /**
6725     * @brief Type that controls when scrollbars should appear.
6726     *
6727     * @see elm_scroller_policy_set()
6728     */
6729    typedef enum _Elm_Scroller_Policy
6730      {
6731         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6732         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6733         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6734         ELM_SCROLLER_POLICY_LAST
6735      } Elm_Scroller_Policy;
6736    /**
6737     * @brief Add a new scroller to the parent
6738     *
6739     * @param parent The parent object
6740     * @return The new object or NULL if it cannot be created
6741     */
6742    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6743    /**
6744     * @brief Set the content of the scroller widget (the object to be scrolled around).
6745     *
6746     * @param obj The scroller object
6747     * @param content The new content object
6748     *
6749     * Once the content object is set, a previously set one will be deleted.
6750     * If you want to keep that old content object, use the
6751     * elm_scroller_content_unset() function.
6752     */
6753    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6754    /**
6755     * @brief Get the content of the scroller widget
6756     *
6757     * @param obj The slider object
6758     * @return The content that is being used
6759     *
6760     * Return the content object which is set for this widget
6761     *
6762     * @see elm_scroller_content_set()
6763     */
6764    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6765    /**
6766     * @brief Unset the content of the scroller widget
6767     *
6768     * @param obj The slider object
6769     * @return The content that was being used
6770     *
6771     * Unparent and return the content object which was set for this widget
6772     *
6773     * @see elm_scroller_content_set()
6774     */
6775    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6776    /**
6777     * @brief Set custom theme elements for the scroller
6778     *
6779     * @param obj The scroller object
6780     * @param widget The widget name to use (default is "scroller")
6781     * @param base The base name to use (default is "base")
6782     */
6783    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6784    /**
6785     * @brief Make the scroller minimum size limited to the minimum size of the content
6786     *
6787     * @param obj The scroller object
6788     * @param w Enable limiting minimum size horizontally
6789     * @param h Enable limiting minimum size vertically
6790     *
6791     * By default the scroller will be as small as its design allows,
6792     * irrespective of its content. This will make the scroller minimum size the
6793     * right size horizontally and/or vertically to perfectly fit its content in
6794     * that direction.
6795     */
6796    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6797    /**
6798     * @brief Show a specific virtual region within the scroller content object
6799     *
6800     * @param obj The scroller object
6801     * @param x X coordinate of the region
6802     * @param y Y coordinate of the region
6803     * @param w Width of the region
6804     * @param h Height of the region
6805     *
6806     * This will ensure all (or part if it does not fit) of the designated
6807     * region in the virtual content object (0, 0 starting at the top-left of the
6808     * virtual content object) is shown within the scroller.
6809     */
6810    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);
6811    /**
6812     * @brief Set the scrollbar visibility policy
6813     *
6814     * @param obj The scroller object
6815     * @param policy_h Horizontal scrollbar policy
6816     * @param policy_v Vertical scrollbar policy
6817     *
6818     * This sets the scrollbar visibility policy for the given scroller.
6819     * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6820     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6821     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6822     * respectively for the horizontal and vertical scrollbars.
6823     */
6824    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6825    /**
6826     * @brief Gets scrollbar visibility policy
6827     *
6828     * @param obj The scroller object
6829     * @param policy_h Horizontal scrollbar policy
6830     * @param policy_v Vertical scrollbar policy
6831     *
6832     * @see elm_scroller_policy_set()
6833     */
6834    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6835    /**
6836     * @brief Get the currently visible content region
6837     *
6838     * @param obj The scroller object
6839     * @param x X coordinate of the region
6840     * @param y Y coordinate of the region
6841     * @param w Width of the region
6842     * @param h Height of the region
6843     *
6844     * This gets the current region in the content object that is visible through
6845     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6846     * w, @p h values pointed to.
6847     *
6848     * @note All coordinates are relative to the content.
6849     *
6850     * @see elm_scroller_region_show()
6851     */
6852    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);
6853    /**
6854     * @brief Get the size of the content object
6855     *
6856     * @param obj The scroller object
6857     * @param w Width return
6858     * @param h Height return
6859     *
6860     * This gets the size of the content object of the scroller.
6861     */
6862    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6863    /**
6864     * @brief Set bouncing behavior
6865     *
6866     * @param obj The scroller object
6867     * @param h_bounce Will the scroller bounce horizontally or not
6868     * @param v_bounce Will the scroller bounce vertically or not
6869     *
6870     * When scrolling, the scroller may "bounce" when reaching an edge of the
6871     * content object. This is a visual way to indicate the end has been reached.
6872     * This is enabled by default for both axis. This will set if it is enabled
6873     * for that axis with the boolean parameters for each axis.
6874     */
6875    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6876    /**
6877     * @brief Get the bounce mode
6878     *
6879     * @param obj The Scroller object
6880     * @param h_bounce Allow bounce horizontally
6881     * @param v_bounce Allow bounce vertically
6882     *
6883     * @see elm_scroller_bounce_set()
6884     */
6885    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6886    /**
6887     * @brief Set scroll page size relative to viewport size.
6888     *
6889     * @param obj The scroller object
6890     * @param h_pagerel The horizontal page relative size
6891     * @param v_pagerel The vertical page relative size
6892     *
6893     * The scroller is capable of limiting scrolling by the user to "pages". That
6894     * is to jump by and only show a "whole page" at a time as if the continuous
6895     * area of the scroller content is split into page sized pieces. This sets
6896     * the size of a page relative to the viewport of the scroller. 1.0 is "1
6897     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6898     * axis. This is mutually exclusive with page size
6899     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
6900     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6901     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6902     * the other axis.
6903     */
6904    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6905    /**
6906     * @brief Set scroll page size.
6907     *
6908     * @param obj The scroller object
6909     * @param h_pagesize The horizontal page size
6910     * @param v_pagesize The vertical page size
6911     *
6912     * This sets the page size to an absolute fixed value, with 0 turning it off
6913     * for that axis.
6914     *
6915     * @see elm_scroller_page_relative_set()
6916     */
6917    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6918    /**
6919     * @brief Get scroll current page number.
6920     *
6921     * @param obj The scroller object
6922     * @param h_pagenumber The horizoptal page number
6923     * @param v_pagenumber The vertical page number
6924     *
6925     * The page number starts from 0. 0 is the first page.
6926     * Current page means the page which meet the top-left of the viewport.
6927     * If there are two or more pages in the viewport, it returns the number of page
6928     * which meet the top-left of the viewport.
6929     *
6930     * @see elm_scroller_last_page_get()
6931     * @see elm_scroller_page_show()
6932     * @see elm_scroller_page_brint_in()
6933     */
6934    EAPI void         elm_scroller_current_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
6935    /**
6936     * @brief Get scroll last page number.
6937     *
6938     * @param obj The scroller object
6939     * @param h_pagenumber The horizoptal page number
6940     * @param v_pagenumber The vertical page number
6941     *
6942     * The page number starts from 0. 0 is the first page.
6943     * This returns the last page number among the pages.
6944     *
6945     * @see elm_scroller_current_page_get()
6946     * @see elm_scroller_page_show()
6947     * @see elm_scroller_page_brint_in()
6948     */
6949    EAPI void         elm_scroller_last_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
6950    /**
6951     * Show a specific virtual region within the scroller content object by page number.
6952     *
6953     * @param obj The scroller object
6954     * @param h_pagenumber The horizoptal page number
6955     * @param v_pagenumber The vertical page number
6956     *
6957     * 0, 0 of the indicated page is located at the top-left of the viewport.
6958     * This will jump to the page directly without animation.
6959     *
6960     * Example of usage:
6961     *
6962     * @code
6963     * sc = elm_scroller_add(win);
6964     * elm_scroller_content_set(sc, content);
6965     * elm_scroller_page_relative_set(sc, 1, 0);
6966     * elm_scroller_current_page_get(sc, &h_page, &v_page);
6967     * elm_scroller_page_show(sc, h_page + 1, v_page);
6968     * @endcode
6969     *
6970     * @see elm_scroller_page_bring_in()
6971     */
6972    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
6973    /**
6974     * Show a specific virtual region within the scroller content object by page number.
6975     *
6976     * @param obj The scroller object
6977     * @param h_pagenumber The horizoptal page number
6978     * @param v_pagenumber The vertical page number
6979     *
6980     * 0, 0 of the indicated page is located at the top-left of the viewport.
6981     * This will slide to the page with animation.
6982     *
6983     * Example of usage:
6984     *
6985     * @code
6986     * sc = elm_scroller_add(win);
6987     * elm_scroller_content_set(sc, content);
6988     * elm_scroller_page_relative_set(sc, 1, 0);
6989     * elm_scroller_last_page_get(sc, &h_page, &v_page);
6990     * elm_scroller_page_bring_in(sc, h_page, v_page);
6991     * @endcode
6992     *
6993     * @see elm_scroller_page_show()
6994     */
6995    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
6996    /**
6997     * @brief Show a specific virtual region within the scroller content object.
6998     *
6999     * @param obj The scroller object
7000     * @param x X coordinate of the region
7001     * @param y Y coordinate of the region
7002     * @param w Width of the region
7003     * @param h Height of the region
7004     *
7005     * This will ensure all (or part if it does not fit) of the designated
7006     * region in the virtual content object (0, 0 starting at the top-left of the
7007     * virtual content object) is shown within the scroller. Unlike
7008     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7009     * to this location (if configuration in general calls for transitions). It
7010     * may not jump immediately to the new location and make take a while and
7011     * show other content along the way.
7012     *
7013     * @see elm_scroller_region_show()
7014     */
7015    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);
7016    /**
7017     * @brief Set event propagation on a scroller
7018     *
7019     * @param obj The scroller object
7020     * @param propagation If propagation is enabled or not
7021     *
7022     * This enables or disabled event propagation from the scroller content to
7023     * the scroller and its parent. By default event propagation is disabled.
7024     */
7025    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7026    /**
7027     * @brief Get event propagation for a scroller
7028     *
7029     * @param obj The scroller object
7030     * @return The propagation state
7031     *
7032     * This gets the event propagation for a scroller.
7033     *
7034     * @see elm_scroller_propagate_events_set()
7035     */
7036    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
7037    /**
7038     * @}
7039     */
7040
7041    /**
7042     * @defgroup Label Label
7043     *
7044     * @image html img/widget/label/preview-00.png
7045     * @image latex img/widget/label/preview-00.eps
7046     *
7047     * @brief Widget to display text, with simple html-like markup.
7048     *
7049     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7050     * text doesn't fit the geometry of the label it will be ellipsized or be
7051     * cut. Elementary provides several themes for this widget:
7052     * @li default - No animation
7053     * @li marker - Centers the text in the label and make it bold by default
7054     * @li slide_long - The entire text appears from the right of the screen and
7055     * slides until it disappears in the left of the screen(reappering on the
7056     * right again).
7057     * @li slide_short - The text appears in the left of the label and slides to
7058     * the right to show the overflow. When all of the text has been shown the
7059     * position is reset.
7060     * @li slide_bounce - The text appears in the left of the label and slides to
7061     * the right to show the overflow. When all of the text has been shown the
7062     * animation reverses, moving the text to the left.
7063     *
7064     * Custom themes can of course invent new markup tags and style them any way
7065     * they like.
7066     *
7067     * See @ref tutorial_label for a demonstration of how to use a label widget.
7068     * @{
7069     */
7070    /**
7071     * @brief Add a new label to the parent
7072     *
7073     * @param parent The parent object
7074     * @return The new object or NULL if it cannot be created
7075     */
7076    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7077    /**
7078     * @brief Set the label on the label object
7079     *
7080     * @param obj The label object
7081     * @param label The label will be used on the label object
7082     * @deprecated See elm_object_text_set()
7083     */
7084    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 */
7085    /**
7086     * @brief Get the label used on the label object
7087     *
7088     * @param obj The label object
7089     * @return The string inside the label
7090     * @deprecated See elm_object_text_get()
7091     */
7092    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7093    /**
7094     * @brief Set the wrapping behavior of the label
7095     *
7096     * @param obj The label object
7097     * @param wrap To wrap text or not
7098     *
7099     * By default no wrapping is done. Possible values for @p wrap are:
7100     * @li ELM_WRAP_NONE - No wrapping
7101     * @li ELM_WRAP_CHAR - wrap between characters
7102     * @li ELM_WRAP_WORD - wrap between words
7103     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7104     */
7105    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7106    /**
7107     * @brief Get the wrapping behavior of the label
7108     *
7109     * @param obj The label object
7110     * @return Wrap type
7111     *
7112     * @see elm_label_line_wrap_set()
7113     */
7114    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7115    /**
7116     * @brief Set wrap width of the label
7117     *
7118     * @param obj The label object
7119     * @param w The wrap width in pixels at a minimum where words need to wrap
7120     *
7121     * This function sets the maximum width size hint of the label.
7122     *
7123     * @warning This is only relevant if the label is inside a container.
7124     */
7125    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7126    /**
7127     * @brief Get wrap width of the label
7128     *
7129     * @param obj The label object
7130     * @return The wrap width in pixels at a minimum where words need to wrap
7131     *
7132     * @see elm_label_wrap_width_set()
7133     */
7134    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7135    /**
7136     * @brief Set wrap height of the label
7137     *
7138     * @param obj The label object
7139     * @param h The wrap height in pixels at a minimum where words need to wrap
7140     *
7141     * This function sets the maximum height size hint of the label.
7142     *
7143     * @warning This is only relevant if the label is inside a container.
7144     */
7145    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7146    /**
7147     * @brief get wrap width of the label
7148     *
7149     * @param obj The label object
7150     * @return The wrap height in pixels at a minimum where words need to wrap
7151     */
7152    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7153    /**
7154     * @brief Set the font size on the label object.
7155     *
7156     * @param obj The label object
7157     * @param size font size
7158     *
7159     * @warning NEVER use this. It is for hyper-special cases only. use styles
7160     * instead. e.g. "big", "medium", "small" - or better name them by use:
7161     * "title", "footnote", "quote" etc.
7162     */
7163    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7164    /**
7165     * @brief Set the text color on the label object
7166     *
7167     * @param obj The label object
7168     * @param r Red property background color of The label object
7169     * @param g Green property background color of The label object
7170     * @param b Blue property background color of The label object
7171     * @param a Alpha property background color of The label object
7172     *
7173     * @warning NEVER use this. It is for hyper-special cases only. use styles
7174     * instead. e.g. "big", "medium", "small" - or better name them by use:
7175     * "title", "footnote", "quote" etc.
7176     */
7177    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);
7178    /**
7179     * @brief Set the text align on the label object
7180     *
7181     * @param obj The label object
7182     * @param align align mode ("left", "center", "right")
7183     *
7184     * @warning NEVER use this. It is for hyper-special cases only. use styles
7185     * instead. e.g. "big", "medium", "small" - or better name them by use:
7186     * "title", "footnote", "quote" etc.
7187     */
7188    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7189    /**
7190     * @brief Set background color of the label
7191     *
7192     * @param obj The label object
7193     * @param r Red property background color of The label object
7194     * @param g Green property background color of The label object
7195     * @param b Blue property background color of The label object
7196     * @param a Alpha property background alpha of The label object
7197     *
7198     * @warning NEVER use this. It is for hyper-special cases only. use styles
7199     * instead. e.g. "big", "medium", "small" - or better name them by use:
7200     * "title", "footnote", "quote" etc.
7201     */
7202    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);
7203    /**
7204     * @brief Set the ellipsis behavior of the label
7205     *
7206     * @param obj The label object
7207     * @param ellipsis To ellipsis text or not
7208     *
7209     * If set to true and the text doesn't fit in the label an ellipsis("...")
7210     * will be shown at the end of the widget.
7211     *
7212     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7213     * choosen wrap method was ELM_WRAP_WORD.
7214     */
7215    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7216    /**
7217     * @brief Set the text slide of the label
7218     *
7219     * @param obj The label object
7220     * @param slide To start slide or stop
7221     *
7222     * If set to true the text of the label will slide throught the length of
7223     * label.
7224     *
7225     * @warning This only work with the themes "slide_short", "slide_long" and
7226     * "slide_bounce".
7227     */
7228    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7229    /**
7230     * @brief Get the text slide mode of the label
7231     *
7232     * @param obj The label object
7233     * @return slide slide mode value
7234     *
7235     * @see elm_label_slide_set()
7236     */
7237    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7238    /**
7239     * @brief Set the slide duration(speed) of the label
7240     *
7241     * @param obj The label object
7242     * @return The duration in seconds in moving text from slide begin position
7243     * to slide end position
7244     */
7245    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7246    /**
7247     * @brief Get the slide duration(speed) of the label
7248     *
7249     * @param obj The label object
7250     * @return The duration time in moving text from slide begin position to slide end position
7251     *
7252     * @see elm_label_slide_duration_set()
7253     */
7254    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7255    /**
7256     * @}
7257     */
7258
7259    /**
7260     * @defgroup Toggle Toggle
7261     *
7262     * @image html img/widget/toggle/preview-00.png
7263     * @image latex img/widget/toggle/preview-00.eps
7264     *
7265     * @brief A toggle is a slider which can be used to toggle between
7266     * two values.  It has two states: on and off.
7267     *
7268     * Signals that you can add callbacks for are:
7269     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7270     *                 until the toggle is released by the cursor (assuming it
7271     *                 has been triggered by the cursor in the first place).
7272     *
7273     * @ref tutorial_toggle show how to use a toggle.
7274     * @{
7275     */
7276    /**
7277     * @brief Add a toggle to @p parent.
7278     *
7279     * @param parent The parent object
7280     *
7281     * @return The toggle object
7282     */
7283    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7284    /**
7285     * @brief Sets the label to be displayed with the toggle.
7286     *
7287     * @param obj The toggle object
7288     * @param label The label to be displayed
7289     *
7290     * @deprecated use elm_object_text_set() instead.
7291     */
7292    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7293    /**
7294     * @brief Gets the label of the toggle
7295     *
7296     * @param obj  toggle object
7297     * @return The label of the toggle
7298     *
7299     * @deprecated use elm_object_text_get() instead.
7300     */
7301    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7302    /**
7303     * @brief Set the icon used for the toggle
7304     *
7305     * @param obj The toggle object
7306     * @param icon The icon object for the button
7307     *
7308     * Once the icon object is set, a previously set one will be deleted
7309     * If you want to keep that old content object, use the
7310     * elm_toggle_icon_unset() function.
7311     */
7312    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7313    /**
7314     * @brief Get the icon used for the toggle
7315     *
7316     * @param obj The toggle object
7317     * @return The icon object that is being used
7318     *
7319     * Return the icon object which is set for this widget.
7320     *
7321     * @see elm_toggle_icon_set()
7322     */
7323    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7324    /**
7325     * @brief Unset the icon used for the toggle
7326     *
7327     * @param obj The toggle object
7328     * @return The icon object that was being used
7329     *
7330     * Unparent and return the icon object which was set for this widget.
7331     *
7332     * @see elm_toggle_icon_set()
7333     */
7334    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7335    /**
7336     * @brief Sets the labels to be associated with the on and off states of the toggle.
7337     *
7338     * @param obj The toggle object
7339     * @param onlabel The label displayed when the toggle is in the "on" state
7340     * @param offlabel The label displayed when the toggle is in the "off" state
7341     */
7342    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7343    /**
7344     * @brief Gets the labels associated with the on and off states of the toggle.
7345     *
7346     * @param obj The toggle object
7347     * @param onlabel A char** to place the onlabel of @p obj into
7348     * @param offlabel A char** to place the offlabel of @p obj into
7349     */
7350    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7351    /**
7352     * @brief Sets the state of the toggle to @p state.
7353     *
7354     * @param obj The toggle object
7355     * @param state The state of @p obj
7356     */
7357    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7358    /**
7359     * @brief Gets the state of the toggle to @p state.
7360     *
7361     * @param obj The toggle object
7362     * @return The state of @p obj
7363     */
7364    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7365    /**
7366     * @brief Sets the state pointer of the toggle to @p statep.
7367     *
7368     * @param obj The toggle object
7369     * @param statep The state pointer of @p obj
7370     */
7371    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7372    /**
7373     * @}
7374     */
7375
7376    /**
7377     * @defgroup Frame Frame
7378     *
7379     * @image html img/widget/frame/preview-00.png
7380     * @image latex img/widget/frame/preview-00.eps
7381     *
7382     * @brief Frame is a widget that holds some content and has a title.
7383     *
7384     * The default look is a frame with a title, but Frame supports multple
7385     * styles:
7386     * @li default
7387     * @li pad_small
7388     * @li pad_medium
7389     * @li pad_large
7390     * @li pad_huge
7391     * @li outdent_top
7392     * @li outdent_bottom
7393     *
7394     * Of all this styles only default shows the title. Frame emits no signals.
7395     *
7396     * For a detailed example see the @ref tutorial_frame.
7397     *
7398     * @{
7399     */
7400    /**
7401     * @brief Add a new frame to the parent
7402     *
7403     * @param parent The parent object
7404     * @return The new object or NULL if it cannot be created
7405     */
7406    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7407    /**
7408     * @brief Set the frame label
7409     *
7410     * @param obj The frame object
7411     * @param label The label of this frame object
7412     *
7413     * @deprecated use elm_object_text_set() instead.
7414     */
7415    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7416    /**
7417     * @brief Get the frame label
7418     *
7419     * @param obj The frame object
7420     *
7421     * @return The label of this frame objet or NULL if unable to get frame
7422     *
7423     * @deprecated use elm_object_text_get() instead.
7424     */
7425    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7426    /**
7427     * @brief Set the content of the frame widget
7428     *
7429     * Once the content object is set, a previously set one will be deleted.
7430     * If you want to keep that old content object, use the
7431     * elm_frame_content_unset() function.
7432     *
7433     * @param obj The frame object
7434     * @param content The content will be filled in this frame object
7435     */
7436    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7437    /**
7438     * @brief Get the content of the frame widget
7439     *
7440     * Return the content object which is set for this widget
7441     *
7442     * @param obj The frame object
7443     * @return The content that is being used
7444     */
7445    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7446    /**
7447     * @brief Unset the content of the frame widget
7448     *
7449     * Unparent and return the content object which was set for this widget
7450     *
7451     * @param obj The frame object
7452     * @return The content that was being used
7453     */
7454    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7455    /**
7456     * @}
7457     */
7458
7459    /**
7460     * @defgroup Table Table
7461     *
7462     * A container widget to arrange other widgets in a table where items can
7463     * also span multiple columns or rows - even overlap (and then be raised or
7464     * lowered accordingly to adjust stacking if they do overlap).
7465     *
7466     * The followin are examples of how to use a table:
7467     * @li @ref tutorial_table_01
7468     * @li @ref tutorial_table_02
7469     *
7470     * @{
7471     */
7472    /**
7473     * @brief Add a new table to the parent
7474     *
7475     * @param parent The parent object
7476     * @return The new object or NULL if it cannot be created
7477     */
7478    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7479    /**
7480     * @brief Set the homogeneous layout in the table
7481     *
7482     * @param obj The layout object
7483     * @param homogeneous A boolean to set if the layout is homogeneous in the
7484     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7485     */
7486    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7487    /**
7488     * @brief Get the current table homogeneous mode.
7489     *
7490     * @param obj The table object
7491     * @return A boolean to indicating if the layout is homogeneous in the table
7492     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7493     */
7494    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7495    /**
7496     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7497     */
7498    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7499    /**
7500     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7501     */
7502    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7503    /**
7504     * @brief Set padding between cells.
7505     *
7506     * @param obj The layout object.
7507     * @param horizontal set the horizontal padding.
7508     * @param vertical set the vertical padding.
7509     *
7510     * Default value is 0.
7511     */
7512    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7513    /**
7514     * @brief Get padding between cells.
7515     *
7516     * @param obj The layout object.
7517     * @param horizontal set the horizontal padding.
7518     * @param vertical set the vertical padding.
7519     */
7520    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7521    /**
7522     * @brief Add a subobject on the table with the coordinates passed
7523     *
7524     * @param obj The table object
7525     * @param subobj The subobject to be added to the table
7526     * @param x Row number
7527     * @param y Column number
7528     * @param w rowspan
7529     * @param h colspan
7530     *
7531     * @note All positioning inside the table is relative to rows and columns, so
7532     * a value of 0 for x and y, means the top left cell of the table, and a
7533     * value of 1 for w and h means @p subobj only takes that 1 cell.
7534     */
7535    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7536    /**
7537     * @brief Remove child from table.
7538     *
7539     * @param obj The table object
7540     * @param subobj The subobject
7541     */
7542    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7543    /**
7544     * @brief Faster way to remove all child objects from a table object.
7545     *
7546     * @param obj The table object
7547     * @param clear If true, will delete children, else just remove from table.
7548     */
7549    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7550    /**
7551     * @brief Set the packing location of an existing child of the table
7552     *
7553     * @param subobj The subobject to be modified in the table
7554     * @param x Row number
7555     * @param y Column number
7556     * @param w rowspan
7557     * @param h colspan
7558     *
7559     * Modifies the position of an object already in the table.
7560     *
7561     * @note All positioning inside the table is relative to rows and columns, so
7562     * a value of 0 for x and y, means the top left cell of the table, and a
7563     * value of 1 for w and h means @p subobj only takes that 1 cell.
7564     */
7565    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7566    /**
7567     * @brief Get the packing location of an existing child of the table
7568     *
7569     * @param subobj The subobject to be modified in the table
7570     * @param x Row number
7571     * @param y Column number
7572     * @param w rowspan
7573     * @param h colspan
7574     *
7575     * @see elm_table_pack_set()
7576     */
7577    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7578    /**
7579     * @}
7580     */
7581
7582    /**
7583     * @defgroup Gengrid Gengrid (Generic grid)
7584     *
7585     * This widget aims to position objects in a grid layout while
7586     * actually creating and rendering only the visible ones, using the
7587     * same idea as the @ref Genlist "genlist": the user defines a @b
7588     * class for each item, specifying functions that will be called at
7589     * object creation, deletion, etc. When those items are selected by
7590     * the user, a callback function is issued. Users may interact with
7591     * a gengrid via the mouse (by clicking on items to select them and
7592     * clicking on the grid's viewport and swiping to pan the whole
7593     * view) or via the keyboard, navigating through item with the
7594     * arrow keys.
7595     *
7596     * @section Gengrid_Layouts Gengrid layouts
7597     *
7598     * Gengrids may layout its items in one of two possible layouts:
7599     * - horizontal or
7600     * - vertical.
7601     *
7602     * When in "horizontal mode", items will be placed in @b columns,
7603     * from top to bottom and, when the space for a column is filled,
7604     * another one is started on the right, thus expanding the grid
7605     * horizontally, making for horizontal scrolling. When in "vertical
7606     * mode" , though, items will be placed in @b rows, from left to
7607     * right and, when the space for a row is filled, another one is
7608     * started below, thus expanding the grid vertically (and making
7609     * for vertical scrolling).
7610     *
7611     * @section Gengrid_Items Gengrid items
7612     *
7613     * An item in a gengrid can have 0 or more text labels (they can be
7614     * regular text or textblock Evas objects - that's up to the style
7615     * to determine), 0 or more icons (which are simply objects
7616     * swallowed into the gengrid item's theming Edje object) and 0 or
7617     * more <b>boolean states</b>, which have the behavior left to the
7618     * user to define. The Edje part names for each of these properties
7619     * will be looked up, in the theme file for the gengrid, under the
7620     * Edje (string) data items named @c "labels", @c "icons" and @c
7621     * "states", respectively. For each of those properties, if more
7622     * than one part is provided, they must have names listed separated
7623     * by spaces in the data fields. For the default gengrid item
7624     * theme, we have @b one label part (@c "elm.text"), @b two icon
7625     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7626     * no state parts.
7627     *
7628     * A gengrid item may be at one of several styles. Elementary
7629     * provides one by default - "default", but this can be extended by
7630     * system or application custom themes/overlays/extensions (see
7631     * @ref Theme "themes" for more details).
7632     *
7633     * @section Gengrid_Item_Class Gengrid item classes
7634     *
7635     * In order to have the ability to add and delete items on the fly,
7636     * gengrid implements a class (callback) system where the
7637     * application provides a structure with information about that
7638     * type of item (gengrid may contain multiple different items with
7639     * different classes, states and styles). Gengrid will call the
7640     * functions in this struct (methods) when an item is "realized"
7641     * (i.e., created dynamically, while the user is scrolling the
7642     * grid). All objects will simply be deleted when no longer needed
7643     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7644     * contains the following members:
7645     * - @c item_style - This is a constant string and simply defines
7646     * the name of the item style. It @b must be specified and the
7647     * default should be @c "default".
7648     * - @c func.label_get - This function is called when an item
7649     * object is actually created. The @c data parameter will point to
7650     * the same data passed to elm_gengrid_item_append() and related
7651     * item creation functions. The @c obj parameter is the gengrid
7652     * object itself, while the @c part one is the name string of one
7653     * of the existing text parts in the Edje group implementing the
7654     * item's theme. This function @b must return a strdup'()ed string,
7655     * as the caller will free() it when done. See
7656     * #Elm_Gengrid_Item_Label_Get_Cb.
7657     * - @c func.icon_get - This function is called when an item object
7658     * is actually created. The @c data parameter will point to the
7659     * same data passed to elm_gengrid_item_append() and related item
7660     * creation functions. The @c obj parameter is the gengrid object
7661     * itself, while the @c part one is the name string of one of the
7662     * existing (icon) swallow parts in the Edje group implementing the
7663     * item's theme. It must return @c NULL, when no icon is desired,
7664     * or a valid object handle, otherwise. The object will be deleted
7665     * by the gengrid on its deletion or when the item is "unrealized".
7666     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7667     * - @c func.state_get - This function is called when an item
7668     * object is actually created. The @c data parameter will point to
7669     * the same data passed to elm_gengrid_item_append() and related
7670     * item creation functions. The @c obj parameter is the gengrid
7671     * object itself, while the @c part one is the name string of one
7672     * of the state parts in the Edje group implementing the item's
7673     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7674     * true/on. Gengrids will emit a signal to its theming Edje object
7675     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7676     * "source" arguments, respectively, when the state is true (the
7677     * default is false), where @c XXX is the name of the (state) part.
7678     * See #Elm_Gengrid_Item_State_Get_Cb.
7679     * - @c func.del - This is called when elm_gengrid_item_del() is
7680     * called on an item or elm_gengrid_clear() is called on the
7681     * gengrid. This is intended for use when gengrid items are
7682     * deleted, so any data attached to the item (e.g. its data
7683     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7684     *
7685     * @section Gengrid_Usage_Hints Usage hints
7686     *
7687     * If the user wants to have multiple items selected at the same
7688     * time, elm_gengrid_multi_select_set() will permit it. If the
7689     * gengrid is single-selection only (the default), then
7690     * elm_gengrid_select_item_get() will return the selected item or
7691     * @c NULL, if none is selected. If the gengrid is under
7692     * multi-selection, then elm_gengrid_selected_items_get() will
7693     * return a list (that is only valid as long as no items are
7694     * modified (added, deleted, selected or unselected) of child items
7695     * on a gengrid.
7696     *
7697     * If an item changes (internal (boolean) state, label or icon
7698     * changes), then use elm_gengrid_item_update() to have gengrid
7699     * update the item with the new state. A gengrid will re-"realize"
7700     * the item, thus calling the functions in the
7701     * #Elm_Gengrid_Item_Class set for that item.
7702     *
7703     * To programmatically (un)select an item, use
7704     * elm_gengrid_item_selected_set(). To get its selected state use
7705     * elm_gengrid_item_selected_get(). To make an item disabled
7706     * (unable to be selected and appear differently) use
7707     * elm_gengrid_item_disabled_set() to set this and
7708     * elm_gengrid_item_disabled_get() to get the disabled state.
7709     *
7710     * Grid cells will only have their selection smart callbacks called
7711     * when firstly getting selected. Any further clicks will do
7712     * nothing, unless you enable the "always select mode", with
7713     * elm_gengrid_always_select_mode_set(), thus making every click to
7714     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7715     * turn off the ability to select items entirely in the widget and
7716     * they will neither appear selected nor call the selection smart
7717     * callbacks.
7718     *
7719     * Remember that you can create new styles and add your own theme
7720     * augmentation per application with elm_theme_extension_add(). If
7721     * you absolutely must have a specific style that overrides any
7722     * theme the user or system sets up you can use
7723     * elm_theme_overlay_add() to add such a file.
7724     *
7725     * @section Gengrid_Smart_Events Gengrid smart events
7726     *
7727     * Smart events that you can add callbacks for are:
7728     * - @c "activated" - The user has double-clicked or pressed
7729     *   (enter|return|spacebar) on an item. The @c event_info parameter
7730     *   is the gengrid item that was activated.
7731     * - @c "clicked,double" - The user has double-clicked an item.
7732     *   The @c event_info parameter is the gengrid item that was double-clicked.
7733     * - @c "selected" - The user has made an item selected. The
7734     *   @c event_info parameter is the gengrid item that was selected.
7735     * - @c "unselected" - The user has made an item unselected. The
7736     *   @c event_info parameter is the gengrid item that was unselected.
7737     * - @c "realized" - This is called when the item in the gengrid
7738     *   has its implementing Evas object instantiated, de facto. @c
7739     *   event_info is the gengrid item that was created. The object
7740     *   may be deleted at any time, so it is highly advised to the
7741     *   caller @b not to use the object pointer returned from
7742     *   elm_gengrid_item_object_get(), because it may point to freed
7743     *   objects.
7744     * - @c "unrealized" - This is called when the implementing Evas
7745     *   object for this item is deleted. @c event_info is the gengrid
7746     *   item that was deleted.
7747     * - @c "changed" - Called when an item is added, removed, resized
7748     *   or moved and when the gengrid is resized or gets "horizontal"
7749     *   property changes.
7750     * - @c "scroll,anim,start" - This is called when scrolling animation has
7751     *   started.
7752     * - @c "scroll,anim,stop" - This is called when scrolling animation has
7753     *   stopped.
7754     * - @c "drag,start,up" - Called when the item in the gengrid has
7755     *   been dragged (not scrolled) up.
7756     * - @c "drag,start,down" - Called when the item in the gengrid has
7757     *   been dragged (not scrolled) down.
7758     * - @c "drag,start,left" - Called when the item in the gengrid has
7759     *   been dragged (not scrolled) left.
7760     * - @c "drag,start,right" - Called when the item in the gengrid has
7761     *   been dragged (not scrolled) right.
7762     * - @c "drag,stop" - Called when the item in the gengrid has
7763     *   stopped being dragged.
7764     * - @c "drag" - Called when the item in the gengrid is being
7765     *   dragged.
7766     * - @c "scroll" - called when the content has been scrolled
7767     *   (moved).
7768     * - @c "scroll,drag,start" - called when dragging the content has
7769     *   started.
7770     * - @c "scroll,drag,stop" - called when dragging the content has
7771     *   stopped.
7772     *
7773     * List of gendrid examples:
7774     * @li @ref gengrid_example
7775     */
7776
7777    /**
7778     * @addtogroup Gengrid
7779     * @{
7780     */
7781
7782    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7783    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7784    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7785    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7786    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. */
7787    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. */
7788    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7789
7790    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7791    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7792    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7793    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7794
7795    /**
7796     * @struct _Elm_Gengrid_Item_Class
7797     *
7798     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7799     * field details.
7800     */
7801    struct _Elm_Gengrid_Item_Class
7802      {
7803         const char             *item_style;
7804         struct _Elm_Gengrid_Item_Class_Func
7805           {
7806              Elm_Gengrid_Item_Label_Get_Cb label_get;
7807              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7808              Elm_Gengrid_Item_State_Get_Cb state_get;
7809              Elm_Gengrid_Item_Del_Cb       del;
7810           } func;
7811      }; /**< #Elm_Gengrid_Item_Class member definitions */
7812
7813    /**
7814     * Add a new gengrid widget to the given parent Elementary
7815     * (container) object
7816     *
7817     * @param parent The parent object
7818     * @return a new gengrid widget handle or @c NULL, on errors
7819     *
7820     * This function inserts a new gengrid widget on the canvas.
7821     *
7822     * @see elm_gengrid_item_size_set()
7823     * @see elm_gengrid_horizontal_set()
7824     * @see elm_gengrid_item_append()
7825     * @see elm_gengrid_item_del()
7826     * @see elm_gengrid_clear()
7827     *
7828     * @ingroup Gengrid
7829     */
7830    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7831
7832    /**
7833     * Set the size for the items of a given gengrid widget
7834     *
7835     * @param obj The gengrid object.
7836     * @param w The items' width.
7837     * @param h The items' height;
7838     *
7839     * A gengrid, after creation, has still no information on the size
7840     * to give to each of its cells. So, you most probably will end up
7841     * with squares one @ref Fingers "finger" wide, the default
7842     * size. Use this function to force a custom size for you items,
7843     * making them as big as you wish.
7844     *
7845     * @see elm_gengrid_item_size_get()
7846     *
7847     * @ingroup Gengrid
7848     */
7849    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7850
7851    /**
7852     * Get the size set for the items of a given gengrid widget
7853     *
7854     * @param obj The gengrid object.
7855     * @param w Pointer to a variable where to store the items' width.
7856     * @param h Pointer to a variable where to store the items' height.
7857     *
7858     * @note Use @c NULL pointers on the size values you're not
7859     * interested in: they'll be ignored by the function.
7860     *
7861     * @see elm_gengrid_item_size_get() for more details
7862     *
7863     * @ingroup Gengrid
7864     */
7865    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7866
7867    /**
7868     * Set the items grid's alignment within a given gengrid widget
7869     *
7870     * @param obj The gengrid object.
7871     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7872     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7873     *
7874     * This sets the alignment of the whole grid of items of a gengrid
7875     * within its given viewport. By default, those values are both
7876     * 0.5, meaning that the gengrid will have its items grid placed
7877     * exactly in the middle of its viewport.
7878     *
7879     * @note If given alignment values are out of the cited ranges,
7880     * they'll be changed to the nearest boundary values on the valid
7881     * ranges.
7882     *
7883     * @see elm_gengrid_align_get()
7884     *
7885     * @ingroup Gengrid
7886     */
7887    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7888
7889    /**
7890     * Get the items grid's alignment values within a given gengrid
7891     * widget
7892     *
7893     * @param obj The gengrid object.
7894     * @param align_x Pointer to a variable where to store the
7895     * horizontal alignment.
7896     * @param align_y Pointer to a variable where to store the vertical
7897     * alignment.
7898     *
7899     * @note Use @c NULL pointers on the alignment values you're not
7900     * interested in: they'll be ignored by the function.
7901     *
7902     * @see elm_gengrid_align_set() for more details
7903     *
7904     * @ingroup Gengrid
7905     */
7906    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7907
7908    /**
7909     * Set whether a given gengrid widget is or not able have items
7910     * @b reordered
7911     *
7912     * @param obj The gengrid object
7913     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7914     * @c EINA_FALSE to turn it off
7915     *
7916     * If a gengrid is set to allow reordering, a click held for more
7917     * than 0.5 over a given item will highlight it specially,
7918     * signalling the gengrid has entered the reordering state. From
7919     * that time on, the user will be able to, while still holding the
7920     * mouse button down, move the item freely in the gengrid's
7921     * viewport, replacing to said item to the locations it goes to.
7922     * The replacements will be animated and, whenever the user
7923     * releases the mouse button, the item being replaced gets a new
7924     * definitive place in the grid.
7925     *
7926     * @see elm_gengrid_reorder_mode_get()
7927     *
7928     * @ingroup Gengrid
7929     */
7930    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7931
7932    /**
7933     * Get whether a given gengrid widget is or not able have items
7934     * @b reordered
7935     *
7936     * @param obj The gengrid object
7937     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
7938     * off
7939     *
7940     * @see elm_gengrid_reorder_mode_set() for more details
7941     *
7942     * @ingroup Gengrid
7943     */
7944    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7945
7946    /**
7947     * Append a new item in a given gengrid widget.
7948     *
7949     * @param obj The gengrid object.
7950     * @param gic The item class for the item.
7951     * @param data The item data.
7952     * @param func Convenience function called when the item is
7953     * selected.
7954     * @param func_data Data to be passed to @p func.
7955     * @return A handle to the item added or @c NULL, on errors.
7956     *
7957     * This adds an item to the beginning of the gengrid.
7958     *
7959     * @see elm_gengrid_item_prepend()
7960     * @see elm_gengrid_item_insert_before()
7961     * @see elm_gengrid_item_insert_after()
7962     * @see elm_gengrid_item_del()
7963     *
7964     * @ingroup Gengrid
7965     */
7966    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);
7967
7968    /**
7969     * Prepend a new item in a given gengrid widget.
7970     *
7971     * @param obj The gengrid object.
7972     * @param gic The item class for the item.
7973     * @param data The item data.
7974     * @param func Convenience function called when the item is
7975     * selected.
7976     * @param func_data Data to be passed to @p func.
7977     * @return A handle to the item added or @c NULL, on errors.
7978     *
7979     * This adds an item to the end of the gengrid.
7980     *
7981     * @see elm_gengrid_item_append()
7982     * @see elm_gengrid_item_insert_before()
7983     * @see elm_gengrid_item_insert_after()
7984     * @see elm_gengrid_item_del()
7985     *
7986     * @ingroup Gengrid
7987     */
7988    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);
7989
7990    /**
7991     * Insert an item before another in a gengrid widget
7992     *
7993     * @param obj The gengrid object.
7994     * @param gic The item class for the item.
7995     * @param data The item data.
7996     * @param relative The item to place this new one before.
7997     * @param func Convenience function called when the item is
7998     * selected.
7999     * @param func_data Data to be passed to @p func.
8000     * @return A handle to the item added or @c NULL, on errors.
8001     *
8002     * This inserts an item before another in the gengrid.
8003     *
8004     * @see elm_gengrid_item_append()
8005     * @see elm_gengrid_item_prepend()
8006     * @see elm_gengrid_item_insert_after()
8007     * @see elm_gengrid_item_del()
8008     *
8009     * @ingroup Gengrid
8010     */
8011    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);
8012
8013    /**
8014     * Insert an item after another in a gengrid widget
8015     *
8016     * @param obj The gengrid object.
8017     * @param gic The item class for the item.
8018     * @param data The item data.
8019     * @param relative The item to place this new one after.
8020     * @param func Convenience function called when the item is
8021     * selected.
8022     * @param func_data Data to be passed to @p func.
8023     * @return A handle to the item added or @c NULL, on errors.
8024     *
8025     * This inserts an item after another in the gengrid.
8026     *
8027     * @see elm_gengrid_item_append()
8028     * @see elm_gengrid_item_prepend()
8029     * @see elm_gengrid_item_insert_after()
8030     * @see elm_gengrid_item_del()
8031     *
8032     * @ingroup Gengrid
8033     */
8034    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);
8035
8036    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);
8037
8038    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);
8039
8040    /**
8041     * Set whether items on a given gengrid widget are to get their
8042     * selection callbacks issued for @b every subsequent selection
8043     * click on them or just for the first click.
8044     *
8045     * @param obj The gengrid object
8046     * @param always_select @c EINA_TRUE to make items "always
8047     * selected", @c EINA_FALSE, otherwise
8048     *
8049     * By default, grid items will only call their selection callback
8050     * function when firstly getting selected, any subsequent further
8051     * clicks will do nothing. With this call, you make those
8052     * subsequent clicks also to issue the selection callbacks.
8053     *
8054     * @note <b>Double clicks</b> will @b always be reported on items.
8055     *
8056     * @see elm_gengrid_always_select_mode_get()
8057     *
8058     * @ingroup Gengrid
8059     */
8060    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8061
8062    /**
8063     * Get whether items on a given gengrid widget have their selection
8064     * callbacks issued for @b every subsequent selection click on them
8065     * or just for the first click.
8066     *
8067     * @param obj The gengrid object.
8068     * @return @c EINA_TRUE if the gengrid items are "always selected",
8069     * @c EINA_FALSE, otherwise
8070     *
8071     * @see elm_gengrid_always_select_mode_set() for more details
8072     *
8073     * @ingroup Gengrid
8074     */
8075    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8076
8077    /**
8078     * Set whether items on a given gengrid widget can be selected or not.
8079     *
8080     * @param obj The gengrid object
8081     * @param no_select @c EINA_TRUE to make items selectable,
8082     * @c EINA_FALSE otherwise
8083     *
8084     * This will make items in @p obj selectable or not. In the latter
8085     * case, any user interacion on the gendrid items will neither make
8086     * them appear selected nor them call their selection callback
8087     * functions.
8088     *
8089     * @see elm_gengrid_no_select_mode_get()
8090     *
8091     * @ingroup Gengrid
8092     */
8093    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8094
8095    /**
8096     * Get whether items on a given gengrid widget can be selected or
8097     * not.
8098     *
8099     * @param obj The gengrid object
8100     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8101     * otherwise
8102     *
8103     * @see elm_gengrid_no_select_mode_set() for more details
8104     *
8105     * @ingroup Gengrid
8106     */
8107    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8108
8109    /**
8110     * Enable or disable multi-selection in a given gengrid widget
8111     *
8112     * @param obj The gengrid object.
8113     * @param multi @c EINA_TRUE, to enable multi-selection,
8114     * @c EINA_FALSE to disable it.
8115     *
8116     * Multi-selection is the ability for one to have @b more than one
8117     * item selected, on a given gengrid, simultaneously. When it is
8118     * enabled, a sequence of clicks on different items will make them
8119     * all selected, progressively. A click on an already selected item
8120     * will unselect it. If interecting via the keyboard,
8121     * multi-selection is enabled while holding the "Shift" key.
8122     *
8123     * @note By default, multi-selection is @b disabled on gengrids
8124     *
8125     * @see elm_gengrid_multi_select_get()
8126     *
8127     * @ingroup Gengrid
8128     */
8129    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8130
8131    /**
8132     * Get whether multi-selection is enabled or disabled for a given
8133     * gengrid widget
8134     *
8135     * @param obj The gengrid object.
8136     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8137     * EINA_FALSE otherwise
8138     *
8139     * @see elm_gengrid_multi_select_set() for more details
8140     *
8141     * @ingroup Gengrid
8142     */
8143    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8144
8145    /**
8146     * Enable or disable bouncing effect for a given gengrid widget
8147     *
8148     * @param obj The gengrid object
8149     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8150     * @c EINA_FALSE to disable it
8151     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8152     * @c EINA_FALSE to disable it
8153     *
8154     * The bouncing effect occurs whenever one reaches the gengrid's
8155     * edge's while panning it -- it will scroll past its limits a
8156     * little bit and return to the edge again, in a animated for,
8157     * automatically.
8158     *
8159     * @note By default, gengrids have bouncing enabled on both axis
8160     *
8161     * @see elm_gengrid_bounce_get()
8162     *
8163     * @ingroup Gengrid
8164     */
8165    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8166
8167    /**
8168     * Get whether bouncing effects are enabled or disabled, for a
8169     * given gengrid widget, on each axis
8170     *
8171     * @param obj The gengrid object
8172     * @param h_bounce Pointer to a variable where to store the
8173     * horizontal bouncing flag.
8174     * @param v_bounce Pointer to a variable where to store the
8175     * vertical bouncing flag.
8176     *
8177     * @see elm_gengrid_bounce_set() for more details
8178     *
8179     * @ingroup Gengrid
8180     */
8181    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8182
8183    /**
8184     * Set a given gengrid widget's scrolling page size, relative to
8185     * its viewport size.
8186     *
8187     * @param obj The gengrid object
8188     * @param h_pagerel The horizontal page (relative) size
8189     * @param v_pagerel The vertical page (relative) size
8190     *
8191     * The gengrid's scroller is capable of binding scrolling by the
8192     * user to "pages". It means that, while scrolling and, specially
8193     * after releasing the mouse button, the grid will @b snap to the
8194     * nearest displaying page's area. When page sizes are set, the
8195     * grid's continuous content area is split into (equal) page sized
8196     * pieces.
8197     *
8198     * This function sets the size of a page <b>relatively to the
8199     * viewport dimensions</b> of the gengrid, for each axis. A value
8200     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8201     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8202     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8203     * 1.0. Values beyond those will make it behave behave
8204     * inconsistently. If you only want one axis to snap to pages, use
8205     * the value @c 0.0 for the other one.
8206     *
8207     * There is a function setting page size values in @b absolute
8208     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8209     * is mutually exclusive to this one.
8210     *
8211     * @see elm_gengrid_page_relative_get()
8212     *
8213     * @ingroup Gengrid
8214     */
8215    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8216
8217    /**
8218     * Get a given gengrid widget's scrolling page size, relative to
8219     * its viewport size.
8220     *
8221     * @param obj The gengrid object
8222     * @param h_pagerel Pointer to a variable where to store the
8223     * horizontal page (relative) size
8224     * @param v_pagerel Pointer to a variable where to store the
8225     * vertical page (relative) size
8226     *
8227     * @see elm_gengrid_page_relative_set() for more details
8228     *
8229     * @ingroup Gengrid
8230     */
8231    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8232
8233    /**
8234     * Set a given gengrid widget's scrolling page size
8235     *
8236     * @param obj The gengrid object
8237     * @param h_pagerel The horizontal page size, in pixels
8238     * @param v_pagerel The vertical page size, in pixels
8239     *
8240     * The gengrid's scroller is capable of binding scrolling by the
8241     * user to "pages". It means that, while scrolling and, specially
8242     * after releasing the mouse button, the grid will @b snap to the
8243     * nearest displaying page's area. When page sizes are set, the
8244     * grid's continuous content area is split into (equal) page sized
8245     * pieces.
8246     *
8247     * This function sets the size of a page of the gengrid, in pixels,
8248     * for each axis. Sane usable values are, between @c 0 and the
8249     * dimensions of @p obj, for each axis. Values beyond those will
8250     * make it behave behave inconsistently. If you only want one axis
8251     * to snap to pages, use the value @c 0 for the other one.
8252     *
8253     * There is a function setting page size values in @b relative
8254     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8255     * use is mutually exclusive to this one.
8256     *
8257     * @ingroup Gengrid
8258     */
8259    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8260
8261    /**
8262     * Set for what direction a given gengrid widget will expand while
8263     * placing its items.
8264     *
8265     * @param obj The gengrid object.
8266     * @param setting @c EINA_TRUE to make the gengrid expand
8267     * horizontally, @c EINA_FALSE to expand vertically.
8268     *
8269     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8270     * in @b columns, from top to bottom and, when the space for a
8271     * column is filled, another one is started on the right, thus
8272     * expanding the grid horizontally. When in "vertical mode"
8273     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8274     * to right and, when the space for a row is filled, another one is
8275     * started below, thus expanding the grid vertically.
8276     *
8277     * @see elm_gengrid_horizontal_get()
8278     *
8279     * @ingroup Gengrid
8280     */
8281    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8282
8283    /**
8284     * Get for what direction a given gengrid widget will expand while
8285     * placing its items.
8286     *
8287     * @param obj The gengrid object.
8288     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8289     * @c EINA_FALSE if it's set to expand vertically.
8290     *
8291     * @see elm_gengrid_horizontal_set() for more detais
8292     *
8293     * @ingroup Gengrid
8294     */
8295    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8296
8297    /**
8298     * Get the first item in a given gengrid widget
8299     *
8300     * @param obj The gengrid object
8301     * @return The first item's handle or @c NULL, if there are no
8302     * items in @p obj (and on errors)
8303     *
8304     * This returns the first item in the @p obj's internal list of
8305     * items.
8306     *
8307     * @see elm_gengrid_last_item_get()
8308     *
8309     * @ingroup Gengrid
8310     */
8311    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8312
8313    /**
8314     * Get the last item in a given gengrid widget
8315     *
8316     * @param obj The gengrid object
8317     * @return The last item's handle or @c NULL, if there are no
8318     * items in @p obj (and on errors)
8319     *
8320     * This returns the last item in the @p obj's internal list of
8321     * items.
8322     *
8323     * @see elm_gengrid_first_item_get()
8324     *
8325     * @ingroup Gengrid
8326     */
8327    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8328
8329    /**
8330     * Get the @b next item in a gengrid widget's internal list of items,
8331     * given a handle to one of those items.
8332     *
8333     * @param item The gengrid item to fetch next from
8334     * @return The item after @p item, or @c NULL if there's none (and
8335     * on errors)
8336     *
8337     * This returns the item placed after the @p item, on the container
8338     * gengrid.
8339     *
8340     * @see elm_gengrid_item_prev_get()
8341     *
8342     * @ingroup Gengrid
8343     */
8344    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8345
8346    /**
8347     * Get the @b previous item in a gengrid widget's internal list of items,
8348     * given a handle to one of those items.
8349     *
8350     * @param item The gengrid item to fetch previous from
8351     * @return The item before @p item, or @c NULL if there's none (and
8352     * on errors)
8353     *
8354     * This returns the item placed before the @p item, on the container
8355     * gengrid.
8356     *
8357     * @see elm_gengrid_item_next_get()
8358     *
8359     * @ingroup Gengrid
8360     */
8361    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8362
8363    /**
8364     * Get the gengrid object's handle which contains a given gengrid
8365     * item
8366     *
8367     * @param item The item to fetch the container from
8368     * @return The gengrid (parent) object
8369     *
8370     * This returns the gengrid object itself that an item belongs to.
8371     *
8372     * @ingroup Gengrid
8373     */
8374    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8375
8376    /**
8377     * Remove a gengrid item from the its parent, deleting it.
8378     *
8379     * @param item The item to be removed.
8380     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8381     *
8382     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8383     * once.
8384     *
8385     * @ingroup Gengrid
8386     */
8387    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8388
8389    /**
8390     * Update the contents of a given gengrid item
8391     *
8392     * @param item The gengrid item
8393     *
8394     * This updates an item by calling all the item class functions
8395     * again to get the icons, labels and states. Use this when the
8396     * original item data has changed and you want thta changes to be
8397     * reflected.
8398     *
8399     * @ingroup Gengrid
8400     */
8401    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8402    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8403    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8404
8405    /**
8406     * Return the data associated to a given gengrid item
8407     *
8408     * @param item The gengrid item.
8409     * @return the data associated to this item.
8410     *
8411     * This returns the @c data value passed on the
8412     * elm_gengrid_item_append() and related item addition calls.
8413     *
8414     * @see elm_gengrid_item_append()
8415     * @see elm_gengrid_item_data_set()
8416     *
8417     * @ingroup Gengrid
8418     */
8419    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8420
8421    /**
8422     * Set the data associated to a given gengrid item
8423     *
8424     * @param item The gengrid item
8425     * @param data The new data pointer to set on it
8426     *
8427     * This @b overrides the @c data value passed on the
8428     * elm_gengrid_item_append() and related item addition calls. This
8429     * function @b won't call elm_gengrid_item_update() automatically,
8430     * so you'd issue it afterwards if you want to hove the item
8431     * updated to reflect the that new data.
8432     *
8433     * @see elm_gengrid_item_data_get()
8434     *
8435     * @ingroup Gengrid
8436     */
8437    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8438
8439    /**
8440     * Get a given gengrid item's position, relative to the whole
8441     * gengrid's grid area.
8442     *
8443     * @param item The Gengrid item.
8444     * @param x Pointer to variable where to store the item's <b>row
8445     * number</b>.
8446     * @param y Pointer to variable where to store the item's <b>column
8447     * number</b>.
8448     *
8449     * This returns the "logical" position of the item whithin the
8450     * gengrid. For example, @c (0, 1) would stand for first row,
8451     * second column.
8452     *
8453     * @ingroup Gengrid
8454     */
8455    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8456
8457    /**
8458     * Set whether a given gengrid item is selected or not
8459     *
8460     * @param item The gengrid item
8461     * @param selected Use @c EINA_TRUE, to make it selected, @c
8462     * EINA_FALSE to make it unselected
8463     *
8464     * This sets the selected state of an item. If multi selection is
8465     * not enabled on the containing gengrid and @p selected is @c
8466     * EINA_TRUE, any other previously selected items will get
8467     * unselected in favor of this new one.
8468     *
8469     * @see elm_gengrid_item_selected_get()
8470     *
8471     * @ingroup Gengrid
8472     */
8473    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8474
8475    /**
8476     * Get whether a given gengrid item is selected or not
8477     *
8478     * @param item The gengrid item
8479     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8480     *
8481     * @see elm_gengrid_item_selected_set() for more details
8482     *
8483     * @ingroup Gengrid
8484     */
8485    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8486
8487    /**
8488     * Get the real Evas object created to implement the view of a
8489     * given gengrid item
8490     *
8491     * @param item The gengrid item.
8492     * @return the Evas object implementing this item's view.
8493     *
8494     * This returns the actual Evas object used to implement the
8495     * specified gengrid item's view. This may be @c NULL, as it may
8496     * not have been created or may have been deleted, at any time, by
8497     * the gengrid. <b>Do not modify this object</b> (move, resize,
8498     * show, hide, etc.), as the gengrid is controlling it. This
8499     * function is for querying, emitting custom signals or hooking
8500     * lower level callbacks for events on that object. Do not delete
8501     * this object under any circumstances.
8502     *
8503     * @see elm_gengrid_item_data_get()
8504     *
8505     * @ingroup Gengrid
8506     */
8507    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8508
8509    /**
8510     * Show the portion of a gengrid's internal grid containing a given
8511     * item, @b immediately.
8512     *
8513     * @param item The item to display
8514     *
8515     * This causes gengrid to @b redraw its viewport's contents to the
8516     * region contining the given @p item item, if it is not fully
8517     * visible.
8518     *
8519     * @see elm_gengrid_item_bring_in()
8520     *
8521     * @ingroup Gengrid
8522     */
8523    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8524
8525    /**
8526     * Animatedly bring in, to the visible are of a gengrid, a given
8527     * item on it.
8528     *
8529     * @param item The gengrid item to display
8530     *
8531     * This causes gengrig to jump to the given @p item item and show
8532     * it (by scrolling), if it is not fully visible. This will use
8533     * animation to do so and take a period of time to complete.
8534     *
8535     * @see elm_gengrid_item_show()
8536     *
8537     * @ingroup Gengrid
8538     */
8539    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8540
8541    /**
8542     * Set whether a given gengrid item is disabled or not.
8543     *
8544     * @param item The gengrid item
8545     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8546     * to enable it back.
8547     *
8548     * A disabled item cannot be selected or unselected. It will also
8549     * change its appearance, to signal the user it's disabled.
8550     *
8551     * @see elm_gengrid_item_disabled_get()
8552     *
8553     * @ingroup Gengrid
8554     */
8555    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8556
8557    /**
8558     * Get whether a given gengrid item is disabled or not.
8559     *
8560     * @param item The gengrid item
8561     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8562     * (and on errors).
8563     *
8564     * @see elm_gengrid_item_disabled_set() for more details
8565     *
8566     * @ingroup Gengrid
8567     */
8568    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8569
8570    /**
8571     * Set the text to be shown in a given gengrid item's tooltips.
8572     *
8573     * @param item The gengrid item
8574     * @param text The text to set in the content
8575     *
8576     * This call will setup the text to be used as tooltip to that item
8577     * (analogous to elm_object_tooltip_text_set(), but being item
8578     * tooltips with higher precedence than object tooltips). It can
8579     * have only one tooltip at a time, so any previous tooltip data
8580     * will get removed.
8581     *
8582     * @ingroup Gengrid
8583     */
8584    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8585
8586    /**
8587     * Set the content to be shown in a given gengrid item's tooltips
8588     *
8589     * @param item The gengrid item.
8590     * @param func The function returning the tooltip contents.
8591     * @param data What to provide to @a func as callback data/context.
8592     * @param del_cb Called when data is not needed anymore, either when
8593     *        another callback replaces @p func, the tooltip is unset with
8594     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8595     *        dies. This callback receives as its first parameter the
8596     *        given @p data, being @c event_info the item handle.
8597     *
8598     * This call will setup the tooltip's contents to @p item
8599     * (analogous to elm_object_tooltip_content_cb_set(), but being
8600     * item tooltips with higher precedence than object tooltips). It
8601     * can have only one tooltip at a time, so any previous tooltip
8602     * content will get removed. @p func (with @p data) will be called
8603     * every time Elementary needs to show the tooltip and it should
8604     * return a valid Evas object, which will be fully managed by the
8605     * tooltip system, getting deleted when the tooltip is gone.
8606     *
8607     * @ingroup Gengrid
8608     */
8609    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);
8610
8611    /**
8612     * Unset a tooltip from a given gengrid item
8613     *
8614     * @param item gengrid item to remove a previously set tooltip from.
8615     *
8616     * This call removes any tooltip set on @p item. The callback
8617     * provided as @c del_cb to
8618     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8619     * notify it is not used anymore (and have resources cleaned, if
8620     * need be).
8621     *
8622     * @see elm_gengrid_item_tooltip_content_cb_set()
8623     *
8624     * @ingroup Gengrid
8625     */
8626    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8627
8628    /**
8629     * Set a different @b style for a given gengrid item's tooltip.
8630     *
8631     * @param item gengrid item with tooltip set
8632     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8633     * "default", @c "transparent", etc)
8634     *
8635     * Tooltips can have <b>alternate styles</b> to be displayed on,
8636     * which are defined by the theme set on Elementary. This function
8637     * works analogously as elm_object_tooltip_style_set(), but here
8638     * applied only to gengrid item objects. The default style for
8639     * tooltips is @c "default".
8640     *
8641     * @note before you set a style you should define a tooltip with
8642     *       elm_gengrid_item_tooltip_content_cb_set() or
8643     *       elm_gengrid_item_tooltip_text_set()
8644     *
8645     * @see elm_gengrid_item_tooltip_style_get()
8646     *
8647     * @ingroup Gengrid
8648     */
8649    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8650
8651    /**
8652     * Get the style set a given gengrid item's tooltip.
8653     *
8654     * @param item gengrid item with tooltip already set on.
8655     * @return style the theme style in use, which defaults to
8656     *         "default". If the object does not have a tooltip set,
8657     *         then @c NULL is returned.
8658     *
8659     * @see elm_gengrid_item_tooltip_style_set() for more details
8660     *
8661     * @ingroup Gengrid
8662     */
8663    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8664    /**
8665     * @brief Disable size restrictions on an object's tooltip
8666     * @param item The tooltip's anchor object
8667     * @param disable If EINA_TRUE, size restrictions are disabled
8668     * @return EINA_FALSE on failure, EINA_TRUE on success
8669     *
8670     * This function allows a tooltip to expand beyond its parant window's canvas.
8671     * It will instead be limited only by the size of the display.
8672     */
8673    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8674    /**
8675     * @brief Retrieve size restriction state of an object's tooltip
8676     * @param item The tooltip's anchor object
8677     * @return If EINA_TRUE, size restrictions are disabled
8678     *
8679     * This function returns whether a tooltip is allowed to expand beyond
8680     * its parant window's canvas.
8681     * It will instead be limited only by the size of the display.
8682     */
8683    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8684    /**
8685     * Set the type of mouse pointer/cursor decoration to be shown,
8686     * when the mouse pointer is over the given gengrid widget item
8687     *
8688     * @param item gengrid item to customize cursor on
8689     * @param cursor the cursor type's name
8690     *
8691     * This function works analogously as elm_object_cursor_set(), but
8692     * here the cursor's changing area is restricted to the item's
8693     * area, and not the whole widget's. Note that that item cursors
8694     * have precedence over widget cursors, so that a mouse over @p
8695     * item will always show cursor @p type.
8696     *
8697     * If this function is called twice for an object, a previously set
8698     * cursor will be unset on the second call.
8699     *
8700     * @see elm_object_cursor_set()
8701     * @see elm_gengrid_item_cursor_get()
8702     * @see elm_gengrid_item_cursor_unset()
8703     *
8704     * @ingroup Gengrid
8705     */
8706    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8707
8708    /**
8709     * Get the type of mouse pointer/cursor decoration set to be shown,
8710     * when the mouse pointer is over the given gengrid widget item
8711     *
8712     * @param item gengrid item with custom cursor set
8713     * @return the cursor type's name or @c NULL, if no custom cursors
8714     * were set to @p item (and on errors)
8715     *
8716     * @see elm_object_cursor_get()
8717     * @see elm_gengrid_item_cursor_set() for more details
8718     * @see elm_gengrid_item_cursor_unset()
8719     *
8720     * @ingroup Gengrid
8721     */
8722    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8723
8724    /**
8725     * Unset any custom mouse pointer/cursor decoration set to be
8726     * shown, when the mouse pointer is over the given gengrid widget
8727     * item, thus making it show the @b default cursor again.
8728     *
8729     * @param item a gengrid item
8730     *
8731     * Use this call to undo any custom settings on this item's cursor
8732     * decoration, bringing it back to defaults (no custom style set).
8733     *
8734     * @see elm_object_cursor_unset()
8735     * @see elm_gengrid_item_cursor_set() for more details
8736     *
8737     * @ingroup Gengrid
8738     */
8739    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8740
8741    /**
8742     * Set a different @b style for a given custom cursor set for a
8743     * gengrid item.
8744     *
8745     * @param item gengrid item with custom cursor set
8746     * @param style the <b>theme style</b> to use (e.g. @c "default",
8747     * @c "transparent", etc)
8748     *
8749     * This function only makes sense when one is using custom mouse
8750     * cursor decorations <b>defined in a theme file</b> , which can
8751     * have, given a cursor name/type, <b>alternate styles</b> on
8752     * it. It works analogously as elm_object_cursor_style_set(), but
8753     * here applied only to gengrid item objects.
8754     *
8755     * @warning Before you set a cursor style you should have defined a
8756     *       custom cursor previously on the item, with
8757     *       elm_gengrid_item_cursor_set()
8758     *
8759     * @see elm_gengrid_item_cursor_engine_only_set()
8760     * @see elm_gengrid_item_cursor_style_get()
8761     *
8762     * @ingroup Gengrid
8763     */
8764    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8765
8766    /**
8767     * Get the current @b style set for a given gengrid item's custom
8768     * cursor
8769     *
8770     * @param item gengrid item with custom cursor set.
8771     * @return style the cursor style in use. If the object does not
8772     *         have a cursor set, then @c NULL is returned.
8773     *
8774     * @see elm_gengrid_item_cursor_style_set() for more details
8775     *
8776     * @ingroup Gengrid
8777     */
8778    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8779
8780    /**
8781     * Set if the (custom) cursor for a given gengrid item should be
8782     * searched in its theme, also, or should only rely on the
8783     * rendering engine.
8784     *
8785     * @param item item with custom (custom) cursor already set on
8786     * @param engine_only Use @c EINA_TRUE to have cursors looked for
8787     * only on those provided by the rendering engine, @c EINA_FALSE to
8788     * have them searched on the widget's theme, as well.
8789     *
8790     * @note This call is of use only if you've set a custom cursor
8791     * for gengrid items, with elm_gengrid_item_cursor_set().
8792     *
8793     * @note By default, cursors will only be looked for between those
8794     * provided by the rendering engine.
8795     *
8796     * @ingroup Gengrid
8797     */
8798    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8799
8800    /**
8801     * Get if the (custom) cursor for a given gengrid item is being
8802     * searched in its theme, also, or is only relying on the rendering
8803     * engine.
8804     *
8805     * @param item a gengrid item
8806     * @return @c EINA_TRUE, if cursors are being looked for only on
8807     * those provided by the rendering engine, @c EINA_FALSE if they
8808     * are being searched on the widget's theme, as well.
8809     *
8810     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8811     *
8812     * @ingroup Gengrid
8813     */
8814    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8815
8816    /**
8817     * Remove all items from a given gengrid widget
8818     *
8819     * @param obj The gengrid object.
8820     *
8821     * This removes (and deletes) all items in @p obj, leaving it
8822     * empty.
8823     *
8824     * @see elm_gengrid_item_del(), to remove just one item.
8825     *
8826     * @ingroup Gengrid
8827     */
8828    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8829
8830    /**
8831     * Get the selected item in a given gengrid widget
8832     *
8833     * @param obj The gengrid object.
8834     * @return The selected item's handleor @c NULL, if none is
8835     * selected at the moment (and on errors)
8836     *
8837     * This returns the selected item in @p obj. If multi selection is
8838     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8839     * the first item in the list is selected, which might not be very
8840     * useful. For that case, see elm_gengrid_selected_items_get().
8841     *
8842     * @ingroup Gengrid
8843     */
8844    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8845
8846    /**
8847     * Get <b>a list</b> of selected items in a given gengrid
8848     *
8849     * @param obj The gengrid object.
8850     * @return The list of selected items or @c NULL, if none is
8851     * selected at the moment (and on errors)
8852     *
8853     * This returns a list of the selected items, in the order that
8854     * they appear in the grid. This list is only valid as long as no
8855     * more items are selected or unselected (or unselected implictly
8856     * by deletion). The list contains #Elm_Gengrid_Item pointers as
8857     * data, naturally.
8858     *
8859     * @see elm_gengrid_selected_item_get()
8860     *
8861     * @ingroup Gengrid
8862     */
8863    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8864
8865    /**
8866     * @}
8867     */
8868
8869    /**
8870     * @defgroup Clock Clock
8871     *
8872     * @image html img/widget/clock/preview-00.png
8873     * @image latex img/widget/clock/preview-00.eps
8874     *
8875     * This is a @b digital clock widget. In its default theme, it has a
8876     * vintage "flipping numbers clock" appearance, which will animate
8877     * sheets of individual algarisms individually as time goes by.
8878     *
8879     * A newly created clock will fetch system's time (already
8880     * considering local time adjustments) to start with, and will tick
8881     * accondingly. It may or may not show seconds.
8882     *
8883     * Clocks have an @b edition mode. When in it, the sheets will
8884     * display extra arrow indications on the top and bottom and the
8885     * user may click on them to raise or lower the time values. After
8886     * it's told to exit edition mode, it will keep ticking with that
8887     * new time set (it keeps the difference from local time).
8888     *
8889     * Also, when under edition mode, user clicks on the cited arrows
8890     * which are @b held for some time will make the clock to flip the
8891     * sheet, thus editing the time, continuosly and automatically for
8892     * the user. The interval between sheet flips will keep growing in
8893     * time, so that it helps the user to reach a time which is distant
8894     * from the one set.
8895     *
8896     * The time display is, by default, in military mode (24h), but an
8897     * am/pm indicator may be optionally shown, too, when it will
8898     * switch to 12h.
8899     *
8900     * Smart callbacks one can register to:
8901     * - "changed" - the clock's user changed the time
8902     *
8903     * Here is an example on its usage:
8904     * @li @ref clock_example
8905     */
8906
8907    /**
8908     * @addtogroup Clock
8909     * @{
8910     */
8911
8912    /**
8913     * Identifiers for which clock digits should be editable, when a
8914     * clock widget is in edition mode. Values may be ORed together to
8915     * make a mask, naturally.
8916     *
8917     * @see elm_clock_edit_set()
8918     * @see elm_clock_digit_edit_set()
8919     */
8920    typedef enum _Elm_Clock_Digedit
8921      {
8922         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8923         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8924         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
8925         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8926         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
8927         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8928         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
8929         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
8930      } Elm_Clock_Digedit;
8931
8932    /**
8933     * Add a new clock widget to the given parent Elementary
8934     * (container) object
8935     *
8936     * @param parent The parent object
8937     * @return a new clock widget handle or @c NULL, on errors
8938     *
8939     * This function inserts a new clock widget on the canvas.
8940     *
8941     * @ingroup Clock
8942     */
8943    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8944
8945    /**
8946     * Set a clock widget's time, programmatically
8947     *
8948     * @param obj The clock widget object
8949     * @param hrs The hours to set
8950     * @param min The minutes to set
8951     * @param sec The secondes to set
8952     *
8953     * This function updates the time that is showed by the clock
8954     * widget.
8955     *
8956     *  Values @b must be set within the following ranges:
8957     * - 0 - 23, for hours
8958     * - 0 - 59, for minutes
8959     * - 0 - 59, for seconds,
8960     *
8961     * even if the clock is not in "military" mode.
8962     *
8963     * @warning The behavior for values set out of those ranges is @b
8964     * indefined.
8965     *
8966     * @ingroup Clock
8967     */
8968    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
8969
8970    /**
8971     * Get a clock widget's time values
8972     *
8973     * @param obj The clock object
8974     * @param[out] hrs Pointer to the variable to get the hours value
8975     * @param[out] min Pointer to the variable to get the minutes value
8976     * @param[out] sec Pointer to the variable to get the seconds value
8977     *
8978     * This function gets the time set for @p obj, returning
8979     * it on the variables passed as the arguments to function
8980     *
8981     * @note Use @c NULL pointers on the time values you're not
8982     * interested in: they'll be ignored by the function.
8983     *
8984     * @ingroup Clock
8985     */
8986    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
8987
8988    /**
8989     * Set whether a given clock widget is under <b>edition mode</b> or
8990     * under (default) displaying-only mode.
8991     *
8992     * @param obj The clock object
8993     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
8994     * put it back to "displaying only" mode
8995     *
8996     * This function makes a clock's time to be editable or not <b>by
8997     * user interaction</b>. When in edition mode, clocks @b stop
8998     * ticking, until one brings them back to canonical mode. The
8999     * elm_clock_digit_edit_set() function will influence which digits
9000     * of the clock will be editable. By default, all of them will be
9001     * (#ELM_CLOCK_NONE).
9002     *
9003     * @note am/pm sheets, if being shown, will @b always be editable
9004     * under edition mode.
9005     *
9006     * @see elm_clock_edit_get()
9007     *
9008     * @ingroup Clock
9009     */
9010    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9011
9012    /**
9013     * Retrieve whether a given clock widget is under <b>edition
9014     * mode</b> or under (default) displaying-only mode.
9015     *
9016     * @param obj The clock object
9017     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9018     * otherwise
9019     *
9020     * This function retrieves whether the clock's time can be edited
9021     * or not by user interaction.
9022     *
9023     * @see elm_clock_edit_set() for more details
9024     *
9025     * @ingroup Clock
9026     */
9027    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9028
9029    /**
9030     * Set what digits of the given clock widget should be editable
9031     * when in edition mode.
9032     *
9033     * @param obj The clock object
9034     * @param digedit Bit mask indicating the digits to be editable
9035     * (values in #Elm_Clock_Digedit).
9036     *
9037     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9038     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9039     * EINA_FALSE).
9040     *
9041     * @see elm_clock_digit_edit_get()
9042     *
9043     * @ingroup Clock
9044     */
9045    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9046
9047    /**
9048     * Retrieve what digits of the given clock widget should be
9049     * editable when in edition mode.
9050     *
9051     * @param obj The clock object
9052     * @return Bit mask indicating the digits to be editable
9053     * (values in #Elm_Clock_Digedit).
9054     *
9055     * @see elm_clock_digit_edit_set() for more details
9056     *
9057     * @ingroup Clock
9058     */
9059    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9060
9061    /**
9062     * Set if the given clock widget must show hours in military or
9063     * am/pm mode
9064     *
9065     * @param obj The clock object
9066     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9067     * to military mode
9068     *
9069     * This function sets if the clock must show hours in military or
9070     * am/pm mode. In some countries like Brazil the military mode
9071     * (00-24h-format) is used, in opposition to the USA, where the
9072     * am/pm mode is more commonly used.
9073     *
9074     * @see elm_clock_show_am_pm_get()
9075     *
9076     * @ingroup Clock
9077     */
9078    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9079
9080    /**
9081     * Get if the given clock widget shows hours in military or am/pm
9082     * mode
9083     *
9084     * @param obj The clock object
9085     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9086     * military
9087     *
9088     * This function gets if the clock shows hours in military or am/pm
9089     * mode.
9090     *
9091     * @see elm_clock_show_am_pm_set() for more details
9092     *
9093     * @ingroup Clock
9094     */
9095    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9096
9097    /**
9098     * Set if the given clock widget must show time with seconds or not
9099     *
9100     * @param obj The clock object
9101     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9102     *
9103     * This function sets if the given clock must show or not elapsed
9104     * seconds. By default, they are @b not shown.
9105     *
9106     * @see elm_clock_show_seconds_get()
9107     *
9108     * @ingroup Clock
9109     */
9110    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9111
9112    /**
9113     * Get whether the given clock widget is showing time with seconds
9114     * or not
9115     *
9116     * @param obj The clock object
9117     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9118     *
9119     * This function gets whether @p obj is showing or not the elapsed
9120     * seconds.
9121     *
9122     * @see elm_clock_show_seconds_set()
9123     *
9124     * @ingroup Clock
9125     */
9126    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9127
9128    /**
9129     * Set the interval on time updates for an user mouse button hold
9130     * on clock widgets' time edition.
9131     *
9132     * @param obj The clock object
9133     * @param interval The (first) interval value in seconds
9134     *
9135     * This interval value is @b decreased while the user holds the
9136     * mouse pointer either incrementing or decrementing a given the
9137     * clock digit's value.
9138     *
9139     * This helps the user to get to a given time distant from the
9140     * current one easier/faster, as it will start to flip quicker and
9141     * quicker on mouse button holds.
9142     *
9143     * The calculation for the next flip interval value, starting from
9144     * the one set with this call, is the previous interval divided by
9145     * 1.05, so it decreases a little bit.
9146     *
9147     * The default starting interval value for automatic flips is
9148     * @b 0.85 seconds.
9149     *
9150     * @see elm_clock_interval_get()
9151     *
9152     * @ingroup Clock
9153     */
9154    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9155
9156    /**
9157     * Get the interval on time updates for an user mouse button hold
9158     * on clock widgets' time edition.
9159     *
9160     * @param obj The clock object
9161     * @return The (first) interval value, in seconds, set on it
9162     *
9163     * @see elm_clock_interval_set() for more details
9164     *
9165     * @ingroup Clock
9166     */
9167    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9168
9169    /**
9170     * @}
9171     */
9172
9173    /**
9174     * @defgroup Layout Layout
9175     *
9176     * @image html img/widget/layout/preview-00.png
9177     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9178     *
9179     * @image html img/layout-predefined.png
9180     * @image latex img/layout-predefined.eps width=\textwidth
9181     *
9182     * This is a container widget that takes a standard Edje design file and
9183     * wraps it very thinly in a widget.
9184     *
9185     * An Edje design (theme) file has a very wide range of possibilities to
9186     * describe the behavior of elements added to the Layout. Check out the Edje
9187     * documentation and the EDC reference to get more information about what can
9188     * be done with Edje.
9189     *
9190     * Just like @ref List, @ref Box, and other container widgets, any
9191     * object added to the Layout will become its child, meaning that it will be
9192     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9193     *
9194     * The Layout widget can contain as many Contents, Boxes or Tables as
9195     * described in its theme file. For instance, objects can be added to
9196     * different Tables by specifying the respective Table part names. The same
9197     * is valid for Content and Box.
9198     *
9199     * The objects added as child of the Layout will behave as described in the
9200     * part description where they were added. There are 3 possible types of
9201     * parts where a child can be added:
9202     *
9203     * @section secContent Content (SWALLOW part)
9204     *
9205     * Only one object can be added to the @c SWALLOW part (but you still can
9206     * have many @c SWALLOW parts and one object on each of them). Use the @c
9207     * elm_layout_content_* set of functions to set, retrieve and unset objects
9208     * as content of the @c SWALLOW. After being set to this part, the object
9209     * size, position, visibility, clipping and other description properties
9210     * will be totally controled by the description of the given part (inside
9211     * the Edje theme file).
9212     *
9213     * One can use @c evas_object_size_hint_* functions on the child to have some
9214     * kind of control over its behavior, but the resulting behavior will still
9215     * depend heavily on the @c SWALLOW part description.
9216     *
9217     * The Edje theme also can change the part description, based on signals or
9218     * scripts running inside the theme. This change can also be animated. All of
9219     * this will affect the child object set as content accordingly. The object
9220     * size will be changed if the part size is changed, it will animate move if
9221     * the part is moving, and so on.
9222     *
9223     * The following picture demonstrates a Layout widget with a child object
9224     * added to its @c SWALLOW:
9225     *
9226     * @image html layout_swallow.png
9227     * @image latex layout_swallow.eps width=\textwidth
9228     *
9229     * @section secBox Box (BOX part)
9230     *
9231     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9232     * allows one to add objects to the box and have them distributed along its
9233     * area, accordingly to the specified @a layout property (now by @a layout we
9234     * mean the chosen layouting design of the Box, not the Layout widget
9235     * itself).
9236     *
9237     * A similar effect for having a box with its position, size and other things
9238     * controled by the Layout theme would be to create an Elementary @ref Box
9239     * widget and add it as a Content in the @c SWALLOW part.
9240     *
9241     * The main difference of using the Layout Box is that its behavior, the box
9242     * properties like layouting format, padding, align, etc. will be all
9243     * controled by the theme. This means, for example, that a signal could be
9244     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9245     * handled the signal by changing the box padding, or align, or both. Using
9246     * the Elementary @ref Box widget is not necessarily harder or easier, it
9247     * just depends on the circunstances and requirements.
9248     *
9249     * The Layout Box can be used through the @c elm_layout_box_* set of
9250     * functions.
9251     *
9252     * The following picture demonstrates a Layout widget with many child objects
9253     * added to its @c BOX part:
9254     *
9255     * @image html layout_box.png
9256     * @image latex layout_box.eps width=\textwidth
9257     *
9258     * @section secTable Table (TABLE part)
9259     *
9260     * Just like the @ref secBox, the Layout Table is very similar to the
9261     * Elementary @ref Table widget. It allows one to add objects to the Table
9262     * specifying the row and column where the object should be added, and any
9263     * column or row span if necessary.
9264     *
9265     * Again, we could have this design by adding a @ref Table widget to the @c
9266     * SWALLOW part using elm_layout_content_set(). The same difference happens
9267     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9268     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9269     *
9270     * The Layout Table can be used through the @c elm_layout_table_* set of
9271     * functions.
9272     *
9273     * The following picture demonstrates a Layout widget with many child objects
9274     * added to its @c TABLE part:
9275     *
9276     * @image html layout_table.png
9277     * @image latex layout_table.eps width=\textwidth
9278     *
9279     * @section secPredef Predefined Layouts
9280     *
9281     * Another interesting thing about the Layout widget is that it offers some
9282     * predefined themes that come with the default Elementary theme. These
9283     * themes can be set by the call elm_layout_theme_set(), and provide some
9284     * basic functionality depending on the theme used.
9285     *
9286     * Most of them already send some signals, some already provide a toolbar or
9287     * back and next buttons.
9288     *
9289     * These are available predefined theme layouts. All of them have class = @c
9290     * layout, group = @c application, and style = one of the following options:
9291     *
9292     * @li @c toolbar-content - application with toolbar and main content area
9293     * @li @c toolbar-content-back - application with toolbar and main content
9294     * area with a back button and title area
9295     * @li @c toolbar-content-back-next - application with toolbar and main
9296     * content area with a back and next buttons and title area
9297     * @li @c content-back - application with a main content area with a back
9298     * button and title area
9299     * @li @c content-back-next - application with a main content area with a
9300     * back and next buttons and title area
9301     * @li @c toolbar-vbox - application with toolbar and main content area as a
9302     * vertical box
9303     * @li @c toolbar-table - application with toolbar and main content area as a
9304     * table
9305     *
9306     * @section secExamples Examples
9307     *
9308     * Some examples of the Layout widget can be found here:
9309     * @li @ref layout_example_01
9310     * @li @ref layout_example_02
9311     * @li @ref layout_example_03
9312     * @li @ref layout_example_edc
9313     *
9314     */
9315
9316    /**
9317     * Add a new layout to the parent
9318     *
9319     * @param parent The parent object
9320     * @return The new object or NULL if it cannot be created
9321     *
9322     * @see elm_layout_file_set()
9323     * @see elm_layout_theme_set()
9324     *
9325     * @ingroup Layout
9326     */
9327    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9328    /**
9329     * Set the file that will be used as layout
9330     *
9331     * @param obj The layout object
9332     * @param file The path to file (edj) that will be used as layout
9333     * @param group The group that the layout belongs in edje file
9334     *
9335     * @return (1 = success, 0 = error)
9336     *
9337     * @ingroup Layout
9338     */
9339    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9340    /**
9341     * Set the edje group from the elementary theme that will be used as layout
9342     *
9343     * @param obj The layout object
9344     * @param clas the clas of the group
9345     * @param group the group
9346     * @param style the style to used
9347     *
9348     * @return (1 = success, 0 = error)
9349     *
9350     * @ingroup Layout
9351     */
9352    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9353    /**
9354     * Set the layout content.
9355     *
9356     * @param obj The layout object
9357     * @param swallow The swallow part name in the edje file
9358     * @param content The child that will be added in this layout object
9359     *
9360     * Once the content object is set, a previously set one will be deleted.
9361     * If you want to keep that old content object, use the
9362     * elm_layout_content_unset() function.
9363     *
9364     * @note In an Edje theme, the part used as a content container is called @c
9365     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9366     * expected to be a part name just like the second parameter of
9367     * elm_layout_box_append().
9368     *
9369     * @see elm_layout_box_append()
9370     * @see elm_layout_content_get()
9371     * @see elm_layout_content_unset()
9372     * @see @ref secBox
9373     *
9374     * @ingroup Layout
9375     */
9376    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9377    /**
9378     * Get the child object in the given content part.
9379     *
9380     * @param obj The layout object
9381     * @param swallow The SWALLOW part to get its content
9382     *
9383     * @return The swallowed object or NULL if none or an error occurred
9384     *
9385     * @see elm_layout_content_set()
9386     *
9387     * @ingroup Layout
9388     */
9389    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9390    /**
9391     * Unset the layout content.
9392     *
9393     * @param obj The layout object
9394     * @param swallow The swallow part name in the edje file
9395     * @return The content that was being used
9396     *
9397     * Unparent and return the content object which was set for this part.
9398     *
9399     * @see elm_layout_content_set()
9400     *
9401     * @ingroup Layout
9402     */
9403     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9404    /**
9405     * Set the text of the given part
9406     *
9407     * @param obj The layout object
9408     * @param part The TEXT part where to set the text
9409     * @param text The text to set
9410     *
9411     * @ingroup Layout
9412     * @deprecated use elm_object_text_* instead.
9413     */
9414    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9415    /**
9416     * Get the text set in the given part
9417     *
9418     * @param obj The layout object
9419     * @param part The TEXT part to retrieve the text off
9420     *
9421     * @return The text set in @p part
9422     *
9423     * @ingroup Layout
9424     * @deprecated use elm_object_text_* instead.
9425     */
9426    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9427    /**
9428     * Append child to layout box part.
9429     *
9430     * @param obj the layout object
9431     * @param part the box part to which the object will be appended.
9432     * @param child the child object to append to box.
9433     *
9434     * Once the object is appended, it will become child of the layout. Its
9435     * lifetime will be bound to the layout, whenever the layout dies the child
9436     * will be deleted automatically. One should use elm_layout_box_remove() to
9437     * make this layout forget about the object.
9438     *
9439     * @see elm_layout_box_prepend()
9440     * @see elm_layout_box_insert_before()
9441     * @see elm_layout_box_insert_at()
9442     * @see elm_layout_box_remove()
9443     *
9444     * @ingroup Layout
9445     */
9446    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9447    /**
9448     * Prepend child to layout box part.
9449     *
9450     * @param obj the layout object
9451     * @param part the box part to prepend.
9452     * @param child the child object to prepend to box.
9453     *
9454     * Once the object is prepended, it will become child of the layout. Its
9455     * lifetime will be bound to the layout, whenever the layout dies the child
9456     * will be deleted automatically. One should use elm_layout_box_remove() to
9457     * make this layout forget about the object.
9458     *
9459     * @see elm_layout_box_append()
9460     * @see elm_layout_box_insert_before()
9461     * @see elm_layout_box_insert_at()
9462     * @see elm_layout_box_remove()
9463     *
9464     * @ingroup Layout
9465     */
9466    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9467    /**
9468     * Insert child to layout box part before a reference object.
9469     *
9470     * @param obj the layout object
9471     * @param part the box part to insert.
9472     * @param child the child object to insert into box.
9473     * @param reference another reference object to insert before in box.
9474     *
9475     * Once the object is inserted, it will become child of the layout. Its
9476     * lifetime will be bound to the layout, whenever the layout dies the child
9477     * will be deleted automatically. One should use elm_layout_box_remove() to
9478     * make this layout forget about the object.
9479     *
9480     * @see elm_layout_box_append()
9481     * @see elm_layout_box_prepend()
9482     * @see elm_layout_box_insert_before()
9483     * @see elm_layout_box_remove()
9484     *
9485     * @ingroup Layout
9486     */
9487    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9488    /**
9489     * Insert child to layout box part at a given position.
9490     *
9491     * @param obj the layout object
9492     * @param part the box part to insert.
9493     * @param child the child object to insert into box.
9494     * @param pos the numeric position >=0 to insert the child.
9495     *
9496     * Once the object is inserted, it will become child of the layout. Its
9497     * lifetime will be bound to the layout, whenever the layout dies the child
9498     * will be deleted automatically. One should use elm_layout_box_remove() to
9499     * make this layout forget about the object.
9500     *
9501     * @see elm_layout_box_append()
9502     * @see elm_layout_box_prepend()
9503     * @see elm_layout_box_insert_before()
9504     * @see elm_layout_box_remove()
9505     *
9506     * @ingroup Layout
9507     */
9508    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9509    /**
9510     * Remove a child of the given part box.
9511     *
9512     * @param obj The layout object
9513     * @param part The box part name to remove child.
9514     * @param child The object to remove from box.
9515     * @return The object that was being used, or NULL if not found.
9516     *
9517     * The object will be removed from the box part and its lifetime will
9518     * not be handled by the layout anymore. This is equivalent to
9519     * elm_layout_content_unset() for box.
9520     *
9521     * @see elm_layout_box_append()
9522     * @see elm_layout_box_remove_all()
9523     *
9524     * @ingroup Layout
9525     */
9526    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9527    /**
9528     * Remove all child of the given part box.
9529     *
9530     * @param obj The layout object
9531     * @param part The box part name to remove child.
9532     * @param clear If EINA_TRUE, then all objects will be deleted as
9533     *        well, otherwise they will just be removed and will be
9534     *        dangling on the canvas.
9535     *
9536     * The objects will be removed from the box part and their lifetime will
9537     * not be handled by the layout anymore. This is equivalent to
9538     * elm_layout_box_remove() for all box children.
9539     *
9540     * @see elm_layout_box_append()
9541     * @see elm_layout_box_remove()
9542     *
9543     * @ingroup Layout
9544     */
9545    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9546    /**
9547     * Insert child to layout table part.
9548     *
9549     * @param obj the layout object
9550     * @param part the box part to pack child.
9551     * @param child_obj the child object to pack into table.
9552     * @param col the column to which the child should be added. (>= 0)
9553     * @param row the row to which the child should be added. (>= 0)
9554     * @param colspan how many columns should be used to store this object. (>=
9555     *        1)
9556     * @param rowspan how many rows should be used to store this object. (>= 1)
9557     *
9558     * Once the object is inserted, it will become child of the table. Its
9559     * lifetime will be bound to the layout, and whenever the layout dies the
9560     * child will be deleted automatically. One should use
9561     * elm_layout_table_remove() to make this layout forget about the object.
9562     *
9563     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9564     * more space than a single cell. For instance, the following code:
9565     * @code
9566     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9567     * @endcode
9568     *
9569     * Would result in an object being added like the following picture:
9570     *
9571     * @image html layout_colspan.png
9572     * @image latex layout_colspan.eps width=\textwidth
9573     *
9574     * @see elm_layout_table_unpack()
9575     * @see elm_layout_table_clear()
9576     *
9577     * @ingroup Layout
9578     */
9579    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);
9580    /**
9581     * Unpack (remove) a child of the given part table.
9582     *
9583     * @param obj The layout object
9584     * @param part The table part name to remove child.
9585     * @param child_obj The object to remove from table.
9586     * @return The object that was being used, or NULL if not found.
9587     *
9588     * The object will be unpacked from the table part and its lifetime
9589     * will not be handled by the layout anymore. This is equivalent to
9590     * elm_layout_content_unset() for table.
9591     *
9592     * @see elm_layout_table_pack()
9593     * @see elm_layout_table_clear()
9594     *
9595     * @ingroup Layout
9596     */
9597    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9598    /**
9599     * Remove all child of the given part table.
9600     *
9601     * @param obj The layout object
9602     * @param part The table part name to remove child.
9603     * @param clear If EINA_TRUE, then all objects will be deleted as
9604     *        well, otherwise they will just be removed and will be
9605     *        dangling on the canvas.
9606     *
9607     * The objects will be removed from the table part and their lifetime will
9608     * not be handled by the layout anymore. This is equivalent to
9609     * elm_layout_table_unpack() for all table children.
9610     *
9611     * @see elm_layout_table_pack()
9612     * @see elm_layout_table_unpack()
9613     *
9614     * @ingroup Layout
9615     */
9616    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9617    /**
9618     * Get the edje layout
9619     *
9620     * @param obj The layout object
9621     *
9622     * @return A Evas_Object with the edje layout settings loaded
9623     * with function elm_layout_file_set
9624     *
9625     * This returns the edje object. It is not expected to be used to then
9626     * swallow objects via edje_object_part_swallow() for example. Use
9627     * elm_layout_content_set() instead so child object handling and sizing is
9628     * done properly.
9629     *
9630     * @note This function should only be used if you really need to call some
9631     * low level Edje function on this edje object. All the common stuff (setting
9632     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9633     * with proper elementary functions.
9634     *
9635     * @see elm_object_signal_callback_add()
9636     * @see elm_object_signal_emit()
9637     * @see elm_object_text_part_set()
9638     * @see elm_layout_content_set()
9639     * @see elm_layout_box_append()
9640     * @see elm_layout_table_pack()
9641     * @see elm_layout_data_get()
9642     *
9643     * @ingroup Layout
9644     */
9645    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9646    /**
9647     * Get the edje data from the given layout
9648     *
9649     * @param obj The layout object
9650     * @param key The data key
9651     *
9652     * @return The edje data string
9653     *
9654     * This function fetches data specified inside the edje theme of this layout.
9655     * This function return NULL if data is not found.
9656     *
9657     * In EDC this comes from a data block within the group block that @p
9658     * obj was loaded from. E.g.
9659     *
9660     * @code
9661     * collections {
9662     *   group {
9663     *     name: "a_group";
9664     *     data {
9665     *       item: "key1" "value1";
9666     *       item: "key2" "value2";
9667     *     }
9668     *   }
9669     * }
9670     * @endcode
9671     *
9672     * @ingroup Layout
9673     */
9674    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9675    /**
9676     * Eval sizing
9677     *
9678     * @param obj The layout object
9679     *
9680     * Manually forces a sizing re-evaluation. This is useful when the minimum
9681     * size required by the edje theme of this layout has changed. The change on
9682     * the minimum size required by the edje theme is not immediately reported to
9683     * the elementary layout, so one needs to call this function in order to tell
9684     * the widget (layout) that it needs to reevaluate its own size.
9685     *
9686     * The minimum size of the theme is calculated based on minimum size of
9687     * parts, the size of elements inside containers like box and table, etc. All
9688     * of this can change due to state changes, and that's when this function
9689     * should be called.
9690     *
9691     * Also note that a standard signal of "size,eval" "elm" emitted from the
9692     * edje object will cause this to happen too.
9693     *
9694     * @ingroup Layout
9695     */
9696    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9697
9698    /**
9699     * Sets a specific cursor for an edje part.
9700     *
9701     * @param obj The layout object.
9702     * @param part_name a part from loaded edje group.
9703     * @param cursor cursor name to use, see Elementary_Cursor.h
9704     *
9705     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9706     *         part not exists or it has "mouse_events: 0".
9707     *
9708     * @ingroup Layout
9709     */
9710    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9711
9712    /**
9713     * Get the cursor to be shown when mouse is over an edje part
9714     *
9715     * @param obj The layout object.
9716     * @param part_name a part from loaded edje group.
9717     * @return the cursor name.
9718     *
9719     * @ingroup Layout
9720     */
9721    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9722
9723    /**
9724     * Unsets a cursor previously set with elm_layout_part_cursor_set().
9725     *
9726     * @param obj The layout object.
9727     * @param part_name a part from loaded edje group, that had a cursor set
9728     *        with elm_layout_part_cursor_set().
9729     *
9730     * @ingroup Layout
9731     */
9732    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9733
9734    /**
9735     * Sets a specific cursor style for an edje part.
9736     *
9737     * @param obj The layout object.
9738     * @param part_name a part from loaded edje group.
9739     * @param style the theme style to use (default, transparent, ...)
9740     *
9741     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9742     *         part not exists or it did not had a cursor set.
9743     *
9744     * @ingroup Layout
9745     */
9746    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9747
9748    /**
9749     * Gets a specific cursor style for an edje part.
9750     *
9751     * @param obj The layout object.
9752     * @param part_name a part from loaded edje group.
9753     *
9754     * @return the theme style in use, defaults to "default". If the
9755     *         object does not have a cursor set, then NULL is returned.
9756     *
9757     * @ingroup Layout
9758     */
9759    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9760
9761    /**
9762     * Sets if the cursor set should be searched on the theme or should use
9763     * the provided by the engine, only.
9764     *
9765     * @note before you set if should look on theme you should define a
9766     * cursor with elm_layout_part_cursor_set(). By default it will only
9767     * look for cursors provided by the engine.
9768     *
9769     * @param obj The layout object.
9770     * @param part_name a part from loaded edje group.
9771     * @param engine_only if cursors should be just provided by the engine
9772     *        or should also search on widget's theme as well
9773     *
9774     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9775     *         part not exists or it did not had a cursor set.
9776     *
9777     * @ingroup Layout
9778     */
9779    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);
9780
9781    /**
9782     * Gets a specific cursor engine_only for an edje part.
9783     *
9784     * @param obj The layout object.
9785     * @param part_name a part from loaded edje group.
9786     *
9787     * @return whenever the cursor is just provided by engine or also from theme.
9788     *
9789     * @ingroup Layout
9790     */
9791    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9792
9793 /**
9794  * @def elm_layout_icon_set
9795  * Convienience macro to set the icon object in a layout that follows the
9796  * Elementary naming convention for its parts.
9797  *
9798  * @ingroup Layout
9799  */
9800 #define elm_layout_icon_set(_ly, _obj) \
9801   do { \
9802     const char *sig; \
9803     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9804     if ((_obj)) sig = "elm,state,icon,visible"; \
9805     else sig = "elm,state,icon,hidden"; \
9806     elm_object_signal_emit((_ly), sig, "elm"); \
9807   } while (0)
9808
9809 /**
9810  * @def elm_layout_icon_get
9811  * Convienience macro to get the icon object from a layout that follows the
9812  * Elementary naming convention for its parts.
9813  *
9814  * @ingroup Layout
9815  */
9816 #define elm_layout_icon_get(_ly) \
9817   elm_layout_content_get((_ly), "elm.swallow.icon")
9818
9819 /**
9820  * @def elm_layout_end_set
9821  * Convienience macro to set the end object in a layout that follows the
9822  * Elementary naming convention for its parts.
9823  *
9824  * @ingroup Layout
9825  */
9826 #define elm_layout_end_set(_ly, _obj) \
9827   do { \
9828     const char *sig; \
9829     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9830     if ((_obj)) sig = "elm,state,end,visible"; \
9831     else sig = "elm,state,end,hidden"; \
9832     elm_object_signal_emit((_ly), sig, "elm"); \
9833   } while (0)
9834
9835 /**
9836  * @def elm_layout_end_get
9837  * Convienience macro to get the end object in a layout that follows the
9838  * Elementary naming convention for its parts.
9839  *
9840  * @ingroup Layout
9841  */
9842 #define elm_layout_end_get(_ly) \
9843   elm_layout_content_get((_ly), "elm.swallow.end")
9844
9845 /**
9846  * @def elm_layout_label_set
9847  * Convienience macro to set the label in a layout that follows the
9848  * Elementary naming convention for its parts.
9849  *
9850  * @ingroup Layout
9851  * @deprecated use elm_object_text_* instead.
9852  */
9853 #define elm_layout_label_set(_ly, _txt) \
9854   elm_layout_text_set((_ly), "elm.text", (_txt))
9855
9856 /**
9857  * @def elm_layout_label_get
9858  * Convienience macro to get the label in a layout that follows the
9859  * Elementary naming convention for its parts.
9860  *
9861  * @ingroup Layout
9862  * @deprecated use elm_object_text_* instead.
9863  */
9864 #define elm_layout_label_get(_ly) \
9865   elm_layout_text_get((_ly), "elm.text")
9866
9867    /* smart callbacks called:
9868     * "theme,changed" - when elm theme is changed.
9869     */
9870
9871    /**
9872     * @defgroup Notify Notify
9873     *
9874     * @image html img/widget/notify/preview-00.png
9875     * @image latex img/widget/notify/preview-00.eps
9876     *
9877     * Display a container in a particular region of the parent(top, bottom,
9878     * etc.  A timeout can be set to automatically hide the notify. This is so
9879     * that, after an evas_object_show() on a notify object, if a timeout was set
9880     * on it, it will @b automatically get hidden after that time.
9881     *
9882     * Signals that you can add callbacks for are:
9883     * @li "timeout" - when timeout happens on notify and it's hidden
9884     * @li "block,clicked" - when a click outside of the notify happens
9885     *
9886     * @ref tutorial_notify show usage of the API.
9887     *
9888     * @{
9889     */
9890    /**
9891     * @brief Possible orient values for notify.
9892     *
9893     * This values should be used in conjunction to elm_notify_orient_set() to
9894     * set the position in which the notify should appear(relative to its parent)
9895     * and in conjunction with elm_notify_orient_get() to know where the notify
9896     * is appearing.
9897     */
9898    typedef enum _Elm_Notify_Orient
9899      {
9900         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9901         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9902         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9903         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9904         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9905         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9906         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9907         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9908         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9909         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9910      } Elm_Notify_Orient;
9911    /**
9912     * @brief Add a new notify to the parent
9913     *
9914     * @param parent The parent object
9915     * @return The new object or NULL if it cannot be created
9916     */
9917    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9918    /**
9919     * @brief Set the content of the notify widget
9920     *
9921     * @param obj The notify object
9922     * @param content The content will be filled in this notify object
9923     *
9924     * Once the content object is set, a previously set one will be deleted. If
9925     * you want to keep that old content object, use the
9926     * elm_notify_content_unset() function.
9927     */
9928    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9929    /**
9930     * @brief Unset the content of the notify widget
9931     *
9932     * @param obj The notify object
9933     * @return The content that was being used
9934     *
9935     * Unparent and return the content object which was set for this widget
9936     *
9937     * @see elm_notify_content_set()
9938     */
9939    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9940    /**
9941     * @brief Return the content of the notify widget
9942     *
9943     * @param obj The notify object
9944     * @return The content that is being used
9945     *
9946     * @see elm_notify_content_set()
9947     */
9948    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9949    /**
9950     * @brief Set the notify parent
9951     *
9952     * @param obj The notify object
9953     * @param content The new parent
9954     *
9955     * Once the parent object is set, a previously set one will be disconnected
9956     * and replaced.
9957     */
9958    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9959    /**
9960     * @brief Get the notify parent
9961     *
9962     * @param obj The notify object
9963     * @return The parent
9964     *
9965     * @see elm_notify_parent_set()
9966     */
9967    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9968    /**
9969     * @brief Set the orientation
9970     *
9971     * @param obj The notify object
9972     * @param orient The new orientation
9973     *
9974     * Sets the position in which the notify will appear in its parent.
9975     *
9976     * @see @ref Elm_Notify_Orient for possible values.
9977     */
9978    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
9979    /**
9980     * @brief Return the orientation
9981     * @param obj The notify object
9982     * @return The orientation of the notification
9983     *
9984     * @see elm_notify_orient_set()
9985     * @see Elm_Notify_Orient
9986     */
9987    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9988    /**
9989     * @brief Set the time interval after which the notify window is going to be
9990     * hidden.
9991     *
9992     * @param obj The notify object
9993     * @param time The timeout in seconds
9994     *
9995     * This function sets a timeout and starts the timer controlling when the
9996     * notify is hidden. Since calling evas_object_show() on a notify restarts
9997     * the timer controlling when the notify is hidden, setting this before the
9998     * notify is shown will in effect mean starting the timer when the notify is
9999     * shown.
10000     *
10001     * @note Set a value <= 0.0 to disable a running timer.
10002     *
10003     * @note If the value > 0.0 and the notify is previously visible, the
10004     * timer will be started with this value, canceling any running timer.
10005     */
10006    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10007    /**
10008     * @brief Return the timeout value (in seconds)
10009     * @param obj the notify object
10010     *
10011     * @see elm_notify_timeout_set()
10012     */
10013    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10014    /**
10015     * @brief Sets whether events should be passed to by a click outside
10016     * its area.
10017     *
10018     * @param obj The notify object
10019     * @param repeats EINA_TRUE Events are repeats, else no
10020     *
10021     * When true if the user clicks outside the window the events will be caught
10022     * by the others widgets, else the events are blocked.
10023     *
10024     * @note The default value is EINA_TRUE.
10025     */
10026    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10027    /**
10028     * @brief Return true if events are repeat below the notify object
10029     * @param obj the notify object
10030     *
10031     * @see elm_notify_repeat_events_set()
10032     */
10033    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10034    /**
10035     * @}
10036     */
10037
10038    /**
10039     * @defgroup Hover Hover
10040     *
10041     * @image html img/widget/hover/preview-00.png
10042     * @image latex img/widget/hover/preview-00.eps
10043     *
10044     * A Hover object will hover over its @p parent object at the @p target
10045     * location. Anything in the background will be given a darker coloring to
10046     * indicate that the hover object is on top (at the default theme). When the
10047     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10048     * clicked that @b doesn't cause the hover to be dismissed.
10049     *
10050     * @note The hover object will take up the entire space of @p target
10051     * object.
10052     *
10053     * Elementary has the following styles for the hover widget:
10054     * @li default
10055     * @li popout
10056     * @li menu
10057     * @li hoversel_vertical
10058     *
10059     * The following are the available position for content:
10060     * @li left
10061     * @li top-left
10062     * @li top
10063     * @li top-right
10064     * @li right
10065     * @li bottom-right
10066     * @li bottom
10067     * @li bottom-left
10068     * @li middle
10069     * @li smart
10070     *
10071     * Signals that you can add callbacks for are:
10072     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10073     * @li "smart,changed" - a content object placed under the "smart"
10074     *                   policy was replaced to a new slot direction.
10075     *
10076     * See @ref tutorial_hover for more information.
10077     *
10078     * @{
10079     */
10080    typedef enum _Elm_Hover_Axis
10081      {
10082         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10083         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10084         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10085         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10086      } Elm_Hover_Axis;
10087    /**
10088     * @brief Adds a hover object to @p parent
10089     *
10090     * @param parent The parent object
10091     * @return The hover object or NULL if one could not be created
10092     */
10093    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10094    /**
10095     * @brief Sets the target object for the hover.
10096     *
10097     * @param obj The hover object
10098     * @param target The object to center the hover onto. The hover
10099     *
10100     * This function will cause the hover to be centered on the target object.
10101     */
10102    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10103    /**
10104     * @brief Gets the target object for the hover.
10105     *
10106     * @param obj The hover object
10107     * @param parent The object to locate the hover over.
10108     *
10109     * @see elm_hover_target_set()
10110     */
10111    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10112    /**
10113     * @brief Sets the parent object for the hover.
10114     *
10115     * @param obj The hover object
10116     * @param parent The object to locate the hover over.
10117     *
10118     * This function will cause the hover to take up the entire space that the
10119     * parent object fills.
10120     */
10121    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10122    /**
10123     * @brief Gets the parent object for the hover.
10124     *
10125     * @param obj The hover object
10126     * @return The parent object to locate the hover over.
10127     *
10128     * @see elm_hover_parent_set()
10129     */
10130    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10131    /**
10132     * @brief Sets the content of the hover object and the direction in which it
10133     * will pop out.
10134     *
10135     * @param obj The hover object
10136     * @param swallow The direction that the object will be displayed
10137     * at. Accepted values are "left", "top-left", "top", "top-right",
10138     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10139     * "smart".
10140     * @param content The content to place at @p swallow
10141     *
10142     * Once the content object is set for a given direction, a previously
10143     * set one (on the same direction) will be deleted. If you want to
10144     * keep that old content object, use the elm_hover_content_unset()
10145     * function.
10146     *
10147     * All directions may have contents at the same time, except for
10148     * "smart". This is a special placement hint and its use case
10149     * independs of the calculations coming from
10150     * elm_hover_best_content_location_get(). Its use is for cases when
10151     * one desires only one hover content, but with a dinamic special
10152     * placement within the hover area. The content's geometry, whenever
10153     * it changes, will be used to decide on a best location not
10154     * extrapolating the hover's parent object view to show it in (still
10155     * being the hover's target determinant of its medium part -- move and
10156     * resize it to simulate finger sizes, for example). If one of the
10157     * directions other than "smart" are used, a previously content set
10158     * using it will be deleted, and vice-versa.
10159     */
10160    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10161    /**
10162     * @brief Get the content of the hover object, in a given direction.
10163     *
10164     * Return the content object which was set for this widget in the
10165     * @p swallow direction.
10166     *
10167     * @param obj The hover object
10168     * @param swallow The direction that the object was display at.
10169     * @return The content that was being used
10170     *
10171     * @see elm_hover_content_set()
10172     */
10173    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10174    /**
10175     * @brief Unset the content of the hover object, in a given direction.
10176     *
10177     * Unparent and return the content object set at @p swallow direction.
10178     *
10179     * @param obj The hover object
10180     * @param swallow The direction that the object was display at.
10181     * @return The content that was being used.
10182     *
10183     * @see elm_hover_content_set()
10184     */
10185    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10186    /**
10187     * @brief Returns the best swallow location for content in the hover.
10188     *
10189     * @param obj The hover object
10190     * @param pref_axis The preferred orientation axis for the hover object to use
10191     * @return The edje location to place content into the hover or @c
10192     *         NULL, on errors.
10193     *
10194     * Best is defined here as the location at which there is the most available
10195     * space.
10196     *
10197     * @p pref_axis may be one of
10198     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10199     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10200     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10201     * - @c ELM_HOVER_AXIS_BOTH -- both
10202     *
10203     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10204     * nescessarily be along the horizontal axis("left" or "right"). If
10205     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10206     * be along the vertical axis("top" or "bottom"). Chossing
10207     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10208     * returned position may be in either axis.
10209     *
10210     * @see elm_hover_content_set()
10211     */
10212    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10213    /**
10214     * @}
10215     */
10216
10217    /* entry */
10218    /**
10219     * @defgroup Entry Entry
10220     *
10221     * @image html img/widget/entry/preview-00.png
10222     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10223     * @image html img/widget/entry/preview-01.png
10224     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10225     * @image html img/widget/entry/preview-02.png
10226     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10227     * @image html img/widget/entry/preview-03.png
10228     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10229     *
10230     * An entry is a convenience widget which shows a box that the user can
10231     * enter text into. Entries by default don't scroll, so they grow to
10232     * accomodate the entire text, resizing the parent window as needed. This
10233     * can be changed with the elm_entry_scrollable_set() function.
10234     *
10235     * They can also be single line or multi line (the default) and when set
10236     * to multi line mode they support text wrapping in any of the modes
10237     * indicated by #Elm_Wrap_Type.
10238     *
10239     * Other features include password mode, filtering of inserted text with
10240     * elm_entry_text_filter_append() and related functions, inline "items" and
10241     * formatted markup text.
10242     *
10243     * @section entry-markup Formatted text
10244     *
10245     * The markup tags supported by the Entry are defined by the theme, but
10246     * even when writing new themes or extensions it's a good idea to stick to
10247     * a sane default, to maintain coherency and avoid application breakages.
10248     * Currently defined by the default theme are the following tags:
10249     * @li \<br\>: Inserts a line break.
10250     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10251     * breaks.
10252     * @li \<tab\>: Inserts a tab.
10253     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10254     * enclosed text.
10255     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10256     * @li \<link\>...\</link\>: Underlines the enclosed text.
10257     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10258     *
10259     * @section entry-special Special markups
10260     *
10261     * Besides those used to format text, entries support two special markup
10262     * tags used to insert clickable portions of text or items inlined within
10263     * the text.
10264     *
10265     * @subsection entry-anchors Anchors
10266     *
10267     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10268     * \</a\> tags and an event will be generated when this text is clicked,
10269     * like this:
10270     *
10271     * @code
10272     * This text is outside <a href=anc-01>but this one is an anchor</a>
10273     * @endcode
10274     *
10275     * The @c href attribute in the opening tag gives the name that will be
10276     * used to identify the anchor and it can be any valid utf8 string.
10277     *
10278     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10279     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10280     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10281     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10282     * an anchor.
10283     *
10284     * @subsection entry-items Items
10285     *
10286     * Inlined in the text, any other @c Evas_Object can be inserted by using
10287     * \<item\> tags this way:
10288     *
10289     * @code
10290     * <item size=16x16 vsize=full href=emoticon/haha></item>
10291     * @endcode
10292     *
10293     * Just like with anchors, the @c href identifies each item, but these need,
10294     * in addition, to indicate their size, which is done using any one of
10295     * @c size, @c absize or @c relsize attributes. These attributes take their
10296     * value in the WxH format, where W is the width and H the height of the
10297     * item.
10298     *
10299     * @li absize: Absolute pixel size for the item. Whatever value is set will
10300     * be the item's size regardless of any scale value the object may have
10301     * been set to. The final line height will be adjusted to fit larger items.
10302     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10303     * for the object.
10304     * @li relsize: Size is adjusted for the item to fit within the current
10305     * line height.
10306     *
10307     * Besides their size, items are specificed a @c vsize value that affects
10308     * how their final size and position are calculated. The possible values
10309     * are:
10310     * @li ascent: Item will be placed within the line's baseline and its
10311     * ascent. That is, the height between the line where all characters are
10312     * positioned and the highest point in the line. For @c size and @c absize
10313     * items, the descent value will be added to the total line height to make
10314     * them fit. @c relsize items will be adjusted to fit within this space.
10315     * @li full: Items will be placed between the descent and ascent, or the
10316     * lowest point in the line and its highest.
10317     *
10318     * The next image shows different configurations of items and how they
10319     * are the previously mentioned options affect their sizes. In all cases,
10320     * the green line indicates the ascent, blue for the baseline and red for
10321     * the descent.
10322     *
10323     * @image html entry_item.png
10324     * @image latex entry_item.eps width=\textwidth
10325     *
10326     * And another one to show how size differs from absize. In the first one,
10327     * the scale value is set to 1.0, while the second one is using one of 2.0.
10328     *
10329     * @image html entry_item_scale.png
10330     * @image latex entry_item_scale.eps width=\textwidth
10331     *
10332     * After the size for an item is calculated, the entry will request an
10333     * object to place in its space. For this, the functions set with
10334     * elm_entry_item_provider_append() and related functions will be called
10335     * in order until one of them returns a @c non-NULL value. If no providers
10336     * are available, or all of them return @c NULL, then the entry falls back
10337     * to one of the internal defaults, provided the name matches with one of
10338     * them.
10339     *
10340     * All of the following are currently supported:
10341     *
10342     * - emoticon/angry
10343     * - emoticon/angry-shout
10344     * - emoticon/crazy-laugh
10345     * - emoticon/evil-laugh
10346     * - emoticon/evil
10347     * - emoticon/goggle-smile
10348     * - emoticon/grumpy
10349     * - emoticon/grumpy-smile
10350     * - emoticon/guilty
10351     * - emoticon/guilty-smile
10352     * - emoticon/haha
10353     * - emoticon/half-smile
10354     * - emoticon/happy-panting
10355     * - emoticon/happy
10356     * - emoticon/indifferent
10357     * - emoticon/kiss
10358     * - emoticon/knowing-grin
10359     * - emoticon/laugh
10360     * - emoticon/little-bit-sorry
10361     * - emoticon/love-lots
10362     * - emoticon/love
10363     * - emoticon/minimal-smile
10364     * - emoticon/not-happy
10365     * - emoticon/not-impressed
10366     * - emoticon/omg
10367     * - emoticon/opensmile
10368     * - emoticon/smile
10369     * - emoticon/sorry
10370     * - emoticon/squint-laugh
10371     * - emoticon/surprised
10372     * - emoticon/suspicious
10373     * - emoticon/tongue-dangling
10374     * - emoticon/tongue-poke
10375     * - emoticon/uh
10376     * - emoticon/unhappy
10377     * - emoticon/very-sorry
10378     * - emoticon/what
10379     * - emoticon/wink
10380     * - emoticon/worried
10381     * - emoticon/wtf
10382     *
10383     * Alternatively, an item may reference an image by its path, using
10384     * the URI form @c file:///path/to/an/image.png and the entry will then
10385     * use that image for the item.
10386     *
10387     * @section entry-files Loading and saving files
10388     *
10389     * Entries have convinience functions to load text from a file and save
10390     * changes back to it after a short delay. The automatic saving is enabled
10391     * by default, but can be disabled with elm_entry_autosave_set() and files
10392     * can be loaded directly as plain text or have any markup in them
10393     * recognized. See elm_entry_file_set() for more details.
10394     *
10395     * @section entry-signals Emitted signals
10396     *
10397     * This widget emits the following signals:
10398     *
10399     * @li "changed": The text within the entry was changed.
10400     * @li "changed,user": The text within the entry was changed because of user interaction.
10401     * @li "activated": The enter key was pressed on a single line entry.
10402     * @li "press": A mouse button has been pressed on the entry.
10403     * @li "longpressed": A mouse button has been pressed and held for a couple
10404     * seconds.
10405     * @li "clicked": The entry has been clicked (mouse press and release).
10406     * @li "clicked,double": The entry has been double clicked.
10407     * @li "clicked,triple": The entry has been triple clicked.
10408     * @li "focused": The entry has received focus.
10409     * @li "unfocused": The entry has lost focus.
10410     * @li "selection,paste": A paste of the clipboard contents was requested.
10411     * @li "selection,copy": A copy of the selected text into the clipboard was
10412     * requested.
10413     * @li "selection,cut": A cut of the selected text into the clipboard was
10414     * requested.
10415     * @li "selection,start": A selection has begun and no previous selection
10416     * existed.
10417     * @li "selection,changed": The current selection has changed.
10418     * @li "selection,cleared": The current selection has been cleared.
10419     * @li "cursor,changed": The cursor has changed position.
10420     * @li "anchor,clicked": An anchor has been clicked. The event_info
10421     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10422     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10423     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10424     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10425     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10426     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10427     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10428     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10429     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10430     * @li "preedit,changed": The preedit string has changed.
10431     *
10432     * @section entry-examples
10433     *
10434     * An overview of the Entry API can be seen in @ref entry_example_01
10435     *
10436     * @{
10437     */
10438    /**
10439     * @typedef Elm_Entry_Anchor_Info
10440     *
10441     * The info sent in the callback for the "anchor,clicked" signals emitted
10442     * by entries.
10443     */
10444    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10445    /**
10446     * @struct _Elm_Entry_Anchor_Info
10447     *
10448     * The info sent in the callback for the "anchor,clicked" signals emitted
10449     * by entries.
10450     */
10451    struct _Elm_Entry_Anchor_Info
10452      {
10453         const char *name; /**< The name of the anchor, as stated in its href */
10454         int         button; /**< The mouse button used to click on it */
10455         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10456                     y, /**< Anchor geometry, relative to canvas */
10457                     w, /**< Anchor geometry, relative to canvas */
10458                     h; /**< Anchor geometry, relative to canvas */
10459      };
10460    /**
10461     * @typedef Elm_Entry_Filter_Cb
10462     * This callback type is used by entry filters to modify text.
10463     * @param data The data specified as the last param when adding the filter
10464     * @param entry The entry object
10465     * @param text A pointer to the location of the text being filtered. This data can be modified,
10466     * but any additional allocations must be managed by the user.
10467     * @see elm_entry_text_filter_append
10468     * @see elm_entry_text_filter_prepend
10469     */
10470    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10471
10472    /**
10473     * This adds an entry to @p parent object.
10474     *
10475     * By default, entries are:
10476     * @li not scrolled
10477     * @li multi-line
10478     * @li word wrapped
10479     * @li autosave is enabled
10480     *
10481     * @param parent The parent object
10482     * @return The new object or NULL if it cannot be created
10483     */
10484    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10485    /**
10486     * Sets the entry to single line mode.
10487     *
10488     * In single line mode, entries don't ever wrap when the text reaches the
10489     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10490     * key will generate an @c "activate" event instead of adding a new line.
10491     *
10492     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10493     * and pressing enter will break the text into a different line
10494     * without generating any events.
10495     *
10496     * @param obj The entry object
10497     * @param single_line If true, the text in the entry
10498     * will be on a single line.
10499     */
10500    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10501    /**
10502     * Gets whether the entry is set to be single line.
10503     *
10504     * @param obj The entry object
10505     * @return single_line If true, the text in the entry is set to display
10506     * on a single line.
10507     *
10508     * @see elm_entry_single_line_set()
10509     */
10510    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10511    /**
10512     * Sets the entry to password mode.
10513     *
10514     * In password mode, entries are implicitly single line and the display of
10515     * any text in them is replaced with asterisks (*).
10516     *
10517     * @param obj The entry object
10518     * @param password If true, password mode is enabled.
10519     */
10520    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10521    /**
10522     * Gets whether the entry is set to password mode.
10523     *
10524     * @param obj The entry object
10525     * @return If true, the entry is set to display all characters
10526     * as asterisks (*).
10527     *
10528     * @see elm_entry_password_set()
10529     */
10530    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10531    /**
10532     * This sets the text displayed within the entry to @p entry.
10533     *
10534     * @param obj The entry object
10535     * @param entry The text to be displayed
10536     *
10537     * @deprecated Use elm_object_text_set() instead.
10538     */
10539    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10540    /**
10541     * This returns the text currently shown in object @p entry.
10542     * See also elm_entry_entry_set().
10543     *
10544     * @param obj The entry object
10545     * @return The currently displayed text or NULL on failure
10546     *
10547     * @deprecated Use elm_object_text_get() instead.
10548     */
10549    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10550    /**
10551     * Appends @p entry to the text of the entry.
10552     *
10553     * Adds the text in @p entry to the end of any text already present in the
10554     * widget.
10555     *
10556     * The appended text is subject to any filters set for the widget.
10557     *
10558     * @param obj The entry object
10559     * @param entry The text to be displayed
10560     *
10561     * @see elm_entry_text_filter_append()
10562     */
10563    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10564    /**
10565     * Gets whether the entry is empty.
10566     *
10567     * Empty means no text at all. If there are any markup tags, like an item
10568     * tag for which no provider finds anything, and no text is displayed, this
10569     * function still returns EINA_FALSE.
10570     *
10571     * @param obj The entry object
10572     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10573     */
10574    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10575    /**
10576     * Gets any selected text within the entry.
10577     *
10578     * If there's any selected text in the entry, this function returns it as
10579     * a string in markup format. NULL is returned if no selection exists or
10580     * if an error occurred.
10581     *
10582     * The returned value points to an internal string and should not be freed
10583     * or modified in any way. If the @p entry object is deleted or its
10584     * contents are changed, the returned pointer should be considered invalid.
10585     *
10586     * @param obj The entry object
10587     * @return The selected text within the entry or NULL on failure
10588     */
10589    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10590    /**
10591     * Inserts the given text into the entry at the current cursor position.
10592     *
10593     * This inserts text at the cursor position as if it was typed
10594     * by the user (note that this also allows markup which a user
10595     * can't just "type" as it would be converted to escaped text, so this
10596     * call can be used to insert things like emoticon items or bold push/pop
10597     * tags, other font and color change tags etc.)
10598     *
10599     * If any selection exists, it will be replaced by the inserted text.
10600     *
10601     * The inserted text is subject to any filters set for the widget.
10602     *
10603     * @param obj The entry object
10604     * @param entry The text to insert
10605     *
10606     * @see elm_entry_text_filter_append()
10607     */
10608    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10609    /**
10610     * Set the line wrap type to use on multi-line entries.
10611     *
10612     * Sets the wrap type used by the entry to any of the specified in
10613     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10614     * line (without inserting a line break or paragraph separator) when it
10615     * reaches the far edge of the widget.
10616     *
10617     * Note that this only makes sense for multi-line entries. A widget set
10618     * to be single line will never wrap.
10619     *
10620     * @param obj The entry object
10621     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10622     */
10623    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10624    /**
10625     * Gets the wrap mode the entry was set to use.
10626     *
10627     * @param obj The entry object
10628     * @return Wrap type
10629     *
10630     * @see also elm_entry_line_wrap_set()
10631     */
10632    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10633    /**
10634     * Sets if the entry is to be editable or not.
10635     *
10636     * By default, entries are editable and when focused, any text input by the
10637     * user will be inserted at the current cursor position. But calling this
10638     * function with @p editable as EINA_FALSE will prevent the user from
10639     * inputting text into the entry.
10640     *
10641     * The only way to change the text of a non-editable entry is to use
10642     * elm_object_text_set(), elm_entry_entry_insert() and other related
10643     * functions.
10644     *
10645     * @param obj The entry object
10646     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10647     * if not, the entry is read-only and no user input is allowed.
10648     */
10649    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10650    /**
10651     * Gets whether the entry is editable or not.
10652     *
10653     * @param obj The entry object
10654     * @return If true, the entry is editable by the user.
10655     * If false, it is not editable by the user
10656     *
10657     * @see elm_entry_editable_set()
10658     */
10659    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10660    /**
10661     * This drops any existing text selection within the entry.
10662     *
10663     * @param obj The entry object
10664     */
10665    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10666    /**
10667     * This selects all text within the entry.
10668     *
10669     * @param obj The entry object
10670     */
10671    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10672    /**
10673     * This moves the cursor one place to the right within the entry.
10674     *
10675     * @param obj The entry object
10676     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10677     */
10678    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10679    /**
10680     * This moves the cursor one place to the left within the entry.
10681     *
10682     * @param obj The entry object
10683     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10684     */
10685    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10686    /**
10687     * This moves the cursor one line up within the entry.
10688     *
10689     * @param obj The entry object
10690     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10691     */
10692    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10693    /**
10694     * This moves the cursor one line down within the entry.
10695     *
10696     * @param obj The entry object
10697     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10698     */
10699    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10700    /**
10701     * This moves the cursor to the beginning of the entry.
10702     *
10703     * @param obj The entry object
10704     */
10705    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10706    /**
10707     * This moves the cursor to the end of the entry.
10708     *
10709     * @param obj The entry object
10710     */
10711    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10712    /**
10713     * This moves the cursor to the beginning of the current line.
10714     *
10715     * @param obj The entry object
10716     */
10717    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10718    /**
10719     * This moves the cursor to the end of the current line.
10720     *
10721     * @param obj The entry object
10722     */
10723    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10724    /**
10725     * This begins a selection within the entry as though
10726     * the user were holding down the mouse button to make a selection.
10727     *
10728     * @param obj The entry object
10729     */
10730    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10731    /**
10732     * This ends a selection within the entry as though
10733     * the user had just released the mouse button while making a selection.
10734     *
10735     * @param obj The entry object
10736     */
10737    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10738    /**
10739     * Gets whether a format node exists at the current cursor position.
10740     *
10741     * A format node is anything that defines how the text is rendered. It can
10742     * be a visible format node, such as a line break or a paragraph separator,
10743     * or an invisible one, such as bold begin or end tag.
10744     * This function returns whether any format node exists at the current
10745     * cursor position.
10746     *
10747     * @param obj The entry object
10748     * @return EINA_TRUE if the current cursor position contains a format node,
10749     * EINA_FALSE otherwise.
10750     *
10751     * @see elm_entry_cursor_is_visible_format_get()
10752     */
10753    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10754    /**
10755     * Gets if the current cursor position holds a visible format node.
10756     *
10757     * @param obj The entry object
10758     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10759     * if it's an invisible one or no format exists.
10760     *
10761     * @see elm_entry_cursor_is_format_get()
10762     */
10763    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10764    /**
10765     * Gets the character pointed by the cursor at its current position.
10766     *
10767     * This function returns a string with the utf8 character stored at the
10768     * current cursor position.
10769     * Only the text is returned, any format that may exist will not be part
10770     * of the return value.
10771     *
10772     * @param obj The entry object
10773     * @return The text pointed by the cursors.
10774     */
10775    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10776    /**
10777     * This function returns the geometry of the cursor.
10778     *
10779     * It's useful if you want to draw something on the cursor (or where it is),
10780     * or for example in the case of scrolled entry where you want to show the
10781     * cursor.
10782     *
10783     * @param obj The entry object
10784     * @param x returned geometry
10785     * @param y returned geometry
10786     * @param w returned geometry
10787     * @param h returned geometry
10788     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10789     */
10790    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);
10791    /**
10792     * Sets the cursor position in the entry to the given value
10793     *
10794     * The value in @p pos is the index of the character position within the
10795     * contents of the string as returned by elm_entry_cursor_pos_get().
10796     *
10797     * @param obj The entry object
10798     * @param pos The position of the cursor
10799     */
10800    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10801    /**
10802     * Retrieves the current position of the cursor in the entry
10803     *
10804     * @param obj The entry object
10805     * @return The cursor position
10806     */
10807    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10808    /**
10809     * This executes a "cut" action on the selected text in the entry.
10810     *
10811     * @param obj The entry object
10812     */
10813    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10814    /**
10815     * This executes a "copy" action on the selected text in the entry.
10816     *
10817     * @param obj The entry object
10818     */
10819    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10820    /**
10821     * This executes a "paste" action in the entry.
10822     *
10823     * @param obj The entry object
10824     */
10825    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10826    /**
10827     * This clears and frees the items in a entry's contextual (longpress)
10828     * menu.
10829     *
10830     * @param obj The entry object
10831     *
10832     * @see elm_entry_context_menu_item_add()
10833     */
10834    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10835    /**
10836     * This adds an item to the entry's contextual menu.
10837     *
10838     * A longpress on an entry will make the contextual menu show up, if this
10839     * hasn't been disabled with elm_entry_context_menu_disabled_set().
10840     * By default, this menu provides a few options like enabling selection mode,
10841     * which is useful on embedded devices that need to be explicit about it,
10842     * and when a selection exists it also shows the copy and cut actions.
10843     *
10844     * With this function, developers can add other options to this menu to
10845     * perform any action they deem necessary.
10846     *
10847     * @param obj The entry object
10848     * @param label The item's text label
10849     * @param icon_file The item's icon file
10850     * @param icon_type The item's icon type
10851     * @param func The callback to execute when the item is clicked
10852     * @param data The data to associate with the item for related functions
10853     */
10854    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);
10855    /**
10856     * This disables the entry's contextual (longpress) menu.
10857     *
10858     * @param obj The entry object
10859     * @param disabled If true, the menu is disabled
10860     */
10861    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10862    /**
10863     * This returns whether the entry's contextual (longpress) menu is
10864     * disabled.
10865     *
10866     * @param obj The entry object
10867     * @return If true, the menu is disabled
10868     */
10869    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10870    /**
10871     * This appends a custom item provider to the list for that entry
10872     *
10873     * This appends the given callback. The list is walked from beginning to end
10874     * with each function called given the item href string in the text. If the
10875     * function returns an object handle other than NULL (it should create an
10876     * object to do this), then this object is used to replace that item. If
10877     * not the next provider is called until one provides an item object, or the
10878     * default provider in entry does.
10879     *
10880     * @param obj The entry object
10881     * @param func The function called to provide the item object
10882     * @param data The data passed to @p func
10883     *
10884     * @see @ref entry-items
10885     */
10886    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);
10887    /**
10888     * This prepends a custom item provider to the list for that entry
10889     *
10890     * This prepends the given callback. See elm_entry_item_provider_append() for
10891     * more information
10892     *
10893     * @param obj The entry object
10894     * @param func The function called to provide the item object
10895     * @param data The data passed to @p func
10896     */
10897    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);
10898    /**
10899     * This removes a custom item provider to the list for that entry
10900     *
10901     * This removes the given callback. See elm_entry_item_provider_append() for
10902     * more information
10903     *
10904     * @param obj The entry object
10905     * @param func The function called to provide the item object
10906     * @param data The data passed to @p func
10907     */
10908    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);
10909    /**
10910     * Append a filter function for text inserted in the entry
10911     *
10912     * Append the given callback to the list. This functions will be called
10913     * whenever any text is inserted into the entry, with the text to be inserted
10914     * as a parameter. The callback function is free to alter the text in any way
10915     * it wants, but it must remember to free the given pointer and update it.
10916     * If the new text is to be discarded, the function can free it and set its
10917     * text parameter to NULL. This will also prevent any following filters from
10918     * being called.
10919     *
10920     * @param obj The entry object
10921     * @param func The function to use as text filter
10922     * @param data User data to pass to @p func
10923     */
10924    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10925    /**
10926     * Prepend a filter function for text insdrted in the entry
10927     *
10928     * Prepend the given callback to the list. See elm_entry_text_filter_append()
10929     * for more information
10930     *
10931     * @param obj The entry object
10932     * @param func The function to use as text filter
10933     * @param data User data to pass to @p func
10934     */
10935    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10936    /**
10937     * Remove a filter from the list
10938     *
10939     * Removes the given callback from the filter list. See
10940     * elm_entry_text_filter_append() for more information.
10941     *
10942     * @param obj The entry object
10943     * @param func The filter function to remove
10944     * @param data The user data passed when adding the function
10945     */
10946    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10947    /**
10948     * This converts a markup (HTML-like) string into UTF-8.
10949     *
10950     * The returned string is a malloc'ed buffer and it should be freed when
10951     * not needed anymore.
10952     *
10953     * @param s The string (in markup) to be converted
10954     * @return The converted string (in UTF-8). It should be freed.
10955     */
10956    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10957    /**
10958     * This converts a UTF-8 string into markup (HTML-like).
10959     *
10960     * The returned string is a malloc'ed buffer and it should be freed when
10961     * not needed anymore.
10962     *
10963     * @param s The string (in UTF-8) to be converted
10964     * @return The converted string (in markup). It should be freed.
10965     */
10966    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10967    /**
10968     * This sets the file (and implicitly loads it) for the text to display and
10969     * then edit. All changes are written back to the file after a short delay if
10970     * the entry object is set to autosave (which is the default).
10971     *
10972     * If the entry had any other file set previously, any changes made to it
10973     * will be saved if the autosave feature is enabled, otherwise, the file
10974     * will be silently discarded and any non-saved changes will be lost.
10975     *
10976     * @param obj The entry object
10977     * @param file The path to the file to load and save
10978     * @param format The file format
10979     */
10980    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
10981    /**
10982     * Gets the file being edited by the entry.
10983     *
10984     * This function can be used to retrieve any file set on the entry for
10985     * edition, along with the format used to load and save it.
10986     *
10987     * @param obj The entry object
10988     * @param file The path to the file to load and save
10989     * @param format The file format
10990     */
10991    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
10992    /**
10993     * This function writes any changes made to the file set with
10994     * elm_entry_file_set()
10995     *
10996     * @param obj The entry object
10997     */
10998    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
10999    /**
11000     * This sets the entry object to 'autosave' the loaded text file or not.
11001     *
11002     * @param obj The entry object
11003     * @param autosave Autosave the loaded file or not
11004     *
11005     * @see elm_entry_file_set()
11006     */
11007    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11008    /**
11009     * This gets the entry object's 'autosave' status.
11010     *
11011     * @param obj The entry object
11012     * @return Autosave the loaded file or not
11013     *
11014     * @see elm_entry_file_set()
11015     */
11016    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11017    /**
11018     * Control pasting of text and images for the widget.
11019     *
11020     * Normally the entry allows both text and images to be pasted.  By setting
11021     * textonly to be true, this prevents images from being pasted.
11022     *
11023     * Note this only changes the behaviour of text.
11024     *
11025     * @param obj The entry object
11026     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11027     * text+image+other.
11028     */
11029    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11030    /**
11031     * Getting elm_entry text paste/drop mode.
11032     *
11033     * In textonly mode, only text may be pasted or dropped into the widget.
11034     *
11035     * @param obj The entry object
11036     * @return If the widget only accepts text from pastes.
11037     */
11038    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11039    /**
11040     * Enable or disable scrolling in entry
11041     *
11042     * Normally the entry is not scrollable unless you enable it with this call.
11043     *
11044     * @param obj The entry object
11045     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11046     */
11047    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11048    /**
11049     * Get the scrollable state of the entry
11050     *
11051     * Normally the entry is not scrollable. This gets the scrollable state
11052     * of the entry. See elm_entry_scrollable_set() for more information.
11053     *
11054     * @param obj The entry object
11055     * @return The scrollable state
11056     */
11057    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11058    /**
11059     * This sets a widget to be displayed to the left of a scrolled entry.
11060     *
11061     * @param obj The scrolled entry object
11062     * @param icon The widget to display on the left side of the scrolled
11063     * entry.
11064     *
11065     * @note A previously set widget will be destroyed.
11066     * @note If the object being set does not have minimum size hints set,
11067     * it won't get properly displayed.
11068     *
11069     * @see elm_entry_end_set()
11070     */
11071    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11072    /**
11073     * Gets the leftmost widget of the scrolled entry. This object is
11074     * owned by the scrolled entry and should not be modified.
11075     *
11076     * @param obj The scrolled entry object
11077     * @return the left widget inside the scroller
11078     */
11079    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11080    /**
11081     * Unset the leftmost widget of the scrolled entry, unparenting and
11082     * returning it.
11083     *
11084     * @param obj The scrolled entry object
11085     * @return the previously set icon sub-object of this entry, on
11086     * success.
11087     *
11088     * @see elm_entry_icon_set()
11089     */
11090    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11091    /**
11092     * Sets the visibility of the left-side widget of the scrolled entry,
11093     * set by elm_entry_icon_set().
11094     *
11095     * @param obj The scrolled entry object
11096     * @param setting EINA_TRUE if the object should be displayed,
11097     * EINA_FALSE if not.
11098     */
11099    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11100    /**
11101     * This sets a widget to be displayed to the end of a scrolled entry.
11102     *
11103     * @param obj The scrolled entry object
11104     * @param end The widget to display on the right side of the scrolled
11105     * entry.
11106     *
11107     * @note A previously set widget will be destroyed.
11108     * @note If the object being set does not have minimum size hints set,
11109     * it won't get properly displayed.
11110     *
11111     * @see elm_entry_icon_set
11112     */
11113    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11114    /**
11115     * Gets the endmost widget of the scrolled entry. This object is owned
11116     * by the scrolled entry and should not be modified.
11117     *
11118     * @param obj The scrolled entry object
11119     * @return the right widget inside the scroller
11120     */
11121    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11122    /**
11123     * Unset the endmost widget of the scrolled entry, unparenting and
11124     * returning it.
11125     *
11126     * @param obj The scrolled entry object
11127     * @return the previously set icon sub-object of this entry, on
11128     * success.
11129     *
11130     * @see elm_entry_icon_set()
11131     */
11132    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11133    /**
11134     * Sets the visibility of the end widget of the scrolled entry, set by
11135     * elm_entry_end_set().
11136     *
11137     * @param obj The scrolled entry object
11138     * @param setting EINA_TRUE if the object should be displayed,
11139     * EINA_FALSE if not.
11140     */
11141    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11142    /**
11143     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11144     * them).
11145     *
11146     * Setting an entry to single-line mode with elm_entry_single_line_set()
11147     * will automatically disable the display of scrollbars when the entry
11148     * moves inside its scroller.
11149     *
11150     * @param obj The scrolled entry object
11151     * @param h The horizontal scrollbar policy to apply
11152     * @param v The vertical scrollbar policy to apply
11153     */
11154    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11155    /**
11156     * This enables/disables bouncing within the entry.
11157     *
11158     * This function sets whether the entry will bounce when scrolling reaches
11159     * the end of the contained entry.
11160     *
11161     * @param obj The scrolled entry object
11162     * @param h The horizontal bounce state
11163     * @param v The vertical bounce state
11164     */
11165    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11166    /**
11167     * Get the bounce mode
11168     *
11169     * @param obj The Entry object
11170     * @param h_bounce Allow bounce horizontally
11171     * @param v_bounce Allow bounce vertically
11172     */
11173    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11174
11175    /* pre-made filters for entries */
11176    /**
11177     * @typedef Elm_Entry_Filter_Limit_Size
11178     *
11179     * Data for the elm_entry_filter_limit_size() entry filter.
11180     */
11181    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11182    /**
11183     * @struct _Elm_Entry_Filter_Limit_Size
11184     *
11185     * Data for the elm_entry_filter_limit_size() entry filter.
11186     */
11187    struct _Elm_Entry_Filter_Limit_Size
11188      {
11189         int max_char_count; /**< The maximum number of characters allowed. */
11190         int max_byte_count; /**< The maximum number of bytes allowed*/
11191      };
11192    /**
11193     * Filter inserted text based on user defined character and byte limits
11194     *
11195     * Add this filter to an entry to limit the characters that it will accept
11196     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11197     * The funtion works on the UTF-8 representation of the string, converting
11198     * it from the set markup, thus not accounting for any format in it.
11199     *
11200     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11201     * it as data when setting the filter. In it, it's possible to set limits
11202     * by character count or bytes (any of them is disabled if 0), and both can
11203     * be set at the same time. In that case, it first checks for characters,
11204     * then bytes.
11205     *
11206     * The function will cut the inserted text in order to allow only the first
11207     * number of characters that are still allowed. The cut is made in
11208     * characters, even when limiting by bytes, in order to always contain
11209     * valid ones and avoid half unicode characters making it in.
11210     *
11211     * This filter, like any others, does not apply when setting the entry text
11212     * directly with elm_object_text_set() (or the deprecated
11213     * elm_entry_entry_set()).
11214     */
11215    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11216    /**
11217     * @typedef Elm_Entry_Filter_Accept_Set
11218     *
11219     * Data for the elm_entry_filter_accept_set() entry filter.
11220     */
11221    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11222    /**
11223     * @struct _Elm_Entry_Filter_Accept_Set
11224     *
11225     * Data for the elm_entry_filter_accept_set() entry filter.
11226     */
11227    struct _Elm_Entry_Filter_Accept_Set
11228      {
11229         const char *accepted; /**< Set of characters accepted in the entry. */
11230         const char *rejected; /**< Set of characters rejected from the entry. */
11231      };
11232    /**
11233     * Filter inserted text based on accepted or rejected sets of characters
11234     *
11235     * Add this filter to an entry to restrict the set of accepted characters
11236     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11237     * This structure contains both accepted and rejected sets, but they are
11238     * mutually exclusive.
11239     *
11240     * The @c accepted set takes preference, so if it is set, the filter will
11241     * only work based on the accepted characters, ignoring anything in the
11242     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11243     *
11244     * In both cases, the function filters by matching utf8 characters to the
11245     * raw markup text, so it can be used to remove formatting tags.
11246     *
11247     * This filter, like any others, does not apply when setting the entry text
11248     * directly with elm_object_text_set() (or the deprecated
11249     * elm_entry_entry_set()).
11250     */
11251    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11252    /**
11253     * @}
11254     */
11255
11256    /* composite widgets - these basically put together basic widgets above
11257     * in convenient packages that do more than basic stuff */
11258
11259    /* anchorview */
11260    /**
11261     * @defgroup Anchorview Anchorview
11262     *
11263     * @image html img/widget/anchorview/preview-00.png
11264     * @image latex img/widget/anchorview/preview-00.eps
11265     *
11266     * Anchorview is for displaying text that contains markup with anchors
11267     * like <c>\<a href=1234\>something\</\></c> in it.
11268     *
11269     * Besides being styled differently, the anchorview widget provides the
11270     * necessary functionality so that clicking on these anchors brings up a
11271     * popup with user defined content such as "call", "add to contacts" or
11272     * "open web page". This popup is provided using the @ref Hover widget.
11273     *
11274     * This widget is very similar to @ref Anchorblock, so refer to that
11275     * widget for an example. The only difference Anchorview has is that the
11276     * widget is already provided with scrolling functionality, so if the
11277     * text set to it is too large to fit in the given space, it will scroll,
11278     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11279     * text can be displayed.
11280     *
11281     * This widget emits the following signals:
11282     * @li "anchor,clicked": will be called when an anchor is clicked. The
11283     * @p event_info parameter on the callback will be a pointer of type
11284     * ::Elm_Entry_Anchorview_Info.
11285     *
11286     * See @ref Anchorblock for an example on how to use both of them.
11287     *
11288     * @see Anchorblock
11289     * @see Entry
11290     * @see Hover
11291     *
11292     * @{
11293     */
11294    /**
11295     * @typedef Elm_Entry_Anchorview_Info
11296     *
11297     * The info sent in the callback for "anchor,clicked" signals emitted by
11298     * the Anchorview widget.
11299     */
11300    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11301    /**
11302     * @struct _Elm_Entry_Anchorview_Info
11303     *
11304     * The info sent in the callback for "anchor,clicked" signals emitted by
11305     * the Anchorview widget.
11306     */
11307    struct _Elm_Entry_Anchorview_Info
11308      {
11309         const char     *name; /**< Name of the anchor, as indicated in its href
11310                                    attribute */
11311         int             button; /**< The mouse button used to click on it */
11312         Evas_Object    *hover; /**< The hover object to use for the popup */
11313         struct {
11314              Evas_Coord    x, y, w, h;
11315         } anchor, /**< Geometry selection of text used as anchor */
11316           hover_parent; /**< Geometry of the object used as parent by the
11317                              hover */
11318         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11319                                              for content on the left side of
11320                                              the hover. Before calling the
11321                                              callback, the widget will make the
11322                                              necessary calculations to check
11323                                              which sides are fit to be set with
11324                                              content, based on the position the
11325                                              hover is activated and its distance
11326                                              to the edges of its parent object
11327                                              */
11328         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11329                                               the right side of the hover.
11330                                               See @ref hover_left */
11331         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11332                                             of the hover. See @ref hover_left */
11333         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11334                                                below the hover. See @ref
11335                                                hover_left */
11336      };
11337    /**
11338     * Add a new Anchorview object
11339     *
11340     * @param parent The parent object
11341     * @return The new object or NULL if it cannot be created
11342     */
11343    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11344    /**
11345     * Set the text to show in the anchorview
11346     *
11347     * Sets the text of the anchorview to @p text. This text can include markup
11348     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11349     * text that will be specially styled and react to click events, ended with
11350     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11351     * "anchor,clicked" signal that you can attach a callback to with
11352     * evas_object_smart_callback_add(). The name of the anchor given in the
11353     * event info struct will be the one set in the href attribute, in this
11354     * case, anchorname.
11355     *
11356     * Other markup can be used to style the text in different ways, but it's
11357     * up to the style defined in the theme which tags do what.
11358     * @deprecated use elm_object_text_set() instead.
11359     */
11360    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11361    /**
11362     * Get the markup text set for the anchorview
11363     *
11364     * Retrieves the text set on the anchorview, with markup tags included.
11365     *
11366     * @param obj The anchorview object
11367     * @return The markup text set or @c NULL if nothing was set or an error
11368     * occurred
11369     * @deprecated use elm_object_text_set() instead.
11370     */
11371    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11372    /**
11373     * Set the parent of the hover popup
11374     *
11375     * Sets the parent object to use by the hover created by the anchorview
11376     * when an anchor is clicked. See @ref Hover for more details on this.
11377     * If no parent is set, the same anchorview object will be used.
11378     *
11379     * @param obj The anchorview object
11380     * @param parent The object to use as parent for the hover
11381     */
11382    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11383    /**
11384     * Get the parent of the hover popup
11385     *
11386     * Get the object used as parent for the hover created by the anchorview
11387     * widget. See @ref Hover for more details on this.
11388     *
11389     * @param obj The anchorview object
11390     * @return The object used as parent for the hover, NULL if none is set.
11391     */
11392    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11393    /**
11394     * Set the style that the hover should use
11395     *
11396     * When creating the popup hover, anchorview will request that it's
11397     * themed according to @p style.
11398     *
11399     * @param obj The anchorview object
11400     * @param style The style to use for the underlying hover
11401     *
11402     * @see elm_object_style_set()
11403     */
11404    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11405    /**
11406     * Get the style that the hover should use
11407     *
11408     * Get the style the hover created by anchorview will use.
11409     *
11410     * @param obj The anchorview object
11411     * @return The style to use by the hover. NULL means the default is used.
11412     *
11413     * @see elm_object_style_set()
11414     */
11415    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11416    /**
11417     * Ends the hover popup in the anchorview
11418     *
11419     * When an anchor is clicked, the anchorview widget will create a hover
11420     * object to use as a popup with user provided content. This function
11421     * terminates this popup, returning the anchorview to its normal state.
11422     *
11423     * @param obj The anchorview object
11424     */
11425    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11426    /**
11427     * Set bouncing behaviour when the scrolled content reaches an edge
11428     *
11429     * Tell the internal scroller object whether it should bounce or not
11430     * when it reaches the respective edges for each axis.
11431     *
11432     * @param obj The anchorview object
11433     * @param h_bounce Whether to bounce or not in the horizontal axis
11434     * @param v_bounce Whether to bounce or not in the vertical axis
11435     *
11436     * @see elm_scroller_bounce_set()
11437     */
11438    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11439    /**
11440     * Get the set bouncing behaviour of the internal scroller
11441     *
11442     * Get whether the internal scroller should bounce when the edge of each
11443     * axis is reached scrolling.
11444     *
11445     * @param obj The anchorview object
11446     * @param h_bounce Pointer where to store the bounce state of the horizontal
11447     *                 axis
11448     * @param v_bounce Pointer where to store the bounce state of the vertical
11449     *                 axis
11450     *
11451     * @see elm_scroller_bounce_get()
11452     */
11453    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11454    /**
11455     * Appends a custom item provider to the given anchorview
11456     *
11457     * Appends the given function to the list of items providers. This list is
11458     * called, one function at a time, with the given @p data pointer, the
11459     * anchorview object and, in the @p item parameter, the item name as
11460     * referenced in its href string. Following functions in the list will be
11461     * called in order until one of them returns something different to NULL,
11462     * which should be an Evas_Object which will be used in place of the item
11463     * element.
11464     *
11465     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11466     * href=item/name\>\</item\>
11467     *
11468     * @param obj The anchorview object
11469     * @param func The function to add to the list of providers
11470     * @param data User data that will be passed to the callback function
11471     *
11472     * @see elm_entry_item_provider_append()
11473     */
11474    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);
11475    /**
11476     * Prepend a custom item provider to the given anchorview
11477     *
11478     * Like elm_anchorview_item_provider_append(), but it adds the function
11479     * @p func to the beginning of the list, instead of the end.
11480     *
11481     * @param obj The anchorview object
11482     * @param func The function to add to the list of providers
11483     * @param data User data that will be passed to the callback function
11484     */
11485    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);
11486    /**
11487     * Remove a custom item provider from the list of the given anchorview
11488     *
11489     * Removes the function and data pairing that matches @p func and @p data.
11490     * That is, unless the same function and same user data are given, the
11491     * function will not be removed from the list. This allows us to add the
11492     * same callback several times, with different @p data pointers and be
11493     * able to remove them later without conflicts.
11494     *
11495     * @param obj The anchorview object
11496     * @param func The function to remove from the list
11497     * @param data The data matching the function to remove from the list
11498     */
11499    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);
11500    /**
11501     * @}
11502     */
11503
11504    /* anchorblock */
11505    /**
11506     * @defgroup Anchorblock Anchorblock
11507     *
11508     * @image html img/widget/anchorblock/preview-00.png
11509     * @image latex img/widget/anchorblock/preview-00.eps
11510     *
11511     * Anchorblock is for displaying text that contains markup with anchors
11512     * like <c>\<a href=1234\>something\</\></c> in it.
11513     *
11514     * Besides being styled differently, the anchorblock widget provides the
11515     * necessary functionality so that clicking on these anchors brings up a
11516     * popup with user defined content such as "call", "add to contacts" or
11517     * "open web page". This popup is provided using the @ref Hover widget.
11518     *
11519     * This widget emits the following signals:
11520     * @li "anchor,clicked": will be called when an anchor is clicked. The
11521     * @p event_info parameter on the callback will be a pointer of type
11522     * ::Elm_Entry_Anchorblock_Info.
11523     *
11524     * @see Anchorview
11525     * @see Entry
11526     * @see Hover
11527     *
11528     * Since examples are usually better than plain words, we might as well
11529     * try @ref tutorial_anchorblock_example "one".
11530     */
11531    /**
11532     * @addtogroup Anchorblock
11533     * @{
11534     */
11535    /**
11536     * @typedef Elm_Entry_Anchorblock_Info
11537     *
11538     * The info sent in the callback for "anchor,clicked" signals emitted by
11539     * the Anchorblock widget.
11540     */
11541    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11542    /**
11543     * @struct _Elm_Entry_Anchorblock_Info
11544     *
11545     * The info sent in the callback for "anchor,clicked" signals emitted by
11546     * the Anchorblock widget.
11547     */
11548    struct _Elm_Entry_Anchorblock_Info
11549      {
11550         const char     *name; /**< Name of the anchor, as indicated in its href
11551                                    attribute */
11552         int             button; /**< The mouse button used to click on it */
11553         Evas_Object    *hover; /**< The hover object to use for the popup */
11554         struct {
11555              Evas_Coord    x, y, w, h;
11556         } anchor, /**< Geometry selection of text used as anchor */
11557           hover_parent; /**< Geometry of the object used as parent by the
11558                              hover */
11559         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11560                                              for content on the left side of
11561                                              the hover. Before calling the
11562                                              callback, the widget will make the
11563                                              necessary calculations to check
11564                                              which sides are fit to be set with
11565                                              content, based on the position the
11566                                              hover is activated and its distance
11567                                              to the edges of its parent object
11568                                              */
11569         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11570                                               the right side of the hover.
11571                                               See @ref hover_left */
11572         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11573                                             of the hover. See @ref hover_left */
11574         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11575                                                below the hover. See @ref
11576                                                hover_left */
11577      };
11578    /**
11579     * Add a new Anchorblock object
11580     *
11581     * @param parent The parent object
11582     * @return The new object or NULL if it cannot be created
11583     */
11584    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11585    /**
11586     * Set the text to show in the anchorblock
11587     *
11588     * Sets the text of the anchorblock to @p text. This text can include markup
11589     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11590     * of text that will be specially styled and react to click events, ended
11591     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11592     * "anchor,clicked" signal that you can attach a callback to with
11593     * evas_object_smart_callback_add(). The name of the anchor given in the
11594     * event info struct will be the one set in the href attribute, in this
11595     * case, anchorname.
11596     *
11597     * Other markup can be used to style the text in different ways, but it's
11598     * up to the style defined in the theme which tags do what.
11599     * @deprecated use elm_object_text_set() instead.
11600     */
11601    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11602    /**
11603     * Get the markup text set for the anchorblock
11604     *
11605     * Retrieves the text set on the anchorblock, with markup tags included.
11606     *
11607     * @param obj The anchorblock object
11608     * @return The markup text set or @c NULL if nothing was set or an error
11609     * occurred
11610     * @deprecated use elm_object_text_set() instead.
11611     */
11612    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11613    /**
11614     * Set the parent of the hover popup
11615     *
11616     * Sets the parent object to use by the hover created by the anchorblock
11617     * when an anchor is clicked. See @ref Hover for more details on this.
11618     *
11619     * @param obj The anchorblock object
11620     * @param parent The object to use as parent for the hover
11621     */
11622    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11623    /**
11624     * Get the parent of the hover popup
11625     *
11626     * Get the object used as parent for the hover created by the anchorblock
11627     * widget. See @ref Hover for more details on this.
11628     * If no parent is set, the same anchorblock object will be used.
11629     *
11630     * @param obj The anchorblock object
11631     * @return The object used as parent for the hover, NULL if none is set.
11632     */
11633    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11634    /**
11635     * Set the style that the hover should use
11636     *
11637     * When creating the popup hover, anchorblock will request that it's
11638     * themed according to @p style.
11639     *
11640     * @param obj The anchorblock object
11641     * @param style The style to use for the underlying hover
11642     *
11643     * @see elm_object_style_set()
11644     */
11645    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11646    /**
11647     * Get the style that the hover should use
11648     *
11649     * Get the style the hover created by anchorblock will use.
11650     *
11651     * @param obj The anchorblock object
11652     * @return The style to use by the hover. NULL means the default is used.
11653     *
11654     * @see elm_object_style_set()
11655     */
11656    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11657    /**
11658     * Ends the hover popup in the anchorblock
11659     *
11660     * When an anchor is clicked, the anchorblock widget will create a hover
11661     * object to use as a popup with user provided content. This function
11662     * terminates this popup, returning the anchorblock to its normal state.
11663     *
11664     * @param obj The anchorblock object
11665     */
11666    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11667    /**
11668     * Appends a custom item provider to the given anchorblock
11669     *
11670     * Appends the given function to the list of items providers. This list is
11671     * called, one function at a time, with the given @p data pointer, the
11672     * anchorblock object and, in the @p item parameter, the item name as
11673     * referenced in its href string. Following functions in the list will be
11674     * called in order until one of them returns something different to NULL,
11675     * which should be an Evas_Object which will be used in place of the item
11676     * element.
11677     *
11678     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11679     * href=item/name\>\</item\>
11680     *
11681     * @param obj The anchorblock object
11682     * @param func The function to add to the list of providers
11683     * @param data User data that will be passed to the callback function
11684     *
11685     * @see elm_entry_item_provider_append()
11686     */
11687    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);
11688    /**
11689     * Prepend a custom item provider to the given anchorblock
11690     *
11691     * Like elm_anchorblock_item_provider_append(), but it adds the function
11692     * @p func to the beginning of the list, instead of the end.
11693     *
11694     * @param obj The anchorblock object
11695     * @param func The function to add to the list of providers
11696     * @param data User data that will be passed to the callback function
11697     */
11698    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);
11699    /**
11700     * Remove a custom item provider from the list of the given anchorblock
11701     *
11702     * Removes the function and data pairing that matches @p func and @p data.
11703     * That is, unless the same function and same user data are given, the
11704     * function will not be removed from the list. This allows us to add the
11705     * same callback several times, with different @p data pointers and be
11706     * able to remove them later without conflicts.
11707     *
11708     * @param obj The anchorblock object
11709     * @param func The function to remove from the list
11710     * @param data The data matching the function to remove from the list
11711     */
11712    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);
11713    /**
11714     * @}
11715     */
11716
11717    /**
11718     * @defgroup Bubble Bubble
11719     *
11720     * @image html img/widget/bubble/preview-00.png
11721     * @image latex img/widget/bubble/preview-00.eps
11722     * @image html img/widget/bubble/preview-01.png
11723     * @image latex img/widget/bubble/preview-01.eps
11724     * @image html img/widget/bubble/preview-02.png
11725     * @image latex img/widget/bubble/preview-02.eps
11726     *
11727     * @brief The Bubble is a widget to show text similarly to how speech is
11728     * represented in comics.
11729     *
11730     * The bubble widget contains 5 important visual elements:
11731     * @li The frame is a rectangle with rounded rectangles and an "arrow".
11732     * @li The @p icon is an image to which the frame's arrow points to.
11733     * @li The @p label is a text which appears to the right of the icon if the
11734     * corner is "top_left" or "bottom_left" and is right aligned to the frame
11735     * otherwise.
11736     * @li The @p info is a text which appears to the right of the label. Info's
11737     * font is of a ligther color than label.
11738     * @li The @p content is an evas object that is shown inside the frame.
11739     *
11740     * The position of the arrow, icon, label and info depends on which corner is
11741     * selected. The four available corners are:
11742     * @li "top_left" - Default
11743     * @li "top_right"
11744     * @li "bottom_left"
11745     * @li "bottom_right"
11746     *
11747     * Signals that you can add callbacks for are:
11748     * @li "clicked" - This is called when a user has clicked the bubble.
11749     *
11750     * For an example of using a buble see @ref bubble_01_example_page "this".
11751     *
11752     * @{
11753     */
11754    /**
11755     * Add a new bubble to the parent
11756     *
11757     * @param parent The parent object
11758     * @return The new object or NULL if it cannot be created
11759     *
11760     * This function adds a text bubble to the given parent evas object.
11761     */
11762    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11763    /**
11764     * Set the label of the bubble
11765     *
11766     * @param obj The bubble object
11767     * @param label The string to set in the label
11768     *
11769     * This function sets the title of the bubble. Where this appears depends on
11770     * the selected corner.
11771     * @deprecated use elm_object_text_set() instead.
11772     */
11773    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11774    /**
11775     * Get the label of the bubble
11776     *
11777     * @param obj The bubble object
11778     * @return The string of set in the label
11779     *
11780     * This function gets the title of the bubble.
11781     * @deprecated use elm_object_text_get() instead.
11782     */
11783    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11784    /**
11785     * Set the info of the bubble
11786     *
11787     * @param obj The bubble object
11788     * @param info The given info about the bubble
11789     *
11790     * This function sets the info of the bubble. Where this appears depends on
11791     * the selected corner.
11792     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11793     */
11794    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11795    /**
11796     * Get the info of the bubble
11797     *
11798     * @param obj The bubble object
11799     *
11800     * @return The "info" string of the bubble
11801     *
11802     * This function gets the info text.
11803     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11804     */
11805    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11806    /**
11807     * Set the content to be shown in the bubble
11808     *
11809     * Once the content object is set, a previously set one will be deleted.
11810     * If you want to keep the old content object, use the
11811     * elm_bubble_content_unset() function.
11812     *
11813     * @param obj The bubble object
11814     * @param content The given content of the bubble
11815     *
11816     * This function sets the content shown on the middle of the bubble.
11817     */
11818    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11819    /**
11820     * Get the content shown in the bubble
11821     *
11822     * Return the content object which is set for this widget.
11823     *
11824     * @param obj The bubble object
11825     * @return The content that is being used
11826     */
11827    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11828    /**
11829     * Unset the content shown in the bubble
11830     *
11831     * Unparent and return the content object which was set for this widget.
11832     *
11833     * @param obj The bubble object
11834     * @return The content that was being used
11835     */
11836    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11837    /**
11838     * Set the icon of the bubble
11839     *
11840     * Once the icon object is set, a previously set one will be deleted.
11841     * If you want to keep the old content object, use the
11842     * elm_icon_content_unset() function.
11843     *
11844     * @param obj The bubble object
11845     * @param icon The given icon for the bubble
11846     */
11847    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11848    /**
11849     * Get the icon of the bubble
11850     *
11851     * @param obj The bubble object
11852     * @return The icon for the bubble
11853     *
11854     * This function gets the icon shown on the top left of bubble.
11855     */
11856    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11857    /**
11858     * Unset the icon of the bubble
11859     *
11860     * Unparent and return the icon object which was set for this widget.
11861     *
11862     * @param obj The bubble object
11863     * @return The icon that was being used
11864     */
11865    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11866    /**
11867     * Set the corner of the bubble
11868     *
11869     * @param obj The bubble object.
11870     * @param corner The given corner for the bubble.
11871     *
11872     * This function sets the corner of the bubble. The corner will be used to
11873     * determine where the arrow in the frame points to and where label, icon and
11874     * info arre shown.
11875     *
11876     * Possible values for corner are:
11877     * @li "top_left" - Default
11878     * @li "top_right"
11879     * @li "bottom_left"
11880     * @li "bottom_right"
11881     */
11882    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11883    /**
11884     * Get the corner of the bubble
11885     *
11886     * @param obj The bubble object.
11887     * @return The given corner for the bubble.
11888     *
11889     * This function gets the selected corner of the bubble.
11890     */
11891    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11892    /**
11893     * @}
11894     */
11895
11896    /**
11897     * @defgroup Photo Photo
11898     *
11899     * For displaying the photo of a person (contact). Simple yet
11900     * with a very specific purpose.
11901     *
11902     * Signals that you can add callbacks for are:
11903     *
11904     * "clicked" - This is called when a user has clicked the photo
11905     * "drag,start" - Someone started dragging the image out of the object
11906     * "drag,end" - Dragged item was dropped (somewhere)
11907     *
11908     * @{
11909     */
11910
11911    /**
11912     * Add a new photo to the parent
11913     *
11914     * @param parent The parent object
11915     * @return The new object or NULL if it cannot be created
11916     *
11917     * @ingroup Photo
11918     */
11919    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11920
11921    /**
11922     * Set the file that will be used as photo
11923     *
11924     * @param obj The photo object
11925     * @param file The path to file that will be used as photo
11926     *
11927     * @return (1 = success, 0 = error)
11928     *
11929     * @ingroup Photo
11930     */
11931    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
11932
11933    /**
11934     * Set the size that will be used on the photo
11935     *
11936     * @param obj The photo object
11937     * @param size The size that the photo will be
11938     *
11939     * @ingroup Photo
11940     */
11941    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
11942
11943    /**
11944     * Set if the photo should be completely visible or not.
11945     *
11946     * @param obj The photo object
11947     * @param fill if true the photo will be completely visible
11948     *
11949     * @ingroup Photo
11950     */
11951    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
11952
11953    /**
11954     * Set editability of the photo.
11955     *
11956     * An editable photo can be dragged to or from, and can be cut or
11957     * pasted too.  Note that pasting an image or dropping an item on
11958     * the image will delete the existing content.
11959     *
11960     * @param obj The photo object.
11961     * @param set To set of clear editablity.
11962     */
11963    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
11964
11965    /**
11966     * @}
11967     */
11968
11969    /* gesture layer */
11970    /**
11971     * @defgroup Elm_Gesture_Layer Gesture Layer
11972     * Gesture Layer Usage:
11973     *
11974     * Use Gesture Layer to detect gestures.
11975     * The advantage is that you don't have to implement
11976     * gesture detection, just set callbacks of gesture state.
11977     * By using gesture layer we make standard interface.
11978     *
11979     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
11980     * with a parent object parameter.
11981     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
11982     * call. Usually with same object as target (2nd parameter).
11983     *
11984     * Now you need to tell gesture layer what gestures you follow.
11985     * This is done with @ref elm_gesture_layer_cb_set call.
11986     * By setting the callback you actually saying to gesture layer:
11987     * I would like to know when the gesture @ref Elm_Gesture_Types
11988     * switches to state @ref Elm_Gesture_State.
11989     *
11990     * Next, you need to implement the actual action that follows the input
11991     * in your callback.
11992     *
11993     * Note that if you like to stop being reported about a gesture, just set
11994     * all callbacks referring this gesture to NULL.
11995     * (again with @ref elm_gesture_layer_cb_set)
11996     *
11997     * The information reported by gesture layer to your callback is depending
11998     * on @ref Elm_Gesture_Types:
11999     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12000     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12001     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12002     *
12003     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12004     * @ref ELM_GESTURE_MOMENTUM.
12005     *
12006     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12007     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12008     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12009     * Note that we consider a flick as a line-gesture that should be completed
12010     * in flick-time-limit as defined in @ref Config.
12011     *
12012     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12013     *
12014     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12015     * */
12016
12017    /**
12018     * @enum _Elm_Gesture_Types
12019     * Enum of supported gesture types.
12020     * @ingroup Elm_Gesture_Layer
12021     */
12022    enum _Elm_Gesture_Types
12023      {
12024         ELM_GESTURE_FIRST = 0,
12025
12026         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12027         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12028         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12029         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12030
12031         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12032
12033         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12034         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12035
12036         ELM_GESTURE_ZOOM, /**< Zoom */
12037         ELM_GESTURE_ROTATE, /**< Rotate */
12038
12039         ELM_GESTURE_LAST
12040      };
12041
12042    /**
12043     * @typedef Elm_Gesture_Types
12044     * gesture types enum
12045     * @ingroup Elm_Gesture_Layer
12046     */
12047    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12048
12049    /**
12050     * @enum _Elm_Gesture_State
12051     * Enum of gesture states.
12052     * @ingroup Elm_Gesture_Layer
12053     */
12054    enum _Elm_Gesture_State
12055      {
12056         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12057         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12058         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12059         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12060         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12061      };
12062
12063    /**
12064     * @typedef Elm_Gesture_State
12065     * gesture states enum
12066     * @ingroup Elm_Gesture_Layer
12067     */
12068    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12069
12070    /**
12071     * @struct _Elm_Gesture_Taps_Info
12072     * Struct holds taps info for user
12073     * @ingroup Elm_Gesture_Layer
12074     */
12075    struct _Elm_Gesture_Taps_Info
12076      {
12077         Evas_Coord x, y;         /**< Holds center point between fingers */
12078         unsigned int n;          /**< Number of fingers tapped           */
12079         unsigned int timestamp;  /**< event timestamp       */
12080      };
12081
12082    /**
12083     * @typedef Elm_Gesture_Taps_Info
12084     * holds taps info for user
12085     * @ingroup Elm_Gesture_Layer
12086     */
12087    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12088
12089    /**
12090     * @struct _Elm_Gesture_Momentum_Info
12091     * Struct holds momentum info for user
12092     * x1 and y1 are not necessarily in sync
12093     * x1 holds x value of x direction starting point
12094     * and same holds for y1.
12095     * This is noticeable when doing V-shape movement
12096     * @ingroup Elm_Gesture_Layer
12097     */
12098    struct _Elm_Gesture_Momentum_Info
12099      {  /* Report line ends, timestamps, and momentum computed        */
12100         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12101         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12102         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12103         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12104
12105         unsigned int tx; /**< Timestamp of start of final x-swipe */
12106         unsigned int ty; /**< Timestamp of start of final y-swipe */
12107
12108         Evas_Coord mx; /**< Momentum on X */
12109         Evas_Coord my; /**< Momentum on Y */
12110      };
12111
12112    /**
12113     * @typedef Elm_Gesture_Momentum_Info
12114     * holds momentum info for user
12115     * @ingroup Elm_Gesture_Layer
12116     */
12117     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12118
12119    /**
12120     * @struct _Elm_Gesture_Line_Info
12121     * Struct holds line info for user
12122     * @ingroup Elm_Gesture_Layer
12123     */
12124    struct _Elm_Gesture_Line_Info
12125      {  /* Report line ends, timestamps, and momentum computed      */
12126         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12127         unsigned int n;            /**< Number of fingers (lines)   */
12128         /* FIXME should be radians, bot degrees */
12129         double angle;              /**< Angle (direction) of lines  */
12130      };
12131
12132    /**
12133     * @typedef Elm_Gesture_Line_Info
12134     * Holds line info for user
12135     * @ingroup Elm_Gesture_Layer
12136     */
12137     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12138
12139    /**
12140     * @struct _Elm_Gesture_Zoom_Info
12141     * Struct holds zoom info for user
12142     * @ingroup Elm_Gesture_Layer
12143     */
12144    struct _Elm_Gesture_Zoom_Info
12145      {
12146         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12147         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12148         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12149         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12150      };
12151
12152    /**
12153     * @typedef Elm_Gesture_Zoom_Info
12154     * Holds zoom info for user
12155     * @ingroup Elm_Gesture_Layer
12156     */
12157    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12158
12159    /**
12160     * @struct _Elm_Gesture_Rotate_Info
12161     * Struct holds rotation info for user
12162     * @ingroup Elm_Gesture_Layer
12163     */
12164    struct _Elm_Gesture_Rotate_Info
12165      {
12166         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12167         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12168         double base_angle; /**< Holds start-angle */
12169         double angle;      /**< Rotation value: 0.0 means no rotation         */
12170         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12171      };
12172
12173    /**
12174     * @typedef Elm_Gesture_Rotate_Info
12175     * Holds rotation info for user
12176     * @ingroup Elm_Gesture_Layer
12177     */
12178    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12179
12180    /**
12181     * @typedef Elm_Gesture_Event_Cb
12182     * User callback used to stream gesture info from gesture layer
12183     * @param data user data
12184     * @param event_info gesture report info
12185     * Returns a flag field to be applied on the causing event.
12186     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12187     * upon the event, in an irreversible way.
12188     *
12189     * @ingroup Elm_Gesture_Layer
12190     */
12191    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12192
12193    /**
12194     * Use function to set callbacks to be notified about
12195     * change of state of gesture.
12196     * When a user registers a callback with this function
12197     * this means this gesture has to be tested.
12198     *
12199     * When ALL callbacks for a gesture are set to NULL
12200     * it means user isn't interested in gesture-state
12201     * and it will not be tested.
12202     *
12203     * @param obj Pointer to gesture-layer.
12204     * @param idx The gesture you would like to track its state.
12205     * @param cb callback function pointer.
12206     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12207     * @param data user info to be sent to callback (usually, Smart Data)
12208     *
12209     * @ingroup Elm_Gesture_Layer
12210     */
12211    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);
12212
12213    /**
12214     * Call this function to get repeat-events settings.
12215     *
12216     * @param obj Pointer to gesture-layer.
12217     *
12218     * @return repeat events settings.
12219     * @see elm_gesture_layer_hold_events_set()
12220     * @ingroup Elm_Gesture_Layer
12221     */
12222    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12223
12224    /**
12225     * This function called in order to make gesture-layer repeat events.
12226     * Set this of you like to get the raw events only if gestures were not detected.
12227     * Clear this if you like gesture layer to fwd events as testing gestures.
12228     *
12229     * @param obj Pointer to gesture-layer.
12230     * @param r Repeat: TRUE/FALSE
12231     *
12232     * @ingroup Elm_Gesture_Layer
12233     */
12234    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12235
12236    /**
12237     * This function sets step-value for zoom action.
12238     * Set step to any positive value.
12239     * Cancel step setting by setting to 0.0
12240     *
12241     * @param obj Pointer to gesture-layer.
12242     * @param s new zoom step value.
12243     *
12244     * @ingroup Elm_Gesture_Layer
12245     */
12246    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12247
12248    /**
12249     * This function sets step-value for rotate action.
12250     * Set step to any positive value.
12251     * Cancel step setting by setting to 0.0
12252     *
12253     * @param obj Pointer to gesture-layer.
12254     * @param s new roatate step value.
12255     *
12256     * @ingroup Elm_Gesture_Layer
12257     */
12258    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12259
12260    /**
12261     * This function called to attach gesture-layer to an Evas_Object.
12262     * @param obj Pointer to gesture-layer.
12263     * @param t Pointer to underlying object (AKA Target)
12264     *
12265     * @return TRUE, FALSE on success, failure.
12266     *
12267     * @ingroup Elm_Gesture_Layer
12268     */
12269    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12270
12271    /**
12272     * Call this function to construct a new gesture-layer object.
12273     * This does not activate the gesture layer. You have to
12274     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12275     *
12276     * @param parent the parent object.
12277     *
12278     * @return Pointer to new gesture-layer object.
12279     *
12280     * @ingroup Elm_Gesture_Layer
12281     */
12282    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12283
12284    /**
12285     * @defgroup Thumb Thumb
12286     *
12287     * @image html img/widget/thumb/preview-00.png
12288     * @image latex img/widget/thumb/preview-00.eps
12289     *
12290     * A thumb object is used for displaying the thumbnail of an image or video.
12291     * You must have compiled Elementary with Ethumb_Client support and the DBus
12292     * service must be present and auto-activated in order to have thumbnails to
12293     * be generated.
12294     *
12295     * Once the thumbnail object becomes visible, it will check if there is a
12296     * previously generated thumbnail image for the file set on it. If not, it
12297     * will start generating this thumbnail.
12298     *
12299     * Different config settings will cause different thumbnails to be generated
12300     * even on the same file.
12301     *
12302     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12303     * Ethumb documentation to change this path, and to see other configuration
12304     * options.
12305     *
12306     * Signals that you can add callbacks for are:
12307     *
12308     * - "clicked" - This is called when a user has clicked the thumb without dragging
12309     *             around.
12310     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12311     * - "press" - This is called when a user has pressed down the thumb.
12312     * - "generate,start" - The thumbnail generation started.
12313     * - "generate,stop" - The generation process stopped.
12314     * - "generate,error" - The generation failed.
12315     * - "load,error" - The thumbnail image loading failed.
12316     *
12317     * available styles:
12318     * - default
12319     * - noframe
12320     *
12321     * An example of use of thumbnail:
12322     *
12323     * - @ref thumb_example_01
12324     */
12325
12326    /**
12327     * @addtogroup Thumb
12328     * @{
12329     */
12330
12331    /**
12332     * @enum _Elm_Thumb_Animation_Setting
12333     * @typedef Elm_Thumb_Animation_Setting
12334     *
12335     * Used to set if a video thumbnail is animating or not.
12336     *
12337     * @ingroup Thumb
12338     */
12339    typedef enum _Elm_Thumb_Animation_Setting
12340      {
12341         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12342         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12343         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12344         ELM_THUMB_ANIMATION_LAST
12345      } Elm_Thumb_Animation_Setting;
12346
12347    /**
12348     * Add a new thumb object to the parent.
12349     *
12350     * @param parent The parent object.
12351     * @return The new object or NULL if it cannot be created.
12352     *
12353     * @see elm_thumb_file_set()
12354     * @see elm_thumb_ethumb_client_get()
12355     *
12356     * @ingroup Thumb
12357     */
12358    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12359    /**
12360     * Reload thumbnail if it was generated before.
12361     *
12362     * @param obj The thumb object to reload
12363     *
12364     * This is useful if the ethumb client configuration changed, like its
12365     * size, aspect or any other property one set in the handle returned
12366     * by elm_thumb_ethumb_client_get().
12367     *
12368     * If the options didn't change, the thumbnail won't be generated again, but
12369     * the old one will still be used.
12370     *
12371     * @see elm_thumb_file_set()
12372     *
12373     * @ingroup Thumb
12374     */
12375    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12376    /**
12377     * Set the file that will be used as thumbnail.
12378     *
12379     * @param obj The thumb object.
12380     * @param file The path to file that will be used as thumb.
12381     * @param key The key used in case of an EET file.
12382     *
12383     * The file can be an image or a video (in that case, acceptable extensions are:
12384     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12385     * function elm_thumb_animate().
12386     *
12387     * @see elm_thumb_file_get()
12388     * @see elm_thumb_reload()
12389     * @see elm_thumb_animate()
12390     *
12391     * @ingroup Thumb
12392     */
12393    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12394    /**
12395     * Get the image or video path and key used to generate the thumbnail.
12396     *
12397     * @param obj The thumb object.
12398     * @param file Pointer to filename.
12399     * @param key Pointer to key.
12400     *
12401     * @see elm_thumb_file_set()
12402     * @see elm_thumb_path_get()
12403     *
12404     * @ingroup Thumb
12405     */
12406    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12407    /**
12408     * Get the path and key to the image or video generated by ethumb.
12409     *
12410     * One just need to make sure that the thumbnail was generated before getting
12411     * its path; otherwise, the path will be NULL. One way to do that is by asking
12412     * for the path when/after the "generate,stop" smart callback is called.
12413     *
12414     * @param obj The thumb object.
12415     * @param file Pointer to thumb path.
12416     * @param key Pointer to thumb key.
12417     *
12418     * @see elm_thumb_file_get()
12419     *
12420     * @ingroup Thumb
12421     */
12422    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12423    /**
12424     * Set the animation state for the thumb object. If its content is an animated
12425     * video, you may start/stop the animation or tell it to play continuously and
12426     * looping.
12427     *
12428     * @param obj The thumb object.
12429     * @param setting The animation setting.
12430     *
12431     * @see elm_thumb_file_set()
12432     *
12433     * @ingroup Thumb
12434     */
12435    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12436    /**
12437     * Get the animation state for the thumb object.
12438     *
12439     * @param obj The thumb object.
12440     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12441     * on errors.
12442     *
12443     * @see elm_thumb_animate_set()
12444     *
12445     * @ingroup Thumb
12446     */
12447    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12448    /**
12449     * Get the ethumb_client handle so custom configuration can be made.
12450     *
12451     * @return Ethumb_Client instance or NULL.
12452     *
12453     * This must be called before the objects are created to be sure no object is
12454     * visible and no generation started.
12455     *
12456     * Example of usage:
12457     *
12458     * @code
12459     * #include <Elementary.h>
12460     * #ifndef ELM_LIB_QUICKLAUNCH
12461     * EAPI int
12462     * elm_main(int argc, char **argv)
12463     * {
12464     *    Ethumb_Client *client;
12465     *
12466     *    elm_need_ethumb();
12467     *
12468     *    // ... your code
12469     *
12470     *    client = elm_thumb_ethumb_client_get();
12471     *    if (!client)
12472     *      {
12473     *         ERR("could not get ethumb_client");
12474     *         return 1;
12475     *      }
12476     *    ethumb_client_size_set(client, 100, 100);
12477     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12478     *    // ... your code
12479     *
12480     *    // Create elm_thumb objects here
12481     *
12482     *    elm_run();
12483     *    elm_shutdown();
12484     *    return 0;
12485     * }
12486     * #endif
12487     * ELM_MAIN()
12488     * @endcode
12489     *
12490     * @note There's only one client handle for Ethumb, so once a configuration
12491     * change is done to it, any other request for thumbnails (for any thumbnail
12492     * object) will use that configuration. Thus, this configuration is global.
12493     *
12494     * @ingroup Thumb
12495     */
12496    EAPI void                        *elm_thumb_ethumb_client_get(void);
12497    /**
12498     * Get the ethumb_client connection state.
12499     *
12500     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12501     * otherwise.
12502     */
12503    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12504    /**
12505     * Make the thumbnail 'editable'.
12506     *
12507     * @param obj Thumb object.
12508     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12509     *
12510     * This means the thumbnail is a valid drag target for drag and drop, and can be
12511     * cut or pasted too.
12512     *
12513     * @see elm_thumb_editable_get()
12514     *
12515     * @ingroup Thumb
12516     */
12517    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12518    /**
12519     * Make the thumbnail 'editable'.
12520     *
12521     * @param obj Thumb object.
12522     * @return Editability.
12523     *
12524     * This means the thumbnail is a valid drag target for drag and drop, and can be
12525     * cut or pasted too.
12526     *
12527     * @see elm_thumb_editable_set()
12528     *
12529     * @ingroup Thumb
12530     */
12531    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12532
12533    /**
12534     * @}
12535     */
12536
12537    /**
12538     * @defgroup Hoversel Hoversel
12539     *
12540     * @image html img/widget/hoversel/preview-00.png
12541     * @image latex img/widget/hoversel/preview-00.eps
12542     *
12543     * A hoversel is a button that pops up a list of items (automatically
12544     * choosing the direction to display) that have a label and, optionally, an
12545     * icon to select from. It is a convenience widget to avoid the need to do
12546     * all the piecing together yourself. It is intended for a small number of
12547     * items in the hoversel menu (no more than 8), though is capable of many
12548     * more.
12549     *
12550     * Signals that you can add callbacks for are:
12551     * "clicked" - the user clicked the hoversel button and popped up the sel
12552     * "selected" - an item in the hoversel list is selected. event_info is the item
12553     * "dismissed" - the hover is dismissed
12554     *
12555     * See @ref tutorial_hoversel for an example.
12556     * @{
12557     */
12558    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12559    /**
12560     * @brief Add a new Hoversel object
12561     *
12562     * @param parent The parent object
12563     * @return The new object or NULL if it cannot be created
12564     */
12565    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12566    /**
12567     * @brief This sets the hoversel to expand horizontally.
12568     *
12569     * @param obj The hoversel object
12570     * @param horizontal If true, the hover will expand horizontally to the
12571     * right.
12572     *
12573     * @note The initial button will display horizontally regardless of this
12574     * setting.
12575     */
12576    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12577    /**
12578     * @brief This returns whether the hoversel is set to expand horizontally.
12579     *
12580     * @param obj The hoversel object
12581     * @return If true, the hover will expand horizontally to the right.
12582     *
12583     * @see elm_hoversel_horizontal_set()
12584     */
12585    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12586    /**
12587     * @brief Set the Hover parent
12588     *
12589     * @param obj The hoversel object
12590     * @param parent The parent to use
12591     *
12592     * Sets the hover parent object, the area that will be darkened when the
12593     * hoversel is clicked. Should probably be the window that the hoversel is
12594     * in. See @ref Hover objects for more information.
12595     */
12596    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12597    /**
12598     * @brief Get the Hover parent
12599     *
12600     * @param obj The hoversel object
12601     * @return The used parent
12602     *
12603     * Gets the hover parent object.
12604     *
12605     * @see elm_hoversel_hover_parent_set()
12606     */
12607    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12608    /**
12609     * @brief Set the hoversel button label
12610     *
12611     * @param obj The hoversel object
12612     * @param label The label text.
12613     *
12614     * This sets the label of the button that is always visible (before it is
12615     * clicked and expanded).
12616     *
12617     * @deprecated elm_object_text_set()
12618     */
12619    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12620    /**
12621     * @brief Get the hoversel button label
12622     *
12623     * @param obj The hoversel object
12624     * @return The label text.
12625     *
12626     * @deprecated elm_object_text_get()
12627     */
12628    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12629    /**
12630     * @brief Set the icon of the hoversel button
12631     *
12632     * @param obj The hoversel object
12633     * @param icon The icon object
12634     *
12635     * Sets the icon of the button that is always visible (before it is clicked
12636     * and expanded).  Once the icon object is set, a previously set one will be
12637     * deleted, if you want to keep that old content object, use the
12638     * elm_hoversel_icon_unset() function.
12639     *
12640     * @see elm_button_icon_set()
12641     */
12642    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12643    /**
12644     * @brief Get the icon of the hoversel button
12645     *
12646     * @param obj The hoversel object
12647     * @return The icon object
12648     *
12649     * Get the icon of the button that is always visible (before it is clicked
12650     * and expanded). Also see elm_button_icon_get().
12651     *
12652     * @see elm_hoversel_icon_set()
12653     */
12654    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12655    /**
12656     * @brief Get and unparent the icon of the hoversel button
12657     *
12658     * @param obj The hoversel object
12659     * @return The icon object that was being used
12660     *
12661     * Unparent and return the icon of the button that is always visible
12662     * (before it is clicked and expanded).
12663     *
12664     * @see elm_hoversel_icon_set()
12665     * @see elm_button_icon_unset()
12666     */
12667    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12668    /**
12669     * @brief This triggers the hoversel popup from code, the same as if the user
12670     * had clicked the button.
12671     *
12672     * @param obj The hoversel object
12673     */
12674    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12675    /**
12676     * @brief This dismisses the hoversel popup as if the user had clicked
12677     * outside the hover.
12678     *
12679     * @param obj The hoversel object
12680     */
12681    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12682    /**
12683     * @brief Returns whether the hoversel is expanded.
12684     *
12685     * @param obj The hoversel object
12686     * @return  This will return EINA_TRUE if the hoversel is expanded or
12687     * EINA_FALSE if it is not expanded.
12688     */
12689    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12690    /**
12691     * @brief This will remove all the children items from the hoversel.
12692     *
12693     * @param obj The hoversel object
12694     *
12695     * @warning Should @b not be called while the hoversel is active; use
12696     * elm_hoversel_expanded_get() to check first.
12697     *
12698     * @see elm_hoversel_item_del_cb_set()
12699     * @see elm_hoversel_item_del()
12700     */
12701    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12702    /**
12703     * @brief Get the list of items within the given hoversel.
12704     *
12705     * @param obj The hoversel object
12706     * @return Returns a list of Elm_Hoversel_Item*
12707     *
12708     * @see elm_hoversel_item_add()
12709     */
12710    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12711    /**
12712     * @brief Add an item to the hoversel button
12713     *
12714     * @param obj The hoversel object
12715     * @param label The text label to use for the item (NULL if not desired)
12716     * @param icon_file An image file path on disk to use for the icon or standard
12717     * icon name (NULL if not desired)
12718     * @param icon_type The icon type if relevant
12719     * @param func Convenience function to call when this item is selected
12720     * @param data Data to pass to item-related functions
12721     * @return A handle to the item added.
12722     *
12723     * This adds an item to the hoversel to show when it is clicked. Note: if you
12724     * need to use an icon from an edje file then use
12725     * elm_hoversel_item_icon_set() right after the this function, and set
12726     * icon_file to NULL here.
12727     *
12728     * For more information on what @p icon_file and @p icon_type are see the
12729     * @ref Icon "icon documentation".
12730     */
12731    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);
12732    /**
12733     * @brief Delete an item from the hoversel
12734     *
12735     * @param item The item to delete
12736     *
12737     * This deletes the item from the hoversel (should not be called while the
12738     * hoversel is active; use elm_hoversel_expanded_get() to check first).
12739     *
12740     * @see elm_hoversel_item_add()
12741     * @see elm_hoversel_item_del_cb_set()
12742     */
12743    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12744    /**
12745     * @brief Set the function to be called when an item from the hoversel is
12746     * freed.
12747     *
12748     * @param item The item to set the callback on
12749     * @param func The function called
12750     *
12751     * That function will receive these parameters:
12752     * @li void *item_data
12753     * @li Evas_Object *the_item_object
12754     * @li Elm_Hoversel_Item *the_object_struct
12755     *
12756     * @see elm_hoversel_item_add()
12757     */
12758    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12759    /**
12760     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12761     * that will be passed to associated function callbacks.
12762     *
12763     * @param item The item to get the data from
12764     * @return The data pointer set with elm_hoversel_item_add()
12765     *
12766     * @see elm_hoversel_item_add()
12767     */
12768    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12769    /**
12770     * @brief This returns the label text of the given hoversel item.
12771     *
12772     * @param item The item to get the label
12773     * @return The label text of the hoversel item
12774     *
12775     * @see elm_hoversel_item_add()
12776     */
12777    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12778    /**
12779     * @brief This sets the icon for the given hoversel item.
12780     *
12781     * @param item The item to set the icon
12782     * @param icon_file An image file path on disk to use for the icon or standard
12783     * icon name
12784     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12785     * to NULL if the icon is not an edje file
12786     * @param icon_type The icon type
12787     *
12788     * The icon can be loaded from the standard set, from an image file, or from
12789     * an edje file.
12790     *
12791     * @see elm_hoversel_item_add()
12792     */
12793    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);
12794    /**
12795     * @brief Get the icon object of the hoversel item
12796     *
12797     * @param item The item to get the icon from
12798     * @param icon_file The image file path on disk used for the icon or standard
12799     * icon name
12800     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12801     * if the icon is not an edje file
12802     * @param icon_type The icon type
12803     *
12804     * @see elm_hoversel_item_icon_set()
12805     * @see elm_hoversel_item_add()
12806     */
12807    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);
12808    /**
12809     * @}
12810     */
12811
12812    /**
12813     * @defgroup Toolbar Toolbar
12814     * @ingroup Elementary
12815     *
12816     * @image html img/widget/toolbar/preview-00.png
12817     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12818     *
12819     * @image html img/toolbar.png
12820     * @image latex img/toolbar.eps width=\textwidth
12821     *
12822     * A toolbar is a widget that displays a list of items inside
12823     * a box. It can be scrollable, show a menu with items that don't fit
12824     * to toolbar size or even crop them.
12825     *
12826     * Only one item can be selected at a time.
12827     *
12828     * Items can have multiple states, or show menus when selected by the user.
12829     *
12830     * Smart callbacks one can listen to:
12831     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12832     *
12833     * Available styles for it:
12834     * - @c "default"
12835     * - @c "transparent" - no background or shadow, just show the content
12836     *
12837     * List of examples:
12838     * @li @ref toolbar_example_01
12839     * @li @ref toolbar_example_02
12840     * @li @ref toolbar_example_03
12841     */
12842
12843    /**
12844     * @addtogroup Toolbar
12845     * @{
12846     */
12847
12848    /**
12849     * @enum _Elm_Toolbar_Shrink_Mode
12850     * @typedef Elm_Toolbar_Shrink_Mode
12851     *
12852     * Set toolbar's items display behavior, it can be scrollabel,
12853     * show a menu with exceeding items, or simply hide them.
12854     *
12855     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12856     * from elm config.
12857     *
12858     * Values <b> don't </b> work as bitmask, only one can be choosen.
12859     *
12860     * @see elm_toolbar_mode_shrink_set()
12861     * @see elm_toolbar_mode_shrink_get()
12862     *
12863     * @ingroup Toolbar
12864     */
12865    typedef enum _Elm_Toolbar_Shrink_Mode
12866      {
12867         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
12868         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
12869         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12870         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
12871      } Elm_Toolbar_Shrink_Mode;
12872
12873    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(). */
12874
12875    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(). */
12876
12877    /**
12878     * Add a new toolbar widget to the given parent Elementary
12879     * (container) object.
12880     *
12881     * @param parent The parent object.
12882     * @return a new toolbar widget handle or @c NULL, on errors.
12883     *
12884     * This function inserts a new toolbar widget on the canvas.
12885     *
12886     * @ingroup Toolbar
12887     */
12888    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12889
12890    /**
12891     * Set the icon size, in pixels, to be used by toolbar items.
12892     *
12893     * @param obj The toolbar object
12894     * @param icon_size The icon size in pixels
12895     *
12896     * @note Default value is @c 32. It reads value from elm config.
12897     *
12898     * @see elm_toolbar_icon_size_get()
12899     *
12900     * @ingroup Toolbar
12901     */
12902    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12903
12904    /**
12905     * Get the icon size, in pixels, to be used by toolbar items.
12906     *
12907     * @param obj The toolbar object.
12908     * @return The icon size in pixels.
12909     *
12910     * @see elm_toolbar_icon_size_set() for details.
12911     *
12912     * @ingroup Toolbar
12913     */
12914    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12915
12916    /**
12917     * Sets icon lookup order, for toolbar items' icons.
12918     *
12919     * @param obj The toolbar object.
12920     * @param order The icon lookup order.
12921     *
12922     * Icons added before calling this function will not be affected.
12923     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12924     *
12925     * @see elm_toolbar_icon_order_lookup_get()
12926     *
12927     * @ingroup Toolbar
12928     */
12929    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12930
12931    /**
12932     * Gets the icon lookup order.
12933     *
12934     * @param obj The toolbar object.
12935     * @return The icon lookup order.
12936     *
12937     * @see elm_toolbar_icon_order_lookup_set() for details.
12938     *
12939     * @ingroup Toolbar
12940     */
12941    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12942
12943    /**
12944     * Set whether the toolbar items' should be selected by the user or not.
12945     *
12946     * @param obj The toolbar object.
12947     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
12948     * enable it.
12949     *
12950     * This will turn off the ability to select items entirely and they will
12951     * neither appear selected nor emit selected signals. The clicked
12952     * callback function will still be called.
12953     *
12954     * Selection is enabled by default.
12955     *
12956     * @see elm_toolbar_no_select_mode_get().
12957     *
12958     * @ingroup Toolbar
12959     */
12960    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12961
12962    /**
12963     * Set whether the toolbar items' should be selected by the user or not.
12964     *
12965     * @param obj The toolbar object.
12966     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
12967     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
12968     *
12969     * @see elm_toolbar_no_select_mode_set() for details.
12970     *
12971     * @ingroup Toolbar
12972     */
12973    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12974
12975    /**
12976     * Append item to the toolbar.
12977     *
12978     * @param obj The toolbar object.
12979     * @param icon A string with icon name or the absolute path of an image file.
12980     * @param label The label of the item.
12981     * @param func The function to call when the item is clicked.
12982     * @param data The data to associate with the item for related callbacks.
12983     * @return The created item or @c NULL upon failure.
12984     *
12985     * A new item will be created and appended to the toolbar, i.e., will
12986     * be set as @b last item.
12987     *
12988     * Items created with this method can be deleted with
12989     * elm_toolbar_item_del().
12990     *
12991     * Associated @p data can be properly freed when item is deleted if a
12992     * callback function is set with elm_toolbar_item_del_cb_set().
12993     *
12994     * If a function is passed as argument, it will be called everytime this item
12995     * is selected, i.e., the user clicks over an unselected item.
12996     * If such function isn't needed, just passing
12997     * @c NULL as @p func is enough. The same should be done for @p data.
12998     *
12999     * Toolbar will load icon image from fdo or current theme.
13000     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13001     * If an absolute path is provided it will load it direct from a file.
13002     *
13003     * @see elm_toolbar_item_icon_set()
13004     * @see elm_toolbar_item_del()
13005     * @see elm_toolbar_item_del_cb_set()
13006     *
13007     * @ingroup Toolbar
13008     */
13009    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);
13010
13011    /**
13012     * Prepend item to the toolbar.
13013     *
13014     * @param obj The toolbar object.
13015     * @param icon A string with icon name or the absolute path of an image file.
13016     * @param label The label of the item.
13017     * @param func The function to call when the item is clicked.
13018     * @param data The data to associate with the item for related callbacks.
13019     * @return The created item or @c NULL upon failure.
13020     *
13021     * A new item will be created and prepended to the toolbar, i.e., will
13022     * be set as @b first item.
13023     *
13024     * Items created with this method can be deleted with
13025     * elm_toolbar_item_del().
13026     *
13027     * Associated @p data can be properly freed when item is deleted if a
13028     * callback function is set with elm_toolbar_item_del_cb_set().
13029     *
13030     * If a function is passed as argument, it will be called everytime this item
13031     * is selected, i.e., the user clicks over an unselected item.
13032     * If such function isn't needed, just passing
13033     * @c NULL as @p func is enough. The same should be done for @p data.
13034     *
13035     * Toolbar will load icon image from fdo or current theme.
13036     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13037     * If an absolute path is provided it will load it direct from a file.
13038     *
13039     * @see elm_toolbar_item_icon_set()
13040     * @see elm_toolbar_item_del()
13041     * @see elm_toolbar_item_del_cb_set()
13042     *
13043     * @ingroup Toolbar
13044     */
13045    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);
13046
13047    /**
13048     * Insert a new item into the toolbar object before item @p before.
13049     *
13050     * @param obj The toolbar object.
13051     * @param before The toolbar item to insert before.
13052     * @param icon A string with icon name or the absolute path of an image file.
13053     * @param label The label of the item.
13054     * @param func The function to call when the item is clicked.
13055     * @param data The data to associate with the item for related callbacks.
13056     * @return The created item or @c NULL upon failure.
13057     *
13058     * A new item will be created and added to the toolbar. Its position in
13059     * this toolbar will be just before item @p before.
13060     *
13061     * Items created with this method can be deleted with
13062     * elm_toolbar_item_del().
13063     *
13064     * Associated @p data can be properly freed when item is deleted if a
13065     * callback function is set with elm_toolbar_item_del_cb_set().
13066     *
13067     * If a function is passed as argument, it will be called everytime this item
13068     * is selected, i.e., the user clicks over an unselected item.
13069     * If such function isn't needed, just passing
13070     * @c NULL as @p func is enough. The same should be done for @p data.
13071     *
13072     * Toolbar will load icon image from fdo or current theme.
13073     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13074     * If an absolute path is provided it will load it direct from a file.
13075     *
13076     * @see elm_toolbar_item_icon_set()
13077     * @see elm_toolbar_item_del()
13078     * @see elm_toolbar_item_del_cb_set()
13079     *
13080     * @ingroup Toolbar
13081     */
13082    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);
13083
13084    /**
13085     * Insert a new item into the toolbar object after item @p after.
13086     *
13087     * @param obj The toolbar object.
13088     * @param before The toolbar item to insert before.
13089     * @param icon A string with icon name or the absolute path of an image file.
13090     * @param label The label of the item.
13091     * @param func The function to call when the item is clicked.
13092     * @param data The data to associate with the item for related callbacks.
13093     * @return The created item or @c NULL upon failure.
13094     *
13095     * A new item will be created and added to the toolbar. Its position in
13096     * this toolbar will be just after item @p after.
13097     *
13098     * Items created with this method can be deleted with
13099     * elm_toolbar_item_del().
13100     *
13101     * Associated @p data can be properly freed when item is deleted if a
13102     * callback function is set with elm_toolbar_item_del_cb_set().
13103     *
13104     * If a function is passed as argument, it will be called everytime this item
13105     * is selected, i.e., the user clicks over an unselected item.
13106     * If such function isn't needed, just passing
13107     * @c NULL as @p func is enough. The same should be done for @p data.
13108     *
13109     * Toolbar will load icon image from fdo or current theme.
13110     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13111     * If an absolute path is provided it will load it direct from a file.
13112     *
13113     * @see elm_toolbar_item_icon_set()
13114     * @see elm_toolbar_item_del()
13115     * @see elm_toolbar_item_del_cb_set()
13116     *
13117     * @ingroup Toolbar
13118     */
13119    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);
13120
13121    /**
13122     * Get the first item in the given toolbar widget's list of
13123     * items.
13124     *
13125     * @param obj The toolbar object
13126     * @return The first item or @c NULL, if it has no items (and on
13127     * errors)
13128     *
13129     * @see elm_toolbar_item_append()
13130     * @see elm_toolbar_last_item_get()
13131     *
13132     * @ingroup Toolbar
13133     */
13134    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13135
13136    /**
13137     * Get the last item in the given toolbar widget's list of
13138     * items.
13139     *
13140     * @param obj The toolbar object
13141     * @return The last item or @c NULL, if it has no items (and on
13142     * errors)
13143     *
13144     * @see elm_toolbar_item_prepend()
13145     * @see elm_toolbar_first_item_get()
13146     *
13147     * @ingroup Toolbar
13148     */
13149    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13150
13151    /**
13152     * Get the item after @p item in toolbar.
13153     *
13154     * @param item The toolbar item.
13155     * @return The item after @p item, or @c NULL if none or on failure.
13156     *
13157     * @note If it is the last item, @c NULL will be returned.
13158     *
13159     * @see elm_toolbar_item_append()
13160     *
13161     * @ingroup Toolbar
13162     */
13163    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13164
13165    /**
13166     * Get the item before @p item in toolbar.
13167     *
13168     * @param item The toolbar item.
13169     * @return The item before @p item, or @c NULL if none or on failure.
13170     *
13171     * @note If it is the first item, @c NULL will be returned.
13172     *
13173     * @see elm_toolbar_item_prepend()
13174     *
13175     * @ingroup Toolbar
13176     */
13177    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13178
13179    /**
13180     * Get the toolbar object from an item.
13181     *
13182     * @param item The item.
13183     * @return The toolbar object.
13184     *
13185     * This returns the toolbar object itself that an item belongs to.
13186     *
13187     * @ingroup Toolbar
13188     */
13189    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13190
13191    /**
13192     * Set the priority of a toolbar item.
13193     *
13194     * @param item The toolbar item.
13195     * @param priority The item priority. The default is zero.
13196     *
13197     * This is used only when the toolbar shrink mode is set to
13198     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13199     * When space is less than required, items with low priority
13200     * will be removed from the toolbar and added to a dynamically-created menu,
13201     * while items with higher priority will remain on the toolbar,
13202     * with the same order they were added.
13203     *
13204     * @see elm_toolbar_item_priority_get()
13205     *
13206     * @ingroup Toolbar
13207     */
13208    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13209
13210    /**
13211     * Get the priority of a toolbar item.
13212     *
13213     * @param item The toolbar item.
13214     * @return The @p item priority, or @c 0 on failure.
13215     *
13216     * @see elm_toolbar_item_priority_set() for details.
13217     *
13218     * @ingroup Toolbar
13219     */
13220    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13221
13222    /**
13223     * Get the label of item.
13224     *
13225     * @param item The item of toolbar.
13226     * @return The label of item.
13227     *
13228     * The return value is a pointer to the label associated to @p item when
13229     * it was created, with function elm_toolbar_item_append() or similar,
13230     * or later,
13231     * with function elm_toolbar_item_label_set. If no label
13232     * was passed as argument, it will return @c NULL.
13233     *
13234     * @see elm_toolbar_item_label_set() for more details.
13235     * @see elm_toolbar_item_append()
13236     *
13237     * @ingroup Toolbar
13238     */
13239    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13240
13241    /**
13242     * Set the label of item.
13243     *
13244     * @param item The item of toolbar.
13245     * @param text The label of item.
13246     *
13247     * The label to be displayed by the item.
13248     * Label will be placed at icons bottom (if set).
13249     *
13250     * If a label was passed as argument on item creation, with function
13251     * elm_toolbar_item_append() or similar, it will be already
13252     * displayed by the item.
13253     *
13254     * @see elm_toolbar_item_label_get()
13255     * @see elm_toolbar_item_append()
13256     *
13257     * @ingroup Toolbar
13258     */
13259    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13260
13261    /**
13262     * Return the data associated with a given toolbar widget item.
13263     *
13264     * @param item The toolbar widget item handle.
13265     * @return The data associated with @p item.
13266     *
13267     * @see elm_toolbar_item_data_set()
13268     *
13269     * @ingroup Toolbar
13270     */
13271    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13272
13273    /**
13274     * Set the data associated with a given toolbar widget item.
13275     *
13276     * @param item The toolbar widget item handle.
13277     * @param data The new data pointer to set to @p item.
13278     *
13279     * This sets new item data on @p item.
13280     *
13281     * @warning The old data pointer won't be touched by this function, so
13282     * the user had better to free that old data himself/herself.
13283     *
13284     * @ingroup Toolbar
13285     */
13286    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13287
13288    /**
13289     * Returns a pointer to a toolbar item by its label.
13290     *
13291     * @param obj The toolbar object.
13292     * @param label The label of the item to find.
13293     *
13294     * @return The pointer to the toolbar item matching @p label or @c NULL
13295     * on failure.
13296     *
13297     * @ingroup Toolbar
13298     */
13299    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13300
13301    /*
13302     * Get whether the @p item is selected or not.
13303     *
13304     * @param item The toolbar item.
13305     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13306     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13307     *
13308     * @see elm_toolbar_selected_item_set() for details.
13309     * @see elm_toolbar_item_selected_get()
13310     *
13311     * @ingroup Toolbar
13312     */
13313    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13314
13315    /**
13316     * Set the selected state of an item.
13317     *
13318     * @param item The toolbar item
13319     * @param selected The selected state
13320     *
13321     * This sets the selected state of the given item @p it.
13322     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13323     *
13324     * If a new item is selected the previosly selected will be unselected.
13325     * Previoulsy selected item can be get with function
13326     * elm_toolbar_selected_item_get().
13327     *
13328     * Selected items will be highlighted.
13329     *
13330     * @see elm_toolbar_item_selected_get()
13331     * @see elm_toolbar_selected_item_get()
13332     *
13333     * @ingroup Toolbar
13334     */
13335    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13336
13337    /**
13338     * Get the selected item.
13339     *
13340     * @param obj The toolbar object.
13341     * @return The selected toolbar item.
13342     *
13343     * The selected item can be unselected with function
13344     * elm_toolbar_item_selected_set().
13345     *
13346     * The selected item always will be highlighted on toolbar.
13347     *
13348     * @see elm_toolbar_selected_items_get()
13349     *
13350     * @ingroup Toolbar
13351     */
13352    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13353
13354    /**
13355     * Set the icon associated with @p item.
13356     *
13357     * @param obj The parent of this item.
13358     * @param item The toolbar item.
13359     * @param icon A string with icon name or the absolute path of an image file.
13360     *
13361     * Toolbar will load icon image from fdo or current theme.
13362     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13363     * If an absolute path is provided it will load it direct from a file.
13364     *
13365     * @see elm_toolbar_icon_order_lookup_set()
13366     * @see elm_toolbar_icon_order_lookup_get()
13367     *
13368     * @ingroup Toolbar
13369     */
13370    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13371
13372    /**
13373     * Get the string used to set the icon of @p item.
13374     *
13375     * @param item The toolbar item.
13376     * @return The string associated with the icon object.
13377     *
13378     * @see elm_toolbar_item_icon_set() for details.
13379     *
13380     * @ingroup Toolbar
13381     */
13382    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13383
13384    /**
13385     * Delete them item from the toolbar.
13386     *
13387     * @param item The item of toolbar to be deleted.
13388     *
13389     * @see elm_toolbar_item_append()
13390     * @see elm_toolbar_item_del_cb_set()
13391     *
13392     * @ingroup Toolbar
13393     */
13394    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13395
13396    /**
13397     * Set the function called when a toolbar item is freed.
13398     *
13399     * @param item The item to set the callback on.
13400     * @param func The function called.
13401     *
13402     * If there is a @p func, then it will be called prior item's memory release.
13403     * That will be called with the following arguments:
13404     * @li item's data;
13405     * @li item's Evas object;
13406     * @li item itself;
13407     *
13408     * This way, a data associated to a toolbar item could be properly freed.
13409     *
13410     * @ingroup Toolbar
13411     */
13412    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13413
13414    /**
13415     * Get a value whether toolbar item is disabled or not.
13416     *
13417     * @param item The item.
13418     * @return The disabled state.
13419     *
13420     * @see elm_toolbar_item_disabled_set() for more details.
13421     *
13422     * @ingroup Toolbar
13423     */
13424    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13425
13426    /**
13427     * Sets the disabled/enabled state of a toolbar item.
13428     *
13429     * @param item The item.
13430     * @param disabled The disabled state.
13431     *
13432     * A disabled item cannot be selected or unselected. It will also
13433     * change its appearance (generally greyed out). This sets the
13434     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13435     * enabled).
13436     *
13437     * @ingroup Toolbar
13438     */
13439    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13440
13441    /**
13442     * Set or unset item as a separator.
13443     *
13444     * @param item The toolbar item.
13445     * @param setting @c EINA_TRUE to set item @p item as separator or
13446     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13447     *
13448     * Items aren't set as separator by default.
13449     *
13450     * If set as separator it will display separator theme, so won't display
13451     * icons or label.
13452     *
13453     * @see elm_toolbar_item_separator_get()
13454     *
13455     * @ingroup Toolbar
13456     */
13457    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13458
13459    /**
13460     * Get a value whether item is a separator or not.
13461     *
13462     * @param item The toolbar item.
13463     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13464     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13465     *
13466     * @see elm_toolbar_item_separator_set() for details.
13467     *
13468     * @ingroup Toolbar
13469     */
13470    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13471
13472    /**
13473     * Set the shrink state of toolbar @p obj.
13474     *
13475     * @param obj The toolbar object.
13476     * @param shrink_mode Toolbar's items display behavior.
13477     *
13478     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13479     * but will enforce a minimun size so all the items will fit, won't scroll
13480     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13481     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13482     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13483     *
13484     * @ingroup Toolbar
13485     */
13486    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13487
13488    /**
13489     * Get the shrink mode of toolbar @p obj.
13490     *
13491     * @param obj The toolbar object.
13492     * @return Toolbar's items display behavior.
13493     *
13494     * @see elm_toolbar_mode_shrink_set() for details.
13495     *
13496     * @ingroup Toolbar
13497     */
13498    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13499
13500    /**
13501     * Enable/disable homogenous mode.
13502     *
13503     * @param obj The toolbar object
13504     * @param homogeneous Assume the items within the toolbar are of the
13505     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13506     *
13507     * This will enable the homogeneous mode where items are of the same size.
13508     * @see elm_toolbar_homogeneous_get()
13509     *
13510     * @ingroup Toolbar
13511     */
13512    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13513
13514    /**
13515     * Get whether the homogenous mode is enabled.
13516     *
13517     * @param obj The toolbar object.
13518     * @return Assume the items within the toolbar are of the same height
13519     * and width (EINA_TRUE = on, EINA_FALSE = off).
13520     *
13521     * @see elm_toolbar_homogeneous_set()
13522     *
13523     * @ingroup Toolbar
13524     */
13525    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13526
13527    /**
13528     * Enable/disable homogenous mode.
13529     *
13530     * @param obj The toolbar object
13531     * @param homogeneous Assume the items within the toolbar are of the
13532     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13533     *
13534     * This will enable the homogeneous mode where items are of the same size.
13535     * @see elm_toolbar_homogeneous_get()
13536     *
13537     * @deprecated use elm_toolbar_homogeneous_set() instead.
13538     *
13539     * @ingroup Toolbar
13540     */
13541    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13542
13543    /**
13544     * Get whether the homogenous mode is enabled.
13545     *
13546     * @param obj The toolbar object.
13547     * @return Assume the items within the toolbar are of the same height
13548     * and width (EINA_TRUE = on, EINA_FALSE = off).
13549     *
13550     * @see elm_toolbar_homogeneous_set()
13551     * @deprecated use elm_toolbar_homogeneous_get() instead.
13552     *
13553     * @ingroup Toolbar
13554     */
13555    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13556
13557    /**
13558     * Set the parent object of the toolbar items' menus.
13559     *
13560     * @param obj The toolbar object.
13561     * @param parent The parent of the menu objects.
13562     *
13563     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13564     *
13565     * For more details about setting the parent for toolbar menus, see
13566     * elm_menu_parent_set().
13567     *
13568     * @see elm_menu_parent_set() for details.
13569     * @see elm_toolbar_item_menu_set() for details.
13570     *
13571     * @ingroup Toolbar
13572     */
13573    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13574
13575    /**
13576     * Get the parent object of the toolbar items' menus.
13577     *
13578     * @param obj The toolbar object.
13579     * @return The parent of the menu objects.
13580     *
13581     * @see elm_toolbar_menu_parent_set() for details.
13582     *
13583     * @ingroup Toolbar
13584     */
13585    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13586
13587    /**
13588     * Set the alignment of the items.
13589     *
13590     * @param obj The toolbar object.
13591     * @param align The new alignment, a float between <tt> 0.0 </tt>
13592     * and <tt> 1.0 </tt>.
13593     *
13594     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13595     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13596     * items.
13597     *
13598     * Centered items by default.
13599     *
13600     * @see elm_toolbar_align_get()
13601     *
13602     * @ingroup Toolbar
13603     */
13604    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13605
13606    /**
13607     * Get the alignment of the items.
13608     *
13609     * @param obj The toolbar object.
13610     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13611     * <tt> 1.0 </tt>.
13612     *
13613     * @see elm_toolbar_align_set() for details.
13614     *
13615     * @ingroup Toolbar
13616     */
13617    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13618
13619    /**
13620     * Set whether the toolbar item opens a menu.
13621     *
13622     * @param item The toolbar item.
13623     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13624     *
13625     * A toolbar item can be set to be a menu, using this function.
13626     *
13627     * Once it is set to be a menu, it can be manipulated through the
13628     * menu-like function elm_toolbar_menu_parent_set() and the other
13629     * elm_menu functions, using the Evas_Object @c menu returned by
13630     * elm_toolbar_item_menu_get().
13631     *
13632     * So, items to be displayed in this item's menu should be added with
13633     * elm_menu_item_add().
13634     *
13635     * The following code exemplifies the most basic usage:
13636     * @code
13637     * tb = elm_toolbar_add(win)
13638     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13639     * elm_toolbar_item_menu_set(item, EINA_TRUE);
13640     * elm_toolbar_menu_parent_set(tb, win);
13641     * menu = elm_toolbar_item_menu_get(item);
13642     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13643     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13644     * NULL);
13645     * @endcode
13646     *
13647     * @see elm_toolbar_item_menu_get()
13648     *
13649     * @ingroup Toolbar
13650     */
13651    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13652
13653    /**
13654     * Get toolbar item's menu.
13655     *
13656     * @param item The toolbar item.
13657     * @return Item's menu object or @c NULL on failure.
13658     *
13659     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13660     * this function will set it.
13661     *
13662     * @see elm_toolbar_item_menu_set() for details.
13663     *
13664     * @ingroup Toolbar
13665     */
13666    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13667
13668    /**
13669     * Add a new state to @p item.
13670     *
13671     * @param item The item.
13672     * @param icon A string with icon name or the absolute path of an image file.
13673     * @param label The label of the new state.
13674     * @param func The function to call when the item is clicked when this
13675     * state is selected.
13676     * @param data The data to associate with the state.
13677     * @return The toolbar item state, or @c NULL upon failure.
13678     *
13679     * Toolbar will load icon image from fdo or current theme.
13680     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13681     * If an absolute path is provided it will load it direct from a file.
13682     *
13683     * States created with this function can be removed with
13684     * elm_toolbar_item_state_del().
13685     *
13686     * @see elm_toolbar_item_state_del()
13687     * @see elm_toolbar_item_state_sel()
13688     * @see elm_toolbar_item_state_get()
13689     *
13690     * @ingroup Toolbar
13691     */
13692    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);
13693
13694    /**
13695     * Delete a previoulsy added state to @p item.
13696     *
13697     * @param item The toolbar item.
13698     * @param state The state to be deleted.
13699     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13700     *
13701     * @see elm_toolbar_item_state_add()
13702     */
13703    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13704
13705    /**
13706     * Set @p state as the current state of @p it.
13707     *
13708     * @param it The item.
13709     * @param state The state to use.
13710     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13711     *
13712     * If @p state is @c NULL, it won't select any state and the default item's
13713     * icon and label will be used. It's the same behaviour than
13714     * elm_toolbar_item_state_unser().
13715     *
13716     * @see elm_toolbar_item_state_unset()
13717     *
13718     * @ingroup Toolbar
13719     */
13720    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13721
13722    /**
13723     * Unset the state of @p it.
13724     *
13725     * @param it The item.
13726     *
13727     * The default icon and label from this item will be displayed.
13728     *
13729     * @see elm_toolbar_item_state_set() for more details.
13730     *
13731     * @ingroup Toolbar
13732     */
13733    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13734
13735    /**
13736     * Get the current state of @p it.
13737     *
13738     * @param item The item.
13739     * @return The selected state or @c NULL if none is selected or on failure.
13740     *
13741     * @see elm_toolbar_item_state_set() for details.
13742     * @see elm_toolbar_item_state_unset()
13743     * @see elm_toolbar_item_state_add()
13744     *
13745     * @ingroup Toolbar
13746     */
13747    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13748
13749    /**
13750     * Get the state after selected state in toolbar's @p item.
13751     *
13752     * @param it The toolbar item to change state.
13753     * @return The state after current state, or @c NULL on failure.
13754     *
13755     * If last state is selected, this function will return first state.
13756     *
13757     * @see elm_toolbar_item_state_set()
13758     * @see elm_toolbar_item_state_add()
13759     *
13760     * @ingroup Toolbar
13761     */
13762    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13763
13764    /**
13765     * Get the state before selected state in toolbar's @p item.
13766     *
13767     * @param it The toolbar item to change state.
13768     * @return The state before current state, or @c NULL on failure.
13769     *
13770     * If first state is selected, this function will return last state.
13771     *
13772     * @see elm_toolbar_item_state_set()
13773     * @see elm_toolbar_item_state_add()
13774     *
13775     * @ingroup Toolbar
13776     */
13777    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13778
13779    /**
13780     * Set the text to be shown in a given toolbar item's tooltips.
13781     *
13782     * @param item Target item.
13783     * @param text The text to set in the content.
13784     *
13785     * Setup the text as tooltip to object. The item can have only one tooltip,
13786     * so any previous tooltip data - set with this function or
13787     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13788     *
13789     * @see elm_object_tooltip_text_set() for more details.
13790     *
13791     * @ingroup Toolbar
13792     */
13793    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13794
13795    /**
13796     * Set the content to be shown in the tooltip item.
13797     *
13798     * Setup the tooltip to item. The item can have only one tooltip,
13799     * so any previous tooltip data is removed. @p func(with @p data) will
13800     * be called every time that need show the tooltip and it should
13801     * return a valid Evas_Object. This object is then managed fully by
13802     * tooltip system and is deleted when the tooltip is gone.
13803     *
13804     * @param item the toolbar item being attached a tooltip.
13805     * @param func the function used to create the tooltip contents.
13806     * @param data what to provide to @a func as callback data/context.
13807     * @param del_cb called when data is not needed anymore, either when
13808     *        another callback replaces @a func, the tooltip is unset with
13809     *        elm_toolbar_item_tooltip_unset() or the owner @a item
13810     *        dies. This callback receives as the first parameter the
13811     *        given @a data, and @c event_info is the item.
13812     *
13813     * @see elm_object_tooltip_content_cb_set() for more details.
13814     *
13815     * @ingroup Toolbar
13816     */
13817    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);
13818
13819    /**
13820     * Unset tooltip from item.
13821     *
13822     * @param item toolbar item to remove previously set tooltip.
13823     *
13824     * Remove tooltip from item. The callback provided as del_cb to
13825     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13826     * it is not used anymore.
13827     *
13828     * @see elm_object_tooltip_unset() for more details.
13829     * @see elm_toolbar_item_tooltip_content_cb_set()
13830     *
13831     * @ingroup Toolbar
13832     */
13833    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13834
13835    /**
13836     * Sets a different style for this item tooltip.
13837     *
13838     * @note before you set a style you should define a tooltip with
13839     *       elm_toolbar_item_tooltip_content_cb_set() or
13840     *       elm_toolbar_item_tooltip_text_set()
13841     *
13842     * @param item toolbar item with tooltip already set.
13843     * @param style the theme style to use (default, transparent, ...)
13844     *
13845     * @see elm_object_tooltip_style_set() for more details.
13846     *
13847     * @ingroup Toolbar
13848     */
13849    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13850
13851    /**
13852     * Get the style for this item tooltip.
13853     *
13854     * @param item toolbar item with tooltip already set.
13855     * @return style the theme style in use, defaults to "default". If the
13856     *         object does not have a tooltip set, then NULL is returned.
13857     *
13858     * @see elm_object_tooltip_style_get() for more details.
13859     * @see elm_toolbar_item_tooltip_style_set()
13860     *
13861     * @ingroup Toolbar
13862     */
13863    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13864
13865    /**
13866     * Set the type of mouse pointer/cursor decoration to be shown,
13867     * when the mouse pointer is over the given toolbar widget item
13868     *
13869     * @param item toolbar item to customize cursor on
13870     * @param cursor the cursor type's name
13871     *
13872     * This function works analogously as elm_object_cursor_set(), but
13873     * here the cursor's changing area is restricted to the item's
13874     * area, and not the whole widget's. Note that that item cursors
13875     * have precedence over widget cursors, so that a mouse over an
13876     * item with custom cursor set will always show @b that cursor.
13877     *
13878     * If this function is called twice for an object, a previously set
13879     * cursor will be unset on the second call.
13880     *
13881     * @see elm_object_cursor_set()
13882     * @see elm_toolbar_item_cursor_get()
13883     * @see elm_toolbar_item_cursor_unset()
13884     *
13885     * @ingroup Toolbar
13886     */
13887    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13888
13889    /*
13890     * Get the type of mouse pointer/cursor decoration set to be shown,
13891     * when the mouse pointer is over the given toolbar widget item
13892     *
13893     * @param item toolbar item with custom cursor set
13894     * @return the cursor type's name or @c NULL, if no custom cursors
13895     * were set to @p item (and on errors)
13896     *
13897     * @see elm_object_cursor_get()
13898     * @see elm_toolbar_item_cursor_set()
13899     * @see elm_toolbar_item_cursor_unset()
13900     *
13901     * @ingroup Toolbar
13902     */
13903    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13904
13905    /**
13906     * Unset any custom mouse pointer/cursor decoration set to be
13907     * shown, when the mouse pointer is over the given toolbar widget
13908     * item, thus making it show the @b default cursor again.
13909     *
13910     * @param item a toolbar item
13911     *
13912     * Use this call to undo any custom settings on this item's cursor
13913     * decoration, bringing it back to defaults (no custom style set).
13914     *
13915     * @see elm_object_cursor_unset()
13916     * @see elm_toolbar_item_cursor_set()
13917     *
13918     * @ingroup Toolbar
13919     */
13920    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13921
13922    /**
13923     * Set a different @b style for a given custom cursor set for a
13924     * toolbar item.
13925     *
13926     * @param item toolbar item with custom cursor set
13927     * @param style the <b>theme style</b> to use (e.g. @c "default",
13928     * @c "transparent", etc)
13929     *
13930     * This function only makes sense when one is using custom mouse
13931     * cursor decorations <b>defined in a theme file</b>, which can have,
13932     * given a cursor name/type, <b>alternate styles</b> on it. It
13933     * works analogously as elm_object_cursor_style_set(), but here
13934     * applyed only to toolbar item objects.
13935     *
13936     * @warning Before you set a cursor style you should have definen a
13937     *       custom cursor previously on the item, with
13938     *       elm_toolbar_item_cursor_set()
13939     *
13940     * @see elm_toolbar_item_cursor_engine_only_set()
13941     * @see elm_toolbar_item_cursor_style_get()
13942     *
13943     * @ingroup Toolbar
13944     */
13945    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13946
13947    /**
13948     * Get the current @b style set for a given toolbar item's custom
13949     * cursor
13950     *
13951     * @param item toolbar item with custom cursor set.
13952     * @return style the cursor style in use. If the object does not
13953     *         have a cursor set, then @c NULL is returned.
13954     *
13955     * @see elm_toolbar_item_cursor_style_set() for more details
13956     *
13957     * @ingroup Toolbar
13958     */
13959    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13960
13961    /**
13962     * Set if the (custom)cursor for a given toolbar item should be
13963     * searched in its theme, also, or should only rely on the
13964     * rendering engine.
13965     *
13966     * @param item item with custom (custom) cursor already set on
13967     * @param engine_only Use @c EINA_TRUE to have cursors looked for
13968     * only on those provided by the rendering engine, @c EINA_FALSE to
13969     * have them searched on the widget's theme, as well.
13970     *
13971     * @note This call is of use only if you've set a custom cursor
13972     * for toolbar items, with elm_toolbar_item_cursor_set().
13973     *
13974     * @note By default, cursors will only be looked for between those
13975     * provided by the rendering engine.
13976     *
13977     * @ingroup Toolbar
13978     */
13979    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13980
13981    /**
13982     * Get if the (custom) cursor for a given toolbar item is being
13983     * searched in its theme, also, or is only relying on the rendering
13984     * engine.
13985     *
13986     * @param item a toolbar item
13987     * @return @c EINA_TRUE, if cursors are being looked for only on
13988     * those provided by the rendering engine, @c EINA_FALSE if they
13989     * are being searched on the widget's theme, as well.
13990     *
13991     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
13992     *
13993     * @ingroup Toolbar
13994     */
13995    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13996
13997    /**
13998     * Change a toolbar's orientation
13999     * @param obj The toolbar object
14000     * @param vertical If @c EINA_TRUE, the toolbar is vertical
14001     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14002     * @ingroup Toolbar
14003     */
14004    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14005
14006    /**
14007     * Get a toolbar's orientation
14008     * @param obj The toolbar object
14009     * @return If @c EINA_TRUE, the toolbar is vertical
14010     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14011     * @ingroup Toolbar
14012     */
14013    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14014
14015    /**
14016     * @}
14017     */
14018
14019    /**
14020     * @defgroup Tooltips Tooltips
14021     *
14022     * The Tooltip is an (internal, for now) smart object used to show a
14023     * content in a frame on mouse hover of objects(or widgets), with
14024     * tips/information about them.
14025     *
14026     * @{
14027     */
14028
14029    EAPI double       elm_tooltip_delay_get(void);
14030    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
14031    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14032    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14033    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14034    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);
14035    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14036    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14037    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14038    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14039    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14040
14041    /**
14042     * @}
14043     */
14044
14045    /**
14046     * @defgroup Cursors Cursors
14047     *
14048     * The Elementary cursor is an internal smart object used to
14049     * customize the mouse cursor displayed over objects (or
14050     * widgets). In the most common scenario, the cursor decoration
14051     * comes from the graphical @b engine Elementary is running
14052     * on. Those engines may provide different decorations for cursors,
14053     * and Elementary provides functions to choose them (think of X11
14054     * cursors, as an example).
14055     *
14056     * There's also the possibility of, besides using engine provided
14057     * cursors, also use ones coming from Edje theming files. Both
14058     * globally and per widget, Elementary makes it possible for one to
14059     * make the cursors lookup to be held on engines only or on
14060     * Elementary's theme file, too.
14061     *
14062     * @{
14063     */
14064
14065    /**
14066     * Set the cursor to be shown when mouse is over the object
14067     *
14068     * Set the cursor that will be displayed when mouse is over the
14069     * object. The object can have only one cursor set to it, so if
14070     * this function is called twice for an object, the previous set
14071     * will be unset.
14072     * If using X cursors, a definition of all the valid cursor names
14073     * is listed on Elementary_Cursors.h. If an invalid name is set
14074     * the default cursor will be used.
14075     *
14076     * @param obj the object being set a cursor.
14077     * @param cursor the cursor name to be used.
14078     *
14079     * @ingroup Cursors
14080     */
14081    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14082
14083    /**
14084     * Get the cursor to be shown when mouse is over the object
14085     *
14086     * @param obj an object with cursor already set.
14087     * @return the cursor name.
14088     *
14089     * @ingroup Cursors
14090     */
14091    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14092
14093    /**
14094     * Unset cursor for object
14095     *
14096     * Unset cursor for object, and set the cursor to default if the mouse
14097     * was over this object.
14098     *
14099     * @param obj Target object
14100     * @see elm_object_cursor_set()
14101     *
14102     * @ingroup Cursors
14103     */
14104    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14105
14106    /**
14107     * Sets a different style for this object cursor.
14108     *
14109     * @note before you set a style you should define a cursor with
14110     *       elm_object_cursor_set()
14111     *
14112     * @param obj an object with cursor already set.
14113     * @param style the theme style to use (default, transparent, ...)
14114     *
14115     * @ingroup Cursors
14116     */
14117    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14118
14119    /**
14120     * Get the style for this object cursor.
14121     *
14122     * @param obj an object with cursor already set.
14123     * @return style the theme style in use, defaults to "default". If the
14124     *         object does not have a cursor set, then NULL is returned.
14125     *
14126     * @ingroup Cursors
14127     */
14128    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14129
14130    /**
14131     * Set if the cursor set should be searched on the theme or should use
14132     * the provided by the engine, only.
14133     *
14134     * @note before you set if should look on theme you should define a cursor
14135     * with elm_object_cursor_set(). By default it will only look for cursors
14136     * provided by the engine.
14137     *
14138     * @param obj an object with cursor already set.
14139     * @param engine_only boolean to define it cursors should be looked only
14140     * between the provided by the engine or searched on widget's theme as well.
14141     *
14142     * @ingroup Cursors
14143     */
14144    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14145
14146    /**
14147     * Get the cursor engine only usage for this object cursor.
14148     *
14149     * @param obj an object with cursor already set.
14150     * @return engine_only boolean to define it cursors should be
14151     * looked only between the provided by the engine or searched on
14152     * widget's theme as well. If the object does not have a cursor
14153     * set, then EINA_FALSE is returned.
14154     *
14155     * @ingroup Cursors
14156     */
14157    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14158
14159    /**
14160     * Get the configured cursor engine only usage
14161     *
14162     * This gets the globally configured exclusive usage of engine cursors.
14163     *
14164     * @return 1 if only engine cursors should be used
14165     * @ingroup Cursors
14166     */
14167    EAPI int          elm_cursor_engine_only_get(void);
14168
14169    /**
14170     * Set the configured cursor engine only usage
14171     *
14172     * This sets the globally configured exclusive usage of engine cursors.
14173     * It won't affect cursors set before changing this value.
14174     *
14175     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14176     * look for them on theme before.
14177     * @return EINA_TRUE if value is valid and setted (0 or 1)
14178     * @ingroup Cursors
14179     */
14180    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
14181
14182    /**
14183     * @}
14184     */
14185
14186    /**
14187     * @defgroup Menu Menu
14188     *
14189     * @image html img/widget/menu/preview-00.png
14190     * @image latex img/widget/menu/preview-00.eps
14191     *
14192     * A menu is a list of items displayed above its parent. When the menu is
14193     * showing its parent is darkened. Each item can have a sub-menu. The menu
14194     * object can be used to display a menu on a right click event, in a toolbar,
14195     * anywhere.
14196     *
14197     * Signals that you can add callbacks for are:
14198     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14199     *             event_info is NULL.
14200     *
14201     * @see @ref tutorial_menu
14202     * @{
14203     */
14204    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14205    /**
14206     * @brief Add a new menu to the parent
14207     *
14208     * @param parent The parent object.
14209     * @return The new object or NULL if it cannot be created.
14210     */
14211    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14212    /**
14213     * @brief Set the parent for the given menu widget
14214     *
14215     * @param obj The menu object.
14216     * @param parent The new parent.
14217     */
14218    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14219    /**
14220     * @brief Get the parent for the given menu widget
14221     *
14222     * @param obj The menu object.
14223     * @return The parent.
14224     *
14225     * @see elm_menu_parent_set()
14226     */
14227    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14228    /**
14229     * @brief Move the menu to a new position
14230     *
14231     * @param obj The menu object.
14232     * @param x The new position.
14233     * @param y The new position.
14234     *
14235     * Sets the top-left position of the menu to (@p x,@p y).
14236     *
14237     * @note @p x and @p y coordinates are relative to parent.
14238     */
14239    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14240    /**
14241     * @brief Close a opened menu
14242     *
14243     * @param obj the menu object
14244     * @return void
14245     *
14246     * Hides the menu and all it's sub-menus.
14247     */
14248    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14249    /**
14250     * @brief Returns a list of @p item's items.
14251     *
14252     * @param obj The menu object
14253     * @return An Eina_List* of @p item's items
14254     */
14255    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14256    /**
14257     * @brief Get the Evas_Object of an Elm_Menu_Item
14258     *
14259     * @param item The menu item object.
14260     * @return The edje object containing the swallowed content
14261     *
14262     * @warning Don't manipulate this object!
14263     */
14264    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14265    /**
14266     * @brief Add an item at the end of the given menu widget
14267     *
14268     * @param obj The menu object.
14269     * @param parent The parent menu item (optional)
14270     * @param icon A icon display on the item. The icon will be destryed by the menu.
14271     * @param label The label of the item.
14272     * @param func Function called when the user select the item.
14273     * @param data Data sent by the callback.
14274     * @return Returns the new item.
14275     */
14276    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);
14277    /**
14278     * @brief Add an object swallowed in an item at the end of the given menu
14279     * widget
14280     *
14281     * @param obj The menu object.
14282     * @param parent The parent menu item (optional)
14283     * @param subobj The object to swallow
14284     * @param func Function called when the user select the item.
14285     * @param data Data sent by the callback.
14286     * @return Returns the new item.
14287     *
14288     * Add an evas object as an item to the menu.
14289     */
14290    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);
14291    /**
14292     * @brief Set the label of a menu item
14293     *
14294     * @param item The menu item object.
14295     * @param label The label to set for @p item
14296     *
14297     * @warning Don't use this funcion on items created with
14298     * elm_menu_item_add_object() or elm_menu_item_separator_add().
14299     */
14300    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14301    /**
14302     * @brief Get the label of a menu item
14303     *
14304     * @param item The menu item object.
14305     * @return The label of @p item
14306     */
14307    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14308    /**
14309     * @brief Set the icon of a menu item to the standard icon with name @p icon
14310     *
14311     * @param item The menu item object.
14312     * @param icon The icon object to set for the content of @p item
14313     *
14314     * Once this icon is set, any previously set icon will be deleted.
14315     */
14316    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14317    /**
14318     * @brief Get the string representation from the icon of a menu item
14319     *
14320     * @param item The menu item object.
14321     * @return The string representation of @p item's icon or NULL
14322     *
14323     * @see elm_menu_item_object_icon_name_set()
14324     */
14325    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14326    /**
14327     * @brief Set the content object of a menu item
14328     *
14329     * @param item The menu item object
14330     * @param The content object or NULL
14331     * @return EINA_TRUE on success, else EINA_FALSE
14332     *
14333     * Use this function to change the object swallowed by a menu item, deleting
14334     * any previously swallowed object.
14335     */
14336    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14337    /**
14338     * @brief Get the content object of a menu item
14339     *
14340     * @param item The menu item object
14341     * @return The content object or NULL
14342     * @note If @p item was added with elm_menu_item_add_object, this
14343     * function will return the object passed, else it will return the
14344     * icon object.
14345     *
14346     * @see elm_menu_item_object_content_set()
14347     */
14348    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14349    /**
14350     * @brief Set the selected state of @p item.
14351     *
14352     * @param item The menu item object.
14353     * @param selected The selected/unselected state of the item
14354     */
14355    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14356    /**
14357     * @brief Get the selected state of @p item.
14358     *
14359     * @param item The menu item object.
14360     * @return The selected/unselected state of the item
14361     *
14362     * @see elm_menu_item_selected_set()
14363     */
14364    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14365    /**
14366     * @brief Set the disabled state of @p item.
14367     *
14368     * @param item The menu item object.
14369     * @param disabled The enabled/disabled state of the item
14370     */
14371    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14372    /**
14373     * @brief Get the disabled state of @p item.
14374     *
14375     * @param item The menu item object.
14376     * @return The enabled/disabled state of the item
14377     *
14378     * @see elm_menu_item_disabled_set()
14379     */
14380    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14381    /**
14382     * @brief Add a separator item to menu @p obj under @p parent.
14383     *
14384     * @param obj The menu object
14385     * @param parent The item to add the separator under
14386     * @return The created item or NULL on failure
14387     *
14388     * This is item is a @ref Separator.
14389     */
14390    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14391    /**
14392     * @brief Returns whether @p item is a separator.
14393     *
14394     * @param item The item to check
14395     * @return If true, @p item is a separator
14396     *
14397     * @see elm_menu_item_separator_add()
14398     */
14399    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14400    /**
14401     * @brief Deletes an item from the menu.
14402     *
14403     * @param item The item to delete.
14404     *
14405     * @see elm_menu_item_add()
14406     */
14407    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14408    /**
14409     * @brief Set the function called when a menu item is deleted.
14410     *
14411     * @param item The item to set the callback on
14412     * @param func The function called
14413     *
14414     * @see elm_menu_item_add()
14415     * @see elm_menu_item_del()
14416     */
14417    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14418    /**
14419     * @brief Returns the data associated with menu item @p item.
14420     *
14421     * @param item The item
14422     * @return The data associated with @p item or NULL if none was set.
14423     *
14424     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14425     */
14426    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14427    /**
14428     * @brief Sets the data to be associated with menu item @p item.
14429     *
14430     * @param item The item
14431     * @param data The data to be associated with @p item
14432     */
14433    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14434    /**
14435     * @brief Returns a list of @p item's subitems.
14436     *
14437     * @param item The item
14438     * @return An Eina_List* of @p item's subitems
14439     *
14440     * @see elm_menu_add()
14441     */
14442    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14443    /**
14444     * @brief Get the position of a menu item
14445     *
14446     * @param item The menu item
14447     * @return The item's index
14448     *
14449     * This function returns the index position of a menu item in a menu.
14450     * For a sub-menu, this number is relative to the first item in the sub-menu.
14451     *
14452     * @note Index values begin with 0
14453     */
14454    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14455    /**
14456     * @brief @brief Return a menu item's owner menu
14457     *
14458     * @param item The menu item
14459     * @return The menu object owning @p item, or NULL on failure
14460     *
14461     * Use this function to get the menu object owning an item.
14462     */
14463    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14464    /**
14465     * @brief Get the selected item in the menu
14466     *
14467     * @param obj The menu object
14468     * @return The selected item, or NULL if none
14469     *
14470     * @see elm_menu_item_selected_get()
14471     * @see elm_menu_item_selected_set()
14472     */
14473    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14474    /**
14475     * @brief Get the last item in the menu
14476     *
14477     * @param obj The menu object
14478     * @return The last item, or NULL if none
14479     */
14480    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14481    /**
14482     * @brief Get the first item in the menu
14483     *
14484     * @param obj The menu object
14485     * @return The first item, or NULL if none
14486     */
14487    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14488    /**
14489     * @brief Get the next item in the menu.
14490     *
14491     * @param item The menu item object.
14492     * @return The item after it, or NULL if none
14493     */
14494    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14495    /**
14496     * @brief Get the previous item in the menu.
14497     *
14498     * @param item The menu item object.
14499     * @return The item before it, or NULL if none
14500     */
14501    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14502    /**
14503     * @}
14504     */
14505
14506    /**
14507     * @defgroup List List
14508     * @ingroup Elementary
14509     *
14510     * @image html img/widget/list/preview-00.png
14511     * @image latex img/widget/list/preview-00.eps width=\textwidth
14512     *
14513     * @image html img/list.png
14514     * @image latex img/list.eps width=\textwidth
14515     *
14516     * A list widget is a container whose children are displayed vertically or
14517     * horizontally, in order, and can be selected.
14518     * The list can accept only one or multiple items selection. Also has many
14519     * modes of items displaying.
14520     *
14521     * A list is a very simple type of list widget.  For more robust
14522     * lists, @ref Genlist should probably be used.
14523     *
14524     * Smart callbacks one can listen to:
14525     * - @c "activated" - The user has double-clicked or pressed
14526     *   (enter|return|spacebar) on an item. The @c event_info parameter
14527     *   is the item that was activated.
14528     * - @c "clicked,double" - The user has double-clicked an item.
14529     *   The @c event_info parameter is the item that was double-clicked.
14530     * - "selected" - when the user selected an item
14531     * - "unselected" - when the user unselected an item
14532     * - "longpressed" - an item in the list is long-pressed
14533     * - "scroll,edge,top" - the list is scrolled until the top edge
14534     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14535     * - "scroll,edge,left" - the list is scrolled until the left edge
14536     * - "scroll,edge,right" - the list is scrolled until the right edge
14537     *
14538     * Available styles for it:
14539     * - @c "default"
14540     *
14541     * List of examples:
14542     * @li @ref list_example_01
14543     * @li @ref list_example_02
14544     * @li @ref list_example_03
14545     */
14546
14547    /**
14548     * @addtogroup List
14549     * @{
14550     */
14551
14552    /**
14553     * @enum _Elm_List_Mode
14554     * @typedef Elm_List_Mode
14555     *
14556     * Set list's resize behavior, transverse axis scroll and
14557     * items cropping. See each mode's description for more details.
14558     *
14559     * @note Default value is #ELM_LIST_SCROLL.
14560     *
14561     * Values <b> don't </b> work as bitmask, only one can be choosen.
14562     *
14563     * @see elm_list_mode_set()
14564     * @see elm_list_mode_get()
14565     *
14566     * @ingroup List
14567     */
14568    typedef enum _Elm_List_Mode
14569      {
14570         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. */
14571         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). */
14572         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. */
14573         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. */
14574         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14575      } Elm_List_Mode;
14576
14577    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().  */
14578
14579    /**
14580     * Add a new list widget to the given parent Elementary
14581     * (container) object.
14582     *
14583     * @param parent The parent object.
14584     * @return a new list widget handle or @c NULL, on errors.
14585     *
14586     * This function inserts a new list widget on the canvas.
14587     *
14588     * @ingroup List
14589     */
14590    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14591
14592    /**
14593     * Starts the list.
14594     *
14595     * @param obj The list object
14596     *
14597     * @note Call before running show() on the list object.
14598     * @warning If not called, it won't display the list properly.
14599     *
14600     * @code
14601     * li = elm_list_add(win);
14602     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14603     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14604     * elm_list_go(li);
14605     * evas_object_show(li);
14606     * @endcode
14607     *
14608     * @ingroup List
14609     */
14610    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14611
14612    /**
14613     * Enable or disable multiple items selection on the list object.
14614     *
14615     * @param obj The list object
14616     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14617     * disable it.
14618     *
14619     * Disabled by default. If disabled, the user can select a single item of
14620     * the list each time. Selected items are highlighted on list.
14621     * If enabled, many items can be selected.
14622     *
14623     * If a selected item is selected again, it will be unselected.
14624     *
14625     * @see elm_list_multi_select_get()
14626     *
14627     * @ingroup List
14628     */
14629    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14630
14631    /**
14632     * Get a value whether multiple items selection is enabled or not.
14633     *
14634     * @see elm_list_multi_select_set() for details.
14635     *
14636     * @param obj The list object.
14637     * @return @c EINA_TRUE means multiple items selection is enabled.
14638     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14639     * @c EINA_FALSE is returned.
14640     *
14641     * @ingroup List
14642     */
14643    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14644
14645    /**
14646     * Set which mode to use for the list object.
14647     *
14648     * @param obj The list object
14649     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14650     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14651     *
14652     * Set list's resize behavior, transverse axis scroll and
14653     * items cropping. See each mode's description for more details.
14654     *
14655     * @note Default value is #ELM_LIST_SCROLL.
14656     *
14657     * Only one can be set, if a previous one was set, it will be changed
14658     * by the new mode set. Bitmask won't work as well.
14659     *
14660     * @see elm_list_mode_get()
14661     *
14662     * @ingroup List
14663     */
14664    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14665
14666    /**
14667     * Get the mode the list is at.
14668     *
14669     * @param obj The list object
14670     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14671     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14672     *
14673     * @note see elm_list_mode_set() for more information.
14674     *
14675     * @ingroup List
14676     */
14677    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14678
14679    /**
14680     * Enable or disable horizontal mode on the list object.
14681     *
14682     * @param obj The list object.
14683     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14684     * disable it, i.e., to enable vertical mode.
14685     *
14686     * @note Vertical mode is set by default.
14687     *
14688     * On horizontal mode items are displayed on list from left to right,
14689     * instead of from top to bottom. Also, the list will scroll horizontally.
14690     * Each item will presents left icon on top and right icon, or end, at
14691     * the bottom.
14692     *
14693     * @see elm_list_horizontal_get()
14694     *
14695     * @ingroup List
14696     */
14697    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14698
14699    /**
14700     * Get a value whether horizontal mode is enabled or not.
14701     *
14702     * @param obj The list object.
14703     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14704     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14705     * @c EINA_FALSE is returned.
14706     *
14707     * @see elm_list_horizontal_set() for details.
14708     *
14709     * @ingroup List
14710     */
14711    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14712
14713    /**
14714     * Enable or disable always select mode on the list object.
14715     *
14716     * @param obj The list object
14717     * @param always_select @c EINA_TRUE to enable always select mode or
14718     * @c EINA_FALSE to disable it.
14719     *
14720     * @note Always select mode is disabled by default.
14721     *
14722     * Default behavior of list items is to only call its callback function
14723     * the first time it's pressed, i.e., when it is selected. If a selected
14724     * item is pressed again, and multi-select is disabled, it won't call
14725     * this function (if multi-select is enabled it will unselect the item).
14726     *
14727     * If always select is enabled, it will call the callback function
14728     * everytime a item is pressed, so it will call when the item is selected,
14729     * and again when a selected item is pressed.
14730     *
14731     * @see elm_list_always_select_mode_get()
14732     * @see elm_list_multi_select_set()
14733     *
14734     * @ingroup List
14735     */
14736    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14737
14738    /**
14739     * Get a value whether always select mode is enabled or not, meaning that
14740     * an item will always call its callback function, even if already selected.
14741     *
14742     * @param obj The list object
14743     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14744     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14745     * @c EINA_FALSE is returned.
14746     *
14747     * @see elm_list_always_select_mode_set() for details.
14748     *
14749     * @ingroup List
14750     */
14751    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14752
14753    /**
14754     * Set bouncing behaviour when the scrolled content reaches an edge.
14755     *
14756     * Tell the internal scroller object whether it should bounce or not
14757     * when it reaches the respective edges for each axis.
14758     *
14759     * @param obj The list object
14760     * @param h_bounce Whether to bounce or not in the horizontal axis.
14761     * @param v_bounce Whether to bounce or not in the vertical axis.
14762     *
14763     * @see elm_scroller_bounce_set()
14764     *
14765     * @ingroup List
14766     */
14767    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14768
14769    /**
14770     * Get the bouncing behaviour of the internal scroller.
14771     *
14772     * Get whether the internal scroller should bounce when the edge of each
14773     * axis is reached scrolling.
14774     *
14775     * @param obj The list object.
14776     * @param h_bounce Pointer where to store the bounce state of the horizontal
14777     * axis.
14778     * @param v_bounce Pointer where to store the bounce state of the vertical
14779     * axis.
14780     *
14781     * @see elm_scroller_bounce_get()
14782     * @see elm_list_bounce_set()
14783     *
14784     * @ingroup List
14785     */
14786    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14787
14788    /**
14789     * Set the scrollbar policy.
14790     *
14791     * @param obj The list object
14792     * @param policy_h Horizontal scrollbar policy.
14793     * @param policy_v Vertical scrollbar policy.
14794     *
14795     * This sets the scrollbar visibility policy for the given scroller.
14796     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14797     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14798     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14799     * This applies respectively for the horizontal and vertical scrollbars.
14800     *
14801     * The both are disabled by default, i.e., are set to
14802     * #ELM_SCROLLER_POLICY_OFF.
14803     *
14804     * @ingroup List
14805     */
14806    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14807
14808    /**
14809     * Get the scrollbar policy.
14810     *
14811     * @see elm_list_scroller_policy_get() for details.
14812     *
14813     * @param obj The list object.
14814     * @param policy_h Pointer where to store horizontal scrollbar policy.
14815     * @param policy_v Pointer where to store vertical scrollbar policy.
14816     *
14817     * @ingroup List
14818     */
14819    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);
14820
14821    /**
14822     * Append a new item to the list object.
14823     *
14824     * @param obj The list object.
14825     * @param label The label of the list item.
14826     * @param icon The icon object to use for the left side of the item. An
14827     * icon can be any Evas object, but usually it is an icon created
14828     * with elm_icon_add().
14829     * @param end The icon object to use for the right side of the item. An
14830     * icon can be any Evas object.
14831     * @param func The function to call when the item is clicked.
14832     * @param data The data to associate with the item for related callbacks.
14833     *
14834     * @return The created item or @c NULL upon failure.
14835     *
14836     * A new item will be created and appended to the list, i.e., will
14837     * be set as @b last item.
14838     *
14839     * Items created with this method can be deleted with
14840     * elm_list_item_del().
14841     *
14842     * Associated @p data can be properly freed when item is deleted if a
14843     * callback function is set with elm_list_item_del_cb_set().
14844     *
14845     * If a function is passed as argument, it will be called everytime this item
14846     * is selected, i.e., the user clicks over an unselected item.
14847     * If always select is enabled it will call this function every time
14848     * user clicks over an item (already selected or not).
14849     * If such function isn't needed, just passing
14850     * @c NULL as @p func is enough. The same should be done for @p data.
14851     *
14852     * Simple example (with no function callback or data associated):
14853     * @code
14854     * li = elm_list_add(win);
14855     * ic = elm_icon_add(win);
14856     * elm_icon_file_set(ic, "path/to/image", NULL);
14857     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14858     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14859     * elm_list_go(li);
14860     * evas_object_show(li);
14861     * @endcode
14862     *
14863     * @see elm_list_always_select_mode_set()
14864     * @see elm_list_item_del()
14865     * @see elm_list_item_del_cb_set()
14866     * @see elm_list_clear()
14867     * @see elm_icon_add()
14868     *
14869     * @ingroup List
14870     */
14871    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);
14872
14873    /**
14874     * Prepend a new item to the list object.
14875     *
14876     * @param obj The list object.
14877     * @param label The label of the list item.
14878     * @param icon The icon object to use for the left side of the item. An
14879     * icon can be any Evas object, but usually it is an icon created
14880     * with elm_icon_add().
14881     * @param end The icon object to use for the right side of the item. An
14882     * icon can be any Evas object.
14883     * @param func The function to call when the item is clicked.
14884     * @param data The data to associate with the item for related callbacks.
14885     *
14886     * @return The created item or @c NULL upon failure.
14887     *
14888     * A new item will be created and prepended to the list, i.e., will
14889     * be set as @b first item.
14890     *
14891     * Items created with this method can be deleted with
14892     * elm_list_item_del().
14893     *
14894     * Associated @p data can be properly freed when item is deleted if a
14895     * callback function is set with elm_list_item_del_cb_set().
14896     *
14897     * If a function is passed as argument, it will be called everytime this item
14898     * is selected, i.e., the user clicks over an unselected item.
14899     * If always select is enabled it will call this function every time
14900     * user clicks over an item (already selected or not).
14901     * If such function isn't needed, just passing
14902     * @c NULL as @p func is enough. The same should be done for @p data.
14903     *
14904     * @see elm_list_item_append() for a simple code example.
14905     * @see elm_list_always_select_mode_set()
14906     * @see elm_list_item_del()
14907     * @see elm_list_item_del_cb_set()
14908     * @see elm_list_clear()
14909     * @see elm_icon_add()
14910     *
14911     * @ingroup List
14912     */
14913    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);
14914
14915    /**
14916     * Insert a new item into the list object before item @p before.
14917     *
14918     * @param obj The list object.
14919     * @param before The list item to insert before.
14920     * @param label The label of the list item.
14921     * @param icon The icon object to use for the left side of the item. An
14922     * icon can be any Evas object, but usually it is an icon created
14923     * with elm_icon_add().
14924     * @param end The icon object to use for the right side of the item. An
14925     * icon can be any Evas object.
14926     * @param func The function to call when the item is clicked.
14927     * @param data The data to associate with the item for related callbacks.
14928     *
14929     * @return The created item or @c NULL upon failure.
14930     *
14931     * A new item will be created and added to the list. Its position in
14932     * this list will be just before item @p before.
14933     *
14934     * Items created with this method can be deleted with
14935     * elm_list_item_del().
14936     *
14937     * Associated @p data can be properly freed when item is deleted if a
14938     * callback function is set with elm_list_item_del_cb_set().
14939     *
14940     * If a function is passed as argument, it will be called everytime this item
14941     * is selected, i.e., the user clicks over an unselected item.
14942     * If always select is enabled it will call this function every time
14943     * user clicks over an item (already selected or not).
14944     * If such function isn't needed, just passing
14945     * @c NULL as @p func is enough. The same should be done for @p data.
14946     *
14947     * @see elm_list_item_append() for a simple code example.
14948     * @see elm_list_always_select_mode_set()
14949     * @see elm_list_item_del()
14950     * @see elm_list_item_del_cb_set()
14951     * @see elm_list_clear()
14952     * @see elm_icon_add()
14953     *
14954     * @ingroup List
14955     */
14956    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);
14957
14958    /**
14959     * Insert a new item into the list object after item @p after.
14960     *
14961     * @param obj The list object.
14962     * @param after The list item to insert after.
14963     * @param label The label of the list item.
14964     * @param icon The icon object to use for the left side of the item. An
14965     * icon can be any Evas object, but usually it is an icon created
14966     * with elm_icon_add().
14967     * @param end The icon object to use for the right side of the item. An
14968     * icon can be any Evas object.
14969     * @param func The function to call when the item is clicked.
14970     * @param data The data to associate with the item for related callbacks.
14971     *
14972     * @return The created item or @c NULL upon failure.
14973     *
14974     * A new item will be created and added to the list. Its position in
14975     * this list will be just after item @p after.
14976     *
14977     * Items created with this method can be deleted with
14978     * elm_list_item_del().
14979     *
14980     * Associated @p data can be properly freed when item is deleted if a
14981     * callback function is set with elm_list_item_del_cb_set().
14982     *
14983     * If a function is passed as argument, it will be called everytime this item
14984     * is selected, i.e., the user clicks over an unselected item.
14985     * If always select is enabled it will call this function every time
14986     * user clicks over an item (already selected or not).
14987     * If such function isn't needed, just passing
14988     * @c NULL as @p func is enough. The same should be done for @p data.
14989     *
14990     * @see elm_list_item_append() for a simple code example.
14991     * @see elm_list_always_select_mode_set()
14992     * @see elm_list_item_del()
14993     * @see elm_list_item_del_cb_set()
14994     * @see elm_list_clear()
14995     * @see elm_icon_add()
14996     *
14997     * @ingroup List
14998     */
14999    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);
15000
15001    /**
15002     * Insert a new item into the sorted list object.
15003     *
15004     * @param obj The list object.
15005     * @param label The label of the list item.
15006     * @param icon The icon object to use for the left side of the item. An
15007     * icon can be any Evas object, but usually it is an icon created
15008     * with elm_icon_add().
15009     * @param end The icon object to use for the right side of the item. An
15010     * icon can be any Evas object.
15011     * @param func The function to call when the item is clicked.
15012     * @param data The data to associate with the item for related callbacks.
15013     * @param cmp_func The comparing function to be used to sort list
15014     * items <b>by #Elm_List_Item item handles</b>. This function will
15015     * receive two items and compare them, returning a non-negative integer
15016     * if the second item should be place after the first, or negative value
15017     * if should be placed before.
15018     *
15019     * @return The created item or @c NULL upon failure.
15020     *
15021     * @note This function inserts values into a list object assuming it was
15022     * sorted and the result will be sorted.
15023     *
15024     * A new item will be created and added to the list. Its position in
15025     * this list will be found comparing the new item with previously inserted
15026     * items using function @p cmp_func.
15027     *
15028     * Items created with this method can be deleted with
15029     * elm_list_item_del().
15030     *
15031     * Associated @p data can be properly freed when item is deleted if a
15032     * callback function is set with elm_list_item_del_cb_set().
15033     *
15034     * If a function is passed as argument, it will be called everytime this item
15035     * is selected, i.e., the user clicks over an unselected item.
15036     * If always select is enabled it will call this function every time
15037     * user clicks over an item (already selected or not).
15038     * If such function isn't needed, just passing
15039     * @c NULL as @p func is enough. The same should be done for @p data.
15040     *
15041     * @see elm_list_item_append() for a simple code example.
15042     * @see elm_list_always_select_mode_set()
15043     * @see elm_list_item_del()
15044     * @see elm_list_item_del_cb_set()
15045     * @see elm_list_clear()
15046     * @see elm_icon_add()
15047     *
15048     * @ingroup List
15049     */
15050    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);
15051
15052    /**
15053     * Remove all list's items.
15054     *
15055     * @param obj The list object
15056     *
15057     * @see elm_list_item_del()
15058     * @see elm_list_item_append()
15059     *
15060     * @ingroup List
15061     */
15062    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15063
15064    /**
15065     * Get a list of all the list items.
15066     *
15067     * @param obj The list object
15068     * @return An @c Eina_List of list items, #Elm_List_Item,
15069     * or @c NULL on failure.
15070     *
15071     * @see elm_list_item_append()
15072     * @see elm_list_item_del()
15073     * @see elm_list_clear()
15074     *
15075     * @ingroup List
15076     */
15077    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15078
15079    /**
15080     * Get the selected item.
15081     *
15082     * @param obj The list object.
15083     * @return The selected list item.
15084     *
15085     * The selected item can be unselected with function
15086     * elm_list_item_selected_set().
15087     *
15088     * The selected item always will be highlighted on list.
15089     *
15090     * @see elm_list_selected_items_get()
15091     *
15092     * @ingroup List
15093     */
15094    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15095
15096    /**
15097     * Return a list of the currently selected list items.
15098     *
15099     * @param obj The list object.
15100     * @return An @c Eina_List of list items, #Elm_List_Item,
15101     * or @c NULL on failure.
15102     *
15103     * Multiple items can be selected if multi select is enabled. It can be
15104     * done with elm_list_multi_select_set().
15105     *
15106     * @see elm_list_selected_item_get()
15107     * @see elm_list_multi_select_set()
15108     *
15109     * @ingroup List
15110     */
15111    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15112
15113    /**
15114     * Set the selected state of an item.
15115     *
15116     * @param item The list item
15117     * @param selected The selected state
15118     *
15119     * This sets the selected state of the given item @p it.
15120     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15121     *
15122     * If a new item is selected the previosly selected will be unselected,
15123     * unless multiple selection is enabled with elm_list_multi_select_set().
15124     * Previoulsy selected item can be get with function
15125     * elm_list_selected_item_get().
15126     *
15127     * Selected items will be highlighted.
15128     *
15129     * @see elm_list_item_selected_get()
15130     * @see elm_list_selected_item_get()
15131     * @see elm_list_multi_select_set()
15132     *
15133     * @ingroup List
15134     */
15135    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15136
15137    /*
15138     * Get whether the @p item is selected or not.
15139     *
15140     * @param item The list item.
15141     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15142     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15143     *
15144     * @see elm_list_selected_item_set() for details.
15145     * @see elm_list_item_selected_get()
15146     *
15147     * @ingroup List
15148     */
15149    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15150
15151    /**
15152     * Set or unset item as a separator.
15153     *
15154     * @param it The list item.
15155     * @param setting @c EINA_TRUE to set item @p it as separator or
15156     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15157     *
15158     * Items aren't set as separator by default.
15159     *
15160     * If set as separator it will display separator theme, so won't display
15161     * icons or label.
15162     *
15163     * @see elm_list_item_separator_get()
15164     *
15165     * @ingroup List
15166     */
15167    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15168
15169    /**
15170     * Get a value whether item is a separator or not.
15171     *
15172     * @see elm_list_item_separator_set() for details.
15173     *
15174     * @param it The list item.
15175     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15176     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15177     *
15178     * @ingroup List
15179     */
15180    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15181
15182    /**
15183     * Show @p item in the list view.
15184     *
15185     * @param item The list item to be shown.
15186     *
15187     * It won't animate list until item is visible. If such behavior is wanted,
15188     * use elm_list_bring_in() intead.
15189     *
15190     * @ingroup List
15191     */
15192    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15193
15194    /**
15195     * Bring in the given item to list view.
15196     *
15197     * @param item The item.
15198     *
15199     * This causes list to jump to the given item @p item and show it
15200     * (by scrolling), if it is not fully visible.
15201     *
15202     * This may use animation to do so and take a period of time.
15203     *
15204     * If animation isn't wanted, elm_list_item_show() can be used.
15205     *
15206     * @ingroup List
15207     */
15208    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15209
15210    /**
15211     * Delete them item from the list.
15212     *
15213     * @param item The item of list to be deleted.
15214     *
15215     * If deleting all list items is required, elm_list_clear()
15216     * should be used instead of getting items list and deleting each one.
15217     *
15218     * @see elm_list_clear()
15219     * @see elm_list_item_append()
15220     * @see elm_list_item_del_cb_set()
15221     *
15222     * @ingroup List
15223     */
15224    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15225
15226    /**
15227     * Set the function called when a list item is freed.
15228     *
15229     * @param item The item to set the callback on
15230     * @param func The function called
15231     *
15232     * If there is a @p func, then it will be called prior item's memory release.
15233     * That will be called with the following arguments:
15234     * @li item's data;
15235     * @li item's Evas object;
15236     * @li item itself;
15237     *
15238     * This way, a data associated to a list item could be properly freed.
15239     *
15240     * @ingroup List
15241     */
15242    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15243
15244    /**
15245     * Get the data associated to the item.
15246     *
15247     * @param item The list item
15248     * @return The data associated to @p item
15249     *
15250     * The return value is a pointer to data associated to @p item when it was
15251     * created, with function elm_list_item_append() or similar. If no data
15252     * was passed as argument, it will return @c NULL.
15253     *
15254     * @see elm_list_item_append()
15255     *
15256     * @ingroup List
15257     */
15258    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15259
15260    /**
15261     * Get the left side icon associated to the item.
15262     *
15263     * @param item The list item
15264     * @return The left side icon associated to @p item
15265     *
15266     * The return value is a pointer to the icon associated to @p item when
15267     * it was
15268     * created, with function elm_list_item_append() or similar, or later
15269     * with function elm_list_item_icon_set(). If no icon
15270     * was passed as argument, it will return @c NULL.
15271     *
15272     * @see elm_list_item_append()
15273     * @see elm_list_item_icon_set()
15274     *
15275     * @ingroup List
15276     */
15277    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15278
15279    /**
15280     * Set the left side icon associated to the item.
15281     *
15282     * @param item The list item
15283     * @param icon The left side icon object to associate with @p item
15284     *
15285     * The icon object to use at left side of the item. An
15286     * icon can be any Evas object, but usually it is an icon created
15287     * with elm_icon_add().
15288     *
15289     * Once the icon object is set, a previously set one will be deleted.
15290     * @warning Setting the same icon for two items will cause the icon to
15291     * dissapear from the first item.
15292     *
15293     * If an icon was passed as argument on item creation, with function
15294     * elm_list_item_append() or similar, it will be already
15295     * associated to the item.
15296     *
15297     * @see elm_list_item_append()
15298     * @see elm_list_item_icon_get()
15299     *
15300     * @ingroup List
15301     */
15302    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15303
15304    /**
15305     * Get the right side icon associated to the item.
15306     *
15307     * @param item The list item
15308     * @return The right side icon associated to @p item
15309     *
15310     * The return value is a pointer to the icon associated to @p item when
15311     * it was
15312     * created, with function elm_list_item_append() or similar, or later
15313     * with function elm_list_item_icon_set(). If no icon
15314     * was passed as argument, it will return @c NULL.
15315     *
15316     * @see elm_list_item_append()
15317     * @see elm_list_item_icon_set()
15318     *
15319     * @ingroup List
15320     */
15321    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15322
15323    /**
15324     * Set the right side icon associated to the item.
15325     *
15326     * @param item The list item
15327     * @param end The right side icon object to associate with @p item
15328     *
15329     * The icon object to use at right side of the item. An
15330     * icon can be any Evas object, but usually it is an icon created
15331     * with elm_icon_add().
15332     *
15333     * Once the icon object is set, a previously set one will be deleted.
15334     * @warning Setting the same icon for two items will cause the icon to
15335     * dissapear from the first item.
15336     *
15337     * If an icon was passed as argument on item creation, with function
15338     * elm_list_item_append() or similar, it will be already
15339     * associated to the item.
15340     *
15341     * @see elm_list_item_append()
15342     * @see elm_list_item_end_get()
15343     *
15344     * @ingroup List
15345     */
15346    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15347
15348    /**
15349     * Gets the base object of the item.
15350     *
15351     * @param item The list item
15352     * @return The base object associated with @p item
15353     *
15354     * Base object is the @c Evas_Object that represents that item.
15355     *
15356     * @ingroup List
15357     */
15358    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15359    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15360
15361    /**
15362     * Get the label of item.
15363     *
15364     * @param item The item of list.
15365     * @return The label of item.
15366     *
15367     * The return value is a pointer to the label associated to @p item when
15368     * it was created, with function elm_list_item_append(), or later
15369     * with function elm_list_item_label_set. If no label
15370     * was passed as argument, it will return @c NULL.
15371     *
15372     * @see elm_list_item_label_set() for more details.
15373     * @see elm_list_item_append()
15374     *
15375     * @ingroup List
15376     */
15377    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15378
15379    /**
15380     * Set the label of item.
15381     *
15382     * @param item The item of list.
15383     * @param text The label of item.
15384     *
15385     * The label to be displayed by the item.
15386     * Label will be placed between left and right side icons (if set).
15387     *
15388     * If a label was passed as argument on item creation, with function
15389     * elm_list_item_append() or similar, it will be already
15390     * displayed by the item.
15391     *
15392     * @see elm_list_item_label_get()
15393     * @see elm_list_item_append()
15394     *
15395     * @ingroup List
15396     */
15397    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15398
15399
15400    /**
15401     * Get the item before @p it in list.
15402     *
15403     * @param it The list item.
15404     * @return The item before @p it, or @c NULL if none or on failure.
15405     *
15406     * @note If it is the first item, @c NULL will be returned.
15407     *
15408     * @see elm_list_item_append()
15409     * @see elm_list_items_get()
15410     *
15411     * @ingroup List
15412     */
15413    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15414
15415    /**
15416     * Get the item after @p it in list.
15417     *
15418     * @param it The list item.
15419     * @return The item after @p it, or @c NULL if none or on failure.
15420     *
15421     * @note If it is the last item, @c NULL will be returned.
15422     *
15423     * @see elm_list_item_append()
15424     * @see elm_list_items_get()
15425     *
15426     * @ingroup List
15427     */
15428    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15429
15430    /**
15431     * Sets the disabled/enabled state of a list item.
15432     *
15433     * @param it The item.
15434     * @param disabled The disabled state.
15435     *
15436     * A disabled item cannot be selected or unselected. It will also
15437     * change its appearance (generally greyed out). This sets the
15438     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15439     * enabled).
15440     *
15441     * @ingroup List
15442     */
15443    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15444
15445    /**
15446     * Get a value whether list item is disabled or not.
15447     *
15448     * @param it The item.
15449     * @return The disabled state.
15450     *
15451     * @see elm_list_item_disabled_set() for more details.
15452     *
15453     * @ingroup List
15454     */
15455    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15456
15457    /**
15458     * Set the text to be shown in a given list item's tooltips.
15459     *
15460     * @param item Target item.
15461     * @param text The text to set in the content.
15462     *
15463     * Setup the text as tooltip to object. The item can have only one tooltip,
15464     * so any previous tooltip data - set with this function or
15465     * elm_list_item_tooltip_content_cb_set() - is removed.
15466     *
15467     * @see elm_object_tooltip_text_set() for more details.
15468     *
15469     * @ingroup List
15470     */
15471    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15472
15473
15474    /**
15475     * @brief Disable size restrictions on an object's tooltip
15476     * @param item The tooltip's anchor object
15477     * @param disable If EINA_TRUE, size restrictions are disabled
15478     * @return EINA_FALSE on failure, EINA_TRUE on success
15479     *
15480     * This function allows a tooltip to expand beyond its parant window's canvas.
15481     * It will instead be limited only by the size of the display.
15482     */
15483    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15484    /**
15485     * @brief Retrieve size restriction state of an object's tooltip
15486     * @param obj The tooltip's anchor object
15487     * @return If EINA_TRUE, size restrictions are disabled
15488     *
15489     * This function returns whether a tooltip is allowed to expand beyond
15490     * its parant window's canvas.
15491     * It will instead be limited only by the size of the display.
15492     */
15493    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15494
15495    /**
15496     * Set the content to be shown in the tooltip item.
15497     *
15498     * Setup the tooltip to item. The item can have only one tooltip,
15499     * so any previous tooltip data is removed. @p func(with @p data) will
15500     * be called every time that need show the tooltip and it should
15501     * return a valid Evas_Object. This object is then managed fully by
15502     * tooltip system and is deleted when the tooltip is gone.
15503     *
15504     * @param item the list item being attached a tooltip.
15505     * @param func the function used to create the tooltip contents.
15506     * @param data what to provide to @a func as callback data/context.
15507     * @param del_cb called when data is not needed anymore, either when
15508     *        another callback replaces @a func, the tooltip is unset with
15509     *        elm_list_item_tooltip_unset() or the owner @a item
15510     *        dies. This callback receives as the first parameter the
15511     *        given @a data, and @c event_info is the item.
15512     *
15513     * @see elm_object_tooltip_content_cb_set() for more details.
15514     *
15515     * @ingroup List
15516     */
15517    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);
15518
15519    /**
15520     * Unset tooltip from item.
15521     *
15522     * @param item list item to remove previously set tooltip.
15523     *
15524     * Remove tooltip from item. The callback provided as del_cb to
15525     * elm_list_item_tooltip_content_cb_set() will be called to notify
15526     * it is not used anymore.
15527     *
15528     * @see elm_object_tooltip_unset() for more details.
15529     * @see elm_list_item_tooltip_content_cb_set()
15530     *
15531     * @ingroup List
15532     */
15533    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15534
15535    /**
15536     * Sets a different style for this item tooltip.
15537     *
15538     * @note before you set a style you should define a tooltip with
15539     *       elm_list_item_tooltip_content_cb_set() or
15540     *       elm_list_item_tooltip_text_set()
15541     *
15542     * @param item list item with tooltip already set.
15543     * @param style the theme style to use (default, transparent, ...)
15544     *
15545     * @see elm_object_tooltip_style_set() for more details.
15546     *
15547     * @ingroup List
15548     */
15549    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15550
15551    /**
15552     * Get the style for this item tooltip.
15553     *
15554     * @param item list item with tooltip already set.
15555     * @return style the theme style in use, defaults to "default". If the
15556     *         object does not have a tooltip set, then NULL is returned.
15557     *
15558     * @see elm_object_tooltip_style_get() for more details.
15559     * @see elm_list_item_tooltip_style_set()
15560     *
15561     * @ingroup List
15562     */
15563    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15564
15565    /**
15566     * Set the type of mouse pointer/cursor decoration to be shown,
15567     * when the mouse pointer is over the given list widget item
15568     *
15569     * @param item list item to customize cursor on
15570     * @param cursor the cursor type's name
15571     *
15572     * This function works analogously as elm_object_cursor_set(), but
15573     * here the cursor's changing area is restricted to the item's
15574     * area, and not the whole widget's. Note that that item cursors
15575     * have precedence over widget cursors, so that a mouse over an
15576     * item with custom cursor set will always show @b that cursor.
15577     *
15578     * If this function is called twice for an object, a previously set
15579     * cursor will be unset on the second call.
15580     *
15581     * @see elm_object_cursor_set()
15582     * @see elm_list_item_cursor_get()
15583     * @see elm_list_item_cursor_unset()
15584     *
15585     * @ingroup List
15586     */
15587    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15588
15589    /*
15590     * Get the type of mouse pointer/cursor decoration set to be shown,
15591     * when the mouse pointer is over the given list widget item
15592     *
15593     * @param item list item with custom cursor set
15594     * @return the cursor type's name or @c NULL, if no custom cursors
15595     * were set to @p item (and on errors)
15596     *
15597     * @see elm_object_cursor_get()
15598     * @see elm_list_item_cursor_set()
15599     * @see elm_list_item_cursor_unset()
15600     *
15601     * @ingroup List
15602     */
15603    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15604
15605    /**
15606     * Unset any custom mouse pointer/cursor decoration set to be
15607     * shown, when the mouse pointer is over the given list widget
15608     * item, thus making it show the @b default cursor again.
15609     *
15610     * @param item a list item
15611     *
15612     * Use this call to undo any custom settings on this item's cursor
15613     * decoration, bringing it back to defaults (no custom style set).
15614     *
15615     * @see elm_object_cursor_unset()
15616     * @see elm_list_item_cursor_set()
15617     *
15618     * @ingroup List
15619     */
15620    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15621
15622    /**
15623     * Set a different @b style for a given custom cursor set for a
15624     * list item.
15625     *
15626     * @param item list item with custom cursor set
15627     * @param style the <b>theme style</b> to use (e.g. @c "default",
15628     * @c "transparent", etc)
15629     *
15630     * This function only makes sense when one is using custom mouse
15631     * cursor decorations <b>defined in a theme file</b>, which can have,
15632     * given a cursor name/type, <b>alternate styles</b> on it. It
15633     * works analogously as elm_object_cursor_style_set(), but here
15634     * applyed only to list item objects.
15635     *
15636     * @warning Before you set a cursor style you should have definen a
15637     *       custom cursor previously on the item, with
15638     *       elm_list_item_cursor_set()
15639     *
15640     * @see elm_list_item_cursor_engine_only_set()
15641     * @see elm_list_item_cursor_style_get()
15642     *
15643     * @ingroup List
15644     */
15645    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15646
15647    /**
15648     * Get the current @b style set for a given list item's custom
15649     * cursor
15650     *
15651     * @param item list item with custom cursor set.
15652     * @return style the cursor style in use. If the object does not
15653     *         have a cursor set, then @c NULL is returned.
15654     *
15655     * @see elm_list_item_cursor_style_set() for more details
15656     *
15657     * @ingroup List
15658     */
15659    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15660
15661    /**
15662     * Set if the (custom)cursor for a given list item should be
15663     * searched in its theme, also, or should only rely on the
15664     * rendering engine.
15665     *
15666     * @param item item with custom (custom) cursor already set on
15667     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15668     * only on those provided by the rendering engine, @c EINA_FALSE to
15669     * have them searched on the widget's theme, as well.
15670     *
15671     * @note This call is of use only if you've set a custom cursor
15672     * for list items, with elm_list_item_cursor_set().
15673     *
15674     * @note By default, cursors will only be looked for between those
15675     * provided by the rendering engine.
15676     *
15677     * @ingroup List
15678     */
15679    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15680
15681    /**
15682     * Get if the (custom) cursor for a given list item is being
15683     * searched in its theme, also, or is only relying on the rendering
15684     * engine.
15685     *
15686     * @param item a list item
15687     * @return @c EINA_TRUE, if cursors are being looked for only on
15688     * those provided by the rendering engine, @c EINA_FALSE if they
15689     * are being searched on the widget's theme, as well.
15690     *
15691     * @see elm_list_item_cursor_engine_only_set(), for more details
15692     *
15693     * @ingroup List
15694     */
15695    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15696
15697    /**
15698     * @}
15699     */
15700
15701    /**
15702     * @defgroup Slider Slider
15703     * @ingroup Elementary
15704     *
15705     * @image html img/widget/slider/preview-00.png
15706     * @image latex img/widget/slider/preview-00.eps width=\textwidth
15707     *
15708     * The slider adds a dragable “slider” widget for selecting the value of
15709     * something within a range.
15710     *
15711     * A slider can be horizontal or vertical. It can contain an Icon and has a
15712     * primary label as well as a units label (that is formatted with floating
15713     * point values and thus accepts a printf-style format string, like
15714     * “%1.2f units”. There is also an indicator string that may be somewhere
15715     * else (like on the slider itself) that also accepts a format string like
15716     * units. Label, Icon Unit and Indicator strings/objects are optional.
15717     *
15718     * A slider may be inverted which means values invert, with high vales being
15719     * on the left or top and low values on the right or bottom (as opposed to
15720     * normally being low on the left or top and high on the bottom and right).
15721     *
15722     * The slider should have its minimum and maximum values set by the
15723     * application with  elm_slider_min_max_set() and value should also be set by
15724     * the application before use with  elm_slider_value_set(). The span of the
15725     * slider is its length (horizontally or vertically). This will be scaled by
15726     * the object or applications scaling factor. At any point code can query the
15727     * slider for its value with elm_slider_value_get().
15728     *
15729     * Smart callbacks one can listen to:
15730     * - "changed" - Whenever the slider value is changed by the user.
15731     * - "slider,drag,start" - dragging the slider indicator around has started.
15732     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15733     * - "delay,changed" - A short time after the value is changed by the user.
15734     * This will be called only when the user stops dragging for
15735     * a very short period or when they release their
15736     * finger/mouse, so it avoids possibly expensive reactions to
15737     * the value change.
15738     *
15739     * Available styles for it:
15740     * - @c "default"
15741     *
15742     * Here is an example on its usage:
15743     * @li @ref slider_example
15744     */
15745
15746    /**
15747     * @addtogroup Slider
15748     * @{
15749     */
15750
15751    /**
15752     * Add a new slider widget to the given parent Elementary
15753     * (container) object.
15754     *
15755     * @param parent The parent object.
15756     * @return a new slider widget handle or @c NULL, on errors.
15757     *
15758     * This function inserts a new slider widget on the canvas.
15759     *
15760     * @ingroup Slider
15761     */
15762    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15763
15764    /**
15765     * Set the label of a given slider widget
15766     *
15767     * @param obj The progress bar object
15768     * @param label The text label string, in UTF-8
15769     *
15770     * @ingroup Slider
15771     * @deprecated use elm_object_text_set() instead.
15772     */
15773    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15774
15775    /**
15776     * Get the label of a given slider widget
15777     *
15778     * @param obj The progressbar object
15779     * @return The text label string, in UTF-8
15780     *
15781     * @ingroup Slider
15782     * @deprecated use elm_object_text_get() instead.
15783     */
15784    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15785
15786    /**
15787     * Set the icon object of the slider object.
15788     *
15789     * @param obj The slider object.
15790     * @param icon The icon object.
15791     *
15792     * On horizontal mode, icon is placed at left, and on vertical mode,
15793     * placed at top.
15794     *
15795     * @note Once the icon object is set, a previously set one will be deleted.
15796     * If you want to keep that old content object, use the
15797     * elm_slider_icon_unset() function.
15798     *
15799     * @warning If the object being set does not have minimum size hints set,
15800     * it won't get properly displayed.
15801     *
15802     * @ingroup Slider
15803     */
15804    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15805
15806    /**
15807     * Unset an icon set on a given slider widget.
15808     *
15809     * @param obj The slider object.
15810     * @return The icon object that was being used, if any was set, or
15811     * @c NULL, otherwise (and on errors).
15812     *
15813     * On horizontal mode, icon is placed at left, and on vertical mode,
15814     * placed at top.
15815     *
15816     * This call will unparent and return the icon object which was set
15817     * for this widget, previously, on success.
15818     *
15819     * @see elm_slider_icon_set() for more details
15820     * @see elm_slider_icon_get()
15821     *
15822     * @ingroup Slider
15823     */
15824    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15825
15826    /**
15827     * Retrieve the icon object set for a given slider widget.
15828     *
15829     * @param obj The slider object.
15830     * @return The icon object's handle, if @p obj had one set, or @c NULL,
15831     * otherwise (and on errors).
15832     *
15833     * On horizontal mode, icon is placed at left, and on vertical mode,
15834     * placed at top.
15835     *
15836     * @see elm_slider_icon_set() for more details
15837     * @see elm_slider_icon_unset()
15838     *
15839     * @ingroup Slider
15840     */
15841    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15842
15843    /**
15844     * Set the end object of the slider object.
15845     *
15846     * @param obj The slider object.
15847     * @param end The end object.
15848     *
15849     * On horizontal mode, end is placed at left, and on vertical mode,
15850     * placed at bottom.
15851     *
15852     * @note Once the icon object is set, a previously set one will be deleted.
15853     * If you want to keep that old content object, use the
15854     * elm_slider_end_unset() function.
15855     *
15856     * @warning If the object being set does not have minimum size hints set,
15857     * it won't get properly displayed.
15858     *
15859     * @ingroup Slider
15860     */
15861    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15862
15863    /**
15864     * Unset an end object set on a given slider widget.
15865     *
15866     * @param obj The slider object.
15867     * @return The end object that was being used, if any was set, or
15868     * @c NULL, otherwise (and on errors).
15869     *
15870     * On horizontal mode, end is placed at left, and on vertical mode,
15871     * placed at bottom.
15872     *
15873     * This call will unparent and return the icon object which was set
15874     * for this widget, previously, on success.
15875     *
15876     * @see elm_slider_end_set() for more details.
15877     * @see elm_slider_end_get()
15878     *
15879     * @ingroup Slider
15880     */
15881    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15882
15883    /**
15884     * Retrieve the end object set for a given slider widget.
15885     *
15886     * @param obj The slider object.
15887     * @return The end object's handle, if @p obj had one set, or @c NULL,
15888     * otherwise (and on errors).
15889     *
15890     * On horizontal mode, icon is placed at right, and on vertical mode,
15891     * placed at bottom.
15892     *
15893     * @see elm_slider_end_set() for more details.
15894     * @see elm_slider_end_unset()
15895     *
15896     * @ingroup Slider
15897     */
15898    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15899
15900    /**
15901     * Set the (exact) length of the bar region of a given slider widget.
15902     *
15903     * @param obj The slider object.
15904     * @param size The length of the slider's bar region.
15905     *
15906     * This sets the minimum width (when in horizontal mode) or height
15907     * (when in vertical mode) of the actual bar area of the slider
15908     * @p obj. This in turn affects the object's minimum size. Use
15909     * this when you're not setting other size hints expanding on the
15910     * given direction (like weight and alignment hints) and you would
15911     * like it to have a specific size.
15912     *
15913     * @note Icon, end, label, indicator and unit text around @p obj
15914     * will require their
15915     * own space, which will make @p obj to require more the @p size,
15916     * actually.
15917     *
15918     * @see elm_slider_span_size_get()
15919     *
15920     * @ingroup Slider
15921     */
15922    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15923
15924    /**
15925     * Get the length set for the bar region of a given slider widget
15926     *
15927     * @param obj The slider object.
15928     * @return The length of the slider's bar region.
15929     *
15930     * If that size was not set previously, with
15931     * elm_slider_span_size_set(), this call will return @c 0.
15932     *
15933     * @ingroup Slider
15934     */
15935    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15936
15937    /**
15938     * Set the format string for the unit label.
15939     *
15940     * @param obj The slider object.
15941     * @param format The format string for the unit display.
15942     *
15943     * Unit label is displayed all the time, if set, after slider's bar.
15944     * In horizontal mode, at right and in vertical mode, at bottom.
15945     *
15946     * If @c NULL, unit label won't be visible. If not it sets the format
15947     * string for the label text. To the label text is provided a floating point
15948     * value, so the label text can display up to 1 floating point value.
15949     * Note that this is optional.
15950     *
15951     * Use a format string such as "%1.2f meters" for example, and it will
15952     * display values like: "3.14 meters" for a value equal to 3.14159.
15953     *
15954     * Default is unit label disabled.
15955     *
15956     * @see elm_slider_indicator_format_get()
15957     *
15958     * @ingroup Slider
15959     */
15960    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
15961
15962    /**
15963     * Get the unit label format of the slider.
15964     *
15965     * @param obj The slider object.
15966     * @return The unit label format string in UTF-8.
15967     *
15968     * Unit label is displayed all the time, if set, after slider's bar.
15969     * In horizontal mode, at right and in vertical mode, at bottom.
15970     *
15971     * @see elm_slider_unit_format_set() for more
15972     * information on how this works.
15973     *
15974     * @ingroup Slider
15975     */
15976    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15977
15978    /**
15979     * Set the format string for the indicator label.
15980     *
15981     * @param obj The slider object.
15982     * @param indicator The format string for the indicator display.
15983     *
15984     * The slider may display its value somewhere else then unit label,
15985     * for example, above the slider knob that is dragged around. This function
15986     * sets the format string used for this.
15987     *
15988     * If @c NULL, indicator label won't be visible. If not it sets the format
15989     * string for the label text. To the label text is provided a floating point
15990     * value, so the label text can display up to 1 floating point value.
15991     * Note that this is optional.
15992     *
15993     * Use a format string such as "%1.2f meters" for example, and it will
15994     * display values like: "3.14 meters" for a value equal to 3.14159.
15995     *
15996     * Default is indicator label disabled.
15997     *
15998     * @see elm_slider_indicator_format_get()
15999     *
16000     * @ingroup Slider
16001     */
16002    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16003
16004    /**
16005     * Get the indicator label format of the slider.
16006     *
16007     * @param obj The slider object.
16008     * @return The indicator label format string in UTF-8.
16009     *
16010     * The slider may display its value somewhere else then unit label,
16011     * for example, above the slider knob that is dragged around. This function
16012     * gets the format string used for this.
16013     *
16014     * @see elm_slider_indicator_format_set() for more
16015     * information on how this works.
16016     *
16017     * @ingroup Slider
16018     */
16019    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16020
16021    /**
16022     * Set the format function pointer for the indicator label
16023     *
16024     * @param obj The slider object.
16025     * @param func The indicator format function.
16026     * @param free_func The freeing function for the format string.
16027     *
16028     * Set the callback function to format the indicator string.
16029     *
16030     * @see elm_slider_indicator_format_set() for more info on how this works.
16031     *
16032     * @ingroup Slider
16033     */
16034   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);
16035
16036   /**
16037    * Set the format function pointer for the units label
16038    *
16039    * @param obj The slider object.
16040    * @param func The units format function.
16041    * @param free_func The freeing function for the format string.
16042    *
16043    * Set the callback function to format the indicator string.
16044    *
16045    * @see elm_slider_units_format_set() for more info on how this works.
16046    *
16047    * @ingroup Slider
16048    */
16049   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);
16050
16051   /**
16052    * Set the orientation of a given slider widget.
16053    *
16054    * @param obj The slider object.
16055    * @param horizontal Use @c EINA_TRUE to make @p obj to be
16056    * @b horizontal, @c EINA_FALSE to make it @b vertical.
16057    *
16058    * Use this function to change how your slider is to be
16059    * disposed: vertically or horizontally.
16060    *
16061    * By default it's displayed horizontally.
16062    *
16063    * @see elm_slider_horizontal_get()
16064    *
16065    * @ingroup Slider
16066    */
16067    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16068
16069    /**
16070     * Retrieve the orientation of a given slider widget
16071     *
16072     * @param obj The slider object.
16073     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16074     * @c EINA_FALSE if it's @b vertical (and on errors).
16075     *
16076     * @see elm_slider_horizontal_set() for more details.
16077     *
16078     * @ingroup Slider
16079     */
16080    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16081
16082    /**
16083     * Set the minimum and maximum values for the slider.
16084     *
16085     * @param obj The slider object.
16086     * @param min The minimum value.
16087     * @param max The maximum value.
16088     *
16089     * Define the allowed range of values to be selected by the user.
16090     *
16091     * If actual value is less than @p min, it will be updated to @p min. If it
16092     * is bigger then @p max, will be updated to @p max. Actual value can be
16093     * get with elm_slider_value_get().
16094     *
16095     * By default, min is equal to 0.0, and max is equal to 1.0.
16096     *
16097     * @warning Maximum must be greater than minimum, otherwise behavior
16098     * is undefined.
16099     *
16100     * @see elm_slider_min_max_get()
16101     *
16102     * @ingroup Slider
16103     */
16104    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16105
16106    /**
16107     * Get the minimum and maximum values of the slider.
16108     *
16109     * @param obj The slider object.
16110     * @param min Pointer where to store the minimum value.
16111     * @param max Pointer where to store the maximum value.
16112     *
16113     * @note If only one value is needed, the other pointer can be passed
16114     * as @c NULL.
16115     *
16116     * @see elm_slider_min_max_set() for details.
16117     *
16118     * @ingroup Slider
16119     */
16120    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16121
16122    /**
16123     * Set the value the slider displays.
16124     *
16125     * @param obj The slider object.
16126     * @param val The value to be displayed.
16127     *
16128     * Value will be presented on the unit label following format specified with
16129     * elm_slider_unit_format_set() and on indicator with
16130     * elm_slider_indicator_format_set().
16131     *
16132     * @warning The value must to be between min and max values. This values
16133     * are set by elm_slider_min_max_set().
16134     *
16135     * @see elm_slider_value_get()
16136     * @see elm_slider_unit_format_set()
16137     * @see elm_slider_indicator_format_set()
16138     * @see elm_slider_min_max_set()
16139     *
16140     * @ingroup Slider
16141     */
16142    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16143
16144    /**
16145     * Get the value displayed by the spinner.
16146     *
16147     * @param obj The spinner object.
16148     * @return The value displayed.
16149     *
16150     * @see elm_spinner_value_set() for details.
16151     *
16152     * @ingroup Slider
16153     */
16154    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16155
16156    /**
16157     * Invert a given slider widget's displaying values order
16158     *
16159     * @param obj The slider object.
16160     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16161     * @c EINA_FALSE to bring it back to default, non-inverted values.
16162     *
16163     * A slider may be @b inverted, in which state it gets its
16164     * values inverted, with high vales being on the left or top and
16165     * low values on the right or bottom, as opposed to normally have
16166     * the low values on the former and high values on the latter,
16167     * respectively, for horizontal and vertical modes.
16168     *
16169     * @see elm_slider_inverted_get()
16170     *
16171     * @ingroup Slider
16172     */
16173    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16174
16175    /**
16176     * Get whether a given slider widget's displaying values are
16177     * inverted or not.
16178     *
16179     * @param obj The slider object.
16180     * @return @c EINA_TRUE, if @p obj has inverted values,
16181     * @c EINA_FALSE otherwise (and on errors).
16182     *
16183     * @see elm_slider_inverted_set() for more details.
16184     *
16185     * @ingroup Slider
16186     */
16187    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16188
16189    /**
16190     * Set whether to enlarge slider indicator (augmented knob) or not.
16191     *
16192     * @param obj The slider object.
16193     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16194     * let the knob always at default size.
16195     *
16196     * By default, indicator will be bigger while dragged by the user.
16197     *
16198     * @warning It won't display values set with
16199     * elm_slider_indicator_format_set() if you disable indicator.
16200     *
16201     * @ingroup Slider
16202     */
16203    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16204
16205    /**
16206     * Get whether a given slider widget's enlarging indicator or not.
16207     *
16208     * @param obj The slider object.
16209     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16210     * @c EINA_FALSE otherwise (and on errors).
16211     *
16212     * @see elm_slider_indicator_show_set() for details.
16213     *
16214     * @ingroup Slider
16215     */
16216    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16217
16218    /**
16219     * @}
16220     */
16221
16222    /**
16223     * @addtogroup Actionslider Actionslider
16224     *
16225     * @image html img/widget/actionslider/preview-00.png
16226     * @image latex img/widget/actionslider/preview-00.eps
16227     *
16228     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16229     * properties. The indicator is the element the user drags to choose a label.
16230     * When the position is set with magnet, when released the indicator will be
16231     * moved to it if it's nearest the magnetized position.
16232     *
16233     * @note By default all positions are set as enabled.
16234     *
16235     * Signals that you can add callbacks for are:
16236     *
16237     * "selected" - when user selects an enabled position (the label is passed
16238     *              as event info)".
16239     * @n
16240     * "pos_changed" - when the indicator reaches any of the positions("left",
16241     *                 "right" or "center").
16242     *
16243     * See an example of actionslider usage @ref actionslider_example_page "here"
16244     * @{
16245     */
16246    typedef enum _Elm_Actionslider_Pos
16247      {
16248         ELM_ACTIONSLIDER_NONE = 0,
16249         ELM_ACTIONSLIDER_LEFT = 1 << 0,
16250         ELM_ACTIONSLIDER_CENTER = 1 << 1,
16251         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16252         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16253      } Elm_Actionslider_Pos;
16254
16255    /**
16256     * Add a new actionslider to the parent.
16257     *
16258     * @param parent The parent object
16259     * @return The new actionslider object or NULL if it cannot be created
16260     */
16261    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16262    /**
16263     * Set actionslider labels.
16264     *
16265     * @param obj The actionslider object
16266     * @param left_label The label to be set on the left.
16267     * @param center_label The label to be set on the center.
16268     * @param right_label The label to be set on the right.
16269     * @deprecated use elm_object_text_set() instead.
16270     */
16271    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);
16272    /**
16273     * Get actionslider labels.
16274     *
16275     * @param obj The actionslider object
16276     * @param left_label A char** to place the left_label of @p obj into.
16277     * @param center_label A char** to place the center_label of @p obj into.
16278     * @param right_label A char** to place the right_label of @p obj into.
16279     * @deprecated use elm_object_text_set() instead.
16280     */
16281    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);
16282    /**
16283     * Get actionslider selected label.
16284     *
16285     * @param obj The actionslider object
16286     * @return The selected label
16287     */
16288    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16289    /**
16290     * Set actionslider indicator position.
16291     *
16292     * @param obj The actionslider object.
16293     * @param pos The position of the indicator.
16294     */
16295    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16296    /**
16297     * Get actionslider indicator position.
16298     *
16299     * @param obj The actionslider object.
16300     * @return The position of the indicator.
16301     */
16302    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16303    /**
16304     * Set actionslider magnet position. To make multiple positions magnets @c or
16305     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16306     *
16307     * @param obj The actionslider object.
16308     * @param pos Bit mask indicating the magnet positions.
16309     */
16310    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16311    /**
16312     * Get actionslider magnet position.
16313     *
16314     * @param obj The actionslider object.
16315     * @return The positions with magnet property.
16316     */
16317    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16318    /**
16319     * Set actionslider enabled position. To set multiple positions as enabled @c or
16320     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16321     *
16322     * @note All the positions are enabled by default.
16323     *
16324     * @param obj The actionslider object.
16325     * @param pos Bit mask indicating the enabled positions.
16326     */
16327    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16328    /**
16329     * Get actionslider enabled position.
16330     *
16331     * @param obj The actionslider object.
16332     * @return The enabled positions.
16333     */
16334    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16335    /**
16336     * Set the label used on the indicator.
16337     *
16338     * @param obj The actionslider object
16339     * @param label The label to be set on the indicator.
16340     * @deprecated use elm_object_text_set() instead.
16341     */
16342    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16343    /**
16344     * Get the label used on the indicator object.
16345     *
16346     * @param obj The actionslider object
16347     * @return The indicator label
16348     * @deprecated use elm_object_text_get() instead.
16349     */
16350    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16351    /**
16352     * @}
16353     */
16354
16355    /**
16356     * @defgroup Genlist Genlist
16357     *
16358     * @image html img/widget/genlist/preview-00.png
16359     * @image latex img/widget/genlist/preview-00.eps
16360     * @image html img/genlist.png
16361     * @image latex img/genlist.eps
16362     *
16363     * This widget aims to have more expansive list than the simple list in
16364     * Elementary that could have more flexible items and allow many more entries
16365     * while still being fast and low on memory usage. At the same time it was
16366     * also made to be able to do tree structures. But the price to pay is more
16367     * complexity when it comes to usage. If all you want is a simple list with
16368     * icons and a single label, use the normal @ref List object.
16369     *
16370     * Genlist has a fairly large API, mostly because it's relatively complex,
16371     * trying to be both expansive, powerful and efficient. First we will begin
16372     * an overview on the theory behind genlist.
16373     *
16374     * @section Genlist_Item_Class Genlist item classes - creating items
16375     *
16376     * In order to have the ability to add and delete items on the fly, genlist
16377     * implements a class (callback) system where the application provides a
16378     * structure with information about that type of item (genlist may contain
16379     * multiple different items with different classes, states and styles).
16380     * Genlist will call the functions in this struct (methods) when an item is
16381     * "realized" (i.e., created dynamically, while the user is scrolling the
16382     * grid). All objects will simply be deleted when no longer needed with
16383     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16384     * following members:
16385     * - @c item_style - This is a constant string and simply defines the name
16386     *   of the item style. It @b must be specified and the default should be @c
16387     *   "default".
16388     * - @c mode_item_style - This is a constant string and simply defines the
16389     *   name of the style that will be used for mode animations. It can be left
16390     *   as @c NULL if you don't plan to use Genlist mode. See
16391     *   elm_genlist_item_mode_set() for more info.
16392     *
16393     * - @c func - A struct with pointers to functions that will be called when
16394     *   an item is going to be actually created. All of them receive a @c data
16395     *   parameter that will point to the same data passed to
16396     *   elm_genlist_item_append() and related item creation functions, and a @c
16397     *   obj parameter that points to the genlist object itself.
16398     *
16399     * The function pointers inside @c func are @c label_get, @c icon_get, @c
16400     * state_get and @c del. The 3 first functions also receive a @c part
16401     * parameter described below. A brief description of these functions follows:
16402     *
16403     * - @c label_get - The @c part parameter is the name string of one of the
16404     *   existing text parts in the Edje group implementing the item's theme.
16405     *   This function @b must return a strdup'()ed string, as the caller will
16406     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16407     * - @c icon_get - The @c part parameter is the name string of one of the
16408     *   existing (icon) swallow parts in the Edje group implementing the item's
16409     *   theme. It must return @c NULL, when no icon is desired, or a valid
16410     *   object handle, otherwise.  The object will be deleted by the genlist on
16411     *   its deletion or when the item is "unrealized".  See
16412     *   #Elm_Genlist_Item_Icon_Get_Cb.
16413     * - @c func.state_get - The @c part parameter is the name string of one of
16414     *   the state parts in the Edje group implementing the item's theme. Return
16415     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16416     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16417     *   and @c "elm" as "emission" and "source" arguments, respectively, when
16418     *   the state is true (the default is false), where @c XXX is the name of
16419     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
16420     * - @c func.del - This is intended for use when genlist items are deleted,
16421     *   so any data attached to the item (e.g. its data parameter on creation)
16422     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
16423     *
16424     * available item styles:
16425     * - default
16426     * - default_style - The text part is a textblock
16427     *
16428     * @image html img/widget/genlist/preview-04.png
16429     * @image latex img/widget/genlist/preview-04.eps
16430     *
16431     * - double_label
16432     *
16433     * @image html img/widget/genlist/preview-01.png
16434     * @image latex img/widget/genlist/preview-01.eps
16435     *
16436     * - icon_top_text_bottom
16437     *
16438     * @image html img/widget/genlist/preview-02.png
16439     * @image latex img/widget/genlist/preview-02.eps
16440     *
16441     * - group_index
16442     *
16443     * @image html img/widget/genlist/preview-03.png
16444     * @image latex img/widget/genlist/preview-03.eps
16445     *
16446     * @section Genlist_Items Structure of items
16447     *
16448     * An item in a genlist can have 0 or more text labels (they can be regular
16449     * text or textblock Evas objects - that's up to the style to determine), 0
16450     * or more icons (which are simply objects swallowed into the genlist item's
16451     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16452     * behavior left to the user to define. The Edje part names for each of
16453     * these properties will be looked up, in the theme file for the genlist,
16454     * under the Edje (string) data items named @c "labels", @c "icons" and @c
16455     * "states", respectively. For each of those properties, if more than one
16456     * part is provided, they must have names listed separated by spaces in the
16457     * data fields. For the default genlist item theme, we have @b one label
16458     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16459     * "elm.swallow.end") and @b no state parts.
16460     *
16461     * A genlist item may be at one of several styles. Elementary provides one
16462     * by default - "default", but this can be extended by system or application
16463     * custom themes/overlays/extensions (see @ref Theme "themes" for more
16464     * details).
16465     *
16466     * @section Genlist_Manipulation Editing and Navigating
16467     *
16468     * Items can be added by several calls. All of them return a @ref
16469     * Elm_Genlist_Item handle that is an internal member inside the genlist.
16470     * They all take a data parameter that is meant to be used for a handle to
16471     * the applications internal data (eg the struct with the original item
16472     * data). The parent parameter is the parent genlist item this belongs to if
16473     * it is a tree or an indexed group, and NULL if there is no parent. The
16474     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16475     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16476     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16477     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
16478     * is set then this item is group index item that is displayed at the top
16479     * until the next group comes. The func parameter is a convenience callback
16480     * that is called when the item is selected and the data parameter will be
16481     * the func_data parameter, obj be the genlist object and event_info will be
16482     * the genlist item.
16483     *
16484     * elm_genlist_item_append() adds an item to the end of the list, or if
16485     * there is a parent, to the end of all the child items of the parent.
16486     * elm_genlist_item_prepend() is the same but adds to the beginning of
16487     * the list or children list. elm_genlist_item_insert_before() inserts at
16488     * item before another item and elm_genlist_item_insert_after() inserts after
16489     * the indicated item.
16490     *
16491     * The application can clear the list with elm_genlist_clear() which deletes
16492     * all the items in the list and elm_genlist_item_del() will delete a specific
16493     * item. elm_genlist_item_subitems_clear() will clear all items that are
16494     * children of the indicated parent item.
16495     *
16496     * To help inspect list items you can jump to the item at the top of the list
16497     * with elm_genlist_first_item_get() which will return the item pointer, and
16498     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16499     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16500     * and previous items respectively relative to the indicated item. Using
16501     * these calls you can walk the entire item list/tree. Note that as a tree
16502     * the items are flattened in the list, so elm_genlist_item_parent_get() will
16503     * let you know which item is the parent (and thus know how to skip them if
16504     * wanted).
16505     *
16506     * @section Genlist_Muti_Selection Multi-selection
16507     *
16508     * If the application wants multiple items to be able to be selected,
16509     * elm_genlist_multi_select_set() can enable this. If the list is
16510     * single-selection only (the default), then elm_genlist_selected_item_get()
16511     * will return the selected item, if any, or NULL I none is selected. If the
16512     * list is multi-select then elm_genlist_selected_items_get() will return a
16513     * list (that is only valid as long as no items are modified (added, deleted,
16514     * selected or unselected)).
16515     *
16516     * @section Genlist_Usage_Hints Usage hints
16517     *
16518     * There are also convenience functions. elm_genlist_item_genlist_get() will
16519     * return the genlist object the item belongs to. elm_genlist_item_show()
16520     * will make the scroller scroll to show that specific item so its visible.
16521     * elm_genlist_item_data_get() returns the data pointer set by the item
16522     * creation functions.
16523     *
16524     * If an item changes (state of boolean changes, label or icons change),
16525     * then use elm_genlist_item_update() to have genlist update the item with
16526     * the new state. Genlist will re-realize the item thus call the functions
16527     * in the _Elm_Genlist_Item_Class for that item.
16528     *
16529     * To programmatically (un)select an item use elm_genlist_item_selected_set().
16530     * To get its selected state use elm_genlist_item_selected_get(). Similarly
16531     * to expand/contract an item and get its expanded state, use
16532     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16533     * again to make an item disabled (unable to be selected and appear
16534     * differently) use elm_genlist_item_disabled_set() to set this and
16535     * elm_genlist_item_disabled_get() to get the disabled state.
16536     *
16537     * In general to indicate how the genlist should expand items horizontally to
16538     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16539     * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16540     * mode means that if items are too wide to fit, the scroller will scroll
16541     * horizontally. Otherwise items are expanded to fill the width of the
16542     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16543     * to the viewport width and limited to that size. This can be combined with
16544     * a different style that uses edjes' ellipsis feature (cutting text off like
16545     * this: "tex...").
16546     *
16547     * Items will only call their selection func and callback when first becoming
16548     * selected. Any further clicks will do nothing, unless you enable always
16549     * select with elm_genlist_always_select_mode_set(). This means even if
16550     * selected, every click will make the selected callbacks be called.
16551     * elm_genlist_no_select_mode_set() will turn off the ability to select
16552     * items entirely and they will neither appear selected nor call selected
16553     * callback functions.
16554     *
16555     * Remember that you can create new styles and add your own theme augmentation
16556     * per application with elm_theme_extension_add(). If you absolutely must
16557     * have a specific style that overrides any theme the user or system sets up
16558     * you can use elm_theme_overlay_add() to add such a file.
16559     *
16560     * @section Genlist_Implementation Implementation
16561     *
16562     * Evas tracks every object you create. Every time it processes an event
16563     * (mouse move, down, up etc.) it needs to walk through objects and find out
16564     * what event that affects. Even worse every time it renders display updates,
16565     * in order to just calculate what to re-draw, it needs to walk through many
16566     * many many objects. Thus, the more objects you keep active, the more
16567     * overhead Evas has in just doing its work. It is advisable to keep your
16568     * active objects to the minimum working set you need. Also remember that
16569     * object creation and deletion carries an overhead, so there is a
16570     * middle-ground, which is not easily determined. But don't keep massive lists
16571     * of objects you can't see or use. Genlist does this with list objects. It
16572     * creates and destroys them dynamically as you scroll around. It groups them
16573     * into blocks so it can determine the visibility etc. of a whole block at
16574     * once as opposed to having to walk the whole list. This 2-level list allows
16575     * for very large numbers of items to be in the list (tests have used up to
16576     * 2,000,000 items). Also genlist employs a queue for adding items. As items
16577     * may be different sizes, every item added needs to be calculated as to its
16578     * size and thus this presents a lot of overhead on populating the list, this
16579     * genlist employs a queue. Any item added is queued and spooled off over
16580     * time, actually appearing some time later, so if your list has many members
16581     * you may find it takes a while for them to all appear, with your process
16582     * consuming a lot of CPU while it is busy spooling.
16583     *
16584     * Genlist also implements a tree structure, but it does so with callbacks to
16585     * the application, with the application filling in tree structures when
16586     * requested (allowing for efficient building of a very deep tree that could
16587     * even be used for file-management). See the above smart signal callbacks for
16588     * details.
16589     *
16590     * @section Genlist_Smart_Events Genlist smart events
16591     *
16592     * Signals that you can add callbacks for are:
16593     * - @c "activated" - The user has double-clicked or pressed
16594     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
16595     *   item that was activated.
16596     * - @c "clicked,double" - The user has double-clicked an item.  The @c
16597     *   event_info parameter is the item that was double-clicked.
16598     * - @c "selected" - This is called when a user has made an item selected.
16599     *   The event_info parameter is the genlist item that was selected.
16600     * - @c "unselected" - This is called when a user has made an item
16601     *   unselected. The event_info parameter is the genlist item that was
16602     *   unselected.
16603     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16604     *   called and the item is now meant to be expanded. The event_info
16605     *   parameter is the genlist item that was indicated to expand.  It is the
16606     *   job of this callback to then fill in the child items.
16607     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16608     *   called and the item is now meant to be contracted. The event_info
16609     *   parameter is the genlist item that was indicated to contract. It is the
16610     *   job of this callback to then delete the child items.
16611     * - @c "expand,request" - This is called when a user has indicated they want
16612     *   to expand a tree branch item. The callback should decide if the item can
16613     *   expand (has any children) and then call elm_genlist_item_expanded_set()
16614     *   appropriately to set the state. The event_info parameter is the genlist
16615     *   item that was indicated to expand.
16616     * - @c "contract,request" - This is called when a user has indicated they
16617     *   want to contract a tree branch item. The callback should decide if the
16618     *   item can contract (has any children) and then call
16619     *   elm_genlist_item_expanded_set() appropriately to set the state. The
16620     *   event_info parameter is the genlist item that was indicated to contract.
16621     * - @c "realized" - This is called when the item in the list is created as a
16622     *   real evas object. event_info parameter is the genlist item that was
16623     *   created. The object may be deleted at any time, so it is up to the
16624     *   caller to not use the object pointer from elm_genlist_item_object_get()
16625     *   in a way where it may point to freed objects.
16626     * - @c "unrealized" - This is called just before an item is unrealized.
16627     *   After this call icon objects provided will be deleted and the item
16628     *   object itself delete or be put into a floating cache.
16629     * - @c "drag,start,up" - This is called when the item in the list has been
16630     *   dragged (not scrolled) up.
16631     * - @c "drag,start,down" - This is called when the item in the list has been
16632     *   dragged (not scrolled) down.
16633     * - @c "drag,start,left" - This is called when the item in the list has been
16634     *   dragged (not scrolled) left.
16635     * - @c "drag,start,right" - This is called when the item in the list has
16636     *   been dragged (not scrolled) right.
16637     * - @c "drag,stop" - This is called when the item in the list has stopped
16638     *   being dragged.
16639     * - @c "drag" - This is called when the item in the list is being dragged.
16640     * - @c "longpressed" - This is called when the item is pressed for a certain
16641     *   amount of time. By default it's 1 second.
16642     * - @c "scroll,anim,start" - This is called when scrolling animation has
16643     *   started.
16644     * - @c "scroll,anim,stop" - This is called when scrolling animation has
16645     *   stopped.
16646     * - @c "scroll,drag,start" - This is called when dragging the content has
16647     *   started.
16648     * - @c "scroll,drag,stop" - This is called when dragging the content has
16649     *   stopped.
16650     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16651     *   the top edge.
16652     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16653     *   until the bottom edge.
16654     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16655     *   until the left edge.
16656     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16657     *   until the right edge.
16658     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16659     *   swiped left.
16660     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16661     *   swiped right.
16662     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16663     *   swiped up.
16664     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16665     *   swiped down.
16666     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16667     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
16668     *   multi-touch pinched in.
16669     * - @c "swipe" - This is called when the genlist is swiped.
16670     *
16671     * @section Genlist_Examples Examples
16672     *
16673     * Here is a list of examples that use the genlist, trying to show some of
16674     * its capabilities:
16675     * - @ref genlist_example_01
16676     * - @ref genlist_example_02
16677     * - @ref genlist_example_03
16678     * - @ref genlist_example_04
16679     * - @ref genlist_example_05
16680     */
16681
16682    /**
16683     * @addtogroup Genlist
16684     * @{
16685     */
16686
16687    /**
16688     * @enum _Elm_Genlist_Item_Flags
16689     * @typedef Elm_Genlist_Item_Flags
16690     *
16691     * Defines if the item is of any special type (has subitems or it's the
16692     * index of a group), or is just a simple item.
16693     *
16694     * @ingroup Genlist
16695     */
16696    typedef enum _Elm_Genlist_Item_Flags
16697      {
16698         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16699         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16700         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16701      } Elm_Genlist_Item_Flags;
16702    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
16703    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16704    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16705    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16706    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. */
16707    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. */
16708    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16709    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16710
16711    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16712    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16713    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16714    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16715
16716    /**
16717     * @struct _Elm_Genlist_Item_Class
16718     *
16719     * Genlist item class definition structs.
16720     *
16721     * This struct contains the style and fetching functions that will define the
16722     * contents of each item.
16723     *
16724     * @see @ref Genlist_Item_Class
16725     */
16726    struct _Elm_Genlist_Item_Class
16727      {
16728         const char                *item_style; /**< style of this class. */
16729         struct
16730           {
16731              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
16732              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
16733              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
16734              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
16735              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
16736           } func;
16737         const char                *mode_item_style;
16738      };
16739
16740    /**
16741     * Add a new genlist widget to the given parent Elementary
16742     * (container) object
16743     *
16744     * @param parent The parent object
16745     * @return a new genlist widget handle or @c NULL, on errors
16746     *
16747     * This function inserts a new genlist widget on the canvas.
16748     *
16749     * @see elm_genlist_item_append()
16750     * @see elm_genlist_item_del()
16751     * @see elm_genlist_clear()
16752     *
16753     * @ingroup Genlist
16754     */
16755    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16756    /**
16757     * Remove all items from a given genlist widget.
16758     *
16759     * @param obj The genlist object
16760     *
16761     * This removes (and deletes) all items in @p obj, leaving it empty.
16762     *
16763     * @see elm_genlist_item_del(), to remove just one item.
16764     *
16765     * @ingroup Genlist
16766     */
16767    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16768    /**
16769     * Enable or disable multi-selection in the genlist
16770     *
16771     * @param obj The genlist object
16772     * @param multi Multi-select enable/disable. Default is disabled.
16773     *
16774     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16775     * the list. This allows more than 1 item to be selected. To retrieve the list
16776     * of selected items, use elm_genlist_selected_items_get().
16777     *
16778     * @see elm_genlist_selected_items_get()
16779     * @see elm_genlist_multi_select_get()
16780     *
16781     * @ingroup Genlist
16782     */
16783    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16784    /**
16785     * Gets if multi-selection in genlist is enabled or disabled.
16786     *
16787     * @param obj The genlist object
16788     * @return Multi-select enabled/disabled
16789     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16790     *
16791     * @see elm_genlist_multi_select_set()
16792     *
16793     * @ingroup Genlist
16794     */
16795    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16796    /**
16797     * This sets the horizontal stretching mode.
16798     *
16799     * @param obj The genlist object
16800     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16801     *
16802     * This sets the mode used for sizing items horizontally. Valid modes
16803     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16804     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16805     * the scroller will scroll horizontally. Otherwise items are expanded
16806     * to fill the width of the viewport of the scroller. If it is
16807     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16808     * limited to that size.
16809     *
16810     * @see elm_genlist_horizontal_get()
16811     *
16812     * @ingroup Genlist
16813     */
16814    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16815    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16816    /**
16817     * Gets the horizontal stretching mode.
16818     *
16819     * @param obj The genlist object
16820     * @return The mode to use
16821     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16822     *
16823     * @see elm_genlist_horizontal_set()
16824     *
16825     * @ingroup Genlist
16826     */
16827    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16828    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16829    /**
16830     * Set the always select mode.
16831     *
16832     * @param obj The genlist object
16833     * @param always_select The always select mode (@c EINA_TRUE = on, @c
16834     * EINA_FALSE = off). Default is @c EINA_FALSE.
16835     *
16836     * Items will only call their selection func and callback when first
16837     * becoming selected. Any further clicks will do nothing, unless you
16838     * enable always select with elm_genlist_always_select_mode_set().
16839     * This means that, even if selected, every click will make the selected
16840     * callbacks be called.
16841     *
16842     * @see elm_genlist_always_select_mode_get()
16843     *
16844     * @ingroup Genlist
16845     */
16846    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16847    /**
16848     * Get the always select mode.
16849     *
16850     * @param obj The genlist object
16851     * @return The always select mode
16852     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16853     *
16854     * @see elm_genlist_always_select_mode_set()
16855     *
16856     * @ingroup Genlist
16857     */
16858    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16859    /**
16860     * Enable/disable the no select mode.
16861     *
16862     * @param obj The genlist object
16863     * @param no_select The no select mode
16864     * (EINA_TRUE = on, EINA_FALSE = off)
16865     *
16866     * This will turn off the ability to select items entirely and they
16867     * will neither appear selected nor call selected callback functions.
16868     *
16869     * @see elm_genlist_no_select_mode_get()
16870     *
16871     * @ingroup Genlist
16872     */
16873    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16874    /**
16875     * Gets whether the no select mode is enabled.
16876     *
16877     * @param obj The genlist object
16878     * @return The no select mode
16879     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16880     *
16881     * @see elm_genlist_no_select_mode_set()
16882     *
16883     * @ingroup Genlist
16884     */
16885    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16886    /**
16887     * Enable/disable compress mode.
16888     *
16889     * @param obj The genlist object
16890     * @param compress The compress mode
16891     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16892     *
16893     * This will enable the compress mode where items are "compressed"
16894     * horizontally to fit the genlist scrollable viewport width. This is
16895     * special for genlist.  Do not rely on
16896     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16897     * work as genlist needs to handle it specially.
16898     *
16899     * @see elm_genlist_compress_mode_get()
16900     *
16901     * @ingroup Genlist
16902     */
16903    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16904    /**
16905     * Get whether the compress mode is enabled.
16906     *
16907     * @param obj The genlist object
16908     * @return The compress mode
16909     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16910     *
16911     * @see elm_genlist_compress_mode_set()
16912     *
16913     * @ingroup Genlist
16914     */
16915    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16916    /**
16917     * Enable/disable height-for-width mode.
16918     *
16919     * @param obj The genlist object
16920     * @param setting The height-for-width mode (@c EINA_TRUE = on,
16921     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16922     *
16923     * With height-for-width mode the item width will be fixed (restricted
16924     * to a minimum of) to the list width when calculating its size in
16925     * order to allow the height to be calculated based on it. This allows,
16926     * for instance, text block to wrap lines if the Edje part is
16927     * configured with "text.min: 0 1".
16928     *
16929     * @note This mode will make list resize slower as it will have to
16930     *       recalculate every item height again whenever the list width
16931     *       changes!
16932     *
16933     * @note When height-for-width mode is enabled, it also enables
16934     *       compress mode (see elm_genlist_compress_mode_set()) and
16935     *       disables homogeneous (see elm_genlist_homogeneous_set()).
16936     *
16937     * @ingroup Genlist
16938     */
16939    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
16940    /**
16941     * Get whether the height-for-width mode is enabled.
16942     *
16943     * @param obj The genlist object
16944     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
16945     * off)
16946     *
16947     * @ingroup Genlist
16948     */
16949    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16950    /**
16951     * Enable/disable horizontal and vertical bouncing effect.
16952     *
16953     * @param obj The genlist object
16954     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
16955     * EINA_FALSE = off). Default is @c EINA_FALSE.
16956     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
16957     * EINA_FALSE = off). Default is @c EINA_TRUE.
16958     *
16959     * This will enable or disable the scroller bouncing effect for the
16960     * genlist. See elm_scroller_bounce_set() for details.
16961     *
16962     * @see elm_scroller_bounce_set()
16963     * @see elm_genlist_bounce_get()
16964     *
16965     * @ingroup Genlist
16966     */
16967    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16968    /**
16969     * Get whether the horizontal and vertical bouncing effect is enabled.
16970     *
16971     * @param obj The genlist object
16972     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
16973     * option is set.
16974     * @param v_bounce Pointer to a bool to receive if the bounce vertically
16975     * option is set.
16976     *
16977     * @see elm_genlist_bounce_set()
16978     *
16979     * @ingroup Genlist
16980     */
16981    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16982    /**
16983     * Enable/disable homogenous mode.
16984     *
16985     * @param obj The genlist object
16986     * @param homogeneous Assume the items within the genlist are of the
16987     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
16988     * EINA_FALSE.
16989     *
16990     * This will enable the homogeneous mode where items are of the same
16991     * height and width so that genlist may do the lazy-loading at its
16992     * maximum (which increases the performance for scrolling the list). This
16993     * implies 'compressed' mode.
16994     *
16995     * @see elm_genlist_compress_mode_set()
16996     * @see elm_genlist_homogeneous_get()
16997     *
16998     * @ingroup Genlist
16999     */
17000    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17001    /**
17002     * Get whether the homogenous mode is enabled.
17003     *
17004     * @param obj The genlist object
17005     * @return Assume the items within the genlist are of the same height
17006     * and width (EINA_TRUE = on, EINA_FALSE = off)
17007     *
17008     * @see elm_genlist_homogeneous_set()
17009     *
17010     * @ingroup Genlist
17011     */
17012    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17013    /**
17014     * Set the maximum number of items within an item block
17015     *
17016     * @param obj The genlist object
17017     * @param n   Maximum number of items within an item block. Default is 32.
17018     *
17019     * This will configure the block count to tune to the target with
17020     * particular performance matrix.
17021     *
17022     * A block of objects will be used to reduce the number of operations due to
17023     * many objects in the screen. It can determine the visibility, or if the
17024     * object has changed, it theme needs to be updated, etc. doing this kind of
17025     * calculation to the entire block, instead of per object.
17026     *
17027     * The default value for the block count is enough for most lists, so unless
17028     * you know you will have a lot of objects visible in the screen at the same
17029     * time, don't try to change this.
17030     *
17031     * @see elm_genlist_block_count_get()
17032     * @see @ref Genlist_Implementation
17033     *
17034     * @ingroup Genlist
17035     */
17036    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17037    /**
17038     * Get the maximum number of items within an item block
17039     *
17040     * @param obj The genlist object
17041     * @return Maximum number of items within an item block
17042     *
17043     * @see elm_genlist_block_count_set()
17044     *
17045     * @ingroup Genlist
17046     */
17047    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17048    /**
17049     * Set the timeout in seconds for the longpress event.
17050     *
17051     * @param obj The genlist object
17052     * @param timeout timeout in seconds. Default is 1.
17053     *
17054     * This option will change how long it takes to send an event "longpressed"
17055     * after the mouse down signal is sent to the list. If this event occurs, no
17056     * "clicked" event will be sent.
17057     *
17058     * @see elm_genlist_longpress_timeout_set()
17059     *
17060     * @ingroup Genlist
17061     */
17062    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17063    /**
17064     * Get the timeout in seconds for the longpress event.
17065     *
17066     * @param obj The genlist object
17067     * @return timeout in seconds
17068     *
17069     * @see elm_genlist_longpress_timeout_get()
17070     *
17071     * @ingroup Genlist
17072     */
17073    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17074    /**
17075     * Append a new item in a given genlist widget.
17076     *
17077     * @param obj The genlist object
17078     * @param itc The item class for the item
17079     * @param data The item data
17080     * @param parent The parent item, or NULL if none
17081     * @param flags Item flags
17082     * @param func Convenience function called when the item is selected
17083     * @param func_data Data passed to @p func above.
17084     * @return A handle to the item added or @c NULL if not possible
17085     *
17086     * This adds the given item to the end of the list or the end of
17087     * the children list if the @p parent is given.
17088     *
17089     * @see elm_genlist_item_prepend()
17090     * @see elm_genlist_item_insert_before()
17091     * @see elm_genlist_item_insert_after()
17092     * @see elm_genlist_item_del()
17093     *
17094     * @ingroup Genlist
17095     */
17096    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);
17097    /**
17098     * Prepend a new item in a given genlist widget.
17099     *
17100     * @param obj The genlist object
17101     * @param itc The item class for the item
17102     * @param data The item data
17103     * @param parent The parent item, or NULL if none
17104     * @param flags Item flags
17105     * @param func Convenience function called when the item is selected
17106     * @param func_data Data passed to @p func above.
17107     * @return A handle to the item added or NULL if not possible
17108     *
17109     * This adds an item to the beginning of the list or beginning of the
17110     * children of the parent if given.
17111     *
17112     * @see elm_genlist_item_append()
17113     * @see elm_genlist_item_insert_before()
17114     * @see elm_genlist_item_insert_after()
17115     * @see elm_genlist_item_del()
17116     *
17117     * @ingroup Genlist
17118     */
17119    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);
17120    /**
17121     * Insert an item before another in a genlist widget
17122     *
17123     * @param obj The genlist object
17124     * @param itc The item class for the item
17125     * @param data The item data
17126     * @param before The item to place this new one before.
17127     * @param flags Item flags
17128     * @param func Convenience function called when the item is selected
17129     * @param func_data Data passed to @p func above.
17130     * @return A handle to the item added or @c NULL if not possible
17131     *
17132     * This inserts an item before another in the list. It will be in the
17133     * same tree level or group as the item it is inserted before.
17134     *
17135     * @see elm_genlist_item_append()
17136     * @see elm_genlist_item_prepend()
17137     * @see elm_genlist_item_insert_after()
17138     * @see elm_genlist_item_del()
17139     *
17140     * @ingroup Genlist
17141     */
17142    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);
17143    /**
17144     * Insert an item after another in a genlist widget
17145     *
17146     * @param obj The genlist object
17147     * @param itc The item class for the item
17148     * @param data The item data
17149     * @param after The item to place this new one after.
17150     * @param flags Item flags
17151     * @param func Convenience function called when the item is selected
17152     * @param func_data Data passed to @p func above.
17153     * @return A handle to the item added or @c NULL if not possible
17154     *
17155     * This inserts an item after another in the list. It will be in the
17156     * same tree level or group as the item it is inserted after.
17157     *
17158     * @see elm_genlist_item_append()
17159     * @see elm_genlist_item_prepend()
17160     * @see elm_genlist_item_insert_before()
17161     * @see elm_genlist_item_del()
17162     *
17163     * @ingroup Genlist
17164     */
17165    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);
17166    /**
17167     * Insert a new item into the sorted genlist object
17168     *
17169     * @param obj The genlist object
17170     * @param itc The item class for the item
17171     * @param data The item data
17172     * @param parent The parent item, or NULL if none
17173     * @param flags Item flags
17174     * @param comp The function called for the sort
17175     * @param func Convenience function called when item selected
17176     * @param func_data Data passed to @p func above.
17177     * @return A handle to the item added or NULL if not possible
17178     *
17179     * @ingroup Genlist
17180     */
17181    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);
17182    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);
17183    /* operations to retrieve existing items */
17184    /**
17185     * Get the selectd item in the genlist.
17186     *
17187     * @param obj The genlist object
17188     * @return The selected item, or NULL if none is selected.
17189     *
17190     * This gets the selected item in the list (if multi-selection is enabled, only
17191     * the item that was first selected in the list is returned - which is not very
17192     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17193     * used).
17194     *
17195     * If no item is selected, NULL is returned.
17196     *
17197     * @see elm_genlist_selected_items_get()
17198     *
17199     * @ingroup Genlist
17200     */
17201    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17202    /**
17203     * Get a list of selected items in the genlist.
17204     *
17205     * @param obj The genlist object
17206     * @return The list of selected items, or NULL if none are selected.
17207     *
17208     * It returns a list of the selected items. This list pointer is only valid so
17209     * long as the selection doesn't change (no items are selected or unselected, or
17210     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17211     * pointers. The order of the items in this list is the order which they were
17212     * selected, i.e. the first item in this list is the first item that was
17213     * selected, and so on.
17214     *
17215     * @note If not in multi-select mode, consider using function
17216     * elm_genlist_selected_item_get() instead.
17217     *
17218     * @see elm_genlist_multi_select_set()
17219     * @see elm_genlist_selected_item_get()
17220     *
17221     * @ingroup Genlist
17222     */
17223    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17224    /**
17225     * Get a list of realized items in genlist
17226     *
17227     * @param obj The genlist object
17228     * @return The list of realized items, nor NULL if none are realized.
17229     *
17230     * This returns a list of the realized items in the genlist. The list
17231     * contains Elm_Genlist_Item pointers. The list must be freed by the
17232     * caller when done with eina_list_free(). The item pointers in the
17233     * list are only valid so long as those items are not deleted or the
17234     * genlist is not deleted.
17235     *
17236     * @see elm_genlist_realized_items_update()
17237     *
17238     * @ingroup Genlist
17239     */
17240    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17241    /**
17242     * Get the item that is at the x, y canvas coords.
17243     *
17244     * @param obj The gelinst object.
17245     * @param x The input x coordinate
17246     * @param y The input y coordinate
17247     * @param posret The position relative to the item returned here
17248     * @return The item at the coordinates or NULL if none
17249     *
17250     * This returns the item at the given coordinates (which are canvas
17251     * relative, not object-relative). If an item is at that coordinate,
17252     * that item handle is returned, and if @p posret is not NULL, the
17253     * integer pointed to is set to a value of -1, 0 or 1, depending if
17254     * the coordinate is on the upper portion of that item (-1), on the
17255     * middle section (0) or on the lower part (1). If NULL is returned as
17256     * an item (no item found there), then posret may indicate -1 or 1
17257     * based if the coordinate is above or below all items respectively in
17258     * the genlist.
17259     *
17260     * @ingroup Genlist
17261     */
17262    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);
17263    /**
17264     * Get the first item in the genlist
17265     *
17266     * This returns the first item in the list.
17267     *
17268     * @param obj The genlist object
17269     * @return The first item, or NULL if none
17270     *
17271     * @ingroup Genlist
17272     */
17273    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17274    /**
17275     * Get the last item in the genlist
17276     *
17277     * This returns the last item in the list.
17278     *
17279     * @return The last item, or NULL if none
17280     *
17281     * @ingroup Genlist
17282     */
17283    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17284    /**
17285     * Set the scrollbar policy
17286     *
17287     * @param obj The genlist object
17288     * @param policy_h Horizontal scrollbar policy.
17289     * @param policy_v Vertical scrollbar policy.
17290     *
17291     * This sets the scrollbar visibility policy for the given genlist
17292     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17293     * made visible if it is needed, and otherwise kept hidden.
17294     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17295     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17296     * respectively for the horizontal and vertical scrollbars. Default is
17297     * #ELM_SMART_SCROLLER_POLICY_AUTO
17298     *
17299     * @see elm_genlist_scroller_policy_get()
17300     *
17301     * @ingroup Genlist
17302     */
17303    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17304    /**
17305     * Get the scrollbar policy
17306     *
17307     * @param obj The genlist object
17308     * @param policy_h Pointer to store the horizontal scrollbar policy.
17309     * @param policy_v Pointer to store the vertical scrollbar policy.
17310     *
17311     * @see elm_genlist_scroller_policy_set()
17312     *
17313     * @ingroup Genlist
17314     */
17315    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);
17316    /**
17317     * Get the @b next item in a genlist widget's internal list of items,
17318     * given a handle to one of those items.
17319     *
17320     * @param item The genlist item to fetch next from
17321     * @return The item after @p item, or @c NULL if there's none (and
17322     * on errors)
17323     *
17324     * This returns the item placed after the @p item, on the container
17325     * genlist.
17326     *
17327     * @see elm_genlist_item_prev_get()
17328     *
17329     * @ingroup Genlist
17330     */
17331    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17332    /**
17333     * Get the @b previous item in a genlist widget's internal list of items,
17334     * given a handle to one of those items.
17335     *
17336     * @param item The genlist item to fetch previous from
17337     * @return The item before @p item, or @c NULL if there's none (and
17338     * on errors)
17339     *
17340     * This returns the item placed before the @p item, on the container
17341     * genlist.
17342     *
17343     * @see elm_genlist_item_next_get()
17344     *
17345     * @ingroup Genlist
17346     */
17347    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17348    /**
17349     * Get the genlist object's handle which contains a given genlist
17350     * item
17351     *
17352     * @param item The item to fetch the container from
17353     * @return The genlist (parent) object
17354     *
17355     * This returns the genlist object itself that an item belongs to.
17356     *
17357     * @ingroup Genlist
17358     */
17359    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17360    /**
17361     * Get the parent item of the given item
17362     *
17363     * @param it The item
17364     * @return The parent of the item or @c NULL if it has no parent.
17365     *
17366     * This returns the item that was specified as parent of the item @p it on
17367     * elm_genlist_item_append() and insertion related functions.
17368     *
17369     * @ingroup Genlist
17370     */
17371    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17372    /**
17373     * Remove all sub-items (children) of the given item
17374     *
17375     * @param it The item
17376     *
17377     * This removes all items that are children (and their descendants) of the
17378     * given item @p it.
17379     *
17380     * @see elm_genlist_clear()
17381     * @see elm_genlist_item_del()
17382     *
17383     * @ingroup Genlist
17384     */
17385    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17386    /**
17387     * Set whether a given genlist item is selected or not
17388     *
17389     * @param it The item
17390     * @param selected Use @c EINA_TRUE, to make it selected, @c
17391     * EINA_FALSE to make it unselected
17392     *
17393     * This sets the selected state of an item. If multi selection is
17394     * not enabled on the containing genlist and @p selected is @c
17395     * EINA_TRUE, any other previously selected items will get
17396     * unselected in favor of this new one.
17397     *
17398     * @see elm_genlist_item_selected_get()
17399     *
17400     * @ingroup Genlist
17401     */
17402    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17403    /**
17404     * Get whether a given genlist item is selected or not
17405     *
17406     * @param it The item
17407     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17408     *
17409     * @see elm_genlist_item_selected_set() for more details
17410     *
17411     * @ingroup Genlist
17412     */
17413    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17414    /**
17415     * Sets the expanded state of an item.
17416     *
17417     * @param it The item
17418     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17419     *
17420     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17421     * expanded or not.
17422     *
17423     * The theme will respond to this change visually, and a signal "expanded" or
17424     * "contracted" will be sent from the genlist with a pointer to the item that
17425     * has been expanded/contracted.
17426     *
17427     * Calling this function won't show or hide any child of this item (if it is
17428     * a parent). You must manually delete and create them on the callbacks fo
17429     * the "expanded" or "contracted" signals.
17430     *
17431     * @see elm_genlist_item_expanded_get()
17432     *
17433     * @ingroup Genlist
17434     */
17435    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17436    /**
17437     * Get the expanded state of an item
17438     *
17439     * @param it The item
17440     * @return The expanded state
17441     *
17442     * This gets the expanded state of an item.
17443     *
17444     * @see elm_genlist_item_expanded_set()
17445     *
17446     * @ingroup Genlist
17447     */
17448    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17449    /**
17450     * Get the depth of expanded item
17451     *
17452     * @param it The genlist item object
17453     * @return The depth of expanded item
17454     *
17455     * @ingroup Genlist
17456     */
17457    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17458    /**
17459     * Set whether a given genlist item is disabled or not.
17460     *
17461     * @param it The item
17462     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17463     * to enable it back.
17464     *
17465     * A disabled item cannot be selected or unselected. It will also
17466     * change its appearance, to signal the user it's disabled.
17467     *
17468     * @see elm_genlist_item_disabled_get()
17469     *
17470     * @ingroup Genlist
17471     */
17472    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17473    /**
17474     * Get whether a given genlist item is disabled or not.
17475     *
17476     * @param it The item
17477     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17478     * (and on errors).
17479     *
17480     * @see elm_genlist_item_disabled_set() for more details
17481     *
17482     * @ingroup Genlist
17483     */
17484    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17485    /**
17486     * Sets the display only state of an item.
17487     *
17488     * @param it The item
17489     * @param display_only @c EINA_TRUE if the item is display only, @c
17490     * EINA_FALSE otherwise.
17491     *
17492     * A display only item cannot be selected or unselected. It is for
17493     * display only and not selecting or otherwise clicking, dragging
17494     * etc. by the user, thus finger size rules will not be applied to
17495     * this item.
17496     *
17497     * It's good to set group index items to display only state.
17498     *
17499     * @see elm_genlist_item_display_only_get()
17500     *
17501     * @ingroup Genlist
17502     */
17503    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17504    /**
17505     * Get the display only state of an item
17506     *
17507     * @param it The item
17508     * @return @c EINA_TRUE if the item is display only, @c
17509     * EINA_FALSE otherwise.
17510     *
17511     * @see elm_genlist_item_display_only_set()
17512     *
17513     * @ingroup Genlist
17514     */
17515    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17516    /**
17517     * Show the portion of a genlist's internal list containing a given
17518     * item, immediately.
17519     *
17520     * @param it The item to display
17521     *
17522     * This causes genlist to jump to the given item @p it and show it (by
17523     * immediately scrolling to that position), if it is not fully visible.
17524     *
17525     * @see elm_genlist_item_bring_in()
17526     * @see elm_genlist_item_top_show()
17527     * @see elm_genlist_item_middle_show()
17528     *
17529     * @ingroup Genlist
17530     */
17531    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17532    /**
17533     * Animatedly bring in, to the visible are of a genlist, a given
17534     * item on it.
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     * animatedly scrolling), if it is not fully visible. This may use animation
17540     * to do so and take a period of time
17541     *
17542     * @see elm_genlist_item_show()
17543     * @see elm_genlist_item_top_bring_in()
17544     * @see elm_genlist_item_middle_bring_in()
17545     *
17546     * @ingroup Genlist
17547     */
17548    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17549    /**
17550     * Show the portion of a genlist's internal list containing a given
17551     * item, immediately.
17552     *
17553     * @param it The item to display
17554     *
17555     * This causes genlist to jump to the given item @p it and show it (by
17556     * immediately scrolling to that position), if it is not fully visible.
17557     *
17558     * The item will be positioned at the top of the genlist viewport.
17559     *
17560     * @see elm_genlist_item_show()
17561     * @see elm_genlist_item_top_bring_in()
17562     *
17563     * @ingroup Genlist
17564     */
17565    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17566    /**
17567     * Animatedly bring in, to the visible are of a genlist, a given
17568     * item on it.
17569     *
17570     * @param it The item
17571     *
17572     * This causes genlist to jump to the given item @p it and show it (by
17573     * animatedly scrolling), if it is not fully visible. This may use animation
17574     * to do so and take a period of time
17575     *
17576     * The item will be positioned at the top of the genlist viewport.
17577     *
17578     * @see elm_genlist_item_bring_in()
17579     * @see elm_genlist_item_top_show()
17580     *
17581     * @ingroup Genlist
17582     */
17583    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17584    /**
17585     * Show the portion of a genlist's internal list containing a given
17586     * item, immediately.
17587     *
17588     * @param it The item to display
17589     *
17590     * This causes genlist to jump to the given item @p it and show it (by
17591     * immediately scrolling to that position), if it is not fully visible.
17592     *
17593     * The item will be positioned at the middle of the genlist viewport.
17594     *
17595     * @see elm_genlist_item_show()
17596     * @see elm_genlist_item_middle_bring_in()
17597     *
17598     * @ingroup Genlist
17599     */
17600    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17601    /**
17602     * Animatedly bring in, to the visible are of a genlist, a given
17603     * item on it.
17604     *
17605     * @param it The item
17606     *
17607     * This causes genlist to jump to the given item @p it and show it (by
17608     * animatedly scrolling), if it is not fully visible. This may use animation
17609     * to do so and take a period of time
17610     *
17611     * The item will be positioned at the middle of the genlist viewport.
17612     *
17613     * @see elm_genlist_item_bring_in()
17614     * @see elm_genlist_item_middle_show()
17615     *
17616     * @ingroup Genlist
17617     */
17618    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17619    /**
17620     * Remove a genlist item from the its parent, deleting it.
17621     *
17622     * @param item The item to be removed.
17623     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17624     *
17625     * @see elm_genlist_clear(), to remove all items in a genlist at
17626     * once.
17627     *
17628     * @ingroup Genlist
17629     */
17630    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17631    /**
17632     * Return the data associated to a given genlist item
17633     *
17634     * @param item The genlist item.
17635     * @return the data associated to this item.
17636     *
17637     * This returns the @c data value passed on the
17638     * elm_genlist_item_append() and related item addition calls.
17639     *
17640     * @see elm_genlist_item_append()
17641     * @see elm_genlist_item_data_set()
17642     *
17643     * @ingroup Genlist
17644     */
17645    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17646    /**
17647     * Set the data associated to a given genlist item
17648     *
17649     * @param item The genlist item
17650     * @param data The new data pointer to set on it
17651     *
17652     * This @b overrides the @c data value passed on the
17653     * elm_genlist_item_append() and related item addition calls. This
17654     * function @b won't call elm_genlist_item_update() automatically,
17655     * so you'd issue it afterwards if you want to hove the item
17656     * updated to reflect the that new data.
17657     *
17658     * @see elm_genlist_item_data_get()
17659     *
17660     * @ingroup Genlist
17661     */
17662    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17663    /**
17664     * Tells genlist to "orphan" icons fetchs by the item class
17665     *
17666     * @param it The item
17667     *
17668     * This instructs genlist to release references to icons in the item,
17669     * meaning that they will no longer be managed by genlist and are
17670     * floating "orphans" that can be re-used elsewhere if the user wants
17671     * to.
17672     *
17673     * @ingroup Genlist
17674     */
17675    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17676    /**
17677     * Get the real Evas object created to implement the view of a
17678     * given genlist item
17679     *
17680     * @param item The genlist item.
17681     * @return the Evas object implementing this item's view.
17682     *
17683     * This returns the actual Evas object used to implement the
17684     * specified genlist item's view. This may be @c NULL, as it may
17685     * not have been created or may have been deleted, at any time, by
17686     * the genlist. <b>Do not modify this object</b> (move, resize,
17687     * show, hide, etc.), as the genlist is controlling it. This
17688     * function is for querying, emitting custom signals or hooking
17689     * lower level callbacks for events on that object. Do not delete
17690     * this object under any circumstances.
17691     *
17692     * @see elm_genlist_item_data_get()
17693     *
17694     * @ingroup Genlist
17695     */
17696    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17697    /**
17698     * Update the contents of an item
17699     *
17700     * @param it The item
17701     *
17702     * This updates an item by calling all the item class functions again
17703     * to get the icons, labels and states. Use this when the original
17704     * item data has changed and the changes are desired to be reflected.
17705     *
17706     * Use elm_genlist_realized_items_update() to update all already realized
17707     * items.
17708     *
17709     * @see elm_genlist_realized_items_update()
17710     *
17711     * @ingroup Genlist
17712     */
17713    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17714    /**
17715     * Update the item class of an item
17716     *
17717     * @param it The item
17718     * @param itc The item class for the item
17719     *
17720     * This sets another class fo the item, changing the way that it is
17721     * displayed. After changing the item class, elm_genlist_item_update() is
17722     * called on the item @p it.
17723     *
17724     * @ingroup Genlist
17725     */
17726    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17727    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17728    /**
17729     * Set the text to be shown in a given genlist item's tooltips.
17730     *
17731     * @param item The genlist item
17732     * @param text The text to set in the content
17733     *
17734     * This call will setup the text to be used as tooltip to that item
17735     * (analogous to elm_object_tooltip_text_set(), but being item
17736     * tooltips with higher precedence than object tooltips). It can
17737     * have only one tooltip at a time, so any previous tooltip data
17738     * will get removed.
17739     *
17740     * In order to set an icon or something else as a tooltip, look at
17741     * elm_genlist_item_tooltip_content_cb_set().
17742     *
17743     * @ingroup Genlist
17744     */
17745    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17746    /**
17747     * Set the content to be shown in a given genlist item's tooltips
17748     *
17749     * @param item The genlist item.
17750     * @param func The function returning the tooltip contents.
17751     * @param data What to provide to @a func as callback data/context.
17752     * @param del_cb Called when data is not needed anymore, either when
17753     *        another callback replaces @p func, the tooltip is unset with
17754     *        elm_genlist_item_tooltip_unset() or the owner @p item
17755     *        dies. This callback receives as its first parameter the
17756     *        given @p data, being @c event_info the item handle.
17757     *
17758     * This call will setup the tooltip's contents to @p item
17759     * (analogous to elm_object_tooltip_content_cb_set(), but being
17760     * item tooltips with higher precedence than object tooltips). It
17761     * can have only one tooltip at a time, so any previous tooltip
17762     * content will get removed. @p func (with @p data) will be called
17763     * every time Elementary needs to show the tooltip and it should
17764     * return a valid Evas object, which will be fully managed by the
17765     * tooltip system, getting deleted when the tooltip is gone.
17766     *
17767     * In order to set just a text as a tooltip, look at
17768     * elm_genlist_item_tooltip_text_set().
17769     *
17770     * @ingroup Genlist
17771     */
17772    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);
17773    /**
17774     * Unset a tooltip from a given genlist item
17775     *
17776     * @param item genlist item to remove a previously set tooltip from.
17777     *
17778     * This call removes any tooltip set on @p item. The callback
17779     * provided as @c del_cb to
17780     * elm_genlist_item_tooltip_content_cb_set() will be called to
17781     * notify it is not used anymore (and have resources cleaned, if
17782     * need be).
17783     *
17784     * @see elm_genlist_item_tooltip_content_cb_set()
17785     *
17786     * @ingroup Genlist
17787     */
17788    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17789    /**
17790     * Set a different @b style for a given genlist item's tooltip.
17791     *
17792     * @param item genlist item with tooltip set
17793     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17794     * "default", @c "transparent", etc)
17795     *
17796     * Tooltips can have <b>alternate styles</b> to be displayed on,
17797     * which are defined by the theme set on Elementary. This function
17798     * works analogously as elm_object_tooltip_style_set(), but here
17799     * applied only to genlist item objects. The default style for
17800     * tooltips is @c "default".
17801     *
17802     * @note before you set a style you should define a tooltip with
17803     *       elm_genlist_item_tooltip_content_cb_set() or
17804     *       elm_genlist_item_tooltip_text_set()
17805     *
17806     * @see elm_genlist_item_tooltip_style_get()
17807     *
17808     * @ingroup Genlist
17809     */
17810    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17811    /**
17812     * Get the style set a given genlist item's tooltip.
17813     *
17814     * @param item genlist item with tooltip already set on.
17815     * @return style the theme style in use, which defaults to
17816     *         "default". If the object does not have a tooltip set,
17817     *         then @c NULL is returned.
17818     *
17819     * @see elm_genlist_item_tooltip_style_set() for more details
17820     *
17821     * @ingroup Genlist
17822     */
17823    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17824    /**
17825     * @brief Disable size restrictions on an object's tooltip
17826     * @param item The tooltip's anchor object
17827     * @param disable If EINA_TRUE, size restrictions are disabled
17828     * @return EINA_FALSE on failure, EINA_TRUE on success
17829     *
17830     * This function allows a tooltip to expand beyond its parant window's canvas.
17831     * It will instead be limited only by the size of the display.
17832     */
17833    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17834    /**
17835     * @brief Retrieve size restriction state of an object's tooltip
17836     * @param item The tooltip's anchor object
17837     * @return If EINA_TRUE, size restrictions are disabled
17838     *
17839     * This function returns whether a tooltip is allowed to expand beyond
17840     * its parant window's canvas.
17841     * It will instead be limited only by the size of the display.
17842     */
17843    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17844    /**
17845     * Set the type of mouse pointer/cursor decoration to be shown,
17846     * when the mouse pointer is over the given genlist widget item
17847     *
17848     * @param item genlist item to customize cursor on
17849     * @param cursor the cursor type's name
17850     *
17851     * This function works analogously as elm_object_cursor_set(), but
17852     * here the cursor's changing area is restricted to the item's
17853     * area, and not the whole widget's. Note that that item cursors
17854     * have precedence over widget cursors, so that a mouse over @p
17855     * item will always show cursor @p type.
17856     *
17857     * If this function is called twice for an object, a previously set
17858     * cursor will be unset on the second call.
17859     *
17860     * @see elm_object_cursor_set()
17861     * @see elm_genlist_item_cursor_get()
17862     * @see elm_genlist_item_cursor_unset()
17863     *
17864     * @ingroup Genlist
17865     */
17866    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17867    /**
17868     * Get the type of mouse pointer/cursor decoration set to be shown,
17869     * when the mouse pointer is over the given genlist widget item
17870     *
17871     * @param item genlist item with custom cursor set
17872     * @return the cursor type's name or @c NULL, if no custom cursors
17873     * were set to @p item (and on errors)
17874     *
17875     * @see elm_object_cursor_get()
17876     * @see elm_genlist_item_cursor_set() for more details
17877     * @see elm_genlist_item_cursor_unset()
17878     *
17879     * @ingroup Genlist
17880     */
17881    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17882    /**
17883     * Unset any custom mouse pointer/cursor decoration set to be
17884     * shown, when the mouse pointer is over the given genlist widget
17885     * item, thus making it show the @b default cursor again.
17886     *
17887     * @param item a genlist item
17888     *
17889     * Use this call to undo any custom settings on this item's cursor
17890     * decoration, bringing it back to defaults (no custom style set).
17891     *
17892     * @see elm_object_cursor_unset()
17893     * @see elm_genlist_item_cursor_set() for more details
17894     *
17895     * @ingroup Genlist
17896     */
17897    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17898    /**
17899     * Set a different @b style for a given custom cursor set for a
17900     * genlist item.
17901     *
17902     * @param item genlist item with custom cursor set
17903     * @param style the <b>theme style</b> to use (e.g. @c "default",
17904     * @c "transparent", etc)
17905     *
17906     * This function only makes sense when one is using custom mouse
17907     * cursor decorations <b>defined in a theme file</b> , which can
17908     * have, given a cursor name/type, <b>alternate styles</b> on
17909     * it. It works analogously as elm_object_cursor_style_set(), but
17910     * here applied only to genlist item objects.
17911     *
17912     * @warning Before you set a cursor style you should have defined a
17913     *       custom cursor previously on the item, with
17914     *       elm_genlist_item_cursor_set()
17915     *
17916     * @see elm_genlist_item_cursor_engine_only_set()
17917     * @see elm_genlist_item_cursor_style_get()
17918     *
17919     * @ingroup Genlist
17920     */
17921    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17922    /**
17923     * Get the current @b style set for a given genlist item's custom
17924     * cursor
17925     *
17926     * @param item genlist item with custom cursor set.
17927     * @return style the cursor style in use. If the object does not
17928     *         have a cursor set, then @c NULL is returned.
17929     *
17930     * @see elm_genlist_item_cursor_style_set() for more details
17931     *
17932     * @ingroup Genlist
17933     */
17934    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17935    /**
17936     * Set if the (custom) cursor for a given genlist item should be
17937     * searched in its theme, also, or should only rely on the
17938     * rendering engine.
17939     *
17940     * @param item item with custom (custom) cursor already set on
17941     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17942     * only on those provided by the rendering engine, @c EINA_FALSE to
17943     * have them searched on the widget's theme, as well.
17944     *
17945     * @note This call is of use only if you've set a custom cursor
17946     * for genlist items, with elm_genlist_item_cursor_set().
17947     *
17948     * @note By default, cursors will only be looked for between those
17949     * provided by the rendering engine.
17950     *
17951     * @ingroup Genlist
17952     */
17953    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17954    /**
17955     * Get if the (custom) cursor for a given genlist item is being
17956     * searched in its theme, also, or is only relying on the rendering
17957     * engine.
17958     *
17959     * @param item a genlist item
17960     * @return @c EINA_TRUE, if cursors are being looked for only on
17961     * those provided by the rendering engine, @c EINA_FALSE if they
17962     * are being searched on the widget's theme, as well.
17963     *
17964     * @see elm_genlist_item_cursor_engine_only_set(), for more details
17965     *
17966     * @ingroup Genlist
17967     */
17968    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17969    /**
17970     * Update the contents of all realized items.
17971     *
17972     * @param obj The genlist object.
17973     *
17974     * This updates all realized items by calling all the item class functions again
17975     * to get the icons, labels and states. Use this when the original
17976     * item data has changed and the changes are desired to be reflected.
17977     *
17978     * To update just one item, use elm_genlist_item_update().
17979     *
17980     * @see elm_genlist_realized_items_get()
17981     * @see elm_genlist_item_update()
17982     *
17983     * @ingroup Genlist
17984     */
17985    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
17986    /**
17987     * Activate a genlist mode on an item
17988     *
17989     * @param item The genlist item
17990     * @param mode Mode name
17991     * @param mode_set Boolean to define set or unset mode.
17992     *
17993     * A genlist mode is a different way of selecting an item. Once a mode is
17994     * activated on an item, any other selected item is immediately unselected.
17995     * This feature provides an easy way of implementing a new kind of animation
17996     * for selecting an item, without having to entirely rewrite the item style
17997     * theme. However, the elm_genlist_selected_* API can't be used to get what
17998     * item is activate for a mode.
17999     *
18000     * The current item style will still be used, but applying a genlist mode to
18001     * an item will select it using a different kind of animation.
18002     *
18003     * The current active item for a mode can be found by
18004     * elm_genlist_mode_item_get().
18005     *
18006     * The characteristics of genlist mode are:
18007     * - Only one mode can be active at any time, and for only one item.
18008     * - Genlist handles deactivating other items when one item is activated.
18009     * - A mode is defined in the genlist theme (edc), and more modes can easily
18010     *   be added.
18011     * - A mode style and the genlist item style are different things. They
18012     *   can be combined to provide a default style to the item, with some kind
18013     *   of animation for that item when the mode is activated.
18014     *
18015     * When a mode is activated on an item, a new view for that item is created.
18016     * The theme of this mode defines the animation that will be used to transit
18017     * the item from the old view to the new view. This second (new) view will be
18018     * active for that item while the mode is active on the item, and will be
18019     * destroyed after the mode is totally deactivated from that item.
18020     *
18021     * @see elm_genlist_mode_get()
18022     * @see elm_genlist_mode_item_get()
18023     *
18024     * @ingroup Genlist
18025     */
18026    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18027    /**
18028     * Get the last (or current) genlist mode used.
18029     *
18030     * @param obj The genlist object
18031     *
18032     * This function just returns the name of the last used genlist mode. It will
18033     * be the current mode if it's still active.
18034     *
18035     * @see elm_genlist_item_mode_set()
18036     * @see elm_genlist_mode_item_get()
18037     *
18038     * @ingroup Genlist
18039     */
18040    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18041    /**
18042     * Get active genlist mode item
18043     *
18044     * @param obj The genlist object
18045     * @return The active item for that current mode. Or @c NULL if no item is
18046     * activated with any mode.
18047     *
18048     * This function returns the item that was activated with a mode, by the
18049     * function elm_genlist_item_mode_set().
18050     *
18051     * @see elm_genlist_item_mode_set()
18052     * @see elm_genlist_mode_get()
18053     *
18054     * @ingroup Genlist
18055     */
18056    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18057
18058    /**
18059     * Set reorder mode
18060     *
18061     * @param obj The genlist object
18062     * @param reorder_mode The reorder mode
18063     * (EINA_TRUE = on, EINA_FALSE = off)
18064     *
18065     * @ingroup Genlist
18066     */
18067    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18068
18069    /**
18070     * Get the reorder mode
18071     *
18072     * @param obj The genlist object
18073     * @return The reorder mode
18074     * (EINA_TRUE = on, EINA_FALSE = off)
18075     *
18076     * @ingroup Genlist
18077     */
18078    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18079
18080    /**
18081     * @}
18082     */
18083
18084    /**
18085     * @defgroup Check Check
18086     *
18087     * @image html img/widget/check/preview-00.png
18088     * @image latex img/widget/check/preview-00.eps
18089     * @image html img/widget/check/preview-01.png
18090     * @image latex img/widget/check/preview-01.eps
18091     * @image html img/widget/check/preview-02.png
18092     * @image latex img/widget/check/preview-02.eps
18093     *
18094     * @brief The check widget allows for toggling a value between true and
18095     * false.
18096     *
18097     * Check objects are a lot like radio objects in layout and functionality
18098     * except they do not work as a group, but independently and only toggle the
18099     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18100     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18101     * returns the current state. For convenience, like the radio objects, you
18102     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18103     * for it to modify.
18104     *
18105     * Signals that you can add callbacks for are:
18106     * "changed" - This is called whenever the user changes the state of one of
18107     *             the check object(event_info is NULL).
18108     *
18109     * @ref tutorial_check should give you a firm grasp of how to use this widget.
18110     * @{
18111     */
18112    /**
18113     * @brief Add a new Check object
18114     *
18115     * @param parent The parent object
18116     * @return The new object or NULL if it cannot be created
18117     */
18118    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18119    /**
18120     * @brief Set the text label of the check object
18121     *
18122     * @param obj The check object
18123     * @param label The text label string in UTF-8
18124     *
18125     * @deprecated use elm_object_text_set() instead.
18126     */
18127    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18128    /**
18129     * @brief Get the text label of the check object
18130     *
18131     * @param obj The check object
18132     * @return The text label string in UTF-8
18133     *
18134     * @deprecated use elm_object_text_get() instead.
18135     */
18136    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18137    /**
18138     * @brief Set the icon object of the check object
18139     *
18140     * @param obj The check object
18141     * @param icon The icon object
18142     *
18143     * Once the icon object is set, a previously set one will be deleted.
18144     * If you want to keep that old content object, use the
18145     * elm_check_icon_unset() function.
18146     */
18147    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18148    /**
18149     * @brief Get the icon object of the check object
18150     *
18151     * @param obj The check object
18152     * @return The icon object
18153     */
18154    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18155    /**
18156     * @brief Unset the icon used for the check object
18157     *
18158     * @param obj The check object
18159     * @return The icon object that was being used
18160     *
18161     * Unparent and return the icon object which was set for this widget.
18162     */
18163    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18164    /**
18165     * @brief Set the on/off state of the check object
18166     *
18167     * @param obj The check object
18168     * @param state The state to use (1 == on, 0 == off)
18169     *
18170     * This sets the state of the check. If set
18171     * with elm_check_state_pointer_set() the state of that variable is also
18172     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18173     */
18174    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18175    /**
18176     * @brief Get the state of the check object
18177     *
18178     * @param obj The check object
18179     * @return The boolean state
18180     */
18181    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18182    /**
18183     * @brief Set a convenience pointer to a boolean to change
18184     *
18185     * @param obj The check object
18186     * @param statep Pointer to the boolean to modify
18187     *
18188     * This sets a pointer to a boolean, that, in addition to the check objects
18189     * state will also be modified directly. To stop setting the object pointed
18190     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18191     * then when this is called, the check objects state will also be modified to
18192     * reflect the value of the boolean @p statep points to, just like calling
18193     * elm_check_state_set().
18194     */
18195    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18196    /**
18197     * @}
18198     */
18199
18200    /**
18201     * @defgroup Radio Radio
18202     *
18203     * @image html img/widget/radio/preview-00.png
18204     * @image latex img/widget/radio/preview-00.eps
18205     *
18206     * @brief Radio is a widget that allows for 1 or more options to be displayed
18207     * and have the user choose only 1 of them.
18208     *
18209     * A radio object contains an indicator, an optional Label and an optional
18210     * icon object. While it's possible to have a group of only one radio they,
18211     * are normally used in groups of 2 or more. To add a radio to a group use
18212     * elm_radio_group_add(). The radio object(s) will select from one of a set
18213     * of integer values, so any value they are configuring needs to be mapped to
18214     * a set of integers. To configure what value that radio object represents,
18215     * use  elm_radio_state_value_set() to set the integer it represents. To set
18216     * the value the whole group(which one is currently selected) is to indicate
18217     * use elm_radio_value_set() on any group member, and to get the groups value
18218     * use elm_radio_value_get(). For convenience the radio objects are also able
18219     * to directly set an integer(int) to the value that is selected. To specify
18220     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18221     * The radio objects will modify this directly. That implies the pointer must
18222     * point to valid memory for as long as the radio objects exist.
18223     *
18224     * Signals that you can add callbacks for are:
18225     * @li changed - This is called whenever the user changes the state of one of
18226     * the radio objects within the group of radio objects that work together.
18227     *
18228     * @ref tutorial_radio show most of this API in action.
18229     * @{
18230     */
18231    /**
18232     * @brief Add a new radio to the parent
18233     *
18234     * @param parent The parent object
18235     * @return The new object or NULL if it cannot be created
18236     */
18237    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18238    /**
18239     * @brief Set the text label of the radio object
18240     *
18241     * @param obj The radio object
18242     * @param label The text label string in UTF-8
18243     *
18244     * @deprecated use elm_object_text_set() instead.
18245     */
18246    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18247    /**
18248     * @brief Get the text label of the radio object
18249     *
18250     * @param obj The radio object
18251     * @return The text label string in UTF-8
18252     *
18253     * @deprecated use elm_object_text_set() instead.
18254     */
18255    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18256    /**
18257     * @brief Set the icon object of the radio object
18258     *
18259     * @param obj The radio object
18260     * @param icon The icon object
18261     *
18262     * Once the icon object is set, a previously set one will be deleted. If you
18263     * want to keep that old content object, use the elm_radio_icon_unset()
18264     * function.
18265     */
18266    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18267    /**
18268     * @brief Get the icon object of the radio object
18269     *
18270     * @param obj The radio object
18271     * @return The icon object
18272     *
18273     * @see elm_radio_icon_set()
18274     */
18275    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18276    /**
18277     * @brief Unset the icon used for the radio object
18278     *
18279     * @param obj The radio object
18280     * @return The icon object that was being used
18281     *
18282     * Unparent and return the icon object which was set for this widget.
18283     *
18284     * @see elm_radio_icon_set()
18285     */
18286    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18287    /**
18288     * @brief Add this radio to a group of other radio objects
18289     *
18290     * @param obj The radio object
18291     * @param group Any object whose group the @p obj is to join.
18292     *
18293     * Radio objects work in groups. Each member should have a different integer
18294     * value assigned. In order to have them work as a group, they need to know
18295     * about each other. This adds the given radio object to the group of which
18296     * the group object indicated is a member.
18297     */
18298    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18299    /**
18300     * @brief Set the integer value that this radio object represents
18301     *
18302     * @param obj The radio object
18303     * @param value The value to use if this radio object is selected
18304     *
18305     * This sets the value of the radio.
18306     */
18307    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18308    /**
18309     * @brief Get the integer value that this radio object represents
18310     *
18311     * @param obj The radio object
18312     * @return The value used if this radio object is selected
18313     *
18314     * This gets the value of the radio.
18315     *
18316     * @see elm_radio_value_set()
18317     */
18318    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18319    /**
18320     * @brief Set the value of the radio.
18321     *
18322     * @param obj The radio object
18323     * @param value The value to use for the group
18324     *
18325     * This sets the value of the radio group and will also set the value if
18326     * pointed to, to the value supplied, but will not call any callbacks.
18327     */
18328    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18329    /**
18330     * @brief Get the state of the radio object
18331     *
18332     * @param obj The radio object
18333     * @return The integer state
18334     */
18335    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18336    /**
18337     * @brief Set a convenience pointer to a integer to change
18338     *
18339     * @param obj The radio object
18340     * @param valuep Pointer to the integer to modify
18341     *
18342     * This sets a pointer to a integer, that, in addition to the radio objects
18343     * state will also be modified directly. To stop setting the object pointed
18344     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18345     * when this is called, the radio objects state will also be modified to
18346     * reflect the value of the integer valuep points to, just like calling
18347     * elm_radio_value_set().
18348     */
18349    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18350    /**
18351     * @}
18352     */
18353
18354    /**
18355     * @defgroup Pager Pager
18356     *
18357     * @image html img/widget/pager/preview-00.png
18358     * @image latex img/widget/pager/preview-00.eps
18359     *
18360     * @brief Widget that allows flipping between 1 or more “pages” of objects.
18361     *
18362     * The flipping between “pages” of objects is animated. All content in pager
18363     * is kept in a stack, the last content to be added will be on the top of the
18364     * stack(be visible).
18365     *
18366     * Objects can be pushed or popped from the stack or deleted as normal.
18367     * Pushes and pops will animate (and a pop will delete the object once the
18368     * animation is finished). Any object already in the pager can be promoted to
18369     * the top(from its current stacking position) through the use of
18370     * elm_pager_content_promote(). Objects are pushed to the top with
18371     * elm_pager_content_push() and when the top item is no longer wanted, simply
18372     * pop it with elm_pager_content_pop() and it will also be deleted. If an
18373     * object is no longer needed and is not the top item, just delete it as
18374     * normal. You can query which objects are the top and bottom with
18375     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18376     *
18377     * Signals that you can add callbacks for are:
18378     * "hide,finished" - when the previous page is hided
18379     *
18380     * This widget has the following styles available:
18381     * @li default
18382     * @li fade
18383     * @li fade_translucide
18384     * @li fade_invisible
18385     * @note This styles affect only the flipping animations, the appearance when
18386     * not animating is unaffected by styles.
18387     *
18388     * @ref tutorial_pager gives a good overview of the usage of the API.
18389     * @{
18390     */
18391    /**
18392     * Add a new pager to the parent
18393     *
18394     * @param parent The parent object
18395     * @return The new object or NULL if it cannot be created
18396     *
18397     * @ingroup Pager
18398     */
18399    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18400    /**
18401     * @brief Push an object to the top of the pager stack (and show it).
18402     *
18403     * @param obj The pager object
18404     * @param content The object to push
18405     *
18406     * The object pushed becomes a child of the pager, it will be controlled and
18407     * deleted when the pager is deleted.
18408     *
18409     * @note If the content is already in the stack use
18410     * elm_pager_content_promote().
18411     * @warning Using this function on @p content already in the stack results in
18412     * undefined behavior.
18413     */
18414    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18415    /**
18416     * @brief Pop the object that is on top of the stack
18417     *
18418     * @param obj The pager object
18419     *
18420     * This pops the object that is on the top(visible) of the pager, makes it
18421     * disappear, then deletes the object. The object that was underneath it on
18422     * the stack will become visible.
18423     */
18424    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18425    /**
18426     * @brief Moves an object already in the pager stack to the top of the stack.
18427     *
18428     * @param obj The pager object
18429     * @param content The object to promote
18430     *
18431     * This will take the @p content and move it to the top of the stack as
18432     * if it had been pushed there.
18433     *
18434     * @note If the content isn't already in the stack use
18435     * elm_pager_content_push().
18436     * @warning Using this function on @p content not already in the stack
18437     * results in undefined behavior.
18438     */
18439    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18440    /**
18441     * @brief Return the object at the bottom of the pager stack
18442     *
18443     * @param obj The pager object
18444     * @return The bottom object or NULL if none
18445     */
18446    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18447    /**
18448     * @brief  Return the object at the top of the pager stack
18449     *
18450     * @param obj The pager object
18451     * @return The top object or NULL if none
18452     */
18453    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18454    /**
18455     * @}
18456     */
18457
18458    /**
18459     * @defgroup Slideshow Slideshow
18460     *
18461     * @image html img/widget/slideshow/preview-00.png
18462     * @image latex img/widget/slideshow/preview-00.eps
18463     *
18464     * This widget, as the name indicates, is a pre-made image
18465     * slideshow panel, with API functions acting on (child) image
18466     * items presentation. Between those actions, are:
18467     * - advance to next/previous image
18468     * - select the style of image transition animation
18469     * - set the exhibition time for each image
18470     * - start/stop the slideshow
18471     *
18472     * The transition animations are defined in the widget's theme,
18473     * consequently new animations can be added without having to
18474     * update the widget's code.
18475     *
18476     * @section Slideshow_Items Slideshow items
18477     *
18478     * For slideshow items, just like for @ref Genlist "genlist" ones,
18479     * the user defines a @b classes, specifying functions that will be
18480     * called on the item's creation and deletion times.
18481     *
18482     * The #Elm_Slideshow_Item_Class structure contains the following
18483     * members:
18484     *
18485     * - @c func.get - When an item is displayed, this function is
18486     *   called, and it's where one should create the item object, de
18487     *   facto. For example, the object can be a pure Evas image object
18488     *   or an Elementary @ref Photocam "photocam" widget. See
18489     *   #SlideshowItemGetFunc.
18490     * - @c func.del - When an item is no more displayed, this function
18491     *   is called, where the user must delete any data associated to
18492     *   the item. See #SlideshowItemDelFunc.
18493     *
18494     * @section Slideshow_Caching Slideshow caching
18495     *
18496     * The slideshow provides facilities to have items adjacent to the
18497     * one being displayed <b>already "realized"</b> (i.e. loaded) for
18498     * you, so that the system does not have to decode image data
18499     * anymore at the time it has to actually switch images on its
18500     * viewport. The user is able to set the numbers of items to be
18501     * cached @b before and @b after the current item, in the widget's
18502     * item list.
18503     *
18504     * Smart events one can add callbacks for are:
18505     *
18506     * - @c "changed" - when the slideshow switches its view to a new
18507     *   item
18508     *
18509     * List of examples for the slideshow widget:
18510     * @li @ref slideshow_example
18511     */
18512
18513    /**
18514     * @addtogroup Slideshow
18515     * @{
18516     */
18517
18518    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18519    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18520    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
18521    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18522    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18523
18524    /**
18525     * @struct _Elm_Slideshow_Item_Class
18526     *
18527     * Slideshow item class definition. See @ref Slideshow_Items for
18528     * field details.
18529     */
18530    struct _Elm_Slideshow_Item_Class
18531      {
18532         struct _Elm_Slideshow_Item_Class_Func
18533           {
18534              SlideshowItemGetFunc get;
18535              SlideshowItemDelFunc del;
18536           } func;
18537      }; /**< #Elm_Slideshow_Item_Class member definitions */
18538
18539    /**
18540     * Add a new slideshow widget to the given parent Elementary
18541     * (container) object
18542     *
18543     * @param parent The parent object
18544     * @return A new slideshow widget handle or @c NULL, on errors
18545     *
18546     * This function inserts a new slideshow widget on the canvas.
18547     *
18548     * @ingroup Slideshow
18549     */
18550    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18551
18552    /**
18553     * Add (append) a new item in a given slideshow widget.
18554     *
18555     * @param obj The slideshow object
18556     * @param itc The item class for the item
18557     * @param data The item's data
18558     * @return A handle to the item added or @c NULL, on errors
18559     *
18560     * Add a new item to @p obj's internal list of items, appending it.
18561     * The item's class must contain the function really fetching the
18562     * image object to show for this item, which could be an Evas image
18563     * object or an Elementary photo, for example. The @p data
18564     * parameter is going to be passed to both class functions of the
18565     * item.
18566     *
18567     * @see #Elm_Slideshow_Item_Class
18568     * @see elm_slideshow_item_sorted_insert()
18569     *
18570     * @ingroup Slideshow
18571     */
18572    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18573
18574    /**
18575     * Insert a new item into the given slideshow widget, using the @p func
18576     * function to sort items (by item handles).
18577     *
18578     * @param obj The slideshow object
18579     * @param itc The item class for the item
18580     * @param data The item's data
18581     * @param func The comparing function to be used to sort slideshow
18582     * items <b>by #Elm_Slideshow_Item item handles</b>
18583     * @return Returns The slideshow item handle, on success, or
18584     * @c NULL, on errors
18585     *
18586     * Add a new item to @p obj's internal list of items, in a position
18587     * determined by the @p func comparing function. The item's class
18588     * must contain the function really fetching the image object to
18589     * show for this item, which could be an Evas image object or an
18590     * Elementary photo, for example. The @p data parameter is going to
18591     * be passed to both class functions of the item.
18592     *
18593     * @see #Elm_Slideshow_Item_Class
18594     * @see elm_slideshow_item_add()
18595     *
18596     * @ingroup Slideshow
18597     */
18598    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);
18599
18600    /**
18601     * Display a given slideshow widget's item, programmatically.
18602     *
18603     * @param obj The slideshow object
18604     * @param item The item to display on @p obj's viewport
18605     *
18606     * The change between the current item and @p item will use the
18607     * transition @p obj is set to use (@see
18608     * elm_slideshow_transition_set()).
18609     *
18610     * @ingroup Slideshow
18611     */
18612    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18613
18614    /**
18615     * Slide to the @b next item, in a given slideshow widget
18616     *
18617     * @param obj The slideshow object
18618     *
18619     * The sliding animation @p obj is set to use will be the
18620     * transition effect used, after this call is issued.
18621     *
18622     * @note If the end of the slideshow's internal list of items is
18623     * reached, it'll wrap around to the list's beginning, again.
18624     *
18625     * @ingroup Slideshow
18626     */
18627    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18628
18629    /**
18630     * Slide to the @b previous item, in a given slideshow widget
18631     *
18632     * @param obj The slideshow object
18633     *
18634     * The sliding animation @p obj is set to use will be the
18635     * transition effect used, after this call is issued.
18636     *
18637     * @note If the beginning of the slideshow's internal list of items
18638     * is reached, it'll wrap around to the list's end, again.
18639     *
18640     * @ingroup Slideshow
18641     */
18642    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18643
18644    /**
18645     * Returns the list of sliding transition/effect names available, for a
18646     * given slideshow widget.
18647     *
18648     * @param obj The slideshow object
18649     * @return The list of transitions (list of @b stringshared strings
18650     * as data)
18651     *
18652     * The transitions, which come from @p obj's theme, must be an EDC
18653     * data item named @c "transitions" on the theme file, with (prefix)
18654     * names of EDC programs actually implementing them.
18655     *
18656     * The available transitions for slideshows on the default theme are:
18657     * - @c "fade" - the current item fades out, while the new one
18658     *   fades in to the slideshow's viewport.
18659     * - @c "black_fade" - the current item fades to black, and just
18660     *   then, the new item will fade in.
18661     * - @c "horizontal" - the current item slides horizontally, until
18662     *   it gets out of the slideshow's viewport, while the new item
18663     *   comes from the left to take its place.
18664     * - @c "vertical" - the current item slides vertically, until it
18665     *   gets out of the slideshow's viewport, while the new item comes
18666     *   from the bottom to take its place.
18667     * - @c "square" - the new item starts to appear from the middle of
18668     *   the current one, but with a tiny size, growing until its
18669     *   target (full) size and covering the old one.
18670     *
18671     * @warning The stringshared strings get no new references
18672     * exclusive to the user grabbing the list, here, so if you'd like
18673     * to use them out of this call's context, you'd better @c
18674     * eina_stringshare_ref() them.
18675     *
18676     * @see elm_slideshow_transition_set()
18677     *
18678     * @ingroup Slideshow
18679     */
18680    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18681
18682    /**
18683     * Set the current slide transition/effect in use for a given
18684     * slideshow widget
18685     *
18686     * @param obj The slideshow object
18687     * @param transition The new transition's name string
18688     *
18689     * If @p transition is implemented in @p obj's theme (i.e., is
18690     * contained in the list returned by
18691     * elm_slideshow_transitions_get()), this new sliding effect will
18692     * be used on the widget.
18693     *
18694     * @see elm_slideshow_transitions_get() for more details
18695     *
18696     * @ingroup Slideshow
18697     */
18698    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18699
18700    /**
18701     * Get the current slide transition/effect in use for a given
18702     * slideshow widget
18703     *
18704     * @param obj The slideshow object
18705     * @return The current transition's name
18706     *
18707     * @see elm_slideshow_transition_set() for more details
18708     *
18709     * @ingroup Slideshow
18710     */
18711    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18712
18713    /**
18714     * Set the interval between each image transition on a given
18715     * slideshow widget, <b>and start the slideshow, itself</b>
18716     *
18717     * @param obj The slideshow object
18718     * @param timeout The new displaying timeout for images
18719     *
18720     * After this call, the slideshow widget will start cycling its
18721     * view, sequentially and automatically, with the images of the
18722     * items it has. The time between each new image displayed is going
18723     * to be @p timeout, in @b seconds. If a different timeout was set
18724     * previously and an slideshow was in progress, it will continue
18725     * with the new time between transitions, after this call.
18726     *
18727     * @note A value less than or equal to 0 on @p timeout will disable
18728     * the widget's internal timer, thus halting any slideshow which
18729     * could be happening on @p obj.
18730     *
18731     * @see elm_slideshow_timeout_get()
18732     *
18733     * @ingroup Slideshow
18734     */
18735    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18736
18737    /**
18738     * Get the interval set for image transitions on a given slideshow
18739     * widget.
18740     *
18741     * @param obj The slideshow object
18742     * @return Returns the timeout set on it
18743     *
18744     * @see elm_slideshow_timeout_set() for more details
18745     *
18746     * @ingroup Slideshow
18747     */
18748    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18749
18750    /**
18751     * Set if, after a slideshow is started, for a given slideshow
18752     * widget, its items should be displayed cyclically or not.
18753     *
18754     * @param obj The slideshow object
18755     * @param loop Use @c EINA_TRUE to make it cycle through items or
18756     * @c EINA_FALSE for it to stop at the end of @p obj's internal
18757     * list of items
18758     *
18759     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18760     * ignore what is set by this functions, i.e., they'll @b always
18761     * cycle through items. This affects only the "automatic"
18762     * slideshow, as set by elm_slideshow_timeout_set().
18763     *
18764     * @see elm_slideshow_loop_get()
18765     *
18766     * @ingroup Slideshow
18767     */
18768    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18769
18770    /**
18771     * Get if, after a slideshow is started, for a given slideshow
18772     * widget, its items are to be displayed cyclically or not.
18773     *
18774     * @param obj The slideshow object
18775     * @return @c EINA_TRUE, if the items in @p obj will be cycled
18776     * through or @c EINA_FALSE, otherwise
18777     *
18778     * @see elm_slideshow_loop_set() for more details
18779     *
18780     * @ingroup Slideshow
18781     */
18782    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18783
18784    /**
18785     * Remove all items from a given slideshow widget
18786     *
18787     * @param obj The slideshow object
18788     *
18789     * This removes (and deletes) all items in @p obj, leaving it
18790     * empty.
18791     *
18792     * @see elm_slideshow_item_del(), to remove just one item.
18793     *
18794     * @ingroup Slideshow
18795     */
18796    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18797
18798    /**
18799     * Get the internal list of items in a given slideshow widget.
18800     *
18801     * @param obj The slideshow object
18802     * @return The list of items (#Elm_Slideshow_Item as data) or
18803     * @c NULL on errors.
18804     *
18805     * This list is @b not to be modified in any way and must not be
18806     * freed. Use the list members with functions like
18807     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18808     *
18809     * @warning This list is only valid until @p obj object's internal
18810     * items list is changed. It should be fetched again with another
18811     * call to this function when changes happen.
18812     *
18813     * @ingroup Slideshow
18814     */
18815    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18816
18817    /**
18818     * Delete a given item from a slideshow widget.
18819     *
18820     * @param item The slideshow item
18821     *
18822     * @ingroup Slideshow
18823     */
18824    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18825
18826    /**
18827     * Return the data associated with a given slideshow item
18828     *
18829     * @param item The slideshow item
18830     * @return Returns the data associated to this item
18831     *
18832     * @ingroup Slideshow
18833     */
18834    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18835
18836    /**
18837     * Returns the currently displayed item, in a given slideshow widget
18838     *
18839     * @param obj The slideshow object
18840     * @return A handle to the item being displayed in @p obj or
18841     * @c NULL, if none is (and on errors)
18842     *
18843     * @ingroup Slideshow
18844     */
18845    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18846
18847    /**
18848     * Get the real Evas object created to implement the view of a
18849     * given slideshow item
18850     *
18851     * @param item The slideshow item.
18852     * @return the Evas object implementing this item's view.
18853     *
18854     * This returns the actual Evas object used to implement the
18855     * specified slideshow item's view. This may be @c NULL, as it may
18856     * not have been created or may have been deleted, at any time, by
18857     * the slideshow. <b>Do not modify this object</b> (move, resize,
18858     * show, hide, etc.), as the slideshow is controlling it. This
18859     * function is for querying, emitting custom signals or hooking
18860     * lower level callbacks for events on that object. Do not delete
18861     * this object under any circumstances.
18862     *
18863     * @see elm_slideshow_item_data_get()
18864     *
18865     * @ingroup Slideshow
18866     */
18867    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18868
18869    /**
18870     * Get the the item, in a given slideshow widget, placed at
18871     * position @p nth, in its internal items list
18872     *
18873     * @param obj The slideshow object
18874     * @param nth The number of the item to grab a handle to (0 being
18875     * the first)
18876     * @return The item stored in @p obj at position @p nth or @c NULL,
18877     * if there's no item with that index (and on errors)
18878     *
18879     * @ingroup Slideshow
18880     */
18881    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18882
18883    /**
18884     * Set the current slide layout in use for a given slideshow widget
18885     *
18886     * @param obj The slideshow object
18887     * @param layout The new layout's name string
18888     *
18889     * If @p layout is implemented in @p obj's theme (i.e., is contained
18890     * in the list returned by elm_slideshow_layouts_get()), this new
18891     * images layout will be used on the widget.
18892     *
18893     * @see elm_slideshow_layouts_get() for more details
18894     *
18895     * @ingroup Slideshow
18896     */
18897    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18898
18899    /**
18900     * Get the current slide layout in use for a given slideshow widget
18901     *
18902     * @param obj The slideshow object
18903     * @return The current layout's name
18904     *
18905     * @see elm_slideshow_layout_set() for more details
18906     *
18907     * @ingroup Slideshow
18908     */
18909    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18910
18911    /**
18912     * Returns the list of @b layout names available, for a given
18913     * slideshow widget.
18914     *
18915     * @param obj The slideshow object
18916     * @return The list of layouts (list of @b stringshared strings
18917     * as data)
18918     *
18919     * Slideshow layouts will change how the widget is to dispose each
18920     * image item in its viewport, with regard to cropping, scaling,
18921     * etc.
18922     *
18923     * The layouts, which come from @p obj's theme, must be an EDC
18924     * data item name @c "layouts" on the theme file, with (prefix)
18925     * names of EDC programs actually implementing them.
18926     *
18927     * The available layouts for slideshows on the default theme are:
18928     * - @c "fullscreen" - item images with original aspect, scaled to
18929     *   touch top and down slideshow borders or, if the image's heigh
18930     *   is not enough, left and right slideshow borders.
18931     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
18932     *   one, but always leaving 10% of the slideshow's dimensions of
18933     *   distance between the item image's borders and the slideshow
18934     *   borders, for each axis.
18935     *
18936     * @warning The stringshared strings get no new references
18937     * exclusive to the user grabbing the list, here, so if you'd like
18938     * to use them out of this call's context, you'd better @c
18939     * eina_stringshare_ref() them.
18940     *
18941     * @see elm_slideshow_layout_set()
18942     *
18943     * @ingroup Slideshow
18944     */
18945    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18946
18947    /**
18948     * Set the number of items to cache, on a given slideshow widget,
18949     * <b>before the current item</b>
18950     *
18951     * @param obj The slideshow object
18952     * @param count Number of items to cache before the current one
18953     *
18954     * The default value for this property is @c 2. See
18955     * @ref Slideshow_Caching "slideshow caching" for more details.
18956     *
18957     * @see elm_slideshow_cache_before_get()
18958     *
18959     * @ingroup Slideshow
18960     */
18961    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18962
18963    /**
18964     * Retrieve the number of items to cache, on a given slideshow widget,
18965     * <b>before the current item</b>
18966     *
18967     * @param obj The slideshow object
18968     * @return The number of items set to be cached before the current one
18969     *
18970     * @see elm_slideshow_cache_before_set() for more details
18971     *
18972     * @ingroup Slideshow
18973     */
18974    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18975
18976    /**
18977     * Set the number of items to cache, on a given slideshow widget,
18978     * <b>after the current item</b>
18979     *
18980     * @param obj The slideshow object
18981     * @param count Number of items to cache after the current one
18982     *
18983     * The default value for this property is @c 2. See
18984     * @ref Slideshow_Caching "slideshow caching" for more details.
18985     *
18986     * @see elm_slideshow_cache_after_get()
18987     *
18988     * @ingroup Slideshow
18989     */
18990    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18991
18992    /**
18993     * Retrieve the number of items to cache, on a given slideshow widget,
18994     * <b>after the current item</b>
18995     *
18996     * @param obj The slideshow object
18997     * @return The number of items set to be cached after the current one
18998     *
18999     * @see elm_slideshow_cache_after_set() for more details
19000     *
19001     * @ingroup Slideshow
19002     */
19003    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19004
19005    /**
19006     * Get the number of items stored in a given slideshow widget
19007     *
19008     * @param obj The slideshow object
19009     * @return The number of items on @p obj, at the moment of this call
19010     *
19011     * @ingroup Slideshow
19012     */
19013    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19014
19015    /**
19016     * @}
19017     */
19018
19019    /**
19020     * @defgroup Fileselector File Selector
19021     *
19022     * @image html img/widget/fileselector/preview-00.png
19023     * @image latex img/widget/fileselector/preview-00.eps
19024     *
19025     * A file selector is a widget that allows a user to navigate
19026     * through a file system, reporting file selections back via its
19027     * API.
19028     *
19029     * It contains shortcut buttons for home directory (@c ~) and to
19030     * jump one directory upwards (..), as well as cancel/ok buttons to
19031     * confirm/cancel a given selection. After either one of those two
19032     * former actions, the file selector will issue its @c "done" smart
19033     * callback.
19034     *
19035     * There's a text entry on it, too, showing the name of the current
19036     * selection. There's the possibility of making it editable, so it
19037     * is useful on file saving dialogs on applications, where one
19038     * gives a file name to save contents to, in a given directory in
19039     * the system. This custom file name will be reported on the @c
19040     * "done" smart callback (explained in sequence).
19041     *
19042     * Finally, it has a view to display file system items into in two
19043     * possible forms:
19044     * - list
19045     * - grid
19046     *
19047     * If Elementary is built with support of the Ethumb thumbnailing
19048     * library, the second form of view will display preview thumbnails
19049     * of files which it supports.
19050     *
19051     * Smart callbacks one can register to:
19052     *
19053     * - @c "selected" - the user has clicked on a file (when not in
19054     *      folders-only mode) or directory (when in folders-only mode)
19055     * - @c "directory,open" - the list has been populated with new
19056     *      content (@c event_info is a pointer to the directory's
19057     *      path, a @b stringshared string)
19058     * - @c "done" - the user has clicked on the "ok" or "cancel"
19059     *      buttons (@c event_info is a pointer to the selection's
19060     *      path, a @b stringshared string)
19061     *
19062     * Here is an example on its usage:
19063     * @li @ref fileselector_example
19064     */
19065
19066    /**
19067     * @addtogroup Fileselector
19068     * @{
19069     */
19070
19071    /**
19072     * Defines how a file selector widget is to layout its contents
19073     * (file system entries).
19074     */
19075    typedef enum _Elm_Fileselector_Mode
19076      {
19077         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19078         ELM_FILESELECTOR_GRID, /**< layout as a grid */
19079         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19080      } Elm_Fileselector_Mode;
19081
19082    /**
19083     * Add a new file selector widget to the given parent Elementary
19084     * (container) object
19085     *
19086     * @param parent The parent object
19087     * @return a new file selector widget handle or @c NULL, on errors
19088     *
19089     * This function inserts a new file selector widget on the canvas.
19090     *
19091     * @ingroup Fileselector
19092     */
19093    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19094
19095    /**
19096     * Enable/disable the file name entry box where the user can type
19097     * in a name for a file, in a given file selector widget
19098     *
19099     * @param obj The file selector object
19100     * @param is_save @c EINA_TRUE to make the file selector a "saving
19101     * dialog", @c EINA_FALSE otherwise
19102     *
19103     * Having the entry editable is useful on file saving dialogs on
19104     * applications, where one gives a file name to save contents to,
19105     * in a given directory in the system. This custom file name will
19106     * be reported on the @c "done" smart callback.
19107     *
19108     * @see elm_fileselector_is_save_get()
19109     *
19110     * @ingroup Fileselector
19111     */
19112    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19113
19114    /**
19115     * Get whether the given file selector is in "saving dialog" mode
19116     *
19117     * @param obj The file selector object
19118     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19119     * mode, @c EINA_FALSE otherwise (and on errors)
19120     *
19121     * @see elm_fileselector_is_save_set() for more details
19122     *
19123     * @ingroup Fileselector
19124     */
19125    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19126
19127    /**
19128     * Enable/disable folder-only view for a given file selector widget
19129     *
19130     * @param obj The file selector object
19131     * @param only @c EINA_TRUE to make @p obj only display
19132     * directories, @c EINA_FALSE to make files to be displayed in it
19133     * too
19134     *
19135     * If enabled, the widget's view will only display folder items,
19136     * naturally.
19137     *
19138     * @see elm_fileselector_folder_only_get()
19139     *
19140     * @ingroup Fileselector
19141     */
19142    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19143
19144    /**
19145     * Get whether folder-only view is set for a given file selector
19146     * widget
19147     *
19148     * @param obj The file selector object
19149     * @return only @c EINA_TRUE if @p obj is only displaying
19150     * directories, @c EINA_FALSE if files are being displayed in it
19151     * too (and on errors)
19152     *
19153     * @see elm_fileselector_folder_only_get()
19154     *
19155     * @ingroup Fileselector
19156     */
19157    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19158
19159    /**
19160     * Enable/disable the "ok" and "cancel" buttons on a given file
19161     * selector widget
19162     *
19163     * @param obj The file selector object
19164     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19165     *
19166     * @note A file selector without those buttons will never emit the
19167     * @c "done" smart event, and is only usable if one is just hooking
19168     * to the other two events.
19169     *
19170     * @see elm_fileselector_buttons_ok_cancel_get()
19171     *
19172     * @ingroup Fileselector
19173     */
19174    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19175
19176    /**
19177     * Get whether the "ok" and "cancel" buttons on a given file
19178     * selector widget are being shown.
19179     *
19180     * @param obj The file selector object
19181     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19182     * otherwise (and on errors)
19183     *
19184     * @see elm_fileselector_buttons_ok_cancel_set() for more details
19185     *
19186     * @ingroup Fileselector
19187     */
19188    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19189
19190    /**
19191     * Enable/disable a tree view in the given file selector widget,
19192     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19193     *
19194     * @param obj The file selector object
19195     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19196     * disable
19197     *
19198     * In a tree view, arrows are created on the sides of directories,
19199     * allowing them to expand in place.
19200     *
19201     * @note If it's in other mode, the changes made by this function
19202     * will only be visible when one switches back to "list" mode.
19203     *
19204     * @see elm_fileselector_expandable_get()
19205     *
19206     * @ingroup Fileselector
19207     */
19208    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19209
19210    /**
19211     * Get whether tree view is enabled for the given file selector
19212     * widget
19213     *
19214     * @param obj The file selector object
19215     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19216     * otherwise (and or errors)
19217     *
19218     * @see elm_fileselector_expandable_set() for more details
19219     *
19220     * @ingroup Fileselector
19221     */
19222    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19223
19224    /**
19225     * Set, programmatically, the @b directory that a given file
19226     * selector widget will display contents from
19227     *
19228     * @param obj The file selector object
19229     * @param path The path to display in @p obj
19230     *
19231     * This will change the @b directory that @p obj is displaying. It
19232     * will also clear the text entry area on the @p obj object, which
19233     * displays select files' names.
19234     *
19235     * @see elm_fileselector_path_get()
19236     *
19237     * @ingroup Fileselector
19238     */
19239    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19240
19241    /**
19242     * Get the parent directory's path that a given file selector
19243     * widget is displaying
19244     *
19245     * @param obj The file selector object
19246     * @return The (full) path of the directory the file selector is
19247     * displaying, a @b stringshared string
19248     *
19249     * @see elm_fileselector_path_set()
19250     *
19251     * @ingroup Fileselector
19252     */
19253    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19254
19255    /**
19256     * Set, programmatically, the currently selected file/directory in
19257     * the given file selector widget
19258     *
19259     * @param obj The file selector object
19260     * @param path The (full) path to a file or directory
19261     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19262     * latter case occurs if the directory or file pointed to do not
19263     * exist.
19264     *
19265     * @see elm_fileselector_selected_get()
19266     *
19267     * @ingroup Fileselector
19268     */
19269    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19270
19271    /**
19272     * Get the currently selected item's (full) path, in the given file
19273     * selector widget
19274     *
19275     * @param obj The file selector object
19276     * @return The absolute path of the selected item, a @b
19277     * stringshared string
19278     *
19279     * @note Custom editions on @p obj object's text entry, if made,
19280     * will appear on the return string of this function, naturally.
19281     *
19282     * @see elm_fileselector_selected_set() for more details
19283     *
19284     * @ingroup Fileselector
19285     */
19286    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19287
19288    /**
19289     * Set the mode in which a given file selector widget will display
19290     * (layout) file system entries in its view
19291     *
19292     * @param obj The file selector object
19293     * @param mode The mode of the fileselector, being it one of
19294     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19295     * first one, naturally, will display the files in a list. The
19296     * latter will make the widget to display its entries in a grid
19297     * form.
19298     *
19299     * @note By using elm_fileselector_expandable_set(), the user may
19300     * trigger a tree view for that list.
19301     *
19302     * @note If Elementary is built with support of the Ethumb
19303     * thumbnailing library, the second form of view will display
19304     * preview thumbnails of files which it supports. You must have
19305     * elm_need_ethumb() called in your Elementary for thumbnailing to
19306     * work, though.
19307     *
19308     * @see elm_fileselector_expandable_set().
19309     * @see elm_fileselector_mode_get().
19310     *
19311     * @ingroup Fileselector
19312     */
19313    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19314
19315    /**
19316     * Get the mode in which a given file selector widget is displaying
19317     * (layouting) file system entries in its view
19318     *
19319     * @param obj The fileselector object
19320     * @return The mode in which the fileselector is at
19321     *
19322     * @see elm_fileselector_mode_set() for more details
19323     *
19324     * @ingroup Fileselector
19325     */
19326    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19327
19328    /**
19329     * @}
19330     */
19331
19332    /**
19333     * @defgroup Progressbar Progress bar
19334     *
19335     * The progress bar is a widget for visually representing the
19336     * progress status of a given job/task.
19337     *
19338     * A progress bar may be horizontal or vertical. It may display an
19339     * icon besides it, as well as primary and @b units labels. The
19340     * former is meant to label the widget as a whole, while the
19341     * latter, which is formatted with floating point values (and thus
19342     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19343     * units"</c>), is meant to label the widget's <b>progress
19344     * value</b>. Label, icon and unit strings/objects are @b optional
19345     * for progress bars.
19346     *
19347     * A progress bar may be @b inverted, in which state it gets its
19348     * values inverted, with high values being on the left or top and
19349     * low values on the right or bottom, as opposed to normally have
19350     * the low values on the former and high values on the latter,
19351     * respectively, for horizontal and vertical modes.
19352     *
19353     * The @b span of the progress, as set by
19354     * elm_progressbar_span_size_set(), is its length (horizontally or
19355     * vertically), unless one puts size hints on the widget to expand
19356     * on desired directions, by any container. That length will be
19357     * scaled by the object or applications scaling factor. At any
19358     * point code can query the progress bar for its value with
19359     * elm_progressbar_value_get().
19360     *
19361     * Available widget styles for progress bars:
19362     * - @c "default"
19363     * - @c "wheel" (simple style, no text, no progression, only
19364     *      "pulse" effect is available)
19365     *
19366     * Here is an example on its usage:
19367     * @li @ref progressbar_example
19368     */
19369
19370    /**
19371     * Add a new progress bar widget to the given parent Elementary
19372     * (container) object
19373     *
19374     * @param parent The parent object
19375     * @return a new progress bar widget handle or @c NULL, on errors
19376     *
19377     * This function inserts a new progress bar widget on the canvas.
19378     *
19379     * @ingroup Progressbar
19380     */
19381    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19382
19383    /**
19384     * Set whether a given progress bar widget is at "pulsing mode" or
19385     * not.
19386     *
19387     * @param obj The progress bar object
19388     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19389     * @c EINA_FALSE to put it back to its default one
19390     *
19391     * By default, progress bars will display values from the low to
19392     * high value boundaries. There are, though, contexts in which the
19393     * state of progression of a given task is @b unknown.  For those,
19394     * one can set a progress bar widget to a "pulsing state", to give
19395     * the user an idea that some computation is being held, but
19396     * without exact progress values. In the default theme it will
19397     * animate its bar with the contents filling in constantly and back
19398     * to non-filled, in a loop. To start and stop this pulsing
19399     * animation, one has to explicitly call elm_progressbar_pulse().
19400     *
19401     * @see elm_progressbar_pulse_get()
19402     * @see elm_progressbar_pulse()
19403     *
19404     * @ingroup Progressbar
19405     */
19406    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19407
19408    /**
19409     * Get whether a given progress bar widget is at "pulsing mode" or
19410     * not.
19411     *
19412     * @param obj The progress bar object
19413     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19414     * if it's in the default one (and on errors)
19415     *
19416     * @ingroup Progressbar
19417     */
19418    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19419
19420    /**
19421     * Start/stop a given progress bar "pulsing" animation, if its
19422     * under that mode
19423     *
19424     * @param obj The progress bar object
19425     * @param state @c EINA_TRUE, to @b start the pulsing animation,
19426     * @c EINA_FALSE to @b stop it
19427     *
19428     * @note This call won't do anything if @p obj is not under "pulsing mode".
19429     *
19430     * @see elm_progressbar_pulse_set() for more details.
19431     *
19432     * @ingroup Progressbar
19433     */
19434    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19435
19436    /**
19437     * Set the progress value (in percentage) on a given progress bar
19438     * widget
19439     *
19440     * @param obj The progress bar object
19441     * @param val The progress value (@b must be between @c 0.0 and @c
19442     * 1.0)
19443     *
19444     * Use this call to set progress bar levels.
19445     *
19446     * @note If you passes a value out of the specified range for @p
19447     * val, it will be interpreted as the @b closest of the @b boundary
19448     * values in the range.
19449     *
19450     * @ingroup Progressbar
19451     */
19452    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19453
19454    /**
19455     * Get the progress value (in percentage) on a given progress bar
19456     * widget
19457     *
19458     * @param obj The progress bar object
19459     * @return The value of the progressbar
19460     *
19461     * @see elm_progressbar_value_set() for more details
19462     *
19463     * @ingroup Progressbar
19464     */
19465    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19466
19467    /**
19468     * Set the label of a given progress bar widget
19469     *
19470     * @param obj The progress bar object
19471     * @param label The text label string, in UTF-8
19472     *
19473     * @ingroup Progressbar
19474     * @deprecated use elm_object_text_set() instead.
19475     */
19476    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19477
19478    /**
19479     * Get the label of a given progress bar widget
19480     *
19481     * @param obj The progressbar object
19482     * @return The text label string, in UTF-8
19483     *
19484     * @ingroup Progressbar
19485     * @deprecated use elm_object_text_set() instead.
19486     */
19487    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19488
19489    /**
19490     * Set the icon object of a given progress bar widget
19491     *
19492     * @param obj The progress bar object
19493     * @param icon The icon object
19494     *
19495     * Use this call to decorate @p obj with an icon next to it.
19496     *
19497     * @note Once the icon object is set, a previously set one will be
19498     * deleted. If you want to keep that old content object, use the
19499     * elm_progressbar_icon_unset() function.
19500     *
19501     * @see elm_progressbar_icon_get()
19502     *
19503     * @ingroup Progressbar
19504     */
19505    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19506
19507    /**
19508     * Retrieve the icon object set for a given progress bar widget
19509     *
19510     * @param obj The progress bar object
19511     * @return The icon object's handle, if @p obj had one set, or @c NULL,
19512     * otherwise (and on errors)
19513     *
19514     * @see elm_progressbar_icon_set() for more details
19515     *
19516     * @ingroup Progressbar
19517     */
19518    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19519
19520    /**
19521     * Unset an icon set on a given progress bar widget
19522     *
19523     * @param obj The progress bar object
19524     * @return The icon object that was being used, if any was set, or
19525     * @c NULL, otherwise (and on errors)
19526     *
19527     * This call will unparent and return the icon object which was set
19528     * for this widget, previously, on success.
19529     *
19530     * @see elm_progressbar_icon_set() for more details
19531     *
19532     * @ingroup Progressbar
19533     */
19534    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19535
19536    /**
19537     * Set the (exact) length of the bar region of a given progress bar
19538     * widget
19539     *
19540     * @param obj The progress bar object
19541     * @param size The length of the progress bar's bar region
19542     *
19543     * This sets the minimum width (when in horizontal mode) or height
19544     * (when in vertical mode) of the actual bar area of the progress
19545     * bar @p obj. This in turn affects the object's minimum size. Use
19546     * this when you're not setting other size hints expanding on the
19547     * given direction (like weight and alignment hints) and you would
19548     * like it to have a specific size.
19549     *
19550     * @note Icon, label and unit text around @p obj will require their
19551     * own space, which will make @p obj to require more the @p size,
19552     * actually.
19553     *
19554     * @see elm_progressbar_span_size_get()
19555     *
19556     * @ingroup Progressbar
19557     */
19558    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19559
19560    /**
19561     * Get the length set for the bar region of a given progress bar
19562     * widget
19563     *
19564     * @param obj The progress bar object
19565     * @return The length of the progress bar's bar region
19566     *
19567     * If that size was not set previously, with
19568     * elm_progressbar_span_size_set(), this call will return @c 0.
19569     *
19570     * @ingroup Progressbar
19571     */
19572    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19573
19574    /**
19575     * Set the format string for a given progress bar widget's units
19576     * label
19577     *
19578     * @param obj The progress bar object
19579     * @param format The format string for @p obj's units label
19580     *
19581     * If @c NULL is passed on @p format, it will make @p obj's units
19582     * area to be hidden completely. If not, it'll set the <b>format
19583     * string</b> for the units label's @b text. The units label is
19584     * provided a floating point value, so the units text is up display
19585     * at most one floating point falue. Note that the units label is
19586     * optional. Use a format string such as "%1.2f meters" for
19587     * example.
19588     *
19589     * @note The default format string for a progress bar is an integer
19590     * percentage, as in @c "%.0f %%".
19591     *
19592     * @see elm_progressbar_unit_format_get()
19593     *
19594     * @ingroup Progressbar
19595     */
19596    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19597
19598    /**
19599     * Retrieve the format string set for a given progress bar widget's
19600     * units label
19601     *
19602     * @param obj The progress bar object
19603     * @return The format set string for @p obj's units label or
19604     * @c NULL, if none was set (and on errors)
19605     *
19606     * @see elm_progressbar_unit_format_set() for more details
19607     *
19608     * @ingroup Progressbar
19609     */
19610    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19611
19612    /**
19613     * Set the orientation of a given progress bar widget
19614     *
19615     * @param obj The progress bar object
19616     * @param horizontal Use @c EINA_TRUE to make @p obj to be
19617     * @b horizontal, @c EINA_FALSE to make it @b vertical
19618     *
19619     * Use this function to change how your progress bar is to be
19620     * disposed: vertically or horizontally.
19621     *
19622     * @see elm_progressbar_horizontal_get()
19623     *
19624     * @ingroup Progressbar
19625     */
19626    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19627
19628    /**
19629     * Retrieve the orientation of a given progress bar widget
19630     *
19631     * @param obj The progress bar object
19632     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19633     * @c EINA_FALSE if it's @b vertical (and on errors)
19634     *
19635     * @see elm_progressbar_horizontal_set() for more details
19636     *
19637     * @ingroup Progressbar
19638     */
19639    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19640
19641    /**
19642     * Invert a given progress bar widget's displaying values order
19643     *
19644     * @param obj The progress bar object
19645     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19646     * @c EINA_FALSE to bring it back to default, non-inverted values.
19647     *
19648     * A progress bar may be @b inverted, in which state it gets its
19649     * values inverted, with high values being on the left or top and
19650     * low values on the right or bottom, as opposed to normally have
19651     * the low values on the former and high values on the latter,
19652     * respectively, for horizontal and vertical modes.
19653     *
19654     * @see elm_progressbar_inverted_get()
19655     *
19656     * @ingroup Progressbar
19657     */
19658    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19659
19660    /**
19661     * Get whether a given progress bar widget's displaying values are
19662     * inverted or not
19663     *
19664     * @param obj The progress bar object
19665     * @return @c EINA_TRUE, if @p obj has inverted values,
19666     * @c EINA_FALSE otherwise (and on errors)
19667     *
19668     * @see elm_progressbar_inverted_set() for more details
19669     *
19670     * @ingroup Progressbar
19671     */
19672    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19673
19674    /**
19675     * @defgroup Separator Separator
19676     *
19677     * @brief Separator is a very thin object used to separate other objects.
19678     *
19679     * A separator can be vertical or horizontal.
19680     *
19681     * @ref tutorial_separator is a good example of how to use a separator.
19682     * @{
19683     */
19684    /**
19685     * @brief Add a separator object to @p parent
19686     *
19687     * @param parent The parent object
19688     *
19689     * @return The separator object, or NULL upon failure
19690     */
19691    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19692    /**
19693     * @brief Set the horizontal mode of a separator object
19694     *
19695     * @param obj The separator object
19696     * @param horizontal If true, the separator is horizontal
19697     */
19698    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19699    /**
19700     * @brief Get the horizontal mode of a separator object
19701     *
19702     * @param obj The separator object
19703     * @return If true, the separator is horizontal
19704     *
19705     * @see elm_separator_horizontal_set()
19706     */
19707    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19708    /**
19709     * @}
19710     */
19711
19712    /**
19713     * @defgroup Spinner Spinner
19714     * @ingroup Elementary
19715     *
19716     * @image html img/widget/spinner/preview-00.png
19717     * @image latex img/widget/spinner/preview-00.eps
19718     *
19719     * A spinner is a widget which allows the user to increase or decrease
19720     * numeric values using arrow buttons, or edit values directly, clicking
19721     * over it and typing the new value.
19722     *
19723     * By default the spinner will not wrap and has a label
19724     * of "%.0f" (just showing the integer value of the double).
19725     *
19726     * A spinner has a label that is formatted with floating
19727     * point values and thus accepts a printf-style format string, like
19728     * “%1.2f units”.
19729     *
19730     * It also allows specific values to be replaced by pre-defined labels.
19731     *
19732     * Smart callbacks one can register to:
19733     *
19734     * - "changed" - Whenever the spinner value is changed.
19735     * - "delay,changed" - A short time after the value is changed by the user.
19736     *    This will be called only when the user stops dragging for a very short
19737     *    period or when they release their finger/mouse, so it avoids possibly
19738     *    expensive reactions to the value change.
19739     *
19740     * Available styles for it:
19741     * - @c "default";
19742     * - @c "vertical": up/down buttons at the right side and text left aligned.
19743     *
19744     * Here is an example on its usage:
19745     * @ref spinner_example
19746     */
19747
19748    /**
19749     * @addtogroup Spinner
19750     * @{
19751     */
19752
19753    /**
19754     * Add a new spinner widget to the given parent Elementary
19755     * (container) object.
19756     *
19757     * @param parent The parent object.
19758     * @return a new spinner widget handle or @c NULL, on errors.
19759     *
19760     * This function inserts a new spinner widget on the canvas.
19761     *
19762     * @ingroup Spinner
19763     *
19764     */
19765    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19766
19767    /**
19768     * Set the format string of the displayed label.
19769     *
19770     * @param obj The spinner object.
19771     * @param fmt The format string for the label display.
19772     *
19773     * If @c NULL, this sets the format to "%.0f". If not it sets the format
19774     * string for the label text. The label text is provided a floating point
19775     * value, so the label text can display up to 1 floating point value.
19776     * Note that this is optional.
19777     *
19778     * Use a format string such as "%1.2f meters" for example, and it will
19779     * display values like: "3.14 meters" for a value equal to 3.14159.
19780     *
19781     * Default is "%0.f".
19782     *
19783     * @see elm_spinner_label_format_get()
19784     *
19785     * @ingroup Spinner
19786     */
19787    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19788
19789    /**
19790     * Get the label format of the spinner.
19791     *
19792     * @param obj The spinner object.
19793     * @return The text label format string in UTF-8.
19794     *
19795     * @see elm_spinner_label_format_set() for details.
19796     *
19797     * @ingroup Spinner
19798     */
19799    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19800
19801    /**
19802     * Set the minimum and maximum values for the spinner.
19803     *
19804     * @param obj The spinner object.
19805     * @param min The minimum value.
19806     * @param max The maximum value.
19807     *
19808     * Define the allowed range of values to be selected by the user.
19809     *
19810     * If actual value is less than @p min, it will be updated to @p min. If it
19811     * is bigger then @p max, will be updated to @p max. Actual value can be
19812     * get with elm_spinner_value_get().
19813     *
19814     * By default, min is equal to 0, and max is equal to 100.
19815     *
19816     * @warning Maximum must be greater than minimum.
19817     *
19818     * @see elm_spinner_min_max_get()
19819     *
19820     * @ingroup Spinner
19821     */
19822    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19823
19824    /**
19825     * Get the minimum and maximum values of the spinner.
19826     *
19827     * @param obj The spinner object.
19828     * @param min Pointer where to store the minimum value.
19829     * @param max Pointer where to store the maximum value.
19830     *
19831     * @note If only one value is needed, the other pointer can be passed
19832     * as @c NULL.
19833     *
19834     * @see elm_spinner_min_max_set() for details.
19835     *
19836     * @ingroup Spinner
19837     */
19838    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19839
19840    /**
19841     * Set the step used to increment or decrement the spinner value.
19842     *
19843     * @param obj The spinner object.
19844     * @param step The step value.
19845     *
19846     * This value will be incremented or decremented to the displayed value.
19847     * It will be incremented while the user keep right or top arrow pressed,
19848     * and will be decremented while the user keep left or bottom arrow pressed.
19849     *
19850     * The interval to increment / decrement can be set with
19851     * elm_spinner_interval_set().
19852     *
19853     * By default step value is equal to 1.
19854     *
19855     * @see elm_spinner_step_get()
19856     *
19857     * @ingroup Spinner
19858     */
19859    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19860
19861    /**
19862     * Get the step used to increment or decrement the spinner value.
19863     *
19864     * @param obj The spinner object.
19865     * @return The step value.
19866     *
19867     * @see elm_spinner_step_get() for more details.
19868     *
19869     * @ingroup Spinner
19870     */
19871    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19872
19873    /**
19874     * Set the value the spinner displays.
19875     *
19876     * @param obj The spinner object.
19877     * @param val The value to be displayed.
19878     *
19879     * Value will be presented on the label following format specified with
19880     * elm_spinner_format_set().
19881     *
19882     * @warning The value must to be between min and max values. This values
19883     * are set by elm_spinner_min_max_set().
19884     *
19885     * @see elm_spinner_value_get().
19886     * @see elm_spinner_format_set().
19887     * @see elm_spinner_min_max_set().
19888     *
19889     * @ingroup Spinner
19890     */
19891    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19892
19893    /**
19894     * Get the value displayed by the spinner.
19895     *
19896     * @param obj The spinner object.
19897     * @return The value displayed.
19898     *
19899     * @see elm_spinner_value_set() for details.
19900     *
19901     * @ingroup Spinner
19902     */
19903    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19904
19905    /**
19906     * Set whether the spinner should wrap when it reaches its
19907     * minimum or maximum value.
19908     *
19909     * @param obj The spinner object.
19910     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19911     * disable it.
19912     *
19913     * Disabled by default. If disabled, when the user tries to increment the
19914     * value,
19915     * but displayed value plus step value is bigger than maximum value,
19916     * the spinner
19917     * won't allow it. The same happens when the user tries to decrement it,
19918     * but the value less step is less than minimum value.
19919     *
19920     * When wrap is enabled, in such situations it will allow these changes,
19921     * but will get the value that would be less than minimum and subtracts
19922     * from maximum. Or add the value that would be more than maximum to
19923     * the minimum.
19924     *
19925     * E.g.:
19926     * @li min value = 10
19927     * @li max value = 50
19928     * @li step value = 20
19929     * @li displayed value = 20
19930     *
19931     * When the user decrement value (using left or bottom arrow), it will
19932     * displays @c 40, because max - (min - (displayed - step)) is
19933     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
19934     *
19935     * @see elm_spinner_wrap_get().
19936     *
19937     * @ingroup Spinner
19938     */
19939    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
19940
19941    /**
19942     * Get whether the spinner should wrap when it reaches its
19943     * minimum or maximum value.
19944     *
19945     * @param obj The spinner object
19946     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
19947     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19948     *
19949     * @see elm_spinner_wrap_set() for details.
19950     *
19951     * @ingroup Spinner
19952     */
19953    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19954
19955    /**
19956     * Set whether the spinner can be directly edited by the user or not.
19957     *
19958     * @param obj The spinner object.
19959     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
19960     * don't allow users to edit it directly.
19961     *
19962     * Spinner objects can have edition @b disabled, in which state they will
19963     * be changed only by arrows.
19964     * Useful for contexts
19965     * where you don't want your users to interact with it writting the value.
19966     * Specially
19967     * when using special values, the user can see real value instead
19968     * of special label on edition.
19969     *
19970     * It's enabled by default.
19971     *
19972     * @see elm_spinner_editable_get()
19973     *
19974     * @ingroup Spinner
19975     */
19976    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19977
19978    /**
19979     * Get whether the spinner can be directly edited by the user or not.
19980     *
19981     * @param obj The spinner object.
19982     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
19983     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19984     *
19985     * @see elm_spinner_editable_set() for details.
19986     *
19987     * @ingroup Spinner
19988     */
19989    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19990
19991    /**
19992     * Set a special string to display in the place of the numerical value.
19993     *
19994     * @param obj The spinner object.
19995     * @param value The value to be replaced.
19996     * @param label The label to be used.
19997     *
19998     * It's useful for cases when a user should select an item that is
19999     * better indicated by a label than a value. For example, weekdays or months.
20000     *
20001     * E.g.:
20002     * @code
20003     * sp = elm_spinner_add(win);
20004     * elm_spinner_min_max_set(sp, 1, 3);
20005     * elm_spinner_special_value_add(sp, 1, "January");
20006     * elm_spinner_special_value_add(sp, 2, "February");
20007     * elm_spinner_special_value_add(sp, 3, "March");
20008     * evas_object_show(sp);
20009     * @endcode
20010     *
20011     * @ingroup Spinner
20012     */
20013    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20014
20015    /**
20016     * Set the interval on time updates for an user mouse button hold
20017     * on spinner widgets' arrows.
20018     *
20019     * @param obj The spinner object.
20020     * @param interval The (first) interval value in seconds.
20021     *
20022     * This interval value is @b decreased while the user holds the
20023     * mouse pointer either incrementing or decrementing spinner's value.
20024     *
20025     * This helps the user to get to a given value distant from the
20026     * current one easier/faster, as it will start to change quicker and
20027     * quicker on mouse button holds.
20028     *
20029     * The calculation for the next change interval value, starting from
20030     * the one set with this call, is the previous interval divided by
20031     * @c 1.05, so it decreases a little bit.
20032     *
20033     * The default starting interval value for automatic changes is
20034     * @c 0.85 seconds.
20035     *
20036     * @see elm_spinner_interval_get()
20037     *
20038     * @ingroup Spinner
20039     */
20040    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20041
20042    /**
20043     * Get the interval on time updates for an user mouse button hold
20044     * on spinner widgets' arrows.
20045     *
20046     * @param obj The spinner object.
20047     * @return The (first) interval value, in seconds, set on it.
20048     *
20049     * @see elm_spinner_interval_set() for more details.
20050     *
20051     * @ingroup Spinner
20052     */
20053    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20054
20055    /**
20056     * @}
20057     */
20058
20059    /**
20060     * @defgroup Index Index
20061     *
20062     * @image html img/widget/index/preview-00.png
20063     * @image latex img/widget/index/preview-00.eps
20064     *
20065     * An index widget gives you an index for fast access to whichever
20066     * group of other UI items one might have. It's a list of text
20067     * items (usually letters, for alphabetically ordered access).
20068     *
20069     * Index widgets are by default hidden and just appear when the
20070     * user clicks over it's reserved area in the canvas. In its
20071     * default theme, it's an area one @ref Fingers "finger" wide on
20072     * the right side of the index widget's container.
20073     *
20074     * When items on the index are selected, smart callbacks get
20075     * called, so that its user can make other container objects to
20076     * show a given area or child object depending on the index item
20077     * selected. You'd probably be using an index together with @ref
20078     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20079     * "general grids".
20080     *
20081     * Smart events one  can add callbacks for are:
20082     * - @c "changed" - When the selected index item changes. @c
20083     *      event_info is the selected item's data pointer.
20084     * - @c "delay,changed" - When the selected index item changes, but
20085     *      after a small idling period. @c event_info is the selected
20086     *      item's data pointer.
20087     * - @c "selected" - When the user releases a mouse button and
20088     *      selects an item. @c event_info is the selected item's data
20089     *      pointer.
20090     * - @c "level,up" - when the user moves a finger from the first
20091     *      level to the second level
20092     * - @c "level,down" - when the user moves a finger from the second
20093     *      level to the first level
20094     *
20095     * The @c "delay,changed" event is so that it'll wait a small time
20096     * before actually reporting those events and, moreover, just the
20097     * last event happening on those time frames will actually be
20098     * reported.
20099     *
20100     * Here are some examples on its usage:
20101     * @li @ref index_example_01
20102     * @li @ref index_example_02
20103     */
20104
20105    /**
20106     * @addtogroup Index
20107     * @{
20108     */
20109
20110    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20111
20112    /**
20113     * Add a new index widget to the given parent Elementary
20114     * (container) object
20115     *
20116     * @param parent The parent object
20117     * @return a new index widget handle or @c NULL, on errors
20118     *
20119     * This function inserts a new index widget on the canvas.
20120     *
20121     * @ingroup Index
20122     */
20123    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20124
20125    /**
20126     * Set whether a given index widget is or not visible,
20127     * programatically.
20128     *
20129     * @param obj The index object
20130     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20131     *
20132     * Not to be confused with visible as in @c evas_object_show() --
20133     * visible with regard to the widget's auto hiding feature.
20134     *
20135     * @see elm_index_active_get()
20136     *
20137     * @ingroup Index
20138     */
20139    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20140
20141    /**
20142     * Get whether a given index widget is currently visible or not.
20143     *
20144     * @param obj The index object
20145     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20146     *
20147     * @see elm_index_active_set() for more details
20148     *
20149     * @ingroup Index
20150     */
20151    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20152
20153    /**
20154     * Set the items level for a given index widget.
20155     *
20156     * @param obj The index object.
20157     * @param level @c 0 or @c 1, the currently implemented levels.
20158     *
20159     * @see elm_index_item_level_get()
20160     *
20161     * @ingroup Index
20162     */
20163    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20164
20165    /**
20166     * Get the items level set for a given index widget.
20167     *
20168     * @param obj The index object.
20169     * @return @c 0 or @c 1, which are the levels @p obj might be at.
20170     *
20171     * @see elm_index_item_level_set() for more information
20172     *
20173     * @ingroup Index
20174     */
20175    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20176
20177    /**
20178     * Returns the last selected item's data, for a given index widget.
20179     *
20180     * @param obj The index object.
20181     * @return The item @b data associated to the last selected item on
20182     * @p obj (or @c NULL, on errors).
20183     *
20184     * @warning The returned value is @b not an #Elm_Index_Item item
20185     * handle, but the data associated to it (see the @c item parameter
20186     * in elm_index_item_append(), as an example).
20187     *
20188     * @ingroup Index
20189     */
20190    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20191
20192    /**
20193     * Append a new item on a given index widget.
20194     *
20195     * @param obj The index object.
20196     * @param letter Letter under which the item should be indexed
20197     * @param item The item data to set for the index's item
20198     *
20199     * Despite the most common usage of the @p letter argument is for
20200     * single char strings, one could use arbitrary strings as index
20201     * entries.
20202     *
20203     * @c item will be the pointer returned back on @c "changed", @c
20204     * "delay,changed" and @c "selected" smart events.
20205     *
20206     * @ingroup Index
20207     */
20208    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20209
20210    /**
20211     * Prepend a new item on a given index widget.
20212     *
20213     * @param obj The index object.
20214     * @param letter Letter under which the item should be indexed
20215     * @param item The item data to set for the index's item
20216     *
20217     * Despite the most common usage of the @p letter argument is for
20218     * single char strings, one could use arbitrary strings as index
20219     * entries.
20220     *
20221     * @c item will be the pointer returned back on @c "changed", @c
20222     * "delay,changed" and @c "selected" smart events.
20223     *
20224     * @ingroup Index
20225     */
20226    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20227
20228    /**
20229     * Append a new item, on a given index widget, <b>after the item
20230     * having @p relative as data</b>.
20231     *
20232     * @param obj The index object.
20233     * @param letter Letter under which the item should be indexed
20234     * @param item The item data to set for the index's item
20235     * @param relative The item data of the index item to be the
20236     * predecessor of this new one
20237     *
20238     * Despite the most common usage of the @p letter argument is for
20239     * single char strings, one could use arbitrary strings as index
20240     * entries.
20241     *
20242     * @c item will be the pointer returned back on @c "changed", @c
20243     * "delay,changed" and @c "selected" smart events.
20244     *
20245     * @note If @p relative is @c NULL or if it's not found to be data
20246     * set on any previous item on @p obj, this function will behave as
20247     * elm_index_item_append().
20248     *
20249     * @ingroup Index
20250     */
20251    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20252
20253    /**
20254     * Prepend a new item, on a given index widget, <b>after the item
20255     * having @p relative as data</b>.
20256     *
20257     * @param obj The index object.
20258     * @param letter Letter under which the item should be indexed
20259     * @param item The item data to set for the index's item
20260     * @param relative The item data of the index item to be the
20261     * successor of this new one
20262     *
20263     * Despite the most common usage of the @p letter argument is for
20264     * single char strings, one could use arbitrary strings as index
20265     * entries.
20266     *
20267     * @c item will be the pointer returned back on @c "changed", @c
20268     * "delay,changed" and @c "selected" smart events.
20269     *
20270     * @note If @p relative is @c NULL or if it's not found to be data
20271     * set on any previous item on @p obj, this function will behave as
20272     * elm_index_item_prepend().
20273     *
20274     * @ingroup Index
20275     */
20276    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20277
20278    /**
20279     * Insert a new item into the given index widget, using @p cmp_func
20280     * function to sort items (by item handles).
20281     *
20282     * @param obj The index object.
20283     * @param letter Letter under which the item should be indexed
20284     * @param item The item data to set for the index's item
20285     * @param cmp_func The comparing function to be used to sort index
20286     * items <b>by #Elm_Index_Item item handles</b>
20287     * @param cmp_data_func A @b fallback function to be called for the
20288     * sorting of index items <b>by item data</b>). It will be used
20289     * when @p cmp_func returns @c 0 (equality), which means an index
20290     * item with provided item data already exists. To decide which
20291     * data item should be pointed to by the index item in question, @p
20292     * cmp_data_func will be used. If @p cmp_data_func returns a
20293     * non-negative value, the previous index item data will be
20294     * replaced by the given @p item pointer. If the previous data need
20295     * to be freed, it should be done by the @p cmp_data_func function,
20296     * because all references to it will be lost. If this function is
20297     * not provided (@c NULL is given), index items will be @b
20298     * duplicated, if @p cmp_func returns @c 0.
20299     *
20300     * Despite the most common usage of the @p letter argument is for
20301     * single char strings, one could use arbitrary strings as index
20302     * entries.
20303     *
20304     * @c item will be the pointer returned back on @c "changed", @c
20305     * "delay,changed" and @c "selected" smart events.
20306     *
20307     * @ingroup Index
20308     */
20309    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);
20310
20311    /**
20312     * Remove an item from a given index widget, <b>to be referenced by
20313     * it's data value</b>.
20314     *
20315     * @param obj The index object
20316     * @param item The item's data pointer for the item to be removed
20317     * from @p obj
20318     *
20319     * If a deletion callback is set, via elm_index_item_del_cb_set(),
20320     * that callback function will be called by this one.
20321     *
20322     * @warning The item to be removed from @p obj will be found via
20323     * its item data pointer, and not by an #Elm_Index_Item handle.
20324     *
20325     * @ingroup Index
20326     */
20327    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20328
20329    /**
20330     * Find a given index widget's item, <b>using item data</b>.
20331     *
20332     * @param obj The index object
20333     * @param item The item data pointed to by the desired index item
20334     * @return The index item handle, if found, or @c NULL otherwise
20335     *
20336     * @ingroup Index
20337     */
20338    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20339
20340    /**
20341     * Removes @b all items from a given index widget.
20342     *
20343     * @param obj The index object.
20344     *
20345     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20346     * that callback function will be called for each item in @p obj.
20347     *
20348     * @ingroup Index
20349     */
20350    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20351
20352    /**
20353     * Go to a given items level on a index widget
20354     *
20355     * @param obj The index object
20356     * @param level The index level (one of @c 0 or @c 1)
20357     *
20358     * @ingroup Index
20359     */
20360    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20361
20362    /**
20363     * Return the data associated with a given index widget item
20364     *
20365     * @param it The index widget item handle
20366     * @return The data associated with @p it
20367     *
20368     * @see elm_index_item_data_set()
20369     *
20370     * @ingroup Index
20371     */
20372    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20373
20374    /**
20375     * Set the data associated with a given index widget item
20376     *
20377     * @param it The index widget item handle
20378     * @param data The new data pointer to set to @p it
20379     *
20380     * This sets new item data on @p it.
20381     *
20382     * @warning The old data pointer won't be touched by this function, so
20383     * the user had better to free that old data himself/herself.
20384     *
20385     * @ingroup Index
20386     */
20387    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20388
20389    /**
20390     * Set the function to be called when a given index widget item is freed.
20391     *
20392     * @param it The item to set the callback on
20393     * @param func The function to call on the item's deletion
20394     *
20395     * When called, @p func will have both @c data and @c event_info
20396     * arguments with the @p it item's data value and, naturally, the
20397     * @c obj argument with a handle to the parent index widget.
20398     *
20399     * @ingroup Index
20400     */
20401    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20402
20403    /**
20404     * Get the letter (string) set on a given index widget item.
20405     *
20406     * @param it The index item handle
20407     * @return The letter string set on @p it
20408     *
20409     * @ingroup Index
20410     */
20411    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20412
20413    /**
20414     * @}
20415     */
20416
20417    /**
20418     * @defgroup Photocam Photocam
20419     *
20420     * @image html img/widget/photocam/preview-00.png
20421     * @image latex img/widget/photocam/preview-00.eps
20422     *
20423     * This is a widget specifically for displaying high-resolution digital
20424     * camera photos giving speedy feedback (fast load), low memory footprint
20425     * and zooming and panning as well as fitting logic. It is entirely focused
20426     * on jpeg images, and takes advantage of properties of the jpeg format (via
20427     * evas loader features in the jpeg loader).
20428     *
20429     * Signals that you can add callbacks for are:
20430     * @li "clicked" - This is called when a user has clicked the photo without
20431     *                 dragging around.
20432     * @li "press" - This is called when a user has pressed down on the photo.
20433     * @li "longpressed" - This is called when a user has pressed down on the
20434     *                     photo for a long time without dragging around.
20435     * @li "clicked,double" - This is called when a user has double-clicked the
20436     *                        photo.
20437     * @li "load" - Photo load begins.
20438     * @li "loaded" - This is called when the image file load is complete for the
20439     *                first view (low resolution blurry version).
20440     * @li "load,detail" - Photo detailed data load begins.
20441     * @li "loaded,detail" - This is called when the image file load is complete
20442     *                      for the detailed image data (full resolution needed).
20443     * @li "zoom,start" - Zoom animation started.
20444     * @li "zoom,stop" - Zoom animation stopped.
20445     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20446     * @li "scroll" - the content has been scrolled (moved)
20447     * @li "scroll,anim,start" - scrolling animation has started
20448     * @li "scroll,anim,stop" - scrolling animation has stopped
20449     * @li "scroll,drag,start" - dragging the contents around has started
20450     * @li "scroll,drag,stop" - dragging the contents around has stopped
20451     *
20452     * @ref tutorial_photocam shows the API in action.
20453     * @{
20454     */
20455    /**
20456     * @brief Types of zoom available.
20457     */
20458    typedef enum _Elm_Photocam_Zoom_Mode
20459      {
20460         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20461         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20462         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20463         ELM_PHOTOCAM_ZOOM_MODE_LAST
20464      } Elm_Photocam_Zoom_Mode;
20465    /**
20466     * @brief Add a new Photocam object
20467     *
20468     * @param parent The parent object
20469     * @return The new object or NULL if it cannot be created
20470     */
20471    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20472    /**
20473     * @brief Set the photo file to be shown
20474     *
20475     * @param obj The photocam object
20476     * @param file The photo file
20477     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20478     *
20479     * This sets (and shows) the specified file (with a relative or absolute
20480     * path) and will return a load error (same error that
20481     * evas_object_image_load_error_get() will return). The image will change and
20482     * adjust its size at this point and begin a background load process for this
20483     * photo that at some time in the future will be displayed at the full
20484     * quality needed.
20485     */
20486    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20487    /**
20488     * @brief Returns the path of the current image file
20489     *
20490     * @param obj The photocam object
20491     * @return Returns the path
20492     *
20493     * @see elm_photocam_file_set()
20494     */
20495    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20496    /**
20497     * @brief Set the zoom level of the photo
20498     *
20499     * @param obj The photocam object
20500     * @param zoom The zoom level to set
20501     *
20502     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20503     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20504     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20505     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20506     * 16, 32, etc.).
20507     */
20508    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20509    /**
20510     * @brief Get the zoom level of the photo
20511     *
20512     * @param obj The photocam object
20513     * @return The current zoom level
20514     *
20515     * This returns the current zoom level of the photocam object. Note that if
20516     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20517     * (which is the default), the zoom level may be changed at any time by the
20518     * photocam object itself to account for photo size and photocam viewpoer
20519     * size.
20520     *
20521     * @see elm_photocam_zoom_set()
20522     * @see elm_photocam_zoom_mode_set()
20523     */
20524    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20525    /**
20526     * @brief Set the zoom mode
20527     *
20528     * @param obj The photocam object
20529     * @param mode The desired mode
20530     *
20531     * This sets the zoom mode to manual or one of several automatic levels.
20532     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20533     * elm_photocam_zoom_set() and will stay at that level until changed by code
20534     * or until zoom mode is changed. This is the default mode. The Automatic
20535     * modes will allow the photocam object to automatically adjust zoom mode
20536     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20537     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20538     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20539     * pixels within the frame are left unfilled.
20540     */
20541    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20542    /**
20543     * @brief Get the zoom mode
20544     *
20545     * @param obj The photocam object
20546     * @return The current zoom mode
20547     *
20548     * This gets the current zoom mode of the photocam object.
20549     *
20550     * @see elm_photocam_zoom_mode_set()
20551     */
20552    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20553    /**
20554     * @brief Get the current image pixel width and height
20555     *
20556     * @param obj The photocam object
20557     * @param w A pointer to the width return
20558     * @param h A pointer to the height return
20559     *
20560     * This gets the current photo pixel width and height (for the original).
20561     * The size will be returned in the integers @p w and @p h that are pointed
20562     * to.
20563     */
20564    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20565    /**
20566     * @brief Get the area of the image that is currently shown
20567     *
20568     * @param obj
20569     * @param x A pointer to the X-coordinate of region
20570     * @param y A pointer to the Y-coordinate of region
20571     * @param w A pointer to the width
20572     * @param h A pointer to the height
20573     *
20574     * @see elm_photocam_image_region_show()
20575     * @see elm_photocam_image_region_bring_in()
20576     */
20577    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20578    /**
20579     * @brief Set the viewed portion of the image
20580     *
20581     * @param obj The photocam object
20582     * @param x X-coordinate of region in image original pixels
20583     * @param y Y-coordinate of region in image original pixels
20584     * @param w Width of region in image original pixels
20585     * @param h Height of region in image original pixels
20586     *
20587     * This shows the region of the image without using animation.
20588     */
20589    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20590    /**
20591     * @brief Bring in the viewed portion of the image
20592     *
20593     * @param obj The photocam object
20594     * @param x X-coordinate of region in image original pixels
20595     * @param y Y-coordinate of region in image original pixels
20596     * @param w Width of region in image original pixels
20597     * @param h Height of region in image original pixels
20598     *
20599     * This shows the region of the image using animation.
20600     */
20601    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20602    /**
20603     * @brief Set the paused state for photocam
20604     *
20605     * @param obj The photocam object
20606     * @param paused The pause state to set
20607     *
20608     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20609     * photocam. The default is off. This will stop zooming using animation on
20610     * zoom levels changes and change instantly. This will stop any existing
20611     * animations that are running.
20612     */
20613    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20614    /**
20615     * @brief Get the paused state for photocam
20616     *
20617     * @param obj The photocam object
20618     * @return The current paused state
20619     *
20620     * This gets the current paused state for the photocam object.
20621     *
20622     * @see elm_photocam_paused_set()
20623     */
20624    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20625    /**
20626     * @brief Get the internal low-res image used for photocam
20627     *
20628     * @param obj The photocam object
20629     * @return The internal image object handle, or NULL if none exists
20630     *
20631     * This gets the internal image object inside photocam. Do not modify it. It
20632     * is for inspection only, and hooking callbacks to. Nothing else. It may be
20633     * deleted at any time as well.
20634     */
20635    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20636    /**
20637     * @brief Set the photocam scrolling bouncing.
20638     *
20639     * @param obj The photocam object
20640     * @param h_bounce bouncing for horizontal
20641     * @param v_bounce bouncing for vertical
20642     */
20643    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20644    /**
20645     * @brief Get the photocam scrolling bouncing.
20646     *
20647     * @param obj The photocam object
20648     * @param h_bounce bouncing for horizontal
20649     * @param v_bounce bouncing for vertical
20650     *
20651     * @see elm_photocam_bounce_set()
20652     */
20653    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20654    /**
20655     * @}
20656     */
20657
20658    /**
20659     * @defgroup Map Map
20660     * @ingroup Elementary
20661     *
20662     * @image html img/widget/map/preview-00.png
20663     * @image latex img/widget/map/preview-00.eps
20664     *
20665     * This is a widget specifically for displaying a map. It uses basically
20666     * OpenStreetMap provider http://www.openstreetmap.org/,
20667     * but custom providers can be added.
20668     *
20669     * It supports some basic but yet nice features:
20670     * @li zoom and scroll
20671     * @li markers with content to be displayed when user clicks over it
20672     * @li group of markers
20673     * @li routes
20674     *
20675     * Smart callbacks one can listen to:
20676     *
20677     * - "clicked" - This is called when a user has clicked the map without
20678     *   dragging around.
20679     * - "press" - This is called when a user has pressed down on the map.
20680     * - "longpressed" - This is called when a user has pressed down on the map
20681     *   for a long time without dragging around.
20682     * - "clicked,double" - This is called when a user has double-clicked
20683     *   the map.
20684     * - "load,detail" - Map detailed data load begins.
20685     * - "loaded,detail" - This is called when all currently visible parts of
20686     *   the map are loaded.
20687     * - "zoom,start" - Zoom animation started.
20688     * - "zoom,stop" - Zoom animation stopped.
20689     * - "zoom,change" - Zoom changed when using an auto zoom mode.
20690     * - "scroll" - the content has been scrolled (moved).
20691     * - "scroll,anim,start" - scrolling animation has started.
20692     * - "scroll,anim,stop" - scrolling animation has stopped.
20693     * - "scroll,drag,start" - dragging the contents around has started.
20694     * - "scroll,drag,stop" - dragging the contents around has stopped.
20695     * - "downloaded" - This is called when all currently required map images
20696     *   are downloaded.
20697     * - "route,load" - This is called when route request begins.
20698     * - "route,loaded" - This is called when route request ends.
20699     * - "name,load" - This is called when name request begins.
20700     * - "name,loaded- This is called when name request ends.
20701     *
20702     * Available style for map widget:
20703     * - @c "default"
20704     *
20705     * Available style for markers:
20706     * - @c "radio"
20707     * - @c "radio2"
20708     * - @c "empty"
20709     *
20710     * Available style for marker bubble:
20711     * - @c "default"
20712     *
20713     * List of examples:
20714     * @li @ref map_example_01
20715     * @li @ref map_example_02
20716     * @li @ref map_example_03
20717     */
20718
20719    /**
20720     * @addtogroup Map
20721     * @{
20722     */
20723
20724    /**
20725     * @enum _Elm_Map_Zoom_Mode
20726     * @typedef Elm_Map_Zoom_Mode
20727     *
20728     * Set map's zoom behavior. It can be set to manual or automatic.
20729     *
20730     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20731     *
20732     * Values <b> don't </b> work as bitmask, only one can be choosen.
20733     *
20734     * @note Valid sizes are 2^zoom, consequently the map may be smaller
20735     * than the scroller view.
20736     *
20737     * @see elm_map_zoom_mode_set()
20738     * @see elm_map_zoom_mode_get()
20739     *
20740     * @ingroup Map
20741     */
20742    typedef enum _Elm_Map_Zoom_Mode
20743      {
20744         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20745         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20746         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20747         ELM_MAP_ZOOM_MODE_LAST
20748      } Elm_Map_Zoom_Mode;
20749
20750    /**
20751     * @enum _Elm_Map_Route_Sources
20752     * @typedef Elm_Map_Route_Sources
20753     *
20754     * Set route service to be used. By default used source is
20755     * #ELM_MAP_ROUTE_SOURCE_YOURS.
20756     *
20757     * @see elm_map_route_source_set()
20758     * @see elm_map_route_source_get()
20759     *
20760     * @ingroup Map
20761     */
20762    typedef enum _Elm_Map_Route_Sources
20763      {
20764         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20765         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. */
20766         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20767         ELM_MAP_ROUTE_SOURCE_LAST
20768      } Elm_Map_Route_Sources;
20769
20770    typedef enum _Elm_Map_Name_Sources
20771      {
20772         ELM_MAP_NAME_SOURCE_NOMINATIM,
20773         ELM_MAP_NAME_SOURCE_LAST
20774      } Elm_Map_Name_Sources;
20775
20776    /**
20777     * @enum _Elm_Map_Route_Type
20778     * @typedef Elm_Map_Route_Type
20779     *
20780     * Set type of transport used on route.
20781     *
20782     * @see elm_map_route_add()
20783     *
20784     * @ingroup Map
20785     */
20786    typedef enum _Elm_Map_Route_Type
20787      {
20788         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20789         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20790         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20791         ELM_MAP_ROUTE_TYPE_LAST
20792      } Elm_Map_Route_Type;
20793
20794    /**
20795     * @enum _Elm_Map_Route_Method
20796     * @typedef Elm_Map_Route_Method
20797     *
20798     * Set the routing method, what should be priorized, time or distance.
20799     *
20800     * @see elm_map_route_add()
20801     *
20802     * @ingroup Map
20803     */
20804    typedef enum _Elm_Map_Route_Method
20805      {
20806         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20807         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20808         ELM_MAP_ROUTE_METHOD_LAST
20809      } Elm_Map_Route_Method;
20810
20811    typedef enum _Elm_Map_Name_Method
20812      {
20813         ELM_MAP_NAME_METHOD_SEARCH,
20814         ELM_MAP_NAME_METHOD_REVERSE,
20815         ELM_MAP_NAME_METHOD_LAST
20816      } Elm_Map_Name_Method;
20817
20818    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(). */
20819    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(). */
20820    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(). */
20821    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(). */
20822    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
20823    typedef struct _Elm_Map_Track           Elm_Map_Track;
20824
20825    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. */
20826    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20827    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20828    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20829
20830    typedef char        *(*ElmMapModuleSourceFunc) (void);
20831    typedef int          (*ElmMapModuleZoomMinFunc) (void);
20832    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
20833    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20834    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
20835    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20836    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20837    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20838    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20839
20840    /**
20841     * Add a new map widget to the given parent Elementary (container) object.
20842     *
20843     * @param parent The parent object.
20844     * @return a new map widget handle or @c NULL, on errors.
20845     *
20846     * This function inserts a new map widget on the canvas.
20847     *
20848     * @ingroup Map
20849     */
20850    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20851
20852    /**
20853     * Set the zoom level of the map.
20854     *
20855     * @param obj The map object.
20856     * @param zoom The zoom level to set.
20857     *
20858     * This sets the zoom level.
20859     *
20860     * It will respect limits defined by elm_map_source_zoom_min_set() and
20861     * elm_map_source_zoom_max_set().
20862     *
20863     * By default these values are 0 (world map) and 18 (maximum zoom).
20864     *
20865     * This function should be used when zoom mode is set to
20866     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20867     * with elm_map_zoom_mode_set().
20868     *
20869     * @see elm_map_zoom_mode_set().
20870     * @see elm_map_zoom_get().
20871     *
20872     * @ingroup Map
20873     */
20874    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20875
20876    /**
20877     * Get the zoom level of the map.
20878     *
20879     * @param obj The map object.
20880     * @return The current zoom level.
20881     *
20882     * This returns the current zoom level of the map object.
20883     *
20884     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20885     * (which is the default), the zoom level may be changed at any time by the
20886     * map object itself to account for map size and map viewport size.
20887     *
20888     * @see elm_map_zoom_set() for details.
20889     *
20890     * @ingroup Map
20891     */
20892    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20893
20894    /**
20895     * Set the zoom mode used by the map object.
20896     *
20897     * @param obj The map object.
20898     * @param mode The zoom mode of the map, being it one of
20899     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20900     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20901     *
20902     * This sets the zoom mode to manual or one of the automatic levels.
20903     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20904     * elm_map_zoom_set() and will stay at that level until changed by code
20905     * or until zoom mode is changed. This is the default mode.
20906     *
20907     * The Automatic modes will allow the map object to automatically
20908     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20909     * adjust zoom so the map fits inside the scroll frame with no pixels
20910     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20911     * ensure no pixels within the frame are left unfilled. Do not forget that
20912     * the valid sizes are 2^zoom, consequently the map may be smaller than
20913     * the scroller view.
20914     *
20915     * @see elm_map_zoom_set()
20916     *
20917     * @ingroup Map
20918     */
20919    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20920
20921    /**
20922     * Get the zoom mode used by the map object.
20923     *
20924     * @param obj The map object.
20925     * @return The zoom mode of the map, being it one of
20926     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20927     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20928     *
20929     * This function returns the current zoom mode used by the map object.
20930     *
20931     * @see elm_map_zoom_mode_set() for more details.
20932     *
20933     * @ingroup Map
20934     */
20935    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20936
20937    /**
20938     * Get the current coordinates of the map.
20939     *
20940     * @param obj The map object.
20941     * @param lon Pointer where to store longitude.
20942     * @param lat Pointer where to store latitude.
20943     *
20944     * This gets the current center coordinates of the map object. It can be
20945     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
20946     *
20947     * @see elm_map_geo_region_bring_in()
20948     * @see elm_map_geo_region_show()
20949     *
20950     * @ingroup Map
20951     */
20952    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
20953
20954    /**
20955     * Animatedly bring in given coordinates to the center of the map.
20956     *
20957     * @param obj The map object.
20958     * @param lon Longitude to center at.
20959     * @param lat Latitude to center at.
20960     *
20961     * This causes map to jump to the given @p lat and @p lon coordinates
20962     * and show it (by scrolling) in the center of the viewport, if it is not
20963     * already centered. This will use animation to do so and take a period
20964     * of time to complete.
20965     *
20966     * @see elm_map_geo_region_show() for a function to avoid animation.
20967     * @see elm_map_geo_region_get()
20968     *
20969     * @ingroup Map
20970     */
20971    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20972
20973    /**
20974     * Show the given coordinates at the center of the map, @b immediately.
20975     *
20976     * @param obj The map object.
20977     * @param lon Longitude to center at.
20978     * @param lat Latitude to center at.
20979     *
20980     * This causes map to @b redraw its viewport's contents to the
20981     * region contining the given @p lat and @p lon, that will be moved to the
20982     * center of the map.
20983     *
20984     * @see elm_map_geo_region_bring_in() for a function to move with animation.
20985     * @see elm_map_geo_region_get()
20986     *
20987     * @ingroup Map
20988     */
20989    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20990
20991    /**
20992     * Pause or unpause the map.
20993     *
20994     * @param obj The map object.
20995     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
20996     * to unpause it.
20997     *
20998     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20999     * for map.
21000     *
21001     * The default is off.
21002     *
21003     * This will stop zooming using animation, changing zoom levels will
21004     * change instantly. This will stop any existing animations that are running.
21005     *
21006     * @see elm_map_paused_get()
21007     *
21008     * @ingroup Map
21009     */
21010    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21011
21012    /**
21013     * Get a value whether map is paused or not.
21014     *
21015     * @param obj The map object.
21016     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21017     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21018     *
21019     * This gets the current paused state for the map object.
21020     *
21021     * @see elm_map_paused_set() for details.
21022     *
21023     * @ingroup Map
21024     */
21025    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21026
21027    /**
21028     * Set to show markers during zoom level changes or not.
21029     *
21030     * @param obj The map object.
21031     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21032     * to show them.
21033     *
21034     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21035     * for map.
21036     *
21037     * The default is off.
21038     *
21039     * This will stop zooming using animation, changing zoom levels will
21040     * change instantly. This will stop any existing animations that are running.
21041     *
21042     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21043     * for the markers.
21044     *
21045     * The default  is off.
21046     *
21047     * Enabling it will force the map to stop displaying the markers during
21048     * zoom level changes. Set to on if you have a large number of markers.
21049     *
21050     * @see elm_map_paused_markers_get()
21051     *
21052     * @ingroup Map
21053     */
21054    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21055
21056    /**
21057     * Get a value whether markers will be displayed on zoom level changes or not
21058     *
21059     * @param obj The map object.
21060     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21061     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21062     *
21063     * This gets the current markers paused state for the map object.
21064     *
21065     * @see elm_map_paused_markers_set() for details.
21066     *
21067     * @ingroup Map
21068     */
21069    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21070
21071    /**
21072     * Get the information of downloading status.
21073     *
21074     * @param obj The map object.
21075     * @param try_num Pointer where to store number of tiles being downloaded.
21076     * @param finish_num Pointer where to store number of tiles successfully
21077     * downloaded.
21078     *
21079     * This gets the current downloading status for the map object, the number
21080     * of tiles being downloaded and the number of tiles already downloaded.
21081     *
21082     * @ingroup Map
21083     */
21084    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21085
21086    /**
21087     * Convert a pixel coordinate (x,y) into a geographic coordinate
21088     * (longitude, latitude).
21089     *
21090     * @param obj The map object.
21091     * @param x the coordinate.
21092     * @param y the coordinate.
21093     * @param size the size in pixels of the map.
21094     * The map is a square and generally his size is : pow(2.0, zoom)*256.
21095     * @param lon Pointer where to store the longitude that correspond to x.
21096     * @param lat Pointer where to store the latitude that correspond to y.
21097     *
21098     * @note Origin pixel point is the top left corner of the viewport.
21099     * Map zoom and size are taken on account.
21100     *
21101     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21102     *
21103     * @ingroup Map
21104     */
21105    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);
21106
21107    /**
21108     * Convert a geographic coordinate (longitude, latitude) into a pixel
21109     * coordinate (x, y).
21110     *
21111     * @param obj The map object.
21112     * @param lon the longitude.
21113     * @param lat the latitude.
21114     * @param size the size in pixels of the map. The map is a square
21115     * and generally his size is : pow(2.0, zoom)*256.
21116     * @param x Pointer where to store the horizontal pixel coordinate that
21117     * correspond to the longitude.
21118     * @param y Pointer where to store the vertical pixel coordinate that
21119     * correspond to the latitude.
21120     *
21121     * @note Origin pixel point is the top left corner of the viewport.
21122     * Map zoom and size are taken on account.
21123     *
21124     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21125     *
21126     * @ingroup Map
21127     */
21128    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);
21129
21130    /**
21131     * Convert a geographic coordinate (longitude, latitude) into a name
21132     * (address).
21133     *
21134     * @param obj The map object.
21135     * @param lon the longitude.
21136     * @param lat the latitude.
21137     * @return name A #Elm_Map_Name handle for this coordinate.
21138     *
21139     * To get the string for this address, elm_map_name_address_get()
21140     * should be used.
21141     *
21142     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21143     *
21144     * @ingroup Map
21145     */
21146    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21147
21148    /**
21149     * Convert a name (address) into a geographic coordinate
21150     * (longitude, latitude).
21151     *
21152     * @param obj The map object.
21153     * @param name The address.
21154     * @return name A #Elm_Map_Name handle for this address.
21155     *
21156     * To get the longitude and latitude, elm_map_name_region_get()
21157     * should be used.
21158     *
21159     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21160     *
21161     * @ingroup Map
21162     */
21163    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21164
21165    /**
21166     * Convert a pixel coordinate into a rotated pixel coordinate.
21167     *
21168     * @param obj The map object.
21169     * @param x horizontal coordinate of the point to rotate.
21170     * @param y vertical coordinate of the point to rotate.
21171     * @param cx rotation's center horizontal position.
21172     * @param cy rotation's center vertical position.
21173     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21174     * @param xx Pointer where to store rotated x.
21175     * @param yy Pointer where to store rotated y.
21176     *
21177     * @ingroup Map
21178     */
21179    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);
21180
21181    /**
21182     * Add a new marker to the map object.
21183     *
21184     * @param obj The map object.
21185     * @param lon The longitude of the marker.
21186     * @param lat The latitude of the marker.
21187     * @param clas The class, to use when marker @b isn't grouped to others.
21188     * @param clas_group The class group, to use when marker is grouped to others
21189     * @param data The data passed to the callbacks.
21190     *
21191     * @return The created marker or @c NULL upon failure.
21192     *
21193     * A marker will be created and shown in a specific point of the map, defined
21194     * by @p lon and @p lat.
21195     *
21196     * It will be displayed using style defined by @p class when this marker
21197     * is displayed alone (not grouped). A new class can be created with
21198     * elm_map_marker_class_new().
21199     *
21200     * If the marker is grouped to other markers, it will be displayed with
21201     * style defined by @p class_group. Markers with the same group are grouped
21202     * if they are close. A new group class can be created with
21203     * elm_map_marker_group_class_new().
21204     *
21205     * Markers created with this method can be deleted with
21206     * elm_map_marker_remove().
21207     *
21208     * A marker can have associated content to be displayed by a bubble,
21209     * when a user click over it, as well as an icon. These objects will
21210     * be fetch using class' callback functions.
21211     *
21212     * @see elm_map_marker_class_new()
21213     * @see elm_map_marker_group_class_new()
21214     * @see elm_map_marker_remove()
21215     *
21216     * @ingroup Map
21217     */
21218    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);
21219
21220    /**
21221     * Set the maximum numbers of markers' content to be displayed in a group.
21222     *
21223     * @param obj The map object.
21224     * @param max The maximum numbers of items displayed in a bubble.
21225     *
21226     * A bubble will be displayed when the user clicks over the group,
21227     * and will place the content of markers that belong to this group
21228     * inside it.
21229     *
21230     * A group can have a long list of markers, consequently the creation
21231     * of the content of the bubble can be very slow.
21232     *
21233     * In order to avoid this, a maximum number of items is displayed
21234     * in a bubble.
21235     *
21236     * By default this number is 30.
21237     *
21238     * Marker with the same group class are grouped if they are close.
21239     *
21240     * @see elm_map_marker_add()
21241     *
21242     * @ingroup Map
21243     */
21244    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21245
21246    /**
21247     * Remove a marker from the map.
21248     *
21249     * @param marker The marker to remove.
21250     *
21251     * @see elm_map_marker_add()
21252     *
21253     * @ingroup Map
21254     */
21255    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21256
21257    /**
21258     * Get the current coordinates of the marker.
21259     *
21260     * @param marker marker.
21261     * @param lat Pointer where to store the marker's latitude.
21262     * @param lon Pointer where to store the marker's longitude.
21263     *
21264     * These values are set when adding markers, with function
21265     * elm_map_marker_add().
21266     *
21267     * @see elm_map_marker_add()
21268     *
21269     * @ingroup Map
21270     */
21271    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21272
21273    /**
21274     * Animatedly bring in given marker to the center of the map.
21275     *
21276     * @param marker The marker to center at.
21277     *
21278     * This causes map to jump to the given @p marker's coordinates
21279     * and show it (by scrolling) in the center of the viewport, if it is not
21280     * already centered. This will use animation to do so and take a period
21281     * of time to complete.
21282     *
21283     * @see elm_map_marker_show() for a function to avoid animation.
21284     * @see elm_map_marker_region_get()
21285     *
21286     * @ingroup Map
21287     */
21288    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21289
21290    /**
21291     * Show the given marker at the center of the map, @b immediately.
21292     *
21293     * @param marker The marker to center at.
21294     *
21295     * This causes map to @b redraw its viewport's contents to the
21296     * region contining the given @p marker's coordinates, that will be
21297     * moved to the center of the map.
21298     *
21299     * @see elm_map_marker_bring_in() for a function to move with animation.
21300     * @see elm_map_markers_list_show() if more than one marker need to be
21301     * displayed.
21302     * @see elm_map_marker_region_get()
21303     *
21304     * @ingroup Map
21305     */
21306    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21307
21308    /**
21309     * Move and zoom the map to display a list of markers.
21310     *
21311     * @param markers A list of #Elm_Map_Marker handles.
21312     *
21313     * The map will be centered on the center point of the markers in the list.
21314     * Then the map will be zoomed in order to fit the markers using the maximum
21315     * zoom which allows display of all the markers.
21316     *
21317     * @warning All the markers should belong to the same map object.
21318     *
21319     * @see elm_map_marker_show() to show a single marker.
21320     * @see elm_map_marker_bring_in()
21321     *
21322     * @ingroup Map
21323     */
21324    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21325
21326    /**
21327     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21328     *
21329     * @param marker The marker wich content should be returned.
21330     * @return Return the evas object if it exists, else @c NULL.
21331     *
21332     * To set callback function #ElmMapMarkerGetFunc for the marker class,
21333     * elm_map_marker_class_get_cb_set() should be used.
21334     *
21335     * This content is what will be inside the bubble that will be displayed
21336     * when an user clicks over the marker.
21337     *
21338     * This returns the actual Evas object used to be placed inside
21339     * the bubble. This may be @c NULL, as it may
21340     * not have been created or may have been deleted, at any time, by
21341     * the map. <b>Do not modify this object</b> (move, resize,
21342     * show, hide, etc.), as the map is controlling it. This
21343     * function is for querying, emitting custom signals or hooking
21344     * lower level callbacks for events on that object. Do not delete
21345     * this object under any circumstances.
21346     *
21347     * @ingroup Map
21348     */
21349    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21350
21351    /**
21352     * Update the marker
21353     *
21354     * @param marker The marker to be updated.
21355     *
21356     * If a content is set to this marker, it will call function to delete it,
21357     * #ElmMapMarkerDelFunc, and then will fetch the content again with
21358     * #ElmMapMarkerGetFunc.
21359     *
21360     * These functions are set for the marker class with
21361     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21362     *
21363     * @ingroup Map
21364     */
21365    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21366
21367    /**
21368     * Close all the bubbles opened by the user.
21369     *
21370     * @param obj The map object.
21371     *
21372     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21373     * when the user clicks on a marker.
21374     *
21375     * This functions is set for the marker class with
21376     * elm_map_marker_class_get_cb_set().
21377     *
21378     * @ingroup Map
21379     */
21380    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21381
21382    /**
21383     * Create a new group class.
21384     *
21385     * @param obj The map object.
21386     * @return Returns the new group class.
21387     *
21388     * Each marker must be associated to a group class. Markers in the same
21389     * group are grouped if they are close.
21390     *
21391     * The group class defines the style of the marker when a marker is grouped
21392     * to others markers. When it is alone, another class will be used.
21393     *
21394     * A group class will need to be provided when creating a marker with
21395     * elm_map_marker_add().
21396     *
21397     * Some properties and functions can be set by class, as:
21398     * - style, with elm_map_group_class_style_set()
21399     * - data - to be associated to the group class. It can be set using
21400     *   elm_map_group_class_data_set().
21401     * - min zoom to display markers, set with
21402     *   elm_map_group_class_zoom_displayed_set().
21403     * - max zoom to group markers, set using
21404     *   elm_map_group_class_zoom_grouped_set().
21405     * - visibility - set if markers will be visible or not, set with
21406     *   elm_map_group_class_hide_set().
21407     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21408     *   It can be set using elm_map_group_class_icon_cb_set().
21409     *
21410     * @see elm_map_marker_add()
21411     * @see elm_map_group_class_style_set()
21412     * @see elm_map_group_class_data_set()
21413     * @see elm_map_group_class_zoom_displayed_set()
21414     * @see elm_map_group_class_zoom_grouped_set()
21415     * @see elm_map_group_class_hide_set()
21416     * @see elm_map_group_class_icon_cb_set()
21417     *
21418     * @ingroup Map
21419     */
21420    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21421
21422    /**
21423     * Set the marker's style of a group class.
21424     *
21425     * @param clas The group class.
21426     * @param style The style to be used by markers.
21427     *
21428     * Each marker must be associated to a group class, and will use the style
21429     * defined by such class when grouped to other markers.
21430     *
21431     * The following styles are provided by default theme:
21432     * @li @c radio - blue circle
21433     * @li @c radio2 - green circle
21434     * @li @c empty
21435     *
21436     * @see elm_map_group_class_new() for more details.
21437     * @see elm_map_marker_add()
21438     *
21439     * @ingroup Map
21440     */
21441    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21442
21443    /**
21444     * Set the icon callback function of a group class.
21445     *
21446     * @param clas The group class.
21447     * @param icon_get The callback function that will return the icon.
21448     *
21449     * Each marker must be associated to a group class, and it can display a
21450     * custom icon. The function @p icon_get must return this icon.
21451     *
21452     * @see elm_map_group_class_new() for more details.
21453     * @see elm_map_marker_add()
21454     *
21455     * @ingroup Map
21456     */
21457    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21458
21459    /**
21460     * Set the data associated to the group class.
21461     *
21462     * @param clas The group class.
21463     * @param data The new user data.
21464     *
21465     * This data will be passed for callback functions, like icon get callback,
21466     * that can be set with elm_map_group_class_icon_cb_set().
21467     *
21468     * If a data was previously set, the object will lose the pointer for it,
21469     * so if needs to be freed, you must do it yourself.
21470     *
21471     * @see elm_map_group_class_new() for more details.
21472     * @see elm_map_group_class_icon_cb_set()
21473     * @see elm_map_marker_add()
21474     *
21475     * @ingroup Map
21476     */
21477    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21478
21479    /**
21480     * Set the minimum zoom from where the markers are displayed.
21481     *
21482     * @param clas The group class.
21483     * @param zoom The minimum zoom.
21484     *
21485     * Markers only will be displayed when the map is displayed at @p zoom
21486     * or bigger.
21487     *
21488     * @see elm_map_group_class_new() for more details.
21489     * @see elm_map_marker_add()
21490     *
21491     * @ingroup Map
21492     */
21493    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21494
21495    /**
21496     * Set the zoom from where the markers are no more grouped.
21497     *
21498     * @param clas The group class.
21499     * @param zoom The maximum zoom.
21500     *
21501     * Markers only will be grouped when the map is displayed at
21502     * less than @p zoom.
21503     *
21504     * @see elm_map_group_class_new() for more details.
21505     * @see elm_map_marker_add()
21506     *
21507     * @ingroup Map
21508     */
21509    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21510
21511    /**
21512     * Set if the markers associated to the group class @clas are hidden or not.
21513     *
21514     * @param clas The group class.
21515     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21516     * to show them.
21517     *
21518     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21519     * is to show them.
21520     *
21521     * @ingroup Map
21522     */
21523    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21524
21525    /**
21526     * Create a new marker class.
21527     *
21528     * @param obj The map object.
21529     * @return Returns the new group class.
21530     *
21531     * Each marker must be associated to a class.
21532     *
21533     * The marker class defines the style of the marker when a marker is
21534     * displayed alone, i.e., not grouped to to others markers. When grouped
21535     * it will use group class style.
21536     *
21537     * A marker class will need to be provided when creating a marker with
21538     * elm_map_marker_add().
21539     *
21540     * Some properties and functions can be set by class, as:
21541     * - style, with elm_map_marker_class_style_set()
21542     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21543     *   It can be set using elm_map_marker_class_icon_cb_set().
21544     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21545     *   Set using elm_map_marker_class_get_cb_set().
21546     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21547     *   Set using elm_map_marker_class_del_cb_set().
21548     *
21549     * @see elm_map_marker_add()
21550     * @see elm_map_marker_class_style_set()
21551     * @see elm_map_marker_class_icon_cb_set()
21552     * @see elm_map_marker_class_get_cb_set()
21553     * @see elm_map_marker_class_del_cb_set()
21554     *
21555     * @ingroup Map
21556     */
21557    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21558
21559    /**
21560     * Set the marker's style of a marker class.
21561     *
21562     * @param clas The marker class.
21563     * @param style The style to be used by markers.
21564     *
21565     * Each marker must be associated to a marker class, and will use the style
21566     * defined by such class when alone, i.e., @b not grouped to other markers.
21567     *
21568     * The following styles are provided by default theme:
21569     * @li @c radio
21570     * @li @c radio2
21571     * @li @c empty
21572     *
21573     * @see elm_map_marker_class_new() for more details.
21574     * @see elm_map_marker_add()
21575     *
21576     * @ingroup Map
21577     */
21578    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21579
21580    /**
21581     * Set the icon callback function of a marker class.
21582     *
21583     * @param clas The marker class.
21584     * @param icon_get The callback function that will return the icon.
21585     *
21586     * Each marker must be associated to a marker class, and it can display a
21587     * custom icon. The function @p icon_get must return this icon.
21588     *
21589     * @see elm_map_marker_class_new() for more details.
21590     * @see elm_map_marker_add()
21591     *
21592     * @ingroup Map
21593     */
21594    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21595
21596    /**
21597     * Set the bubble content callback function of a marker class.
21598     *
21599     * @param clas The marker class.
21600     * @param get The callback function that will return the content.
21601     *
21602     * Each marker must be associated to a marker class, and it can display a
21603     * a content on a bubble that opens when the user click over the marker.
21604     * The function @p get must return this content object.
21605     *
21606     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21607     * can be used.
21608     *
21609     * @see elm_map_marker_class_new() for more details.
21610     * @see elm_map_marker_class_del_cb_set()
21611     * @see elm_map_marker_add()
21612     *
21613     * @ingroup Map
21614     */
21615    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21616
21617    /**
21618     * Set the callback function used to delete bubble content of a marker class.
21619     *
21620     * @param clas The marker class.
21621     * @param del The callback function that will delete the content.
21622     *
21623     * Each marker must be associated to a marker class, and it can display a
21624     * a content on a bubble that opens when the user click over the marker.
21625     * The function to return such content can be set with
21626     * elm_map_marker_class_get_cb_set().
21627     *
21628     * If this content must be freed, a callback function need to be
21629     * set for that task with this function.
21630     *
21631     * If this callback is defined it will have to delete (or not) the
21632     * object inside, but if the callback is not defined the object will be
21633     * destroyed with evas_object_del().
21634     *
21635     * @see elm_map_marker_class_new() for more details.
21636     * @see elm_map_marker_class_get_cb_set()
21637     * @see elm_map_marker_add()
21638     *
21639     * @ingroup Map
21640     */
21641    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21642
21643    /**
21644     * Get the list of available sources.
21645     *
21646     * @param obj The map object.
21647     * @return The source names list.
21648     *
21649     * It will provide a list with all available sources, that can be set as
21650     * current source with elm_map_source_name_set(), or get with
21651     * elm_map_source_name_get().
21652     *
21653     * Available sources:
21654     * @li "Mapnik"
21655     * @li "Osmarender"
21656     * @li "CycleMap"
21657     * @li "Maplint"
21658     *
21659     * @see elm_map_source_name_set() for more details.
21660     * @see elm_map_source_name_get()
21661     *
21662     * @ingroup Map
21663     */
21664    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21665
21666    /**
21667     * Set the source of the map.
21668     *
21669     * @param obj The map object.
21670     * @param source The source to be used.
21671     *
21672     * Map widget retrieves images that composes the map from a web service.
21673     * This web service can be set with this method.
21674     *
21675     * A different service can return a different maps with different
21676     * information and it can use different zoom values.
21677     *
21678     * The @p source_name need to match one of the names provided by
21679     * elm_map_source_names_get().
21680     *
21681     * The current source can be get using elm_map_source_name_get().
21682     *
21683     * @see elm_map_source_names_get()
21684     * @see elm_map_source_name_get()
21685     *
21686     *
21687     * @ingroup Map
21688     */
21689    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21690
21691    /**
21692     * Get the name of currently used source.
21693     *
21694     * @param obj The map object.
21695     * @return Returns the name of the source in use.
21696     *
21697     * @see elm_map_source_name_set() for more details.
21698     *
21699     * @ingroup Map
21700     */
21701    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21702
21703    /**
21704     * Set the source of the route service to be used by the map.
21705     *
21706     * @param obj The map object.
21707     * @param source The route service to be used, being it one of
21708     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21709     * and #ELM_MAP_ROUTE_SOURCE_ORS.
21710     *
21711     * Each one has its own algorithm, so the route retrieved may
21712     * differ depending on the source route. Now, only the default is working.
21713     *
21714     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21715     * http://www.yournavigation.org/.
21716     *
21717     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21718     * assumptions. Its routing core is based on Contraction Hierarchies.
21719     *
21720     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21721     *
21722     * @see elm_map_route_source_get().
21723     *
21724     * @ingroup Map
21725     */
21726    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21727
21728    /**
21729     * Get the current route source.
21730     *
21731     * @param obj The map object.
21732     * @return The source of the route service used by the map.
21733     *
21734     * @see elm_map_route_source_set() for details.
21735     *
21736     * @ingroup Map
21737     */
21738    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21739
21740    /**
21741     * Set the minimum zoom of the source.
21742     *
21743     * @param obj The map object.
21744     * @param zoom New minimum zoom value to be used.
21745     *
21746     * By default, it's 0.
21747     *
21748     * @ingroup Map
21749     */
21750    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21751
21752    /**
21753     * Get the minimum zoom of the source.
21754     *
21755     * @param obj The map object.
21756     * @return Returns the minimum zoom of the source.
21757     *
21758     * @see elm_map_source_zoom_min_set() for details.
21759     *
21760     * @ingroup Map
21761     */
21762    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21763
21764    /**
21765     * Set the maximum zoom of the source.
21766     *
21767     * @param obj The map object.
21768     * @param zoom New maximum zoom value to be used.
21769     *
21770     * By default, it's 18.
21771     *
21772     * @ingroup Map
21773     */
21774    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21775
21776    /**
21777     * Get the maximum zoom of the source.
21778     *
21779     * @param obj The map object.
21780     * @return Returns the maximum zoom of the source.
21781     *
21782     * @see elm_map_source_zoom_min_set() for details.
21783     *
21784     * @ingroup Map
21785     */
21786    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21787
21788    /**
21789     * Set the user agent used by the map object to access routing services.
21790     *
21791     * @param obj The map object.
21792     * @param user_agent The user agent to be used by the map.
21793     *
21794     * User agent is a client application implementing a network protocol used
21795     * in communications within a client–server distributed computing system
21796     *
21797     * The @p user_agent identification string will transmitted in a header
21798     * field @c User-Agent.
21799     *
21800     * @see elm_map_user_agent_get()
21801     *
21802     * @ingroup Map
21803     */
21804    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21805
21806    /**
21807     * Get the user agent used by the map object.
21808     *
21809     * @param obj The map object.
21810     * @return The user agent identification string used by the map.
21811     *
21812     * @see elm_map_user_agent_set() for details.
21813     *
21814     * @ingroup Map
21815     */
21816    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21817
21818    /**
21819     * Add a new route to the map object.
21820     *
21821     * @param obj The map object.
21822     * @param type The type of transport to be considered when tracing a route.
21823     * @param method The routing method, what should be priorized.
21824     * @param flon The start longitude.
21825     * @param flat The start latitude.
21826     * @param tlon The destination longitude.
21827     * @param tlat The destination latitude.
21828     *
21829     * @return The created route or @c NULL upon failure.
21830     *
21831     * A route will be traced by point on coordinates (@p flat, @p flon)
21832     * to point on coordinates (@p tlat, @p tlon), using the route service
21833     * set with elm_map_route_source_set().
21834     *
21835     * It will take @p type on consideration to define the route,
21836     * depending if the user will be walking or driving, the route may vary.
21837     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21838     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21839     *
21840     * Another parameter is what the route should priorize, the minor distance
21841     * or the less time to be spend on the route. So @p method should be one
21842     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21843     *
21844     * Routes created with this method can be deleted with
21845     * elm_map_route_remove(), colored with elm_map_route_color_set(),
21846     * and distance can be get with elm_map_route_distance_get().
21847     *
21848     * @see elm_map_route_remove()
21849     * @see elm_map_route_color_set()
21850     * @see elm_map_route_distance_get()
21851     * @see elm_map_route_source_set()
21852     *
21853     * @ingroup Map
21854     */
21855    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);
21856
21857    /**
21858     * Remove a route from the map.
21859     *
21860     * @param route The route to remove.
21861     *
21862     * @see elm_map_route_add()
21863     *
21864     * @ingroup Map
21865     */
21866    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21867
21868    /**
21869     * Set the route color.
21870     *
21871     * @param route The route object.
21872     * @param r Red channel value, from 0 to 255.
21873     * @param g Green channel value, from 0 to 255.
21874     * @param b Blue channel value, from 0 to 255.
21875     * @param a Alpha channel value, from 0 to 255.
21876     *
21877     * It uses an additive color model, so each color channel represents
21878     * how much of each primary colors must to be used. 0 represents
21879     * ausence of this color, so if all of the three are set to 0,
21880     * the color will be black.
21881     *
21882     * These component values should be integers in the range 0 to 255,
21883     * (single 8-bit byte).
21884     *
21885     * This sets the color used for the route. By default, it is set to
21886     * solid red (r = 255, g = 0, b = 0, a = 255).
21887     *
21888     * For alpha channel, 0 represents completely transparent, and 255, opaque.
21889     *
21890     * @see elm_map_route_color_get()
21891     *
21892     * @ingroup Map
21893     */
21894    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21895
21896    /**
21897     * Get the route color.
21898     *
21899     * @param route The route object.
21900     * @param r Pointer where to store the red channel value.
21901     * @param g Pointer where to store the green channel value.
21902     * @param b Pointer where to store the blue channel value.
21903     * @param a Pointer where to store the alpha channel value.
21904     *
21905     * @see elm_map_route_color_set() for details.
21906     *
21907     * @ingroup Map
21908     */
21909    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21910
21911    /**
21912     * Get the route distance in kilometers.
21913     *
21914     * @param route The route object.
21915     * @return The distance of route (unit : km).
21916     *
21917     * @ingroup Map
21918     */
21919    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21920
21921    /**
21922     * Get the information of route nodes.
21923     *
21924     * @param route The route object.
21925     * @return Returns a string with the nodes of route.
21926     *
21927     * @ingroup Map
21928     */
21929    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21930
21931    /**
21932     * Get the information of route waypoint.
21933     *
21934     * @param route the route object.
21935     * @return Returns a string with information about waypoint of route.
21936     *
21937     * @ingroup Map
21938     */
21939    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21940
21941    /**
21942     * Get the address of the name.
21943     *
21944     * @param name The name handle.
21945     * @return Returns the address string of @p name.
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 const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21956
21957    /**
21958     * Get the current coordinates of the name.
21959     *
21960     * @param name The name handle.
21961     * @param lat Pointer where to store the latitude.
21962     * @param lon Pointer where to store The longitude.
21963     *
21964     * This gets the coordinates of the @p name, created with one of the
21965     * conversion functions.
21966     *
21967     * @see elm_map_utils_convert_name_into_coord()
21968     * @see elm_map_utils_convert_coord_into_name()
21969     *
21970     * @ingroup Map
21971     */
21972    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
21973
21974    /**
21975     * Remove a name from the map.
21976     *
21977     * @param name The name to remove.
21978     *
21979     * Basically the struct handled by @p name will be freed, so convertions
21980     * between address and coordinates will be lost.
21981     *
21982     * @see elm_map_utils_convert_name_into_coord()
21983     * @see elm_map_utils_convert_coord_into_name()
21984     *
21985     * @ingroup Map
21986     */
21987    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21988
21989    /**
21990     * Rotate the map.
21991     *
21992     * @param obj The map object.
21993     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
21994     * @param cx Rotation's center horizontal position.
21995     * @param cy Rotation's center vertical position.
21996     *
21997     * @see elm_map_rotate_get()
21998     *
21999     * @ingroup Map
22000     */
22001    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22002
22003    /**
22004     * Get the rotate degree of the map
22005     *
22006     * @param obj The map object
22007     * @param degree Pointer where to store degrees from 0.0 to 360.0
22008     * to rotate arount Z axis.
22009     * @param cx Pointer where to store rotation's center horizontal position.
22010     * @param cy Pointer where to store rotation's center vertical position.
22011     *
22012     * @see elm_map_rotate_set() to set map rotation.
22013     *
22014     * @ingroup Map
22015     */
22016    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);
22017
22018    /**
22019     * Enable or disable mouse wheel to be used to zoom in / out the map.
22020     *
22021     * @param obj The map object.
22022     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22023     * to enable it.
22024     *
22025     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22026     *
22027     * It's disabled by default.
22028     *
22029     * @see elm_map_wheel_disabled_get()
22030     *
22031     * @ingroup Map
22032     */
22033    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22034
22035    /**
22036     * Get a value whether mouse wheel is enabled or not.
22037     *
22038     * @param obj The map object.
22039     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22040     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22041     *
22042     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22043     *
22044     * @see elm_map_wheel_disabled_set() for details.
22045     *
22046     * @ingroup Map
22047     */
22048    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22049
22050 #ifdef ELM_EMAP
22051    /**
22052     * Add a track on the map
22053     *
22054     * @param obj The map object.
22055     * @param emap The emap route object.
22056     * @return The route object. This is an elm object of type Route.
22057     *
22058     * @see elm_route_add() for details.
22059     *
22060     * @ingroup Map
22061     */
22062    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22063 #endif
22064
22065    /**
22066     * Remove a track from the map
22067     *
22068     * @param obj The map object.
22069     * @param route The track to remove.
22070     *
22071     * @ingroup Map
22072     */
22073    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22074
22075    /**
22076     * @}
22077     */
22078
22079    /* Route */
22080    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22081 #ifdef ELM_EMAP
22082    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22083 #endif
22084    EAPI double elm_route_lon_min_get(Evas_Object *obj);
22085    EAPI double elm_route_lat_min_get(Evas_Object *obj);
22086    EAPI double elm_route_lon_max_get(Evas_Object *obj);
22087    EAPI double elm_route_lat_max_get(Evas_Object *obj);
22088
22089
22090    /**
22091     * @defgroup Panel Panel
22092     *
22093     * @image html img/widget/panel/preview-00.png
22094     * @image latex img/widget/panel/preview-00.eps
22095     *
22096     * @brief A panel is a type of animated container that contains subobjects.
22097     * It can be expanded or contracted by clicking the button on it's edge.
22098     *
22099     * Orientations are as follows:
22100     * @li ELM_PANEL_ORIENT_TOP
22101     * @li ELM_PANEL_ORIENT_LEFT
22102     * @li ELM_PANEL_ORIENT_RIGHT
22103     *
22104     * @ref tutorial_panel shows one way to use this widget.
22105     * @{
22106     */
22107    typedef enum _Elm_Panel_Orient
22108      {
22109         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22110         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22111         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22112         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22113      } Elm_Panel_Orient;
22114    /**
22115     * @brief Adds a panel object
22116     *
22117     * @param parent The parent object
22118     *
22119     * @return The panel object, or NULL on failure
22120     */
22121    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22122    /**
22123     * @brief Sets the orientation of the panel
22124     *
22125     * @param parent The parent object
22126     * @param orient The panel orientation. Can be one of the following:
22127     * @li ELM_PANEL_ORIENT_TOP
22128     * @li ELM_PANEL_ORIENT_LEFT
22129     * @li ELM_PANEL_ORIENT_RIGHT
22130     *
22131     * Sets from where the panel will (dis)appear.
22132     */
22133    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22134    /**
22135     * @brief Get the orientation of the panel.
22136     *
22137     * @param obj The panel object
22138     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22139     */
22140    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22141    /**
22142     * @brief Set the content of the panel.
22143     *
22144     * @param obj The panel object
22145     * @param content The panel content
22146     *
22147     * Once the content object is set, a previously set one will be deleted.
22148     * If you want to keep that old content object, use the
22149     * elm_panel_content_unset() function.
22150     */
22151    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22152    /**
22153     * @brief Get the content of the panel.
22154     *
22155     * @param obj The panel object
22156     * @return The content that is being used
22157     *
22158     * Return the content object which is set for this widget.
22159     *
22160     * @see elm_panel_content_set()
22161     */
22162    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22163    /**
22164     * @brief Unset the content of the panel.
22165     *
22166     * @param obj The panel object
22167     * @return The content that was being used
22168     *
22169     * Unparent and return the content object which was set for this widget.
22170     *
22171     * @see elm_panel_content_set()
22172     */
22173    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22174    /**
22175     * @brief Set the state of the panel.
22176     *
22177     * @param obj The panel object
22178     * @param hidden If true, the panel will run the animation to contract
22179     */
22180    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22181    /**
22182     * @brief Get the state of the panel.
22183     *
22184     * @param obj The panel object
22185     * @param hidden If true, the panel is in the "hide" state
22186     */
22187    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22188    /**
22189     * @brief Toggle the hidden state of the panel from code
22190     *
22191     * @param obj The panel object
22192     */
22193    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22194    /**
22195     * @}
22196     */
22197
22198    /**
22199     * @defgroup Panes Panes
22200     * @ingroup Elementary
22201     *
22202     * @image html img/widget/panes/preview-00.png
22203     * @image latex img/widget/panes/preview-00.eps width=\textwidth
22204     *
22205     * @image html img/panes.png
22206     * @image latex img/panes.eps width=\textwidth
22207     *
22208     * The panes adds a dragable bar between two contents. When dragged
22209     * this bar will resize contents size.
22210     *
22211     * Panes can be displayed vertically or horizontally, and contents
22212     * size proportion can be customized (homogeneous by default).
22213     *
22214     * Smart callbacks one can listen to:
22215     * - "press" - The panes has been pressed (button wasn't released yet).
22216     * - "unpressed" - The panes was released after being pressed.
22217     * - "clicked" - The panes has been clicked>
22218     * - "clicked,double" - The panes has been double clicked
22219     *
22220     * Available styles for it:
22221     * - @c "default"
22222     *
22223     * Here is an example on its usage:
22224     * @li @ref panes_example
22225     */
22226
22227    /**
22228     * @addtogroup Panes
22229     * @{
22230     */
22231
22232    /**
22233     * Add a new panes widget to the given parent Elementary
22234     * (container) object.
22235     *
22236     * @param parent The parent object.
22237     * @return a new panes widget handle or @c NULL, on errors.
22238     *
22239     * This function inserts a new panes widget on the canvas.
22240     *
22241     * @ingroup Panes
22242     */
22243    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22244
22245    /**
22246     * Set the left content of the panes widget.
22247     *
22248     * @param obj The panes object.
22249     * @param content The new left content object.
22250     *
22251     * Once the content object is set, a previously set one will be deleted.
22252     * If you want to keep that old content object, use the
22253     * elm_panes_content_left_unset() function.
22254     *
22255     * If panes is displayed vertically, left content will be displayed at
22256     * top.
22257     *
22258     * @see elm_panes_content_left_get()
22259     * @see elm_panes_content_right_set() to set content on the other side.
22260     *
22261     * @ingroup Panes
22262     */
22263    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22264
22265    /**
22266     * Set the right content of the panes widget.
22267     *
22268     * @param obj The panes object.
22269     * @param content The new right content object.
22270     *
22271     * Once the content object is set, a previously set one will be deleted.
22272     * If you want to keep that old content object, use the
22273     * elm_panes_content_right_unset() function.
22274     *
22275     * If panes is displayed vertically, left content will be displayed at
22276     * bottom.
22277     *
22278     * @see elm_panes_content_right_get()
22279     * @see elm_panes_content_left_set() to set content on the other side.
22280     *
22281     * @ingroup Panes
22282     */
22283    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22284
22285    /**
22286     * Get the left content of the panes.
22287     *
22288     * @param obj The panes object.
22289     * @return The left content object that is being used.
22290     *
22291     * Return the left content object which is set for this widget.
22292     *
22293     * @see elm_panes_content_left_set() for details.
22294     *
22295     * @ingroup Panes
22296     */
22297    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22298
22299    /**
22300     * Get the right content of the panes.
22301     *
22302     * @param obj The panes object
22303     * @return The right content object that is being used
22304     *
22305     * Return the right content object which is set for this widget.
22306     *
22307     * @see elm_panes_content_right_set() for details.
22308     *
22309     * @ingroup Panes
22310     */
22311    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22312
22313    /**
22314     * Unset the left content used for the panes.
22315     *
22316     * @param obj The panes object.
22317     * @return The left content object that was being used.
22318     *
22319     * Unparent and return the left content object which was set for this widget.
22320     *
22321     * @see elm_panes_content_left_set() for details.
22322     * @see elm_panes_content_left_get().
22323     *
22324     * @ingroup Panes
22325     */
22326    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22327
22328    /**
22329     * Unset the right content used for the panes.
22330     *
22331     * @param obj The panes object.
22332     * @return The right content object that was being used.
22333     *
22334     * Unparent and return the right content object which was set for this
22335     * widget.
22336     *
22337     * @see elm_panes_content_right_set() for details.
22338     * @see elm_panes_content_right_get().
22339     *
22340     * @ingroup Panes
22341     */
22342    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22343
22344    /**
22345     * Get the size proportion of panes widget's left side.
22346     *
22347     * @param obj The panes object.
22348     * @return float value between 0.0 and 1.0 representing size proportion
22349     * of left side.
22350     *
22351     * @see elm_panes_content_left_size_set() for more details.
22352     *
22353     * @ingroup Panes
22354     */
22355    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22356
22357    /**
22358     * Set the size proportion of panes widget's left side.
22359     *
22360     * @param obj The panes object.
22361     * @param size Value between 0.0 and 1.0 representing size proportion
22362     * of left side.
22363     *
22364     * By default it's homogeneous, i.e., both sides have the same size.
22365     *
22366     * If something different is required, it can be set with this function.
22367     * For example, if the left content should be displayed over
22368     * 75% of the panes size, @p size should be passed as @c 0.75.
22369     * This way, right content will be resized to 25% of panes size.
22370     *
22371     * If displayed vertically, left content is displayed at top, and
22372     * right content at bottom.
22373     *
22374     * @note This proportion will change when user drags the panes bar.
22375     *
22376     * @see elm_panes_content_left_size_get()
22377     *
22378     * @ingroup Panes
22379     */
22380    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22381
22382   /**
22383    * Set the orientation of a given panes widget.
22384    *
22385    * @param obj The panes object.
22386    * @param horizontal Use @c EINA_TRUE to make @p obj to be
22387    * @b horizontal, @c EINA_FALSE to make it @b vertical.
22388    *
22389    * Use this function to change how your panes is to be
22390    * disposed: vertically or horizontally.
22391    *
22392    * By default it's displayed horizontally.
22393    *
22394    * @see elm_panes_horizontal_get()
22395    *
22396    * @ingroup Panes
22397    */
22398    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22399
22400    /**
22401     * Retrieve the orientation of a given panes widget.
22402     *
22403     * @param obj The panes object.
22404     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22405     * @c EINA_FALSE if it's @b vertical (and on errors).
22406     *
22407     * @see elm_panes_horizontal_set() for more details.
22408     *
22409     * @ingroup Panes
22410     */
22411    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22412
22413    /**
22414     * @}
22415     */
22416
22417    /**
22418     * @defgroup Flip Flip
22419     *
22420     * @image html img/widget/flip/preview-00.png
22421     * @image latex img/widget/flip/preview-00.eps
22422     *
22423     * This widget holds 2 content objects(Evas_Object): one on the front and one
22424     * on the back. It allows you to flip from front to back and vice-versa using
22425     * various animations.
22426     *
22427     * If either the front or back contents are not set the flip will treat that
22428     * as transparent. So if you wore to set the front content but not the back,
22429     * and then call elm_flip_go() you would see whatever is below the flip.
22430     *
22431     * For a list of supported animations see elm_flip_go().
22432     *
22433     * Signals that you can add callbacks for are:
22434     * "animate,begin" - when a flip animation was started
22435     * "animate,done" - when a flip animation is finished
22436     *
22437     * @ref tutorial_flip show how to use most of the API.
22438     *
22439     * @{
22440     */
22441    typedef enum _Elm_Flip_Mode
22442      {
22443         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22444         ELM_FLIP_ROTATE_X_CENTER_AXIS,
22445         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22446         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22447         ELM_FLIP_CUBE_LEFT,
22448         ELM_FLIP_CUBE_RIGHT,
22449         ELM_FLIP_CUBE_UP,
22450         ELM_FLIP_CUBE_DOWN,
22451         ELM_FLIP_PAGE_LEFT,
22452         ELM_FLIP_PAGE_RIGHT,
22453         ELM_FLIP_PAGE_UP,
22454         ELM_FLIP_PAGE_DOWN
22455      } Elm_Flip_Mode;
22456    typedef enum _Elm_Flip_Interaction
22457      {
22458         ELM_FLIP_INTERACTION_NONE,
22459         ELM_FLIP_INTERACTION_ROTATE,
22460         ELM_FLIP_INTERACTION_CUBE,
22461         ELM_FLIP_INTERACTION_PAGE
22462      } Elm_Flip_Interaction;
22463    typedef enum _Elm_Flip_Direction
22464      {
22465         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22466         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22467         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22468         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22469      } Elm_Flip_Direction;
22470    /**
22471     * @brief Add a new flip to the parent
22472     *
22473     * @param parent The parent object
22474     * @return The new object or NULL if it cannot be created
22475     */
22476    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22477    /**
22478     * @brief Set the front content of the flip widget.
22479     *
22480     * @param obj The flip object
22481     * @param content The new front content object
22482     *
22483     * Once the content object is set, a previously set one will be deleted.
22484     * If you want to keep that old content object, use the
22485     * elm_flip_content_front_unset() function.
22486     */
22487    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22488    /**
22489     * @brief Set the back content of the flip widget.
22490     *
22491     * @param obj The flip object
22492     * @param content The new back content object
22493     *
22494     * Once the content object is set, a previously set one will be deleted.
22495     * If you want to keep that old content object, use the
22496     * elm_flip_content_back_unset() function.
22497     */
22498    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22499    /**
22500     * @brief Get the front content used for the flip
22501     *
22502     * @param obj The flip object
22503     * @return The front content object that is being used
22504     *
22505     * Return the front content object which is set for this widget.
22506     */
22507    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22508    /**
22509     * @brief Get the back content used for the flip
22510     *
22511     * @param obj The flip object
22512     * @return The back content object that is being used
22513     *
22514     * Return the back content object which is set for this widget.
22515     */
22516    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22517    /**
22518     * @brief Unset the front content used for the flip
22519     *
22520     * @param obj The flip object
22521     * @return The front content object that was being used
22522     *
22523     * Unparent and return the front content object which was set for this widget.
22524     */
22525    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22526    /**
22527     * @brief Unset the back content used for the flip
22528     *
22529     * @param obj The flip object
22530     * @return The back content object that was being used
22531     *
22532     * Unparent and return the back content object which was set for this widget.
22533     */
22534    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22535    /**
22536     * @brief Get flip front visibility state
22537     *
22538     * @param obj The flip objct
22539     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22540     * showing.
22541     */
22542    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22543    /**
22544     * @brief Set flip perspective
22545     *
22546     * @param obj The flip object
22547     * @param foc The coordinate to set the focus on
22548     * @param x The X coordinate
22549     * @param y The Y coordinate
22550     *
22551     * @warning This function currently does nothing.
22552     */
22553    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22554    /**
22555     * @brief Runs the flip animation
22556     *
22557     * @param obj The flip object
22558     * @param mode The mode type
22559     *
22560     * Flips the front and back contents using the @p mode animation. This
22561     * efectively hides the currently visible content and shows the hidden one.
22562     *
22563     * There a number of possible animations to use for the flipping:
22564     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22565     * around a horizontal axis in the middle of its height, the other content
22566     * is shown as the other side of the flip.
22567     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22568     * around a vertical axis in the middle of its width, the other content is
22569     * shown as the other side of the flip.
22570     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22571     * around a diagonal axis in the middle of its width, the other content is
22572     * shown as the other side of the flip.
22573     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22574     * around a diagonal axis in the middle of its height, the other content is
22575     * shown as the other side of the flip.
22576     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22577     * as if the flip was a cube, the other content is show as the right face of
22578     * the cube.
22579     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22580     * right as if the flip was a cube, the other content is show as the left
22581     * face of the cube.
22582     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22583     * flip was a cube, the other content is show as the bottom face of the cube.
22584     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22585     * the flip was a cube, the other content is show as the upper face of the
22586     * cube.
22587     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22588     * if the flip was a book, the other content is shown as the page below that.
22589     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22590     * as if the flip was a book, the other content is shown as the page below
22591     * that.
22592     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22593     * flip was a book, the other content is shown as the page below that.
22594     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22595     * flip was a book, the other content is shown as the page below that.
22596     *
22597     * @image html elm_flip.png
22598     * @image latex elm_flip.eps width=\textwidth
22599     */
22600    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22601    /**
22602     * @brief Set the interactive flip mode
22603     *
22604     * @param obj The flip object
22605     * @param mode The interactive flip mode to use
22606     *
22607     * This sets if the flip should be interactive (allow user to click and
22608     * drag a side of the flip to reveal the back page and cause it to flip).
22609     * By default a flip is not interactive. You may also need to set which
22610     * sides of the flip are "active" for flipping and how much space they use
22611     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22612     * and elm_flip_interacton_direction_hitsize_set()
22613     *
22614     * The four avilable mode of interaction are:
22615     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22616     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22617     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22618     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22619     *
22620     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22621     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22622     * happen, those can only be acheived with elm_flip_go();
22623     */
22624    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22625    /**
22626     * @brief Get the interactive flip mode
22627     *
22628     * @param obj The flip object
22629     * @return The interactive flip mode
22630     *
22631     * Returns the interactive flip mode set by elm_flip_interaction_set()
22632     */
22633    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22634    /**
22635     * @brief Set which directions of the flip respond to interactive flip
22636     *
22637     * @param obj The flip object
22638     * @param dir The direction to change
22639     * @param enabled If that direction is enabled or not
22640     *
22641     * By default all directions are disabled, so you may want to enable the
22642     * desired directions for flipping if you need interactive flipping. You must
22643     * call this function once for each direction that should be enabled.
22644     *
22645     * @see elm_flip_interaction_set()
22646     */
22647    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22648    /**
22649     * @brief Get the enabled state of that flip direction
22650     *
22651     * @param obj The flip object
22652     * @param dir The direction to check
22653     * @return If that direction is enabled or not
22654     *
22655     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22656     *
22657     * @see elm_flip_interaction_set()
22658     */
22659    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22660    /**
22661     * @brief Set the amount of the flip that is sensitive to interactive flip
22662     *
22663     * @param obj The flip object
22664     * @param dir The direction to modify
22665     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22666     *
22667     * Set the amount of the flip that is sensitive to interactive flip, with 0
22668     * representing no area in the flip and 1 representing the entire flip. There
22669     * is however a consideration to be made in that the area will never be
22670     * smaller than the finger size set(as set in your Elementary configuration).
22671     *
22672     * @see elm_flip_interaction_set()
22673     */
22674    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22675    /**
22676     * @brief Get the amount of the flip that is sensitive to interactive flip
22677     *
22678     * @param obj The flip object
22679     * @param dir The direction to check
22680     * @return The size set for that direction
22681     *
22682     * Returns the amount os sensitive area set by
22683     * elm_flip_interacton_direction_hitsize_set().
22684     */
22685    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22686    /**
22687     * @}
22688     */
22689
22690    /* scrolledentry */
22691    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22692    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22693    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22694    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22695    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22696    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22697    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22698    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22699    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22700    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22701    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22702    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22703    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22704    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22705    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22706    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22707    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22708    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22709    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22710    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22711    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22712    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22713    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22714    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22715    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22716    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22717    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22718    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22719    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22720    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22721    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22722    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22723    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22724    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22725    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22726    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);
22727    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22728    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22729    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);
22730    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22731    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);
22732    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22733    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22734    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22735    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22736    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22737    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22738    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22739    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22740    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);
22741    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);
22742    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);
22743    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);
22744    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);
22745    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);
22746    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22747    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22748    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22749    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22750    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22751    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22752    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22753
22754    /**
22755     * @defgroup Conformant Conformant
22756     * @ingroup Elementary
22757     *
22758     * @image html img/widget/conformant/preview-00.png
22759     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22760     *
22761     * @image html img/conformant.png
22762     * @image latex img/conformant.eps width=\textwidth
22763     *
22764     * The aim is to provide a widget that can be used in elementary apps to
22765     * account for space taken up by the indicator, virtual keypad & softkey
22766     * windows when running the illume2 module of E17.
22767     *
22768     * So conformant content will be sized and positioned considering the
22769     * space required for such stuff, and when they popup, as a keyboard
22770     * shows when an entry is selected, conformant content won't change.
22771     *
22772     * Available styles for it:
22773     * - @c "default"
22774     *
22775     * See how to use this widget in this example:
22776     * @ref conformant_example
22777     */
22778
22779    /**
22780     * @addtogroup Conformant
22781     * @{
22782     */
22783
22784    /**
22785     * Add a new conformant widget to the given parent Elementary
22786     * (container) object.
22787     *
22788     * @param parent The parent object.
22789     * @return A new conformant widget handle or @c NULL, on errors.
22790     *
22791     * This function inserts a new conformant widget on the canvas.
22792     *
22793     * @ingroup Conformant
22794     */
22795    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22796
22797    /**
22798     * Set the content of the conformant widget.
22799     *
22800     * @param obj The conformant object.
22801     * @param content The content to be displayed by the conformant.
22802     *
22803     * Content will be sized and positioned considering the space required
22804     * to display a virtual keyboard. So it won't fill all the conformant
22805     * size. This way is possible to be sure that content won't resize
22806     * or be re-positioned after the keyboard is displayed.
22807     *
22808     * Once the content object is set, a previously set one will be deleted.
22809     * If you want to keep that old content object, use the
22810     * elm_conformat_content_unset() function.
22811     *
22812     * @see elm_conformant_content_unset()
22813     * @see elm_conformant_content_get()
22814     *
22815     * @ingroup Conformant
22816     */
22817    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22818
22819    /**
22820     * Get the content of the conformant widget.
22821     *
22822     * @param obj The conformant object.
22823     * @return The content that is being used.
22824     *
22825     * Return the content object which is set for this widget.
22826     * It won't be unparent from conformant. For that, use
22827     * elm_conformant_content_unset().
22828     *
22829     * @see elm_conformant_content_set() for more details.
22830     * @see elm_conformant_content_unset()
22831     *
22832     * @ingroup Conformant
22833     */
22834    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22835
22836    /**
22837     * Unset the content of the conformant widget.
22838     *
22839     * @param obj The conformant object.
22840     * @return The content that was being used.
22841     *
22842     * Unparent and return the content object which was set for this widget.
22843     *
22844     * @see elm_conformant_content_set() for more details.
22845     *
22846     * @ingroup Conformant
22847     */
22848    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22849
22850    /**
22851     * Returns the Evas_Object that represents the content area.
22852     *
22853     * @param obj The conformant object.
22854     * @return The content area of the widget.
22855     *
22856     * @ingroup Conformant
22857     */
22858    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22859
22860    /**
22861     * @}
22862     */
22863
22864    /**
22865     * @defgroup Mapbuf Mapbuf
22866     * @ingroup Elementary
22867     *
22868     * @image html img/widget/mapbuf/preview-00.png
22869     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22870     *
22871     * This holds one content object and uses an Evas Map of transformation
22872     * points to be later used with this content. So the content will be
22873     * moved, resized, etc as a single image. So it will improve performance
22874     * when you have a complex interafce, with a lot of elements, and will
22875     * need to resize or move it frequently (the content object and its
22876     * children).
22877     *
22878     * See how to use this widget in this example:
22879     * @ref mapbuf_example
22880     */
22881
22882    /**
22883     * @addtogroup Mapbuf
22884     * @{
22885     */
22886
22887    /**
22888     * Add a new mapbuf widget to the given parent Elementary
22889     * (container) object.
22890     *
22891     * @param parent The parent object.
22892     * @return A new mapbuf widget handle or @c NULL, on errors.
22893     *
22894     * This function inserts a new mapbuf widget on the canvas.
22895     *
22896     * @ingroup Mapbuf
22897     */
22898    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22899
22900    /**
22901     * Set the content of the mapbuf.
22902     *
22903     * @param obj The mapbuf object.
22904     * @param content The content that will be filled in this mapbuf object.
22905     *
22906     * Once the content object is set, a previously set one will be deleted.
22907     * If you want to keep that old content object, use the
22908     * elm_mapbuf_content_unset() function.
22909     *
22910     * To enable map, elm_mapbuf_enabled_set() should be used.
22911     *
22912     * @ingroup Mapbuf
22913     */
22914    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22915
22916    /**
22917     * Get the content of the mapbuf.
22918     *
22919     * @param obj The mapbuf object.
22920     * @return The content that is being used.
22921     *
22922     * Return the content object which is set for this widget.
22923     *
22924     * @see elm_mapbuf_content_set() for details.
22925     *
22926     * @ingroup Mapbuf
22927     */
22928    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22929
22930    /**
22931     * Unset the content of the mapbuf.
22932     *
22933     * @param obj The mapbuf object.
22934     * @return The content that was being used.
22935     *
22936     * Unparent and return the content object which was set for this widget.
22937     *
22938     * @see elm_mapbuf_content_set() for details.
22939     *
22940     * @ingroup Mapbuf
22941     */
22942    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22943
22944    /**
22945     * Enable or disable the map.
22946     *
22947     * @param obj The mapbuf object.
22948     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
22949     *
22950     * This enables the map that is set or disables it. On enable, the object
22951     * geometry will be saved, and the new geometry will change (position and
22952     * size) to reflect the map geometry set.
22953     *
22954     * Also, when enabled, alpha and smooth states will be used, so if the
22955     * content isn't solid, alpha should be enabled, for example, otherwise
22956     * a black retangle will fill the content.
22957     *
22958     * When disabled, the stored map will be freed and geometry prior to
22959     * enabling the map will be restored.
22960     *
22961     * It's disabled by default.
22962     *
22963     * @see elm_mapbuf_alpha_set()
22964     * @see elm_mapbuf_smooth_set()
22965     *
22966     * @ingroup Mapbuf
22967     */
22968    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22969
22970    /**
22971     * Get a value whether map is enabled or not.
22972     *
22973     * @param obj The mapbuf object.
22974     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
22975     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22976     *
22977     * @see elm_mapbuf_enabled_set() for details.
22978     *
22979     * @ingroup Mapbuf
22980     */
22981    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22982
22983    /**
22984     * Enable or disable smooth map rendering.
22985     *
22986     * @param obj The mapbuf object.
22987     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
22988     * to disable it.
22989     *
22990     * This sets smoothing for map rendering. If the object is a type that has
22991     * its own smoothing settings, then both the smooth settings for this object
22992     * and the map must be turned off.
22993     *
22994     * By default smooth maps are enabled.
22995     *
22996     * @ingroup Mapbuf
22997     */
22998    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
22999
23000    /**
23001     * Get a value whether smooth map rendering is enabled or not.
23002     *
23003     * @param obj The mapbuf object.
23004     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23005     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23006     *
23007     * @see elm_mapbuf_smooth_set() for details.
23008     *
23009     * @ingroup Mapbuf
23010     */
23011    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23012
23013    /**
23014     * Set or unset alpha flag for map rendering.
23015     *
23016     * @param obj The mapbuf object.
23017     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23018     * to disable it.
23019     *
23020     * This sets alpha flag for map rendering. If the object is a type that has
23021     * its own alpha settings, then this will take precedence. Only image objects
23022     * have this currently. It stops alpha blending of the map area, and is
23023     * useful if you know the object and/or all sub-objects is 100% solid.
23024     *
23025     * Alpha is enabled by default.
23026     *
23027     * @ingroup Mapbuf
23028     */
23029    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23030
23031    /**
23032     * Get a value whether alpha blending is enabled or not.
23033     *
23034     * @param obj The mapbuf object.
23035     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23036     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23037     *
23038     * @see elm_mapbuf_alpha_set() for details.
23039     *
23040     * @ingroup Mapbuf
23041     */
23042    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23043
23044    /**
23045     * @}
23046     */
23047
23048    /**
23049     * @defgroup Flipselector Flip Selector
23050     *
23051     * @image html img/widget/flipselector/preview-00.png
23052     * @image latex img/widget/flipselector/preview-00.eps
23053     *
23054     * A flip selector is a widget to show a set of @b text items, one
23055     * at a time, with the same sheet switching style as the @ref Clock
23056     * "clock" widget, when one changes the current displaying sheet
23057     * (thus, the "flip" in the name).
23058     *
23059     * User clicks to flip sheets which are @b held for some time will
23060     * make the flip selector to flip continuosly and automatically for
23061     * the user. The interval between flips will keep growing in time,
23062     * so that it helps the user to reach an item which is distant from
23063     * the current selection.
23064     *
23065     * Smart callbacks one can register to:
23066     * - @c "selected" - when the widget's selected text item is changed
23067     * - @c "overflowed" - when the widget's current selection is changed
23068     *   from the first item in its list to the last
23069     * - @c "underflowed" - when the widget's current selection is changed
23070     *   from the last item in its list to the first
23071     *
23072     * Available styles for it:
23073     * - @c "default"
23074     *
23075     * Here is an example on its usage:
23076     * @li @ref flipselector_example
23077     */
23078
23079    /**
23080     * @addtogroup Flipselector
23081     * @{
23082     */
23083
23084    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23085
23086    /**
23087     * Add a new flip selector widget to the given parent Elementary
23088     * (container) widget
23089     *
23090     * @param parent The parent object
23091     * @return a new flip selector widget handle or @c NULL, on errors
23092     *
23093     * This function inserts a new flip selector widget on the canvas.
23094     *
23095     * @ingroup Flipselector
23096     */
23097    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23098
23099    /**
23100     * Programmatically select the next item of a flip selector widget
23101     *
23102     * @param obj The flipselector object
23103     *
23104     * @note The selection will be animated. Also, if it reaches the
23105     * end of its list of member items, it will continue with the first
23106     * one onwards.
23107     *
23108     * @ingroup Flipselector
23109     */
23110    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23111
23112    /**
23113     * Programmatically select the previous item of a flip selector
23114     * widget
23115     *
23116     * @param obj The flipselector object
23117     *
23118     * @note The selection will be animated.  Also, if it reaches the
23119     * beginning of its list of member items, it will continue with the
23120     * last one backwards.
23121     *
23122     * @ingroup Flipselector
23123     */
23124    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23125
23126    /**
23127     * Append a (text) item to a flip selector widget
23128     *
23129     * @param obj The flipselector object
23130     * @param label The (text) label of the new item
23131     * @param func Convenience callback function to take place when
23132     * item is selected
23133     * @param data Data passed to @p func, above
23134     * @return A handle to the item added or @c NULL, on errors
23135     *
23136     * The widget's list of labels to show will be appended with the
23137     * given value. If the user wishes so, a callback function pointer
23138     * can be passed, which will get called when this same item is
23139     * selected.
23140     *
23141     * @note The current selection @b won't be modified by appending an
23142     * element to the list.
23143     *
23144     * @note The maximum length of the text label is going to be
23145     * determined <b>by the widget's theme</b>. Strings larger than
23146     * that value are going to be @b truncated.
23147     *
23148     * @ingroup Flipselector
23149     */
23150    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23151
23152    /**
23153     * Prepend a (text) item to a flip selector widget
23154     *
23155     * @param obj The flipselector object
23156     * @param label The (text) label of the new item
23157     * @param func Convenience callback function to take place when
23158     * item is selected
23159     * @param data Data passed to @p func, above
23160     * @return A handle to the item added or @c NULL, on errors
23161     *
23162     * The widget's list of labels to show will be prepended with the
23163     * given value. If the user wishes so, a callback function pointer
23164     * can be passed, which will get called when this same item is
23165     * selected.
23166     *
23167     * @note The current selection @b won't be modified by prepending
23168     * an element to the list.
23169     *
23170     * @note The maximum length of the text label is going to be
23171     * determined <b>by the widget's theme</b>. Strings larger than
23172     * that value are going to be @b truncated.
23173     *
23174     * @ingroup Flipselector
23175     */
23176    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23177
23178    /**
23179     * Get the internal list of items in a given flip selector widget.
23180     *
23181     * @param obj The flipselector object
23182     * @return The list of items (#Elm_Flipselector_Item as data) or
23183     * @c NULL on errors.
23184     *
23185     * This list is @b not to be modified in any way and must not be
23186     * freed. Use the list members with functions like
23187     * elm_flipselector_item_label_set(),
23188     * elm_flipselector_item_label_get(),
23189     * elm_flipselector_item_del(),
23190     * elm_flipselector_item_selected_get(),
23191     * elm_flipselector_item_selected_set().
23192     *
23193     * @warning This list is only valid until @p obj object's internal
23194     * items list is changed. It should be fetched again with another
23195     * call to this function when changes happen.
23196     *
23197     * @ingroup Flipselector
23198     */
23199    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23200
23201    /**
23202     * Get the first item in the given flip selector widget's list of
23203     * items.
23204     *
23205     * @param obj The flipselector object
23206     * @return The first item or @c NULL, if it has no items (and on
23207     * errors)
23208     *
23209     * @see elm_flipselector_item_append()
23210     * @see elm_flipselector_last_item_get()
23211     *
23212     * @ingroup Flipselector
23213     */
23214    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23215
23216    /**
23217     * Get the last item in the given flip selector widget's list of
23218     * items.
23219     *
23220     * @param obj The flipselector object
23221     * @return The last item or @c NULL, if it has no items (and on
23222     * errors)
23223     *
23224     * @see elm_flipselector_item_prepend()
23225     * @see elm_flipselector_first_item_get()
23226     *
23227     * @ingroup Flipselector
23228     */
23229    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23230
23231    /**
23232     * Get the currently selected item in a flip selector widget.
23233     *
23234     * @param obj The flipselector object
23235     * @return The selected item or @c NULL, if the widget has no items
23236     * (and on erros)
23237     *
23238     * @ingroup Flipselector
23239     */
23240    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23241
23242    /**
23243     * Set whether a given flip selector widget's item should be the
23244     * currently selected one.
23245     *
23246     * @param item The flip selector item
23247     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23248     *
23249     * This sets whether @p item is or not the selected (thus, under
23250     * display) one. If @p item is different than one under display,
23251     * the latter will be unselected. If the @p item is set to be
23252     * unselected, on the other hand, the @b first item in the widget's
23253     * internal members list will be the new selected one.
23254     *
23255     * @see elm_flipselector_item_selected_get()
23256     *
23257     * @ingroup Flipselector
23258     */
23259    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23260
23261    /**
23262     * Get whether a given flip selector widget's item is the currently
23263     * selected one.
23264     *
23265     * @param item The flip selector item
23266     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23267     * (or on errors).
23268     *
23269     * @see elm_flipselector_item_selected_set()
23270     *
23271     * @ingroup Flipselector
23272     */
23273    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23274
23275    /**
23276     * Delete a given item from a flip selector widget.
23277     *
23278     * @param item The item to delete
23279     *
23280     * @ingroup Flipselector
23281     */
23282    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23283
23284    /**
23285     * Get the label of a given flip selector widget's item.
23286     *
23287     * @param item The item to get label from
23288     * @return The text label of @p item or @c NULL, on errors
23289     *
23290     * @see elm_flipselector_item_label_set()
23291     *
23292     * @ingroup Flipselector
23293     */
23294    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23295
23296    /**
23297     * Set the label of a given flip selector widget's item.
23298     *
23299     * @param item The item to set label on
23300     * @param label The text label string, in UTF-8 encoding
23301     *
23302     * @see elm_flipselector_item_label_get()
23303     *
23304     * @ingroup Flipselector
23305     */
23306    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23307
23308    /**
23309     * Gets the item before @p item in a flip selector widget's
23310     * internal list of items.
23311     *
23312     * @param item The item to fetch previous from
23313     * @return The item before the @p item, in its parent's list. If
23314     *         there is no previous item for @p item or there's an
23315     *         error, @c NULL is returned.
23316     *
23317     * @see elm_flipselector_item_next_get()
23318     *
23319     * @ingroup Flipselector
23320     */
23321    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23322
23323    /**
23324     * Gets the item after @p item in a flip selector widget's
23325     * internal list of items.
23326     *
23327     * @param item The item to fetch next from
23328     * @return The item after the @p item, in its parent's list. If
23329     *         there is no next item for @p item or there's an
23330     *         error, @c NULL is returned.
23331     *
23332     * @see elm_flipselector_item_next_get()
23333     *
23334     * @ingroup Flipselector
23335     */
23336    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23337
23338    /**
23339     * Set the interval on time updates for an user mouse button hold
23340     * on a flip selector widget.
23341     *
23342     * @param obj The flip selector object
23343     * @param interval The (first) interval value in seconds
23344     *
23345     * This interval value is @b decreased while the user holds the
23346     * mouse pointer either flipping up or flipping doww a given flip
23347     * selector.
23348     *
23349     * This helps the user to get to a given item distant from the
23350     * current one easier/faster, as it will start to flip quicker and
23351     * quicker on mouse button holds.
23352     *
23353     * The calculation for the next flip interval value, starting from
23354     * the one set with this call, is the previous interval divided by
23355     * 1.05, so it decreases a little bit.
23356     *
23357     * The default starting interval value for automatic flips is
23358     * @b 0.85 seconds.
23359     *
23360     * @see elm_flipselector_interval_get()
23361     *
23362     * @ingroup Flipselector
23363     */
23364    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23365
23366    /**
23367     * Get the interval on time updates for an user mouse button hold
23368     * on a flip selector widget.
23369     *
23370     * @param obj The flip selector object
23371     * @return The (first) interval value, in seconds, set on it
23372     *
23373     * @see elm_flipselector_interval_set() for more details
23374     *
23375     * @ingroup Flipselector
23376     */
23377    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23378    /**
23379     * @}
23380     */
23381
23382    /**
23383     * @addtogroup Calendar
23384     * @{
23385     */
23386
23387    /**
23388     * @enum _Elm_Calendar_Mark_Repeat
23389     * @typedef Elm_Calendar_Mark_Repeat
23390     *
23391     * Event periodicity, used to define if a mark should be repeated
23392     * @b beyond event's day. It's set when a mark is added.
23393     *
23394     * So, for a mark added to 13th May with periodicity set to WEEKLY,
23395     * there will be marks every week after this date. Marks will be displayed
23396     * at 13th, 20th, 27th, 3rd June ...
23397     *
23398     * Values don't work as bitmask, only one can be choosen.
23399     *
23400     * @see elm_calendar_mark_add()
23401     *
23402     * @ingroup Calendar
23403     */
23404    typedef enum _Elm_Calendar_Mark_Repeat
23405      {
23406         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23407         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23408         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23409         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*/
23410         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. */
23411      } Elm_Calendar_Mark_Repeat;
23412
23413    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(). */
23414
23415    /**
23416     * Add a new calendar widget to the given parent Elementary
23417     * (container) object.
23418     *
23419     * @param parent The parent object.
23420     * @return a new calendar widget handle or @c NULL, on errors.
23421     *
23422     * This function inserts a new calendar widget on the canvas.
23423     *
23424     * @ref calendar_example_01
23425     *
23426     * @ingroup Calendar
23427     */
23428    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23429
23430    /**
23431     * Get weekdays names displayed by the calendar.
23432     *
23433     * @param obj The calendar object.
23434     * @return Array of seven strings to be used as weekday names.
23435     *
23436     * By default, weekdays abbreviations get from system are displayed:
23437     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23438     * The first string is related to Sunday, the second to Monday...
23439     *
23440     * @see elm_calendar_weekdays_name_set()
23441     *
23442     * @ref calendar_example_05
23443     *
23444     * @ingroup Calendar
23445     */
23446    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23447
23448    /**
23449     * Set weekdays names to be displayed by the calendar.
23450     *
23451     * @param obj The calendar object.
23452     * @param weekdays Array of seven strings to be used as weekday names.
23453     * @warning It must have 7 elements, or it will access invalid memory.
23454     * @warning The strings must be NULL terminated ('@\0').
23455     *
23456     * By default, weekdays abbreviations get from system are displayed:
23457     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23458     *
23459     * The first string should be related to Sunday, the second to Monday...
23460     *
23461     * The usage should be like this:
23462     * @code
23463     *   const char *weekdays[] =
23464     *   {
23465     *      "Sunday", "Monday", "Tuesday", "Wednesday",
23466     *      "Thursday", "Friday", "Saturday"
23467     *   };
23468     *   elm_calendar_weekdays_names_set(calendar, weekdays);
23469     * @endcode
23470     *
23471     * @see elm_calendar_weekdays_name_get()
23472     *
23473     * @ref calendar_example_02
23474     *
23475     * @ingroup Calendar
23476     */
23477    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23478
23479    /**
23480     * Set the minimum and maximum values for the year
23481     *
23482     * @param obj The calendar object
23483     * @param min The minimum year, greater than 1901;
23484     * @param max The maximum year;
23485     *
23486     * Maximum must be greater than minimum, except if you don't wan't to set
23487     * maximum year.
23488     * Default values are 1902 and -1.
23489     *
23490     * If the maximum year is a negative value, it will be limited depending
23491     * on the platform architecture (year 2037 for 32 bits);
23492     *
23493     * @see elm_calendar_min_max_year_get()
23494     *
23495     * @ref calendar_example_03
23496     *
23497     * @ingroup Calendar
23498     */
23499    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23500
23501    /**
23502     * Get the minimum and maximum values for the year
23503     *
23504     * @param obj The calendar object.
23505     * @param min The minimum year.
23506     * @param max The maximum year.
23507     *
23508     * Default values are 1902 and -1.
23509     *
23510     * @see elm_calendar_min_max_year_get() for more details.
23511     *
23512     * @ref calendar_example_05
23513     *
23514     * @ingroup Calendar
23515     */
23516    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23517
23518    /**
23519     * Enable or disable day selection
23520     *
23521     * @param obj The calendar object.
23522     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23523     * disable it.
23524     *
23525     * Enabled by default. If disabled, the user still can select months,
23526     * but not days. Selected days are highlighted on calendar.
23527     * It should be used if you won't need such selection for the widget usage.
23528     *
23529     * When a day is selected, or month is changed, smart callbacks for
23530     * signal "changed" will be called.
23531     *
23532     * @see elm_calendar_day_selection_enable_get()
23533     *
23534     * @ref calendar_example_04
23535     *
23536     * @ingroup Calendar
23537     */
23538    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23539
23540    /**
23541     * Get a value whether day selection is enabled or not.
23542     *
23543     * @see elm_calendar_day_selection_enable_set() for details.
23544     *
23545     * @param obj The calendar object.
23546     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23547     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23548     *
23549     * @ref calendar_example_05
23550     *
23551     * @ingroup Calendar
23552     */
23553    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23554
23555
23556    /**
23557     * Set selected date to be highlighted on calendar.
23558     *
23559     * @param obj The calendar object.
23560     * @param selected_time A @b tm struct to represent the selected date.
23561     *
23562     * Set the selected date, changing the displayed month if needed.
23563     * Selected date changes when the user goes to next/previous month or
23564     * select a day pressing over it on calendar.
23565     *
23566     * @see elm_calendar_selected_time_get()
23567     *
23568     * @ref calendar_example_04
23569     *
23570     * @ingroup Calendar
23571     */
23572    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23573
23574    /**
23575     * Get selected date.
23576     *
23577     * @param obj The calendar object
23578     * @param selected_time A @b tm struct to point to selected date
23579     * @return EINA_FALSE means an error ocurred and returned time shouldn't
23580     * be considered.
23581     *
23582     * Get date selected by the user or set by function
23583     * elm_calendar_selected_time_set().
23584     * Selected date changes when the user goes to next/previous month or
23585     * select a day pressing over it on calendar.
23586     *
23587     * @see elm_calendar_selected_time_get()
23588     *
23589     * @ref calendar_example_05
23590     *
23591     * @ingroup Calendar
23592     */
23593    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23594
23595    /**
23596     * Set a function to format the string that will be used to display
23597     * month and year;
23598     *
23599     * @param obj The calendar object
23600     * @param format_function Function to set the month-year string given
23601     * the selected date
23602     *
23603     * By default it uses strftime with "%B %Y" format string.
23604     * It should allocate the memory that will be used by the string,
23605     * that will be freed by the widget after usage.
23606     * A pointer to the string and a pointer to the time struct will be provided.
23607     *
23608     * Example:
23609     * @code
23610     * static char *
23611     * _format_month_year(struct tm *selected_time)
23612     * {
23613     *    char buf[32];
23614     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23615     *    return strdup(buf);
23616     * }
23617     *
23618     * elm_calendar_format_function_set(calendar, _format_month_year);
23619     * @endcode
23620     *
23621     * @ref calendar_example_02
23622     *
23623     * @ingroup Calendar
23624     */
23625    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23626
23627    /**
23628     * Add a new mark to the calendar
23629     *
23630     * @param obj The calendar object
23631     * @param mark_type A string used to define the type of mark. It will be
23632     * emitted to the theme, that should display a related modification on these
23633     * days representation.
23634     * @param mark_time A time struct to represent the date of inclusion of the
23635     * mark. For marks that repeats it will just be displayed after the inclusion
23636     * date in the calendar.
23637     * @param repeat Repeat the event following this periodicity. Can be a unique
23638     * mark (that don't repeat), daily, weekly, monthly or annually.
23639     * @return The created mark or @p NULL upon failure.
23640     *
23641     * Add a mark that will be drawn in the calendar respecting the insertion
23642     * time and periodicity. It will emit the type as signal to the widget theme.
23643     * Default theme supports "holiday" and "checked", but it can be extended.
23644     *
23645     * It won't immediately update the calendar, drawing the marks.
23646     * For this, call elm_calendar_marks_draw(). However, when user selects
23647     * next or previous month calendar forces marks drawn.
23648     *
23649     * Marks created with this method can be deleted with
23650     * elm_calendar_mark_del().
23651     *
23652     * Example
23653     * @code
23654     * struct tm selected_time;
23655     * time_t current_time;
23656     *
23657     * current_time = time(NULL) + 5 * 84600;
23658     * localtime_r(&current_time, &selected_time);
23659     * elm_calendar_mark_add(cal, "holiday", selected_time,
23660     *     ELM_CALENDAR_ANNUALLY);
23661     *
23662     * current_time = time(NULL) + 1 * 84600;
23663     * localtime_r(&current_time, &selected_time);
23664     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23665     *
23666     * elm_calendar_marks_draw(cal);
23667     * @endcode
23668     *
23669     * @see elm_calendar_marks_draw()
23670     * @see elm_calendar_mark_del()
23671     *
23672     * @ref calendar_example_06
23673     *
23674     * @ingroup Calendar
23675     */
23676    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);
23677
23678    /**
23679     * Delete mark from the calendar.
23680     *
23681     * @param mark The mark to be deleted.
23682     *
23683     * If deleting all calendar marks is required, elm_calendar_marks_clear()
23684     * should be used instead of getting marks list and deleting each one.
23685     *
23686     * @see elm_calendar_mark_add()
23687     *
23688     * @ref calendar_example_06
23689     *
23690     * @ingroup Calendar
23691     */
23692    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23693
23694    /**
23695     * Remove all calendar's marks
23696     *
23697     * @param obj The calendar object.
23698     *
23699     * @see elm_calendar_mark_add()
23700     * @see elm_calendar_mark_del()
23701     *
23702     * @ingroup Calendar
23703     */
23704    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23705
23706
23707    /**
23708     * Get a list of all the calendar marks.
23709     *
23710     * @param obj The calendar object.
23711     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23712     *
23713     * @see elm_calendar_mark_add()
23714     * @see elm_calendar_mark_del()
23715     * @see elm_calendar_marks_clear()
23716     *
23717     * @ingroup Calendar
23718     */
23719    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23720
23721    /**
23722     * Draw calendar marks.
23723     *
23724     * @param obj The calendar object.
23725     *
23726     * Should be used after adding, removing or clearing marks.
23727     * It will go through the entire marks list updating the calendar.
23728     * If lots of marks will be added, add all the marks and then call
23729     * this function.
23730     *
23731     * When the month is changed, i.e. user selects next or previous month,
23732     * marks will be drawed.
23733     *
23734     * @see elm_calendar_mark_add()
23735     * @see elm_calendar_mark_del()
23736     * @see elm_calendar_marks_clear()
23737     *
23738     * @ref calendar_example_06
23739     *
23740     * @ingroup Calendar
23741     */
23742    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23743
23744    /**
23745     * Set a day text color to the same that represents Saturdays.
23746     *
23747     * @param obj The calendar object.
23748     * @param pos The text position. Position is the cell counter, from left
23749     * to right, up to down. It starts on 0 and ends on 41.
23750     *
23751     * @deprecated use elm_calendar_mark_add() instead like:
23752     *
23753     * @code
23754     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23755     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23756     * @endcode
23757     *
23758     * @see elm_calendar_mark_add()
23759     *
23760     * @ingroup Calendar
23761     */
23762    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23763
23764    /**
23765     * Set a day text color to the same that represents Sundays.
23766     *
23767     * @param obj The calendar object.
23768     * @param pos The text position. Position is the cell counter, from left
23769     * to right, up to down. It starts on 0 and ends on 41.
23770
23771     * @deprecated use elm_calendar_mark_add() instead like:
23772     *
23773     * @code
23774     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23775     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23776     * @endcode
23777     *
23778     * @see elm_calendar_mark_add()
23779     *
23780     * @ingroup Calendar
23781     */
23782    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23783
23784    /**
23785     * Set a day text color to the same that represents Weekdays.
23786     *
23787     * @param obj The calendar object
23788     * @param pos The text position. Position is the cell counter, from left
23789     * to right, up to down. It starts on 0 and ends on 41.
23790     *
23791     * @deprecated use elm_calendar_mark_add() instead like:
23792     *
23793     * @code
23794     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23795     *
23796     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23797     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23798     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23799     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23800     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23801     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23802     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23803     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23804     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23805     * @endcode
23806     *
23807     * @see elm_calendar_mark_add()
23808     *
23809     * @ingroup Calendar
23810     */
23811    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23812
23813    /**
23814     * Set the interval on time updates for an user mouse button hold
23815     * on calendar widgets' month selection.
23816     *
23817     * @param obj The calendar object
23818     * @param interval The (first) interval value in seconds
23819     *
23820     * This interval value is @b decreased while the user holds the
23821     * mouse pointer either selecting next or previous month.
23822     *
23823     * This helps the user to get to a given month distant from the
23824     * current one easier/faster, as it will start to change quicker and
23825     * quicker on mouse button holds.
23826     *
23827     * The calculation for the next change interval value, starting from
23828     * the one set with this call, is the previous interval divided by
23829     * 1.05, so it decreases a little bit.
23830     *
23831     * The default starting interval value for automatic changes is
23832     * @b 0.85 seconds.
23833     *
23834     * @see elm_calendar_interval_get()
23835     *
23836     * @ingroup Calendar
23837     */
23838    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23839
23840    /**
23841     * Get the interval on time updates for an user mouse button hold
23842     * on calendar widgets' month selection.
23843     *
23844     * @param obj The calendar object
23845     * @return The (first) interval value, in seconds, set on it
23846     *
23847     * @see elm_calendar_interval_set() for more details
23848     *
23849     * @ingroup Calendar
23850     */
23851    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23852
23853    /**
23854     * @}
23855     */
23856
23857    /**
23858     * @defgroup Diskselector Diskselector
23859     * @ingroup Elementary
23860     *
23861     * @image html img/widget/diskselector/preview-00.png
23862     * @image latex img/widget/diskselector/preview-00.eps
23863     *
23864     * A diskselector is a kind of list widget. It scrolls horizontally,
23865     * and can contain label and icon objects. Three items are displayed
23866     * with the selected one in the middle.
23867     *
23868     * It can act like a circular list with round mode and labels can be
23869     * reduced for a defined length for side items.
23870     *
23871     * Smart callbacks one can listen to:
23872     * - "selected" - when item is selected, i.e. scroller stops.
23873     *
23874     * Available styles for it:
23875     * - @c "default"
23876     *
23877     * List of examples:
23878     * @li @ref diskselector_example_01
23879     * @li @ref diskselector_example_02
23880     */
23881
23882    /**
23883     * @addtogroup Diskselector
23884     * @{
23885     */
23886
23887    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(). */
23888
23889    /**
23890     * Add a new diskselector widget to the given parent Elementary
23891     * (container) object.
23892     *
23893     * @param parent The parent object.
23894     * @return a new diskselector widget handle or @c NULL, on errors.
23895     *
23896     * This function inserts a new diskselector widget on the canvas.
23897     *
23898     * @ingroup Diskselector
23899     */
23900    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23901
23902    /**
23903     * Enable or disable round mode.
23904     *
23905     * @param obj The diskselector object.
23906     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23907     * disable it.
23908     *
23909     * Disabled by default. If round mode is enabled the items list will
23910     * work like a circle list, so when the user reaches the last item,
23911     * the first one will popup.
23912     *
23913     * @see elm_diskselector_round_get()
23914     *
23915     * @ingroup Diskselector
23916     */
23917    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23918
23919    /**
23920     * Get a value whether round mode is enabled or not.
23921     *
23922     * @see elm_diskselector_round_set() for details.
23923     *
23924     * @param obj The diskselector object.
23925     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23926     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23927     *
23928     * @ingroup Diskselector
23929     */
23930    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23931
23932    /**
23933     * Get the side labels max length.
23934     *
23935     * @deprecated use elm_diskselector_side_label_length_get() instead:
23936     *
23937     * @param obj The diskselector object.
23938     * @return The max length defined for side labels, or 0 if not a valid
23939     * diskselector.
23940     *
23941     * @ingroup Diskselector
23942     */
23943    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23944
23945    /**
23946     * Set the side labels max length.
23947     *
23948     * @deprecated use elm_diskselector_side_label_length_set() instead:
23949     *
23950     * @param obj The diskselector object.
23951     * @param len The max length defined for side labels.
23952     *
23953     * @ingroup Diskselector
23954     */
23955    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23956
23957    /**
23958     * Get the side labels max length.
23959     *
23960     * @see elm_diskselector_side_label_length_set() for details.
23961     *
23962     * @param obj The diskselector object.
23963     * @return The max length defined for side labels, or 0 if not a valid
23964     * diskselector.
23965     *
23966     * @ingroup Diskselector
23967     */
23968    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23969
23970    /**
23971     * Set the side labels max length.
23972     *
23973     * @param obj The diskselector object.
23974     * @param len The max length defined for side labels.
23975     *
23976     * Length is the number of characters of items' label that will be
23977     * visible when it's set on side positions. It will just crop
23978     * the string after defined size. E.g.:
23979     *
23980     * An item with label "January" would be displayed on side position as
23981     * "Jan" if max length is set to 3, or "Janu", if this property
23982     * is set to 4.
23983     *
23984     * When it's selected, the entire label will be displayed, except for
23985     * width restrictions. In this case label will be cropped and "..."
23986     * will be concatenated.
23987     *
23988     * Default side label max length is 3.
23989     *
23990     * This property will be applyed over all items, included before or
23991     * later this function call.
23992     *
23993     * @ingroup Diskselector
23994     */
23995    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23996
23997    /**
23998     * Set the number of items to be displayed.
23999     *
24000     * @param obj The diskselector object.
24001     * @param num The number of items the diskselector will display.
24002     *
24003     * Default value is 3, and also it's the minimun. If @p num is less
24004     * than 3, it will be set to 3.
24005     *
24006     * Also, it can be set on theme, using data item @c display_item_num
24007     * on group "elm/diskselector/item/X", where X is style set.
24008     * E.g.:
24009     *
24010     * group { name: "elm/diskselector/item/X";
24011     * data {
24012     *     item: "display_item_num" "5";
24013     *     }
24014     *
24015     * @ingroup Diskselector
24016     */
24017    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24018
24019    /**
24020     * Set bouncing behaviour when the scrolled content reaches an edge.
24021     *
24022     * Tell the internal scroller object whether it should bounce or not
24023     * when it reaches the respective edges for each axis.
24024     *
24025     * @param obj The diskselector object.
24026     * @param h_bounce Whether to bounce or not in the horizontal axis.
24027     * @param v_bounce Whether to bounce or not in the vertical axis.
24028     *
24029     * @see elm_scroller_bounce_set()
24030     *
24031     * @ingroup Diskselector
24032     */
24033    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24034
24035    /**
24036     * Get the bouncing behaviour of the internal scroller.
24037     *
24038     * Get whether the internal scroller should bounce when the edge of each
24039     * axis is reached scrolling.
24040     *
24041     * @param obj The diskselector object.
24042     * @param h_bounce Pointer where to store the bounce state of the horizontal
24043     * axis.
24044     * @param v_bounce Pointer where to store the bounce state of the vertical
24045     * axis.
24046     *
24047     * @see elm_scroller_bounce_get()
24048     * @see elm_diskselector_bounce_set()
24049     *
24050     * @ingroup Diskselector
24051     */
24052    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24053
24054    /**
24055     * Get the scrollbar policy.
24056     *
24057     * @see elm_diskselector_scroller_policy_get() for details.
24058     *
24059     * @param obj The diskselector object.
24060     * @param policy_h Pointer where to store horizontal scrollbar policy.
24061     * @param policy_v Pointer where to store vertical scrollbar policy.
24062     *
24063     * @ingroup Diskselector
24064     */
24065    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);
24066
24067    /**
24068     * Set the scrollbar policy.
24069     *
24070     * @param obj The diskselector object.
24071     * @param policy_h Horizontal scrollbar policy.
24072     * @param policy_v Vertical scrollbar policy.
24073     *
24074     * This sets the scrollbar visibility policy for the given scroller.
24075     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
24076     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24077     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24078     * This applies respectively for the horizontal and vertical scrollbars.
24079     *
24080     * The both are disabled by default, i.e., are set to
24081     * #ELM_SCROLLER_POLICY_OFF.
24082     *
24083     * @ingroup Diskselector
24084     */
24085    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24086
24087    /**
24088     * Remove all diskselector's items.
24089     *
24090     * @param obj The diskselector object.
24091     *
24092     * @see elm_diskselector_item_del()
24093     * @see elm_diskselector_item_append()
24094     *
24095     * @ingroup Diskselector
24096     */
24097    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24098
24099    /**
24100     * Get a list of all the diskselector items.
24101     *
24102     * @param obj The diskselector object.
24103     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24104     * or @c NULL on failure.
24105     *
24106     * @see elm_diskselector_item_append()
24107     * @see elm_diskselector_item_del()
24108     * @see elm_diskselector_clear()
24109     *
24110     * @ingroup Diskselector
24111     */
24112    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24113
24114    /**
24115     * Appends a new item to the diskselector object.
24116     *
24117     * @param obj The diskselector object.
24118     * @param label The label of the diskselector item.
24119     * @param icon The icon object to use at left side of the item. An
24120     * icon can be any Evas object, but usually it is an icon created
24121     * with elm_icon_add().
24122     * @param func The function to call when the item is selected.
24123     * @param data The data to associate with the item for related callbacks.
24124     *
24125     * @return The created item or @c NULL upon failure.
24126     *
24127     * A new item will be created and appended to the diskselector, i.e., will
24128     * be set as last item. Also, if there is no selected item, it will
24129     * be selected. This will always happens for the first appended item.
24130     *
24131     * If no icon is set, label will be centered on item position, otherwise
24132     * the icon will be placed at left of the label, that will be shifted
24133     * to the right.
24134     *
24135     * Items created with this method can be deleted with
24136     * elm_diskselector_item_del().
24137     *
24138     * Associated @p data can be properly freed when item is deleted if a
24139     * callback function is set with elm_diskselector_item_del_cb_set().
24140     *
24141     * If a function is passed as argument, it will be called everytime this item
24142     * is selected, i.e., the user stops the diskselector with this
24143     * item on center position. If such function isn't needed, just passing
24144     * @c NULL as @p func is enough. The same should be done for @p data.
24145     *
24146     * Simple example (with no function callback or data associated):
24147     * @code
24148     * disk = elm_diskselector_add(win);
24149     * ic = elm_icon_add(win);
24150     * elm_icon_file_set(ic, "path/to/image", NULL);
24151     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24152     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24153     * @endcode
24154     *
24155     * @see elm_diskselector_item_del()
24156     * @see elm_diskselector_item_del_cb_set()
24157     * @see elm_diskselector_clear()
24158     * @see elm_icon_add()
24159     *
24160     * @ingroup Diskselector
24161     */
24162    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);
24163
24164
24165    /**
24166     * Delete them item from the diskselector.
24167     *
24168     * @param it The item of diskselector to be deleted.
24169     *
24170     * If deleting all diskselector items is required, elm_diskselector_clear()
24171     * should be used instead of getting items list and deleting each one.
24172     *
24173     * @see elm_diskselector_clear()
24174     * @see elm_diskselector_item_append()
24175     * @see elm_diskselector_item_del_cb_set()
24176     *
24177     * @ingroup Diskselector
24178     */
24179    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24180
24181    /**
24182     * Set the function called when a diskselector item is freed.
24183     *
24184     * @param it The item to set the callback on
24185     * @param func The function called
24186     *
24187     * If there is a @p func, then it will be called prior item's memory release.
24188     * That will be called with the following arguments:
24189     * @li item's data;
24190     * @li item's Evas object;
24191     * @li item itself;
24192     *
24193     * This way, a data associated to a diskselector item could be properly
24194     * freed.
24195     *
24196     * @ingroup Diskselector
24197     */
24198    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24199
24200    /**
24201     * Get the data associated to the item.
24202     *
24203     * @param it The diskselector item
24204     * @return The data associated to @p it
24205     *
24206     * The return value is a pointer to data associated to @p item when it was
24207     * created, with function elm_diskselector_item_append(). If no data
24208     * was passed as argument, it will return @c NULL.
24209     *
24210     * @see elm_diskselector_item_append()
24211     *
24212     * @ingroup Diskselector
24213     */
24214    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24215
24216    /**
24217     * Set the icon associated to the item.
24218     *
24219     * @param it The diskselector item
24220     * @param icon The icon object to associate with @p it
24221     *
24222     * The icon object to use at left side of the item. An
24223     * icon can be any Evas object, but usually it is an icon created
24224     * with elm_icon_add().
24225     *
24226     * Once the icon object is set, a previously set one will be deleted.
24227     * @warning Setting the same icon for two items will cause the icon to
24228     * dissapear from the first item.
24229     *
24230     * If an icon was passed as argument on item creation, with function
24231     * elm_diskselector_item_append(), it will be already
24232     * associated to the item.
24233     *
24234     * @see elm_diskselector_item_append()
24235     * @see elm_diskselector_item_icon_get()
24236     *
24237     * @ingroup Diskselector
24238     */
24239    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24240
24241    /**
24242     * Get the icon associated to the item.
24243     *
24244     * @param it The diskselector item
24245     * @return The icon associated to @p it
24246     *
24247     * The return value is a pointer to the icon associated to @p item when it was
24248     * created, with function elm_diskselector_item_append(), or later
24249     * with function elm_diskselector_item_icon_set. If no icon
24250     * was passed as argument, it will return @c NULL.
24251     *
24252     * @see elm_diskselector_item_append()
24253     * @see elm_diskselector_item_icon_set()
24254     *
24255     * @ingroup Diskselector
24256     */
24257    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24258
24259    /**
24260     * Set the label of item.
24261     *
24262     * @param it The item of diskselector.
24263     * @param label The label of item.
24264     *
24265     * The label to be displayed by the item.
24266     *
24267     * If no icon is set, label will be centered on item position, otherwise
24268     * the icon will be placed at left of the label, that will be shifted
24269     * to the right.
24270     *
24271     * An item with label "January" would be displayed on side position as
24272     * "Jan" if max length is set to 3 with function
24273     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24274     * is set to 4.
24275     *
24276     * When this @p item is selected, the entire label will be displayed,
24277     * except for width restrictions.
24278     * In this case label will be cropped and "..." will be concatenated,
24279     * but only for display purposes. It will keep the entire string, so
24280     * if diskselector is resized the remaining characters will be displayed.
24281     *
24282     * If a label was passed as argument on item creation, with function
24283     * elm_diskselector_item_append(), it will be already
24284     * displayed by the item.
24285     *
24286     * @see elm_diskselector_side_label_lenght_set()
24287     * @see elm_diskselector_item_label_get()
24288     * @see elm_diskselector_item_append()
24289     *
24290     * @ingroup Diskselector
24291     */
24292    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24293
24294    /**
24295     * Get the label of item.
24296     *
24297     * @param it The item of diskselector.
24298     * @return The label of item.
24299     *
24300     * The return value is a pointer to the label associated to @p item when it was
24301     * created, with function elm_diskselector_item_append(), or later
24302     * with function elm_diskselector_item_label_set. If no label
24303     * was passed as argument, it will return @c NULL.
24304     *
24305     * @see elm_diskselector_item_label_set() for more details.
24306     * @see elm_diskselector_item_append()
24307     *
24308     * @ingroup Diskselector
24309     */
24310    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24311
24312    /**
24313     * Get the selected item.
24314     *
24315     * @param obj The diskselector object.
24316     * @return The selected diskselector item.
24317     *
24318     * The selected item can be unselected with function
24319     * elm_diskselector_item_selected_set(), and the first item of
24320     * diskselector will be selected.
24321     *
24322     * The selected item always will be centered on diskselector, with
24323     * full label displayed, i.e., max lenght set to side labels won't
24324     * apply on the selected item. More details on
24325     * elm_diskselector_side_label_length_set().
24326     *
24327     * @ingroup Diskselector
24328     */
24329    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24330
24331    /**
24332     * Set the selected state of an item.
24333     *
24334     * @param it The diskselector item
24335     * @param selected The selected state
24336     *
24337     * This sets the selected state of the given item @p it.
24338     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24339     *
24340     * If a new item is selected the previosly selected will be unselected.
24341     * Previoulsy selected item can be get with function
24342     * elm_diskselector_selected_item_get().
24343     *
24344     * If the item @p it is unselected, the first item of diskselector will
24345     * be selected.
24346     *
24347     * Selected items will be visible on center position of diskselector.
24348     * So if it was on another position before selected, or was invisible,
24349     * diskselector will animate items until the selected item reaches center
24350     * position.
24351     *
24352     * @see elm_diskselector_item_selected_get()
24353     * @see elm_diskselector_selected_item_get()
24354     *
24355     * @ingroup Diskselector
24356     */
24357    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24358
24359    /*
24360     * Get whether the @p item is selected or not.
24361     *
24362     * @param it The diskselector item.
24363     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24364     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24365     *
24366     * @see elm_diskselector_selected_item_set() for details.
24367     * @see elm_diskselector_item_selected_get()
24368     *
24369     * @ingroup Diskselector
24370     */
24371    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24372
24373    /**
24374     * Get the first item of the diskselector.
24375     *
24376     * @param obj The diskselector object.
24377     * @return The first item, or @c NULL if none.
24378     *
24379     * The list of items follows append order. So it will return the first
24380     * item appended to the widget that wasn't deleted.
24381     *
24382     * @see elm_diskselector_item_append()
24383     * @see elm_diskselector_items_get()
24384     *
24385     * @ingroup Diskselector
24386     */
24387    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24388
24389    /**
24390     * Get the last item of the diskselector.
24391     *
24392     * @param obj The diskselector object.
24393     * @return The last item, or @c NULL if none.
24394     *
24395     * The list of items follows append order. So it will return last first
24396     * item appended to the widget that wasn't deleted.
24397     *
24398     * @see elm_diskselector_item_append()
24399     * @see elm_diskselector_items_get()
24400     *
24401     * @ingroup Diskselector
24402     */
24403    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24404
24405    /**
24406     * Get the item before @p item in diskselector.
24407     *
24408     * @param it The diskselector item.
24409     * @return The item before @p item, or @c NULL if none or on failure.
24410     *
24411     * The list of items follows append order. So it will return item appended
24412     * just before @p item and that wasn't deleted.
24413     *
24414     * If it is the first item, @c NULL will be returned.
24415     * First item can be get by elm_diskselector_first_item_get().
24416     *
24417     * @see elm_diskselector_item_append()
24418     * @see elm_diskselector_items_get()
24419     *
24420     * @ingroup Diskselector
24421     */
24422    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24423
24424    /**
24425     * Get the item after @p item in diskselector.
24426     *
24427     * @param it The diskselector item.
24428     * @return The item after @p item, or @c NULL if none or on failure.
24429     *
24430     * The list of items follows append order. So it will return item appended
24431     * just after @p item and that wasn't deleted.
24432     *
24433     * If it is the last item, @c NULL will be returned.
24434     * Last item can be get by elm_diskselector_last_item_get().
24435     *
24436     * @see elm_diskselector_item_append()
24437     * @see elm_diskselector_items_get()
24438     *
24439     * @ingroup Diskselector
24440     */
24441    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24442
24443    /**
24444     * Set the text to be shown in the diskselector item.
24445     *
24446     * @param item Target item
24447     * @param text The text to set in the content
24448     *
24449     * Setup the text as tooltip to object. The item can have only one tooltip,
24450     * so any previous tooltip data is removed.
24451     *
24452     * @see elm_object_tooltip_text_set() for more details.
24453     *
24454     * @ingroup Diskselector
24455     */
24456    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24457
24458    /**
24459     * Set the content to be shown in the tooltip item.
24460     *
24461     * Setup the tooltip to item. The item can have only one tooltip,
24462     * so any previous tooltip data is removed. @p func(with @p data) will
24463     * be called every time that need show the tooltip and it should
24464     * return a valid Evas_Object. This object is then managed fully by
24465     * tooltip system and is deleted when the tooltip is gone.
24466     *
24467     * @param item the diskselector item being attached a tooltip.
24468     * @param func the function used to create the tooltip contents.
24469     * @param data what to provide to @a func as callback data/context.
24470     * @param del_cb called when data is not needed anymore, either when
24471     *        another callback replaces @p func, the tooltip is unset with
24472     *        elm_diskselector_item_tooltip_unset() or the owner @a item
24473     *        dies. This callback receives as the first parameter the
24474     *        given @a data, and @c event_info is the item.
24475     *
24476     * @see elm_object_tooltip_content_cb_set() for more details.
24477     *
24478     * @ingroup Diskselector
24479     */
24480    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);
24481
24482    /**
24483     * Unset tooltip from item.
24484     *
24485     * @param item diskselector item to remove previously set tooltip.
24486     *
24487     * Remove tooltip from item. The callback provided as del_cb to
24488     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24489     * it is not used anymore.
24490     *
24491     * @see elm_object_tooltip_unset() for more details.
24492     * @see elm_diskselector_item_tooltip_content_cb_set()
24493     *
24494     * @ingroup Diskselector
24495     */
24496    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24497
24498
24499    /**
24500     * Sets a different style for this item tooltip.
24501     *
24502     * @note before you set a style you should define a tooltip with
24503     *       elm_diskselector_item_tooltip_content_cb_set() or
24504     *       elm_diskselector_item_tooltip_text_set()
24505     *
24506     * @param item diskselector item with tooltip already set.
24507     * @param style the theme style to use (default, transparent, ...)
24508     *
24509     * @see elm_object_tooltip_style_set() for more details.
24510     *
24511     * @ingroup Diskselector
24512     */
24513    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24514
24515    /**
24516     * Get the style for this item tooltip.
24517     *
24518     * @param item diskselector item with tooltip already set.
24519     * @return style the theme style in use, defaults to "default". If the
24520     *         object does not have a tooltip set, then NULL is returned.
24521     *
24522     * @see elm_object_tooltip_style_get() for more details.
24523     * @see elm_diskselector_item_tooltip_style_set()
24524     *
24525     * @ingroup Diskselector
24526     */
24527    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24528
24529    /**
24530     * Set the cursor to be shown when mouse is over the diskselector item
24531     *
24532     * @param item Target item
24533     * @param cursor the cursor name to be used.
24534     *
24535     * @see elm_object_cursor_set() for more details.
24536     *
24537     * @ingroup Diskselector
24538     */
24539    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24540
24541    /**
24542     * Get the cursor to be shown when mouse is over the diskselector item
24543     *
24544     * @param item diskselector item with cursor already set.
24545     * @return the cursor name.
24546     *
24547     * @see elm_object_cursor_get() for more details.
24548     * @see elm_diskselector_cursor_set()
24549     *
24550     * @ingroup Diskselector
24551     */
24552    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24553
24554
24555    /**
24556     * Unset the cursor to be shown when mouse is over the diskselector item
24557     *
24558     * @param item Target item
24559     *
24560     * @see elm_object_cursor_unset() for more details.
24561     * @see elm_diskselector_cursor_set()
24562     *
24563     * @ingroup Diskselector
24564     */
24565    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24566
24567    /**
24568     * Sets a different style for this item cursor.
24569     *
24570     * @note before you set a style you should define a cursor with
24571     *       elm_diskselector_item_cursor_set()
24572     *
24573     * @param item diskselector item with cursor already set.
24574     * @param style the theme style to use (default, transparent, ...)
24575     *
24576     * @see elm_object_cursor_style_set() for more details.
24577     *
24578     * @ingroup Diskselector
24579     */
24580    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24581
24582
24583    /**
24584     * Get the style for this item cursor.
24585     *
24586     * @param item diskselector item with cursor already set.
24587     * @return style the theme style in use, defaults to "default". If the
24588     *         object does not have a cursor set, then @c NULL is returned.
24589     *
24590     * @see elm_object_cursor_style_get() for more details.
24591     * @see elm_diskselector_item_cursor_style_set()
24592     *
24593     * @ingroup Diskselector
24594     */
24595    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24596
24597
24598    /**
24599     * Set if the cursor set should be searched on the theme or should use
24600     * the provided by the engine, only.
24601     *
24602     * @note before you set if should look on theme you should define a cursor
24603     * with elm_diskselector_item_cursor_set().
24604     * By default it will only look for cursors provided by the engine.
24605     *
24606     * @param item widget item with cursor already set.
24607     * @param engine_only boolean to define if cursors set with
24608     * elm_diskselector_item_cursor_set() should be searched only
24609     * between cursors provided by the engine or searched on widget's
24610     * theme as well.
24611     *
24612     * @see elm_object_cursor_engine_only_set() for more details.
24613     *
24614     * @ingroup Diskselector
24615     */
24616    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24617
24618    /**
24619     * Get the cursor engine only usage for this item cursor.
24620     *
24621     * @param item widget item with cursor already set.
24622     * @return engine_only boolean to define it cursors should be looked only
24623     * between the provided by the engine or searched on widget's theme as well.
24624     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24625     *
24626     * @see elm_object_cursor_engine_only_get() for more details.
24627     * @see elm_diskselector_item_cursor_engine_only_set()
24628     *
24629     * @ingroup Diskselector
24630     */
24631    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24632
24633    /**
24634     * @}
24635     */
24636
24637    /**
24638     * @defgroup Colorselector Colorselector
24639     *
24640     * @{
24641     *
24642     * @image html img/widget/colorselector/preview-00.png
24643     * @image latex img/widget/colorselector/preview-00.eps
24644     *
24645     * @brief Widget for user to select a color.
24646     *
24647     * Signals that you can add callbacks for are:
24648     * "changed" - When the color value changes(event_info is NULL).
24649     *
24650     * See @ref tutorial_colorselector.
24651     */
24652    /**
24653     * @brief Add a new colorselector to the parent
24654     *
24655     * @param parent The parent object
24656     * @return The new object or NULL if it cannot be created
24657     *
24658     * @ingroup Colorselector
24659     */
24660    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24661    /**
24662     * Set a color for the colorselector
24663     *
24664     * @param obj   Colorselector object
24665     * @param r     r-value of color
24666     * @param g     g-value of color
24667     * @param b     b-value of color
24668     * @param a     a-value of color
24669     *
24670     * @ingroup Colorselector
24671     */
24672    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24673    /**
24674     * Get a color from the colorselector
24675     *
24676     * @param obj   Colorselector object
24677     * @param r     integer pointer for r-value of color
24678     * @param g     integer pointer for g-value of color
24679     * @param b     integer pointer for b-value of color
24680     * @param a     integer pointer for a-value of color
24681     *
24682     * @ingroup Colorselector
24683     */
24684    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24685    /**
24686     * @}
24687     */
24688
24689    /**
24690     * @defgroup Ctxpopup Ctxpopup
24691     *
24692     * @image html img/widget/ctxpopup/preview-00.png
24693     * @image latex img/widget/ctxpopup/preview-00.eps
24694     *
24695     * @brief Context popup widet.
24696     *
24697     * A ctxpopup is a widget that, when shown, pops up a list of items.
24698     * It automatically chooses an area inside its parent object's view
24699     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24700     * optimally fit into it. In the default theme, it will also point an
24701     * arrow to it's top left position at the time one shows it. Ctxpopup
24702     * items have a label and/or an icon. It is intended for a small
24703     * number of items (hence the use of list, not genlist).
24704     *
24705     * @note Ctxpopup is a especialization of @ref Hover.
24706     *
24707     * Signals that you can add callbacks for are:
24708     * "dismissed" - the ctxpopup was dismissed
24709     *
24710     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24711     * @{
24712     */
24713    typedef enum _Elm_Ctxpopup_Direction
24714      {
24715         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24716                                           area */
24717         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24718                                            the clicked area */
24719         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24720                                           the clicked area */
24721         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24722                                         area */
24723      } Elm_Ctxpopup_Direction;
24724
24725    /**
24726     * @brief Add a new Ctxpopup object to the parent.
24727     *
24728     * @param parent Parent object
24729     * @return New object or @c NULL, if it cannot be created
24730     */
24731    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24732    /**
24733     * @brief Set the Ctxpopup's parent
24734     *
24735     * @param obj The ctxpopup object
24736     * @param area The parent to use
24737     *
24738     * Set the parent object.
24739     *
24740     * @note elm_ctxpopup_add() will automatically call this function
24741     * with its @c parent argument.
24742     *
24743     * @see elm_ctxpopup_add()
24744     * @see elm_hover_parent_set()
24745     */
24746    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24747    /**
24748     * @brief Get the Ctxpopup's parent
24749     *
24750     * @param obj The ctxpopup object
24751     *
24752     * @see elm_ctxpopup_hover_parent_set() for more information
24753     */
24754    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24755    /**
24756     * @brief Clear all items in the given ctxpopup object.
24757     *
24758     * @param obj Ctxpopup object
24759     */
24760    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24761    /**
24762     * @brief Change the ctxpopup's orientation to horizontal or vertical.
24763     *
24764     * @param obj Ctxpopup object
24765     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24766     */
24767    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24768    /**
24769     * @brief Get the value of current ctxpopup object's orientation.
24770     *
24771     * @param obj Ctxpopup object
24772     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24773     *
24774     * @see elm_ctxpopup_horizontal_set()
24775     */
24776    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24777    /**
24778     * @brief Add a new item to a ctxpopup object.
24779     *
24780     * @param obj Ctxpopup object
24781     * @param icon Icon to be set on new item
24782     * @param label The Label of the new item
24783     * @param func Convenience function called when item selected
24784     * @param data Data passed to @p func
24785     * @return A handle to the item added or @c NULL, on errors
24786     *
24787     * @warning Ctxpopup can't hold both an item list and a content at the same
24788     * time. When an item is added, any previous content will be removed.
24789     *
24790     * @see elm_ctxpopup_content_set()
24791     */
24792    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);
24793    /**
24794     * @brief Delete the given item in a ctxpopup object.
24795     *
24796     * @param it Ctxpopup item to be deleted
24797     *
24798     * @see elm_ctxpopup_item_append()
24799     */
24800    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24801    /**
24802     * @brief Set the ctxpopup item's state as disabled or enabled.
24803     *
24804     * @param it Ctxpopup item to be enabled/disabled
24805     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24806     *
24807     * When disabled the item is greyed out to indicate it's state.
24808     */
24809    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24810    /**
24811     * @brief Get the ctxpopup item's disabled/enabled state.
24812     *
24813     * @param it Ctxpopup item to be enabled/disabled
24814     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24815     *
24816     * @see elm_ctxpopup_item_disabled_set()
24817     */
24818    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24819    /**
24820     * @brief Get the icon object for the given ctxpopup item.
24821     *
24822     * @param it Ctxpopup item
24823     * @return icon object or @c NULL, if the item does not have icon or an error
24824     * occurred
24825     *
24826     * @see elm_ctxpopup_item_append()
24827     * @see elm_ctxpopup_item_icon_set()
24828     */
24829    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24830    /**
24831     * @brief Sets the side icon associated with the ctxpopup item
24832     *
24833     * @param it Ctxpopup item
24834     * @param icon Icon object to be set
24835     *
24836     * Once the icon object is set, a previously set one will be deleted.
24837     * @warning Setting the same icon for two items will cause the icon to
24838     * dissapear from the first item.
24839     *
24840     * @see elm_ctxpopup_item_append()
24841     */
24842    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24843    /**
24844     * @brief Get the label for the given ctxpopup item.
24845     *
24846     * @param it Ctxpopup item
24847     * @return label string or @c NULL, if the item does not have label or an
24848     * error occured
24849     *
24850     * @see elm_ctxpopup_item_append()
24851     * @see elm_ctxpopup_item_label_set()
24852     */
24853    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24854    /**
24855     * @brief (Re)set the label on the given ctxpopup item.
24856     *
24857     * @param it Ctxpopup item
24858     * @param label String to set as label
24859     */
24860    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24861    /**
24862     * @brief Set an elm widget as the content of the ctxpopup.
24863     *
24864     * @param obj Ctxpopup object
24865     * @param content Content to be swallowed
24866     *
24867     * If the content object is already set, a previous one will bedeleted. If
24868     * you want to keep that old content object, use the
24869     * elm_ctxpopup_content_unset() function.
24870     *
24871     * @deprecated use elm_object_content_set()
24872     *
24873     * @warning Ctxpopup can't hold both a item list and a content at the same
24874     * time. When a content is set, any previous items will be removed.
24875     */
24876    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24877    /**
24878     * @brief Unset the ctxpopup content
24879     *
24880     * @param obj Ctxpopup object
24881     * @return The content that was being used
24882     *
24883     * Unparent and return the content object which was set for this widget.
24884     *
24885     * @deprecated use elm_object_content_unset()
24886     *
24887     * @see elm_ctxpopup_content_set()
24888     */
24889    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24890    /**
24891     * @brief Set the direction priority of a ctxpopup.
24892     *
24893     * @param obj Ctxpopup object
24894     * @param first 1st priority of direction
24895     * @param second 2nd priority of direction
24896     * @param third 3th priority of direction
24897     * @param fourth 4th priority of direction
24898     *
24899     * This functions gives a chance to user to set the priority of ctxpopup
24900     * showing direction. This doesn't guarantee the ctxpopup will appear in the
24901     * requested direction.
24902     *
24903     * @see Elm_Ctxpopup_Direction
24904     */
24905    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);
24906    /**
24907     * @brief Get the direction priority of a ctxpopup.
24908     *
24909     * @param obj Ctxpopup object
24910     * @param first 1st priority of direction to be returned
24911     * @param second 2nd priority of direction to be returned
24912     * @param third 3th priority of direction to be returned
24913     * @param fourth 4th priority of direction to be returned
24914     *
24915     * @see elm_ctxpopup_direction_priority_set() for more information.
24916     */
24917    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);
24918    /**
24919     * @}
24920     */
24921
24922    /* transit */
24923    /**
24924     *
24925     * @defgroup Transit Transit
24926     * @ingroup Elementary
24927     *
24928     * Transit is designed to apply various animated transition effects to @c
24929     * Evas_Object, such like translation, rotation, etc. For using these
24930     * effects, create an @ref Elm_Transit and add the desired transition effects.
24931     *
24932     * Once the effects are added into transit, they will be automatically
24933     * managed (their callback will be called until the duration is ended, and
24934     * they will be deleted on completion).
24935     *
24936     * Example:
24937     * @code
24938     * Elm_Transit *trans = elm_transit_add();
24939     * elm_transit_object_add(trans, obj);
24940     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
24941     * elm_transit_duration_set(transit, 1);
24942     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
24943     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
24944     * elm_transit_repeat_times_set(transit, 3);
24945     * @endcode
24946     *
24947     * Some transition effects are used to change the properties of objects. They
24948     * are:
24949     * @li @ref elm_transit_effect_translation_add
24950     * @li @ref elm_transit_effect_color_add
24951     * @li @ref elm_transit_effect_rotation_add
24952     * @li @ref elm_transit_effect_wipe_add
24953     * @li @ref elm_transit_effect_zoom_add
24954     * @li @ref elm_transit_effect_resizing_add
24955     *
24956     * Other transition effects are used to make one object disappear and another
24957     * object appear on its old place. These effects are:
24958     *
24959     * @li @ref elm_transit_effect_flip_add
24960     * @li @ref elm_transit_effect_resizable_flip_add
24961     * @li @ref elm_transit_effect_fade_add
24962     * @li @ref elm_transit_effect_blend_add
24963     *
24964     * It's also possible to make a transition chain with @ref
24965     * elm_transit_chain_transit_add.
24966     *
24967     * @warning We strongly recommend to use elm_transit just when edje can not do
24968     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
24969     * animations can be manipulated inside the theme.
24970     *
24971     * List of examples:
24972     * @li @ref transit_example_01_explained
24973     * @li @ref transit_example_02_explained
24974     * @li @ref transit_example_03_c
24975     * @li @ref transit_example_04_c
24976     *
24977     * @{
24978     */
24979
24980    /**
24981     * @enum Elm_Transit_Tween_Mode
24982     *
24983     * The type of acceleration used in the transition.
24984     */
24985    typedef enum
24986      {
24987         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
24988         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
24989                                              over time, then decrease again
24990                                              and stop slowly */
24991         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
24992                                              speed over time */
24993         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
24994                                             over time */
24995      } Elm_Transit_Tween_Mode;
24996
24997    /**
24998     * @enum Elm_Transit_Effect_Flip_Axis
24999     *
25000     * The axis where flip effect should be applied.
25001     */
25002    typedef enum
25003      {
25004         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25005         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25006      } Elm_Transit_Effect_Flip_Axis;
25007    /**
25008     * @enum Elm_Transit_Effect_Wipe_Dir
25009     *
25010     * The direction where the wipe effect should occur.
25011     */
25012    typedef enum
25013      {
25014         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25015         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25016         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25017         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25018      } Elm_Transit_Effect_Wipe_Dir;
25019    /** @enum Elm_Transit_Effect_Wipe_Type
25020     *
25021     * Whether the wipe effect should show or hide the object.
25022     */
25023    typedef enum
25024      {
25025         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25026                                              animation */
25027         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25028                                             animation */
25029      } Elm_Transit_Effect_Wipe_Type;
25030
25031    /**
25032     * @typedef Elm_Transit
25033     *
25034     * The Transit created with elm_transit_add(). This type has the information
25035     * about the objects which the transition will be applied, and the
25036     * transition effects that will be used. It also contains info about
25037     * duration, number of repetitions, auto-reverse, etc.
25038     */
25039    typedef struct _Elm_Transit Elm_Transit;
25040    typedef void Elm_Transit_Effect;
25041    /**
25042     * @typedef Elm_Transit_Effect_Transition_Cb
25043     *
25044     * Transition callback called for this effect on each transition iteration.
25045     */
25046    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25047    /**
25048     * Elm_Transit_Effect_End_Cb
25049     *
25050     * Transition callback called for this effect when the transition is over.
25051     */
25052    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25053
25054    /**
25055     * Elm_Transit_Del_Cb
25056     *
25057     * A callback called when the transit is deleted.
25058     */
25059    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25060
25061    /**
25062     * Add new transit.
25063     *
25064     * @note Is not necessary to delete the transit object, it will be deleted at
25065     * the end of its operation.
25066     * @note The transit will start playing when the program enter in the main loop, is not
25067     * necessary to give a start to the transit.
25068     *
25069     * @return The transit object.
25070     *
25071     * @ingroup Transit
25072     */
25073    EAPI Elm_Transit                *elm_transit_add(void);
25074
25075    /**
25076     * Stops the animation and delete the @p transit object.
25077     *
25078     * Call this function if you wants to stop the animation before the duration
25079     * time. Make sure the @p transit object is still alive with
25080     * elm_transit_del_cb_set() function.
25081     * All added effects will be deleted, calling its repective data_free_cb
25082     * functions. The function setted by elm_transit_del_cb_set() will be called.
25083     *
25084     * @see elm_transit_del_cb_set()
25085     *
25086     * @param transit The transit object to be deleted.
25087     *
25088     * @ingroup Transit
25089     * @warning Just call this function if you are sure the transit is alive.
25090     */
25091    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25092
25093    /**
25094     * Add a new effect to the transit.
25095     *
25096     * @note The cb function and the data are the key to the effect. If you try to
25097     * add an already added effect, nothing is done.
25098     * @note After the first addition of an effect in @p transit, if its
25099     * effect list become empty again, the @p transit will be killed by
25100     * elm_transit_del(transit) function.
25101     *
25102     * Exemple:
25103     * @code
25104     * Elm_Transit *transit = elm_transit_add();
25105     * elm_transit_effect_add(transit,
25106     *                        elm_transit_effect_blend_op,
25107     *                        elm_transit_effect_blend_context_new(),
25108     *                        elm_transit_effect_blend_context_free);
25109     * @endcode
25110     *
25111     * @param transit The transit object.
25112     * @param transition_cb The operation function. It is called when the
25113     * animation begins, it is the function that actually performs the animation.
25114     * It is called with the @p data, @p transit and the time progression of the
25115     * animation (a double value between 0.0 and 1.0).
25116     * @param effect The context data of the effect.
25117     * @param end_cb The function to free the context data, it will be called
25118     * at the end of the effect, it must finalize the animation and free the
25119     * @p data.
25120     *
25121     * @ingroup Transit
25122     * @warning The transit free the context data at the and of the transition with
25123     * the data_free_cb function, do not use the context data in another transit.
25124     */
25125    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);
25126
25127    /**
25128     * Delete an added effect.
25129     *
25130     * This function will remove the effect from the @p transit, calling the
25131     * data_free_cb to free the @p data.
25132     *
25133     * @see elm_transit_effect_add()
25134     *
25135     * @note If the effect is not found, nothing is done.
25136     * @note If the effect list become empty, this function will call
25137     * elm_transit_del(transit), that is, it will kill the @p transit.
25138     *
25139     * @param transit The transit object.
25140     * @param transition_cb The operation function.
25141     * @param effect The context data of the effect.
25142     *
25143     * @ingroup Transit
25144     */
25145    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);
25146
25147    /**
25148     * Add new object to apply the effects.
25149     *
25150     * @note After the first addition of an object in @p transit, if its
25151     * object list become empty again, the @p transit will be killed by
25152     * elm_transit_del(transit) function.
25153     * @note If the @p obj belongs to another transit, the @p obj will be
25154     * removed from it and it will only belong to the @p transit. If the old
25155     * transit stays without objects, it will die.
25156     * @note When you add an object into the @p transit, its state from
25157     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25158     * transit ends, if you change this state whith evas_object_pass_events_set()
25159     * after add the object, this state will change again when @p transit stops to
25160     * run.
25161     *
25162     * @param transit The transit object.
25163     * @param obj Object to be animated.
25164     *
25165     * @ingroup Transit
25166     * @warning It is not allowed to add a new object after transit begins to go.
25167     */
25168    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25169
25170    /**
25171     * Removes an added object from the transit.
25172     *
25173     * @note If the @p obj is not in the @p transit, nothing is done.
25174     * @note If the list become empty, this function will call
25175     * elm_transit_del(transit), that is, it will kill the @p transit.
25176     *
25177     * @param transit The transit object.
25178     * @param obj Object to be removed from @p transit.
25179     *
25180     * @ingroup Transit
25181     * @warning It is not allowed to remove objects after transit begins to go.
25182     */
25183    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25184
25185    /**
25186     * Get the objects of the transit.
25187     *
25188     * @param transit The transit object.
25189     * @return a Eina_List with the objects from the transit.
25190     *
25191     * @ingroup Transit
25192     */
25193    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25194
25195    /**
25196     * Enable/disable keeping up the objects states.
25197     * If it is not kept, the objects states will be reset when transition ends.
25198     *
25199     * @note @p transit can not be NULL.
25200     * @note One state includes geometry, color, map data.
25201     *
25202     * @param transit The transit object.
25203     * @param state_keep Keeping or Non Keeping.
25204     *
25205     * @ingroup Transit
25206     */
25207    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25208
25209    /**
25210     * Get a value whether the objects states will be reset or not.
25211     *
25212     * @note @p transit can not be NULL
25213     *
25214     * @see elm_transit_objects_final_state_keep_set()
25215     *
25216     * @param transit The transit object.
25217     * @return EINA_TRUE means the states of the objects will be reset.
25218     * If @p transit is NULL, EINA_FALSE is returned
25219     *
25220     * @ingroup Transit
25221     */
25222    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25223
25224    /**
25225     * Set the event enabled when transit is operating.
25226     *
25227     * If @p enabled is EINA_TRUE, the objects of the transit will receives
25228     * events from mouse and keyboard during the animation.
25229     * @note When you add an object with elm_transit_object_add(), its state from
25230     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25231     * transit ends, if you change this state with evas_object_pass_events_set()
25232     * after adding the object, this state will change again when @p transit stops
25233     * to run.
25234     *
25235     * @param transit The transit object.
25236     * @param enabled Events are received when enabled is @c EINA_TRUE, and
25237     * ignored otherwise.
25238     *
25239     * @ingroup Transit
25240     */
25241    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25242
25243    /**
25244     * Get the value of event enabled status.
25245     *
25246     * @see elm_transit_event_enabled_set()
25247     *
25248     * @param transit The Transit object
25249     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25250     * EINA_FALSE is returned
25251     *
25252     * @ingroup Transit
25253     */
25254    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25255
25256    /**
25257     * Set the user-callback function when the transit is deleted.
25258     *
25259     * @note Using this function twice will overwrite the first function setted.
25260     * @note the @p transit object will be deleted after call @p cb function.
25261     *
25262     * @param transit The transit object.
25263     * @param cb Callback function pointer. This function will be called before
25264     * the deletion of the transit.
25265     * @param data Callback funtion user data. It is the @p op parameter.
25266     *
25267     * @ingroup Transit
25268     */
25269    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25270
25271    /**
25272     * Set reverse effect automatically.
25273     *
25274     * If auto reverse is setted, after running the effects with the progress
25275     * parameter from 0 to 1, it will call the effecs again with the progress
25276     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25277     * where the duration was setted with the function elm_transit_add and
25278     * the repeat with the function elm_transit_repeat_times_set().
25279     *
25280     * @param transit The transit object.
25281     * @param reverse EINA_TRUE means the auto_reverse is on.
25282     *
25283     * @ingroup Transit
25284     */
25285    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25286
25287    /**
25288     * Get if the auto reverse is on.
25289     *
25290     * @see elm_transit_auto_reverse_set()
25291     *
25292     * @param transit The transit object.
25293     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25294     * EINA_FALSE is returned
25295     *
25296     * @ingroup Transit
25297     */
25298    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25299
25300    /**
25301     * Set the transit repeat count. Effect will be repeated by repeat count.
25302     *
25303     * This function sets the number of repetition the transit will run after
25304     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25305     * If the @p repeat is a negative number, it will repeat infinite times.
25306     *
25307     * @note If this function is called during the transit execution, the transit
25308     * will run @p repeat times, ignoring the times it already performed.
25309     *
25310     * @param transit The transit object
25311     * @param repeat Repeat count
25312     *
25313     * @ingroup Transit
25314     */
25315    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25316
25317    /**
25318     * Get the transit repeat count.
25319     *
25320     * @see elm_transit_repeat_times_set()
25321     *
25322     * @param transit The Transit object.
25323     * @return The repeat count. If @p transit is NULL
25324     * 0 is returned
25325     *
25326     * @ingroup Transit
25327     */
25328    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25329
25330    /**
25331     * Set the transit animation acceleration type.
25332     *
25333     * This function sets the tween mode of the transit that can be:
25334     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25335     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25336     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25337     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25338     *
25339     * @param transit The transit object.
25340     * @param tween_mode The tween type.
25341     *
25342     * @ingroup Transit
25343     */
25344    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25345
25346    /**
25347     * Get the transit animation acceleration type.
25348     *
25349     * @note @p transit can not be NULL
25350     *
25351     * @param transit The transit object.
25352     * @return The tween type. If @p transit is NULL
25353     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25354     *
25355     * @ingroup Transit
25356     */
25357    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25358
25359    /**
25360     * Set the transit animation time
25361     *
25362     * @note @p transit can not be NULL
25363     *
25364     * @param transit The transit object.
25365     * @param duration The animation time.
25366     *
25367     * @ingroup Transit
25368     */
25369    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25370
25371    /**
25372     * Get the transit animation time
25373     *
25374     * @note @p transit can not be NULL
25375     *
25376     * @param transit The transit object.
25377     *
25378     * @return The transit animation time.
25379     *
25380     * @ingroup Transit
25381     */
25382    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25383
25384    /**
25385     * Starts the transition.
25386     * Once this API is called, the transit begins to measure the time.
25387     *
25388     * @note @p transit can not be NULL
25389     *
25390     * @param transit The transit object.
25391     *
25392     * @ingroup Transit
25393     */
25394    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25395
25396    /**
25397     * Pause/Resume the transition.
25398     *
25399     * If you call elm_transit_go again, the transit will be started from the
25400     * beginning, and will be unpaused.
25401     *
25402     * @note @p transit can not be NULL
25403     *
25404     * @param transit The transit object.
25405     * @param paused Whether the transition should be paused or not.
25406     *
25407     * @ingroup Transit
25408     */
25409    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25410
25411    /**
25412     * Get the value of paused status.
25413     *
25414     * @see elm_transit_paused_set()
25415     *
25416     * @note @p transit can not be NULL
25417     *
25418     * @param transit The transit object.
25419     * @return EINA_TRUE means transition is paused. If @p transit is NULL
25420     * EINA_FALSE is returned
25421     *
25422     * @ingroup Transit
25423     */
25424    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25425
25426    /**
25427     * Get the time progression of the animation (a double value between 0.0 and 1.0).
25428     *
25429     * The value returned is a fraction (current time / total time). It
25430     * represents the progression position relative to the total.
25431     *
25432     * @note @p transit can not be NULL
25433     *
25434     * @param transit The transit object.
25435     *
25436     * @return The time progression value. If @p transit is NULL
25437     * 0 is returned
25438     *
25439     * @ingroup Transit
25440     */
25441    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25442
25443    /**
25444     * Makes the chain relationship between two transits.
25445     *
25446     * @note @p transit can not be NULL. Transit would have multiple chain transits.
25447     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25448     *
25449     * @param transit The transit object.
25450     * @param chain_transit The chain transit object. This transit will be operated
25451     *        after transit is done.
25452     *
25453     * This function adds @p chain_transit transition to a chain after the @p
25454     * transit, and will be started as soon as @p transit ends. See @ref
25455     * transit_example_02_explained for a full example.
25456     *
25457     * @ingroup Transit
25458     */
25459    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25460
25461    /**
25462     * Cut off the chain relationship between two transits.
25463     *
25464     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25465     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25466     *
25467     * @param transit The transit object.
25468     * @param chain_transit The chain transit object.
25469     *
25470     * This function remove the @p chain_transit transition from the @p transit.
25471     *
25472     * @ingroup Transit
25473     */
25474    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25475
25476    /**
25477     * Get the current chain transit list.
25478     *
25479     * @note @p transit can not be NULL.
25480     *
25481     * @param transit The transit object.
25482     * @return chain transit list.
25483     *
25484     * @ingroup Transit
25485     */
25486    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
25487
25488    /**
25489     * Add the Resizing Effect to Elm_Transit.
25490     *
25491     * @note This API is one of the facades. It creates resizing effect context
25492     * and add it's required APIs to elm_transit_effect_add.
25493     *
25494     * @see elm_transit_effect_add()
25495     *
25496     * @param transit Transit object.
25497     * @param from_w Object width size when effect begins.
25498     * @param from_h Object height size when effect begins.
25499     * @param to_w Object width size when effect ends.
25500     * @param to_h Object height size when effect ends.
25501     * @return Resizing effect context data.
25502     *
25503     * @ingroup Transit
25504     */
25505    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);
25506
25507    /**
25508     * Add the Translation Effect to Elm_Transit.
25509     *
25510     * @note This API is one of the facades. It creates translation effect context
25511     * and add it's required APIs to elm_transit_effect_add.
25512     *
25513     * @see elm_transit_effect_add()
25514     *
25515     * @param transit Transit object.
25516     * @param from_dx X Position variation when effect begins.
25517     * @param from_dy Y Position variation when effect begins.
25518     * @param to_dx X Position variation when effect ends.
25519     * @param to_dy Y Position variation when effect ends.
25520     * @return Translation effect context data.
25521     *
25522     * @ingroup Transit
25523     * @warning It is highly recommended just create a transit with this effect when
25524     * the window that the objects of the transit belongs has already been created.
25525     * This is because this effect needs the geometry information about the objects,
25526     * and if the window was not created yet, it can get a wrong information.
25527     */
25528    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);
25529
25530    /**
25531     * Add the Zoom Effect to Elm_Transit.
25532     *
25533     * @note This API is one of the facades. It creates zoom effect context
25534     * and add it's required APIs to elm_transit_effect_add.
25535     *
25536     * @see elm_transit_effect_add()
25537     *
25538     * @param transit Transit object.
25539     * @param from_rate Scale rate when effect begins (1 is current rate).
25540     * @param to_rate Scale rate when effect ends.
25541     * @return Zoom effect context data.
25542     *
25543     * @ingroup Transit
25544     * @warning It is highly recommended just create a transit with this effect when
25545     * the window that the objects of the transit belongs has already been created.
25546     * This is because this effect needs the geometry information about the objects,
25547     * and if the window was not created yet, it can get a wrong information.
25548     */
25549    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25550
25551    /**
25552     * Add the Flip Effect to Elm_Transit.
25553     *
25554     * @note This API is one of the facades. It creates flip effect context
25555     * and add it's required APIs to elm_transit_effect_add.
25556     * @note This effect is applied to each pair of objects in the order they are listed
25557     * in the transit list of objects. The first object in the pair will be the
25558     * "front" object and the second will be the "back" object.
25559     *
25560     * @see elm_transit_effect_add()
25561     *
25562     * @param transit Transit object.
25563     * @param axis Flipping Axis(X or Y).
25564     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25565     * @return Flip effect context data.
25566     *
25567     * @ingroup Transit
25568     * @warning It is highly recommended just create a transit with this effect when
25569     * the window that the objects of the transit belongs has already been created.
25570     * This is because this effect needs the geometry information about the objects,
25571     * and if the window was not created yet, it can get a wrong information.
25572     */
25573    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25574
25575    /**
25576     * Add the Resizable Flip Effect to Elm_Transit.
25577     *
25578     * @note This API is one of the facades. It creates resizable flip effect context
25579     * and add it's required APIs to elm_transit_effect_add.
25580     * @note This effect is applied to each pair of objects in the order they are listed
25581     * in the transit list of objects. The first object in the pair will be the
25582     * "front" object and the second will be the "back" object.
25583     *
25584     * @see elm_transit_effect_add()
25585     *
25586     * @param transit Transit object.
25587     * @param axis Flipping Axis(X or Y).
25588     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25589     * @return Resizable flip effect context data.
25590     *
25591     * @ingroup Transit
25592     * @warning It is highly recommended just create a transit with this effect when
25593     * the window that the objects of the transit belongs has already been created.
25594     * This is because this effect needs the geometry information about the objects,
25595     * and if the window was not created yet, it can get a wrong information.
25596     */
25597    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25598
25599    /**
25600     * Add the Wipe Effect to Elm_Transit.
25601     *
25602     * @note This API is one of the facades. It creates wipe effect context
25603     * and add it's required APIs to elm_transit_effect_add.
25604     *
25605     * @see elm_transit_effect_add()
25606     *
25607     * @param transit Transit object.
25608     * @param type Wipe type. Hide or show.
25609     * @param dir Wipe Direction.
25610     * @return Wipe effect context data.
25611     *
25612     * @ingroup Transit
25613     * @warning It is highly recommended just create a transit with this effect when
25614     * the window that the objects of the transit belongs has already been created.
25615     * This is because this effect needs the geometry information about the objects,
25616     * and if the window was not created yet, it can get a wrong information.
25617     */
25618    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25619
25620    /**
25621     * Add the Color Effect to Elm_Transit.
25622     *
25623     * @note This API is one of the facades. It creates color effect context
25624     * and add it's required APIs to elm_transit_effect_add.
25625     *
25626     * @see elm_transit_effect_add()
25627     *
25628     * @param transit        Transit object.
25629     * @param  from_r        RGB R when effect begins.
25630     * @param  from_g        RGB G when effect begins.
25631     * @param  from_b        RGB B when effect begins.
25632     * @param  from_a        RGB A when effect begins.
25633     * @param  to_r          RGB R when effect ends.
25634     * @param  to_g          RGB G when effect ends.
25635     * @param  to_b          RGB B when effect ends.
25636     * @param  to_a          RGB A when effect ends.
25637     * @return               Color effect context data.
25638     *
25639     * @ingroup Transit
25640     */
25641    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);
25642
25643    /**
25644     * Add the Fade Effect to Elm_Transit.
25645     *
25646     * @note This API is one of the facades. It creates fade effect context
25647     * and add it's required APIs to elm_transit_effect_add.
25648     * @note This effect is applied to each pair of objects in the order they are listed
25649     * in the transit list of objects. The first object in the pair will be the
25650     * "before" object and the second will be the "after" object.
25651     *
25652     * @see elm_transit_effect_add()
25653     *
25654     * @param transit Transit object.
25655     * @return Fade effect context data.
25656     *
25657     * @ingroup Transit
25658     * @warning It is highly recommended just create a transit with this effect when
25659     * the window that the objects of the transit belongs has already been created.
25660     * This is because this effect needs the color information about the objects,
25661     * and if the window was not created yet, it can get a wrong information.
25662     */
25663    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25664
25665    /**
25666     * Add the Blend Effect to Elm_Transit.
25667     *
25668     * @note This API is one of the facades. It creates blend effect context
25669     * and add it's required APIs to elm_transit_effect_add.
25670     * @note This effect is applied to each pair of objects in the order they are listed
25671     * in the transit list of objects. The first object in the pair will be the
25672     * "before" object and the second will be the "after" object.
25673     *
25674     * @see elm_transit_effect_add()
25675     *
25676     * @param transit Transit object.
25677     * @return Blend effect context data.
25678     *
25679     * @ingroup Transit
25680     * @warning It is highly recommended just create a transit with this effect when
25681     * the window that the objects of the transit belongs has already been created.
25682     * This is because this effect needs the color information about the objects,
25683     * and if the window was not created yet, it can get a wrong information.
25684     */
25685    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25686
25687    /**
25688     * Add the Rotation Effect to Elm_Transit.
25689     *
25690     * @note This API is one of the facades. It creates rotation effect context
25691     * and add it's required APIs to elm_transit_effect_add.
25692     *
25693     * @see elm_transit_effect_add()
25694     *
25695     * @param transit Transit object.
25696     * @param from_degree Degree when effect begins.
25697     * @param to_degree Degree when effect is ends.
25698     * @return Rotation effect context data.
25699     *
25700     * @ingroup Transit
25701     * @warning It is highly recommended just create a transit with this effect when
25702     * the window that the objects of the transit belongs has already been created.
25703     * This is because this effect needs the geometry information about the objects,
25704     * and if the window was not created yet, it can get a wrong information.
25705     */
25706    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25707
25708    /**
25709     * Add the ImageAnimation Effect to Elm_Transit.
25710     *
25711     * @note This API is one of the facades. It creates image animation effect context
25712     * and add it's required APIs to elm_transit_effect_add.
25713     * The @p images parameter is a list images paths. This list and
25714     * its contents will be deleted at the end of the effect by
25715     * elm_transit_effect_image_animation_context_free() function.
25716     *
25717     * Example:
25718     * @code
25719     * char buf[PATH_MAX];
25720     * Eina_List *images = NULL;
25721     * Elm_Transit *transi = elm_transit_add();
25722     *
25723     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25724     * images = eina_list_append(images, eina_stringshare_add(buf));
25725     *
25726     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25727     * images = eina_list_append(images, eina_stringshare_add(buf));
25728     * elm_transit_effect_image_animation_add(transi, images);
25729     *
25730     * @endcode
25731     *
25732     * @see elm_transit_effect_add()
25733     *
25734     * @param transit Transit object.
25735     * @param images Eina_List of images file paths. This list and
25736     * its contents will be deleted at the end of the effect by
25737     * elm_transit_effect_image_animation_context_free() function.
25738     * @return Image Animation effect context data.
25739     *
25740     * @ingroup Transit
25741     */
25742    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25743    /**
25744     * @}
25745     */
25746
25747   typedef struct _Elm_Store                      Elm_Store;
25748   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
25749   typedef struct _Elm_Store_Item                 Elm_Store_Item;
25750   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
25751   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
25752   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25753   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
25754   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
25755   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
25756   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
25757   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
25758
25759   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25760   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25761   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25762   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25763
25764   typedef enum
25765     {
25766        ELM_STORE_ITEM_MAPPING_NONE = 0,
25767        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25768        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25769        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25770        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25771        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25772        // can add more here as needed by common apps
25773        ELM_STORE_ITEM_MAPPING_LAST
25774     } Elm_Store_Item_Mapping_Type;
25775
25776   struct _Elm_Store_Item_Mapping_Icon
25777     {
25778        // FIXME: allow edje file icons
25779        int                   w, h;
25780        Elm_Icon_Lookup_Order lookup_order;
25781        Eina_Bool             standard_name : 1;
25782        Eina_Bool             no_scale : 1;
25783        Eina_Bool             smooth : 1;
25784        Eina_Bool             scale_up : 1;
25785        Eina_Bool             scale_down : 1;
25786     };
25787
25788   struct _Elm_Store_Item_Mapping_Empty
25789     {
25790        Eina_Bool             dummy;
25791     };
25792
25793   struct _Elm_Store_Item_Mapping_Photo
25794     {
25795        int                   size;
25796     };
25797
25798   struct _Elm_Store_Item_Mapping_Custom
25799     {
25800        Elm_Store_Item_Mapping_Cb func;
25801     };
25802
25803   struct _Elm_Store_Item_Mapping
25804     {
25805        Elm_Store_Item_Mapping_Type     type;
25806        const char                     *part;
25807        int                             offset;
25808        union
25809          {
25810             Elm_Store_Item_Mapping_Empty  empty;
25811             Elm_Store_Item_Mapping_Icon   icon;
25812             Elm_Store_Item_Mapping_Photo  photo;
25813             Elm_Store_Item_Mapping_Custom custom;
25814             // add more types here
25815          } details;
25816     };
25817
25818   struct _Elm_Store_Item_Info
25819     {
25820       Elm_Genlist_Item_Class       *item_class;
25821       const Elm_Store_Item_Mapping *mapping;
25822       void                         *data;
25823       char                         *sort_id;
25824     };
25825
25826   struct _Elm_Store_Item_Info_Filesystem
25827     {
25828       Elm_Store_Item_Info  base;
25829       char                *path;
25830     };
25831
25832 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25833 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25834
25835   EAPI void                    elm_store_free(Elm_Store *st);
25836
25837   EAPI Elm_Store              *elm_store_filesystem_new(void);
25838   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25839   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25840   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25841
25842   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25843
25844   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25845   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25846   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25847   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25848   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25849   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25850
25851   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25852   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25853   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25854   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25855   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25856   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25857   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25858
25859    /**
25860     * @defgroup SegmentControl SegmentControl
25861     * @ingroup Elementary
25862     *
25863     * @image html img/widget/segment_control/preview-00.png
25864     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25865     *
25866     * @image html img/segment_control.png
25867     * @image latex img/segment_control.eps width=\textwidth
25868     *
25869     * Segment control widget is a horizontal control made of multiple segment
25870     * items, each segment item functioning similar to discrete two state button.
25871     * A segment control groups the items together and provides compact
25872     * single button with multiple equal size segments.
25873     *
25874     * Segment item size is determined by base widget
25875     * size and the number of items added.
25876     * Only one segment item can be at selected state. A segment item can display
25877     * combination of Text and any Evas_Object like Images or other widget.
25878     *
25879     * Smart callbacks one can listen to:
25880     * - "changed" - When the user clicks on a segment item which is not
25881     *   previously selected and get selected. The event_info parameter is the
25882     *   segment item index.
25883     *
25884     * Available styles for it:
25885     * - @c "default"
25886     *
25887     * Here is an example on its usage:
25888     * @li @ref segment_control_example
25889     */
25890
25891    /**
25892     * @addtogroup SegmentControl
25893     * @{
25894     */
25895
25896    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25897
25898    /**
25899     * Add a new segment control widget to the given parent Elementary
25900     * (container) object.
25901     *
25902     * @param parent The parent object.
25903     * @return a new segment control widget handle or @c NULL, on errors.
25904     *
25905     * This function inserts a new segment control widget on the canvas.
25906     *
25907     * @ingroup SegmentControl
25908     */
25909    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25910
25911    /**
25912     * Append a new item to the segment control object.
25913     *
25914     * @param obj The segment control object.
25915     * @param icon The icon object to use for the left side of the item. An
25916     * icon can be any Evas object, but usually it is an icon created
25917     * with elm_icon_add().
25918     * @param label The label of the item.
25919     *        Note that, NULL is different from empty string "".
25920     * @return The created item or @c NULL upon failure.
25921     *
25922     * A new item will be created and appended to the segment control, i.e., will
25923     * be set as @b last item.
25924     *
25925     * If it should be inserted at another position,
25926     * elm_segment_control_item_insert_at() should be used instead.
25927     *
25928     * Items created with this function can be deleted with function
25929     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25930     *
25931     * @note @p label set to @c NULL is different from empty string "".
25932     * If an item
25933     * only has icon, it will be displayed bigger and centered. If it has
25934     * icon and label, even that an empty string, icon will be smaller and
25935     * positioned at left.
25936     *
25937     * Simple example:
25938     * @code
25939     * sc = elm_segment_control_add(win);
25940     * ic = elm_icon_add(win);
25941     * elm_icon_file_set(ic, "path/to/image", NULL);
25942     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25943     * elm_segment_control_item_add(sc, ic, "label");
25944     * evas_object_show(sc);
25945     * @endcode
25946     *
25947     * @see elm_segment_control_item_insert_at()
25948     * @see elm_segment_control_item_del()
25949     *
25950     * @ingroup SegmentControl
25951     */
25952    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
25953
25954    /**
25955     * Insert a new item to the segment control object at specified position.
25956     *
25957     * @param obj The segment control object.
25958     * @param icon The icon object to use for the left side of the item. An
25959     * icon can be any Evas object, but usually it is an icon created
25960     * with elm_icon_add().
25961     * @param label The label of the item.
25962     * @param index Item position. Value should be between 0 and items count.
25963     * @return The created item or @c NULL upon failure.
25964
25965     * Index values must be between @c 0, when item will be prepended to
25966     * segment control, and items count, that can be get with
25967     * elm_segment_control_item_count_get(), case when item will be appended
25968     * to segment control, just like elm_segment_control_item_add().
25969     *
25970     * Items created with this function can be deleted with function
25971     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25972     *
25973     * @note @p label set to @c NULL is different from empty string "".
25974     * If an item
25975     * only has icon, it will be displayed bigger and centered. If it has
25976     * icon and label, even that an empty string, icon will be smaller and
25977     * positioned at left.
25978     *
25979     * @see elm_segment_control_item_add()
25980     * @see elm_segment_control_count_get()
25981     * @see elm_segment_control_item_del()
25982     *
25983     * @ingroup SegmentControl
25984     */
25985    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);
25986
25987    /**
25988     * Remove a segment control item from its parent, deleting it.
25989     *
25990     * @param it The item to be removed.
25991     *
25992     * Items can be added with elm_segment_control_item_add() or
25993     * elm_segment_control_item_insert_at().
25994     *
25995     * @ingroup SegmentControl
25996     */
25997    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25998
25999    /**
26000     * Remove a segment control item at given index from its parent,
26001     * deleting it.
26002     *
26003     * @param obj The segment control object.
26004     * @param index The position of the segment control item to be deleted.
26005     *
26006     * Items can be added with elm_segment_control_item_add() or
26007     * elm_segment_control_item_insert_at().
26008     *
26009     * @ingroup SegmentControl
26010     */
26011    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26012
26013    /**
26014     * Get the Segment items count from segment control.
26015     *
26016     * @param obj The segment control object.
26017     * @return Segment items count.
26018     *
26019     * It will just return the number of items added to segment control @p obj.
26020     *
26021     * @ingroup SegmentControl
26022     */
26023    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26024
26025    /**
26026     * Get the item placed at specified index.
26027     *
26028     * @param obj The segment control object.
26029     * @param index The index of the segment item.
26030     * @return The segment control item or @c NULL on failure.
26031     *
26032     * Index is the position of an item in segment control widget. Its
26033     * range is from @c 0 to <tt> count - 1 </tt>.
26034     * Count is the number of items, that can be get with
26035     * elm_segment_control_item_count_get().
26036     *
26037     * @ingroup SegmentControl
26038     */
26039    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26040
26041    /**
26042     * Get the label of item.
26043     *
26044     * @param obj The segment control object.
26045     * @param index The index of the segment item.
26046     * @return The label of the item at @p index.
26047     *
26048     * The return value is a pointer to the label associated to the item when
26049     * it was created, with function elm_segment_control_item_add(), or later
26050     * with function elm_segment_control_item_label_set. If no label
26051     * was passed as argument, it will return @c NULL.
26052     *
26053     * @see elm_segment_control_item_label_set() for more details.
26054     * @see elm_segment_control_item_add()
26055     *
26056     * @ingroup SegmentControl
26057     */
26058    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26059
26060    /**
26061     * Set the label of item.
26062     *
26063     * @param it The item of segment control.
26064     * @param text The label of item.
26065     *
26066     * The label to be displayed by the item.
26067     * Label will be at right of the icon (if set).
26068     *
26069     * If a label was passed as argument on item creation, with function
26070     * elm_control_segment_item_add(), it will be already
26071     * displayed by the item.
26072     *
26073     * @see elm_segment_control_item_label_get()
26074     * @see elm_segment_control_item_add()
26075     *
26076     * @ingroup SegmentControl
26077     */
26078    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26079
26080    /**
26081     * Get the icon associated to the item.
26082     *
26083     * @param obj The segment control object.
26084     * @param index The index of the segment item.
26085     * @return The left side icon associated to the item at @p index.
26086     *
26087     * The return value is a pointer to the icon associated to the item when
26088     * it was created, with function elm_segment_control_item_add(), or later
26089     * with function elm_segment_control_item_icon_set(). If no icon
26090     * was passed as argument, it will return @c NULL.
26091     *
26092     * @see elm_segment_control_item_add()
26093     * @see elm_segment_control_item_icon_set()
26094     *
26095     * @ingroup SegmentControl
26096     */
26097    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26098
26099    /**
26100     * Set the icon associated to the item.
26101     *
26102     * @param it The segment control item.
26103     * @param icon The icon object to associate with @p it.
26104     *
26105     * The icon object to use at left side of the item. An
26106     * icon can be any Evas object, but usually it is an icon created
26107     * with elm_icon_add().
26108     *
26109     * Once the icon object is set, a previously set one will be deleted.
26110     * @warning Setting the same icon for two items will cause the icon to
26111     * dissapear from the first item.
26112     *
26113     * If an icon was passed as argument on item creation, with function
26114     * elm_segment_control_item_add(), it will be already
26115     * associated to the item.
26116     *
26117     * @see elm_segment_control_item_add()
26118     * @see elm_segment_control_item_icon_get()
26119     *
26120     * @ingroup SegmentControl
26121     */
26122    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26123
26124    /**
26125     * Get the index of an item.
26126     *
26127     * @param it The segment control item.
26128     * @return The position of item in segment control widget.
26129     *
26130     * Index is the position of an item in segment control widget. Its
26131     * range is from @c 0 to <tt> count - 1 </tt>.
26132     * Count is the number of items, that can be get with
26133     * elm_segment_control_item_count_get().
26134     *
26135     * @ingroup SegmentControl
26136     */
26137    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26138
26139    /**
26140     * Get the base object of the item.
26141     *
26142     * @param it The segment control item.
26143     * @return The base object associated with @p it.
26144     *
26145     * Base object is the @c Evas_Object that represents that item.
26146     *
26147     * @ingroup SegmentControl
26148     */
26149    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26150
26151    /**
26152     * Get the selected item.
26153     *
26154     * @param obj The segment control object.
26155     * @return The selected item or @c NULL if none of segment items is
26156     * selected.
26157     *
26158     * The selected item can be unselected with function
26159     * elm_segment_control_item_selected_set().
26160     *
26161     * The selected item always will be highlighted on segment control.
26162     *
26163     * @ingroup SegmentControl
26164     */
26165    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26166
26167    /**
26168     * Set the selected state of an item.
26169     *
26170     * @param it The segment control item
26171     * @param select The selected state
26172     *
26173     * This sets the selected state of the given item @p it.
26174     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26175     *
26176     * If a new item is selected the previosly selected will be unselected.
26177     * Previoulsy selected item can be get with function
26178     * elm_segment_control_item_selected_get().
26179     *
26180     * The selected item always will be highlighted on segment control.
26181     *
26182     * @see elm_segment_control_item_selected_get()
26183     *
26184     * @ingroup SegmentControl
26185     */
26186    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26187
26188    /**
26189     * @}
26190     */
26191
26192    /**
26193     * @defgroup Grid Grid
26194     *
26195     * The grid is a grid layout widget that lays out a series of children as a
26196     * fixed "grid" of widgets using a given percentage of the grid width and
26197     * height each using the child object.
26198     *
26199     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26200     * widgets size itself. The default is 100 x 100, so that means the
26201     * position and sizes of children will effectively be percentages (0 to 100)
26202     * of the width or height of the grid widget
26203     *
26204     * @{
26205     */
26206
26207    /**
26208     * Add a new grid to the parent
26209     *
26210     * @param parent The parent object
26211     * @return The new object or NULL if it cannot be created
26212     *
26213     * @ingroup Grid
26214     */
26215    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26216
26217    /**
26218     * Set the virtual size of the grid
26219     *
26220     * @param obj The grid object
26221     * @param w The virtual width of the grid
26222     * @param h The virtual height of the grid
26223     *
26224     * @ingroup Grid
26225     */
26226    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
26227
26228    /**
26229     * Get the virtual size of the grid
26230     *
26231     * @param obj The grid object
26232     * @param w Pointer to integer to store the virtual width of the grid
26233     * @param h Pointer to integer to store the virtual height of the grid
26234     *
26235     * @ingroup Grid
26236     */
26237    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26238
26239    /**
26240     * Pack child at given position and size
26241     *
26242     * @param obj The grid object
26243     * @param subobj The child to pack
26244     * @param x The virtual x coord at which to pack it
26245     * @param y The virtual y coord at which to pack it
26246     * @param w The virtual width at which to pack it
26247     * @param h The virtual height at which to pack it
26248     *
26249     * @ingroup Grid
26250     */
26251    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26252
26253    /**
26254     * Unpack a child from a grid object
26255     *
26256     * @param obj The grid object
26257     * @param subobj The child to unpack
26258     *
26259     * @ingroup Grid
26260     */
26261    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26262
26263    /**
26264     * Faster way to remove all child objects from a grid object.
26265     *
26266     * @param obj The grid object
26267     * @param clear If true, it will delete just removed children
26268     *
26269     * @ingroup Grid
26270     */
26271    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26272
26273    /**
26274     * Set packing of an existing child at to position and size
26275     *
26276     * @param subobj The child to set packing of
26277     * @param x The virtual x coord at which to pack it
26278     * @param y The virtual y coord at which to pack it
26279     * @param w The virtual width at which to pack it
26280     * @param h The virtual height at which to pack it
26281     *
26282     * @ingroup Grid
26283     */
26284    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26285
26286    /**
26287     * get packing of a child
26288     *
26289     * @param subobj The child to query
26290     * @param x Pointer to integer to store the virtual x coord
26291     * @param y Pointer to integer to store the virtual y coord
26292     * @param w Pointer to integer to store the virtual width
26293     * @param h Pointer to integer to store the virtual height
26294     *
26295     * @ingroup Grid
26296     */
26297    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26298
26299    /**
26300     * @}
26301     */
26302
26303    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26304    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26305    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26306
26307    /**
26308     * @defgroup Video Video
26309     *
26310     * This object display an player that let you control an Elm_Video
26311     * object. It take care of updating it's content according to what is
26312     * going on inside the Emotion object. It does activate the remember
26313     * function on the linked Elm_Video object.
26314     *
26315     * Signals that you cann add callback for are :
26316     *
26317     * "forward,clicked" - the user clicked the forward button.
26318     * "info,clicked" - the user clicked the info button.
26319     * "next,clicked" - the user clicked the next button.
26320     * "pause,clicked" - the user clicked the pause button.
26321     * "play,clicked" - the user clicked the play button.
26322     * "prev,clicked" - the user clicked the prev button.
26323     * "rewind,clicked" - the user clicked the rewind button.
26324     * "stop,clicked" - the user clicked the stop button.
26325     */
26326    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26327    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26328    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26329    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26330    EAPI void elm_video_play(Evas_Object *video);
26331    EAPI void elm_video_pause(Evas_Object *video);
26332    EAPI void elm_video_stop(Evas_Object *video);
26333    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26334    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26335    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26336    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26337    EAPI double elm_video_audio_level_get(Evas_Object *video);
26338    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26339    EAPI double elm_video_play_position_get(Evas_Object *video);
26340    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26341    EAPI double elm_video_play_length_get(Evas_Object *video);
26342    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26343    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26344    EAPI const char *elm_video_title_get(Evas_Object *video);
26345
26346    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26347    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26348
26349   /* naviframe */
26350    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26351    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);
26352    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26353    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26354    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26355    EAPI void                elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26356    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26357    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26358    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26359    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26360    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26361    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26362    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26363    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26364    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26365
26366 #ifdef __cplusplus
26367 }
26368 #endif
26369
26370 #endif