[elementary] Clarification for a func's doc.
[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 buiuld it is there) you will need a
69  * configure.ac, Makefile.am and autogen.sh file.
70  *
71  * configure.ac:
72  *
73 @verbatim
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_PREREQ(2.52)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
78 AC_PROG_CC
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
81 AC_OUTPUT(Makefile)
82 @endverbatim
83  *
84  * Makefile.am:
85  *
86 @verbatim
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89
90 INCLUDES = -I$(top_srcdir)
91
92 bin_PROGRAMS = myapp
93
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
97 @endverbatim
98  *
99  * autogen.sh:
100  *
101 @verbatim
102 #!/bin/sh
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
107 ./configure "$@"
108 @endverbatim
109  *
110  * To generate all the things needed to bootstrap just run:
111  *
112 @verbatim
113 ./autogen.sh
114 @endverbatim
115  *
116  * This will generate Makefile.in's, the confgure script and everything else.
117  * After this it works like all normal autotools projects:
118 @verbatim
119 ./configure
120 make
121 sudo make install
122 @endverbatim
123  *
124  * Note sudo was assumed to get root permissions, as this would install in
125  * /usr/local which is system-owned. Use any way you like to gain root, or
126  * specify a different prefix with configure:
127  *
128 @verbatim
129 ./confiugre --prefix=$HOME/mysoftware
130 @endverbatim
131  *
132  * Also remember that autotools buys you some useful commands like:
133 @verbatim
134 make uninstall
135 @endverbatim
136  *
137  * This uninstalls the software after it was installed with "make install".
138  * It is very useful to clear up what you built if you wish to clean the
139  * system.
140  *
141 @verbatim
142 make distcheck
143 @endverbatim
144  *
145  * This firstly checks if your build tree is "clean" and ready for
146  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147  * ready to upload and distribute to the world, that contains the generated
148  * Makefile.in's and configure script. The users do not need to run
149  * autogen.sh - just configure and on. They don't need autotools installed.
150  * This tarball also builds cleanly, has all the sources it needs to build
151  * included (that is sources for your application, not libraries it depends
152  * on like Elementary). It builds cleanly in a buildroot and does not
153  * contain any files that are temporarily generated like binaries and other
154  * build-generated files, so the tarball is clean, and no need to worry
155  * about cleaning up your tree before packaging.
156  *
157 @verbatim
158 make clean
159 @endverbatim
160  *
161  * This cleans up all build files (binaries, objects etc.) from the tree.
162  *
163 @verbatim
164 make distclean
165 @endverbatim
166  *
167  * This cleans out all files from the build and from configure's output too.
168  *
169 @verbatim
170 make maintainer-clean
171 @endverbatim
172  *
173  * This deletes all the files autogen.sh will produce so the tree is clean
174  * to be put into a revision-control system (like CVS, SVN or GIT for example).
175  *
176  * There is a more advanced way of making use of the quicklaunch infrastructure
177  * in Elementary (which will not be covered here due to its more advanced
178  * nature).
179  * 
180  * Now let's actually create an interactive "Hello World" gui that you can
181  * click the ok button to exit. It's more code because this now does something
182  * much more significant, but it's still very simple:
183  *
184 @code
185 #include <Elementary.h>
186
187 static void
188 on_done(void *data, Evas_Object *obj, void *event_info)
189 {
190    // quit the mainloop (elm_run function will return)
191    elm_exit();
192 }
193
194 EAPI int
195 elm_main(int argc, char **argv)
196 {
197    Evas_Object *win, *bg, *box, *lab, *btn;
198    
199    // new window - do the usual and give it a name, title and delete handler
200    win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201    elm_win_title_set(win, "Hello");
202    // when the user clicks "close" on a window there is a request to delete
203    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
204    
205    // add a standard bg
206    bg = elm_bg_add(win);
207    // add object as a resize object for the window (controls window minimum
208    // size as well as gets resized if window is resized)
209    elm_win_resize_object_add(win, bg);
210    evas_object_show(bg);
211    
212    // add a box object - default is vertical. a box holds children in a row,
213    // either horizontally or vertically. nothing more.
214    box = elm_box_add(win);
215    // make the box hotizontal
216    elm_box_horizontal_set(box, EINA_TRUE);
217    // add object as a resize object for the window (controls window minimum
218    // size as well as gets resized if window is resized)
219    elm_win_resize_object_add(win, box);
220    evas_object_show(box);
221    
222    // add a label widget, set the text and put it in the pad frame
223    lab = elm_label_add(win);
224    // set default text of the label
225    elm_object_text_set(lab, "Hello out there world!");
226    // pack the label at the end of the box
227    elm_box_pack_end(box, lab);
228    evas_object_show(lab);
229    
230    // add an ok button
231    btn = elm_button_add(win);
232    // set default text of button to "OK"
233    elm_object_text_set(btn, "OK");
234    // pack the button at the end of the box
235    elm_box_pack_end(box, btn);
236    evas_object_show(btn);
237    // call on_done when button is clicked
238    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
239    
240    // now we are done, show the window
241    evas_object_show(win);
242    
243    // run the mainloop and process events and callbacks
244    elm_run();
245    return 0;
246 }
247 ELM_MAIN()
248 @endcode
249    * 
250    */
251
252 /**
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296
297 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
298 contact with the developers and maintainers.
299  */
300
301 #ifndef ELEMENTARY_H
302 #define ELEMENTARY_H
303
304 /**
305  * @file Elementary.h
306  * @brief Elementary's API
307  *
308  * Elementary API.
309  */
310
311 @ELM_UNIX_DEF@ ELM_UNIX
312 @ELM_WIN32_DEF@ ELM_WIN32
313 @ELM_WINCE_DEF@ ELM_WINCE
314 @ELM_EDBUS_DEF@ ELM_EDBUS
315 @ELM_EFREET_DEF@ ELM_EFREET
316 @ELM_ETHUMB_DEF@ ELM_ETHUMB
317 @ELM_EMAP_DEF@ ELM_EMAP
318 @ELM_DEBUG_DEF@ ELM_DEBUG
319 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
320 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
321
322 /* Standard headers for standard system calls etc. */
323 #include <stdio.h>
324 #include <stdlib.h>
325 #include <unistd.h>
326 #include <string.h>
327 #include <sys/types.h>
328 #include <sys/stat.h>
329 #include <sys/time.h>
330 #include <sys/param.h>
331 #include <dlfcn.h>
332 #include <math.h>
333 #include <fnmatch.h>
334 #include <limits.h>
335 #include <ctype.h>
336 #include <time.h>
337 #include <dirent.h>
338 #include <pwd.h>
339 #include <errno.h>
340
341 #ifdef ELM_UNIX
342 # include <locale.h>
343 # ifdef ELM_LIBINTL_H
344 #  include <libintl.h>
345 # endif
346 # include <signal.h>
347 # include <grp.h>
348 # include <glob.h>
349 #endif
350
351 #ifdef ELM_ALLOCA_H
352 # include <alloca.h>
353 #endif
354
355 #if defined (ELM_WIN32) || defined (ELM_WINCE)
356 # include <malloc.h>
357 # ifndef alloca
358 #  define alloca _alloca
359 # endif
360 #endif
361
362
363 /* EFL headers */
364 #include <Eina.h>
365 #include <Eet.h>
366 #include <Evas.h>
367 #include <Evas_GL.h>
368 #include <Ecore.h>
369 #include <Ecore_Evas.h>
370 #include <Ecore_File.h>
371 #include <Ecore_IMF.h>
372 #include <Ecore_Con.h>
373 #include <Edje.h>
374
375 #ifdef ELM_EDBUS
376 # include <E_DBus.h>
377 #endif
378
379 #ifdef ELM_EFREET
380 # include <Efreet.h>
381 # include <Efreet_Mime.h>
382 # include <Efreet_Trash.h>
383 #endif
384
385 #ifdef ELM_ETHUMB
386 # include <Ethumb_Client.h>
387 #endif
388
389 #ifdef ELM_EMAP
390 # include <EMap.h>
391 #endif
392
393 #ifdef EAPI
394 # undef EAPI
395 #endif
396
397 #ifdef _WIN32
398 # ifdef ELEMENTARY_BUILD
399 #  ifdef DLL_EXPORT
400 #   define EAPI __declspec(dllexport)
401 #  else
402 #   define EAPI
403 #  endif /* ! DLL_EXPORT */
404 # else
405 #  define EAPI __declspec(dllimport)
406 # endif /* ! EFL_EVAS_BUILD */
407 #else
408 # ifdef __GNUC__
409 #  if __GNUC__ >= 4
410 #   define EAPI __attribute__ ((visibility("default")))
411 #  else
412 #   define EAPI
413 #  endif
414 # else
415 #  define EAPI
416 # endif
417 #endif /* ! _WIN32 */
418
419
420 /* allow usage from c++ */
421 #ifdef __cplusplus
422 extern "C" {
423 #endif
424
425 #define ELM_VERSION_MAJOR @VMAJ@
426 #define ELM_VERSION_MINOR @VMIN@
427
428    typedef struct _Elm_Version
429      {
430         int major;
431         int minor;
432         int micro;
433         int revision;
434      } Elm_Version;
435
436    EAPI extern Elm_Version *elm_version;
437
438 /* handy macros */
439 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
440 #define ELM_PI 3.14159265358979323846
441
442    /**
443     * @defgroup General General
444     *
445     * @brief General Elementary API. Functions that don't relate to
446     * Elementary objects specifically.
447     *
448     * Here are documented functions which init/shutdown the library,
449     * that apply to generic Elementary objects, that deal with
450     * configuration, et cetera.
451     *
452     * @ref general_functions_example_page "This" example contemplates
453     * some of these functions.
454     */
455
456    /**
457     * @addtogroup General
458     * @{
459     */
460
461   /**
462    * Defines couple of standard Evas_Object layers to be used
463    * with evas_object_layer_set().
464    *
465    * @note whenever extending with new values, try to keep some padding
466    *       to siblings so there is room for further extensions.
467    */
468   typedef enum _Elm_Object_Layer
469     {
470        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
471        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
472        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
473        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
474        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
475        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
476     } Elm_Object_Layer;
477
478 /**************************************************************************/
479    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
480
481    /**
482     * Emitted when any Elementary's policy value is changed.
483     */
484    EAPI extern int ELM_EVENT_POLICY_CHANGED;
485
486    /**
487     * @typedef Elm_Event_Policy_Changed
488     *
489     * Data on the event when an Elementary policy has changed
490     */
491     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
492
493    /**
494     * @struct _Elm_Event_Policy_Changed
495     *
496     * Data on the event when an Elementary policy has changed
497     */
498     struct _Elm_Event_Policy_Changed
499      {
500         unsigned int policy; /**< the policy identifier */
501         int          new_value; /**< value the policy had before the change */
502         int          old_value; /**< new value the policy got */
503     };
504
505    /**
506     * Policy identifiers.
507     */
508     typedef enum _Elm_Policy
509     {
510         ELM_POLICY_QUIT, /**< under which circunstances the application
511                           * should quit automatically. @see
512                           * Elm_Policy_Quit.
513                           */
514         ELM_POLICY_LAST
515     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
516  */
517
518    typedef enum _Elm_Policy_Quit
519      {
520         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
521                                    * automatically */
522         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
523                                             * application's last
524                                             * window is closed */
525      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
526
527    typedef enum _Elm_Focus_Direction
528      {
529         ELM_FOCUS_PREVIOUS,
530         ELM_FOCUS_NEXT
531      } Elm_Focus_Direction;
532
533    typedef enum _Elm_Text_Format
534      {
535         ELM_TEXT_FORMAT_PLAIN_UTF8,
536         ELM_TEXT_FORMAT_MARKUP_UTF8
537      } Elm_Text_Format;
538
539    /**
540     * Line wrapping types.
541     */
542    typedef enum _Elm_Wrap_Type
543      {
544         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
545         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
546         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
547         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
548         ELM_WRAP_LAST
549      } Elm_Wrap_Type;
550
551    /**
552     * @typedef Elm_Object_Item
553     * An Elementary Object item handle.
554     * @ingroup General
555     */
556    typedef struct _Elm_Object_Item Elm_Object_Item;
557
558
559    /**
560     * Called back when a widget's tooltip is activated and needs content.
561     * @param data user-data given to elm_object_tooltip_content_cb_set()
562     * @param obj owner widget.
563     * @param tooltip The tooltip object (affix content to this!)
564     */
565    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
566
567    /**
568     * Called back when a widget's item tooltip is activated and needs content.
569     * @param data user-data given to elm_object_tooltip_content_cb_set()
570     * @param obj owner widget.
571     * @param tooltip The tooltip object (affix content to this!)
572     * @param item context dependent item. As an example, if tooltip was
573     *        set on Elm_List_Item, then it is of this type.
574     */
575    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
576
577    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
578
579 #ifndef ELM_LIB_QUICKLAUNCH
580 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
581 #else
582 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
583 #endif
584
585 /**************************************************************************/
586    /* General calls */
587
588    /**
589     * Initialize Elementary
590     *
591     * @param[in] argc System's argument count value
592     * @param[in] argv System's pointer to array of argument strings
593     * @return The init counter value.
594     *
595     * This function initializes Elementary and increments a counter of
596     * the number of calls to it. It returs the new counter's value.
597     *
598     * @warning This call is exported only for use by the @c ELM_MAIN()
599     * macro. There is no need to use this if you use this macro (which
600     * is highly advisable). An elm_main() should contain the entry
601     * point code for your application, having the same prototype as
602     * elm_init(), and @b not being static (putting the @c EAPI symbol
603     * in front of its type declaration is advisable). The @c
604     * ELM_MAIN() call should be placed just after it.
605     *
606     * Example:
607     * @dontinclude bg_example_01.c
608     * @skip static void
609     * @until ELM_MAIN
610     *
611     * See the full @ref bg_example_01_c "example".
612     *
613     * @see elm_shutdown().
614     * @ingroup General
615     */
616    EAPI int          elm_init(int argc, char **argv);
617
618    /**
619     * Shut down Elementary
620     *
621     * @return The init counter value.
622     *
623     * This should be called at the end of your application, just
624     * before it ceases to do any more processing. This will clean up
625     * any permanent resources your application may have allocated via
626     * Elementary that would otherwise persist.
627     *
628     * @see elm_init() for an example
629     *
630     * @ingroup General
631     */
632    EAPI int          elm_shutdown(void);
633
634    /**
635     * Run Elementary's main loop
636     *
637     * This call should be issued just after all initialization is
638     * completed. This function will not return until elm_exit() is
639     * called. It will keep looping, running the main
640     * (event/processing) loop for Elementary.
641     *
642     * @see elm_init() for an example
643     *
644     * @ingroup General
645     */
646    EAPI void         elm_run(void);
647
648    /**
649     * Exit Elementary's main loop
650     *
651     * If this call is issued, it will flag the main loop to cease
652     * processing and return back to its parent function (usually your
653     * elm_main() function).
654     *
655     * @see elm_init() for an example. There, just after a request to
656     * close the window comes, the main loop will be left.
657     *
658     * @note By using the #ELM_POLICY_QUIT on your Elementary
659     * applications, you'll this function called automatically for you.
660     *
661     * @ingroup General
662     */
663    EAPI void         elm_exit(void);
664
665    /**
666     * Provide information in order to make Elementary determine the @b
667     * run time location of the software in question, so other data files
668     * such as images, sound files, executable utilities, libraries,
669     * modules and locale files can be found.
670     *
671     * @param mainfunc This is your application's main function name,
672     *        whose binary's location is to be found. Providing @c NULL
673     *        will make Elementary not to use it
674     * @param dom This will be used as the application's "domain", in the
675     *        form of a prefix to any environment variables that may
676     *        override prefix detection and the directory name, inside the
677     *        standard share or data directories, where the software's
678     *        data files will be looked for.
679     * @param checkfile This is an (optional) magic file's path to check
680     *        for existence (and it must be located in the data directory,
681     *        under the share directory provided above). Its presence will
682     *        help determine the prefix found was correct. Pass @c NULL if
683     *        the check is not to be done.
684     *
685     * This function allows one to re-locate the application somewhere
686     * else after compilation, if the developer wishes for easier
687     * distribution of pre-compiled binaries.
688     *
689     * The prefix system is designed to locate where the given software is
690     * installed (under a common path prefix) at run time and then report
691     * specific locations of this prefix and common directories inside
692     * this prefix like the binary, library, data and locale directories,
693     * through the @c elm_app_*_get() family of functions.
694     *
695     * Call elm_app_info_set() early on before you change working
696     * directory or anything about @c argv[0], so it gets accurate
697     * information.
698     *
699     * It will then try and trace back which file @p mainfunc comes from,
700     * if provided, to determine the application's prefix directory.
701     *
702     * The @p dom parameter provides a string prefix to prepend before
703     * environment variables, allowing a fallback to @b specific
704     * environment variables to locate the software. You would most
705     * probably provide a lowercase string there, because it will also
706     * serve as directory domain, explained next. For environment
707     * variables purposes, this string is made uppercase. For example if
708     * @c "myapp" is provided as the prefix, then the program would expect
709     * @c "MYAPP_PREFIX" as a master environment variable to specify the
710     * exact install prefix for the software, or more specific environment
711     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
712     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
713     * the user or scripts before launching. If not provided (@c NULL),
714     * environment variables will not be used to override compiled-in
715     * defaults or auto detections.
716     *
717     * The @p dom string also provides a subdirectory inside the system
718     * shared data directory for data files. For example, if the system
719     * directory is @c /usr/local/share, then this directory name is
720     * appended, creating @c /usr/local/share/myapp, if it @p was @c
721     * "myapp". It is expected the application installs data files in
722     * this directory.
723     *
724     * The @p checkfile is a file name or path of something inside the
725     * share or data directory to be used to test that the prefix
726     * detection worked. For example, your app will install a wallpaper
727     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
728     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
729     * checkfile string.
730     *
731     * @see elm_app_compile_bin_dir_set()
732     * @see elm_app_compile_lib_dir_set()
733     * @see elm_app_compile_data_dir_set()
734     * @see elm_app_compile_locale_set()
735     * @see elm_app_prefix_dir_get()
736     * @see elm_app_bin_dir_get()
737     * @see elm_app_lib_dir_get()
738     * @see elm_app_data_dir_get()
739     * @see elm_app_locale_dir_get()
740     */
741    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
742
743    /**
744     * Provide information on the @b fallback application's binaries
745     * directory, on scenarios where they get overriden by
746     * elm_app_info_set().
747     *
748     * @param dir The path to the default binaries directory (compile time
749     * one)
750     *
751     * @note Elementary will as well use this path to determine actual
752     * names of binaries' directory paths, maybe changing it to be @c
753     * something/local/bin instead of @c something/bin, only, for
754     * example.
755     *
756     * @warning You should call this function @b before
757     * elm_app_info_set().
758     */
759    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
760
761    /**
762     * Provide information on the @b fallback application's libraries
763     * directory, on scenarios where they get overriden by
764     * elm_app_info_set().
765     *
766     * @param dir The path to the default libraries directory (compile
767     * time one)
768     *
769     * @note Elementary will as well use this path to determine actual
770     * names of libraries' directory paths, maybe changing it to be @c
771     * something/lib32 or @c something/lib64 instead of @c something/lib,
772     * only, for example.
773     *
774     * @warning You should call this function @b before
775     * elm_app_info_set().
776     */
777    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
778
779    /**
780     * Provide information on the @b fallback application's data
781     * directory, on scenarios where they get overriden by
782     * elm_app_info_set().
783     *
784     * @param dir The path to the default data directory (compile time
785     * one)
786     *
787     * @note Elementary will as well use this path to determine actual
788     * names of data directory paths, maybe changing it to be @c
789     * something/local/share instead of @c something/share, only, for
790     * example.
791     *
792     * @warning You should call this function @b before
793     * elm_app_info_set().
794     */
795    EAPI void         elm_app_compile_data_dir_set(const char *dir);
796
797    /**
798     * Provide information on the @b fallback application's locale
799     * directory, on scenarios where they get overriden by
800     * elm_app_info_set().
801     *
802     * @param dir The path to the default locale directory (compile time
803     * one)
804     *
805     * @warning You should call this function @b before
806     * elm_app_info_set().
807     */
808    EAPI void         elm_app_compile_locale_set(const char *dir);
809
810    /**
811     * Retrieve the application's run time prefix directory, as set by
812     * elm_app_info_set() and the way (environment) the application was
813     * run from.
814     *
815     * @return The directory prefix the application is actually using
816     */
817    EAPI const char  *elm_app_prefix_dir_get(void);
818
819    /**
820     * Retrieve the application's run time binaries prefix directory, as
821     * set by elm_app_info_set() and the way (environment) the application
822     * was run from.
823     *
824     * @return The binaries directory prefix the application is actually
825     * using
826     */
827    EAPI const char  *elm_app_bin_dir_get(void);
828
829    /**
830     * Retrieve the application's run time libraries prefix directory, as
831     * set by elm_app_info_set() and the way (environment) the application
832     * was run from.
833     *
834     * @return The libraries directory prefix the application is actually
835     * using
836     */
837    EAPI const char  *elm_app_lib_dir_get(void);
838
839    /**
840     * Retrieve the application's run time data prefix directory, as
841     * set by elm_app_info_set() and the way (environment) the application
842     * was run from.
843     *
844     * @return The data directory prefix the application is actually
845     * using
846     */
847    EAPI const char  *elm_app_data_dir_get(void);
848
849    /**
850     * Retrieve the application's run time locale prefix directory, as
851     * set by elm_app_info_set() and the way (environment) the application
852     * was run from.
853     *
854     * @return The locale directory prefix the application is actually
855     * using
856     */
857    EAPI const char  *elm_app_locale_dir_get(void);
858
859    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
860    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
861    EAPI int          elm_quicklaunch_init(int argc, char **argv);
862    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
863    EAPI int          elm_quicklaunch_sub_shutdown(void);
864    EAPI int          elm_quicklaunch_shutdown(void);
865    EAPI void         elm_quicklaunch_seed(void);
866    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
867    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
868    EAPI void         elm_quicklaunch_cleanup(void);
869    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
870    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
871
872    EAPI Eina_Bool    elm_need_efreet(void);
873    EAPI Eina_Bool    elm_need_e_dbus(void);
874
875    /**
876     * This must be called before any other function that handle with
877     * elm_thumb objects or ethumb_client instances.
878     *
879     * @ingroup Thumb
880     */
881    EAPI Eina_Bool    elm_need_ethumb(void);
882
883    /**
884     * Set a new policy's value (for a given policy group/identifier).
885     *
886     * @param policy policy identifier, as in @ref Elm_Policy.
887     * @param value policy value, which depends on the identifier
888     *
889     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
890     *
891     * Elementary policies define applications' behavior,
892     * somehow. These behaviors are divided in policy groups (see
893     * #Elm_Policy enumeration). This call will emit the Ecore event
894     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
895     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
896     * then.
897     *
898     * @note Currently, we have only one policy identifier/group
899     * (#ELM_POLICY_QUIT), which has two possible values.
900     *
901     * @ingroup General
902     */
903    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
904
905    /**
906     * Gets the policy value set for given policy identifier.
907     *
908     * @param policy policy identifier, as in #Elm_Policy.
909     * @return The currently set policy value, for that
910     * identifier. Will be @c 0 if @p policy passed is invalid.
911     *
912     * @ingroup General
913     */
914    EAPI int          elm_policy_get(unsigned int policy);
915
916    /**
917     * Set a label of an object
918     *
919     * @param obj The Elementary object
920     * @param part The text part name to set (NULL for the default label)
921     * @param label The new text of the label
922     *
923     * @note Elementary objects may have many labels (e.g. Action Slider)
924     *
925     * @ingroup General
926     */
927    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
928
929 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
930
931    /**
932     * Get a label of an object
933     *
934     * @param obj The Elementary object
935     * @param part The text part name to get (NULL for the default label)
936     * @return text of the label or NULL for any error
937     *
938     * @note Elementary objects may have many labels (e.g. Action Slider)
939     *
940     * @ingroup General
941     */
942    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
943
944 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
945
946    /**
947     * Set a content of an object
948     *
949     * @param obj The Elementary object
950     * @param part The content part name to set (NULL for the default content)
951     * @param content The new content of the object
952     *
953     * @note Elementary objects may have many contents
954     *
955     * @ingroup General
956     */
957    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
958
959 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
960
961    /**
962     * Get a content of an object
963     *
964     * @param obj The Elementary object
965     * @param item The content part name to get (NULL for the default content)
966     * @return content of the object or NULL for any error
967     *
968     * @note Elementary objects may have many contents
969     *
970     * @ingroup General
971     */
972    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
973
974 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
975
976    /**
977     * Unset a content of an object
978     *
979     * @param obj The Elementary object
980     * @param item The content part name to unset (NULL for the default content)
981     *
982     * @note Elementary objects may have many contents
983     *
984     * @ingroup General
985     */
986    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
987
988 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
989
990    /**
991     * Set a content of an object item
992     *
993     * @param it The Elementary object item
994     * @param part The content part name to unset (NULL for the default content)
995     * @param content The new content of the object item
996     *
997     * @note Elementary object items may have many contents
998     *
999     * @ingroup General
1000     */
1001    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1002
1003 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1004
1005    /**
1006     * Get a content of an object item
1007     *
1008     * @param it The Elementary object item
1009     * @param part The content part name to unset (NULL for the default content)
1010     * @return content of the object item or NULL for any error
1011     *
1012     * @note Elementary object items may have many contents
1013     *
1014     * @ingroup General
1015     */
1016    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1017
1018 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1019
1020    /**
1021     * Unset a content of an object item
1022     *
1023     * @param it The Elementary object item
1024     * @param part The content part name to unset (NULL for the default content)
1025     *
1026     * @note Elementary object items may have many contents
1027     *
1028     * @ingroup General
1029     */
1030    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1031
1032 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1033
1034    /**
1035     * Set a label of an objec itemt
1036     *
1037     * @param it The Elementary object item
1038     * @param part The text part name to set (NULL for the default label)
1039     * @param label The new text of the label
1040     *
1041     * @note Elementary object items may have many labels
1042     *
1043     * @ingroup General
1044     */
1045    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1046
1047 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1048
1049    /**
1050     * Get a label of an object
1051     *
1052     * @param it The Elementary object item
1053     * @param part The text part name to get (NULL for the default label)
1054     * @return text of the label or NULL for any error
1055     *
1056     * @note Elementary object items may have many labels
1057     *
1058     * @ingroup General
1059     */
1060    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1061
1062 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1063
1064    /**
1065     * @}
1066     */
1067
1068    /**
1069     * @defgroup Caches Caches
1070     *
1071     * These are functions which let one fine-tune some cache values for
1072     * Elementary applications, thus allowing for performance adjustments.
1073     *
1074     * @{
1075     */
1076
1077    /**
1078     * Flush all caches & dump all data that can be to lean down to use
1079     * less memory
1080     *
1081     * @ingroup Caches
1082     */
1083    EAPI void         elm_all_flush(void);
1084
1085    /**
1086     * Get the configured cache flush interval time
1087     *
1088     * This gets the globally configured cache flush interval time, in
1089     * ticks
1090     *
1091     * @return The cache flush interval time
1092     * @ingroup Caches
1093     *
1094     * @see elm_all_flush()
1095     */
1096    EAPI int          elm_cache_flush_interval_get(void);
1097
1098    /**
1099     * Set the configured cache flush interval time
1100     *
1101     * This sets the globally configured cache flush interval time, in ticks
1102     *
1103     * @param size The cache flush interval time
1104     * @ingroup Caches
1105     *
1106     * @see elm_all_flush()
1107     */
1108    EAPI void         elm_cache_flush_interval_set(int size);
1109
1110    /**
1111     * Set the configured cache flush interval time for all applications on the
1112     * display
1113     *
1114     * This sets the globally configured cache flush interval time -- in ticks
1115     * -- for all applications on the display.
1116     *
1117     * @param size The cache flush interval time
1118     * @ingroup Caches
1119     */
1120    EAPI void         elm_cache_flush_interval_all_set(int size);
1121
1122    /**
1123     * Get the configured cache flush enabled state
1124     *
1125     * This gets the globally configured cache flush state - if it is enabled
1126     * or not. When cache flushing is enabled, elementary will regularly
1127     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1128     * memory and allow usage to re-seed caches and data in memory where it
1129     * can do so. An idle application will thus minimise its memory usage as
1130     * data will be freed from memory and not be re-loaded as it is idle and
1131     * not rendering or doing anything graphically right now.
1132     *
1133     * @return The cache flush state
1134     * @ingroup Caches
1135     *
1136     * @see elm_all_flush()
1137     */
1138    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1139
1140    /**
1141     * Set the configured cache flush enabled state
1142     *
1143     * This sets the globally configured cache flush enabled state
1144     *
1145     * @param size The cache flush enabled state
1146     * @ingroup Caches
1147     *
1148     * @see elm_all_flush()
1149     */
1150    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1151
1152    /**
1153     * Set the configured cache flush enabled state for all applications on the
1154     * display
1155     *
1156     * This sets the globally configured cache flush enabled state for all
1157     * applications on the display.
1158     *
1159     * @param size The cache flush enabled state
1160     * @ingroup Caches
1161     */
1162    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1163
1164    /**
1165     * Get the configured font cache size
1166     *
1167     * This gets the globally configured font cache size, in bytes
1168     *
1169     * @return The font cache size
1170     * @ingroup Caches
1171     */
1172    EAPI int          elm_font_cache_get(void);
1173
1174    /**
1175     * Set the configured font cache size
1176     *
1177     * This sets the globally configured font cache size, in bytes
1178     *
1179     * @param size The font cache size
1180     * @ingroup Caches
1181     */
1182    EAPI void         elm_font_cache_set(int size);
1183
1184    /**
1185     * Set the configured font cache size for all applications on the
1186     * display
1187     *
1188     * This sets the globally configured font cache size -- in bytes
1189     * -- for all applications on the display.
1190     *
1191     * @param size The font cache size
1192     * @ingroup Caches
1193     */
1194    EAPI void         elm_font_cache_all_set(int size);
1195
1196    /**
1197     * Get the configured image cache size
1198     *
1199     * This gets the globally configured image cache size, in bytes
1200     *
1201     * @return The image cache size
1202     * @ingroup Caches
1203     */
1204    EAPI int          elm_image_cache_get(void);
1205
1206    /**
1207     * Set the configured image cache size
1208     *
1209     * This sets the globally configured image cache size, in bytes
1210     *
1211     * @param size The image cache size
1212     * @ingroup Caches
1213     */
1214    EAPI void         elm_image_cache_set(int size);
1215
1216    /**
1217     * Set the configured image cache size for all applications on the
1218     * display
1219     *
1220     * This sets the globally configured image cache size -- in bytes
1221     * -- for all applications on the display.
1222     *
1223     * @param size The image cache size
1224     * @ingroup Caches
1225     */
1226    EAPI void         elm_image_cache_all_set(int size);
1227
1228    /**
1229     * Get the configured edje file cache size.
1230     *
1231     * This gets the globally configured edje file cache size, in number
1232     * of files.
1233     *
1234     * @return The edje file cache size
1235     * @ingroup Caches
1236     */
1237    EAPI int          elm_edje_file_cache_get(void);
1238
1239    /**
1240     * Set the configured edje file cache size
1241     *
1242     * This sets the globally configured edje file cache size, in number
1243     * of files.
1244     *
1245     * @param size The edje file cache size
1246     * @ingroup Caches
1247     */
1248    EAPI void         elm_edje_file_cache_set(int size);
1249
1250    /**
1251     * Set the configured edje file cache size for all applications on the
1252     * display
1253     *
1254     * This sets the globally configured edje file cache size -- in number
1255     * of files -- for all applications on the display.
1256     *
1257     * @param size The edje file cache size
1258     * @ingroup Caches
1259     */
1260    EAPI void         elm_edje_file_cache_all_set(int size);
1261
1262    /**
1263     * Get the configured edje collections (groups) cache size.
1264     *
1265     * This gets the globally configured edje collections cache size, in
1266     * number of collections.
1267     *
1268     * @return The edje collections cache size
1269     * @ingroup Caches
1270     */
1271    EAPI int          elm_edje_collection_cache_get(void);
1272
1273    /**
1274     * Set the configured edje collections (groups) cache size
1275     *
1276     * This sets the globally configured edje collections cache size, in
1277     * number of collections.
1278     *
1279     * @param size The edje collections cache size
1280     * @ingroup Caches
1281     */
1282    EAPI void         elm_edje_collection_cache_set(int size);
1283
1284    /**
1285     * Set the configured edje collections (groups) cache size for all
1286     * applications on the display
1287     *
1288     * This sets the globally configured edje collections cache size -- in
1289     * number of collections -- for all applications on the display.
1290     *
1291     * @param size The edje collections cache size
1292     * @ingroup Caches
1293     */
1294    EAPI void         elm_edje_collection_cache_all_set(int size);
1295
1296    /**
1297     * @}
1298     */
1299
1300    /**
1301     * @defgroup Scaling Widget Scaling
1302     *
1303     * Different widgets can be scaled independently. These functions
1304     * allow you to manipulate this scaling on a per-widget basis. The
1305     * object and all its children get their scaling factors multiplied
1306     * by the scale factor set. This is multiplicative, in that if a
1307     * child also has a scale size set it is in turn multiplied by its
1308     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1309     * double size, @c 0.5 is half, etc.
1310     *
1311     * @ref general_functions_example_page "This" example contemplates
1312     * some of these functions.
1313     */
1314
1315    /**
1316     * Get the global scaling factor
1317     *
1318     * This gets the globally configured scaling factor that is applied to all
1319     * objects.
1320     *
1321     * @return The scaling factor
1322     * @ingroup Scaling
1323     */
1324    EAPI double       elm_scale_get(void);
1325
1326    /**
1327     * Set the global scaling factor
1328     *
1329     * This sets the globally configured scaling factor that is applied to all
1330     * objects.
1331     *
1332     * @param scale The scaling factor to set
1333     * @ingroup Scaling
1334     */
1335    EAPI void         elm_scale_set(double scale);
1336
1337    /**
1338     * Set the global scaling factor for all applications on the display
1339     *
1340     * This sets the globally configured scaling factor that is applied to all
1341     * objects for all applications.
1342     * @param scale The scaling factor to set
1343     * @ingroup Scaling
1344     */
1345    EAPI void         elm_scale_all_set(double scale);
1346
1347    /**
1348     * Set the scaling factor for a given Elementary object
1349     *
1350     * @param obj The Elementary to operate on
1351     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1352     * no scaling)
1353     *
1354     * @ingroup Scaling
1355     */
1356    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1357
1358    /**
1359     * Get the scaling factor for a given Elementary object
1360     *
1361     * @param obj The object
1362     * @return The scaling factor set by elm_object_scale_set()
1363     *
1364     * @ingroup Scaling
1365     */
1366    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1367
1368    /**
1369     * @defgroup UI-Mirroring Selective Widget mirroring
1370     *
1371     * These functions allow you to set ui-mirroring on specific
1372     * widgets or the whole interface. Widgets can be in one of two
1373     * modes, automatic and manual.  Automatic means they'll be changed
1374     * according to the system mirroring mode and manual means only
1375     * explicit changes will matter. You are not supposed to change
1376     * mirroring state of a widget set to automatic, will mostly work,
1377     * but the behavior is not really defined.
1378     *
1379     * @{
1380     */
1381
1382    EAPI Eina_Bool    elm_mirrored_get(void);
1383    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1384
1385    /**
1386     * Get the system mirrored mode. This determines the default mirrored mode
1387     * of widgets.
1388     *
1389     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1390     */
1391    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1392
1393    /**
1394     * Set the system mirrored mode. This determines the default mirrored mode
1395     * of widgets.
1396     *
1397     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1398     */
1399    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1400
1401    /**
1402     * Returns the widget's mirrored mode setting.
1403     *
1404     * @param obj The widget.
1405     * @return mirrored mode setting of the object.
1406     *
1407     **/
1408    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1409
1410    /**
1411     * Sets the widget's mirrored mode setting.
1412     * When widget in automatic mode, it follows the system mirrored mode set by
1413     * elm_mirrored_set().
1414     * @param obj The widget.
1415     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1416     */
1417    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1418
1419    /**
1420     * @}
1421     */
1422
1423    /**
1424     * Set the style to use by a widget
1425     *
1426     * Sets the style name that will define the appearance of a widget. Styles
1427     * vary from widget to widget and may also be defined by other themes
1428     * by means of extensions and overlays.
1429     *
1430     * @param obj The Elementary widget to style
1431     * @param style The style name to use
1432     *
1433     * @see elm_theme_extension_add()
1434     * @see elm_theme_extension_del()
1435     * @see elm_theme_overlay_add()
1436     * @see elm_theme_overlay_del()
1437     *
1438     * @ingroup Styles
1439     */
1440    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1441    /**
1442     * Get the style used by the widget
1443     *
1444     * This gets the style being used for that widget. Note that the string
1445     * pointer is only valid as longas the object is valid and the style doesn't
1446     * change.
1447     *
1448     * @param obj The Elementary widget to query for its style
1449     * @return The style name used
1450     *
1451     * @see elm_object_style_set()
1452     *
1453     * @ingroup Styles
1454     */
1455    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1456
1457    /**
1458     * @defgroup Styles Styles
1459     *
1460     * Widgets can have different styles of look. These generic API's
1461     * set styles of widgets, if they support them (and if the theme(s)
1462     * do).
1463     *
1464     * @ref general_functions_example_page "This" example contemplates
1465     * some of these functions.
1466     */
1467
1468    /**
1469     * Set the disabled state of an Elementary object.
1470     *
1471     * @param obj The Elementary object to operate on
1472     * @param disabled The state to put in in: @c EINA_TRUE for
1473     *        disabled, @c EINA_FALSE for enabled
1474     *
1475     * Elementary objects can be @b disabled, in which state they won't
1476     * receive input and, in general, will be themed differently from
1477     * their normal state, usually greyed out. Useful for contexts
1478     * where you don't want your users to interact with some of the
1479     * parts of you interface.
1480     *
1481     * This sets the state for the widget, either disabling it or
1482     * enabling it back.
1483     *
1484     * @ingroup Styles
1485     */
1486    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1487
1488    /**
1489     * Get the disabled state of an Elementary object.
1490     *
1491     * @param obj The Elementary object to operate on
1492     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1493     *            if it's enabled (or on errors)
1494     *
1495     * This gets the state of the widget, which might be enabled or disabled.
1496     *
1497     * @ingroup Styles
1498     */
1499    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1500
1501    /**
1502     * @defgroup WidgetNavigation Widget Tree Navigation.
1503     *
1504     * How to check if an Evas Object is an Elementary widget? How to
1505     * get the first elementary widget that is parent of the given
1506     * object?  These are all covered in widget tree navigation.
1507     *
1508     * @ref general_functions_example_page "This" example contemplates
1509     * some of these functions.
1510     */
1511
1512    /**
1513     * Check if the given Evas Object is an Elementary widget.
1514     *
1515     * @param obj the object to query.
1516     * @return @c EINA_TRUE if it is an elementary widget variant,
1517     *         @c EINA_FALSE otherwise
1518     * @ingroup WidgetNavigation
1519     */
1520    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1521
1522    /**
1523     * Get the first parent of the given object that is an Elementary
1524     * widget.
1525     *
1526     * @param obj the Elementary object to query parent from.
1527     * @return the parent object that is an Elementary widget, or @c
1528     *         NULL, if it was not found.
1529     *
1530     * Use this to query for an object's parent widget.
1531     *
1532     * @note Most of Elementary users wouldn't be mixing non-Elementary
1533     * smart objects in the objects tree of an application, as this is
1534     * an advanced usage of Elementary with Evas. So, except for the
1535     * application's window, which is the root of that tree, all other
1536     * objects would have valid Elementary widget parents.
1537     *
1538     * @ingroup WidgetNavigation
1539     */
1540    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1541
1542    /**
1543     * Get the top level parent of an Elementary widget.
1544     *
1545     * @param obj The object to query.
1546     * @return The top level Elementary widget, or @c NULL if parent cannot be
1547     * found.
1548     * @ingroup WidgetNavigation
1549     */
1550    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1551
1552    /**
1553     * Get the string that represents this Elementary widget.
1554     *
1555     * @note Elementary is weird and exposes itself as a single
1556     *       Evas_Object_Smart_Class of type "elm_widget", so
1557     *       evas_object_type_get() always return that, making debug and
1558     *       language bindings hard. This function tries to mitigate this
1559     *       problem, but the solution is to change Elementary to use
1560     *       proper inheritance.
1561     *
1562     * @param obj the object to query.
1563     * @return Elementary widget name, or @c NULL if not a valid widget.
1564     * @ingroup WidgetNavigation
1565     */
1566    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1567
1568    /**
1569     * @defgroup Config Elementary Config
1570     *
1571     * Elementary configuration is formed by a set options bounded to a
1572     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1573     * "finger size", etc. These are functions with which one syncronizes
1574     * changes made to those values to the configuration storing files, de
1575     * facto. You most probably don't want to use the functions in this
1576     * group unlees you're writing an elementary configuration manager.
1577     *
1578     * @{
1579     */
1580
1581    /**
1582     * Save back Elementary's configuration, so that it will persist on
1583     * future sessions.
1584     *
1585     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1586     * @ingroup Config
1587     *
1588     * This function will take effect -- thus, do I/O -- immediately. Use
1589     * it when you want to apply all configuration changes at once. The
1590     * current configuration set will get saved onto the current profile
1591     * configuration file.
1592     *
1593     */
1594    EAPI Eina_Bool    elm_config_save(void);
1595
1596    /**
1597     * Reload Elementary's configuration, bounded to current selected
1598     * profile.
1599     *
1600     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1601     * @ingroup Config
1602     *
1603     * Useful when you want to force reloading of configuration values for
1604     * a profile. If one removes user custom configuration directories,
1605     * for example, it will force a reload with system values insted.
1606     *
1607     */
1608    EAPI void         elm_config_reload(void);
1609
1610    /**
1611     * @}
1612     */
1613
1614    /**
1615     * @defgroup Profile Elementary Profile
1616     *
1617     * Profiles are pre-set options that affect the whole look-and-feel of
1618     * Elementary-based applications. There are, for example, profiles
1619     * aimed at desktop computer applications and others aimed at mobile,
1620     * touchscreen-based ones. You most probably don't want to use the
1621     * functions in this group unlees you're writing an elementary
1622     * configuration manager.
1623     *
1624     * @{
1625     */
1626
1627    /**
1628     * Get Elementary's profile in use.
1629     *
1630     * This gets the global profile that is applied to all Elementary
1631     * applications.
1632     *
1633     * @return The profile's name
1634     * @ingroup Profile
1635     */
1636    EAPI const char  *elm_profile_current_get(void);
1637
1638    /**
1639     * Get an Elementary's profile directory path in the filesystem. One
1640     * may want to fetch a system profile's dir or an user one (fetched
1641     * inside $HOME).
1642     *
1643     * @param profile The profile's name
1644     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1645     *                or a system one (@c EINA_FALSE)
1646     * @return The profile's directory path.
1647     * @ingroup Profile
1648     *
1649     * @note You must free it with elm_profile_dir_free().
1650     */
1651    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1652
1653    /**
1654     * Free an Elementary's profile directory path, as returned by
1655     * elm_profile_dir_get().
1656     *
1657     * @param p_dir The profile's path
1658     * @ingroup Profile
1659     *
1660     */
1661    EAPI void         elm_profile_dir_free(const char *p_dir);
1662
1663    /**
1664     * Get Elementary's list of available profiles.
1665     *
1666     * @return The profiles list. List node data are the profile name
1667     *         strings.
1668     * @ingroup Profile
1669     *
1670     * @note One must free this list, after usage, with the function
1671     *       elm_profile_list_free().
1672     */
1673    EAPI Eina_List   *elm_profile_list_get(void);
1674
1675    /**
1676     * Free Elementary's list of available profiles.
1677     *
1678     * @param l The profiles list, as returned by elm_profile_list_get().
1679     * @ingroup Profile
1680     *
1681     */
1682    EAPI void         elm_profile_list_free(Eina_List *l);
1683
1684    /**
1685     * Set Elementary's profile.
1686     *
1687     * This sets the global profile that is applied to Elementary
1688     * applications. Just the process the call comes from will be
1689     * affected.
1690     *
1691     * @param profile The profile's name
1692     * @ingroup Profile
1693     *
1694     */
1695    EAPI void         elm_profile_set(const char *profile);
1696
1697    /**
1698     * Set Elementary's profile.
1699     *
1700     * This sets the global profile that is applied to all Elementary
1701     * applications. All running Elementary windows will be affected.
1702     *
1703     * @param profile The profile's name
1704     * @ingroup Profile
1705     *
1706     */
1707    EAPI void         elm_profile_all_set(const char *profile);
1708
1709    /**
1710     * @}
1711     */
1712
1713    /**
1714     * @defgroup Engine Elementary Engine
1715     *
1716     * These are functions setting and querying which rendering engine
1717     * Elementary will use for drawing its windows' pixels.
1718     *
1719     * The following are the available engines:
1720     * @li "software_x11"
1721     * @li "fb"
1722     * @li "directfb"
1723     * @li "software_16_x11"
1724     * @li "software_8_x11"
1725     * @li "xrender_x11"
1726     * @li "opengl_x11"
1727     * @li "software_gdi"
1728     * @li "software_16_wince_gdi"
1729     * @li "sdl"
1730     * @li "software_16_sdl"
1731     * @li "opengl_sdl"
1732     * @li "buffer"
1733     *
1734     * @{
1735     */
1736
1737    /**
1738     * @brief Get Elementary's rendering engine in use.
1739     *
1740     * @return The rendering engine's name
1741     * @note there's no need to free the returned string, here.
1742     *
1743     * This gets the global rendering engine that is applied to all Elementary
1744     * applications.
1745     *
1746     * @see elm_engine_set()
1747     */
1748    EAPI const char  *elm_engine_current_get(void);
1749
1750    /**
1751     * @brief Set Elementary's rendering engine for use.
1752     *
1753     * @param engine The rendering engine's name
1754     *
1755     * This sets global rendering engine that is applied to all Elementary
1756     * applications. Note that it will take effect only to Elementary windows
1757     * created after this is called.
1758     *
1759     * @see elm_win_add()
1760     */
1761    EAPI void         elm_engine_set(const char *engine);
1762
1763    /**
1764     * @}
1765     */
1766
1767    /**
1768     * @defgroup Fonts Elementary Fonts
1769     *
1770     * These are functions dealing with font rendering, selection and the
1771     * like for Elementary applications. One might fetch which system
1772     * fonts are there to use and set custom fonts for individual classes
1773     * of UI items containing text (text classes).
1774     *
1775     * @{
1776     */
1777
1778   typedef struct _Elm_Text_Class
1779     {
1780        const char *name;
1781        const char *desc;
1782     } Elm_Text_Class;
1783
1784   typedef struct _Elm_Font_Overlay
1785     {
1786        const char     *text_class;
1787        const char     *font;
1788        Evas_Font_Size  size;
1789     } Elm_Font_Overlay;
1790
1791   typedef struct _Elm_Font_Properties
1792     {
1793        const char *name;
1794        Eina_List  *styles;
1795     } Elm_Font_Properties;
1796
1797    /**
1798     * Get Elementary's list of supported text classes.
1799     *
1800     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1801     * @ingroup Fonts
1802     *
1803     * Release the list with elm_text_classes_list_free().
1804     */
1805    EAPI const Eina_List     *elm_text_classes_list_get(void);
1806
1807    /**
1808     * Free Elementary's list of supported text classes.
1809     *
1810     * @ingroup Fonts
1811     *
1812     * @see elm_text_classes_list_get().
1813     */
1814    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1815
1816    /**
1817     * Get Elementary's list of font overlays, set with
1818     * elm_font_overlay_set().
1819     *
1820     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1821     * data.
1822     *
1823     * @ingroup Fonts
1824     *
1825     * For each text class, one can set a <b>font overlay</b> for it,
1826     * overriding the default font properties for that class coming from
1827     * the theme in use. There is no need to free this list.
1828     *
1829     * @see elm_font_overlay_set() and elm_font_overlay_unset().
1830     */
1831    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1832
1833    /**
1834     * Set a font overlay for a given Elementary text class.
1835     *
1836     * @param text_class Text class name
1837     * @param font Font name and style string
1838     * @param size Font size
1839     *
1840     * @ingroup Fonts
1841     *
1842     * @p font has to be in the format returned by
1843     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1844     * and elm_font_overlay_unset().
1845     */
1846    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1847
1848    /**
1849     * Unset a font overlay for a given Elementary text class.
1850     *
1851     * @param text_class Text class name
1852     *
1853     * @ingroup Fonts
1854     *
1855     * This will bring back text elements belonging to text class
1856     * @p text_class back to their default font settings.
1857     */
1858    EAPI void                 elm_font_overlay_unset(const char *text_class);
1859
1860    /**
1861     * Apply the changes made with elm_font_overlay_set() and
1862     * elm_font_overlay_unset() on the current Elementary window.
1863     *
1864     * @ingroup Fonts
1865     *
1866     * This applies all font overlays set to all objects in the UI.
1867     */
1868    EAPI void                 elm_font_overlay_apply(void);
1869
1870    /**
1871     * Apply the changes made with elm_font_overlay_set() and
1872     * elm_font_overlay_unset() on all Elementary application windows.
1873     *
1874     * @ingroup Fonts
1875     *
1876     * This applies all font overlays set to all objects in the UI.
1877     */
1878    EAPI void                 elm_font_overlay_all_apply(void);
1879
1880    /**
1881     * Translate a font (family) name string in fontconfig's font names
1882     * syntax into an @c Elm_Font_Properties struct.
1883     *
1884     * @param font The font name and styles string
1885     * @return the font properties struct
1886     *
1887     * @ingroup Fonts
1888     *
1889     * @note The reverse translation can be achived with
1890     * elm_font_fontconfig_name_get(), for one style only (single font
1891     * instance, not family).
1892     */
1893    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1894
1895    /**
1896     * Free font properties return by elm_font_properties_get().
1897     *
1898     * @param efp the font properties struct
1899     *
1900     * @ingroup Fonts
1901     */
1902    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1903
1904    /**
1905     * Translate a font name, bound to a style, into fontconfig's font names
1906     * syntax.
1907     *
1908     * @param name The font (family) name
1909     * @param style The given style (may be @c NULL)
1910     *
1911     * @return the font name and style string
1912     *
1913     * @ingroup Fonts
1914     *
1915     * @note The reverse translation can be achived with
1916     * elm_font_properties_get(), for one style only (single font
1917     * instance, not family).
1918     */
1919    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
1920
1921    /**
1922     * Free the font string return by elm_font_fontconfig_name_get().
1923     *
1924     * @param efp the font properties struct
1925     *
1926     * @ingroup Fonts
1927     */
1928    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
1929
1930    /**
1931     * Create a font hash table of available system fonts.
1932     *
1933     * One must call it with @p list being the return value of
1934     * evas_font_available_list(). The hash will be indexed by font
1935     * (family) names, being its values @c Elm_Font_Properties blobs.
1936     *
1937     * @param list The list of available system fonts, as returned by
1938     * evas_font_available_list().
1939     * @return the font hash.
1940     *
1941     * @ingroup Fonts
1942     *
1943     * @note The user is supposed to get it populated at least with 3
1944     * default font families (Sans, Serif, Monospace), which should be
1945     * present on most systems.
1946     */
1947    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
1948
1949    /**
1950     * Free the hash return by elm_font_available_hash_add().
1951     *
1952     * @param hash the hash to be freed.
1953     *
1954     * @ingroup Fonts
1955     */
1956    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
1957
1958    /**
1959     * @}
1960     */
1961
1962    /**
1963     * @defgroup Fingers Fingers
1964     *
1965     * Elementary is designed to be finger-friendly for touchscreens,
1966     * and so in addition to scaling for display resolution, it can
1967     * also scale based on finger "resolution" (or size). You can then
1968     * customize the granularity of the areas meant to receive clicks
1969     * on touchscreens.
1970     *
1971     * Different profiles may have pre-set values for finger sizes.
1972     *
1973     * @ref general_functions_example_page "This" example contemplates
1974     * some of these functions.
1975     *
1976     * @{
1977     */
1978
1979    /**
1980     * Get the configured "finger size"
1981     *
1982     * @return The finger size
1983     *
1984     * This gets the globally configured finger size, <b>in pixels</b>
1985     *
1986     * @ingroup Fingers
1987     */
1988    EAPI Evas_Coord       elm_finger_size_get(void);
1989
1990    /**
1991     * Set the configured finger size
1992     *
1993     * This sets the globally configured finger size in pixels
1994     *
1995     * @param size The finger size
1996     * @ingroup Fingers
1997     */
1998    EAPI void             elm_finger_size_set(Evas_Coord size);
1999
2000    /**
2001     * Set the configured finger size for all applications on the display
2002     *
2003     * This sets the globally configured finger size in pixels for all
2004     * applications on the display
2005     *
2006     * @param size The finger size
2007     * @ingroup Fingers
2008     */
2009    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2010
2011    /**
2012     * @}
2013     */
2014
2015    /**
2016     * @defgroup Focus Focus
2017     *
2018     * An Elementary application has, at all times, one (and only one)
2019     * @b focused object. This is what determines where the input
2020     * events go to within the application's window. Also, focused
2021     * objects can be decorated differently, in order to signal to the
2022     * user where the input is, at a given moment.
2023     *
2024     * Elementary applications also have the concept of <b>focus
2025     * chain</b>: one can cycle through all the windows' focusable
2026     * objects by input (tab key) or programmatically. The default
2027     * focus chain for an application is the one define by the order in
2028     * which the widgets where added in code. One will cycle through
2029     * top level widgets, and, for each one containg sub-objects, cycle
2030     * through them all, before returning to the level
2031     * above. Elementary also allows one to set @b custom focus chains
2032     * for their applications.
2033     *
2034     * Besides the focused decoration a widget may exhibit, when it
2035     * gets focus, Elementary has a @b global focus highlight object
2036     * that can be enabled for a window. If one chooses to do so, this
2037     * extra highlight effect will surround the current focused object,
2038     * too.
2039     *
2040     * @note Some Elementary widgets are @b unfocusable, after
2041     * creation, by their very nature: they are not meant to be
2042     * interacted with input events, but are there just for visual
2043     * purposes.
2044     *
2045     * @ref general_functions_example_page "This" example contemplates
2046     * some of these functions.
2047     */
2048
2049    /**
2050     * Get the enable status of the focus highlight
2051     *
2052     * This gets whether the highlight on focused objects is enabled or not
2053     * @ingroup Focus
2054     */
2055    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2056
2057    /**
2058     * Set the enable status of the focus highlight
2059     *
2060     * Set whether to show or not the highlight on focused objects
2061     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2062     * @ingroup Focus
2063     */
2064    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2065
2066    /**
2067     * Get the enable status of the highlight animation
2068     *
2069     * Get whether the focus highlight, if enabled, will animate its switch from
2070     * one object to the next
2071     * @ingroup Focus
2072     */
2073    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2074
2075    /**
2076     * Set the enable status of the highlight animation
2077     *
2078     * Set whether the focus highlight, if enabled, will animate its switch from
2079     * one object to the next
2080     * @param animate Enable animation if EINA_TRUE, disable otherwise
2081     * @ingroup Focus
2082     */
2083    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2084
2085    /**
2086     * Get the whether an Elementary object has the focus or not.
2087     *
2088     * @param obj The Elementary object to get the information from
2089     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2090     *            not (and on errors).
2091     *
2092     * @see elm_object_focus_set()
2093     *
2094     * @ingroup Focus
2095     */
2096    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2097
2098    /**
2099     * Set/unset focus to a given Elementary object.
2100     *
2101     * @param obj The Elementary object to operate on.
2102     * @param enable @c EINA_TRUE Set focus to a given object,
2103     *               @c EINA_FALSE Unset focus to a given object.
2104     *
2105     * @note When you set focus to this object, if it can handle focus, will
2106     * take the focus away from the one who had it previously and will, for
2107     * now on, be the one receiving input events. Unsetting focus will remove
2108     * the focus from @p obj, passing it back to the previous element in the
2109     * focus chain list.
2110     *
2111     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2112     *
2113     * @ingroup Focus
2114     */
2115    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2116
2117    /**
2118     * Make a given Elementary object the focused one.
2119     *
2120     * @param obj The Elementary object to make focused.
2121     *
2122     * @note This object, if it can handle focus, will take the focus
2123     * away from the one who had it previously and will, for now on, be
2124     * the one receiving input events.
2125     *
2126     * @see elm_object_focus_get()
2127     * @deprecated use elm_object_focus_set() instead.
2128     *
2129     * @ingroup Focus
2130     */
2131    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2132
2133    /**
2134     * Remove the focus from an Elementary object
2135     *
2136     * @param obj The Elementary to take focus from
2137     *
2138     * This removes the focus from @p obj, passing it back to the
2139     * previous element in the focus chain list.
2140     *
2141     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2142     * @deprecated use elm_object_focus_set() instead.
2143     *
2144     * @ingroup Focus
2145     */
2146    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2147
2148    /**
2149     * Set the ability for an Element object to be focused
2150     *
2151     * @param obj The Elementary object to operate on
2152     * @param enable @c EINA_TRUE if the object can be focused, @c
2153     *        EINA_FALSE if not (and on errors)
2154     *
2155     * This sets whether the object @p obj is able to take focus or
2156     * not. Unfocusable objects do nothing when programmatically
2157     * focused, being the nearest focusable parent object the one
2158     * really getting focus. Also, when they receive mouse input, they
2159     * will get the event, but not take away the focus from where it
2160     * was previously.
2161     *
2162     * @ingroup Focus
2163     */
2164    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2165
2166    /**
2167     * Get whether an Elementary object is focusable or not
2168     *
2169     * @param obj The Elementary object to operate on
2170     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2171     *             EINA_FALSE if not (and on errors)
2172     *
2173     * @note Objects which are meant to be interacted with by input
2174     * events are created able to be focused, by default. All the
2175     * others are not.
2176     *
2177     * @ingroup Focus
2178     */
2179    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2180
2181    /**
2182     * Set custom focus chain.
2183     *
2184     * This function overwrites any previous custom focus chain within
2185     * the list of objects. The previous list will be deleted and this list
2186     * will be managed by elementary. After it is set, don't modify it.
2187     *
2188     * @note On focus cycle, only will be evaluated children of this container.
2189     *
2190     * @param obj The container object
2191     * @param objs Chain of objects to pass focus
2192     * @ingroup Focus
2193     */
2194    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2195
2196    /**
2197     * Unset a custom focus chain on a given Elementary widget
2198     *
2199     * @param obj The container object to remove focus chain from
2200     *
2201     * Any focus chain previously set on @p obj (for its child objects)
2202     * is removed entirely after this call.
2203     *
2204     * @ingroup Focus
2205     */
2206    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2207
2208    /**
2209     * Get custom focus chain
2210     *
2211     * @param obj The container object
2212     * @ingroup Focus
2213     */
2214    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2215
2216    /**
2217     * Append object to custom focus chain.
2218     *
2219     * @note If relative_child equal to NULL or not in custom chain, the object
2220     * will be added in end.
2221     *
2222     * @note On focus cycle, only will be evaluated children of this container.
2223     *
2224     * @param obj The container object
2225     * @param child The child to be added in custom chain
2226     * @param relative_child The relative object to position the child
2227     * @ingroup Focus
2228     */
2229    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2230
2231    /**
2232     * Prepend object to custom focus chain.
2233     *
2234     * @note If relative_child equal to NULL or not in custom chain, the object
2235     * will be added in begin.
2236     *
2237     * @note On focus cycle, only will be evaluated children of this container.
2238     *
2239     * @param obj The container object
2240     * @param child The child to be added in custom chain
2241     * @param relative_child The relative object to position the child
2242     * @ingroup Focus
2243     */
2244    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2245
2246    /**
2247     * Give focus to next object in object tree.
2248     *
2249     * Give focus to next object in focus chain of one object sub-tree.
2250     * If the last object of chain already have focus, the focus will go to the
2251     * first object of chain.
2252     *
2253     * @param obj The object root of sub-tree
2254     * @param dir Direction to cycle the focus
2255     *
2256     * @ingroup Focus
2257     */
2258    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2259
2260    /**
2261     * Give focus to near object in one direction.
2262     *
2263     * Give focus to near object in direction of one object.
2264     * If none focusable object in given direction, the focus will not change.
2265     *
2266     * @param obj The reference object
2267     * @param x Horizontal component of direction to focus
2268     * @param y Vertical component of direction to focus
2269     *
2270     * @ingroup Focus
2271     */
2272    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2273
2274    /**
2275     * Make the elementary object and its children to be unfocusable
2276     * (or focusable).
2277     *
2278     * @param obj The Elementary object to operate on
2279     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2280     *        @c EINA_FALSE for focusable.
2281     *
2282     * This sets whether the object @p obj and its children objects
2283     * are able to take focus or not. If the tree is set as unfocusable,
2284     * newest focused object which is not in this tree will get focus.
2285     * This API can be helpful for an object to be deleted.
2286     * When an object will be deleted soon, it and its children may not
2287     * want to get focus (by focus reverting or by other focus controls).
2288     * Then, just use this API before deleting.
2289     *
2290     * @see elm_object_tree_unfocusable_get()
2291     *
2292     * @ingroup Focus
2293     */
2294    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2295
2296    /**
2297     * Get whether an Elementary object and its children are unfocusable or not.
2298     *
2299     * @param obj The Elementary object to get the information from
2300     * @return @c EINA_TRUE, if the tree is unfocussable,
2301     *         @c EINA_FALSE if not (and on errors).
2302     *
2303     * @see elm_object_tree_unfocusable_set()
2304     *
2305     * @ingroup Focus
2306     */
2307    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2308
2309    /**
2310     * @defgroup Scrolling Scrolling
2311     *
2312     * These are functions setting how scrollable views in Elementary
2313     * widgets should behave on user interaction.
2314     *
2315     * @{
2316     */
2317
2318    /**
2319     * Get whether scrollers should bounce when they reach their
2320     * viewport's edge during a scroll.
2321     *
2322     * @return the thumb scroll bouncing state
2323     *
2324     * This is the default behavior for touch screens, in general.
2325     * @ingroup Scrolling
2326     */
2327    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2328
2329    /**
2330     * Set whether scrollers should bounce when they reach their
2331     * viewport's edge during a scroll.
2332     *
2333     * @param enabled the thumb scroll bouncing state
2334     *
2335     * @see elm_thumbscroll_bounce_enabled_get()
2336     * @ingroup Scrolling
2337     */
2338    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2339
2340    /**
2341     * Set whether scrollers should bounce when they reach their
2342     * viewport's edge during a scroll, for all Elementary application
2343     * windows.
2344     *
2345     * @param enabled the thumb scroll bouncing state
2346     *
2347     * @see elm_thumbscroll_bounce_enabled_get()
2348     * @ingroup Scrolling
2349     */
2350    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2351
2352    /**
2353     * Get the amount of inertia a scroller will impose at bounce
2354     * animations.
2355     *
2356     * @return the thumb scroll bounce friction
2357     *
2358     * @ingroup Scrolling
2359     */
2360    EAPI double           elm_scroll_bounce_friction_get(void);
2361
2362    /**
2363     * Set the amount of inertia a scroller will impose at bounce
2364     * animations.
2365     *
2366     * @param friction the thumb scroll bounce friction
2367     *
2368     * @see elm_thumbscroll_bounce_friction_get()
2369     * @ingroup Scrolling
2370     */
2371    EAPI void             elm_scroll_bounce_friction_set(double friction);
2372
2373    /**
2374     * Set the amount of inertia a scroller will impose at bounce
2375     * animations, for all Elementary application windows.
2376     *
2377     * @param friction the thumb scroll bounce friction
2378     *
2379     * @see elm_thumbscroll_bounce_friction_get()
2380     * @ingroup Scrolling
2381     */
2382    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2383
2384    /**
2385     * Get the amount of inertia a <b>paged</b> scroller will impose at
2386     * page fitting animations.
2387     *
2388     * @return the page scroll friction
2389     *
2390     * @ingroup Scrolling
2391     */
2392    EAPI double           elm_scroll_page_scroll_friction_get(void);
2393
2394    /**
2395     * Set the amount of inertia a <b>paged</b> scroller will impose at
2396     * page fitting animations.
2397     *
2398     * @param friction the page scroll friction
2399     *
2400     * @see elm_thumbscroll_page_scroll_friction_get()
2401     * @ingroup Scrolling
2402     */
2403    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2404
2405    /**
2406     * Set the amount of inertia a <b>paged</b> scroller will impose at
2407     * page fitting animations, for all Elementary application windows.
2408     *
2409     * @param friction the page scroll friction
2410     *
2411     * @see elm_thumbscroll_page_scroll_friction_get()
2412     * @ingroup Scrolling
2413     */
2414    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2415
2416    /**
2417     * Get the amount of inertia a scroller will impose at region bring
2418     * animations.
2419     *
2420     * @return the bring in scroll friction
2421     *
2422     * @ingroup Scrolling
2423     */
2424    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2425
2426    /**
2427     * Set the amount of inertia a scroller will impose at region bring
2428     * animations.
2429     *
2430     * @param friction the bring in scroll friction
2431     *
2432     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2433     * @ingroup Scrolling
2434     */
2435    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2436
2437    /**
2438     * Set the amount of inertia a scroller will impose at region bring
2439     * animations, for all Elementary application windows.
2440     *
2441     * @param friction the bring in scroll friction
2442     *
2443     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2444     * @ingroup Scrolling
2445     */
2446    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2447
2448    /**
2449     * Get the amount of inertia scrollers will impose at animations
2450     * triggered by Elementary widgets' zooming API.
2451     *
2452     * @return the zoom friction
2453     *
2454     * @ingroup Scrolling
2455     */
2456    EAPI double           elm_scroll_zoom_friction_get(void);
2457
2458    /**
2459     * Set the amount of inertia scrollers will impose at animations
2460     * triggered by Elementary widgets' zooming API.
2461     *
2462     * @param friction the zoom friction
2463     *
2464     * @see elm_thumbscroll_zoom_friction_get()
2465     * @ingroup Scrolling
2466     */
2467    EAPI void             elm_scroll_zoom_friction_set(double friction);
2468
2469    /**
2470     * Set the amount of inertia scrollers will impose at animations
2471     * triggered by Elementary widgets' zooming API, for all Elementary
2472     * application windows.
2473     *
2474     * @param friction the zoom friction
2475     *
2476     * @see elm_thumbscroll_zoom_friction_get()
2477     * @ingroup Scrolling
2478     */
2479    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2480
2481    /**
2482     * Get whether scrollers should be draggable from any point in their
2483     * views.
2484     *
2485     * @return the thumb scroll state
2486     *
2487     * @note This is the default behavior for touch screens, in general.
2488     * @note All other functions namespaced with "thumbscroll" will only
2489     *       have effect if this mode is enabled.
2490     *
2491     * @ingroup Scrolling
2492     */
2493    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2494
2495    /**
2496     * Set whether scrollers should be draggable from any point in their
2497     * views.
2498     *
2499     * @param enabled the thumb scroll state
2500     *
2501     * @see elm_thumbscroll_enabled_get()
2502     * @ingroup Scrolling
2503     */
2504    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2505
2506    /**
2507     * Set whether scrollers should be draggable from any point in their
2508     * views, for all Elementary application windows.
2509     *
2510     * @param enabled the thumb scroll state
2511     *
2512     * @see elm_thumbscroll_enabled_get()
2513     * @ingroup Scrolling
2514     */
2515    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2516
2517    /**
2518     * Get the number of pixels one should travel while dragging a
2519     * scroller's view to actually trigger scrolling.
2520     *
2521     * @return the thumb scroll threshould
2522     *
2523     * One would use higher values for touch screens, in general, because
2524     * of their inherent imprecision.
2525     * @ingroup Scrolling
2526     */
2527    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2528
2529    /**
2530     * Set the number of pixels one should travel while dragging a
2531     * scroller's view to actually trigger scrolling.
2532     *
2533     * @param threshold the thumb scroll threshould
2534     *
2535     * @see elm_thumbscroll_threshould_get()
2536     * @ingroup Scrolling
2537     */
2538    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2539
2540    /**
2541     * Set the number of pixels one should travel while dragging a
2542     * scroller's view to actually trigger scrolling, for all Elementary
2543     * application windows.
2544     *
2545     * @param threshold the thumb scroll threshould
2546     *
2547     * @see elm_thumbscroll_threshould_get()
2548     * @ingroup Scrolling
2549     */
2550    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2551
2552    /**
2553     * Get the minimum speed of mouse cursor movement which will trigger
2554     * list self scrolling animation after a mouse up event
2555     * (pixels/second).
2556     *
2557     * @return the thumb scroll momentum threshould
2558     *
2559     * @ingroup Scrolling
2560     */
2561    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2562
2563    /**
2564     * Set the minimum speed of mouse cursor movement which will trigger
2565     * list self scrolling animation after a mouse up event
2566     * (pixels/second).
2567     *
2568     * @param threshold the thumb scroll momentum threshould
2569     *
2570     * @see elm_thumbscroll_momentum_threshould_get()
2571     * @ingroup Scrolling
2572     */
2573    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2574
2575    /**
2576     * Set the minimum speed of mouse cursor movement which will trigger
2577     * list self scrolling animation after a mouse up event
2578     * (pixels/second), for all Elementary application windows.
2579     *
2580     * @param threshold the thumb scroll momentum threshould
2581     *
2582     * @see elm_thumbscroll_momentum_threshould_get()
2583     * @ingroup Scrolling
2584     */
2585    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2586
2587    /**
2588     * Get the amount of inertia a scroller will impose at self scrolling
2589     * animations.
2590     *
2591     * @return the thumb scroll friction
2592     *
2593     * @ingroup Scrolling
2594     */
2595    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2596
2597    /**
2598     * Set the amount of inertia a scroller will impose at self scrolling
2599     * animations.
2600     *
2601     * @param friction the thumb scroll friction
2602     *
2603     * @see elm_thumbscroll_friction_get()
2604     * @ingroup Scrolling
2605     */
2606    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2607
2608    /**
2609     * Set the amount of inertia a scroller will impose at self scrolling
2610     * animations, for all Elementary application windows.
2611     *
2612     * @param friction the thumb scroll friction
2613     *
2614     * @see elm_thumbscroll_friction_get()
2615     * @ingroup Scrolling
2616     */
2617    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2618
2619    /**
2620     * Get the amount of lag between your actual mouse cursor dragging
2621     * movement and a scroller's view movement itself, while pushing it
2622     * into bounce state manually.
2623     *
2624     * @return the thumb scroll border friction
2625     *
2626     * @ingroup Scrolling
2627     */
2628    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2629
2630    /**
2631     * Set the amount of lag between your actual mouse cursor dragging
2632     * movement and a scroller's view movement itself, while pushing it
2633     * into bounce state manually.
2634     *
2635     * @param friction the thumb scroll border friction. @c 0.0 for
2636     *        perfect synchrony between two movements, @c 1.0 for maximum
2637     *        lag.
2638     *
2639     * @see elm_thumbscroll_border_friction_get()
2640     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2641     *
2642     * @ingroup Scrolling
2643     */
2644    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2645
2646    /**
2647     * Set the amount of lag between your actual mouse cursor dragging
2648     * movement and a scroller's view movement itself, while pushing it
2649     * into bounce state manually, for all Elementary application windows.
2650     *
2651     * @param friction the thumb scroll border friction. @c 0.0 for
2652     *        perfect synchrony between two movements, @c 1.0 for maximum
2653     *        lag.
2654     *
2655     * @see elm_thumbscroll_border_friction_get()
2656     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2657     *
2658     * @ingroup Scrolling
2659     */
2660    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2661
2662    /**
2663     * @}
2664     */
2665
2666    /**
2667     * @defgroup Scrollhints Scrollhints
2668     *
2669     * Objects when inside a scroller can scroll, but this may not always be
2670     * desirable in certain situations. This allows an object to hint to itself
2671     * and parents to "not scroll" in one of 2 ways. If any chilkd object of a
2672     * scroller has pushed a scroll freeze or hold then it affects all parent
2673     * scrollers until all children have released them.
2674     *
2675     * 1. To hold on scrolling. This means just flicking and dragging may no
2676     * longer scroll, but pressing/dragging near an edge of the scroller will
2677     * still scroll. This is automatically used by the entry object when
2678     * selecting text.
2679     *
2680     * 2. To totally freeze scrolling. This means it stops. until
2681     * popped/released.
2682     *
2683     * @{
2684     */
2685
2686    /**
2687     * Push the scroll hold by 1
2688     *
2689     * This increments the scroll hold count by one. If it is more than 0 it will
2690     * take effect on the parents of the indicated object.
2691     *
2692     * @param obj The object
2693     * @ingroup Scrollhints
2694     */
2695    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2696
2697    /**
2698     * Pop the scroll hold by 1
2699     *
2700     * This decrements the scroll hold count by one. If it is more than 0 it will
2701     * take effect on the parents of the indicated object.
2702     *
2703     * @param obj The object
2704     * @ingroup Scrollhints
2705     */
2706    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2707
2708    /**
2709     * Push the scroll freeze by 1
2710     *
2711     * This increments the scroll freeze count by one. If it is more
2712     * than 0 it will take effect on the parents of the indicated
2713     * object.
2714     *
2715     * @param obj The object
2716     * @ingroup Scrollhints
2717     */
2718    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2719
2720    /**
2721     * Pop the scroll freeze by 1
2722     *
2723     * This decrements the scroll freeze count by one. If it is more
2724     * than 0 it will take effect on the parents of the indicated
2725     * object.
2726     *
2727     * @param obj The object
2728     * @ingroup Scrollhints
2729     */
2730    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2731
2732    /**
2733     * Lock the scrolling of the given widget (and thus all parents)
2734     *
2735     * This locks the given object from scrolling in the X axis (and implicitly
2736     * also locks all parent scrollers too from doing the same).
2737     *
2738     * @param obj The object
2739     * @param lock The lock state (1 == locked, 0 == unlocked)
2740     * @ingroup Scrollhints
2741     */
2742    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2743
2744    /**
2745     * Lock the scrolling of the given widget (and thus all parents)
2746     *
2747     * This locks the given object from scrolling in the Y axis (and implicitly
2748     * also locks all parent scrollers too from doing the same).
2749     *
2750     * @param obj The object
2751     * @param lock The lock state (1 == locked, 0 == unlocked)
2752     * @ingroup Scrollhints
2753     */
2754    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2755
2756    /**
2757     * Get the scrolling lock of the given widget
2758     *
2759     * This gets the lock for X axis scrolling.
2760     *
2761     * @param obj The object
2762     * @ingroup Scrollhints
2763     */
2764    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2765
2766    /**
2767     * Get the scrolling lock of the given widget
2768     *
2769     * This gets the lock for X axis scrolling.
2770     *
2771     * @param obj The object
2772     * @ingroup Scrollhints
2773     */
2774    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2775
2776    /**
2777     * @}
2778     */
2779
2780    /**
2781     * Send a signal to the widget edje object.
2782     *
2783     * This function sends a signal to the edje object of the obj. An
2784     * edje program can respond to a signal by specifying matching
2785     * 'signal' and 'source' fields.
2786     *
2787     * @param obj The object
2788     * @param emission The signal's name.
2789     * @param source The signal's source.
2790     * @ingroup General
2791     */
2792    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2793
2794    /**
2795     * Add a callback for a signal emitted by widget edje object.
2796     *
2797     * This function connects a callback function to a signal emitted by the
2798     * edje object of the obj.
2799     * Globs can occur in either the emission or source name.
2800     *
2801     * @param obj The object
2802     * @param emission The signal's name.
2803     * @param source The signal's source.
2804     * @param func The callback function to be executed when the signal is
2805     * emitted.
2806     * @param data A pointer to data to pass in to the callback function.
2807     * @ingroup General
2808     */
2809    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);
2810
2811    /**
2812     * Remove a signal-triggered callback from an widget edje object.
2813     *
2814     * This function removes a callback, previoulsy attached to a
2815     * signal emitted by the edje object of the obj.  The parameters
2816     * emission, source and func must match exactly those passed to a
2817     * previous call to elm_object_signal_callback_add(). The data
2818     * pointer that was passed to this call will be returned.
2819     *
2820     * @param obj The object
2821     * @param emission The signal's name.
2822     * @param source The signal's source.
2823     * @param func The callback function to be executed when the signal is
2824     * emitted.
2825     * @return The data pointer
2826     * @ingroup General
2827     */
2828    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);
2829
2830    /**
2831     * Add a callback for a event emitted by widget or their children.
2832     *
2833     * This function connects a callback function to any key_down key_up event
2834     * emitted by the @p obj or their children.
2835     * This only will be called if no other callback has consumed the event.
2836     * If you want consume the event, and no other get it, func should return
2837     * EINA_TRUE and put EVAS_EVENT_FLAG_ON_HOLD in event_flags.
2838     *
2839     * @warning Accept duplicated callback addition.
2840     *
2841     * @param obj The object
2842     * @param func The callback function to be executed when the event is
2843     * emitted.
2844     * @param data Data to pass in to the callback function.
2845     * @ingroup General
2846     */
2847    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2848
2849    /**
2850     * Remove a event callback from an widget.
2851     *
2852     * This function removes a callback, previoulsy attached to event emission
2853     * by the @p obj.
2854     * The parameters func and data must match exactly those passed to
2855     * a previous call to elm_object_event_callback_add(). The data pointer that
2856     * was passed to this call will be returned.
2857     *
2858     * @param obj The object
2859     * @param func The callback function to be executed when the event is
2860     * emitted.
2861     * @param data Data to pass in to the callback function.
2862     * @return The data pointer
2863     * @ingroup General
2864     */
2865    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2866
2867    /**
2868     * Adjust size of an element for finger usage.
2869     *
2870     * @param times_w How many fingers should fit horizontally
2871     * @param w Pointer to the width size to adjust
2872     * @param times_h How many fingers should fit vertically
2873     * @param h Pointer to the height size to adjust
2874     *
2875     * This takes width and height sizes (in pixels) as input and a
2876     * size multiple (which is how many fingers you want to place
2877     * within the area, being "finger" the size set by
2878     * elm_finger_size_set()), and adjusts the size to be large enough
2879     * to accommodate the resulting size -- if it doesn't already
2880     * accommodate it. On return the @p w and @p h sizes pointed to by
2881     * these parameters will be modified, on those conditions.
2882     *
2883     * @note This is kind of a low level Elementary call, most useful
2884     * on size evaluation times for widgets. An external user wouldn't
2885     * be calling, most of the time.
2886     *
2887     * @ingroup Fingers
2888     */
2889    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
2890
2891    /**
2892     * Get the duration for occuring long press event.
2893     *
2894     * @return Timeout for long press event
2895     * @ingroup Longpress
2896     */
2897    EAPI double           elm_longpress_timeout_get(void);
2898
2899    /**
2900     * Set the duration for occuring long press event.
2901     *
2902     * @param lonpress_timeout Timeout for long press event
2903     * @ingroup Longpress
2904     */
2905    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
2906
2907    /**
2908     * @defgroup Debug Debug
2909     * don't use it unless you are sure
2910     *
2911     * @{
2912     */
2913
2914    /**
2915     * Print Tree object hierarchy in stdout
2916     *
2917     * @param obj The root object
2918     * @ingroup Debug
2919     */
2920    EAPI void             elm_object_tree_dump(const Evas_Object *top);
2921
2922    /**
2923     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
2924     *
2925     * @param obj The root object
2926     * @param file The path of output file
2927     * @ingroup Debug
2928     */
2929    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
2930
2931    /**
2932     * @}
2933     */
2934
2935    /**
2936     * @defgroup Theme Theme
2937     *
2938     * Elementary uses Edje to theme its widgets, naturally. But for the most
2939     * part this is hidden behind a simpler interface that lets the user set
2940     * extensions and choose the style of widgets in a much easier way.
2941     *
2942     * Instead of thinking in terms of paths to Edje files and their groups
2943     * each time you want to change the appearance of a widget, Elementary
2944     * works so you can add any theme file with extensions or replace the
2945     * main theme at one point in the application, and then just set the style
2946     * of widgets with elm_object_style_set() and related functions. Elementary
2947     * will then look in its list of themes for a matching group and apply it,
2948     * and when the theme changes midway through the application, all widgets
2949     * will be updated accordingly.
2950     *
2951     * There are three concepts you need to know to understand how Elementary
2952     * theming works: default theme, extensions and overlays.
2953     *
2954     * Default theme, obviously enough, is the one that provides the default
2955     * look of all widgets. End users can change the theme used by Elementary
2956     * by setting the @c ELM_THEME environment variable before running an
2957     * application, or globally for all programs using the @c elementary_config
2958     * utility. Applications can change the default theme using elm_theme_set(),
2959     * but this can go against the user wishes, so it's not an adviced practice.
2960     *
2961     * Ideally, applications should find everything they need in the already
2962     * provided theme, but there may be occasions when that's not enough and
2963     * custom styles are required to correctly express the idea. For this
2964     * cases, Elementary has extensions.
2965     *
2966     * Extensions allow the application developer to write styles of its own
2967     * to apply to some widgets. This requires knowledge of how each widget
2968     * is themed, as extensions will always replace the entire group used by
2969     * the widget, so important signals and parts need to be there for the
2970     * object to behave properly (see documentation of Edje for details).
2971     * Once the theme for the extension is done, the application needs to add
2972     * it to the list of themes Elementary will look into, using
2973     * elm_theme_extension_add(), and set the style of the desired widgets as
2974     * he would normally with elm_object_style_set().
2975     *
2976     * Overlays, on the other hand, can replace the look of all widgets by
2977     * overriding the default style. Like extensions, it's up to the application
2978     * developer to write the theme for the widgets it wants, the difference
2979     * being that when looking for the theme, Elementary will check first the
2980     * list of overlays, then the set theme and lastly the list of extensions,
2981     * so with overlays it's possible to replace the default view and every
2982     * widget will be affected. This is very much alike to setting the whole
2983     * theme for the application and will probably clash with the end user
2984     * options, not to mention the risk of ending up with not matching styles
2985     * across the program. Unless there's a very special reason to use them,
2986     * overlays should be avoided for the resons exposed before.
2987     *
2988     * All these theme lists are handled by ::Elm_Theme instances. Elementary
2989     * keeps one default internally and every function that receives one of
2990     * these can be called with NULL to refer to this default (except for
2991     * elm_theme_free()). It's possible to create a new instance of a
2992     * ::Elm_Theme to set other theme for a specific widget (and all of its
2993     * children), but this is as discouraged, if not even more so, than using
2994     * overlays. Don't use this unless you really know what you are doing.
2995     *
2996     * But to be less negative about things, you can look at the following
2997     * examples:
2998     * @li @ref theme_example_01 "Using extensions"
2999     * @li @ref theme_example_02 "Using overlays"
3000     *
3001     * @{
3002     */
3003    /**
3004     * @typedef Elm_Theme
3005     *
3006     * Opaque handler for the list of themes Elementary looks for when
3007     * rendering widgets.
3008     *
3009     * Stay out of this unless you really know what you are doing. For most
3010     * cases, sticking to the default is all a developer needs.
3011     */
3012    typedef struct _Elm_Theme Elm_Theme;
3013
3014    /**
3015     * Create a new specific theme
3016     *
3017     * This creates an empty specific theme that only uses the default theme. A
3018     * specific theme has its own private set of extensions and overlays too
3019     * (which are empty by default). Specific themes do not fall back to themes
3020     * of parent objects. They are not intended for this use. Use styles, overlays
3021     * and extensions when needed, but avoid specific themes unless there is no
3022     * other way (example: you want to have a preview of a new theme you are
3023     * selecting in a "theme selector" window. The preview is inside a scroller
3024     * and should display what the theme you selected will look like, but not
3025     * actually apply it yet. The child of the scroller will have a specific
3026     * theme set to show this preview before the user decides to apply it to all
3027     * applications).
3028     */
3029    EAPI Elm_Theme       *elm_theme_new(void);
3030    /**
3031     * Free a specific theme
3032     *
3033     * @param th The theme to free
3034     *
3035     * This frees a theme created with elm_theme_new().
3036     */
3037    EAPI void             elm_theme_free(Elm_Theme *th);
3038    /**
3039     * Copy the theme fom the source to the destination theme
3040     *
3041     * @param th The source theme to copy from
3042     * @param thdst The destination theme to copy data to
3043     *
3044     * This makes a one-time static copy of all the theme config, extensions
3045     * and overlays from @p th to @p thdst. If @p th references a theme, then
3046     * @p thdst is also set to reference it, with all the theme settings,
3047     * overlays and extensions that @p th had.
3048     */
3049    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3050    /**
3051     * Tell the source theme to reference the ref theme
3052     *
3053     * @param th The theme that will do the referencing
3054     * @param thref The theme that is the reference source
3055     *
3056     * This clears @p th to be empty and then sets it to refer to @p thref
3057     * so @p th acts as an override to @p thref, but where its overrides
3058     * don't apply, it will fall through to @p thref for configuration.
3059     */
3060    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3061    /**
3062     * Return the theme referred to
3063     *
3064     * @param th The theme to get the reference from
3065     * @return The referenced theme handle
3066     *
3067     * This gets the theme set as the reference theme by elm_theme_ref_set().
3068     * If no theme is set as a reference, NULL is returned.
3069     */
3070    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3071    /**
3072     * Return the default theme
3073     *
3074     * @return The default theme handle
3075     *
3076     * This returns the internal default theme setup handle that all widgets
3077     * use implicitly unless a specific theme is set. This is also often use
3078     * as a shorthand of NULL.
3079     */
3080    EAPI Elm_Theme       *elm_theme_default_get(void);
3081    /**
3082     * Prepends a theme overlay to the list of overlays
3083     *
3084     * @param th The theme to add to, or if NULL, the default theme
3085     * @param item The Edje file path to be used
3086     *
3087     * Use this if your application needs to provide some custom overlay theme
3088     * (An Edje file that replaces some default styles of widgets) where adding
3089     * new styles, or changing system theme configuration is not possible. Do
3090     * NOT use this instead of a proper system theme configuration. Use proper
3091     * configuration files, profiles, environment variables etc. to set a theme
3092     * so that the theme can be altered by simple confiugration by a user. Using
3093     * this call to achieve that effect is abusing the API and will create lots
3094     * of trouble.
3095     *
3096     * @see elm_theme_extension_add()
3097     */
3098    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3099    /**
3100     * Delete a theme overlay from the list of overlays
3101     *
3102     * @param th The theme to delete from, or if NULL, the default theme
3103     * @param item The name of the theme overlay
3104     *
3105     * @see elm_theme_overlay_add()
3106     */
3107    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3108    /**
3109     * Appends a theme extension to the list of extensions.
3110     *
3111     * @param th The theme to add to, or if NULL, the default theme
3112     * @param item The Edje file path to be used
3113     *
3114     * This is intended when an application needs more styles of widgets or new
3115     * widget themes that the default does not provide (or may not provide). The
3116     * application has "extended" usage by coming up with new custom style names
3117     * for widgets for specific uses, but as these are not "standard", they are
3118     * not guaranteed to be provided by a default theme. This means the
3119     * application is required to provide these extra elements itself in specific
3120     * Edje files. This call adds one of those Edje files to the theme search
3121     * path to be search after the default theme. The use of this call is
3122     * encouraged when default styles do not meet the needs of the application.
3123     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3124     *
3125     * @see elm_object_style_set()
3126     */
3127    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3128    /**
3129     * Deletes a theme extension from the list of extensions.
3130     *
3131     * @param th The theme to delete from, or if NULL, the default theme
3132     * @param item The name of the theme extension
3133     *
3134     * @see elm_theme_extension_add()
3135     */
3136    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3137    /**
3138     * Set the theme search order for the given theme
3139     *
3140     * @param th The theme to set the search order, or if NULL, the default theme
3141     * @param theme Theme search string
3142     *
3143     * This sets the search string for the theme in path-notation from first
3144     * theme to search, to last, delimited by the : character. Example:
3145     *
3146     * "shiny:/path/to/file.edj:default"
3147     *
3148     * See the ELM_THEME environment variable for more information.
3149     *
3150     * @see elm_theme_get()
3151     * @see elm_theme_list_get()
3152     */
3153    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3154    /**
3155     * Return the theme search order
3156     *
3157     * @param th The theme to get the search order, or if NULL, the default theme
3158     * @return The internal search order path
3159     *
3160     * This function returns a colon separated string of theme elements as
3161     * returned by elm_theme_list_get().
3162     *
3163     * @see elm_theme_set()
3164     * @see elm_theme_list_get()
3165     */
3166    EAPI const char      *elm_theme_get(Elm_Theme *th);
3167    /**
3168     * Return a list of theme elements to be used in a theme.
3169     *
3170     * @param th Theme to get the list of theme elements from.
3171     * @return The internal list of theme elements
3172     *
3173     * This returns the internal list of theme elements (will only be valid as
3174     * long as the theme is not modified by elm_theme_set() or theme is not
3175     * freed by elm_theme_free(). This is a list of strings which must not be
3176     * altered as they are also internal. If @p th is NULL, then the default
3177     * theme element list is returned.
3178     *
3179     * A theme element can consist of a full or relative path to a .edj file,
3180     * or a name, without extension, for a theme to be searched in the known
3181     * theme paths for Elemementary.
3182     *
3183     * @see elm_theme_set()
3184     * @see elm_theme_get()
3185     */
3186    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3187    /**
3188     * Return the full patrh for a theme element
3189     *
3190     * @param f The theme element name
3191     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3192     * @return The full path to the file found.
3193     *
3194     * This returns a string you should free with free() on success, NULL on
3195     * failure. This will search for the given theme element, and if it is a
3196     * full or relative path element or a simple searchable name. The returned
3197     * path is the full path to the file, if searched, and the file exists, or it
3198     * is simply the full path given in the element or a resolved path if
3199     * relative to home. The @p in_search_path boolean pointed to is set to
3200     * EINA_TRUE if the file was a searchable file andis in the search path,
3201     * and EINA_FALSE otherwise.
3202     */
3203    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3204    /**
3205     * Flush the current theme.
3206     *
3207     * @param th Theme to flush
3208     *
3209     * This flushes caches that let elementary know where to find theme elements
3210     * in the given theme. If @p th is NULL, then the default theme is flushed.
3211     * Call this function if source theme data has changed in such a way as to
3212     * make any caches Elementary kept invalid.
3213     */
3214    EAPI void             elm_theme_flush(Elm_Theme *th);
3215    /**
3216     * This flushes all themes (default and specific ones).
3217     *
3218     * This will flush all themes in the current application context, by calling
3219     * elm_theme_flush() on each of them.
3220     */
3221    EAPI void             elm_theme_full_flush(void);
3222    /**
3223     * Set the theme for all elementary using applications on the current display
3224     *
3225     * @param theme The name of the theme to use. Format same as the ELM_THEME
3226     * environment variable.
3227     */
3228    EAPI void             elm_theme_all_set(const char *theme);
3229    /**
3230     * Return a list of theme elements in the theme search path
3231     *
3232     * @return A list of strings that are the theme element names.
3233     *
3234     * This lists all available theme files in the standard Elementary search path
3235     * for theme elements, and returns them in alphabetical order as theme
3236     * element names in a list of strings. Free this with
3237     * elm_theme_name_available_list_free() when you are done with the list.
3238     */
3239    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3240    /**
3241     * Free the list returned by elm_theme_name_available_list_new()
3242     *
3243     * This frees the list of themes returned by
3244     * elm_theme_name_available_list_new(). Once freed the list should no longer
3245     * be used. a new list mys be created.
3246     */
3247    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3248    /**
3249     * Set a specific theme to be used for this object and its children
3250     *
3251     * @param obj The object to set the theme on
3252     * @param th The theme to set
3253     *
3254     * This sets a specific theme that will be used for the given object and any
3255     * child objects it has. If @p th is NULL then the theme to be used is
3256     * cleared and the object will inherit its theme from its parent (which
3257     * ultimately will use the default theme if no specific themes are set).
3258     *
3259     * Use special themes with great care as this will annoy users and make
3260     * configuration difficult. Avoid any custom themes at all if it can be
3261     * helped.
3262     */
3263    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3264    /**
3265     * Get the specific theme to be used
3266     *
3267     * @param obj The object to get the specific theme from
3268     * @return The specifc theme set.
3269     *
3270     * This will return a specific theme set, or NULL if no specific theme is
3271     * set on that object. It will not return inherited themes from parents, only
3272     * the specific theme set for that specific object. See elm_object_theme_set()
3273     * for more information.
3274     */
3275    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3276    /**
3277     * @}
3278     */
3279
3280    /* win */
3281    /** @defgroup Win Win
3282     *
3283     * @image html img/widget/win/preview-00.png
3284     * @image latex img/widget/win/preview-00.eps
3285     *
3286     * The window class of Elementary.  Contains functions to manipulate
3287     * windows. The Evas engine used to render the window contents is specified
3288     * in the system or user elementary config files (whichever is found last),
3289     * and can be overridden with the ELM_ENGINE environment variable for
3290     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3291     * compilation setup and modules actually installed at runtime) are (listed
3292     * in order of best supported and most likely to be complete and work to
3293     * lowest quality).
3294     *
3295     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3296     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3297     * rendering in X11)
3298     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3299     * exits)
3300     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3301     * rendering)
3302     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3303     * buffer)
3304     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3305     * rendering using SDL as the buffer)
3306     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3307     * GDI with software)
3308     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3309     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3310     * grayscale using dedicated 8bit software engine in X11)
3311     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3312     * X11 using 16bit software engine)
3313     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3314     * (Windows CE rendering via GDI with 16bit software renderer)
3315     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3316     * buffer with 16bit software renderer)
3317     *
3318     * All engines use a simple string to select the engine to render, EXCEPT
3319     * the "shot" engine. This actually encodes the output of the virtual
3320     * screenshot and how long to delay in the engine string. The engine string
3321     * is encoded in the following way:
3322     *
3323     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3324     *
3325     * Where options are separated by a ":" char if more than one option is
3326     * given, with delay, if provided being the first option and file the last
3327     * (order is important). The delay specifies how long to wait after the
3328     * window is shown before doing the virtual "in memory" rendering and then
3329     * save the output to the file specified by the file option (and then exit).
3330     * If no delay is given, the default is 0.5 seconds. If no file is given the
3331     * default output file is "out.png". Repeat option is for continous
3332     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3333     * fixed to "out001.png" Some examples of using the shot engine:
3334     *
3335     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3336     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3337     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3338     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3339     *   ELM_ENGINE="shot:" elementary_test
3340     *
3341     * Signals that you can add callbacks for are:
3342     *
3343     * @li "delete,request": the user requested to close the window. See
3344     * elm_win_autodel_set().
3345     * @li "focus,in": window got focus
3346     * @li "focus,out": window lost focus
3347     * @li "moved": window that holds the canvas was moved
3348     *
3349     * Examples:
3350     * @li @ref win_example_01
3351     *
3352     * @{
3353     */
3354    /**
3355     * Defines the types of window that can be created
3356     *
3357     * These are hints set on the window so that a running Window Manager knows
3358     * how the window should be handled and/or what kind of decorations it
3359     * should have.
3360     *
3361     * Currently, only the X11 backed engines use them.
3362     */
3363    typedef enum _Elm_Win_Type
3364      {
3365         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3366                          window. Almost every window will be created with this
3367                          type. */
3368         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3369         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3370                            window holding desktop icons. */
3371         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3372                         be kept on top of any other window by the Window
3373                         Manager. */
3374         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3375                            similar. */
3376         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3377         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3378                            pallete. */
3379         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3380         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3381                                  entry in a menubar is clicked. Typically used
3382                                  with elm_win_override_set(). This hint exists
3383                                  for completion only, as the EFL way of
3384                                  implementing a menu would not normally use a
3385                                  separate window for its contents. */
3386         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3387                               triggered by right-clicking an object. */
3388         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3389                            explanatory text that typically appear after the
3390                            mouse cursor hovers over an object for a while.
3391                            Typically used with elm_win_override_set() and also
3392                            not very commonly used in the EFL. */
3393         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3394                                 battery life or a new E-Mail received. */
3395         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3396                          usually used in the EFL. */
3397         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3398                        object being dragged across different windows, or even
3399                        applications. Typically used with
3400                        elm_win_override_set(). */
3401         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3402                                  buffer. No actual window is created for this
3403                                  type, instead the window and all of its
3404                                  contents will be rendered to an image buffer.
3405                                  This allows to have children window inside a
3406                                  parent one just like any other object would
3407                                  be, and do other things like applying @c
3408                                  Evas_Map effects to it. This is the only type
3409                                  of window that requires the @c parent
3410                                  parameter of elm_win_add() to be a valid @c
3411                                  Evas_Object. */
3412      } Elm_Win_Type;
3413
3414    /**
3415     * The differents layouts that can be requested for the virtual keyboard.
3416     *
3417     * When the application window is being managed by Illume, it may request
3418     * any of the following layouts for the virtual keyboard.
3419     */
3420    typedef enum _Elm_Win_Keyboard_Mode
3421      {
3422         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3423         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3424         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3425         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3426         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3427         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3428         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3429         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3430         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3431         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3432         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3433         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3434         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3435         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3436         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3437         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3438      } Elm_Win_Keyboard_Mode;
3439
3440    /**
3441     * Available commands that can be sent to the Illume manager.
3442     *
3443     * When running under an Illume session, a window may send commands to the
3444     * Illume manager to perform different actions.
3445     */
3446    typedef enum _Elm_Illume_Command
3447      {
3448         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3449                                          window */
3450         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3451                                             in the list */
3452         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3453                                          screen */
3454         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3455      } Elm_Illume_Command;
3456
3457    /**
3458     * Adds a window object. If this is the first window created, pass NULL as
3459     * @p parent.
3460     *
3461     * @param parent Parent object to add the window to, or NULL
3462     * @param name The name of the window
3463     * @param type The window type, one of #Elm_Win_Type.
3464     *
3465     * The @p parent paramter can be @c NULL for every window @p type except
3466     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3467     * which the image object will be created.
3468     *
3469     * @return The created object, or NULL on failure
3470     */
3471    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3472    /**
3473     * Add @p subobj as a resize object of window @p obj.
3474     *
3475     *
3476     * Setting an object as a resize object of the window means that the
3477     * @p subobj child's size and position will be controlled by the window
3478     * directly. That is, the object will be resized to match the window size
3479     * and should never be moved or resized manually by the developer.
3480     *
3481     * In addition, resize objects of the window control what the minimum size
3482     * of it will be, as well as whether it can or not be resized by the user.
3483     *
3484     * For the end user to be able to resize a window by dragging the handles
3485     * or borders provided by the Window Manager, or using any other similar
3486     * mechanism, all of the resize objects in the window should have their
3487     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3488     *
3489     * @param obj The window object
3490     * @param subobj The resize object to add
3491     */
3492    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3493    /**
3494     * Delete @p subobj as a resize object of window @p obj.
3495     *
3496     * This function removes the object @p subobj from the resize objects of
3497     * the window @p obj. It will not delete the object itself, which will be
3498     * left unmanaged and should be deleted by the developer, manually handled
3499     * or set as child of some other container.
3500     *
3501     * @param obj The window object
3502     * @param subobj The resize object to add
3503     */
3504    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3505    /**
3506     * Set the title of the window
3507     *
3508     * @param obj The window object
3509     * @param title The title to set
3510     */
3511    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3512    /**
3513     * Get the title of the window
3514     *
3515     * The returned string is an internal one and should not be freed or
3516     * modified. It will also be rendered invalid if a new title is set or if
3517     * the window is destroyed.
3518     *
3519     * @param obj The window object
3520     * @return The title
3521     */
3522    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3523    /**
3524     * Set the window's autodel state.
3525     *
3526     * When closing the window in any way outside of the program control, like
3527     * pressing the X button in the titlebar or using a command from the
3528     * Window Manager, a "delete,request" signal is emitted to indicate that
3529     * this event occurred and the developer can take any action, which may
3530     * include, or not, destroying the window object.
3531     *
3532     * When the @p autodel parameter is set, the window will be automatically
3533     * destroyed when this event occurs, after the signal is emitted.
3534     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3535     * and is up to the program to do so when it's required.
3536     *
3537     * @param obj The window object
3538     * @param autodel If true, the window will automatically delete itself when
3539     * closed
3540     */
3541    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3542    /**
3543     * Get the window's autodel state.
3544     *
3545     * @param obj The window object
3546     * @return If the window will automatically delete itself when closed
3547     *
3548     * @see elm_win_autodel_set()
3549     */
3550    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3551    /**
3552     * Activate a window object.
3553     *
3554     * This function sends a request to the Window Manager to activate the
3555     * window pointed by @p obj. If honored by the WM, the window will receive
3556     * the keyboard focus.
3557     *
3558     * @note This is just a request that a Window Manager may ignore, so calling
3559     * this function does not ensure in any way that the window will be the
3560     * active one after it.
3561     *
3562     * @param obj The window object
3563     */
3564    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3565    /**
3566     * Lower a window object.
3567     *
3568     * Places the window pointed by @p obj at the bottom of the stack, so that
3569     * no other window is covered by it.
3570     *
3571     * If elm_win_override_set() is not set, the Window Manager may ignore this
3572     * request.
3573     *
3574     * @param obj The window object
3575     */
3576    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3577    /**
3578     * Raise a window object.
3579     *
3580     * Places the window pointed by @p obj at the top of the stack, so that it's
3581     * not covered by any other window.
3582     *
3583     * If elm_win_override_set() is not set, the Window Manager may ignore this
3584     * request.
3585     *
3586     * @param obj The window object
3587     */
3588    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3589    /**
3590     * Set the borderless state of a window.
3591     *
3592     * This function requests the Window Manager to not draw any decoration
3593     * around the window.
3594     *
3595     * @param obj The window object
3596     * @param borderless If true, the window is borderless
3597     */
3598    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3599    /**
3600     * Get the borderless state of a window.
3601     *
3602     * @param obj The window object
3603     * @return If true, the window is borderless
3604     */
3605    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3606    /**
3607     * Set the shaped state of a window.
3608     *
3609     * Shaped windows, when supported, will render the parts of the window that
3610     * has no content, transparent.
3611     *
3612     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3613     * background object or cover the entire window in any other way, or the
3614     * parts of the canvas that have no data will show framebuffer artifacts.
3615     *
3616     * @param obj The window object
3617     * @param shaped If true, the window is shaped
3618     *
3619     * @see elm_win_alpha_set()
3620     */
3621    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3622    /**
3623     * Get the shaped state of a window.
3624     *
3625     * @param obj The window object
3626     * @return If true, the window is shaped
3627     *
3628     * @see elm_win_shaped_set()
3629     */
3630    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3631    /**
3632     * Set the alpha channel state of a window.
3633     *
3634     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3635     * possibly making parts of the window completely or partially transparent.
3636     * This is also subject to the underlying system supporting it, like for
3637     * example, running under a compositing manager. If no compositing is
3638     * available, enabling this option will instead fallback to using shaped
3639     * windows, with elm_win_shaped_set().
3640     *
3641     * @param obj The window object
3642     * @param alpha If true, the window has an alpha channel
3643     *
3644     * @see elm_win_alpha_set()
3645     */
3646    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3647    /**
3648     * Get the transparency state of a window.
3649     *
3650     * @param obj The window object
3651     * @return If true, the window is transparent
3652     *
3653     * @see elm_win_transparent_set()
3654     */
3655    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3656    /**
3657     * Set the transparency state of a window.
3658     *
3659     * Use elm_win_alpha_set() instead.
3660     *
3661     * @param obj The window object
3662     * @param transparent If true, the window is transparent
3663     *
3664     * @see elm_win_alpha_set()
3665     */
3666    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3667    /**
3668     * Get the alpha channel state of a window.
3669     *
3670     * @param obj The window object
3671     * @return If true, the window has an alpha channel
3672     */
3673    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3674    /**
3675     * Set the override state of a window.
3676     *
3677     * A window with @p override set to EINA_TRUE will not be managed by the
3678     * Window Manager. This means that no decorations of any kind will be shown
3679     * for it, moving and resizing must be handled by the application, as well
3680     * as the window visibility.
3681     *
3682     * This should not be used for normal windows, and even for not so normal
3683     * ones, it should only be used when there's a good reason and with a lot
3684     * of care. Mishandling override windows may result situations that
3685     * disrupt the normal workflow of the end user.
3686     *
3687     * @param obj The window object
3688     * @param override If true, the window is overridden
3689     */
3690    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3691    /**
3692     * Get the override state of a window.
3693     *
3694     * @param obj The window object
3695     * @return If true, the window is overridden
3696     *
3697     * @see elm_win_override_set()
3698     */
3699    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3700    /**
3701     * Set the fullscreen state of a window.
3702     *
3703     * @param obj The window object
3704     * @param fullscreen If true, the window is fullscreen
3705     */
3706    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3707    /**
3708     * Get the fullscreen state of a window.
3709     *
3710     * @param obj The window object
3711     * @return If true, the window is fullscreen
3712     */
3713    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3714    /**
3715     * Set the maximized state of a window.
3716     *
3717     * @param obj The window object
3718     * @param maximized If true, the window is maximized
3719     */
3720    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3721    /**
3722     * Get the maximized state of a window.
3723     *
3724     * @param obj The window object
3725     * @return If true, the window is maximized
3726     */
3727    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3728    /**
3729     * Set the iconified state of a window.
3730     *
3731     * @param obj The window object
3732     * @param iconified If true, the window is iconified
3733     */
3734    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3735    /**
3736     * Get the iconified state of a window.
3737     *
3738     * @param obj The window object
3739     * @return If true, the window is iconified
3740     */
3741    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3742    /**
3743     * Set the layer of the window.
3744     *
3745     * What this means exactly will depend on the underlying engine used.
3746     *
3747     * In the case of X11 backed engines, the value in @p layer has the
3748     * following meanings:
3749     * @li < 3: The window will be placed below all others.
3750     * @li > 5: The window will be placed above all others.
3751     * @li other: The window will be placed in the default layer.
3752     *
3753     * @param obj The window object
3754     * @param layer The layer of the window
3755     */
3756    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3757    /**
3758     * Get the layer of the window.
3759     *
3760     * @param obj The window object
3761     * @return The layer of the window
3762     *
3763     * @see elm_win_layer_set()
3764     */
3765    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3766    /**
3767     * Set the rotation of the window.
3768     *
3769     * Most engines only work with multiples of 90.
3770     *
3771     * This function is used to set the orientation of the window @p obj to
3772     * match that of the screen. The window itself will be resized to adjust
3773     * to the new geometry of its contents. If you want to keep the window size,
3774     * see elm_win_rotation_with_resize_set().
3775     *
3776     * @param obj The window object
3777     * @param rotation The rotation of the window, in degrees (0-360),
3778     * counter-clockwise.
3779     */
3780    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3781    /**
3782     * Rotates the window and resizes it.
3783     *
3784     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3785     * that they fit inside the current window geometry.
3786     *
3787     * @param obj The window object
3788     * @param layer The rotation of the window in degrees (0-360),
3789     * counter-clockwise.
3790     */
3791    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3792    /**
3793     * Get the rotation of the window.
3794     *
3795     * @param obj The window object
3796     * @return The rotation of the window in degrees (0-360)
3797     *
3798     * @see elm_win_rotation_set()
3799     * @see elm_win_rotation_with_resize_set()
3800     */
3801    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3802    /**
3803     * Set the sticky state of the window.
3804     *
3805     * Hints the Window Manager that the window in @p obj should be left fixed
3806     * at its position even when the virtual desktop it's on moves or changes.
3807     *
3808     * @param obj The window object
3809     * @param sticky If true, the window's sticky state is enabled
3810     */
3811    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3812    /**
3813     * Get the sticky state of the window.
3814     *
3815     * @param obj The window object
3816     * @return If true, the window's sticky state is enabled
3817     *
3818     * @see elm_win_sticky_set()
3819     */
3820    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3821    /**
3822     * Set if this window is an illume conformant window
3823     *
3824     * @param obj The window object
3825     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3826     */
3827    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3828    /**
3829     * Get if this window is an illume conformant window
3830     *
3831     * @param obj The window object
3832     * @return A boolean if this window is illume conformant or not
3833     */
3834    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3835    /**
3836     * Set a window to be an illume quickpanel window
3837     *
3838     * By default window objects are not quickpanel windows.
3839     *
3840     * @param obj The window object
3841     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3842     */
3843    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3844    /**
3845     * Get if this window is a quickpanel or not
3846     *
3847     * @param obj The window object
3848     * @return A boolean if this window is a quickpanel or not
3849     */
3850    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3851    /**
3852     * Set the major priority of a quickpanel window
3853     *
3854     * @param obj The window object
3855     * @param priority The major priority for this quickpanel
3856     */
3857    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3858    /**
3859     * Get the major priority of a quickpanel window
3860     *
3861     * @param obj The window object
3862     * @return The major priority of this quickpanel
3863     */
3864    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3865    /**
3866     * Set the minor priority of a quickpanel window
3867     *
3868     * @param obj The window object
3869     * @param priority The minor priority for this quickpanel
3870     */
3871    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3872    /**
3873     * Get the minor priority of a quickpanel window
3874     *
3875     * @param obj The window object
3876     * @return The minor priority of this quickpanel
3877     */
3878    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3879    /**
3880     * Set which zone this quickpanel should appear in
3881     *
3882     * @param obj The window object
3883     * @param zone The requested zone for this quickpanel
3884     */
3885    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
3886    /**
3887     * Get which zone this quickpanel should appear in
3888     *
3889     * @param obj The window object
3890     * @return The requested zone for this quickpanel
3891     */
3892    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3893    /**
3894     * Set the window to be skipped by keyboard focus
3895     *
3896     * This sets the window to be skipped by normal keyboard input. This means
3897     * a window manager will be asked to not focus this window as well as omit
3898     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
3899     *
3900     * Call this and enable it on a window BEFORE you show it for the first time,
3901     * otherwise it may have no effect.
3902     *
3903     * Use this for windows that have only output information or might only be
3904     * interacted with by the mouse or fingers, and never for typing input.
3905     * Be careful that this may have side-effects like making the window
3906     * non-accessible in some cases unless the window is specially handled. Use
3907     * this with care.
3908     *
3909     * @param obj The window object
3910     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
3911     */
3912    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
3913    /**
3914     * Send a command to the windowing environment
3915     *
3916     * This is intended to work in touchscreen or small screen device
3917     * environments where there is a more simplistic window management policy in
3918     * place. This uses the window object indicated to select which part of the
3919     * environment to control (the part that this window lives in), and provides
3920     * a command and an optional parameter structure (use NULL for this if not
3921     * needed).
3922     *
3923     * @param obj The window object that lives in the environment to control
3924     * @param command The command to send
3925     * @param params Optional parameters for the command
3926     */
3927    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
3928    /**
3929     * Get the inlined image object handle
3930     *
3931     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
3932     * then the window is in fact an evas image object inlined in the parent
3933     * canvas. You can get this object (be careful to not manipulate it as it
3934     * is under control of elementary), and use it to do things like get pixel
3935     * data, save the image to a file, etc.
3936     *
3937     * @param obj The window object to get the inlined image from
3938     * @return The inlined image object, or NULL if none exists
3939     */
3940    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
3941    /**
3942     * Set the enabled status for the focus highlight in a window
3943     *
3944     * This function will enable or disable the focus highlight only for the
3945     * given window, regardless of the global setting for it
3946     *
3947     * @param obj The window where to enable the highlight
3948     * @param enabled The enabled value for the highlight
3949     */
3950    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
3951    /**
3952     * Get the enabled value of the focus highlight for this window
3953     *
3954     * @param obj The window in which to check if the focus highlight is enabled
3955     *
3956     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
3957     */
3958    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3959    /**
3960     * Set the style for the focus highlight on this window
3961     *
3962     * Sets the style to use for theming the highlight of focused objects on
3963     * the given window. If @p style is NULL, the default will be used.
3964     *
3965     * @param obj The window where to set the style
3966     * @param style The style to set
3967     */
3968    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
3969    /**
3970     * Get the style set for the focus highlight object
3971     *
3972     * Gets the style set for this windows highilght object, or NULL if none
3973     * is set.
3974     *
3975     * @param obj The window to retrieve the highlights style from
3976     *
3977     * @return The style set or NULL if none was. Default is used in that case.
3978     */
3979    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3980    /*...
3981     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
3982     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
3983     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
3984     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
3985     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
3986     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
3987     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
3988     *
3989     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
3990     * (blank mouse, private mouse obj, defaultmouse)
3991     *
3992     */
3993    /**
3994     * Sets the keyboard mode of the window.
3995     *
3996     * @param obj The window object
3997     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
3998     */
3999    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4000    /**
4001     * Gets the keyboard mode of the window.
4002     *
4003     * @param obj The window object
4004     * @return The mode, one of #Elm_Win_Keyboard_Mode
4005     */
4006    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4007    /**
4008     * Sets whether the window is a keyboard.
4009     *
4010     * @param obj The window object
4011     * @param is_keyboard If true, the window is a virtual keyboard
4012     */
4013    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4014    /**
4015     * Gets whether the window is a keyboard.
4016     *
4017     * @param obj The window object
4018     * @return If the window is a virtual keyboard
4019     */
4020    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4021
4022    /**
4023     * Get the screen position of a window.
4024     *
4025     * @param obj The window object
4026     * @param x The int to store the x coordinate to
4027     * @param y The int to store the y coordinate to
4028     */
4029    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4030    /**
4031     * @}
4032     */
4033
4034    /**
4035     * @defgroup Inwin Inwin
4036     *
4037     * @image html img/widget/inwin/preview-00.png
4038     * @image latex img/widget/inwin/preview-00.eps
4039     * @image html img/widget/inwin/preview-01.png
4040     * @image latex img/widget/inwin/preview-01.eps
4041     * @image html img/widget/inwin/preview-02.png
4042     * @image latex img/widget/inwin/preview-02.eps
4043     *
4044     * An inwin is a window inside a window that is useful for a quick popup.
4045     * It does not hover.
4046     *
4047     * It works by creating an object that will occupy the entire window, so it
4048     * must be created using an @ref Win "elm_win" as parent only. The inwin
4049     * object can be hidden or restacked below every other object if it's
4050     * needed to show what's behind it without destroying it. If this is done,
4051     * the elm_win_inwin_activate() function can be used to bring it back to
4052     * full visibility again.
4053     *
4054     * There are three styles available in the default theme. These are:
4055     * @li default: The inwin is sized to take over most of the window it's
4056     * placed in.
4057     * @li minimal: The size of the inwin will be the minimum necessary to show
4058     * its contents.
4059     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4060     * possible, but it's sized vertically the most it needs to fit its\
4061     * contents.
4062     *
4063     * Some examples of Inwin can be found in the following:
4064     * @li @ref inwin_example_01
4065     *
4066     * @{
4067     */
4068    /**
4069     * Adds an inwin to the current window
4070     *
4071     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4072     * Never call this function with anything other than the top-most window
4073     * as its parameter, unless you are fond of undefined behavior.
4074     *
4075     * After creating the object, the widget will set itself as resize object
4076     * for the window with elm_win_resize_object_add(), so when shown it will
4077     * appear to cover almost the entire window (how much of it depends on its
4078     * content and the style used). It must not be added into other container
4079     * objects and it needs not be moved or resized manually.
4080     *
4081     * @param parent The parent object
4082     * @return The new object or NULL if it cannot be created
4083     */
4084    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4085    /**
4086     * Activates an inwin object, ensuring its visibility
4087     *
4088     * This function will make sure that the inwin @p obj is completely visible
4089     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4090     * to the front. It also sets the keyboard focus to it, which will be passed
4091     * onto its content.
4092     *
4093     * The object's theme will also receive the signal "elm,action,show" with
4094     * source "elm".
4095     *
4096     * @param obj The inwin to activate
4097     */
4098    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4099    /**
4100     * Set the content of an inwin object.
4101     *
4102     * Once the content object is set, a previously set one will be deleted.
4103     * If you want to keep that old content object, use the
4104     * elm_win_inwin_content_unset() function.
4105     *
4106     * @param obj The inwin object
4107     * @param content The object to set as content
4108     */
4109    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4110    /**
4111     * Get the content of an inwin object.
4112     *
4113     * Return the content object which is set for this widget.
4114     *
4115     * The returned object is valid as long as the inwin is still alive and no
4116     * other content is set on it. Deleting the object will notify the inwin
4117     * about it and this one will be left empty.
4118     *
4119     * If you need to remove an inwin's content to be reused somewhere else,
4120     * see elm_win_inwin_content_unset().
4121     *
4122     * @param obj The inwin object
4123     * @return The content that is being used
4124     */
4125    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4126    /**
4127     * Unset the content of an inwin object.
4128     *
4129     * Unparent and return the content object which was set for this widget.
4130     *
4131     * @param obj The inwin object
4132     * @return The content that was being used
4133     */
4134    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4135    /**
4136     * @}
4137     */
4138    /* X specific calls - won't work on non-x engines (return 0) */
4139
4140    /**
4141     * Get the Ecore_X_Window of an Evas_Object
4142     *
4143     * @param obj The object
4144     *
4145     * @return The Ecore_X_Window of @p obj
4146     *
4147     * @ingroup Win
4148     */
4149    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4150
4151    /* smart callbacks called:
4152     * "delete,request" - the user requested to delete the window
4153     * "focus,in" - window got focus
4154     * "focus,out" - window lost focus
4155     * "moved" - window that holds the canvas was moved
4156     */
4157
4158    /**
4159     * @defgroup Bg Bg
4160     *
4161     * @image html img/widget/bg/preview-00.png
4162     * @image latex img/widget/bg/preview-00.eps
4163     *
4164     * @brief Background object, used for setting a solid color, image or Edje
4165     * group as background to a window or any container object.
4166     *
4167     * The bg object is used for setting a solid background to a window or
4168     * packing into any container object. It works just like an image, but has
4169     * some properties useful to a background, like setting it to tiled,
4170     * centered, scaled or stretched.
4171     *
4172     * Here is some sample code using it:
4173     * @li @ref bg_01_example_page
4174     * @li @ref bg_02_example_page
4175     * @li @ref bg_03_example_page
4176     */
4177
4178    /* bg */
4179    typedef enum _Elm_Bg_Option
4180      {
4181         ELM_BG_OPTION_CENTER,  /**< center the background */
4182         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4183         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4184         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4185      } Elm_Bg_Option;
4186
4187    /**
4188     * Add a new background to the parent
4189     *
4190     * @param parent The parent object
4191     * @return The new object or NULL if it cannot be created
4192     *
4193     * @ingroup Bg
4194     */
4195    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4196
4197    /**
4198     * Set the file (image or edje) used for the background
4199     *
4200     * @param obj The bg object
4201     * @param file The file path
4202     * @param group Optional key (group in Edje) within the file
4203     *
4204     * This sets the image file used in the background object. The image (or edje)
4205     * will be stretched (retaining aspect if its an image file) to completely fill
4206     * the bg object. This may mean some parts are not visible.
4207     *
4208     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4209     * even if @p file is NULL.
4210     *
4211     * @ingroup Bg
4212     */
4213    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4214
4215    /**
4216     * Get the file (image or edje) used for the background
4217     *
4218     * @param obj The bg object
4219     * @param file The file path
4220     * @param group Optional key (group in Edje) within the file
4221     *
4222     * @ingroup Bg
4223     */
4224    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4225
4226    /**
4227     * Set the option used for the background image
4228     *
4229     * @param obj The bg object
4230     * @param option The desired background option (TILE, SCALE)
4231     *
4232     * This sets the option used for manipulating the display of the background
4233     * image. The image can be tiled or scaled.
4234     *
4235     * @ingroup Bg
4236     */
4237    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4238
4239    /**
4240     * Get the option used for the background image
4241     *
4242     * @param obj The bg object
4243     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4244     *
4245     * @ingroup Bg
4246     */
4247    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4248    /**
4249     * Set the option used for the background color
4250     *
4251     * @param obj The bg object
4252     * @param r
4253     * @param g
4254     * @param b
4255     *
4256     * This sets the color used for the background rectangle. Its range goes
4257     * from 0 to 255.
4258     *
4259     * @ingroup Bg
4260     */
4261    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4262    /**
4263     * Get the option used for the background color
4264     *
4265     * @param obj The bg object
4266     * @param r
4267     * @param g
4268     * @param b
4269     *
4270     * @ingroup Bg
4271     */
4272    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4273
4274    /**
4275     * Set the overlay object used for the background object.
4276     *
4277     * @param obj The bg object
4278     * @param overlay The overlay object
4279     *
4280     * This provides a way for elm_bg to have an 'overlay' that will be on top
4281     * of the bg. Once the over object is set, a previously set one will be
4282     * deleted, even if you set the new one to NULL. If you want to keep that
4283     * old content object, use the elm_bg_overlay_unset() function.
4284     *
4285     * @ingroup Bg
4286     */
4287
4288    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4289
4290    /**
4291     * Get the overlay object used for the background object.
4292     *
4293     * @param obj The bg object
4294     * @return The content that is being used
4295     *
4296     * Return the content object which is set for this widget
4297     *
4298     * @ingroup Bg
4299     */
4300    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4301
4302    /**
4303     * Get the overlay object used for the background object.
4304     *
4305     * @param obj The bg object
4306     * @return The content that was being used
4307     *
4308     * Unparent and return the overlay object which was set for this widget
4309     *
4310     * @ingroup Bg
4311     */
4312    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4313
4314    /**
4315     * Set the size of the pixmap representation of the image.
4316     *
4317     * This option just makes sense if an image is going to be set in the bg.
4318     *
4319     * @param obj The bg object
4320     * @param w The new width of the image pixmap representation.
4321     * @param h The new height of the image pixmap representation.
4322     *
4323     * This function sets a new size for pixmap representation of the given bg
4324     * image. It allows the image to be loaded already in the specified size,
4325     * reducing the memory usage and load time when loading a big image with load
4326     * size set to a smaller size.
4327     *
4328     * NOTE: this is just a hint, the real size of the pixmap may differ
4329     * depending on the type of image being loaded, being bigger than requested.
4330     *
4331     * @ingroup Bg
4332     */
4333    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4334    /* smart callbacks called:
4335     */
4336
4337    /**
4338     * @defgroup Icon Icon
4339     *
4340     * @image html img/widget/icon/preview-00.png
4341     * @image latex img/widget/icon/preview-00.eps
4342     *
4343     * An object that provides standard icon images (delete, edit, arrows, etc.)
4344     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4345     *
4346     * The icon image requested can be in the elementary theme, or in the
4347     * freedesktop.org paths. It's possible to set the order of preference from
4348     * where the image will be used.
4349     *
4350     * This API is very similar to @ref Image, but with ready to use images.
4351     *
4352     * Default images provided by the theme are described below.
4353     *
4354     * The first list contains icons that were first intended to be used in
4355     * toolbars, but can be used in many other places too:
4356     * @li home
4357     * @li close
4358     * @li apps
4359     * @li arrow_up
4360     * @li arrow_down
4361     * @li arrow_left
4362     * @li arrow_right
4363     * @li chat
4364     * @li clock
4365     * @li delete
4366     * @li edit
4367     * @li refresh
4368     * @li folder
4369     * @li file
4370     *
4371     * Now some icons that were designed to be used in menus (but again, you can
4372     * use them anywhere else):
4373     * @li menu/home
4374     * @li menu/close
4375     * @li menu/apps
4376     * @li menu/arrow_up
4377     * @li menu/arrow_down
4378     * @li menu/arrow_left
4379     * @li menu/arrow_right
4380     * @li menu/chat
4381     * @li menu/clock
4382     * @li menu/delete
4383     * @li menu/edit
4384     * @li menu/refresh
4385     * @li menu/folder
4386     * @li menu/file
4387     *
4388     * And here we have some media player specific icons:
4389     * @li media_player/forward
4390     * @li media_player/info
4391     * @li media_player/next
4392     * @li media_player/pause
4393     * @li media_player/play
4394     * @li media_player/prev
4395     * @li media_player/rewind
4396     * @li media_player/stop
4397     *
4398     * Signals that you can add callbacks for are:
4399     *
4400     * "clicked" - This is called when a user has clicked the icon
4401     *
4402     * An example of usage for this API follows:
4403     * @li @ref tutorial_icon
4404     */
4405
4406    /**
4407     * @addtogroup Icon
4408     * @{
4409     */
4410
4411    typedef enum _Elm_Icon_Type
4412      {
4413         ELM_ICON_NONE,
4414         ELM_ICON_FILE,
4415         ELM_ICON_STANDARD
4416      } Elm_Icon_Type;
4417    /**
4418     * @enum _Elm_Icon_Lookup_Order
4419     * @typedef Elm_Icon_Lookup_Order
4420     *
4421     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4422     * theme, FDO paths, or both?
4423     *
4424     * @ingroup Icon
4425     */
4426    typedef enum _Elm_Icon_Lookup_Order
4427      {
4428         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4429         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4430         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4431         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4432      } Elm_Icon_Lookup_Order;
4433
4434    /**
4435     * Add a new icon object to the parent.
4436     *
4437     * @param parent The parent object
4438     * @return The new object or NULL if it cannot be created
4439     *
4440     * @see elm_icon_file_set()
4441     *
4442     * @ingroup Icon
4443     */
4444    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4445    /**
4446     * Set the file that will be used as icon.
4447     *
4448     * @param obj The icon object
4449     * @param file The path to file that will be used as icon image
4450     * @param group The group that the icon belongs to in edje file
4451     *
4452     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4453     *
4454     * @note The icon image set by this function can be changed by
4455     * elm_icon_standard_set().
4456     *
4457     * @see elm_icon_file_get()
4458     *
4459     * @ingroup Icon
4460     */
4461    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4462    /**
4463     * Set a location in memory to be used as an icon
4464     *
4465     * @param obj The icon object
4466     * @param img The binary data that will be used as an image
4467     * @param size The size of binary data @p img
4468     * @param format Optional format of @p img to pass to the image loader
4469     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4470     *
4471     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4472     *
4473     * @note The icon image set by this function can be changed by
4474     * elm_icon_standard_set().
4475     *
4476     * @ingroup Icon
4477     */
4478    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);
4479    /**
4480     * Get the file that will be used as icon.
4481     *
4482     * @param obj The icon object
4483     * @param file The path to file that will be used as icon icon image
4484     * @param group The group that the icon belongs to in edje file
4485     *
4486     * @see elm_icon_file_set()
4487     *
4488     * @ingroup Icon
4489     */
4490    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4491    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4492    /**
4493     * Set the icon by icon standards names.
4494     *
4495     * @param obj The icon object
4496     * @param name The icon name
4497     *
4498     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4499     *
4500     * For example, freedesktop.org defines standard icon names such as "home",
4501     * "network", etc. There can be different icon sets to match those icon
4502     * keys. The @p name given as parameter is one of these "keys", and will be
4503     * used to look in the freedesktop.org paths and elementary theme. One can
4504     * change the lookup order with elm_icon_order_lookup_set().
4505     *
4506     * If name is not found in any of the expected locations and it is the
4507     * absolute path of an image file, this image will be used.
4508     *
4509     * @note The icon image set by this function can be changed by
4510     * elm_icon_file_set().
4511     *
4512     * @see elm_icon_standard_get()
4513     * @see elm_icon_file_set()
4514     *
4515     * @ingroup Icon
4516     */
4517    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4518    /**
4519     * Get the icon name set by icon standard names.
4520     *
4521     * @param obj The icon object
4522     * @return The icon name
4523     *
4524     * If the icon image was set using elm_icon_file_set() instead of
4525     * elm_icon_standard_set(), then this function will return @c NULL.
4526     *
4527     * @see elm_icon_standard_set()
4528     *
4529     * @ingroup Icon
4530     */
4531    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4532    /**
4533     * Set the smooth effect for an icon object.
4534     *
4535     * @param obj The icon object
4536     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4537     * otherwise. Default is @c EINA_TRUE.
4538     *
4539     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4540     * scaling provides a better resulting image, but is slower.
4541     *
4542     * The smooth scaling should be disabled when making animations that change
4543     * the icon size, since they will be faster. Animations that don't require
4544     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4545     * is already scaled, since the scaled icon image will be cached).
4546     *
4547     * @see elm_icon_smooth_get()
4548     *
4549     * @ingroup Icon
4550     */
4551    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4552    /**
4553     * Get the smooth effect for an icon object.
4554     *
4555     * @param obj The icon object
4556     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4557     *
4558     * @see elm_icon_smooth_set()
4559     *
4560     * @ingroup Icon
4561     */
4562    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4563    /**
4564     * Disable scaling of this object.
4565     *
4566     * @param obj The icon object.
4567     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4568     * otherwise. Default is @c EINA_FALSE.
4569     *
4570     * This function disables scaling of the icon object through the function
4571     * elm_object_scale_set(). However, this does not affect the object
4572     * size/resize in any way. For that effect, take a look at
4573     * elm_icon_scale_set().
4574     *
4575     * @see elm_icon_no_scale_get()
4576     * @see elm_icon_scale_set()
4577     * @see elm_object_scale_set()
4578     *
4579     * @ingroup Icon
4580     */
4581    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4582    /**
4583     * Get whether scaling is disabled on the object.
4584     *
4585     * @param obj The icon object
4586     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4587     *
4588     * @see elm_icon_no_scale_set()
4589     *
4590     * @ingroup Icon
4591     */
4592    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4593    /**
4594     * Set if the object is (up/down) resizeable.
4595     *
4596     * @param obj The icon object
4597     * @param scale_up A bool to set if the object is resizeable up. Default is
4598     * @c EINA_TRUE.
4599     * @param scale_down A bool to set if the object is resizeable down. Default
4600     * is @c EINA_TRUE.
4601     *
4602     * This function limits the icon object resize ability. If @p scale_up is set to
4603     * @c EINA_FALSE, the object can't have its height or width resized to a value
4604     * higher than the original icon size. Same is valid for @p scale_down.
4605     *
4606     * @see elm_icon_scale_get()
4607     *
4608     * @ingroup Icon
4609     */
4610    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4611    /**
4612     * Get if the object is (up/down) resizeable.
4613     *
4614     * @param obj The icon object
4615     * @param scale_up A bool to set if the object is resizeable up
4616     * @param scale_down A bool to set if the object is resizeable down
4617     *
4618     * @see elm_icon_scale_set()
4619     *
4620     * @ingroup Icon
4621     */
4622    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4623    /**
4624     * Get the object's image size
4625     *
4626     * @param obj The icon object
4627     * @param w A pointer to store the width in
4628     * @param h A pointer to store the height in
4629     *
4630     * @ingroup Icon
4631     */
4632    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4633    /**
4634     * Set if the icon fill the entire object area.
4635     *
4636     * @param obj The icon object
4637     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4638     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4639     *
4640     * When the icon object is resized to a different aspect ratio from the
4641     * original icon image, the icon image will still keep its aspect. This flag
4642     * tells how the image should fill the object's area. They are: keep the
4643     * entire icon inside the limits of height and width of the object (@p
4644     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4645     * of the object, and the icon will fill the entire object (@p fill_outside
4646     * is @c EINA_TRUE).
4647     *
4648     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4649     * retain property to false. Thus, the icon image will always keep its
4650     * original aspect ratio.
4651     *
4652     * @see elm_icon_fill_outside_get()
4653     * @see elm_image_fill_outside_set()
4654     *
4655     * @ingroup Icon
4656     */
4657    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4658    /**
4659     * Get if the object is filled outside.
4660     *
4661     * @param obj The icon object
4662     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4663     *
4664     * @see elm_icon_fill_outside_set()
4665     *
4666     * @ingroup Icon
4667     */
4668    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4669    /**
4670     * Set the prescale size for the icon.
4671     *
4672     * @param obj The icon object
4673     * @param size The prescale size. This value is used for both width and
4674     * height.
4675     *
4676     * This function sets a new size for pixmap representation of the given
4677     * icon. It allows the icon to be loaded already in the specified size,
4678     * reducing the memory usage and load time when loading a big icon with load
4679     * size set to a smaller size.
4680     *
4681     * It's equivalent to the elm_bg_load_size_set() function for bg.
4682     *
4683     * @note this is just a hint, the real size of the pixmap may differ
4684     * depending on the type of icon being loaded, being bigger than requested.
4685     *
4686     * @see elm_icon_prescale_get()
4687     * @see elm_bg_load_size_set()
4688     *
4689     * @ingroup Icon
4690     */
4691    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4692    /**
4693     * Get the prescale size for the icon.
4694     *
4695     * @param obj The icon object
4696     * @return The prescale size
4697     *
4698     * @see elm_icon_prescale_set()
4699     *
4700     * @ingroup Icon
4701     */
4702    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4703    /**
4704     * Sets the icon lookup order used by elm_icon_standard_set().
4705     *
4706     * @param obj The icon object
4707     * @param order The icon lookup order (can be one of
4708     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4709     * or ELM_ICON_LOOKUP_THEME)
4710     *
4711     * @see elm_icon_order_lookup_get()
4712     * @see Elm_Icon_Lookup_Order
4713     *
4714     * @ingroup Icon
4715     */
4716    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4717    /**
4718     * Gets the icon lookup order.
4719     *
4720     * @param obj The icon object
4721     * @return The icon lookup order
4722     *
4723     * @see elm_icon_order_lookup_set()
4724     * @see Elm_Icon_Lookup_Order
4725     *
4726     * @ingroup Icon
4727     */
4728    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4729
4730    /**
4731     * @}
4732     */
4733
4734    /**
4735     * @defgroup Image Image
4736     *
4737     * @image html img/widget/image/preview-00.png
4738     * @image latex img/widget/image/preview-00.eps
4739     *
4740     * An object that allows one to load an image file to it. It can be used
4741     * anywhere like any other elementary widget.
4742     *
4743     * This widget provides most of the functionality provided from @ref Bg or @ref
4744     * Icon, but with a slightly different API (use the one that fits better your
4745     * needs).
4746     *
4747     * The features not provided by those two other image widgets are:
4748     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4749     * @li change the object orientation with elm_image_orient_set();
4750     * @li and turning the image editable with elm_image_editable_set().
4751     *
4752     * Signals that you can add callbacks for are:
4753     *
4754     * @li @c "clicked" - This is called when a user has clicked the image
4755     *
4756     * An example of usage for this API follows:
4757     * @li @ref tutorial_image
4758     */
4759
4760    /**
4761     * @addtogroup Image
4762     * @{
4763     */
4764
4765    /**
4766     * @enum _Elm_Image_Orient
4767     * @typedef Elm_Image_Orient
4768     *
4769     * Possible orientation options for elm_image_orient_set().
4770     *
4771     * @image html elm_image_orient_set.png
4772     * @image latex elm_image_orient_set.eps width=\textwidth
4773     *
4774     * @ingroup Image
4775     */
4776    typedef enum _Elm_Image_Orient
4777      {
4778         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4779         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4780         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4781         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4782         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4783         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4784         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4785         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4786      } Elm_Image_Orient;
4787
4788    /**
4789     * Add a new image to the parent.
4790     *
4791     * @param parent The parent object
4792     * @return The new object or NULL if it cannot be created
4793     *
4794     * @see elm_image_file_set()
4795     *
4796     * @ingroup Image
4797     */
4798    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4799    /**
4800     * Set the file that will be used as image.
4801     *
4802     * @param obj The image object
4803     * @param file The path to file that will be used as image
4804     * @param group The group that the image belongs in edje file (if it's an
4805     * edje image)
4806     *
4807     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4808     *
4809     * @see elm_image_file_get()
4810     *
4811     * @ingroup Image
4812     */
4813    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4814    /**
4815     * Get the file that will be used as image.
4816     *
4817     * @param obj The image object
4818     * @param file The path to file
4819     * @param group The group that the image belongs in edje file
4820     *
4821     * @see elm_image_file_set()
4822     *
4823     * @ingroup Image
4824     */
4825    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4826    /**
4827     * Set the smooth effect for an image.
4828     *
4829     * @param obj The image object
4830     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4831     * otherwise. Default is @c EINA_TRUE.
4832     *
4833     * Set the scaling algorithm to be used when scaling the image. Smooth
4834     * scaling provides a better resulting image, but is slower.
4835     *
4836     * The smooth scaling should be disabled when making animations that change
4837     * the image size, since it will be faster. Animations that don't require
4838     * resizing of the image can keep the smooth scaling enabled (even if the
4839     * image is already scaled, since the scaled image will be cached).
4840     *
4841     * @see elm_image_smooth_get()
4842     *
4843     * @ingroup Image
4844     */
4845    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4846    /**
4847     * Get the smooth effect for an image.
4848     *
4849     * @param obj The image object
4850     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4851     *
4852     * @see elm_image_smooth_get()
4853     *
4854     * @ingroup Image
4855     */
4856    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4857    /**
4858     * Gets the current size of the image.
4859     *
4860     * @param obj The image object.
4861     * @param w Pointer to store width, or NULL.
4862     * @param h Pointer to store height, or NULL.
4863     *
4864     * This is the real size of the image, not the size of the object.
4865     *
4866     * On error, neither w or h will be written.
4867     *
4868     * @ingroup Image
4869     */
4870    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4871    /**
4872     * Disable scaling of this object.
4873     *
4874     * @param obj The image object.
4875     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4876     * otherwise. Default is @c EINA_FALSE.
4877     *
4878     * This function disables scaling of the elm_image widget through the
4879     * function elm_object_scale_set(). However, this does not affect the widget
4880     * size/resize in any way. For that effect, take a look at
4881     * elm_image_scale_set().
4882     *
4883     * @see elm_image_no_scale_get()
4884     * @see elm_image_scale_set()
4885     * @see elm_object_scale_set()
4886     *
4887     * @ingroup Image
4888     */
4889    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4890    /**
4891     * Get whether scaling is disabled on the object.
4892     *
4893     * @param obj The image object
4894     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4895     *
4896     * @see elm_image_no_scale_set()
4897     *
4898     * @ingroup Image
4899     */
4900    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4901    /**
4902     * Set if the object is (up/down) resizeable.
4903     *
4904     * @param obj The image object
4905     * @param scale_up A bool to set if the object is resizeable up. Default is
4906     * @c EINA_TRUE.
4907     * @param scale_down A bool to set if the object is resizeable down. Default
4908     * is @c EINA_TRUE.
4909     *
4910     * This function limits the image resize ability. If @p scale_up is set to
4911     * @c EINA_FALSE, the object can't have its height or width resized to a value
4912     * higher than the original image size. Same is valid for @p scale_down.
4913     *
4914     * @see elm_image_scale_get()
4915     *
4916     * @ingroup Image
4917     */
4918    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4919    /**
4920     * Get if the object is (up/down) resizeable.
4921     *
4922     * @param obj The image object
4923     * @param scale_up A bool to set if the object is resizeable up
4924     * @param scale_down A bool to set if the object is resizeable down
4925     *
4926     * @see elm_image_scale_set()
4927     *
4928     * @ingroup Image
4929     */
4930    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4931    /**
4932     * Set if the image fill the entire object area when keeping the aspect ratio.
4933     *
4934     * @param obj The image object
4935     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4936     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4937     *
4938     * When the image should keep its aspect ratio even if resized to another
4939     * aspect ratio, there are two possibilities to resize it: keep the entire
4940     * image inside the limits of height and width of the object (@p fill_outside
4941     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
4942     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
4943     *
4944     * @note This option will have no effect if
4945     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
4946     *
4947     * @see elm_image_fill_outside_get()
4948     * @see elm_image_aspect_ratio_retained_set()
4949     *
4950     * @ingroup Image
4951     */
4952    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4953    /**
4954     * Get if the object is filled outside
4955     *
4956     * @param obj The image object
4957     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4958     *
4959     * @see elm_image_fill_outside_set()
4960     *
4961     * @ingroup Image
4962     */
4963    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4964    /**
4965     * Set the prescale size for the image
4966     *
4967     * @param obj The image object
4968     * @param size The prescale size. This value is used for both width and
4969     * height.
4970     *
4971     * This function sets a new size for pixmap representation of the given
4972     * image. It allows the image to be loaded already in the specified size,
4973     * reducing the memory usage and load time when loading a big image with load
4974     * size set to a smaller size.
4975     *
4976     * It's equivalent to the elm_bg_load_size_set() function for bg.
4977     *
4978     * @note this is just a hint, the real size of the pixmap may differ
4979     * depending on the type of image being loaded, being bigger than requested.
4980     *
4981     * @see elm_image_prescale_get()
4982     * @see elm_bg_load_size_set()
4983     *
4984     * @ingroup Image
4985     */
4986    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4987    /**
4988     * Get the prescale size for the image
4989     *
4990     * @param obj The image object
4991     * @return The prescale size
4992     *
4993     * @see elm_image_prescale_set()
4994     *
4995     * @ingroup Image
4996     */
4997    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4998    /**
4999     * Set the image orientation.
5000     *
5001     * @param obj The image object
5002     * @param orient The image orientation
5003     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5004     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5005     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5006     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5007     *  Default is #ELM_IMAGE_ORIENT_NONE.
5008     *
5009     * This function allows to rotate or flip the given image.
5010     *
5011     * @see elm_image_orient_get()
5012     * @see @ref Elm_Image_Orient
5013     *
5014     * @ingroup Image
5015     */
5016    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5017    /**
5018     * Get the image orientation.
5019     *
5020     * @param obj The image object
5021     * @return The image orientation
5022     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5023     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5024     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5025     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5026     *
5027     * @see elm_image_orient_set()
5028     * @see @ref Elm_Image_Orient
5029     *
5030     * @ingroup Image
5031     */
5032    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5033    /**
5034     * Make the image 'editable'.
5035     *
5036     * @param obj Image object.
5037     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5038     *
5039     * This means the image is a valid drag target for drag and drop, and can be
5040     * cut or pasted too.
5041     *
5042     * @ingroup Image
5043     */
5044    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5045    /**
5046     * Make the image 'editable'.
5047     *
5048     * @param obj Image object.
5049     * @return Editability.
5050     *
5051     * This means the image is a valid drag target for drag and drop, and can be
5052     * cut or pasted too.
5053     *
5054     * @ingroup Image
5055     */
5056    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5057    /**
5058     * Get the basic Evas_Image object from this object (widget).
5059     *
5060     * @param obj The image object to get the inlined image from
5061     * @return The inlined image object, or NULL if none exists
5062     *
5063     * This function allows one to get the underlying @c Evas_Object of type
5064     * Image from this elementary widget. It can be useful to do things like get
5065     * the pixel data, save the image to a file, etc.
5066     *
5067     * @note Be careful to not manipulate it, as it is under control of
5068     * elementary.
5069     *
5070     * @ingroup Image
5071     */
5072    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5073    /**
5074     * Set whether the original aspect ratio of the image should be kept on resize.
5075     *
5076     * @param obj The image object.
5077     * @param retained @c EINA_TRUE if the image should retain the aspect,
5078     * @c EINA_FALSE otherwise.
5079     *
5080     * The original aspect ratio (width / height) of the image is usually
5081     * distorted to match the object's size. Enabling this option will retain
5082     * this original aspect, and the way that the image is fit into the object's
5083     * area depends on the option set by elm_image_fill_outside_set().
5084     *
5085     * @see elm_image_aspect_ratio_retained_get()
5086     * @see elm_image_fill_outside_set()
5087     *
5088     * @ingroup Image
5089     */
5090    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5091    /**
5092     * Get if the object retains the original aspect ratio.
5093     *
5094     * @param obj The image object.
5095     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5096     * otherwise.
5097     *
5098     * @ingroup Image
5099     */
5100    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5101
5102    /* smart callbacks called:
5103     * "clicked" - the user clicked the image
5104     */
5105
5106    /**
5107     * @}
5108     */
5109
5110    /* glview */
5111    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5112
5113    typedef enum _Elm_GLView_Mode
5114      {
5115         ELM_GLVIEW_ALPHA   = 1,
5116         ELM_GLVIEW_DEPTH   = 2,
5117         ELM_GLVIEW_STENCIL = 4
5118      } Elm_GLView_Mode;
5119
5120    /**
5121     * Defines a policy for the glview resizing.
5122     *
5123     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5124     */
5125    typedef enum _Elm_GLView_Resize_Policy
5126      {
5127         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5128         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5129      } Elm_GLView_Resize_Policy;
5130
5131    typedef enum _Elm_GLView_Render_Policy
5132      {
5133         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5134         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5135      } Elm_GLView_Render_Policy;
5136
5137    /**
5138     * @defgroup GLView
5139     *
5140     * A simple GLView widget that allows GL rendering.
5141     *
5142     * Signals that you can add callbacks for are:
5143     *
5144     * @{
5145     */
5146
5147    /**
5148     * Add a new glview to the parent
5149     *
5150     * @param parent The parent object
5151     * @return The new object or NULL if it cannot be created
5152     *
5153     * @ingroup GLView
5154     */
5155    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5156
5157    /**
5158     * Sets the size of the glview
5159     *
5160     * @param obj The glview object
5161     * @param width width of the glview object
5162     * @param height height of the glview object
5163     *
5164     * @ingroup GLView
5165     */
5166    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5167
5168    /**
5169     * Gets the size of the glview.
5170     *
5171     * @param obj The glview object
5172     * @param width width of the glview object
5173     * @param height height of the glview object
5174     *
5175     * Note that this function returns the actual image size of the
5176     * glview.  This means that when the scale policy is set to
5177     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5178     * size.
5179     *
5180     * @ingroup GLView
5181     */
5182    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5183
5184    /**
5185     * Gets the gl api struct for gl rendering
5186     *
5187     * @param obj The glview object
5188     * @return The api object or NULL if it cannot be created
5189     *
5190     * @ingroup GLView
5191     */
5192    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5193
5194    /**
5195     * Set the mode of the GLView. Supports Three simple modes.
5196     *
5197     * @param obj The glview object
5198     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5199     * @return True if set properly.
5200     *
5201     * @ingroup GLView
5202     */
5203    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5204
5205    /**
5206     * Set the resize policy for the glview object.
5207     *
5208     * @param obj The glview object.
5209     * @param policy The scaling policy.
5210     *
5211     * By default, the resize policy is set to
5212     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5213     * destroys the previous surface and recreates the newly specified
5214     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5215     * however, glview only scales the image object and not the underlying
5216     * GL Surface.
5217     *
5218     * @ingroup GLView
5219     */
5220    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5221
5222    /**
5223     * Set the render policy for the glview object.
5224     *
5225     * @param obj The glview object.
5226     * @param policy The render policy.
5227     *
5228     * By default, the render policy is set to
5229     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5230     * that during the render loop, glview is only redrawn if it needs
5231     * to be redrawn. (i.e. When it is visible) If the policy is set to
5232     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5233     * whether it is visible/need redrawing or not.
5234     *
5235     * @ingroup GLView
5236     */
5237    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5238
5239    /**
5240     * Set the init function that runs once in the main loop.
5241     *
5242     * @param obj The glview object.
5243     * @param func The init function to be registered.
5244     *
5245     * The registered init function gets called once during the render loop.
5246     *
5247     * @ingroup GLView
5248     */
5249    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5250
5251    /**
5252     * Set the render function that runs in the main loop.
5253     *
5254     * @param obj The glview object.
5255     * @param func The delete function to be registered.
5256     *
5257     * The registered del function gets called when GLView object is deleted.
5258     *
5259     * @ingroup GLView
5260     */
5261    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5262
5263    /**
5264     * Set the resize function that gets called when resize happens.
5265     *
5266     * @param obj The glview object.
5267     * @param func The resize function to be registered.
5268     *
5269     * @ingroup GLView
5270     */
5271    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5272
5273    /**
5274     * Set the render function that runs in the main loop.
5275     *
5276     * @param obj The glview object.
5277     * @param func The render function to be registered.
5278     *
5279     * @ingroup GLView
5280     */
5281    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5282
5283    /**
5284     * Notifies that there has been changes in the GLView.
5285     *
5286     * @param obj The glview object.
5287     *
5288     * @ingroup GLView
5289     */
5290    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5291
5292    /**
5293     * @}
5294     */
5295
5296    /* box */
5297    /**
5298     * @defgroup Box Box
5299     *
5300     * @image html img/widget/box/preview-00.png
5301     * @image latex img/widget/box/preview-00.eps width=\textwidth
5302     *
5303     * @image html img/box.png
5304     * @image latex img/box.eps width=\textwidth
5305     *
5306     * A box arranges objects in a linear fashion, governed by a layout function
5307     * that defines the details of this arrangement.
5308     *
5309     * By default, the box will use an internal function to set the layout to
5310     * a single row, either vertical or horizontal. This layout is affected
5311     * by a number of parameters, such as the homogeneous flag set by
5312     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5313     * elm_box_align_set() and the hints set to each object in the box.
5314     *
5315     * For this default layout, it's possible to change the orientation with
5316     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5317     * placing its elements ordered from top to bottom. When horizontal is set,
5318     * the order will go from left to right. If the box is set to be
5319     * homogeneous, every object in it will be assigned the same space, that
5320     * of the largest object. Padding can be used to set some spacing between
5321     * the cell given to each object. The alignment of the box, set with
5322     * elm_box_align_set(), determines how the bounding box of all the elements
5323     * will be placed within the space given to the box widget itself.
5324     *
5325     * The size hints of each object also affect how they are placed and sized
5326     * within the box. evas_object_size_hint_min_set() will give the minimum
5327     * size the object can have, and the box will use it as the basis for all
5328     * latter calculations. Elementary widgets set their own minimum size as
5329     * needed, so there's rarely any need to use it manually.
5330     *
5331     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5332     * used to tell whether the object will be allocated the minimum size it
5333     * needs or if the space given to it should be expanded. It's important
5334     * to realize that expanding the size given to the object is not the same
5335     * thing as resizing the object. It could very well end being a small
5336     * widget floating in a much larger empty space. If not set, the weight
5337     * for objects will normally be 0.0 for both axis, meaning the widget will
5338     * not be expanded. To take as much space possible, set the weight to
5339     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5340     *
5341     * Besides how much space each object is allocated, it's possible to control
5342     * how the widget will be placed within that space using
5343     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5344     * for both axis, meaning the object will be centered, but any value from
5345     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5346     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5347     * is -1.0, means the object will be resized to fill the entire space it
5348     * was allocated.
5349     *
5350     * In addition, customized functions to define the layout can be set, which
5351     * allow the application developer to organize the objects within the box
5352     * in any number of ways.
5353     *
5354     * The special elm_box_layout_transition() function can be used
5355     * to switch from one layout to another, animating the motion of the
5356     * children of the box.
5357     *
5358     * @note Objects should not be added to box objects using _add() calls.
5359     *
5360     * Some examples on how to use boxes follow:
5361     * @li @ref box_example_01
5362     * @li @ref box_example_02
5363     *
5364     * @{
5365     */
5366    /**
5367     * @typedef Elm_Box_Transition
5368     *
5369     * Opaque handler containing the parameters to perform an animated
5370     * transition of the layout the box uses.
5371     *
5372     * @see elm_box_transition_new()
5373     * @see elm_box_layout_set()
5374     * @see elm_box_layout_transition()
5375     */
5376    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5377
5378    /**
5379     * Add a new box to the parent
5380     *
5381     * By default, the box will be in vertical mode and non-homogeneous.
5382     *
5383     * @param parent The parent object
5384     * @return The new object or NULL if it cannot be created
5385     */
5386    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5387    /**
5388     * Set the horizontal orientation
5389     *
5390     * By default, box object arranges their contents vertically from top to
5391     * bottom.
5392     * By calling this function with @p horizontal as EINA_TRUE, the box will
5393     * become horizontal, arranging contents from left to right.
5394     *
5395     * @note This flag is ignored if a custom layout function is set.
5396     *
5397     * @param obj The box object
5398     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5399     * EINA_FALSE = vertical)
5400     */
5401    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5402    /**
5403     * Get the horizontal orientation
5404     *
5405     * @param obj The box object
5406     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5407     */
5408    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5409    /**
5410     * Set the box to arrange its children homogeneously
5411     *
5412     * If enabled, homogeneous layout makes all items the same size, according
5413     * to the size of the largest of its children.
5414     *
5415     * @note This flag is ignored if a custom layout function is set.
5416     *
5417     * @param obj The box object
5418     * @param homogeneous The homogeneous flag
5419     */
5420    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5421    /**
5422     * Get whether the box is using homogeneous mode or not
5423     *
5424     * @param obj The box object
5425     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5426     */
5427    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5428    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5429    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5430    /**
5431     * Add an object to the beginning of the pack list
5432     *
5433     * Pack @p subobj into the box @p obj, placing it first in the list of
5434     * children objects. The actual position the object will get on screen
5435     * depends on the layout used. If no custom layout is set, it will be at
5436     * the top or left, depending if the box is vertical or horizontal,
5437     * respectively.
5438     *
5439     * @param obj The box object
5440     * @param subobj The object to add to the box
5441     *
5442     * @see elm_box_pack_end()
5443     * @see elm_box_pack_before()
5444     * @see elm_box_pack_after()
5445     * @see elm_box_unpack()
5446     * @see elm_box_unpack_all()
5447     * @see elm_box_clear()
5448     */
5449    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5450    /**
5451     * Add an object at the end of the pack list
5452     *
5453     * Pack @p subobj into the box @p obj, placing it last in the list of
5454     * children objects. The actual position the object will get on screen
5455     * depends on the layout used. If no custom layout is set, it will be at
5456     * the bottom or right, depending if the box is vertical or horizontal,
5457     * respectively.
5458     *
5459     * @param obj The box object
5460     * @param subobj The object to add to the box
5461     *
5462     * @see elm_box_pack_start()
5463     * @see elm_box_pack_before()
5464     * @see elm_box_pack_after()
5465     * @see elm_box_unpack()
5466     * @see elm_box_unpack_all()
5467     * @see elm_box_clear()
5468     */
5469    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5470    /**
5471     * Adds an object to the box before the indicated object
5472     *
5473     * This will add the @p subobj to the box indicated before the object
5474     * indicated with @p before. If @p before is not already in the box, results
5475     * are undefined. Before means either to the left of the indicated object or
5476     * above it depending on orientation.
5477     *
5478     * @param obj The box object
5479     * @param subobj The object to add to the box
5480     * @param before The object before which to add it
5481     *
5482     * @see elm_box_pack_start()
5483     * @see elm_box_pack_end()
5484     * @see elm_box_pack_after()
5485     * @see elm_box_unpack()
5486     * @see elm_box_unpack_all()
5487     * @see elm_box_clear()
5488     */
5489    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5490    /**
5491     * Adds an object to the box after the indicated object
5492     *
5493     * This will add the @p subobj to the box indicated after the object
5494     * indicated with @p after. If @p after is not already in the box, results
5495     * are undefined. After means either to the right of the indicated object or
5496     * below it depending on orientation.
5497     *
5498     * @param obj The box object
5499     * @param subobj The object to add to the box
5500     * @param after The object after which to add it
5501     *
5502     * @see elm_box_pack_start()
5503     * @see elm_box_pack_end()
5504     * @see elm_box_pack_before()
5505     * @see elm_box_unpack()
5506     * @see elm_box_unpack_all()
5507     * @see elm_box_clear()
5508     */
5509    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5510    /**
5511     * Clear the box of all children
5512     *
5513     * Remove all the elements contained by the box, deleting the respective
5514     * objects.
5515     *
5516     * @param obj The box object
5517     *
5518     * @see elm_box_unpack()
5519     * @see elm_box_unpack_all()
5520     */
5521    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5522    /**
5523     * Unpack a box item
5524     *
5525     * Remove the object given by @p subobj from the box @p obj without
5526     * deleting it.
5527     *
5528     * @param obj The box object
5529     *
5530     * @see elm_box_unpack_all()
5531     * @see elm_box_clear()
5532     */
5533    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5534    /**
5535     * Remove all items from the box, without deleting them
5536     *
5537     * Clear the box from all children, but don't delete the respective objects.
5538     * If no other references of the box children exist, the objects will never
5539     * be deleted, and thus the application will leak the memory. Make sure
5540     * when using this function that you hold a reference to all the objects
5541     * in the box @p obj.
5542     *
5543     * @param obj The box object
5544     *
5545     * @see elm_box_clear()
5546     * @see elm_box_unpack()
5547     */
5548    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5549    /**
5550     * Retrieve a list of the objects packed into the box
5551     *
5552     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5553     * The order of the list corresponds to the packing order the box uses.
5554     *
5555     * You must free this list with eina_list_free() once you are done with it.
5556     *
5557     * @param obj The box object
5558     */
5559    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5560    /**
5561     * Set the space (padding) between the box's elements.
5562     *
5563     * Extra space in pixels that will be added between a box child and its
5564     * neighbors after its containing cell has been calculated. This padding
5565     * is set for all elements in the box, besides any possible padding that
5566     * individual elements may have through their size hints.
5567     *
5568     * @param obj The box object
5569     * @param horizontal The horizontal space between elements
5570     * @param vertical The vertical space between elements
5571     */
5572    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5573    /**
5574     * Get the space (padding) between the box's elements.
5575     *
5576     * @param obj The box object
5577     * @param horizontal The horizontal space between elements
5578     * @param vertical The vertical space between elements
5579     *
5580     * @see elm_box_padding_set()
5581     */
5582    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5583    /**
5584     * Set the alignment of the whole bouding box of contents.
5585     *
5586     * Sets how the bounding box containing all the elements of the box, after
5587     * their sizes and position has been calculated, will be aligned within
5588     * the space given for the whole box widget.
5589     *
5590     * @param obj The box object
5591     * @param horizontal The horizontal alignment of elements
5592     * @param vertical The vertical alignment of elements
5593     */
5594    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5595    /**
5596     * Get the alignment of the whole bouding box of contents.
5597     *
5598     * @param obj The box object
5599     * @param horizontal The horizontal alignment of elements
5600     * @param vertical The vertical alignment of elements
5601     *
5602     * @see elm_box_align_set()
5603     */
5604    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5605
5606    /**
5607     * Set the layout defining function to be used by the box
5608     *
5609     * Whenever anything changes that requires the box in @p obj to recalculate
5610     * the size and position of its elements, the function @p cb will be called
5611     * to determine what the layout of the children will be.
5612     *
5613     * Once a custom function is set, everything about the children layout
5614     * is defined by it. The flags set by elm_box_horizontal_set() and
5615     * elm_box_homogeneous_set() no longer have any meaning, and the values
5616     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5617     * layout function to decide if they are used and how. These last two
5618     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5619     * passed to @p cb. The @c Evas_Object the function receives is not the
5620     * Elementary widget, but the internal Evas Box it uses, so none of the
5621     * functions described here can be used on it.
5622     *
5623     * Any of the layout functions in @c Evas can be used here, as well as the
5624     * special elm_box_layout_transition().
5625     *
5626     * The final @p data argument received by @p cb is the same @p data passed
5627     * here, and the @p free_data function will be called to free it
5628     * whenever the box is destroyed or another layout function is set.
5629     *
5630     * Setting @p cb to NULL will revert back to the default layout function.
5631     *
5632     * @param obj The box object
5633     * @param cb The callback function used for layout
5634     * @param data Data that will be passed to layout function
5635     * @param free_data Function called to free @p data
5636     *
5637     * @see elm_box_layout_transition()
5638     */
5639    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);
5640    /**
5641     * Special layout function that animates the transition from one layout to another
5642     *
5643     * Normally, when switching the layout function for a box, this will be
5644     * reflected immediately on screen on the next render, but it's also
5645     * possible to do this through an animated transition.
5646     *
5647     * This is done by creating an ::Elm_Box_Transition and setting the box
5648     * layout to this function.
5649     *
5650     * For example:
5651     * @code
5652     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5653     *                            evas_object_box_layout_vertical, // start
5654     *                            NULL, // data for initial layout
5655     *                            NULL, // free function for initial data
5656     *                            evas_object_box_layout_horizontal, // end
5657     *                            NULL, // data for final layout
5658     *                            NULL, // free function for final data
5659     *                            anim_end, // will be called when animation ends
5660     *                            NULL); // data for anim_end function\
5661     * elm_box_layout_set(box, elm_box_layout_transition, t,
5662     *                    elm_box_transition_free);
5663     * @endcode
5664     *
5665     * @note This function can only be used with elm_box_layout_set(). Calling
5666     * it directly will not have the expected results.
5667     *
5668     * @see elm_box_transition_new
5669     * @see elm_box_transition_free
5670     * @see elm_box_layout_set
5671     */
5672    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5673    /**
5674     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5675     *
5676     * If you want to animate the change from one layout to another, you need
5677     * to set the layout function of the box to elm_box_layout_transition(),
5678     * passing as user data to it an instance of ::Elm_Box_Transition with the
5679     * necessary information to perform this animation. The free function to
5680     * set for the layout is elm_box_transition_free().
5681     *
5682     * The parameters to create an ::Elm_Box_Transition sum up to how long
5683     * will it be, in seconds, a layout function to describe the initial point,
5684     * another for the final position of the children and one function to be
5685     * called when the whole animation ends. This last function is useful to
5686     * set the definitive layout for the box, usually the same as the end
5687     * layout for the animation, but could be used to start another transition.
5688     *
5689     * @param start_layout The layout function that will be used to start the animation
5690     * @param start_layout_data The data to be passed the @p start_layout function
5691     * @param start_layout_free_data Function to free @p start_layout_data
5692     * @param end_layout The layout function that will be used to end the animation
5693     * @param end_layout_free_data The data to be passed the @p end_layout function
5694     * @param end_layout_free_data Function to free @p end_layout_data
5695     * @param transition_end_cb Callback function called when animation ends
5696     * @param transition_end_data Data to be passed to @p transition_end_cb
5697     * @return An instance of ::Elm_Box_Transition
5698     *
5699     * @see elm_box_transition_new
5700     * @see elm_box_layout_transition
5701     */
5702    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);
5703    /**
5704     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5705     *
5706     * This function is mostly useful as the @c free_data parameter in
5707     * elm_box_layout_set() when elm_box_layout_transition().
5708     *
5709     * @param data The Elm_Box_Transition instance to be freed.
5710     *
5711     * @see elm_box_transition_new
5712     * @see elm_box_layout_transition
5713     */
5714    EAPI void                elm_box_transition_free(void *data);
5715    /**
5716     * @}
5717     */
5718
5719    /* button */
5720    /**
5721     * @defgroup Button Button
5722     *
5723     * @image html img/widget/button/preview-00.png
5724     * @image latex img/widget/button/preview-00.eps
5725     * @image html img/widget/button/preview-01.png
5726     * @image latex img/widget/button/preview-01.eps
5727     * @image html img/widget/button/preview-02.png
5728     * @image latex img/widget/button/preview-02.eps
5729     *
5730     * This is a push-button. Press it and run some function. It can contain
5731     * a simple label and icon object and it also has an autorepeat feature.
5732     *
5733     * This widgets emits the following signals:
5734     * @li "clicked": the user clicked the button (press/release).
5735     * @li "repeated": the user pressed the button without releasing it.
5736     * @li "pressed": button was pressed.
5737     * @li "unpressed": button was released after being pressed.
5738     * In all three cases, the @c event parameter of the callback will be
5739     * @c NULL.
5740     *
5741     * Also, defined in the default theme, the button has the following styles
5742     * available:
5743     * @li default: a normal button.
5744     * @li anchor: Like default, but the button fades away when the mouse is not
5745     * over it, leaving only the text or icon.
5746     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5747     * continuous look across its options.
5748     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5749     *
5750     * Follow through a complete example @ref button_example_01 "here".
5751     * @{
5752     */
5753    /**
5754     * Add a new button to the parent's canvas
5755     *
5756     * @param parent The parent object
5757     * @return The new object or NULL if it cannot be created
5758     */
5759    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5760    /**
5761     * Set the label used in the button
5762     *
5763     * The passed @p label can be NULL to clean any existing text in it and
5764     * leave the button as an icon only object.
5765     *
5766     * @param obj The button object
5767     * @param label The text will be written on the button
5768     * @deprecated use elm_object_text_set() instead.
5769     */
5770    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5771    /**
5772     * Get the label set for the button
5773     *
5774     * The string returned is an internal pointer and should not be freed or
5775     * altered. It will also become invalid when the button is destroyed.
5776     * The string returned, if not NULL, is a stringshare, so if you need to
5777     * keep it around even after the button is destroyed, you can use
5778     * eina_stringshare_ref().
5779     *
5780     * @param obj The button object
5781     * @return The text set to the label, or NULL if nothing is set
5782     * @deprecated use elm_object_text_set() instead.
5783     */
5784    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5785    /**
5786     * Set the icon used for the button
5787     *
5788     * Setting a new icon will delete any other that was previously set, making
5789     * any reference to them invalid. If you need to maintain the previous
5790     * object alive, unset it first with elm_button_icon_unset().
5791     *
5792     * @param obj The button object
5793     * @param icon The icon object for the button
5794     */
5795    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5796    /**
5797     * Get the icon used for the button
5798     *
5799     * Return the icon object which is set for this widget. If the button is
5800     * destroyed or another icon is set, the returned object will be deleted
5801     * and any reference to it will be invalid.
5802     *
5803     * @param obj The button object
5804     * @return The icon object that is being used
5805     *
5806     * @see elm_button_icon_unset()
5807     */
5808    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5809    /**
5810     * Remove the icon set without deleting it and return the object
5811     *
5812     * This function drops the reference the button holds of the icon object
5813     * and returns this last object. It is used in case you want to remove any
5814     * icon, or set another one, without deleting the actual object. The button
5815     * will be left without an icon set.
5816     *
5817     * @param obj The button object
5818     * @return The icon object that was being used
5819     */
5820    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5821    /**
5822     * Turn on/off the autorepeat event generated when the button is kept pressed
5823     *
5824     * When off, no autorepeat is performed and buttons emit a normal @c clicked
5825     * signal when they are clicked.
5826     *
5827     * When on, keeping a button pressed will continuously emit a @c repeated
5828     * signal until the button is released. The time it takes until it starts
5829     * emitting the signal is given by
5830     * elm_button_autorepeat_initial_timeout_set(), and the time between each
5831     * new emission by elm_button_autorepeat_gap_timeout_set().
5832     *
5833     * @param obj The button object
5834     * @param on  A bool to turn on/off the event
5835     */
5836    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
5837    /**
5838     * Get whether the autorepeat feature is enabled
5839     *
5840     * @param obj The button object
5841     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
5842     *
5843     * @see elm_button_autorepeat_set()
5844     */
5845    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5846    /**
5847     * Set the initial timeout before the autorepeat event is generated
5848     *
5849     * Sets the timeout, in seconds, since the button is pressed until the
5850     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
5851     * won't be any delay and the even will be fired the moment the button is
5852     * pressed.
5853     *
5854     * @param obj The button object
5855     * @param t   Timeout in seconds
5856     *
5857     * @see elm_button_autorepeat_set()
5858     * @see elm_button_autorepeat_gap_timeout_set()
5859     */
5860    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5861    /**
5862     * Get the initial timeout before the autorepeat event is generated
5863     *
5864     * @param obj The button object
5865     * @return Timeout in seconds
5866     *
5867     * @see elm_button_autorepeat_initial_timeout_set()
5868     */
5869    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5870    /**
5871     * Set the interval between each generated autorepeat event
5872     *
5873     * After the first @c repeated event is fired, all subsequent ones will
5874     * follow after a delay of @p t seconds for each.
5875     *
5876     * @param obj The button object
5877     * @param t   Interval in seconds
5878     *
5879     * @see elm_button_autorepeat_initial_timeout_set()
5880     */
5881    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
5882    /**
5883     * Get the interval between each generated autorepeat event
5884     *
5885     * @param obj The button object
5886     * @return Interval in seconds
5887     */
5888    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5889    /**
5890     * @}
5891     */
5892
5893    /**
5894     * @defgroup File_Selector_Button File Selector Button
5895     *
5896     * @image html img/widget/fileselector_button/preview-00.png
5897     * @image latex img/widget/fileselector_button/preview-00.eps
5898     * @image html img/widget/fileselector_button/preview-01.png
5899     * @image latex img/widget/fileselector_button/preview-01.eps
5900     * @image html img/widget/fileselector_button/preview-02.png
5901     * @image latex img/widget/fileselector_button/preview-02.eps
5902     *
5903     * This is a button that, when clicked, creates an Elementary
5904     * window (or inner window) <b> with a @ref Fileselector "file
5905     * selector widget" within</b>. When a file is chosen, the (inner)
5906     * window is closed and the button emits a signal having the
5907     * selected file as it's @c event_info.
5908     *
5909     * This widget encapsulates operations on its internal file
5910     * selector on its own API. There is less control over its file
5911     * selector than that one would have instatiating one directly.
5912     *
5913     * The following styles are available for this button:
5914     * @li @c "default"
5915     * @li @c "anchor"
5916     * @li @c "hoversel_vertical"
5917     * @li @c "hoversel_vertical_entry"
5918     *
5919     * Smart callbacks one can register to:
5920     * - @c "file,chosen" - the user has selected a path, whose string
5921     *   pointer comes as the @c event_info data (a stringshared
5922     *   string)
5923     *
5924     * Here is an example on its usage:
5925     * @li @ref fileselector_button_example
5926     *
5927     * @see @ref File_Selector_Entry for a similar widget.
5928     * @{
5929     */
5930
5931    /**
5932     * Add a new file selector button widget to the given parent
5933     * Elementary (container) object
5934     *
5935     * @param parent The parent object
5936     * @return a new file selector button widget handle or @c NULL, on
5937     * errors
5938     */
5939    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5940
5941    /**
5942     * Set the label for a given file selector button widget
5943     *
5944     * @param obj The file selector button widget
5945     * @param label The text label to be displayed on @p obj
5946     *
5947     * @deprecated use elm_object_text_set() instead.
5948     */
5949    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5950
5951    /**
5952     * Get the label set for a given file selector button widget
5953     *
5954     * @param obj The file selector button widget
5955     * @return The button label
5956     *
5957     * @deprecated use elm_object_text_set() instead.
5958     */
5959    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5960
5961    /**
5962     * Set the icon on a given file selector button widget
5963     *
5964     * @param obj The file selector button widget
5965     * @param icon The icon object for the button
5966     *
5967     * Once the icon object is set, a previously set one will be
5968     * deleted. If you want to keep the latter, use the
5969     * elm_fileselector_button_icon_unset() function.
5970     *
5971     * @see elm_fileselector_button_icon_get()
5972     */
5973    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5974
5975    /**
5976     * Get the icon set for a given file selector button widget
5977     *
5978     * @param obj The file selector button widget
5979     * @return The icon object currently set on @p obj or @c NULL, if
5980     * none is
5981     *
5982     * @see elm_fileselector_button_icon_set()
5983     */
5984    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5985
5986    /**
5987     * Unset the icon used in a given file selector button widget
5988     *
5989     * @param obj The file selector button widget
5990     * @return The icon object that was being used on @p obj or @c
5991     * NULL, on errors
5992     *
5993     * Unparent and return the icon object which was set for this
5994     * widget.
5995     *
5996     * @see elm_fileselector_button_icon_set()
5997     */
5998    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
5999
6000    /**
6001     * Set the title for a given file selector button widget's window
6002     *
6003     * @param obj The file selector button widget
6004     * @param title The title string
6005     *
6006     * This will change the window's title, when the file selector pops
6007     * out after a click on the button. Those windows have the default
6008     * (unlocalized) value of @c "Select a file" as titles.
6009     *
6010     * @note It will only take any effect if the file selector
6011     * button widget is @b not under "inwin mode".
6012     *
6013     * @see elm_fileselector_button_window_title_get()
6014     */
6015    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6016
6017    /**
6018     * Get the title set for a given file selector button widget's
6019     * window
6020     *
6021     * @param obj The file selector button widget
6022     * @return Title of the file selector button's window
6023     *
6024     * @see elm_fileselector_button_window_title_get() for more details
6025     */
6026    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6027
6028    /**
6029     * Set the size of a given file selector button widget's window,
6030     * holding the file selector itself.
6031     *
6032     * @param obj The file selector button widget
6033     * @param width The window's width
6034     * @param height The window's height
6035     *
6036     * @note it will only take any effect if the file selector button
6037     * widget is @b not under "inwin mode". The default size for the
6038     * window (when applicable) is 400x400 pixels.
6039     *
6040     * @see elm_fileselector_button_window_size_get()
6041     */
6042    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6043
6044    /**
6045     * Get the size of a given file selector button widget's window,
6046     * holding the file selector itself.
6047     *
6048     * @param obj The file selector button widget
6049     * @param width Pointer into which to store the width value
6050     * @param height Pointer into which to store the height value
6051     *
6052     * @note Use @c NULL pointers on the size values you're not
6053     * interested in: they'll be ignored by the function.
6054     *
6055     * @see elm_fileselector_button_window_size_set(), for more details
6056     */
6057    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6058
6059    /**
6060     * Set the initial file system path for a given file selector
6061     * button widget
6062     *
6063     * @param obj The file selector button widget
6064     * @param path The path string
6065     *
6066     * It must be a <b>directory</b> path, which will have the contents
6067     * displayed initially in the file selector's view, when invoked
6068     * from @p obj. The default initial path is the @c "HOME"
6069     * environment variable's value.
6070     *
6071     * @see elm_fileselector_button_path_get()
6072     */
6073    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6074
6075    /**
6076     * Get the initial file system path set for a given file selector
6077     * button widget
6078     *
6079     * @param obj The file selector button widget
6080     * @return path The path string
6081     *
6082     * @see elm_fileselector_button_path_set() for more details
6083     */
6084    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6085
6086    /**
6087     * Enable/disable a tree view in the given file selector button
6088     * widget's internal file selector
6089     *
6090     * @param obj The file selector button widget
6091     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6092     * disable
6093     *
6094     * This has the same effect as elm_fileselector_expandable_set(),
6095     * but now applied to a file selector button's internal file
6096     * selector.
6097     *
6098     * @note There's no way to put a file selector button's internal
6099     * file selector in "grid mode", as one may do with "pure" file
6100     * selectors.
6101     *
6102     * @see elm_fileselector_expandable_get()
6103     */
6104    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6105
6106    /**
6107     * Get whether tree view is enabled for the given file selector
6108     * button widget's internal file selector
6109     *
6110     * @param obj The file selector button widget
6111     * @return @c EINA_TRUE if @p obj widget's internal file selector
6112     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6113     *
6114     * @see elm_fileselector_expandable_set() for more details
6115     */
6116    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6117
6118    /**
6119     * Set whether a given file selector button widget's internal file
6120     * selector is to display folders only or the directory contents,
6121     * as well.
6122     *
6123     * @param obj The file selector button widget
6124     * @param only @c EINA_TRUE to make @p obj widget's internal file
6125     * selector only display directories, @c EINA_FALSE to make files
6126     * to be displayed in it too
6127     *
6128     * This has the same effect as elm_fileselector_folder_only_set(),
6129     * but now applied to a file selector button's internal file
6130     * selector.
6131     *
6132     * @see elm_fileselector_folder_only_get()
6133     */
6134    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6135
6136    /**
6137     * Get whether a given file selector button widget's internal file
6138     * selector is displaying folders only or the directory contents,
6139     * as well.
6140     *
6141     * @param obj The file selector button widget
6142     * @return @c EINA_TRUE if @p obj widget's internal file
6143     * selector is only displaying directories, @c EINA_FALSE if files
6144     * are being displayed in it too (and on errors)
6145     *
6146     * @see elm_fileselector_button_folder_only_set() for more details
6147     */
6148    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6149
6150    /**
6151     * Enable/disable the file name entry box where the user can type
6152     * in a name for a file, in a given file selector button widget's
6153     * internal file selector.
6154     *
6155     * @param obj The file selector button widget
6156     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6157     * file selector a "saving dialog", @c EINA_FALSE otherwise
6158     *
6159     * This has the same effect as elm_fileselector_is_save_set(),
6160     * but now applied to a file selector button's internal file
6161     * selector.
6162     *
6163     * @see elm_fileselector_is_save_get()
6164     */
6165    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6166
6167    /**
6168     * Get whether the given file selector button widget's internal
6169     * file selector is in "saving dialog" mode
6170     *
6171     * @param obj The file selector button widget
6172     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6173     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6174     * errors)
6175     *
6176     * @see elm_fileselector_button_is_save_set() for more details
6177     */
6178    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6179
6180    /**
6181     * Set whether a given file selector button widget's internal file
6182     * selector will raise an Elementary "inner window", instead of a
6183     * dedicated Elementary window. By default, it won't.
6184     *
6185     * @param obj The file selector button widget
6186     * @param value @c EINA_TRUE to make it use an inner window, @c
6187     * EINA_TRUE to make it use a dedicated window
6188     *
6189     * @see elm_win_inwin_add() for more information on inner windows
6190     * @see elm_fileselector_button_inwin_mode_get()
6191     */
6192    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6193
6194    /**
6195     * Get whether a given file selector button widget's internal file
6196     * selector will raise an Elementary "inner window", instead of a
6197     * dedicated Elementary window.
6198     *
6199     * @param obj The file selector button widget
6200     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6201     * if it will use a dedicated window
6202     *
6203     * @see elm_fileselector_button_inwin_mode_set() for more details
6204     */
6205    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6206
6207    /**
6208     * @}
6209     */
6210
6211     /**
6212     * @defgroup File_Selector_Entry File Selector Entry
6213     *
6214     * @image html img/widget/fileselector_entry/preview-00.png
6215     * @image latex img/widget/fileselector_entry/preview-00.eps
6216     *
6217     * This is an entry made to be filled with or display a <b>file
6218     * system path string</b>. Besides the entry itself, the widget has
6219     * a @ref File_Selector_Button "file selector button" on its side,
6220     * which will raise an internal @ref Fileselector "file selector widget",
6221     * when clicked, for path selection aided by file system
6222     * navigation.
6223     *
6224     * This file selector may appear in an Elementary window or in an
6225     * inner window. When a file is chosen from it, the (inner) window
6226     * is closed and the selected file's path string is exposed both as
6227     * an smart event and as the new text on the entry.
6228     *
6229     * This widget encapsulates operations on its internal file
6230     * selector on its own API. There is less control over its file
6231     * selector than that one would have instatiating one directly.
6232     *
6233     * Smart callbacks one can register to:
6234     * - @c "changed" - The text within the entry was changed
6235     * - @c "activated" - The entry has had editing finished and
6236     *   changes are to be "committed"
6237     * - @c "press" - The entry has been clicked
6238     * - @c "longpressed" - The entry has been clicked (and held) for a
6239     *   couple seconds
6240     * - @c "clicked" - The entry has been clicked
6241     * - @c "clicked,double" - The entry has been double clicked
6242     * - @c "focused" - The entry has received focus
6243     * - @c "unfocused" - The entry has lost focus
6244     * - @c "selection,paste" - A paste action has occurred on the
6245     *   entry
6246     * - @c "selection,copy" - A copy action has occurred on the entry
6247     * - @c "selection,cut" - A cut action has occurred on the entry
6248     * - @c "unpressed" - The file selector entry's button was released
6249     *   after being pressed.
6250     * - @c "file,chosen" - The user has selected a path via the file
6251     *   selector entry's internal file selector, whose string pointer
6252     *   comes as the @c event_info data (a stringshared string)
6253     *
6254     * Here is an example on its usage:
6255     * @li @ref fileselector_entry_example
6256     *
6257     * @see @ref File_Selector_Button for a similar widget.
6258     * @{
6259     */
6260
6261    /**
6262     * Add a new file selector entry widget to the given parent
6263     * Elementary (container) object
6264     *
6265     * @param parent The parent object
6266     * @return a new file selector entry widget handle or @c NULL, on
6267     * errors
6268     */
6269    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6270
6271    /**
6272     * Set the label for a given file selector entry widget's button
6273     *
6274     * @param obj The file selector entry widget
6275     * @param label The text label to be displayed on @p obj widget's
6276     * button
6277     *
6278     * @deprecated use elm_object_text_set() instead.
6279     */
6280    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6281
6282    /**
6283     * Get the label set for a given file selector entry widget's button
6284     *
6285     * @param obj The file selector entry widget
6286     * @return The widget button's label
6287     *
6288     * @deprecated use elm_object_text_set() instead.
6289     */
6290    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6291
6292    /**
6293     * Set the icon on a given file selector entry widget's button
6294     *
6295     * @param obj The file selector entry widget
6296     * @param icon The icon object for the entry's button
6297     *
6298     * Once the icon object is set, a previously set one will be
6299     * deleted. If you want to keep the latter, use the
6300     * elm_fileselector_entry_button_icon_unset() function.
6301     *
6302     * @see elm_fileselector_entry_button_icon_get()
6303     */
6304    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6305
6306    /**
6307     * Get the icon set for a given file selector entry widget's button
6308     *
6309     * @param obj The file selector entry widget
6310     * @return The icon object currently set on @p obj widget's button
6311     * or @c NULL, if none is
6312     *
6313     * @see elm_fileselector_entry_button_icon_set()
6314     */
6315    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6316
6317    /**
6318     * Unset the icon used in a given file selector entry widget's
6319     * button
6320     *
6321     * @param obj The file selector entry widget
6322     * @return The icon object that was being used on @p obj widget's
6323     * button or @c NULL, on errors
6324     *
6325     * Unparent and return the icon object which was set for this
6326     * widget's button.
6327     *
6328     * @see elm_fileselector_entry_button_icon_set()
6329     */
6330    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6331
6332    /**
6333     * Set the title for a given file selector entry widget's window
6334     *
6335     * @param obj The file selector entry widget
6336     * @param title The title string
6337     *
6338     * This will change the window's title, when the file selector pops
6339     * out after a click on the entry's button. Those windows have the
6340     * default (unlocalized) value of @c "Select a file" as titles.
6341     *
6342     * @note It will only take any effect if the file selector
6343     * entry widget is @b not under "inwin mode".
6344     *
6345     * @see elm_fileselector_entry_window_title_get()
6346     */
6347    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6348
6349    /**
6350     * Get the title set for a given file selector entry widget's
6351     * window
6352     *
6353     * @param obj The file selector entry widget
6354     * @return Title of the file selector entry's window
6355     *
6356     * @see elm_fileselector_entry_window_title_get() for more details
6357     */
6358    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6359
6360    /**
6361     * Set the size of a given file selector entry widget's window,
6362     * holding the file selector itself.
6363     *
6364     * @param obj The file selector entry widget
6365     * @param width The window's width
6366     * @param height The window's height
6367     *
6368     * @note it will only take any effect if the file selector entry
6369     * widget is @b not under "inwin mode". The default size for the
6370     * window (when applicable) is 400x400 pixels.
6371     *
6372     * @see elm_fileselector_entry_window_size_get()
6373     */
6374    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6375
6376    /**
6377     * Get the size of a given file selector entry widget's window,
6378     * holding the file selector itself.
6379     *
6380     * @param obj The file selector entry widget
6381     * @param width Pointer into which to store the width value
6382     * @param height Pointer into which to store the height value
6383     *
6384     * @note Use @c NULL pointers on the size values you're not
6385     * interested in: they'll be ignored by the function.
6386     *
6387     * @see elm_fileselector_entry_window_size_set(), for more details
6388     */
6389    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6390
6391    /**
6392     * Set the initial file system path and the entry's path string for
6393     * a given file selector entry widget
6394     *
6395     * @param obj The file selector entry widget
6396     * @param path The path string
6397     *
6398     * It must be a <b>directory</b> path, which will have the contents
6399     * displayed initially in the file selector's view, when invoked
6400     * from @p obj. The default initial path is the @c "HOME"
6401     * environment variable's value.
6402     *
6403     * @see elm_fileselector_entry_path_get()
6404     */
6405    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6406
6407    /**
6408     * Get the entry's path string for a given file selector entry
6409     * widget
6410     *
6411     * @param obj The file selector entry widget
6412     * @return path The path string
6413     *
6414     * @see elm_fileselector_entry_path_set() for more details
6415     */
6416    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6417
6418    /**
6419     * Enable/disable a tree view in the given file selector entry
6420     * widget's internal file selector
6421     *
6422     * @param obj The file selector entry widget
6423     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6424     * disable
6425     *
6426     * This has the same effect as elm_fileselector_expandable_set(),
6427     * but now applied to a file selector entry's internal file
6428     * selector.
6429     *
6430     * @note There's no way to put a file selector entry's internal
6431     * file selector in "grid mode", as one may do with "pure" file
6432     * selectors.
6433     *
6434     * @see elm_fileselector_expandable_get()
6435     */
6436    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6437
6438    /**
6439     * Get whether tree view is enabled for the given file selector
6440     * entry widget's internal file selector
6441     *
6442     * @param obj The file selector entry widget
6443     * @return @c EINA_TRUE if @p obj widget's internal file selector
6444     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6445     *
6446     * @see elm_fileselector_expandable_set() for more details
6447     */
6448    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6449
6450    /**
6451     * Set whether a given file selector entry widget's internal file
6452     * selector is to display folders only or the directory contents,
6453     * as well.
6454     *
6455     * @param obj The file selector entry widget
6456     * @param only @c EINA_TRUE to make @p obj widget's internal file
6457     * selector only display directories, @c EINA_FALSE to make files
6458     * to be displayed in it too
6459     *
6460     * This has the same effect as elm_fileselector_folder_only_set(),
6461     * but now applied to a file selector entry's internal file
6462     * selector.
6463     *
6464     * @see elm_fileselector_folder_only_get()
6465     */
6466    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6467
6468    /**
6469     * Get whether a given file selector entry widget's internal file
6470     * selector is displaying folders only or the directory contents,
6471     * as well.
6472     *
6473     * @param obj The file selector entry widget
6474     * @return @c EINA_TRUE if @p obj widget's internal file
6475     * selector is only displaying directories, @c EINA_FALSE if files
6476     * are being displayed in it too (and on errors)
6477     *
6478     * @see elm_fileselector_entry_folder_only_set() for more details
6479     */
6480    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6481
6482    /**
6483     * Enable/disable the file name entry box where the user can type
6484     * in a name for a file, in a given file selector entry widget's
6485     * internal file selector.
6486     *
6487     * @param obj The file selector entry widget
6488     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6489     * file selector a "saving dialog", @c EINA_FALSE otherwise
6490     *
6491     * This has the same effect as elm_fileselector_is_save_set(),
6492     * but now applied to a file selector entry's internal file
6493     * selector.
6494     *
6495     * @see elm_fileselector_is_save_get()
6496     */
6497    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6498
6499    /**
6500     * Get whether the given file selector entry widget's internal
6501     * file selector is in "saving dialog" mode
6502     *
6503     * @param obj The file selector entry widget
6504     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6505     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6506     * errors)
6507     *
6508     * @see elm_fileselector_entry_is_save_set() for more details
6509     */
6510    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6511
6512    /**
6513     * Set whether a given file selector entry widget's internal file
6514     * selector will raise an Elementary "inner window", instead of a
6515     * dedicated Elementary window. By default, it won't.
6516     *
6517     * @param obj The file selector entry widget
6518     * @param value @c EINA_TRUE to make it use an inner window, @c
6519     * EINA_TRUE to make it use a dedicated window
6520     *
6521     * @see elm_win_inwin_add() for more information on inner windows
6522     * @see elm_fileselector_entry_inwin_mode_get()
6523     */
6524    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6525
6526    /**
6527     * Get whether a given file selector entry widget's internal file
6528     * selector will raise an Elementary "inner window", instead of a
6529     * dedicated Elementary window.
6530     *
6531     * @param obj The file selector entry widget
6532     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6533     * if it will use a dedicated window
6534     *
6535     * @see elm_fileselector_entry_inwin_mode_set() for more details
6536     */
6537    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6538
6539    /**
6540     * Set the initial file system path for a given file selector entry
6541     * widget
6542     *
6543     * @param obj The file selector entry widget
6544     * @param path The path string
6545     *
6546     * It must be a <b>directory</b> path, which will have the contents
6547     * displayed initially in the file selector's view, when invoked
6548     * from @p obj. The default initial path is the @c "HOME"
6549     * environment variable's value.
6550     *
6551     * @see elm_fileselector_entry_path_get()
6552     */
6553    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6554
6555    /**
6556     * Get the parent directory's path to the latest file selection on
6557     * a given filer selector entry widget
6558     *
6559     * @param obj The file selector object
6560     * @return The (full) path of the directory of the last selection
6561     * on @p obj widget, a @b stringshared string
6562     *
6563     * @see elm_fileselector_entry_path_set()
6564     */
6565    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6566
6567    /**
6568     * @}
6569     */
6570
6571    /**
6572     * @defgroup Scroller Scroller
6573     *
6574     * A scroller holds a single object and "scrolls it around". This means that
6575     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6576     * region around, allowing to move through a much larger object that is
6577     * contained in the scroller. The scroiller will always have a small minimum
6578     * size by default as it won't be limited by the contents of the scroller.
6579     *
6580     * Signals that you can add callbacks for are:
6581     * @li "edge,left" - the left edge of the content has been reached
6582     * @li "edge,right" - the right edge of the content has been reached
6583     * @li "edge,top" - the top edge of the content has been reached
6584     * @li "edge,bottom" - the bottom edge of the content has been reached
6585     * @li "scroll" - the content has been scrolled (moved)
6586     * @li "scroll,anim,start" - scrolling animation has started
6587     * @li "scroll,anim,stop" - scrolling animation has stopped
6588     * @li "scroll,drag,start" - dragging the contents around has started
6589     * @li "scroll,drag,stop" - dragging the contents around has stopped
6590     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6591     * user intervetion.
6592     *
6593     * @note When Elemementary is in embedded mode the scrollbars will not be
6594     * dragable, they appear merely as indicators of how much has been scrolled.
6595     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6596     * fingerscroll) won't work.
6597     *
6598     * In @ref tutorial_scroller you'll find an example of how to use most of
6599     * this API.
6600     * @{
6601     */
6602    /**
6603     * @brief Type that controls when scrollbars should appear.
6604     *
6605     * @see elm_scroller_policy_set()
6606     */
6607    typedef enum _Elm_Scroller_Policy
6608      {
6609         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6610         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6611         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6612         ELM_SCROLLER_POLICY_LAST
6613      } Elm_Scroller_Policy;
6614    /**
6615     * @brief Add a new scroller to the parent
6616     *
6617     * @param parent The parent object
6618     * @return The new object or NULL if it cannot be created
6619     */
6620    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6621    /**
6622     * @brief Set the content of the scroller widget (the object to be scrolled around).
6623     *
6624     * @param obj The scroller object
6625     * @param content The new content object
6626     *
6627     * Once the content object is set, a previously set one will be deleted.
6628     * If you want to keep that old content object, use the
6629     * elm_scroller_content_unset() function.
6630     */
6631    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6632    /**
6633     * @brief Get the content of the scroller widget
6634     *
6635     * @param obj The slider object
6636     * @return The content that is being used
6637     *
6638     * Return the content object which is set for this widget
6639     *
6640     * @see elm_scroller_content_set()
6641     */
6642    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6643    /**
6644     * @brief Unset the content of the scroller widget
6645     *
6646     * @param obj The slider object
6647     * @return The content that was being used
6648     *
6649     * Unparent and return the content object which was set for this widget
6650     *
6651     * @see elm_scroller_content_set()
6652     */
6653    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6654    /**
6655     * @brief Set custom theme elements for the scroller
6656     *
6657     * @param obj The scroller object
6658     * @param widget The widget name to use (default is "scroller")
6659     * @param base The base name to use (default is "base")
6660     */
6661    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6662    /**
6663     * @brief Make the scroller minimum size limited to the minimum size of the content
6664     *
6665     * @param obj The scroller object
6666     * @param w Enable limiting minimum size horizontally
6667     * @param h Enable limiting minimum size vertically
6668     *
6669     * By default the scroller will be as small as its design allows,
6670     * irrespective of its content. This will make the scroller minimum size the
6671     * right size horizontally and/or vertically to perfectly fit its content in
6672     * that direction.
6673     */
6674    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6675    /**
6676     * @brief Show a specific virtual region within the scroller content object
6677     *
6678     * @param obj The scroller object
6679     * @param x X coordinate of the region
6680     * @param y Y coordinate of the region
6681     * @param w Width of the region
6682     * @param h Height of the region
6683     *
6684     * This will ensure all (or part if it does not fit) of the designated
6685     * region in the virtual content object (0, 0 starting at the top-left of the
6686     * virtual content object) is shown within the scroller.
6687     */
6688    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);
6689    /**
6690     * @brief Set the scrollbar visibility policy
6691     *
6692     * @param obj The scroller object
6693     * @param policy_h Horizontal scrollbar policy
6694     * @param policy_v Vertical scrollbar policy
6695     *
6696     * This sets the scrollbar visibility policy for the given scroller.
6697     * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6698     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6699     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6700     * respectively for the horizontal and vertical scrollbars.
6701     */
6702    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6703    /**
6704     * @brief Gets scrollbar visibility policy
6705     *
6706     * @param obj The scroller object
6707     * @param policy_h Horizontal scrollbar policy
6708     * @param policy_v Vertical scrollbar policy
6709     *
6710     * @see elm_scroller_policy_set()
6711     */
6712    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6713    /**
6714     * @brief Get the currently visible content region
6715     *
6716     * @param obj The scroller object
6717     * @param x X coordinate of the region
6718     * @param y Y coordinate of the region
6719     * @param w Width of the region
6720     * @param h Height of the region
6721     *
6722     * This gets the current region in the content object that is visible through
6723     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6724     * w, @p h values pointed to.
6725     *
6726     * @note All coordinates are relative to the content.
6727     *
6728     * @see elm_scroller_region_show()
6729     */
6730    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);
6731    /**
6732     * @brief Get the size of the content object
6733     *
6734     * @param obj The scroller object
6735     * @param w Width return
6736     * @param h Height return
6737     *
6738     * This gets the size of the content object of the scroller.
6739     */
6740    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6741    /**
6742     * @brief Set bouncing behavior
6743     *
6744     * @param obj The scroller object
6745     * @param h_bounce Will the scroller bounce horizontally or not
6746     * @param v_bounce Will the scroller bounce vertically or not
6747     *
6748     * When scrolling, the scroller may "bounce" when reaching an edge of the
6749     * content object. This is a visual way to indicate the end has been reached.
6750     * This is enabled by default for both axis. This will set if it is enabled
6751     * for that axis with the boolean parameters for each axis.
6752     */
6753    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6754    /**
6755     * @brief Get the bounce mode
6756     *
6757     * @param obj The Scroller object
6758     * @param h_bounce Allow bounce horizontally
6759     * @param v_bounce Allow bounce vertically
6760     *
6761     * @see elm_scroller_bounce_set()
6762     */
6763    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6764    /**
6765     * @brief Set scroll page size relative to viewport size.
6766     *
6767     * @param obj The scroller object
6768     * @param h_pagerel The horizontal page relative size
6769     * @param v_pagerel The vertical page relative size
6770     *
6771     * The scroller is capable of limiting scrolling by the user to "pages". That
6772     * is to jump by and only show a "whole page" at a time as if the continuous
6773     * area of the scroller content is split into page sized pieces. This sets
6774     * the size of a page relative to the viewport of the scroller. 1.0 is "1
6775     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6776     * axis. This is mutually exclusive with page size
6777     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
6778     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6779     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6780     * the other axis.
6781     */
6782    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6783    /**
6784     * @brief Set scroll page size.
6785     *
6786     * @param obj The scroller object
6787     * @param h_pagesize The horizontal page size
6788     * @param v_pagesize The vertical page size
6789     *
6790     * This sets the page size to an absolute fixed value, with 0 turning it off
6791     * for that axis.
6792     *
6793     * @see elm_scroller_page_relative_set()
6794     */
6795    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6796    /**
6797     * @brief Show a specific virtual region within the scroller content object.
6798     *
6799     * @param obj The scroller object
6800     * @param x X coordinate of the region
6801     * @param y Y coordinate of the region
6802     * @param w Width of the region
6803     * @param h Height of the region
6804     *
6805     * This will ensure all (or part if it does not fit) of the designated
6806     * region in the virtual content object (0, 0 starting at the top-left of the
6807     * virtual content object) is shown within the scroller. Unlike
6808     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
6809     * to this location (if configuration in general calls for transitions). It
6810     * may not jump immediately to the new location and make take a while and
6811     * show other content along the way.
6812     *
6813     * @see elm_scroller_region_show()
6814     */
6815    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);
6816    /**
6817     * @brief Set event propagation on a scroller
6818     *
6819     * @param obj The scroller object
6820     * @param propagation If propagation is enabled or not
6821     *
6822     * This enables or disabled event propagation from the scroller content to
6823     * the scroller and its parent. By default event propagation is disabled.
6824     */
6825    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
6826    /**
6827     * @brief Get event propagation for a scroller
6828     *
6829     * @param obj The scroller object
6830     * @return The propagation state
6831     *
6832     * This gets the event propagation for a scroller.
6833     *
6834     * @see elm_scroller_propagate_events_set()
6835     */
6836    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
6837    /**
6838     * @}
6839     */
6840
6841    /**
6842     * @defgroup Label Label
6843     *
6844     * @image html img/widget/label/preview-00.png
6845     * @image latex img/widget/label/preview-00.eps
6846     *
6847     * @brief Widget to display text, with simple html-like markup.
6848     *
6849     * The Label widget @b doesn't allow text to overflow its boundaries, if the
6850     * text doesn't fit the geometry of the label it will be ellipsized or be
6851     * cut. Elementary provides several themes for this widget:
6852     * @li default - No animation
6853     * @li marker - Centers the text in the label and make it bold by default
6854     * @li slide_long - The entire text appears from the right of the screen and
6855     * slides until it disappears in the left of the screen(reappering on the
6856     * right again).
6857     * @li slide_short - The text appears in the left of the label and slides to
6858     * the right to show the overflow. When all of the text has been shown the
6859     * position is reset.
6860     * @li slide_bounce - The text appears in the left of the label and slides to
6861     * the right to show the overflow. When all of the text has been shown the
6862     * animation reverses, moving the text to the left.
6863     *
6864     * Custom themes can of course invent new markup tags and style them any way
6865     * they like.
6866     *
6867     * See @ref tutorial_label for a demonstration of how to use a label widget.
6868     * @{
6869     */
6870    /**
6871     * @brief Add a new label to the parent
6872     *
6873     * @param parent The parent object
6874     * @return The new object or NULL if it cannot be created
6875     */
6876    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6877    /**
6878     * @brief Set the label on the label object
6879     *
6880     * @param obj The label object
6881     * @param label The label will be used on the label object
6882     * @deprecated See elm_object_text_set()
6883     */
6884    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 */
6885    /**
6886     * @brief Get the label used on the label object
6887     *
6888     * @param obj The label object
6889     * @return The string inside the label
6890     * @deprecated See elm_object_text_get()
6891     */
6892    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
6893    /**
6894     * @brief Set the wrapping behavior of the label
6895     *
6896     * @param obj The label object
6897     * @param wrap To wrap text or not
6898     *
6899     * By default no wrapping is done. Possible values for @p wrap are:
6900     * @li ELM_WRAP_NONE - No wrapping
6901     * @li ELM_WRAP_CHAR - wrap between characters
6902     * @li ELM_WRAP_WORD - wrap between words
6903     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
6904     */
6905    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
6906    /**
6907     * @brief Get the wrapping behavior of the label
6908     *
6909     * @param obj The label object
6910     * @return Wrap type
6911     *
6912     * @see elm_label_line_wrap_set()
6913     */
6914    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6915    /**
6916     * @brief Set wrap width of the label
6917     *
6918     * @param obj The label object
6919     * @param w The wrap width in pixels at a minimum where words need to wrap
6920     *
6921     * This function sets the maximum width size hint of the label.
6922     *
6923     * @warning This is only relevant if the label is inside a container.
6924     */
6925    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
6926    /**
6927     * @brief Get wrap width of the label
6928     *
6929     * @param obj The label object
6930     * @return The wrap width in pixels at a minimum where words need to wrap
6931     *
6932     * @see elm_label_wrap_width_set()
6933     */
6934    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6935    /**
6936     * @brief Set wrap height of the label
6937     *
6938     * @param obj The label object
6939     * @param h The wrap height in pixels at a minimum where words need to wrap
6940     *
6941     * This function sets the maximum height size hint of the label.
6942     *
6943     * @warning This is only relevant if the label is inside a container.
6944     */
6945    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
6946    /**
6947     * @brief get wrap width of the label
6948     *
6949     * @param obj The label object
6950     * @return The wrap height in pixels at a minimum where words need to wrap
6951     */
6952    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6953    /**
6954     * @brief Set the font size on the label object.
6955     *
6956     * @param obj The label object
6957     * @param size font size
6958     *
6959     * @warning NEVER use this. It is for hyper-special cases only. use styles
6960     * instead. e.g. "big", "medium", "small" - or better name them by use:
6961     * "title", "footnote", "quote" etc.
6962     */
6963    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
6964    /**
6965     * @brief Set the text color on the label object
6966     *
6967     * @param obj The label object
6968     * @param r Red property background color of The label object
6969     * @param g Green property background color of The label object
6970     * @param b Blue property background color of The label object
6971     * @param a Alpha property background color of The label object
6972     *
6973     * @warning NEVER use this. It is for hyper-special cases only. use styles
6974     * instead. e.g. "big", "medium", "small" - or better name them by use:
6975     * "title", "footnote", "quote" etc.
6976     */
6977    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);
6978    /**
6979     * @brief Set the text align on the label object
6980     *
6981     * @param obj The label object
6982     * @param align align mode ("left", "center", "right")
6983     *
6984     * @warning NEVER use this. It is for hyper-special cases only. use styles
6985     * instead. e.g. "big", "medium", "small" - or better name them by use:
6986     * "title", "footnote", "quote" etc.
6987     */
6988    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
6989    /**
6990     * @brief Set background color of the label
6991     *
6992     * @param obj The label object
6993     * @param r Red property background color of The label object
6994     * @param g Green property background color of The label object
6995     * @param b Blue property background color of The label object
6996     * @param a Alpha property background alpha of The label object
6997     *
6998     * @warning NEVER use this. It is for hyper-special cases only. use styles
6999     * instead. e.g. "big", "medium", "small" - or better name them by use:
7000     * "title", "footnote", "quote" etc.
7001     */
7002    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);
7003    /**
7004     * @brief Set the ellipsis behavior of the label
7005     *
7006     * @param obj The label object
7007     * @param ellipsis To ellipsis text or not
7008     *
7009     * If set to true and the text doesn't fit in the label an ellipsis("...")
7010     * will be shown at the end of the widget.
7011     *
7012     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7013     * choosen wrap method was ELM_WRAP_WORD.
7014     */
7015    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7016    /**
7017     * @brief Set the text slide of the label
7018     *
7019     * @param obj The label object
7020     * @param slide To start slide or stop
7021     *
7022     * If set to true the text of the label will slide throught the length of
7023     * label.
7024     *
7025     * @warning This only work with the themes "slide_short", "slide_long" and
7026     * "slide_bounce".
7027     */
7028    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7029    /**
7030     * @brief Get the text slide mode of the label
7031     *
7032     * @param obj The label object
7033     * @return slide slide mode value
7034     *
7035     * @see elm_label_slide_set()
7036     */
7037    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7038    /**
7039     * @brief Set the slide duration(speed) of the label
7040     *
7041     * @param obj The label object
7042     * @return The duration in seconds in moving text from slide begin position
7043     * to slide end position
7044     */
7045    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7046    /**
7047     * @brief Get the slide duration(speed) of the label
7048     *
7049     * @param obj The label object
7050     * @return The duration time in moving text from slide begin position to slide end position
7051     *
7052     * @see elm_label_slide_duration_set()
7053     */
7054    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7055    /**
7056     * @}
7057     */
7058
7059    /**
7060     * @defgroup Toggle Toggle
7061     *
7062     * @image html img/widget/toggle/preview-00.png
7063     * @image latex img/widget/toggle/preview-00.eps
7064     *
7065     * @brief A toggle is a slider which can be used to toggle between
7066     * two values.  It has two states: on and off.
7067     *
7068     * Signals that you can add callbacks for are:
7069     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7070     *                 until the toggle is released by the cursor (assuming it
7071     *                 has been triggered by the cursor in the first place).
7072     *
7073     * @ref tutorial_toggle show how to use a toggle.
7074     * @{
7075     */
7076    /**
7077     * @brief Add a toggle to @p parent.
7078     *
7079     * @param parent The parent object
7080     *
7081     * @return The toggle object
7082     */
7083    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7084    /**
7085     * @brief Sets the label to be displayed with the toggle.
7086     *
7087     * @param obj The toggle object
7088     * @param label The label to be displayed
7089     *
7090     * @deprecated use elm_object_text_set() instead.
7091     */
7092    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7093    /**
7094     * @brief Gets the label of the toggle
7095     *
7096     * @param obj  toggle object
7097     * @return The label of the toggle
7098     *
7099     * @deprecated use elm_object_text_get() instead.
7100     */
7101    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7102    /**
7103     * @brief Set the icon used for the toggle
7104     *
7105     * @param obj The toggle object
7106     * @param icon The icon object for the button
7107     *
7108     * Once the icon object is set, a previously set one will be deleted
7109     * If you want to keep that old content object, use the
7110     * elm_toggle_icon_unset() function.
7111     */
7112    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7113    /**
7114     * @brief Get the icon used for the toggle
7115     *
7116     * @param obj The toggle object
7117     * @return The icon object that is being used
7118     *
7119     * Return the icon object which is set for this widget.
7120     *
7121     * @see elm_toggle_icon_set()
7122     */
7123    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7124    /**
7125     * @brief Unset the icon used for the toggle
7126     *
7127     * @param obj The toggle object
7128     * @return The icon object that was being used
7129     *
7130     * Unparent and return the icon object which was set for this widget.
7131     *
7132     * @see elm_toggle_icon_set()
7133     */
7134    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7135    /**
7136     * @brief Sets the labels to be associated with the on and off states of the toggle.
7137     *
7138     * @param obj The toggle object
7139     * @param onlabel The label displayed when the toggle is in the "on" state
7140     * @param offlabel The label displayed when the toggle is in the "off" state
7141     */
7142    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7143    /**
7144     * @brief Gets the labels associated with the on and off states of the toggle.
7145     *
7146     * @param obj The toggle object
7147     * @param onlabel A char** to place the onlabel of @p obj into
7148     * @param offlabel A char** to place the offlabel of @p obj into
7149     */
7150    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7151    /**
7152     * @brief Sets the state of the toggle to @p state.
7153     *
7154     * @param obj The toggle object
7155     * @param state The state of @p obj
7156     */
7157    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7158    /**
7159     * @brief Gets the state of the toggle to @p state.
7160     *
7161     * @param obj The toggle object
7162     * @return The state of @p obj
7163     */
7164    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7165    /**
7166     * @brief Sets the state pointer of the toggle to @p statep.
7167     *
7168     * @param obj The toggle object
7169     * @param statep The state pointer of @p obj
7170     */
7171    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7172    /**
7173     * @}
7174     */
7175
7176    /**
7177     * @defgroup Frame Frame
7178     *
7179     * @image html img/widget/frame/preview-00.png
7180     * @image latex img/widget/frame/preview-00.eps
7181     *
7182     * @brief Frame is a widget that holds some content and has a title.
7183     *
7184     * The default look is a frame with a title, but Frame supports multple
7185     * styles:
7186     * @li default
7187     * @li pad_small
7188     * @li pad_medium
7189     * @li pad_large
7190     * @li pad_huge
7191     * @li outdent_top
7192     * @li outdent_bottom
7193     *
7194     * Of all this styles only default shows the title. Frame emits no signals.
7195     *
7196     * For a detailed example see the @ref tutorial_frame.
7197     *
7198     * @{
7199     */
7200    /**
7201     * @brief Add a new frame to the parent
7202     *
7203     * @param parent The parent object
7204     * @return The new object or NULL if it cannot be created
7205     */
7206    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7207    /**
7208     * @brief Set the frame label
7209     *
7210     * @param obj The frame object
7211     * @param label The label of this frame object
7212     *
7213     * @deprecated use elm_object_text_set() instead.
7214     */
7215    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7216    /**
7217     * @brief Get the frame label
7218     *
7219     * @param obj The frame object
7220     *
7221     * @return The label of this frame objet or NULL if unable to get frame
7222     *
7223     * @deprecated use elm_object_text_get() instead.
7224     */
7225    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7226    /**
7227     * @brief Set the content of the frame widget
7228     *
7229     * Once the content object is set, a previously set one will be deleted.
7230     * If you want to keep that old content object, use the
7231     * elm_frame_content_unset() function.
7232     *
7233     * @param obj The frame object
7234     * @param content The content will be filled in this frame object
7235     */
7236    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7237    /**
7238     * @brief Get the content of the frame widget
7239     *
7240     * Return the content object which is set for this widget
7241     *
7242     * @param obj The frame object
7243     * @return The content that is being used
7244     */
7245    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7246    /**
7247     * @brief Unset the content of the frame widget
7248     *
7249     * Unparent and return the content object which was set for this widget
7250     *
7251     * @param obj The frame object
7252     * @return The content that was being used
7253     */
7254    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7255    /**
7256     * @}
7257     */
7258
7259    /**
7260     * @defgroup Table Table
7261     *
7262     * A container widget to arrange other widgets in a table where items can
7263     * also span multiple columns or rows - even overlap (and then be raised or
7264     * lowered accordingly to adjust stacking if they do overlap).
7265     *
7266     * The followin are examples of how to use a table:
7267     * @li @ref tutorial_table_01
7268     * @li @ref tutorial_table_02
7269     *
7270     * @{
7271     */
7272    /**
7273     * @brief Add a new table to the parent
7274     *
7275     * @param parent The parent object
7276     * @return The new object or NULL if it cannot be created
7277     */
7278    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7279    /**
7280     * @brief Set the homogeneous layout in the table
7281     *
7282     * @param obj The layout object
7283     * @param homogeneous A boolean to set if the layout is homogeneous in the
7284     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7285     */
7286    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7287    /**
7288     * @brief Get the current table homogeneous mode.
7289     *
7290     * @param obj The table object
7291     * @return A boolean to indicating if the layout is homogeneous in the table
7292     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7293     */
7294    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7295    /**
7296     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7297     */
7298    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7299    /**
7300     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7301     */
7302    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7303    /**
7304     * @brief Set padding between cells.
7305     *
7306     * @param obj The layout object.
7307     * @param horizontal set the horizontal padding.
7308     * @param vertical set the vertical padding.
7309     *
7310     * Default value is 0.
7311     */
7312    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7313    /**
7314     * @brief Get padding between cells.
7315     *
7316     * @param obj The layout object.
7317     * @param horizontal set the horizontal padding.
7318     * @param vertical set the vertical padding.
7319     */
7320    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7321    /**
7322     * @brief Add a subobject on the table with the coordinates passed
7323     *
7324     * @param obj The table object
7325     * @param subobj The subobject to be added to the table
7326     * @param x Row number
7327     * @param y Column number
7328     * @param w rowspan
7329     * @param h colspan
7330     *
7331     * @note All positioning inside the table is relative to rows and columns, so
7332     * a value of 0 for x and y, means the top left cell of the table, and a
7333     * value of 1 for w and h means @p subobj only takes that 1 cell.
7334     */
7335    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7336    /**
7337     * @brief Remove child from table.
7338     *
7339     * @param obj The table object
7340     * @param subobj The subobject
7341     */
7342    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7343    /**
7344     * @brief Faster way to remove all child objects from a table object.
7345     *
7346     * @param obj The table object
7347     * @param clear If true, will delete children, else just remove from table.
7348     */
7349    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7350    /**
7351     * @brief Set the packing location of an existing child of the table
7352     *
7353     * @param subobj The subobject to be modified in the table
7354     * @param x Row number
7355     * @param y Column number
7356     * @param w rowspan
7357     * @param h colspan
7358     *
7359     * Modifies the position of an object already in the table.
7360     *
7361     * @note All positioning inside the table is relative to rows and columns, so
7362     * a value of 0 for x and y, means the top left cell of the table, and a
7363     * value of 1 for w and h means @p subobj only takes that 1 cell.
7364     */
7365    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7366    /**
7367     * @brief Get the packing location of an existing child of the table
7368     *
7369     * @param subobj The subobject to be modified in the table
7370     * @param x Row number
7371     * @param y Column number
7372     * @param w rowspan
7373     * @param h colspan
7374     *
7375     * @see elm_table_pack_set()
7376     */
7377    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7378    /**
7379     * @}
7380     */
7381
7382    /**
7383     * @defgroup Gengrid Gengrid (Generic grid)
7384     *
7385     * This widget aims to position objects in a grid layout while
7386     * actually creating and rendering only the visible ones, using the
7387     * same idea as the @ref Genlist "genlist": the user defines a @b
7388     * class for each item, specifying functions that will be called at
7389     * object creation, deletion, etc. When those items are selected by
7390     * the user, a callback function is issued. Users may interact with
7391     * a gengrid via the mouse (by clicking on items to select them and
7392     * clicking on the grid's viewport and swiping to pan the whole
7393     * view) or via the keyboard, navigating through item with the
7394     * arrow keys.
7395     *
7396     * @section Gengrid_Layouts Gengrid layouts
7397     *
7398     * Gengrids may layout its items in one of two possible layouts:
7399     * - horizontal or
7400     * - vertical.
7401     *
7402     * When in "horizontal mode", items will be placed in @b columns,
7403     * from top to bottom and, when the space for a column is filled,
7404     * another one is started on the right, thus expanding the grid
7405     * horizontally, making for horizontal scrolling. When in "vertical
7406     * mode" , though, items will be placed in @b rows, from left to
7407     * right and, when the space for a row is filled, another one is
7408     * started below, thus expanding the grid vertically (and making
7409     * for vertical scrolling).
7410     *
7411     * @section Gengrid_Items Gengrid items
7412     *
7413     * An item in a gengrid can have 0 or more text labels (they can be
7414     * regular text or textblock Evas objects - that's up to the style
7415     * to determine), 0 or more icons (which are simply objects
7416     * swallowed into the gengrid item's theming Edje object) and 0 or
7417     * more <b>boolean states</b>, which have the behavior left to the
7418     * user to define. The Edje part names for each of these properties
7419     * will be looked up, in the theme file for the gengrid, under the
7420     * Edje (string) data items named @c "labels", @c "icons" and @c
7421     * "states", respectively. For each of those properties, if more
7422     * than one part is provided, they must have names listed separated
7423     * by spaces in the data fields. For the default gengrid item
7424     * theme, we have @b one label part (@c "elm.text"), @b two icon
7425     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7426     * no state parts.
7427     *
7428     * A gengrid item may be at one of several styles. Elementary
7429     * provides one by default - "default", but this can be extended by
7430     * system or application custom themes/overlays/extensions (see
7431     * @ref Theme "themes" for more details).
7432     *
7433     * @section Gengrid_Item_Class Gengrid item classes
7434     *
7435     * In order to have the ability to add and delete items on the fly,
7436     * gengrid implements a class (callback) system where the
7437     * application provides a structure with information about that
7438     * type of item (gengrid may contain multiple different items with
7439     * different classes, states and styles). Gengrid will call the
7440     * functions in this struct (methods) when an item is "realized"
7441     * (i.e., created dynamically, while the user is scrolling the
7442     * grid). All objects will simply be deleted when no longer needed
7443     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7444     * contains the following members:
7445     * - @c item_style - This is a constant string and simply defines
7446     * the name of the item style. It @b must be specified and the
7447     * default should be @c "default".
7448     * - @c func.label_get - This function is called when an item
7449     * object is actually created. The @c data parameter will point to
7450     * the same data passed to elm_gengrid_item_append() and related
7451     * item creation functions. The @c obj parameter is the gengrid
7452     * object itself, while the @c part one is the name string of one
7453     * of the existing text parts in the Edje group implementing the
7454     * item's theme. This function @b must return a strdup'()ed string,
7455     * as the caller will free() it when done. See
7456     * #Elm_Gengrid_Item_Label_Get_Cb.
7457     * - @c func.icon_get - This function is called when an item object
7458     * is actually created. The @c data parameter will point to the
7459     * same data passed to elm_gengrid_item_append() and related item
7460     * creation functions. The @c obj parameter is the gengrid object
7461     * itself, while the @c part one is the name string of one of the
7462     * existing (icon) swallow parts in the Edje group implementing the
7463     * item's theme. It must return @c NULL, when no icon is desired,
7464     * or a valid object handle, otherwise. The object will be deleted
7465     * by the gengrid on its deletion or when the item is "unrealized".
7466     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7467     * - @c func.state_get - This function is called when an item
7468     * object is actually created. The @c data parameter will point to
7469     * the same data passed to elm_gengrid_item_append() and related
7470     * item creation functions. The @c obj parameter is the gengrid
7471     * object itself, while the @c part one is the name string of one
7472     * of the state parts in the Edje group implementing the item's
7473     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7474     * true/on. Gengrids will emit a signal to its theming Edje object
7475     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7476     * "source" arguments, respectively, when the state is true (the
7477     * default is false), where @c XXX is the name of the (state) part.
7478     * See #Elm_Gengrid_Item_State_Get_Cb.
7479     * - @c func.del - This is called when elm_gengrid_item_del() is
7480     * called on an item or elm_gengrid_clear() is called on the
7481     * gengrid. This is intended for use when gengrid items are
7482     * deleted, so any data attached to the item (e.g. its data
7483     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7484     *
7485     * @section Gengrid_Usage_Hints Usage hints
7486     *
7487     * If the user wants to have multiple items selected at the same
7488     * time, elm_gengrid_multi_select_set() will permit it. If the
7489     * gengrid is single-selection only (the default), then
7490     * elm_gengrid_select_item_get() will return the selected item or
7491     * @c NULL, if none is selected. If the gengrid is under
7492     * multi-selection, then elm_gengrid_selected_items_get() will
7493     * return a list (that is only valid as long as no items are
7494     * modified (added, deleted, selected or unselected) of child items
7495     * on a gengrid.
7496     *
7497     * If an item changes (internal (boolean) state, label or icon
7498     * changes), then use elm_gengrid_item_update() to have gengrid
7499     * update the item with the new state. A gengrid will re-"realize"
7500     * the item, thus calling the functions in the
7501     * #Elm_Gengrid_Item_Class set for that item.
7502     *
7503     * To programmatically (un)select an item, use
7504     * elm_gengrid_item_selected_set(). To get its selected state use
7505     * elm_gengrid_item_selected_get(). To make an item disabled
7506     * (unable to be selected and appear differently) use
7507     * elm_gengrid_item_disabled_set() to set this and
7508     * elm_gengrid_item_disabled_get() to get the disabled state.
7509     *
7510     * Grid cells will only have their selection smart callbacks called
7511     * when firstly getting selected. Any further clicks will do
7512     * nothing, unless you enable the "always select mode", with
7513     * elm_gengrid_always_select_mode_set(), thus making every click to
7514     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7515     * turn off the ability to select items entirely in the widget and
7516     * they will neither appear selected nor call the selection smart
7517     * callbacks.
7518     *
7519     * Remember that you can create new styles and add your own theme
7520     * augmentation per application with elm_theme_extension_add(). If
7521     * you absolutely must have a specific style that overrides any
7522     * theme the user or system sets up you can use
7523     * elm_theme_overlay_add() to add such a file.
7524     *
7525     * @section Gengrid_Smart_Events Gengrid smart events
7526     *
7527     * Smart events that you can add callbacks for are:
7528     * - @c "activated" - The user has double-clicked or pressed
7529     *   (enter|return|spacebar) on an item. The @c event_info parameter
7530     *   is the gengrid item that was activated.
7531     * - @c "clicked,double" - The user has double-clicked an item.
7532     *   The @c event_info parameter is the gengrid item that was double-clicked.
7533     * - @c "selected" - The user has made an item selected. The
7534     *   @c event_info parameter is the gengrid item that was selected.
7535     * - @c "unselected" - The user has made an item unselected. The
7536     *   @c event_info parameter is the gengrid item that was unselected.
7537     * - @c "realized" - This is called when the item in the gengrid
7538     *   has its implementing Evas object instantiated, de facto. @c
7539     *   event_info is the gengrid item that was created. The object
7540     *   may be deleted at any time, so it is highly advised to the
7541     *   caller @b not to use the object pointer returned from
7542     *   elm_gengrid_item_object_get(), because it may point to freed
7543     *   objects.
7544     * - @c "unrealized" - This is called when the implementing Evas
7545     *   object for this item is deleted. @c event_info is the gengrid
7546     *   item that was deleted.
7547     * - @c "changed" - Called when an item is added, removed, resized
7548     *   or moved and when the gengrid is resized or gets "horizontal"
7549     *   property changes.
7550     * - @c "drag,start,up" - Called when the item in the gengrid has
7551     *   been dragged (not scrolled) up.
7552     * - @c "drag,start,down" - Called when the item in the gengrid has
7553     *   been dragged (not scrolled) down.
7554     * - @c "drag,start,left" - Called when the item in the gengrid has
7555     *   been dragged (not scrolled) left.
7556     * - @c "drag,start,right" - Called when the item in the gengrid has
7557     *   been dragged (not scrolled) right.
7558     * - @c "drag,stop" - Called when the item in the gengrid has
7559     *   stopped being dragged.
7560     * - @c "drag" - Called when the item in the gengrid is being
7561     *   dragged.
7562     * - @c "scroll" - called when the content has been scrolled
7563     *   (moved).
7564     * - @c "scroll,drag,start" - called when dragging the content has
7565     *   started.
7566     * - @c "scroll,drag,stop" - called when dragging the content has
7567     *   stopped.
7568     *
7569     * List of gendrid examples:
7570     * @li @ref gengrid_example
7571     */
7572
7573    /**
7574     * @addtogroup Gengrid
7575     * @{
7576     */
7577
7578    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7579    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7580    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7581    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7582    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. */
7583    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. */
7584    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7585
7586    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7587    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7588    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7589    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7590
7591    /**
7592     * @struct _Elm_Gengrid_Item_Class
7593     *
7594     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7595     * field details.
7596     */
7597    struct _Elm_Gengrid_Item_Class
7598      {
7599         const char             *item_style;
7600         struct _Elm_Gengrid_Item_Class_Func
7601           {
7602              Elm_Gengrid_Item_Label_Get_Cb label_get;
7603              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7604              Elm_Gengrid_Item_State_Get_Cb state_get;
7605              Elm_Gengrid_Item_Del_Cb       del;
7606           } func;
7607      }; /**< #Elm_Gengrid_Item_Class member definitions */
7608
7609    /**
7610     * Add a new gengrid widget to the given parent Elementary
7611     * (container) object
7612     *
7613     * @param parent The parent object
7614     * @return a new gengrid widget handle or @c NULL, on errors
7615     *
7616     * This function inserts a new gengrid widget on the canvas.
7617     *
7618     * @see elm_gengrid_item_size_set()
7619     * @see elm_gengrid_horizontal_set()
7620     * @see elm_gengrid_item_append()
7621     * @see elm_gengrid_item_del()
7622     * @see elm_gengrid_clear()
7623     *
7624     * @ingroup Gengrid
7625     */
7626    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7627
7628    /**
7629     * Set the size for the items of a given gengrid widget
7630     *
7631     * @param obj The gengrid object.
7632     * @param w The items' width.
7633     * @param h The items' height;
7634     *
7635     * A gengrid, after creation, has still no information on the size
7636     * to give to each of its cells. So, you most probably will end up
7637     * with squares one @ref Fingers "finger" wide, the default
7638     * size. Use this function to force a custom size for you items,
7639     * making them as big as you wish.
7640     *
7641     * @see elm_gengrid_item_size_get()
7642     *
7643     * @ingroup Gengrid
7644     */
7645    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7646
7647    /**
7648     * Get the size set for the items of a given gengrid widget
7649     *
7650     * @param obj The gengrid object.
7651     * @param w Pointer to a variable where to store the items' width.
7652     * @param h Pointer to a variable where to store the items' height.
7653     *
7654     * @note Use @c NULL pointers on the size values you're not
7655     * interested in: they'll be ignored by the function.
7656     *
7657     * @see elm_gengrid_item_size_get() for more details
7658     *
7659     * @ingroup Gengrid
7660     */
7661    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7662
7663    /**
7664     * Set the items grid's alignment within a given gengrid widget
7665     *
7666     * @param obj The gengrid object.
7667     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7668     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7669     *
7670     * This sets the alignment of the whole grid of items of a gengrid
7671     * within its given viewport. By default, those values are both
7672     * 0.5, meaning that the gengrid will have its items grid placed
7673     * exactly in the middle of its viewport.
7674     *
7675     * @note If given alignment values are out of the cited ranges,
7676     * they'll be changed to the nearest boundary values on the valid
7677     * ranges.
7678     *
7679     * @see elm_gengrid_align_get()
7680     *
7681     * @ingroup Gengrid
7682     */
7683    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7684
7685    /**
7686     * Get the items grid's alignment values within a given gengrid
7687     * widget
7688     *
7689     * @param obj The gengrid object.
7690     * @param align_x Pointer to a variable where to store the
7691     * horizontal alignment.
7692     * @param align_y Pointer to a variable where to store the vertical
7693     * alignment.
7694     *
7695     * @note Use @c NULL pointers on the alignment values you're not
7696     * interested in: they'll be ignored by the function.
7697     *
7698     * @see elm_gengrid_align_set() for more details
7699     *
7700     * @ingroup Gengrid
7701     */
7702    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7703
7704    /**
7705     * Set whether a given gengrid widget is or not able have items
7706     * @b reordered
7707     *
7708     * @param obj The gengrid object
7709     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7710     * @c EINA_FALSE to turn it off
7711     *
7712     * If a gengrid is set to allow reordering, a click held for more
7713     * than 0.5 over a given item will highlight it specially,
7714     * signalling the gengrid has entered the reordering state. From
7715     * that time on, the user will be able to, while still holding the
7716     * mouse button down, move the item freely in the gengrid's
7717     * viewport, replacing to said item to the locations it goes to.
7718     * The replacements will be animated and, whenever the user
7719     * releases the mouse button, the item being replaced gets a new
7720     * definitive place in the grid.
7721     *
7722     * @see elm_gengrid_reorder_mode_get()
7723     *
7724     * @ingroup Gengrid
7725     */
7726    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
7727
7728    /**
7729     * Get whether a given gengrid widget is or not able have items
7730     * @b reordered
7731     *
7732     * @param obj The gengrid object
7733     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
7734     * off
7735     *
7736     * @see elm_gengrid_reorder_mode_set() for more details
7737     *
7738     * @ingroup Gengrid
7739     */
7740    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7741
7742    /**
7743     * Append a new item in a given gengrid widget.
7744     *
7745     * @param obj The gengrid object.
7746     * @param gic The item class for the item.
7747     * @param data The item data.
7748     * @param func Convenience function called when the item is
7749     * selected.
7750     * @param func_data Data to be passed to @p func.
7751     * @return A handle to the item added or @c NULL, on errors.
7752     *
7753     * This adds an item to the beginning of the gengrid.
7754     *
7755     * @see elm_gengrid_item_prepend()
7756     * @see elm_gengrid_item_insert_before()
7757     * @see elm_gengrid_item_insert_after()
7758     * @see elm_gengrid_item_del()
7759     *
7760     * @ingroup Gengrid
7761     */
7762    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);
7763
7764    /**
7765     * Prepend a new item in a given gengrid widget.
7766     *
7767     * @param obj The gengrid object.
7768     * @param gic The item class for the item.
7769     * @param data The item data.
7770     * @param func Convenience function called when the item is
7771     * selected.
7772     * @param func_data Data to be passed to @p func.
7773     * @return A handle to the item added or @c NULL, on errors.
7774     *
7775     * This adds an item to the end of the gengrid.
7776     *
7777     * @see elm_gengrid_item_append()
7778     * @see elm_gengrid_item_insert_before()
7779     * @see elm_gengrid_item_insert_after()
7780     * @see elm_gengrid_item_del()
7781     *
7782     * @ingroup Gengrid
7783     */
7784    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);
7785
7786    /**
7787     * Insert an item before another in a gengrid widget
7788     *
7789     * @param obj The gengrid object.
7790     * @param gic The item class for the item.
7791     * @param data The item data.
7792     * @param relative The item to place this new one before.
7793     * @param func Convenience function called when the item is
7794     * selected.
7795     * @param func_data Data to be passed to @p func.
7796     * @return A handle to the item added or @c NULL, on errors.
7797     *
7798     * This inserts an item before another in the gengrid.
7799     *
7800     * @see elm_gengrid_item_append()
7801     * @see elm_gengrid_item_prepend()
7802     * @see elm_gengrid_item_insert_after()
7803     * @see elm_gengrid_item_del()
7804     *
7805     * @ingroup Gengrid
7806     */
7807    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);
7808
7809    /**
7810     * Insert an item after another in a gengrid widget
7811     *
7812     * @param obj The gengrid object.
7813     * @param gic The item class for the item.
7814     * @param data The item data.
7815     * @param relative The item to place this new one after.
7816     * @param func Convenience function called when the item is
7817     * selected.
7818     * @param func_data Data to be passed to @p func.
7819     * @return A handle to the item added or @c NULL, on errors.
7820     *
7821     * This inserts an item after another in the gengrid.
7822     *
7823     * @see elm_gengrid_item_append()
7824     * @see elm_gengrid_item_prepend()
7825     * @see elm_gengrid_item_insert_after()
7826     * @see elm_gengrid_item_del()
7827     *
7828     * @ingroup Gengrid
7829     */
7830    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);
7831
7832    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);
7833
7834    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);
7835
7836    /**
7837     * Set whether items on a given gengrid widget are to get their
7838     * selection callbacks issued for @b every subsequent selection
7839     * click on them or just for the first click.
7840     *
7841     * @param obj The gengrid object
7842     * @param always_select @c EINA_TRUE to make items "always
7843     * selected", @c EINA_FALSE, otherwise
7844     *
7845     * By default, grid items will only call their selection callback
7846     * function when firstly getting selected, any subsequent further
7847     * clicks will do nothing. With this call, you make those
7848     * subsequent clicks also to issue the selection callbacks.
7849     *
7850     * @note <b>Double clicks</b> will @b always be reported on items.
7851     *
7852     * @see elm_gengrid_always_select_mode_get()
7853     *
7854     * @ingroup Gengrid
7855     */
7856    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
7857
7858    /**
7859     * Get whether items on a given gengrid widget have their selection
7860     * callbacks issued for @b every subsequent selection click on them
7861     * or just for the first click.
7862     *
7863     * @param obj The gengrid object.
7864     * @return @c EINA_TRUE if the gengrid items are "always selected",
7865     * @c EINA_FALSE, otherwise
7866     *
7867     * @see elm_gengrid_always_select_mode_set() for more details
7868     *
7869     * @ingroup Gengrid
7870     */
7871    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7872
7873    /**
7874     * Set whether items on a given gengrid widget can be selected or not.
7875     *
7876     * @param obj The gengrid object
7877     * @param no_select @c EINA_TRUE to make items selectable,
7878     * @c EINA_FALSE otherwise
7879     *
7880     * This will make items in @p obj selectable or not. In the latter
7881     * case, any user interacion on the gendrid items will neither make
7882     * them appear selected nor them call their selection callback
7883     * functions.
7884     *
7885     * @see elm_gengrid_no_select_mode_get()
7886     *
7887     * @ingroup Gengrid
7888     */
7889    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
7890
7891    /**
7892     * Get whether items on a given gengrid widget can be selected or
7893     * not.
7894     *
7895     * @param obj The gengrid object
7896     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
7897     * otherwise
7898     *
7899     * @see elm_gengrid_no_select_mode_set() for more details
7900     *
7901     * @ingroup Gengrid
7902     */
7903    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7904
7905    /**
7906     * Enable or disable multi-selection in a given gengrid widget
7907     *
7908     * @param obj The gengrid object.
7909     * @param multi @c EINA_TRUE, to enable multi-selection,
7910     * @c EINA_FALSE to disable it.
7911     *
7912     * Multi-selection is the ability for one to have @b more than one
7913     * item selected, on a given gengrid, simultaneously. When it is
7914     * enabled, a sequence of clicks on different items will make them
7915     * all selected, progressively. A click on an already selected item
7916     * will unselect it. If interecting via the keyboard,
7917     * multi-selection is enabled while holding the "Shift" key.
7918     *
7919     * @note By default, multi-selection is @b disabled on gengrids
7920     *
7921     * @see elm_gengrid_multi_select_get()
7922     *
7923     * @ingroup Gengrid
7924     */
7925    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
7926
7927    /**
7928     * Get whether multi-selection is enabled or disabled for a given
7929     * gengrid widget
7930     *
7931     * @param obj The gengrid object.
7932     * @return @c EINA_TRUE, if multi-selection is enabled, @c
7933     * EINA_FALSE otherwise
7934     *
7935     * @see elm_gengrid_multi_select_set() for more details
7936     *
7937     * @ingroup Gengrid
7938     */
7939    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7940
7941    /**
7942     * Enable or disable bouncing effect for a given gengrid widget
7943     *
7944     * @param obj The gengrid object
7945     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
7946     * @c EINA_FALSE to disable it
7947     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
7948     * @c EINA_FALSE to disable it
7949     *
7950     * The bouncing effect occurs whenever one reaches the gengrid's
7951     * edge's while panning it -- it will scroll past its limits a
7952     * little bit and return to the edge again, in a animated for,
7953     * automatically.
7954     *
7955     * @note By default, gengrids have bouncing enabled on both axis
7956     *
7957     * @see elm_gengrid_bounce_get()
7958     *
7959     * @ingroup Gengrid
7960     */
7961    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7962
7963    /**
7964     * Get whether bouncing effects are enabled or disabled, for a
7965     * given gengrid widget, on each axis
7966     *
7967     * @param obj The gengrid object
7968     * @param h_bounce Pointer to a variable where to store the
7969     * horizontal bouncing flag.
7970     * @param v_bounce Pointer to a variable where to store the
7971     * vertical bouncing flag.
7972     *
7973     * @see elm_gengrid_bounce_set() for more details
7974     *
7975     * @ingroup Gengrid
7976     */
7977    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7978
7979    /**
7980     * Set a given gengrid widget's scrolling page size, relative to
7981     * its viewport size.
7982     *
7983     * @param obj The gengrid object
7984     * @param h_pagerel The horizontal page (relative) size
7985     * @param v_pagerel The vertical page (relative) size
7986     *
7987     * The gengrid's scroller is capable of binding scrolling by the
7988     * user to "pages". It means that, while scrolling and, specially
7989     * after releasing the mouse button, the grid will @b snap to the
7990     * nearest displaying page's area. When page sizes are set, the
7991     * grid's continuous content area is split into (equal) page sized
7992     * pieces.
7993     *
7994     * This function sets the size of a page <b>relatively to the
7995     * viewport dimensions</b> of the gengrid, for each axis. A value
7996     * @c 1.0 means "the exact viewport's size", in that axis, while @c
7997     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
7998     * a viewport". Sane usable values are, than, between @c 0.0 and @c
7999     * 1.0. Values beyond those will make it behave behave
8000     * inconsistently. If you only want one axis to snap to pages, use
8001     * the value @c 0.0 for the other one.
8002     *
8003     * There is a function setting page size values in @b absolute
8004     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8005     * is mutually exclusive to this one.
8006     *
8007     * @see elm_gengrid_page_relative_get()
8008     *
8009     * @ingroup Gengrid
8010     */
8011    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8012
8013    /**
8014     * Get a given gengrid widget's scrolling page size, relative to
8015     * its viewport size.
8016     *
8017     * @param obj The gengrid object
8018     * @param h_pagerel Pointer to a variable where to store the
8019     * horizontal page (relative) size
8020     * @param v_pagerel Pointer to a variable where to store the
8021     * vertical page (relative) size
8022     *
8023     * @see elm_gengrid_page_relative_set() for more details
8024     *
8025     * @ingroup Gengrid
8026     */
8027    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8028
8029    /**
8030     * Set a given gengrid widget's scrolling page size
8031     *
8032     * @param obj The gengrid object
8033     * @param h_pagerel The horizontal page size, in pixels
8034     * @param v_pagerel The vertical page size, in pixels
8035     *
8036     * The gengrid's scroller is capable of binding scrolling by the
8037     * user to "pages". It means that, while scrolling and, specially
8038     * after releasing the mouse button, the grid will @b snap to the
8039     * nearest displaying page's area. When page sizes are set, the
8040     * grid's continuous content area is split into (equal) page sized
8041     * pieces.
8042     *
8043     * This function sets the size of a page of the gengrid, in pixels,
8044     * for each axis. Sane usable values are, between @c 0 and the
8045     * dimensions of @p obj, for each axis. Values beyond those will
8046     * make it behave behave inconsistently. If you only want one axis
8047     * to snap to pages, use the value @c 0 for the other one.
8048     *
8049     * There is a function setting page size values in @b relative
8050     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8051     * use is mutually exclusive to this one.
8052     *
8053     * @ingroup Gengrid
8054     */
8055    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8056
8057    /**
8058     * Set for what direction a given gengrid widget will expand while
8059     * placing its items.
8060     *
8061     * @param obj The gengrid object.
8062     * @param setting @c EINA_TRUE to make the gengrid expand
8063     * horizontally, @c EINA_FALSE to expand vertically.
8064     *
8065     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8066     * in @b columns, from top to bottom and, when the space for a
8067     * column is filled, another one is started on the right, thus
8068     * expanding the grid horizontally. When in "vertical mode"
8069     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8070     * to right and, when the space for a row is filled, another one is
8071     * started below, thus expanding the grid vertically.
8072     *
8073     * @see elm_gengrid_horizontal_get()
8074     *
8075     * @ingroup Gengrid
8076     */
8077    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8078
8079    /**
8080     * Get for what direction a given gengrid widget will expand while
8081     * placing its items.
8082     *
8083     * @param obj The gengrid object.
8084     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8085     * @c EINA_FALSE if it's set to expand vertically.
8086     *
8087     * @see elm_gengrid_horizontal_set() for more detais
8088     *
8089     * @ingroup Gengrid
8090     */
8091    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8092
8093    /**
8094     * Get the first item in a given gengrid widget
8095     *
8096     * @param obj The gengrid object
8097     * @return The first item's handle or @c NULL, if there are no
8098     * items in @p obj (and on errors)
8099     *
8100     * This returns the first item in the @p obj's internal list of
8101     * items.
8102     *
8103     * @see elm_gengrid_last_item_get()
8104     *
8105     * @ingroup Gengrid
8106     */
8107    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8108
8109    /**
8110     * Get the last item in a given gengrid widget
8111     *
8112     * @param obj The gengrid object
8113     * @return The last item's handle or @c NULL, if there are no
8114     * items in @p obj (and on errors)
8115     *
8116     * This returns the last item in the @p obj's internal list of
8117     * items.
8118     *
8119     * @see elm_gengrid_first_item_get()
8120     *
8121     * @ingroup Gengrid
8122     */
8123    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8124
8125    /**
8126     * Get the @b next item in a gengrid widget's internal list of items,
8127     * given a handle to one of those items.
8128     *
8129     * @param item The gengrid item to fetch next from
8130     * @return The item after @p item, or @c NULL if there's none (and
8131     * on errors)
8132     *
8133     * This returns the item placed after the @p item, on the container
8134     * gengrid.
8135     *
8136     * @see elm_gengrid_item_prev_get()
8137     *
8138     * @ingroup Gengrid
8139     */
8140    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8141
8142    /**
8143     * Get the @b previous item in a gengrid widget's internal list of items,
8144     * given a handle to one of those items.
8145     *
8146     * @param item The gengrid item to fetch previous from
8147     * @return The item before @p item, or @c NULL if there's none (and
8148     * on errors)
8149     *
8150     * This returns the item placed before the @p item, on the container
8151     * gengrid.
8152     *
8153     * @see elm_gengrid_item_next_get()
8154     *
8155     * @ingroup Gengrid
8156     */
8157    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8158
8159    /**
8160     * Get the gengrid object's handle which contains a given gengrid
8161     * item
8162     *
8163     * @param item The item to fetch the container from
8164     * @return The gengrid (parent) object
8165     *
8166     * This returns the gengrid object itself that an item belongs to.
8167     *
8168     * @ingroup Gengrid
8169     */
8170    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8171
8172    /**
8173     * Remove a gengrid item from the its parent, deleting it.
8174     *
8175     * @param item The item to be removed.
8176     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8177     *
8178     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8179     * once.
8180     *
8181     * @ingroup Gengrid
8182     */
8183    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8184
8185    /**
8186     * Update the contents of a given gengrid item
8187     *
8188     * @param item The gengrid item
8189     *
8190     * This updates an item by calling all the item class functions
8191     * again to get the icons, labels and states. Use this when the
8192     * original item data has changed and you want thta changes to be
8193     * reflected.
8194     *
8195     * @ingroup Gengrid
8196     */
8197    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8198    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8199    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8200
8201    /**
8202     * Return the data associated to a given gengrid item
8203     *
8204     * @param item The gengrid item.
8205     * @return the data associated to this item.
8206     *
8207     * This returns the @c data value passed on the
8208     * elm_gengrid_item_append() and related item addition calls.
8209     *
8210     * @see elm_gengrid_item_append()
8211     * @see elm_gengrid_item_data_set()
8212     *
8213     * @ingroup Gengrid
8214     */
8215    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8216
8217    /**
8218     * Set the data associated to a given gengrid item
8219     *
8220     * @param item The gengrid item
8221     * @param data The new data pointer to set on it
8222     *
8223     * This @b overrides the @c data value passed on the
8224     * elm_gengrid_item_append() and related item addition calls. This
8225     * function @b won't call elm_gengrid_item_update() automatically,
8226     * so you'd issue it afterwards if you want to hove the item
8227     * updated to reflect the that new data.
8228     *
8229     * @see elm_gengrid_item_data_get()
8230     *
8231     * @ingroup Gengrid
8232     */
8233    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8234
8235    /**
8236     * Get a given gengrid item's position, relative to the whole
8237     * gengrid's grid area.
8238     *
8239     * @param item The Gengrid item.
8240     * @param x Pointer to variable where to store the item's <b>row
8241     * number</b>.
8242     * @param y Pointer to variable where to store the item's <b>column
8243     * number</b>.
8244     *
8245     * This returns the "logical" position of the item whithin the
8246     * gengrid. For example, @c (0, 1) would stand for first row,
8247     * second column.
8248     *
8249     * @ingroup Gengrid
8250     */
8251    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8252
8253    /**
8254     * Set whether a given gengrid item is selected or not
8255     *
8256     * @param item The gengrid item
8257     * @param selected Use @c EINA_TRUE, to make it selected, @c
8258     * EINA_FALSE to make it unselected
8259     *
8260     * This sets the selected state of an item. If multi selection is
8261     * not enabled on the containing gengrid and @p selected is @c
8262     * EINA_TRUE, any other previously selected items will get
8263     * unselected in favor of this new one.
8264     *
8265     * @see elm_gengrid_item_selected_get()
8266     *
8267     * @ingroup Gengrid
8268     */
8269    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8270
8271    /**
8272     * Get whether a given gengrid item is selected or not
8273     *
8274     * @param item The gengrid item
8275     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8276     *
8277     * @see elm_gengrid_item_selected_set() for more details
8278     *
8279     * @ingroup Gengrid
8280     */
8281    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8282
8283    /**
8284     * Get the real Evas object created to implement the view of a
8285     * given gengrid item
8286     *
8287     * @param item The gengrid item.
8288     * @return the Evas object implementing this item's view.
8289     *
8290     * This returns the actual Evas object used to implement the
8291     * specified gengrid item's view. This may be @c NULL, as it may
8292     * not have been created or may have been deleted, at any time, by
8293     * the gengrid. <b>Do not modify this object</b> (move, resize,
8294     * show, hide, etc.), as the gengrid is controlling it. This
8295     * function is for querying, emitting custom signals or hooking
8296     * lower level callbacks for events on that object. Do not delete
8297     * this object under any circumstances.
8298     *
8299     * @see elm_gengrid_item_data_get()
8300     *
8301     * @ingroup Gengrid
8302     */
8303    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8304
8305    /**
8306     * Show the portion of a gengrid's internal grid containing a given
8307     * item, @b immediately.
8308     *
8309     * @param item The item to display
8310     *
8311     * This causes gengrid to @b redraw its viewport's contents to the
8312     * region contining the given @p item item, if it is not fully
8313     * visible.
8314     *
8315     * @see elm_gengrid_item_bring_in()
8316     *
8317     * @ingroup Gengrid
8318     */
8319    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8320
8321    /**
8322     * Animatedly bring in, to the visible are of a gengrid, a given
8323     * item on it.
8324     *
8325     * @param item The gengrid item to display
8326     *
8327     * This causes gengrig to jump to the given @p item item and show
8328     * it (by scrolling), if it is not fully visible. This will use
8329     * animation to do so and take a period of time to complete.
8330     *
8331     * @see elm_gengrid_item_show()
8332     *
8333     * @ingroup Gengrid
8334     */
8335    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8336
8337    /**
8338     * Set whether a given gengrid item is disabled or not.
8339     *
8340     * @param item The gengrid item
8341     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8342     * to enable it back.
8343     *
8344     * A disabled item cannot be selected or unselected. It will also
8345     * change its appearance, to signal the user it's disabled.
8346     *
8347     * @see elm_gengrid_item_disabled_get()
8348     *
8349     * @ingroup Gengrid
8350     */
8351    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8352
8353    /**
8354     * Get whether a given gengrid item is disabled or not.
8355     *
8356     * @param item The gengrid item
8357     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8358     * (and on errors).
8359     *
8360     * @see elm_gengrid_item_disabled_set() for more details
8361     *
8362     * @ingroup Gengrid
8363     */
8364    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8365
8366    /**
8367     * Set the text to be shown in a given gengrid item's tooltips.
8368     *
8369     * @param item The gengrid item
8370     * @param text The text to set in the content
8371     *
8372     * This call will setup the text to be used as tooltip to that item
8373     * (analogous to elm_object_tooltip_text_set(), but being item
8374     * tooltips with higher precedence than object tooltips). It can
8375     * have only one tooltip at a time, so any previous tooltip data
8376     * will get removed.
8377     *
8378     * @ingroup Gengrid
8379     */
8380    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8381
8382    /**
8383     * Set the content to be shown in a given gengrid item's tooltips
8384     *
8385     * @param item The gengrid item.
8386     * @param func The function returning the tooltip contents.
8387     * @param data What to provide to @a func as callback data/context.
8388     * @param del_cb Called when data is not needed anymore, either when
8389     *        another callback replaces @p func, the tooltip is unset with
8390     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8391     *        dies. This callback receives as its first parameter the
8392     *        given @p data, being @c event_info the item handle.
8393     *
8394     * This call will setup the tooltip's contents to @p item
8395     * (analogous to elm_object_tooltip_content_cb_set(), but being
8396     * item tooltips with higher precedence than object tooltips). It
8397     * can have only one tooltip at a time, so any previous tooltip
8398     * content will get removed. @p func (with @p data) will be called
8399     * every time Elementary needs to show the tooltip and it should
8400     * return a valid Evas object, which will be fully managed by the
8401     * tooltip system, getting deleted when the tooltip is gone.
8402     *
8403     * @ingroup Gengrid
8404     */
8405    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);
8406
8407    /**
8408     * Unset a tooltip from a given gengrid item
8409     *
8410     * @param item gengrid item to remove a previously set tooltip from.
8411     *
8412     * This call removes any tooltip set on @p item. The callback
8413     * provided as @c del_cb to
8414     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8415     * notify it is not used anymore (and have resources cleaned, if
8416     * need be).
8417     *
8418     * @see elm_gengrid_item_tooltip_content_cb_set()
8419     *
8420     * @ingroup Gengrid
8421     */
8422    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8423
8424    /**
8425     * Set a different @b style for a given gengrid item's tooltip.
8426     *
8427     * @param item gengrid item with tooltip set
8428     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8429     * "default", @c "transparent", etc)
8430     *
8431     * Tooltips can have <b>alternate styles</b> to be displayed on,
8432     * which are defined by the theme set on Elementary. This function
8433     * works analogously as elm_object_tooltip_style_set(), but here
8434     * applied only to gengrid item objects. The default style for
8435     * tooltips is @c "default".
8436     *
8437     * @note before you set a style you should define a tooltip with
8438     *       elm_gengrid_item_tooltip_content_cb_set() or
8439     *       elm_gengrid_item_tooltip_text_set()
8440     *
8441     * @see elm_gengrid_item_tooltip_style_get()
8442     *
8443     * @ingroup Gengrid
8444     */
8445    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8446
8447    /**
8448     * Get the style set a given gengrid item's tooltip.
8449     *
8450     * @param item gengrid item with tooltip already set on.
8451     * @return style the theme style in use, which defaults to
8452     *         "default". If the object does not have a tooltip set,
8453     *         then @c NULL is returned.
8454     *
8455     * @see elm_gengrid_item_tooltip_style_set() for more details
8456     *
8457     * @ingroup Gengrid
8458     */
8459    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8460    /**
8461     * @brief Disable size restrictions on an object's tooltip
8462     * @param item The tooltip's anchor object
8463     * @param disable If EINA_TRUE, size restrictions are disabled
8464     * @return EINA_FALSE on failure, EINA_TRUE on success
8465     *
8466     * This function allows a tooltip to expand beyond its parant window's canvas.
8467     * It will instead be limited only by the size of the display.
8468     */
8469    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8470    /**
8471     * @brief Retrieve size restriction state of an object's tooltip
8472     * @param item The tooltip's anchor object
8473     * @return If EINA_TRUE, size restrictions are disabled
8474     *
8475     * This function returns whether a tooltip is allowed to expand beyond
8476     * its parant window's canvas.
8477     * It will instead be limited only by the size of the display.
8478     */
8479    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8480    /**
8481     * Set the type of mouse pointer/cursor decoration to be shown,
8482     * when the mouse pointer is over the given gengrid widget item
8483     *
8484     * @param item gengrid item to customize cursor on
8485     * @param cursor the cursor type's name
8486     *
8487     * This function works analogously as elm_object_cursor_set(), but
8488     * here the cursor's changing area is restricted to the item's
8489     * area, and not the whole widget's. Note that that item cursors
8490     * have precedence over widget cursors, so that a mouse over @p
8491     * item will always show cursor @p type.
8492     *
8493     * If this function is called twice for an object, a previously set
8494     * cursor will be unset on the second call.
8495     *
8496     * @see elm_object_cursor_set()
8497     * @see elm_gengrid_item_cursor_get()
8498     * @see elm_gengrid_item_cursor_unset()
8499     *
8500     * @ingroup Gengrid
8501     */
8502    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8503
8504    /**
8505     * Get the type of mouse pointer/cursor decoration set to be shown,
8506     * when the mouse pointer is over the given gengrid widget item
8507     *
8508     * @param item gengrid item with custom cursor set
8509     * @return the cursor type's name or @c NULL, if no custom cursors
8510     * were set to @p item (and on errors)
8511     *
8512     * @see elm_object_cursor_get()
8513     * @see elm_gengrid_item_cursor_set() for more details
8514     * @see elm_gengrid_item_cursor_unset()
8515     *
8516     * @ingroup Gengrid
8517     */
8518    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8519
8520    /**
8521     * Unset any custom mouse pointer/cursor decoration set to be
8522     * shown, when the mouse pointer is over the given gengrid widget
8523     * item, thus making it show the @b default cursor again.
8524     *
8525     * @param item a gengrid item
8526     *
8527     * Use this call to undo any custom settings on this item's cursor
8528     * decoration, bringing it back to defaults (no custom style set).
8529     *
8530     * @see elm_object_cursor_unset()
8531     * @see elm_gengrid_item_cursor_set() for more details
8532     *
8533     * @ingroup Gengrid
8534     */
8535    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8536
8537    /**
8538     * Set a different @b style for a given custom cursor set for a
8539     * gengrid item.
8540     *
8541     * @param item gengrid item with custom cursor set
8542     * @param style the <b>theme style</b> to use (e.g. @c "default",
8543     * @c "transparent", etc)
8544     *
8545     * This function only makes sense when one is using custom mouse
8546     * cursor decorations <b>defined in a theme file</b> , which can
8547     * have, given a cursor name/type, <b>alternate styles</b> on
8548     * it. It works analogously as elm_object_cursor_style_set(), but
8549     * here applied only to gengrid item objects.
8550     *
8551     * @warning Before you set a cursor style you should have defined a
8552     *       custom cursor previously on the item, with
8553     *       elm_gengrid_item_cursor_set()
8554     *
8555     * @see elm_gengrid_item_cursor_engine_only_set()
8556     * @see elm_gengrid_item_cursor_style_get()
8557     *
8558     * @ingroup Gengrid
8559     */
8560    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8561
8562    /**
8563     * Get the current @b style set for a given gengrid item's custom
8564     * cursor
8565     *
8566     * @param item gengrid item with custom cursor set.
8567     * @return style the cursor style in use. If the object does not
8568     *         have a cursor set, then @c NULL is returned.
8569     *
8570     * @see elm_gengrid_item_cursor_style_set() for more details
8571     *
8572     * @ingroup Gengrid
8573     */
8574    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8575
8576    /**
8577     * Set if the (custom) cursor for a given gengrid item should be
8578     * searched in its theme, also, or should only rely on the
8579     * rendering engine.
8580     *
8581     * @param item item with custom (custom) cursor already set on
8582     * @param engine_only Use @c EINA_TRUE to have cursors looked for
8583     * only on those provided by the rendering engine, @c EINA_FALSE to
8584     * have them searched on the widget's theme, as well.
8585     *
8586     * @note This call is of use only if you've set a custom cursor
8587     * for gengrid items, with elm_gengrid_item_cursor_set().
8588     *
8589     * @note By default, cursors will only be looked for between those
8590     * provided by the rendering engine.
8591     *
8592     * @ingroup Gengrid
8593     */
8594    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8595
8596    /**
8597     * Get if the (custom) cursor for a given gengrid item is being
8598     * searched in its theme, also, or is only relying on the rendering
8599     * engine.
8600     *
8601     * @param item a gengrid item
8602     * @return @c EINA_TRUE, if cursors are being looked for only on
8603     * those provided by the rendering engine, @c EINA_FALSE if they
8604     * are being searched on the widget's theme, as well.
8605     *
8606     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8607     *
8608     * @ingroup Gengrid
8609     */
8610    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8611
8612    /**
8613     * Remove all items from a given gengrid widget
8614     *
8615     * @param obj The gengrid object.
8616     *
8617     * This removes (and deletes) all items in @p obj, leaving it
8618     * empty.
8619     *
8620     * @see elm_gengrid_item_del(), to remove just one item.
8621     *
8622     * @ingroup Gengrid
8623     */
8624    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8625
8626    /**
8627     * Get the selected item in a given gengrid widget
8628     *
8629     * @param obj The gengrid object.
8630     * @return The selected item's handleor @c NULL, if none is
8631     * selected at the moment (and on errors)
8632     *
8633     * This returns the selected item in @p obj. If multi selection is
8634     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8635     * the first item in the list is selected, which might not be very
8636     * useful. For that case, see elm_gengrid_selected_items_get().
8637     *
8638     * @ingroup Gengrid
8639     */
8640    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8641
8642    /**
8643     * Get <b>a list</b> of selected items in a given gengrid
8644     *
8645     * @param obj The gengrid object.
8646     * @return The list of selected items or @c NULL, if none is
8647     * selected at the moment (and on errors)
8648     *
8649     * This returns a list of the selected items, in the order that
8650     * they appear in the grid. This list is only valid as long as no
8651     * more items are selected or unselected (or unselected implictly
8652     * by deletion). The list contains #Elm_Gengrid_Item pointers as
8653     * data, naturally.
8654     *
8655     * @see elm_gengrid_selected_item_get()
8656     *
8657     * @ingroup Gengrid
8658     */
8659    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8660
8661    /**
8662     * @}
8663     */
8664
8665    /**
8666     * @defgroup Clock Clock
8667     *
8668     * @image html img/widget/clock/preview-00.png
8669     * @image latex img/widget/clock/preview-00.eps
8670     *
8671     * This is a @b digital clock widget. In its default theme, it has a
8672     * vintage "flipping numbers clock" appearance, which will animate
8673     * sheets of individual algarisms individually as time goes by.
8674     *
8675     * A newly created clock will fetch system's time (already
8676     * considering local time adjustments) to start with, and will tick
8677     * accondingly. It may or may not show seconds.
8678     *
8679     * Clocks have an @b edition mode. When in it, the sheets will
8680     * display extra arrow indications on the top and bottom and the
8681     * user may click on them to raise or lower the time values. After
8682     * it's told to exit edition mode, it will keep ticking with that
8683     * new time set (it keeps the difference from local time).
8684     *
8685     * Also, when under edition mode, user clicks on the cited arrows
8686     * which are @b held for some time will make the clock to flip the
8687     * sheet, thus editing the time, continuosly and automatically for
8688     * the user. The interval between sheet flips will keep growing in
8689     * time, so that it helps the user to reach a time which is distant
8690     * from the one set.
8691     *
8692     * The time display is, by default, in military mode (24h), but an
8693     * am/pm indicator may be optionally shown, too, when it will
8694     * switch to 12h.
8695     *
8696     * Smart callbacks one can register to:
8697     * - "changed" - the clock's user changed the time
8698     *
8699     * Here is an example on its usage:
8700     * @li @ref clock_example
8701     */
8702
8703    /**
8704     * @addtogroup Clock
8705     * @{
8706     */
8707
8708    /**
8709     * Identifiers for which clock digits should be editable, when a
8710     * clock widget is in edition mode. Values may be ORed together to
8711     * make a mask, naturally.
8712     *
8713     * @see elm_clock_edit_set()
8714     * @see elm_clock_digit_edit_set()
8715     */
8716    typedef enum _Elm_Clock_Digedit
8717      {
8718         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8719         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8720         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
8721         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8722         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
8723         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8724         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
8725         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
8726      } Elm_Clock_Digedit;
8727
8728    /**
8729     * Add a new clock widget to the given parent Elementary
8730     * (container) object
8731     *
8732     * @param parent The parent object
8733     * @return a new clock widget handle or @c NULL, on errors
8734     *
8735     * This function inserts a new clock widget on the canvas.
8736     *
8737     * @ingroup Clock
8738     */
8739    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8740
8741    /**
8742     * Set a clock widget's time, programmatically
8743     *
8744     * @param obj The clock widget object
8745     * @param hrs The hours to set
8746     * @param min The minutes to set
8747     * @param sec The secondes to set
8748     *
8749     * This function updates the time that is showed by the clock
8750     * widget.
8751     *
8752     *  Values @b must be set within the following ranges:
8753     * - 0 - 23, for hours
8754     * - 0 - 59, for minutes
8755     * - 0 - 59, for seconds,
8756     *
8757     * even if the clock is not in "military" mode.
8758     *
8759     * @warning The behavior for values set out of those ranges is @b
8760     * indefined.
8761     *
8762     * @ingroup Clock
8763     */
8764    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
8765
8766    /**
8767     * Get a clock widget's time values
8768     *
8769     * @param obj The clock object
8770     * @param[out] hrs Pointer to the variable to get the hours value
8771     * @param[out] min Pointer to the variable to get the minutes value
8772     * @param[out] sec Pointer to the variable to get the seconds value
8773     *
8774     * This function gets the time set for @p obj, returning
8775     * it on the variables passed as the arguments to function
8776     *
8777     * @note Use @c NULL pointers on the time values you're not
8778     * interested in: they'll be ignored by the function.
8779     *
8780     * @ingroup Clock
8781     */
8782    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
8783
8784    /**
8785     * Set whether a given clock widget is under <b>edition mode</b> or
8786     * under (default) displaying-only mode.
8787     *
8788     * @param obj The clock object
8789     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
8790     * put it back to "displaying only" mode
8791     *
8792     * This function makes a clock's time to be editable or not <b>by
8793     * user interaction</b>. When in edition mode, clocks @b stop
8794     * ticking, until one brings them back to canonical mode. The
8795     * elm_clock_digit_edit_set() function will influence which digits
8796     * of the clock will be editable. By default, all of them will be
8797     * (#ELM_CLOCK_NONE).
8798     *
8799     * @note am/pm sheets, if being shown, will @b always be editable
8800     * under edition mode.
8801     *
8802     * @see elm_clock_edit_get()
8803     *
8804     * @ingroup Clock
8805     */
8806    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
8807
8808    /**
8809     * Retrieve whether a given clock widget is under <b>edition
8810     * mode</b> or under (default) displaying-only mode.
8811     *
8812     * @param obj The clock object
8813     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
8814     * otherwise
8815     *
8816     * This function retrieves whether the clock's time can be edited
8817     * or not by user interaction.
8818     *
8819     * @see elm_clock_edit_set() for more details
8820     *
8821     * @ingroup Clock
8822     */
8823    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8824
8825    /**
8826     * Set what digits of the given clock widget should be editable
8827     * when in edition mode.
8828     *
8829     * @param obj The clock object
8830     * @param digedit Bit mask indicating the digits to be editable
8831     * (values in #Elm_Clock_Digedit).
8832     *
8833     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
8834     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
8835     * EINA_FALSE).
8836     *
8837     * @see elm_clock_digit_edit_get()
8838     *
8839     * @ingroup Clock
8840     */
8841    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
8842
8843    /**
8844     * Retrieve what digits of the given clock widget should be
8845     * editable when in edition mode.
8846     *
8847     * @param obj The clock object
8848     * @return Bit mask indicating the digits to be editable
8849     * (values in #Elm_Clock_Digedit).
8850     *
8851     * @see elm_clock_digit_edit_set() for more details
8852     *
8853     * @ingroup Clock
8854     */
8855    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8856
8857    /**
8858     * Set if the given clock widget must show hours in military or
8859     * am/pm mode
8860     *
8861     * @param obj The clock object
8862     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
8863     * to military mode
8864     *
8865     * This function sets if the clock must show hours in military or
8866     * am/pm mode. In some countries like Brazil the military mode
8867     * (00-24h-format) is used, in opposition to the USA, where the
8868     * am/pm mode is more commonly used.
8869     *
8870     * @see elm_clock_show_am_pm_get()
8871     *
8872     * @ingroup Clock
8873     */
8874    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
8875
8876    /**
8877     * Get if the given clock widget shows hours in military or am/pm
8878     * mode
8879     *
8880     * @param obj The clock object
8881     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
8882     * military
8883     *
8884     * This function gets if the clock shows hours in military or am/pm
8885     * mode.
8886     *
8887     * @see elm_clock_show_am_pm_set() for more details
8888     *
8889     * @ingroup Clock
8890     */
8891    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8892
8893    /**
8894     * Set if the given clock widget must show time with seconds or not
8895     *
8896     * @param obj The clock object
8897     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
8898     *
8899     * This function sets if the given clock must show or not elapsed
8900     * seconds. By default, they are @b not shown.
8901     *
8902     * @see elm_clock_show_seconds_get()
8903     *
8904     * @ingroup Clock
8905     */
8906    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
8907
8908    /**
8909     * Get whether the given clock widget is showing time with seconds
8910     * or not
8911     *
8912     * @param obj The clock object
8913     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
8914     *
8915     * This function gets whether @p obj is showing or not the elapsed
8916     * seconds.
8917     *
8918     * @see elm_clock_show_seconds_set()
8919     *
8920     * @ingroup Clock
8921     */
8922    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8923
8924    /**
8925     * Set the interval on time updates for an user mouse button hold
8926     * on clock widgets' time edition.
8927     *
8928     * @param obj The clock object
8929     * @param interval The (first) interval value in seconds
8930     *
8931     * This interval value is @b decreased while the user holds the
8932     * mouse pointer either incrementing or decrementing a given the
8933     * clock digit's value.
8934     *
8935     * This helps the user to get to a given time distant from the
8936     * current one easier/faster, as it will start to flip quicker and
8937     * quicker on mouse button holds.
8938     *
8939     * The calculation for the next flip interval value, starting from
8940     * the one set with this call, is the previous interval divided by
8941     * 1.05, so it decreases a little bit.
8942     *
8943     * The default starting interval value for automatic flips is
8944     * @b 0.85 seconds.
8945     *
8946     * @see elm_clock_interval_get()
8947     *
8948     * @ingroup Clock
8949     */
8950    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
8951
8952    /**
8953     * Get the interval on time updates for an user mouse button hold
8954     * on clock widgets' time edition.
8955     *
8956     * @param obj The clock object
8957     * @return The (first) interval value, in seconds, set on it
8958     *
8959     * @see elm_clock_interval_set() for more details
8960     *
8961     * @ingroup Clock
8962     */
8963    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8964
8965    /**
8966     * @}
8967     */
8968
8969    /**
8970     * @defgroup Layout Layout
8971     *
8972     * @image html img/widget/layout/preview-00.png
8973     * @image latex img/widget/layout/preview-00.eps width=\textwidth
8974     *
8975     * @image html img/layout-predefined.png
8976     * @image latex img/layout-predefined.eps width=\textwidth
8977     *
8978     * This is a container widget that takes a standard Edje design file and
8979     * wraps it very thinly in a widget.
8980     *
8981     * An Edje design (theme) file has a very wide range of possibilities to
8982     * describe the behavior of elements added to the Layout. Check out the Edje
8983     * documentation and the EDC reference to get more information about what can
8984     * be done with Edje.
8985     *
8986     * Just like @ref List, @ref Box, and other container widgets, any
8987     * object added to the Layout will become its child, meaning that it will be
8988     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
8989     *
8990     * The Layout widget can contain as many Contents, Boxes or Tables as
8991     * described in its theme file. For instance, objects can be added to
8992     * different Tables by specifying the respective Table part names. The same
8993     * is valid for Content and Box.
8994     *
8995     * The objects added as child of the Layout will behave as described in the
8996     * part description where they were added. There are 3 possible types of
8997     * parts where a child can be added:
8998     *
8999     * @section secContent Content (SWALLOW part)
9000     *
9001     * Only one object can be added to the @c SWALLOW part (but you still can
9002     * have many @c SWALLOW parts and one object on each of them). Use the @c
9003     * elm_layout_content_* set of functions to set, retrieve and unset objects
9004     * as content of the @c SWALLOW. After being set to this part, the object
9005     * size, position, visibility, clipping and other description properties
9006     * will be totally controled by the description of the given part (inside
9007     * the Edje theme file).
9008     *
9009     * One can use @c evas_object_size_hint_* functions on the child to have some
9010     * kind of control over its behavior, but the resulting behavior will still
9011     * depend heavily on the @c SWALLOW part description.
9012     *
9013     * The Edje theme also can change the part description, based on signals or
9014     * scripts running inside the theme. This change can also be animated. All of
9015     * this will affect the child object set as content accordingly. The object
9016     * size will be changed if the part size is changed, it will animate move if
9017     * the part is moving, and so on.
9018     *
9019     * The following picture demonstrates a Layout widget with a child object
9020     * added to its @c SWALLOW:
9021     *
9022     * @image html layout_swallow.png
9023     * @image latex layout_swallow.eps width=\textwidth
9024     *
9025     * @section secBox Box (BOX part)
9026     *
9027     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9028     * allows one to add objects to the box and have them distributed along its
9029     * area, accordingly to the specified @a layout property (now by @a layout we
9030     * mean the chosen layouting design of the Box, not the Layout widget
9031     * itself).
9032     *
9033     * A similar effect for having a box with its position, size and other things
9034     * controled by the Layout theme would be to create an Elementary @ref Box
9035     * widget and add it as a Content in the @c SWALLOW part.
9036     *
9037     * The main difference of using the Layout Box is that its behavior, the box
9038     * properties like layouting format, padding, align, etc. will be all
9039     * controled by the theme. This means, for example, that a signal could be
9040     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9041     * handled the signal by changing the box padding, or align, or both. Using
9042     * the Elementary @ref Box widget is not necessarily harder or easier, it
9043     * just depends on the circunstances and requirements.
9044     *
9045     * The Layout Box can be used through the @c elm_layout_box_* set of
9046     * functions.
9047     *
9048     * The following picture demonstrates a Layout widget with many child objects
9049     * added to its @c BOX part:
9050     *
9051     * @image html layout_box.png
9052     * @image latex layout_box.eps width=\textwidth
9053     *
9054     * @section secTable Table (TABLE part)
9055     *
9056     * Just like the @ref secBox, the Layout Table is very similar to the
9057     * Elementary @ref Table widget. It allows one to add objects to the Table
9058     * specifying the row and column where the object should be added, and any
9059     * column or row span if necessary.
9060     *
9061     * Again, we could have this design by adding a @ref Table widget to the @c
9062     * SWALLOW part using elm_layout_content_set(). The same difference happens
9063     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9064     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9065     *
9066     * The Layout Table can be used through the @c elm_layout_table_* set of
9067     * functions.
9068     *
9069     * The following picture demonstrates a Layout widget with many child objects
9070     * added to its @c TABLE part:
9071     *
9072     * @image html layout_table.png
9073     * @image latex layout_table.eps width=\textwidth
9074     *
9075     * @section secPredef Predefined Layouts
9076     *
9077     * Another interesting thing about the Layout widget is that it offers some
9078     * predefined themes that come with the default Elementary theme. These
9079     * themes can be set by the call elm_layout_theme_set(), and provide some
9080     * basic functionality depending on the theme used.
9081     *
9082     * Most of them already send some signals, some already provide a toolbar or
9083     * back and next buttons.
9084     *
9085     * These are available predefined theme layouts. All of them have class = @c
9086     * layout, group = @c application, and style = one of the following options:
9087     *
9088     * @li @c toolbar-content - application with toolbar and main content area
9089     * @li @c toolbar-content-back - application with toolbar and main content
9090     * area with a back button and title area
9091     * @li @c toolbar-content-back-next - application with toolbar and main
9092     * content area with a back and next buttons and title area
9093     * @li @c content-back - application with a main content area with a back
9094     * button and title area
9095     * @li @c content-back-next - application with a main content area with a
9096     * back and next buttons and title area
9097     * @li @c toolbar-vbox - application with toolbar and main content area as a
9098     * vertical box
9099     * @li @c toolbar-table - application with toolbar and main content area as a
9100     * table
9101     *
9102     * @section secExamples Examples
9103     *
9104     * Some examples of the Layout widget can be found here:
9105     * @li @ref layout_example_01
9106     * @li @ref layout_example_02
9107     * @li @ref layout_example_03
9108     * @li @ref layout_example_edc
9109     *
9110     */
9111
9112    /**
9113     * Add a new layout to the parent
9114     *
9115     * @param parent The parent object
9116     * @return The new object or NULL if it cannot be created
9117     *
9118     * @see elm_layout_file_set()
9119     * @see elm_layout_theme_set()
9120     *
9121     * @ingroup Layout
9122     */
9123    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9124    /**
9125     * Set the file that will be used as layout
9126     *
9127     * @param obj The layout object
9128     * @param file The path to file (edj) that will be used as layout
9129     * @param group The group that the layout belongs in edje file
9130     *
9131     * @return (1 = success, 0 = error)
9132     *
9133     * @ingroup Layout
9134     */
9135    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9136    /**
9137     * Set the edje group from the elementary theme that will be used as layout
9138     *
9139     * @param obj The layout object
9140     * @param clas the clas of the group
9141     * @param group the group
9142     * @param style the style to used
9143     *
9144     * @return (1 = success, 0 = error)
9145     *
9146     * @ingroup Layout
9147     */
9148    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9149    /**
9150     * Set the layout content.
9151     *
9152     * @param obj The layout object
9153     * @param swallow The swallow part name in the edje file
9154     * @param content The child that will be added in this layout object
9155     *
9156     * Once the content object is set, a previously set one will be deleted.
9157     * If you want to keep that old content object, use the
9158     * elm_layout_content_unset() function.
9159     *
9160     * @note In an Edje theme, the part used as a content container is called @c
9161     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9162     * expected to be a part name just like the second parameter of
9163     * elm_layout_box_append().
9164     *
9165     * @see elm_layout_box_append()
9166     * @see elm_layout_content_get()
9167     * @see elm_layout_content_unset()
9168     * @see @ref secBox
9169     *
9170     * @ingroup Layout
9171     */
9172    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9173    /**
9174     * Get the child object in the given content part.
9175     *
9176     * @param obj The layout object
9177     * @param swallow The SWALLOW part to get its content
9178     *
9179     * @return The swallowed object or NULL if none or an error occurred
9180     *
9181     * @see elm_layout_content_set()
9182     *
9183     * @ingroup Layout
9184     */
9185    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9186    /**
9187     * Unset the layout content.
9188     *
9189     * @param obj The layout object
9190     * @param swallow The swallow part name in the edje file
9191     * @return The content that was being used
9192     *
9193     * Unparent and return the content object which was set for this part.
9194     *
9195     * @see elm_layout_content_set()
9196     *
9197     * @ingroup Layout
9198     */
9199     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9200    /**
9201     * Set the text of the given part
9202     *
9203     * @param obj The layout object
9204     * @param part The TEXT part where to set the text
9205     * @param text The text to set
9206     *
9207     * @ingroup Layout
9208     * @deprecated use elm_object_text_* instead.
9209     */
9210    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9211    /**
9212     * Get the text set in the given part
9213     *
9214     * @param obj The layout object
9215     * @param part The TEXT part to retrieve the text off
9216     *
9217     * @return The text set in @p part
9218     *
9219     * @ingroup Layout
9220     * @deprecated use elm_object_text_* instead.
9221     */
9222    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9223    /**
9224     * Append child to layout box part.
9225     *
9226     * @param obj the layout object
9227     * @param part the box part to which the object will be appended.
9228     * @param child the child object to append to box.
9229     *
9230     * Once the object is appended, it will become child of the layout. Its
9231     * lifetime will be bound to the layout, whenever the layout dies the child
9232     * will be deleted automatically. One should use elm_layout_box_remove() to
9233     * make this layout forget about the object.
9234     *
9235     * @see elm_layout_box_prepend()
9236     * @see elm_layout_box_insert_before()
9237     * @see elm_layout_box_insert_at()
9238     * @see elm_layout_box_remove()
9239     *
9240     * @ingroup Layout
9241     */
9242    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9243    /**
9244     * Prepend child to layout box part.
9245     *
9246     * @param obj the layout object
9247     * @param part the box part to prepend.
9248     * @param child the child object to prepend to box.
9249     *
9250     * Once the object is prepended, it will become child of the layout. Its
9251     * lifetime will be bound to the layout, whenever the layout dies the child
9252     * will be deleted automatically. One should use elm_layout_box_remove() to
9253     * make this layout forget about the object.
9254     *
9255     * @see elm_layout_box_append()
9256     * @see elm_layout_box_insert_before()
9257     * @see elm_layout_box_insert_at()
9258     * @see elm_layout_box_remove()
9259     *
9260     * @ingroup Layout
9261     */
9262    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9263    /**
9264     * Insert child to layout box part before a reference object.
9265     *
9266     * @param obj the layout object
9267     * @param part the box part to insert.
9268     * @param child the child object to insert into box.
9269     * @param reference another reference object to insert before in box.
9270     *
9271     * Once the object is inserted, it will become child of the layout. Its
9272     * lifetime will be bound to the layout, whenever the layout dies the child
9273     * will be deleted automatically. One should use elm_layout_box_remove() to
9274     * make this layout forget about the object.
9275     *
9276     * @see elm_layout_box_append()
9277     * @see elm_layout_box_prepend()
9278     * @see elm_layout_box_insert_before()
9279     * @see elm_layout_box_remove()
9280     *
9281     * @ingroup Layout
9282     */
9283    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9284    /**
9285     * Insert child to layout box part at a given position.
9286     *
9287     * @param obj the layout object
9288     * @param part the box part to insert.
9289     * @param child the child object to insert into box.
9290     * @param pos the numeric position >=0 to insert the child.
9291     *
9292     * Once the object is inserted, it will become child of the layout. Its
9293     * lifetime will be bound to the layout, whenever the layout dies the child
9294     * will be deleted automatically. One should use elm_layout_box_remove() to
9295     * make this layout forget about the object.
9296     *
9297     * @see elm_layout_box_append()
9298     * @see elm_layout_box_prepend()
9299     * @see elm_layout_box_insert_before()
9300     * @see elm_layout_box_remove()
9301     *
9302     * @ingroup Layout
9303     */
9304    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9305    /**
9306     * Remove a child of the given part box.
9307     *
9308     * @param obj The layout object
9309     * @param part The box part name to remove child.
9310     * @param child The object to remove from box.
9311     * @return The object that was being used, or NULL if not found.
9312     *
9313     * The object will be removed from the box part and its lifetime will
9314     * not be handled by the layout anymore. This is equivalent to
9315     * elm_layout_content_unset() for box.
9316     *
9317     * @see elm_layout_box_append()
9318     * @see elm_layout_box_remove_all()
9319     *
9320     * @ingroup Layout
9321     */
9322    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9323    /**
9324     * Remove all child of the given part box.
9325     *
9326     * @param obj The layout object
9327     * @param part The box part name to remove child.
9328     * @param clear If EINA_TRUE, then all objects will be deleted as
9329     *        well, otherwise they will just be removed and will be
9330     *        dangling on the canvas.
9331     *
9332     * The objects will be removed from the box part and their lifetime will
9333     * not be handled by the layout anymore. This is equivalent to
9334     * elm_layout_box_remove() for all box children.
9335     *
9336     * @see elm_layout_box_append()
9337     * @see elm_layout_box_remove()
9338     *
9339     * @ingroup Layout
9340     */
9341    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9342    /**
9343     * Insert child to layout table part.
9344     *
9345     * @param obj the layout object
9346     * @param part the box part to pack child.
9347     * @param child_obj the child object to pack into table.
9348     * @param col the column to which the child should be added. (>= 0)
9349     * @param row the row to which the child should be added. (>= 0)
9350     * @param colspan how many columns should be used to store this object. (>=
9351     *        1)
9352     * @param rowspan how many rows should be used to store this object. (>= 1)
9353     *
9354     * Once the object is inserted, it will become child of the table. Its
9355     * lifetime will be bound to the layout, and whenever the layout dies the
9356     * child will be deleted automatically. One should use
9357     * elm_layout_table_remove() to make this layout forget about the object.
9358     *
9359     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9360     * more space than a single cell. For instance, the following code:
9361     * @code
9362     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9363     * @endcode
9364     *
9365     * Would result in an object being added like the following picture:
9366     *
9367     * @image html layout_colspan.png
9368     * @image latex layout_colspan.eps width=\textwidth
9369     *
9370     * @see elm_layout_table_unpack()
9371     * @see elm_layout_table_clear()
9372     *
9373     * @ingroup Layout
9374     */
9375    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);
9376    /**
9377     * Unpack (remove) a child of the given part table.
9378     *
9379     * @param obj The layout object
9380     * @param part The table part name to remove child.
9381     * @param child_obj The object to remove from table.
9382     * @return The object that was being used, or NULL if not found.
9383     *
9384     * The object will be unpacked from the table part and its lifetime
9385     * will not be handled by the layout anymore. This is equivalent to
9386     * elm_layout_content_unset() for table.
9387     *
9388     * @see elm_layout_table_pack()
9389     * @see elm_layout_table_clear()
9390     *
9391     * @ingroup Layout
9392     */
9393    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9394    /**
9395     * Remove all child of the given part table.
9396     *
9397     * @param obj The layout object
9398     * @param part The table part name to remove child.
9399     * @param clear If EINA_TRUE, then all objects will be deleted as
9400     *        well, otherwise they will just be removed and will be
9401     *        dangling on the canvas.
9402     *
9403     * The objects will be removed from the table part and their lifetime will
9404     * not be handled by the layout anymore. This is equivalent to
9405     * elm_layout_table_unpack() for all table children.
9406     *
9407     * @see elm_layout_table_pack()
9408     * @see elm_layout_table_unpack()
9409     *
9410     * @ingroup Layout
9411     */
9412    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9413    /**
9414     * Get the edje layout
9415     *
9416     * @param obj The layout object
9417     *
9418     * @return A Evas_Object with the edje layout settings loaded
9419     * with function elm_layout_file_set
9420     *
9421     * This returns the edje object. It is not expected to be used to then
9422     * swallow objects via edje_object_part_swallow() for example. Use
9423     * elm_layout_content_set() instead so child object handling and sizing is
9424     * done properly.
9425     *
9426     * @note This function should only be used if you really need to call some
9427     * low level Edje function on this edje object. All the common stuff (setting
9428     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9429     * with proper elementary functions.
9430     *
9431     * @see elm_object_signal_callback_add()
9432     * @see elm_object_signal_emit()
9433     * @see elm_object_text_part_set()
9434     * @see elm_layout_content_set()
9435     * @see elm_layout_box_append()
9436     * @see elm_layout_table_pack()
9437     * @see elm_layout_data_get()
9438     *
9439     * @ingroup Layout
9440     */
9441    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9442    /**
9443     * Get the edje data from the given layout
9444     *
9445     * @param obj The layout object
9446     * @param key The data key
9447     *
9448     * @return The edje data string
9449     *
9450     * This function fetches data specified inside the edje theme of this layout.
9451     * This function return NULL if data is not found.
9452     *
9453     * In EDC this comes from a data block within the group block that @p
9454     * obj was loaded from. E.g.
9455     *
9456     * @code
9457     * collections {
9458     *   group {
9459     *     name: "a_group";
9460     *     data {
9461     *       item: "key1" "value1";
9462     *       item: "key2" "value2";
9463     *     }
9464     *   }
9465     * }
9466     * @endcode
9467     *
9468     * @ingroup Layout
9469     */
9470    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9471    /**
9472     * Eval sizing
9473     *
9474     * @param obj The layout object
9475     *
9476     * Manually forces a sizing re-evaluation. This is useful when the minimum
9477     * size required by the edje theme of this layout has changed. The change on
9478     * the minimum size required by the edje theme is not immediately reported to
9479     * the elementary layout, so one needs to call this function in order to tell
9480     * the widget (layout) that it needs to reevaluate its own size.
9481     *
9482     * The minimum size of the theme is calculated based on minimum size of
9483     * parts, the size of elements inside containers like box and table, etc. All
9484     * of this can change due to state changes, and that's when this function
9485     * should be called.
9486     *
9487     * Also note that a standard signal of "size,eval" "elm" emitted from the
9488     * edje object will cause this to happen too.
9489     *
9490     * @ingroup Layout
9491     */
9492    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9493
9494    /**
9495     * Sets a specific cursor for an edje part.
9496     *
9497     * @param obj The layout object.
9498     * @param part_name a part from loaded edje group.
9499     * @param cursor cursor name to use, see Elementary_Cursor.h
9500     *
9501     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9502     *         part not exists or it has "mouse_events: 0".
9503     *
9504     * @ingroup Layout
9505     */
9506    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9507
9508    /**
9509     * Get the cursor to be shown when mouse is over an edje part
9510     *
9511     * @param obj The layout object.
9512     * @param part_name a part from loaded edje group.
9513     * @return the cursor name.
9514     *
9515     * @ingroup Layout
9516     */
9517    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9518
9519    /**
9520     * Unsets a cursor previously set with elm_layout_part_cursor_set().
9521     *
9522     * @param obj The layout object.
9523     * @param part_name a part from loaded edje group, that had a cursor set
9524     *        with elm_layout_part_cursor_set().
9525     *
9526     * @ingroup Layout
9527     */
9528    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9529
9530    /**
9531     * Sets a specific cursor style for an edje part.
9532     *
9533     * @param obj The layout object.
9534     * @param part_name a part from loaded edje group.
9535     * @param style the theme style to use (default, transparent, ...)
9536     *
9537     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9538     *         part not exists or it did not had a cursor set.
9539     *
9540     * @ingroup Layout
9541     */
9542    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9543
9544    /**
9545     * Gets a specific cursor style for an edje part.
9546     *
9547     * @param obj The layout object.
9548     * @param part_name a part from loaded edje group.
9549     *
9550     * @return the theme style in use, defaults to "default". If the
9551     *         object does not have a cursor set, then NULL is returned.
9552     *
9553     * @ingroup Layout
9554     */
9555    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9556
9557    /**
9558     * Sets if the cursor set should be searched on the theme or should use
9559     * the provided by the engine, only.
9560     *
9561     * @note before you set if should look on theme you should define a
9562     * cursor with elm_layout_part_cursor_set(). By default it will only
9563     * look for cursors provided by the engine.
9564     *
9565     * @param obj The layout object.
9566     * @param part_name a part from loaded edje group.
9567     * @param engine_only if cursors should be just provided by the engine
9568     *        or should also search on widget's theme as well
9569     *
9570     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9571     *         part not exists or it did not had a cursor set.
9572     *
9573     * @ingroup Layout
9574     */
9575    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);
9576
9577    /**
9578     * Gets a specific cursor engine_only for an edje part.
9579     *
9580     * @param obj The layout object.
9581     * @param part_name a part from loaded edje group.
9582     *
9583     * @return whenever the cursor is just provided by engine or also from theme.
9584     *
9585     * @ingroup Layout
9586     */
9587    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9588
9589 /**
9590  * @def elm_layout_icon_set
9591  * Convienience macro to set the icon object in a layout that follows the
9592  * Elementary naming convention for its parts.
9593  *
9594  * @ingroup Layout
9595  */
9596 #define elm_layout_icon_set(_ly, _obj) \
9597   do { \
9598     const char *sig; \
9599     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9600     if ((_obj)) sig = "elm,state,icon,visible"; \
9601     else sig = "elm,state,icon,hidden"; \
9602     elm_object_signal_emit((_ly), sig, "elm"); \
9603   } while (0)
9604
9605 /**
9606  * @def elm_layout_icon_get
9607  * Convienience macro to get the icon object from a layout that follows the
9608  * Elementary naming convention for its parts.
9609  *
9610  * @ingroup Layout
9611  */
9612 #define elm_layout_icon_get(_ly) \
9613   elm_layout_content_get((_ly), "elm.swallow.icon")
9614
9615 /**
9616  * @def elm_layout_end_set
9617  * Convienience macro to set the end object in a layout that follows the
9618  * Elementary naming convention for its parts.
9619  *
9620  * @ingroup Layout
9621  */
9622 #define elm_layout_end_set(_ly, _obj) \
9623   do { \
9624     const char *sig; \
9625     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9626     if ((_obj)) sig = "elm,state,end,visible"; \
9627     else sig = "elm,state,end,hidden"; \
9628     elm_object_signal_emit((_ly), sig, "elm"); \
9629   } while (0)
9630
9631 /**
9632  * @def elm_layout_end_get
9633  * Convienience macro to get the end object in a layout that follows the
9634  * Elementary naming convention for its parts.
9635  *
9636  * @ingroup Layout
9637  */
9638 #define elm_layout_end_get(_ly) \
9639   elm_layout_content_get((_ly), "elm.swallow.end")
9640
9641 /**
9642  * @def elm_layout_label_set
9643  * Convienience macro to set the label in a layout that follows the
9644  * Elementary naming convention for its parts.
9645  *
9646  * @ingroup Layout
9647  * @deprecated use elm_object_text_* instead.
9648  */
9649 #define elm_layout_label_set(_ly, _txt) \
9650   elm_layout_text_set((_ly), "elm.text", (_txt))
9651
9652 /**
9653  * @def elm_layout_label_get
9654  * Convienience macro to get the label in a layout that follows the
9655  * Elementary naming convention for its parts.
9656  *
9657  * @ingroup Layout
9658  * @deprecated use elm_object_text_* instead.
9659  */
9660 #define elm_layout_label_get(_ly) \
9661   elm_layout_text_get((_ly), "elm.text")
9662
9663    /* smart callbacks called:
9664     * "theme,changed" - when elm theme is changed.
9665     */
9666
9667    /**
9668     * @defgroup Notify Notify
9669     *
9670     * @image html img/widget/notify/preview-00.png
9671     * @image latex img/widget/notify/preview-00.eps
9672     *
9673     * Display a container in a particular region of the parent(top, bottom,
9674     * etc.  A timeout can be set to automatically hide the notify. This is so
9675     * that, after an evas_object_show() on a notify object, if a timeout was set
9676     * on it, it will @b automatically get hidden after that time.
9677     *
9678     * Signals that you can add callbacks for are:
9679     * @li "timeout" - when timeout happens on notify and it's hidden
9680     * @li "block,clicked" - when a click outside of the notify happens
9681     *
9682     * @ref tutorial_notify show usage of the API.
9683     *
9684     * @{
9685     */
9686    /**
9687     * @brief Possible orient values for notify.
9688     *
9689     * This values should be used in conjunction to elm_notify_orient_set() to
9690     * set the position in which the notify should appear(relative to its parent)
9691     * and in conjunction with elm_notify_orient_get() to know where the notify
9692     * is appearing.
9693     */
9694    typedef enum _Elm_Notify_Orient
9695      {
9696         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9697         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9698         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9699         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9700         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9701         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9702         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9703         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9704         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9705         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9706      } Elm_Notify_Orient;
9707    /**
9708     * @brief Add a new notify to the parent
9709     *
9710     * @param parent The parent object
9711     * @return The new object or NULL if it cannot be created
9712     */
9713    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9714    /**
9715     * @brief Set the content of the notify widget
9716     *
9717     * @param obj The notify object
9718     * @param content The content will be filled in this notify object
9719     *
9720     * Once the content object is set, a previously set one will be deleted. If
9721     * you want to keep that old content object, use the
9722     * elm_notify_content_unset() function.
9723     */
9724    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9725    /**
9726     * @brief Unset the content of the notify widget
9727     *
9728     * @param obj The notify object
9729     * @return The content that was being used
9730     *
9731     * Unparent and return the content object which was set for this widget
9732     *
9733     * @see elm_notify_content_set()
9734     */
9735    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
9736    /**
9737     * @brief Return the content of the notify widget
9738     *
9739     * @param obj The notify object
9740     * @return The content that is being used
9741     *
9742     * @see elm_notify_content_set()
9743     */
9744    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9745    /**
9746     * @brief Set the notify parent
9747     *
9748     * @param obj The notify object
9749     * @param content The new parent
9750     *
9751     * Once the parent object is set, a previously set one will be disconnected
9752     * and replaced.
9753     */
9754    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9755    /**
9756     * @brief Get the notify parent
9757     *
9758     * @param obj The notify object
9759     * @return The parent
9760     *
9761     * @see elm_notify_parent_set()
9762     */
9763    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9764    /**
9765     * @brief Set the orientation
9766     *
9767     * @param obj The notify object
9768     * @param orient The new orientation
9769     *
9770     * Sets the position in which the notify will appear in its parent.
9771     *
9772     * @see @ref Elm_Notify_Orient for possible values.
9773     */
9774    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
9775    /**
9776     * @brief Return the orientation
9777     * @param obj The notify object
9778     * @return The orientation of the notification
9779     *
9780     * @see elm_notify_orient_set()
9781     * @see Elm_Notify_Orient
9782     */
9783    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9784    /**
9785     * @brief Set the time interval after which the notify window is going to be
9786     * hidden.
9787     *
9788     * @param obj The notify object
9789     * @param time The timeout in seconds
9790     *
9791     * This function sets a timeout and starts the timer controlling when the
9792     * notify is hidden. Since calling evas_object_show() on a notify restarts
9793     * the timer controlling when the notify is hidden, setting this before the
9794     * notify is shown will in effect mean starting the timer when the notify is
9795     * shown.
9796     *
9797     * @note Set a value <= 0.0 to disable a running timer.
9798     *
9799     * @note If the value > 0.0 and the notify is previously visible, the
9800     * timer will be started with this value, canceling any running timer.
9801     */
9802    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
9803    /**
9804     * @brief Return the timeout value (in seconds)
9805     * @param obj the notify object
9806     *
9807     * @see elm_notify_timeout_set()
9808     */
9809    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9810    /**
9811     * @brief Sets whether events should be passed to by a click outside
9812     * its area.
9813     *
9814     * @param obj The notify object
9815     * @param repeats EINA_TRUE Events are repeats, else no
9816     *
9817     * When true if the user clicks outside the window the events will be caught
9818     * by the others widgets, else the events are blocked.
9819     *
9820     * @note The default value is EINA_TRUE.
9821     */
9822    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
9823    /**
9824     * @brief Return true if events are repeat below the notify object
9825     * @param obj the notify object
9826     *
9827     * @see elm_notify_repeat_events_set()
9828     */
9829    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9830    /**
9831     * @}
9832     */
9833
9834    /**
9835     * @defgroup Hover Hover
9836     *
9837     * @image html img/widget/hover/preview-00.png
9838     * @image latex img/widget/hover/preview-00.eps
9839     *
9840     * A Hover object will hover over its @p parent object at the @p target
9841     * location. Anything in the background will be given a darker coloring to
9842     * indicate that the hover object is on top (at the default theme). When the
9843     * hover is clicked it is dismissed(hidden), if the contents of the hover are
9844     * clicked that @b doesn't cause the hover to be dismissed.
9845     *
9846     * @note The hover object will take up the entire space of @p target
9847     * object.
9848     *
9849     * Elementary has the following styles for the hover widget:
9850     * @li default
9851     * @li popout
9852     * @li menu
9853     * @li hoversel_vertical
9854     *
9855     * The following are the available position for content:
9856     * @li left
9857     * @li top-left
9858     * @li top
9859     * @li top-right
9860     * @li right
9861     * @li bottom-right
9862     * @li bottom
9863     * @li bottom-left
9864     * @li middle
9865     * @li smart
9866     *
9867     * Signals that you can add callbacks for are:
9868     * @li "clicked" - the user clicked the empty space in the hover to dismiss
9869     * @li "smart,changed" - a content object placed under the "smart"
9870     *                   policy was replaced to a new slot direction.
9871     *
9872     * See @ref tutorial_hover for more information.
9873     *
9874     * @{
9875     */
9876    typedef enum _Elm_Hover_Axis
9877      {
9878         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
9879         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
9880         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
9881         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
9882      } Elm_Hover_Axis;
9883    /**
9884     * @brief Adds a hover object to @p parent
9885     *
9886     * @param parent The parent object
9887     * @return The hover object or NULL if one could not be created
9888     */
9889    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9890    /**
9891     * @brief Sets the target object for the hover.
9892     *
9893     * @param obj The hover object
9894     * @param target The object to center the hover onto. The hover
9895     *
9896     * This function will cause the hover to be centered on the target object.
9897     */
9898    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
9899    /**
9900     * @brief Gets the target object for the hover.
9901     *
9902     * @param obj The hover object
9903     * @param parent The object to locate the hover over.
9904     *
9905     * @see elm_hover_target_set()
9906     */
9907    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9908    /**
9909     * @brief Sets the parent object for the hover.
9910     *
9911     * @param obj The hover object
9912     * @param parent The object to locate the hover over.
9913     *
9914     * This function will cause the hover to take up the entire space that the
9915     * parent object fills.
9916     */
9917    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
9918    /**
9919     * @brief Gets the parent object for the hover.
9920     *
9921     * @param obj The hover object
9922     * @return The parent object to locate the hover over.
9923     *
9924     * @see elm_hover_parent_set()
9925     */
9926    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9927    /**
9928     * @brief Sets the content of the hover object and the direction in which it
9929     * will pop out.
9930     *
9931     * @param obj The hover object
9932     * @param swallow The direction that the object will be displayed
9933     * at. Accepted values are "left", "top-left", "top", "top-right",
9934     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
9935     * "smart".
9936     * @param content The content to place at @p swallow
9937     *
9938     * Once the content object is set for a given direction, a previously
9939     * set one (on the same direction) will be deleted. If you want to
9940     * keep that old content object, use the elm_hover_content_unset()
9941     * function.
9942     *
9943     * All directions may have contents at the same time, except for
9944     * "smart". This is a special placement hint and its use case
9945     * independs of the calculations coming from
9946     * elm_hover_best_content_location_get(). Its use is for cases when
9947     * one desires only one hover content, but with a dinamic special
9948     * placement within the hover area. The content's geometry, whenever
9949     * it changes, will be used to decide on a best location not
9950     * extrapolating the hover's parent object view to show it in (still
9951     * being the hover's target determinant of its medium part -- move and
9952     * resize it to simulate finger sizes, for example). If one of the
9953     * directions other than "smart" are used, a previously content set
9954     * using it will be deleted, and vice-versa.
9955     */
9956    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9957    /**
9958     * @brief Get the content of the hover object, in a given direction.
9959     *
9960     * Return the content object which was set for this widget in the
9961     * @p swallow direction.
9962     *
9963     * @param obj The hover object
9964     * @param swallow The direction that the object was display at.
9965     * @return The content that was being used
9966     *
9967     * @see elm_hover_content_set()
9968     */
9969    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9970    /**
9971     * @brief Unset the content of the hover object, in a given direction.
9972     *
9973     * Unparent and return the content object set at @p swallow direction.
9974     *
9975     * @param obj The hover object
9976     * @param swallow The direction that the object was display at.
9977     * @return The content that was being used.
9978     *
9979     * @see elm_hover_content_set()
9980     */
9981    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9982    /**
9983     * @brief Returns the best swallow location for content in the hover.
9984     *
9985     * @param obj The hover object
9986     * @param pref_axis The preferred orientation axis for the hover object to use
9987     * @return The edje location to place content into the hover or @c
9988     *         NULL, on errors.
9989     *
9990     * Best is defined here as the location at which there is the most available
9991     * space.
9992     *
9993     * @p pref_axis may be one of
9994     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
9995     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
9996     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
9997     * - @c ELM_HOVER_AXIS_BOTH -- both
9998     *
9999     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10000     * nescessarily be along the horizontal axis("left" or "right"). If
10001     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10002     * be along the vertical axis("top" or "bottom"). Chossing
10003     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10004     * returned position may be in either axis.
10005     *
10006     * @see elm_hover_content_set()
10007     */
10008    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10009    /**
10010     * @}
10011     */
10012
10013    /* entry */
10014    /**
10015     * @defgroup Entry Entry
10016     *
10017     * @image html img/widget/entry/preview-00.png
10018     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10019     * @image html img/widget/entry/preview-01.png
10020     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10021     * @image html img/widget/entry/preview-02.png
10022     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10023     * @image html img/widget/entry/preview-03.png
10024     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10025     *
10026     * An entry is a convenience widget which shows a box that the user can
10027     * enter text into. Entries by default don't scroll, so they grow to
10028     * accomodate the entire text, resizing the parent window as needed. This
10029     * can be changed with the elm_entry_scrollable_set() function.
10030     *
10031     * They can also be single line or multi line (the default) and when set
10032     * to multi line mode they support text wrapping in any of the modes
10033     * indicated by #Elm_Wrap_Type.
10034     *
10035     * Other features include password mode, filtering of inserted text with
10036     * elm_entry_text_filter_append() and related functions, inline "items" and
10037     * formatted markup text.
10038     *
10039     * @section entry-markup Formatted text
10040     *
10041     * The markup tags supported by the Entry are defined by the theme, but
10042     * even when writing new themes or extensions it's a good idea to stick to
10043     * a sane default, to maintain coherency and avoid application breakages.
10044     * Currently defined by the default theme are the following tags:
10045     * @li \<br\>: Inserts a line break.
10046     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10047     * breaks.
10048     * @li \<tab\>: Inserts a tab.
10049     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10050     * enclosed text.
10051     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10052     * @li \<link\>...\</link\>: Underlines the enclosed text.
10053     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10054     *
10055     * @section entry-special Special markups
10056     *
10057     * Besides those used to format text, entries support two special markup
10058     * tags used to insert clickable portions of text or items inlined within
10059     * the text.
10060     *
10061     * @subsection entry-anchors Anchors
10062     *
10063     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10064     * \</a\> tags and an event will be generated when this text is clicked,
10065     * like this:
10066     *
10067     * @code
10068     * This text is outside <a href=anc-01>but this one is an anchor</a>
10069     * @endcode
10070     *
10071     * The @c href attribute in the opening tag gives the name that will be
10072     * used to identify the anchor and it can be any valid utf8 string.
10073     *
10074     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10075     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10076     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10077     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10078     * an anchor.
10079     *
10080     * @subsection entry-items Items
10081     *
10082     * Inlined in the text, any other @c Evas_Object can be inserted by using
10083     * \<item\> tags this way:
10084     *
10085     * @code
10086     * <item size=16x16 vsize=full href=emoticon/haha></item>
10087     * @endcode
10088     *
10089     * Just like with anchors, the @c href identifies each item, but these need,
10090     * in addition, to indicate their size, which is done using any one of
10091     * @c size, @c absize or @c relsize attributes. These attributes take their
10092     * value in the WxH format, where W is the width and H the height of the
10093     * item.
10094     *
10095     * @li absize: Absolute pixel size for the item. Whatever value is set will
10096     * be the item's size regardless of any scale value the object may have
10097     * been set to. The final line height will be adjusted to fit larger items.
10098     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10099     * for the object.
10100     * @li relsize: Size is adjusted for the item to fit within the current
10101     * line height.
10102     *
10103     * Besides their size, items are specificed a @c vsize value that affects
10104     * how their final size and position are calculated. The possible values
10105     * are:
10106     * @li ascent: Item will be placed within the line's baseline and its
10107     * ascent. That is, the height between the line where all characters are
10108     * positioned and the highest point in the line. For @c size and @c absize
10109     * items, the descent value will be added to the total line height to make
10110     * them fit. @c relsize items will be adjusted to fit within this space.
10111     * @li full: Items will be placed between the descent and ascent, or the
10112     * lowest point in the line and its highest.
10113     *
10114     * The next image shows different configurations of items and how they
10115     * are the previously mentioned options affect their sizes. In all cases,
10116     * the green line indicates the ascent, blue for the baseline and red for
10117     * the descent.
10118     *
10119     * @image html entry_item.png
10120     * @image latex entry_item.eps width=\textwidth
10121     *
10122     * And another one to show how size differs from absize. In the first one,
10123     * the scale value is set to 1.0, while the second one is using one of 2.0.
10124     *
10125     * @image html entry_item_scale.png
10126     * @image latex entry_item_scale.eps width=\textwidth
10127     *
10128     * After the size for an item is calculated, the entry will request an
10129     * object to place in its space. For this, the functions set with
10130     * elm_entry_item_provider_append() and related functions will be called
10131     * in order until one of them returns a @c non-NULL value. If no providers
10132     * are available, or all of them return @c NULL, then the entry falls back
10133     * to one of the internal defaults, provided the name matches with one of
10134     * them.
10135     *
10136     * All of the following are currently supported:
10137     *
10138     * - emoticon/angry
10139     * - emoticon/angry-shout
10140     * - emoticon/crazy-laugh
10141     * - emoticon/evil-laugh
10142     * - emoticon/evil
10143     * - emoticon/goggle-smile
10144     * - emoticon/grumpy
10145     * - emoticon/grumpy-smile
10146     * - emoticon/guilty
10147     * - emoticon/guilty-smile
10148     * - emoticon/haha
10149     * - emoticon/half-smile
10150     * - emoticon/happy-panting
10151     * - emoticon/happy
10152     * - emoticon/indifferent
10153     * - emoticon/kiss
10154     * - emoticon/knowing-grin
10155     * - emoticon/laugh
10156     * - emoticon/little-bit-sorry
10157     * - emoticon/love-lots
10158     * - emoticon/love
10159     * - emoticon/minimal-smile
10160     * - emoticon/not-happy
10161     * - emoticon/not-impressed
10162     * - emoticon/omg
10163     * - emoticon/opensmile
10164     * - emoticon/smile
10165     * - emoticon/sorry
10166     * - emoticon/squint-laugh
10167     * - emoticon/surprised
10168     * - emoticon/suspicious
10169     * - emoticon/tongue-dangling
10170     * - emoticon/tongue-poke
10171     * - emoticon/uh
10172     * - emoticon/unhappy
10173     * - emoticon/very-sorry
10174     * - emoticon/what
10175     * - emoticon/wink
10176     * - emoticon/worried
10177     * - emoticon/wtf
10178     *
10179     * Alternatively, an item may reference an image by its path, using
10180     * the URI form @c file:///path/to/an/image.png and the entry will then
10181     * use that image for the item.
10182     *
10183     * @section entry-files Loading and saving files
10184     *
10185     * Entries have convinience functions to load text from a file and save
10186     * changes back to it after a short delay. The automatic saving is enabled
10187     * by default, but can be disabled with elm_entry_autosave_set() and files
10188     * can be loaded directly as plain text or have any markup in them
10189     * recognized. See elm_entry_file_set() for more details.
10190     *
10191     * @section entry-signals Emitted signals
10192     *
10193     * This widget emits the following signals:
10194     *
10195     * @li "changed": The text within the entry was changed.
10196     * @li "changed,user": The text within the entry was changed because of user interaction.
10197     * @li "activated": The enter key was pressed on a single line entry.
10198     * @li "press": A mouse button has been pressed on the entry.
10199     * @li "longpressed": A mouse button has been pressed and held for a couple
10200     * seconds.
10201     * @li "clicked": The entry has been clicked (mouse press and release).
10202     * @li "clicked,double": The entry has been double clicked.
10203     * @li "clicked,triple": The entry has been triple clicked.
10204     * @li "focused": The entry has received focus.
10205     * @li "unfocused": The entry has lost focus.
10206     * @li "selection,paste": A paste of the clipboard contents was requested.
10207     * @li "selection,copy": A copy of the selected text into the clipboard was
10208     * requested.
10209     * @li "selection,cut": A cut of the selected text into the clipboard was
10210     * requested.
10211     * @li "selection,start": A selection has begun and no previous selection
10212     * existed.
10213     * @li "selection,changed": The current selection has changed.
10214     * @li "selection,cleared": The current selection has been cleared.
10215     * @li "cursor,changed": The cursor has changed position.
10216     * @li "anchor,clicked": An anchor has been clicked. The event_info
10217     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10218     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10219     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10220     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10221     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10222     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10223     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10224     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10225     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10226     * @li "preedit,changed": The preedit string has changed.
10227     *
10228     * @section entry-examples
10229     *
10230     * An overview of the Entry API can be seen in @ref entry_example_01
10231     *
10232     * @{
10233     */
10234    /**
10235     * @typedef Elm_Entry_Anchor_Info
10236     *
10237     * The info sent in the callback for the "anchor,clicked" signals emitted
10238     * by entries.
10239     */
10240    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10241    /**
10242     * @struct _Elm_Entry_Anchor_Info
10243     *
10244     * The info sent in the callback for the "anchor,clicked" signals emitted
10245     * by entries.
10246     */
10247    struct _Elm_Entry_Anchor_Info
10248      {
10249         const char *name; /**< The name of the anchor, as stated in its href */
10250         int         button; /**< The mouse button used to click on it */
10251         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10252                     y, /**< Anchor geometry, relative to canvas */
10253                     w, /**< Anchor geometry, relative to canvas */
10254                     h; /**< Anchor geometry, relative to canvas */
10255      };
10256    /**
10257     * @typedef Elm_Entry_Filter_Cb
10258     * This callback type is used by entry filters to modify text.
10259     * @param data The data specified as the last param when adding the filter
10260     * @param entry The entry object
10261     * @param text A pointer to the location of the text being filtered. This data can be modified,
10262     * but any additional allocations must be managed by the user.
10263     * @see elm_entry_text_filter_append
10264     * @see elm_entry_text_filter_prepend
10265     */
10266    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10267
10268    /**
10269     * This adds an entry to @p parent object.
10270     *
10271     * By default, entries are:
10272     * @li not scrolled
10273     * @li multi-line
10274     * @li word wrapped
10275     * @li autosave is enabled
10276     *
10277     * @param parent The parent object
10278     * @return The new object or NULL if it cannot be created
10279     */
10280    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10281    /**
10282     * Sets the entry to single line mode.
10283     *
10284     * In single line mode, entries don't ever wrap when the text reaches the
10285     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10286     * key will generate an @c "activate" event instead of adding a new line.
10287     *
10288     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10289     * and pressing enter will break the text into a different line
10290     * without generating any events.
10291     *
10292     * @param obj The entry object
10293     * @param single_line If true, the text in the entry
10294     * will be on a single line.
10295     */
10296    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10297    /**
10298     * Gets whether the entry is set to be single line.
10299     *
10300     * @param obj The entry object
10301     * @return single_line If true, the text in the entry is set to display
10302     * on a single line.
10303     *
10304     * @see elm_entry_single_line_set()
10305     */
10306    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10307    /**
10308     * Sets the entry to password mode.
10309     *
10310     * In password mode, entries are implicitly single line and the display of
10311     * any text in them is replaced with asterisks (*).
10312     *
10313     * @param obj The entry object
10314     * @param password If true, password mode is enabled.
10315     */
10316    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10317    /**
10318     * Gets whether the entry is set to password mode.
10319     *
10320     * @param obj The entry object
10321     * @return If true, the entry is set to display all characters
10322     * as asterisks (*).
10323     *
10324     * @see elm_entry_password_set()
10325     */
10326    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10327    /**
10328     * This sets the text displayed within the entry to @p entry.
10329     *
10330     * @param obj The entry object
10331     * @param entry The text to be displayed
10332     *
10333     * @deprecated Use elm_object_text_set() instead.
10334     */
10335    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10336    /**
10337     * This returns the text currently shown in object @p entry.
10338     * See also elm_entry_entry_set().
10339     *
10340     * @param obj The entry object
10341     * @return The currently displayed text or NULL on failure
10342     *
10343     * @deprecated Use elm_object_text_get() instead.
10344     */
10345    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10346    /**
10347     * Appends @p entry to the text of the entry.
10348     *
10349     * Adds the text in @p entry to the end of any text already present in the
10350     * widget.
10351     *
10352     * The appended text is subject to any filters set for the widget.
10353     *
10354     * @param obj The entry object
10355     * @param entry The text to be displayed
10356     *
10357     * @see elm_entry_text_filter_append()
10358     */
10359    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10360    /**
10361     * Gets whether the entry is empty.
10362     *
10363     * Empty means no text at all. If there are any markup tags, like an item
10364     * tag for which no provider finds anything, and no text is displayed, this
10365     * function still returns EINA_FALSE.
10366     *
10367     * @param obj The entry object
10368     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10369     */
10370    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10371    /**
10372     * Gets any selected text within the entry.
10373     *
10374     * If there's any selected text in the entry, this function returns it as
10375     * a string in markup format. NULL is returned if no selection exists or
10376     * if an error occurred.
10377     *
10378     * The returned value points to an internal string and should not be freed
10379     * or modified in any way. If the @p entry object is deleted or its
10380     * contents are changed, the returned pointer should be considered invalid.
10381     *
10382     * @param obj The entry object
10383     * @return The selected text within the entry or NULL on failure
10384     */
10385    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10386    /**
10387     * Inserts the given text into the entry at the current cursor position.
10388     *
10389     * This inserts text at the cursor position as if it was typed
10390     * by the user (note that this also allows markup which a user
10391     * can't just "type" as it would be converted to escaped text, so this
10392     * call can be used to insert things like emoticon items or bold push/pop
10393     * tags, other font and color change tags etc.)
10394     *
10395     * If any selection exists, it will be replaced by the inserted text.
10396     *
10397     * The inserted text is subject to any filters set for the widget.
10398     *
10399     * @param obj The entry object
10400     * @param entry The text to insert
10401     *
10402     * @see elm_entry_text_filter_append()
10403     */
10404    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10405    /**
10406     * Set the line wrap type to use on multi-line entries.
10407     *
10408     * Sets the wrap type used by the entry to any of the specified in
10409     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10410     * line (without inserting a line break or paragraph separator) when it
10411     * reaches the far edge of the widget.
10412     *
10413     * Note that this only makes sense for multi-line entries. A widget set
10414     * to be single line will never wrap.
10415     *
10416     * @param obj The entry object
10417     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10418     */
10419    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10420    /**
10421     * Gets the wrap mode the entry was set to use.
10422     *
10423     * @param obj The entry object
10424     * @return Wrap type
10425     *
10426     * @see also elm_entry_line_wrap_set()
10427     */
10428    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10429    /**
10430     * Sets if the entry is to be editable or not.
10431     *
10432     * By default, entries are editable and when focused, any text input by the
10433     * user will be inserted at the current cursor position. But calling this
10434     * function with @p editable as EINA_FALSE will prevent the user from
10435     * inputting text into the entry.
10436     *
10437     * The only way to change the text of a non-editable entry is to use
10438     * elm_object_text_set(), elm_entry_entry_insert() and other related
10439     * functions.
10440     *
10441     * @param obj The entry object
10442     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10443     * if not, the entry is read-only and no user input is allowed.
10444     */
10445    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10446    /**
10447     * Gets whether the entry is editable or not.
10448     *
10449     * @param obj The entry object
10450     * @return If true, the entry is editable by the user.
10451     * If false, it is not editable by the user
10452     *
10453     * @see elm_entry_editable_set()
10454     */
10455    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10456    /**
10457     * This drops any existing text selection within the entry.
10458     *
10459     * @param obj The entry object
10460     */
10461    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10462    /**
10463     * This selects all text within the entry.
10464     *
10465     * @param obj The entry object
10466     */
10467    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10468    /**
10469     * This moves the cursor one place to the right within the entry.
10470     *
10471     * @param obj The entry object
10472     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10473     */
10474    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10475    /**
10476     * This moves the cursor one place to the left within the entry.
10477     *
10478     * @param obj The entry object
10479     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10480     */
10481    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10482    /**
10483     * This moves the cursor one line up within the entry.
10484     *
10485     * @param obj The entry object
10486     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10487     */
10488    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10489    /**
10490     * This moves the cursor one line down within the entry.
10491     *
10492     * @param obj The entry object
10493     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10494     */
10495    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10496    /**
10497     * This moves the cursor to the beginning of the entry.
10498     *
10499     * @param obj The entry object
10500     */
10501    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10502    /**
10503     * This moves the cursor to the end of the entry.
10504     *
10505     * @param obj The entry object
10506     */
10507    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10508    /**
10509     * This moves the cursor to the beginning of the current line.
10510     *
10511     * @param obj The entry object
10512     */
10513    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10514    /**
10515     * This moves the cursor to the end of the current line.
10516     *
10517     * @param obj The entry object
10518     */
10519    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10520    /**
10521     * This begins a selection within the entry as though
10522     * the user were holding down the mouse button to make a selection.
10523     *
10524     * @param obj The entry object
10525     */
10526    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10527    /**
10528     * This ends a selection within the entry as though
10529     * the user had just released the mouse button while making a selection.
10530     *
10531     * @param obj The entry object
10532     */
10533    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10534    /**
10535     * Gets whether a format node exists at the current cursor position.
10536     *
10537     * A format node is anything that defines how the text is rendered. It can
10538     * be a visible format node, such as a line break or a paragraph separator,
10539     * or an invisible one, such as bold begin or end tag.
10540     * This function returns whether any format node exists at the current
10541     * cursor position.
10542     *
10543     * @param obj The entry object
10544     * @return EINA_TRUE if the current cursor position contains a format node,
10545     * EINA_FALSE otherwise.
10546     *
10547     * @see elm_entry_cursor_is_visible_format_get()
10548     */
10549    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10550    /**
10551     * Gets if the current cursor position holds a visible format node.
10552     *
10553     * @param obj The entry object
10554     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10555     * if it's an invisible one or no format exists.
10556     *
10557     * @see elm_entry_cursor_is_format_get()
10558     */
10559    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10560    /**
10561     * Gets the character pointed by the cursor at its current position.
10562     *
10563     * This function returns a string with the utf8 character stored at the
10564     * current cursor position.
10565     * Only the text is returned, any format that may exist will not be part
10566     * of the return value.
10567     *
10568     * @param obj The entry object
10569     * @return The text pointed by the cursors.
10570     */
10571    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10572    /**
10573     * This function returns the geometry of the cursor.
10574     *
10575     * It's useful if you want to draw something on the cursor (or where it is),
10576     * or for example in the case of scrolled entry where you want to show the
10577     * cursor.
10578     *
10579     * @param obj The entry object
10580     * @param x returned geometry
10581     * @param y returned geometry
10582     * @param w returned geometry
10583     * @param h returned geometry
10584     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10585     */
10586    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);
10587    /**
10588     * Sets the cursor position in the entry to the given value
10589     *
10590     * The value in @p pos is the index of the character position within the
10591     * contents of the string as returned by elm_entry_cursor_pos_get().
10592     *
10593     * @param obj The entry object
10594     * @param pos The position of the cursor
10595     */
10596    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10597    /**
10598     * Retrieves the current position of the cursor in the entry
10599     *
10600     * @param obj The entry object
10601     * @return The cursor position
10602     */
10603    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10604    /**
10605     * This executes a "cut" action on the selected text in the entry.
10606     *
10607     * @param obj The entry object
10608     */
10609    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10610    /**
10611     * This executes a "copy" action on the selected text in the entry.
10612     *
10613     * @param obj The entry object
10614     */
10615    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10616    /**
10617     * This executes a "paste" action in the entry.
10618     *
10619     * @param obj The entry object
10620     */
10621    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10622    /**
10623     * This clears and frees the items in a entry's contextual (longpress)
10624     * menu.
10625     *
10626     * @param obj The entry object
10627     *
10628     * @see elm_entry_context_menu_item_add()
10629     */
10630    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10631    /**
10632     * This adds an item to the entry's contextual menu.
10633     *
10634     * A longpress on an entry will make the contextual menu show up, if this
10635     * hasn't been disabled with elm_entry_context_menu_disabled_set().
10636     * By default, this menu provides a few options like enabling selection mode,
10637     * which is useful on embedded devices that need to be explicit about it,
10638     * and when a selection exists it also shows the copy and cut actions.
10639     *
10640     * With this function, developers can add other options to this menu to
10641     * perform any action they deem necessary.
10642     *
10643     * @param obj The entry object
10644     * @param label The item's text label
10645     * @param icon_file The item's icon file
10646     * @param icon_type The item's icon type
10647     * @param func The callback to execute when the item is clicked
10648     * @param data The data to associate with the item for related functions
10649     */
10650    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);
10651    /**
10652     * This disables the entry's contextual (longpress) menu.
10653     *
10654     * @param obj The entry object
10655     * @param disabled If true, the menu is disabled
10656     */
10657    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10658    /**
10659     * This returns whether the entry's contextual (longpress) menu is
10660     * disabled.
10661     *
10662     * @param obj The entry object
10663     * @return If true, the menu is disabled
10664     */
10665    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10666    /**
10667     * This appends a custom item provider to the list for that entry
10668     *
10669     * This appends the given callback. The list is walked from beginning to end
10670     * with each function called given the item href string in the text. If the
10671     * function returns an object handle other than NULL (it should create an
10672     * object to do this), then this object is used to replace that item. If
10673     * not the next provider is called until one provides an item object, or the
10674     * default provider in entry does.
10675     *
10676     * @param obj The entry object
10677     * @param func The function called to provide the item object
10678     * @param data The data passed to @p func
10679     *
10680     * @see @ref entry-items
10681     */
10682    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);
10683    /**
10684     * This prepends a custom item provider to the list for that entry
10685     *
10686     * This prepends the given callback. See elm_entry_item_provider_append() for
10687     * more information
10688     *
10689     * @param obj The entry object
10690     * @param func The function called to provide the item object
10691     * @param data The data passed to @p func
10692     */
10693    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);
10694    /**
10695     * This removes a custom item provider to the list for that entry
10696     *
10697     * This removes the given callback. See elm_entry_item_provider_append() for
10698     * more information
10699     *
10700     * @param obj The entry object
10701     * @param func The function called to provide the item object
10702     * @param data The data passed to @p func
10703     */
10704    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);
10705    /**
10706     * Append a filter function for text inserted in the entry
10707     *
10708     * Append the given callback to the list. This functions will be called
10709     * whenever any text is inserted into the entry, with the text to be inserted
10710     * as a parameter. The callback function is free to alter the text in any way
10711     * it wants, but it must remember to free the given pointer and update it.
10712     * If the new text is to be discarded, the function can free it and set its
10713     * text parameter to NULL. This will also prevent any following filters from
10714     * being called.
10715     *
10716     * @param obj The entry object
10717     * @param func The function to use as text filter
10718     * @param data User data to pass to @p func
10719     */
10720    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10721    /**
10722     * Prepend a filter function for text insdrted in the entry
10723     *
10724     * Prepend the given callback to the list. See elm_entry_text_filter_append()
10725     * for more information
10726     *
10727     * @param obj The entry object
10728     * @param func The function to use as text filter
10729     * @param data User data to pass to @p func
10730     */
10731    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10732    /**
10733     * Remove a filter from the list
10734     *
10735     * Removes the given callback from the filter list. See
10736     * elm_entry_text_filter_append() for more information.
10737     *
10738     * @param obj The entry object
10739     * @param func The filter function to remove
10740     * @param data The user data passed when adding the function
10741     */
10742    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10743    /**
10744     * This converts a markup (HTML-like) string into UTF-8.
10745     *
10746     * The returned string is a malloc'ed buffer and it should be freed when
10747     * not needed anymore.
10748     *
10749     * @param s The string (in markup) to be converted
10750     * @return The converted string (in UTF-8). It should be freed.
10751     */
10752    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10753    /**
10754     * This converts a UTF-8 string into markup (HTML-like).
10755     *
10756     * The returned string is a malloc'ed buffer and it should be freed when
10757     * not needed anymore.
10758     *
10759     * @param s The string (in UTF-8) to be converted
10760     * @return The converted string (in markup). It should be freed.
10761     */
10762    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
10763    /**
10764     * This sets the file (and implicitly loads it) for the text to display and
10765     * then edit. All changes are written back to the file after a short delay if
10766     * the entry object is set to autosave (which is the default).
10767     *
10768     * If the entry had any other file set previously, any changes made to it
10769     * will be saved if the autosave feature is enabled, otherwise, the file
10770     * will be silently discarded and any non-saved changes will be lost.
10771     *
10772     * @param obj The entry object
10773     * @param file The path to the file to load and save
10774     * @param format The file format
10775     */
10776    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
10777    /**
10778     * Gets the file being edited by the entry.
10779     *
10780     * This function can be used to retrieve any file set on the entry for
10781     * edition, along with the format used to load and save it.
10782     *
10783     * @param obj The entry object
10784     * @param file The path to the file to load and save
10785     * @param format The file format
10786     */
10787    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
10788    /**
10789     * This function writes any changes made to the file set with
10790     * elm_entry_file_set()
10791     *
10792     * @param obj The entry object
10793     */
10794    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
10795    /**
10796     * This sets the entry object to 'autosave' the loaded text file or not.
10797     *
10798     * @param obj The entry object
10799     * @param autosave Autosave the loaded file or not
10800     *
10801     * @see elm_entry_file_set()
10802     */
10803    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
10804    /**
10805     * This gets the entry object's 'autosave' status.
10806     *
10807     * @param obj The entry object
10808     * @return Autosave the loaded file or not
10809     *
10810     * @see elm_entry_file_set()
10811     */
10812    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10813    /**
10814     * Control pasting of text and images for the widget.
10815     *
10816     * Normally the entry allows both text and images to be pasted.  By setting
10817     * textonly to be true, this prevents images from being pasted.
10818     *
10819     * Note this only changes the behaviour of text.
10820     *
10821     * @param obj The entry object
10822     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
10823     * text+image+other.
10824     */
10825    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
10826    /**
10827     * Getting elm_entry text paste/drop mode.
10828     *
10829     * In textonly mode, only text may be pasted or dropped into the widget.
10830     *
10831     * @param obj The entry object
10832     * @return If the widget only accepts text from pastes.
10833     */
10834    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10835    /**
10836     * Enable or disable scrolling in entry
10837     *
10838     * Normally the entry is not scrollable unless you enable it with this call.
10839     *
10840     * @param obj The entry object
10841     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
10842     */
10843    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
10844    /**
10845     * Get the scrollable state of the entry
10846     *
10847     * Normally the entry is not scrollable. This gets the scrollable state
10848     * of the entry. See elm_entry_scrollable_set() for more information.
10849     *
10850     * @param obj The entry object
10851     * @return The scrollable state
10852     */
10853    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
10854    /**
10855     * This sets a widget to be displayed to the left of a scrolled entry.
10856     *
10857     * @param obj The scrolled entry object
10858     * @param icon The widget to display on the left side of the scrolled
10859     * entry.
10860     *
10861     * @note A previously set widget will be destroyed.
10862     * @note If the object being set does not have minimum size hints set,
10863     * it won't get properly displayed.
10864     *
10865     * @see elm_entry_end_set()
10866     */
10867    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
10868    /**
10869     * Gets the leftmost widget of the scrolled entry. This object is
10870     * owned by the scrolled entry and should not be modified.
10871     *
10872     * @param obj The scrolled entry object
10873     * @return the left widget inside the scroller
10874     */
10875    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
10876    /**
10877     * Unset the leftmost widget of the scrolled entry, unparenting and
10878     * returning it.
10879     *
10880     * @param obj The scrolled entry object
10881     * @return the previously set icon sub-object of this entry, on
10882     * success.
10883     *
10884     * @see elm_entry_icon_set()
10885     */
10886    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
10887    /**
10888     * Sets the visibility of the left-side widget of the scrolled entry,
10889     * set by elm_entry_icon_set().
10890     *
10891     * @param obj The scrolled entry object
10892     * @param setting EINA_TRUE if the object should be displayed,
10893     * EINA_FALSE if not.
10894     */
10895    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
10896    /**
10897     * This sets a widget to be displayed to the end of a scrolled entry.
10898     *
10899     * @param obj The scrolled entry object
10900     * @param end The widget to display on the right side of the scrolled
10901     * entry.
10902     *
10903     * @note A previously set widget will be destroyed.
10904     * @note If the object being set does not have minimum size hints set,
10905     * it won't get properly displayed.
10906     *
10907     * @see elm_entry_icon_set
10908     */
10909    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
10910    /**
10911     * Gets the endmost widget of the scrolled entry. This object is owned
10912     * by the scrolled entry and should not be modified.
10913     *
10914     * @param obj The scrolled entry object
10915     * @return the right widget inside the scroller
10916     */
10917    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
10918    /**
10919     * Unset the endmost widget of the scrolled entry, unparenting and
10920     * returning it.
10921     *
10922     * @param obj The scrolled entry object
10923     * @return the previously set icon sub-object of this entry, on
10924     * success.
10925     *
10926     * @see elm_entry_icon_set()
10927     */
10928    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
10929    /**
10930     * Sets the visibility of the end widget of the scrolled entry, set by
10931     * elm_entry_end_set().
10932     *
10933     * @param obj The scrolled entry object
10934     * @param setting EINA_TRUE if the object should be displayed,
10935     * EINA_FALSE if not.
10936     */
10937    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
10938    /**
10939     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
10940     * them).
10941     *
10942     * Setting an entry to single-line mode with elm_entry_single_line_set()
10943     * will automatically disable the display of scrollbars when the entry
10944     * moves inside its scroller.
10945     *
10946     * @param obj The scrolled entry object
10947     * @param h The horizontal scrollbar policy to apply
10948     * @param v The vertical scrollbar policy to apply
10949     */
10950    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
10951    /**
10952     * This enables/disables bouncing within the entry.
10953     *
10954     * This function sets whether the entry will bounce when scrolling reaches
10955     * the end of the contained entry.
10956     *
10957     * @param obj The scrolled entry object
10958     * @param h The horizontal bounce state
10959     * @param v The vertical bounce state
10960     */
10961    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
10962    /**
10963     * Get the bounce mode
10964     *
10965     * @param obj The Entry object
10966     * @param h_bounce Allow bounce horizontally
10967     * @param v_bounce Allow bounce vertically
10968     */
10969    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
10970
10971    /* pre-made filters for entries */
10972    /**
10973     * @typedef Elm_Entry_Filter_Limit_Size
10974     *
10975     * Data for the elm_entry_filter_limit_size() entry filter.
10976     */
10977    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
10978    /**
10979     * @struct _Elm_Entry_Filter_Limit_Size
10980     *
10981     * Data for the elm_entry_filter_limit_size() entry filter.
10982     */
10983    struct _Elm_Entry_Filter_Limit_Size
10984      {
10985         int max_char_count; /**< The maximum number of characters allowed. */
10986         int max_byte_count; /**< The maximum number of bytes allowed*/
10987      };
10988    /**
10989     * Filter inserted text based on user defined character and byte limits
10990     *
10991     * Add this filter to an entry to limit the characters that it will accept
10992     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
10993     * The funtion works on the UTF-8 representation of the string, converting
10994     * it from the set markup, thus not accounting for any format in it.
10995     *
10996     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
10997     * it as data when setting the filter. In it, it's possible to set limits
10998     * by character count or bytes (any of them is disabled if 0), and both can
10999     * be set at the same time. In that case, it first checks for characters,
11000     * then bytes.
11001     *
11002     * The function will cut the inserted text in order to allow only the first
11003     * number of characters that are still allowed. The cut is made in
11004     * characters, even when limiting by bytes, in order to always contain
11005     * valid ones and avoid half unicode characters making it in.
11006     *
11007     * This filter, like any others, does not apply when setting the entry text
11008     * directly with elm_object_text_set() (or the deprecated
11009     * elm_entry_entry_set()).
11010     */
11011    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11012    /**
11013     * @typedef Elm_Entry_Filter_Accept_Set
11014     *
11015     * Data for the elm_entry_filter_accept_set() entry filter.
11016     */
11017    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11018    /**
11019     * @struct _Elm_Entry_Filter_Accept_Set
11020     *
11021     * Data for the elm_entry_filter_accept_set() entry filter.
11022     */
11023    struct _Elm_Entry_Filter_Accept_Set
11024      {
11025         const char *accepted; /**< Set of characters accepted in the entry. */
11026         const char *rejected; /**< Set of characters rejected from the entry. */
11027      };
11028    /**
11029     * Filter inserted text based on accepted or rejected sets of characters
11030     *
11031     * Add this filter to an entry to restrict the set of accepted characters
11032     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11033     * This structure contains both accepted and rejected sets, but they are
11034     * mutually exclusive.
11035     *
11036     * The @c accepted set takes preference, so if it is set, the filter will
11037     * only work based on the accepted characters, ignoring anything in the
11038     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11039     *
11040     * In both cases, the function filters by matching utf8 characters to the
11041     * raw markup text, so it can be used to remove formatting tags.
11042     *
11043     * This filter, like any others, does not apply when setting the entry text
11044     * directly with elm_object_text_set() (or the deprecated
11045     * elm_entry_entry_set()).
11046     */
11047    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11048    /**
11049     * @}
11050     */
11051
11052    /* composite widgets - these basically put together basic widgets above
11053     * in convenient packages that do more than basic stuff */
11054
11055    /* anchorview */
11056    /**
11057     * @defgroup Anchorview Anchorview
11058     *
11059     * @image html img/widget/anchorview/preview-00.png
11060     * @image latex img/widget/anchorview/preview-00.eps
11061     *
11062     * Anchorview is for displaying text that contains markup with anchors
11063     * like <c>\<a href=1234\>something\</\></c> in it.
11064     *
11065     * Besides being styled differently, the anchorview widget provides the
11066     * necessary functionality so that clicking on these anchors brings up a
11067     * popup with user defined content such as "call", "add to contacts" or
11068     * "open web page". This popup is provided using the @ref Hover widget.
11069     *
11070     * This widget is very similar to @ref Anchorblock, so refer to that
11071     * widget for an example. The only difference Anchorview has is that the
11072     * widget is already provided with scrolling functionality, so if the
11073     * text set to it is too large to fit in the given space, it will scroll,
11074     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11075     * text can be displayed.
11076     *
11077     * This widget emits the following signals:
11078     * @li "anchor,clicked": will be called when an anchor is clicked. The
11079     * @p event_info parameter on the callback will be a pointer of type
11080     * ::Elm_Entry_Anchorview_Info.
11081     *
11082     * See @ref Anchorblock for an example on how to use both of them.
11083     *
11084     * @see Anchorblock
11085     * @see Entry
11086     * @see Hover
11087     *
11088     * @{
11089     */
11090    /**
11091     * @typedef Elm_Entry_Anchorview_Info
11092     *
11093     * The info sent in the callback for "anchor,clicked" signals emitted by
11094     * the Anchorview widget.
11095     */
11096    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11097    /**
11098     * @struct _Elm_Entry_Anchorview_Info
11099     *
11100     * The info sent in the callback for "anchor,clicked" signals emitted by
11101     * the Anchorview widget.
11102     */
11103    struct _Elm_Entry_Anchorview_Info
11104      {
11105         const char     *name; /**< Name of the anchor, as indicated in its href
11106                                    attribute */
11107         int             button; /**< The mouse button used to click on it */
11108         Evas_Object    *hover; /**< The hover object to use for the popup */
11109         struct {
11110              Evas_Coord    x, y, w, h;
11111         } anchor, /**< Geometry selection of text used as anchor */
11112           hover_parent; /**< Geometry of the object used as parent by the
11113                              hover */
11114         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11115                                              for content on the left side of
11116                                              the hover. Before calling the
11117                                              callback, the widget will make the
11118                                              necessary calculations to check
11119                                              which sides are fit to be set with
11120                                              content, based on the position the
11121                                              hover is activated and its distance
11122                                              to the edges of its parent object
11123                                              */
11124         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11125                                               the right side of the hover.
11126                                               See @ref hover_left */
11127         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11128                                             of the hover. See @ref hover_left */
11129         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11130                                                below the hover. See @ref
11131                                                hover_left */
11132      };
11133    /**
11134     * Add a new Anchorview object
11135     *
11136     * @param parent The parent object
11137     * @return The new object or NULL if it cannot be created
11138     */
11139    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11140    /**
11141     * Set the text to show in the anchorview
11142     *
11143     * Sets the text of the anchorview to @p text. This text can include markup
11144     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11145     * text that will be specially styled and react to click events, ended with
11146     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11147     * "anchor,clicked" signal that you can attach a callback to with
11148     * evas_object_smart_callback_add(). The name of the anchor given in the
11149     * event info struct will be the one set in the href attribute, in this
11150     * case, anchorname.
11151     *
11152     * Other markup can be used to style the text in different ways, but it's
11153     * up to the style defined in the theme which tags do what.
11154     * @deprecated use elm_object_text_set() instead.
11155     */
11156    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11157    /**
11158     * Get the markup text set for the anchorview
11159     *
11160     * Retrieves the text set on the anchorview, with markup tags included.
11161     *
11162     * @param obj The anchorview object
11163     * @return The markup text set or @c NULL if nothing was set or an error
11164     * occurred
11165     * @deprecated use elm_object_text_set() instead.
11166     */
11167    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11168    /**
11169     * Set the parent of the hover popup
11170     *
11171     * Sets the parent object to use by the hover created by the anchorview
11172     * when an anchor is clicked. See @ref Hover for more details on this.
11173     * If no parent is set, the same anchorview object will be used.
11174     *
11175     * @param obj The anchorview object
11176     * @param parent The object to use as parent for the hover
11177     */
11178    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11179    /**
11180     * Get the parent of the hover popup
11181     *
11182     * Get the object used as parent for the hover created by the anchorview
11183     * widget. See @ref Hover for more details on this.
11184     *
11185     * @param obj The anchorview object
11186     * @return The object used as parent for the hover, NULL if none is set.
11187     */
11188    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11189    /**
11190     * Set the style that the hover should use
11191     *
11192     * When creating the popup hover, anchorview will request that it's
11193     * themed according to @p style.
11194     *
11195     * @param obj The anchorview object
11196     * @param style The style to use for the underlying hover
11197     *
11198     * @see elm_object_style_set()
11199     */
11200    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11201    /**
11202     * Get the style that the hover should use
11203     *
11204     * Get the style the hover created by anchorview will use.
11205     *
11206     * @param obj The anchorview object
11207     * @return The style to use by the hover. NULL means the default is used.
11208     *
11209     * @see elm_object_style_set()
11210     */
11211    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11212    /**
11213     * Ends the hover popup in the anchorview
11214     *
11215     * When an anchor is clicked, the anchorview widget will create a hover
11216     * object to use as a popup with user provided content. This function
11217     * terminates this popup, returning the anchorview to its normal state.
11218     *
11219     * @param obj The anchorview object
11220     */
11221    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11222    /**
11223     * Set bouncing behaviour when the scrolled content reaches an edge
11224     *
11225     * Tell the internal scroller object whether it should bounce or not
11226     * when it reaches the respective edges for each axis.
11227     *
11228     * @param obj The anchorview object
11229     * @param h_bounce Whether to bounce or not in the horizontal axis
11230     * @param v_bounce Whether to bounce or not in the vertical axis
11231     *
11232     * @see elm_scroller_bounce_set()
11233     */
11234    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11235    /**
11236     * Get the set bouncing behaviour of the internal scroller
11237     *
11238     * Get whether the internal scroller should bounce when the edge of each
11239     * axis is reached scrolling.
11240     *
11241     * @param obj The anchorview object
11242     * @param h_bounce Pointer where to store the bounce state of the horizontal
11243     *                 axis
11244     * @param v_bounce Pointer where to store the bounce state of the vertical
11245     *                 axis
11246     *
11247     * @see elm_scroller_bounce_get()
11248     */
11249    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11250    /**
11251     * Appends a custom item provider to the given anchorview
11252     *
11253     * Appends the given function to the list of items providers. This list is
11254     * called, one function at a time, with the given @p data pointer, the
11255     * anchorview object and, in the @p item parameter, the item name as
11256     * referenced in its href string. Following functions in the list will be
11257     * called in order until one of them returns something different to NULL,
11258     * which should be an Evas_Object which will be used in place of the item
11259     * element.
11260     *
11261     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11262     * href=item/name\>\</item\>
11263     *
11264     * @param obj The anchorview object
11265     * @param func The function to add to the list of providers
11266     * @param data User data that will be passed to the callback function
11267     *
11268     * @see elm_entry_item_provider_append()
11269     */
11270    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);
11271    /**
11272     * Prepend a custom item provider to the given anchorview
11273     *
11274     * Like elm_anchorview_item_provider_append(), but it adds the function
11275     * @p func to the beginning of the list, instead of the end.
11276     *
11277     * @param obj The anchorview object
11278     * @param func The function to add to the list of providers
11279     * @param data User data that will be passed to the callback function
11280     */
11281    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);
11282    /**
11283     * Remove a custom item provider from the list of the given anchorview
11284     *
11285     * Removes the function and data pairing that matches @p func and @p data.
11286     * That is, unless the same function and same user data are given, the
11287     * function will not be removed from the list. This allows us to add the
11288     * same callback several times, with different @p data pointers and be
11289     * able to remove them later without conflicts.
11290     *
11291     * @param obj The anchorview object
11292     * @param func The function to remove from the list
11293     * @param data The data matching the function to remove from the list
11294     */
11295    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);
11296    /**
11297     * @}
11298     */
11299
11300    /* anchorblock */
11301    /**
11302     * @defgroup Anchorblock Anchorblock
11303     *
11304     * @image html img/widget/anchorblock/preview-00.png
11305     * @image latex img/widget/anchorblock/preview-00.eps
11306     *
11307     * Anchorblock is for displaying text that contains markup with anchors
11308     * like <c>\<a href=1234\>something\</\></c> in it.
11309     *
11310     * Besides being styled differently, the anchorblock widget provides the
11311     * necessary functionality so that clicking on these anchors brings up a
11312     * popup with user defined content such as "call", "add to contacts" or
11313     * "open web page". This popup is provided using the @ref Hover widget.
11314     *
11315     * This widget emits the following signals:
11316     * @li "anchor,clicked": will be called when an anchor is clicked. The
11317     * @p event_info parameter on the callback will be a pointer of type
11318     * ::Elm_Entry_Anchorblock_Info.
11319     *
11320     * @see Anchorview
11321     * @see Entry
11322     * @see Hover
11323     *
11324     * Since examples are usually better than plain words, we might as well
11325     * try @ref tutorial_anchorblock_example "one".
11326     */
11327    /**
11328     * @addtogroup Anchorblock
11329     * @{
11330     */
11331    /**
11332     * @typedef Elm_Entry_Anchorblock_Info
11333     *
11334     * The info sent in the callback for "anchor,clicked" signals emitted by
11335     * the Anchorblock widget.
11336     */
11337    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11338    /**
11339     * @struct _Elm_Entry_Anchorblock_Info
11340     *
11341     * The info sent in the callback for "anchor,clicked" signals emitted by
11342     * the Anchorblock widget.
11343     */
11344    struct _Elm_Entry_Anchorblock_Info
11345      {
11346         const char     *name; /**< Name of the anchor, as indicated in its href
11347                                    attribute */
11348         int             button; /**< The mouse button used to click on it */
11349         Evas_Object    *hover; /**< The hover object to use for the popup */
11350         struct {
11351              Evas_Coord    x, y, w, h;
11352         } anchor, /**< Geometry selection of text used as anchor */
11353           hover_parent; /**< Geometry of the object used as parent by the
11354                              hover */
11355         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11356                                              for content on the left side of
11357                                              the hover. Before calling the
11358                                              callback, the widget will make the
11359                                              necessary calculations to check
11360                                              which sides are fit to be set with
11361                                              content, based on the position the
11362                                              hover is activated and its distance
11363                                              to the edges of its parent object
11364                                              */
11365         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11366                                               the right side of the hover.
11367                                               See @ref hover_left */
11368         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11369                                             of the hover. See @ref hover_left */
11370         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11371                                                below the hover. See @ref
11372                                                hover_left */
11373      };
11374    /**
11375     * Add a new Anchorblock object
11376     *
11377     * @param parent The parent object
11378     * @return The new object or NULL if it cannot be created
11379     */
11380    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11381    /**
11382     * Set the text to show in the anchorblock
11383     *
11384     * Sets the text of the anchorblock to @p text. This text can include markup
11385     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11386     * of text that will be specially styled and react to click events, ended
11387     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11388     * "anchor,clicked" signal that you can attach a callback to with
11389     * evas_object_smart_callback_add(). The name of the anchor given in the
11390     * event info struct will be the one set in the href attribute, in this
11391     * case, anchorname.
11392     *
11393     * Other markup can be used to style the text in different ways, but it's
11394     * up to the style defined in the theme which tags do what.
11395     * @deprecated use elm_object_text_set() instead.
11396     */
11397    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11398    /**
11399     * Get the markup text set for the anchorblock
11400     *
11401     * Retrieves the text set on the anchorblock, with markup tags included.
11402     *
11403     * @param obj The anchorblock object
11404     * @return The markup text set or @c NULL if nothing was set or an error
11405     * occurred
11406     * @deprecated use elm_object_text_set() instead.
11407     */
11408    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11409    /**
11410     * Set the parent of the hover popup
11411     *
11412     * Sets the parent object to use by the hover created by the anchorblock
11413     * when an anchor is clicked. See @ref Hover for more details on this.
11414     *
11415     * @param obj The anchorblock object
11416     * @param parent The object to use as parent for the hover
11417     */
11418    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11419    /**
11420     * Get the parent of the hover popup
11421     *
11422     * Get the object used as parent for the hover created by the anchorblock
11423     * widget. See @ref Hover for more details on this.
11424     * If no parent is set, the same anchorblock object will be used.
11425     *
11426     * @param obj The anchorblock object
11427     * @return The object used as parent for the hover, NULL if none is set.
11428     */
11429    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11430    /**
11431     * Set the style that the hover should use
11432     *
11433     * When creating the popup hover, anchorblock will request that it's
11434     * themed according to @p style.
11435     *
11436     * @param obj The anchorblock object
11437     * @param style The style to use for the underlying hover
11438     *
11439     * @see elm_object_style_set()
11440     */
11441    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11442    /**
11443     * Get the style that the hover should use
11444     *
11445     * Get the style the hover created by anchorblock will use.
11446     *
11447     * @param obj The anchorblock object
11448     * @return The style to use by the hover. NULL means the default is used.
11449     *
11450     * @see elm_object_style_set()
11451     */
11452    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11453    /**
11454     * Ends the hover popup in the anchorblock
11455     *
11456     * When an anchor is clicked, the anchorblock widget will create a hover
11457     * object to use as a popup with user provided content. This function
11458     * terminates this popup, returning the anchorblock to its normal state.
11459     *
11460     * @param obj The anchorblock object
11461     */
11462    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11463    /**
11464     * Appends a custom item provider to the given anchorblock
11465     *
11466     * Appends the given function to the list of items providers. This list is
11467     * called, one function at a time, with the given @p data pointer, the
11468     * anchorblock object and, in the @p item parameter, the item name as
11469     * referenced in its href string. Following functions in the list will be
11470     * called in order until one of them returns something different to NULL,
11471     * which should be an Evas_Object which will be used in place of the item
11472     * element.
11473     *
11474     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11475     * href=item/name\>\</item\>
11476     *
11477     * @param obj The anchorblock object
11478     * @param func The function to add to the list of providers
11479     * @param data User data that will be passed to the callback function
11480     *
11481     * @see elm_entry_item_provider_append()
11482     */
11483    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);
11484    /**
11485     * Prepend a custom item provider to the given anchorblock
11486     *
11487     * Like elm_anchorblock_item_provider_append(), but it adds the function
11488     * @p func to the beginning of the list, instead of the end.
11489     *
11490     * @param obj The anchorblock object
11491     * @param func The function to add to the list of providers
11492     * @param data User data that will be passed to the callback function
11493     */
11494    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);
11495    /**
11496     * Remove a custom item provider from the list of the given anchorblock
11497     *
11498     * Removes the function and data pairing that matches @p func and @p data.
11499     * That is, unless the same function and same user data are given, the
11500     * function will not be removed from the list. This allows us to add the
11501     * same callback several times, with different @p data pointers and be
11502     * able to remove them later without conflicts.
11503     *
11504     * @param obj The anchorblock object
11505     * @param func The function to remove from the list
11506     * @param data The data matching the function to remove from the list
11507     */
11508    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);
11509    /**
11510     * @}
11511     */
11512
11513    /**
11514     * @defgroup Bubble Bubble
11515     *
11516     * @image html img/widget/bubble/preview-00.png
11517     * @image latex img/widget/bubble/preview-00.eps
11518     * @image html img/widget/bubble/preview-01.png
11519     * @image latex img/widget/bubble/preview-01.eps
11520     * @image html img/widget/bubble/preview-02.png
11521     * @image latex img/widget/bubble/preview-02.eps
11522     *
11523     * @brief The Bubble is a widget to show text similarly to how speech is
11524     * represented in comics.
11525     *
11526     * The bubble widget contains 5 important visual elements:
11527     * @li The frame is a rectangle with rounded rectangles and an "arrow".
11528     * @li The @p icon is an image to which the frame's arrow points to.
11529     * @li The @p label is a text which appears to the right of the icon if the
11530     * corner is "top_left" or "bottom_left" and is right aligned to the frame
11531     * otherwise.
11532     * @li The @p info is a text which appears to the right of the label. Info's
11533     * font is of a ligther color than label.
11534     * @li The @p content is an evas object that is shown inside the frame.
11535     *
11536     * The position of the arrow, icon, label and info depends on which corner is
11537     * selected. The four available corners are:
11538     * @li "top_left" - Default
11539     * @li "top_right"
11540     * @li "bottom_left"
11541     * @li "bottom_right"
11542     *
11543     * Signals that you can add callbacks for are:
11544     * @li "clicked" - This is called when a user has clicked the bubble.
11545     *
11546     * For an example of using a buble see @ref bubble_01_example_page "this".
11547     *
11548     * @{
11549     */
11550    /**
11551     * Add a new bubble to the parent
11552     *
11553     * @param parent The parent object
11554     * @return The new object or NULL if it cannot be created
11555     *
11556     * This function adds a text bubble to the given parent evas object.
11557     */
11558    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11559    /**
11560     * Set the label of the bubble
11561     *
11562     * @param obj The bubble object
11563     * @param label The string to set in the label
11564     *
11565     * This function sets the title of the bubble. Where this appears depends on
11566     * the selected corner.
11567     * @deprecated use elm_object_text_set() instead.
11568     */
11569    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11570    /**
11571     * Get the label of the bubble
11572     *
11573     * @param obj The bubble object
11574     * @return The string of set in the label
11575     *
11576     * This function gets the title of the bubble.
11577     * @deprecated use elm_object_text_get() instead.
11578     */
11579    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11580    /**
11581     * Set the info of the bubble
11582     *
11583     * @param obj The bubble object
11584     * @param info The given info about the bubble
11585     *
11586     * This function sets the info of the bubble. Where this appears depends on
11587     * the selected corner.
11588     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11589     */
11590    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11591    /**
11592     * Get the info of the bubble
11593     *
11594     * @param obj The bubble object
11595     *
11596     * @return The "info" string of the bubble
11597     *
11598     * This function gets the info text.
11599     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11600     */
11601    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11602    /**
11603     * Set the content to be shown in the bubble
11604     *
11605     * Once the content object is set, a previously set one will be deleted.
11606     * If you want to keep the old content object, use the
11607     * elm_bubble_content_unset() function.
11608     *
11609     * @param obj The bubble object
11610     * @param content The given content of the bubble
11611     *
11612     * This function sets the content shown on the middle of the bubble.
11613     */
11614    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11615    /**
11616     * Get the content shown in the bubble
11617     *
11618     * Return the content object which is set for this widget.
11619     *
11620     * @param obj The bubble object
11621     * @return The content that is being used
11622     */
11623    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11624    /**
11625     * Unset the content shown in the bubble
11626     *
11627     * Unparent and return the content object which was set for this widget.
11628     *
11629     * @param obj The bubble object
11630     * @return The content that was being used
11631     */
11632    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11633    /**
11634     * Set the icon of the bubble
11635     *
11636     * Once the icon object is set, a previously set one will be deleted.
11637     * If you want to keep the old content object, use the
11638     * elm_icon_content_unset() function.
11639     *
11640     * @param obj The bubble object
11641     * @param icon The given icon for the bubble
11642     */
11643    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11644    /**
11645     * Get the icon of the bubble
11646     *
11647     * @param obj The bubble object
11648     * @return The icon for the bubble
11649     *
11650     * This function gets the icon shown on the top left of bubble.
11651     */
11652    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11653    /**
11654     * Unset the icon of the bubble
11655     *
11656     * Unparent and return the icon object which was set for this widget.
11657     *
11658     * @param obj The bubble object
11659     * @return The icon that was being used
11660     */
11661    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11662    /**
11663     * Set the corner of the bubble
11664     *
11665     * @param obj The bubble object.
11666     * @param corner The given corner for the bubble.
11667     *
11668     * This function sets the corner of the bubble. The corner will be used to
11669     * determine where the arrow in the frame points to and where label, icon and
11670     * info arre shown.
11671     *
11672     * Possible values for corner are:
11673     * @li "top_left" - Default
11674     * @li "top_right"
11675     * @li "bottom_left"
11676     * @li "bottom_right"
11677     */
11678    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11679    /**
11680     * Get the corner of the bubble
11681     *
11682     * @param obj The bubble object.
11683     * @return The given corner for the bubble.
11684     *
11685     * This function gets the selected corner of the bubble.
11686     */
11687    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11688    /**
11689     * @}
11690     */
11691
11692    /**
11693     * @defgroup Photo Photo
11694     *
11695     * For displaying the photo of a person (contact). Simple yet
11696     * with a very specific purpose.
11697     *
11698     * Signals that you can add callbacks for are:
11699     *
11700     * "clicked" - This is called when a user has clicked the photo
11701     * "drag,start" - Someone started dragging the image out of the object
11702     * "drag,end" - Dragged item was dropped (somewhere)
11703     *
11704     * @{
11705     */
11706
11707    /**
11708     * Add a new photo to the parent
11709     *
11710     * @param parent The parent object
11711     * @return The new object or NULL if it cannot be created
11712     *
11713     * @ingroup Photo
11714     */
11715    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11716
11717    /**
11718     * Set the file that will be used as photo
11719     *
11720     * @param obj The photo object
11721     * @param file The path to file that will be used as photo
11722     *
11723     * @return (1 = success, 0 = error)
11724     *
11725     * @ingroup Photo
11726     */
11727    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
11728
11729    /**
11730     * Set the size that will be used on the photo
11731     *
11732     * @param obj The photo object
11733     * @param size The size that the photo will be
11734     *
11735     * @ingroup Photo
11736     */
11737    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
11738
11739    /**
11740     * Set if the photo should be completely visible or not.
11741     *
11742     * @param obj The photo object
11743     * @param fill if true the photo will be completely visible
11744     *
11745     * @ingroup Photo
11746     */
11747    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
11748
11749    /**
11750     * Set editability of the photo.
11751     *
11752     * An editable photo can be dragged to or from, and can be cut or
11753     * pasted too.  Note that pasting an image or dropping an item on
11754     * the image will delete the existing content.
11755     *
11756     * @param obj The photo object.
11757     * @param set To set of clear editablity.
11758     */
11759    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
11760
11761    /**
11762     * @}
11763     */
11764
11765    /* gesture layer */
11766    /**
11767     * @defgroup Elm_Gesture_Layer Gesture Layer
11768     * Gesture Layer Usage:
11769     *
11770     * Use Gesture Layer to detect gestures.
11771     * The advantage is that you don't have to implement
11772     * gesture detection, just set callbacks of gesture state.
11773     * By using gesture layer we make standard interface.
11774     *
11775     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
11776     * with a parent object parameter.
11777     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
11778     * call. Usually with same object as target (2nd parameter).
11779     *
11780     * Now you need to tell gesture layer what gestures you follow.
11781     * This is done with @ref elm_gesture_layer_cb_set call.
11782     * By setting the callback you actually saying to gesture layer:
11783     * I would like to know when the gesture @ref Elm_Gesture_Types
11784     * switches to state @ref Elm_Gesture_State.
11785     *
11786     * Next, you need to implement the actual action that follows the input
11787     * in your callback.
11788     *
11789     * Note that if you like to stop being reported about a gesture, just set
11790     * all callbacks referring this gesture to NULL.
11791     * (again with @ref elm_gesture_layer_cb_set)
11792     *
11793     * The information reported by gesture layer to your callback is depending
11794     * on @ref Elm_Gesture_Types:
11795     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
11796     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
11797     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
11798     *
11799     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
11800     * @ref ELM_GESTURE_MOMENTUM.
11801     *
11802     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
11803     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
11804     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
11805     * Note that we consider a flick as a line-gesture that should be completed
11806     * in flick-time-limit as defined in @ref Config.
11807     *
11808     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
11809     *
11810     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
11811     * */
11812
11813    /**
11814     * @enum _Elm_Gesture_Types
11815     * Enum of supported gesture types.
11816     * @ingroup Elm_Gesture_Layer
11817     */
11818    enum _Elm_Gesture_Types
11819      {
11820         ELM_GESTURE_FIRST = 0,
11821
11822         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
11823         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
11824         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
11825         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
11826
11827         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
11828
11829         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
11830         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
11831
11832         ELM_GESTURE_ZOOM, /**< Zoom */
11833         ELM_GESTURE_ROTATE, /**< Rotate */
11834
11835         ELM_GESTURE_LAST
11836      };
11837
11838    /**
11839     * @typedef Elm_Gesture_Types
11840     * gesture types enum
11841     * @ingroup Elm_Gesture_Layer
11842     */
11843    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
11844
11845    /**
11846     * @enum _Elm_Gesture_State
11847     * Enum of gesture states.
11848     * @ingroup Elm_Gesture_Layer
11849     */
11850    enum _Elm_Gesture_State
11851      {
11852         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
11853         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
11854         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
11855         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
11856         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
11857      };
11858
11859    /**
11860     * @typedef Elm_Gesture_State
11861     * gesture states enum
11862     * @ingroup Elm_Gesture_Layer
11863     */
11864    typedef enum _Elm_Gesture_State Elm_Gesture_State;
11865
11866    /**
11867     * @struct _Elm_Gesture_Taps_Info
11868     * Struct holds taps info for user
11869     * @ingroup Elm_Gesture_Layer
11870     */
11871    struct _Elm_Gesture_Taps_Info
11872      {
11873         Evas_Coord x, y;         /**< Holds center point between fingers */
11874         unsigned int n;          /**< Number of fingers tapped           */
11875         unsigned int timestamp;  /**< event timestamp       */
11876      };
11877
11878    /**
11879     * @typedef Elm_Gesture_Taps_Info
11880     * holds taps info for user
11881     * @ingroup Elm_Gesture_Layer
11882     */
11883    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
11884
11885    /**
11886     * @struct _Elm_Gesture_Momentum_Info
11887     * Struct holds momentum info for user
11888     * x1 and y1 are not necessarily in sync
11889     * x1 holds x value of x direction starting point
11890     * and same holds for y1.
11891     * This is noticeable when doing V-shape movement
11892     * @ingroup Elm_Gesture_Layer
11893     */
11894    struct _Elm_Gesture_Momentum_Info
11895      {  /* Report line ends, timestamps, and momentum computed        */
11896         Evas_Coord x1; /**< Final-swipe direction starting point on X */
11897         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
11898         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
11899         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
11900
11901         unsigned int tx; /**< Timestamp of start of final x-swipe */
11902         unsigned int ty; /**< Timestamp of start of final y-swipe */
11903
11904         Evas_Coord mx; /**< Momentum on X */
11905         Evas_Coord my; /**< Momentum on Y */
11906      };
11907
11908    /**
11909     * @typedef Elm_Gesture_Momentum_Info
11910     * holds momentum info for user
11911     * @ingroup Elm_Gesture_Layer
11912     */
11913     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
11914
11915    /**
11916     * @struct _Elm_Gesture_Line_Info
11917     * Struct holds line info for user
11918     * @ingroup Elm_Gesture_Layer
11919     */
11920    struct _Elm_Gesture_Line_Info
11921      {  /* Report line ends, timestamps, and momentum computed      */
11922         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
11923         unsigned int n;            /**< Number of fingers (lines)   */
11924         /* FIXME should be radians, bot degrees */
11925         double angle;              /**< Angle (direction) of lines  */
11926      };
11927
11928    /**
11929     * @typedef Elm_Gesture_Line_Info
11930     * Holds line info for user
11931     * @ingroup Elm_Gesture_Layer
11932     */
11933     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
11934
11935    /**
11936     * @struct _Elm_Gesture_Zoom_Info
11937     * Struct holds zoom info for user
11938     * @ingroup Elm_Gesture_Layer
11939     */
11940    struct _Elm_Gesture_Zoom_Info
11941      {
11942         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
11943         Evas_Coord radius; /**< Holds radius between fingers reported to user */
11944         double zoom;            /**< Zoom value: 1.0 means no zoom             */
11945         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
11946      };
11947
11948    /**
11949     * @typedef Elm_Gesture_Zoom_Info
11950     * Holds zoom info for user
11951     * @ingroup Elm_Gesture_Layer
11952     */
11953    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
11954
11955    /**
11956     * @struct _Elm_Gesture_Rotate_Info
11957     * Struct holds rotation info for user
11958     * @ingroup Elm_Gesture_Layer
11959     */
11960    struct _Elm_Gesture_Rotate_Info
11961      {
11962         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
11963         Evas_Coord radius; /**< Holds radius between fingers reported to user */
11964         double base_angle; /**< Holds start-angle */
11965         double angle;      /**< Rotation value: 0.0 means no rotation         */
11966         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
11967      };
11968
11969    /**
11970     * @typedef Elm_Gesture_Rotate_Info
11971     * Holds rotation info for user
11972     * @ingroup Elm_Gesture_Layer
11973     */
11974    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
11975
11976    /**
11977     * @typedef Elm_Gesture_Event_Cb
11978     * User callback used to stream gesture info from gesture layer
11979     * @param data user data
11980     * @param event_info gesture report info
11981     * Returns a flag field to be applied on the causing event.
11982     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
11983     * upon the event, in an irreversible way.
11984     *
11985     * @ingroup Elm_Gesture_Layer
11986     */
11987    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
11988
11989    /**
11990     * Use function to set callbacks to be notified about
11991     * change of state of gesture.
11992     * When a user registers a callback with this function
11993     * this means this gesture has to be tested.
11994     *
11995     * When ALL callbacks for a gesture are set to NULL
11996     * it means user isn't interested in gesture-state
11997     * and it will not be tested.
11998     *
11999     * @param obj Pointer to gesture-layer.
12000     * @param idx The gesture you would like to track its state.
12001     * @param cb callback function pointer.
12002     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12003     * @param data user info to be sent to callback (usually, Smart Data)
12004     *
12005     * @ingroup Elm_Gesture_Layer
12006     */
12007    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);
12008
12009    /**
12010     * Call this function to get repeat-events settings.
12011     *
12012     * @param obj Pointer to gesture-layer.
12013     *
12014     * @return repeat events settings.
12015     * @see elm_gesture_layer_hold_events_set()
12016     * @ingroup Elm_Gesture_Layer
12017     */
12018    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12019
12020    /**
12021     * This function called in order to make gesture-layer repeat events.
12022     * Set this of you like to get the raw events only if gestures were not detected.
12023     * Clear this if you like gesture layer to fwd events as testing gestures.
12024     *
12025     * @param obj Pointer to gesture-layer.
12026     * @param r Repeat: TRUE/FALSE
12027     *
12028     * @ingroup Elm_Gesture_Layer
12029     */
12030    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12031
12032    /**
12033     * This function sets step-value for zoom action.
12034     * Set step to any positive value.
12035     * Cancel step setting by setting to 0.0
12036     *
12037     * @param obj Pointer to gesture-layer.
12038     * @param s new zoom step value.
12039     *
12040     * @ingroup Elm_Gesture_Layer
12041     */
12042    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12043
12044    /**
12045     * This function sets step-value for rotate action.
12046     * Set step to any positive value.
12047     * Cancel step setting by setting to 0.0
12048     *
12049     * @param obj Pointer to gesture-layer.
12050     * @param s new roatate step value.
12051     *
12052     * @ingroup Elm_Gesture_Layer
12053     */
12054    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12055
12056    /**
12057     * This function called to attach gesture-layer to an Evas_Object.
12058     * @param obj Pointer to gesture-layer.
12059     * @param t Pointer to underlying object (AKA Target)
12060     *
12061     * @return TRUE, FALSE on success, failure.
12062     *
12063     * @ingroup Elm_Gesture_Layer
12064     */
12065    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12066
12067    /**
12068     * Call this function to construct a new gesture-layer object.
12069     * This does not activate the gesture layer. You have to
12070     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12071     *
12072     * @param parent the parent object.
12073     *
12074     * @return Pointer to new gesture-layer object.
12075     *
12076     * @ingroup Elm_Gesture_Layer
12077     */
12078    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12079
12080    /**
12081     * @defgroup Thumb Thumb
12082     *
12083     * @image html img/widget/thumb/preview-00.png
12084     * @image latex img/widget/thumb/preview-00.eps
12085     *
12086     * A thumb object is used for displaying the thumbnail of an image or video.
12087     * You must have compiled Elementary with Ethumb_Client support and the DBus
12088     * service must be present and auto-activated in order to have thumbnails to
12089     * be generated.
12090     *
12091     * Once the thumbnail object becomes visible, it will check if there is a
12092     * previously generated thumbnail image for the file set on it. If not, it
12093     * will start generating this thumbnail.
12094     *
12095     * Different config settings will cause different thumbnails to be generated
12096     * even on the same file.
12097     *
12098     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12099     * Ethumb documentation to change this path, and to see other configuration
12100     * options.
12101     *
12102     * Signals that you can add callbacks for are:
12103     *
12104     * - "clicked" - This is called when a user has clicked the thumb without dragging
12105     *             around.
12106     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12107     * - "press" - This is called when a user has pressed down the thumb.
12108     * - "generate,start" - The thumbnail generation started.
12109     * - "generate,stop" - The generation process stopped.
12110     * - "generate,error" - The generation failed.
12111     * - "load,error" - The thumbnail image loading failed.
12112     *
12113     * available styles:
12114     * - default
12115     * - noframe
12116     *
12117     * An example of use of thumbnail:
12118     *
12119     * - @ref thumb_example_01
12120     */
12121
12122    /**
12123     * @addtogroup Thumb
12124     * @{
12125     */
12126
12127    /**
12128     * @enum _Elm_Thumb_Animation_Setting
12129     * @typedef Elm_Thumb_Animation_Setting
12130     *
12131     * Used to set if a video thumbnail is animating or not.
12132     *
12133     * @ingroup Thumb
12134     */
12135    typedef enum _Elm_Thumb_Animation_Setting
12136      {
12137         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12138         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12139         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12140         ELM_THUMB_ANIMATION_LAST
12141      } Elm_Thumb_Animation_Setting;
12142
12143    /**
12144     * Add a new thumb object to the parent.
12145     *
12146     * @param parent The parent object.
12147     * @return The new object or NULL if it cannot be created.
12148     *
12149     * @see elm_thumb_file_set()
12150     * @see elm_thumb_ethumb_client_get()
12151     *
12152     * @ingroup Thumb
12153     */
12154    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12155    /**
12156     * Reload thumbnail if it was generated before.
12157     *
12158     * @param obj The thumb object to reload
12159     *
12160     * This is useful if the ethumb client configuration changed, like its
12161     * size, aspect or any other property one set in the handle returned
12162     * by elm_thumb_ethumb_client_get().
12163     *
12164     * If the options didn't change, the thumbnail won't be generated again, but
12165     * the old one will still be used.
12166     *
12167     * @see elm_thumb_file_set()
12168     *
12169     * @ingroup Thumb
12170     */
12171    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12172    /**
12173     * Set the file that will be used as thumbnail.
12174     *
12175     * @param obj The thumb object.
12176     * @param file The path to file that will be used as thumb.
12177     * @param key The key used in case of an EET file.
12178     *
12179     * The file can be an image or a video (in that case, acceptable extensions are:
12180     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12181     * function elm_thumb_animate().
12182     *
12183     * @see elm_thumb_file_get()
12184     * @see elm_thumb_reload()
12185     * @see elm_thumb_animate()
12186     *
12187     * @ingroup Thumb
12188     */
12189    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12190    /**
12191     * Get the image or video path and key used to generate the thumbnail.
12192     *
12193     * @param obj The thumb object.
12194     * @param file Pointer to filename.
12195     * @param key Pointer to key.
12196     *
12197     * @see elm_thumb_file_set()
12198     * @see elm_thumb_path_get()
12199     *
12200     * @ingroup Thumb
12201     */
12202    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12203    /**
12204     * Get the path and key to the image or video generated by ethumb.
12205     *
12206     * One just need to make sure that the thumbnail was generated before getting
12207     * its path; otherwise, the path will be NULL. One way to do that is by asking
12208     * for the path when/after the "generate,stop" smart callback is called.
12209     *
12210     * @param obj The thumb object.
12211     * @param file Pointer to thumb path.
12212     * @param key Pointer to thumb key.
12213     *
12214     * @see elm_thumb_file_get()
12215     *
12216     * @ingroup Thumb
12217     */
12218    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12219    /**
12220     * Set the animation state for the thumb object. If its content is an animated
12221     * video, you may start/stop the animation or tell it to play continuously and
12222     * looping.
12223     *
12224     * @param obj The thumb object.
12225     * @param setting The animation setting.
12226     *
12227     * @see elm_thumb_file_set()
12228     *
12229     * @ingroup Thumb
12230     */
12231    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12232    /**
12233     * Get the animation state for the thumb object.
12234     *
12235     * @param obj The thumb object.
12236     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12237     * on errors.
12238     *
12239     * @see elm_thumb_animate_set()
12240     *
12241     * @ingroup Thumb
12242     */
12243    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12244    /**
12245     * Get the ethumb_client handle so custom configuration can be made.
12246     *
12247     * @return Ethumb_Client instance or NULL.
12248     *
12249     * This must be called before the objects are created to be sure no object is
12250     * visible and no generation started.
12251     *
12252     * Example of usage:
12253     *
12254     * @code
12255     * #include <Elementary.h>
12256     * #ifndef ELM_LIB_QUICKLAUNCH
12257     * EAPI int
12258     * elm_main(int argc, char **argv)
12259     * {
12260     *    Ethumb_Client *client;
12261     *
12262     *    elm_need_ethumb();
12263     *
12264     *    // ... your code
12265     *
12266     *    client = elm_thumb_ethumb_client_get();
12267     *    if (!client)
12268     *      {
12269     *         ERR("could not get ethumb_client");
12270     *         return 1;
12271     *      }
12272     *    ethumb_client_size_set(client, 100, 100);
12273     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12274     *    // ... your code
12275     *
12276     *    // Create elm_thumb objects here
12277     *
12278     *    elm_run();
12279     *    elm_shutdown();
12280     *    return 0;
12281     * }
12282     * #endif
12283     * ELM_MAIN()
12284     * @endcode
12285     *
12286     * @note There's only one client handle for Ethumb, so once a configuration
12287     * change is done to it, any other request for thumbnails (for any thumbnail
12288     * object) will use that configuration. Thus, this configuration is global.
12289     *
12290     * @ingroup Thumb
12291     */
12292    EAPI void                        *elm_thumb_ethumb_client_get(void);
12293    /**
12294     * Get the ethumb_client connection state.
12295     *
12296     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12297     * otherwise.
12298     */
12299    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12300    /**
12301     * Make the thumbnail 'editable'.
12302     *
12303     * @param obj Thumb object.
12304     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12305     *
12306     * This means the thumbnail is a valid drag target for drag and drop, and can be
12307     * cut or pasted too.
12308     *
12309     * @see elm_thumb_editable_get()
12310     *
12311     * @ingroup Thumb
12312     */
12313    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12314    /**
12315     * Make the thumbnail 'editable'.
12316     *
12317     * @param obj Thumb object.
12318     * @return Editability.
12319     *
12320     * This means the thumbnail is a valid drag target for drag and drop, and can be
12321     * cut or pasted too.
12322     *
12323     * @see elm_thumb_editable_set()
12324     *
12325     * @ingroup Thumb
12326     */
12327    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12328
12329    /**
12330     * @}
12331     */
12332
12333    /**
12334     * @defgroup Hoversel Hoversel
12335     *
12336     * @image html img/widget/hoversel/preview-00.png
12337     * @image latex img/widget/hoversel/preview-00.eps
12338     *
12339     * A hoversel is a button that pops up a list of items (automatically
12340     * choosing the direction to display) that have a label and, optionally, an
12341     * icon to select from. It is a convenience widget to avoid the need to do
12342     * all the piecing together yourself. It is intended for a small number of
12343     * items in the hoversel menu (no more than 8), though is capable of many
12344     * more.
12345     *
12346     * Signals that you can add callbacks for are:
12347     * "clicked" - the user clicked the hoversel button and popped up the sel
12348     * "selected" - an item in the hoversel list is selected. event_info is the item
12349     * "dismissed" - the hover is dismissed
12350     *
12351     * See @ref tutorial_hoversel for an example.
12352     * @{
12353     */
12354    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12355    /**
12356     * @brief Add a new Hoversel object
12357     *
12358     * @param parent The parent object
12359     * @return The new object or NULL if it cannot be created
12360     */
12361    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12362    /**
12363     * @brief This sets the hoversel to expand horizontally.
12364     *
12365     * @param obj The hoversel object
12366     * @param horizontal If true, the hover will expand horizontally to the
12367     * right.
12368     *
12369     * @note The initial button will display horizontally regardless of this
12370     * setting.
12371     */
12372    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12373    /**
12374     * @brief This returns whether the hoversel is set to expand horizontally.
12375     *
12376     * @param obj The hoversel object
12377     * @return If true, the hover will expand horizontally to the right.
12378     *
12379     * @see elm_hoversel_horizontal_set()
12380     */
12381    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12382    /**
12383     * @brief Set the Hover parent
12384     *
12385     * @param obj The hoversel object
12386     * @param parent The parent to use
12387     *
12388     * Sets the hover parent object, the area that will be darkened when the
12389     * hoversel is clicked. Should probably be the window that the hoversel is
12390     * in. See @ref Hover objects for more information.
12391     */
12392    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12393    /**
12394     * @brief Get the Hover parent
12395     *
12396     * @param obj The hoversel object
12397     * @return The used parent
12398     *
12399     * Gets the hover parent object.
12400     *
12401     * @see elm_hoversel_hover_parent_set()
12402     */
12403    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12404    /**
12405     * @brief Set the hoversel button label
12406     *
12407     * @param obj The hoversel object
12408     * @param label The label text.
12409     *
12410     * This sets the label of the button that is always visible (before it is
12411     * clicked and expanded).
12412     *
12413     * @deprecated elm_object_text_set()
12414     */
12415    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12416    /**
12417     * @brief Get the hoversel button label
12418     *
12419     * @param obj The hoversel object
12420     * @return The label text.
12421     *
12422     * @deprecated elm_object_text_get()
12423     */
12424    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12425    /**
12426     * @brief Set the icon of the hoversel button
12427     *
12428     * @param obj The hoversel object
12429     * @param icon The icon object
12430     *
12431     * Sets the icon of the button that is always visible (before it is clicked
12432     * and expanded).  Once the icon object is set, a previously set one will be
12433     * deleted, if you want to keep that old content object, use the
12434     * elm_hoversel_icon_unset() function.
12435     *
12436     * @see elm_button_icon_set()
12437     */
12438    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12439    /**
12440     * @brief Get the icon of the hoversel button
12441     *
12442     * @param obj The hoversel object
12443     * @return The icon object
12444     *
12445     * Get the icon of the button that is always visible (before it is clicked
12446     * and expanded). Also see elm_button_icon_get().
12447     *
12448     * @see elm_hoversel_icon_set()
12449     */
12450    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12451    /**
12452     * @brief Get and unparent the icon of the hoversel button
12453     *
12454     * @param obj The hoversel object
12455     * @return The icon object that was being used
12456     *
12457     * Unparent and return the icon of the button that is always visible
12458     * (before it is clicked and expanded).
12459     *
12460     * @see elm_hoversel_icon_set()
12461     * @see elm_button_icon_unset()
12462     */
12463    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12464    /**
12465     * @brief This triggers the hoversel popup from code, the same as if the user
12466     * had clicked the button.
12467     *
12468     * @param obj The hoversel object
12469     */
12470    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12471    /**
12472     * @brief This dismisses the hoversel popup as if the user had clicked
12473     * outside the hover.
12474     *
12475     * @param obj The hoversel object
12476     */
12477    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12478    /**
12479     * @brief Returns whether the hoversel is expanded.
12480     *
12481     * @param obj The hoversel object
12482     * @return  This will return EINA_TRUE if the hoversel is expanded or
12483     * EINA_FALSE if it is not expanded.
12484     */
12485    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12486    /**
12487     * @brief This will remove all the children items from the hoversel.
12488     *
12489     * @param obj The hoversel object
12490     *
12491     * @warning Should @b not be called while the hoversel is active; use
12492     * elm_hoversel_expanded_get() to check first.
12493     *
12494     * @see elm_hoversel_item_del_cb_set()
12495     * @see elm_hoversel_item_del()
12496     */
12497    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12498    /**
12499     * @brief Get the list of items within the given hoversel.
12500     *
12501     * @param obj The hoversel object
12502     * @return Returns a list of Elm_Hoversel_Item*
12503     *
12504     * @see elm_hoversel_item_add()
12505     */
12506    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12507    /**
12508     * @brief Add an item to the hoversel button
12509     *
12510     * @param obj The hoversel object
12511     * @param label The text label to use for the item (NULL if not desired)
12512     * @param icon_file An image file path on disk to use for the icon or standard
12513     * icon name (NULL if not desired)
12514     * @param icon_type The icon type if relevant
12515     * @param func Convenience function to call when this item is selected
12516     * @param data Data to pass to item-related functions
12517     * @return A handle to the item added.
12518     *
12519     * This adds an item to the hoversel to show when it is clicked. Note: if you
12520     * need to use an icon from an edje file then use
12521     * elm_hoversel_item_icon_set() right after the this function, and set
12522     * icon_file to NULL here.
12523     *
12524     * For more information on what @p icon_file and @p icon_type are see the
12525     * @ref Icon "icon documentation".
12526     */
12527    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);
12528    /**
12529     * @brief Delete an item from the hoversel
12530     *
12531     * @param item The item to delete
12532     *
12533     * This deletes the item from the hoversel (should not be called while the
12534     * hoversel is active; use elm_hoversel_expanded_get() to check first).
12535     *
12536     * @see elm_hoversel_item_add()
12537     * @see elm_hoversel_item_del_cb_set()
12538     */
12539    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12540    /**
12541     * @brief Set the function to be called when an item from the hoversel is
12542     * freed.
12543     *
12544     * @param item The item to set the callback on
12545     * @param func The function called
12546     *
12547     * That function will receive these parameters:
12548     * @li void *item_data
12549     * @li Evas_Object *the_item_object
12550     * @li Elm_Hoversel_Item *the_object_struct
12551     *
12552     * @see elm_hoversel_item_add()
12553     */
12554    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12555    /**
12556     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12557     * that will be passed to associated function callbacks.
12558     *
12559     * @param item The item to get the data from
12560     * @return The data pointer set with elm_hoversel_item_add()
12561     *
12562     * @see elm_hoversel_item_add()
12563     */
12564    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12565    /**
12566     * @brief This returns the label text of the given hoversel item.
12567     *
12568     * @param item The item to get the label
12569     * @return The label text of the hoversel item
12570     *
12571     * @see elm_hoversel_item_add()
12572     */
12573    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12574    /**
12575     * @brief This sets the icon for the given hoversel item.
12576     *
12577     * @param item The item to set the icon
12578     * @param icon_file An image file path on disk to use for the icon or standard
12579     * icon name
12580     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12581     * to NULL if the icon is not an edje file
12582     * @param icon_type The icon type
12583     *
12584     * The icon can be loaded from the standard set, from an image file, or from
12585     * an edje file.
12586     *
12587     * @see elm_hoversel_item_add()
12588     */
12589    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);
12590    /**
12591     * @brief Get the icon object of the hoversel item
12592     *
12593     * @param item The item to get the icon from
12594     * @param icon_file The image file path on disk used for the icon or standard
12595     * icon name
12596     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12597     * if the icon is not an edje file
12598     * @param icon_type The icon type
12599     *
12600     * @see elm_hoversel_item_icon_set()
12601     * @see elm_hoversel_item_add()
12602     */
12603    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);
12604    /**
12605     * @}
12606     */
12607
12608    /**
12609     * @defgroup Toolbar Toolbar
12610     * @ingroup Elementary
12611     *
12612     * @image html img/widget/toolbar/preview-00.png
12613     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12614     *
12615     * @image html img/toolbar.png
12616     * @image latex img/toolbar.eps width=\textwidth
12617     *
12618     * A toolbar is a widget that displays a list of items inside
12619     * a box. It can be scrollable, show a menu with items that don't fit
12620     * to toolbar size or even crop them.
12621     *
12622     * Only one item can be selected at a time.
12623     *
12624     * Items can have multiple states, or show menus when selected by the user.
12625     *
12626     * Smart callbacks one can listen to:
12627     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12628     *
12629     * Available styles for it:
12630     * - @c "default"
12631     * - @c "transparent" - no background or shadow, just show the content
12632     *
12633     * List of examples:
12634     * @li @ref toolbar_example_01
12635     * @li @ref toolbar_example_02
12636     * @li @ref toolbar_example_03
12637     */
12638
12639    /**
12640     * @addtogroup Toolbar
12641     * @{
12642     */
12643
12644    /**
12645     * @enum _Elm_Toolbar_Shrink_Mode
12646     * @typedef Elm_Toolbar_Shrink_Mode
12647     *
12648     * Set toolbar's items display behavior, it can be scrollabel,
12649     * show a menu with exceeding items, or simply hide them.
12650     *
12651     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12652     * from elm config.
12653     *
12654     * Values <b> don't </b> work as bitmask, only one can be choosen.
12655     *
12656     * @see elm_toolbar_mode_shrink_set()
12657     * @see elm_toolbar_mode_shrink_get()
12658     *
12659     * @ingroup Toolbar
12660     */
12661    typedef enum _Elm_Toolbar_Shrink_Mode
12662      {
12663         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
12664         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
12665         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12666         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
12667      } Elm_Toolbar_Shrink_Mode;
12668
12669    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(). */
12670
12671    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(). */
12672
12673    /**
12674     * Add a new toolbar widget to the given parent Elementary
12675     * (container) object.
12676     *
12677     * @param parent The parent object.
12678     * @return a new toolbar widget handle or @c NULL, on errors.
12679     *
12680     * This function inserts a new toolbar widget on the canvas.
12681     *
12682     * @ingroup Toolbar
12683     */
12684    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12685
12686    /**
12687     * Set the icon size, in pixels, to be used by toolbar items.
12688     *
12689     * @param obj The toolbar object
12690     * @param icon_size The icon size in pixels
12691     *
12692     * @note Default value is @c 32. It reads value from elm config.
12693     *
12694     * @see elm_toolbar_icon_size_get()
12695     *
12696     * @ingroup Toolbar
12697     */
12698    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12699
12700    /**
12701     * Get the icon size, in pixels, to be used by toolbar items.
12702     *
12703     * @param obj The toolbar object.
12704     * @return The icon size in pixels.
12705     *
12706     * @see elm_toolbar_icon_size_set() for details.
12707     *
12708     * @ingroup Toolbar
12709     */
12710    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12711
12712    /**
12713     * Sets icon lookup order, for toolbar items' icons.
12714     *
12715     * @param obj The toolbar object.
12716     * @param order The icon lookup order.
12717     *
12718     * Icons added before calling this function will not be affected.
12719     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12720     *
12721     * @see elm_toolbar_icon_order_lookup_get()
12722     *
12723     * @ingroup Toolbar
12724     */
12725    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12726
12727    /**
12728     * Gets the icon lookup order.
12729     *
12730     * @param obj The toolbar object.
12731     * @return The icon lookup order.
12732     *
12733     * @see elm_toolbar_icon_order_lookup_set() for details.
12734     *
12735     * @ingroup Toolbar
12736     */
12737    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12738
12739    /**
12740     * Set whether the toolbar items' should be selected by the user or not.
12741     *
12742     * @param obj The toolbar object.
12743     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
12744     * enable it.
12745     *
12746     * This will turn off the ability to select items entirely and they will
12747     * neither appear selected nor emit selected signals. The clicked
12748     * callback function will still be called.
12749     *
12750     * Selection is enabled by default.
12751     *
12752     * @see elm_toolbar_no_select_mode_get().
12753     *
12754     * @ingroup Toolbar
12755     */
12756    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
12757
12758    /**
12759     * Set whether the toolbar items' should be selected by the user or not.
12760     *
12761     * @param obj The toolbar object.
12762     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
12763     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
12764     *
12765     * @see elm_toolbar_no_select_mode_set() for details.
12766     *
12767     * @ingroup Toolbar
12768     */
12769    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12770
12771    /**
12772     * Append item to the toolbar.
12773     *
12774     * @param obj The toolbar object.
12775     * @param icon A string with icon name or the absolute path of an image file.
12776     * @param label The label of the item.
12777     * @param func The function to call when the item is clicked.
12778     * @param data The data to associate with the item for related callbacks.
12779     * @return The created item or @c NULL upon failure.
12780     *
12781     * A new item will be created and appended to the toolbar, i.e., will
12782     * be set as @b last item.
12783     *
12784     * Items created with this method can be deleted with
12785     * elm_toolbar_item_del().
12786     *
12787     * Associated @p data can be properly freed when item is deleted if a
12788     * callback function is set with elm_toolbar_item_del_cb_set().
12789     *
12790     * If a function is passed as argument, it will be called everytime this item
12791     * is selected, i.e., the user clicks over an unselected item.
12792     * If such function isn't needed, just passing
12793     * @c NULL as @p func is enough. The same should be done for @p data.
12794     *
12795     * Toolbar will load icon image from fdo or current theme.
12796     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12797     * If an absolute path is provided it will load it direct from a file.
12798     *
12799     * @see elm_toolbar_item_icon_set()
12800     * @see elm_toolbar_item_del()
12801     * @see elm_toolbar_item_del_cb_set()
12802     *
12803     * @ingroup Toolbar
12804     */
12805    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);
12806
12807    /**
12808     * Prepend item to the toolbar.
12809     *
12810     * @param obj The toolbar object.
12811     * @param icon A string with icon name or the absolute path of an image file.
12812     * @param label The label of the item.
12813     * @param func The function to call when the item is clicked.
12814     * @param data The data to associate with the item for related callbacks.
12815     * @return The created item or @c NULL upon failure.
12816     *
12817     * A new item will be created and prepended to the toolbar, i.e., will
12818     * be set as @b first item.
12819     *
12820     * Items created with this method can be deleted with
12821     * elm_toolbar_item_del().
12822     *
12823     * Associated @p data can be properly freed when item is deleted if a
12824     * callback function is set with elm_toolbar_item_del_cb_set().
12825     *
12826     * If a function is passed as argument, it will be called everytime this item
12827     * is selected, i.e., the user clicks over an unselected item.
12828     * If such function isn't needed, just passing
12829     * @c NULL as @p func is enough. The same should be done for @p data.
12830     *
12831     * Toolbar will load icon image from fdo or current theme.
12832     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12833     * If an absolute path is provided it will load it direct from a file.
12834     *
12835     * @see elm_toolbar_item_icon_set()
12836     * @see elm_toolbar_item_del()
12837     * @see elm_toolbar_item_del_cb_set()
12838     *
12839     * @ingroup Toolbar
12840     */
12841    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);
12842
12843    /**
12844     * Insert a new item into the toolbar object before item @p before.
12845     *
12846     * @param obj The toolbar object.
12847     * @param before The toolbar item to insert before.
12848     * @param icon A string with icon name or the absolute path of an image file.
12849     * @param label The label of the item.
12850     * @param func The function to call when the item is clicked.
12851     * @param data The data to associate with the item for related callbacks.
12852     * @return The created item or @c NULL upon failure.
12853     *
12854     * A new item will be created and added to the toolbar. Its position in
12855     * this toolbar will be just before item @p before.
12856     *
12857     * Items created with this method can be deleted with
12858     * elm_toolbar_item_del().
12859     *
12860     * Associated @p data can be properly freed when item is deleted if a
12861     * callback function is set with elm_toolbar_item_del_cb_set().
12862     *
12863     * If a function is passed as argument, it will be called everytime this item
12864     * is selected, i.e., the user clicks over an unselected item.
12865     * If such function isn't needed, just passing
12866     * @c NULL as @p func is enough. The same should be done for @p data.
12867     *
12868     * Toolbar will load icon image from fdo or current theme.
12869     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12870     * If an absolute path is provided it will load it direct from a file.
12871     *
12872     * @see elm_toolbar_item_icon_set()
12873     * @see elm_toolbar_item_del()
12874     * @see elm_toolbar_item_del_cb_set()
12875     *
12876     * @ingroup Toolbar
12877     */
12878    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);
12879
12880    /**
12881     * Insert a new item into the toolbar object after item @p after.
12882     *
12883     * @param obj The toolbar object.
12884     * @param before The toolbar item to insert before.
12885     * @param icon A string with icon name or the absolute path of an image file.
12886     * @param label The label of the item.
12887     * @param func The function to call when the item is clicked.
12888     * @param data The data to associate with the item for related callbacks.
12889     * @return The created item or @c NULL upon failure.
12890     *
12891     * A new item will be created and added to the toolbar. Its position in
12892     * this toolbar will be just after item @p after.
12893     *
12894     * Items created with this method can be deleted with
12895     * elm_toolbar_item_del().
12896     *
12897     * Associated @p data can be properly freed when item is deleted if a
12898     * callback function is set with elm_toolbar_item_del_cb_set().
12899     *
12900     * If a function is passed as argument, it will be called everytime this item
12901     * is selected, i.e., the user clicks over an unselected item.
12902     * If such function isn't needed, just passing
12903     * @c NULL as @p func is enough. The same should be done for @p data.
12904     *
12905     * Toolbar will load icon image from fdo or current theme.
12906     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
12907     * If an absolute path is provided it will load it direct from a file.
12908     *
12909     * @see elm_toolbar_item_icon_set()
12910     * @see elm_toolbar_item_del()
12911     * @see elm_toolbar_item_del_cb_set()
12912     *
12913     * @ingroup Toolbar
12914     */
12915    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);
12916
12917    /**
12918     * Get the first item in the given toolbar widget's list of
12919     * items.
12920     *
12921     * @param obj The toolbar object
12922     * @return The first item or @c NULL, if it has no items (and on
12923     * errors)
12924     *
12925     * @see elm_toolbar_item_append()
12926     * @see elm_toolbar_last_item_get()
12927     *
12928     * @ingroup Toolbar
12929     */
12930    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12931
12932    /**
12933     * Get the last item in the given toolbar widget's list of
12934     * items.
12935     *
12936     * @param obj The toolbar object
12937     * @return The last item or @c NULL, if it has no items (and on
12938     * errors)
12939     *
12940     * @see elm_toolbar_item_prepend()
12941     * @see elm_toolbar_first_item_get()
12942     *
12943     * @ingroup Toolbar
12944     */
12945    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12946
12947    /**
12948     * Get the item after @p item in toolbar.
12949     *
12950     * @param item The toolbar item.
12951     * @return The item after @p item, or @c NULL if none or on failure.
12952     *
12953     * @note If it is the last item, @c NULL will be returned.
12954     *
12955     * @see elm_toolbar_item_append()
12956     *
12957     * @ingroup Toolbar
12958     */
12959    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12960
12961    /**
12962     * Get the item before @p item in toolbar.
12963     *
12964     * @param item The toolbar item.
12965     * @return The item before @p item, or @c NULL if none or on failure.
12966     *
12967     * @note If it is the first item, @c NULL will be returned.
12968     *
12969     * @see elm_toolbar_item_prepend()
12970     *
12971     * @ingroup Toolbar
12972     */
12973    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12974
12975    /**
12976     * Get the toolbar object from an item.
12977     *
12978     * @param item The item.
12979     * @return The toolbar object.
12980     *
12981     * This returns the toolbar object itself that an item belongs to.
12982     *
12983     * @ingroup Toolbar
12984     */
12985    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
12986
12987    /**
12988     * Set the priority of a toolbar item.
12989     *
12990     * @param item The toolbar item.
12991     * @param priority The item priority. The default is zero.
12992     *
12993     * This is used only when the toolbar shrink mode is set to
12994     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
12995     * When space is less than required, items with low priority
12996     * will be removed from the toolbar and added to a dynamically-created menu,
12997     * while items with higher priority will remain on the toolbar,
12998     * with the same order they were added.
12999     *
13000     * @see elm_toolbar_item_priority_get()
13001     *
13002     * @ingroup Toolbar
13003     */
13004    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13005
13006    /**
13007     * Get the priority of a toolbar item.
13008     *
13009     * @param item The toolbar item.
13010     * @return The @p item priority, or @c 0 on failure.
13011     *
13012     * @see elm_toolbar_item_priority_set() for details.
13013     *
13014     * @ingroup Toolbar
13015     */
13016    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13017
13018    /**
13019     * Get the label of item.
13020     *
13021     * @param item The item of toolbar.
13022     * @return The label of item.
13023     *
13024     * The return value is a pointer to the label associated to @p item when
13025     * it was created, with function elm_toolbar_item_append() or similar,
13026     * or later,
13027     * with function elm_toolbar_item_label_set. If no label
13028     * was passed as argument, it will return @c NULL.
13029     *
13030     * @see elm_toolbar_item_label_set() for more details.
13031     * @see elm_toolbar_item_append()
13032     *
13033     * @ingroup Toolbar
13034     */
13035    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13036
13037    /**
13038     * Set the label of item.
13039     *
13040     * @param item The item of toolbar.
13041     * @param text The label of item.
13042     *
13043     * The label to be displayed by the item.
13044     * Label will be placed at icons bottom (if set).
13045     *
13046     * If a label was passed as argument on item creation, with function
13047     * elm_toolbar_item_append() or similar, it will be already
13048     * displayed by the item.
13049     *
13050     * @see elm_toolbar_item_label_get()
13051     * @see elm_toolbar_item_append()
13052     *
13053     * @ingroup Toolbar
13054     */
13055    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13056
13057    /**
13058     * Return the data associated with a given toolbar widget item.
13059     *
13060     * @param item The toolbar widget item handle.
13061     * @return The data associated with @p item.
13062     *
13063     * @see elm_toolbar_item_data_set()
13064     *
13065     * @ingroup Toolbar
13066     */
13067    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13068
13069    /**
13070     * Set the data associated with a given toolbar widget item.
13071     *
13072     * @param item The toolbar widget item handle.
13073     * @param data The new data pointer to set to @p item.
13074     *
13075     * This sets new item data on @p item.
13076     *
13077     * @warning The old data pointer won't be touched by this function, so
13078     * the user had better to free that old data himself/herself.
13079     *
13080     * @ingroup Toolbar
13081     */
13082    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13083
13084    /**
13085     * Returns a pointer to a toolbar item by its label.
13086     *
13087     * @param obj The toolbar object.
13088     * @param label The label of the item to find.
13089     *
13090     * @return The pointer to the toolbar item matching @p label or @c NULL
13091     * on failure.
13092     *
13093     * @ingroup Toolbar
13094     */
13095    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13096
13097    /*
13098     * Get whether the @p item is selected or not.
13099     *
13100     * @param item The toolbar item.
13101     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13102     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13103     *
13104     * @see elm_toolbar_selected_item_set() for details.
13105     * @see elm_toolbar_item_selected_get()
13106     *
13107     * @ingroup Toolbar
13108     */
13109    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13110
13111    /**
13112     * Set the selected state of an item.
13113     *
13114     * @param item The toolbar item
13115     * @param selected The selected state
13116     *
13117     * This sets the selected state of the given item @p it.
13118     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13119     *
13120     * If a new item is selected the previosly selected will be unselected.
13121     * Previoulsy selected item can be get with function
13122     * elm_toolbar_selected_item_get().
13123     *
13124     * Selected items will be highlighted.
13125     *
13126     * @see elm_toolbar_item_selected_get()
13127     * @see elm_toolbar_selected_item_get()
13128     *
13129     * @ingroup Toolbar
13130     */
13131    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13132
13133    /**
13134     * Get the selected item.
13135     *
13136     * @param obj The toolbar object.
13137     * @return The selected toolbar item.
13138     *
13139     * The selected item can be unselected with function
13140     * elm_toolbar_item_selected_set().
13141     *
13142     * The selected item always will be highlighted on toolbar.
13143     *
13144     * @see elm_toolbar_selected_items_get()
13145     *
13146     * @ingroup Toolbar
13147     */
13148    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13149
13150    /**
13151     * Set the icon associated with @p item.
13152     *
13153     * @param obj The parent of this item.
13154     * @param item The toolbar item.
13155     * @param icon A string with icon name or the absolute path of an image file.
13156     *
13157     * Toolbar will load icon image from fdo or current theme.
13158     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13159     * If an absolute path is provided it will load it direct from a file.
13160     *
13161     * @see elm_toolbar_icon_order_lookup_set()
13162     * @see elm_toolbar_icon_order_lookup_get()
13163     *
13164     * @ingroup Toolbar
13165     */
13166    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13167
13168    /**
13169     * Get the string used to set the icon of @p item.
13170     *
13171     * @param item The toolbar item.
13172     * @return The string associated with the icon object.
13173     *
13174     * @see elm_toolbar_item_icon_set() for details.
13175     *
13176     * @ingroup Toolbar
13177     */
13178    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13179
13180    /**
13181     * Delete them item from the toolbar.
13182     *
13183     * @param item The item of toolbar to be deleted.
13184     *
13185     * @see elm_toolbar_item_append()
13186     * @see elm_toolbar_item_del_cb_set()
13187     *
13188     * @ingroup Toolbar
13189     */
13190    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13191
13192    /**
13193     * Set the function called when a toolbar item is freed.
13194     *
13195     * @param item The item to set the callback on.
13196     * @param func The function called.
13197     *
13198     * If there is a @p func, then it will be called prior item's memory release.
13199     * That will be called with the following arguments:
13200     * @li item's data;
13201     * @li item's Evas object;
13202     * @li item itself;
13203     *
13204     * This way, a data associated to a toolbar item could be properly freed.
13205     *
13206     * @ingroup Toolbar
13207     */
13208    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13209
13210    /**
13211     * Get a value whether toolbar item is disabled or not.
13212     *
13213     * @param item The item.
13214     * @return The disabled state.
13215     *
13216     * @see elm_toolbar_item_disabled_set() for more details.
13217     *
13218     * @ingroup Toolbar
13219     */
13220    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13221
13222    /**
13223     * Sets the disabled/enabled state of a toolbar item.
13224     *
13225     * @param item The item.
13226     * @param disabled The disabled state.
13227     *
13228     * A disabled item cannot be selected or unselected. It will also
13229     * change its appearance (generally greyed out). This sets the
13230     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13231     * enabled).
13232     *
13233     * @ingroup Toolbar
13234     */
13235    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13236
13237    /**
13238     * Set or unset item as a separator.
13239     *
13240     * @param item The toolbar item.
13241     * @param setting @c EINA_TRUE to set item @p item as separator or
13242     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13243     *
13244     * Items aren't set as separator by default.
13245     *
13246     * If set as separator it will display separator theme, so won't display
13247     * icons or label.
13248     *
13249     * @see elm_toolbar_item_separator_get()
13250     *
13251     * @ingroup Toolbar
13252     */
13253    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13254
13255    /**
13256     * Get a value whether item is a separator or not.
13257     *
13258     * @param item The toolbar item.
13259     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13260     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13261     *
13262     * @see elm_toolbar_item_separator_set() for details.
13263     *
13264     * @ingroup Toolbar
13265     */
13266    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13267
13268    /**
13269     * Set the shrink state of toolbar @p obj.
13270     *
13271     * @param obj The toolbar object.
13272     * @param shrink_mode Toolbar's items display behavior.
13273     *
13274     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13275     * but will enforce a minimun size so all the items will fit, won't scroll
13276     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13277     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13278     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13279     *
13280     * @ingroup Toolbar
13281     */
13282    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13283
13284    /**
13285     * Get the shrink mode of toolbar @p obj.
13286     *
13287     * @param obj The toolbar object.
13288     * @return Toolbar's items display behavior.
13289     *
13290     * @see elm_toolbar_mode_shrink_set() for details.
13291     *
13292     * @ingroup Toolbar
13293     */
13294    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13295
13296    /**
13297     * Enable/disable homogenous mode.
13298     *
13299     * @param obj The toolbar object
13300     * @param homogeneous Assume the items within the toolbar are of the
13301     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13302     *
13303     * This will enable the homogeneous mode where items are of the same size.
13304     * @see elm_toolbar_homogeneous_get()
13305     *
13306     * @ingroup Toolbar
13307     */
13308    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13309
13310    /**
13311     * Get whether the homogenous mode is enabled.
13312     *
13313     * @param obj The toolbar object.
13314     * @return Assume the items within the toolbar are of the same height
13315     * and width (EINA_TRUE = on, EINA_FALSE = off).
13316     *
13317     * @see elm_toolbar_homogeneous_set()
13318     *
13319     * @ingroup Toolbar
13320     */
13321    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13322
13323    /**
13324     * Enable/disable homogenous mode.
13325     *
13326     * @param obj The toolbar object
13327     * @param homogeneous Assume the items within the toolbar are of the
13328     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13329     *
13330     * This will enable the homogeneous mode where items are of the same size.
13331     * @see elm_toolbar_homogeneous_get()
13332     *
13333     * @deprecated use elm_toolbar_homogeneous_set() instead.
13334     *
13335     * @ingroup Toolbar
13336     */
13337    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13338
13339    /**
13340     * Get whether the homogenous mode is enabled.
13341     *
13342     * @param obj The toolbar object.
13343     * @return Assume the items within the toolbar are of the same height
13344     * and width (EINA_TRUE = on, EINA_FALSE = off).
13345     *
13346     * @see elm_toolbar_homogeneous_set()
13347     * @deprecated use elm_toolbar_homogeneous_get() instead.
13348     *
13349     * @ingroup Toolbar
13350     */
13351    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13352
13353    /**
13354     * Set the parent object of the toolbar items' menus.
13355     *
13356     * @param obj The toolbar object.
13357     * @param parent The parent of the menu objects.
13358     *
13359     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13360     *
13361     * For more details about setting the parent for toolbar menus, see
13362     * elm_menu_parent_set().
13363     *
13364     * @see elm_menu_parent_set() for details.
13365     * @see elm_toolbar_item_menu_set() for details.
13366     *
13367     * @ingroup Toolbar
13368     */
13369    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13370
13371    /**
13372     * Get the parent object of the toolbar items' menus.
13373     *
13374     * @param obj The toolbar object.
13375     * @return The parent of the menu objects.
13376     *
13377     * @see elm_toolbar_menu_parent_set() for details.
13378     *
13379     * @ingroup Toolbar
13380     */
13381    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13382
13383    /**
13384     * Set the alignment of the items.
13385     *
13386     * @param obj The toolbar object.
13387     * @param align The new alignment, a float between <tt> 0.0 </tt>
13388     * and <tt> 1.0 </tt>.
13389     *
13390     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13391     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13392     * items.
13393     *
13394     * Centered items by default.
13395     *
13396     * @see elm_toolbar_align_get()
13397     *
13398     * @ingroup Toolbar
13399     */
13400    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13401
13402    /**
13403     * Get the alignment of the items.
13404     *
13405     * @param obj The toolbar object.
13406     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13407     * <tt> 1.0 </tt>.
13408     *
13409     * @see elm_toolbar_align_set() for details.
13410     *
13411     * @ingroup Toolbar
13412     */
13413    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13414
13415    /**
13416     * Set whether the toolbar item opens a menu.
13417     *
13418     * @param item The toolbar item.
13419     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13420     *
13421     * A toolbar item can be set to be a menu, using this function.
13422     *
13423     * Once it is set to be a menu, it can be manipulated through the
13424     * menu-like function elm_toolbar_menu_parent_set() and the other
13425     * elm_menu functions, using the Evas_Object @c menu returned by
13426     * elm_toolbar_item_menu_get().
13427     *
13428     * So, items to be displayed in this item's menu should be added with
13429     * elm_menu_item_add().
13430     *
13431     * The following code exemplifies the most basic usage:
13432     * @code
13433     * tb = elm_toolbar_add(win)
13434     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13435     * elm_toolbar_item_menu_set(item, EINA_TRUE);
13436     * elm_toolbar_menu_parent_set(tb, win);
13437     * menu = elm_toolbar_item_menu_get(item);
13438     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13439     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13440     * NULL);
13441     * @endcode
13442     *
13443     * @see elm_toolbar_item_menu_get()
13444     *
13445     * @ingroup Toolbar
13446     */
13447    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13448
13449    /**
13450     * Get toolbar item's menu.
13451     *
13452     * @param item The toolbar item.
13453     * @return Item's menu object or @c NULL on failure.
13454     *
13455     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13456     * this function will set it.
13457     *
13458     * @see elm_toolbar_item_menu_set() for details.
13459     *
13460     * @ingroup Toolbar
13461     */
13462    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13463
13464    /**
13465     * Add a new state to @p item.
13466     *
13467     * @param item The item.
13468     * @param icon A string with icon name or the absolute path of an image file.
13469     * @param label The label of the new state.
13470     * @param func The function to call when the item is clicked when this
13471     * state is selected.
13472     * @param data The data to associate with the state.
13473     * @return The toolbar item state, or @c NULL upon failure.
13474     *
13475     * Toolbar will load icon image from fdo or current theme.
13476     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13477     * If an absolute path is provided it will load it direct from a file.
13478     *
13479     * States created with this function can be removed with
13480     * elm_toolbar_item_state_del().
13481     *
13482     * @see elm_toolbar_item_state_del()
13483     * @see elm_toolbar_item_state_sel()
13484     * @see elm_toolbar_item_state_get()
13485     *
13486     * @ingroup Toolbar
13487     */
13488    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);
13489
13490    /**
13491     * Delete a previoulsy added state to @p item.
13492     *
13493     * @param item The toolbar item.
13494     * @param state The state to be deleted.
13495     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13496     *
13497     * @see elm_toolbar_item_state_add()
13498     */
13499    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13500
13501    /**
13502     * Set @p state as the current state of @p it.
13503     *
13504     * @param it The item.
13505     * @param state The state to use.
13506     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13507     *
13508     * If @p state is @c NULL, it won't select any state and the default item's
13509     * icon and label will be used. It's the same behaviour than
13510     * elm_toolbar_item_state_unser().
13511     *
13512     * @see elm_toolbar_item_state_unset()
13513     *
13514     * @ingroup Toolbar
13515     */
13516    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13517
13518    /**
13519     * Unset the state of @p it.
13520     *
13521     * @param it The item.
13522     *
13523     * The default icon and label from this item will be displayed.
13524     *
13525     * @see elm_toolbar_item_state_set() for more details.
13526     *
13527     * @ingroup Toolbar
13528     */
13529    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13530
13531    /**
13532     * Get the current state of @p it.
13533     *
13534     * @param item The item.
13535     * @return The selected state or @c NULL if none is selected or on failure.
13536     *
13537     * @see elm_toolbar_item_state_set() for details.
13538     * @see elm_toolbar_item_state_unset()
13539     * @see elm_toolbar_item_state_add()
13540     *
13541     * @ingroup Toolbar
13542     */
13543    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13544
13545    /**
13546     * Get the state after selected state in toolbar's @p item.
13547     *
13548     * @param it The toolbar item to change state.
13549     * @return The state after current state, or @c NULL on failure.
13550     *
13551     * If last state is selected, this function will return first state.
13552     *
13553     * @see elm_toolbar_item_state_set()
13554     * @see elm_toolbar_item_state_add()
13555     *
13556     * @ingroup Toolbar
13557     */
13558    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13559
13560    /**
13561     * Get the state before selected state in toolbar's @p item.
13562     *
13563     * @param it The toolbar item to change state.
13564     * @return The state before current state, or @c NULL on failure.
13565     *
13566     * If first state is selected, this function will return last state.
13567     *
13568     * @see elm_toolbar_item_state_set()
13569     * @see elm_toolbar_item_state_add()
13570     *
13571     * @ingroup Toolbar
13572     */
13573    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13574
13575    /**
13576     * Set the text to be shown in a given toolbar item's tooltips.
13577     *
13578     * @param item Target item.
13579     * @param text The text to set in the content.
13580     *
13581     * Setup the text as tooltip to object. The item can have only one tooltip,
13582     * so any previous tooltip data - set with this function or
13583     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13584     *
13585     * @see elm_object_tooltip_text_set() for more details.
13586     *
13587     * @ingroup Toolbar
13588     */
13589    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13590
13591    /**
13592     * Set the content to be shown in the tooltip item.
13593     *
13594     * Setup the tooltip to item. The item can have only one tooltip,
13595     * so any previous tooltip data is removed. @p func(with @p data) will
13596     * be called every time that need show the tooltip and it should
13597     * return a valid Evas_Object. This object is then managed fully by
13598     * tooltip system and is deleted when the tooltip is gone.
13599     *
13600     * @param item the toolbar item being attached a tooltip.
13601     * @param func the function used to create the tooltip contents.
13602     * @param data what to provide to @a func as callback data/context.
13603     * @param del_cb called when data is not needed anymore, either when
13604     *        another callback replaces @a func, the tooltip is unset with
13605     *        elm_toolbar_item_tooltip_unset() or the owner @a item
13606     *        dies. This callback receives as the first parameter the
13607     *        given @a data, and @c event_info is the item.
13608     *
13609     * @see elm_object_tooltip_content_cb_set() for more details.
13610     *
13611     * @ingroup Toolbar
13612     */
13613    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);
13614
13615    /**
13616     * Unset tooltip from item.
13617     *
13618     * @param item toolbar item to remove previously set tooltip.
13619     *
13620     * Remove tooltip from item. The callback provided as del_cb to
13621     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13622     * it is not used anymore.
13623     *
13624     * @see elm_object_tooltip_unset() for more details.
13625     * @see elm_toolbar_item_tooltip_content_cb_set()
13626     *
13627     * @ingroup Toolbar
13628     */
13629    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13630
13631    /**
13632     * Sets a different style for this item tooltip.
13633     *
13634     * @note before you set a style you should define a tooltip with
13635     *       elm_toolbar_item_tooltip_content_cb_set() or
13636     *       elm_toolbar_item_tooltip_text_set()
13637     *
13638     * @param item toolbar item with tooltip already set.
13639     * @param style the theme style to use (default, transparent, ...)
13640     *
13641     * @see elm_object_tooltip_style_set() for more details.
13642     *
13643     * @ingroup Toolbar
13644     */
13645    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13646
13647    /**
13648     * Get the style for this item tooltip.
13649     *
13650     * @param item toolbar item with tooltip already set.
13651     * @return style the theme style in use, defaults to "default". If the
13652     *         object does not have a tooltip set, then NULL is returned.
13653     *
13654     * @see elm_object_tooltip_style_get() for more details.
13655     * @see elm_toolbar_item_tooltip_style_set()
13656     *
13657     * @ingroup Toolbar
13658     */
13659    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13660
13661    /**
13662     * Set the type of mouse pointer/cursor decoration to be shown,
13663     * when the mouse pointer is over the given toolbar widget item
13664     *
13665     * @param item toolbar item to customize cursor on
13666     * @param cursor the cursor type's name
13667     *
13668     * This function works analogously as elm_object_cursor_set(), but
13669     * here the cursor's changing area is restricted to the item's
13670     * area, and not the whole widget's. Note that that item cursors
13671     * have precedence over widget cursors, so that a mouse over an
13672     * item with custom cursor set will always show @b that cursor.
13673     *
13674     * If this function is called twice for an object, a previously set
13675     * cursor will be unset on the second call.
13676     *
13677     * @see elm_object_cursor_set()
13678     * @see elm_toolbar_item_cursor_get()
13679     * @see elm_toolbar_item_cursor_unset()
13680     *
13681     * @ingroup Toolbar
13682     */
13683    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13684
13685    /*
13686     * Get the type of mouse pointer/cursor decoration set to be shown,
13687     * when the mouse pointer is over the given toolbar widget item
13688     *
13689     * @param item toolbar item with custom cursor set
13690     * @return the cursor type's name or @c NULL, if no custom cursors
13691     * were set to @p item (and on errors)
13692     *
13693     * @see elm_object_cursor_get()
13694     * @see elm_toolbar_item_cursor_set()
13695     * @see elm_toolbar_item_cursor_unset()
13696     *
13697     * @ingroup Toolbar
13698     */
13699    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13700
13701    /**
13702     * Unset any custom mouse pointer/cursor decoration set to be
13703     * shown, when the mouse pointer is over the given toolbar widget
13704     * item, thus making it show the @b default cursor again.
13705     *
13706     * @param item a toolbar item
13707     *
13708     * Use this call to undo any custom settings on this item's cursor
13709     * decoration, bringing it back to defaults (no custom style set).
13710     *
13711     * @see elm_object_cursor_unset()
13712     * @see elm_toolbar_item_cursor_set()
13713     *
13714     * @ingroup Toolbar
13715     */
13716    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13717
13718    /**
13719     * Set a different @b style for a given custom cursor set for a
13720     * toolbar item.
13721     *
13722     * @param item toolbar item with custom cursor set
13723     * @param style the <b>theme style</b> to use (e.g. @c "default",
13724     * @c "transparent", etc)
13725     *
13726     * This function only makes sense when one is using custom mouse
13727     * cursor decorations <b>defined in a theme file</b>, which can have,
13728     * given a cursor name/type, <b>alternate styles</b> on it. It
13729     * works analogously as elm_object_cursor_style_set(), but here
13730     * applyed only to toolbar item objects.
13731     *
13732     * @warning Before you set a cursor style you should have definen a
13733     *       custom cursor previously on the item, with
13734     *       elm_toolbar_item_cursor_set()
13735     *
13736     * @see elm_toolbar_item_cursor_engine_only_set()
13737     * @see elm_toolbar_item_cursor_style_get()
13738     *
13739     * @ingroup Toolbar
13740     */
13741    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13742
13743    /**
13744     * Get the current @b style set for a given toolbar item's custom
13745     * cursor
13746     *
13747     * @param item toolbar item with custom cursor set.
13748     * @return style the cursor style in use. If the object does not
13749     *         have a cursor set, then @c NULL is returned.
13750     *
13751     * @see elm_toolbar_item_cursor_style_set() for more details
13752     *
13753     * @ingroup Toolbar
13754     */
13755    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13756
13757    /**
13758     * Set if the (custom)cursor for a given toolbar item should be
13759     * searched in its theme, also, or should only rely on the
13760     * rendering engine.
13761     *
13762     * @param item item with custom (custom) cursor already set on
13763     * @param engine_only Use @c EINA_TRUE to have cursors looked for
13764     * only on those provided by the rendering engine, @c EINA_FALSE to
13765     * have them searched on the widget's theme, as well.
13766     *
13767     * @note This call is of use only if you've set a custom cursor
13768     * for toolbar items, with elm_toolbar_item_cursor_set().
13769     *
13770     * @note By default, cursors will only be looked for between those
13771     * provided by the rendering engine.
13772     *
13773     * @ingroup Toolbar
13774     */
13775    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13776
13777    /**
13778     * Get if the (custom) cursor for a given toolbar item is being
13779     * searched in its theme, also, or is only relying on the rendering
13780     * engine.
13781     *
13782     * @param item a toolbar item
13783     * @return @c EINA_TRUE, if cursors are being looked for only on
13784     * those provided by the rendering engine, @c EINA_FALSE if they
13785     * are being searched on the widget's theme, as well.
13786     *
13787     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
13788     *
13789     * @ingroup Toolbar
13790     */
13791    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13792
13793    /**
13794     * Change a toolbar's orientation
13795     * @param obj The toolbar object
13796     * @param vertical If @c EINA_TRUE, the toolbar is vertical
13797     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
13798     * @ingroup Toolbar
13799     */
13800    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
13801
13802    /**
13803     * Get a toolbar's orientation
13804     * @param obj The toolbar object
13805     * @return If @c EINA_TRUE, the toolbar is vertical
13806     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
13807     * @ingroup Toolbar
13808     */
13809    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13810
13811    /**
13812     * @}
13813     */
13814
13815    /**
13816     * @defgroup Tooltips Tooltips
13817     *
13818     * The Tooltip is an (internal, for now) smart object used to show a
13819     * content in a frame on mouse hover of objects(or widgets), with
13820     * tips/information about them.
13821     *
13822     * @{
13823     */
13824
13825    EAPI double       elm_tooltip_delay_get(void);
13826    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
13827    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
13828    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
13829    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
13830    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);
13831    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13832    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13833    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13834    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
13835    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
13836
13837    /**
13838     * @}
13839     */
13840
13841    /**
13842     * @defgroup Cursors Cursors
13843     *
13844     * The Elementary cursor is an internal smart object used to
13845     * customize the mouse cursor displayed over objects (or
13846     * widgets). In the most common scenario, the cursor decoration
13847     * comes from the graphical @b engine Elementary is running
13848     * on. Those engines may provide different decorations for cursors,
13849     * and Elementary provides functions to choose them (think of X11
13850     * cursors, as an example).
13851     *
13852     * There's also the possibility of, besides using engine provided
13853     * cursors, also use ones coming from Edje theming files. Both
13854     * globally and per widget, Elementary makes it possible for one to
13855     * make the cursors lookup to be held on engines only or on
13856     * Elementary's theme file, too.
13857     *
13858     * @{
13859     */
13860
13861    /**
13862     * Set the cursor to be shown when mouse is over the object
13863     *
13864     * Set the cursor that will be displayed when mouse is over the
13865     * object. The object can have only one cursor set to it, so if
13866     * this function is called twice for an object, the previous set
13867     * will be unset.
13868     * If using X cursors, a definition of all the valid cursor names
13869     * is listed on Elementary_Cursors.h. If an invalid name is set
13870     * the default cursor will be used.
13871     *
13872     * @param obj the object being set a cursor.
13873     * @param cursor the cursor name to be used.
13874     *
13875     * @ingroup Cursors
13876     */
13877    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
13878
13879    /**
13880     * Get the cursor to be shown when mouse is over the object
13881     *
13882     * @param obj an object with cursor already set.
13883     * @return the cursor name.
13884     *
13885     * @ingroup Cursors
13886     */
13887    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13888
13889    /**
13890     * Unset cursor for object
13891     *
13892     * Unset cursor for object, and set the cursor to default if the mouse
13893     * was over this object.
13894     *
13895     * @param obj Target object
13896     * @see elm_object_cursor_set()
13897     *
13898     * @ingroup Cursors
13899     */
13900    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13901
13902    /**
13903     * Sets a different style for this object cursor.
13904     *
13905     * @note before you set a style you should define a cursor with
13906     *       elm_object_cursor_set()
13907     *
13908     * @param obj an object with cursor already set.
13909     * @param style the theme style to use (default, transparent, ...)
13910     *
13911     * @ingroup Cursors
13912     */
13913    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
13914
13915    /**
13916     * Get the style for this object cursor.
13917     *
13918     * @param obj an object with cursor already set.
13919     * @return style the theme style in use, defaults to "default". If the
13920     *         object does not have a cursor set, then NULL is returned.
13921     *
13922     * @ingroup Cursors
13923     */
13924    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13925
13926    /**
13927     * Set if the cursor set should be searched on the theme or should use
13928     * the provided by the engine, only.
13929     *
13930     * @note before you set if should look on theme you should define a cursor
13931     * with elm_object_cursor_set(). By default it will only look for cursors
13932     * provided by the engine.
13933     *
13934     * @param obj an object with cursor already set.
13935     * @param engine_only boolean to define it cursors should be looked only
13936     * between the provided by the engine or searched on widget's theme as well.
13937     *
13938     * @ingroup Cursors
13939     */
13940    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
13941
13942    /**
13943     * Get the cursor engine only usage for this object cursor.
13944     *
13945     * @param obj an object with cursor already set.
13946     * @return engine_only boolean to define it cursors should be
13947     * looked only between the provided by the engine or searched on
13948     * widget's theme as well. If the object does not have a cursor
13949     * set, then EINA_FALSE is returned.
13950     *
13951     * @ingroup Cursors
13952     */
13953    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13954
13955    /**
13956     * Get the configured cursor engine only usage
13957     *
13958     * This gets the globally configured exclusive usage of engine cursors.
13959     *
13960     * @return 1 if only engine cursors should be used
13961     * @ingroup Cursors
13962     */
13963    EAPI int          elm_cursor_engine_only_get(void);
13964
13965    /**
13966     * Set the configured cursor engine only usage
13967     *
13968     * This sets the globally configured exclusive usage of engine cursors.
13969     * It won't affect cursors set before changing this value.
13970     *
13971     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
13972     * look for them on theme before.
13973     * @return EINA_TRUE if value is valid and setted (0 or 1)
13974     * @ingroup Cursors
13975     */
13976    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
13977
13978    /**
13979     * @}
13980     */
13981
13982    /**
13983     * @defgroup Menu Menu
13984     *
13985     * @image html img/widget/menu/preview-00.png
13986     * @image latex img/widget/menu/preview-00.eps
13987     *
13988     * A menu is a list of items displayed above its parent. When the menu is
13989     * showing its parent is darkened. Each item can have a sub-menu. The menu
13990     * object can be used to display a menu on a right click event, in a toolbar,
13991     * anywhere.
13992     *
13993     * Signals that you can add callbacks for are:
13994     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
13995     *             event_info is NULL.
13996     *
13997     * @see @ref tutorial_menu
13998     * @{
13999     */
14000    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14001    /**
14002     * @brief Add a new menu to the parent
14003     *
14004     * @param parent The parent object.
14005     * @return The new object or NULL if it cannot be created.
14006     */
14007    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14008    /**
14009     * @brief Set the parent for the given menu widget
14010     *
14011     * @param obj The menu object.
14012     * @param parent The new parent.
14013     */
14014    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14015    /**
14016     * @brief Get the parent for the given menu widget
14017     *
14018     * @param obj The menu object.
14019     * @return The parent.
14020     *
14021     * @see elm_menu_parent_set()
14022     */
14023    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14024    /**
14025     * @brief Move the menu to a new position
14026     *
14027     * @param obj The menu object.
14028     * @param x The new position.
14029     * @param y The new position.
14030     *
14031     * Sets the top-left position of the menu to (@p x,@p y).
14032     *
14033     * @note @p x and @p y coordinates are relative to parent.
14034     */
14035    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14036    /**
14037     * @brief Close a opened menu
14038     *
14039     * @param obj the menu object
14040     * @return void
14041     *
14042     * Hides the menu and all it's sub-menus.
14043     */
14044    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14045    /**
14046     * @brief Returns a list of @p item's items.
14047     *
14048     * @param obj The menu object
14049     * @return An Eina_List* of @p item's items
14050     */
14051    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14052    /**
14053     * @brief Get the Evas_Object of an Elm_Menu_Item
14054     *
14055     * @param item The menu item object.
14056     * @return The edje object containing the swallowed content
14057     *
14058     * @warning Don't manipulate this object!
14059     */
14060    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14061    /**
14062     * @brief Add an item at the end of the given menu widget
14063     *
14064     * @param obj The menu object.
14065     * @param parent The parent menu item (optional)
14066     * @param icon A icon display on the item. The icon will be destryed by the menu.
14067     * @param label The label of the item.
14068     * @param func Function called when the user select the item.
14069     * @param data Data sent by the callback.
14070     * @return Returns the new item.
14071     */
14072    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);
14073    /**
14074     * @brief Add an object swallowed in an item at the end of the given menu
14075     * widget
14076     *
14077     * @param obj The menu object.
14078     * @param parent The parent menu item (optional)
14079     * @param subobj The object to swallow
14080     * @param func Function called when the user select the item.
14081     * @param data Data sent by the callback.
14082     * @return Returns the new item.
14083     *
14084     * Add an evas object as an item to the menu.
14085     */
14086    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);
14087    /**
14088     * @brief Set the label of a menu item
14089     *
14090     * @param item The menu item object.
14091     * @param label The label to set for @p item
14092     *
14093     * @warning Don't use this funcion on items created with
14094     * elm_menu_item_add_object() or elm_menu_item_separator_add().
14095     */
14096    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14097    /**
14098     * @brief Get the label of a menu item
14099     *
14100     * @param item The menu item object.
14101     * @return The label of @p item
14102     */
14103    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14104    /**
14105     * @brief Set the icon of a menu item to the standard icon with name @p icon
14106     *
14107     * @param item The menu item object.
14108     * @param icon The icon object to set for the content of @p item
14109     *
14110     * Once this icon is set, any previously set icon will be deleted.
14111     */
14112    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14113    /**
14114     * @brief Get the string representation from the icon of a menu item
14115     *
14116     * @param item The menu item object.
14117     * @return The string representation of @p item's icon or NULL
14118     *
14119     * @see elm_menu_item_object_icon_name_set()
14120     */
14121    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14122    /**
14123     * @brief Set the content object of a menu item
14124     *
14125     * @param item The menu item object
14126     * @param The content object or NULL
14127     * @return EINA_TRUE on success, else EINA_FALSE
14128     *
14129     * Use this function to change the object swallowed by a menu item, deleting
14130     * any previously swallowed object.
14131     */
14132    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14133    /**
14134     * @brief Get the content object of a menu item
14135     *
14136     * @param item The menu item object
14137     * @return The content object or NULL
14138     * @note If @p item was added with elm_menu_item_add_object, this
14139     * function will return the object passed, else it will return the
14140     * icon object.
14141     *
14142     * @see elm_menu_item_object_content_set()
14143     */
14144    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14145    /**
14146     * @brief Set the selected state of @p item.
14147     *
14148     * @param item The menu item object.
14149     * @param selected The selected/unselected state of the item
14150     */
14151    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14152    /**
14153     * @brief Get the selected state of @p item.
14154     *
14155     * @param item The menu item object.
14156     * @return The selected/unselected state of the item
14157     *
14158     * @see elm_menu_item_selected_set()
14159     */
14160    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14161    /**
14162     * @brief Set the disabled state of @p item.
14163     *
14164     * @param item The menu item object.
14165     * @param disabled The enabled/disabled state of the item
14166     */
14167    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14168    /**
14169     * @brief Get the disabled state of @p item.
14170     *
14171     * @param item The menu item object.
14172     * @return The enabled/disabled state of the item
14173     *
14174     * @see elm_menu_item_disabled_set()
14175     */
14176    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14177    /**
14178     * @brief Add a separator item to menu @p obj under @p parent.
14179     *
14180     * @param obj The menu object
14181     * @param parent The item to add the separator under
14182     * @return The created item or NULL on failure
14183     *
14184     * This is item is a @ref Separator.
14185     */
14186    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14187    /**
14188     * @brief Returns whether @p item is a separator.
14189     *
14190     * @param item The item to check
14191     * @return If true, @p item is a separator
14192     *
14193     * @see elm_menu_item_separator_add()
14194     */
14195    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14196    /**
14197     * @brief Deletes an item from the menu.
14198     *
14199     * @param item The item to delete.
14200     *
14201     * @see elm_menu_item_add()
14202     */
14203    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14204    /**
14205     * @brief Set the function called when a menu item is deleted.
14206     *
14207     * @param item The item to set the callback on
14208     * @param func The function called
14209     *
14210     * @see elm_menu_item_add()
14211     * @see elm_menu_item_del()
14212     */
14213    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14214    /**
14215     * @brief Returns the data associated with menu item @p item.
14216     *
14217     * @param item The item
14218     * @return The data associated with @p item or NULL if none was set.
14219     *
14220     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14221     */
14222    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14223    /**
14224     * @brief Sets the data to be associated with menu item @p item.
14225     *
14226     * @param item The item
14227     * @param data The data to be associated with @p item
14228     */
14229    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14230    /**
14231     * @brief Returns a list of @p item's subitems.
14232     *
14233     * @param item The item
14234     * @return An Eina_List* of @p item's subitems
14235     *
14236     * @see elm_menu_add()
14237     */
14238    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14239    /**
14240     * @brief Get the position of a menu item
14241     *
14242     * @param item The menu item
14243     * @return The item's index
14244     *
14245     * This function returns the index position of a menu item in a menu.
14246     * For a sub-menu, this number is relative to the first item in the sub-menu.
14247     *
14248     * @note Index values begin with 0
14249     */
14250    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14251    /**
14252     * @brief @brief Return a menu item's owner menu
14253     *
14254     * @param item The menu item
14255     * @return The menu object owning @p item, or NULL on failure
14256     *
14257     * Use this function to get the menu object owning an item.
14258     */
14259    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14260    /**
14261     * @brief Get the selected item in the menu
14262     *
14263     * @param obj The menu object
14264     * @return The selected item, or NULL if none
14265     *
14266     * @see elm_menu_item_selected_get()
14267     * @see elm_menu_item_selected_set()
14268     */
14269    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14270    /**
14271     * @brief Get the last item in the menu
14272     *
14273     * @param obj The menu object
14274     * @return The last item, or NULL if none
14275     */
14276    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14277    /**
14278     * @brief Get the first item in the menu
14279     *
14280     * @param obj The menu object
14281     * @return The first item, or NULL if none
14282     */
14283    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14284    /**
14285     * @brief Get the next item in the menu.
14286     *
14287     * @param item The menu item object.
14288     * @return The item after it, or NULL if none
14289     */
14290    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14291    /**
14292     * @brief Get the previous item in the menu.
14293     *
14294     * @param item The menu item object.
14295     * @return The item before it, or NULL if none
14296     */
14297    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14298    /**
14299     * @}
14300     */
14301
14302    /**
14303     * @defgroup List List
14304     * @ingroup Elementary
14305     *
14306     * @image html img/widget/list/preview-00.png
14307     * @image latex img/widget/list/preview-00.eps width=\textwidth
14308     *
14309     * @image html img/list.png
14310     * @image latex img/list.eps width=\textwidth
14311     *
14312     * A list widget is a container whose children are displayed vertically or
14313     * horizontally, in order, and can be selected.
14314     * The list can accept only one or multiple items selection. Also has many
14315     * modes of items displaying.
14316     *
14317     * A list is a very simple type of list widget.  For more robust
14318     * lists, @ref Genlist should probably be used.
14319     *
14320     * Smart callbacks one can listen to:
14321     * - @c "activated" - The user has double-clicked or pressed
14322     *   (enter|return|spacebar) on an item. The @c event_info parameter
14323     *   is the item that was activated.
14324     * - @c "clicked,double" - The user has double-clicked an item.
14325     *   The @c event_info parameter is the item that was double-clicked.
14326     * - "selected" - when the user selected an item
14327     * - "unselected" - when the user unselected an item
14328     * - "longpressed" - an item in the list is long-pressed
14329     * - "scroll,edge,top" - the list is scrolled until the top edge
14330     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14331     * - "scroll,edge,left" - the list is scrolled until the left edge
14332     * - "scroll,edge,right" - the list is scrolled until the right edge
14333     *
14334     * Available styles for it:
14335     * - @c "default"
14336     *
14337     * List of examples:
14338     * @li @ref list_example_01
14339     * @li @ref list_example_02
14340     * @li @ref list_example_03
14341     */
14342
14343    /**
14344     * @addtogroup List
14345     * @{
14346     */
14347
14348    /**
14349     * @enum _Elm_List_Mode
14350     * @typedef Elm_List_Mode
14351     *
14352     * Set list's resize behavior, transverse axis scroll and
14353     * items cropping. See each mode's description for more details.
14354     *
14355     * @note Default value is #ELM_LIST_SCROLL.
14356     *
14357     * Values <b> don't </b> work as bitmask, only one can be choosen.
14358     *
14359     * @see elm_list_mode_set()
14360     * @see elm_list_mode_get()
14361     *
14362     * @ingroup List
14363     */
14364    typedef enum _Elm_List_Mode
14365      {
14366         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. */
14367         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). */
14368         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. */
14369         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. */
14370         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14371      } Elm_List_Mode;
14372
14373    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().  */
14374
14375    /**
14376     * Add a new list widget to the given parent Elementary
14377     * (container) object.
14378     *
14379     * @param parent The parent object.
14380     * @return a new list widget handle or @c NULL, on errors.
14381     *
14382     * This function inserts a new list widget on the canvas.
14383     *
14384     * @ingroup List
14385     */
14386    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14387
14388    /**
14389     * Starts the list.
14390     *
14391     * @param obj The list object
14392     *
14393     * @note Call before running show() on the list object.
14394     * @warning If not called, it won't display the list properly.
14395     *
14396     * @code
14397     * li = elm_list_add(win);
14398     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14399     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14400     * elm_list_go(li);
14401     * evas_object_show(li);
14402     * @endcode
14403     *
14404     * @ingroup List
14405     */
14406    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14407
14408    /**
14409     * Enable or disable multiple items selection on the list object.
14410     *
14411     * @param obj The list object
14412     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14413     * disable it.
14414     *
14415     * Disabled by default. If disabled, the user can select a single item of
14416     * the list each time. Selected items are highlighted on list.
14417     * If enabled, many items can be selected.
14418     *
14419     * If a selected item is selected again, it will be unselected.
14420     *
14421     * @see elm_list_multi_select_get()
14422     *
14423     * @ingroup List
14424     */
14425    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14426
14427    /**
14428     * Get a value whether multiple items selection is enabled or not.
14429     *
14430     * @see elm_list_multi_select_set() for details.
14431     *
14432     * @param obj The list object.
14433     * @return @c EINA_TRUE means multiple items selection is enabled.
14434     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14435     * @c EINA_FALSE is returned.
14436     *
14437     * @ingroup List
14438     */
14439    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14440
14441    /**
14442     * Set which mode to use for the list object.
14443     *
14444     * @param obj The list object
14445     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14446     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14447     *
14448     * Set list's resize behavior, transverse axis scroll and
14449     * items cropping. See each mode's description for more details.
14450     *
14451     * @note Default value is #ELM_LIST_SCROLL.
14452     *
14453     * Only one can be set, if a previous one was set, it will be changed
14454     * by the new mode set. Bitmask won't work as well.
14455     *
14456     * @see elm_list_mode_get()
14457     *
14458     * @ingroup List
14459     */
14460    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14461
14462    /**
14463     * Get the mode the list is at.
14464     *
14465     * @param obj The list object
14466     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14467     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14468     *
14469     * @note see elm_list_mode_set() for more information.
14470     *
14471     * @ingroup List
14472     */
14473    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14474
14475    /**
14476     * Enable or disable horizontal mode on the list object.
14477     *
14478     * @param obj The list object.
14479     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14480     * disable it, i.e., to enable vertical mode.
14481     *
14482     * @note Vertical mode is set by default.
14483     *
14484     * On horizontal mode items are displayed on list from left to right,
14485     * instead of from top to bottom. Also, the list will scroll horizontally.
14486     * Each item will presents left icon on top and right icon, or end, at
14487     * the bottom.
14488     *
14489     * @see elm_list_horizontal_get()
14490     *
14491     * @ingroup List
14492     */
14493    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14494
14495    /**
14496     * Get a value whether horizontal mode is enabled or not.
14497     *
14498     * @param obj The list object.
14499     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14500     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14501     * @c EINA_FALSE is returned.
14502     *
14503     * @see elm_list_horizontal_set() for details.
14504     *
14505     * @ingroup List
14506     */
14507    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14508
14509    /**
14510     * Enable or disable always select mode on the list object.
14511     *
14512     * @param obj The list object
14513     * @param always_select @c EINA_TRUE to enable always select mode or
14514     * @c EINA_FALSE to disable it.
14515     *
14516     * @note Always select mode is disabled by default.
14517     *
14518     * Default behavior of list items is to only call its callback function
14519     * the first time it's pressed, i.e., when it is selected. If a selected
14520     * item is pressed again, and multi-select is disabled, it won't call
14521     * this function (if multi-select is enabled it will unselect the item).
14522     *
14523     * If always select is enabled, it will call the callback function
14524     * everytime a item is pressed, so it will call when the item is selected,
14525     * and again when a selected item is pressed.
14526     *
14527     * @see elm_list_always_select_mode_get()
14528     * @see elm_list_multi_select_set()
14529     *
14530     * @ingroup List
14531     */
14532    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14533
14534    /**
14535     * Get a value whether always select mode is enabled or not, meaning that
14536     * an item will always call its callback function, even if already selected.
14537     *
14538     * @param obj The list object
14539     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14540     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14541     * @c EINA_FALSE is returned.
14542     *
14543     * @see elm_list_always_select_mode_set() for details.
14544     *
14545     * @ingroup List
14546     */
14547    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14548
14549    /**
14550     * Set bouncing behaviour when the scrolled content reaches an edge.
14551     *
14552     * Tell the internal scroller object whether it should bounce or not
14553     * when it reaches the respective edges for each axis.
14554     *
14555     * @param obj The list object
14556     * @param h_bounce Whether to bounce or not in the horizontal axis.
14557     * @param v_bounce Whether to bounce or not in the vertical axis.
14558     *
14559     * @see elm_scroller_bounce_set()
14560     *
14561     * @ingroup List
14562     */
14563    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14564
14565    /**
14566     * Get the bouncing behaviour of the internal scroller.
14567     *
14568     * Get whether the internal scroller should bounce when the edge of each
14569     * axis is reached scrolling.
14570     *
14571     * @param obj The list object.
14572     * @param h_bounce Pointer where to store the bounce state of the horizontal
14573     * axis.
14574     * @param v_bounce Pointer where to store the bounce state of the vertical
14575     * axis.
14576     *
14577     * @see elm_scroller_bounce_get()
14578     * @see elm_list_bounce_set()
14579     *
14580     * @ingroup List
14581     */
14582    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14583
14584    /**
14585     * Set the scrollbar policy.
14586     *
14587     * @param obj The list object
14588     * @param policy_h Horizontal scrollbar policy.
14589     * @param policy_v Vertical scrollbar policy.
14590     *
14591     * This sets the scrollbar visibility policy for the given scroller.
14592     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14593     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14594     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14595     * This applies respectively for the horizontal and vertical scrollbars.
14596     *
14597     * The both are disabled by default, i.e., are set to
14598     * #ELM_SCROLLER_POLICY_OFF.
14599     *
14600     * @ingroup List
14601     */
14602    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14603
14604    /**
14605     * Get the scrollbar policy.
14606     *
14607     * @see elm_list_scroller_policy_get() for details.
14608     *
14609     * @param obj The list object.
14610     * @param policy_h Pointer where to store horizontal scrollbar policy.
14611     * @param policy_v Pointer where to store vertical scrollbar policy.
14612     *
14613     * @ingroup List
14614     */
14615    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);
14616
14617    /**
14618     * Append a new item to the list object.
14619     *
14620     * @param obj The list object.
14621     * @param label The label of the list item.
14622     * @param icon The icon object to use for the left side of the item. An
14623     * icon can be any Evas object, but usually it is an icon created
14624     * with elm_icon_add().
14625     * @param end The icon object to use for the right side of the item. An
14626     * icon can be any Evas object.
14627     * @param func The function to call when the item is clicked.
14628     * @param data The data to associate with the item for related callbacks.
14629     *
14630     * @return The created item or @c NULL upon failure.
14631     *
14632     * A new item will be created and appended to the list, i.e., will
14633     * be set as @b last item.
14634     *
14635     * Items created with this method can be deleted with
14636     * elm_list_item_del().
14637     *
14638     * Associated @p data can be properly freed when item is deleted if a
14639     * callback function is set with elm_list_item_del_cb_set().
14640     *
14641     * If a function is passed as argument, it will be called everytime this item
14642     * is selected, i.e., the user clicks over an unselected item.
14643     * If always select is enabled it will call this function every time
14644     * user clicks over an item (already selected or not).
14645     * If such function isn't needed, just passing
14646     * @c NULL as @p func is enough. The same should be done for @p data.
14647     *
14648     * Simple example (with no function callback or data associated):
14649     * @code
14650     * li = elm_list_add(win);
14651     * ic = elm_icon_add(win);
14652     * elm_icon_file_set(ic, "path/to/image", NULL);
14653     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14654     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14655     * elm_list_go(li);
14656     * evas_object_show(li);
14657     * @endcode
14658     *
14659     * @see elm_list_always_select_mode_set()
14660     * @see elm_list_item_del()
14661     * @see elm_list_item_del_cb_set()
14662     * @see elm_list_clear()
14663     * @see elm_icon_add()
14664     *
14665     * @ingroup List
14666     */
14667    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);
14668
14669    /**
14670     * Prepend a new item to the list object.
14671     *
14672     * @param obj The list object.
14673     * @param label The label of the list item.
14674     * @param icon The icon object to use for the left side of the item. An
14675     * icon can be any Evas object, but usually it is an icon created
14676     * with elm_icon_add().
14677     * @param end The icon object to use for the right side of the item. An
14678     * icon can be any Evas object.
14679     * @param func The function to call when the item is clicked.
14680     * @param data The data to associate with the item for related callbacks.
14681     *
14682     * @return The created item or @c NULL upon failure.
14683     *
14684     * A new item will be created and prepended to the list, i.e., will
14685     * be set as @b first item.
14686     *
14687     * Items created with this method can be deleted with
14688     * elm_list_item_del().
14689     *
14690     * Associated @p data can be properly freed when item is deleted if a
14691     * callback function is set with elm_list_item_del_cb_set().
14692     *
14693     * If a function is passed as argument, it will be called everytime this item
14694     * is selected, i.e., the user clicks over an unselected item.
14695     * If always select is enabled it will call this function every time
14696     * user clicks over an item (already selected or not).
14697     * If such function isn't needed, just passing
14698     * @c NULL as @p func is enough. The same should be done for @p data.
14699     *
14700     * @see elm_list_item_append() for a simple code example.
14701     * @see elm_list_always_select_mode_set()
14702     * @see elm_list_item_del()
14703     * @see elm_list_item_del_cb_set()
14704     * @see elm_list_clear()
14705     * @see elm_icon_add()
14706     *
14707     * @ingroup List
14708     */
14709    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);
14710
14711    /**
14712     * Insert a new item into the list object before item @p before.
14713     *
14714     * @param obj The list object.
14715     * @param before The list item to insert before.
14716     * @param label The label of the list item.
14717     * @param icon The icon object to use for the left side of the item. An
14718     * icon can be any Evas object, but usually it is an icon created
14719     * with elm_icon_add().
14720     * @param end The icon object to use for the right side of the item. An
14721     * icon can be any Evas object.
14722     * @param func The function to call when the item is clicked.
14723     * @param data The data to associate with the item for related callbacks.
14724     *
14725     * @return The created item or @c NULL upon failure.
14726     *
14727     * A new item will be created and added to the list. Its position in
14728     * this list will be just before item @p before.
14729     *
14730     * Items created with this method can be deleted with
14731     * elm_list_item_del().
14732     *
14733     * Associated @p data can be properly freed when item is deleted if a
14734     * callback function is set with elm_list_item_del_cb_set().
14735     *
14736     * If a function is passed as argument, it will be called everytime this item
14737     * is selected, i.e., the user clicks over an unselected item.
14738     * If always select is enabled it will call this function every time
14739     * user clicks over an item (already selected or not).
14740     * If such function isn't needed, just passing
14741     * @c NULL as @p func is enough. The same should be done for @p data.
14742     *
14743     * @see elm_list_item_append() for a simple code example.
14744     * @see elm_list_always_select_mode_set()
14745     * @see elm_list_item_del()
14746     * @see elm_list_item_del_cb_set()
14747     * @see elm_list_clear()
14748     * @see elm_icon_add()
14749     *
14750     * @ingroup List
14751     */
14752    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);
14753
14754    /**
14755     * Insert a new item into the list object after item @p after.
14756     *
14757     * @param obj The list object.
14758     * @param after The list item to insert after.
14759     * @param label The label of the list item.
14760     * @param icon The icon object to use for the left side of the item. An
14761     * icon can be any Evas object, but usually it is an icon created
14762     * with elm_icon_add().
14763     * @param end The icon object to use for the right side of the item. An
14764     * icon can be any Evas object.
14765     * @param func The function to call when the item is clicked.
14766     * @param data The data to associate with the item for related callbacks.
14767     *
14768     * @return The created item or @c NULL upon failure.
14769     *
14770     * A new item will be created and added to the list. Its position in
14771     * this list will be just after item @p after.
14772     *
14773     * Items created with this method can be deleted with
14774     * elm_list_item_del().
14775     *
14776     * Associated @p data can be properly freed when item is deleted if a
14777     * callback function is set with elm_list_item_del_cb_set().
14778     *
14779     * If a function is passed as argument, it will be called everytime this item
14780     * is selected, i.e., the user clicks over an unselected item.
14781     * If always select is enabled it will call this function every time
14782     * user clicks over an item (already selected or not).
14783     * If such function isn't needed, just passing
14784     * @c NULL as @p func is enough. The same should be done for @p data.
14785     *
14786     * @see elm_list_item_append() for a simple code example.
14787     * @see elm_list_always_select_mode_set()
14788     * @see elm_list_item_del()
14789     * @see elm_list_item_del_cb_set()
14790     * @see elm_list_clear()
14791     * @see elm_icon_add()
14792     *
14793     * @ingroup List
14794     */
14795    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);
14796
14797    /**
14798     * Insert a new item into the sorted list object.
14799     *
14800     * @param obj The list object.
14801     * @param label The label of the list item.
14802     * @param icon The icon object to use for the left side of the item. An
14803     * icon can be any Evas object, but usually it is an icon created
14804     * with elm_icon_add().
14805     * @param end The icon object to use for the right side of the item. An
14806     * icon can be any Evas object.
14807     * @param func The function to call when the item is clicked.
14808     * @param data The data to associate with the item for related callbacks.
14809     * @param cmp_func The comparing function to be used to sort list
14810     * items <b>by #Elm_List_Item item handles</b>. This function will
14811     * receive two items and compare them, returning a non-negative integer
14812     * if the second item should be place after the first, or negative value
14813     * if should be placed before.
14814     *
14815     * @return The created item or @c NULL upon failure.
14816     *
14817     * @note This function inserts values into a list object assuming it was
14818     * sorted and the result will be sorted.
14819     *
14820     * A new item will be created and added to the list. Its position in
14821     * this list will be found comparing the new item with previously inserted
14822     * items using function @p cmp_func.
14823     *
14824     * Items created with this method can be deleted with
14825     * elm_list_item_del().
14826     *
14827     * Associated @p data can be properly freed when item is deleted if a
14828     * callback function is set with elm_list_item_del_cb_set().
14829     *
14830     * If a function is passed as argument, it will be called everytime this item
14831     * is selected, i.e., the user clicks over an unselected item.
14832     * If always select is enabled it will call this function every time
14833     * user clicks over an item (already selected or not).
14834     * If such function isn't needed, just passing
14835     * @c NULL as @p func is enough. The same should be done for @p data.
14836     *
14837     * @see elm_list_item_append() for a simple code example.
14838     * @see elm_list_always_select_mode_set()
14839     * @see elm_list_item_del()
14840     * @see elm_list_item_del_cb_set()
14841     * @see elm_list_clear()
14842     * @see elm_icon_add()
14843     *
14844     * @ingroup List
14845     */
14846    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);
14847
14848    /**
14849     * Remove all list's items.
14850     *
14851     * @param obj The list object
14852     *
14853     * @see elm_list_item_del()
14854     * @see elm_list_item_append()
14855     *
14856     * @ingroup List
14857     */
14858    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14859
14860    /**
14861     * Get a list of all the list items.
14862     *
14863     * @param obj The list object
14864     * @return An @c Eina_List of list items, #Elm_List_Item,
14865     * or @c NULL on failure.
14866     *
14867     * @see elm_list_item_append()
14868     * @see elm_list_item_del()
14869     * @see elm_list_clear()
14870     *
14871     * @ingroup List
14872     */
14873    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14874
14875    /**
14876     * Get the selected item.
14877     *
14878     * @param obj The list object.
14879     * @return The selected list item.
14880     *
14881     * The selected item can be unselected with function
14882     * elm_list_item_selected_set().
14883     *
14884     * The selected item always will be highlighted on list.
14885     *
14886     * @see elm_list_selected_items_get()
14887     *
14888     * @ingroup List
14889     */
14890    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14891
14892    /**
14893     * Return a list of the currently selected list items.
14894     *
14895     * @param obj The list object.
14896     * @return An @c Eina_List of list items, #Elm_List_Item,
14897     * or @c NULL on failure.
14898     *
14899     * Multiple items can be selected if multi select is enabled. It can be
14900     * done with elm_list_multi_select_set().
14901     *
14902     * @see elm_list_selected_item_get()
14903     * @see elm_list_multi_select_set()
14904     *
14905     * @ingroup List
14906     */
14907    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14908
14909    /**
14910     * Set the selected state of an item.
14911     *
14912     * @param item The list item
14913     * @param selected The selected state
14914     *
14915     * This sets the selected state of the given item @p it.
14916     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14917     *
14918     * If a new item is selected the previosly selected will be unselected,
14919     * unless multiple selection is enabled with elm_list_multi_select_set().
14920     * Previoulsy selected item can be get with function
14921     * elm_list_selected_item_get().
14922     *
14923     * Selected items will be highlighted.
14924     *
14925     * @see elm_list_item_selected_get()
14926     * @see elm_list_selected_item_get()
14927     * @see elm_list_multi_select_set()
14928     *
14929     * @ingroup List
14930     */
14931    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14932
14933    /*
14934     * Get whether the @p item is selected or not.
14935     *
14936     * @param item The list item.
14937     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14938     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14939     *
14940     * @see elm_list_selected_item_set() for details.
14941     * @see elm_list_item_selected_get()
14942     *
14943     * @ingroup List
14944     */
14945    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
14946
14947    /**
14948     * Set or unset item as a separator.
14949     *
14950     * @param it The list item.
14951     * @param setting @c EINA_TRUE to set item @p it as separator or
14952     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14953     *
14954     * Items aren't set as separator by default.
14955     *
14956     * If set as separator it will display separator theme, so won't display
14957     * icons or label.
14958     *
14959     * @see elm_list_item_separator_get()
14960     *
14961     * @ingroup List
14962     */
14963    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
14964
14965    /**
14966     * Get a value whether item is a separator or not.
14967     *
14968     * @see elm_list_item_separator_set() for details.
14969     *
14970     * @param it The list item.
14971     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14972     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14973     *
14974     * @ingroup List
14975     */
14976    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
14977
14978    /**
14979     * Show @p item in the list view.
14980     *
14981     * @param item The list item to be shown.
14982     *
14983     * It won't animate list until item is visible. If such behavior is wanted,
14984     * use elm_list_bring_in() intead.
14985     *
14986     * @ingroup List
14987     */
14988    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
14989
14990    /**
14991     * Bring in the given item to list view.
14992     *
14993     * @param item The item.
14994     *
14995     * This causes list to jump to the given item @p item and show it
14996     * (by scrolling), if it is not fully visible.
14997     *
14998     * This may use animation to do so and take a period of time.
14999     *
15000     * If animation isn't wanted, elm_list_item_show() can be used.
15001     *
15002     * @ingroup List
15003     */
15004    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15005
15006    /**
15007     * Delete them item from the list.
15008     *
15009     * @param item The item of list to be deleted.
15010     *
15011     * If deleting all list items is required, elm_list_clear()
15012     * should be used instead of getting items list and deleting each one.
15013     *
15014     * @see elm_list_clear()
15015     * @see elm_list_item_append()
15016     * @see elm_list_item_del_cb_set()
15017     *
15018     * @ingroup List
15019     */
15020    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15021
15022    /**
15023     * Set the function called when a list item is freed.
15024     *
15025     * @param item The item to set the callback on
15026     * @param func The function called
15027     *
15028     * If there is a @p func, then it will be called prior item's memory release.
15029     * That will be called with the following arguments:
15030     * @li item's data;
15031     * @li item's Evas object;
15032     * @li item itself;
15033     *
15034     * This way, a data associated to a list item could be properly freed.
15035     *
15036     * @ingroup List
15037     */
15038    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15039
15040    /**
15041     * Get the data associated to the item.
15042     *
15043     * @param item The list item
15044     * @return The data associated to @p item
15045     *
15046     * The return value is a pointer to data associated to @p item when it was
15047     * created, with function elm_list_item_append() or similar. If no data
15048     * was passed as argument, it will return @c NULL.
15049     *
15050     * @see elm_list_item_append()
15051     *
15052     * @ingroup List
15053     */
15054    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15055
15056    /**
15057     * Get the left side icon associated to the item.
15058     *
15059     * @param item The list item
15060     * @return The left side icon associated to @p item
15061     *
15062     * The return value is a pointer to the icon associated to @p item when
15063     * it was
15064     * created, with function elm_list_item_append() or similar, or later
15065     * with function elm_list_item_icon_set(). If no icon
15066     * was passed as argument, it will return @c NULL.
15067     *
15068     * @see elm_list_item_append()
15069     * @see elm_list_item_icon_set()
15070     *
15071     * @ingroup List
15072     */
15073    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15074
15075    /**
15076     * Set the left side icon associated to the item.
15077     *
15078     * @param item The list item
15079     * @param icon The left side icon object to associate with @p item
15080     *
15081     * The icon object to use at left side of the item. An
15082     * icon can be any Evas object, but usually it is an icon created
15083     * with elm_icon_add().
15084     *
15085     * Once the icon object is set, a previously set one will be deleted.
15086     * @warning Setting the same icon for two items will cause the icon to
15087     * dissapear from the first item.
15088     *
15089     * If an icon was passed as argument on item creation, with function
15090     * elm_list_item_append() or similar, it will be already
15091     * associated to the item.
15092     *
15093     * @see elm_list_item_append()
15094     * @see elm_list_item_icon_get()
15095     *
15096     * @ingroup List
15097     */
15098    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15099
15100    /**
15101     * Get the right side icon associated to the item.
15102     *
15103     * @param item The list item
15104     * @return The right side icon associated to @p item
15105     *
15106     * The return value is a pointer to the icon associated to @p item when
15107     * it was
15108     * created, with function elm_list_item_append() or similar, or later
15109     * with function elm_list_item_icon_set(). If no icon
15110     * was passed as argument, it will return @c NULL.
15111     *
15112     * @see elm_list_item_append()
15113     * @see elm_list_item_icon_set()
15114     *
15115     * @ingroup List
15116     */
15117    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15118
15119    /**
15120     * Set the right side icon associated to the item.
15121     *
15122     * @param item The list item
15123     * @param end The right side icon object to associate with @p item
15124     *
15125     * The icon object to use at right side of the item. An
15126     * icon can be any Evas object, but usually it is an icon created
15127     * with elm_icon_add().
15128     *
15129     * Once the icon object is set, a previously set one will be deleted.
15130     * @warning Setting the same icon for two items will cause the icon to
15131     * dissapear from the first item.
15132     *
15133     * If an icon was passed as argument on item creation, with function
15134     * elm_list_item_append() or similar, it will be already
15135     * associated to the item.
15136     *
15137     * @see elm_list_item_append()
15138     * @see elm_list_item_end_get()
15139     *
15140     * @ingroup List
15141     */
15142    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15143
15144    /**
15145     * Gets the base object of the item.
15146     *
15147     * @param item The list item
15148     * @return The base object associated with @p item
15149     *
15150     * Base object is the @c Evas_Object that represents that item.
15151     *
15152     * @ingroup List
15153     */
15154    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15155
15156    /**
15157     * Get the label of item.
15158     *
15159     * @param item The item of list.
15160     * @return The label of item.
15161     *
15162     * The return value is a pointer to the label associated to @p item when
15163     * it was created, with function elm_list_item_append(), or later
15164     * with function elm_list_item_label_set. If no label
15165     * was passed as argument, it will return @c NULL.
15166     *
15167     * @see elm_list_item_label_set() for more details.
15168     * @see elm_list_item_append()
15169     *
15170     * @ingroup List
15171     */
15172    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15173
15174    /**
15175     * Set the label of item.
15176     *
15177     * @param item The item of list.
15178     * @param text The label of item.
15179     *
15180     * The label to be displayed by the item.
15181     * Label will be placed between left and right side icons (if set).
15182     *
15183     * If a label was passed as argument on item creation, with function
15184     * elm_list_item_append() or similar, it will be already
15185     * displayed by the item.
15186     *
15187     * @see elm_list_item_label_get()
15188     * @see elm_list_item_append()
15189     *
15190     * @ingroup List
15191     */
15192    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15193
15194
15195    /**
15196     * Get the item before @p it in list.
15197     *
15198     * @param it The list item.
15199     * @return The item before @p it, or @c NULL if none or on failure.
15200     *
15201     * @note If it is the first item, @c NULL will be returned.
15202     *
15203     * @see elm_list_item_append()
15204     * @see elm_list_items_get()
15205     *
15206     * @ingroup List
15207     */
15208    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15209
15210    /**
15211     * Get the item after @p it in list.
15212     *
15213     * @param it The list item.
15214     * @return The item after @p it, or @c NULL if none or on failure.
15215     *
15216     * @note If it is the last item, @c NULL will be returned.
15217     *
15218     * @see elm_list_item_append()
15219     * @see elm_list_items_get()
15220     *
15221     * @ingroup List
15222     */
15223    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15224
15225    /**
15226     * Sets the disabled/enabled state of a list item.
15227     *
15228     * @param it The item.
15229     * @param disabled The disabled state.
15230     *
15231     * A disabled item cannot be selected or unselected. It will also
15232     * change its appearance (generally greyed out). This sets the
15233     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15234     * enabled).
15235     *
15236     * @ingroup List
15237     */
15238    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15239
15240    /**
15241     * Get a value whether list item is disabled or not.
15242     *
15243     * @param it The item.
15244     * @return The disabled state.
15245     *
15246     * @see elm_list_item_disabled_set() for more details.
15247     *
15248     * @ingroup List
15249     */
15250    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15251
15252    /**
15253     * Set the text to be shown in a given list item's tooltips.
15254     *
15255     * @param item Target item.
15256     * @param text The text to set in the content.
15257     *
15258     * Setup the text as tooltip to object. The item can have only one tooltip,
15259     * so any previous tooltip data - set with this function or
15260     * elm_list_item_tooltip_content_cb_set() - is removed.
15261     *
15262     * @see elm_object_tooltip_text_set() for more details.
15263     *
15264     * @ingroup List
15265     */
15266    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15267
15268
15269    /**
15270     * @brief Disable size restrictions on an object's tooltip
15271     * @param item The tooltip's anchor object
15272     * @param disable If EINA_TRUE, size restrictions are disabled
15273     * @return EINA_FALSE on failure, EINA_TRUE on success
15274     *
15275     * This function allows a tooltip to expand beyond its parant window's canvas.
15276     * It will instead be limited only by the size of the display.
15277     */
15278    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15279    /**
15280     * @brief Retrieve size restriction state of an object's tooltip
15281     * @param obj The tooltip's anchor object
15282     * @return If EINA_TRUE, size restrictions are disabled
15283     *
15284     * This function returns whether a tooltip is allowed to expand beyond
15285     * its parant window's canvas.
15286     * It will instead be limited only by the size of the display.
15287     */
15288    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15289
15290    /**
15291     * Set the content to be shown in the tooltip item.
15292     *
15293     * Setup the tooltip to item. The item can have only one tooltip,
15294     * so any previous tooltip data is removed. @p func(with @p data) will
15295     * be called every time that need show the tooltip and it should
15296     * return a valid Evas_Object. This object is then managed fully by
15297     * tooltip system and is deleted when the tooltip is gone.
15298     *
15299     * @param item the list item being attached a tooltip.
15300     * @param func the function used to create the tooltip contents.
15301     * @param data what to provide to @a func as callback data/context.
15302     * @param del_cb called when data is not needed anymore, either when
15303     *        another callback replaces @a func, the tooltip is unset with
15304     *        elm_list_item_tooltip_unset() or the owner @a item
15305     *        dies. This callback receives as the first parameter the
15306     *        given @a data, and @c event_info is the item.
15307     *
15308     * @see elm_object_tooltip_content_cb_set() for more details.
15309     *
15310     * @ingroup List
15311     */
15312    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);
15313
15314    /**
15315     * Unset tooltip from item.
15316     *
15317     * @param item list item to remove previously set tooltip.
15318     *
15319     * Remove tooltip from item. The callback provided as del_cb to
15320     * elm_list_item_tooltip_content_cb_set() will be called to notify
15321     * it is not used anymore.
15322     *
15323     * @see elm_object_tooltip_unset() for more details.
15324     * @see elm_list_item_tooltip_content_cb_set()
15325     *
15326     * @ingroup List
15327     */
15328    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15329
15330    /**
15331     * Sets a different style for this item tooltip.
15332     *
15333     * @note before you set a style you should define a tooltip with
15334     *       elm_list_item_tooltip_content_cb_set() or
15335     *       elm_list_item_tooltip_text_set()
15336     *
15337     * @param item list item with tooltip already set.
15338     * @param style the theme style to use (default, transparent, ...)
15339     *
15340     * @see elm_object_tooltip_style_set() for more details.
15341     *
15342     * @ingroup List
15343     */
15344    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15345
15346    /**
15347     * Get the style for this item tooltip.
15348     *
15349     * @param item list item with tooltip already set.
15350     * @return style the theme style in use, defaults to "default". If the
15351     *         object does not have a tooltip set, then NULL is returned.
15352     *
15353     * @see elm_object_tooltip_style_get() for more details.
15354     * @see elm_list_item_tooltip_style_set()
15355     *
15356     * @ingroup List
15357     */
15358    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15359
15360    /**
15361     * Set the type of mouse pointer/cursor decoration to be shown,
15362     * when the mouse pointer is over the given list widget item
15363     *
15364     * @param item list item to customize cursor on
15365     * @param cursor the cursor type's name
15366     *
15367     * This function works analogously as elm_object_cursor_set(), but
15368     * here the cursor's changing area is restricted to the item's
15369     * area, and not the whole widget's. Note that that item cursors
15370     * have precedence over widget cursors, so that a mouse over an
15371     * item with custom cursor set will always show @b that cursor.
15372     *
15373     * If this function is called twice for an object, a previously set
15374     * cursor will be unset on the second call.
15375     *
15376     * @see elm_object_cursor_set()
15377     * @see elm_list_item_cursor_get()
15378     * @see elm_list_item_cursor_unset()
15379     *
15380     * @ingroup List
15381     */
15382    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15383
15384    /*
15385     * Get the type of mouse pointer/cursor decoration set to be shown,
15386     * when the mouse pointer is over the given list widget item
15387     *
15388     * @param item list item with custom cursor set
15389     * @return the cursor type's name or @c NULL, if no custom cursors
15390     * were set to @p item (and on errors)
15391     *
15392     * @see elm_object_cursor_get()
15393     * @see elm_list_item_cursor_set()
15394     * @see elm_list_item_cursor_unset()
15395     *
15396     * @ingroup List
15397     */
15398    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15399
15400    /**
15401     * Unset any custom mouse pointer/cursor decoration set to be
15402     * shown, when the mouse pointer is over the given list widget
15403     * item, thus making it show the @b default cursor again.
15404     *
15405     * @param item a list item
15406     *
15407     * Use this call to undo any custom settings on this item's cursor
15408     * decoration, bringing it back to defaults (no custom style set).
15409     *
15410     * @see elm_object_cursor_unset()
15411     * @see elm_list_item_cursor_set()
15412     *
15413     * @ingroup List
15414     */
15415    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15416
15417    /**
15418     * Set a different @b style for a given custom cursor set for a
15419     * list item.
15420     *
15421     * @param item list item with custom cursor set
15422     * @param style the <b>theme style</b> to use (e.g. @c "default",
15423     * @c "transparent", etc)
15424     *
15425     * This function only makes sense when one is using custom mouse
15426     * cursor decorations <b>defined in a theme file</b>, which can have,
15427     * given a cursor name/type, <b>alternate styles</b> on it. It
15428     * works analogously as elm_object_cursor_style_set(), but here
15429     * applyed only to list item objects.
15430     *
15431     * @warning Before you set a cursor style you should have definen a
15432     *       custom cursor previously on the item, with
15433     *       elm_list_item_cursor_set()
15434     *
15435     * @see elm_list_item_cursor_engine_only_set()
15436     * @see elm_list_item_cursor_style_get()
15437     *
15438     * @ingroup List
15439     */
15440    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15441
15442    /**
15443     * Get the current @b style set for a given list item's custom
15444     * cursor
15445     *
15446     * @param item list item with custom cursor set.
15447     * @return style the cursor style in use. If the object does not
15448     *         have a cursor set, then @c NULL is returned.
15449     *
15450     * @see elm_list_item_cursor_style_set() for more details
15451     *
15452     * @ingroup List
15453     */
15454    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15455
15456    /**
15457     * Set if the (custom)cursor for a given list item should be
15458     * searched in its theme, also, or should only rely on the
15459     * rendering engine.
15460     *
15461     * @param item item with custom (custom) cursor already set on
15462     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15463     * only on those provided by the rendering engine, @c EINA_FALSE to
15464     * have them searched on the widget's theme, as well.
15465     *
15466     * @note This call is of use only if you've set a custom cursor
15467     * for list items, with elm_list_item_cursor_set().
15468     *
15469     * @note By default, cursors will only be looked for between those
15470     * provided by the rendering engine.
15471     *
15472     * @ingroup List
15473     */
15474    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15475
15476    /**
15477     * Get if the (custom) cursor for a given list item is being
15478     * searched in its theme, also, or is only relying on the rendering
15479     * engine.
15480     *
15481     * @param item a list item
15482     * @return @c EINA_TRUE, if cursors are being looked for only on
15483     * those provided by the rendering engine, @c EINA_FALSE if they
15484     * are being searched on the widget's theme, as well.
15485     *
15486     * @see elm_list_item_cursor_engine_only_set(), for more details
15487     *
15488     * @ingroup List
15489     */
15490    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15491
15492    /**
15493     * @}
15494     */
15495
15496    /**
15497     * @defgroup Slider Slider
15498     * @ingroup Elementary
15499     *
15500     * @image html img/widget/slider/preview-00.png
15501     * @image latex img/widget/slider/preview-00.eps width=\textwidth
15502     *
15503     * The slider adds a dragable “slider” widget for selecting the value of
15504     * something within a range.
15505     *
15506     * A slider can be horizontal or vertical. It can contain an Icon and has a
15507     * primary label as well as a units label (that is formatted with floating
15508     * point values and thus accepts a printf-style format string, like
15509     * “%1.2f units”. There is also an indicator string that may be somewhere
15510     * else (like on the slider itself) that also accepts a format string like
15511     * units. Label, Icon Unit and Indicator strings/objects are optional.
15512     *
15513     * A slider may be inverted which means values invert, with high vales being
15514     * on the left or top and low values on the right or bottom (as opposed to
15515     * normally being low on the left or top and high on the bottom and right).
15516     *
15517     * The slider should have its minimum and maximum values set by the
15518     * application with  elm_slider_min_max_set() and value should also be set by
15519     * the application before use with  elm_slider_value_set(). The span of the
15520     * slider is its length (horizontally or vertically). This will be scaled by
15521     * the object or applications scaling factor. At any point code can query the
15522     * slider for its value with elm_slider_value_get().
15523     *
15524     * Smart callbacks one can listen to:
15525     * - "changed" - Whenever the slider value is changed by the user.
15526     * - "slider,drag,start" - dragging the slider indicator around has started.
15527     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15528     * - "delay,changed" - A short time after the value is changed by the user.
15529     * This will be called only when the user stops dragging for
15530     * a very short period or when they release their
15531     * finger/mouse, so it avoids possibly expensive reactions to
15532     * the value change.
15533     *
15534     * Available styles for it:
15535     * - @c "default"
15536     *
15537     * Here is an example on its usage:
15538     * @li @ref slider_example
15539     */
15540
15541    /**
15542     * @addtogroup Slider
15543     * @{
15544     */
15545
15546    /**
15547     * Add a new slider widget to the given parent Elementary
15548     * (container) object.
15549     *
15550     * @param parent The parent object.
15551     * @return a new slider widget handle or @c NULL, on errors.
15552     *
15553     * This function inserts a new slider widget on the canvas.
15554     *
15555     * @ingroup Slider
15556     */
15557    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15558
15559    /**
15560     * Set the label of a given slider widget
15561     *
15562     * @param obj The progress bar object
15563     * @param label The text label string, in UTF-8
15564     *
15565     * @ingroup Slider
15566     * @deprecated use elm_object_text_set() instead.
15567     */
15568    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15569
15570    /**
15571     * Get the label of a given slider widget
15572     *
15573     * @param obj The progressbar object
15574     * @return The text label string, in UTF-8
15575     *
15576     * @ingroup Slider
15577     * @deprecated use elm_object_text_get() instead.
15578     */
15579    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15580
15581    /**
15582     * Set the icon object of the slider object.
15583     *
15584     * @param obj The slider object.
15585     * @param icon The icon object.
15586     *
15587     * On horizontal mode, icon is placed at left, and on vertical mode,
15588     * placed at top.
15589     *
15590     * @note Once the icon object is set, a previously set one will be deleted.
15591     * If you want to keep that old content object, use the
15592     * elm_slider_icon_unset() function.
15593     *
15594     * @warning If the object being set does not have minimum size hints set,
15595     * it won't get properly displayed.
15596     *
15597     * @ingroup Slider
15598     */
15599    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15600
15601    /**
15602     * Unset an icon set on a given slider widget.
15603     *
15604     * @param obj The slider object.
15605     * @return The icon object that was being used, if any was set, or
15606     * @c NULL, otherwise (and on errors).
15607     *
15608     * On horizontal mode, icon is placed at left, and on vertical mode,
15609     * placed at top.
15610     *
15611     * This call will unparent and return the icon object which was set
15612     * for this widget, previously, on success.
15613     *
15614     * @see elm_slider_icon_set() for more details
15615     * @see elm_slider_icon_get()
15616     *
15617     * @ingroup Slider
15618     */
15619    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15620
15621    /**
15622     * Retrieve the icon object set for a given slider widget.
15623     *
15624     * @param obj The slider object.
15625     * @return The icon object's handle, if @p obj had one set, or @c NULL,
15626     * otherwise (and on errors).
15627     *
15628     * On horizontal mode, icon is placed at left, and on vertical mode,
15629     * placed at top.
15630     *
15631     * @see elm_slider_icon_set() for more details
15632     * @see elm_slider_icon_unset()
15633     *
15634     * @ingroup Slider
15635     */
15636    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15637
15638    /**
15639     * Set the end object of the slider object.
15640     *
15641     * @param obj The slider object.
15642     * @param end The end object.
15643     *
15644     * On horizontal mode, end is placed at left, and on vertical mode,
15645     * placed at bottom.
15646     *
15647     * @note Once the icon object is set, a previously set one will be deleted.
15648     * If you want to keep that old content object, use the
15649     * elm_slider_end_unset() function.
15650     *
15651     * @warning If the object being set does not have minimum size hints set,
15652     * it won't get properly displayed.
15653     *
15654     * @ingroup Slider
15655     */
15656    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15657
15658    /**
15659     * Unset an end object set on a given slider widget.
15660     *
15661     * @param obj The slider object.
15662     * @return The end object that was being used, if any was set, or
15663     * @c NULL, otherwise (and on errors).
15664     *
15665     * On horizontal mode, end is placed at left, and on vertical mode,
15666     * placed at bottom.
15667     *
15668     * This call will unparent and return the icon object which was set
15669     * for this widget, previously, on success.
15670     *
15671     * @see elm_slider_end_set() for more details.
15672     * @see elm_slider_end_get()
15673     *
15674     * @ingroup Slider
15675     */
15676    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15677
15678    /**
15679     * Retrieve the end object set for a given slider widget.
15680     *
15681     * @param obj The slider object.
15682     * @return The end object's handle, if @p obj had one set, or @c NULL,
15683     * otherwise (and on errors).
15684     *
15685     * On horizontal mode, icon is placed at right, and on vertical mode,
15686     * placed at bottom.
15687     *
15688     * @see elm_slider_end_set() for more details.
15689     * @see elm_slider_end_unset()
15690     *
15691     * @ingroup Slider
15692     */
15693    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15694
15695    /**
15696     * Set the (exact) length of the bar region of a given slider widget.
15697     *
15698     * @param obj The slider object.
15699     * @param size The length of the slider's bar region.
15700     *
15701     * This sets the minimum width (when in horizontal mode) or height
15702     * (when in vertical mode) of the actual bar area of the slider
15703     * @p obj. This in turn affects the object's minimum size. Use
15704     * this when you're not setting other size hints expanding on the
15705     * given direction (like weight and alignment hints) and you would
15706     * like it to have a specific size.
15707     *
15708     * @note Icon, end, label, indicator and unit text around @p obj
15709     * will require their
15710     * own space, which will make @p obj to require more the @p size,
15711     * actually.
15712     *
15713     * @see elm_slider_span_size_get()
15714     *
15715     * @ingroup Slider
15716     */
15717    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15718
15719    /**
15720     * Get the length set for the bar region of a given slider widget
15721     *
15722     * @param obj The slider object.
15723     * @return The length of the slider's bar region.
15724     *
15725     * If that size was not set previously, with
15726     * elm_slider_span_size_set(), this call will return @c 0.
15727     *
15728     * @ingroup Slider
15729     */
15730    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15731
15732    /**
15733     * Set the format string for the unit label.
15734     *
15735     * @param obj The slider object.
15736     * @param format The format string for the unit display.
15737     *
15738     * Unit label is displayed all the time, if set, after slider's bar.
15739     * In horizontal mode, at right and in vertical mode, at bottom.
15740     *
15741     * If @c NULL, unit label won't be visible. If not it sets the format
15742     * string for the label text. To the label text is provided a floating point
15743     * value, so the label text can display up to 1 floating point value.
15744     * Note that this is optional.
15745     *
15746     * Use a format string such as "%1.2f meters" for example, and it will
15747     * display values like: "3.14 meters" for a value equal to 3.14159.
15748     *
15749     * Default is unit label disabled.
15750     *
15751     * @see elm_slider_indicator_format_get()
15752     *
15753     * @ingroup Slider
15754     */
15755    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
15756
15757    /**
15758     * Get the unit label format of the slider.
15759     *
15760     * @param obj The slider object.
15761     * @return The unit label format string in UTF-8.
15762     *
15763     * Unit label is displayed all the time, if set, after slider's bar.
15764     * In horizontal mode, at right and in vertical mode, at bottom.
15765     *
15766     * @see elm_slider_unit_format_set() for more
15767     * information on how this works.
15768     *
15769     * @ingroup Slider
15770     */
15771    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15772
15773    /**
15774     * Set the format string for the indicator label.
15775     *
15776     * @param obj The slider object.
15777     * @param indicator The format string for the indicator display.
15778     *
15779     * The slider may display its value somewhere else then unit label,
15780     * for example, above the slider knob that is dragged around. This function
15781     * sets the format string used for this.
15782     *
15783     * If @c NULL, indicator label won't be visible. If not it sets the format
15784     * string for the label text. To the label text is provided a floating point
15785     * value, so the label text can display up to 1 floating point value.
15786     * Note that this is optional.
15787     *
15788     * Use a format string such as "%1.2f meters" for example, and it will
15789     * display values like: "3.14 meters" for a value equal to 3.14159.
15790     *
15791     * Default is indicator label disabled.
15792     *
15793     * @see elm_slider_indicator_format_get()
15794     *
15795     * @ingroup Slider
15796     */
15797    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
15798
15799    /**
15800     * Get the indicator label format of the slider.
15801     *
15802     * @param obj The slider object.
15803     * @return The indicator label format string in UTF-8.
15804     *
15805     * The slider may display its value somewhere else then unit label,
15806     * for example, above the slider knob that is dragged around. This function
15807     * gets the format string used for this.
15808     *
15809     * @see elm_slider_indicator_format_set() for more
15810     * information on how this works.
15811     *
15812     * @ingroup Slider
15813     */
15814    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15815
15816    /**
15817     * Set the format function pointer for the indicator label
15818     *
15819     * @param obj The slider object.
15820     * @param func The indicator format function.
15821     * @param free_func The freeing function for the format string.
15822     *
15823     * Set the callback function to format the indicator string.
15824     *
15825     * @see elm_slider_indicator_format_set() for more info on how this works.
15826     *
15827     * @ingroup Slider
15828     */
15829   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);
15830
15831   /**
15832    * Set the format function pointer for the units label
15833    *
15834    * @param obj The slider object.
15835    * @param func The units format function.
15836    * @param free_func The freeing function for the format string.
15837    *
15838    * Set the callback function to format the indicator string.
15839    *
15840    * @see elm_slider_units_format_set() for more info on how this works.
15841    *
15842    * @ingroup Slider
15843    */
15844   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);
15845
15846   /**
15847    * Set the orientation of a given slider widget.
15848    *
15849    * @param obj The slider object.
15850    * @param horizontal Use @c EINA_TRUE to make @p obj to be
15851    * @b horizontal, @c EINA_FALSE to make it @b vertical.
15852    *
15853    * Use this function to change how your slider is to be
15854    * disposed: vertically or horizontally.
15855    *
15856    * By default it's displayed horizontally.
15857    *
15858    * @see elm_slider_horizontal_get()
15859    *
15860    * @ingroup Slider
15861    */
15862    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15863
15864    /**
15865     * Retrieve the orientation of a given slider widget
15866     *
15867     * @param obj The slider object.
15868     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
15869     * @c EINA_FALSE if it's @b vertical (and on errors).
15870     *
15871     * @see elm_slider_horizontal_set() for more details.
15872     *
15873     * @ingroup Slider
15874     */
15875    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15876
15877    /**
15878     * Set the minimum and maximum values for the slider.
15879     *
15880     * @param obj The slider object.
15881     * @param min The minimum value.
15882     * @param max The maximum value.
15883     *
15884     * Define the allowed range of values to be selected by the user.
15885     *
15886     * If actual value is less than @p min, it will be updated to @p min. If it
15887     * is bigger then @p max, will be updated to @p max. Actual value can be
15888     * get with elm_slider_value_get().
15889     *
15890     * By default, min is equal to 0.0, and max is equal to 1.0.
15891     *
15892     * @warning Maximum must be greater than minimum, otherwise behavior
15893     * is undefined.
15894     *
15895     * @see elm_slider_min_max_get()
15896     *
15897     * @ingroup Slider
15898     */
15899    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
15900
15901    /**
15902     * Get the minimum and maximum values of the slider.
15903     *
15904     * @param obj The slider object.
15905     * @param min Pointer where to store the minimum value.
15906     * @param max Pointer where to store the maximum value.
15907     *
15908     * @note If only one value is needed, the other pointer can be passed
15909     * as @c NULL.
15910     *
15911     * @see elm_slider_min_max_set() for details.
15912     *
15913     * @ingroup Slider
15914     */
15915    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
15916
15917    /**
15918     * Set the value the slider displays.
15919     *
15920     * @param obj The slider object.
15921     * @param val The value to be displayed.
15922     *
15923     * Value will be presented on the unit label following format specified with
15924     * elm_slider_unit_format_set() and on indicator with
15925     * elm_slider_indicator_format_set().
15926     *
15927     * @warning The value must to be between min and max values. This values
15928     * are set by elm_slider_min_max_set().
15929     *
15930     * @see elm_slider_value_get()
15931     * @see elm_slider_unit_format_set()
15932     * @see elm_slider_indicator_format_set()
15933     * @see elm_slider_min_max_set()
15934     *
15935     * @ingroup Slider
15936     */
15937    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
15938
15939    /**
15940     * Get the value displayed by the spinner.
15941     *
15942     * @param obj The spinner object.
15943     * @return The value displayed.
15944     *
15945     * @see elm_spinner_value_set() for details.
15946     *
15947     * @ingroup Slider
15948     */
15949    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15950
15951    /**
15952     * Invert a given slider widget's displaying values order
15953     *
15954     * @param obj The slider object.
15955     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
15956     * @c EINA_FALSE to bring it back to default, non-inverted values.
15957     *
15958     * A slider may be @b inverted, in which state it gets its
15959     * values inverted, with high vales being on the left or top and
15960     * low values on the right or bottom, as opposed to normally have
15961     * the low values on the former and high values on the latter,
15962     * respectively, for horizontal and vertical modes.
15963     *
15964     * @see elm_slider_inverted_get()
15965     *
15966     * @ingroup Slider
15967     */
15968    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
15969
15970    /**
15971     * Get whether a given slider widget's displaying values are
15972     * inverted or not.
15973     *
15974     * @param obj The slider object.
15975     * @return @c EINA_TRUE, if @p obj has inverted values,
15976     * @c EINA_FALSE otherwise (and on errors).
15977     *
15978     * @see elm_slider_inverted_set() for more details.
15979     *
15980     * @ingroup Slider
15981     */
15982    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15983
15984    /**
15985     * Set whether to enlarge slider indicator (augmented knob) or not.
15986     *
15987     * @param obj The slider object.
15988     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
15989     * let the knob always at default size.
15990     *
15991     * By default, indicator will be bigger while dragged by the user.
15992     *
15993     * @warning It won't display values set with
15994     * elm_slider_indicator_format_set() if you disable indicator.
15995     *
15996     * @ingroup Slider
15997     */
15998    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
15999
16000    /**
16001     * Get whether a given slider widget's enlarging indicator or not.
16002     *
16003     * @param obj The slider object.
16004     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16005     * @c EINA_FALSE otherwise (and on errors).
16006     *
16007     * @see elm_slider_indicator_show_set() for details.
16008     *
16009     * @ingroup Slider
16010     */
16011    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16012
16013    /**
16014     * @}
16015     */
16016
16017    /**
16018     * @addtogroup Actionslider Actionslider
16019     *
16020     * @image html img/widget/actionslider/preview-00.png
16021     * @image latex img/widget/actionslider/preview-00.eps
16022     *
16023     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16024     * properties. The indicator is the element the user drags to choose a label.
16025     * When the position is set with magnet, when released the indicator will be
16026     * moved to it if it's nearest the magnetized position.
16027     *
16028     * @note By default all positions are set as enabled.
16029     *
16030     * Signals that you can add callbacks for are:
16031     *
16032     * "selected" - when user selects an enabled position (the label is passed
16033     *              as event info)".
16034     * @n
16035     * "pos_changed" - when the indicator reaches any of the positions("left",
16036     *                 "right" or "center").
16037     *
16038     * See an example of actionslider usage @ref actionslider_example_page "here"
16039     * @{
16040     */
16041    typedef enum _Elm_Actionslider_Pos
16042      {
16043         ELM_ACTIONSLIDER_NONE = 0,
16044         ELM_ACTIONSLIDER_LEFT = 1 << 0,
16045         ELM_ACTIONSLIDER_CENTER = 1 << 1,
16046         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16047         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16048      } Elm_Actionslider_Pos;
16049
16050    /**
16051     * Add a new actionslider to the parent.
16052     *
16053     * @param parent The parent object
16054     * @return The new actionslider object or NULL if it cannot be created
16055     */
16056    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16057    /**
16058     * Set actionslider labels.
16059     *
16060     * @param obj The actionslider object
16061     * @param left_label The label to be set on the left.
16062     * @param center_label The label to be set on the center.
16063     * @param right_label The label to be set on the right.
16064     * @deprecated use elm_object_text_set() instead.
16065     */
16066    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);
16067    /**
16068     * Get actionslider labels.
16069     *
16070     * @param obj The actionslider object
16071     * @param left_label A char** to place the left_label of @p obj into.
16072     * @param center_label A char** to place the center_label of @p obj into.
16073     * @param right_label A char** to place the right_label of @p obj into.
16074     * @deprecated use elm_object_text_set() instead.
16075     */
16076    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);
16077    /**
16078     * Get actionslider selected label.
16079     *
16080     * @param obj The actionslider object
16081     * @return The selected label
16082     */
16083    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16084    /**
16085     * Set actionslider indicator position.
16086     *
16087     * @param obj The actionslider object.
16088     * @param pos The position of the indicator.
16089     */
16090    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16091    /**
16092     * Get actionslider indicator position.
16093     *
16094     * @param obj The actionslider object.
16095     * @return The position of the indicator.
16096     */
16097    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16098    /**
16099     * Set actionslider magnet position. To make multiple positions magnets @c or
16100     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16101     *
16102     * @param obj The actionslider object.
16103     * @param pos Bit mask indicating the magnet positions.
16104     */
16105    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16106    /**
16107     * Get actionslider magnet position.
16108     *
16109     * @param obj The actionslider object.
16110     * @return The positions with magnet property.
16111     */
16112    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16113    /**
16114     * Set actionslider enabled position. To set multiple positions as enabled @c or
16115     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16116     *
16117     * @note All the positions are enabled by default.
16118     *
16119     * @param obj The actionslider object.
16120     * @param pos Bit mask indicating the enabled positions.
16121     */
16122    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16123    /**
16124     * Get actionslider enabled position.
16125     *
16126     * @param obj The actionslider object.
16127     * @return The enabled positions.
16128     */
16129    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16130    /**
16131     * Set the label used on the indicator.
16132     *
16133     * @param obj The actionslider object
16134     * @param label The label to be set on the indicator.
16135     * @deprecated use elm_object_text_set() instead.
16136     */
16137    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16138    /**
16139     * Get the label used on the indicator object.
16140     *
16141     * @param obj The actionslider object
16142     * @return The indicator label
16143     * @deprecated use elm_object_text_get() instead.
16144     */
16145    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16146    /**
16147     * @}
16148     */
16149
16150    /**
16151     * @defgroup Genlist Genlist
16152     *
16153     * @image html img/widget/genlist/preview-00.png
16154     * @image latex img/widget/genlist/preview-00.eps
16155     * @image html img/genlist.png
16156     * @image latex img/genlist.eps
16157     *
16158     * This widget aims to have more expansive list than the simple list in
16159     * Elementary that could have more flexible items and allow many more entries
16160     * while still being fast and low on memory usage. At the same time it was
16161     * also made to be able to do tree structures. But the price to pay is more
16162     * complexity when it comes to usage. If all you want is a simple list with
16163     * icons and a single label, use the normal @ref List object.
16164     *
16165     * Genlist has a fairly large API, mostly because it's relatively complex,
16166     * trying to be both expansive, powerful and efficient. First we will begin
16167     * an overview on the theory behind genlist.
16168     *
16169     * @section Genlist_Item_Class Genlist item classes - creating items
16170     *
16171     * In order to have the ability to add and delete items on the fly, genlist
16172     * implements a class (callback) system where the application provides a
16173     * structure with information about that type of item (genlist may contain
16174     * multiple different items with different classes, states and styles).
16175     * Genlist will call the functions in this struct (methods) when an item is
16176     * "realized" (i.e., created dynamically, while the user is scrolling the
16177     * grid). All objects will simply be deleted when no longer needed with
16178     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16179     * following members:
16180     * - @c item_style - This is a constant string and simply defines the name
16181     *   of the item style. It @b must be specified and the default should be @c
16182     *   "default".
16183     * - @c mode_item_style - This is a constant string and simply defines the
16184     *   name of the style that will be used for mode animations. It can be left
16185     *   as @c NULL if you don't plan to use Genlist mode. See
16186     *   elm_genlist_item_mode_set() for more info.
16187     *
16188     * - @c func - A struct with pointers to functions that will be called when
16189     *   an item is going to be actually created. All of them receive a @c data
16190     *   parameter that will point to the same data passed to
16191     *   elm_genlist_item_append() and related item creation functions, and a @c
16192     *   obj parameter that points to the genlist object itself.
16193     *
16194     * The function pointers inside @c func are @c label_get, @c icon_get, @c
16195     * state_get and @c del. The 3 first functions also receive a @c part
16196     * parameter described below. A brief description of these functions follows:
16197     *
16198     * - @c label_get - The @c part parameter is the name string of one of the
16199     *   existing text parts in the Edje group implementing the item's theme.
16200     *   This function @b must return a strdup'()ed string, as the caller will
16201     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16202     * - @c icon_get - The @c part parameter is the name string of one of the
16203     *   existing (icon) swallow parts in the Edje group implementing the item's
16204     *   theme. It must return @c NULL, when no icon is desired, or a valid
16205     *   object handle, otherwise.  The object will be deleted by the genlist on
16206     *   its deletion or when the item is "unrealized".  See
16207     *   #Elm_Genlist_Item_Icon_Get_Cb.
16208     * - @c func.state_get - The @c part parameter is the name string of one of
16209     *   the state parts in the Edje group implementing the item's theme. Return
16210     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16211     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16212     *   and @c "elm" as "emission" and "source" arguments, respectively, when
16213     *   the state is true (the default is false), where @c XXX is the name of
16214     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
16215     * - @c func.del - This is intended for use when genlist items are deleted,
16216     *   so any data attached to the item (e.g. its data parameter on creation)
16217     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
16218     *
16219     * available item styles:
16220     * - default
16221     * - default_style - The text part is a textblock
16222     *
16223     * @image html img/widget/genlist/preview-04.png
16224     * @image latex img/widget/genlist/preview-04.eps
16225     *
16226     * - double_label
16227     *
16228     * @image html img/widget/genlist/preview-01.png
16229     * @image latex img/widget/genlist/preview-01.eps
16230     *
16231     * - icon_top_text_bottom
16232     *
16233     * @image html img/widget/genlist/preview-02.png
16234     * @image latex img/widget/genlist/preview-02.eps
16235     *
16236     * - group_index
16237     *
16238     * @image html img/widget/genlist/preview-03.png
16239     * @image latex img/widget/genlist/preview-03.eps
16240     *
16241     * @section Genlist_Items Structure of items
16242     *
16243     * An item in a genlist can have 0 or more text labels (they can be regular
16244     * text or textblock Evas objects - that's up to the style to determine), 0
16245     * or more icons (which are simply objects swallowed into the genlist item's
16246     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16247     * behavior left to the user to define. The Edje part names for each of
16248     * these properties will be looked up, in the theme file for the genlist,
16249     * under the Edje (string) data items named @c "labels", @c "icons" and @c
16250     * "states", respectively. For each of those properties, if more than one
16251     * part is provided, they must have names listed separated by spaces in the
16252     * data fields. For the default genlist item theme, we have @b one label
16253     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16254     * "elm.swallow.end") and @b no state parts.
16255     *
16256     * A genlist item may be at one of several styles. Elementary provides one
16257     * by default - "default", but this can be extended by system or application
16258     * custom themes/overlays/extensions (see @ref Theme "themes" for more
16259     * details).
16260     *
16261     * @section Genlist_Manipulation Editing and Navigating
16262     *
16263     * Items can be added by several calls. All of them return a @ref
16264     * Elm_Genlist_Item handle that is an internal member inside the genlist.
16265     * They all take a data parameter that is meant to be used for a handle to
16266     * the applications internal data (eg the struct with the original item
16267     * data). The parent parameter is the parent genlist item this belongs to if
16268     * it is a tree or an indexed group, and NULL if there is no parent. The
16269     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16270     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16271     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16272     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
16273     * is set then this item is group index item that is displayed at the top
16274     * until the next group comes. The func parameter is a convenience callback
16275     * that is called when the item is selected and the data parameter will be
16276     * the func_data parameter, obj be the genlist object and event_info will be
16277     * the genlist item.
16278     *
16279     * elm_genlist_item_append() adds an item to the end of the list, or if
16280     * there is a parent, to the end of all the child items of the parent.
16281     * elm_genlist_item_prepend() is the same but adds to the beginning of
16282     * the list or children list. elm_genlist_item_insert_before() inserts at
16283     * item before another item and elm_genlist_item_insert_after() inserts after
16284     * the indicated item.
16285     *
16286     * The application can clear the list with elm_genlist_clear() which deletes
16287     * all the items in the list and elm_genlist_item_del() will delete a specific
16288     * item. elm_genlist_item_subitems_clear() will clear all items that are
16289     * children of the indicated parent item.
16290     *
16291     * To help inspect list items you can jump to the item at the top of the list
16292     * with elm_genlist_first_item_get() which will return the item pointer, and
16293     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16294     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16295     * and previous items respectively relative to the indicated item. Using
16296     * these calls you can walk the entire item list/tree. Note that as a tree
16297     * the items are flattened in the list, so elm_genlist_item_parent_get() will
16298     * let you know which item is the parent (and thus know how to skip them if
16299     * wanted).
16300     *
16301     * @section Genlist_Muti_Selection Multi-selection
16302     *
16303     * If the application wants multiple items to be able to be selected,
16304     * elm_genlist_multi_select_set() can enable this. If the list is
16305     * single-selection only (the default), then elm_genlist_selected_item_get()
16306     * will return the selected item, if any, or NULL I none is selected. If the
16307     * list is multi-select then elm_genlist_selected_items_get() will return a
16308     * list (that is only valid as long as no items are modified (added, deleted,
16309     * selected or unselected)).
16310     *
16311     * @section Genlist_Usage_Hints Usage hints
16312     *
16313     * There are also convenience functions. elm_genlist_item_genlist_get() will
16314     * return the genlist object the item belongs to. elm_genlist_item_show()
16315     * will make the scroller scroll to show that specific item so its visible.
16316     * elm_genlist_item_data_get() returns the data pointer set by the item
16317     * creation functions.
16318     *
16319     * If an item changes (state of boolean changes, label or icons change),
16320     * then use elm_genlist_item_update() to have genlist update the item with
16321     * the new state. Genlist will re-realize the item thus call the functions
16322     * in the _Elm_Genlist_Item_Class for that item.
16323     *
16324     * To programmatically (un)select an item use elm_genlist_item_selected_set().
16325     * To get its selected state use elm_genlist_item_selected_get(). Similarly
16326     * to expand/contract an item and get its expanded state, use
16327     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16328     * again to make an item disabled (unable to be selected and appear
16329     * differently) use elm_genlist_item_disabled_set() to set this and
16330     * elm_genlist_item_disabled_get() to get the disabled state.
16331     *
16332     * In general to indicate how the genlist should expand items horizontally to
16333     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16334     * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16335     * mode means that if items are too wide to fit, the scroller will scroll
16336     * horizontally. Otherwise items are expanded to fill the width of the
16337     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16338     * to the viewport width and limited to that size. This can be combined with
16339     * a different style that uses edjes' ellipsis feature (cutting text off like
16340     * this: "tex...").
16341     *
16342     * Items will only call their selection func and callback when first becoming
16343     * selected. Any further clicks will do nothing, unless you enable always
16344     * select with elm_genlist_always_select_mode_set(). This means even if
16345     * selected, every click will make the selected callbacks be called.
16346     * elm_genlist_no_select_mode_set() will turn off the ability to select
16347     * items entirely and they will neither appear selected nor call selected
16348     * callback functions.
16349     *
16350     * Remember that you can create new styles and add your own theme augmentation
16351     * per application with elm_theme_extension_add(). If you absolutely must
16352     * have a specific style that overrides any theme the user or system sets up
16353     * you can use elm_theme_overlay_add() to add such a file.
16354     *
16355     * @section Genlist_Implementation Implementation
16356     *
16357     * Evas tracks every object you create. Every time it processes an event
16358     * (mouse move, down, up etc.) it needs to walk through objects and find out
16359     * what event that affects. Even worse every time it renders display updates,
16360     * in order to just calculate what to re-draw, it needs to walk through many
16361     * many many objects. Thus, the more objects you keep active, the more
16362     * overhead Evas has in just doing its work. It is advisable to keep your
16363     * active objects to the minimum working set you need. Also remember that
16364     * object creation and deletion carries an overhead, so there is a
16365     * middle-ground, which is not easily determined. But don't keep massive lists
16366     * of objects you can't see or use. Genlist does this with list objects. It
16367     * creates and destroys them dynamically as you scroll around. It groups them
16368     * into blocks so it can determine the visibility etc. of a whole block at
16369     * once as opposed to having to walk the whole list. This 2-level list allows
16370     * for very large numbers of items to be in the list (tests have used up to
16371     * 2,000,000 items). Also genlist employs a queue for adding items. As items
16372     * may be different sizes, every item added needs to be calculated as to its
16373     * size and thus this presents a lot of overhead on populating the list, this
16374     * genlist employs a queue. Any item added is queued and spooled off over
16375     * time, actually appearing some time later, so if your list has many members
16376     * you may find it takes a while for them to all appear, with your process
16377     * consuming a lot of CPU while it is busy spooling.
16378     *
16379     * Genlist also implements a tree structure, but it does so with callbacks to
16380     * the application, with the application filling in tree structures when
16381     * requested (allowing for efficient building of a very deep tree that could
16382     * even be used for file-management). See the above smart signal callbacks for
16383     * details.
16384     *
16385     * @section Genlist_Smart_Events Genlist smart events
16386     *
16387     * Signals that you can add callbacks for are:
16388     * - @c "activated" - The user has double-clicked or pressed
16389     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
16390     *   item that was activated.
16391     * - @c "clicked,double" - The user has double-clicked an item.  The @c
16392     *   event_info parameter is the item that was double-clicked.
16393     * - @c "selected" - This is called when a user has made an item selected.
16394     *   The event_info parameter is the genlist item that was selected.
16395     * - @c "unselected" - This is called when a user has made an item
16396     *   unselected. The event_info parameter is the genlist item that was
16397     *   unselected.
16398     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16399     *   called and the item is now meant to be expanded. The event_info
16400     *   parameter is the genlist item that was indicated to expand.  It is the
16401     *   job of this callback to then fill in the child items.
16402     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16403     *   called and the item is now meant to be contracted. The event_info
16404     *   parameter is the genlist item that was indicated to contract. It is the
16405     *   job of this callback to then delete the child items.
16406     * - @c "expand,request" - This is called when a user has indicated they want
16407     *   to expand a tree branch item. The callback should decide if the item can
16408     *   expand (has any children) and then call elm_genlist_item_expanded_set()
16409     *   appropriately to set the state. The event_info parameter is the genlist
16410     *   item that was indicated to expand.
16411     * - @c "contract,request" - This is called when a user has indicated they
16412     *   want to contract a tree branch item. The callback should decide if the
16413     *   item can contract (has any children) and then call
16414     *   elm_genlist_item_expanded_set() appropriately to set the state. The
16415     *   event_info parameter is the genlist item that was indicated to contract.
16416     * - @c "realized" - This is called when the item in the list is created as a
16417     *   real evas object. event_info parameter is the genlist item that was
16418     *   created. The object may be deleted at any time, so it is up to the
16419     *   caller to not use the object pointer from elm_genlist_item_object_get()
16420     *   in a way where it may point to freed objects.
16421     * - @c "unrealized" - This is called just before an item is unrealized.
16422     *   After this call icon objects provided will be deleted and the item
16423     *   object itself delete or be put into a floating cache.
16424     * - @c "drag,start,up" - This is called when the item in the list has been
16425     *   dragged (not scrolled) up.
16426     * - @c "drag,start,down" - This is called when the item in the list has been
16427     *   dragged (not scrolled) down.
16428     * - @c "drag,start,left" - This is called when the item in the list has been
16429     *   dragged (not scrolled) left.
16430     * - @c "drag,start,right" - This is called when the item in the list has
16431     *   been dragged (not scrolled) right.
16432     * - @c "drag,stop" - This is called when the item in the list has stopped
16433     *   being dragged.
16434     * - @c "drag" - This is called when the item in the list is being dragged.
16435     * - @c "longpressed" - This is called when the item is pressed for a certain
16436     *   amount of time. By default it's 1 second.
16437     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16438     *   the top edge.
16439     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16440     *   until the bottom edge.
16441     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16442     *   until the left edge.
16443     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16444     *   until the right edge.
16445     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16446     *   swiped left.
16447     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16448     *   swiped right.
16449     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16450     *   swiped up.
16451     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16452     *   swiped down.
16453     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16454     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
16455     *   multi-touch pinched in.
16456     * - @c "swipe" - This is called when the genlist is swiped.
16457     *
16458     * @section Genlist_Examples Examples
16459     *
16460     * Here is a list of examples that use the genlist, trying to show some of
16461     * its capabilities:
16462     * - @ref genlist_example_01
16463     * - @ref genlist_example_02
16464     * - @ref genlist_example_03
16465     * - @ref genlist_example_04
16466     * - @ref genlist_example_05
16467     */
16468
16469    /**
16470     * @addtogroup Genlist
16471     * @{
16472     */
16473
16474    /**
16475     * @enum _Elm_Genlist_Item_Flags
16476     * @typedef Elm_Genlist_Item_Flags
16477     *
16478     * Defines if the item is of any special type (has subitems or it's the
16479     * index of a group), or is just a simple item.
16480     *
16481     * @ingroup Genlist
16482     */
16483    typedef enum _Elm_Genlist_Item_Flags
16484      {
16485         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16486         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16487         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16488      } Elm_Genlist_Item_Flags;
16489    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
16490    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16491    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16492    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16493    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. */
16494    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. */
16495    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16496    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16497
16498    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16499    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16500    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16501    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16502
16503    /**
16504     * @struct _Elm_Genlist_Item_Class
16505     *
16506     * Genlist item class definition structs.
16507     *
16508     * This struct contains the style and fetching functions that will define the
16509     * contents of each item.
16510     *
16511     * @see @ref Genlist_Item_Class
16512     */
16513    struct _Elm_Genlist_Item_Class
16514      {
16515         const char                *item_style; /**< style of this class. */
16516         struct
16517           {
16518              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
16519              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
16520              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
16521              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
16522              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
16523           } func;
16524         const char                *mode_item_style;
16525      };
16526
16527    /**
16528     * Add a new genlist widget to the given parent Elementary
16529     * (container) object
16530     *
16531     * @param parent The parent object
16532     * @return a new genlist widget handle or @c NULL, on errors
16533     *
16534     * This function inserts a new genlist widget on the canvas.
16535     *
16536     * @see elm_genlist_item_append()
16537     * @see elm_genlist_item_del()
16538     * @see elm_genlist_clear()
16539     *
16540     * @ingroup Genlist
16541     */
16542    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16543    /**
16544     * Remove all items from a given genlist widget.
16545     *
16546     * @param obj The genlist object
16547     *
16548     * This removes (and deletes) all items in @p obj, leaving it empty.
16549     *
16550     * @see elm_genlist_item_del(), to remove just one item.
16551     *
16552     * @ingroup Genlist
16553     */
16554    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16555    /**
16556     * Enable or disable multi-selection in the genlist
16557     *
16558     * @param obj The genlist object
16559     * @param multi Multi-select enable/disable. Default is disabled.
16560     *
16561     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16562     * the list. This allows more than 1 item to be selected. To retrieve the list
16563     * of selected items, use elm_genlist_selected_items_get().
16564     *
16565     * @see elm_genlist_selected_items_get()
16566     * @see elm_genlist_multi_select_get()
16567     *
16568     * @ingroup Genlist
16569     */
16570    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16571    /**
16572     * Gets if multi-selection in genlist is enabled or disabled.
16573     *
16574     * @param obj The genlist object
16575     * @return Multi-select enabled/disabled
16576     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16577     *
16578     * @see elm_genlist_multi_select_set()
16579     *
16580     * @ingroup Genlist
16581     */
16582    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16583    /**
16584     * This sets the horizontal stretching mode.
16585     *
16586     * @param obj The genlist object
16587     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16588     *
16589     * This sets the mode used for sizing items horizontally. Valid modes
16590     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16591     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16592     * the scroller will scroll horizontally. Otherwise items are expanded
16593     * to fill the width of the viewport of the scroller. If it is
16594     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16595     * limited to that size.
16596     *
16597     * @see elm_genlist_horizontal_get()
16598     *
16599     * @ingroup Genlist
16600     */
16601    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16602    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16603    /**
16604     * Gets the horizontal stretching mode.
16605     *
16606     * @param obj The genlist object
16607     * @return The mode to use
16608     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16609     *
16610     * @see elm_genlist_horizontal_set()
16611     *
16612     * @ingroup Genlist
16613     */
16614    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16615    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16616    /**
16617     * Set the always select mode.
16618     *
16619     * @param obj The genlist object
16620     * @param always_select The always select mode (@c EINA_TRUE = on, @c
16621     * EINA_FALSE = off). Default is @c EINA_FALSE.
16622     *
16623     * Items will only call their selection func and callback when first
16624     * becoming selected. Any further clicks will do nothing, unless you
16625     * enable always select with elm_genlist_always_select_mode_set().
16626     * This means that, even if selected, every click will make the selected
16627     * callbacks be called.
16628     *
16629     * @see elm_genlist_always_select_mode_get()
16630     *
16631     * @ingroup Genlist
16632     */
16633    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16634    /**
16635     * Get the always select mode.
16636     *
16637     * @param obj The genlist object
16638     * @return The always select mode
16639     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16640     *
16641     * @see elm_genlist_always_select_mode_set()
16642     *
16643     * @ingroup Genlist
16644     */
16645    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16646    /**
16647     * Enable/disable the no select mode.
16648     *
16649     * @param obj The genlist object
16650     * @param no_select The no select mode
16651     * (EINA_TRUE = on, EINA_FALSE = off)
16652     *
16653     * This will turn off the ability to select items entirely and they
16654     * will neither appear selected nor call selected callback functions.
16655     *
16656     * @see elm_genlist_no_select_mode_get()
16657     *
16658     * @ingroup Genlist
16659     */
16660    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16661    /**
16662     * Gets whether the no select mode is enabled.
16663     *
16664     * @param obj The genlist object
16665     * @return The no select mode
16666     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16667     *
16668     * @see elm_genlist_no_select_mode_set()
16669     *
16670     * @ingroup Genlist
16671     */
16672    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16673    /**
16674     * Enable/disable compress mode.
16675     *
16676     * @param obj The genlist object
16677     * @param compress The compress mode
16678     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16679     *
16680     * This will enable the compress mode where items are "compressed"
16681     * horizontally to fit the genlist scrollable viewport width. This is
16682     * special for genlist.  Do not rely on
16683     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16684     * work as genlist needs to handle it specially.
16685     *
16686     * @see elm_genlist_compress_mode_get()
16687     *
16688     * @ingroup Genlist
16689     */
16690    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16691    /**
16692     * Get whether the compress mode is enabled.
16693     *
16694     * @param obj The genlist object
16695     * @return The compress mode
16696     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16697     *
16698     * @see elm_genlist_compress_mode_set()
16699     *
16700     * @ingroup Genlist
16701     */
16702    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16703    /**
16704     * Enable/disable height-for-width mode.
16705     *
16706     * @param obj The genlist object
16707     * @param setting The height-for-width mode (@c EINA_TRUE = on,
16708     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16709     *
16710     * With height-for-width mode the item width will be fixed (restricted
16711     * to a minimum of) to the list width when calculating its size in
16712     * order to allow the height to be calculated based on it. This allows,
16713     * for instance, text block to wrap lines if the Edje part is
16714     * configured with "text.min: 0 1".
16715     *
16716     * @note This mode will make list resize slower as it will have to
16717     *       recalculate every item height again whenever the list width
16718     *       changes!
16719     *
16720     * @note When height-for-width mode is enabled, it also enables
16721     *       compress mode (see elm_genlist_compress_mode_set()) and
16722     *       disables homogeneous (see elm_genlist_homogeneous_set()).
16723     *
16724     * @ingroup Genlist
16725     */
16726    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
16727    /**
16728     * Get whether the height-for-width mode is enabled.
16729     *
16730     * @param obj The genlist object
16731     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
16732     * off)
16733     *
16734     * @ingroup Genlist
16735     */
16736    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16737    /**
16738     * Enable/disable horizontal and vertical bouncing effect.
16739     *
16740     * @param obj The genlist object
16741     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
16742     * EINA_FALSE = off). Default is @c EINA_FALSE.
16743     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
16744     * EINA_FALSE = off). Default is @c EINA_TRUE.
16745     *
16746     * This will enable or disable the scroller bouncing effect for the
16747     * genlist. See elm_scroller_bounce_set() for details.
16748     *
16749     * @see elm_scroller_bounce_set()
16750     * @see elm_genlist_bounce_get()
16751     *
16752     * @ingroup Genlist
16753     */
16754    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16755    /**
16756     * Get whether the horizontal and vertical bouncing effect is enabled.
16757     *
16758     * @param obj The genlist object
16759     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
16760     * option is set.
16761     * @param v_bounce Pointer to a bool to receive if the bounce vertically
16762     * option is set.
16763     *
16764     * @see elm_genlist_bounce_set()
16765     *
16766     * @ingroup Genlist
16767     */
16768    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16769    /**
16770     * Enable/disable homogenous mode.
16771     *
16772     * @param obj The genlist object
16773     * @param homogeneous Assume the items within the genlist are of the
16774     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
16775     * EINA_FALSE.
16776     *
16777     * This will enable the homogeneous mode where items are of the same
16778     * height and width so that genlist may do the lazy-loading at its
16779     * maximum (which increases the performance for scrolling the list). This
16780     * implies 'compressed' mode.
16781     *
16782     * @see elm_genlist_compress_mode_set()
16783     * @see elm_genlist_homogeneous_get()
16784     *
16785     * @ingroup Genlist
16786     */
16787    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
16788    /**
16789     * Get whether the homogenous mode is enabled.
16790     *
16791     * @param obj The genlist object
16792     * @return Assume the items within the genlist are of the same height
16793     * and width (EINA_TRUE = on, EINA_FALSE = off)
16794     *
16795     * @see elm_genlist_homogeneous_set()
16796     *
16797     * @ingroup Genlist
16798     */
16799    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16800    /**
16801     * Set the maximum number of items within an item block
16802     *
16803     * @param obj The genlist object
16804     * @param n   Maximum number of items within an item block. Default is 32.
16805     *
16806     * This will configure the block count to tune to the target with
16807     * particular performance matrix.
16808     *
16809     * A block of objects will be used to reduce the number of operations due to
16810     * many objects in the screen. It can determine the visibility, or if the
16811     * object has changed, it theme needs to be updated, etc. doing this kind of
16812     * calculation to the entire block, instead of per object.
16813     *
16814     * The default value for the block count is enough for most lists, so unless
16815     * you know you will have a lot of objects visible in the screen at the same
16816     * time, don't try to change this.
16817     *
16818     * @see elm_genlist_block_count_get()
16819     * @see @ref Genlist_Implementation
16820     *
16821     * @ingroup Genlist
16822     */
16823    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
16824    /**
16825     * Get the maximum number of items within an item block
16826     *
16827     * @param obj The genlist object
16828     * @return Maximum number of items within an item block
16829     *
16830     * @see elm_genlist_block_count_set()
16831     *
16832     * @ingroup Genlist
16833     */
16834    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16835    /**
16836     * Set the timeout in seconds for the longpress event.
16837     *
16838     * @param obj The genlist object
16839     * @param timeout timeout in seconds. Default is 1.
16840     *
16841     * This option will change how long it takes to send an event "longpressed"
16842     * after the mouse down signal is sent to the list. If this event occurs, no
16843     * "clicked" event will be sent.
16844     *
16845     * @see elm_genlist_longpress_timeout_set()
16846     *
16847     * @ingroup Genlist
16848     */
16849    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
16850    /**
16851     * Get the timeout in seconds for the longpress event.
16852     *
16853     * @param obj The genlist object
16854     * @return timeout in seconds
16855     *
16856     * @see elm_genlist_longpress_timeout_get()
16857     *
16858     * @ingroup Genlist
16859     */
16860    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16861    /**
16862     * Append a new item in a given genlist widget.
16863     *
16864     * @param obj The genlist object
16865     * @param itc The item class for the item
16866     * @param data The item data
16867     * @param parent The parent item, or NULL if none
16868     * @param flags Item flags
16869     * @param func Convenience function called when the item is selected
16870     * @param func_data Data passed to @p func above.
16871     * @return A handle to the item added or @c NULL if not possible
16872     *
16873     * This adds the given item to the end of the list or the end of
16874     * the children list if the @p parent is given.
16875     *
16876     * @see elm_genlist_item_prepend()
16877     * @see elm_genlist_item_insert_before()
16878     * @see elm_genlist_item_insert_after()
16879     * @see elm_genlist_item_del()
16880     *
16881     * @ingroup Genlist
16882     */
16883    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);
16884    /**
16885     * Prepend a new item in a given genlist widget.
16886     *
16887     * @param obj The genlist object
16888     * @param itc The item class for the item
16889     * @param data The item data
16890     * @param parent The parent item, or NULL if none
16891     * @param flags Item flags
16892     * @param func Convenience function called when the item is selected
16893     * @param func_data Data passed to @p func above.
16894     * @return A handle to the item added or NULL if not possible
16895     *
16896     * This adds an item to the beginning of the list or beginning of the
16897     * children of the parent if given.
16898     *
16899     * @see elm_genlist_item_append()
16900     * @see elm_genlist_item_insert_before()
16901     * @see elm_genlist_item_insert_after()
16902     * @see elm_genlist_item_del()
16903     *
16904     * @ingroup Genlist
16905     */
16906    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);
16907    /**
16908     * Insert an item before another in a genlist widget
16909     *
16910     * @param obj The genlist object
16911     * @param itc The item class for the item
16912     * @param data The item data
16913     * @param before The item to place this new one before.
16914     * @param flags Item flags
16915     * @param func Convenience function called when the item is selected
16916     * @param func_data Data passed to @p func above.
16917     * @return A handle to the item added or @c NULL if not possible
16918     *
16919     * This inserts an item before another in the list. It will be in the
16920     * same tree level or group as the item it is inserted before.
16921     *
16922     * @see elm_genlist_item_append()
16923     * @see elm_genlist_item_prepend()
16924     * @see elm_genlist_item_insert_after()
16925     * @see elm_genlist_item_del()
16926     *
16927     * @ingroup Genlist
16928     */
16929    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);
16930    /**
16931     * Insert an item after another in a genlist widget
16932     *
16933     * @param obj The genlist object
16934     * @param itc The item class for the item
16935     * @param data The item data
16936     * @param after The item to place this new one after.
16937     * @param flags Item flags
16938     * @param func Convenience function called when the item is selected
16939     * @param func_data Data passed to @p func above.
16940     * @return A handle to the item added or @c NULL if not possible
16941     *
16942     * This inserts an item after another in the list. It will be in the
16943     * same tree level or group as the item it is inserted after.
16944     *
16945     * @see elm_genlist_item_append()
16946     * @see elm_genlist_item_prepend()
16947     * @see elm_genlist_item_insert_before()
16948     * @see elm_genlist_item_del()
16949     *
16950     * @ingroup Genlist
16951     */
16952    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);
16953    /**
16954     * Insert a new item into the sorted genlist object
16955     *
16956     * @param obj The genlist object
16957     * @param itc The item class for the item
16958     * @param data The item data
16959     * @param parent The parent item, or NULL if none
16960     * @param flags Item flags
16961     * @param comp The function called for the sort
16962     * @param func Convenience function called when item selected
16963     * @param func_data Data passed to @p func above.
16964     * @return A handle to the item added or NULL if not possible
16965     *
16966     * @ingroup Genlist
16967     */
16968    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);
16969    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);
16970    /* operations to retrieve existing items */
16971    /**
16972     * Get the selectd item in the genlist.
16973     *
16974     * @param obj The genlist object
16975     * @return The selected item, or NULL if none is selected.
16976     *
16977     * This gets the selected item in the list (if multi-selection is enabled, only
16978     * the item that was first selected in the list is returned - which is not very
16979     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
16980     * used).
16981     *
16982     * If no item is selected, NULL is returned.
16983     *
16984     * @see elm_genlist_selected_items_get()
16985     *
16986     * @ingroup Genlist
16987     */
16988    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16989    /**
16990     * Get a list of selected items in the genlist.
16991     *
16992     * @param obj The genlist object
16993     * @return The list of selected items, or NULL if none are selected.
16994     *
16995     * It returns a list of the selected items. This list pointer is only valid so
16996     * long as the selection doesn't change (no items are selected or unselected, or
16997     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
16998     * pointers. The order of the items in this list is the order which they were
16999     * selected, i.e. the first item in this list is the first item that was
17000     * selected, and so on.
17001     *
17002     * @note If not in multi-select mode, consider using function
17003     * elm_genlist_selected_item_get() instead.
17004     *
17005     * @see elm_genlist_multi_select_set()
17006     * @see elm_genlist_selected_item_get()
17007     *
17008     * @ingroup Genlist
17009     */
17010    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17011    /**
17012     * Get a list of realized items in genlist
17013     *
17014     * @param obj The genlist object
17015     * @return The list of realized items, nor NULL if none are realized.
17016     *
17017     * This returns a list of the realized items in the genlist. The list
17018     * contains Elm_Genlist_Item pointers. The list must be freed by the
17019     * caller when done with eina_list_free(). The item pointers in the
17020     * list are only valid so long as those items are not deleted or the
17021     * genlist is not deleted.
17022     *
17023     * @see elm_genlist_realized_items_update()
17024     *
17025     * @ingroup Genlist
17026     */
17027    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17028    /**
17029     * Get the item that is at the x, y canvas coords.
17030     *
17031     * @param obj The gelinst object.
17032     * @param x The input x coordinate
17033     * @param y The input y coordinate
17034     * @param posret The position relative to the item returned here
17035     * @return The item at the coordinates or NULL if none
17036     *
17037     * This returns the item at the given coordinates (which are canvas
17038     * relative, not object-relative). If an item is at that coordinate,
17039     * that item handle is returned, and if @p posret is not NULL, the
17040     * integer pointed to is set to a value of -1, 0 or 1, depending if
17041     * the coordinate is on the upper portion of that item (-1), on the
17042     * middle section (0) or on the lower part (1). If NULL is returned as
17043     * an item (no item found there), then posret may indicate -1 or 1
17044     * based if the coordinate is above or below all items respectively in
17045     * the genlist.
17046     *
17047     * @ingroup Genlist
17048     */
17049    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);
17050    /**
17051     * Get the first item in the genlist
17052     *
17053     * This returns the first item in the list.
17054     *
17055     * @param obj The genlist object
17056     * @return The first item, or NULL if none
17057     *
17058     * @ingroup Genlist
17059     */
17060    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17061    /**
17062     * Get the last item in the genlist
17063     *
17064     * This returns the last item in the list.
17065     *
17066     * @return The last item, or NULL if none
17067     *
17068     * @ingroup Genlist
17069     */
17070    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17071    /**
17072     * Set the scrollbar policy
17073     *
17074     * @param obj The genlist object
17075     * @param policy_h Horizontal scrollbar policy.
17076     * @param policy_v Vertical scrollbar policy.
17077     *
17078     * This sets the scrollbar visibility policy for the given genlist
17079     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17080     * made visible if it is needed, and otherwise kept hidden.
17081     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17082     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17083     * respectively for the horizontal and vertical scrollbars. Default is
17084     * #ELM_SMART_SCROLLER_POLICY_AUTO
17085     *
17086     * @see elm_genlist_scroller_policy_get()
17087     *
17088     * @ingroup Genlist
17089     */
17090    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17091    /**
17092     * Get the scrollbar policy
17093     *
17094     * @param obj The genlist object
17095     * @param policy_h Pointer to store the horizontal scrollbar policy.
17096     * @param policy_v Pointer to store the vertical scrollbar policy.
17097     *
17098     * @see elm_genlist_scroller_policy_set()
17099     *
17100     * @ingroup Genlist
17101     */
17102    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);
17103    /**
17104     * Get the @b next item in a genlist widget's internal list of items,
17105     * given a handle to one of those items.
17106     *
17107     * @param item The genlist item to fetch next from
17108     * @return The item after @p item, or @c NULL if there's none (and
17109     * on errors)
17110     *
17111     * This returns the item placed after the @p item, on the container
17112     * genlist.
17113     *
17114     * @see elm_genlist_item_prev_get()
17115     *
17116     * @ingroup Genlist
17117     */
17118    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17119    /**
17120     * Get the @b previous item in a genlist widget's internal list of items,
17121     * given a handle to one of those items.
17122     *
17123     * @param item The genlist item to fetch previous from
17124     * @return The item before @p item, or @c NULL if there's none (and
17125     * on errors)
17126     *
17127     * This returns the item placed before the @p item, on the container
17128     * genlist.
17129     *
17130     * @see elm_genlist_item_next_get()
17131     *
17132     * @ingroup Genlist
17133     */
17134    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17135    /**
17136     * Get the genlist object's handle which contains a given genlist
17137     * item
17138     *
17139     * @param item The item to fetch the container from
17140     * @return The genlist (parent) object
17141     *
17142     * This returns the genlist object itself that an item belongs to.
17143     *
17144     * @ingroup Genlist
17145     */
17146    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17147    /**
17148     * Get the parent item of the given item
17149     *
17150     * @param it The item
17151     * @return The parent of the item or @c NULL if it has no parent.
17152     *
17153     * This returns the item that was specified as parent of the item @p it on
17154     * elm_genlist_item_append() and insertion related functions.
17155     *
17156     * @ingroup Genlist
17157     */
17158    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17159    /**
17160     * Remove all sub-items (children) of the given item
17161     *
17162     * @param it The item
17163     *
17164     * This removes all items that are children (and their descendants) of the
17165     * given item @p it.
17166     *
17167     * @see elm_genlist_clear()
17168     * @see elm_genlist_item_del()
17169     *
17170     * @ingroup Genlist
17171     */
17172    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17173    /**
17174     * Set whether a given genlist item is selected or not
17175     *
17176     * @param it The item
17177     * @param selected Use @c EINA_TRUE, to make it selected, @c
17178     * EINA_FALSE to make it unselected
17179     *
17180     * This sets the selected state of an item. If multi selection is
17181     * not enabled on the containing genlist and @p selected is @c
17182     * EINA_TRUE, any other previously selected items will get
17183     * unselected in favor of this new one.
17184     *
17185     * @see elm_genlist_item_selected_get()
17186     *
17187     * @ingroup Genlist
17188     */
17189    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17190    /**
17191     * Get whether a given genlist item is selected or not
17192     *
17193     * @param it The item
17194     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17195     *
17196     * @see elm_genlist_item_selected_set() for more details
17197     *
17198     * @ingroup Genlist
17199     */
17200    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17201    /**
17202     * Sets the expanded state of an item.
17203     *
17204     * @param it The item
17205     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17206     *
17207     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17208     * expanded or not.
17209     *
17210     * The theme will respond to this change visually, and a signal "expanded" or
17211     * "contracted" will be sent from the genlist with a pointer to the item that
17212     * has been expanded/contracted.
17213     *
17214     * Calling this function won't show or hide any child of this item (if it is
17215     * a parent). You must manually delete and create them on the callbacks fo
17216     * the "expanded" or "contracted" signals.
17217     *
17218     * @see elm_genlist_item_expanded_get()
17219     *
17220     * @ingroup Genlist
17221     */
17222    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17223    /**
17224     * Get the expanded state of an item
17225     *
17226     * @param it The item
17227     * @return The expanded state
17228     *
17229     * This gets the expanded state of an item.
17230     *
17231     * @see elm_genlist_item_expanded_set()
17232     *
17233     * @ingroup Genlist
17234     */
17235    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17236    /**
17237     * Get the depth of expanded item
17238     *
17239     * @param it The genlist item object
17240     * @return The depth of expanded item
17241     *
17242     * @ingroup Genlist
17243     */
17244    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17245    /**
17246     * Set whether a given genlist item is disabled or not.
17247     *
17248     * @param it The item
17249     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17250     * to enable it back.
17251     *
17252     * A disabled item cannot be selected or unselected. It will also
17253     * change its appearance, to signal the user it's disabled.
17254     *
17255     * @see elm_genlist_item_disabled_get()
17256     *
17257     * @ingroup Genlist
17258     */
17259    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17260    /**
17261     * Get whether a given genlist item is disabled or not.
17262     *
17263     * @param it The item
17264     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17265     * (and on errors).
17266     *
17267     * @see elm_genlist_item_disabled_set() for more details
17268     *
17269     * @ingroup Genlist
17270     */
17271    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17272    /**
17273     * Sets the display only state of an item.
17274     *
17275     * @param it The item
17276     * @param display_only @c EINA_TRUE if the item is display only, @c
17277     * EINA_FALSE otherwise.
17278     *
17279     * A display only item cannot be selected or unselected. It is for
17280     * display only and not selecting or otherwise clicking, dragging
17281     * etc. by the user, thus finger size rules will not be applied to
17282     * this item.
17283     *
17284     * It's good to set group index items to display only state.
17285     *
17286     * @see elm_genlist_item_display_only_get()
17287     *
17288     * @ingroup Genlist
17289     */
17290    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17291    /**
17292     * Get the display only state of an item
17293     *
17294     * @param it The item
17295     * @return @c EINA_TRUE if the item is display only, @c
17296     * EINA_FALSE otherwise.
17297     *
17298     * @see elm_genlist_item_display_only_set()
17299     *
17300     * @ingroup Genlist
17301     */
17302    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17303    /**
17304     * Show the portion of a genlist's internal list containing a given
17305     * item, immediately.
17306     *
17307     * @param it The item to display
17308     *
17309     * This causes genlist to jump to the given item @p it and show it (by
17310     * immediately scrolling to that position), if it is not fully visible.
17311     *
17312     * @see elm_genlist_item_bring_in()
17313     * @see elm_genlist_item_top_show()
17314     * @see elm_genlist_item_middle_show()
17315     *
17316     * @ingroup Genlist
17317     */
17318    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17319    /**
17320     * Animatedly bring in, to the visible are of a genlist, a given
17321     * item on it.
17322     *
17323     * @param it The item to display
17324     *
17325     * This causes genlist to jump to the given item @p it and show it (by
17326     * animatedly scrolling), if it is not fully visible. This may use animation
17327     * to do so and take a period of time
17328     *
17329     * @see elm_genlist_item_show()
17330     * @see elm_genlist_item_top_bring_in()
17331     * @see elm_genlist_item_middle_bring_in()
17332     *
17333     * @ingroup Genlist
17334     */
17335    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17336    /**
17337     * Show the portion of a genlist's internal list containing a given
17338     * item, immediately.
17339     *
17340     * @param it The item to display
17341     *
17342     * This causes genlist to jump to the given item @p it and show it (by
17343     * immediately scrolling to that position), if it is not fully visible.
17344     *
17345     * The item will be positioned at the top of the genlist viewport.
17346     *
17347     * @see elm_genlist_item_show()
17348     * @see elm_genlist_item_top_bring_in()
17349     *
17350     * @ingroup Genlist
17351     */
17352    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17353    /**
17354     * Animatedly bring in, to the visible are of a genlist, a given
17355     * item on it.
17356     *
17357     * @param it The item
17358     *
17359     * This causes genlist to jump to the given item @p it and show it (by
17360     * animatedly scrolling), if it is not fully visible. This may use animation
17361     * to do so and take a period of time
17362     *
17363     * The item will be positioned at the top of the genlist viewport.
17364     *
17365     * @see elm_genlist_item_bring_in()
17366     * @see elm_genlist_item_top_show()
17367     *
17368     * @ingroup Genlist
17369     */
17370    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17371    /**
17372     * Show the portion of a genlist's internal list containing a given
17373     * item, immediately.
17374     *
17375     * @param it The item to display
17376     *
17377     * This causes genlist to jump to the given item @p it and show it (by
17378     * immediately scrolling to that position), if it is not fully visible.
17379     *
17380     * The item will be positioned at the middle of the genlist viewport.
17381     *
17382     * @see elm_genlist_item_show()
17383     * @see elm_genlist_item_middle_bring_in()
17384     *
17385     * @ingroup Genlist
17386     */
17387    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17388    /**
17389     * Animatedly bring in, to the visible are of a genlist, a given
17390     * item on it.
17391     *
17392     * @param it The item
17393     *
17394     * This causes genlist to jump to the given item @p it and show it (by
17395     * animatedly scrolling), if it is not fully visible. This may use animation
17396     * to do so and take a period of time
17397     *
17398     * The item will be positioned at the middle of the genlist viewport.
17399     *
17400     * @see elm_genlist_item_bring_in()
17401     * @see elm_genlist_item_middle_show()
17402     *
17403     * @ingroup Genlist
17404     */
17405    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17406    /**
17407     * Remove a genlist item from the its parent, deleting it.
17408     *
17409     * @param item The item to be removed.
17410     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17411     *
17412     * @see elm_genlist_clear(), to remove all items in a genlist at
17413     * once.
17414     *
17415     * @ingroup Genlist
17416     */
17417    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17418    /**
17419     * Return the data associated to a given genlist item
17420     *
17421     * @param item The genlist item.
17422     * @return the data associated to this item.
17423     *
17424     * This returns the @c data value passed on the
17425     * elm_genlist_item_append() and related item addition calls.
17426     *
17427     * @see elm_genlist_item_append()
17428     * @see elm_genlist_item_data_set()
17429     *
17430     * @ingroup Genlist
17431     */
17432    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17433    /**
17434     * Set the data associated to a given genlist item
17435     *
17436     * @param item The genlist item
17437     * @param data The new data pointer to set on it
17438     *
17439     * This @b overrides the @c data value passed on the
17440     * elm_genlist_item_append() and related item addition calls. This
17441     * function @b won't call elm_genlist_item_update() automatically,
17442     * so you'd issue it afterwards if you want to hove the item
17443     * updated to reflect the that new data.
17444     *
17445     * @see elm_genlist_item_data_get()
17446     *
17447     * @ingroup Genlist
17448     */
17449    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17450    /**
17451     * Tells genlist to "orphan" icons fetchs by the item class
17452     *
17453     * @param it The item
17454     *
17455     * This instructs genlist to release references to icons in the item,
17456     * meaning that they will no longer be managed by genlist and are
17457     * floating "orphans" that can be re-used elsewhere if the user wants
17458     * to.
17459     *
17460     * @ingroup Genlist
17461     */
17462    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17463    /**
17464     * Get the real Evas object created to implement the view of a
17465     * given genlist item
17466     *
17467     * @param item The genlist item.
17468     * @return the Evas object implementing this item's view.
17469     *
17470     * This returns the actual Evas object used to implement the
17471     * specified genlist item's view. This may be @c NULL, as it may
17472     * not have been created or may have been deleted, at any time, by
17473     * the genlist. <b>Do not modify this object</b> (move, resize,
17474     * show, hide, etc.), as the genlist is controlling it. This
17475     * function is for querying, emitting custom signals or hooking
17476     * lower level callbacks for events on that object. Do not delete
17477     * this object under any circumstances.
17478     *
17479     * @see elm_genlist_item_data_get()
17480     *
17481     * @ingroup Genlist
17482     */
17483    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17484    /**
17485     * Update the contents of an item
17486     *
17487     * @param it The item
17488     *
17489     * This updates an item by calling all the item class functions again
17490     * to get the icons, labels and states. Use this when the original
17491     * item data has changed and the changes are desired to be reflected.
17492     *
17493     * Use elm_genlist_realized_items_update() to update all already realized
17494     * items.
17495     *
17496     * @see elm_genlist_realized_items_update()
17497     *
17498     * @ingroup Genlist
17499     */
17500    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17501    /**
17502     * Update the item class of an item
17503     *
17504     * @param it The item
17505     * @param itc The item class for the item
17506     *
17507     * This sets another class fo the item, changing the way that it is
17508     * displayed. After changing the item class, elm_genlist_item_update() is
17509     * called on the item @p it.
17510     *
17511     * @ingroup Genlist
17512     */
17513    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17514    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17515    /**
17516     * Set the text to be shown in a given genlist item's tooltips.
17517     *
17518     * @param item The genlist item
17519     * @param text The text to set in the content
17520     *
17521     * This call will setup the text to be used as tooltip to that item
17522     * (analogous to elm_object_tooltip_text_set(), but being item
17523     * tooltips with higher precedence than object tooltips). It can
17524     * have only one tooltip at a time, so any previous tooltip data
17525     * will get removed.
17526     *
17527     * In order to set an icon or something else as a tooltip, look at
17528     * elm_genlist_item_tooltip_content_cb_set().
17529     *
17530     * @ingroup Genlist
17531     */
17532    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17533    /**
17534     * Set the content to be shown in a given genlist item's tooltips
17535     *
17536     * @param item The genlist item.
17537     * @param func The function returning the tooltip contents.
17538     * @param data What to provide to @a func as callback data/context.
17539     * @param del_cb Called when data is not needed anymore, either when
17540     *        another callback replaces @p func, the tooltip is unset with
17541     *        elm_genlist_item_tooltip_unset() or the owner @p item
17542     *        dies. This callback receives as its first parameter the
17543     *        given @p data, being @c event_info the item handle.
17544     *
17545     * This call will setup the tooltip's contents to @p item
17546     * (analogous to elm_object_tooltip_content_cb_set(), but being
17547     * item tooltips with higher precedence than object tooltips). It
17548     * can have only one tooltip at a time, so any previous tooltip
17549     * content will get removed. @p func (with @p data) will be called
17550     * every time Elementary needs to show the tooltip and it should
17551     * return a valid Evas object, which will be fully managed by the
17552     * tooltip system, getting deleted when the tooltip is gone.
17553     *
17554     * In order to set just a text as a tooltip, look at
17555     * elm_genlist_item_tooltip_text_set().
17556     *
17557     * @ingroup Genlist
17558     */
17559    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);
17560    /**
17561     * Unset a tooltip from a given genlist item
17562     *
17563     * @param item genlist item to remove a previously set tooltip from.
17564     *
17565     * This call removes any tooltip set on @p item. The callback
17566     * provided as @c del_cb to
17567     * elm_genlist_item_tooltip_content_cb_set() will be called to
17568     * notify it is not used anymore (and have resources cleaned, if
17569     * need be).
17570     *
17571     * @see elm_genlist_item_tooltip_content_cb_set()
17572     *
17573     * @ingroup Genlist
17574     */
17575    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17576    /**
17577     * Set a different @b style for a given genlist item's tooltip.
17578     *
17579     * @param item genlist item with tooltip set
17580     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17581     * "default", @c "transparent", etc)
17582     *
17583     * Tooltips can have <b>alternate styles</b> to be displayed on,
17584     * which are defined by the theme set on Elementary. This function
17585     * works analogously as elm_object_tooltip_style_set(), but here
17586     * applied only to genlist item objects. The default style for
17587     * tooltips is @c "default".
17588     *
17589     * @note before you set a style you should define a tooltip with
17590     *       elm_genlist_item_tooltip_content_cb_set() or
17591     *       elm_genlist_item_tooltip_text_set()
17592     *
17593     * @see elm_genlist_item_tooltip_style_get()
17594     *
17595     * @ingroup Genlist
17596     */
17597    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17598    /**
17599     * Get the style set a given genlist item's tooltip.
17600     *
17601     * @param item genlist item with tooltip already set on.
17602     * @return style the theme style in use, which defaults to
17603     *         "default". If the object does not have a tooltip set,
17604     *         then @c NULL is returned.
17605     *
17606     * @see elm_genlist_item_tooltip_style_set() for more details
17607     *
17608     * @ingroup Genlist
17609     */
17610    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17611    /**
17612     * @brief Disable size restrictions on an object's tooltip
17613     * @param item The tooltip's anchor object
17614     * @param disable If EINA_TRUE, size restrictions are disabled
17615     * @return EINA_FALSE on failure, EINA_TRUE on success
17616     *
17617     * This function allows a tooltip to expand beyond its parant window's canvas.
17618     * It will instead be limited only by the size of the display.
17619     */
17620    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17621    /**
17622     * @brief Retrieve size restriction state of an object's tooltip
17623     * @param item The tooltip's anchor object
17624     * @return If EINA_TRUE, size restrictions are disabled
17625     *
17626     * This function returns whether a tooltip is allowed to expand beyond
17627     * its parant window's canvas.
17628     * It will instead be limited only by the size of the display.
17629     */
17630    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17631    /**
17632     * Set the type of mouse pointer/cursor decoration to be shown,
17633     * when the mouse pointer is over the given genlist widget item
17634     *
17635     * @param item genlist item to customize cursor on
17636     * @param cursor the cursor type's name
17637     *
17638     * This function works analogously as elm_object_cursor_set(), but
17639     * here the cursor's changing area is restricted to the item's
17640     * area, and not the whole widget's. Note that that item cursors
17641     * have precedence over widget cursors, so that a mouse over @p
17642     * item will always show cursor @p type.
17643     *
17644     * If this function is called twice for an object, a previously set
17645     * cursor will be unset on the second call.
17646     *
17647     * @see elm_object_cursor_set()
17648     * @see elm_genlist_item_cursor_get()
17649     * @see elm_genlist_item_cursor_unset()
17650     *
17651     * @ingroup Genlist
17652     */
17653    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17654    /**
17655     * Get the type of mouse pointer/cursor decoration set to be shown,
17656     * when the mouse pointer is over the given genlist widget item
17657     *
17658     * @param item genlist item with custom cursor set
17659     * @return the cursor type's name or @c NULL, if no custom cursors
17660     * were set to @p item (and on errors)
17661     *
17662     * @see elm_object_cursor_get()
17663     * @see elm_genlist_item_cursor_set() for more details
17664     * @see elm_genlist_item_cursor_unset()
17665     *
17666     * @ingroup Genlist
17667     */
17668    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17669    /**
17670     * Unset any custom mouse pointer/cursor decoration set to be
17671     * shown, when the mouse pointer is over the given genlist widget
17672     * item, thus making it show the @b default cursor again.
17673     *
17674     * @param item a genlist item
17675     *
17676     * Use this call to undo any custom settings on this item's cursor
17677     * decoration, bringing it back to defaults (no custom style set).
17678     *
17679     * @see elm_object_cursor_unset()
17680     * @see elm_genlist_item_cursor_set() for more details
17681     *
17682     * @ingroup Genlist
17683     */
17684    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17685    /**
17686     * Set a different @b style for a given custom cursor set for a
17687     * genlist item.
17688     *
17689     * @param item genlist item with custom cursor set
17690     * @param style the <b>theme style</b> to use (e.g. @c "default",
17691     * @c "transparent", etc)
17692     *
17693     * This function only makes sense when one is using custom mouse
17694     * cursor decorations <b>defined in a theme file</b> , which can
17695     * have, given a cursor name/type, <b>alternate styles</b> on
17696     * it. It works analogously as elm_object_cursor_style_set(), but
17697     * here applied only to genlist item objects.
17698     *
17699     * @warning Before you set a cursor style you should have defined a
17700     *       custom cursor previously on the item, with
17701     *       elm_genlist_item_cursor_set()
17702     *
17703     * @see elm_genlist_item_cursor_engine_only_set()
17704     * @see elm_genlist_item_cursor_style_get()
17705     *
17706     * @ingroup Genlist
17707     */
17708    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17709    /**
17710     * Get the current @b style set for a given genlist item's custom
17711     * cursor
17712     *
17713     * @param item genlist item with custom cursor set.
17714     * @return style the cursor style in use. If the object does not
17715     *         have a cursor set, then @c NULL is returned.
17716     *
17717     * @see elm_genlist_item_cursor_style_set() for more details
17718     *
17719     * @ingroup Genlist
17720     */
17721    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17722    /**
17723     * Set if the (custom) cursor for a given genlist item should be
17724     * searched in its theme, also, or should only rely on the
17725     * rendering engine.
17726     *
17727     * @param item item with custom (custom) cursor already set on
17728     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17729     * only on those provided by the rendering engine, @c EINA_FALSE to
17730     * have them searched on the widget's theme, as well.
17731     *
17732     * @note This call is of use only if you've set a custom cursor
17733     * for genlist items, with elm_genlist_item_cursor_set().
17734     *
17735     * @note By default, cursors will only be looked for between those
17736     * provided by the rendering engine.
17737     *
17738     * @ingroup Genlist
17739     */
17740    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17741    /**
17742     * Get if the (custom) cursor for a given genlist item is being
17743     * searched in its theme, also, or is only relying on the rendering
17744     * engine.
17745     *
17746     * @param item a genlist item
17747     * @return @c EINA_TRUE, if cursors are being looked for only on
17748     * those provided by the rendering engine, @c EINA_FALSE if they
17749     * are being searched on the widget's theme, as well.
17750     *
17751     * @see elm_genlist_item_cursor_engine_only_set(), for more details
17752     *
17753     * @ingroup Genlist
17754     */
17755    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17756    /**
17757     * Update the contents of all realized items.
17758     *
17759     * @param obj The genlist object.
17760     *
17761     * This updates all realized items by calling all the item class functions again
17762     * to get the icons, labels and states. Use this when the original
17763     * item data has changed and the changes are desired to be reflected.
17764     *
17765     * To update just one item, use elm_genlist_item_update().
17766     *
17767     * @see elm_genlist_realized_items_get()
17768     * @see elm_genlist_item_update()
17769     *
17770     * @ingroup Genlist
17771     */
17772    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
17773    /**
17774     * Activate a genlist mode on an item
17775     *
17776     * @param item The genlist item
17777     * @param mode Mode name
17778     * @param mode_set Boolean to define set or unset mode.
17779     *
17780     * A genlist mode is a different way of selecting an item. Once a mode is
17781     * activated on an item, any other selected item is immediately unselected.
17782     * This feature provides an easy way of implementing a new kind of animation
17783     * for selecting an item, without having to entirely rewrite the item style
17784     * theme. However, the elm_genlist_selected_* API can't be used to get what
17785     * item is activate for a mode.
17786     *
17787     * The current item style will still be used, but applying a genlist mode to
17788     * an item will select it using a different kind of animation.
17789     *
17790     * The current active item for a mode can be found by
17791     * elm_genlist_mode_item_get().
17792     *
17793     * The characteristics of genlist mode are:
17794     * - Only one mode can be active at any time, and for only one item.
17795     * - Genlist handles deactivating other items when one item is activated.
17796     * - A mode is defined in the genlist theme (edc), and more modes can easily
17797     *   be added.
17798     * - A mode style and the genlist item style are different things. They
17799     *   can be combined to provide a default style to the item, with some kind
17800     *   of animation for that item when the mode is activated.
17801     *
17802     * When a mode is activated on an item, a new view for that item is created.
17803     * The theme of this mode defines the animation that will be used to transit
17804     * the item from the old view to the new view. This second (new) view will be
17805     * active for that item while the mode is active on the item, and will be
17806     * destroyed after the mode is totally deactivated from that item.
17807     *
17808     * @see elm_genlist_mode_get()
17809     * @see elm_genlist_mode_item_get()
17810     *
17811     * @ingroup Genlist
17812     */
17813    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
17814    /**
17815     * Get the last (or current) genlist mode used.
17816     *
17817     * @param obj The genlist object
17818     *
17819     * This function just returns the name of the last used genlist mode. It will
17820     * be the current mode if it's still active.
17821     *
17822     * @see elm_genlist_item_mode_set()
17823     * @see elm_genlist_mode_item_get()
17824     *
17825     * @ingroup Genlist
17826     */
17827    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17828    /**
17829     * Get active genlist mode item
17830     *
17831     * @param obj The genlist object
17832     * @return The active item for that current mode. Or @c NULL if no item is
17833     * activated with any mode.
17834     *
17835     * This function returns the item that was activated with a mode, by the
17836     * function elm_genlist_item_mode_set().
17837     *
17838     * @see elm_genlist_item_mode_set()
17839     * @see elm_genlist_mode_get()
17840     *
17841     * @ingroup Genlist
17842     */
17843    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17844
17845    /**
17846     * Set reorder mode
17847     *
17848     * @param obj The genlist object
17849     * @param reorder_mode The reorder mode
17850     * (EINA_TRUE = on, EINA_FALSE = off)
17851     *
17852     * @ingroup Genlist
17853     */
17854    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
17855
17856    /**
17857     * Get the reorder mode
17858     *
17859     * @param obj The genlist object
17860     * @return The reorder mode
17861     * (EINA_TRUE = on, EINA_FALSE = off)
17862     *
17863     * @ingroup Genlist
17864     */
17865    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17866
17867    /**
17868     * @}
17869     */
17870
17871    /**
17872     * @defgroup Check Check
17873     *
17874     * @image html img/widget/check/preview-00.png
17875     * @image latex img/widget/check/preview-00.eps
17876     * @image html img/widget/check/preview-01.png
17877     * @image latex img/widget/check/preview-01.eps
17878     * @image html img/widget/check/preview-02.png
17879     * @image latex img/widget/check/preview-02.eps
17880     *
17881     * @brief The check widget allows for toggling a value between true and
17882     * false.
17883     *
17884     * Check objects are a lot like radio objects in layout and functionality
17885     * except they do not work as a group, but independently and only toggle the
17886     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
17887     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
17888     * returns the current state. For convenience, like the radio objects, you
17889     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
17890     * for it to modify.
17891     *
17892     * Signals that you can add callbacks for are:
17893     * "changed" - This is called whenever the user changes the state of one of
17894     *             the check object(event_info is NULL).
17895     *
17896     * @ref tutorial_check should give you a firm grasp of how to use this widget.
17897     * @{
17898     */
17899    /**
17900     * @brief Add a new Check object
17901     *
17902     * @param parent The parent object
17903     * @return The new object or NULL if it cannot be created
17904     */
17905    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17906    /**
17907     * @brief Set the text label of the check object
17908     *
17909     * @param obj The check object
17910     * @param label The text label string in UTF-8
17911     *
17912     * @deprecated use elm_object_text_set() instead.
17913     */
17914    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17915    /**
17916     * @brief Get the text label of the check object
17917     *
17918     * @param obj The check object
17919     * @return The text label string in UTF-8
17920     *
17921     * @deprecated use elm_object_text_get() instead.
17922     */
17923    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17924    /**
17925     * @brief Set the icon object of the check object
17926     *
17927     * @param obj The check object
17928     * @param icon The icon object
17929     *
17930     * Once the icon object is set, a previously set one will be deleted.
17931     * If you want to keep that old content object, use the
17932     * elm_check_icon_unset() function.
17933     */
17934    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17935    /**
17936     * @brief Get the icon object of the check object
17937     *
17938     * @param obj The check object
17939     * @return The icon object
17940     */
17941    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17942    /**
17943     * @brief Unset the icon used for the check object
17944     *
17945     * @param obj The check object
17946     * @return The icon object that was being used
17947     *
17948     * Unparent and return the icon object which was set for this widget.
17949     */
17950    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17951    /**
17952     * @brief Set the on/off state of the check object
17953     *
17954     * @param obj The check object
17955     * @param state The state to use (1 == on, 0 == off)
17956     *
17957     * This sets the state of the check. If set
17958     * with elm_check_state_pointer_set() the state of that variable is also
17959     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
17960     */
17961    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
17962    /**
17963     * @brief Get the state of the check object
17964     *
17965     * @param obj The check object
17966     * @return The boolean state
17967     */
17968    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17969    /**
17970     * @brief Set a convenience pointer to a boolean to change
17971     *
17972     * @param obj The check object
17973     * @param statep Pointer to the boolean to modify
17974     *
17975     * This sets a pointer to a boolean, that, in addition to the check objects
17976     * state will also be modified directly. To stop setting the object pointed
17977     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
17978     * then when this is called, the check objects state will also be modified to
17979     * reflect the value of the boolean @p statep points to, just like calling
17980     * elm_check_state_set().
17981     */
17982    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
17983    /**
17984     * @}
17985     */
17986
17987    /**
17988     * @defgroup Radio Radio
17989     *
17990     * @image html img/widget/radio/preview-00.png
17991     * @image latex img/widget/radio/preview-00.eps
17992     *
17993     * @brief Radio is a widget that allows for 1 or more options to be displayed
17994     * and have the user choose only 1 of them.
17995     *
17996     * A radio object contains an indicator, an optional Label and an optional
17997     * icon object. While it's possible to have a group of only one radio they,
17998     * are normally used in groups of 2 or more. To add a radio to a group use
17999     * elm_radio_group_add(). The radio object(s) will select from one of a set
18000     * of integer values, so any value they are configuring needs to be mapped to
18001     * a set of integers. To configure what value that radio object represents,
18002     * use  elm_radio_state_value_set() to set the integer it represents. To set
18003     * the value the whole group(which one is currently selected) is to indicate
18004     * use elm_radio_value_set() on any group member, and to get the groups value
18005     * use elm_radio_value_get(). For convenience the radio objects are also able
18006     * to directly set an integer(int) to the value that is selected. To specify
18007     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18008     * The radio objects will modify this directly. That implies the pointer must
18009     * point to valid memory for as long as the radio objects exist.
18010     *
18011     * Signals that you can add callbacks for are:
18012     * @li changed - This is called whenever the user changes the state of one of
18013     * the radio objects within the group of radio objects that work together.
18014     *
18015     * @ref tutorial_radio show most of this API in action.
18016     * @{
18017     */
18018    /**
18019     * @brief Add a new radio to the parent
18020     *
18021     * @param parent The parent object
18022     * @return The new object or NULL if it cannot be created
18023     */
18024    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18025    /**
18026     * @brief Set the text label of the radio object
18027     *
18028     * @param obj The radio object
18029     * @param label The text label string in UTF-8
18030     *
18031     * @deprecated use elm_object_text_set() instead.
18032     */
18033    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18034    /**
18035     * @brief Get the text label of the radio object
18036     *
18037     * @param obj The radio object
18038     * @return The text label string in UTF-8
18039     *
18040     * @deprecated use elm_object_text_set() instead.
18041     */
18042    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18043    /**
18044     * @brief Set the icon object of the radio object
18045     *
18046     * @param obj The radio object
18047     * @param icon The icon object
18048     *
18049     * Once the icon object is set, a previously set one will be deleted. If you
18050     * want to keep that old content object, use the elm_radio_icon_unset()
18051     * function.
18052     */
18053    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18054    /**
18055     * @brief Get the icon object of the radio object
18056     *
18057     * @param obj The radio object
18058     * @return The icon object
18059     *
18060     * @see elm_radio_icon_set()
18061     */
18062    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18063    /**
18064     * @brief Unset the icon used for the radio object
18065     *
18066     * @param obj The radio object
18067     * @return The icon object that was being used
18068     *
18069     * Unparent and return the icon object which was set for this widget.
18070     *
18071     * @see elm_radio_icon_set()
18072     */
18073    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18074    /**
18075     * @brief Add this radio to a group of other radio objects
18076     *
18077     * @param obj The radio object
18078     * @param group Any object whose group the @p obj is to join.
18079     *
18080     * Radio objects work in groups. Each member should have a different integer
18081     * value assigned. In order to have them work as a group, they need to know
18082     * about each other. This adds the given radio object to the group of which
18083     * the group object indicated is a member.
18084     */
18085    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18086    /**
18087     * @brief Set the integer value that this radio object represents
18088     *
18089     * @param obj The radio object
18090     * @param value The value to use if this radio object is selected
18091     *
18092     * This sets the value of the radio.
18093     */
18094    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18095    /**
18096     * @brief Get the integer value that this radio object represents
18097     *
18098     * @param obj The radio object
18099     * @return The value used if this radio object is selected
18100     *
18101     * This gets the value of the radio.
18102     *
18103     * @see elm_radio_value_set()
18104     */
18105    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18106    /**
18107     * @brief Set the value of the radio.
18108     *
18109     * @param obj The radio object
18110     * @param value The value to use for the group
18111     *
18112     * This sets the value of the radio group and will also set the value if
18113     * pointed to, to the value supplied, but will not call any callbacks.
18114     */
18115    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18116    /**
18117     * @brief Get the state of the radio object
18118     *
18119     * @param obj The radio object
18120     * @return The integer state
18121     */
18122    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18123    /**
18124     * @brief Set a convenience pointer to a integer to change
18125     *
18126     * @param obj The radio object
18127     * @param valuep Pointer to the integer to modify
18128     *
18129     * This sets a pointer to a integer, that, in addition to the radio objects
18130     * state will also be modified directly. To stop setting the object pointed
18131     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18132     * when this is called, the radio objects state will also be modified to
18133     * reflect the value of the integer valuep points to, just like calling
18134     * elm_radio_value_set().
18135     */
18136    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18137    /**
18138     * @}
18139     */
18140
18141    /**
18142     * @defgroup Pager Pager
18143     *
18144     * @image html img/widget/pager/preview-00.png
18145     * @image latex img/widget/pager/preview-00.eps
18146     *
18147     * @brief Widget that allows flipping between 1 or more “pages” of objects.
18148     *
18149     * The flipping between “pages” of objects is animated. All content in pager
18150     * is kept in a stack, the last content to be added will be on the top of the
18151     * stack(be visible).
18152     *
18153     * Objects can be pushed or popped from the stack or deleted as normal.
18154     * Pushes and pops will animate (and a pop will delete the object once the
18155     * animation is finished). Any object already in the pager can be promoted to
18156     * the top(from its current stacking position) through the use of
18157     * elm_pager_content_promote(). Objects are pushed to the top with
18158     * elm_pager_content_push() and when the top item is no longer wanted, simply
18159     * pop it with elm_pager_content_pop() and it will also be deleted. If an
18160     * object is no longer needed and is not the top item, just delete it as
18161     * normal. You can query which objects are the top and bottom with
18162     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18163     *
18164     * Signals that you can add callbacks for are:
18165     * "hide,finished" - when the previous page is hided
18166     *
18167     * This widget has the following styles available:
18168     * @li default
18169     * @li fade
18170     * @li fade_translucide
18171     * @li fade_invisible
18172     * @note This styles affect only the flipping animations, the appearance when
18173     * not animating is unaffected by styles.
18174     *
18175     * @ref tutorial_pager gives a good overview of the usage of the API.
18176     * @{
18177     */
18178    /**
18179     * Add a new pager to the parent
18180     *
18181     * @param parent The parent object
18182     * @return The new object or NULL if it cannot be created
18183     *
18184     * @ingroup Pager
18185     */
18186    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18187    /**
18188     * @brief Push an object to the top of the pager stack (and show it).
18189     *
18190     * @param obj The pager object
18191     * @param content The object to push
18192     *
18193     * The object pushed becomes a child of the pager, it will be controlled and
18194     * deleted when the pager is deleted.
18195     *
18196     * @note If the content is already in the stack use
18197     * elm_pager_content_promote().
18198     * @warning Using this function on @p content already in the stack results in
18199     * undefined behavior.
18200     */
18201    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18202    /**
18203     * @brief Pop the object that is on top of the stack
18204     *
18205     * @param obj The pager object
18206     *
18207     * This pops the object that is on the top(visible) of the pager, makes it
18208     * disappear, then deletes the object. The object that was underneath it on
18209     * the stack will become visible.
18210     */
18211    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18212    /**
18213     * @brief Moves an object already in the pager stack to the top of the stack.
18214     *
18215     * @param obj The pager object
18216     * @param content The object to promote
18217     *
18218     * This will take the @p content and move it to the top of the stack as
18219     * if it had been pushed there.
18220     *
18221     * @note If the content isn't already in the stack use
18222     * elm_pager_content_push().
18223     * @warning Using this function on @p content not already in the stack
18224     * results in undefined behavior.
18225     */
18226    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18227    /**
18228     * @brief Return the object at the bottom of the pager stack
18229     *
18230     * @param obj The pager object
18231     * @return The bottom object or NULL if none
18232     */
18233    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18234    /**
18235     * @brief  Return the object at the top of the pager stack
18236     *
18237     * @param obj The pager object
18238     * @return The top object or NULL if none
18239     */
18240    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18241    /**
18242     * @}
18243     */
18244
18245    /**
18246     * @defgroup Slideshow Slideshow
18247     *
18248     * @image html img/widget/slideshow/preview-00.png
18249     * @image latex img/widget/slideshow/preview-00.eps
18250     *
18251     * This widget, as the name indicates, is a pre-made image
18252     * slideshow panel, with API functions acting on (child) image
18253     * items presentation. Between those actions, are:
18254     * - advance to next/previous image
18255     * - select the style of image transition animation
18256     * - set the exhibition time for each image
18257     * - start/stop the slideshow
18258     *
18259     * The transition animations are defined in the widget's theme,
18260     * consequently new animations can be added without having to
18261     * update the widget's code.
18262     *
18263     * @section Slideshow_Items Slideshow items
18264     *
18265     * For slideshow items, just like for @ref Genlist "genlist" ones,
18266     * the user defines a @b classes, specifying functions that will be
18267     * called on the item's creation and deletion times.
18268     *
18269     * The #Elm_Slideshow_Item_Class structure contains the following
18270     * members:
18271     *
18272     * - @c func.get - When an item is displayed, this function is
18273     *   called, and it's where one should create the item object, de
18274     *   facto. For example, the object can be a pure Evas image object
18275     *   or an Elementary @ref Photocam "photocam" widget. See
18276     *   #SlideshowItemGetFunc.
18277     * - @c func.del - When an item is no more displayed, this function
18278     *   is called, where the user must delete any data associated to
18279     *   the item. See #SlideshowItemDelFunc.
18280     *
18281     * @section Slideshow_Caching Slideshow caching
18282     *
18283     * The slideshow provides facilities to have items adjacent to the
18284     * one being displayed <b>already "realized"</b> (i.e. loaded) for
18285     * you, so that the system does not have to decode image data
18286     * anymore at the time it has to actually switch images on its
18287     * viewport. The user is able to set the numbers of items to be
18288     * cached @b before and @b after the current item, in the widget's
18289     * item list.
18290     *
18291     * Smart events one can add callbacks for are:
18292     *
18293     * - @c "changed" - when the slideshow switches its view to a new
18294     *   item
18295     *
18296     * List of examples for the slideshow widget:
18297     * @li @ref slideshow_example
18298     */
18299
18300    /**
18301     * @addtogroup Slideshow
18302     * @{
18303     */
18304
18305    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18306    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18307    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
18308    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18309    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18310
18311    /**
18312     * @struct _Elm_Slideshow_Item_Class
18313     *
18314     * Slideshow item class definition. See @ref Slideshow_Items for
18315     * field details.
18316     */
18317    struct _Elm_Slideshow_Item_Class
18318      {
18319         struct _Elm_Slideshow_Item_Class_Func
18320           {
18321              SlideshowItemGetFunc get;
18322              SlideshowItemDelFunc del;
18323           } func;
18324      }; /**< #Elm_Slideshow_Item_Class member definitions */
18325
18326    /**
18327     * Add a new slideshow widget to the given parent Elementary
18328     * (container) object
18329     *
18330     * @param parent The parent object
18331     * @return A new slideshow widget handle or @c NULL, on errors
18332     *
18333     * This function inserts a new slideshow widget on the canvas.
18334     *
18335     * @ingroup Slideshow
18336     */
18337    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18338
18339    /**
18340     * Add (append) a new item in a given slideshow widget.
18341     *
18342     * @param obj The slideshow object
18343     * @param itc The item class for the item
18344     * @param data The item's data
18345     * @return A handle to the item added or @c NULL, on errors
18346     *
18347     * Add a new item to @p obj's internal list of items, appending it.
18348     * The item's class must contain the function really fetching the
18349     * image object to show for this item, which could be an Evas image
18350     * object or an Elementary photo, for example. The @p data
18351     * parameter is going to be passed to both class functions of the
18352     * item.
18353     *
18354     * @see #Elm_Slideshow_Item_Class
18355     * @see elm_slideshow_item_sorted_insert()
18356     *
18357     * @ingroup Slideshow
18358     */
18359    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18360
18361    /**
18362     * Insert a new item into the given slideshow widget, using the @p func
18363     * function to sort items (by item handles).
18364     *
18365     * @param obj The slideshow object
18366     * @param itc The item class for the item
18367     * @param data The item's data
18368     * @param func The comparing function to be used to sort slideshow
18369     * items <b>by #Elm_Slideshow_Item item handles</b>
18370     * @return Returns The slideshow item handle, on success, or
18371     * @c NULL, on errors
18372     *
18373     * Add a new item to @p obj's internal list of items, in a position
18374     * determined by the @p func comparing function. The item's class
18375     * must contain the function really fetching the image object to
18376     * show for this item, which could be an Evas image object or an
18377     * Elementary photo, for example. The @p data parameter is going to
18378     * be passed to both class functions of the item.
18379     *
18380     * @see #Elm_Slideshow_Item_Class
18381     * @see elm_slideshow_item_add()
18382     *
18383     * @ingroup Slideshow
18384     */
18385    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);
18386
18387    /**
18388     * Display a given slideshow widget's item, programmatically.
18389     *
18390     * @param obj The slideshow object
18391     * @param item The item to display on @p obj's viewport
18392     *
18393     * The change between the current item and @p item will use the
18394     * transition @p obj is set to use (@see
18395     * elm_slideshow_transition_set()).
18396     *
18397     * @ingroup Slideshow
18398     */
18399    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18400
18401    /**
18402     * Slide to the @b next item, in a given slideshow widget
18403     *
18404     * @param obj The slideshow object
18405     *
18406     * The sliding animation @p obj is set to use will be the
18407     * transition effect used, after this call is issued.
18408     *
18409     * @note If the end of the slideshow's internal list of items is
18410     * reached, it'll wrap around to the list's beginning, again.
18411     *
18412     * @ingroup Slideshow
18413     */
18414    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18415
18416    /**
18417     * Slide to the @b previous item, in a given slideshow widget
18418     *
18419     * @param obj The slideshow object
18420     *
18421     * The sliding animation @p obj is set to use will be the
18422     * transition effect used, after this call is issued.
18423     *
18424     * @note If the beginning of the slideshow's internal list of items
18425     * is reached, it'll wrap around to the list's end, again.
18426     *
18427     * @ingroup Slideshow
18428     */
18429    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18430
18431    /**
18432     * Returns the list of sliding transition/effect names available, for a
18433     * given slideshow widget.
18434     *
18435     * @param obj The slideshow object
18436     * @return The list of transitions (list of @b stringshared strings
18437     * as data)
18438     *
18439     * The transitions, which come from @p obj's theme, must be an EDC
18440     * data item named @c "transitions" on the theme file, with (prefix)
18441     * names of EDC programs actually implementing them.
18442     *
18443     * The available transitions for slideshows on the default theme are:
18444     * - @c "fade" - the current item fades out, while the new one
18445     *   fades in to the slideshow's viewport.
18446     * - @c "black_fade" - the current item fades to black, and just
18447     *   then, the new item will fade in.
18448     * - @c "horizontal" - the current item slides horizontally, until
18449     *   it gets out of the slideshow's viewport, while the new item
18450     *   comes from the left to take its place.
18451     * - @c "vertical" - the current item slides vertically, until it
18452     *   gets out of the slideshow's viewport, while the new item comes
18453     *   from the bottom to take its place.
18454     * - @c "square" - the new item starts to appear from the middle of
18455     *   the current one, but with a tiny size, growing until its
18456     *   target (full) size and covering the old one.
18457     *
18458     * @warning The stringshared strings get no new references
18459     * exclusive to the user grabbing the list, here, so if you'd like
18460     * to use them out of this call's context, you'd better @c
18461     * eina_stringshare_ref() them.
18462     *
18463     * @see elm_slideshow_transition_set()
18464     *
18465     * @ingroup Slideshow
18466     */
18467    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18468
18469    /**
18470     * Set the current slide transition/effect in use for a given
18471     * slideshow widget
18472     *
18473     * @param obj The slideshow object
18474     * @param transition The new transition's name string
18475     *
18476     * If @p transition is implemented in @p obj's theme (i.e., is
18477     * contained in the list returned by
18478     * elm_slideshow_transitions_get()), this new sliding effect will
18479     * be used on the widget.
18480     *
18481     * @see elm_slideshow_transitions_get() for more details
18482     *
18483     * @ingroup Slideshow
18484     */
18485    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18486
18487    /**
18488     * Get the current slide transition/effect in use for a given
18489     * slideshow widget
18490     *
18491     * @param obj The slideshow object
18492     * @return The current transition's name
18493     *
18494     * @see elm_slideshow_transition_set() for more details
18495     *
18496     * @ingroup Slideshow
18497     */
18498    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18499
18500    /**
18501     * Set the interval between each image transition on a given
18502     * slideshow widget, <b>and start the slideshow, itself</b>
18503     *
18504     * @param obj The slideshow object
18505     * @param timeout The new displaying timeout for images
18506     *
18507     * After this call, the slideshow widget will start cycling its
18508     * view, sequentially and automatically, with the images of the
18509     * items it has. The time between each new image displayed is going
18510     * to be @p timeout, in @b seconds. If a different timeout was set
18511     * previously and an slideshow was in progress, it will continue
18512     * with the new time between transitions, after this call.
18513     *
18514     * @note A value less than or equal to 0 on @p timeout will disable
18515     * the widget's internal timer, thus halting any slideshow which
18516     * could be happening on @p obj.
18517     *
18518     * @see elm_slideshow_timeout_get()
18519     *
18520     * @ingroup Slideshow
18521     */
18522    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18523
18524    /**
18525     * Get the interval set for image transitions on a given slideshow
18526     * widget.
18527     *
18528     * @param obj The slideshow object
18529     * @return Returns the timeout set on it
18530     *
18531     * @see elm_slideshow_timeout_set() for more details
18532     *
18533     * @ingroup Slideshow
18534     */
18535    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18536
18537    /**
18538     * Set if, after a slideshow is started, for a given slideshow
18539     * widget, its items should be displayed cyclically or not.
18540     *
18541     * @param obj The slideshow object
18542     * @param loop Use @c EINA_TRUE to make it cycle through items or
18543     * @c EINA_FALSE for it to stop at the end of @p obj's internal
18544     * list of items
18545     *
18546     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18547     * ignore what is set by this functions, i.e., they'll @b always
18548     * cycle through items. This affects only the "automatic"
18549     * slideshow, as set by elm_slideshow_timeout_set().
18550     *
18551     * @see elm_slideshow_loop_get()
18552     *
18553     * @ingroup Slideshow
18554     */
18555    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18556
18557    /**
18558     * Get if, after a slideshow is started, for a given slideshow
18559     * widget, its items are to be displayed cyclically or not.
18560     *
18561     * @param obj The slideshow object
18562     * @return @c EINA_TRUE, if the items in @p obj will be cycled
18563     * through or @c EINA_FALSE, otherwise
18564     *
18565     * @see elm_slideshow_loop_set() for more details
18566     *
18567     * @ingroup Slideshow
18568     */
18569    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18570
18571    /**
18572     * Remove all items from a given slideshow widget
18573     *
18574     * @param obj The slideshow object
18575     *
18576     * This removes (and deletes) all items in @p obj, leaving it
18577     * empty.
18578     *
18579     * @see elm_slideshow_item_del(), to remove just one item.
18580     *
18581     * @ingroup Slideshow
18582     */
18583    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18584
18585    /**
18586     * Get the internal list of items in a given slideshow widget.
18587     *
18588     * @param obj The slideshow object
18589     * @return The list of items (#Elm_Slideshow_Item as data) or
18590     * @c NULL on errors.
18591     *
18592     * This list is @b not to be modified in any way and must not be
18593     * freed. Use the list members with functions like
18594     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18595     *
18596     * @warning This list is only valid until @p obj object's internal
18597     * items list is changed. It should be fetched again with another
18598     * call to this function when changes happen.
18599     *
18600     * @ingroup Slideshow
18601     */
18602    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18603
18604    /**
18605     * Delete a given item from a slideshow widget.
18606     *
18607     * @param item The slideshow item
18608     *
18609     * @ingroup Slideshow
18610     */
18611    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18612
18613    /**
18614     * Return the data associated with a given slideshow item
18615     *
18616     * @param item The slideshow item
18617     * @return Returns the data associated to this item
18618     *
18619     * @ingroup Slideshow
18620     */
18621    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18622
18623    /**
18624     * Returns the currently displayed item, in a given slideshow widget
18625     *
18626     * @param obj The slideshow object
18627     * @return A handle to the item being displayed in @p obj or
18628     * @c NULL, if none is (and on errors)
18629     *
18630     * @ingroup Slideshow
18631     */
18632    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18633
18634    /**
18635     * Get the real Evas object created to implement the view of a
18636     * given slideshow item
18637     *
18638     * @param item The slideshow item.
18639     * @return the Evas object implementing this item's view.
18640     *
18641     * This returns the actual Evas object used to implement the
18642     * specified slideshow item's view. This may be @c NULL, as it may
18643     * not have been created or may have been deleted, at any time, by
18644     * the slideshow. <b>Do not modify this object</b> (move, resize,
18645     * show, hide, etc.), as the slideshow is controlling it. This
18646     * function is for querying, emitting custom signals or hooking
18647     * lower level callbacks for events on that object. Do not delete
18648     * this object under any circumstances.
18649     *
18650     * @see elm_slideshow_item_data_get()
18651     *
18652     * @ingroup Slideshow
18653     */
18654    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18655
18656    /**
18657     * Get the the item, in a given slideshow widget, placed at
18658     * position @p nth, in its internal items list
18659     *
18660     * @param obj The slideshow object
18661     * @param nth The number of the item to grab a handle to (0 being
18662     * the first)
18663     * @return The item stored in @p obj at position @p nth or @c NULL,
18664     * if there's no item with that index (and on errors)
18665     *
18666     * @ingroup Slideshow
18667     */
18668    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18669
18670    /**
18671     * Set the current slide layout in use for a given slideshow widget
18672     *
18673     * @param obj The slideshow object
18674     * @param layout The new layout's name string
18675     *
18676     * If @p layout is implemented in @p obj's theme (i.e., is contained
18677     * in the list returned by elm_slideshow_layouts_get()), this new
18678     * images layout will be used on the widget.
18679     *
18680     * @see elm_slideshow_layouts_get() for more details
18681     *
18682     * @ingroup Slideshow
18683     */
18684    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18685
18686    /**
18687     * Get the current slide layout in use for a given slideshow widget
18688     *
18689     * @param obj The slideshow object
18690     * @return The current layout's name
18691     *
18692     * @see elm_slideshow_layout_set() for more details
18693     *
18694     * @ingroup Slideshow
18695     */
18696    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18697
18698    /**
18699     * Returns the list of @b layout names available, for a given
18700     * slideshow widget.
18701     *
18702     * @param obj The slideshow object
18703     * @return The list of layouts (list of @b stringshared strings
18704     * as data)
18705     *
18706     * Slideshow layouts will change how the widget is to dispose each
18707     * image item in its viewport, with regard to cropping, scaling,
18708     * etc.
18709     *
18710     * The layouts, which come from @p obj's theme, must be an EDC
18711     * data item name @c "layouts" on the theme file, with (prefix)
18712     * names of EDC programs actually implementing them.
18713     *
18714     * The available layouts for slideshows on the default theme are:
18715     * - @c "fullscreen" - item images with original aspect, scaled to
18716     *   touch top and down slideshow borders or, if the image's heigh
18717     *   is not enough, left and right slideshow borders.
18718     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
18719     *   one, but always leaving 10% of the slideshow's dimensions of
18720     *   distance between the item image's borders and the slideshow
18721     *   borders, for each axis.
18722     *
18723     * @warning The stringshared strings get no new references
18724     * exclusive to the user grabbing the list, here, so if you'd like
18725     * to use them out of this call's context, you'd better @c
18726     * eina_stringshare_ref() them.
18727     *
18728     * @see elm_slideshow_layout_set()
18729     *
18730     * @ingroup Slideshow
18731     */
18732    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18733
18734    /**
18735     * Set the number of items to cache, on a given slideshow widget,
18736     * <b>before the current item</b>
18737     *
18738     * @param obj The slideshow object
18739     * @param count Number of items to cache before the current one
18740     *
18741     * The default value for this property is @c 2. See
18742     * @ref Slideshow_Caching "slideshow caching" for more details.
18743     *
18744     * @see elm_slideshow_cache_before_get()
18745     *
18746     * @ingroup Slideshow
18747     */
18748    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18749
18750    /**
18751     * Retrieve the number of items to cache, on a given slideshow widget,
18752     * <b>before the current item</b>
18753     *
18754     * @param obj The slideshow object
18755     * @return The number of items set to be cached before the current one
18756     *
18757     * @see elm_slideshow_cache_before_set() for more details
18758     *
18759     * @ingroup Slideshow
18760     */
18761    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18762
18763    /**
18764     * Set the number of items to cache, on a given slideshow widget,
18765     * <b>after the current item</b>
18766     *
18767     * @param obj The slideshow object
18768     * @param count Number of items to cache after the current one
18769     *
18770     * The default value for this property is @c 2. See
18771     * @ref Slideshow_Caching "slideshow caching" for more details.
18772     *
18773     * @see elm_slideshow_cache_after_get()
18774     *
18775     * @ingroup Slideshow
18776     */
18777    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
18778
18779    /**
18780     * Retrieve the number of items to cache, on a given slideshow widget,
18781     * <b>after the current item</b>
18782     *
18783     * @param obj The slideshow object
18784     * @return The number of items set to be cached after the current one
18785     *
18786     * @see elm_slideshow_cache_after_set() for more details
18787     *
18788     * @ingroup Slideshow
18789     */
18790    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18791
18792    /**
18793     * Get the number of items stored in a given slideshow widget
18794     *
18795     * @param obj The slideshow object
18796     * @return The number of items on @p obj, at the moment of this call
18797     *
18798     * @ingroup Slideshow
18799     */
18800    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18801
18802    /**
18803     * @}
18804     */
18805
18806    /**
18807     * @defgroup Fileselector File Selector
18808     *
18809     * @image html img/widget/fileselector/preview-00.png
18810     * @image latex img/widget/fileselector/preview-00.eps
18811     *
18812     * A file selector is a widget that allows a user to navigate
18813     * through a file system, reporting file selections back via its
18814     * API.
18815     *
18816     * It contains shortcut buttons for home directory (@c ~) and to
18817     * jump one directory upwards (..), as well as cancel/ok buttons to
18818     * confirm/cancel a given selection. After either one of those two
18819     * former actions, the file selector will issue its @c "done" smart
18820     * callback.
18821     *
18822     * There's a text entry on it, too, showing the name of the current
18823     * selection. There's the possibility of making it editable, so it
18824     * is useful on file saving dialogs on applications, where one
18825     * gives a file name to save contents to, in a given directory in
18826     * the system. This custom file name will be reported on the @c
18827     * "done" smart callback (explained in sequence).
18828     *
18829     * Finally, it has a view to display file system items into in two
18830     * possible forms:
18831     * - list
18832     * - grid
18833     *
18834     * If Elementary is built with support of the Ethumb thumbnailing
18835     * library, the second form of view will display preview thumbnails
18836     * of files which it supports.
18837     *
18838     * Smart callbacks one can register to:
18839     *
18840     * - @c "selected" - the user has clicked on a file (when not in
18841     *      folders-only mode) or directory (when in folders-only mode)
18842     * - @c "directory,open" - the list has been populated with new
18843     *      content (@c event_info is a pointer to the directory's
18844     *      path, a @b stringshared string)
18845     * - @c "done" - the user has clicked on the "ok" or "cancel"
18846     *      buttons (@c event_info is a pointer to the selection's
18847     *      path, a @b stringshared string)
18848     *
18849     * Here is an example on its usage:
18850     * @li @ref fileselector_example
18851     */
18852
18853    /**
18854     * @addtogroup Fileselector
18855     * @{
18856     */
18857
18858    /**
18859     * Defines how a file selector widget is to layout its contents
18860     * (file system entries).
18861     */
18862    typedef enum _Elm_Fileselector_Mode
18863      {
18864         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
18865         ELM_FILESELECTOR_GRID, /**< layout as a grid */
18866         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
18867      } Elm_Fileselector_Mode;
18868
18869    /**
18870     * Add a new file selector widget to the given parent Elementary
18871     * (container) object
18872     *
18873     * @param parent The parent object
18874     * @return a new file selector widget handle or @c NULL, on errors
18875     *
18876     * This function inserts a new file selector widget on the canvas.
18877     *
18878     * @ingroup Fileselector
18879     */
18880    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18881
18882    /**
18883     * Enable/disable the file name entry box where the user can type
18884     * in a name for a file, in a given file selector widget
18885     *
18886     * @param obj The file selector object
18887     * @param is_save @c EINA_TRUE to make the file selector a "saving
18888     * dialog", @c EINA_FALSE otherwise
18889     *
18890     * Having the entry editable is useful on file saving dialogs on
18891     * applications, where one gives a file name to save contents to,
18892     * in a given directory in the system. This custom file name will
18893     * be reported on the @c "done" smart callback.
18894     *
18895     * @see elm_fileselector_is_save_get()
18896     *
18897     * @ingroup Fileselector
18898     */
18899    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
18900
18901    /**
18902     * Get whether the given file selector is in "saving dialog" mode
18903     *
18904     * @param obj The file selector object
18905     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
18906     * mode, @c EINA_FALSE otherwise (and on errors)
18907     *
18908     * @see elm_fileselector_is_save_set() for more details
18909     *
18910     * @ingroup Fileselector
18911     */
18912    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18913
18914    /**
18915     * Enable/disable folder-only view for a given file selector widget
18916     *
18917     * @param obj The file selector object
18918     * @param only @c EINA_TRUE to make @p obj only display
18919     * directories, @c EINA_FALSE to make files to be displayed in it
18920     * too
18921     *
18922     * If enabled, the widget's view will only display folder items,
18923     * naturally.
18924     *
18925     * @see elm_fileselector_folder_only_get()
18926     *
18927     * @ingroup Fileselector
18928     */
18929    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
18930
18931    /**
18932     * Get whether folder-only view is set for a given file selector
18933     * widget
18934     *
18935     * @param obj The file selector object
18936     * @return only @c EINA_TRUE if @p obj is only displaying
18937     * directories, @c EINA_FALSE if files are being displayed in it
18938     * too (and on errors)
18939     *
18940     * @see elm_fileselector_folder_only_get()
18941     *
18942     * @ingroup Fileselector
18943     */
18944    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18945
18946    /**
18947     * Enable/disable the "ok" and "cancel" buttons on a given file
18948     * selector widget
18949     *
18950     * @param obj The file selector object
18951     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
18952     *
18953     * @note A file selector without those buttons will never emit the
18954     * @c "done" smart event, and is only usable if one is just hooking
18955     * to the other two events.
18956     *
18957     * @see elm_fileselector_buttons_ok_cancel_get()
18958     *
18959     * @ingroup Fileselector
18960     */
18961    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
18962
18963    /**
18964     * Get whether the "ok" and "cancel" buttons on a given file
18965     * selector widget are being shown.
18966     *
18967     * @param obj The file selector object
18968     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
18969     * otherwise (and on errors)
18970     *
18971     * @see elm_fileselector_buttons_ok_cancel_set() for more details
18972     *
18973     * @ingroup Fileselector
18974     */
18975    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18976
18977    /**
18978     * Enable/disable a tree view in the given file selector widget,
18979     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
18980     *
18981     * @param obj The file selector object
18982     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
18983     * disable
18984     *
18985     * In a tree view, arrows are created on the sides of directories,
18986     * allowing them to expand in place.
18987     *
18988     * @note If it's in other mode, the changes made by this function
18989     * will only be visible when one switches back to "list" mode.
18990     *
18991     * @see elm_fileselector_expandable_get()
18992     *
18993     * @ingroup Fileselector
18994     */
18995    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
18996
18997    /**
18998     * Get whether tree view is enabled for the given file selector
18999     * widget
19000     *
19001     * @param obj The file selector object
19002     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19003     * otherwise (and or errors)
19004     *
19005     * @see elm_fileselector_expandable_set() for more details
19006     *
19007     * @ingroup Fileselector
19008     */
19009    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19010
19011    /**
19012     * Set, programmatically, the @b directory that a given file
19013     * selector widget will display contents from
19014     *
19015     * @param obj The file selector object
19016     * @param path The path to display in @p obj
19017     *
19018     * This will change the @b directory that @p obj is displaying. It
19019     * will also clear the text entry area on the @p obj object, which
19020     * displays select files' names.
19021     *
19022     * @see elm_fileselector_path_get()
19023     *
19024     * @ingroup Fileselector
19025     */
19026    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19027
19028    /**
19029     * Get the parent directory's path that a given file selector
19030     * widget is displaying
19031     *
19032     * @param obj The file selector object
19033     * @return The (full) path of the directory the file selector is
19034     * displaying, a @b stringshared string
19035     *
19036     * @see elm_fileselector_path_set()
19037     *
19038     * @ingroup Fileselector
19039     */
19040    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19041
19042    /**
19043     * Set, programmatically, the currently selected file/directory in
19044     * the given file selector widget
19045     *
19046     * @param obj The file selector object
19047     * @param path The (full) path to a file or directory
19048     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19049     * latter case occurs if the directory or file pointed to do not
19050     * exist.
19051     *
19052     * @see elm_fileselector_selected_get()
19053     *
19054     * @ingroup Fileselector
19055     */
19056    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19057
19058    /**
19059     * Get the currently selected item's (full) path, in the given file
19060     * selector widget
19061     *
19062     * @param obj The file selector object
19063     * @return The absolute path of the selected item, a @b
19064     * stringshared string
19065     *
19066     * @note Custom editions on @p obj object's text entry, if made,
19067     * will appear on the return string of this function, naturally.
19068     *
19069     * @see elm_fileselector_selected_set() for more details
19070     *
19071     * @ingroup Fileselector
19072     */
19073    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19074
19075    /**
19076     * Set the mode in which a given file selector widget will display
19077     * (layout) file system entries in its view
19078     *
19079     * @param obj The file selector object
19080     * @param mode The mode of the fileselector, being it one of
19081     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19082     * first one, naturally, will display the files in a list. The
19083     * latter will make the widget to display its entries in a grid
19084     * form.
19085     *
19086     * @note By using elm_fileselector_expandable_set(), the user may
19087     * trigger a tree view for that list.
19088     *
19089     * @note If Elementary is built with support of the Ethumb
19090     * thumbnailing library, the second form of view will display
19091     * preview thumbnails of files which it supports. You must have
19092     * elm_need_ethumb() called in your Elementary for thumbnailing to
19093     * work, though.
19094     *
19095     * @see elm_fileselector_expandable_set().
19096     * @see elm_fileselector_mode_get().
19097     *
19098     * @ingroup Fileselector
19099     */
19100    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19101
19102    /**
19103     * Get the mode in which a given file selector widget is displaying
19104     * (layouting) file system entries in its view
19105     *
19106     * @param obj The fileselector object
19107     * @return The mode in which the fileselector is at
19108     *
19109     * @see elm_fileselector_mode_set() for more details
19110     *
19111     * @ingroup Fileselector
19112     */
19113    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19114
19115    /**
19116     * @}
19117     */
19118
19119    /**
19120     * @defgroup Progressbar Progress bar
19121     *
19122     * The progress bar is a widget for visually representing the
19123     * progress status of a given job/task.
19124     *
19125     * A progress bar may be horizontal or vertical. It may display an
19126     * icon besides it, as well as primary and @b units labels. The
19127     * former is meant to label the widget as a whole, while the
19128     * latter, which is formatted with floating point values (and thus
19129     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19130     * units"</c>), is meant to label the widget's <b>progress
19131     * value</b>. Label, icon and unit strings/objects are @b optional
19132     * for progress bars.
19133     *
19134     * A progress bar may be @b inverted, in which state it gets its
19135     * values inverted, with high values being on the left or top and
19136     * low values on the right or bottom, as opposed to normally have
19137     * the low values on the former and high values on the latter,
19138     * respectively, for horizontal and vertical modes.
19139     *
19140     * The @b span of the progress, as set by
19141     * elm_progressbar_span_size_set(), is its length (horizontally or
19142     * vertically), unless one puts size hints on the widget to expand
19143     * on desired directions, by any container. That length will be
19144     * scaled by the object or applications scaling factor. At any
19145     * point code can query the progress bar for its value with
19146     * elm_progressbar_value_get().
19147     *
19148     * Available widget styles for progress bars:
19149     * - @c "default"
19150     * - @c "wheel" (simple style, no text, no progression, only
19151     *      "pulse" effect is available)
19152     *
19153     * Here is an example on its usage:
19154     * @li @ref progressbar_example
19155     */
19156
19157    /**
19158     * Add a new progress bar widget to the given parent Elementary
19159     * (container) object
19160     *
19161     * @param parent The parent object
19162     * @return a new progress bar widget handle or @c NULL, on errors
19163     *
19164     * This function inserts a new progress bar widget on the canvas.
19165     *
19166     * @ingroup Progressbar
19167     */
19168    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19169
19170    /**
19171     * Set whether a given progress bar widget is at "pulsing mode" or
19172     * not.
19173     *
19174     * @param obj The progress bar object
19175     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19176     * @c EINA_FALSE to put it back to its default one
19177     *
19178     * By default, progress bars will display values from the low to
19179     * high value boundaries. There are, though, contexts in which the
19180     * state of progression of a given task is @b unknown.  For those,
19181     * one can set a progress bar widget to a "pulsing state", to give
19182     * the user an idea that some computation is being held, but
19183     * without exact progress values. In the default theme it will
19184     * animate its bar with the contents filling in constantly and back
19185     * to non-filled, in a loop. To start and stop this pulsing
19186     * animation, one has to explicitly call elm_progressbar_pulse().
19187     *
19188     * @see elm_progressbar_pulse_get()
19189     * @see elm_progressbar_pulse()
19190     *
19191     * @ingroup Progressbar
19192     */
19193    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19194
19195    /**
19196     * Get whether a given progress bar widget is at "pulsing mode" or
19197     * not.
19198     *
19199     * @param obj The progress bar object
19200     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19201     * if it's in the default one (and on errors)
19202     *
19203     * @ingroup Progressbar
19204     */
19205    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19206
19207    /**
19208     * Start/stop a given progress bar "pulsing" animation, if its
19209     * under that mode
19210     *
19211     * @param obj The progress bar object
19212     * @param state @c EINA_TRUE, to @b start the pulsing animation,
19213     * @c EINA_FALSE to @b stop it
19214     *
19215     * @note This call won't do anything if @p obj is not under "pulsing mode".
19216     *
19217     * @see elm_progressbar_pulse_set() for more details.
19218     *
19219     * @ingroup Progressbar
19220     */
19221    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19222
19223    /**
19224     * Set the progress value (in percentage) on a given progress bar
19225     * widget
19226     *
19227     * @param obj The progress bar object
19228     * @param val The progress value (@b must be between @c 0.0 and @c
19229     * 1.0)
19230     *
19231     * Use this call to set progress bar levels.
19232     *
19233     * @note If you passes a value out of the specified range for @p
19234     * val, it will be interpreted as the @b closest of the @b boundary
19235     * values in the range.
19236     *
19237     * @ingroup Progressbar
19238     */
19239    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19240
19241    /**
19242     * Get the progress value (in percentage) on a given progress bar
19243     * widget
19244     *
19245     * @param obj The progress bar object
19246     * @return The value of the progressbar
19247     *
19248     * @see elm_progressbar_value_set() for more details
19249     *
19250     * @ingroup Progressbar
19251     */
19252    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19253
19254    /**
19255     * Set the label of a given progress bar widget
19256     *
19257     * @param obj The progress bar object
19258     * @param label The text label string, in UTF-8
19259     *
19260     * @ingroup Progressbar
19261     * @deprecated use elm_object_text_set() instead.
19262     */
19263    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19264
19265    /**
19266     * Get the label of a given progress bar widget
19267     *
19268     * @param obj The progressbar object
19269     * @return The text label string, in UTF-8
19270     *
19271     * @ingroup Progressbar
19272     * @deprecated use elm_object_text_set() instead.
19273     */
19274    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19275
19276    /**
19277     * Set the icon object of a given progress bar widget
19278     *
19279     * @param obj The progress bar object
19280     * @param icon The icon object
19281     *
19282     * Use this call to decorate @p obj with an icon next to it.
19283     *
19284     * @note Once the icon object is set, a previously set one will be
19285     * deleted. If you want to keep that old content object, use the
19286     * elm_progressbar_icon_unset() function.
19287     *
19288     * @see elm_progressbar_icon_get()
19289     *
19290     * @ingroup Progressbar
19291     */
19292    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19293
19294    /**
19295     * Retrieve the icon object set for a given progress bar widget
19296     *
19297     * @param obj The progress bar object
19298     * @return The icon object's handle, if @p obj had one set, or @c NULL,
19299     * otherwise (and on errors)
19300     *
19301     * @see elm_progressbar_icon_set() for more details
19302     *
19303     * @ingroup Progressbar
19304     */
19305    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19306
19307    /**
19308     * Unset an icon set on a given progress bar widget
19309     *
19310     * @param obj The progress bar object
19311     * @return The icon object that was being used, if any was set, or
19312     * @c NULL, otherwise (and on errors)
19313     *
19314     * This call will unparent and return the icon object which was set
19315     * for this widget, previously, on success.
19316     *
19317     * @see elm_progressbar_icon_set() for more details
19318     *
19319     * @ingroup Progressbar
19320     */
19321    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19322
19323    /**
19324     * Set the (exact) length of the bar region of a given progress bar
19325     * widget
19326     *
19327     * @param obj The progress bar object
19328     * @param size The length of the progress bar's bar region
19329     *
19330     * This sets the minimum width (when in horizontal mode) or height
19331     * (when in vertical mode) of the actual bar area of the progress
19332     * bar @p obj. This in turn affects the object's minimum size. Use
19333     * this when you're not setting other size hints expanding on the
19334     * given direction (like weight and alignment hints) and you would
19335     * like it to have a specific size.
19336     *
19337     * @note Icon, label and unit text around @p obj will require their
19338     * own space, which will make @p obj to require more the @p size,
19339     * actually.
19340     *
19341     * @see elm_progressbar_span_size_get()
19342     *
19343     * @ingroup Progressbar
19344     */
19345    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19346
19347    /**
19348     * Get the length set for the bar region of a given progress bar
19349     * widget
19350     *
19351     * @param obj The progress bar object
19352     * @return The length of the progress bar's bar region
19353     *
19354     * If that size was not set previously, with
19355     * elm_progressbar_span_size_set(), this call will return @c 0.
19356     *
19357     * @ingroup Progressbar
19358     */
19359    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19360
19361    /**
19362     * Set the format string for a given progress bar widget's units
19363     * label
19364     *
19365     * @param obj The progress bar object
19366     * @param format The format string for @p obj's units label
19367     *
19368     * If @c NULL is passed on @p format, it will make @p obj's units
19369     * area to be hidden completely. If not, it'll set the <b>format
19370     * string</b> for the units label's @b text. The units label is
19371     * provided a floating point value, so the units text is up display
19372     * at most one floating point falue. Note that the units label is
19373     * optional. Use a format string such as "%1.2f meters" for
19374     * example.
19375     *
19376     * @note The default format string for a progress bar is an integer
19377     * percentage, as in @c "%.0f %%".
19378     *
19379     * @see elm_progressbar_unit_format_get()
19380     *
19381     * @ingroup Progressbar
19382     */
19383    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19384
19385    /**
19386     * Retrieve the format string set for a given progress bar widget's
19387     * units label
19388     *
19389     * @param obj The progress bar object
19390     * @return The format set string for @p obj's units label or
19391     * @c NULL, if none was set (and on errors)
19392     *
19393     * @see elm_progressbar_unit_format_set() for more details
19394     *
19395     * @ingroup Progressbar
19396     */
19397    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19398
19399    /**
19400     * Set the orientation of a given progress bar widget
19401     *
19402     * @param obj The progress bar object
19403     * @param horizontal Use @c EINA_TRUE to make @p obj to be
19404     * @b horizontal, @c EINA_FALSE to make it @b vertical
19405     *
19406     * Use this function to change how your progress bar is to be
19407     * disposed: vertically or horizontally.
19408     *
19409     * @see elm_progressbar_horizontal_get()
19410     *
19411     * @ingroup Progressbar
19412     */
19413    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19414
19415    /**
19416     * Retrieve the orientation of a given progress bar widget
19417     *
19418     * @param obj The progress bar object
19419     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19420     * @c EINA_FALSE if it's @b vertical (and on errors)
19421     *
19422     * @see elm_progressbar_horizontal_set() for more details
19423     *
19424     * @ingroup Progressbar
19425     */
19426    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19427
19428    /**
19429     * Invert a given progress bar widget's displaying values order
19430     *
19431     * @param obj The progress bar object
19432     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19433     * @c EINA_FALSE to bring it back to default, non-inverted values.
19434     *
19435     * A progress bar may be @b inverted, in which state it gets its
19436     * values inverted, with high values being on the left or top and
19437     * low values on the right or bottom, as opposed to normally have
19438     * the low values on the former and high values on the latter,
19439     * respectively, for horizontal and vertical modes.
19440     *
19441     * @see elm_progressbar_inverted_get()
19442     *
19443     * @ingroup Progressbar
19444     */
19445    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19446
19447    /**
19448     * Get whether a given progress bar widget's displaying values are
19449     * inverted or not
19450     *
19451     * @param obj The progress bar object
19452     * @return @c EINA_TRUE, if @p obj has inverted values,
19453     * @c EINA_FALSE otherwise (and on errors)
19454     *
19455     * @see elm_progressbar_inverted_set() for more details
19456     *
19457     * @ingroup Progressbar
19458     */
19459    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19460
19461    /**
19462     * @defgroup Separator Separator
19463     *
19464     * @brief Separator is a very thin object used to separate other objects.
19465     *
19466     * A separator can be vertical or horizontal.
19467     *
19468     * @ref tutorial_separator is a good example of how to use a separator.
19469     * @{
19470     */
19471    /**
19472     * @brief Add a separator object to @p parent
19473     *
19474     * @param parent The parent object
19475     *
19476     * @return The separator object, or NULL upon failure
19477     */
19478    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19479    /**
19480     * @brief Set the horizontal mode of a separator object
19481     *
19482     * @param obj The separator object
19483     * @param horizontal If true, the separator is horizontal
19484     */
19485    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19486    /**
19487     * @brief Get the horizontal mode of a separator object
19488     *
19489     * @param obj The separator object
19490     * @return If true, the separator is horizontal
19491     *
19492     * @see elm_separator_horizontal_set()
19493     */
19494    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19495    /**
19496     * @}
19497     */
19498
19499    /**
19500     * @defgroup Spinner Spinner
19501     * @ingroup Elementary
19502     *
19503     * @image html img/widget/spinner/preview-00.png
19504     * @image latex img/widget/spinner/preview-00.eps
19505     *
19506     * A spinner is a widget which allows the user to increase or decrease
19507     * numeric values using arrow buttons, or edit values directly, clicking
19508     * over it and typing the new value.
19509     *
19510     * By default the spinner will not wrap and has a label
19511     * of "%.0f" (just showing the integer value of the double).
19512     *
19513     * A spinner has a label that is formatted with floating
19514     * point values and thus accepts a printf-style format string, like
19515     * “%1.2f units”.
19516     *
19517     * It also allows specific values to be replaced by pre-defined labels.
19518     *
19519     * Smart callbacks one can register to:
19520     *
19521     * - "changed" - Whenever the spinner value is changed.
19522     * - "delay,changed" - A short time after the value is changed by the user.
19523     *    This will be called only when the user stops dragging for a very short
19524     *    period or when they release their finger/mouse, so it avoids possibly
19525     *    expensive reactions to the value change.
19526     *
19527     * Available styles for it:
19528     * - @c "default";
19529     * - @c "vertical": up/down buttons at the right side and text left aligned.
19530     *
19531     * Here is an example on its usage:
19532     * @ref spinner_example
19533     */
19534
19535    /**
19536     * @addtogroup Spinner
19537     * @{
19538     */
19539
19540    /**
19541     * Add a new spinner widget to the given parent Elementary
19542     * (container) object.
19543     *
19544     * @param parent The parent object.
19545     * @return a new spinner widget handle or @c NULL, on errors.
19546     *
19547     * This function inserts a new spinner widget on the canvas.
19548     *
19549     * @ingroup Spinner
19550     *
19551     */
19552    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19553
19554    /**
19555     * Set the format string of the displayed label.
19556     *
19557     * @param obj The spinner object.
19558     * @param fmt The format string for the label display.
19559     *
19560     * If @c NULL, this sets the format to "%.0f". If not it sets the format
19561     * string for the label text. The label text is provided a floating point
19562     * value, so the label text can display up to 1 floating point value.
19563     * Note that this is optional.
19564     *
19565     * Use a format string such as "%1.2f meters" for example, and it will
19566     * display values like: "3.14 meters" for a value equal to 3.14159.
19567     *
19568     * Default is "%0.f".
19569     *
19570     * @see elm_spinner_label_format_get()
19571     *
19572     * @ingroup Spinner
19573     */
19574    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19575
19576    /**
19577     * Get the label format of the spinner.
19578     *
19579     * @param obj The spinner object.
19580     * @return The text label format string in UTF-8.
19581     *
19582     * @see elm_spinner_label_format_set() for details.
19583     *
19584     * @ingroup Spinner
19585     */
19586    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19587
19588    /**
19589     * Set the minimum and maximum values for the spinner.
19590     *
19591     * @param obj The spinner object.
19592     * @param min The minimum value.
19593     * @param max The maximum value.
19594     *
19595     * Define the allowed range of values to be selected by the user.
19596     *
19597     * If actual value is less than @p min, it will be updated to @p min. If it
19598     * is bigger then @p max, will be updated to @p max. Actual value can be
19599     * get with elm_spinner_value_get().
19600     *
19601     * By default, min is equal to 0, and max is equal to 100.
19602     *
19603     * @warning Maximum must be greater than minimum.
19604     *
19605     * @see elm_spinner_min_max_get()
19606     *
19607     * @ingroup Spinner
19608     */
19609    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19610
19611    /**
19612     * Get the minimum and maximum values of the spinner.
19613     *
19614     * @param obj The spinner object.
19615     * @param min Pointer where to store the minimum value.
19616     * @param max Pointer where to store the maximum value.
19617     *
19618     * @note If only one value is needed, the other pointer can be passed
19619     * as @c NULL.
19620     *
19621     * @see elm_spinner_min_max_set() for details.
19622     *
19623     * @ingroup Spinner
19624     */
19625    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19626
19627    /**
19628     * Set the step used to increment or decrement the spinner value.
19629     *
19630     * @param obj The spinner object.
19631     * @param step The step value.
19632     *
19633     * This value will be incremented or decremented to the displayed value.
19634     * It will be incremented while the user keep right or top arrow pressed,
19635     * and will be decremented while the user keep left or bottom arrow pressed.
19636     *
19637     * The interval to increment / decrement can be set with
19638     * elm_spinner_interval_set().
19639     *
19640     * By default step value is equal to 1.
19641     *
19642     * @see elm_spinner_step_get()
19643     *
19644     * @ingroup Spinner
19645     */
19646    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19647
19648    /**
19649     * Get the step used to increment or decrement the spinner value.
19650     *
19651     * @param obj The spinner object.
19652     * @return The step value.
19653     *
19654     * @see elm_spinner_step_get() for more details.
19655     *
19656     * @ingroup Spinner
19657     */
19658    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19659
19660    /**
19661     * Set the value the spinner displays.
19662     *
19663     * @param obj The spinner object.
19664     * @param val The value to be displayed.
19665     *
19666     * Value will be presented on the label following format specified with
19667     * elm_spinner_format_set().
19668     *
19669     * @warning The value must to be between min and max values. This values
19670     * are set by elm_spinner_min_max_set().
19671     *
19672     * @see elm_spinner_value_get().
19673     * @see elm_spinner_format_set().
19674     * @see elm_spinner_min_max_set().
19675     *
19676     * @ingroup Spinner
19677     */
19678    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19679
19680    /**
19681     * Get the value displayed by the spinner.
19682     *
19683     * @param obj The spinner object.
19684     * @return The value displayed.
19685     *
19686     * @see elm_spinner_value_set() for details.
19687     *
19688     * @ingroup Spinner
19689     */
19690    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19691
19692    /**
19693     * Set whether the spinner should wrap when it reaches its
19694     * minimum or maximum value.
19695     *
19696     * @param obj The spinner object.
19697     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19698     * disable it.
19699     *
19700     * Disabled by default. If disabled, when the user tries to increment the
19701     * value,
19702     * but displayed value plus step value is bigger than maximum value,
19703     * the spinner
19704     * won't allow it. The same happens when the user tries to decrement it,
19705     * but the value less step is less than minimum value.
19706     *
19707     * When wrap is enabled, in such situations it will allow these changes,
19708     * but will get the value that would be less than minimum and subtracts
19709     * from maximum. Or add the value that would be more than maximum to
19710     * the minimum.
19711     *
19712     * E.g.:
19713     * @li min value = 10
19714     * @li max value = 50
19715     * @li step value = 20
19716     * @li displayed value = 20
19717     *
19718     * When the user decrement value (using left or bottom arrow), it will
19719     * displays @c 40, because max - (min - (displayed - step)) is
19720     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
19721     *
19722     * @see elm_spinner_wrap_get().
19723     *
19724     * @ingroup Spinner
19725     */
19726    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
19727
19728    /**
19729     * Get whether the spinner should wrap when it reaches its
19730     * minimum or maximum value.
19731     *
19732     * @param obj The spinner object
19733     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
19734     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19735     *
19736     * @see elm_spinner_wrap_set() for details.
19737     *
19738     * @ingroup Spinner
19739     */
19740    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19741
19742    /**
19743     * Set whether the spinner can be directly edited by the user or not.
19744     *
19745     * @param obj The spinner object.
19746     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
19747     * don't allow users to edit it directly.
19748     *
19749     * Spinner objects can have edition @b disabled, in which state they will
19750     * be changed only by arrows.
19751     * Useful for contexts
19752     * where you don't want your users to interact with it writting the value.
19753     * Specially
19754     * when using special values, the user can see real value instead
19755     * of special label on edition.
19756     *
19757     * It's enabled by default.
19758     *
19759     * @see elm_spinner_editable_get()
19760     *
19761     * @ingroup Spinner
19762     */
19763    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
19764
19765    /**
19766     * Get whether the spinner can be directly edited by the user or not.
19767     *
19768     * @param obj The spinner object.
19769     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
19770     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
19771     *
19772     * @see elm_spinner_editable_set() for details.
19773     *
19774     * @ingroup Spinner
19775     */
19776    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19777
19778    /**
19779     * Set a special string to display in the place of the numerical value.
19780     *
19781     * @param obj The spinner object.
19782     * @param value The value to be replaced.
19783     * @param label The label to be used.
19784     *
19785     * It's useful for cases when a user should select an item that is
19786     * better indicated by a label than a value. For example, weekdays or months.
19787     *
19788     * E.g.:
19789     * @code
19790     * sp = elm_spinner_add(win);
19791     * elm_spinner_min_max_set(sp, 1, 3);
19792     * elm_spinner_special_value_add(sp, 1, "January");
19793     * elm_spinner_special_value_add(sp, 2, "February");
19794     * elm_spinner_special_value_add(sp, 3, "March");
19795     * evas_object_show(sp);
19796     * @endcode
19797     *
19798     * @ingroup Spinner
19799     */
19800    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
19801
19802    /**
19803     * Set the interval on time updates for an user mouse button hold
19804     * on spinner widgets' arrows.
19805     *
19806     * @param obj The spinner object.
19807     * @param interval The (first) interval value in seconds.
19808     *
19809     * This interval value is @b decreased while the user holds the
19810     * mouse pointer either incrementing or decrementing spinner's value.
19811     *
19812     * This helps the user to get to a given value distant from the
19813     * current one easier/faster, as it will start to change quicker and
19814     * quicker on mouse button holds.
19815     *
19816     * The calculation for the next change interval value, starting from
19817     * the one set with this call, is the previous interval divided by
19818     * @c 1.05, so it decreases a little bit.
19819     *
19820     * The default starting interval value for automatic changes is
19821     * @c 0.85 seconds.
19822     *
19823     * @see elm_spinner_interval_get()
19824     *
19825     * @ingroup Spinner
19826     */
19827    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
19828
19829    /**
19830     * Get the interval on time updates for an user mouse button hold
19831     * on spinner widgets' arrows.
19832     *
19833     * @param obj The spinner object.
19834     * @return The (first) interval value, in seconds, set on it.
19835     *
19836     * @see elm_spinner_interval_set() for more details.
19837     *
19838     * @ingroup Spinner
19839     */
19840    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19841
19842    /**
19843     * @}
19844     */
19845
19846    /**
19847     * @defgroup Index Index
19848     *
19849     * @image html img/widget/index/preview-00.png
19850     * @image latex img/widget/index/preview-00.eps
19851     *
19852     * An index widget gives you an index for fast access to whichever
19853     * group of other UI items one might have. It's a list of text
19854     * items (usually letters, for alphabetically ordered access).
19855     *
19856     * Index widgets are by default hidden and just appear when the
19857     * user clicks over it's reserved area in the canvas. In its
19858     * default theme, it's an area one @ref Fingers "finger" wide on
19859     * the right side of the index widget's container.
19860     *
19861     * When items on the index are selected, smart callbacks get
19862     * called, so that its user can make other container objects to
19863     * show a given area or child object depending on the index item
19864     * selected. You'd probably be using an index together with @ref
19865     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
19866     * "general grids".
19867     *
19868     * Smart events one  can add callbacks for are:
19869     * - @c "changed" - When the selected index item changes. @c
19870     *      event_info is the selected item's data pointer.
19871     * - @c "delay,changed" - When the selected index item changes, but
19872     *      after a small idling period. @c event_info is the selected
19873     *      item's data pointer.
19874     * - @c "selected" - When the user releases a mouse button and
19875     *      selects an item. @c event_info is the selected item's data
19876     *      pointer.
19877     * - @c "level,up" - when the user moves a finger from the first
19878     *      level to the second level
19879     * - @c "level,down" - when the user moves a finger from the second
19880     *      level to the first level
19881     *
19882     * The @c "delay,changed" event is so that it'll wait a small time
19883     * before actually reporting those events and, moreover, just the
19884     * last event happening on those time frames will actually be
19885     * reported.
19886     *
19887     * Here are some examples on its usage:
19888     * @li @ref index_example_01
19889     * @li @ref index_example_02
19890     */
19891
19892    /**
19893     * @addtogroup Index
19894     * @{
19895     */
19896
19897    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
19898
19899    /**
19900     * Add a new index widget to the given parent Elementary
19901     * (container) object
19902     *
19903     * @param parent The parent object
19904     * @return a new index widget handle or @c NULL, on errors
19905     *
19906     * This function inserts a new index widget on the canvas.
19907     *
19908     * @ingroup Index
19909     */
19910    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19911
19912    /**
19913     * Set whether a given index widget is or not visible,
19914     * programatically.
19915     *
19916     * @param obj The index object
19917     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
19918     *
19919     * Not to be confused with visible as in @c evas_object_show() --
19920     * visible with regard to the widget's auto hiding feature.
19921     *
19922     * @see elm_index_active_get()
19923     *
19924     * @ingroup Index
19925     */
19926    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
19927
19928    /**
19929     * Get whether a given index widget is currently visible or not.
19930     *
19931     * @param obj The index object
19932     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
19933     *
19934     * @see elm_index_active_set() for more details
19935     *
19936     * @ingroup Index
19937     */
19938    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19939
19940    /**
19941     * Set the items level for a given index widget.
19942     *
19943     * @param obj The index object.
19944     * @param level @c 0 or @c 1, the currently implemented levels.
19945     *
19946     * @see elm_index_item_level_get()
19947     *
19948     * @ingroup Index
19949     */
19950    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
19951
19952    /**
19953     * Get the items level set for a given index widget.
19954     *
19955     * @param obj The index object.
19956     * @return @c 0 or @c 1, which are the levels @p obj might be at.
19957     *
19958     * @see elm_index_item_level_set() for more information
19959     *
19960     * @ingroup Index
19961     */
19962    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19963
19964    /**
19965     * Returns the last selected item's data, for a given index widget.
19966     *
19967     * @param obj The index object.
19968     * @return The item @b data associated to the last selected item on
19969     * @p obj (or @c NULL, on errors).
19970     *
19971     * @warning The returned value is @b not an #Elm_Index_Item item
19972     * handle, but the data associated to it (see the @c item parameter
19973     * in elm_index_item_append(), as an example).
19974     *
19975     * @ingroup Index
19976     */
19977    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
19978
19979    /**
19980     * Append a new item on a given index widget.
19981     *
19982     * @param obj The index object.
19983     * @param letter Letter under which the item should be indexed
19984     * @param item The item data to set for the index's item
19985     *
19986     * Despite the most common usage of the @p letter argument is for
19987     * single char strings, one could use arbitrary strings as index
19988     * entries.
19989     *
19990     * @c item will be the pointer returned back on @c "changed", @c
19991     * "delay,changed" and @c "selected" smart events.
19992     *
19993     * @ingroup Index
19994     */
19995    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
19996
19997    /**
19998     * Prepend a new item on a given index widget.
19999     *
20000     * @param obj The index object.
20001     * @param letter Letter under which the item should be indexed
20002     * @param item The item data to set for the index's item
20003     *
20004     * Despite the most common usage of the @p letter argument is for
20005     * single char strings, one could use arbitrary strings as index
20006     * entries.
20007     *
20008     * @c item will be the pointer returned back on @c "changed", @c
20009     * "delay,changed" and @c "selected" smart events.
20010     *
20011     * @ingroup Index
20012     */
20013    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20014
20015    /**
20016     * Append a new item, on a given index widget, <b>after the item
20017     * having @p relative as data</b>.
20018     *
20019     * @param obj The index object.
20020     * @param letter Letter under which the item should be indexed
20021     * @param item The item data to set for the index's item
20022     * @param relative The item data of the index item to be the
20023     * predecessor of this new one
20024     *
20025     * Despite the most common usage of the @p letter argument is for
20026     * single char strings, one could use arbitrary strings as index
20027     * entries.
20028     *
20029     * @c item will be the pointer returned back on @c "changed", @c
20030     * "delay,changed" and @c "selected" smart events.
20031     *
20032     * @note If @p relative is @c NULL or if it's not found to be data
20033     * set on any previous item on @p obj, this function will behave as
20034     * elm_index_item_append().
20035     *
20036     * @ingroup Index
20037     */
20038    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20039
20040    /**
20041     * Prepend a new item, on a given index widget, <b>after the item
20042     * having @p relative as data</b>.
20043     *
20044     * @param obj The index object.
20045     * @param letter Letter under which the item should be indexed
20046     * @param item The item data to set for the index's item
20047     * @param relative The item data of the index item to be the
20048     * successor of this new one
20049     *
20050     * Despite the most common usage of the @p letter argument is for
20051     * single char strings, one could use arbitrary strings as index
20052     * entries.
20053     *
20054     * @c item will be the pointer returned back on @c "changed", @c
20055     * "delay,changed" and @c "selected" smart events.
20056     *
20057     * @note If @p relative is @c NULL or if it's not found to be data
20058     * set on any previous item on @p obj, this function will behave as
20059     * elm_index_item_prepend().
20060     *
20061     * @ingroup Index
20062     */
20063    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20064
20065    /**
20066     * Insert a new item into the given index widget, using @p cmp_func
20067     * function to sort items (by item handles).
20068     *
20069     * @param obj The index object.
20070     * @param letter Letter under which the item should be indexed
20071     * @param item The item data to set for the index's item
20072     * @param cmp_func The comparing function to be used to sort index
20073     * items <b>by #Elm_Index_Item item handles</b>
20074     * @param cmp_data_func A @b fallback function to be called for the
20075     * sorting of index items <b>by item data</b>). It will be used
20076     * when @p cmp_func returns @c 0 (equality), which means an index
20077     * item with provided item data already exists. To decide which
20078     * data item should be pointed to by the index item in question, @p
20079     * cmp_data_func will be used. If @p cmp_data_func returns a
20080     * non-negative value, the previous index item data will be
20081     * replaced by the given @p item pointer. If the previous data need
20082     * to be freed, it should be done by the @p cmp_data_func function,
20083     * because all references to it will be lost. If this function is
20084     * not provided (@c NULL is given), index items will be @b
20085     * duplicated, if @p cmp_func returns @c 0.
20086     *
20087     * Despite the most common usage of the @p letter argument is for
20088     * single char strings, one could use arbitrary strings as index
20089     * entries.
20090     *
20091     * @c item will be the pointer returned back on @c "changed", @c
20092     * "delay,changed" and @c "selected" smart events.
20093     *
20094     * @ingroup Index
20095     */
20096    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);
20097
20098    /**
20099     * Remove an item from a given index widget, <b>to be referenced by
20100     * it's data value</b>.
20101     *
20102     * @param obj The index object
20103     * @param item The item's data pointer for the item to be removed
20104     * from @p obj
20105     *
20106     * If a deletion callback is set, via elm_index_item_del_cb_set(),
20107     * that callback function will be called by this one.
20108     *
20109     * @warning The item to be removed from @p obj will be found via
20110     * its item data pointer, and not by an #Elm_Index_Item handle.
20111     *
20112     * @ingroup Index
20113     */
20114    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20115
20116    /**
20117     * Find a given index widget's item, <b>using item data</b>.
20118     *
20119     * @param obj The index object
20120     * @param item The item data pointed to by the desired index item
20121     * @return The index item handle, if found, or @c NULL otherwise
20122     *
20123     * @ingroup Index
20124     */
20125    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20126
20127    /**
20128     * Removes @b all items from a given index widget.
20129     *
20130     * @param obj The index object.
20131     *
20132     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20133     * that callback function will be called for each item in @p obj.
20134     *
20135     * @ingroup Index
20136     */
20137    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20138
20139    /**
20140     * Go to a given items level on a index widget
20141     *
20142     * @param obj The index object
20143     * @param level The index level (one of @c 0 or @c 1)
20144     *
20145     * @ingroup Index
20146     */
20147    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20148
20149    /**
20150     * Return the data associated with a given index widget item
20151     *
20152     * @param it The index widget item handle
20153     * @return The data associated with @p it
20154     *
20155     * @see elm_index_item_data_set()
20156     *
20157     * @ingroup Index
20158     */
20159    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20160
20161    /**
20162     * Set the data associated with a given index widget item
20163     *
20164     * @param it The index widget item handle
20165     * @param data The new data pointer to set to @p it
20166     *
20167     * This sets new item data on @p it.
20168     *
20169     * @warning The old data pointer won't be touched by this function, so
20170     * the user had better to free that old data himself/herself.
20171     *
20172     * @ingroup Index
20173     */
20174    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20175
20176    /**
20177     * Set the function to be called when a given index widget item is freed.
20178     *
20179     * @param it The item to set the callback on
20180     * @param func The function to call on the item's deletion
20181     *
20182     * When called, @p func will have both @c data and @c event_info
20183     * arguments with the @p it item's data value and, naturally, the
20184     * @c obj argument with a handle to the parent index widget.
20185     *
20186     * @ingroup Index
20187     */
20188    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20189
20190    /**
20191     * Get the letter (string) set on a given index widget item.
20192     *
20193     * @param it The index item handle
20194     * @return The letter string set on @p it
20195     *
20196     * @ingroup Index
20197     */
20198    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20199
20200    /**
20201     * @}
20202     */
20203
20204    /**
20205     * @defgroup Photocam Photocam
20206     *
20207     * @image html img/widget/photocam/preview-00.png
20208     * @image latex img/widget/photocam/preview-00.eps
20209     *
20210     * This is a widget specifically for displaying high-resolution digital
20211     * camera photos giving speedy feedback (fast load), low memory footprint
20212     * and zooming and panning as well as fitting logic. It is entirely focused
20213     * on jpeg images, and takes advantage of properties of the jpeg format (via
20214     * evas loader features in the jpeg loader).
20215     *
20216     * Signals that you can add callbacks for are:
20217     * @li "clicked" - This is called when a user has clicked the photo without
20218     *                 dragging around.
20219     * @li "press" - This is called when a user has pressed down on the photo.
20220     * @li "longpressed" - This is called when a user has pressed down on the
20221     *                     photo for a long time without dragging around.
20222     * @li "clicked,double" - This is called when a user has double-clicked the
20223     *                        photo.
20224     * @li "load" - Photo load begins.
20225     * @li "loaded" - This is called when the image file load is complete for the
20226     *                first view (low resolution blurry version).
20227     * @li "load,detail" - Photo detailed data load begins.
20228     * @li "loaded,detail" - This is called when the image file load is complete
20229     *                      for the detailed image data (full resolution needed).
20230     * @li "zoom,start" - Zoom animation started.
20231     * @li "zoom,stop" - Zoom animation stopped.
20232     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20233     * @li "scroll" - the content has been scrolled (moved)
20234     * @li "scroll,anim,start" - scrolling animation has started
20235     * @li "scroll,anim,stop" - scrolling animation has stopped
20236     * @li "scroll,drag,start" - dragging the contents around has started
20237     * @li "scroll,drag,stop" - dragging the contents around has stopped
20238     *
20239     * @ref tutorial_photocam shows the API in action.
20240     * @{
20241     */
20242    /**
20243     * @brief Types of zoom available.
20244     */
20245    typedef enum _Elm_Photocam_Zoom_Mode
20246      {
20247         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20248         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20249         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20250         ELM_PHOTOCAM_ZOOM_MODE_LAST
20251      } Elm_Photocam_Zoom_Mode;
20252    /**
20253     * @brief Add a new Photocam object
20254     *
20255     * @param parent The parent object
20256     * @return The new object or NULL if it cannot be created
20257     */
20258    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20259    /**
20260     * @brief Set the photo file to be shown
20261     *
20262     * @param obj The photocam object
20263     * @param file The photo file
20264     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20265     *
20266     * This sets (and shows) the specified file (with a relative or absolute
20267     * path) and will return a load error (same error that
20268     * evas_object_image_load_error_get() will return). The image will change and
20269     * adjust its size at this point and begin a background load process for this
20270     * photo that at some time in the future will be displayed at the full
20271     * quality needed.
20272     */
20273    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20274    /**
20275     * @brief Returns the path of the current image file
20276     *
20277     * @param obj The photocam object
20278     * @return Returns the path
20279     *
20280     * @see elm_photocam_file_set()
20281     */
20282    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20283    /**
20284     * @brief Set the zoom level of the photo
20285     *
20286     * @param obj The photocam object
20287     * @param zoom The zoom level to set
20288     *
20289     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20290     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20291     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20292     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20293     * 16, 32, etc.).
20294     */
20295    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20296    /**
20297     * @brief Get the zoom level of the photo
20298     *
20299     * @param obj The photocam object
20300     * @return The current zoom level
20301     *
20302     * This returns the current zoom level of the photocam object. Note that if
20303     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20304     * (which is the default), the zoom level may be changed at any time by the
20305     * photocam object itself to account for photo size and photocam viewpoer
20306     * size.
20307     *
20308     * @see elm_photocam_zoom_set()
20309     * @see elm_photocam_zoom_mode_set()
20310     */
20311    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20312    /**
20313     * @brief Set the zoom mode
20314     *
20315     * @param obj The photocam object
20316     * @param mode The desired mode
20317     *
20318     * This sets the zoom mode to manual or one of several automatic levels.
20319     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20320     * elm_photocam_zoom_set() and will stay at that level until changed by code
20321     * or until zoom mode is changed. This is the default mode. The Automatic
20322     * modes will allow the photocam object to automatically adjust zoom mode
20323     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20324     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20325     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20326     * pixels within the frame are left unfilled.
20327     */
20328    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20329    /**
20330     * @brief Get the zoom mode
20331     *
20332     * @param obj The photocam object
20333     * @return The current zoom mode
20334     *
20335     * This gets the current zoom mode of the photocam object.
20336     *
20337     * @see elm_photocam_zoom_mode_set()
20338     */
20339    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20340    /**
20341     * @brief Get the current image pixel width and height
20342     *
20343     * @param obj The photocam object
20344     * @param w A pointer to the width return
20345     * @param h A pointer to the height return
20346     *
20347     * This gets the current photo pixel width and height (for the original).
20348     * The size will be returned in the integers @p w and @p h that are pointed
20349     * to.
20350     */
20351    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20352    /**
20353     * @brief Get the area of the image that is currently shown
20354     *
20355     * @param obj
20356     * @param x A pointer to the X-coordinate of region
20357     * @param y A pointer to the Y-coordinate of region
20358     * @param w A pointer to the width
20359     * @param h A pointer to the height
20360     *
20361     * @see elm_photocam_image_region_show()
20362     * @see elm_photocam_image_region_bring_in()
20363     */
20364    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20365    /**
20366     * @brief Set the viewed portion of the image
20367     *
20368     * @param obj The photocam object
20369     * @param x X-coordinate of region in image original pixels
20370     * @param y Y-coordinate of region in image original pixels
20371     * @param w Width of region in image original pixels
20372     * @param h Height of region in image original pixels
20373     *
20374     * This shows the region of the image without using animation.
20375     */
20376    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20377    /**
20378     * @brief Bring in the viewed portion of the image
20379     *
20380     * @param obj The photocam object
20381     * @param x X-coordinate of region in image original pixels
20382     * @param y Y-coordinate of region in image original pixels
20383     * @param w Width of region in image original pixels
20384     * @param h Height of region in image original pixels
20385     *
20386     * This shows the region of the image using animation.
20387     */
20388    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20389    /**
20390     * @brief Set the paused state for photocam
20391     *
20392     * @param obj The photocam object
20393     * @param paused The pause state to set
20394     *
20395     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20396     * photocam. The default is off. This will stop zooming using animation on
20397     * zoom levels changes and change instantly. This will stop any existing
20398     * animations that are running.
20399     */
20400    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20401    /**
20402     * @brief Get the paused state for photocam
20403     *
20404     * @param obj The photocam object
20405     * @return The current paused state
20406     *
20407     * This gets the current paused state for the photocam object.
20408     *
20409     * @see elm_photocam_paused_set()
20410     */
20411    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20412    /**
20413     * @brief Get the internal low-res image used for photocam
20414     *
20415     * @param obj The photocam object
20416     * @return The internal image object handle, or NULL if none exists
20417     *
20418     * This gets the internal image object inside photocam. Do not modify it. It
20419     * is for inspection only, and hooking callbacks to. Nothing else. It may be
20420     * deleted at any time as well.
20421     */
20422    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20423    /**
20424     * @brief Set the photocam scrolling bouncing.
20425     *
20426     * @param obj The photocam object
20427     * @param h_bounce bouncing for horizontal
20428     * @param v_bounce bouncing for vertical
20429     */
20430    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20431    /**
20432     * @brief Get the photocam scrolling bouncing.
20433     *
20434     * @param obj The photocam object
20435     * @param h_bounce bouncing for horizontal
20436     * @param v_bounce bouncing for vertical
20437     *
20438     * @see elm_photocam_bounce_set()
20439     */
20440    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20441    /**
20442     * @}
20443     */
20444
20445    /**
20446     * @defgroup Map Map
20447     * @ingroup Elementary
20448     *
20449     * @image html img/widget/map/preview-00.png
20450     * @image latex img/widget/map/preview-00.eps
20451     *
20452     * This is a widget specifically for displaying a map. It uses basically
20453     * OpenStreetMap provider http://www.openstreetmap.org/,
20454     * but custom providers can be added.
20455     *
20456     * It supports some basic but yet nice features:
20457     * @li zoom and scroll
20458     * @li markers with content to be displayed when user clicks over it
20459     * @li group of markers
20460     * @li routes
20461     *
20462     * Smart callbacks one can listen to:
20463     *
20464     * - "clicked" - This is called when a user has clicked the map without
20465     *   dragging around.
20466     * - "press" - This is called when a user has pressed down on the map.
20467     * - "longpressed" - This is called when a user has pressed down on the map
20468     *   for a long time without dragging around.
20469     * - "clicked,double" - This is called when a user has double-clicked
20470     *   the map.
20471     * - "load,detail" - Map detailed data load begins.
20472     * - "loaded,detail" - This is called when all currently visible parts of
20473     *   the map are loaded.
20474     * - "zoom,start" - Zoom animation started.
20475     * - "zoom,stop" - Zoom animation stopped.
20476     * - "zoom,change" - Zoom changed when using an auto zoom mode.
20477     * - "scroll" - the content has been scrolled (moved).
20478     * - "scroll,anim,start" - scrolling animation has started.
20479     * - "scroll,anim,stop" - scrolling animation has stopped.
20480     * - "scroll,drag,start" - dragging the contents around has started.
20481     * - "scroll,drag,stop" - dragging the contents around has stopped.
20482     * - "downloaded" - This is called when all currently required map images
20483     *   are downloaded.
20484     * - "route,load" - This is called when route request begins.
20485     * - "route,loaded" - This is called when route request ends.
20486     * - "name,load" - This is called when name request begins.
20487     * - "name,loaded- This is called when name request ends.
20488     *
20489     * Available style for map widget:
20490     * - @c "default"
20491     *
20492     * Available style for markers:
20493     * - @c "radio"
20494     * - @c "radio2"
20495     * - @c "empty"
20496     *
20497     * Available style for marker bubble:
20498     * - @c "default"
20499     *
20500     * List of examples:
20501     * @li @ref map_example_01
20502     * @li @ref map_example_02
20503     * @li @ref map_example_03
20504     */
20505
20506    /**
20507     * @addtogroup Map
20508     * @{
20509     */
20510
20511    /**
20512     * @enum _Elm_Map_Zoom_Mode
20513     * @typedef Elm_Map_Zoom_Mode
20514     *
20515     * Set map's zoom behavior. It can be set to manual or automatic.
20516     *
20517     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20518     *
20519     * Values <b> don't </b> work as bitmask, only one can be choosen.
20520     *
20521     * @note Valid sizes are 2^zoom, consequently the map may be smaller
20522     * than the scroller view.
20523     *
20524     * @see elm_map_zoom_mode_set()
20525     * @see elm_map_zoom_mode_get()
20526     *
20527     * @ingroup Map
20528     */
20529    typedef enum _Elm_Map_Zoom_Mode
20530      {
20531         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20532         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20533         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20534         ELM_MAP_ZOOM_MODE_LAST
20535      } Elm_Map_Zoom_Mode;
20536
20537    /**
20538     * @enum _Elm_Map_Route_Sources
20539     * @typedef Elm_Map_Route_Sources
20540     *
20541     * Set route service to be used. By default used source is
20542     * #ELM_MAP_ROUTE_SOURCE_YOURS.
20543     *
20544     * @see elm_map_route_source_set()
20545     * @see elm_map_route_source_get()
20546     *
20547     * @ingroup Map
20548     */
20549    typedef enum _Elm_Map_Route_Sources
20550      {
20551         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20552         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. */
20553         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20554         ELM_MAP_ROUTE_SOURCE_LAST
20555      } Elm_Map_Route_Sources;
20556
20557    typedef enum _Elm_Map_Name_Sources
20558      {
20559         ELM_MAP_NAME_SOURCE_NOMINATIM,
20560         ELM_MAP_NAME_SOURCE_LAST
20561      } Elm_Map_Name_Sources;
20562
20563    /**
20564     * @enum _Elm_Map_Route_Type
20565     * @typedef Elm_Map_Route_Type
20566     *
20567     * Set type of transport used on route.
20568     *
20569     * @see elm_map_route_add()
20570     *
20571     * @ingroup Map
20572     */
20573    typedef enum _Elm_Map_Route_Type
20574      {
20575         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20576         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20577         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20578         ELM_MAP_ROUTE_TYPE_LAST
20579      } Elm_Map_Route_Type;
20580
20581    /**
20582     * @enum _Elm_Map_Route_Method
20583     * @typedef Elm_Map_Route_Method
20584     *
20585     * Set the routing method, what should be priorized, time or distance.
20586     *
20587     * @see elm_map_route_add()
20588     *
20589     * @ingroup Map
20590     */
20591    typedef enum _Elm_Map_Route_Method
20592      {
20593         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20594         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20595         ELM_MAP_ROUTE_METHOD_LAST
20596      } Elm_Map_Route_Method;
20597
20598    typedef enum _Elm_Map_Name_Method
20599      {
20600         ELM_MAP_NAME_METHOD_SEARCH,
20601         ELM_MAP_NAME_METHOD_REVERSE,
20602         ELM_MAP_NAME_METHOD_LAST
20603      } Elm_Map_Name_Method;
20604
20605    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(). */
20606    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(). */
20607    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(). */
20608    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(). */
20609    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
20610    typedef struct _Elm_Map_Track           Elm_Map_Track;
20611
20612    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. */
20613    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20614    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20615    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20616
20617    typedef char        *(*ElmMapModuleSourceFunc) (void);
20618    typedef int          (*ElmMapModuleZoomMinFunc) (void);
20619    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
20620    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20621    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
20622    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20623    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20624    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20625    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20626
20627    /**
20628     * Add a new map widget to the given parent Elementary (container) object.
20629     *
20630     * @param parent The parent object.
20631     * @return a new map widget handle or @c NULL, on errors.
20632     *
20633     * This function inserts a new map widget on the canvas.
20634     *
20635     * @ingroup Map
20636     */
20637    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20638
20639    /**
20640     * Set the zoom level of the map.
20641     *
20642     * @param obj The map object.
20643     * @param zoom The zoom level to set.
20644     *
20645     * This sets the zoom level.
20646     *
20647     * It will respect limits defined by elm_map_source_zoom_min_set() and
20648     * elm_map_source_zoom_max_set().
20649     *
20650     * By default these values are 0 (world map) and 18 (maximum zoom).
20651     *
20652     * This function should be used when zoom mode is set to
20653     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20654     * with elm_map_zoom_mode_set().
20655     *
20656     * @see elm_map_zoom_mode_set().
20657     * @see elm_map_zoom_get().
20658     *
20659     * @ingroup Map
20660     */
20661    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20662
20663    /**
20664     * Get the zoom level of the map.
20665     *
20666     * @param obj The map object.
20667     * @return The current zoom level.
20668     *
20669     * This returns the current zoom level of the map object.
20670     *
20671     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20672     * (which is the default), the zoom level may be changed at any time by the
20673     * map object itself to account for map size and map viewport size.
20674     *
20675     * @see elm_map_zoom_set() for details.
20676     *
20677     * @ingroup Map
20678     */
20679    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20680
20681    /**
20682     * Set the zoom mode used by the map object.
20683     *
20684     * @param obj The map object.
20685     * @param mode The zoom mode of the map, being it one of
20686     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20687     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20688     *
20689     * This sets the zoom mode to manual or one of the automatic levels.
20690     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20691     * elm_map_zoom_set() and will stay at that level until changed by code
20692     * or until zoom mode is changed. This is the default mode.
20693     *
20694     * The Automatic modes will allow the map object to automatically
20695     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20696     * adjust zoom so the map fits inside the scroll frame with no pixels
20697     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20698     * ensure no pixels within the frame are left unfilled. Do not forget that
20699     * the valid sizes are 2^zoom, consequently the map may be smaller than
20700     * the scroller view.
20701     *
20702     * @see elm_map_zoom_set()
20703     *
20704     * @ingroup Map
20705     */
20706    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20707
20708    /**
20709     * Get the zoom mode used by the map object.
20710     *
20711     * @param obj The map object.
20712     * @return The zoom mode of the map, being it one of
20713     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20714     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20715     *
20716     * This function returns the current zoom mode used by the map object.
20717     *
20718     * @see elm_map_zoom_mode_set() for more details.
20719     *
20720     * @ingroup Map
20721     */
20722    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20723
20724    /**
20725     * Get the current coordinates of the map.
20726     *
20727     * @param obj The map object.
20728     * @param lon Pointer where to store longitude.
20729     * @param lat Pointer where to store latitude.
20730     *
20731     * This gets the current center coordinates of the map object. It can be
20732     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
20733     *
20734     * @see elm_map_geo_region_bring_in()
20735     * @see elm_map_geo_region_show()
20736     *
20737     * @ingroup Map
20738     */
20739    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
20740
20741    /**
20742     * Animatedly bring in given coordinates to the center of the map.
20743     *
20744     * @param obj The map object.
20745     * @param lon Longitude to center at.
20746     * @param lat Latitude to center at.
20747     *
20748     * This causes map to jump to the given @p lat and @p lon coordinates
20749     * and show it (by scrolling) in the center of the viewport, if it is not
20750     * already centered. This will use animation to do so and take a period
20751     * of time to complete.
20752     *
20753     * @see elm_map_geo_region_show() for a function to avoid animation.
20754     * @see elm_map_geo_region_get()
20755     *
20756     * @ingroup Map
20757     */
20758    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20759
20760    /**
20761     * Show the given coordinates at the center of the map, @b immediately.
20762     *
20763     * @param obj The map object.
20764     * @param lon Longitude to center at.
20765     * @param lat Latitude to center at.
20766     *
20767     * This causes map to @b redraw its viewport's contents to the
20768     * region contining the given @p lat and @p lon, that will be moved to the
20769     * center of the map.
20770     *
20771     * @see elm_map_geo_region_bring_in() for a function to move with animation.
20772     * @see elm_map_geo_region_get()
20773     *
20774     * @ingroup Map
20775     */
20776    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20777
20778    /**
20779     * Pause or unpause the map.
20780     *
20781     * @param obj The map object.
20782     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
20783     * to unpause it.
20784     *
20785     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20786     * for map.
20787     *
20788     * The default is off.
20789     *
20790     * This will stop zooming using animation, changing zoom levels will
20791     * change instantly. This will stop any existing animations that are running.
20792     *
20793     * @see elm_map_paused_get()
20794     *
20795     * @ingroup Map
20796     */
20797    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20798
20799    /**
20800     * Get a value whether map is paused or not.
20801     *
20802     * @param obj The map object.
20803     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
20804     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
20805     *
20806     * This gets the current paused state for the map object.
20807     *
20808     * @see elm_map_paused_set() for details.
20809     *
20810     * @ingroup Map
20811     */
20812    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20813
20814    /**
20815     * Set to show markers during zoom level changes or not.
20816     *
20817     * @param obj The map object.
20818     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
20819     * to show them.
20820     *
20821     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20822     * for map.
20823     *
20824     * The default is off.
20825     *
20826     * This will stop zooming using animation, changing zoom levels will
20827     * change instantly. This will stop any existing animations that are running.
20828     *
20829     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
20830     * for the markers.
20831     *
20832     * The default  is off.
20833     *
20834     * Enabling it will force the map to stop displaying the markers during
20835     * zoom level changes. Set to on if you have a large number of markers.
20836     *
20837     * @see elm_map_paused_markers_get()
20838     *
20839     * @ingroup Map
20840     */
20841    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20842
20843    /**
20844     * Get a value whether markers will be displayed on zoom level changes or not
20845     *
20846     * @param obj The map object.
20847     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
20848     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
20849     *
20850     * This gets the current markers paused state for the map object.
20851     *
20852     * @see elm_map_paused_markers_set() for details.
20853     *
20854     * @ingroup Map
20855     */
20856    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20857
20858    /**
20859     * Get the information of downloading status.
20860     *
20861     * @param obj The map object.
20862     * @param try_num Pointer where to store number of tiles being downloaded.
20863     * @param finish_num Pointer where to store number of tiles successfully
20864     * downloaded.
20865     *
20866     * This gets the current downloading status for the map object, the number
20867     * of tiles being downloaded and the number of tiles already downloaded.
20868     *
20869     * @ingroup Map
20870     */
20871    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
20872
20873    /**
20874     * Convert a pixel coordinate (x,y) into a geographic coordinate
20875     * (longitude, latitude).
20876     *
20877     * @param obj The map object.
20878     * @param x the coordinate.
20879     * @param y the coordinate.
20880     * @param size the size in pixels of the map.
20881     * The map is a square and generally his size is : pow(2.0, zoom)*256.
20882     * @param lon Pointer where to store the longitude that correspond to x.
20883     * @param lat Pointer where to store the latitude that correspond to y.
20884     *
20885     * @note Origin pixel point is the top left corner of the viewport.
20886     * Map zoom and size are taken on account.
20887     *
20888     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
20889     *
20890     * @ingroup Map
20891     */
20892    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);
20893
20894    /**
20895     * Convert a geographic coordinate (longitude, latitude) into a pixel
20896     * coordinate (x, y).
20897     *
20898     * @param obj The map object.
20899     * @param lon the longitude.
20900     * @param lat the latitude.
20901     * @param size the size in pixels of the map. The map is a square
20902     * and generally his size is : pow(2.0, zoom)*256.
20903     * @param x Pointer where to store the horizontal pixel coordinate that
20904     * correspond to the longitude.
20905     * @param y Pointer where to store the vertical pixel coordinate that
20906     * correspond to the latitude.
20907     *
20908     * @note Origin pixel point is the top left corner of the viewport.
20909     * Map zoom and size are taken on account.
20910     *
20911     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
20912     *
20913     * @ingroup Map
20914     */
20915    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);
20916
20917    /**
20918     * Convert a geographic coordinate (longitude, latitude) into a name
20919     * (address).
20920     *
20921     * @param obj The map object.
20922     * @param lon the longitude.
20923     * @param lat the latitude.
20924     * @return name A #Elm_Map_Name handle for this coordinate.
20925     *
20926     * To get the string for this address, elm_map_name_address_get()
20927     * should be used.
20928     *
20929     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
20930     *
20931     * @ingroup Map
20932     */
20933    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
20934
20935    /**
20936     * Convert a name (address) into a geographic coordinate
20937     * (longitude, latitude).
20938     *
20939     * @param obj The map object.
20940     * @param name The address.
20941     * @return name A #Elm_Map_Name handle for this address.
20942     *
20943     * To get the longitude and latitude, elm_map_name_region_get()
20944     * should be used.
20945     *
20946     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
20947     *
20948     * @ingroup Map
20949     */
20950    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
20951
20952    /**
20953     * Convert a pixel coordinate into a rotated pixel coordinate.
20954     *
20955     * @param obj The map object.
20956     * @param x horizontal coordinate of the point to rotate.
20957     * @param y vertical coordinate of the point to rotate.
20958     * @param cx rotation's center horizontal position.
20959     * @param cy rotation's center vertical position.
20960     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
20961     * @param xx Pointer where to store rotated x.
20962     * @param yy Pointer where to store rotated y.
20963     *
20964     * @ingroup Map
20965     */
20966    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);
20967
20968    /**
20969     * Add a new marker to the map object.
20970     *
20971     * @param obj The map object.
20972     * @param lon The longitude of the marker.
20973     * @param lat The latitude of the marker.
20974     * @param clas The class, to use when marker @b isn't grouped to others.
20975     * @param clas_group The class group, to use when marker is grouped to others
20976     * @param data The data passed to the callbacks.
20977     *
20978     * @return The created marker or @c NULL upon failure.
20979     *
20980     * A marker will be created and shown in a specific point of the map, defined
20981     * by @p lon and @p lat.
20982     *
20983     * It will be displayed using style defined by @p class when this marker
20984     * is displayed alone (not grouped). A new class can be created with
20985     * elm_map_marker_class_new().
20986     *
20987     * If the marker is grouped to other markers, it will be displayed with
20988     * style defined by @p class_group. Markers with the same group are grouped
20989     * if they are close. A new group class can be created with
20990     * elm_map_marker_group_class_new().
20991     *
20992     * Markers created with this method can be deleted with
20993     * elm_map_marker_remove().
20994     *
20995     * A marker can have associated content to be displayed by a bubble,
20996     * when a user click over it, as well as an icon. These objects will
20997     * be fetch using class' callback functions.
20998     *
20999     * @see elm_map_marker_class_new()
21000     * @see elm_map_marker_group_class_new()
21001     * @see elm_map_marker_remove()
21002     *
21003     * @ingroup Map
21004     */
21005    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);
21006
21007    /**
21008     * Set the maximum numbers of markers' content to be displayed in a group.
21009     *
21010     * @param obj The map object.
21011     * @param max The maximum numbers of items displayed in a bubble.
21012     *
21013     * A bubble will be displayed when the user clicks over the group,
21014     * and will place the content of markers that belong to this group
21015     * inside it.
21016     *
21017     * A group can have a long list of markers, consequently the creation
21018     * of the content of the bubble can be very slow.
21019     *
21020     * In order to avoid this, a maximum number of items is displayed
21021     * in a bubble.
21022     *
21023     * By default this number is 30.
21024     *
21025     * Marker with the same group class are grouped if they are close.
21026     *
21027     * @see elm_map_marker_add()
21028     *
21029     * @ingroup Map
21030     */
21031    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21032
21033    /**
21034     * Remove a marker from the map.
21035     *
21036     * @param marker The marker to remove.
21037     *
21038     * @see elm_map_marker_add()
21039     *
21040     * @ingroup Map
21041     */
21042    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21043
21044    /**
21045     * Get the current coordinates of the marker.
21046     *
21047     * @param marker marker.
21048     * @param lat Pointer where to store the marker's latitude.
21049     * @param lon Pointer where to store the marker's longitude.
21050     *
21051     * These values are set when adding markers, with function
21052     * elm_map_marker_add().
21053     *
21054     * @see elm_map_marker_add()
21055     *
21056     * @ingroup Map
21057     */
21058    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21059
21060    /**
21061     * Animatedly bring in given marker to the center of the map.
21062     *
21063     * @param marker The marker to center at.
21064     *
21065     * This causes map to jump to the given @p marker's coordinates
21066     * and show it (by scrolling) in the center of the viewport, if it is not
21067     * already centered. This will use animation to do so and take a period
21068     * of time to complete.
21069     *
21070     * @see elm_map_marker_show() for a function to avoid animation.
21071     * @see elm_map_marker_region_get()
21072     *
21073     * @ingroup Map
21074     */
21075    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21076
21077    /**
21078     * Show the given marker at the center of the map, @b immediately.
21079     *
21080     * @param marker The marker to center at.
21081     *
21082     * This causes map to @b redraw its viewport's contents to the
21083     * region contining the given @p marker's coordinates, that will be
21084     * moved to the center of the map.
21085     *
21086     * @see elm_map_marker_bring_in() for a function to move with animation.
21087     * @see elm_map_markers_list_show() if more than one marker need to be
21088     * displayed.
21089     * @see elm_map_marker_region_get()
21090     *
21091     * @ingroup Map
21092     */
21093    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21094
21095    /**
21096     * Move and zoom the map to display a list of markers.
21097     *
21098     * @param markers A list of #Elm_Map_Marker handles.
21099     *
21100     * The map will be centered on the center point of the markers in the list.
21101     * Then the map will be zoomed in order to fit the markers using the maximum
21102     * zoom which allows display of all the markers.
21103     *
21104     * @warning All the markers should belong to the same map object.
21105     *
21106     * @see elm_map_marker_show() to show a single marker.
21107     * @see elm_map_marker_bring_in()
21108     *
21109     * @ingroup Map
21110     */
21111    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21112
21113    /**
21114     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21115     *
21116     * @param marker The marker wich content should be returned.
21117     * @return Return the evas object if it exists, else @c NULL.
21118     *
21119     * To set callback function #ElmMapMarkerGetFunc for the marker class,
21120     * elm_map_marker_class_get_cb_set() should be used.
21121     *
21122     * This content is what will be inside the bubble that will be displayed
21123     * when an user clicks over the marker.
21124     *
21125     * This returns the actual Evas object used to be placed inside
21126     * the bubble. This may be @c NULL, as it may
21127     * not have been created or may have been deleted, at any time, by
21128     * the map. <b>Do not modify this object</b> (move, resize,
21129     * show, hide, etc.), as the map is controlling it. This
21130     * function is for querying, emitting custom signals or hooking
21131     * lower level callbacks for events on that object. Do not delete
21132     * this object under any circumstances.
21133     *
21134     * @ingroup Map
21135     */
21136    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21137
21138    /**
21139     * Update the marker
21140     *
21141     * @param marker The marker to be updated.
21142     *
21143     * If a content is set to this marker, it will call function to delete it,
21144     * #ElmMapMarkerDelFunc, and then will fetch the content again with
21145     * #ElmMapMarkerGetFunc.
21146     *
21147     * These functions are set for the marker class with
21148     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21149     *
21150     * @ingroup Map
21151     */
21152    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21153
21154    /**
21155     * Close all the bubbles opened by the user.
21156     *
21157     * @param obj The map object.
21158     *
21159     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21160     * when the user clicks on a marker.
21161     *
21162     * This functions is set for the marker class with
21163     * elm_map_marker_class_get_cb_set().
21164     *
21165     * @ingroup Map
21166     */
21167    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21168
21169    /**
21170     * Create a new group class.
21171     *
21172     * @param obj The map object.
21173     * @return Returns the new group class.
21174     *
21175     * Each marker must be associated to a group class. Markers in the same
21176     * group are grouped if they are close.
21177     *
21178     * The group class defines the style of the marker when a marker is grouped
21179     * to others markers. When it is alone, another class will be used.
21180     *
21181     * A group class will need to be provided when creating a marker with
21182     * elm_map_marker_add().
21183     *
21184     * Some properties and functions can be set by class, as:
21185     * - style, with elm_map_group_class_style_set()
21186     * - data - to be associated to the group class. It can be set using
21187     *   elm_map_group_class_data_set().
21188     * - min zoom to display markers, set with
21189     *   elm_map_group_class_zoom_displayed_set().
21190     * - max zoom to group markers, set using
21191     *   elm_map_group_class_zoom_grouped_set().
21192     * - visibility - set if markers will be visible or not, set with
21193     *   elm_map_group_class_hide_set().
21194     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21195     *   It can be set using elm_map_group_class_icon_cb_set().
21196     *
21197     * @see elm_map_marker_add()
21198     * @see elm_map_group_class_style_set()
21199     * @see elm_map_group_class_data_set()
21200     * @see elm_map_group_class_zoom_displayed_set()
21201     * @see elm_map_group_class_zoom_grouped_set()
21202     * @see elm_map_group_class_hide_set()
21203     * @see elm_map_group_class_icon_cb_set()
21204     *
21205     * @ingroup Map
21206     */
21207    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21208
21209    /**
21210     * Set the marker's style of a group class.
21211     *
21212     * @param clas The group class.
21213     * @param style The style to be used by markers.
21214     *
21215     * Each marker must be associated to a group class, and will use the style
21216     * defined by such class when grouped to other markers.
21217     *
21218     * The following styles are provided by default theme:
21219     * @li @c radio - blue circle
21220     * @li @c radio2 - green circle
21221     * @li @c empty
21222     *
21223     * @see elm_map_group_class_new() for more details.
21224     * @see elm_map_marker_add()
21225     *
21226     * @ingroup Map
21227     */
21228    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21229
21230    /**
21231     * Set the icon callback function of a group class.
21232     *
21233     * @param clas The group class.
21234     * @param icon_get The callback function that will return the icon.
21235     *
21236     * Each marker must be associated to a group class, and it can display a
21237     * custom icon. The function @p icon_get must return this icon.
21238     *
21239     * @see elm_map_group_class_new() for more details.
21240     * @see elm_map_marker_add()
21241     *
21242     * @ingroup Map
21243     */
21244    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21245
21246    /**
21247     * Set the data associated to the group class.
21248     *
21249     * @param clas The group class.
21250     * @param data The new user data.
21251     *
21252     * This data will be passed for callback functions, like icon get callback,
21253     * that can be set with elm_map_group_class_icon_cb_set().
21254     *
21255     * If a data was previously set, the object will lose the pointer for it,
21256     * so if needs to be freed, you must do it yourself.
21257     *
21258     * @see elm_map_group_class_new() for more details.
21259     * @see elm_map_group_class_icon_cb_set()
21260     * @see elm_map_marker_add()
21261     *
21262     * @ingroup Map
21263     */
21264    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21265
21266    /**
21267     * Set the minimum zoom from where the markers are displayed.
21268     *
21269     * @param clas The group class.
21270     * @param zoom The minimum zoom.
21271     *
21272     * Markers only will be displayed when the map is displayed at @p zoom
21273     * or bigger.
21274     *
21275     * @see elm_map_group_class_new() for more details.
21276     * @see elm_map_marker_add()
21277     *
21278     * @ingroup Map
21279     */
21280    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21281
21282    /**
21283     * Set the zoom from where the markers are no more grouped.
21284     *
21285     * @param clas The group class.
21286     * @param zoom The maximum zoom.
21287     *
21288     * Markers only will be grouped when the map is displayed at
21289     * less than @p zoom.
21290     *
21291     * @see elm_map_group_class_new() for more details.
21292     * @see elm_map_marker_add()
21293     *
21294     * @ingroup Map
21295     */
21296    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21297
21298    /**
21299     * Set if the markers associated to the group class @clas are hidden or not.
21300     *
21301     * @param clas The group class.
21302     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21303     * to show them.
21304     *
21305     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21306     * is to show them.
21307     *
21308     * @ingroup Map
21309     */
21310    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21311
21312    /**
21313     * Create a new marker class.
21314     *
21315     * @param obj The map object.
21316     * @return Returns the new group class.
21317     *
21318     * Each marker must be associated to a class.
21319     *
21320     * The marker class defines the style of the marker when a marker is
21321     * displayed alone, i.e., not grouped to to others markers. When grouped
21322     * it will use group class style.
21323     *
21324     * A marker class will need to be provided when creating a marker with
21325     * elm_map_marker_add().
21326     *
21327     * Some properties and functions can be set by class, as:
21328     * - style, with elm_map_marker_class_style_set()
21329     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21330     *   It can be set using elm_map_marker_class_icon_cb_set().
21331     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21332     *   Set using elm_map_marker_class_get_cb_set().
21333     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21334     *   Set using elm_map_marker_class_del_cb_set().
21335     *
21336     * @see elm_map_marker_add()
21337     * @see elm_map_marker_class_style_set()
21338     * @see elm_map_marker_class_icon_cb_set()
21339     * @see elm_map_marker_class_get_cb_set()
21340     * @see elm_map_marker_class_del_cb_set()
21341     *
21342     * @ingroup Map
21343     */
21344    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21345
21346    /**
21347     * Set the marker's style of a marker class.
21348     *
21349     * @param clas The marker class.
21350     * @param style The style to be used by markers.
21351     *
21352     * Each marker must be associated to a marker class, and will use the style
21353     * defined by such class when alone, i.e., @b not grouped to other markers.
21354     *
21355     * The following styles are provided by default theme:
21356     * @li @c radio
21357     * @li @c radio2
21358     * @li @c empty
21359     *
21360     * @see elm_map_marker_class_new() for more details.
21361     * @see elm_map_marker_add()
21362     *
21363     * @ingroup Map
21364     */
21365    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21366
21367    /**
21368     * Set the icon callback function of a marker class.
21369     *
21370     * @param clas The marker class.
21371     * @param icon_get The callback function that will return the icon.
21372     *
21373     * Each marker must be associated to a marker class, and it can display a
21374     * custom icon. The function @p icon_get must return this icon.
21375     *
21376     * @see elm_map_marker_class_new() for more details.
21377     * @see elm_map_marker_add()
21378     *
21379     * @ingroup Map
21380     */
21381    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21382
21383    /**
21384     * Set the bubble content callback function of a marker class.
21385     *
21386     * @param clas The marker class.
21387     * @param get The callback function that will return the content.
21388     *
21389     * Each marker must be associated to a marker class, and it can display a
21390     * a content on a bubble that opens when the user click over the marker.
21391     * The function @p get must return this content object.
21392     *
21393     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21394     * can be used.
21395     *
21396     * @see elm_map_marker_class_new() for more details.
21397     * @see elm_map_marker_class_del_cb_set()
21398     * @see elm_map_marker_add()
21399     *
21400     * @ingroup Map
21401     */
21402    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21403
21404    /**
21405     * Set the callback function used to delete bubble content of a marker class.
21406     *
21407     * @param clas The marker class.
21408     * @param del The callback function that will delete the content.
21409     *
21410     * Each marker must be associated to a marker class, and it can display a
21411     * a content on a bubble that opens when the user click over the marker.
21412     * The function to return such content can be set with
21413     * elm_map_marker_class_get_cb_set().
21414     *
21415     * If this content must be freed, a callback function need to be
21416     * set for that task with this function.
21417     *
21418     * If this callback is defined it will have to delete (or not) the
21419     * object inside, but if the callback is not defined the object will be
21420     * destroyed with evas_object_del().
21421     *
21422     * @see elm_map_marker_class_new() for more details.
21423     * @see elm_map_marker_class_get_cb_set()
21424     * @see elm_map_marker_add()
21425     *
21426     * @ingroup Map
21427     */
21428    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21429
21430    /**
21431     * Get the list of available sources.
21432     *
21433     * @param obj The map object.
21434     * @return The source names list.
21435     *
21436     * It will provide a list with all available sources, that can be set as
21437     * current source with elm_map_source_name_set(), or get with
21438     * elm_map_source_name_get().
21439     *
21440     * Available sources:
21441     * @li "Mapnik"
21442     * @li "Osmarender"
21443     * @li "CycleMap"
21444     * @li "Maplint"
21445     *
21446     * @see elm_map_source_name_set() for more details.
21447     * @see elm_map_source_name_get()
21448     *
21449     * @ingroup Map
21450     */
21451    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21452
21453    /**
21454     * Set the source of the map.
21455     *
21456     * @param obj The map object.
21457     * @param source The source to be used.
21458     *
21459     * Map widget retrieves images that composes the map from a web service.
21460     * This web service can be set with this method.
21461     *
21462     * A different service can return a different maps with different
21463     * information and it can use different zoom values.
21464     *
21465     * The @p source_name need to match one of the names provided by
21466     * elm_map_source_names_get().
21467     *
21468     * The current source can be get using elm_map_source_name_get().
21469     *
21470     * @see elm_map_source_names_get()
21471     * @see elm_map_source_name_get()
21472     *
21473     *
21474     * @ingroup Map
21475     */
21476    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21477
21478    /**
21479     * Get the name of currently used source.
21480     *
21481     * @param obj The map object.
21482     * @return Returns the name of the source in use.
21483     *
21484     * @see elm_map_source_name_set() for more details.
21485     *
21486     * @ingroup Map
21487     */
21488    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21489
21490    /**
21491     * Set the source of the route service to be used by the map.
21492     *
21493     * @param obj The map object.
21494     * @param source The route service to be used, being it one of
21495     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21496     * and #ELM_MAP_ROUTE_SOURCE_ORS.
21497     *
21498     * Each one has its own algorithm, so the route retrieved may
21499     * differ depending on the source route. Now, only the default is working.
21500     *
21501     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21502     * http://www.yournavigation.org/.
21503     *
21504     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21505     * assumptions. Its routing core is based on Contraction Hierarchies.
21506     *
21507     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21508     *
21509     * @see elm_map_route_source_get().
21510     *
21511     * @ingroup Map
21512     */
21513    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21514
21515    /**
21516     * Get the current route source.
21517     *
21518     * @param obj The map object.
21519     * @return The source of the route service used by the map.
21520     *
21521     * @see elm_map_route_source_set() for details.
21522     *
21523     * @ingroup Map
21524     */
21525    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21526
21527    /**
21528     * Set the minimum zoom of the source.
21529     *
21530     * @param obj The map object.
21531     * @param zoom New minimum zoom value to be used.
21532     *
21533     * By default, it's 0.
21534     *
21535     * @ingroup Map
21536     */
21537    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21538
21539    /**
21540     * Get the minimum zoom of the source.
21541     *
21542     * @param obj The map object.
21543     * @return Returns the minimum zoom of the source.
21544     *
21545     * @see elm_map_source_zoom_min_set() for details.
21546     *
21547     * @ingroup Map
21548     */
21549    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21550
21551    /**
21552     * Set the maximum zoom of the source.
21553     *
21554     * @param obj The map object.
21555     * @param zoom New maximum zoom value to be used.
21556     *
21557     * By default, it's 18.
21558     *
21559     * @ingroup Map
21560     */
21561    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21562
21563    /**
21564     * Get the maximum zoom of the source.
21565     *
21566     * @param obj The map object.
21567     * @return Returns the maximum zoom of the source.
21568     *
21569     * @see elm_map_source_zoom_min_set() for details.
21570     *
21571     * @ingroup Map
21572     */
21573    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21574
21575    /**
21576     * Set the user agent used by the map object to access routing services.
21577     *
21578     * @param obj The map object.
21579     * @param user_agent The user agent to be used by the map.
21580     *
21581     * User agent is a client application implementing a network protocol used
21582     * in communications within a client–server distributed computing system
21583     *
21584     * The @p user_agent identification string will transmitted in a header
21585     * field @c User-Agent.
21586     *
21587     * @see elm_map_user_agent_get()
21588     *
21589     * @ingroup Map
21590     */
21591    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21592
21593    /**
21594     * Get the user agent used by the map object.
21595     *
21596     * @param obj The map object.
21597     * @return The user agent identification string used by the map.
21598     *
21599     * @see elm_map_user_agent_set() for details.
21600     *
21601     * @ingroup Map
21602     */
21603    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21604
21605    /**
21606     * Add a new route to the map object.
21607     *
21608     * @param obj The map object.
21609     * @param type The type of transport to be considered when tracing a route.
21610     * @param method The routing method, what should be priorized.
21611     * @param flon The start longitude.
21612     * @param flat The start latitude.
21613     * @param tlon The destination longitude.
21614     * @param tlat The destination latitude.
21615     *
21616     * @return The created route or @c NULL upon failure.
21617     *
21618     * A route will be traced by point on coordinates (@p flat, @p flon)
21619     * to point on coordinates (@p tlat, @p tlon), using the route service
21620     * set with elm_map_route_source_set().
21621     *
21622     * It will take @p type on consideration to define the route,
21623     * depending if the user will be walking or driving, the route may vary.
21624     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21625     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21626     *
21627     * Another parameter is what the route should priorize, the minor distance
21628     * or the less time to be spend on the route. So @p method should be one
21629     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21630     *
21631     * Routes created with this method can be deleted with
21632     * elm_map_route_remove(), colored with elm_map_route_color_set(),
21633     * and distance can be get with elm_map_route_distance_get().
21634     *
21635     * @see elm_map_route_remove()
21636     * @see elm_map_route_color_set()
21637     * @see elm_map_route_distance_get()
21638     * @see elm_map_route_source_set()
21639     *
21640     * @ingroup Map
21641     */
21642    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);
21643
21644    /**
21645     * Remove a route from the map.
21646     *
21647     * @param route The route to remove.
21648     *
21649     * @see elm_map_route_add()
21650     *
21651     * @ingroup Map
21652     */
21653    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21654
21655    /**
21656     * Set the route color.
21657     *
21658     * @param route The route object.
21659     * @param r Red channel value, from 0 to 255.
21660     * @param g Green channel value, from 0 to 255.
21661     * @param b Blue channel value, from 0 to 255.
21662     * @param a Alpha channel value, from 0 to 255.
21663     *
21664     * It uses an additive color model, so each color channel represents
21665     * how much of each primary colors must to be used. 0 represents
21666     * ausence of this color, so if all of the three are set to 0,
21667     * the color will be black.
21668     *
21669     * These component values should be integers in the range 0 to 255,
21670     * (single 8-bit byte).
21671     *
21672     * This sets the color used for the route. By default, it is set to
21673     * solid red (r = 255, g = 0, b = 0, a = 255).
21674     *
21675     * For alpha channel, 0 represents completely transparent, and 255, opaque.
21676     *
21677     * @see elm_map_route_color_get()
21678     *
21679     * @ingroup Map
21680     */
21681    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21682
21683    /**
21684     * Get the route color.
21685     *
21686     * @param route The route object.
21687     * @param r Pointer where to store the red channel value.
21688     * @param g Pointer where to store the green channel value.
21689     * @param b Pointer where to store the blue channel value.
21690     * @param a Pointer where to store the alpha channel value.
21691     *
21692     * @see elm_map_route_color_set() for details.
21693     *
21694     * @ingroup Map
21695     */
21696    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21697
21698    /**
21699     * Get the route distance in kilometers.
21700     *
21701     * @param route The route object.
21702     * @return The distance of route (unit : km).
21703     *
21704     * @ingroup Map
21705     */
21706    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21707
21708    /**
21709     * Get the information of route nodes.
21710     *
21711     * @param route The route object.
21712     * @return Returns a string with the nodes of route.
21713     *
21714     * @ingroup Map
21715     */
21716    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21717
21718    /**
21719     * Get the information of route waypoint.
21720     *
21721     * @param route the route object.
21722     * @return Returns a string with information about waypoint of route.
21723     *
21724     * @ingroup Map
21725     */
21726    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21727
21728    /**
21729     * Get the address of the name.
21730     *
21731     * @param name The name handle.
21732     * @return Returns the address string of @p name.
21733     *
21734     * This gets the coordinates of the @p name, created with one of the
21735     * conversion functions.
21736     *
21737     * @see elm_map_utils_convert_name_into_coord()
21738     * @see elm_map_utils_convert_coord_into_name()
21739     *
21740     * @ingroup Map
21741     */
21742    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21743
21744    /**
21745     * Get the current coordinates of the name.
21746     *
21747     * @param name The name handle.
21748     * @param lat Pointer where to store the latitude.
21749     * @param lon Pointer where to store The longitude.
21750     *
21751     * This gets the coordinates of the @p name, created with one of the
21752     * conversion functions.
21753     *
21754     * @see elm_map_utils_convert_name_into_coord()
21755     * @see elm_map_utils_convert_coord_into_name()
21756     *
21757     * @ingroup Map
21758     */
21759    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
21760
21761    /**
21762     * Remove a name from the map.
21763     *
21764     * @param name The name to remove.
21765     *
21766     * Basically the struct handled by @p name will be freed, so convertions
21767     * between address and coordinates will be lost.
21768     *
21769     * @see elm_map_utils_convert_name_into_coord()
21770     * @see elm_map_utils_convert_coord_into_name()
21771     *
21772     * @ingroup Map
21773     */
21774    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
21775
21776    /**
21777     * Rotate the map.
21778     *
21779     * @param obj The map object.
21780     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
21781     * @param cx Rotation's center horizontal position.
21782     * @param cy Rotation's center vertical position.
21783     *
21784     * @see elm_map_rotate_get()
21785     *
21786     * @ingroup Map
21787     */
21788    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
21789
21790    /**
21791     * Get the rotate degree of the map
21792     *
21793     * @param obj The map object
21794     * @param degree Pointer where to store degrees from 0.0 to 360.0
21795     * to rotate arount Z axis.
21796     * @param cx Pointer where to store rotation's center horizontal position.
21797     * @param cy Pointer where to store rotation's center vertical position.
21798     *
21799     * @see elm_map_rotate_set() to set map rotation.
21800     *
21801     * @ingroup Map
21802     */
21803    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);
21804
21805    /**
21806     * Enable or disable mouse wheel to be used to zoom in / out the map.
21807     *
21808     * @param obj The map object.
21809     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
21810     * to enable it.
21811     *
21812     * Mouse wheel can be used for the user to zoom in or zoom out the map.
21813     *
21814     * It's disabled by default.
21815     *
21816     * @see elm_map_wheel_disabled_get()
21817     *
21818     * @ingroup Map
21819     */
21820    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
21821
21822    /**
21823     * Get a value whether mouse wheel is enabled or not.
21824     *
21825     * @param obj The map object.
21826     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
21827     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21828     *
21829     * Mouse wheel can be used for the user to zoom in or zoom out the map.
21830     *
21831     * @see elm_map_wheel_disabled_set() for details.
21832     *
21833     * @ingroup Map
21834     */
21835    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21836
21837 #ifdef ELM_EMAP
21838    /**
21839     * Add a track on the map
21840     *
21841     * @param obj The map object.
21842     * @param emap The emap route object.
21843     * @return The route object. This is an elm object of type Route.
21844     *
21845     * @see elm_route_add() for details.
21846     *
21847     * @ingroup Map
21848     */
21849    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
21850 #endif
21851
21852    /**
21853     * Remove a track from the map
21854     *
21855     * @param obj The map object.
21856     * @param route The track to remove.
21857     *
21858     * @ingroup Map
21859     */
21860    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
21861
21862    /**
21863     * @}
21864     */
21865
21866    /* Route */
21867    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
21868 #ifdef ELM_EMAP
21869    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
21870 #endif
21871    EAPI double elm_route_lon_min_get(Evas_Object *obj);
21872    EAPI double elm_route_lat_min_get(Evas_Object *obj);
21873    EAPI double elm_route_lon_max_get(Evas_Object *obj);
21874    EAPI double elm_route_lat_max_get(Evas_Object *obj);
21875
21876
21877    /**
21878     * @defgroup Panel Panel
21879     *
21880     * @image html img/widget/panel/preview-00.png
21881     * @image latex img/widget/panel/preview-00.eps
21882     *
21883     * @brief A panel is a type of animated container that contains subobjects.
21884     * It can be expanded or contracted by clicking the button on it's edge.
21885     *
21886     * Orientations are as follows:
21887     * @li ELM_PANEL_ORIENT_TOP
21888     * @li ELM_PANEL_ORIENT_LEFT
21889     * @li ELM_PANEL_ORIENT_RIGHT
21890     *
21891     * @ref tutorial_panel shows one way to use this widget.
21892     * @{
21893     */
21894    typedef enum _Elm_Panel_Orient
21895      {
21896         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
21897         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
21898         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
21899         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
21900      } Elm_Panel_Orient;
21901    /**
21902     * @brief Adds a panel object
21903     *
21904     * @param parent The parent object
21905     *
21906     * @return The panel object, or NULL on failure
21907     */
21908    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21909    /**
21910     * @brief Sets the orientation of the panel
21911     *
21912     * @param parent The parent object
21913     * @param orient The panel orientation. Can be one of the following:
21914     * @li ELM_PANEL_ORIENT_TOP
21915     * @li ELM_PANEL_ORIENT_LEFT
21916     * @li ELM_PANEL_ORIENT_RIGHT
21917     *
21918     * Sets from where the panel will (dis)appear.
21919     */
21920    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
21921    /**
21922     * @brief Get the orientation of the panel.
21923     *
21924     * @param obj The panel object
21925     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
21926     */
21927    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21928    /**
21929     * @brief Set the content of the panel.
21930     *
21931     * @param obj The panel object
21932     * @param content The panel content
21933     *
21934     * Once the content object is set, a previously set one will be deleted.
21935     * If you want to keep that old content object, use the
21936     * elm_panel_content_unset() function.
21937     */
21938    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
21939    /**
21940     * @brief Get the content of the panel.
21941     *
21942     * @param obj The panel object
21943     * @return The content that is being used
21944     *
21945     * Return the content object which is set for this widget.
21946     *
21947     * @see elm_panel_content_set()
21948     */
21949    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21950    /**
21951     * @brief Unset the content of the panel.
21952     *
21953     * @param obj The panel object
21954     * @return The content that was being used
21955     *
21956     * Unparent and return the content object which was set for this widget.
21957     *
21958     * @see elm_panel_content_set()
21959     */
21960    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21961    /**
21962     * @brief Set the state of the panel.
21963     *
21964     * @param obj The panel object
21965     * @param hidden If true, the panel will run the animation to contract
21966     */
21967    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
21968    /**
21969     * @brief Get the state of the panel.
21970     *
21971     * @param obj The panel object
21972     * @param hidden If true, the panel is in the "hide" state
21973     */
21974    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21975    /**
21976     * @brief Toggle the hidden state of the panel from code
21977     *
21978     * @param obj The panel object
21979     */
21980    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
21981    /**
21982     * @}
21983     */
21984
21985    /**
21986     * @defgroup Panes Panes
21987     * @ingroup Elementary
21988     *
21989     * @image html img/widget/panes/preview-00.png
21990     * @image latex img/widget/panes/preview-00.eps width=\textwidth
21991     *
21992     * @image html img/panes.png
21993     * @image latex img/panes.eps width=\textwidth
21994     *
21995     * The panes adds a dragable bar between two contents. When dragged
21996     * this bar will resize contents size.
21997     *
21998     * Panes can be displayed vertically or horizontally, and contents
21999     * size proportion can be customized (homogeneous by default).
22000     *
22001     * Smart callbacks one can listen to:
22002     * - "press" - The panes has been pressed (button wasn't released yet).
22003     * - "unpressed" - The panes was released after being pressed.
22004     * - "clicked" - The panes has been clicked>
22005     * - "clicked,double" - The panes has been double clicked
22006     *
22007     * Available styles for it:
22008     * - @c "default"
22009     *
22010     * Here is an example on its usage:
22011     * @li @ref panes_example
22012     */
22013
22014    /**
22015     * @addtogroup Panes
22016     * @{
22017     */
22018
22019    /**
22020     * Add a new panes widget to the given parent Elementary
22021     * (container) object.
22022     *
22023     * @param parent The parent object.
22024     * @return a new panes widget handle or @c NULL, on errors.
22025     *
22026     * This function inserts a new panes widget on the canvas.
22027     *
22028     * @ingroup Panes
22029     */
22030    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22031
22032    /**
22033     * Set the left content of the panes widget.
22034     *
22035     * @param obj The panes object.
22036     * @param content The new left content object.
22037     *
22038     * Once the content object is set, a previously set one will be deleted.
22039     * If you want to keep that old content object, use the
22040     * elm_panes_content_left_unset() function.
22041     *
22042     * If panes is displayed vertically, left content will be displayed at
22043     * top.
22044     *
22045     * @see elm_panes_content_left_get()
22046     * @see elm_panes_content_right_set() to set content on the other side.
22047     *
22048     * @ingroup Panes
22049     */
22050    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22051
22052    /**
22053     * Set the right content of the panes widget.
22054     *
22055     * @param obj The panes object.
22056     * @param content The new right content object.
22057     *
22058     * Once the content object is set, a previously set one will be deleted.
22059     * If you want to keep that old content object, use the
22060     * elm_panes_content_right_unset() function.
22061     *
22062     * If panes is displayed vertically, left content will be displayed at
22063     * bottom.
22064     *
22065     * @see elm_panes_content_right_get()
22066     * @see elm_panes_content_left_set() to set content on the other side.
22067     *
22068     * @ingroup Panes
22069     */
22070    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22071
22072    /**
22073     * Get the left content of the panes.
22074     *
22075     * @param obj The panes object.
22076     * @return The left content object that is being used.
22077     *
22078     * Return the left content object which is set for this widget.
22079     *
22080     * @see elm_panes_content_left_set() for details.
22081     *
22082     * @ingroup Panes
22083     */
22084    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22085
22086    /**
22087     * Get the right content of the panes.
22088     *
22089     * @param obj The panes object
22090     * @return The right content object that is being used
22091     *
22092     * Return the right content object which is set for this widget.
22093     *
22094     * @see elm_panes_content_right_set() for details.
22095     *
22096     * @ingroup Panes
22097     */
22098    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22099
22100    /**
22101     * Unset the left content used for the panes.
22102     *
22103     * @param obj The panes object.
22104     * @return The left content object that was being used.
22105     *
22106     * Unparent and return the left content object which was set for this widget.
22107     *
22108     * @see elm_panes_content_left_set() for details.
22109     * @see elm_panes_content_left_get().
22110     *
22111     * @ingroup Panes
22112     */
22113    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22114
22115    /**
22116     * Unset the right content used for the panes.
22117     *
22118     * @param obj The panes object.
22119     * @return The right content object that was being used.
22120     *
22121     * Unparent and return the right content object which was set for this
22122     * widget.
22123     *
22124     * @see elm_panes_content_right_set() for details.
22125     * @see elm_panes_content_right_get().
22126     *
22127     * @ingroup Panes
22128     */
22129    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22130
22131    /**
22132     * Get the size proportion of panes widget's left side.
22133     *
22134     * @param obj The panes object.
22135     * @return float value between 0.0 and 1.0 representing size proportion
22136     * of left side.
22137     *
22138     * @see elm_panes_content_left_size_set() for more details.
22139     *
22140     * @ingroup Panes
22141     */
22142    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22143
22144    /**
22145     * Set the size proportion of panes widget's left side.
22146     *
22147     * @param obj The panes object.
22148     * @param size Value between 0.0 and 1.0 representing size proportion
22149     * of left side.
22150     *
22151     * By default it's homogeneous, i.e., both sides have the same size.
22152     *
22153     * If something different is required, it can be set with this function.
22154     * For example, if the left content should be displayed over
22155     * 75% of the panes size, @p size should be passed as @c 0.75.
22156     * This way, right content will be resized to 25% of panes size.
22157     *
22158     * If displayed vertically, left content is displayed at top, and
22159     * right content at bottom.
22160     *
22161     * @note This proportion will change when user drags the panes bar.
22162     *
22163     * @see elm_panes_content_left_size_get()
22164     *
22165     * @ingroup Panes
22166     */
22167    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22168
22169   /**
22170    * Set the orientation of a given panes widget.
22171    *
22172    * @param obj The panes object.
22173    * @param horizontal Use @c EINA_TRUE to make @p obj to be
22174    * @b horizontal, @c EINA_FALSE to make it @b vertical.
22175    *
22176    * Use this function to change how your panes is to be
22177    * disposed: vertically or horizontally.
22178    *
22179    * By default it's displayed horizontally.
22180    *
22181    * @see elm_panes_horizontal_get()
22182    *
22183    * @ingroup Panes
22184    */
22185    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22186
22187    /**
22188     * Retrieve the orientation of a given panes widget.
22189     *
22190     * @param obj The panes object.
22191     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22192     * @c EINA_FALSE if it's @b vertical (and on errors).
22193     *
22194     * @see elm_panes_horizontal_set() for more details.
22195     *
22196     * @ingroup Panes
22197     */
22198    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22199
22200    /**
22201     * @}
22202     */
22203
22204    /**
22205     * @defgroup Flip Flip
22206     *
22207     * @image html img/widget/flip/preview-00.png
22208     * @image latex img/widget/flip/preview-00.eps
22209     *
22210     * This widget holds 2 content objects(Evas_Object): one on the front and one
22211     * on the back. It allows you to flip from front to back and vice-versa using
22212     * various animations.
22213     *
22214     * If either the front or back contents are not set the flip will treat that
22215     * as transparent. So if you wore to set the front content but not the back,
22216     * and then call elm_flip_go() you would see whatever is below the flip.
22217     *
22218     * For a list of supported animations see elm_flip_go().
22219     *
22220     * Signals that you can add callbacks for are:
22221     * "animate,begin" - when a flip animation was started
22222     * "animate,done" - when a flip animation is finished
22223     *
22224     * @ref tutorial_flip show how to use most of the API.
22225     *
22226     * @{
22227     */
22228    typedef enum _Elm_Flip_Mode
22229      {
22230         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22231         ELM_FLIP_ROTATE_X_CENTER_AXIS,
22232         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22233         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22234         ELM_FLIP_CUBE_LEFT,
22235         ELM_FLIP_CUBE_RIGHT,
22236         ELM_FLIP_CUBE_UP,
22237         ELM_FLIP_CUBE_DOWN,
22238         ELM_FLIP_PAGE_LEFT,
22239         ELM_FLIP_PAGE_RIGHT,
22240         ELM_FLIP_PAGE_UP,
22241         ELM_FLIP_PAGE_DOWN
22242      } Elm_Flip_Mode;
22243    typedef enum _Elm_Flip_Interaction
22244      {
22245         ELM_FLIP_INTERACTION_NONE,
22246         ELM_FLIP_INTERACTION_ROTATE,
22247         ELM_FLIP_INTERACTION_CUBE,
22248         ELM_FLIP_INTERACTION_PAGE
22249      } Elm_Flip_Interaction;
22250    typedef enum _Elm_Flip_Direction
22251      {
22252         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22253         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22254         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22255         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22256      } Elm_Flip_Direction;
22257    /**
22258     * @brief Add a new flip to the parent
22259     *
22260     * @param parent The parent object
22261     * @return The new object or NULL if it cannot be created
22262     */
22263    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22264    /**
22265     * @brief Set the front content of the flip widget.
22266     *
22267     * @param obj The flip object
22268     * @param content The new front content object
22269     *
22270     * Once the content object is set, a previously set one will be deleted.
22271     * If you want to keep that old content object, use the
22272     * elm_flip_content_front_unset() function.
22273     */
22274    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22275    /**
22276     * @brief Set the back content of the flip widget.
22277     *
22278     * @param obj The flip object
22279     * @param content The new back content object
22280     *
22281     * Once the content object is set, a previously set one will be deleted.
22282     * If you want to keep that old content object, use the
22283     * elm_flip_content_back_unset() function.
22284     */
22285    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22286    /**
22287     * @brief Get the front content used for the flip
22288     *
22289     * @param obj The flip object
22290     * @return The front content object that is being used
22291     *
22292     * Return the front content object which is set for this widget.
22293     */
22294    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22295    /**
22296     * @brief Get the back content used for the flip
22297     *
22298     * @param obj The flip object
22299     * @return The back content object that is being used
22300     *
22301     * Return the back content object which is set for this widget.
22302     */
22303    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22304    /**
22305     * @brief Unset the front content used for the flip
22306     *
22307     * @param obj The flip object
22308     * @return The front content object that was being used
22309     *
22310     * Unparent and return the front content object which was set for this widget.
22311     */
22312    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22313    /**
22314     * @brief Unset the back content used for the flip
22315     *
22316     * @param obj The flip object
22317     * @return The back content object that was being used
22318     *
22319     * Unparent and return the back content object which was set for this widget.
22320     */
22321    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22322    /**
22323     * @brief Get flip front visibility state
22324     *
22325     * @param obj The flip objct
22326     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22327     * showing.
22328     */
22329    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22330    /**
22331     * @brief Set flip perspective
22332     *
22333     * @param obj The flip object
22334     * @param foc The coordinate to set the focus on
22335     * @param x The X coordinate
22336     * @param y The Y coordinate
22337     *
22338     * @warning This function currently does nothing.
22339     */
22340    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22341    /**
22342     * @brief Runs the flip animation
22343     *
22344     * @param obj The flip object
22345     * @param mode The mode type
22346     *
22347     * Flips the front and back contents using the @p mode animation. This
22348     * efectively hides the currently visible content and shows the hidden one.
22349     *
22350     * There a number of possible animations to use for the flipping:
22351     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22352     * around a horizontal axis in the middle of its height, the other content
22353     * is shown as the other side of the flip.
22354     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22355     * around a vertical axis in the middle of its width, the other content is
22356     * shown as the other side of the flip.
22357     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22358     * around a diagonal axis in the middle of its width, the other content is
22359     * shown as the other side of the flip.
22360     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22361     * around a diagonal axis in the middle of its height, the other content is
22362     * shown as the other side of the flip.
22363     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22364     * as if the flip was a cube, the other content is show as the right face of
22365     * the cube.
22366     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22367     * right as if the flip was a cube, the other content is show as the left
22368     * face of the cube.
22369     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22370     * flip was a cube, the other content is show as the bottom face of the cube.
22371     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22372     * the flip was a cube, the other content is show as the upper face of the
22373     * cube.
22374     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22375     * if the flip was a book, the other content is shown as the page below that.
22376     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22377     * as if the flip was a book, the other content is shown as the page below
22378     * that.
22379     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22380     * flip was a book, the other content is shown as the page below that.
22381     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22382     * flip was a book, the other content is shown as the page below that.
22383     *
22384     * @image html elm_flip.png
22385     * @image latex elm_flip.eps width=\textwidth
22386     */
22387    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22388    /**
22389     * @brief Set the interactive flip mode
22390     *
22391     * @param obj The flip object
22392     * @param mode The interactive flip mode to use
22393     *
22394     * This sets if the flip should be interactive (allow user to click and
22395     * drag a side of the flip to reveal the back page and cause it to flip).
22396     * By default a flip is not interactive. You may also need to set which
22397     * sides of the flip are "active" for flipping and how much space they use
22398     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22399     * and elm_flip_interacton_direction_hitsize_set()
22400     *
22401     * The four avilable mode of interaction are:
22402     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22403     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22404     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22405     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22406     *
22407     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22408     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22409     * happen, those can only be acheived with elm_flip_go();
22410     */
22411    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22412    /**
22413     * @brief Get the interactive flip mode
22414     *
22415     * @param obj The flip object
22416     * @return The interactive flip mode
22417     *
22418     * Returns the interactive flip mode set by elm_flip_interaction_set()
22419     */
22420    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22421    /**
22422     * @brief Set which directions of the flip respond to interactive flip
22423     *
22424     * @param obj The flip object
22425     * @param dir The direction to change
22426     * @param enabled If that direction is enabled or not
22427     *
22428     * By default all directions are disabled, so you may want to enable the
22429     * desired directions for flipping if you need interactive flipping. You must
22430     * call this function once for each direction that should be enabled.
22431     *
22432     * @see elm_flip_interaction_set()
22433     */
22434    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22435    /**
22436     * @brief Get the enabled state of that flip direction
22437     *
22438     * @param obj The flip object
22439     * @param dir The direction to check
22440     * @return If that direction is enabled or not
22441     *
22442     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22443     *
22444     * @see elm_flip_interaction_set()
22445     */
22446    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22447    /**
22448     * @brief Set the amount of the flip that is sensitive to interactive flip
22449     *
22450     * @param obj The flip object
22451     * @param dir The direction to modify
22452     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22453     *
22454     * Set the amount of the flip that is sensitive to interactive flip, with 0
22455     * representing no area in the flip and 1 representing the entire flip. There
22456     * is however a consideration to be made in that the area will never be
22457     * smaller than the finger size set(as set in your Elementary configuration).
22458     *
22459     * @see elm_flip_interaction_set()
22460     */
22461    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22462    /**
22463     * @brief Get the amount of the flip that is sensitive to interactive flip
22464     *
22465     * @param obj The flip object
22466     * @param dir The direction to check
22467     * @return The size set for that direction
22468     *
22469     * Returns the amount os sensitive area set by
22470     * elm_flip_interacton_direction_hitsize_set().
22471     */
22472    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22473    /**
22474     * @}
22475     */
22476
22477    /* scrolledentry */
22478    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22479    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22480    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22481    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22482    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22483    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22484    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22485    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22486    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22487    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22488    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22489    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22490    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22491    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22492    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22493    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22494    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22495    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22496    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22497    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22498    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22499    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22500    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22501    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22502    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22503    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22504    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22505    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22506    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22507    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22508    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22509    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22510    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22511    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22512    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22513    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);
22514    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22515    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22516    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);
22517    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22518    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);
22519    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22520    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22521    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22522    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22523    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22524    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22525    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22526    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22527    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);
22528    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);
22529    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);
22530    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);
22531    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);
22532    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);
22533    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22534    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22535    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22536    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22537    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22538    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22539    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22540
22541    /**
22542     * @defgroup Conformant Conformant
22543     * @ingroup Elementary
22544     *
22545     * @image html img/widget/conformant/preview-00.png
22546     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22547     *
22548     * @image html img/conformant.png
22549     * @image latex img/conformant.eps width=\textwidth
22550     *
22551     * The aim is to provide a widget that can be used in elementary apps to
22552     * account for space taken up by the indicator, virtual keypad & softkey
22553     * windows when running the illume2 module of E17.
22554     *
22555     * So conformant content will be sized and positioned considering the
22556     * space required for such stuff, and when they popup, as a keyboard
22557     * shows when an entry is selected, conformant content won't change.
22558     *
22559     * Available styles for it:
22560     * - @c "default"
22561     *
22562     * See how to use this widget in this example:
22563     * @ref conformant_example
22564     */
22565
22566    /**
22567     * @addtogroup Conformant
22568     * @{
22569     */
22570
22571    /**
22572     * Add a new conformant widget to the given parent Elementary
22573     * (container) object.
22574     *
22575     * @param parent The parent object.
22576     * @return A new conformant widget handle or @c NULL, on errors.
22577     *
22578     * This function inserts a new conformant widget on the canvas.
22579     *
22580     * @ingroup Conformant
22581     */
22582    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22583
22584    /**
22585     * Set the content of the conformant widget.
22586     *
22587     * @param obj The conformant object.
22588     * @param content The content to be displayed by the conformant.
22589     *
22590     * Content will be sized and positioned considering the space required
22591     * to display a virtual keyboard. So it won't fill all the conformant
22592     * size. This way is possible to be sure that content won't resize
22593     * or be re-positioned after the keyboard is displayed.
22594     *
22595     * Once the content object is set, a previously set one will be deleted.
22596     * If you want to keep that old content object, use the
22597     * elm_conformat_content_unset() function.
22598     *
22599     * @see elm_conformant_content_unset()
22600     * @see elm_conformant_content_get()
22601     *
22602     * @ingroup Conformant
22603     */
22604    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22605
22606    /**
22607     * Get the content of the conformant widget.
22608     *
22609     * @param obj The conformant object.
22610     * @return The content that is being used.
22611     *
22612     * Return the content object which is set for this widget.
22613     * It won't be unparent from conformant. For that, use
22614     * elm_conformant_content_unset().
22615     *
22616     * @see elm_conformant_content_set() for more details.
22617     * @see elm_conformant_content_unset()
22618     *
22619     * @ingroup Conformant
22620     */
22621    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22622
22623    /**
22624     * Unset the content of the conformant widget.
22625     *
22626     * @param obj The conformant object.
22627     * @return The content that was being used.
22628     *
22629     * Unparent and return the content object which was set for this widget.
22630     *
22631     * @see elm_conformant_content_set() for more details.
22632     *
22633     * @ingroup Conformant
22634     */
22635    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22636
22637    /**
22638     * Returns the Evas_Object that represents the content area.
22639     *
22640     * @param obj The conformant object.
22641     * @return The content area of the widget.
22642     *
22643     * @ingroup Conformant
22644     */
22645    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22646
22647    /**
22648     * @}
22649     */
22650
22651    /**
22652     * @defgroup Mapbuf Mapbuf
22653     * @ingroup Elementary
22654     *
22655     * @image html img/widget/mapbuf/preview-00.png
22656     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22657     *
22658     * This holds one content object and uses an Evas Map of transformation
22659     * points to be later used with this content. So the content will be
22660     * moved, resized, etc as a single image. So it will improve performance
22661     * when you have a complex interafce, with a lot of elements, and will
22662     * need to resize or move it frequently (the content object and its
22663     * children).
22664     *
22665     * See how to use this widget in this example:
22666     * @ref mapbuf_example
22667     */
22668
22669    /**
22670     * @addtogroup Mapbuf
22671     * @{
22672     */
22673
22674    /**
22675     * Add a new mapbuf widget to the given parent Elementary
22676     * (container) object.
22677     *
22678     * @param parent The parent object.
22679     * @return A new mapbuf widget handle or @c NULL, on errors.
22680     *
22681     * This function inserts a new mapbuf widget on the canvas.
22682     *
22683     * @ingroup Mapbuf
22684     */
22685    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22686
22687    /**
22688     * Set the content of the mapbuf.
22689     *
22690     * @param obj The mapbuf object.
22691     * @param content The content that will be filled in this mapbuf object.
22692     *
22693     * Once the content object is set, a previously set one will be deleted.
22694     * If you want to keep that old content object, use the
22695     * elm_mapbuf_content_unset() function.
22696     *
22697     * To enable map, elm_mapbuf_enabled_set() should be used.
22698     *
22699     * @ingroup Mapbuf
22700     */
22701    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22702
22703    /**
22704     * Get the content of the mapbuf.
22705     *
22706     * @param obj The mapbuf object.
22707     * @return The content that is being used.
22708     *
22709     * Return the content object which is set for this widget.
22710     *
22711     * @see elm_mapbuf_content_set() for details.
22712     *
22713     * @ingroup Mapbuf
22714     */
22715    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22716
22717    /**
22718     * Unset the content of the mapbuf.
22719     *
22720     * @param obj The mapbuf object.
22721     * @return The content that was being used.
22722     *
22723     * Unparent and return the content object which was set for this widget.
22724     *
22725     * @see elm_mapbuf_content_set() for details.
22726     *
22727     * @ingroup Mapbuf
22728     */
22729    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22730
22731    /**
22732     * Enable or disable the map.
22733     *
22734     * @param obj The mapbuf object.
22735     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
22736     *
22737     * This enables the map that is set or disables it. On enable, the object
22738     * geometry will be saved, and the new geometry will change (position and
22739     * size) to reflect the map geometry set.
22740     *
22741     * Also, when enabled, alpha and smooth states will be used, so if the
22742     * content isn't solid, alpha should be enabled, for example, otherwise
22743     * a black retangle will fill the content.
22744     *
22745     * When disabled, the stored map will be freed and geometry prior to
22746     * enabling the map will be restored.
22747     *
22748     * It's disabled by default.
22749     *
22750     * @see elm_mapbuf_alpha_set()
22751     * @see elm_mapbuf_smooth_set()
22752     *
22753     * @ingroup Mapbuf
22754     */
22755    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
22756
22757    /**
22758     * Get a value whether map is enabled or not.
22759     *
22760     * @param obj The mapbuf object.
22761     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
22762     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22763     *
22764     * @see elm_mapbuf_enabled_set() for details.
22765     *
22766     * @ingroup Mapbuf
22767     */
22768    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22769
22770    /**
22771     * Enable or disable smooth map rendering.
22772     *
22773     * @param obj The mapbuf object.
22774     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
22775     * to disable it.
22776     *
22777     * This sets smoothing for map rendering. If the object is a type that has
22778     * its own smoothing settings, then both the smooth settings for this object
22779     * and the map must be turned off.
22780     *
22781     * By default smooth maps are enabled.
22782     *
22783     * @ingroup Mapbuf
22784     */
22785    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
22786
22787    /**
22788     * Get a value whether smooth map rendering is enabled or not.
22789     *
22790     * @param obj The mapbuf object.
22791     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
22792     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22793     *
22794     * @see elm_mapbuf_smooth_set() for details.
22795     *
22796     * @ingroup Mapbuf
22797     */
22798    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22799
22800    /**
22801     * Set or unset alpha flag for map rendering.
22802     *
22803     * @param obj The mapbuf object.
22804     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
22805     * to disable it.
22806     *
22807     * This sets alpha flag for map rendering. If the object is a type that has
22808     * its own alpha settings, then this will take precedence. Only image objects
22809     * have this currently. It stops alpha blending of the map area, and is
22810     * useful if you know the object and/or all sub-objects is 100% solid.
22811     *
22812     * Alpha is enabled by default.
22813     *
22814     * @ingroup Mapbuf
22815     */
22816    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
22817
22818    /**
22819     * Get a value whether alpha blending is enabled or not.
22820     *
22821     * @param obj The mapbuf object.
22822     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
22823     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22824     *
22825     * @see elm_mapbuf_alpha_set() for details.
22826     *
22827     * @ingroup Mapbuf
22828     */
22829    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22830
22831    /**
22832     * @}
22833     */
22834
22835    /**
22836     * @defgroup Flipselector Flip Selector
22837     *
22838     * @image html img/widget/flipselector/preview-00.png
22839     * @image latex img/widget/flipselector/preview-00.eps
22840     *
22841     * A flip selector is a widget to show a set of @b text items, one
22842     * at a time, with the same sheet switching style as the @ref Clock
22843     * "clock" widget, when one changes the current displaying sheet
22844     * (thus, the "flip" in the name).
22845     *
22846     * User clicks to flip sheets which are @b held for some time will
22847     * make the flip selector to flip continuosly and automatically for
22848     * the user. The interval between flips will keep growing in time,
22849     * so that it helps the user to reach an item which is distant from
22850     * the current selection.
22851     *
22852     * Smart callbacks one can register to:
22853     * - @c "selected" - when the widget's selected text item is changed
22854     * - @c "overflowed" - when the widget's current selection is changed
22855     *   from the first item in its list to the last
22856     * - @c "underflowed" - when the widget's current selection is changed
22857     *   from the last item in its list to the first
22858     *
22859     * Available styles for it:
22860     * - @c "default"
22861     *
22862     * Here is an example on its usage:
22863     * @li @ref flipselector_example
22864     */
22865
22866    /**
22867     * @addtogroup Flipselector
22868     * @{
22869     */
22870
22871    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
22872
22873    /**
22874     * Add a new flip selector widget to the given parent Elementary
22875     * (container) widget
22876     *
22877     * @param parent The parent object
22878     * @return a new flip selector widget handle or @c NULL, on errors
22879     *
22880     * This function inserts a new flip selector widget on the canvas.
22881     *
22882     * @ingroup Flipselector
22883     */
22884    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22885
22886    /**
22887     * Programmatically select the next item of a flip selector widget
22888     *
22889     * @param obj The flipselector object
22890     *
22891     * @note The selection will be animated. Also, if it reaches the
22892     * end of its list of member items, it will continue with the first
22893     * one onwards.
22894     *
22895     * @ingroup Flipselector
22896     */
22897    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22898
22899    /**
22900     * Programmatically select the previous item of a flip selector
22901     * widget
22902     *
22903     * @param obj The flipselector object
22904     *
22905     * @note The selection will be animated.  Also, if it reaches the
22906     * beginning of its list of member items, it will continue with the
22907     * last one backwards.
22908     *
22909     * @ingroup Flipselector
22910     */
22911    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22912
22913    /**
22914     * Append a (text) item to a flip selector widget
22915     *
22916     * @param obj The flipselector object
22917     * @param label The (text) label of the new item
22918     * @param func Convenience callback function to take place when
22919     * item is selected
22920     * @param data Data passed to @p func, above
22921     * @return A handle to the item added or @c NULL, on errors
22922     *
22923     * The widget's list of labels to show will be appended with the
22924     * given value. If the user wishes so, a callback function pointer
22925     * can be passed, which will get called when this same item is
22926     * selected.
22927     *
22928     * @note The current selection @b won't be modified by appending an
22929     * element to the list.
22930     *
22931     * @note The maximum length of the text label is going to be
22932     * determined <b>by the widget's theme</b>. Strings larger than
22933     * that value are going to be @b truncated.
22934     *
22935     * @ingroup Flipselector
22936     */
22937    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
22938
22939    /**
22940     * Prepend a (text) item to a flip selector widget
22941     *
22942     * @param obj The flipselector object
22943     * @param label The (text) label of the new item
22944     * @param func Convenience callback function to take place when
22945     * item is selected
22946     * @param data Data passed to @p func, above
22947     * @return A handle to the item added or @c NULL, on errors
22948     *
22949     * The widget's list of labels to show will be prepended with the
22950     * given value. If the user wishes so, a callback function pointer
22951     * can be passed, which will get called when this same item is
22952     * selected.
22953     *
22954     * @note The current selection @b won't be modified by prepending
22955     * an element to the list.
22956     *
22957     * @note The maximum length of the text label is going to be
22958     * determined <b>by the widget's theme</b>. Strings larger than
22959     * that value are going to be @b truncated.
22960     *
22961     * @ingroup Flipselector
22962     */
22963    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
22964
22965    /**
22966     * Get the internal list of items in a given flip selector widget.
22967     *
22968     * @param obj The flipselector object
22969     * @return The list of items (#Elm_Flipselector_Item as data) or
22970     * @c NULL on errors.
22971     *
22972     * This list is @b not to be modified in any way and must not be
22973     * freed. Use the list members with functions like
22974     * elm_flipselector_item_label_set(),
22975     * elm_flipselector_item_label_get(),
22976     * elm_flipselector_item_del(),
22977     * elm_flipselector_item_selected_get(),
22978     * elm_flipselector_item_selected_set().
22979     *
22980     * @warning This list is only valid until @p obj object's internal
22981     * items list is changed. It should be fetched again with another
22982     * call to this function when changes happen.
22983     *
22984     * @ingroup Flipselector
22985     */
22986    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22987
22988    /**
22989     * Get the first item in the given flip selector widget's list of
22990     * items.
22991     *
22992     * @param obj The flipselector object
22993     * @return The first item or @c NULL, if it has no items (and on
22994     * errors)
22995     *
22996     * @see elm_flipselector_item_append()
22997     * @see elm_flipselector_last_item_get()
22998     *
22999     * @ingroup Flipselector
23000     */
23001    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23002
23003    /**
23004     * Get the last item in the given flip selector widget's list of
23005     * items.
23006     *
23007     * @param obj The flipselector object
23008     * @return The last item or @c NULL, if it has no items (and on
23009     * errors)
23010     *
23011     * @see elm_flipselector_item_prepend()
23012     * @see elm_flipselector_first_item_get()
23013     *
23014     * @ingroup Flipselector
23015     */
23016    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23017
23018    /**
23019     * Get the currently selected item in a flip selector widget.
23020     *
23021     * @param obj The flipselector object
23022     * @return The selected item or @c NULL, if the widget has no items
23023     * (and on erros)
23024     *
23025     * @ingroup Flipselector
23026     */
23027    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23028
23029    /**
23030     * Set whether a given flip selector widget's item should be the
23031     * currently selected one.
23032     *
23033     * @param item The flip selector item
23034     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23035     *
23036     * This sets whether @p item is or not the selected (thus, under
23037     * display) one. If @p item is different than one under display,
23038     * the latter will be unselected. If the @p item is set to be
23039     * unselected, on the other hand, the @b first item in the widget's
23040     * internal members list will be the new selected one.
23041     *
23042     * @see elm_flipselector_item_selected_get()
23043     *
23044     * @ingroup Flipselector
23045     */
23046    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23047
23048    /**
23049     * Get whether a given flip selector widget's item is the currently
23050     * selected one.
23051     *
23052     * @param item The flip selector item
23053     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23054     * (or on errors).
23055     *
23056     * @see elm_flipselector_item_selected_set()
23057     *
23058     * @ingroup Flipselector
23059     */
23060    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23061
23062    /**
23063     * Delete a given item from a flip selector widget.
23064     *
23065     * @param item The item to delete
23066     *
23067     * @ingroup Flipselector
23068     */
23069    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23070
23071    /**
23072     * Get the label of a given flip selector widget's item.
23073     *
23074     * @param item The item to get label from
23075     * @return The text label of @p item or @c NULL, on errors
23076     *
23077     * @see elm_flipselector_item_label_set()
23078     *
23079     * @ingroup Flipselector
23080     */
23081    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23082
23083    /**
23084     * Set the label of a given flip selector widget's item.
23085     *
23086     * @param item The item to set label on
23087     * @param label The text label string, in UTF-8 encoding
23088     *
23089     * @see elm_flipselector_item_label_get()
23090     *
23091     * @ingroup Flipselector
23092     */
23093    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23094
23095    /**
23096     * Gets the item before @p item in a flip selector widget's
23097     * internal list of items.
23098     *
23099     * @param item The item to fetch previous from
23100     * @return The item before the @p item, in its parent's list. If
23101     *         there is no previous item for @p item or there's an
23102     *         error, @c NULL is returned.
23103     *
23104     * @see elm_flipselector_item_next_get()
23105     *
23106     * @ingroup Flipselector
23107     */
23108    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23109
23110    /**
23111     * Gets the item after @p item in a flip selector widget's
23112     * internal list of items.
23113     *
23114     * @param item The item to fetch next from
23115     * @return The item after the @p item, in its parent's list. If
23116     *         there is no next item for @p item or there's an
23117     *         error, @c NULL is returned.
23118     *
23119     * @see elm_flipselector_item_next_get()
23120     *
23121     * @ingroup Flipselector
23122     */
23123    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23124
23125    /**
23126     * Set the interval on time updates for an user mouse button hold
23127     * on a flip selector widget.
23128     *
23129     * @param obj The flip selector object
23130     * @param interval The (first) interval value in seconds
23131     *
23132     * This interval value is @b decreased while the user holds the
23133     * mouse pointer either flipping up or flipping doww a given flip
23134     * selector.
23135     *
23136     * This helps the user to get to a given item distant from the
23137     * current one easier/faster, as it will start to flip quicker and
23138     * quicker on mouse button holds.
23139     *
23140     * The calculation for the next flip interval value, starting from
23141     * the one set with this call, is the previous interval divided by
23142     * 1.05, so it decreases a little bit.
23143     *
23144     * The default starting interval value for automatic flips is
23145     * @b 0.85 seconds.
23146     *
23147     * @see elm_flipselector_interval_get()
23148     *
23149     * @ingroup Flipselector
23150     */
23151    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23152
23153    /**
23154     * Get the interval on time updates for an user mouse button hold
23155     * on a flip selector widget.
23156     *
23157     * @param obj The flip selector object
23158     * @return The (first) interval value, in seconds, set on it
23159     *
23160     * @see elm_flipselector_interval_set() for more details
23161     *
23162     * @ingroup Flipselector
23163     */
23164    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23165    /**
23166     * @}
23167     */
23168
23169    /**
23170     * @addtogroup Calendar
23171     * @{
23172     */
23173
23174    /**
23175     * @enum _Elm_Calendar_Mark_Repeat
23176     * @typedef Elm_Calendar_Mark_Repeat
23177     *
23178     * Event periodicity, used to define if a mark should be repeated
23179     * @b beyond event's day. It's set when a mark is added.
23180     *
23181     * So, for a mark added to 13th May with periodicity set to WEEKLY,
23182     * there will be marks every week after this date. Marks will be displayed
23183     * at 13th, 20th, 27th, 3rd June ...
23184     *
23185     * Values don't work as bitmask, only one can be choosen.
23186     *
23187     * @see elm_calendar_mark_add()
23188     *
23189     * @ingroup Calendar
23190     */
23191    typedef enum _Elm_Calendar_Mark_Repeat
23192      {
23193         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23194         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23195         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23196         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*/
23197         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. */
23198      } Elm_Calendar_Mark_Repeat;
23199
23200    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(). */
23201
23202    /**
23203     * Add a new calendar widget to the given parent Elementary
23204     * (container) object.
23205     *
23206     * @param parent The parent object.
23207     * @return a new calendar widget handle or @c NULL, on errors.
23208     *
23209     * This function inserts a new calendar widget on the canvas.
23210     *
23211     * @ref calendar_example_01
23212     *
23213     * @ingroup Calendar
23214     */
23215    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23216
23217    /**
23218     * Get weekdays names displayed by the calendar.
23219     *
23220     * @param obj The calendar object.
23221     * @return Array of seven strings to be used as weekday names.
23222     *
23223     * By default, weekdays abbreviations get from system are displayed:
23224     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23225     * The first string is related to Sunday, the second to Monday...
23226     *
23227     * @see elm_calendar_weekdays_name_set()
23228     *
23229     * @ref calendar_example_05
23230     *
23231     * @ingroup Calendar
23232     */
23233    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23234
23235    /**
23236     * Set weekdays names to be displayed by the calendar.
23237     *
23238     * @param obj The calendar object.
23239     * @param weekdays Array of seven strings to be used as weekday names.
23240     * @warning It must have 7 elements, or it will access invalid memory.
23241     * @warning The strings must be NULL terminated ('@\0').
23242     *
23243     * By default, weekdays abbreviations get from system are displayed:
23244     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23245     *
23246     * The first string should be related to Sunday, the second to Monday...
23247     *
23248     * The usage should be like this:
23249     * @code
23250     *   const char *weekdays[] =
23251     *   {
23252     *      "Sunday", "Monday", "Tuesday", "Wednesday",
23253     *      "Thursday", "Friday", "Saturday"
23254     *   };
23255     *   elm_calendar_weekdays_names_set(calendar, weekdays);
23256     * @endcode
23257     *
23258     * @see elm_calendar_weekdays_name_get()
23259     *
23260     * @ref calendar_example_02
23261     *
23262     * @ingroup Calendar
23263     */
23264    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23265
23266    /**
23267     * Set the minimum and maximum values for the year
23268     *
23269     * @param obj The calendar object
23270     * @param min The minimum year, greater than 1901;
23271     * @param max The maximum year;
23272     *
23273     * Maximum must be greater than minimum, except if you don't wan't to set
23274     * maximum year.
23275     * Default values are 1902 and -1.
23276     *
23277     * If the maximum year is a negative value, it will be limited depending
23278     * on the platform architecture (year 2037 for 32 bits);
23279     *
23280     * @see elm_calendar_min_max_year_get()
23281     *
23282     * @ref calendar_example_03
23283     *
23284     * @ingroup Calendar
23285     */
23286    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23287
23288    /**
23289     * Get the minimum and maximum values for the year
23290     *
23291     * @param obj The calendar object.
23292     * @param min The minimum year.
23293     * @param max The maximum year.
23294     *
23295     * Default values are 1902 and -1.
23296     *
23297     * @see elm_calendar_min_max_year_get() for more details.
23298     *
23299     * @ref calendar_example_05
23300     *
23301     * @ingroup Calendar
23302     */
23303    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23304
23305    /**
23306     * Enable or disable day selection
23307     *
23308     * @param obj The calendar object.
23309     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23310     * disable it.
23311     *
23312     * Enabled by default. If disabled, the user still can select months,
23313     * but not days. Selected days are highlighted on calendar.
23314     * It should be used if you won't need such selection for the widget usage.
23315     *
23316     * When a day is selected, or month is changed, smart callbacks for
23317     * signal "changed" will be called.
23318     *
23319     * @see elm_calendar_day_selection_enable_get()
23320     *
23321     * @ref calendar_example_04
23322     *
23323     * @ingroup Calendar
23324     */
23325    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23326
23327    /**
23328     * Get a value whether day selection is enabled or not.
23329     *
23330     * @see elm_calendar_day_selection_enable_set() for details.
23331     *
23332     * @param obj The calendar object.
23333     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23334     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23335     *
23336     * @ref calendar_example_05
23337     *
23338     * @ingroup Calendar
23339     */
23340    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23341
23342
23343    /**
23344     * Set selected date to be highlighted on calendar.
23345     *
23346     * @param obj The calendar object.
23347     * @param selected_time A @b tm struct to represent the selected date.
23348     *
23349     * Set the selected date, changing the displayed month if needed.
23350     * Selected date changes when the user goes to next/previous month or
23351     * select a day pressing over it on calendar.
23352     *
23353     * @see elm_calendar_selected_time_get()
23354     *
23355     * @ref calendar_example_04
23356     *
23357     * @ingroup Calendar
23358     */
23359    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23360
23361    /**
23362     * Get selected date.
23363     *
23364     * @param obj The calendar object
23365     * @param selected_time A @b tm struct to point to selected date
23366     * @return EINA_FALSE means an error ocurred and returned time shouldn't
23367     * be considered.
23368     *
23369     * Get date selected by the user or set by function
23370     * elm_calendar_selected_time_set().
23371     * Selected date changes when the user goes to next/previous month or
23372     * select a day pressing over it on calendar.
23373     *
23374     * @see elm_calendar_selected_time_get()
23375     *
23376     * @ref calendar_example_05
23377     *
23378     * @ingroup Calendar
23379     */
23380    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23381
23382    /**
23383     * Set a function to format the string that will be used to display
23384     * month and year;
23385     *
23386     * @param obj The calendar object
23387     * @param format_function Function to set the month-year string given
23388     * the selected date
23389     *
23390     * By default it uses strftime with "%B %Y" format string.
23391     * It should allocate the memory that will be used by the string,
23392     * that will be freed by the widget after usage.
23393     * A pointer to the string and a pointer to the time struct will be provided.
23394     *
23395     * Example:
23396     * @code
23397     * static char *
23398     * _format_month_year(struct tm *selected_time)
23399     * {
23400     *    char buf[32];
23401     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23402     *    return strdup(buf);
23403     * }
23404     *
23405     * elm_calendar_format_function_set(calendar, _format_month_year);
23406     * @endcode
23407     *
23408     * @ref calendar_example_02
23409     *
23410     * @ingroup Calendar
23411     */
23412    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23413
23414    /**
23415     * Add a new mark to the calendar
23416     *
23417     * @param obj The calendar object
23418     * @param mark_type A string used to define the type of mark. It will be
23419     * emitted to the theme, that should display a related modification on these
23420     * days representation.
23421     * @param mark_time A time struct to represent the date of inclusion of the
23422     * mark. For marks that repeats it will just be displayed after the inclusion
23423     * date in the calendar.
23424     * @param repeat Repeat the event following this periodicity. Can be a unique
23425     * mark (that don't repeat), daily, weekly, monthly or annually.
23426     * @return The created mark or @p NULL upon failure.
23427     *
23428     * Add a mark that will be drawn in the calendar respecting the insertion
23429     * time and periodicity. It will emit the type as signal to the widget theme.
23430     * Default theme supports "holiday" and "checked", but it can be extended.
23431     *
23432     * It won't immediately update the calendar, drawing the marks.
23433     * For this, call elm_calendar_marks_draw(). However, when user selects
23434     * next or previous month calendar forces marks drawn.
23435     *
23436     * Marks created with this method can be deleted with
23437     * elm_calendar_mark_del().
23438     *
23439     * Example
23440     * @code
23441     * struct tm selected_time;
23442     * time_t current_time;
23443     *
23444     * current_time = time(NULL) + 5 * 84600;
23445     * localtime_r(&current_time, &selected_time);
23446     * elm_calendar_mark_add(cal, "holiday", selected_time,
23447     *     ELM_CALENDAR_ANNUALLY);
23448     *
23449     * current_time = time(NULL) + 1 * 84600;
23450     * localtime_r(&current_time, &selected_time);
23451     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23452     *
23453     * elm_calendar_marks_draw(cal);
23454     * @endcode
23455     *
23456     * @see elm_calendar_marks_draw()
23457     * @see elm_calendar_mark_del()
23458     *
23459     * @ref calendar_example_06
23460     *
23461     * @ingroup Calendar
23462     */
23463    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);
23464
23465    /**
23466     * Delete mark from the calendar.
23467     *
23468     * @param mark The mark to be deleted.
23469     *
23470     * If deleting all calendar marks is required, elm_calendar_marks_clear()
23471     * should be used instead of getting marks list and deleting each one.
23472     *
23473     * @see elm_calendar_mark_add()
23474     *
23475     * @ref calendar_example_06
23476     *
23477     * @ingroup Calendar
23478     */
23479    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23480
23481    /**
23482     * Remove all calendar's marks
23483     *
23484     * @param obj The calendar object.
23485     *
23486     * @see elm_calendar_mark_add()
23487     * @see elm_calendar_mark_del()
23488     *
23489     * @ingroup Calendar
23490     */
23491    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23492
23493
23494    /**
23495     * Get a list of all the calendar marks.
23496     *
23497     * @param obj The calendar object.
23498     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23499     *
23500     * @see elm_calendar_mark_add()
23501     * @see elm_calendar_mark_del()
23502     * @see elm_calendar_marks_clear()
23503     *
23504     * @ingroup Calendar
23505     */
23506    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23507
23508    /**
23509     * Draw calendar marks.
23510     *
23511     * @param obj The calendar object.
23512     *
23513     * Should be used after adding, removing or clearing marks.
23514     * It will go through the entire marks list updating the calendar.
23515     * If lots of marks will be added, add all the marks and then call
23516     * this function.
23517     *
23518     * When the month is changed, i.e. user selects next or previous month,
23519     * marks will be drawed.
23520     *
23521     * @see elm_calendar_mark_add()
23522     * @see elm_calendar_mark_del()
23523     * @see elm_calendar_marks_clear()
23524     *
23525     * @ref calendar_example_06
23526     *
23527     * @ingroup Calendar
23528     */
23529    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23530
23531    /**
23532     * Set a day text color to the same that represents Saturdays.
23533     *
23534     * @param obj The calendar object.
23535     * @param pos The text position. Position is the cell counter, from left
23536     * to right, up to down. It starts on 0 and ends on 41.
23537     *
23538     * @deprecated use elm_calendar_mark_add() instead like:
23539     *
23540     * @code
23541     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23542     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23543     * @endcode
23544     *
23545     * @see elm_calendar_mark_add()
23546     *
23547     * @ingroup Calendar
23548     */
23549    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23550
23551    /**
23552     * Set a day text color to the same that represents Sundays.
23553     *
23554     * @param obj The calendar object.
23555     * @param pos The text position. Position is the cell counter, from left
23556     * to right, up to down. It starts on 0 and ends on 41.
23557
23558     * @deprecated use elm_calendar_mark_add() instead like:
23559     *
23560     * @code
23561     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23562     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23563     * @endcode
23564     *
23565     * @see elm_calendar_mark_add()
23566     *
23567     * @ingroup Calendar
23568     */
23569    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23570
23571    /**
23572     * Set a day text color to the same that represents Weekdays.
23573     *
23574     * @param obj The calendar object
23575     * @param pos The text position. Position is the cell counter, from left
23576     * to right, up to down. It starts on 0 and ends on 41.
23577     *
23578     * @deprecated use elm_calendar_mark_add() instead like:
23579     *
23580     * @code
23581     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23582     *
23583     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23584     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23585     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23586     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23587     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23588     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23589     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23590     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23591     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23592     * @endcode
23593     *
23594     * @see elm_calendar_mark_add()
23595     *
23596     * @ingroup Calendar
23597     */
23598    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23599
23600    /**
23601     * Set the interval on time updates for an user mouse button hold
23602     * on calendar widgets' month selection.
23603     *
23604     * @param obj The calendar object
23605     * @param interval The (first) interval value in seconds
23606     *
23607     * This interval value is @b decreased while the user holds the
23608     * mouse pointer either selecting next or previous month.
23609     *
23610     * This helps the user to get to a given month distant from the
23611     * current one easier/faster, as it will start to change quicker and
23612     * quicker on mouse button holds.
23613     *
23614     * The calculation for the next change interval value, starting from
23615     * the one set with this call, is the previous interval divided by
23616     * 1.05, so it decreases a little bit.
23617     *
23618     * The default starting interval value for automatic changes is
23619     * @b 0.85 seconds.
23620     *
23621     * @see elm_calendar_interval_get()
23622     *
23623     * @ingroup Calendar
23624     */
23625    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23626
23627    /**
23628     * Get the interval on time updates for an user mouse button hold
23629     * on calendar widgets' month selection.
23630     *
23631     * @param obj The calendar object
23632     * @return The (first) interval value, in seconds, set on it
23633     *
23634     * @see elm_calendar_interval_set() for more details
23635     *
23636     * @ingroup Calendar
23637     */
23638    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23639
23640    /**
23641     * @}
23642     */
23643
23644    /**
23645     * @defgroup Diskselector Diskselector
23646     * @ingroup Elementary
23647     *
23648     * @image html img/widget/diskselector/preview-00.png
23649     * @image latex img/widget/diskselector/preview-00.eps
23650     *
23651     * A diskselector is a kind of list widget. It scrolls horizontally,
23652     * and can contain label and icon objects. Three items are displayed
23653     * with the selected one in the middle.
23654     *
23655     * It can act like a circular list with round mode and labels can be
23656     * reduced for a defined length for side items.
23657     *
23658     * Smart callbacks one can listen to:
23659     * - "selected" - when item is selected, i.e. scroller stops.
23660     *
23661     * Available styles for it:
23662     * - @c "default"
23663     *
23664     * List of examples:
23665     * @li @ref diskselector_example_01
23666     * @li @ref diskselector_example_02
23667     */
23668
23669    /**
23670     * @addtogroup Diskselector
23671     * @{
23672     */
23673
23674    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(). */
23675
23676    /**
23677     * Add a new diskselector widget to the given parent Elementary
23678     * (container) object.
23679     *
23680     * @param parent The parent object.
23681     * @return a new diskselector widget handle or @c NULL, on errors.
23682     *
23683     * This function inserts a new diskselector widget on the canvas.
23684     *
23685     * @ingroup Diskselector
23686     */
23687    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23688
23689    /**
23690     * Enable or disable round mode.
23691     *
23692     * @param obj The diskselector object.
23693     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23694     * disable it.
23695     *
23696     * Disabled by default. If round mode is enabled the items list will
23697     * work like a circle list, so when the user reaches the last item,
23698     * the first one will popup.
23699     *
23700     * @see elm_diskselector_round_get()
23701     *
23702     * @ingroup Diskselector
23703     */
23704    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23705
23706    /**
23707     * Get a value whether round mode is enabled or not.
23708     *
23709     * @see elm_diskselector_round_set() for details.
23710     *
23711     * @param obj The diskselector object.
23712     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23713     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23714     *
23715     * @ingroup Diskselector
23716     */
23717    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23718
23719    /**
23720     * Get the side labels max length.
23721     *
23722     * @deprecated use elm_diskselector_side_label_length_get() instead:
23723     *
23724     * @param obj The diskselector object.
23725     * @return The max length defined for side labels, or 0 if not a valid
23726     * diskselector.
23727     *
23728     * @ingroup Diskselector
23729     */
23730    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23731
23732    /**
23733     * Set the side labels max length.
23734     *
23735     * @deprecated use elm_diskselector_side_label_length_set() instead:
23736     *
23737     * @param obj The diskselector object.
23738     * @param len The max length defined for side labels.
23739     *
23740     * @ingroup Diskselector
23741     */
23742    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23743
23744    /**
23745     * Get the side labels max length.
23746     *
23747     * @see elm_diskselector_side_label_length_set() for details.
23748     *
23749     * @param obj The diskselector object.
23750     * @return The max length defined for side labels, or 0 if not a valid
23751     * diskselector.
23752     *
23753     * @ingroup Diskselector
23754     */
23755    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23756
23757    /**
23758     * Set the side labels max length.
23759     *
23760     * @param obj The diskselector object.
23761     * @param len The max length defined for side labels.
23762     *
23763     * Length is the number of characters of items' label that will be
23764     * visible when it's set on side positions. It will just crop
23765     * the string after defined size. E.g.:
23766     *
23767     * An item with label "January" would be displayed on side position as
23768     * "Jan" if max length is set to 3, or "Janu", if this property
23769     * is set to 4.
23770     *
23771     * When it's selected, the entire label will be displayed, except for
23772     * width restrictions. In this case label will be cropped and "..."
23773     * will be concatenated.
23774     *
23775     * Default side label max length is 3.
23776     *
23777     * This property will be applyed over all items, included before or
23778     * later this function call.
23779     *
23780     * @ingroup Diskselector
23781     */
23782    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
23783
23784    /**
23785     * Set the number of items to be displayed.
23786     *
23787     * @param obj The diskselector object.
23788     * @param num The number of items the diskselector will display.
23789     *
23790     * Default value is 3, and also it's the minimun. If @p num is less
23791     * than 3, it will be set to 3.
23792     *
23793     * Also, it can be set on theme, using data item @c display_item_num
23794     * on group "elm/diskselector/item/X", where X is style set.
23795     * E.g.:
23796     *
23797     * group { name: "elm/diskselector/item/X";
23798     * data {
23799     *     item: "display_item_num" "5";
23800     *     }
23801     *
23802     * @ingroup Diskselector
23803     */
23804    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
23805
23806    /**
23807     * Set bouncing behaviour when the scrolled content reaches an edge.
23808     *
23809     * Tell the internal scroller object whether it should bounce or not
23810     * when it reaches the respective edges for each axis.
23811     *
23812     * @param obj The diskselector object.
23813     * @param h_bounce Whether to bounce or not in the horizontal axis.
23814     * @param v_bounce Whether to bounce or not in the vertical axis.
23815     *
23816     * @see elm_scroller_bounce_set()
23817     *
23818     * @ingroup Diskselector
23819     */
23820    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
23821
23822    /**
23823     * Get the bouncing behaviour of the internal scroller.
23824     *
23825     * Get whether the internal scroller should bounce when the edge of each
23826     * axis is reached scrolling.
23827     *
23828     * @param obj The diskselector object.
23829     * @param h_bounce Pointer where to store the bounce state of the horizontal
23830     * axis.
23831     * @param v_bounce Pointer where to store the bounce state of the vertical
23832     * axis.
23833     *
23834     * @see elm_scroller_bounce_get()
23835     * @see elm_diskselector_bounce_set()
23836     *
23837     * @ingroup Diskselector
23838     */
23839    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
23840
23841    /**
23842     * Get the scrollbar policy.
23843     *
23844     * @see elm_diskselector_scroller_policy_get() for details.
23845     *
23846     * @param obj The diskselector object.
23847     * @param policy_h Pointer where to store horizontal scrollbar policy.
23848     * @param policy_v Pointer where to store vertical scrollbar policy.
23849     *
23850     * @ingroup Diskselector
23851     */
23852    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);
23853
23854    /**
23855     * Set the scrollbar policy.
23856     *
23857     * @param obj The diskselector object.
23858     * @param policy_h Horizontal scrollbar policy.
23859     * @param policy_v Vertical scrollbar policy.
23860     *
23861     * This sets the scrollbar visibility policy for the given scroller.
23862     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
23863     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
23864     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
23865     * This applies respectively for the horizontal and vertical scrollbars.
23866     *
23867     * The both are disabled by default, i.e., are set to
23868     * #ELM_SCROLLER_POLICY_OFF.
23869     *
23870     * @ingroup Diskselector
23871     */
23872    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
23873
23874    /**
23875     * Remove all diskselector's items.
23876     *
23877     * @param obj The diskselector object.
23878     *
23879     * @see elm_diskselector_item_del()
23880     * @see elm_diskselector_item_append()
23881     *
23882     * @ingroup Diskselector
23883     */
23884    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23885
23886    /**
23887     * Get a list of all the diskselector items.
23888     *
23889     * @param obj The diskselector object.
23890     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
23891     * or @c NULL on failure.
23892     *
23893     * @see elm_diskselector_item_append()
23894     * @see elm_diskselector_item_del()
23895     * @see elm_diskselector_clear()
23896     *
23897     * @ingroup Diskselector
23898     */
23899    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23900
23901    /**
23902     * Appends a new item to the diskselector object.
23903     *
23904     * @param obj The diskselector object.
23905     * @param label The label of the diskselector item.
23906     * @param icon The icon object to use at left side of the item. An
23907     * icon can be any Evas object, but usually it is an icon created
23908     * with elm_icon_add().
23909     * @param func The function to call when the item is selected.
23910     * @param data The data to associate with the item for related callbacks.
23911     *
23912     * @return The created item or @c NULL upon failure.
23913     *
23914     * A new item will be created and appended to the diskselector, i.e., will
23915     * be set as last item. Also, if there is no selected item, it will
23916     * be selected. This will always happens for the first appended item.
23917     *
23918     * If no icon is set, label will be centered on item position, otherwise
23919     * the icon will be placed at left of the label, that will be shifted
23920     * to the right.
23921     *
23922     * Items created with this method can be deleted with
23923     * elm_diskselector_item_del().
23924     *
23925     * Associated @p data can be properly freed when item is deleted if a
23926     * callback function is set with elm_diskselector_item_del_cb_set().
23927     *
23928     * If a function is passed as argument, it will be called everytime this item
23929     * is selected, i.e., the user stops the diskselector with this
23930     * item on center position. If such function isn't needed, just passing
23931     * @c NULL as @p func is enough. The same should be done for @p data.
23932     *
23933     * Simple example (with no function callback or data associated):
23934     * @code
23935     * disk = elm_diskselector_add(win);
23936     * ic = elm_icon_add(win);
23937     * elm_icon_file_set(ic, "path/to/image", NULL);
23938     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
23939     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
23940     * @endcode
23941     *
23942     * @see elm_diskselector_item_del()
23943     * @see elm_diskselector_item_del_cb_set()
23944     * @see elm_diskselector_clear()
23945     * @see elm_icon_add()
23946     *
23947     * @ingroup Diskselector
23948     */
23949    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);
23950
23951
23952    /**
23953     * Delete them item from the diskselector.
23954     *
23955     * @param it The item of diskselector to be deleted.
23956     *
23957     * If deleting all diskselector items is required, elm_diskselector_clear()
23958     * should be used instead of getting items list and deleting each one.
23959     *
23960     * @see elm_diskselector_clear()
23961     * @see elm_diskselector_item_append()
23962     * @see elm_diskselector_item_del_cb_set()
23963     *
23964     * @ingroup Diskselector
23965     */
23966    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
23967
23968    /**
23969     * Set the function called when a diskselector item is freed.
23970     *
23971     * @param it The item to set the callback on
23972     * @param func The function called
23973     *
23974     * If there is a @p func, then it will be called prior item's memory release.
23975     * That will be called with the following arguments:
23976     * @li item's data;
23977     * @li item's Evas object;
23978     * @li item itself;
23979     *
23980     * This way, a data associated to a diskselector item could be properly
23981     * freed.
23982     *
23983     * @ingroup Diskselector
23984     */
23985    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
23986
23987    /**
23988     * Get the data associated to the item.
23989     *
23990     * @param it The diskselector item
23991     * @return The data associated to @p it
23992     *
23993     * The return value is a pointer to data associated to @p item when it was
23994     * created, with function elm_diskselector_item_append(). If no data
23995     * was passed as argument, it will return @c NULL.
23996     *
23997     * @see elm_diskselector_item_append()
23998     *
23999     * @ingroup Diskselector
24000     */
24001    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24002
24003    /**
24004     * Set the icon associated to the item.
24005     *
24006     * @param it The diskselector item
24007     * @param icon The icon object to associate with @p it
24008     *
24009     * The icon object to use at left side of the item. An
24010     * icon can be any Evas object, but usually it is an icon created
24011     * with elm_icon_add().
24012     *
24013     * Once the icon object is set, a previously set one will be deleted.
24014     * @warning Setting the same icon for two items will cause the icon to
24015     * dissapear from the first item.
24016     *
24017     * If an icon was passed as argument on item creation, with function
24018     * elm_diskselector_item_append(), it will be already
24019     * associated to the item.
24020     *
24021     * @see elm_diskselector_item_append()
24022     * @see elm_diskselector_item_icon_get()
24023     *
24024     * @ingroup Diskselector
24025     */
24026    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24027
24028    /**
24029     * Get the icon associated to the item.
24030     *
24031     * @param it The diskselector item
24032     * @return The icon associated to @p it
24033     *
24034     * The return value is a pointer to the icon associated to @p item when it was
24035     * created, with function elm_diskselector_item_append(), or later
24036     * with function elm_diskselector_item_icon_set. If no icon
24037     * was passed as argument, it will return @c NULL.
24038     *
24039     * @see elm_diskselector_item_append()
24040     * @see elm_diskselector_item_icon_set()
24041     *
24042     * @ingroup Diskselector
24043     */
24044    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24045
24046    /**
24047     * Set the label of item.
24048     *
24049     * @param it The item of diskselector.
24050     * @param label The label of item.
24051     *
24052     * The label to be displayed by the item.
24053     *
24054     * If no icon is set, label will be centered on item position, otherwise
24055     * the icon will be placed at left of the label, that will be shifted
24056     * to the right.
24057     *
24058     * An item with label "January" would be displayed on side position as
24059     * "Jan" if max length is set to 3 with function
24060     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24061     * is set to 4.
24062     *
24063     * When this @p item is selected, the entire label will be displayed,
24064     * except for width restrictions.
24065     * In this case label will be cropped and "..." will be concatenated,
24066     * but only for display purposes. It will keep the entire string, so
24067     * if diskselector is resized the remaining characters will be displayed.
24068     *
24069     * If a label was passed as argument on item creation, with function
24070     * elm_diskselector_item_append(), it will be already
24071     * displayed by the item.
24072     *
24073     * @see elm_diskselector_side_label_lenght_set()
24074     * @see elm_diskselector_item_label_get()
24075     * @see elm_diskselector_item_append()
24076     *
24077     * @ingroup Diskselector
24078     */
24079    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24080
24081    /**
24082     * Get the label of item.
24083     *
24084     * @param it The item of diskselector.
24085     * @return The label of item.
24086     *
24087     * The return value is a pointer to the label associated to @p item when it was
24088     * created, with function elm_diskselector_item_append(), or later
24089     * with function elm_diskselector_item_label_set. If no label
24090     * was passed as argument, it will return @c NULL.
24091     *
24092     * @see elm_diskselector_item_label_set() for more details.
24093     * @see elm_diskselector_item_append()
24094     *
24095     * @ingroup Diskselector
24096     */
24097    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24098
24099    /**
24100     * Get the selected item.
24101     *
24102     * @param obj The diskselector object.
24103     * @return The selected diskselector item.
24104     *
24105     * The selected item can be unselected with function
24106     * elm_diskselector_item_selected_set(), and the first item of
24107     * diskselector will be selected.
24108     *
24109     * The selected item always will be centered on diskselector, with
24110     * full label displayed, i.e., max lenght set to side labels won't
24111     * apply on the selected item. More details on
24112     * elm_diskselector_side_label_length_set().
24113     *
24114     * @ingroup Diskselector
24115     */
24116    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24117
24118    /**
24119     * Set the selected state of an item.
24120     *
24121     * @param it The diskselector item
24122     * @param selected The selected state
24123     *
24124     * This sets the selected state of the given item @p it.
24125     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24126     *
24127     * If a new item is selected the previosly selected will be unselected.
24128     * Previoulsy selected item can be get with function
24129     * elm_diskselector_selected_item_get().
24130     *
24131     * If the item @p it is unselected, the first item of diskselector will
24132     * be selected.
24133     *
24134     * Selected items will be visible on center position of diskselector.
24135     * So if it was on another position before selected, or was invisible,
24136     * diskselector will animate items until the selected item reaches center
24137     * position.
24138     *
24139     * @see elm_diskselector_item_selected_get()
24140     * @see elm_diskselector_selected_item_get()
24141     *
24142     * @ingroup Diskselector
24143     */
24144    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24145
24146    /*
24147     * Get whether the @p item is selected or not.
24148     *
24149     * @param it The diskselector item.
24150     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24151     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24152     *
24153     * @see elm_diskselector_selected_item_set() for details.
24154     * @see elm_diskselector_item_selected_get()
24155     *
24156     * @ingroup Diskselector
24157     */
24158    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24159
24160    /**
24161     * Get the first item of the diskselector.
24162     *
24163     * @param obj The diskselector object.
24164     * @return The first item, or @c NULL if none.
24165     *
24166     * The list of items follows append order. So it will return the first
24167     * item appended to the widget that wasn't deleted.
24168     *
24169     * @see elm_diskselector_item_append()
24170     * @see elm_diskselector_items_get()
24171     *
24172     * @ingroup Diskselector
24173     */
24174    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24175
24176    /**
24177     * Get the last item of the diskselector.
24178     *
24179     * @param obj The diskselector object.
24180     * @return The last item, or @c NULL if none.
24181     *
24182     * The list of items follows append order. So it will return last first
24183     * item appended to the widget that wasn't deleted.
24184     *
24185     * @see elm_diskselector_item_append()
24186     * @see elm_diskselector_items_get()
24187     *
24188     * @ingroup Diskselector
24189     */
24190    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24191
24192    /**
24193     * Get the item before @p item in diskselector.
24194     *
24195     * @param it The diskselector item.
24196     * @return The item before @p item, or @c NULL if none or on failure.
24197     *
24198     * The list of items follows append order. So it will return item appended
24199     * just before @p item and that wasn't deleted.
24200     *
24201     * If it is the first item, @c NULL will be returned.
24202     * First item can be get by elm_diskselector_first_item_get().
24203     *
24204     * @see elm_diskselector_item_append()
24205     * @see elm_diskselector_items_get()
24206     *
24207     * @ingroup Diskselector
24208     */
24209    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24210
24211    /**
24212     * Get the item after @p item in diskselector.
24213     *
24214     * @param it The diskselector item.
24215     * @return The item after @p item, or @c NULL if none or on failure.
24216     *
24217     * The list of items follows append order. So it will return item appended
24218     * just after @p item and that wasn't deleted.
24219     *
24220     * If it is the last item, @c NULL will be returned.
24221     * Last item can be get by elm_diskselector_last_item_get().
24222     *
24223     * @see elm_diskselector_item_append()
24224     * @see elm_diskselector_items_get()
24225     *
24226     * @ingroup Diskselector
24227     */
24228    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24229
24230    /**
24231     * Set the text to be shown in the diskselector item.
24232     *
24233     * @param item Target item
24234     * @param text The text to set in the content
24235     *
24236     * Setup the text as tooltip to object. The item can have only one tooltip,
24237     * so any previous tooltip data is removed.
24238     *
24239     * @see elm_object_tooltip_text_set() for more details.
24240     *
24241     * @ingroup Diskselector
24242     */
24243    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24244
24245    /**
24246     * Set the content to be shown in the tooltip item.
24247     *
24248     * Setup the tooltip to item. The item can have only one tooltip,
24249     * so any previous tooltip data is removed. @p func(with @p data) will
24250     * be called every time that need show the tooltip and it should
24251     * return a valid Evas_Object. This object is then managed fully by
24252     * tooltip system and is deleted when the tooltip is gone.
24253     *
24254     * @param item the diskselector item being attached a tooltip.
24255     * @param func the function used to create the tooltip contents.
24256     * @param data what to provide to @a func as callback data/context.
24257     * @param del_cb called when data is not needed anymore, either when
24258     *        another callback replaces @p func, the tooltip is unset with
24259     *        elm_diskselector_item_tooltip_unset() or the owner @a item
24260     *        dies. This callback receives as the first parameter the
24261     *        given @a data, and @c event_info is the item.
24262     *
24263     * @see elm_object_tooltip_content_cb_set() for more details.
24264     *
24265     * @ingroup Diskselector
24266     */
24267    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);
24268
24269    /**
24270     * Unset tooltip from item.
24271     *
24272     * @param item diskselector item to remove previously set tooltip.
24273     *
24274     * Remove tooltip from item. The callback provided as del_cb to
24275     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24276     * it is not used anymore.
24277     *
24278     * @see elm_object_tooltip_unset() for more details.
24279     * @see elm_diskselector_item_tooltip_content_cb_set()
24280     *
24281     * @ingroup Diskselector
24282     */
24283    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24284
24285
24286    /**
24287     * Sets a different style for this item tooltip.
24288     *
24289     * @note before you set a style you should define a tooltip with
24290     *       elm_diskselector_item_tooltip_content_cb_set() or
24291     *       elm_diskselector_item_tooltip_text_set()
24292     *
24293     * @param item diskselector item with tooltip already set.
24294     * @param style the theme style to use (default, transparent, ...)
24295     *
24296     * @see elm_object_tooltip_style_set() for more details.
24297     *
24298     * @ingroup Diskselector
24299     */
24300    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24301
24302    /**
24303     * Get the style for this item tooltip.
24304     *
24305     * @param item diskselector item with tooltip already set.
24306     * @return style the theme style in use, defaults to "default". If the
24307     *         object does not have a tooltip set, then NULL is returned.
24308     *
24309     * @see elm_object_tooltip_style_get() for more details.
24310     * @see elm_diskselector_item_tooltip_style_set()
24311     *
24312     * @ingroup Diskselector
24313     */
24314    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24315
24316    /**
24317     * Set the cursor to be shown when mouse is over the diskselector item
24318     *
24319     * @param item Target item
24320     * @param cursor the cursor name to be used.
24321     *
24322     * @see elm_object_cursor_set() for more details.
24323     *
24324     * @ingroup Diskselector
24325     */
24326    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24327
24328    /**
24329     * Get the cursor to be shown when mouse is over the diskselector item
24330     *
24331     * @param item diskselector item with cursor already set.
24332     * @return the cursor name.
24333     *
24334     * @see elm_object_cursor_get() for more details.
24335     * @see elm_diskselector_cursor_set()
24336     *
24337     * @ingroup Diskselector
24338     */
24339    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24340
24341
24342    /**
24343     * Unset the cursor to be shown when mouse is over the diskselector item
24344     *
24345     * @param item Target item
24346     *
24347     * @see elm_object_cursor_unset() for more details.
24348     * @see elm_diskselector_cursor_set()
24349     *
24350     * @ingroup Diskselector
24351     */
24352    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24353
24354    /**
24355     * Sets a different style for this item cursor.
24356     *
24357     * @note before you set a style you should define a cursor with
24358     *       elm_diskselector_item_cursor_set()
24359     *
24360     * @param item diskselector item with cursor already set.
24361     * @param style the theme style to use (default, transparent, ...)
24362     *
24363     * @see elm_object_cursor_style_set() for more details.
24364     *
24365     * @ingroup Diskselector
24366     */
24367    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24368
24369
24370    /**
24371     * Get the style for this item cursor.
24372     *
24373     * @param item diskselector item with cursor already set.
24374     * @return style the theme style in use, defaults to "default". If the
24375     *         object does not have a cursor set, then @c NULL is returned.
24376     *
24377     * @see elm_object_cursor_style_get() for more details.
24378     * @see elm_diskselector_item_cursor_style_set()
24379     *
24380     * @ingroup Diskselector
24381     */
24382    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24383
24384
24385    /**
24386     * Set if the cursor set should be searched on the theme or should use
24387     * the provided by the engine, only.
24388     *
24389     * @note before you set if should look on theme you should define a cursor
24390     * with elm_diskselector_item_cursor_set().
24391     * By default it will only look for cursors provided by the engine.
24392     *
24393     * @param item widget item with cursor already set.
24394     * @param engine_only boolean to define if cursors set with
24395     * elm_diskselector_item_cursor_set() should be searched only
24396     * between cursors provided by the engine or searched on widget's
24397     * theme as well.
24398     *
24399     * @see elm_object_cursor_engine_only_set() for more details.
24400     *
24401     * @ingroup Diskselector
24402     */
24403    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24404
24405    /**
24406     * Get the cursor engine only usage for this item cursor.
24407     *
24408     * @param item widget item with cursor already set.
24409     * @return engine_only boolean to define it cursors should be looked only
24410     * between the provided by the engine or searched on widget's theme as well.
24411     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24412     *
24413     * @see elm_object_cursor_engine_only_get() for more details.
24414     * @see elm_diskselector_item_cursor_engine_only_set()
24415     *
24416     * @ingroup Diskselector
24417     */
24418    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24419
24420    /**
24421     * @}
24422     */
24423
24424    /**
24425     * @defgroup Colorselector Colorselector
24426     *
24427     * @{
24428     *
24429     * @image html img/widget/colorselector/preview-00.png
24430     * @image latex img/widget/colorselector/preview-00.eps
24431     *
24432     * @brief Widget for user to select a color.
24433     *
24434     * Signals that you can add callbacks for are:
24435     * "changed" - When the color value changes(event_info is NULL).
24436     *
24437     * See @ref tutorial_colorselector.
24438     */
24439    /**
24440     * @brief Add a new colorselector to the parent
24441     *
24442     * @param parent The parent object
24443     * @return The new object or NULL if it cannot be created
24444     *
24445     * @ingroup Colorselector
24446     */
24447    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24448    /**
24449     * Set a color for the colorselector
24450     *
24451     * @param obj   Colorselector object
24452     * @param r     r-value of color
24453     * @param g     g-value of color
24454     * @param b     b-value of color
24455     * @param a     a-value of color
24456     *
24457     * @ingroup Colorselector
24458     */
24459    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24460    /**
24461     * Get a color from the colorselector
24462     *
24463     * @param obj   Colorselector object
24464     * @param r     integer pointer for r-value of color
24465     * @param g     integer pointer for g-value of color
24466     * @param b     integer pointer for b-value of color
24467     * @param a     integer pointer for a-value of color
24468     *
24469     * @ingroup Colorselector
24470     */
24471    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24472    /**
24473     * @}
24474     */
24475
24476    /**
24477     * @defgroup Ctxpopup Ctxpopup
24478     *
24479     * @image html img/widget/ctxpopup/preview-00.png
24480     * @image latex img/widget/ctxpopup/preview-00.eps
24481     *
24482     * @brief Context popup widet.
24483     *
24484     * A ctxpopup is a widget that, when shown, pops up a list of items.
24485     * It automatically chooses an area inside its parent object's view
24486     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24487     * optimally fit into it. In the default theme, it will also point an
24488     * arrow to it's top left position at the time one shows it. Ctxpopup
24489     * items have a label and/or an icon. It is intended for a small
24490     * number of items (hence the use of list, not genlist).
24491     *
24492     * @note Ctxpopup is a especialization of @ref Hover.
24493     *
24494     * Signals that you can add callbacks for are:
24495     * "dismissed" - the ctxpopup was dismissed
24496     *
24497     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24498     * @{
24499     */
24500    typedef struct _Elm_Ctxpopup_Item Elm_Ctxpopup_Item;
24501
24502    typedef enum _Elm_Ctxpopup_Direction
24503      {
24504         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24505                                           area */
24506         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24507                                            the clicked area */
24508         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24509                                           the clicked area */
24510         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24511                                         area */
24512      } Elm_Ctxpopup_Direction;
24513
24514    /**
24515     * @brief Add a new Ctxpopup object to the parent.
24516     *
24517     * @param parent Parent object
24518     * @return New object or @c NULL, if it cannot be created
24519     */
24520    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24521    /**
24522     * @brief Set the Ctxpopup's parent
24523     *
24524     * @param obj The ctxpopup object
24525     * @param area The parent to use
24526     *
24527     * Set the parent object.
24528     *
24529     * @note elm_ctxpopup_add() will automatically call this function
24530     * with its @c parent argument.
24531     *
24532     * @see elm_ctxpopup_add()
24533     * @see elm_hover_parent_set()
24534     */
24535    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24536    /**
24537     * @brief Get the Ctxpopup's parent
24538     *
24539     * @param obj The ctxpopup object
24540     *
24541     * @see elm_ctxpopup_hover_parent_set() for more information
24542     */
24543    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24544    /**
24545     * @brief Clear all items in the given ctxpopup object.
24546     *
24547     * @param obj Ctxpopup object
24548     */
24549    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24550    /**
24551     * @brief Change the ctxpopup's orientation to horizontal or vertical.
24552     *
24553     * @param obj Ctxpopup object
24554     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24555     */
24556    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24557    /**
24558     * @brief Get the value of current ctxpopup object's orientation.
24559     *
24560     * @param obj Ctxpopup object
24561     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24562     *
24563     * @see elm_ctxpopup_horizontal_set()
24564     */
24565    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24566    /**
24567     * @brief Add a new item to a ctxpopup object.
24568     *
24569     * @param obj Ctxpopup object
24570     * @param icon Icon to be set on new item
24571     * @param label The Label of the new item
24572     * @param func Convenience function called when item selected
24573     * @param data Data passed to @p func
24574     * @return A handle to the item added or @c NULL, on errors
24575     *
24576     * @warning Ctxpopup can't hold both an item list and a content at the same
24577     * time. When an item is added, any previous content will be removed.
24578     *
24579     * @see elm_ctxpopup_content_set()
24580     */
24581    Elm_Ctxpopup_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);
24582    /**
24583     * @brief Delete the given item in a ctxpopup object.
24584     *
24585     * @param item Ctxpopup item to be deleted
24586     *
24587     * @see elm_ctxpopup_item_append()
24588     */
24589    EAPI void          elm_ctxpopup_item_del(Elm_Ctxpopup_Item *it) EINA_ARG_NONNULL(1);
24590    /**
24591     * @brief Set the ctxpopup item's state as disabled or enabled.
24592     *
24593     * @param item Ctxpopup item to be enabled/disabled
24594     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24595     *
24596     * When disabled the item is greyed out to indicate it's state.
24597     */
24598    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Ctxpopup_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24599    /**
24600     * @brief Get the ctxpopup item's disabled/enabled state.
24601     *
24602     * @param item Ctxpopup item to be enabled/disabled
24603     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24604     *
24605     * @see elm_ctxpopup_item_disabled_set()
24606     */
24607    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24608    /**
24609     * @brief Get the icon object for the given ctxpopup item.
24610     *
24611     * @param item Ctxpopup item
24612     * @return icon object or @c NULL, if the item does not have icon or an error
24613     * occurred
24614     *
24615     * @see elm_ctxpopup_item_append()
24616     * @see elm_ctxpopup_item_icon_set()
24617     */
24618    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24619    /**
24620     * @brief Sets the side icon associated with the ctxpopup item
24621     *
24622     * @param item Ctxpopup item
24623     * @param icon Icon object to be set
24624     *
24625     * Once the icon object is set, a previously set one will be deleted.
24626     * @warning Setting the same icon for two items will cause the icon to
24627     * dissapear from the first item.
24628     *
24629     * @see elm_ctxpopup_item_append()
24630     */
24631    EAPI void          elm_ctxpopup_item_icon_set(Elm_Ctxpopup_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24632    /**
24633     * @brief Get the label for the given ctxpopup item.
24634     *
24635     * @param item Ctxpopup item
24636     * @return label string or @c NULL, if the item does not have label or an
24637     * error occured
24638     *
24639     * @see elm_ctxpopup_item_append()
24640     * @see elm_ctxpopup_item_label_set()
24641     */
24642    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Ctxpopup_Item *item) EINA_ARG_NONNULL(1);
24643    /**
24644     * @brief (Re)set the label on the given ctxpopup item.
24645     *
24646     * @param item Ctxpopup item
24647     * @param label String to set as label
24648     */
24649    EAPI void          elm_ctxpopup_item_label_set(Elm_Ctxpopup_Item *item, const char *label) EINA_ARG_NONNULL(1);
24650    /**
24651     * @brief Set an elm widget as the content of the ctxpopup.
24652     *
24653     * @param obj Ctxpopup object
24654     * @param content Content to be swallowed
24655     *
24656     * If the content object is already set, a previous one will bedeleted. If
24657     * you want to keep that old content object, use the
24658     * elm_ctxpopup_content_unset() function.
24659     *
24660     * @deprecated use elm_object_content_set()
24661     *
24662     * @warning Ctxpopup can't hold both a item list and a content at the same
24663     * time. When a content is set, any previous items will be removed.
24664     */
24665    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24666    /**
24667     * @brief Unset the ctxpopup content
24668     *
24669     * @param obj Ctxpopup object
24670     * @return The content that was being used
24671     *
24672     * Unparent and return the content object which was set for this widget.
24673     *
24674     * @deprecated use elm_object_content_unset()
24675     *
24676     * @see elm_ctxpopup_content_set()
24677     */
24678    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24679    /**
24680     * @brief Set the direction priority of a ctxpopup.
24681     *
24682     * @param obj Ctxpopup object
24683     * @param first 1st priority of direction
24684     * @param second 2nd priority of direction
24685     * @param third 3th priority of direction
24686     * @param fourth 4th priority of direction
24687     *
24688     * This functions gives a chance to user to set the priority of ctxpopup
24689     * showing direction. This doesn't guarantee the ctxpopup will appear in the
24690     * requested direction.
24691     *
24692     * @see Elm_Ctxpopup_Direction
24693     */
24694    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);
24695    /**
24696     * @brief Get the direction priority of a ctxpopup.
24697     *
24698     * @param obj Ctxpopup object
24699     * @param first 1st priority of direction to be returned
24700     * @param second 2nd priority of direction to be returned
24701     * @param third 3th priority of direction to be returned
24702     * @param fourth 4th priority of direction to be returned
24703     *
24704     * @see elm_ctxpopup_direction_priority_set() for more information.
24705     */
24706    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);
24707    /**
24708     * @}
24709     */
24710
24711    /* transit */
24712    /**
24713     *
24714     * @defgroup Transit Transit
24715     * @ingroup Elementary
24716     *
24717     * Transit is designed to apply various animated transition effects to @c
24718     * Evas_Object, such like translation, rotation, etc. For using these
24719     * effects, create an @ref Elm_Transit and add the desired transition effects.
24720     *
24721     * Once the effects are added into transit, they will be automatically
24722     * managed (their callback will be called until the duration is ended, and
24723     * they will be deleted on completion).
24724     *
24725     * Example:
24726     * @code
24727     * Elm_Transit *trans = elm_transit_add();
24728     * elm_transit_object_add(trans, obj);
24729     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
24730     * elm_transit_duration_set(transit, 1);
24731     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
24732     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
24733     * elm_transit_repeat_times_set(transit, 3);
24734     * @endcode
24735     *
24736     * Some transition effects are used to change the properties of objects. They
24737     * are:
24738     * @li @ref elm_transit_effect_translation_add
24739     * @li @ref elm_transit_effect_color_add
24740     * @li @ref elm_transit_effect_rotation_add
24741     * @li @ref elm_transit_effect_wipe_add
24742     * @li @ref elm_transit_effect_zoom_add
24743     * @li @ref elm_transit_effect_resizing_add
24744     *
24745     * Other transition effects are used to make one object disappear and another
24746     * object appear on its old place. These effects are:
24747     *
24748     * @li @ref elm_transit_effect_flip_add
24749     * @li @ref elm_transit_effect_resizable_flip_add
24750     * @li @ref elm_transit_effect_fade_add
24751     * @li @ref elm_transit_effect_blend_add
24752     *
24753     * It's also possible to make a transition chain with @ref
24754     * elm_transit_chain_transit_add.
24755     *
24756     * @warning We strongly recommend to use elm_transit just when edje can not do
24757     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
24758     * animations can be manipulated inside the theme.
24759     *
24760     * List of examples:
24761     * @li @ref transit_example_01_explained
24762     * @li @ref transit_example_02_explained
24763     * @li @ref transit_example_03_c
24764     * @li @ref transit_example_04_c
24765     *
24766     * @{
24767     */
24768
24769    /**
24770     * @enum Elm_Transit_Tween_Mode
24771     *
24772     * The type of acceleration used in the transition.
24773     */
24774    typedef enum
24775      {
24776         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
24777         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
24778                                              over time, then decrease again
24779                                              and stop slowly */
24780         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
24781                                              speed over time */
24782         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
24783                                             over time */
24784      } Elm_Transit_Tween_Mode;
24785
24786    /**
24787     * @enum Elm_Transit_Effect_Flip_Axis
24788     *
24789     * The axis where flip effect should be applied.
24790     */
24791    typedef enum
24792      {
24793         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
24794         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
24795      } Elm_Transit_Effect_Flip_Axis;
24796    /**
24797     * @enum Elm_Transit_Effect_Wipe_Dir
24798     *
24799     * The direction where the wipe effect should occur.
24800     */
24801    typedef enum
24802      {
24803         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
24804         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
24805         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
24806         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
24807      } Elm_Transit_Effect_Wipe_Dir;
24808    /** @enum Elm_Transit_Effect_Wipe_Type
24809     *
24810     * Whether the wipe effect should show or hide the object.
24811     */
24812    typedef enum
24813      {
24814         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
24815                                              animation */
24816         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
24817                                             animation */
24818      } Elm_Transit_Effect_Wipe_Type;
24819
24820    /**
24821     * @typedef Elm_Transit
24822     *
24823     * The Transit created with elm_transit_add(). This type has the information
24824     * about the objects which the transition will be applied, and the
24825     * transition effects that will be used. It also contains info about
24826     * duration, number of repetitions, auto-reverse, etc.
24827     */
24828    typedef struct _Elm_Transit Elm_Transit;
24829    typedef void Elm_Transit_Effect;
24830    /**
24831     * @typedef Elm_Transit_Effect_Transition_Cb
24832     *
24833     * Transition callback called for this effect on each transition iteration.
24834     */
24835    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
24836    /**
24837     * Elm_Transit_Effect_End_Cb
24838     *
24839     * Transition callback called for this effect when the transition is over.
24840     */
24841    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
24842
24843    /**
24844     * Elm_Transit_Del_Cb
24845     *
24846     * A callback called when the transit is deleted.
24847     */
24848    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
24849
24850    /**
24851     * Add new transit.
24852     *
24853     * @note Is not necessary to delete the transit object, it will be deleted at
24854     * the end of its operation.
24855     * @note The transit will start playing when the program enter in the main loop, is not
24856     * necessary to give a start to the transit.
24857     *
24858     * @return The transit object.
24859     *
24860     * @ingroup Transit
24861     */
24862    EAPI Elm_Transit                *elm_transit_add(void);
24863
24864    /**
24865     * Stops the animation and delete the @p transit object.
24866     *
24867     * Call this function if you wants to stop the animation before the duration
24868     * time. Make sure the @p transit object is still alive with
24869     * elm_transit_del_cb_set() function.
24870     * All added effects will be deleted, calling its repective data_free_cb
24871     * functions. The function setted by elm_transit_del_cb_set() will be called.
24872     *
24873     * @see elm_transit_del_cb_set()
24874     *
24875     * @param transit The transit object to be deleted.
24876     *
24877     * @ingroup Transit
24878     * @warning Just call this function if you are sure the transit is alive.
24879     */
24880    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
24881
24882    /**
24883     * Add a new effect to the transit.
24884     *
24885     * @note The cb function and the data are the key to the effect. If you try to
24886     * add an already added effect, nothing is done.
24887     * @note After the first addition of an effect in @p transit, if its
24888     * effect list become empty again, the @p transit will be killed by
24889     * elm_transit_del(transit) function.
24890     *
24891     * Exemple:
24892     * @code
24893     * Elm_Transit *transit = elm_transit_add();
24894     * elm_transit_effect_add(transit,
24895     *                        elm_transit_effect_blend_op,
24896     *                        elm_transit_effect_blend_context_new(),
24897     *                        elm_transit_effect_blend_context_free);
24898     * @endcode
24899     *
24900     * @param transit The transit object.
24901     * @param transition_cb The operation function. It is called when the
24902     * animation begins, it is the function that actually performs the animation.
24903     * It is called with the @p data, @p transit and the time progression of the
24904     * animation (a double value between 0.0 and 1.0).
24905     * @param effect The context data of the effect.
24906     * @param end_cb The function to free the context data, it will be called
24907     * at the end of the effect, it must finalize the animation and free the
24908     * @p data.
24909     *
24910     * @ingroup Transit
24911     * @warning The transit free the context data at the and of the transition with
24912     * the data_free_cb function, do not use the context data in another transit.
24913     */
24914    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);
24915
24916    /**
24917     * Delete an added effect.
24918     *
24919     * This function will remove the effect from the @p transit, calling the
24920     * data_free_cb to free the @p data.
24921     *
24922     * @see elm_transit_effect_add()
24923     *
24924     * @note If the effect is not found, nothing is done.
24925     * @note If the effect list become empty, this function will call
24926     * elm_transit_del(transit), that is, it will kill the @p transit.
24927     *
24928     * @param transit The transit object.
24929     * @param transition_cb The operation function.
24930     * @param effect The context data of the effect.
24931     *
24932     * @ingroup Transit
24933     */
24934    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);
24935
24936    /**
24937     * Add new object to apply the effects.
24938     *
24939     * @note After the first addition of an object in @p transit, if its
24940     * object list become empty again, the @p transit will be killed by
24941     * elm_transit_del(transit) function.
24942     * @note If the @p obj belongs to another transit, the @p obj will be
24943     * removed from it and it will only belong to the @p transit. If the old
24944     * transit stays without objects, it will die.
24945     * @note When you add an object into the @p transit, its state from
24946     * evas_object_pass_events_get(obj) is saved, and it is applied when the
24947     * transit ends, if you change this state whith evas_object_pass_events_set()
24948     * after add the object, this state will change again when @p transit stops to
24949     * run.
24950     *
24951     * @param transit The transit object.
24952     * @param obj Object to be animated.
24953     *
24954     * @ingroup Transit
24955     * @warning It is not allowed to add a new object after transit begins to go.
24956     */
24957    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
24958
24959    /**
24960     * Removes an added object from the transit.
24961     *
24962     * @note If the @p obj is not in the @p transit, nothing is done.
24963     * @note If the list become empty, this function will call
24964     * elm_transit_del(transit), that is, it will kill the @p transit.
24965     *
24966     * @param transit The transit object.
24967     * @param obj Object to be removed from @p transit.
24968     *
24969     * @ingroup Transit
24970     * @warning It is not allowed to remove objects after transit begins to go.
24971     */
24972    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
24973
24974    /**
24975     * Get the objects of the transit.
24976     *
24977     * @param transit The transit object.
24978     * @return a Eina_List with the objects from the transit.
24979     *
24980     * @ingroup Transit
24981     */
24982    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
24983
24984    /**
24985     * Enable/disable keeping up the objects states.
24986     * If it is not kept, the objects states will be reset when transition ends.
24987     *
24988     * @note @p transit can not be NULL.
24989     * @note One state includes geometry, color, map data.
24990     *
24991     * @param transit The transit object.
24992     * @param state_keep Keeping or Non Keeping.
24993     *
24994     * @ingroup Transit
24995     */
24996    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
24997
24998    /**
24999     * Get a value whether the objects states will be reset or not.
25000     *
25001     * @note @p transit can not be NULL
25002     *
25003     * @see elm_transit_objects_final_state_keep_set()
25004     *
25005     * @param transit The transit object.
25006     * @return EINA_TRUE means the states of the objects will be reset.
25007     * If @p transit is NULL, EINA_FALSE is returned
25008     *
25009     * @ingroup Transit
25010     */
25011    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25012
25013    /**
25014     * Set the event enabled when transit is operating.
25015     *
25016     * If @p enabled is EINA_TRUE, the objects of the transit will receives
25017     * events from mouse and keyboard during the animation.
25018     * @note When you add an object with elm_transit_object_add(), its state from
25019     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25020     * transit ends, if you change this state with evas_object_pass_events_set()
25021     * after adding the object, this state will change again when @p transit stops
25022     * to run.
25023     *
25024     * @param transit The transit object.
25025     * @param enabled Events are received when enabled is @c EINA_TRUE, and
25026     * ignored otherwise.
25027     *
25028     * @ingroup Transit
25029     */
25030    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25031
25032    /**
25033     * Get the value of event enabled status.
25034     *
25035     * @see elm_transit_event_enabled_set()
25036     *
25037     * @param transit The Transit object
25038     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25039     * EINA_FALSE is returned
25040     *
25041     * @ingroup Transit
25042     */
25043    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25044
25045    /**
25046     * Set the user-callback function when the transit is deleted.
25047     *
25048     * @note Using this function twice will overwrite the first function setted.
25049     * @note the @p transit object will be deleted after call @p cb function.
25050     *
25051     * @param transit The transit object.
25052     * @param cb Callback function pointer. This function will be called before
25053     * the deletion of the transit.
25054     * @param data Callback funtion user data. It is the @p op parameter.
25055     *
25056     * @ingroup Transit
25057     */
25058    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25059
25060    /**
25061     * Set reverse effect automatically.
25062     *
25063     * If auto reverse is setted, after running the effects with the progress
25064     * parameter from 0 to 1, it will call the effecs again with the progress
25065     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25066     * where the duration was setted with the function elm_transit_add and
25067     * the repeat with the function elm_transit_repeat_times_set().
25068     *
25069     * @param transit The transit object.
25070     * @param reverse EINA_TRUE means the auto_reverse is on.
25071     *
25072     * @ingroup Transit
25073     */
25074    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25075
25076    /**
25077     * Get if the auto reverse is on.
25078     *
25079     * @see elm_transit_auto_reverse_set()
25080     *
25081     * @param transit The transit object.
25082     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25083     * EINA_FALSE is returned
25084     *
25085     * @ingroup Transit
25086     */
25087    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25088
25089    /**
25090     * Set the transit repeat count. Effect will be repeated by repeat count.
25091     *
25092     * This function sets the number of repetition the transit will run after
25093     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25094     * If the @p repeat is a negative number, it will repeat infinite times.
25095     *
25096     * @note If this function is called during the transit execution, the transit
25097     * will run @p repeat times, ignoring the times it already performed.
25098     *
25099     * @param transit The transit object
25100     * @param repeat Repeat count
25101     *
25102     * @ingroup Transit
25103     */
25104    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25105
25106    /**
25107     * Get the transit repeat count.
25108     *
25109     * @see elm_transit_repeat_times_set()
25110     *
25111     * @param transit The Transit object.
25112     * @return The repeat count. If @p transit is NULL
25113     * 0 is returned
25114     *
25115     * @ingroup Transit
25116     */
25117    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25118
25119    /**
25120     * Set the transit animation acceleration type.
25121     *
25122     * This function sets the tween mode of the transit that can be:
25123     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25124     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25125     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25126     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25127     *
25128     * @param transit The transit object.
25129     * @param tween_mode The tween type.
25130     *
25131     * @ingroup Transit
25132     */
25133    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25134
25135    /**
25136     * Get the transit animation acceleration type.
25137     *
25138     * @note @p transit can not be NULL
25139     *
25140     * @param transit The transit object.
25141     * @return The tween type. If @p transit is NULL
25142     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25143     *
25144     * @ingroup Transit
25145     */
25146    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25147
25148    /**
25149     * Set the transit animation time
25150     *
25151     * @note @p transit can not be NULL
25152     *
25153     * @param transit The transit object.
25154     * @param duration The animation time.
25155     *
25156     * @ingroup Transit
25157     */
25158    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25159
25160    /**
25161     * Get the transit animation time
25162     *
25163     * @note @p transit can not be NULL
25164     *
25165     * @param transit The transit object.
25166     *
25167     * @return The transit animation time.
25168     *
25169     * @ingroup Transit
25170     */
25171    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25172
25173    /**
25174     * Starts the transition.
25175     * Once this API is called, the transit begins to measure the time.
25176     *
25177     * @note @p transit can not be NULL
25178     *
25179     * @param transit The transit object.
25180     *
25181     * @ingroup Transit
25182     */
25183    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25184
25185    /**
25186     * Pause/Resume the transition.
25187     *
25188     * If you call elm_transit_go again, the transit will be started from the
25189     * beginning, and will be unpaused.
25190     *
25191     * @note @p transit can not be NULL
25192     *
25193     * @param transit The transit object.
25194     * @param paused Whether the transition should be paused or not.
25195     *
25196     * @ingroup Transit
25197     */
25198    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25199
25200    /**
25201     * Get the value of paused status.
25202     *
25203     * @see elm_transit_paused_set()
25204     *
25205     * @note @p transit can not be NULL
25206     *
25207     * @param transit The transit object.
25208     * @return EINA_TRUE means transition is paused. If @p transit is NULL
25209     * EINA_FALSE is returned
25210     *
25211     * @ingroup Transit
25212     */
25213    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25214
25215    /**
25216     * Get the time progression of the animation (a double value between 0.0 and 1.0).
25217     *
25218     * The value returned is a fraction (current time / total time). It
25219     * represents the progression position relative to the total.
25220     *
25221     * @note @p transit can not be NULL
25222     *
25223     * @param transit The transit object.
25224     *
25225     * @return The time progression value. If @p transit is NULL
25226     * 0 is returned
25227     *
25228     * @ingroup Transit
25229     */
25230    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25231
25232    /**
25233     * Makes the chain relationship between two transits.
25234     *
25235     * @note @p transit can not be NULL. Transit would have multiple chain transits.
25236     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25237     *
25238     * @param transit The transit object.
25239     * @param chain_transit The chain transit object. This transit will be operated
25240     *        after transit is done.
25241     *
25242     * This function adds @p chain_transit transition to a chain after the @p
25243     * transit, and will be started as soon as @p transit ends. See @ref
25244     * transit_example_02_explained for a full example.
25245     *
25246     * @ingroup Transit
25247     */
25248    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25249
25250    /**
25251     * Cut off the chain relationship between two transits.
25252     *
25253     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25254     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25255     *
25256     * @param transit The transit object.
25257     * @param chain_transit The chain transit object.
25258     *
25259     * This function remove the @p chain_transit transition from the @p transit.
25260     *
25261     * @ingroup Transit
25262     */
25263    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25264
25265    /**
25266     * Get the current chain transit list.
25267     *
25268     * @note @p transit can not be NULL.
25269     *
25270     * @param transit The transit object.
25271     * @return chain transit list.
25272     *
25273     * @ingroup Transit
25274     */
25275    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
25276
25277    /**
25278     * Add the Resizing Effect to Elm_Transit.
25279     *
25280     * @note This API is one of the facades. It creates resizing effect context
25281     * and add it's required APIs to elm_transit_effect_add.
25282     *
25283     * @see elm_transit_effect_add()
25284     *
25285     * @param transit Transit object.
25286     * @param from_w Object width size when effect begins.
25287     * @param from_h Object height size when effect begins.
25288     * @param to_w Object width size when effect ends.
25289     * @param to_h Object height size when effect ends.
25290     * @return Resizing effect context data.
25291     *
25292     * @ingroup Transit
25293     */
25294    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);
25295
25296    /**
25297     * Add the Translation Effect to Elm_Transit.
25298     *
25299     * @note This API is one of the facades. It creates translation effect context
25300     * and add it's required APIs to elm_transit_effect_add.
25301     *
25302     * @see elm_transit_effect_add()
25303     *
25304     * @param transit Transit object.
25305     * @param from_dx X Position variation when effect begins.
25306     * @param from_dy Y Position variation when effect begins.
25307     * @param to_dx X Position variation when effect ends.
25308     * @param to_dy Y Position variation when effect ends.
25309     * @return Translation effect context data.
25310     *
25311     * @ingroup Transit
25312     * @warning It is highly recommended just create a transit with this effect when
25313     * the window that the objects of the transit belongs has already been created.
25314     * This is because this effect needs the geometry information about the objects,
25315     * and if the window was not created yet, it can get a wrong information.
25316     */
25317    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);
25318
25319    /**
25320     * Add the Zoom Effect to Elm_Transit.
25321     *
25322     * @note This API is one of the facades. It creates zoom effect context
25323     * and add it's required APIs to elm_transit_effect_add.
25324     *
25325     * @see elm_transit_effect_add()
25326     *
25327     * @param transit Transit object.
25328     * @param from_rate Scale rate when effect begins (1 is current rate).
25329     * @param to_rate Scale rate when effect ends.
25330     * @return Zoom effect context data.
25331     *
25332     * @ingroup Transit
25333     * @warning It is highly recommended just create a transit with this effect when
25334     * the window that the objects of the transit belongs has already been created.
25335     * This is because this effect needs the geometry information about the objects,
25336     * and if the window was not created yet, it can get a wrong information.
25337     */
25338    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25339
25340    /**
25341     * Add the Flip Effect to Elm_Transit.
25342     *
25343     * @note This API is one of the facades. It creates flip effect context
25344     * and add it's required APIs to elm_transit_effect_add.
25345     * @note This effect is applied to each pair of objects in the order they are listed
25346     * in the transit list of objects. The first object in the pair will be the
25347     * "front" object and the second will be the "back" object.
25348     *
25349     * @see elm_transit_effect_add()
25350     *
25351     * @param transit Transit object.
25352     * @param axis Flipping Axis(X or Y).
25353     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25354     * @return Flip effect context data.
25355     *
25356     * @ingroup Transit
25357     * @warning It is highly recommended just create a transit with this effect when
25358     * the window that the objects of the transit belongs has already been created.
25359     * This is because this effect needs the geometry information about the objects,
25360     * and if the window was not created yet, it can get a wrong information.
25361     */
25362    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25363
25364    /**
25365     * Add the Resizable Flip Effect to Elm_Transit.
25366     *
25367     * @note This API is one of the facades. It creates resizable flip effect context
25368     * and add it's required APIs to elm_transit_effect_add.
25369     * @note This effect is applied to each pair of objects in the order they are listed
25370     * in the transit list of objects. The first object in the pair will be the
25371     * "front" object and the second will be the "back" object.
25372     *
25373     * @see elm_transit_effect_add()
25374     *
25375     * @param transit Transit object.
25376     * @param axis Flipping Axis(X or Y).
25377     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25378     * @return Resizable flip effect context data.
25379     *
25380     * @ingroup Transit
25381     * @warning It is highly recommended just create a transit with this effect when
25382     * the window that the objects of the transit belongs has already been created.
25383     * This is because this effect needs the geometry information about the objects,
25384     * and if the window was not created yet, it can get a wrong information.
25385     */
25386    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25387
25388    /**
25389     * Add the Wipe Effect to Elm_Transit.
25390     *
25391     * @note This API is one of the facades. It creates wipe effect context
25392     * and add it's required APIs to elm_transit_effect_add.
25393     *
25394     * @see elm_transit_effect_add()
25395     *
25396     * @param transit Transit object.
25397     * @param type Wipe type. Hide or show.
25398     * @param dir Wipe Direction.
25399     * @return Wipe effect context data.
25400     *
25401     * @ingroup Transit
25402     * @warning It is highly recommended just create a transit with this effect when
25403     * the window that the objects of the transit belongs has already been created.
25404     * This is because this effect needs the geometry information about the objects,
25405     * and if the window was not created yet, it can get a wrong information.
25406     */
25407    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25408
25409    /**
25410     * Add the Color Effect to Elm_Transit.
25411     *
25412     * @note This API is one of the facades. It creates color effect context
25413     * and add it's required APIs to elm_transit_effect_add.
25414     *
25415     * @see elm_transit_effect_add()
25416     *
25417     * @param transit        Transit object.
25418     * @param  from_r        RGB R when effect begins.
25419     * @param  from_g        RGB G when effect begins.
25420     * @param  from_b        RGB B when effect begins.
25421     * @param  from_a        RGB A when effect begins.
25422     * @param  to_r          RGB R when effect ends.
25423     * @param  to_g          RGB G when effect ends.
25424     * @param  to_b          RGB B when effect ends.
25425     * @param  to_a          RGB A when effect ends.
25426     * @return               Color effect context data.
25427     *
25428     * @ingroup Transit
25429     */
25430    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);
25431
25432    /**
25433     * Add the Fade Effect to Elm_Transit.
25434     *
25435     * @note This API is one of the facades. It creates fade effect context
25436     * and add it's required APIs to elm_transit_effect_add.
25437     * @note This effect is applied to each pair of objects in the order they are listed
25438     * in the transit list of objects. The first object in the pair will be the
25439     * "before" object and the second will be the "after" object.
25440     *
25441     * @see elm_transit_effect_add()
25442     *
25443     * @param transit Transit object.
25444     * @return Fade effect context data.
25445     *
25446     * @ingroup Transit
25447     * @warning It is highly recommended just create a transit with this effect when
25448     * the window that the objects of the transit belongs has already been created.
25449     * This is because this effect needs the color information about the objects,
25450     * and if the window was not created yet, it can get a wrong information.
25451     */
25452    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25453
25454    /**
25455     * Add the Blend Effect to Elm_Transit.
25456     *
25457     * @note This API is one of the facades. It creates blend effect context
25458     * and add it's required APIs to elm_transit_effect_add.
25459     * @note This effect is applied to each pair of objects in the order they are listed
25460     * in the transit list of objects. The first object in the pair will be the
25461     * "before" object and the second will be the "after" object.
25462     *
25463     * @see elm_transit_effect_add()
25464     *
25465     * @param transit Transit object.
25466     * @return Blend effect context data.
25467     *
25468     * @ingroup Transit
25469     * @warning It is highly recommended just create a transit with this effect when
25470     * the window that the objects of the transit belongs has already been created.
25471     * This is because this effect needs the color information about the objects,
25472     * and if the window was not created yet, it can get a wrong information.
25473     */
25474    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25475
25476    /**
25477     * Add the Rotation Effect to Elm_Transit.
25478     *
25479     * @note This API is one of the facades. It creates rotation effect context
25480     * and add it's required APIs to elm_transit_effect_add.
25481     *
25482     * @see elm_transit_effect_add()
25483     *
25484     * @param transit Transit object.
25485     * @param from_degree Degree when effect begins.
25486     * @param to_degree Degree when effect is ends.
25487     * @return Rotation effect context data.
25488     *
25489     * @ingroup Transit
25490     * @warning It is highly recommended just create a transit with this effect when
25491     * the window that the objects of the transit belongs has already been created.
25492     * This is because this effect needs the geometry information about the objects,
25493     * and if the window was not created yet, it can get a wrong information.
25494     */
25495    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25496
25497    /**
25498     * Add the ImageAnimation Effect to Elm_Transit.
25499     *
25500     * @note This API is one of the facades. It creates image animation effect context
25501     * and add it's required APIs to elm_transit_effect_add.
25502     * The @p images parameter is a list images paths. This list and
25503     * its contents will be deleted at the end of the effect by
25504     * elm_transit_effect_image_animation_context_free() function.
25505     *
25506     * Example:
25507     * @code
25508     * char buf[PATH_MAX];
25509     * Eina_List *images = NULL;
25510     * Elm_Transit *transi = elm_transit_add();
25511     *
25512     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25513     * images = eina_list_append(images, eina_stringshare_add(buf));
25514     *
25515     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25516     * images = eina_list_append(images, eina_stringshare_add(buf));
25517     * elm_transit_effect_image_animation_add(transi, images);
25518     *
25519     * @endcode
25520     *
25521     * @see elm_transit_effect_add()
25522     *
25523     * @param transit Transit object.
25524     * @param images Eina_List of images file paths. This list and
25525     * its contents will be deleted at the end of the effect by
25526     * elm_transit_effect_image_animation_context_free() function.
25527     * @return Image Animation effect context data.
25528     *
25529     * @ingroup Transit
25530     */
25531    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25532    /**
25533     * @}
25534     */
25535
25536   typedef struct _Elm_Store                      Elm_Store;
25537   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
25538   typedef struct _Elm_Store_Item                 Elm_Store_Item;
25539   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
25540   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
25541   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25542   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
25543   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
25544   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
25545   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
25546   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
25547
25548   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25549   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25550   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25551   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25552
25553   typedef enum
25554     {
25555        ELM_STORE_ITEM_MAPPING_NONE = 0,
25556        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25557        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25558        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25559        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25560        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25561        // can add more here as needed by common apps
25562        ELM_STORE_ITEM_MAPPING_LAST
25563     } Elm_Store_Item_Mapping_Type;
25564
25565   struct _Elm_Store_Item_Mapping_Icon
25566     {
25567        // FIXME: allow edje file icons
25568        int                   w, h;
25569        Elm_Icon_Lookup_Order lookup_order;
25570        Eina_Bool             standard_name : 1;
25571        Eina_Bool             no_scale : 1;
25572        Eina_Bool             smooth : 1;
25573        Eina_Bool             scale_up : 1;
25574        Eina_Bool             scale_down : 1;
25575     };
25576
25577   struct _Elm_Store_Item_Mapping_Empty
25578     {
25579        Eina_Bool             dummy;
25580     };
25581
25582   struct _Elm_Store_Item_Mapping_Photo
25583     {
25584        int                   size;
25585     };
25586
25587   struct _Elm_Store_Item_Mapping_Custom
25588     {
25589        Elm_Store_Item_Mapping_Cb func;
25590     };
25591
25592   struct _Elm_Store_Item_Mapping
25593     {
25594        Elm_Store_Item_Mapping_Type     type;
25595        const char                     *part;
25596        int                             offset;
25597        union
25598          {
25599             Elm_Store_Item_Mapping_Empty  empty;
25600             Elm_Store_Item_Mapping_Icon   icon;
25601             Elm_Store_Item_Mapping_Photo  photo;
25602             Elm_Store_Item_Mapping_Custom custom;
25603             // add more types here
25604          } details;
25605     };
25606
25607   struct _Elm_Store_Item_Info
25608     {
25609       Elm_Genlist_Item_Class       *item_class;
25610       const Elm_Store_Item_Mapping *mapping;
25611       void                         *data;
25612       char                         *sort_id;
25613     };
25614
25615   struct _Elm_Store_Item_Info_Filesystem
25616     {
25617       Elm_Store_Item_Info  base;
25618       char                *path;
25619     };
25620
25621 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25622 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25623
25624   EAPI void                    elm_store_free(Elm_Store *st);
25625
25626   EAPI Elm_Store              *elm_store_filesystem_new(void);
25627   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25628   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25629   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25630
25631   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25632
25633   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25634   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25635   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25636   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25637   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25638   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25639
25640   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25641   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25642   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25643   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25644   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25645   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25646   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25647
25648    /**
25649     * @defgroup SegmentControl SegmentControl
25650     * @ingroup Elementary
25651     *
25652     * @image html img/widget/segment_control/preview-00.png
25653     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25654     *
25655     * @image html img/segment_control.png
25656     * @image latex img/segment_control.eps width=\textwidth
25657     *
25658     * Segment control widget is a horizontal control made of multiple segment
25659     * items, each segment item functioning similar to discrete two state button.
25660     * A segment control groups the items together and provides compact
25661     * single button with multiple equal size segments.
25662     *
25663     * Segment item size is determined by base widget
25664     * size and the number of items added.
25665     * Only one segment item can be at selected state. A segment item can display
25666     * combination of Text and any Evas_Object like Images or other widget.
25667     *
25668     * Smart callbacks one can listen to:
25669     * - "changed" - When the user clicks on a segment item which is not
25670     *   previously selected and get selected. The event_info parameter is the
25671     *   segment item index.
25672     *
25673     * Available styles for it:
25674     * - @c "default"
25675     *
25676     * Here is an example on its usage:
25677     * @li @ref segment_control_example
25678     */
25679
25680    /**
25681     * @addtogroup SegmentControl
25682     * @{
25683     */
25684
25685    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25686
25687    /**
25688     * Add a new segment control widget to the given parent Elementary
25689     * (container) object.
25690     *
25691     * @param parent The parent object.
25692     * @return a new segment control widget handle or @c NULL, on errors.
25693     *
25694     * This function inserts a new segment control widget on the canvas.
25695     *
25696     * @ingroup SegmentControl
25697     */
25698    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25699
25700    /**
25701     * Append a new item to the segment control object.
25702     *
25703     * @param obj The segment control object.
25704     * @param icon The icon object to use for the left side of the item. An
25705     * icon can be any Evas object, but usually it is an icon created
25706     * with elm_icon_add().
25707     * @param label The label of the item.
25708     *        Note that, NULL is different from empty string "".
25709     * @return The created item or @c NULL upon failure.
25710     *
25711     * A new item will be created and appended to the segment control, i.e., will
25712     * be set as @b last item.
25713     *
25714     * If it should be inserted at another position,
25715     * elm_segment_control_item_insert_at() should be used instead.
25716     *
25717     * Items created with this function can be deleted with function
25718     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25719     *
25720     * @note @p label set to @c NULL is different from empty string "".
25721     * If an item
25722     * only has icon, it will be displayed bigger and centered. If it has
25723     * icon and label, even that an empty string, icon will be smaller and
25724     * positioned at left.
25725     *
25726     * Simple example:
25727     * @code
25728     * sc = elm_segment_control_add(win);
25729     * ic = elm_icon_add(win);
25730     * elm_icon_file_set(ic, "path/to/image", NULL);
25731     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25732     * elm_segment_control_item_add(sc, ic, "label");
25733     * evas_object_show(sc);
25734     * @endcode
25735     *
25736     * @see elm_segment_control_item_insert_at()
25737     * @see elm_segment_control_item_del()
25738     *
25739     * @ingroup SegmentControl
25740     */
25741    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
25742
25743    /**
25744     * Insert a new item to the segment control object at specified position.
25745     *
25746     * @param obj The segment control object.
25747     * @param icon The icon object to use for the left side of the item. An
25748     * icon can be any Evas object, but usually it is an icon created
25749     * with elm_icon_add().
25750     * @param label The label of the item.
25751     * @param index Item position. Value should be between 0 and items count.
25752     * @return The created item or @c NULL upon failure.
25753
25754     * Index values must be between @c 0, when item will be prepended to
25755     * segment control, and items count, that can be get with
25756     * elm_segment_control_item_count_get(), case when item will be appended
25757     * to segment control, just like elm_segment_control_item_add().
25758     *
25759     * Items created with this function can be deleted with function
25760     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25761     *
25762     * @note @p label set to @c NULL is different from empty string "".
25763     * If an item
25764     * only has icon, it will be displayed bigger and centered. If it has
25765     * icon and label, even that an empty string, icon will be smaller and
25766     * positioned at left.
25767     *
25768     * @see elm_segment_control_item_add()
25769     * @see elm_segment_control_count_get()
25770     * @see elm_segment_control_item_del()
25771     *
25772     * @ingroup SegmentControl
25773     */
25774    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);
25775
25776    /**
25777     * Remove a segment control item from its parent, deleting it.
25778     *
25779     * @param it The item to be removed.
25780     *
25781     * Items can be added with elm_segment_control_item_add() or
25782     * elm_segment_control_item_insert_at().
25783     *
25784     * @ingroup SegmentControl
25785     */
25786    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25787
25788    /**
25789     * Remove a segment control item at given index from its parent,
25790     * deleting it.
25791     *
25792     * @param obj The segment control object.
25793     * @param index The position of the segment control item to be deleted.
25794     *
25795     * Items can be added with elm_segment_control_item_add() or
25796     * elm_segment_control_item_insert_at().
25797     *
25798     * @ingroup SegmentControl
25799     */
25800    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25801
25802    /**
25803     * Get the Segment items count from segment control.
25804     *
25805     * @param obj The segment control object.
25806     * @return Segment items count.
25807     *
25808     * It will just return the number of items added to segment control @p obj.
25809     *
25810     * @ingroup SegmentControl
25811     */
25812    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25813
25814    /**
25815     * Get the item placed at specified index.
25816     *
25817     * @param obj The segment control object.
25818     * @param index The index of the segment item.
25819     * @return The segment control item or @c NULL on failure.
25820     *
25821     * Index is the position of an item in segment control widget. Its
25822     * range is from @c 0 to <tt> count - 1 </tt>.
25823     * Count is the number of items, that can be get with
25824     * elm_segment_control_item_count_get().
25825     *
25826     * @ingroup SegmentControl
25827     */
25828    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25829
25830    /**
25831     * Get the label of item.
25832     *
25833     * @param obj The segment control object.
25834     * @param index The index of the segment item.
25835     * @return The label of the item at @p index.
25836     *
25837     * The return value is a pointer to the label associated to the item when
25838     * it was created, with function elm_segment_control_item_add(), or later
25839     * with function elm_segment_control_item_label_set. If no label
25840     * was passed as argument, it will return @c NULL.
25841     *
25842     * @see elm_segment_control_item_label_set() for more details.
25843     * @see elm_segment_control_item_add()
25844     *
25845     * @ingroup SegmentControl
25846     */
25847    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25848
25849    /**
25850     * Set the label of item.
25851     *
25852     * @param it The item of segment control.
25853     * @param text The label of item.
25854     *
25855     * The label to be displayed by the item.
25856     * Label will be at right of the icon (if set).
25857     *
25858     * If a label was passed as argument on item creation, with function
25859     * elm_control_segment_item_add(), it will be already
25860     * displayed by the item.
25861     *
25862     * @see elm_segment_control_item_label_get()
25863     * @see elm_segment_control_item_add()
25864     *
25865     * @ingroup SegmentControl
25866     */
25867    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
25868
25869    /**
25870     * Get the icon associated to the item.
25871     *
25872     * @param obj The segment control object.
25873     * @param index The index of the segment item.
25874     * @return The left side icon associated to the item at @p index.
25875     *
25876     * The return value is a pointer to the icon associated to the item when
25877     * it was created, with function elm_segment_control_item_add(), or later
25878     * with function elm_segment_control_item_icon_set(). If no icon
25879     * was passed as argument, it will return @c NULL.
25880     *
25881     * @see elm_segment_control_item_add()
25882     * @see elm_segment_control_item_icon_set()
25883     *
25884     * @ingroup SegmentControl
25885     */
25886    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
25887
25888    /**
25889     * Set the icon associated to the item.
25890     *
25891     * @param it The segment control item.
25892     * @param icon The icon object to associate with @p it.
25893     *
25894     * The icon object to use at left side of the item. An
25895     * icon can be any Evas object, but usually it is an icon created
25896     * with elm_icon_add().
25897     *
25898     * Once the icon object is set, a previously set one will be deleted.
25899     * @warning Setting the same icon for two items will cause the icon to
25900     * dissapear from the first item.
25901     *
25902     * If an icon was passed as argument on item creation, with function
25903     * elm_segment_control_item_add(), it will be already
25904     * associated to the item.
25905     *
25906     * @see elm_segment_control_item_add()
25907     * @see elm_segment_control_item_icon_get()
25908     *
25909     * @ingroup SegmentControl
25910     */
25911    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
25912
25913    /**
25914     * Get the index of an item.
25915     *
25916     * @param it The segment control item.
25917     * @return The position of item in segment control widget.
25918     *
25919     * Index is the position of an item in segment control widget. Its
25920     * range is from @c 0 to <tt> count - 1 </tt>.
25921     * Count is the number of items, that can be get with
25922     * elm_segment_control_item_count_get().
25923     *
25924     * @ingroup SegmentControl
25925     */
25926    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25927
25928    /**
25929     * Get the base object of the item.
25930     *
25931     * @param it The segment control item.
25932     * @return The base object associated with @p it.
25933     *
25934     * Base object is the @c Evas_Object that represents that item.
25935     *
25936     * @ingroup SegmentControl
25937     */
25938    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
25939
25940    /**
25941     * Get the selected item.
25942     *
25943     * @param obj The segment control object.
25944     * @return The selected item or @c NULL if none of segment items is
25945     * selected.
25946     *
25947     * The selected item can be unselected with function
25948     * elm_segment_control_item_selected_set().
25949     *
25950     * The selected item always will be highlighted on segment control.
25951     *
25952     * @ingroup SegmentControl
25953     */
25954    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25955
25956    /**
25957     * Set the selected state of an item.
25958     *
25959     * @param it The segment control item
25960     * @param select The selected state
25961     *
25962     * This sets the selected state of the given item @p it.
25963     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25964     *
25965     * If a new item is selected the previosly selected will be unselected.
25966     * Previoulsy selected item can be get with function
25967     * elm_segment_control_item_selected_get().
25968     *
25969     * The selected item always will be highlighted on segment control.
25970     *
25971     * @see elm_segment_control_item_selected_get()
25972     *
25973     * @ingroup SegmentControl
25974     */
25975    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
25976
25977    /**
25978     * @}
25979     */
25980
25981    /**
25982     * @defgroup Grid Grid
25983     *
25984     * The grid is a grid layout widget that lays out a series of children as a
25985     * fixed "grid" of widgets using a given percentage of the grid width and
25986     * height each using the child object.
25987     *
25988     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
25989     * widgets size itself. The default is 100 x 100, so that means the
25990     * position and sizes of children will effectively be percentages (0 to 100)
25991     * of the width or height of the grid widget
25992     *
25993     * @{
25994     */
25995
25996    /**
25997     * Add a new grid to the parent
25998     *
25999     * @param parent The parent object
26000     * @return The new object or NULL if it cannot be created
26001     *
26002     * @ingroup Grid
26003     */
26004    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26005
26006    /**
26007     * Set the virtual size of the grid
26008     *
26009     * @param obj The grid object
26010     * @param w The virtual width of the grid
26011     * @param h The virtual height of the grid
26012     *
26013     * @ingroup Grid
26014     */
26015    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
26016
26017    /**
26018     * Get the virtual size of the grid
26019     *
26020     * @param obj The grid object
26021     * @param w Pointer to integer to store the virtual width of the grid
26022     * @param h Pointer to integer to store the virtual height of the grid
26023     *
26024     * @ingroup Grid
26025     */
26026    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26027
26028    /**
26029     * Pack child at given position and size
26030     *
26031     * @param obj The grid object
26032     * @param subobj The child to pack
26033     * @param x The virtual x coord at which to pack it
26034     * @param y The virtual y coord at which to pack it
26035     * @param w The virtual width at which to pack it
26036     * @param h The virtual height at which to pack it
26037     *
26038     * @ingroup Grid
26039     */
26040    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26041
26042    /**
26043     * Unpack a child from a grid object
26044     *
26045     * @param obj The grid object
26046     * @param subobj The child to unpack
26047     *
26048     * @ingroup Grid
26049     */
26050    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26051
26052    /**
26053     * Faster way to remove all child objects from a grid object.
26054     *
26055     * @param obj The grid object
26056     * @param clear If true, it will delete just removed children
26057     *
26058     * @ingroup Grid
26059     */
26060    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26061
26062    /**
26063     * Set packing of an existing child at to position and size
26064     *
26065     * @param subobj The child to set packing of
26066     * @param x The virtual x coord at which to pack it
26067     * @param y The virtual y coord at which to pack it
26068     * @param w The virtual width at which to pack it
26069     * @param h The virtual height at which to pack it
26070     *
26071     * @ingroup Grid
26072     */
26073    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26074
26075    /**
26076     * get packing of a child
26077     *
26078     * @param subobj The child to query
26079     * @param x Pointer to integer to store the virtual x coord
26080     * @param y Pointer to integer to store the virtual y coord
26081     * @param w Pointer to integer to store the virtual width
26082     * @param h Pointer to integer to store the virtual height
26083     *
26084     * @ingroup Grid
26085     */
26086    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26087
26088    /**
26089     * @}
26090     */
26091
26092    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26093    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26094    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26095    
26096    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26097    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26098    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26099    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26100    EAPI void elm_video_play(Evas_Object *video);
26101    EAPI void elm_video_pause(Evas_Object *video);
26102    EAPI void elm_video_stop(Evas_Object *video);
26103    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26104    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26105    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26106    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26107    EAPI double elm_video_audio_level_get(Evas_Object *video);
26108    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26109    EAPI double elm_video_play_position_get(Evas_Object *video);
26110    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26111    EAPI double elm_video_play_length_get(Evas_Object *video);
26112    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26113    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26114    EAPI const char *elm_video_title_get(Evas_Object *video);
26115
26116    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26117    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26118
26119   /* naviframe */
26120    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26121    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);
26122    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26123    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26124    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26125    EAPI void                elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26126    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26127    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26128    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26129    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26130    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26131    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26132    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26133    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26134    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26135
26136    /**
26137     * @defgroup Video Video
26138     *
26139     * This object display an player that let you control an Elm_Video
26140     * object. It take care of updating it's content according to what is
26141     * going on inside the Emotion object. It does activate the remember
26142     * function on the linked Elm_Video object.
26143     *
26144     * Signals that you cann add callback for are :
26145     *
26146     * "forward,clicked" - the user clicked the forward button.
26147     * "info,clicked" - the user clicked the info button.
26148     * "next,clicked" - the user clicked the next button.
26149     * "pause,clicked" - the user clicked the pause button.
26150     * "play,clicked" - the user clicked the play button.
26151     * "prev,clicked" - the user clicked the prev button.
26152     * "rewind,clicked" - the user clicked the rewind button.
26153     * "stop,clicked" - the user clicked the stop button.
26154     */
26155
26156 #ifdef __cplusplus
26157 }
26158 #endif
26159
26160 #endif